| 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.Types
Description
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
- 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' {}
- newAttachmentItem :: AttachmentItem
- attachmentItem_attachmentId :: Lens' AttachmentItem (Maybe Text)
- attachmentItem_attachmentName :: Lens' AttachmentItem (Maybe Text)
- attachmentItem_contentType :: Lens' AttachmentItem (Maybe Text)
- attachmentItem_status :: Lens' AttachmentItem (Maybe ArtifactStatus)
- data ConnectionCredentials = ConnectionCredentials' {}
- newConnectionCredentials :: ConnectionCredentials
- connectionCredentials_connectionToken :: Lens' ConnectionCredentials (Maybe Text)
- connectionCredentials_expiry :: Lens' ConnectionCredentials (Maybe Text)
- data Item = Item' {}
- newItem :: Item
- item_absoluteTime :: Lens' Item (Maybe Text)
- item_attachments :: Lens' Item (Maybe [AttachmentItem])
- item_content :: Lens' Item (Maybe Text)
- item_contentType :: Lens' Item (Maybe Text)
- item_displayName :: Lens' Item (Maybe Text)
- item_id :: Lens' Item (Maybe Text)
- item_messageMetadata :: Lens' Item (Maybe MessageMetadata)
- item_participantId :: Lens' Item (Maybe Text)
- item_participantRole :: Lens' Item (Maybe ParticipantRole)
- item_type :: Lens' Item (Maybe ChatItemType)
- data MessageMetadata = MessageMetadata' {}
- newMessageMetadata :: MessageMetadata
- messageMetadata_messageId :: Lens' MessageMetadata (Maybe Text)
- messageMetadata_receipts :: Lens' MessageMetadata (Maybe [Receipt])
- data Receipt = Receipt' {}
- newReceipt :: Receipt
- receipt_deliveredTimestamp :: Lens' Receipt (Maybe Text)
- receipt_readTimestamp :: Lens' Receipt (Maybe Text)
- receipt_recipientParticipantId :: Lens' Receipt (Maybe Text)
- data StartPosition = StartPosition' {
- absoluteTime :: Maybe Text
- id :: Maybe Text
- mostRecent :: Maybe Natural
- newStartPosition :: StartPosition
- startPosition_absoluteTime :: Lens' StartPosition (Maybe Text)
- startPosition_id :: Lens' StartPosition (Maybe Text)
- startPosition_mostRecent :: Lens' StartPosition (Maybe Natural)
- data UploadMetadata = UploadMetadata' {}
- newUploadMetadata :: UploadMetadata
- uploadMetadata_headersToInclude :: Lens' UploadMetadata (Maybe (HashMap Text Text))
- uploadMetadata_url :: Lens' UploadMetadata (Maybe Text)
- uploadMetadata_urlExpiry :: Lens' UploadMetadata (Maybe Text)
- data Websocket = Websocket' {}
- newWebsocket :: Websocket
- websocket_connectionExpiry :: Lens' Websocket (Maybe Text)
- websocket_url :: Lens' Websocket (Maybe Text)
Service Configuration
defaultService :: Service Source #
API version 2018-09-07 of the Amazon Connect Participant Service SDK configuration.
Errors
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
You do not have sufficient access to perform this action.
_ConflictException :: AsError a => Fold a ServiceError Source #
An attachment with that identifier is already being uploaded.
_InternalServerException :: AsError a => Fold a ServiceError Source #
This exception occurs when there is an internal failure in the Amazon Connect service.
_ServiceQuotaExceededException :: AsError a => Fold a ServiceError Source #
The number of attachments per contact exceeds the quota.
_ThrottlingException :: AsError a => Fold a ServiceError Source #
The request was denied due to request throttling.
_ValidationException :: AsError a => Fold a ServiceError Source #
The input fails to satisfy the constraints specified by Amazon Connect.
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' | |
Fields
| |
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.
attachmentItem_attachmentId :: Lens' AttachmentItem (Maybe Text) Source #
A unique identifier for the attachment.
attachmentItem_attachmentName :: Lens' AttachmentItem (Maybe Text) Source #
A case-sensitive name of the attachment being uploaded.
attachmentItem_contentType :: Lens' AttachmentItem (Maybe Text) Source #
Describes the MIME file type of the attachment. For a list of supported file types, see Feature specifications in the Amazon Connect Administrator Guide.
attachmentItem_status :: Lens' AttachmentItem (Maybe ArtifactStatus) Source #
Status of the attachment.
ConnectionCredentials
data ConnectionCredentials Source #
Connection credentials.
See: newConnectionCredentials smart constructor.
Constructors
| ConnectionCredentials' | |
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.
connectionCredentials_connectionToken :: Lens' ConnectionCredentials (Maybe Text) Source #
The connection token.
connectionCredentials_expiry :: Lens' ConnectionCredentials (Maybe Text) Source #
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' | |
Fields
| |
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.
item_absoluteTime :: Lens' Item (Maybe Text) Source #
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.
item_attachments :: Lens' Item (Maybe [AttachmentItem]) Source #
Provides information about the attachments.
item_messageMetadata :: Lens' Item (Maybe MessageMetadata) Source #
The metadata related to the message. Currently this supports only information related to message receipts.
item_participantRole :: Lens' Item (Maybe ParticipantRole) Source #
The role of the sender. For example, is it a customer, agent, or system.
MessageMetadata
data MessageMetadata Source #
Contains metadata related to a message.
See: newMessageMetadata smart constructor.
Constructors
| MessageMetadata' | |
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.
messageMetadata_messageId :: Lens' MessageMetadata (Maybe Text) Source #
The identifier of the message that contains the metadata information.
messageMetadata_receipts :: Lens' MessageMetadata (Maybe [Receipt]) Source #
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.
Constructors
| Receipt' | |
Fields
| |
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.
receipt_deliveredTimestamp :: Lens' Receipt (Maybe Text) Source #
The time when the message was delivered to the recipient.
receipt_readTimestamp :: Lens' Receipt (Maybe Text) Source #
The time when the message was read by the recipient.
receipt_recipientParticipantId :: Lens' Receipt (Maybe Text) Source #
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.
Constructors
| StartPosition' | |
Fields
| |
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.
startPosition_absoluteTime :: Lens' StartPosition (Maybe Text) Source #
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.
startPosition_id :: Lens' StartPosition (Maybe Text) Source #
The ID of the message or event where to start.
startPosition_mostRecent :: Lens' StartPosition (Maybe Natural) Source #
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.
Constructors
| UploadMetadata' | |
Fields
| |
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.
uploadMetadata_headersToInclude :: Lens' UploadMetadata (Maybe (HashMap Text Text)) Source #
The headers to be provided while uploading the file to the URL.
uploadMetadata_url :: Lens' UploadMetadata (Maybe Text) Source #
This is the pre-signed URL that can be used for uploading the file to Amazon S3 when used in response to StartAttachmentUpload.
uploadMetadata_urlExpiry :: Lens' UploadMetadata (Maybe Text) Source #
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' | |
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.