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 |
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
- data DisconnectParticipant = DisconnectParticipant' {}
- newDisconnectParticipant :: Text -> DisconnectParticipant
- disconnectParticipant_clientToken :: Lens' DisconnectParticipant (Maybe Text)
- disconnectParticipant_connectionToken :: Lens' DisconnectParticipant Text
- data DisconnectParticipantResponse = DisconnectParticipantResponse' {
- httpStatus :: Int
- newDisconnectParticipantResponse :: Int -> DisconnectParticipantResponse
- disconnectParticipantResponse_httpStatus :: Lens' DisconnectParticipantResponse Int
Creating a Request
data DisconnectParticipant Source #
See: newDisconnectParticipant
smart constructor.
DisconnectParticipant' | |
|
Instances
newDisconnectParticipant Source #
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.
DisconnectParticipantResponse' | |
|
Instances
newDisconnectParticipantResponse Source #
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.