Serialized Form (AWS Java SDK for Amazon Interactive Video Service RealTime 1.12.716 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.ChannelDestinationConfiguration extends Object implements Serializable
  - Serialized Fields
    - channelArn
```
String channelArn
```
      ARN of the channel to use for broadcasting. The channel and stage resources must be in the same AWS account and region. The channel must be offline (not broadcasting).
    - encoderConfigurationArn
```
String encoderConfigurationArn
```
      ARN of the EncoderConfiguration resource. The encoder configuration and stage resources must be in the same AWS account and region.
- Class com.amazonaws.services.ivsrealtime.model.Composition extends Object implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      ARN of the Composition resource.
    - destinations
```
List<E> destinations
```
      Array of Destination objects. A Composition can contain either one destination (channel or s3) or two (one channel and one s3).
    - endTime
```
Date endTime
```
      UTC time of the Composition end. This is an ISO 8601 timestamp; note that this is returned as a string.
    - layout
```
LayoutConfiguration layout
```
      Layout object to configure composition parameters.
    - stageArn
```
String stageArn
```
      ARN of the stage used as input
    - startTime
```
Date startTime
```
      UTC time of the Composition start. This is an ISO 8601 timestamp; note that this is returned as a string.
    - state
```
String state
```
      State of the Composition.
    - 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.CompositionSummary extends Object implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      ARN of the Composition resource.
    - destinations
```
List<E> destinations
```
      Array of Destination objects.
    - endTime
```
Date endTime
```
      UTC time of the Composition end. This is an ISO 8601 timestamp; note that this is returned as a string.
    - stageArn
```
String stageArn
```
      ARN of the attached stage.
    - startTime
```
Date startTime
```
      UTC time of the Composition start. This is an ISO 8601 timestamp; note that this is returned as a string.
    - state
```
String state
```
      State of the Composition resource.
    - 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.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.CreateEncoderConfigurationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - name
```
String name
```
      Optional name to identify the resource.
    - 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.
    - video
```
Video video
```
      Video configuration. Default: video resolution 1280x720, bitrate 2500 kbps, 30 fps.
- Class com.amazonaws.services.ivsrealtime.model.CreateEncoderConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - encoderConfiguration
```
EncoderConfiguration encoderConfiguration
```
      The EncoderConfiguration that was created.
- 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.CreateStorageConfigurationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - name
```
String name
```
      Storage configuration name. The value does not need to be unique.
    - s3
```
S3StorageConfiguration s3
```
      A complex type that contains a storage configuration for where recorded video will be stored.
    - 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.CreateStorageConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - storageConfiguration
```
StorageConfiguration storageConfiguration
```
      The StorageConfiguration that was created.
- Class com.amazonaws.services.ivsrealtime.model.DeleteEncoderConfigurationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      ARN of the EncoderConfiguration.
- Class com.amazonaws.services.ivsrealtime.model.DeleteEncoderConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- 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.DeleteStorageConfigurationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      ARN of the storage configuration to be deleted.
- Class com.amazonaws.services.ivsrealtime.model.DeleteStorageConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.ivsrealtime.model.Destination extends Object implements Serializable
  - Serialized Fields
    - configuration
```
DestinationConfiguration configuration
```
      Configuration used to create this destination.
    - detail
```
DestinationDetail detail
```
      Optional details regarding the status of the destination.
    - endTime
```
Date endTime
```
      UTC time of the destination end. This is an ISO 8601 timestamp; note that this is returned as a string.
    - id
```
String id
```
      Unique identifier for this destination, assigned by IVS.
    - startTime
```
Date startTime
```
      UTC time of the destination start. This is an ISO 8601 timestamp; note that this is returned as a string.
    - state
```
String state
```
      State of the Composition Destination.
- Class com.amazonaws.services.ivsrealtime.model.DestinationConfiguration extends Object implements Serializable
  - Serialized Fields
    - channel
```
ChannelDestinationConfiguration channel
```
      An IVS channel to be used for broadcasting, for server-side composition. Either a channel or an s3 must be specified.
    - name
```
String name
```
      Name that can be specified to help identify the destination.
    - s3
```
S3DestinationConfiguration s3
```
      An S3 storage configuration to be used for recording video data. Either a channel or an s3 must be specified.
- Class com.amazonaws.services.ivsrealtime.model.DestinationDetail extends Object implements Serializable
  - Serialized Fields
    - s3
```
S3Detail s3
```
      An S3 detail object to return information about the S3 destination.
- Class com.amazonaws.services.ivsrealtime.model.DestinationSummary extends Object implements Serializable
  - Serialized Fields
    - endTime
```
Date endTime
```
      UTC time of the destination end. This is an ISO 8601 timestamp; note that this is returned as a string.
    - id
```
String id
```
      Unique identifier for this destination, assigned by IVS.
    - startTime
```
Date startTime
```
      UTC time of the destination start. This is an ISO 8601 timestamp; note that this is returned as a string.
    - state
```
String state
```
      State of the Composition Destination.
- 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.EncoderConfiguration extends Object implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      ARN of the EncoderConfiguration resource.
    - name
```
String name
```
      Optional name to identify the resource.
    - 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.
    - video
```
Video video
```
      Video configuration. Default: video resolution 1280x720, bitrate 2500 kbps, 30 fps
- Class com.amazonaws.services.ivsrealtime.model.EncoderConfigurationSummary extends Object implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      ARN of the EncoderConfiguration resource.
    - name
```
String name
```
      Optional name to identify the resource.
    - 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.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. QUOTA_EXCEEDED indicates that the number of participants who want to publish/subscribe to a stage exceeds the quota; for more information, see Service Quotas. PUBLISHER_NOT_FOUND indicates that the participant tried to subscribe to a publisher that doesn’t exist.
    - 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.GetCompositionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      ARN of the Composition resource.
- Class com.amazonaws.services.ivsrealtime.model.GetCompositionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - composition
```
Composition composition
```
      The Composition that was returned.
- Class com.amazonaws.services.ivsrealtime.model.GetEncoderConfigurationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      ARN of the EncoderConfiguration resource.
- Class com.amazonaws.services.ivsrealtime.model.GetEncoderConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - encoderConfiguration
```
EncoderConfiguration encoderConfiguration
```
      The EncoderConfiguration that was returned.
- 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.GetStorageConfigurationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      ARN of the storage configuration to be retrieved.
- Class com.amazonaws.services.ivsrealtime.model.GetStorageConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - storageConfiguration
```
StorageConfiguration storageConfiguration
```
      The StorageConfiguration that was returned.
- Class com.amazonaws.services.ivsrealtime.model.GridConfiguration extends Object implements Serializable
  - Serialized Fields
    - featuredParticipantAttribute
```
String featuredParticipantAttribute
```
      This attribute name identifies the featured slot. A participant with this attribute set to "true" (as a string value) in ParticipantTokenConfiguration is placed in the featured slot.
    - gridGap
```
Integer gridGap
```
      Specifies the spacing between participant tiles in pixels. Default: 2.
    - omitStoppedVideo
```
Boolean omitStoppedVideo
```
      Determines whether to omit participants with stopped video in the composition. Default: false.
    - videoAspectRatio
```
String videoAspectRatio
```
      Sets the non-featured participant display mode. Default: VIDEO.
    - videoFillMode
```
String videoFillMode
```
      Defines how video fits within the participant tile. When not set, videoFillMode defaults to COVER fill mode for participants in the grid and to CONTAIN fill mode for featured participants.
- 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.LayoutConfiguration extends Object implements Serializable
  - Serialized Fields
    - grid
```
GridConfiguration grid
```
      Configuration related to grid layout. Default: Grid layout.
    - pip
```
PipConfiguration pip
```
      Configuration related to PiP layout.
- Class com.amazonaws.services.ivsrealtime.model.ListCompositionsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - filterByEncoderConfigurationArn
```
String filterByEncoderConfigurationArn
```
      Filters the Composition list to match the specified EncoderConfiguration attached to at least one of its output.
    - filterByStageArn
```
String filterByStageArn
```
      Filters the Composition list to match the specified Stage ARN.
    - maxResults
```
Integer maxResults
```
      Maximum number of results to return. Default: 100.
    - nextToken
```
String nextToken
```
      The first Composition to retrieve. This is used for pagination; see the nextToken response field.
- Class com.amazonaws.services.ivsrealtime.model.ListCompositionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - compositions
```
List<E> compositions
```
      List of the matching Compositions (summary information only).
    - nextToken
```
String nextToken
```
      If there are more compositions than maxResults, use nextToken in the request to get the next set.
- Class com.amazonaws.services.ivsrealtime.model.ListEncoderConfigurationsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - maxResults
```
Integer maxResults
```
      Maximum number of results to return. Default: 100.
    - nextToken
```
String nextToken
```
      The first encoder configuration to retrieve. This is used for pagination; see the nextToken response field.
- Class com.amazonaws.services.ivsrealtime.model.ListEncoderConfigurationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - encoderConfigurations
```
List<E> encoderConfigurations
```
      List of the matching EncoderConfigurations (summary information only).
    - nextToken
```
String nextToken
```
      If there are more encoder configurations than maxResults, use nextToken in the request to get the next set.
- 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 event 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 events 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 participants 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 session 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 stage sessions 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 stages 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.ListStorageConfigurationsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - maxResults
```
Integer maxResults
```
      Maximum number of storage configurations to return. Default: your service quota or 100, whichever is smaller.
    - nextToken
```
String nextToken
```
      The first storage configuration to retrieve. This is used for pagination; see the nextToken response field.
- Class com.amazonaws.services.ivsrealtime.model.ListStorageConfigurationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - nextToken
```
String nextToken
```
      If there are more storage configurations than maxResults, use nextToken in the request to get the next set.
    - storageConfigurations
```
List<E> storageConfigurations
```
      List of the matching storage configurations.
- 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.
    - browserName
```
String browserName
```
      The participant’s browser.
    - browserVersion
```
String browserVersion
```
      The participant’s browser version.
    - firstJoinTime
```
Date firstJoinTime
```
      ISO 8601 timestamp (returned as a string) when the participant first joined the stage session.
    - ispName
```
String ispName
```
      The participant’s Internet Service Provider.
    - osName
```
String osName
```
      The participant’s operating system.
    - osVersion
```
String osVersion
```
      The participant’s operating system version.
    - participantId
```
String participantId
```
      Unique identifier for this participant, assigned by IVS.
    - published
```
Boolean published
```
      Whether the participant ever published to the stage session.
    - sdkVersion
```
String sdkVersion
```
      The participant’s SDK version.
    - 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.PipConfiguration extends Object implements Serializable
  - Serialized Fields
    - featuredParticipantAttribute
```
String featuredParticipantAttribute
```
      This attribute name identifies the featured slot. A participant with this attribute set to "true" (as a string value) in ParticipantTokenConfiguration is placed in the featured slot.
    - gridGap
```
Integer gridGap
```
      Specifies the spacing between participant tiles in pixels. Default: 0.
    - omitStoppedVideo
```
Boolean omitStoppedVideo
```
      Determines whether to omit participants with stopped video in the composition. Default: false.
    - pipBehavior
```
String pipBehavior
```
      Defines PiP behavior when all participants have left. Default: STATIC.
    - pipHeight
```
Integer pipHeight
```
      Specifies the height of the PiP window in pixels. When this is not set explicitly, pipHeight’s value will be based on the size of the composition and the aspect ratio of the participant’s video.
    - pipOffset
```
Integer pipOffset
```
      Sets the PiP window’s offset position in pixels from the closest edges determined by PipPosition. Default: 0.
    - pipParticipantAttribute
```
String pipParticipantAttribute
```
      Identifies the PiP slot. A participant with this attribute set to "true" (as a string value) in ParticipantTokenConfiguration is placed in the PiP slot.
    - pipPosition
```
String pipPosition
```
      Determines the corner position of the PiP window. Default: BOTTOM_RIGHT.
    - pipWidth
```
Integer pipWidth
```
      Specifies the width of the PiP window in pixels. When this is not set explicitly, pipWidth’s value will be based on the size of the composition and the aspect ratio of the participant’s video.
    - videoFillMode
```
String videoFillMode
```
      Defines how video fits within the participant tile. Default: COVER.
- Class com.amazonaws.services.ivsrealtime.model.RecordingConfiguration extends Object implements Serializable
  - Serialized Fields
    - format
```
String format
```
      The recording format for storing a recording in Amazon S3.
- 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.S3DestinationConfiguration extends Object implements Serializable
  - Serialized Fields
    - encoderConfigurationArns
```
List<E> encoderConfigurationArns
```
      ARNs of the EncoderConfiguration resource. The encoder configuration and stage resources must be in the same AWS account and region.
    - recordingConfiguration
```
RecordingConfiguration recordingConfiguration
```
      Array of maps, each of the form string:string (key:value). This is an optional customer specification, currently used only to specify the recording format for storing a recording in Amazon S3.
    - storageConfigurationArn
```
String storageConfigurationArn
```
      ARN of the StorageConfiguration where recorded videos will be stored.
- Class com.amazonaws.services.ivsrealtime.model.S3Detail extends Object implements Serializable
  - Serialized Fields
    - recordingPrefix
```
String recordingPrefix
```
      The S3 bucket prefix under which the recording is stored.
- Class com.amazonaws.services.ivsrealtime.model.S3StorageConfiguration extends Object implements Serializable
  - Serialized Fields
    - bucketName
```
String bucketName
```
      Location (S3 bucket name) where recorded videos will be stored. Note that the StorageConfiguration and S3 bucket must be in the same region as the Composition.
- 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.StartCompositionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - destinations
```
List<E> destinations
```
      Array of destination configuration.
    - idempotencyToken
```
String idempotencyToken
```
      Idempotency token.
    - layout
```
LayoutConfiguration layout
```
      Layout object to configure composition parameters.
    - stageArn
```
String stageArn
```
      ARN of the stage to be used for compositing.
    - 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.StartCompositionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - composition
```
Composition composition
```
      The Composition that was created.
- Class com.amazonaws.services.ivsrealtime.model.StopCompositionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      ARN of the Composition.
- Class com.amazonaws.services.ivsrealtime.model.StopCompositionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.ivsrealtime.model.StorageConfiguration extends Object implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      ARN of the storage configuration.
    - name
```
String name
```
      Name of the storage configuration.
    - s3
```
S3StorageConfiguration s3
```
      An S3 destination configuration where recorded videos will be stored.
    - 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.StorageConfigurationSummary extends Object implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      ARN of the storage configuration.
    - name
```
String name
```
      Name of the storage configuration.
    - s3
```
S3StorageConfiguration s3
```
      An S3 destination configuration where recorded videos will be stored.
    - 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.
- Class com.amazonaws.services.ivsrealtime.model.Video extends Object implements Serializable
  - Serialized Fields
    - bitrate
```
Integer bitrate
```
      Bitrate for generated output, in bps. Default: 2500000.
    - framerate
```
Float framerate
```
      Video frame rate, in fps. Default: 30.
    - height
```
Integer height
```
      Video-resolution height. Note that the maximum value is determined by width times height, such that the maximum total pixels is 2073600 (1920x1080 or 1080x1920). Default: 720.
    - width
```
Integer width
```
      Video-resolution width. Note that the maximum value is determined by width times height , such that the maximum total pixels is 2073600 (1920x1080 or 1080x1920). Default: 1280.

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.ChannelDestinationConfiguration extends Object implements Serializable

Serialized Fields

channelArn

encoderConfigurationArn

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

Serialized Fields

arn

destinations

endTime

layout

stageArn

startTime

state

tags

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

Serialized Fields

arn

destinations

endTime

stageArn

startTime

state

tags

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

Serialized Fields

exceptionMessage

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

Serialized Fields

name

tags

video

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

Serialized Fields

encoderConfiguration

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.CreateStorageConfigurationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

name

s3

tags

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

Serialized Fields

storageConfiguration

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

Serialized Fields

arn

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

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.DeleteStorageConfigurationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

arn

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

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