Serialized Form (AWS Java SDK for Amazon Interactive Video Service RealTime 1.12.490 API)

Package com.amazonaws.services.ivsrealtime.model
- Class com.amazonaws.services.ivsrealtime.model.AccessDeniedException extends AmazonIVSRealTimeException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - exceptionMessage
```
String exceptionMessage
```
      User does not have sufficient access to perform this action.
- Class com.amazonaws.services.ivsrealtime.model.AmazonIVSRealTimeException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.ivsrealtime.model.ConflictException extends AmazonIVSRealTimeException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - exceptionMessage
```
String exceptionMessage
```
      Updating or deleting a resource can cause an inconsistent state.
- Class com.amazonaws.services.ivsrealtime.model.CreateParticipantTokenRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - attributes
```
Map<K,V> attributes
```
      Application-provided attributes to encode into the token and attach to a stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
    - capabilities
```
List<E> capabilities
```
      Set of capabilities that the user is allowed to perform in the stage. Default: PUBLISH, SUBSCRIBE.
    - duration
```
Integer duration
```
      Duration (in minutes), after which the token expires. Default: 720 (12 hours).
    - stageArn
```
String stageArn
```
      ARN of the stage to which this token is scoped.
    - userId
```
String userId
```
      Name that can be specified to help identify the token. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
- Class com.amazonaws.services.ivsrealtime.model.CreateParticipantTokenResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - participantToken
```
ParticipantToken participantToken
```
      The participant token that was created.
- Class com.amazonaws.services.ivsrealtime.model.CreateStageRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - name
```
String name
```
      Optional name that can be specified for the stage being created.
    - participantTokenConfigurations
```
List<E> participantTokenConfigurations
```
      Array of participant token configuration objects to attach to the new stage.
    - tags
```
Map<K,V> tags
```
      Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.
- Class com.amazonaws.services.ivsrealtime.model.CreateStageResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - participantTokens
```
List<E> participantTokens
```
      Participant tokens attached to the stage. These correspond to the participants in the request.
    - stage
```
Stage stage
```
      The stage that was created.
- Class com.amazonaws.services.ivsrealtime.model.DeleteStageRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      ARN of the stage to be deleted.
- Class com.amazonaws.services.ivsrealtime.model.DeleteStageResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.ivsrealtime.model.DisconnectParticipantRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - participantId
```
String participantId
```
      Identifier of the participant to be disconnected. This is assigned by IVS and returned by CreateParticipantToken.
    - reason
```
String reason
```
      Description of why this participant is being disconnected.
    - stageArn
```
String stageArn
```
      ARN of the stage to which the participant is attached.
- Class com.amazonaws.services.ivsrealtime.model.DisconnectParticipantResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.ivsrealtime.model.Event extends Object implements Serializable
  - Serialized Fields
    - errorCode
```
String errorCode
```
      If the event is an error event, the error code is provided to give insight into the specific error that occurred. If the event is not an error event, this field is null. INSUFFICIENT_CAPABILITIES indicates that the participant tried to take an action that the participant’s token is not allowed to do. For more information about participant capabilities, see the capabilities field in CreateParticipantToken.
    - eventTime
```
Date eventTime
```
      ISO 8601 timestamp (returned as a string) for when the event occurred.
    - name
```
String name
```
      The name of the event.
    - participantId
```
String participantId
```
      Unique identifier for the participant who triggered the event. This is assigned by IVS.
    - remoteParticipantId
```
String remoteParticipantId
```
      Unique identifier for the remote participant. For a subscribe event, this is the publisher. For a publish or join event, this is null. This is assigned by IVS.
- Class com.amazonaws.services.ivsrealtime.model.GetParticipantRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - participantId
```
String participantId
```
      Unique identifier for the participant. This is assigned by IVS and returned by CreateParticipantToken.
    - sessionId
```
String sessionId
```
      ID of a session within the stage.
    - stageArn
```
String stageArn
```
      Stage ARN.
- Class com.amazonaws.services.ivsrealtime.model.GetParticipantResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - participant
```
Participant participant
```
      The participant that is returned.
- Class com.amazonaws.services.ivsrealtime.model.GetStageRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      ARN of the stage for which the information is to be retrieved.
- Class com.amazonaws.services.ivsrealtime.model.GetStageResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - stage
```
Stage stage
```
      The stage that is returned.
- Class com.amazonaws.services.ivsrealtime.model.GetStageSessionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - sessionId
```
String sessionId
```
      ID of a session within the stage.
    - stageArn
```
String stageArn
```
      ARN of the stage for which the information is to be retrieved.
- Class com.amazonaws.services.ivsrealtime.model.GetStageSessionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - stageSession
```
StageSession stageSession
```
      The stage session that is returned.
- Class com.amazonaws.services.ivsrealtime.model.InternalServerException extends AmazonIVSRealTimeException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - exceptionMessage
```
String exceptionMessage
```
      Unexpected error during processing of request.
- Class com.amazonaws.services.ivsrealtime.model.ListParticipantEventsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - maxResults
```
Integer maxResults
```
      Maximum number of results to return. Default: 50.
    - nextToken
```
String nextToken
```
      The first participant to retrieve. This is used for pagination; see the nextToken response field.
    - participantId
```
String participantId
```
      Unique identifier for this participant. This is assigned by IVS and returned by CreateParticipantToken.
    - sessionId
```
String sessionId
```
      ID of a session within the stage.
    - stageArn
```
String stageArn
```
      Stage ARN.
- Class com.amazonaws.services.ivsrealtime.model.ListParticipantEventsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - events
```
List<E> events
```
      List of the matching events.
    - nextToken
```
String nextToken
```
      If there are more rooms than maxResults, use nextToken in the request to get the next set.
- Class com.amazonaws.services.ivsrealtime.model.ListParticipantsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - filterByPublished
```
Boolean filterByPublished
```
      Filters the response list to only show participants who published during the stage session. Only one of filterByUserId, filterByPublished, or filterByState can be provided per request.
    - filterByState
```
String filterByState
```
      Filters the response list to only show participants in the specified state. Only one of filterByUserId, filterByPublished, or filterByState can be provided per request.
    - filterByUserId
```
String filterByUserId
```
      Filters the response list to match the specified user ID. Only one of filterByUserId, filterByPublished, or filterByState can be provided per request. A userId is a customer-assigned name to help identify the token; this can be used to link a participant to a user in the customer’s own systems.
    - maxResults
```
Integer maxResults
```
      Maximum number of results to return. Default: 50.
    - nextToken
```
String nextToken
```
      The first participant to retrieve. This is used for pagination; see the nextToken response field.
    - sessionId
```
String sessionId
```
      ID of the session within the stage.
    - stageArn
```
String stageArn
```
      Stage ARN.
- Class com.amazonaws.services.ivsrealtime.model.ListParticipantsResult 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.
    - participants
```
List<E> participants
```
      List of the matching participants (summary information only).
- Class com.amazonaws.services.ivsrealtime.model.ListStageSessionsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - maxResults
```
Integer maxResults
```
      Maximum number of results to return. Default: 50.
    - nextToken
```
String nextToken
```
      The first stage to retrieve. This is used for pagination; see the nextToken response field.
    - stageArn
```
String stageArn
```
      Stage ARN.
- Class com.amazonaws.services.ivsrealtime.model.ListStageSessionsResult 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.
    - stageSessions
```
List<E> stageSessions
```
      List of matching stage sessions.
- Class com.amazonaws.services.ivsrealtime.model.ListStagesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - maxResults
```
Integer maxResults
```
      Maximum number of results to return. Default: 50.
    - nextToken
```
String nextToken
```
      The first stage to retrieve. This is used for pagination; see the nextToken response field.
- Class com.amazonaws.services.ivsrealtime.model.ListStagesResult 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.
    - stages
```
List<E> stages
```
      List of the matching stages (summary information only).
- Class com.amazonaws.services.ivsrealtime.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.ivsrealtime.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - tags
```
Map<K,V> tags
```
      Tags attached to the resource. Array of maps, each of the form string:string (key:value).
- Class com.amazonaws.services.ivsrealtime.model.Participant extends Object implements Serializable
  - Serialized Fields
    - attributes
```
Map<K,V> attributes
```
      Application-provided attributes to encode into the token and attach to a stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
    - firstJoinTime
```
Date firstJoinTime
```
      ISO 8601 timestamp (returned as a string) when the participant first joined the stage session.
    - participantId
```
String participantId
```
      Unique identifier for this participant, assigned by IVS.
    - published
```
Boolean published
```
      Whether the participant ever published to the stage session.
    - state
```
String state
```
      Whether the participant is connected to or disconnected from the stage.
    - userId
```
String userId
```
      Customer-assigned name to help identify the token; this can be used to link a participant to a user in the customer’s own systems. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
- Class com.amazonaws.services.ivsrealtime.model.ParticipantSummary extends Object implements Serializable
  - Serialized Fields
    - firstJoinTime
```
Date firstJoinTime
```
      ISO 8601 timestamp (returned as a string) when the participant first joined the stage session.
    - participantId
```
String participantId
```
      Unique identifier for this participant, assigned by IVS.
    - published
```
Boolean published
```
      Whether the participant ever published to the stage session.
    - state
```
String state
```
      Whether the participant is connected to or disconnected from the stage.
    - userId
```
String userId
```
      Customer-assigned name to help identify the token; this can be used to link a participant to a user in the customer’s own systems. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
- Class com.amazonaws.services.ivsrealtime.model.ParticipantToken extends Object implements Serializable
  - Serialized Fields
    - attributes
```
Map<K,V> attributes
```
      Application-provided attributes to encode into the token and attach to a stage. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
    - capabilities
```
List<E> capabilities
```
      Set of capabilities that the user is allowed to perform in the stage.
    - duration
```
Integer duration
```
      Duration (in minutes), after which the participant token expires. Default: 720 (12 hours).
    - expirationTime
```
Date expirationTime
```
      ISO 8601 timestamp (returned as a string) for when this token expires.
    - participantId
```
String participantId
```
      Unique identifier for this participant token, assigned by IVS.
    - token
```
String token
```
      The issued client token, encrypted.
    - userId
```
String userId
```
      Customer-assigned name to help identify the token; this can be used to link a participant to a user in the customer’s own systems. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
- Class com.amazonaws.services.ivsrealtime.model.ParticipantTokenConfiguration extends Object implements Serializable
  - Serialized Fields
    - attributes
```
Map<K,V> attributes
```
      Application-provided attributes to encode into the corresponding participant token and attach to a stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
    - capabilities
```
List<E> capabilities
```
      Set of capabilities that the user is allowed to perform in the stage.
    - duration
```
Integer duration
```
      Duration (in minutes), after which the corresponding participant token expires. Default: 720 (12 hours).
    - userId
```
String userId
```
      Customer-assigned name to help identify the token; this can be used to link a participant to a user in the customer’s own systems. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
- Class com.amazonaws.services.ivsrealtime.model.PendingVerificationException extends AmazonIVSRealTimeException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - exceptionMessage
```
String exceptionMessage
```
      Your account is pending verification.
- Class com.amazonaws.services.ivsrealtime.model.ResourceNotFoundException extends AmazonIVSRealTimeException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - exceptionMessage
```
String exceptionMessage
```
      Request references a resource which does not exist.
- Class com.amazonaws.services.ivsrealtime.model.ServiceQuotaExceededException extends AmazonIVSRealTimeException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - exceptionMessage
```
String exceptionMessage
```
      Request would cause a service quota to be exceeded.
- Class com.amazonaws.services.ivsrealtime.model.Stage extends Object implements Serializable
  - Serialized Fields
    - activeSessionId
```
String activeSessionId
```
      ID of the active session within the stage.
    - arn
```
String arn
```
      Stage ARN.
    - name
```
String name
```
      Stage name.
    - tags
```
Map<K,V> tags
```
      Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.
- Class com.amazonaws.services.ivsrealtime.model.StageSession extends Object implements Serializable
  - Serialized Fields
    - endTime
```
Date endTime
```
      ISO 8601 timestamp (returned as a string) when the stage session ended. This is null if the stage is active.
    - sessionId
```
String sessionId
```
      ID of the session within the stage.
    - startTime
```
Date startTime
```
      ISO 8601 timestamp (returned as a string) when this stage session began.
- Class com.amazonaws.services.ivsrealtime.model.StageSessionSummary extends Object implements Serializable
  - Serialized Fields
    - endTime
```
Date endTime
```
      ISO 8601 timestamp (returned as a string) when the stage session ended. This is null if the stage is active.
    - sessionId
```
String sessionId
```
      ID of the session within the stage.
    - startTime
```
Date startTime
```
      ISO 8601 timestamp (returned as a string) when this stage session began.
- Class com.amazonaws.services.ivsrealtime.model.StageSummary extends Object implements Serializable
  - Serialized Fields
    - activeSessionId
```
String activeSessionId
```
      ID of the active session within the stage.
    - arn
```
String arn
```
      Stage ARN.
    - name
```
String name
```
      Stage name.
    - tags
```
Map<K,V> tags
```
      Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.
- Class com.amazonaws.services.ivsrealtime.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. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints beyond what is documented there.
- Class com.amazonaws.services.ivsrealtime.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.ivsrealtime.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. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints beyond what is documented there.
- Class com.amazonaws.services.ivsrealtime.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.ivsrealtime.model.UpdateStageRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      ARN of the stage to be updated.
    - name
```
String name
```
      Name of the stage to be updated.
- Class com.amazonaws.services.ivsrealtime.model.UpdateStageResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - stage
```
Stage stage
```
      The updated stage.
- Class com.amazonaws.services.ivsrealtime.model.ValidationException extends AmazonIVSRealTimeException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - exceptionMessage
```
String exceptionMessage
```
      The input fails to satisfy the constraints specified by an Amazon Web Services service.

Serialized Form

Package com.amazonaws.services.ivsrealtime.model

Class com.amazonaws.services.ivsrealtime.model.AccessDeniedException extends AmazonIVSRealTimeException implements Serializable

Serialized Fields

exceptionMessage

Class com.amazonaws.services.ivsrealtime.model.AmazonIVSRealTimeException extends AmazonServiceException implements Serializable

Class com.amazonaws.services.ivsrealtime.model.ConflictException extends AmazonIVSRealTimeException implements Serializable

Serialized Fields

exceptionMessage

Class com.amazonaws.services.ivsrealtime.model.CreateParticipantTokenRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attributes

capabilities

duration

stageArn

userId

Class com.amazonaws.services.ivsrealtime.model.CreateParticipantTokenResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

participantToken

Class com.amazonaws.services.ivsrealtime.model.CreateStageRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

name

participantTokenConfigurations

tags

Class com.amazonaws.services.ivsrealtime.model.CreateStageResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

participantTokens

stage

Class com.amazonaws.services.ivsrealtime.model.DeleteStageRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

arn

Class com.amazonaws.services.ivsrealtime.model.DeleteStageResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

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

Serialized Fields

participantId

reason

stageArn

Class com.amazonaws.services.ivsrealtime.model.DisconnectParticipantResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Class com.amazonaws.services.ivsrealtime.model.Event extends Object implements Serializable

Serialized Fields

errorCode

eventTime

name

participantId

remoteParticipantId

Class com.amazonaws.services.ivsrealtime.model.GetParticipantRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

participantId

sessionId

stageArn

Class com.amazonaws.services.ivsrealtime.model.GetParticipantResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

participant

Class com.amazonaws.services.ivsrealtime.model.GetStageRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

arn

Class com.amazonaws.services.ivsrealtime.model.GetStageResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

stage

Class com.amazonaws.services.ivsrealtime.model.GetStageSessionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

sessionId

stageArn

Class com.amazonaws.services.ivsrealtime.model.GetStageSessionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

stageSession

Class com.amazonaws.services.ivsrealtime.model.InternalServerException extends AmazonIVSRealTimeException implements Serializable

Serialized Fields

exceptionMessage

Class com.amazonaws.services.ivsrealtime.model.ListParticipantEventsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxResults

nextToken

participantId

sessionId

stageArn

Class com.amazonaws.services.ivsrealtime.model.ListParticipantEventsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

events

nextToken