| 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.ConnectParticipant.CreateParticipantConnection
Description
Creates the participant's connection.
ParticipantToken is used for invoking this API instead of
ConnectionToken.
The participant token is valid for the lifetime of the participant – until they are part of a contact.
The response URL for WEBSOCKET Type has a connect expiry timeout of
100s. Clients must manually connect to the returned websocket URL and
subscribe to the desired topic.
For chat, you need to publish the following on the established websocket connection:
{"topic":"aws/subscribe","content":{"topics":["aws/chat"]}}Upon websocket URL expiry, as specified in the response ConnectionExpiry parameter, clients need to call this API again to obtain a new websocket URL and perform the same steps as before.
Message streaming support: This API can also be used together with the StartContactStreaming API to create a participant connection for chat contacts that are not using a websocket. For more information about message streaming, Enable real-time chat message streaming in the Amazon Connect Administrator Guide.
Feature specifications: For information about feature specifications, such as the allowed number of open websocket connections per participant, see Feature specifications in the Amazon Connect Administrator Guide.
The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.
Synopsis
- data CreateParticipantConnection = CreateParticipantConnection' {}
- newCreateParticipantConnection :: Text -> CreateParticipantConnection
- createParticipantConnection_connectParticipant :: Lens' CreateParticipantConnection (Maybe Bool)
- createParticipantConnection_type :: Lens' CreateParticipantConnection (Maybe (NonEmpty ConnectionType))
- createParticipantConnection_participantToken :: Lens' CreateParticipantConnection Text
- data CreateParticipantConnectionResponse = CreateParticipantConnectionResponse' {}
- newCreateParticipantConnectionResponse :: Int -> CreateParticipantConnectionResponse
- createParticipantConnectionResponse_connectionCredentials :: Lens' CreateParticipantConnectionResponse (Maybe ConnectionCredentials)
- createParticipantConnectionResponse_websocket :: Lens' CreateParticipantConnectionResponse (Maybe Websocket)
- createParticipantConnectionResponse_httpStatus :: Lens' CreateParticipantConnectionResponse Int
Creating a Request
data CreateParticipantConnection Source #
See: newCreateParticipantConnection smart constructor.
Constructors
| CreateParticipantConnection' | |
Fields
| |
Instances
newCreateParticipantConnection Source #
Create a value of CreateParticipantConnection 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:connectParticipant:CreateParticipantConnection', createParticipantConnection_connectParticipant - Amazon Connect Participant is used to mark the participant as connected
for message streaming.
CreateParticipantConnection, createParticipantConnection_type - Type of connection information required. This can be omitted if
ConnectParticipant is true.
$sel:participantToken:CreateParticipantConnection', createParticipantConnection_participantToken - This is a header parameter.
The ParticipantToken as obtained from StartChatContact API response.
Request Lenses
createParticipantConnection_connectParticipant :: Lens' CreateParticipantConnection (Maybe Bool) Source #
Amazon Connect Participant is used to mark the participant as connected for message streaming.
createParticipantConnection_type :: Lens' CreateParticipantConnection (Maybe (NonEmpty ConnectionType)) Source #
Type of connection information required. This can be omitted if
ConnectParticipant is true.
createParticipantConnection_participantToken :: Lens' CreateParticipantConnection Text Source #
This is a header parameter.
The ParticipantToken as obtained from StartChatContact API response.
Destructuring the Response
data CreateParticipantConnectionResponse Source #
See: newCreateParticipantConnectionResponse smart constructor.
Constructors
| CreateParticipantConnectionResponse' | |
Fields
| |
Instances
newCreateParticipantConnectionResponse Source #
Arguments
| :: Int | |
| -> CreateParticipantConnectionResponse |
Create a value of CreateParticipantConnectionResponse 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:connectionCredentials:CreateParticipantConnectionResponse', createParticipantConnectionResponse_connectionCredentials - Creates the participant's connection credentials. The authentication
token associated with the participant's connection.
$sel:websocket:CreateParticipantConnectionResponse', createParticipantConnectionResponse_websocket - Creates the participant's websocket connection.
$sel:httpStatus:CreateParticipantConnectionResponse', createParticipantConnectionResponse_httpStatus - The response's http status code.
Response Lenses
createParticipantConnectionResponse_connectionCredentials :: Lens' CreateParticipantConnectionResponse (Maybe ConnectionCredentials) Source #
Creates the participant's connection credentials. The authentication token associated with the participant's connection.
createParticipantConnectionResponse_websocket :: Lens' CreateParticipantConnectionResponse (Maybe Websocket) Source #
Creates the participant's websocket connection.
createParticipantConnectionResponse_httpStatus :: Lens' CreateParticipantConnectionResponse Int Source #
The response's http status code.