| 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
Description
Derived from API version 2018-09-07 of the AWS service descriptions, licensed under Apache 2.0.
Amazon Connect is a cloud-based contact center solution that makes it easy to set up and manage a customer contact center. Amazon Connect enables customer contacts through voice or chat. Use the Amazon Connect Participant Service to manage chat participants, such as agents and customers.
Synopsis
- defaultService :: Service
- _AccessDeniedException :: AsError a => Fold a ServiceError
- _ConflictException :: AsError a => Fold a ServiceError
- _InternalServerException :: AsError a => Fold a ServiceError
- _ServiceQuotaExceededException :: AsError a => Fold a ServiceError
- _ThrottlingException :: AsError a => Fold a ServiceError
- _ValidationException :: AsError a => Fold a ServiceError
- data CompleteAttachmentUpload = CompleteAttachmentUpload' (NonEmpty Text) Text Text
- newCompleteAttachmentUpload :: NonEmpty Text -> Text -> Text -> CompleteAttachmentUpload
- data CompleteAttachmentUploadResponse = CompleteAttachmentUploadResponse' Int
- newCompleteAttachmentUploadResponse :: Int -> CompleteAttachmentUploadResponse
- data CreateParticipantConnection = CreateParticipantConnection' (Maybe Bool) (Maybe (NonEmpty ConnectionType)) Text
- newCreateParticipantConnection :: Text -> CreateParticipantConnection
- data CreateParticipantConnectionResponse = CreateParticipantConnectionResponse' (Maybe ConnectionCredentials) (Maybe Websocket) Int
- newCreateParticipantConnectionResponse :: Int -> CreateParticipantConnectionResponse
- data DisconnectParticipant = DisconnectParticipant' (Maybe Text) Text
- newDisconnectParticipant :: Text -> DisconnectParticipant
- data DisconnectParticipantResponse = DisconnectParticipantResponse' Int
- newDisconnectParticipantResponse :: Int -> DisconnectParticipantResponse
- data GetAttachment = GetAttachment' Text Text
- newGetAttachment :: Text -> Text -> GetAttachment
- data GetAttachmentResponse = GetAttachmentResponse' (Maybe Text) (Maybe Text) Int
- newGetAttachmentResponse :: Int -> GetAttachmentResponse
- data GetTranscript = GetTranscript' (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe ScanDirection) (Maybe SortKey) (Maybe StartPosition) Text
- newGetTranscript :: Text -> GetTranscript
- data GetTranscriptResponse = GetTranscriptResponse' (Maybe Text) (Maybe Text) (Maybe [Item]) Int
- newGetTranscriptResponse :: Int -> GetTranscriptResponse
- data SendEvent = SendEvent' (Maybe Text) (Maybe Text) Text Text
- newSendEvent :: Text -> Text -> SendEvent
- data SendEventResponse = SendEventResponse' (Maybe Text) (Maybe Text) Int
- newSendEventResponse :: Int -> SendEventResponse
- data SendMessage = SendMessage' (Maybe Text) Text Text Text
- newSendMessage :: Text -> Text -> Text -> SendMessage
- data SendMessageResponse = SendMessageResponse' (Maybe Text) (Maybe Text) Int
- newSendMessageResponse :: Int -> SendMessageResponse
- data StartAttachmentUpload = StartAttachmentUpload' Text Natural Text Text Text
- newStartAttachmentUpload :: Text -> Natural -> Text -> Text -> Text -> StartAttachmentUpload
- data StartAttachmentUploadResponse = StartAttachmentUploadResponse' (Maybe Text) (Maybe UploadMetadata) Int
- newStartAttachmentUploadResponse :: Int -> StartAttachmentUploadResponse
- newtype ArtifactStatus where
- ArtifactStatus' { }
- pattern ArtifactStatus_APPROVED :: ArtifactStatus
- pattern ArtifactStatus_IN_PROGRESS :: ArtifactStatus
- pattern ArtifactStatus_REJECTED :: ArtifactStatus
- newtype ChatItemType where
- ChatItemType' { }
- pattern ChatItemType_ATTACHMENT :: ChatItemType
- pattern ChatItemType_CHAT_ENDED :: ChatItemType
- pattern ChatItemType_CONNECTION_ACK :: ChatItemType
- pattern ChatItemType_EVENT :: ChatItemType
- pattern ChatItemType_MESSAGE :: ChatItemType
- pattern ChatItemType_MESSAGE_DELIVERED :: ChatItemType
- pattern ChatItemType_MESSAGE_READ :: ChatItemType
- pattern ChatItemType_PARTICIPANT_JOINED :: ChatItemType
- pattern ChatItemType_PARTICIPANT_LEFT :: ChatItemType
- pattern ChatItemType_TRANSFER_FAILED :: ChatItemType
- pattern ChatItemType_TRANSFER_SUCCEEDED :: ChatItemType
- pattern ChatItemType_TYPING :: ChatItemType
- newtype ConnectionType where
- ConnectionType' { }
- pattern ConnectionType_CONNECTION_CREDENTIALS :: ConnectionType
- pattern ConnectionType_WEBSOCKET :: ConnectionType
- newtype ParticipantRole where
- ParticipantRole' { }
- pattern ParticipantRole_AGENT :: ParticipantRole
- pattern ParticipantRole_CUSTOMER :: ParticipantRole
- pattern ParticipantRole_SYSTEM :: ParticipantRole
- newtype ScanDirection where
- ScanDirection' { }
- pattern ScanDirection_BACKWARD :: ScanDirection
- pattern ScanDirection_FORWARD :: ScanDirection
- newtype SortKey where
- SortKey' {
- fromSortKey :: Text
- pattern SortKey_ASCENDING :: SortKey
- pattern SortKey_DESCENDING :: SortKey
- SortKey' {
- data AttachmentItem = AttachmentItem' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ArtifactStatus)
- newAttachmentItem :: AttachmentItem
- data ConnectionCredentials = ConnectionCredentials' (Maybe Text) (Maybe Text)
- newConnectionCredentials :: ConnectionCredentials
- data Item = Item' (Maybe Text) (Maybe [AttachmentItem]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe MessageMetadata) (Maybe Text) (Maybe ParticipantRole) (Maybe ChatItemType)
- newItem :: Item
- data MessageMetadata = MessageMetadata' (Maybe Text) (Maybe [Receipt])
- newMessageMetadata :: MessageMetadata
- data Receipt = Receipt' (Maybe Text) (Maybe Text) (Maybe Text)
- newReceipt :: Receipt
- data StartPosition = StartPosition' (Maybe Text) (Maybe Text) (Maybe Natural)
- newStartPosition :: StartPosition
- data UploadMetadata = UploadMetadata' (Maybe (HashMap Text Text)) (Maybe Text) (Maybe Text)
- newUploadMetadata :: UploadMetadata
- data Websocket = Websocket' (Maybe Text) (Maybe Text)
- newWebsocket :: Websocket
Service Configuration
defaultService :: Service Source #
API version 2018-09-07 of the Amazon Connect Participant Service SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by ConnectParticipant.
AccessDeniedException
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
You do not have sufficient access to perform this action.
ConflictException
_ConflictException :: AsError a => Fold a ServiceError Source #
An attachment with that identifier is already being uploaded.
InternalServerException
_InternalServerException :: AsError a => Fold a ServiceError Source #
This exception occurs when there is an internal failure in the Amazon Connect service.
ServiceQuotaExceededException
_ServiceQuotaExceededException :: AsError a => Fold a ServiceError Source #
The number of attachments per contact exceeds the quota.
ThrottlingException
_ThrottlingException :: AsError a => Fold a ServiceError Source #
The request was denied due to request throttling.
ValidationException
_ValidationException :: AsError a => Fold a ServiceError Source #
The input fails to satisfy the constraints specified by Amazon Connect.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
CompleteAttachmentUpload
data CompleteAttachmentUpload Source #
See: newCompleteAttachmentUpload smart constructor.
Constructors
| CompleteAttachmentUpload' (NonEmpty Text) Text Text |
Instances
newCompleteAttachmentUpload Source #
Arguments
| :: NonEmpty Text | |
| -> Text | |
| -> Text | |
| -> CompleteAttachmentUpload |
Create a value of CompleteAttachmentUpload 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:attachmentIds:CompleteAttachmentUpload', completeAttachmentUpload_attachmentIds - A list of unique identifiers for the attachments.
$sel:clientToken:CompleteAttachmentUpload', completeAttachmentUpload_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.
CompleteAttachmentUpload, completeAttachmentUpload_connectionToken - The authentication token associated with the participant's connection.
data CompleteAttachmentUploadResponse Source #
See: newCompleteAttachmentUploadResponse smart constructor.
Constructors
| CompleteAttachmentUploadResponse' Int |
Instances
newCompleteAttachmentUploadResponse Source #
Create a value of CompleteAttachmentUploadResponse 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:CompleteAttachmentUploadResponse', completeAttachmentUploadResponse_httpStatus - The response's http status code.
CreateParticipantConnection
data CreateParticipantConnection Source #
See: newCreateParticipantConnection smart constructor.
Constructors
| CreateParticipantConnection' (Maybe Bool) (Maybe (NonEmpty ConnectionType)) Text |
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.
data CreateParticipantConnectionResponse Source #
See: newCreateParticipantConnectionResponse smart constructor.
Constructors
| CreateParticipantConnectionResponse' (Maybe ConnectionCredentials) (Maybe Websocket) Int |
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.
DisconnectParticipant
data DisconnectParticipant Source #
See: newDisconnectParticipant smart constructor.
Constructors
| DisconnectParticipant' (Maybe Text) Text |
Instances
newDisconnectParticipant Source #
Arguments
| :: Text | |
| -> 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.
data DisconnectParticipantResponse Source #
See: newDisconnectParticipantResponse smart constructor.
Constructors
| DisconnectParticipantResponse' Int |
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.
GetAttachment
data GetAttachment Source #
See: newGetAttachment smart constructor.
Constructors
| GetAttachment' Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> GetAttachment |
Create a value of GetAttachment 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:
GetAttachment, getAttachment_attachmentId - A unique identifier for the attachment.
GetAttachment, getAttachment_connectionToken - The authentication token associated with the participant's connection.
data GetAttachmentResponse Source #
See: newGetAttachmentResponse smart constructor.
Instances
newGetAttachmentResponse Source #
Create a value of GetAttachmentResponse 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:
GetAttachmentResponse, getAttachmentResponse_url - This is the pre-signed URL that can be used for uploading the file to
Amazon S3 when used in response to
StartAttachmentUpload.
GetAttachmentResponse, getAttachmentResponse_urlExpiry - The expiration time of the URL in ISO timestamp. It's specified in ISO
8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example,
2019-11-08T02:41:28.172Z.
$sel:httpStatus:GetAttachmentResponse', getAttachmentResponse_httpStatus - The response's http status code.
GetTranscript
data GetTranscript Source #
See: newGetTranscript smart constructor.
Constructors
| GetTranscript' (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe ScanDirection) (Maybe SortKey) (Maybe StartPosition) Text |
Instances
Arguments
| :: Text | |
| -> GetTranscript |
Create a value of GetTranscript 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:contactId:GetTranscript', getTranscript_contactId - The contactId from the current contact chain for which transcript is
needed.
$sel:maxResults:GetTranscript', getTranscript_maxResults - The maximum number of results to return in the page. Default: 10.
GetTranscript, getTranscript_nextToken - The pagination token. Use the value returned previously in the next
subsequent request to retrieve the next set of results.
$sel:scanDirection:GetTranscript', getTranscript_scanDirection - The direction from StartPosition from which to retrieve message.
Default: BACKWARD when no StartPosition is provided, FORWARD with
StartPosition.
$sel:sortOrder:GetTranscript', getTranscript_sortOrder - The sort order for the records. Default: DESCENDING.
$sel:startPosition:GetTranscript', getTranscript_startPosition - A filtering option for where to start.
GetTranscript, getTranscript_connectionToken - The authentication token associated with the participant's connection.
data GetTranscriptResponse Source #
See: newGetTranscriptResponse smart constructor.
Instances
newGetTranscriptResponse Source #
Create a value of GetTranscriptResponse 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:initialContactId:GetTranscriptResponse', getTranscriptResponse_initialContactId - The initial contact ID for the contact.
GetTranscript, getTranscriptResponse_nextToken - The pagination token. Use the value returned previously in the next
subsequent request to retrieve the next set of results.
$sel:transcript:GetTranscriptResponse', getTranscriptResponse_transcript - The list of messages in the session.
$sel:httpStatus:GetTranscriptResponse', getTranscriptResponse_httpStatus - The response's http status code.
SendEvent
See: newSendEvent smart constructor.
Instances
Create a value of SendEvent 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:SendEvent', sendEvent_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.
SendEvent, sendEvent_content - The content of the event to be sent (for example, message text). For
content related to message receipts, this is supported in the form of a
JSON string.
Sample Content: "{\"messageId\":\"11111111-aaaa-bbbb-cccc-EXAMPLE01234\"}"
SendEvent, sendEvent_contentType - The content type of the request. Supported types are:
- application/vnd.amazonaws.connect.event.typing
- application/vnd.amazonaws.connect.event.connection.acknowledged
- application/vnd.amazonaws.connect.event.message.delivered
- application/vnd.amazonaws.connect.event.message.read
SendEvent, sendEvent_connectionToken - The authentication token associated with the participant's connection.
data SendEventResponse Source #
See: newSendEventResponse smart constructor.
Instances
Arguments
| :: Int | |
| -> SendEventResponse |
Create a value of SendEventResponse 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:
SendEventResponse, sendEventResponse_absoluteTime - The time when the event was sent.
It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.
SendEventResponse, sendEventResponse_id - The ID of the response.
$sel:httpStatus:SendEventResponse', sendEventResponse_httpStatus - The response's http status code.
SendMessage
data SendMessage Source #
See: newSendMessage smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> SendMessage |
Create a value of SendMessage 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:SendMessage', sendMessage_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.
SendMessage, sendMessage_contentType - The type of the content. Supported types are text/plain,
text/markdown, and application/json.
SendMessage, sendMessage_content - The content of the message.
- For
text/plainandtext/markdown, the Length Constraints are Minimum of 1, Maximum of 1024. - For
application/json, the Length Constraints are Minimum of 1, Maximum of 12000.
SendMessage, sendMessage_connectionToken - The authentication token associated with the connection.
data SendMessageResponse Source #
See: newSendMessageResponse smart constructor.
Instances
newSendMessageResponse Source #
Arguments
| :: Int | |
| -> SendMessageResponse |
Create a value of SendMessageResponse 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:
SendMessageResponse, sendMessageResponse_absoluteTime - The time when the message was sent.
It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.
SendMessageResponse, sendMessageResponse_id - The ID of the message.
$sel:httpStatus:SendMessageResponse', sendMessageResponse_httpStatus - The response's http status code.
StartAttachmentUpload
data StartAttachmentUpload Source #
See: newStartAttachmentUpload smart constructor.
Instances
newStartAttachmentUpload Source #
Create a value of StartAttachmentUpload 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:
StartAttachmentUpload, startAttachmentUpload_contentType - Describes the MIME file type of the attachment. For a list of supported
file types, see
Feature specifications
in the Amazon Connect Administrator Guide.
$sel:attachmentSizeInBytes:StartAttachmentUpload', startAttachmentUpload_attachmentSizeInBytes - The size of the attachment in bytes.
StartAttachmentUpload, startAttachmentUpload_attachmentName - A case-sensitive name of the attachment being uploaded.
$sel:clientToken:StartAttachmentUpload', startAttachmentUpload_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.
StartAttachmentUpload, startAttachmentUpload_connectionToken - The authentication token associated with the participant's connection.
data StartAttachmentUploadResponse Source #
See: newStartAttachmentUploadResponse smart constructor.
Constructors
| StartAttachmentUploadResponse' (Maybe Text) (Maybe UploadMetadata) Int |
Instances
newStartAttachmentUploadResponse Source #
Create a value of StartAttachmentUploadResponse 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:
StartAttachmentUploadResponse, startAttachmentUploadResponse_attachmentId - A unique identifier for the attachment.
$sel:uploadMetadata:StartAttachmentUploadResponse', startAttachmentUploadResponse_uploadMetadata - Fields to be used while uploading the attachment.
$sel:httpStatus:StartAttachmentUploadResponse', startAttachmentUploadResponse_httpStatus - The response's http status code.
Types
ArtifactStatus
newtype ArtifactStatus Source #
Constructors
| ArtifactStatus' | |
Fields | |
Bundled Patterns
| pattern ArtifactStatus_APPROVED :: ArtifactStatus | |
| pattern ArtifactStatus_IN_PROGRESS :: ArtifactStatus | |
| pattern ArtifactStatus_REJECTED :: ArtifactStatus |
Instances
ChatItemType
newtype ChatItemType Source #
Constructors
| ChatItemType' | |
Fields | |
Bundled Patterns
| pattern ChatItemType_ATTACHMENT :: ChatItemType | |
| pattern ChatItemType_CHAT_ENDED :: ChatItemType | |
| pattern ChatItemType_CONNECTION_ACK :: ChatItemType | |
| pattern ChatItemType_EVENT :: ChatItemType | |
| pattern ChatItemType_MESSAGE :: ChatItemType | |
| pattern ChatItemType_MESSAGE_DELIVERED :: ChatItemType | |
| pattern ChatItemType_MESSAGE_READ :: ChatItemType | |
| pattern ChatItemType_PARTICIPANT_JOINED :: ChatItemType | |
| pattern ChatItemType_PARTICIPANT_LEFT :: ChatItemType | |
| pattern ChatItemType_TRANSFER_FAILED :: ChatItemType | |
| pattern ChatItemType_TRANSFER_SUCCEEDED :: ChatItemType | |
| pattern ChatItemType_TYPING :: ChatItemType |
Instances
ConnectionType
newtype ConnectionType Source #
Constructors
| ConnectionType' | |
Fields | |
Bundled Patterns
| pattern ConnectionType_CONNECTION_CREDENTIALS :: ConnectionType | |
| pattern ConnectionType_WEBSOCKET :: ConnectionType |
Instances
ParticipantRole
newtype ParticipantRole Source #
Constructors
| ParticipantRole' | |
Fields | |
Bundled Patterns
| pattern ParticipantRole_AGENT :: ParticipantRole | |
| pattern ParticipantRole_CUSTOMER :: ParticipantRole | |
| pattern ParticipantRole_SYSTEM :: ParticipantRole |
Instances
ScanDirection
newtype ScanDirection Source #
Constructors
| ScanDirection' | |
Fields | |
Bundled Patterns
| pattern ScanDirection_BACKWARD :: ScanDirection | |
| pattern ScanDirection_FORWARD :: ScanDirection |
Instances
SortKey
Constructors
| SortKey' | |
Fields
| |
Bundled Patterns
| pattern SortKey_ASCENDING :: SortKey | |
| pattern SortKey_DESCENDING :: SortKey |
Instances
AttachmentItem
data AttachmentItem Source #
The case-insensitive input to indicate standard MIME type that describes the format of the file that will be uploaded.
See: newAttachmentItem smart constructor.
Constructors
| AttachmentItem' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ArtifactStatus) |
Instances
newAttachmentItem :: AttachmentItem Source #
Create a value of AttachmentItem 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:attachmentId:AttachmentItem', attachmentItem_attachmentId - A unique identifier for the attachment.
$sel:attachmentName:AttachmentItem', attachmentItem_attachmentName - A case-sensitive name of the attachment being uploaded.
$sel:contentType:AttachmentItem', attachmentItem_contentType - Describes the MIME file type of the attachment. For a list of supported
file types, see
Feature specifications
in the Amazon Connect Administrator Guide.
$sel:status:AttachmentItem', attachmentItem_status - Status of the attachment.
ConnectionCredentials
data ConnectionCredentials Source #
Connection credentials.
See: newConnectionCredentials smart constructor.
Constructors
| ConnectionCredentials' (Maybe Text) (Maybe Text) |
Instances
newConnectionCredentials :: ConnectionCredentials Source #
Create a value of ConnectionCredentials 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:connectionToken:ConnectionCredentials', connectionCredentials_connectionToken - The connection token.
$sel:expiry:ConnectionCredentials', connectionCredentials_expiry - The expiration of the token.
It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.
Item
An item - message or event - that has been sent.
See: newItem smart constructor.
Constructors
| Item' (Maybe Text) (Maybe [AttachmentItem]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe MessageMetadata) (Maybe Text) (Maybe ParticipantRole) (Maybe ChatItemType) |
Instances
Create a value of Item 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:absoluteTime:Item', item_absoluteTime - The time when the message or event was sent.
It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.
$sel:attachments:Item', item_attachments - Provides information about the attachments.
$sel:content:Item', item_content - The content of the message or event.
Item, item_contentType - The type of content of the item.
$sel:displayName:Item', item_displayName - The chat display name of the sender.
$sel:id:Item', item_id - The ID of the item.
$sel:messageMetadata:Item', item_messageMetadata - The metadata related to the message. Currently this supports only
information related to message receipts.
$sel:participantId:Item', item_participantId - The ID of the sender in the session.
$sel:participantRole:Item', item_participantRole - The role of the sender. For example, is it a customer, agent, or system.
$sel:type':Item', item_type - Type of the item: message or event.
MessageMetadata
data MessageMetadata Source #
Contains metadata related to a message.
See: newMessageMetadata smart constructor.
Constructors
| MessageMetadata' (Maybe Text) (Maybe [Receipt]) |
Instances
newMessageMetadata :: MessageMetadata Source #
Create a value of MessageMetadata 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:messageId:MessageMetadata', messageMetadata_messageId - The identifier of the message that contains the metadata information.
$sel:receipts:MessageMetadata', messageMetadata_receipts - The list of receipt information for a message for different recipients.
Receipt
The receipt for the message delivered to the recipient.
See: newReceipt smart constructor.
Instances
| FromJSON Receipt Source # | |
| Generic Receipt Source # | |
| Read Receipt Source # | |
| Show Receipt Source # | |
| NFData Receipt Source # | |
Defined in Amazonka.ConnectParticipant.Types.Receipt | |
| Eq Receipt Source # | |
| Hashable Receipt Source # | |
Defined in Amazonka.ConnectParticipant.Types.Receipt | |
| type Rep Receipt Source # | |
Defined in Amazonka.ConnectParticipant.Types.Receipt type Rep Receipt = D1 ('MetaData "Receipt" "Amazonka.ConnectParticipant.Types.Receipt" "amazonka-connectparticipant-2.0-I4GmkIlwxQUGg1dW7eNFQJ" 'False) (C1 ('MetaCons "Receipt'" 'PrefixI 'True) (S1 ('MetaSel ('Just "deliveredTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "readTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "recipientParticipantId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) | |
newReceipt :: Receipt Source #
Create a value of Receipt 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:deliveredTimestamp:Receipt', receipt_deliveredTimestamp - The time when the message was delivered to the recipient.
$sel:readTimestamp:Receipt', receipt_readTimestamp - The time when the message was read by the recipient.
$sel:recipientParticipantId:Receipt', receipt_recipientParticipantId - The identifier of the recipient of the message.
StartPosition
data StartPosition Source #
A filtering option for where to start. For example, if you sent 100 messages, start with message 50.
See: newStartPosition smart constructor.
Instances
newStartPosition :: StartPosition Source #
Create a value of StartPosition 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:absoluteTime:StartPosition', startPosition_absoluteTime - The time in ISO format where to start.
It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.
$sel:id:StartPosition', startPosition_id - The ID of the message or event where to start.
$sel:mostRecent:StartPosition', startPosition_mostRecent - The start position of the most recent message where you want to start.
UploadMetadata
data UploadMetadata Source #
Fields to be used while uploading the attachment.
See: newUploadMetadata smart constructor.
Instances
newUploadMetadata :: UploadMetadata Source #
Create a value of UploadMetadata 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:headersToInclude:UploadMetadata', uploadMetadata_headersToInclude - The headers to be provided while uploading the file to the URL.
$sel:url:UploadMetadata', uploadMetadata_url - This is the pre-signed URL that can be used for uploading the file to
Amazon S3 when used in response to
StartAttachmentUpload.
$sel:urlExpiry:UploadMetadata', uploadMetadata_urlExpiry - The expiration time of the URL in ISO timestamp. It's specified in ISO
8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example,
2019-11-08T02:41:28.172Z.
Websocket
The websocket for the participant's connection.
See: newWebsocket smart constructor.
Constructors
| Websocket' (Maybe Text) (Maybe Text) |
Instances
| FromJSON Websocket Source # | |
| Generic Websocket Source # | |
| Read Websocket Source # | |
| Show Websocket Source # | |
| NFData Websocket Source # | |
Defined in Amazonka.ConnectParticipant.Types.Websocket | |
| Eq Websocket Source # | |
| Hashable Websocket Source # | |
Defined in Amazonka.ConnectParticipant.Types.Websocket | |
| type Rep Websocket Source # | |
Defined in Amazonka.ConnectParticipant.Types.Websocket type Rep Websocket = D1 ('MetaData "Websocket" "Amazonka.ConnectParticipant.Types.Websocket" "amazonka-connectparticipant-2.0-I4GmkIlwxQUGg1dW7eNFQJ" 'False) (C1 ('MetaCons "Websocket'" 'PrefixI 'True) (S1 ('MetaSel ('Just "connectionExpiry") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "url") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) | |
newWebsocket :: Websocket Source #
Create a value of Websocket 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:connectionExpiry:Websocket', websocket_connectionExpiry - The URL expiration timestamp in ISO date format.
It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.
$sel:url:Websocket', websocket_url - The URL of the websocket.