amazonka-connectparticipant-2.0: Amazon Connect Participant Service SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.ConnectParticipant.DisconnectParticipant

Description

Disconnects a participant.

ConnectionToken is used for invoking this API instead of ParticipantToken.

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

Synopsis

Creating a Request

data DisconnectParticipant Source #

See: newDisconnectParticipant smart constructor.

Constructors

DisconnectParticipant' 

Fields

Instances

Instances details
ToJSON DisconnectParticipant Source # 
Instance details

Defined in Amazonka.ConnectParticipant.DisconnectParticipant

Methods

toJSON :: DisconnectParticipant -> Value #

toEncoding :: DisconnectParticipant -> Encoding #

toJSONList :: [DisconnectParticipant] -> Value #

toEncodingList :: [DisconnectParticipant] -> Encoding #

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 #

AWSRequest DisconnectParticipant Source # 
Instance details

Defined in Amazonka.ConnectParticipant.DisconnectParticipant

Associated Types

type AWSResponse DisconnectParticipant #

Methods

request :: (Service -> Service) -> DisconnectParticipant -> Request DisconnectParticipant #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DisconnectParticipant -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DisconnectParticipant))) #

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 #

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 #

NFData DisconnectParticipant Source # 
Instance details

Defined in Amazonka.ConnectParticipant.DisconnectParticipant

Methods

rnf :: DisconnectParticipant -> () #

Eq DisconnectParticipant Source # 
Instance details

Defined in Amazonka.ConnectParticipant.DisconnectParticipant

Methods

(==) :: DisconnectParticipant -> DisconnectParticipant -> Bool #

(/=) :: DisconnectParticipant -> DisconnectParticipant -> Bool #

Hashable DisconnectParticipant Source # 
Instance details

Defined in Amazonka.ConnectParticipant.DisconnectParticipant

Methods

hashWithSalt :: Int -> DisconnectParticipant -> Int #

hash :: DisconnectParticipant -> Int #

type AWSResponse DisconnectParticipant Source # 
Instance details

Defined in Amazonka.ConnectParticipant.DisconnectParticipant

type AWSResponse DisconnectParticipant = DisconnectParticipantResponse
type Rep DisconnectParticipant Source # 
Instance details

Defined in Amazonka.ConnectParticipant.DisconnectParticipant

type Rep DisconnectParticipant = D1 ('MetaData "DisconnectParticipant" "Amazonka.ConnectParticipant.DisconnectParticipant" "amazonka-connectparticipant-2.0-I4GmkIlwxQUGg1dW7eNFQJ" '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)))

newDisconnectParticipant Source #

Arguments

:: Text

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. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

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. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

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

Instances

Instances details
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 #

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 #

NFData DisconnectParticipantResponse Source # 
Instance details

Defined in Amazonka.ConnectParticipant.DisconnectParticipant

Methods

rnf :: DisconnectParticipantResponse -> () #

Eq DisconnectParticipantResponse Source # 
Instance details

Defined in Amazonka.ConnectParticipant.DisconnectParticipant

Methods

(==) :: DisconnectParticipantResponse -> DisconnectParticipantResponse -> Bool #

(/=) :: DisconnectParticipantResponse -> DisconnectParticipantResponse -> Bool #

type Rep DisconnectParticipantResponse Source # 
Instance details

Defined in Amazonka.ConnectParticipant.DisconnectParticipant

type Rep DisconnectParticipantResponse = D1 ('MetaData "DisconnectParticipantResponse" "Amazonka.ConnectParticipant.DisconnectParticipant" "amazonka-connectparticipant-2.0-I4GmkIlwxQUGg1dW7eNFQJ" '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.