Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.ConnectParticipant.DisconnectParticipant

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Disconnects a participant. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.

The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.

Creating a Request

data DisconnectParticipant Source #

See: newDisconnectParticipant smart constructor.

Constructors

DisconnectParticipant'
Fields clientToken :: Maybe Text A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. connectionToken :: Text The authentication token associated with the participant's connection.

Instances

Instances details

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

newDisconnectParticipant Source #

Arguments

:: Text	`$sel:connectionToken:DisconnectParticipant'`
-> DisconnectParticipant

Create a value of DisconnectParticipant 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:clientToken:DisconnectParticipant', disconnectParticipant_clientToken - A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

$sel:connectionToken:DisconnectParticipant', disconnectParticipant_connectionToken - The authentication token associated with the participant's connection.

Request Lenses

disconnectParticipant_clientToken :: Lens' DisconnectParticipant (Maybe Text) Source #

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

disconnectParticipant_connectionToken :: Lens' DisconnectParticipant Text Source #

The authentication token associated with the participant's connection.

Destructuring the Response

data DisconnectParticipantResponse Source #

See: newDisconnectParticipantResponse smart constructor.

Constructors

DisconnectParticipantResponse'
Fields httpStatus :: Int The response's http status code.

Instances

Instances details

Eq DisconnectParticipantResponse Source #
Instance details Defined in Amazonka.ConnectParticipant.DisconnectParticipant Methods (==) :: DisconnectParticipantResponse -> DisconnectParticipantResponse -> Bool # (/=) :: DisconnectParticipantResponse -> DisconnectParticipantResponse -> Bool #
Read DisconnectParticipantResponse Source #
Instance details Defined in Amazonka.ConnectParticipant.DisconnectParticipant Methods readsPrec :: Int -> ReadS DisconnectParticipantResponse # readList :: ReadS [DisconnectParticipantResponse] # readPrec :: ReadPrec DisconnectParticipantResponse # readListPrec :: ReadPrec [DisconnectParticipantResponse] #
Show DisconnectParticipantResponse Source #
Instance details Defined in Amazonka.ConnectParticipant.DisconnectParticipant Methods showsPrec :: Int -> DisconnectParticipantResponse -> ShowS # show :: DisconnectParticipantResponse -> String # showList :: [DisconnectParticipantResponse] -> ShowS #
Generic DisconnectParticipantResponse Source #
Instance details Defined in Amazonka.ConnectParticipant.DisconnectParticipant Associated Types type Rep DisconnectParticipantResponse :: Type -> Type # Methods from :: DisconnectParticipantResponse -> Rep DisconnectParticipantResponse x # to :: Rep DisconnectParticipantResponse x -> DisconnectParticipantResponse #
NFData DisconnectParticipantResponse Source #
Instance details Defined in Amazonka.ConnectParticipant.DisconnectParticipant Methods rnf :: DisconnectParticipantResponse -> () #
type Rep DisconnectParticipantResponse Source #
Instance details Defined in Amazonka.ConnectParticipant.DisconnectParticipant type Rep DisconnectParticipantResponse = D1 ('MetaData "DisconnectParticipantResponse" "Amazonka.ConnectParticipant.DisconnectParticipant" "libZSservicesZSamazonka-connectparticipantZSamazonka-connectparticipant" 'False) (C1 ('MetaCons "DisconnectParticipantResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDisconnectParticipantResponse Source #

Arguments

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

Create a value of DisconnectParticipantResponse 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:httpStatus:DisconnectParticipantResponse', disconnectParticipantResponse_httpStatus - The response's http status code.

Response Lenses

disconnectParticipantResponse_httpStatus :: Lens' DisconnectParticipantResponse Int Source #

The response's http status code.