Serialized Form (aws-android-sdk-connectparticipant 2.81.1 API)

Package com.amazonaws.services.connectparticipant.model
- Class com.amazonaws.services.connectparticipant.model.AccessDeniedException extends com.amazonaws.AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.connectparticipant.model.AttachmentItem extends java.lang.Object implements Serializable
  - Serialized Fields
    - contentType
```
java.lang.String 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.
      
      Constraints:
      Length: 1 - 255
    - attachmentId
```
java.lang.String attachmentId
```
      A unique identifier for the attachment.
      
      Constraints:
      Length: 1 - 256
    - attachmentName
```
java.lang.String attachmentName
```
      A case-sensitive name of the attachment being uploaded.
      
      Constraints:
      Length: 1 - 256
    - status
```
java.lang.String status
```
      Status of the attachment.
      
      Constraints:
      Allowed Values: APPROVED, REJECTED, IN_PROGRESS
- Class com.amazonaws.services.connectparticipant.model.CompleteAttachmentUploadRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - attachmentIds
```
java.util.List<E> attachmentIds
```
      A list of unique identifiers for the attachments.
    - clientToken
```
java.lang.String 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.
      
      Constraints:
      Length: 1 - 500
    - connectionToken
```
java.lang.String connectionToken
```
      The authentication token associated with the participant's connection.
      
      Constraints:
      Length: 1 - 1000
- Class com.amazonaws.services.connectparticipant.model.CompleteAttachmentUploadResult extends java.lang.Object implements Serializable
- Class com.amazonaws.services.connectparticipant.model.ConflictException extends com.amazonaws.AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.connectparticipant.model.ConnectionCredentials extends java.lang.Object implements Serializable
  - Serialized Fields
    - connectionToken
```
java.lang.String connectionToken
```
      The connection token.
      
      Constraints:
      Length: 1 - 1000
    - expiry
```
java.lang.String 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.
- Class com.amazonaws.services.connectparticipant.model.CreateParticipantConnectionRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - type
```
java.util.List<E> type
```
      Type of connection information required. If you need CONNECTION_CREDENTIALS along with marking participant as connected, pass CONNECTION_CREDENTIALS in Type.
    - participantToken
```
java.lang.String participantToken
```
      This is a header parameter.
      
      The ParticipantToken as obtained from StartChatContact API response.
      
      Constraints:
      Length: 1 - 1000
    - connectParticipant
```
java.lang.Boolean connectParticipant
```
      Amazon Connect Participant is used to mark the participant as connected for customer participant in message streaming, as well as for agent or manager participant in non-streaming chats.
- Class com.amazonaws.services.connectparticipant.model.CreateParticipantConnectionResult extends java.lang.Object implements Serializable
  - Serialized Fields
    - websocket
```
Websocket websocket
```
      Creates the participant's websocket connection.
    - connectionCredentials
```
ConnectionCredentials connectionCredentials
```
      Creates the participant's connection credentials. The authentication token associated with the participant's connection.
- Class com.amazonaws.services.connectparticipant.model.DescribeViewRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - viewToken
```
java.lang.String viewToken
```
      An encrypted token originating from the interactive message of a ShowView block operation. Represents the desired view.
      
      Constraints:
      Length: 1 - 1000
    - connectionToken
```
java.lang.String connectionToken
```
      The connection token.
      
      Constraints:
      Length: 1 - 1000
- Class com.amazonaws.services.connectparticipant.model.DescribeViewResult extends java.lang.Object implements Serializable
  - Serialized Fields
    - view
```
View view
```
      A view resource object. Contains metadata and content necessary to render the view.
- Class com.amazonaws.services.connectparticipant.model.DisconnectParticipantRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - clientToken
```
java.lang.String 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.
      
      Constraints:
      Length: - 500
    - connectionToken
```
java.lang.String connectionToken
```
      The authentication token associated with the participant's connection.
      
      Constraints:
      Length: 1 - 1000
- Class com.amazonaws.services.connectparticipant.model.DisconnectParticipantResult extends java.lang.Object implements Serializable
- Class com.amazonaws.services.connectparticipant.model.GetAttachmentRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - attachmentId
```
java.lang.String attachmentId
```
      A unique identifier for the attachment.
      
      Constraints:
      Length: 1 - 256
    - connectionToken
```
java.lang.String connectionToken
```
      The authentication token associated with the participant's connection.
      
      Constraints:
      Length: 1 - 1000
- Class com.amazonaws.services.connectparticipant.model.GetAttachmentResult extends java.lang.Object implements Serializable
  - Serialized Fields
    - url
```
java.lang.String url
```
      This is the pre-signed URL that can be used for uploading the file to Amazon S3 when used in response to StartAttachmentUpload.
      
      Constraints:
      Length: 1 - 2000
    - urlExpiry
```
java.lang.String 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.
- Class com.amazonaws.services.connectparticipant.model.GetTranscriptRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - contactId
```
java.lang.String contactId
```
      The contactId from the current contact chain for which transcript is needed.
      
      Constraints:
      Length: 1 - 256
    - maxResults
```
java.lang.Integer maxResults
```
      The maximum number of results to return in the page. Default: 10.
      
      Constraints:
      Range: 0 - 100
    - nextToken
```
java.lang.String nextToken
```
      The pagination token. Use the value returned previously in the next subsequent request to retrieve the next set of results.
      
      Constraints:
      Length: 1 - 1000
    - scanDirection
```
java.lang.String scanDirection
```
      The direction from StartPosition from which to retrieve message. Default: BACKWARD when no StartPosition is provided, FORWARD with StartPosition.
      
      Constraints:
      Allowed Values: FORWARD, BACKWARD
    - sortOrder
```
java.lang.String sortOrder
```
      The sort order for the records. Default: DESCENDING.
      
      Constraints:
      Allowed Values: DESCENDING, ASCENDING
    - startPosition
```
StartPosition startPosition
```
      A filtering option for where to start.
    - connectionToken
```
java.lang.String connectionToken
```
      The authentication token associated with the participant's connection.
      
      Constraints:
      Length: 1 - 1000
- Class com.amazonaws.services.connectparticipant.model.GetTranscriptResult extends java.lang.Object implements Serializable
  - Serialized Fields
    - initialContactId
```
java.lang.String initialContactId
```
      The initial contact ID for the contact.
      
      Constraints:
      Length: 1 - 256
    - transcript
```
java.util.List<E> transcript
```
      The list of messages in the session.
    - nextToken
```
java.lang.String nextToken
```
      The pagination token. Use the value returned previously in the next subsequent request to retrieve the next set of results.
      
      Constraints:
      Length: 1 - 1000
- Class com.amazonaws.services.connectparticipant.model.InternalServerException extends com.amazonaws.AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.connectparticipant.model.Item extends java.lang.Object implements Serializable
  - Serialized Fields
    - absoluteTime
```
java.lang.String 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.
      
      Constraints:
      Length: 1 - 100
    - content
```
java.lang.String content
```
      The content of the message or event.
      
      Constraints:
      Length: 1 - 16384
    - contentType
```
java.lang.String contentType
```
      The type of content of the item.
      
      Constraints:
      Length: 1 - 100
    - id
```
java.lang.String id
```
      The ID of the item.
      
      Constraints:
      Length: 1 - 256
    - type
```
java.lang.String type
```
      Type of the item: message or event.
      
      Constraints:
      Allowed Values: TYPING, PARTICIPANT_JOINED, PARTICIPANT_LEFT, CHAT_ENDED, TRANSFER_SUCCEEDED, TRANSFER_FAILED, MESSAGE, EVENT, ATTACHMENT, CONNECTION_ACK, MESSAGE_DELIVERED, MESSAGE_READ
    - participantId
```
java.lang.String participantId
```
      The ID of the sender in the session.
      
      Constraints:
      Length: 1 - 256
    - displayName
```
java.lang.String displayName
```
      The chat display name of the sender.
      
      Constraints:
      Length: 1 - 256
    - participantRole
```
java.lang.String participantRole
```
      The role of the sender. For example, is it a customer, agent, or system.
      
      Constraints:
      Allowed Values: AGENT, CUSTOMER, SYSTEM, CUSTOM_BOT
    - attachments
```
java.util.List<E> attachments
```
      Provides information about the attachments.
    - messageMetadata
```
MessageMetadata messageMetadata
```
      The metadata related to the message. Currently this supports only information related to message receipts.
    - relatedContactId
```
java.lang.String relatedContactId
```
      The contactId on which the transcript item was originally sent. This field is only populated for persistent chats when the transcript item is from the past chat session. For more information, see Enable persistent chat.
      
      Constraints:
      Length: 1 - 256
    - contactId
```
java.lang.String contactId
```
      The contactId on which the transcript item was originally sent. This field is populated only when the transcript item is from the current chat session.
      
      Constraints:
      Length: 1 - 256
- Class com.amazonaws.services.connectparticipant.model.MessageMetadata extends java.lang.Object implements Serializable
  - Serialized Fields
    - messageId
```
java.lang.String messageId
```
      The identifier of the message that contains the metadata information.
      
      Constraints:
      Length: 1 - 256
    - receipts
```
java.util.List<E> receipts
```
      The list of receipt information for a message for different recipients.
- Class com.amazonaws.services.connectparticipant.model.Receipt extends java.lang.Object implements Serializable
  - Serialized Fields
    - deliveredTimestamp
```
java.lang.String deliveredTimestamp
```
      The time when the message was delivered to the recipient.
      
      Constraints:
      Length: 1 - 100
    - readTimestamp
```
java.lang.String readTimestamp
```
      The time when the message was read by the recipient.
      
      Constraints:
      Length: 1 - 100
    - recipientParticipantId
```
java.lang.String recipientParticipantId
```
      The identifier of the recipient of the message.
      
      Constraints:
      Length: 1 - 256
- Class com.amazonaws.services.connectparticipant.model.ResourceNotFoundException extends com.amazonaws.AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - resourceId
```
java.lang.String resourceId
```
      The identifier of the resource.
    - resourceType
```
java.lang.String resourceType
```
      The type of Amazon Connect resource.
      
      Constraints:
      Allowed Values: CONTACT, CONTACT_FLOW, INSTANCE, PARTICIPANT, HIERARCHY_LEVEL, HIERARCHY_GROUP, USER
- Class com.amazonaws.services.connectparticipant.model.SendEventRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - contentType
```
java.lang.String 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
      
      Constraints:
      Length: 1 - 100
    - content
```
java.lang.String 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\"}"
      
      Constraints:
      Length: 1 - 16384
    - clientToken
```
java.lang.String 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.
      
      Constraints:
      Length: - 500
    - connectionToken
```
java.lang.String connectionToken
```
      The authentication token associated with the participant's connection.
      
      Constraints:
      Length: 1 - 1000
- Class com.amazonaws.services.connectparticipant.model.SendEventResult extends java.lang.Object implements Serializable
  - Serialized Fields
    - id
```
java.lang.String id
```
      The ID of the response.
      
      Constraints:
      Length: 1 - 256
    - absoluteTime
```
java.lang.String 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.
      
      Constraints:
      Length: 1 - 100
- Class com.amazonaws.services.connectparticipant.model.SendMessageRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - contentType
```
java.lang.String contentType
```
      The type of the content. Supported types are text/plain, text/markdown, application/json, and application/vnd.amazonaws.connect.message.interactive.response .
      
      Constraints:
      Length: 1 - 100
    - content
```
java.lang.String content
```
      The content of the message.
      
      For text/plain and text/markdown, the Length Constraints are Minimum of 1, Maximum of 1024.
      
      For application/json, the Length Constraints are Minimum of 1, Maximum of 12000.
      
      For application/vnd.amazonaws.connect.message.interactive.response , the Length Constraints are Minimum of 1, Maximum of 12288.
      
      Constraints:
      Length: 1 - 16384
    - clientToken
```
java.lang.String 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.
      
      Constraints:
      Length: - 500
    - connectionToken
```
java.lang.String connectionToken
```
      The authentication token associated with the connection.
      
      Constraints:
      Length: 1 - 1000
- Class com.amazonaws.services.connectparticipant.model.SendMessageResult extends java.lang.Object implements Serializable
  - Serialized Fields
    - id
```
java.lang.String id
```
      The ID of the message.
      
      Constraints:
      Length: 1 - 256
    - absoluteTime
```
java.lang.String 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.
      
      Constraints:
      Length: 1 - 100
- Class com.amazonaws.services.connectparticipant.model.ServiceQuotaExceededException extends com.amazonaws.AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.connectparticipant.model.StartAttachmentUploadRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - contentType
```
java.lang.String 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.
      
      Constraints:
      Length: 1 - 255
    - attachmentSizeInBytes
```
java.lang.Long attachmentSizeInBytes
```
      The size of the attachment in bytes.
      
      Constraints:
      Range: 1 -
    - attachmentName
```
java.lang.String attachmentName
```
      A case-sensitive name of the attachment being uploaded.
      
      Constraints:
      Length: 1 - 256
    - clientToken
```
java.lang.String 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.
      
      Constraints:
      Length: 1 - 500
    - connectionToken
```
java.lang.String connectionToken
```
      The authentication token associated with the participant's connection.
      
      Constraints:
      Length: 1 - 1000
- Class com.amazonaws.services.connectparticipant.model.StartAttachmentUploadResult extends java.lang.Object implements Serializable
  - Serialized Fields
    - attachmentId
```
java.lang.String attachmentId
```
      A unique identifier for the attachment.
      
      Constraints:
      Length: 1 - 256
    - uploadMetadata
```
UploadMetadata uploadMetadata
```
      Fields to be used while uploading the attachment.
- Class com.amazonaws.services.connectparticipant.model.StartPosition extends java.lang.Object implements Serializable
  - Serialized Fields
    - id
```
java.lang.String id
```
      The ID of the message or event where to start.
      
      Constraints:
      Length: 1 - 256
    - absoluteTime
```
java.lang.String 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.
      
      Constraints:
      Length: 1 - 100
    - mostRecent
```
java.lang.Integer mostRecent
```
      The start position of the most recent message where you want to start.
      
      Constraints:
      Range: 0 - 100
- Class com.amazonaws.services.connectparticipant.model.ThrottlingException extends com.amazonaws.AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.connectparticipant.model.UploadMetadata extends java.lang.Object implements Serializable
  - Serialized Fields
    - url
```
java.lang.String url
```
      This is the pre-signed URL that can be used for uploading the file to Amazon S3 when used in response to StartAttachmentUpload.
      
      Constraints:
      Length: 1 - 2000
    - urlExpiry
```
java.lang.String 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.
    - headersToInclude
```
java.util.Map<K,V> headersToInclude
```
      The headers to be provided while uploading the file to the URL.
- Class com.amazonaws.services.connectparticipant.model.ValidationException extends com.amazonaws.AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.connectparticipant.model.View extends java.lang.Object implements Serializable
  - Serialized Fields
    - id
```
java.lang.String id
```
      The identifier of the view.
      
      Constraints:
      Length: 1 - 500
      Pattern: ^[a-zA-Z0-9\_\-:\/$]+$
    - arn
```
java.lang.String arn
```
      The Amazon Resource Name (ARN) of the view.
    - name
```
java.lang.String name
```
      The name of the view.
      
      Constraints:
      Length: 1 - 255
      Pattern: ^([\p{L}\p{N}_.:\/=+\-@()']+[\p{L}\p{Z}\p{N}_.:\/=+\-@()']*)$
    - version
```
java.lang.Integer version
```
      The current version of the view.
    - content
```
ViewContent content
```
      View content containing all content necessary to render a view except for runtime input data.
- Class com.amazonaws.services.connectparticipant.model.ViewContent extends java.lang.Object implements Serializable
  - Serialized Fields
    - inputSchema
```
java.lang.String inputSchema
```
      The schema representing the input data that the view template must be supplied to render.
    - template
```
java.lang.String template
```
      The view template representing the structure of the view.
    - actions
```
java.util.List<E> actions
```
      A list of actions possible from the view
- Class com.amazonaws.services.connectparticipant.model.Websocket extends java.lang.Object implements Serializable
  - Serialized Fields
    - url
```
java.lang.String url
```
      The URL of the websocket.
      
      Constraints:
      Length: 1 - 2000
    - connectionExpiry
```
java.lang.String 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.

Serialized Form

Package com.amazonaws.services.connectparticipant.model

Class com.amazonaws.services.connectparticipant.model.AccessDeniedException extends com.amazonaws.AmazonServiceException implements Serializable

Class com.amazonaws.services.connectparticipant.model.AttachmentItem extends java.lang.Object implements Serializable

Serialized Fields

contentType

attachmentId

attachmentName

status

Class com.amazonaws.services.connectparticipant.model.CompleteAttachmentUploadRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable

Serialized Fields

attachmentIds

clientToken

connectionToken

Class com.amazonaws.services.connectparticipant.model.CompleteAttachmentUploadResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.connectparticipant.model.ConflictException extends com.amazonaws.AmazonServiceException implements Serializable

Class com.amazonaws.services.connectparticipant.model.ConnectionCredentials extends java.lang.Object implements Serializable

Serialized Fields

connectionToken

expiry

Class com.amazonaws.services.connectparticipant.model.CreateParticipantConnectionRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable

Serialized Fields

type

participantToken

connectParticipant

Class com.amazonaws.services.connectparticipant.model.CreateParticipantConnectionResult extends java.lang.Object implements Serializable

Serialized Fields

websocket

connectionCredentials

Class com.amazonaws.services.connectparticipant.model.DescribeViewRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable

Serialized Fields

viewToken

connectionToken

Class com.amazonaws.services.connectparticipant.model.DescribeViewResult extends java.lang.Object implements Serializable

Serialized Fields

view

Class com.amazonaws.services.connectparticipant.model.DisconnectParticipantRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable

Serialized Fields

clientToken

connectionToken

Class com.amazonaws.services.connectparticipant.model.DisconnectParticipantResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.connectparticipant.model.GetAttachmentRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable

Serialized Fields

attachmentId

connectionToken

Class com.amazonaws.services.connectparticipant.model.GetAttachmentResult extends java.lang.Object implements Serializable

Serialized Fields

url

urlExpiry

Class com.amazonaws.services.connectparticipant.model.GetTranscriptRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable

Serialized Fields

contactId

maxResults

nextToken

scanDirection

sortOrder

startPosition

connectionToken

Class com.amazonaws.services.connectparticipant.model.GetTranscriptResult extends java.lang.Object implements Serializable

Serialized Fields

initialContactId

transcript

nextToken

Class com.amazonaws.services.connectparticipant.model.InternalServerException extends com.amazonaws.AmazonServiceException implements Serializable

Class com.amazonaws.services.connectparticipant.model.Item extends java.lang.Object implements Serializable

Serialized Fields

absoluteTime

content

contentType

id

type

participantId

displayName

participantRole

attachments

messageMetadata

relatedContactId

contactId

Class com.amazonaws.services.connectparticipant.model.MessageMetadata extends java.lang.Object implements Serializable

Serialized Fields