Serialized Form (AWS Java SDK for Amazon Interactive Video Service Chat 1.12.253 API)

Package com.amazonaws.services.ivschat.model
- Class com.amazonaws.services.ivschat.model.AccessDeniedException extends AmazonivschatException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.ivschat.model.AmazonivschatException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.ivschat.model.ConflictException extends AmazonivschatException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - resourceId
```
String resourceId
```
    - resourceType
```
String resourceType
```
- Class com.amazonaws.services.ivschat.model.CreateChatTokenRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - attributes
```
Map<K,V> attributes
```
      Application-provided attributes to encode into the token and attach to a chat session. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total.
    - capabilities
```
List<E> capabilities
```
      Set of capabilities that the user is allowed to perform in the room. Default: None (the capability to view messages is implicitly included in all requests).
    - roomIdentifier
```
String roomIdentifier
```
      Identifier of the room that the client is trying to access. Currently this must be an ARN.
    - sessionDurationInMinutes
```
Integer sessionDurationInMinutes
```
      Session duration (in minutes), after which the session expires. Default: 60 (1 hour).
    - userId
```
String userId
```
      Application-provided ID that uniquely identifies the user associated with this token. This can be any UTF-8 encoded text.
- Class com.amazonaws.services.ivschat.model.CreateChatTokenResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - sessionExpirationTime
```
Date sessionExpirationTime
```
      Time after which an end user's session is no longer valid. This is an ISO 8601 timestamp; note that this is returned as a string.
    - token
```
String token
```
      The issued client token, encrypted.
    - tokenExpirationTime
```
Date tokenExpirationTime
```
      Time after which the token is no longer valid and cannot be used to connect to a room. This is an ISO 8601 timestamp; note that this is returned as a string.
- Class com.amazonaws.services.ivschat.model.CreateRoomRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - maximumMessageLength
```
Integer maximumMessageLength
```
      Maximum number of characters in a single message. Messages are expected to be UTF-8 encoded and this limit applies specifically to rune/code-point count, not number of bytes. Default: 500.
    - maximumMessageRatePerSecond
```
Integer maximumMessageRatePerSecond
```
      Maximum number of messages per second that can be sent to the room (by all clients). Default: 10.
    - messageReviewHandler
```
MessageReviewHandler messageReviewHandler
```
      Configuration information for optional review of messages.
    - name
```
String name
```
      Room name. The value does not need to be unique.
    - tags
```
Map<K,V> tags
```
      Tags to attach to the resource. Array of maps, each of the form string:string (key:value).
- Class com.amazonaws.services.ivschat.model.CreateRoomResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      Room ARN, assigned by the system.
    - createTime
```
Date createTime
```
      Time when the room was created. This is an ISO 8601 timestamp; note that this is returned as a string.
    - id
```
String id
```
      Room ID, generated by the system. This is a relative identifier, the part of the ARN that uniquely identifies the room.
    - maximumMessageLength
```
Integer maximumMessageLength
```
      Maximum number of characters in a single message, from the request.
    - maximumMessageRatePerSecond
```
Integer maximumMessageRatePerSecond
```
      Maximum number of messages per second that can be sent to the room (by all clients), from the request.
    - messageReviewHandler
```
MessageReviewHandler messageReviewHandler
```
      Configuration information for optional review of messages.
    - name
```
String name
```
      Room name, from the request (if specified).
    - tags
```
Map<K,V> tags
```
      Tags attached to the resource, from the request.
    - updateTime
```
Date updateTime
```
      Time of the room’s last update. This is an ISO 8601 timestamp; note that this is returned as a string.
- Class com.amazonaws.services.ivschat.model.DeleteMessageRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - id
```
String id
```
      ID of the message to be deleted. This is the Id field in the received message (see Message (Subscribe) in the Chat Messaging API).
    - reason
```
String reason
```
      Reason for deleting the message.
    - roomIdentifier
```
String roomIdentifier
```
      Identifier of the room where the message should be deleted. Currently this must be an ARN.
- Class com.amazonaws.services.ivschat.model.DeleteMessageResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - id
```
String id
```
      Operation identifier, generated by Amazon IVS Chat.
- Class com.amazonaws.services.ivschat.model.DeleteRoomRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - identifier
```
String identifier
```
      Identifier of the room to be deleted. Currently this must be an ARN.
- Class com.amazonaws.services.ivschat.model.DeleteRoomResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.ivschat.model.DisconnectUserRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - reason
```
String reason
```
      Reason for disconnecting the user.
    - roomIdentifier
```
String roomIdentifier
```
      Identifier of the room from which the user's clients should be disconnected. Currently this must be an ARN.
    - userId
```
String userId
```
      ID of the user (connection) to disconnect from the room.
- Class com.amazonaws.services.ivschat.model.DisconnectUserResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.ivschat.model.GetRoomRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - identifier
```
String identifier
```
      Identifier of the room for which the configuration is to be retrieved. Currently this must be an ARN.
- Class com.amazonaws.services.ivschat.model.GetRoomResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      Room ARN, from the request (if identifier was an ARN).
    - createTime
```
Date createTime
```
      Time when the room was created. This is an ISO 8601 timestamp; note that this is returned as a string.
    - id
```
String id
```
      Room ID, generated by the system. This is a relative identifier, the part of the ARN that uniquely identifies the room.
    - maximumMessageLength
```
Integer maximumMessageLength
```
      Maximum number of characters in a single message. Messages are expected to be UTF-8 encoded and this limit applies specifically to rune/code-point count, not number of bytes. Default: 500.
    - maximumMessageRatePerSecond
```
Integer maximumMessageRatePerSecond
```
      Maximum number of messages per second that can be sent to the room (by all clients). Default: 10.
    - messageReviewHandler
```
MessageReviewHandler messageReviewHandler
```
      Configuration information for optional review of messages.
    - name
```
String name
```
      Room name. The value does not need to be unique.
    - tags
```
Map<K,V> tags
```
      Tags attached to the resource. Array of maps, each of the form string:string (key:value).
    - updateTime
```
Date updateTime
```
      Time of the room’s last update. This is an ISO 8601 timestamp; note that this is returned as a string.
- Class com.amazonaws.services.ivschat.model.InternalServerException extends AmazonivschatException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.ivschat.model.ListRoomsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - maxResults
```
Integer maxResults
```
      Maximum number of rooms to return. Default: 50.
    - messageReviewHandlerUri
```
String messageReviewHandlerUri
```
      Filters the list to match the specified message review handler URI.
    - name
```
String name
```
      Filters the list to match the specified room name.
    - nextToken
```
String nextToken
```
      The first room to retrieve. This is used for pagination; see the nextToken response field.
- Class com.amazonaws.services.ivschat.model.ListRoomsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - nextToken
```
String nextToken
```
      If there are more rooms than maxResults, use nextToken in the request to get the next set.
    - rooms
```
List<E> rooms
```
      List of the matching rooms (summary information only).
- Class com.amazonaws.services.ivschat.model.ListTagsForResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceArn
```
String resourceArn
```
      The ARN of the resource to be retrieved. The ARN must be URL-encoded.
- Class com.amazonaws.services.ivschat.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - tags
```
Map<K,V> tags
```
      Tags to attach to the resource. Array of maps, each of the form string:string (key:value).
- Class com.amazonaws.services.ivschat.model.MessageReviewHandler extends Object implements Serializable
  - Serialized Fields
    - fallbackResult
```
String fallbackResult
```
      Specifies the fallback behavior (whether the message is allowed or denied) if the handler does not return a valid response, encounters an error, or times out. (For the timeout period, see Service Quotas.) If allowed, the message is delivered with returned content to all users connected to the room. If denied, the message is not delivered to any user. Default: ALLOW.
    - uri
```
String uri
```
      Identifier of the message review handler. Currently this must be an ARN of a lambda function.
- Class com.amazonaws.services.ivschat.model.PendingVerificationException extends AmazonivschatException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.ivschat.model.ResourceNotFoundException extends AmazonivschatException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - resourceId
```
String resourceId
```
    - resourceType
```
String resourceType
```
- Class com.amazonaws.services.ivschat.model.RoomSummary extends Object implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      Room ARN.
    - createTime
```
Date createTime
```
      Time when the room was created. This is an ISO 8601 timestamp; note that this is returned as a string.
    - id
```
String id
```
      Room ID, generated by the system. This is a relative identifier, the part of the ARN that uniquely identifies the room.
    - messageReviewHandler
```
MessageReviewHandler messageReviewHandler
```
      Configuration information for optional review of messages.
    - name
```
String name
```
      Room name. The value does not need to be unique.
    - tags
```
Map<K,V> tags
```
      Tags attached to the resource.
    - updateTime
```
Date updateTime
```
      Time of the room’s last update. This is an ISO 8601 timestamp; note that this is returned as a string.
- Class com.amazonaws.services.ivschat.model.SendEventRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - attributes
```
Map<K,V> attributes
```
      Application-defined metadata to attach to the event sent to clients. The maximum length of the metadata is 1 KB total.
    - eventName
```
String eventName
```
      Application-defined name of the event to send to clients.
    - roomIdentifier
```
String roomIdentifier
```
      Identifier of the room to which the event will be sent. Currently this must be an ARN.
- Class com.amazonaws.services.ivschat.model.SendEventResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - id
```
String id
```
      An identifier generated by Amazon IVS Chat. This identifier must be used in subsequent operations for this message, such as DeleteMessage.
- Class com.amazonaws.services.ivschat.model.ServiceQuotaExceededException extends AmazonivschatException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - limit
```
Integer limit
```
    - resourceId
```
String resourceId
```
    - resourceType
```
String resourceType
```
- Class com.amazonaws.services.ivschat.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceArn
```
String resourceArn
```
      The ARN of the resource to be tagged. The ARN must be URL-encoded.
    - tags
```
Map<K,V> tags
```
      Array of tags to be added or updated.
- Class com.amazonaws.services.ivschat.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.ivschat.model.ThrottlingException extends AmazonivschatException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - limit
```
Integer limit
```
    - resourceId
```
String resourceId
```
    - resourceType
```
String resourceType
```
- Class com.amazonaws.services.ivschat.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceArn
```
String resourceArn
```
      The ARN of the resource to be untagged. The ARN must be URL-encoded.
    - tagKeys
```
List<E> tagKeys
```
      Array of tags to be removed.
- Class com.amazonaws.services.ivschat.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.ivschat.model.UpdateRoomRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - identifier
```
String identifier
```
      Identifier of the room to be updated. Currently this must be an ARN.
    - maximumMessageLength
```
Integer maximumMessageLength
```
      The maximum number of characters in a single message. Messages are expected to be UTF-8 encoded and this limit applies specifically to rune/code-point count, not number of bytes. Default: 500.
    - maximumMessageRatePerSecond
```
Integer maximumMessageRatePerSecond
```
      Maximum number of messages per second that can be sent to the room (by all clients). Default: 10.
    - messageReviewHandler
```
MessageReviewHandler messageReviewHandler
```
      Configuration information for optional review of messages. Specify an empty uri string to disassociate a message review handler from the specified room.
    - name
```
String name
```
      Room name. The value does not need to be unique.
- Class com.amazonaws.services.ivschat.model.UpdateRoomResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      Room ARN, from the request (if identifier was an ARN).
    - createTime
```
Date createTime
```
      Time when the room was created. This is an ISO 8601 timestamp; note that this is returned as a string.
    - id
```
String id
```
      Room ID, generated by the system. This is a relative identifier, the part of the ARN that uniquely identifies the room.
    - maximumMessageLength
```
Integer maximumMessageLength
```
      Maximum number of characters in a single message, from the request.
    - maximumMessageRatePerSecond
```
Integer maximumMessageRatePerSecond
```
      Maximum number of messages per second that can be sent to the room (by all clients), from the request.
    - messageReviewHandler
```
MessageReviewHandler messageReviewHandler
```
      Configuration information for optional review of messages.
    - name
```
String name
```
      Room name, from the request.
    - tags
```
Map<K,V> tags
```
      Tags attached to the resource.
    - updateTime
```
Date updateTime
```
      Time of the room’s last update. This is an ISO 8601 timestamp; note that this is returned as a string.
- Class com.amazonaws.services.ivschat.model.ValidationException extends AmazonivschatException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - fieldList
```
List<E> fieldList
```
    - reason
```
String reason
```
- Class com.amazonaws.services.ivschat.model.ValidationExceptionField extends Object implements Serializable
  - Serialized Fields
    - message
```
String message
```
      Explanation of the reason for the validation error.
    - name
```
String name
```
      Name of the field which failed validation.

Serialized Form

Package com.amazonaws.services.ivschat.model

Class com.amazonaws.services.ivschat.model.AccessDeniedException extends AmazonivschatException implements Serializable

Class com.amazonaws.services.ivschat.model.AmazonivschatException extends AmazonServiceException implements Serializable

Class com.amazonaws.services.ivschat.model.ConflictException extends AmazonivschatException implements Serializable

Serialized Fields

resourceId

resourceType

Class com.amazonaws.services.ivschat.model.CreateChatTokenRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attributes

capabilities

roomIdentifier

sessionDurationInMinutes

userId

Class com.amazonaws.services.ivschat.model.CreateChatTokenResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

sessionExpirationTime

token

tokenExpirationTime

Class com.amazonaws.services.ivschat.model.CreateRoomRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maximumMessageLength

maximumMessageRatePerSecond

messageReviewHandler

name

tags

Class com.amazonaws.services.ivschat.model.CreateRoomResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

arn

createTime

id

maximumMessageLength

maximumMessageRatePerSecond

messageReviewHandler

name

tags

updateTime

Class com.amazonaws.services.ivschat.model.DeleteMessageRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

id

reason

roomIdentifier

Class com.amazonaws.services.ivschat.model.DeleteMessageResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

id

Class com.amazonaws.services.ivschat.model.DeleteRoomRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

identifier

Class com.amazonaws.services.ivschat.model.DeleteRoomResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Class com.amazonaws.services.ivschat.model.DisconnectUserRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

reason

roomIdentifier

userId

Class com.amazonaws.services.ivschat.model.DisconnectUserResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Class com.amazonaws.services.ivschat.model.GetRoomRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

identifier

Class com.amazonaws.services.ivschat.model.GetRoomResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

arn

createTime

id

maximumMessageLength

maximumMessageRatePerSecond

messageReviewHandler

name

tags

updateTime

Class com.amazonaws.services.ivschat.model.InternalServerException extends AmazonivschatException implements Serializable

Class com.amazonaws.services.ivschat.model.ListRoomsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxResults

messageReviewHandlerUri

name

nextToken

Class com.amazonaws.services.ivschat.model.ListRoomsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

nextToken