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

Amazonka.Connect.MonitorContact

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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' {
- allowedMonitorCapabilities :: Maybe [MonitorCapability]
- clientToken :: Maybe Text
- instanceId :: Text
- contactId :: Text
- userId :: Text
}
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.

Constructors

MonitorContact'

Fields

allowedMonitorCapabilities :: Maybe [MonitorCapability]
Specify which monitoring actions the user is allowed to take. For example, whether the user is allowed to escalate from silent monitoring to barge.
clientToken :: Maybe Text
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.
instanceId :: Text
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
contactId :: Text
The identifier of the contact.
userId :: Text
The identifier of the user account.

Instances

Instances details

ToJSON MonitorContact Source #
Instance details Defined in Amazonka.Connect.MonitorContact Methods toJSON :: MonitorContact -> Value # toEncoding :: MonitorContact -> Encoding # toJSONList :: [MonitorContact] -> Value # toEncodingList :: [MonitorContact] -> Encoding #
ToHeaders MonitorContact Source #
Instance details Defined in Amazonka.Connect.MonitorContact Methods toHeaders :: MonitorContact -> [Header] #
ToPath MonitorContact Source #
Instance details Defined in Amazonka.Connect.MonitorContact Methods toPath :: MonitorContact -> ByteString #
ToQuery MonitorContact Source #
Instance details Defined in Amazonka.Connect.MonitorContact Methods toQuery :: MonitorContact -> QueryString #
AWSRequest MonitorContact Source #
Instance details Defined in Amazonka.Connect.MonitorContact Associated Types type AWSResponse MonitorContact # Methods request :: (Service -> Service) -> MonitorContact -> Request MonitorContact # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy MonitorContact -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse MonitorContact))) #
Generic MonitorContact Source #
Instance details Defined in Amazonka.Connect.MonitorContact Associated Types type Rep MonitorContact :: Type -> Type # Methods from :: MonitorContact -> Rep MonitorContact x # to :: Rep MonitorContact x -> MonitorContact #
Read MonitorContact Source #
Instance details Defined in Amazonka.Connect.MonitorContact Methods readsPrec :: Int -> ReadS MonitorContact # readList :: ReadS [MonitorContact] # readPrec :: ReadPrec MonitorContact # readListPrec :: ReadPrec [MonitorContact] #
Show MonitorContact Source #
Instance details Defined in Amazonka.Connect.MonitorContact Methods showsPrec :: Int -> MonitorContact -> ShowS # show :: MonitorContact -> String # showList :: [MonitorContact] -> ShowS #
NFData MonitorContact Source #
Instance details Defined in Amazonka.Connect.MonitorContact Methods rnf :: MonitorContact -> () #
Eq MonitorContact Source #
Instance details Defined in Amazonka.Connect.MonitorContact Methods (==) :: MonitorContact -> MonitorContact -> Bool # (/=) :: MonitorContact -> MonitorContact -> Bool #
Hashable MonitorContact Source #
Instance details Defined in Amazonka.Connect.MonitorContact Methods hashWithSalt :: Int -> MonitorContact -> Int # hash :: MonitorContact -> Int #
type AWSResponse MonitorContact Source #
Instance details Defined in Amazonka.Connect.MonitorContact type AWSResponse MonitorContact = MonitorContactResponse
type Rep MonitorContact Source #
Instance details Defined in Amazonka.Connect.MonitorContact type Rep MonitorContact = D1 ('MetaData "MonitorContact" "Amazonka.Connect.MonitorContact" "amazonka-connect-2.0-IAACrecRcUS5AABe9BOFyN" 'False) (C1 ('MetaCons "MonitorContact'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "allowedMonitorCapabilities") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [MonitorCapability])) :: S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "instanceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "contactId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "userId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newMonitorContact Source #

Arguments

:: Text	`MonitorContact`
-> Text	`MonitorContact`
-> Text	`MonitorContact`
-> MonitorContact

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.

Constructors

MonitorContactResponse'
Fields contactArn :: Maybe Text The ARN of the contact. contactId :: Maybe Text The identifier of the contact. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic MonitorContactResponse Source #
Instance details Defined in Amazonka.Connect.MonitorContact Associated Types type Rep MonitorContactResponse :: Type -> Type # Methods from :: MonitorContactResponse -> Rep MonitorContactResponse x # to :: Rep MonitorContactResponse x -> MonitorContactResponse #
Read MonitorContactResponse Source #
Instance details Defined in Amazonka.Connect.MonitorContact Methods readsPrec :: Int -> ReadS MonitorContactResponse # readList :: ReadS [MonitorContactResponse] # readPrec :: ReadPrec MonitorContactResponse # readListPrec :: ReadPrec [MonitorContactResponse] #
Show MonitorContactResponse Source #
Instance details Defined in Amazonka.Connect.MonitorContact Methods showsPrec :: Int -> MonitorContactResponse -> ShowS # show :: MonitorContactResponse -> String # showList :: [MonitorContactResponse] -> ShowS #
NFData MonitorContactResponse Source #
Instance details Defined in Amazonka.Connect.MonitorContact Methods rnf :: MonitorContactResponse -> () #
Eq MonitorContactResponse Source #
Instance details Defined in Amazonka.Connect.MonitorContact Methods (==) :: MonitorContactResponse -> MonitorContactResponse -> Bool # (/=) :: MonitorContactResponse -> MonitorContactResponse -> Bool #
type Rep MonitorContactResponse Source #
Instance details Defined in Amazonka.Connect.MonitorContact type Rep MonitorContactResponse = D1 ('MetaData "MonitorContactResponse" "Amazonka.Connect.MonitorContact" "amazonka-connect-2.0-IAACrecRcUS5AABe9BOFyN" 'False) (C1 ('MetaCons "MonitorContactResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "contactArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "contactId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newMonitorContactResponse Source #

Arguments

:: Int	`$sel:httpStatus:MonitorContactResponse'`
-> MonitorContactResponse

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.