| 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.StartContactStreaming
Description
Initiates real-time message streaming for a new chat contact.
For more information about message streaming, see Enable real-time chat message streaming in the Amazon Connect Administrator Guide.
Synopsis
- data StartContactStreaming = StartContactStreaming' {}
- newStartContactStreaming :: Text -> Text -> ChatStreamingConfiguration -> Text -> StartContactStreaming
- startContactStreaming_instanceId :: Lens' StartContactStreaming Text
- startContactStreaming_contactId :: Lens' StartContactStreaming Text
- startContactStreaming_chatStreamingConfiguration :: Lens' StartContactStreaming ChatStreamingConfiguration
- startContactStreaming_clientToken :: Lens' StartContactStreaming Text
- data StartContactStreamingResponse = StartContactStreamingResponse' {
- httpStatus :: Int
- streamingId :: Text
- newStartContactStreamingResponse :: Int -> Text -> StartContactStreamingResponse
- startContactStreamingResponse_httpStatus :: Lens' StartContactStreamingResponse Int
- startContactStreamingResponse_streamingId :: Lens' StartContactStreamingResponse Text
Creating a Request
data StartContactStreaming Source #
See: newStartContactStreaming smart constructor.
Constructors
| StartContactStreaming' | |
Fields
| |
Instances
newStartContactStreaming Source #
Arguments
| :: Text | |
| -> Text | |
| -> ChatStreamingConfiguration | |
| -> Text | |
| -> StartContactStreaming |
Create a value of StartContactStreaming 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:
StartContactStreaming, startContactStreaming_instanceId - The identifier of the Amazon Connect instance. You can find the
instanceId in the ARN of the instance.
StartContactStreaming, startContactStreaming_contactId - The identifier of the contact. This is the identifier of the contact
associated with the first interaction with the contact center.
$sel:chatStreamingConfiguration:StartContactStreaming', startContactStreaming_chatStreamingConfiguration - The streaming configuration, such as the Amazon SNS streaming endpoint.
$sel:clientToken:StartContactStreaming', startContactStreaming_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.
Request Lenses
startContactStreaming_instanceId :: Lens' StartContactStreaming Text Source #
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
startContactStreaming_contactId :: Lens' StartContactStreaming Text Source #
The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.
startContactStreaming_chatStreamingConfiguration :: Lens' StartContactStreaming ChatStreamingConfiguration Source #
The streaming configuration, such as the Amazon SNS streaming endpoint.
startContactStreaming_clientToken :: Lens' StartContactStreaming 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.
Destructuring the Response
data StartContactStreamingResponse Source #
See: newStartContactStreamingResponse smart constructor.
Constructors
| StartContactStreamingResponse' | |
Fields
| |
Instances
newStartContactStreamingResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> StartContactStreamingResponse |
Create a value of StartContactStreamingResponse 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:StartContactStreamingResponse', startContactStreamingResponse_httpStatus - The response's http status code.
$sel:streamingId:StartContactStreamingResponse', startContactStreamingResponse_streamingId - The identifier of the streaming configuration enabled.
Response Lenses
startContactStreamingResponse_httpStatus :: Lens' StartContactStreamingResponse Int Source #
The response's http status code.
startContactStreamingResponse_streamingId :: Lens' StartContactStreamingResponse Text Source #
The identifier of the streaming configuration enabled.