Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Synopsis
- defaultService :: Service
- _ValidationException :: AsError a => Getting (First ServiceError) a ServiceError
- _AccessDeniedException :: AsError a => Getting (First ServiceError) a ServiceError
- _ConflictException :: AsError a => Getting (First ServiceError) a ServiceError
- _ServiceQuotaExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _ThrottlingException :: AsError a => Getting (First ServiceError) a ServiceError
- _InternalServerException :: AsError a => Getting (First ServiceError) 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_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_status :: Lens' AttachmentItem (Maybe ArtifactStatus)
- attachmentItem_attachmentName :: Lens' AttachmentItem (Maybe Text)
- attachmentItem_attachmentId :: Lens' AttachmentItem (Maybe Text)
- attachmentItem_contentType :: Lens' AttachmentItem (Maybe Text)
- data ConnectionCredentials = ConnectionCredentials' {}
- newConnectionCredentials :: ConnectionCredentials
- connectionCredentials_expiry :: Lens' ConnectionCredentials (Maybe Text)
- connectionCredentials_connectionToken :: Lens' ConnectionCredentials (Maybe Text)
- data Item = Item' {}
- newItem :: Item
- item_participantId :: Lens' Item (Maybe Text)
- item_absoluteTime :: Lens' Item (Maybe Text)
- item_attachments :: Lens' Item (Maybe [AttachmentItem])
- item_participantRole :: Lens' Item (Maybe ParticipantRole)
- item_content :: Lens' Item (Maybe Text)
- item_id :: Lens' Item (Maybe Text)
- item_displayName :: Lens' Item (Maybe Text)
- item_type :: Lens' Item (Maybe ChatItemType)
- item_contentType :: Lens' Item (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_urlExpiry :: Lens' UploadMetadata (Maybe Text)
- uploadMetadata_headersToInclude :: Lens' UploadMetadata (Maybe (HashMap Text Text))
- uploadMetadata_url :: Lens' UploadMetadata (Maybe Text)
- data Websocket = Websocket' {}
- newWebsocket :: Websocket
- websocket_url :: Lens' Websocket (Maybe Text)
- websocket_connectionExpiry :: Lens' Websocket (Maybe Text)
Service Configuration
defaultService :: Service Source #
API version 2018-09-07
of the Amazon Connect Participant Service SDK configuration.
Errors
_ValidationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The input fails to satisfy the constraints specified by Amazon Connect.
_AccessDeniedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
You do not have sufficient access to perform this action.
_ConflictException :: AsError a => Getting (First ServiceError) a ServiceError Source #
An attachment with that identifier is already being uploaded.
_ServiceQuotaExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The number of attachments per contact exceeds the quota.
_ThrottlingException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request was denied due to request throttling.
_InternalServerException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception occurs when there is an internal failure in the Amazon Connect service.
ArtifactStatus
newtype ArtifactStatus Source #
pattern ArtifactStatus_APPROVED :: ArtifactStatus | |
pattern ArtifactStatus_IN_PROGRESS :: ArtifactStatus | |
pattern ArtifactStatus_REJECTED :: ArtifactStatus |
Instances
ChatItemType
newtype ChatItemType Source #
pattern ChatItemType_ATTACHMENT :: ChatItemType | |
pattern ChatItemType_CHAT_ENDED :: ChatItemType | |
pattern ChatItemType_CONNECTION_ACK :: ChatItemType | |
pattern ChatItemType_EVENT :: ChatItemType | |
pattern ChatItemType_MESSAGE :: 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 #
pattern ConnectionType_CONNECTION_CREDENTIALS :: ConnectionType | |
pattern ConnectionType_WEBSOCKET :: ConnectionType |
Instances
ParticipantRole
newtype ParticipantRole Source #
pattern ParticipantRole_AGENT :: ParticipantRole | |
pattern ParticipantRole_CUSTOMER :: ParticipantRole | |
pattern ParticipantRole_SYSTEM :: ParticipantRole |
Instances
ScanDirection
newtype ScanDirection Source #
pattern ScanDirection_BACKWARD :: ScanDirection | |
pattern ScanDirection_FORWARD :: ScanDirection |
Instances
SortKey
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.
AttachmentItem' | |
|
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:status:AttachmentItem'
, attachmentItem_status
- Status of the attachment.
$sel:attachmentName:AttachmentItem'
, attachmentItem_attachmentName
- A case-sensitive name of the attachment being uploaded.
$sel:attachmentId:AttachmentItem'
, attachmentItem_attachmentId
- A unique identifier for the attachment.
$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.
attachmentItem_status :: Lens' AttachmentItem (Maybe ArtifactStatus) Source #
Status of the attachment.
attachmentItem_attachmentName :: Lens' AttachmentItem (Maybe Text) Source #
A case-sensitive name of the attachment being uploaded.
attachmentItem_attachmentId :: Lens' AttachmentItem (Maybe Text) Source #
A unique identifier for the attachment.
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.
ConnectionCredentials
data ConnectionCredentials Source #
Connection credentials.
See: newConnectionCredentials
smart constructor.
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: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.
$sel:connectionToken:ConnectionCredentials'
, connectionCredentials_connectionToken
- 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.
connectionCredentials_connectionToken :: Lens' ConnectionCredentials (Maybe Text) Source #
The connection token.
Item
An item - message or event - that has been sent.
See: newItem
smart constructor.
Item' | |
|
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:participantId:Item'
, item_participantId
- The ID of the sender in the session.
$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:participantRole:Item'
, item_participantRole
- The role of the sender. For example, is it a customer, agent, or system.
$sel:content:Item'
, item_content
- The content of the message or event.
$sel:id:Item'
, item_id
- The ID of the item.
$sel:displayName:Item'
, item_displayName
- The chat display name of the sender.
$sel:type':Item'
, item_type
- Type of the item: message or event.
$sel:contentType:Item'
, item_contentType
- The type of content of the item.
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_participantRole :: Lens' Item (Maybe ParticipantRole) Source #
The role of the sender. For example, is it a customer, agent, or system.
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.
StartPosition' | |
|
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.
UploadMetadata' | |
|
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: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.
$sel:headersToInclude:UploadMetadata'
, uploadMetadata_headersToInclude
- The headers to be provided while uploading the file to the URL.
$sel:url:UploadMetadata'
, uploadMetadata_url
- The pre-signed URL using which file would be downloaded from Amazon S3
by the API caller.
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.
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 #
The pre-signed URL using which file would be downloaded from Amazon S3 by the API caller.
Websocket
The websocket for the participant's connection.
See: newWebsocket
smart constructor.
Instances
Eq Websocket Source # | |
Read Websocket Source # | |
Show Websocket Source # | |
Generic Websocket Source # | |
NFData Websocket Source # | |
Defined in Amazonka.ConnectParticipant.Types.Websocket | |
Hashable Websocket Source # | |
Defined in Amazonka.ConnectParticipant.Types.Websocket | |
FromJSON Websocket Source # | |
type Rep Websocket Source # | |
Defined in Amazonka.ConnectParticipant.Types.Websocket type Rep Websocket = D1 ('MetaData "Websocket" "Amazonka.ConnectParticipant.Types.Websocket" "libZSservicesZSamazonka-connectparticipantZSamazonka-connectparticipant" 'False) (C1 ('MetaCons "Websocket'" 'PrefixI 'True) (S1 ('MetaSel ('Just "url") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "connectionExpiry") '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:url:Websocket'
, websocket_url
- The URL of the websocket.
$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.