Serialized Form (AWS Java SDK for Amazon Interactive Video 1.12.427 API)

Package com.amazonaws.services.ivs.model
- Class com.amazonaws.services.ivs.model.AccessDeniedException extends AmazonIVSException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - exceptionMessage
```
String exceptionMessage
```
      User does not have sufficient access to perform this action.
- Class com.amazonaws.services.ivs.model.AmazonIVSException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.ivs.model.AudioConfiguration extends Object implements Serializable
  - Serialized Fields
    - channels
```
Long channels
```
      Number of audio channels.
    - codec
```
String codec
```
      Codec used for the audio encoding.
    - sampleRate
```
Long sampleRate
```
      Number of audio samples recorded per second.
    - targetBitrate
```
Long targetBitrate
```
      The expected ingest bitrate (bits per second). This is configured in the encoder.
- Class com.amazonaws.services.ivs.model.BatchError extends Object implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      Channel ARN.
    - code
```
String code
```
      Error code.
    - message
```
String message
```
      Error message, determined by the application.
- Class com.amazonaws.services.ivs.model.BatchGetChannelRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - arns
```
List<E> arns
```
      Array of ARNs, one per channel.
- Class com.amazonaws.services.ivs.model.BatchGetChannelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - channels
```
List<E> channels
```
    - errors
```
List<E> errors
```
      Each error object is related to a specific ARN in the request.
- Class com.amazonaws.services.ivs.model.BatchGetStreamKeyRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - arns
```
List<E> arns
```
      Array of ARNs, one per stream key.
- Class com.amazonaws.services.ivs.model.BatchGetStreamKeyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - errors
```
List<E> errors
```
    - streamKeys
```
List<E> streamKeys
```
- Class com.amazonaws.services.ivs.model.Channel extends Object implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      Channel ARN.
    - authorized
```
Boolean authorized
```
      Whether the channel is private (enabled for playback authorization). Default: false.
    - ingestEndpoint
```
String ingestEndpoint
```
      Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.
    - latencyMode
```
String latencyMode
```
      Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers. Default: LOW. (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.)
    - name
```
String name
```
      Channel name.
    - playbackUrl
```
String playbackUrl
```
      Channel playback URL.
    - recordingConfigurationArn
```
String recordingConfigurationArn
```
      Recording-configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (empty string, recording is disabled).
    - tags
```
Map<K,V> tags
```
      Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.
    - type
```
String type
```
      Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. Valid values:
      
      STANDARD: Video is transcoded: multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Transcoding allows higher playback quality across a range of download speeds. Resolution can be up to 1080p and bitrate can be up to 8.5 Mbps. Audio is transcoded only for renditions 360p and below; above that, audio is passed through. This is the default.
      
      BASIC: Video is transmuxed: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Resolution can be up to 1080p and bitrate can be up to 1.5 Mbps for 480p and up to 3.5 Mbps for resolutions between 480p and 1080p.
- Class com.amazonaws.services.ivs.model.ChannelNotBroadcastingException extends AmazonIVSException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - exceptionMessage
```
String exceptionMessage
```
      The stream is offline for the given channel ARN.
- Class com.amazonaws.services.ivs.model.ChannelSummary extends Object implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      Channel ARN.
    - authorized
```
Boolean authorized
```
      Whether the channel is private (enabled for playback authorization). Default: false.
    - latencyMode
```
String latencyMode
```
      Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers. Default: LOW. (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.)
    - name
```
String name
```
      Channel name.
    - recordingConfigurationArn
```
String recordingConfigurationArn
```
      Recording-configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (empty string, recording is disabled).
    - tags
```
Map<K,V> tags
```
      Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.
- Class com.amazonaws.services.ivs.model.ConflictException extends AmazonIVSException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - exceptionMessage
```
String exceptionMessage
```
      Updating or deleting a resource can cause an inconsistent state.
- Class com.amazonaws.services.ivs.model.CreateChannelRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - authorized
```
Boolean authorized
```
      Whether the channel is private (enabled for playback authorization). Default: false.
    - latencyMode
```
String latencyMode
```
      Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers. (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.) Default: LOW.
    - name
```
String name
```
      Channel name.
    - recordingConfigurationArn
```
String recordingConfigurationArn
```
      Recording-configuration ARN. Default: "" (empty string, recording is disabled).
    - tags
```
Map<K,V> tags
```
      Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.
    - type
```
String type
```
      Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. Valid values:
      
      STANDARD: Video is transcoded: multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Transcoding allows higher playback quality across a range of download speeds. Resolution can be up to 1080p and bitrate can be up to 8.5 Mbps. Audio is transcoded only for renditions 360p and below; above that, audio is passed through. This is the default.
      
      BASIC: Video is transmuxed: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Resolution can be up to 1080p and bitrate can be up to 1.5 Mbps for 480p and up to 3.5 Mbps for resolutions between 480p and 1080p.
- Class com.amazonaws.services.ivs.model.CreateChannelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - channel
```
Channel channel
```
    - streamKey
```
StreamKey streamKey
```
- Class com.amazonaws.services.ivs.model.CreateRecordingConfigurationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - destinationConfiguration
```
DestinationConfiguration destinationConfiguration
```
      A complex type that contains a destination configuration for where recorded video will be stored.
    - name
```
String name
```
      Recording-configuration name. The value does not need to be unique.
    - recordingReconnectWindowSeconds
```
Integer recordingReconnectWindowSeconds
```
      If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together. Default: 0.
    - tags
```
Map<K,V> tags
```
      Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.
    - thumbnailConfiguration
```
ThumbnailConfiguration thumbnailConfiguration
```
      A complex type that allows you to enable/disable the recording of thumbnails for a live session and modify the interval at which thumbnails are generated for the live session.
- Class com.amazonaws.services.ivs.model.CreateRecordingConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - recordingConfiguration
```
RecordingConfiguration recordingConfiguration
```
- Class com.amazonaws.services.ivs.model.CreateStreamKeyRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - channelArn
```
String channelArn
```
      ARN of the channel for which to create the stream key.
    - tags
```
Map<K,V> tags
```
      Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.
- Class com.amazonaws.services.ivs.model.CreateStreamKeyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - streamKey
```
StreamKey streamKey
```
      Stream key used to authenticate an RTMPS stream for ingestion.
- Class com.amazonaws.services.ivs.model.DeleteChannelRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      ARN of the channel to be deleted.
- Class com.amazonaws.services.ivs.model.DeleteChannelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.ivs.model.DeletePlaybackKeyPairRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      ARN of the key pair to be deleted.
- Class com.amazonaws.services.ivs.model.DeletePlaybackKeyPairResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.ivs.model.DeleteRecordingConfigurationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      ARN of the recording configuration to be deleted.
- Class com.amazonaws.services.ivs.model.DeleteRecordingConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.ivs.model.DeleteStreamKeyRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      ARN of the stream key to be deleted.
- Class com.amazonaws.services.ivs.model.DeleteStreamKeyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.ivs.model.DestinationConfiguration extends Object implements Serializable
  - Serialized Fields
    - s3
```
S3DestinationConfiguration s3
```
      An S3 destination configuration where recorded videos will be stored.
- Class com.amazonaws.services.ivs.model.GetChannelRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      ARN of the channel for which the configuration is to be retrieved.
- Class com.amazonaws.services.ivs.model.GetChannelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - channel
```
Channel channel
```
- Class com.amazonaws.services.ivs.model.GetPlaybackKeyPairRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      ARN of the key pair to be returned.
- Class com.amazonaws.services.ivs.model.GetPlaybackKeyPairResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - keyPair
```
PlaybackKeyPair keyPair
```
- Class com.amazonaws.services.ivs.model.GetRecordingConfigurationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      ARN of the recording configuration to be retrieved.
- Class com.amazonaws.services.ivs.model.GetRecordingConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - recordingConfiguration
```
RecordingConfiguration recordingConfiguration
```
- Class com.amazonaws.services.ivs.model.GetStreamKeyRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      ARN for the stream key to be retrieved.
- Class com.amazonaws.services.ivs.model.GetStreamKeyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - streamKey
```
StreamKey streamKey
```
- Class com.amazonaws.services.ivs.model.GetStreamRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - channelArn
```
String channelArn
```
      Channel ARN for stream to be accessed.
- Class com.amazonaws.services.ivs.model.GetStreamResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - stream
```
Stream stream
```
- Class com.amazonaws.services.ivs.model.GetStreamSessionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - channelArn
```
String channelArn
```
      ARN of the channel resource
    - streamId
```
String streamId
```
      Unique identifier for a live or previously live stream in the specified channel. If no streamId is provided, this returns the most recent stream session for the channel, if it exists.
- Class com.amazonaws.services.ivs.model.GetStreamSessionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - streamSession
```
StreamSession streamSession
```
      List of stream details.
- Class com.amazonaws.services.ivs.model.ImportPlaybackKeyPairRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - name
```
String name
```
      Playback-key-pair name. The value does not need to be unique.
    - publicKeyMaterial
```
String publicKeyMaterial
```
      The public portion of a customer-generated key pair.
    - tags
```
Map<K,V> tags
```
      Any tags provided with the request are added to the playback key pair tags. See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.
- Class com.amazonaws.services.ivs.model.ImportPlaybackKeyPairResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - keyPair
```
PlaybackKeyPair keyPair
```
- Class com.amazonaws.services.ivs.model.IngestConfiguration extends Object implements Serializable
  - Serialized Fields
    - audio
```
AudioConfiguration audio
```
      Encoder settings for audio.
    - video
```
VideoConfiguration video
```
      Encoder settings for video.
- Class com.amazonaws.services.ivs.model.InternalServerException extends AmazonIVSException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - exceptionMessage
```
String exceptionMessage
```
      Unexpected error during processing of request.
- Class com.amazonaws.services.ivs.model.ListChannelsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - filterByName
```
String filterByName
```
      Filters the channel list to match the specified name.
    - filterByRecordingConfigurationArn
```
String filterByRecordingConfigurationArn
```
      Filters the channel list to match the specified recording-configuration ARN.
    - maxResults
```
Integer maxResults
```
      Maximum number of channels to return. Default: 100.
    - nextToken
```
String nextToken
```
      The first channel to retrieve. This is used for pagination; see the nextToken response field.
- Class com.amazonaws.services.ivs.model.ListChannelsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - channels
```
List<E> channels
```
      List of the matching channels.
    - nextToken
```
String nextToken
```
      If there are more channels than maxResults, use nextToken in the request to get the next set.
- Class com.amazonaws.services.ivs.model.ListPlaybackKeyPairsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - maxResults
```
Integer maxResults
```
      Maximum number of key pairs to return. Default: your service quota or 100, whichever is smaller.
    - nextToken
```
String nextToken
```
      The first key pair to retrieve. This is used for pagination; see the nextToken response field.
- Class com.amazonaws.services.ivs.model.ListPlaybackKeyPairsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - keyPairs
```
List<E> keyPairs
```
      List of key pairs.
    - nextToken
```
String nextToken
```
      If there are more key pairs than maxResults, use nextToken in the request to get the next set.
- Class com.amazonaws.services.ivs.model.ListRecordingConfigurationsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - maxResults
```
Integer maxResults
```
      Maximum number of recording configurations to return. Default: your service quota or 100, whichever is smaller.
    - nextToken
```
String nextToken
```
      The first recording configuration to retrieve. This is used for pagination; see the nextToken response field.
- Class com.amazonaws.services.ivs.model.ListRecordingConfigurationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - nextToken
```
String nextToken
```
      If there are more recording configurations than maxResults, use nextToken in the request to get the next set.
    - recordingConfigurations
```
List<E> recordingConfigurations
```
      List of the matching recording configurations.
- Class com.amazonaws.services.ivs.model.ListStreamKeysRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - channelArn
```
String channelArn
```
      Channel ARN used to filter the list.
    - maxResults
```
Integer maxResults
```
      Maximum number of streamKeys to return. Default: 1.
    - nextToken
```
String nextToken
```
      The first stream key to retrieve. This is used for pagination; see the nextToken response field.
- Class com.amazonaws.services.ivs.model.ListStreamKeysResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - nextToken
```
String nextToken
```
      If there are more stream keys than maxResults, use nextToken in the request to get the next set.
    - streamKeys
```
List<E> streamKeys
```
      List of stream keys.
- Class com.amazonaws.services.ivs.model.ListStreamSessionsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - channelArn
```
String channelArn
```
      Channel ARN used to filter the list.
    - maxResults
```
Integer maxResults
```
      Maximum number of streams to return. Default: 100.
    - nextToken
```
String nextToken
```
      The first stream to retrieve. This is used for pagination; see the nextToken response field.
- Class com.amazonaws.services.ivs.model.ListStreamSessionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - nextToken
```
String nextToken
```
      If there are more streams than maxResults, use nextToken in the request to get the next set.
    - streamSessions
```
List<E> streamSessions
```
      List of stream sessions.
- Class com.amazonaws.services.ivs.model.ListStreamsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - filterBy
```
StreamFilters filterBy
```
      Filters the stream list to match the specified criterion.
    - maxResults
```
Integer maxResults
```
      Maximum number of streams to return. Default: 100.
    - nextToken
```
String nextToken
```
      The first stream to retrieve. This is used for pagination; see the nextToken response field.
- Class com.amazonaws.services.ivs.model.ListStreamsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - nextToken
```
String nextToken
```
      If there are more streams than maxResults, use nextToken in the request to get the next set.
    - streams
```
List<E> streams
```
      List of streams.
- Class com.amazonaws.services.ivs.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.ivs.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.ivs.model.PendingVerificationException extends AmazonIVSException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - exceptionMessage
```
String exceptionMessage
```
      Your account is pending verification.
- Class com.amazonaws.services.ivs.model.PlaybackKeyPair extends Object implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      Key-pair ARN.
    - fingerprint
```
String fingerprint
```
      Key-pair identifier.
    - name
```
String name
```
      Playback-key-pair name. The value does not need to be unique.
    - tags
```
Map<K,V> tags
```
      Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.
- Class com.amazonaws.services.ivs.model.PlaybackKeyPairSummary extends Object implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      Key-pair ARN.
    - name
```
String name
```
      Playback-key-pair name. The value does not need to be unique.
    - tags
```
Map<K,V> tags
```
      Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.
- Class com.amazonaws.services.ivs.model.PutMetadataRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - channelArn
```
String channelArn
```
      ARN of the channel into which metadata is inserted. This channel must have an active stream.
    - metadata
```
String metadata
```
      Metadata to insert into the stream. Maximum: 1 KB per request.
- Class com.amazonaws.services.ivs.model.PutMetadataResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.ivs.model.RecordingConfiguration extends Object implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      Recording-configuration ARN.
    - destinationConfiguration
```
DestinationConfiguration destinationConfiguration
```
      A complex type that contains information about where recorded video will be stored.
    - name
```
String name
```
      Recording-configuration name. The value does not need to be unique.
    - recordingReconnectWindowSeconds
```
Integer recordingReconnectWindowSeconds
```
      If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together. Default: 0.
    - state
```
String state
```
      Indicates the current state of the recording configuration. When the state is ACTIVE, the configuration is ready for recording a channel stream.
    - tags
```
Map<K,V> tags
```
      Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.
    - thumbnailConfiguration
```
ThumbnailConfiguration thumbnailConfiguration
```
      A complex type that allows you to enable/disable the recording of thumbnails for a live session and modify the interval at which thumbnails are generated for the live session.
- Class com.amazonaws.services.ivs.model.RecordingConfigurationSummary extends Object implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      Recording-configuration ARN.
    - destinationConfiguration
```
DestinationConfiguration destinationConfiguration
```
      A complex type that contains information about where recorded video will be stored.
    - name
```
String name
```
      Recording-configuration name. The value does not need to be unique.
    - state
```
String state
```
      Indicates the current state of the recording configuration. When the state is ACTIVE, the configuration is ready for recording a channel stream.
    - tags
```
Map<K,V> tags
```
      Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.
- Class com.amazonaws.services.ivs.model.ResourceNotFoundException extends AmazonIVSException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - exceptionMessage
```
String exceptionMessage
```
      Request references a resource which does not exist.
- Class com.amazonaws.services.ivs.model.S3DestinationConfiguration extends Object implements Serializable
  - Serialized Fields
    - bucketName
```
String bucketName
```
      Location (S3 bucket name) where recorded videos will be stored.
- Class com.amazonaws.services.ivs.model.ServiceQuotaExceededException extends AmazonIVSException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - exceptionMessage
```
String exceptionMessage
```
      Request would cause a service quota to be exceeded.
- Class com.amazonaws.services.ivs.model.StopStreamRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - channelArn
```
String channelArn
```
      ARN of the channel for which the stream is to be stopped.
- Class com.amazonaws.services.ivs.model.StopStreamResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.ivs.model.Stream extends Object implements Serializable
  - Serialized Fields
    - channelArn
```
String channelArn
```
      Channel ARN for the stream.
    - health
```
String health
```
      The stream’s health.
    - playbackUrl
```
String playbackUrl
```
      URL of the master playlist, required by the video player to play the HLS stream.
    - startTime
```
Date startTime
```
      Time of the stream’s start. This is an ISO 8601 timestamp; note that this is returned as a string.
    - state
```
String state
```
      The stream’s state. Do not rely on the OFFLINE state, as the API may not return it; instead, a "NotBroadcasting" error will indicate that the stream is not live.
    - streamId
```
String streamId
```
      Unique identifier for a live or previously live stream in the specified channel.
    - viewerCount
```
Long viewerCount
```
      A count of concurrent views of the stream. Typically, a new view appears in viewerCount within 15 seconds of when video playback starts and a view is removed from viewerCount within 1 minute of when video playback ends. A value of -1 indicates that the request timed out; in this case, retry.
- Class com.amazonaws.services.ivs.model.StreamEvent extends Object implements Serializable
  - Serialized Fields
    - eventTime
```
Date eventTime
```
      Time when the event occurred. This is an ISO 8601 timestamp; note that this is returned as a string.
    - name
```
String name
```
      Name that identifies the stream event within a type.
    - type
```
String type
```
      Logical group for certain events.
- Class com.amazonaws.services.ivs.model.StreamFilters extends Object implements Serializable
  - Serialized Fields
    - health
```
String health
```
      The stream’s health.
- Class com.amazonaws.services.ivs.model.StreamKey extends Object implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      Stream-key ARN.
    - channelArn
```
String channelArn
```
      Channel ARN for the stream.
    - tags
```
Map<K,V> tags
```
      Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.
    - value
```
String value
```
      Stream-key value.
- Class com.amazonaws.services.ivs.model.StreamKeySummary extends Object implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      Stream-key ARN.
    - channelArn
```
String channelArn
```
      Channel ARN for the stream.
    - tags
```
Map<K,V> tags
```
      Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.
- Class com.amazonaws.services.ivs.model.StreamSession extends Object implements Serializable
  - Serialized Fields
    - channel
```
Channel channel
```
      The properties of the channel at the time of going live.
    - endTime
```
Date endTime
```
      Time when the channel went offline. This is an ISO 8601 timestamp; note that this is returned as a string. For live streams, this is NULL.
    - ingestConfiguration
```
IngestConfiguration ingestConfiguration
```
      The properties of the incoming RTMP stream for the stream.
    - recordingConfiguration
```
RecordingConfiguration recordingConfiguration
```
      The properties of recording the live stream.
    - startTime
```
Date startTime
```
      Time when the channel went live. This is an ISO 8601 timestamp; note that this is returned as a string.
    - streamId
```
String streamId
```
      Unique identifier for a live or previously live stream in the specified channel.
    - truncatedEvents
```
List<E> truncatedEvents
```
      List of Amazon IVS events that the stream encountered. The list is sorted by most recent events and contains up to 500 events. For Amazon IVS events, see Using Amazon EventBridge with Amazon IVS.
- Class com.amazonaws.services.ivs.model.StreamSessionSummary extends Object implements Serializable
  - Serialized Fields
    - endTime
```
Date endTime
```
      Time when the channel went offline. This is an ISO 8601 timestamp; note that this is returned as a string. For live streams, this is NULL.
    - hasErrorEvent
```
Boolean hasErrorEvent
```
      If true, this stream encountered a quota breach or failure.
    - startTime
```
Date startTime
```
      Time when the channel went live. This is an ISO 8601 timestamp; note that this is returned as a string.
    - streamId
```
String streamId
```
      Unique identifier for a live or previously live stream in the specified channel.
- Class com.amazonaws.services.ivs.model.StreamSummary extends Object implements Serializable
  - Serialized Fields
    - channelArn
```
String channelArn
```
      Channel ARN for the stream.
    - health
```
String health
```
      The stream’s health.
    - startTime
```
Date startTime
```
      Time of the stream’s start. This is an ISO 8601 timestamp; note that this is returned as a string.
    - state
```
String state
```
      The stream’s state. Do not rely on the OFFLINE state, as the API may not return it; instead, a "NotBroadcasting" error will indicate that the stream is not live.
    - streamId
```
String streamId
```
      Unique identifier for a live or previously live stream in the specified channel.
    - viewerCount
```
Long viewerCount
```
      A count of concurrent views of the stream. Typically, a new view appears in viewerCount within 15 seconds of when video playback starts and a view is removed from viewerCount within 1 minute of when video playback ends. A value of -1 indicates that the request timed out; in this case, retry.
- Class com.amazonaws.services.ivs.model.StreamUnavailableException extends AmazonIVSException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - exceptionMessage
```
String exceptionMessage
```
      The stream is temporarily unavailable.
- Class com.amazonaws.services.ivs.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceArn
```
String resourceArn
```
      ARN of the resource for which tags are to be added or updated. 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 Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.
- Class com.amazonaws.services.ivs.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.ivs.model.ThrottlingException extends AmazonIVSException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - exceptionMessage
```
String exceptionMessage
```
      Request was denied due to request throttling.
- Class com.amazonaws.services.ivs.model.ThumbnailConfiguration extends Object implements Serializable
  - Serialized Fields
    - recordingMode
```
String recordingMode
```
      Thumbnail recording mode. Default: INTERVAL.
    - targetIntervalSeconds
```
Long targetIntervalSeconds
```
      The targeted thumbnail-generation interval in seconds. This is configurable (and required) only if recordingMode is INTERVAL. Default: 60.
      
      Important: Setting a value for targetIntervalSeconds does not guarantee that thumbnails are generated at the specified interval. For thumbnails to be generated at the targetIntervalSeconds interval, the IDR/Keyframe value for the input video must be less than the targetIntervalSeconds value. See Amazon IVS Streaming Configuration for information on setting IDR/Keyframe to the recommended value in video-encoder settings.
- Class com.amazonaws.services.ivs.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceArn
```
String resourceArn
```
      ARN of the resource for which tags are to be removed. 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 Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.
- Class com.amazonaws.services.ivs.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.ivs.model.UpdateChannelRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      ARN of the channel to be updated.
    - authorized
```
Boolean authorized
```
      Whether the channel is private (enabled for playback authorization).
    - latencyMode
```
String latencyMode
```
      Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers. (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.)
    - name
```
String name
```
      Channel name.
    - recordingConfigurationArn
```
String recordingConfigurationArn
```
      Recording-configuration ARN. If this is set to an empty string, recording is disabled. A value other than an empty string indicates that recording is enabled
    - type
```
String type
```
      Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately. Valid values:
      
      STANDARD: Video is transcoded: multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Transcoding allows higher playback quality across a range of download speeds. Resolution can be up to 1080p and bitrate can be up to 8.5 Mbps. Audio is transcoded only for renditions 360p and below; above that, audio is passed through. This is the default.
      
      BASIC: Video is transmuxed: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Resolution can be up to 1080p and bitrate can be up to 1.5 Mbps for 480p and up to 3.5 Mbps for resolutions between 480p and 1080p.
- Class com.amazonaws.services.ivs.model.UpdateChannelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - channel
```
Channel channel
```
- Class com.amazonaws.services.ivs.model.ValidationException extends AmazonIVSException 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.ivs.model.VideoConfiguration extends Object implements Serializable
  - Serialized Fields
    - avcLevel
```
String avcLevel
```
      Indicates the degree of required decoder performance for a profile. Normally this is set automatically by the encoder. For details, see the H.264 specification.
    - avcProfile
```
String avcProfile
```
      Indicates to the decoder the requirements for decoding the stream. For definitions of the valid values, see the H.264 specification.
    - codec
```
String codec
```
      Codec used for the video encoding.
    - encoder
```
String encoder
```
      Software or hardware used to encode the video.
    - targetBitrate
```
Long targetBitrate
```
      The expected ingest bitrate (bits per second). This is configured in the encoder.
    - targetFramerate
```
Long targetFramerate
```
      The expected ingest framerate. This is configured in the encoder.
    - videoHeight
```
Long videoHeight
```
      Video-resolution height in pixels.
    - videoWidth
```
Long videoWidth
```
      Video-resolution width in pixels.

Serialized Form

Package com.amazonaws.services.ivs.model

Class com.amazonaws.services.ivs.model.AccessDeniedException extends AmazonIVSException implements Serializable

Serialized Fields

exceptionMessage

Class com.amazonaws.services.ivs.model.AmazonIVSException extends AmazonServiceException implements Serializable

Class com.amazonaws.services.ivs.model.AudioConfiguration extends Object implements Serializable

Serialized Fields

channels

codec

sampleRate

targetBitrate

Class com.amazonaws.services.ivs.model.BatchError extends Object implements Serializable

Serialized Fields

arn

code

message

Class com.amazonaws.services.ivs.model.BatchGetChannelRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

arns

Class com.amazonaws.services.ivs.model.BatchGetChannelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

channels

errors

Class com.amazonaws.services.ivs.model.BatchGetStreamKeyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

arns

Class com.amazonaws.services.ivs.model.BatchGetStreamKeyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

errors

streamKeys

Class com.amazonaws.services.ivs.model.Channel extends Object implements Serializable

Serialized Fields

arn

authorized

ingestEndpoint

latencyMode

name

playbackUrl

recordingConfigurationArn

tags

type

Class com.amazonaws.services.ivs.model.ChannelNotBroadcastingException extends AmazonIVSException implements Serializable

Serialized Fields

exceptionMessage

Class com.amazonaws.services.ivs.model.ChannelSummary extends Object implements Serializable

Serialized Fields

arn

authorized

latencyMode

name

recordingConfigurationArn

tags

Class com.amazonaws.services.ivs.model.ConflictException extends AmazonIVSException implements Serializable

Serialized Fields

exceptionMessage

Class com.amazonaws.services.ivs.model.CreateChannelRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

authorized

latencyMode

name

recordingConfigurationArn

tags

type

Class com.amazonaws.services.ivs.model.CreateChannelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

channel

streamKey

Class com.amazonaws.services.ivs.model.CreateRecordingConfigurationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

destinationConfiguration

name

recordingReconnectWindowSeconds

tags

thumbnailConfiguration

Class com.amazonaws.services.ivs.model.CreateRecordingConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

recordingConfiguration

Class com.amazonaws.services.ivs.model.CreateStreamKeyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields