Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Initiates silent monitoring of a contact. The Contact Control Panel (CCP) of the user specified by userId will be set to silent monitoring mode on the contact.
Synopsis
- data MonitorContact = MonitorContact' {}
- newMonitorContact :: Text -> Text -> Text -> MonitorContact
- monitorContact_allowedMonitorCapabilities :: Lens' MonitorContact (Maybe [MonitorCapability])
- monitorContact_clientToken :: Lens' MonitorContact (Maybe Text)
- monitorContact_instanceId :: Lens' MonitorContact Text
- monitorContact_contactId :: Lens' MonitorContact Text
- monitorContact_userId :: Lens' MonitorContact Text
- data MonitorContactResponse = MonitorContactResponse' {
- contactArn :: Maybe Text
- contactId :: Maybe Text
- httpStatus :: Int
- newMonitorContactResponse :: Int -> MonitorContactResponse
- monitorContactResponse_contactArn :: Lens' MonitorContactResponse (Maybe Text)
- monitorContactResponse_contactId :: Lens' MonitorContactResponse (Maybe Text)
- monitorContactResponse_httpStatus :: Lens' MonitorContactResponse Int
Creating a Request
data MonitorContact Source #
See: newMonitorContact
smart constructor.
MonitorContact' | |
|
Instances
Create a value of MonitorContact
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:allowedMonitorCapabilities:MonitorContact'
, monitorContact_allowedMonitorCapabilities
- Specify which monitoring actions the user is allowed to take. For
example, whether the user is allowed to escalate from silent monitoring
to barge.
$sel:clientToken:MonitorContact'
, monitorContact_clientToken
- A unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. If not provided, the Amazon Web Services SDK
populates this field. For more information about idempotency, see
Making retries safe with idempotent APIs.
MonitorContact
, monitorContact_instanceId
- The identifier of the Amazon Connect instance. You can find the
instanceId in the ARN of the instance.
MonitorContact
, monitorContact_contactId
- The identifier of the contact.
MonitorContact
, monitorContact_userId
- The identifier of the user account.
Request Lenses
monitorContact_allowedMonitorCapabilities :: Lens' MonitorContact (Maybe [MonitorCapability]) Source #
Specify which monitoring actions the user is allowed to take. For example, whether the user is allowed to escalate from silent monitoring to barge.
monitorContact_clientToken :: Lens' MonitorContact (Maybe Text) Source #
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
monitorContact_instanceId :: Lens' MonitorContact Text Source #
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
monitorContact_contactId :: Lens' MonitorContact Text Source #
The identifier of the contact.
monitorContact_userId :: Lens' MonitorContact Text Source #
The identifier of the user account.
Destructuring the Response
data MonitorContactResponse Source #
See: newMonitorContactResponse
smart constructor.
MonitorContactResponse' | |
|
Instances
newMonitorContactResponse Source #
Create a value of MonitorContactResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:contactArn:MonitorContactResponse'
, monitorContactResponse_contactArn
- The ARN of the contact.
MonitorContact
, monitorContactResponse_contactId
- The identifier of the contact.
$sel:httpStatus:MonitorContactResponse'
, monitorContactResponse_httpStatus
- The response's http status code.
Response Lenses
monitorContactResponse_contactArn :: Lens' MonitorContactResponse (Maybe Text) Source #
The ARN of the contact.
monitorContactResponse_contactId :: Lens' MonitorContactResponse (Maybe Text) Source #
The identifier of the contact.
monitorContactResponse_httpStatus :: Lens' MonitorContactResponse Int Source #
The response's http status code.