'2.0', 'service' => '

Introduction

The Amazon Interactive Video Service (IVS) API is REST compatible, using a standard HTTP API and an Amazon Web Services EventBridge event stream for responses. JSON is used for both requests and responses, including errors.

The API is an Amazon Web Services regional service. For a list of supported regions and Amazon IVS HTTPS service endpoints, see the Amazon IVS page in the Amazon Web Services General Reference.

All API request parameters and URLs are case sensitive.

For a summary of notable documentation changes in each release, see Document History.

Allowed Header Values

Resources

The following resources contain information about your IVS live stream (see Getting Started with Amazon IVS):

Tagging

A tag is a metadata label that you assign to an Amazon Web Services resource. A tag comprises a key and a value, both set by you. For example, you might set a tag as topic:nature to label a particular video category. 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.

Tags can help you identify and organize your Amazon Web Services resources. For example, you can use the same tag for different resources to indicate that they are related. You can also use tags to manage access (see Access Tags).

The Amazon IVS API has these tag-related endpoints: TagResource, UntagResource, and ListTagsForResource. The following resources support tagging: Channels, Stream Keys, Playback Key Pairs, and Recording Configurations.

At most 50 tags can be applied to a resource.

Authentication versus Authorization

Note the differences between these concepts:

Authentication

All Amazon IVS API requests must be authenticated with a signature. The Amazon Web Services Command-Line Interface (CLI) and Amazon IVS Player SDKs take care of signing the underlying API calls for you. However, if your application calls the Amazon IVS API directly, it’s your responsibility to sign the requests.

You generate a signature using valid Amazon Web Services credentials that have permission to perform the requested action. For example, you must sign PutMetadata requests with a signature generated from a user account that has the ivs:PutMetadata permission.

For more information:

Amazon Resource Names (ARNs)

ARNs uniquely identify AWS resources. An ARN is required when you need to specify a resource unambiguously across all of AWS, such as in IAM policies and API calls. For more information, see Amazon Resource Names in the AWS General Reference.

Channel Endpoints

StreamKey Endpoints

Stream Endpoints

Private Channel Endpoints

For more information, see Setting Up Private Channels in the Amazon IVS User Guide.

RecordingConfiguration Endpoints

Amazon Web Services Tags Endpoints

', 'operations' => [ 'BatchGetChannel' => '

Performs GetChannel on multiple ARNs simultaneously.

', 'BatchGetStreamKey' => '

Performs GetStreamKey on multiple ARNs simultaneously.

', 'BatchStartViewerSessionRevocation' => '

Performs StartViewerSessionRevocation on multiple channel ARN and viewer ID pairs simultaneously.

', 'CreateChannel' => '

Creates a new channel and an associated stream key to start streaming.

', 'CreateRecordingConfiguration' => '

Creates a new recording configuration, used to enable recording to Amazon S3.

Known issue: In the us-east-1 region, if you use the Amazon Web Services CLI to create a recording configuration, it returns success even if the S3 bucket is in a different region. In this case, the state of the recording configuration is CREATE_FAILED (instead of ACTIVE). (In other regions, the CLI correctly returns failure if the bucket is in a different region.)

Workaround: Ensure that your S3 bucket is in the same region as the recording configuration. If you create a recording configuration in a different region as your S3 bucket, delete that recording configuration and create a new one with an S3 bucket from the correct region.

', 'CreateStreamKey' => '

Creates a stream key, used to initiate a stream, for the specified channel ARN.

Note that CreateChannel creates a stream key. If you subsequently use CreateStreamKey on the same channel, it will fail because a stream key already exists and there is a limit of 1 stream key per channel. To reset the stream key on a channel, use DeleteStreamKey and then CreateStreamKey.

', 'DeleteChannel' => '

Deletes the specified channel and its associated stream keys.

If you try to delete a live channel, you will get an error (409 ConflictException). To delete a channel that is live, call StopStream, wait for the Amazon EventBridge "Stream End" event (to verify that the stream\'s state is no longer Live), then call DeleteChannel. (See Using EventBridge with Amazon IVS.)

', 'DeletePlaybackKeyPair' => '

Deletes a specified authorization key pair. This invalidates future viewer tokens generated using the key pair’s privateKey. For more information, see Setting Up Private Channels in the Amazon IVS User Guide.

', 'DeleteRecordingConfiguration' => '

Deletes the recording configuration for the specified ARN.

If you try to delete a recording configuration that is associated with a channel, you will get an error (409 ConflictException). To avoid this, for all channels that reference the recording configuration, first use UpdateChannel to set the recordingConfigurationArn field to an empty string, then use DeleteRecordingConfiguration.

', 'DeleteStreamKey' => '

Deletes the stream key for the specified ARN, so it can no longer be used to stream.

', 'GetChannel' => '

Gets the channel configuration for the specified channel ARN. See also BatchGetChannel.

', 'GetPlaybackKeyPair' => '

Gets a specified playback authorization key pair and returns the arn and fingerprint. The privateKey held by the caller can be used to generate viewer authorization tokens, to grant viewers access to private channels. For more information, see Setting Up Private Channels in the Amazon IVS User Guide.

', 'GetRecordingConfiguration' => '

Gets the recording configuration for the specified ARN.

', 'GetStream' => '

Gets information about the active (live) stream on a specified channel.

', 'GetStreamKey' => '

Gets stream-key information for a specified ARN.

', 'GetStreamSession' => '

Gets metadata on a specified stream.

', 'ImportPlaybackKeyPair' => '

Imports the public portion of a new key pair and returns its arn and fingerprint. The privateKey can then be used to generate viewer authorization tokens, to grant viewers access to private channels. For more information, see Setting Up Private Channels in the Amazon IVS User Guide.

', 'ListChannels' => '

Gets summary information about all channels in your account, in the Amazon Web Services region where the API request is processed. This list can be filtered to match a specified name or recording-configuration ARN. Filters are mutually exclusive and cannot be used together. If you try to use both filters, you will get an error (409 ConflictException).

', 'ListPlaybackKeyPairs' => '

Gets summary information about playback key pairs. For more information, see Setting Up Private Channels in the Amazon IVS User Guide.

', 'ListRecordingConfigurations' => '

Gets summary information about all recording configurations in your account, in the Amazon Web Services region where the API request is processed.

', 'ListStreamKeys' => '

Gets summary information about stream keys for the specified channel.

', 'ListStreamSessions' => '

Gets a summary of current and previous streams for a specified channel in your account, in the AWS region where the API request is processed.

', 'ListStreams' => '

Gets summary information about live streams in your account, in the Amazon Web Services region where the API request is processed.

', 'ListTagsForResource' => '

Gets information about Amazon Web Services tags for the specified ARN.

', 'PutMetadata' => '

Inserts metadata into the active stream of the specified channel. At most 5 requests per second per channel are allowed, each with a maximum 1 KB payload. (If 5 TPS is not sufficient for your needs, we recommend batching your data into a single PutMetadata call.) At most 155 requests per second per account are allowed. Also see Embedding Metadata within a Video Stream in the Amazon IVS User Guide.

', 'StartViewerSessionRevocation' => '

Starts the process of revoking the viewer session associated with a specified channel ARN and viewer ID. Optionally, you can provide a version to revoke viewer sessions less than and including that version. For instructions on associating a viewer ID with a viewer session, see Setting Up Private Channels.

', 'StopStream' => '

Disconnects the incoming RTMPS stream for the specified channel. Can be used in conjunction with DeleteStreamKey to prevent further streaming to a channel.

Many streaming client-software libraries automatically reconnect a dropped RTMPS session, so to stop the stream permanently, you may want to first revoke the streamKey attached to the channel.

', 'TagResource' => '

Adds or updates tags for the Amazon Web Services resource with the specified ARN.

', 'UntagResource' => '

Removes tags from the resource with the specified ARN.

', 'UpdateChannel' => '

Updates a channel\'s configuration. Live channels cannot be updated. You must stop the ongoing stream, update the channel, and restart the stream for the changes to take effect.

', ], 'shapes' => [ 'AccessDeniedException' => [ 'base' => '

', 'refs' => [], ], 'AudioConfiguration' => [ 'base' => '

Object specifying a stream’s audio configuration, as set up by the broadcaster (usually in an encoder). This is part of the IngestConfiguration object and used for monitoring stream health.

', 'refs' => [ 'IngestConfiguration$audio' => '

Encoder settings for audio.

', ], ], 'BatchError' => [ 'base' => '

Error related to a specific channel, specified by its ARN.

', 'refs' => [ 'BatchErrors$member' => NULL, ], ], 'BatchErrors' => [ 'base' => NULL, 'refs' => [ 'BatchGetChannelResponse$errors' => '

Each error object is related to a specific ARN in the request.

', 'BatchGetStreamKeyResponse$errors' => '

', ], ], 'BatchGetChannelRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetChannelResponse' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetStreamKeyRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetStreamKeyResponse' => [ 'base' => NULL, 'refs' => [], ], 'BatchStartViewerSessionRevocationError' => [ 'base' => '

Error for a request in the batch for BatchStartViewerSessionRevocation. Each error is related to a specific channel-ARN and viewer-ID pair.

', 'refs' => [ 'BatchStartViewerSessionRevocationErrors$member' => NULL, ], ], 'BatchStartViewerSessionRevocationErrors' => [ 'base' => NULL, 'refs' => [ 'BatchStartViewerSessionRevocationResponse$errors' => '

Each error object is related to a specific channelArn and viewerId pair in the request.

', ], ], 'BatchStartViewerSessionRevocationRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchStartViewerSessionRevocationResponse' => [ 'base' => NULL, 'refs' => [], ], 'BatchStartViewerSessionRevocationViewerSession' => [ 'base' => '

A viewer session to revoke in the call to BatchStartViewerSessionRevocation.

', 'refs' => [ 'BatchStartViewerSessionRevocationViewerSessionList$member' => NULL, ], ], 'BatchStartViewerSessionRevocationViewerSessionList' => [ 'base' => NULL, 'refs' => [ 'BatchStartViewerSessionRevocationRequest$viewerSessions' => '

Array of viewer sessions, one per channel-ARN and viewer-ID pair.

', ], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'CreateChannelRequest$authorized' => '

Whether the channel is private (enabled for playback authorization). Default: false.

', 'CreateChannelRequest$insecureIngest' => '

Whether the channel allows insecure RTMP ingest. Default: false.

', 'StreamSessionSummary$hasErrorEvent' => '

If true, this stream encountered a quota breach or failure.

', 'UpdateChannelRequest$authorized' => '

Whether the channel is private (enabled for playback authorization).

', 'UpdateChannelRequest$insecureIngest' => '

Whether the channel allows insecure RTMP ingest. Default: false.

', ], ], 'Channel' => [ 'base' => '

Object specifying a channel.

', 'refs' => [ 'Channels$member' => NULL, 'CreateChannelResponse$channel' => '

', 'GetChannelResponse$channel' => '

', 'StreamSession$channel' => '

The properties of the channel at the time of going live.

', 'UpdateChannelResponse$channel' => NULL, ], ], 'ChannelArn' => [ 'base' => NULL, 'refs' => [ 'BatchStartViewerSessionRevocationError$channelArn' => '

Channel ARN.

', 'BatchStartViewerSessionRevocationViewerSession$channelArn' => '

The ARN of the channel associated with the viewer session to revoke.

', 'Channel$arn' => '

Channel ARN.

', 'ChannelArnList$member' => NULL, 'ChannelSummary$arn' => '

Channel ARN.

', 'CreateStreamKeyRequest$channelArn' => '

ARN of the channel for which to create the stream key.

', 'DeleteChannelRequest$arn' => '

ARN of the channel to be deleted.

', 'GetChannelRequest$arn' => '

ARN of the channel for which the configuration is to be retrieved.

', 'GetStreamRequest$channelArn' => '

Channel ARN for stream to be accessed.

', 'GetStreamSessionRequest$channelArn' => '

ARN of the channel resource

', 'ListStreamKeysRequest$channelArn' => '

Channel ARN used to filter the list.

', 'ListStreamSessionsRequest$channelArn' => '

Channel ARN used to filter the list.

', 'PutMetadataRequest$channelArn' => '

ARN of the channel into which metadata is inserted. This channel must have an active stream.

', 'StartViewerSessionRevocationRequest$channelArn' => '

The ARN of the channel associated with the viewer session to revoke.

', 'StopStreamRequest$channelArn' => '

ARN of the channel for which the stream is to be stopped.

', 'Stream$channelArn' => '

Channel ARN for the stream.

', 'StreamKey$channelArn' => '

Channel ARN for the stream.

', 'StreamKeySummary$channelArn' => '

Channel ARN for the stream.

', 'StreamSummary$channelArn' => '

Channel ARN for the stream.

', 'UpdateChannelRequest$arn' => '

ARN of the channel to be updated.

', ], ], 'ChannelArnList' => [ 'base' => NULL, 'refs' => [ 'BatchGetChannelRequest$arns' => '

Array of ARNs, one per channel.

', ], ], 'ChannelLatencyMode' => [ 'base' => NULL, 'refs' => [ 'Channel$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.)

', 'ChannelSummary$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.)

', 'CreateChannelRequest$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.

', 'UpdateChannelRequest$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.)

', ], ], 'ChannelList' => [ 'base' => NULL, 'refs' => [ 'ListChannelsResponse$channels' => '

List of the matching channels.

', ], ], 'ChannelName' => [ 'base' => NULL, 'refs' => [ 'Channel$name' => '

Channel name.

', 'ChannelSummary$name' => '

Channel name.

', 'CreateChannelRequest$name' => '

Channel name.

', 'ListChannelsRequest$filterByName' => '

Filters the channel list to match the specified name.

', 'UpdateChannelRequest$name' => '

Channel name.

', ], ], 'ChannelNotBroadcasting' => [ 'base' => '

', 'refs' => [], ], 'ChannelRecordingConfigurationArn' => [ 'base' => NULL, 'refs' => [ 'Channel$recordingConfigurationArn' => '

Recording-configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (empty string, recording is disabled).

', 'ChannelSummary$recordingConfigurationArn' => '

Recording-configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (empty string, recording is disabled).

', 'CreateChannelRequest$recordingConfigurationArn' => '

Recording-configuration ARN. Default: "" (empty string, recording is disabled).

', 'ListChannelsRequest$filterByRecordingConfigurationArn' => '

Filters the channel list to match the specified recording-configuration ARN.

', 'UpdateChannelRequest$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

', ], ], 'ChannelSummary' => [ 'base' => '

Summary information about a channel.

', 'refs' => [ 'ChannelList$member' => NULL, ], ], 'ChannelType' => [ 'base' => NULL, 'refs' => [ 'Channel$type' => '

Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately. Some types generate multiple qualities (renditions) from the original input; this automatically gives viewers the best experience for their devices and network conditions. Some types provide transcoded video; transcoding allows higher playback quality across a range of download speeds. Default: STANDARD. Valid values:

Optional transcode presets (available for the ADVANCED types) allow you to trade off available download bandwidth and video quality, to optimize the viewing experience. There are two presets:

', 'ChannelSummary$type' => '

Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately. Some types generate multiple qualities (renditions) from the original input; this automatically gives viewers the best experience for their devices and network conditions. Some types provide transcoded video; transcoding allows higher playback quality across a range of download speeds. Default: STANDARD. Valid values:

Optional transcode presets (available for the ADVANCED types) allow you to trade off available download bandwidth and video quality, to optimize the viewing experience. There are two presets:

', 'CreateChannelRequest$type' => '

Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately. Some types generate multiple qualities (renditions) from the original input; this automatically gives viewers the best experience for their devices and network conditions. Some types provide transcoded video; transcoding allows higher playback quality across a range of download speeds. Default: STANDARD. Valid values:

Optional transcode presets (available for the ADVANCED types) allow you to trade off available download bandwidth and video quality, to optimize the viewing experience. There are two presets:

', 'UpdateChannelRequest$type' => '

Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately. Some types generate multiple qualities (renditions) from the original input; this automatically gives viewers the best experience for their devices and network conditions. Some types provide transcoded video; transcoding allows higher playback quality across a range of download speeds. Default: STANDARD. Valid values:

Optional transcode presets (available for the ADVANCED types) allow you to trade off available download bandwidth and video quality, to optimize the viewing experience. There are two presets:

', ], ], 'Channels' => [ 'base' => NULL, 'refs' => [ 'BatchGetChannelResponse$channels' => '

', ], ], 'ConflictException' => [ 'base' => '

', 'refs' => [], ], 'CreateChannelRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateChannelResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateRecordingConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateRecordingConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateStreamKeyRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateStreamKeyResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteChannelRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeletePlaybackKeyPairRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeletePlaybackKeyPairResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteRecordingConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteStreamKeyRequest' => [ 'base' => NULL, 'refs' => [], ], 'DestinationConfiguration' => [ 'base' => '

A complex type that describes a location where recorded videos will be stored. Each member represents a type of destination configuration. For recording, you define one and only one type of destination configuration.

', 'refs' => [ 'CreateRecordingConfigurationRequest$destinationConfiguration' => '

A complex type that contains a destination configuration for where recorded video will be stored.

', 'RecordingConfiguration$destinationConfiguration' => '

A complex type that contains information about where recorded video will be stored.

', 'RecordingConfigurationSummary$destinationConfiguration' => '

A complex type that contains information about where recorded video will be stored.

', ], ], 'GetChannelRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetChannelResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetPlaybackKeyPairRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetPlaybackKeyPairResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetRecordingConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetRecordingConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetStreamKeyRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetStreamKeyResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetStreamRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetStreamResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetStreamSessionRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetStreamSessionResponse' => [ 'base' => NULL, 'refs' => [], ], 'ImportPlaybackKeyPairRequest' => [ 'base' => NULL, 'refs' => [], ], 'ImportPlaybackKeyPairResponse' => [ 'base' => NULL, 'refs' => [], ], 'IngestConfiguration' => [ 'base' => '

Object specifying the ingest configuration set up by the broadcaster, usually in an encoder.

', 'refs' => [ 'StreamSession$ingestConfiguration' => '

The properties of the incoming RTMP stream for the stream.

', ], ], 'IngestEndpoint' => [ 'base' => NULL, 'refs' => [ 'Channel$ingestEndpoint' => '

Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.

', ], ], 'InsecureIngest' => [ 'base' => NULL, 'refs' => [ 'Channel$insecureIngest' => '

Whether the channel allows insecure RTMP ingest. Default: false.

', 'ChannelSummary$insecureIngest' => '

Whether the channel allows insecure RTMP ingest. Default: false.

', ], ], 'Integer' => [ 'base' => NULL, 'refs' => [ 'AudioConfiguration$channels' => '

Number of audio channels.

', 'AudioConfiguration$sampleRate' => '

Number of audio samples recorded per second.

', 'AudioConfiguration$targetBitrate' => '

The expected ingest bitrate (bits per second). This is configured in the encoder.

', 'VideoConfiguration$targetBitrate' => '

The expected ingest bitrate (bits per second). This is configured in the encoder.

', 'VideoConfiguration$targetFramerate' => '

The expected ingest framerate. This is configured in the encoder.

', 'VideoConfiguration$videoHeight' => '

Video-resolution height in pixels.

', 'VideoConfiguration$videoWidth' => '

Video-resolution width in pixels.

', ], ], 'InternalServerException' => [ 'base' => '

', 'refs' => [], ], 'IsAuthorized' => [ 'base' => NULL, 'refs' => [ 'Channel$authorized' => '

Whether the channel is private (enabled for playback authorization). Default: false.

', 'ChannelSummary$authorized' => '

Whether the channel is private (enabled for playback authorization). Default: false.

', ], ], 'ListChannelsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListChannelsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListPlaybackKeyPairsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListPlaybackKeyPairsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListRecordingConfigurationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListRecordingConfigurationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListStreamKeysRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListStreamKeysResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListStreamSessionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListStreamSessionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListStreamsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListStreamsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'MaxChannelResults' => [ 'base' => NULL, 'refs' => [ 'ListChannelsRequest$maxResults' => '

Maximum number of channels to return. Default: 100.

', ], ], 'MaxPlaybackKeyPairResults' => [ 'base' => NULL, 'refs' => [ 'ListPlaybackKeyPairsRequest$maxResults' => '

Maximum number of key pairs to return. Default: your service quota or 100, whichever is smaller.

', ], ], 'MaxRecordingConfigurationResults' => [ 'base' => NULL, 'refs' => [ 'ListRecordingConfigurationsRequest$maxResults' => '

Maximum number of recording configurations to return. Default: your service quota or 100, whichever is smaller.

', ], ], 'MaxStreamKeyResults' => [ 'base' => NULL, 'refs' => [ 'ListStreamKeysRequest$maxResults' => '

Maximum number of streamKeys to return. Default: 1.

', ], ], 'MaxStreamResults' => [ 'base' => NULL, 'refs' => [ 'ListStreamSessionsRequest$maxResults' => '

Maximum number of streams to return. Default: 100.

', 'ListStreamsRequest$maxResults' => '

Maximum number of streams to return. Default: 100.

', ], ], 'PaginationToken' => [ 'base' => NULL, 'refs' => [ 'ListChannelsRequest$nextToken' => '

The first channel to retrieve. This is used for pagination; see the nextToken response field.

', 'ListChannelsResponse$nextToken' => '

If there are more channels than maxResults, use nextToken in the request to get the next set.

', 'ListPlaybackKeyPairsRequest$nextToken' => '

The first key pair to retrieve. This is used for pagination; see the nextToken response field.

', 'ListPlaybackKeyPairsResponse$nextToken' => '

If there are more key pairs than maxResults, use nextToken in the request to get the next set.

', 'ListRecordingConfigurationsRequest$nextToken' => '

The first recording configuration to retrieve. This is used for pagination; see the nextToken response field.

', 'ListRecordingConfigurationsResponse$nextToken' => '

If there are more recording configurations than maxResults, use nextToken in the request to get the next set.

', 'ListStreamKeysRequest$nextToken' => '

The first stream key to retrieve. This is used for pagination; see the nextToken response field.

', 'ListStreamKeysResponse$nextToken' => '

If there are more stream keys than maxResults, use nextToken in the request to get the next set.

', 'ListStreamSessionsRequest$nextToken' => '

The first stream to retrieve. This is used for pagination; see the nextToken response field.

', 'ListStreamSessionsResponse$nextToken' => '

If there are more streams than maxResults, use nextToken in the request to get the next set.

', 'ListStreamsRequest$nextToken' => '

The first stream to retrieve. This is used for pagination; see the nextToken response field.

', 'ListStreamsResponse$nextToken' => '

If there are more streams than maxResults, use nextToken in the request to get the next set.

', ], ], 'PendingVerification' => [ 'base' => '

', 'refs' => [], ], 'PlaybackKeyPair' => [ 'base' => '

A key pair used to sign and validate a playback authorization token.

', 'refs' => [ 'GetPlaybackKeyPairResponse$keyPair' => '', 'ImportPlaybackKeyPairResponse$keyPair' => '

', ], ], 'PlaybackKeyPairArn' => [ 'base' => NULL, 'refs' => [ 'DeletePlaybackKeyPairRequest$arn' => '

ARN of the key pair to be deleted.

', 'GetPlaybackKeyPairRequest$arn' => '

ARN of the key pair to be returned.

', 'PlaybackKeyPair$arn' => '

Key-pair ARN.

', 'PlaybackKeyPairSummary$arn' => '

Key-pair ARN.

', ], ], 'PlaybackKeyPairFingerprint' => [ 'base' => NULL, 'refs' => [ 'PlaybackKeyPair$fingerprint' => '

Key-pair identifier.

', ], ], 'PlaybackKeyPairList' => [ 'base' => NULL, 'refs' => [ 'ListPlaybackKeyPairsResponse$keyPairs' => '

List of key pairs.

', ], ], 'PlaybackKeyPairName' => [ 'base' => NULL, 'refs' => [ 'ImportPlaybackKeyPairRequest$name' => '

Playback-key-pair name. The value does not need to be unique.

', 'PlaybackKeyPair$name' => '

Playback-key-pair name. The value does not need to be unique.

', 'PlaybackKeyPairSummary$name' => '

Playback-key-pair name. The value does not need to be unique.

', ], ], 'PlaybackKeyPairSummary' => [ 'base' => '

Summary information about a playback key pair.

', 'refs' => [ 'PlaybackKeyPairList$member' => NULL, ], ], 'PlaybackPublicKeyMaterial' => [ 'base' => NULL, 'refs' => [ 'ImportPlaybackKeyPairRequest$publicKeyMaterial' => '

The public portion of a customer-generated key pair.

', ], ], 'PlaybackURL' => [ 'base' => NULL, 'refs' => [ 'Channel$playbackUrl' => '

Channel playback URL.

', 'Stream$playbackUrl' => '

URL of the master playlist, required by the video player to play the HLS stream.

', ], ], 'PutMetadataRequest' => [ 'base' => NULL, 'refs' => [], ], 'RecordingConfiguration' => [ 'base' => '

An object representing a configuration to record a channel stream.

', 'refs' => [ 'CreateRecordingConfigurationResponse$recordingConfiguration' => '', 'GetRecordingConfigurationResponse$recordingConfiguration' => '', 'StreamSession$recordingConfiguration' => '

The properties of recording the live stream.

', ], ], 'RecordingConfigurationArn' => [ 'base' => NULL, 'refs' => [ 'DeleteRecordingConfigurationRequest$arn' => '

ARN of the recording configuration to be deleted.

', 'GetRecordingConfigurationRequest$arn' => '

ARN of the recording configuration to be retrieved.

', 'RecordingConfiguration$arn' => '

Recording-configuration ARN.

', 'RecordingConfigurationSummary$arn' => '

Recording-configuration ARN.

', ], ], 'RecordingConfigurationList' => [ 'base' => NULL, 'refs' => [ 'ListRecordingConfigurationsResponse$recordingConfigurations' => '

List of the matching recording configurations.

', ], ], 'RecordingConfigurationName' => [ 'base' => NULL, 'refs' => [ 'CreateRecordingConfigurationRequest$name' => '

Recording-configuration name. The value does not need to be unique.

', 'RecordingConfiguration$name' => '

Recording-configuration name. The value does not need to be unique.

', 'RecordingConfigurationSummary$name' => '

Recording-configuration name. The value does not need to be unique.

', ], ], 'RecordingConfigurationState' => [ 'base' => NULL, 'refs' => [ 'RecordingConfiguration$state' => '

Indicates the current state of the recording configuration. When the state is ACTIVE, the configuration is ready for recording a channel stream.

', 'RecordingConfigurationSummary$state' => '

Indicates the current state of the recording configuration. When the state is ACTIVE, the configuration is ready for recording a channel stream.

', ], ], 'RecordingConfigurationSummary' => [ 'base' => '

Summary information about a RecordingConfiguration.

', 'refs' => [ 'RecordingConfigurationList$member' => NULL, ], ], 'RecordingMode' => [ 'base' => NULL, 'refs' => [ 'ThumbnailConfiguration$recordingMode' => '

Thumbnail recording mode. Default: INTERVAL.

', ], ], 'RecordingReconnectWindowSeconds' => [ 'base' => NULL, 'refs' => [ 'CreateRecordingConfigurationRequest$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.

', 'RecordingConfiguration$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.

', ], ], 'RenditionConfiguration' => [ 'base' => '

Object that describes which renditions should be recorded for a stream.

', 'refs' => [ 'CreateRecordingConfigurationRequest$renditionConfiguration' => '

Object that describes which renditions should be recorded for a stream.

', 'RecordingConfiguration$renditionConfiguration' => '

Object that describes which renditions should be recorded for a stream.

', ], ], 'RenditionConfigurationRendition' => [ 'base' => NULL, 'refs' => [ 'RenditionConfigurationRenditionList$member' => NULL, ], ], 'RenditionConfigurationRenditionList' => [ 'base' => NULL, 'refs' => [ 'RenditionConfiguration$renditions' => '

Indicates which renditions are recorded for a stream, if renditionSelection is CUSTOM; otherwise, this field is irrelevant. The selected renditions are recorded if they are available during the stream. If a selected rendition is unavailable, the best available rendition is recorded. For details on the resolution dimensions of each rendition, see Auto-Record to Amazon S3.

', ], ], 'RenditionConfigurationRenditionSelection' => [ 'base' => NULL, 'refs' => [ 'RenditionConfiguration$renditionSelection' => '

Indicates which set of renditions are recorded for a stream. For BASIC channels, the CUSTOM value has no effect. If CUSTOM is specified, a set of renditions must be specified in the renditions field. Default: ALL.

', ], ], 'ResourceArn' => [ 'base' => NULL, 'refs' => [ 'BatchError$arn' => '

Channel ARN.

', 'ListTagsForResourceRequest$resourceArn' => '

The ARN of the resource to be retrieved. The ARN must be URL-encoded.

', 'TagResourceRequest$resourceArn' => '

ARN of the resource for which tags are to be added or updated. The ARN must be URL-encoded.

', 'UntagResourceRequest$resourceArn' => '

ARN of the resource for which tags are to be removed. The ARN must be URL-encoded.

', ], ], 'ResourceNotFoundException' => [ 'base' => '

', 'refs' => [], ], 'S3DestinationBucketName' => [ 'base' => NULL, 'refs' => [ 'S3DestinationConfiguration$bucketName' => '

Location (S3 bucket name) where recorded videos will be stored.

', ], ], 'S3DestinationConfiguration' => [ 'base' => '

A complex type that describes an S3 location where recorded videos will be stored.

', 'refs' => [ 'DestinationConfiguration$s3' => '

An S3 destination configuration where recorded videos will be stored.

', ], ], 'ServiceQuotaExceededException' => [ 'base' => '

', 'refs' => [], ], 'StartViewerSessionRevocationRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartViewerSessionRevocationResponse' => [ 'base' => NULL, 'refs' => [], ], 'StopStreamRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopStreamResponse' => [ 'base' => NULL, 'refs' => [], ], 'Stream' => [ 'base' => '

Specifies a live video stream that has been ingested and distributed.

', 'refs' => [ 'GetStreamResponse$stream' => '

', ], ], 'StreamEvent' => [ 'base' => '

Object specifying a stream’s events. For a list of events, see Using Amazon EventBridge with Amazon IVS.

', 'refs' => [ 'StreamEvents$member' => NULL, ], ], 'StreamEvents' => [ 'base' => NULL, 'refs' => [ 'StreamSession$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.

', ], ], 'StreamFilters' => [ 'base' => '

Object specifying the stream attribute on which to filter.

', 'refs' => [ 'ListStreamsRequest$filterBy' => '

Filters the stream list to match the specified criterion.

', ], ], 'StreamHealth' => [ 'base' => NULL, 'refs' => [ 'Stream$health' => '

The stream’s health.

', 'StreamFilters$health' => '

The stream’s health.

', 'StreamSummary$health' => '

The stream’s health.

', ], ], 'StreamId' => [ 'base' => NULL, 'refs' => [ 'GetStreamSessionRequest$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.

', 'Stream$streamId' => '

Unique identifier for a live or previously live stream in the specified channel.

', 'StreamSession$streamId' => '

Unique identifier for a live or previously live stream in the specified channel.

', 'StreamSessionSummary$streamId' => '

Unique identifier for a live or previously live stream in the specified channel.

', 'StreamSummary$streamId' => '

Unique identifier for a live or previously live stream in the specified channel.

', ], ], 'StreamKey' => [ 'base' => '

Object specifying a stream key.

', 'refs' => [ 'CreateChannelResponse$streamKey' => '

', 'CreateStreamKeyResponse$streamKey' => '

Stream key used to authenticate an RTMPS stream for ingestion.

', 'GetStreamKeyResponse$streamKey' => '', 'StreamKeys$member' => NULL, ], ], 'StreamKeyArn' => [ 'base' => NULL, 'refs' => [ 'DeleteStreamKeyRequest$arn' => '

ARN of the stream key to be deleted.

', 'GetStreamKeyRequest$arn' => '

ARN for the stream key to be retrieved.

', 'StreamKey$arn' => '

Stream-key ARN.

', 'StreamKeyArnList$member' => NULL, 'StreamKeySummary$arn' => '

Stream-key ARN.

', ], ], 'StreamKeyArnList' => [ 'base' => NULL, 'refs' => [ 'BatchGetStreamKeyRequest$arns' => '

Array of ARNs, one per stream key.

', ], ], 'StreamKeyList' => [ 'base' => NULL, 'refs' => [ 'ListStreamKeysResponse$streamKeys' => '

List of stream keys.

', ], ], 'StreamKeySummary' => [ 'base' => '

Summary information about a stream key.

', 'refs' => [ 'StreamKeyList$member' => NULL, ], ], 'StreamKeyValue' => [ 'base' => NULL, 'refs' => [ 'StreamKey$value' => '

Stream-key value.

', ], ], 'StreamKeys' => [ 'base' => NULL, 'refs' => [ 'BatchGetStreamKeyResponse$streamKeys' => '

', ], ], 'StreamList' => [ 'base' => NULL, 'refs' => [ 'ListStreamsResponse$streams' => '

List of streams.

', ], ], 'StreamMetadata' => [ 'base' => NULL, 'refs' => [ 'PutMetadataRequest$metadata' => '

Metadata to insert into the stream. Maximum: 1 KB per request.

', ], ], 'StreamSession' => [ 'base' => '

Object that captures the Amazon IVS configuration that the customer provisioned, the ingest configurations that the broadcaster used, and the most recent Amazon IVS stream events it encountered.

', 'refs' => [ 'GetStreamSessionResponse$streamSession' => '

List of stream details.

', ], ], 'StreamSessionList' => [ 'base' => NULL, 'refs' => [ 'ListStreamSessionsResponse$streamSessions' => '

List of stream sessions.

', ], ], 'StreamSessionSummary' => [ 'base' => '

Summary information about a stream session.

', 'refs' => [ 'StreamSessionList$member' => NULL, ], ], 'StreamStartTime' => [ 'base' => NULL, 'refs' => [ 'Stream$startTime' => '

Time of the stream’s start. This is an ISO 8601 timestamp; note that this is returned as a string.

', 'StreamSummary$startTime' => '

Time of the stream’s start. This is an ISO 8601 timestamp; note that this is returned as a string.

', ], ], 'StreamState' => [ 'base' => NULL, 'refs' => [ 'Stream$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.

', 'StreamSummary$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.

', ], ], 'StreamSummary' => [ 'base' => '

Summary information about a stream.

', 'refs' => [ 'StreamList$member' => NULL, ], ], 'StreamUnavailable' => [ 'base' => '

', 'refs' => [], ], 'StreamViewerCount' => [ 'base' => NULL, 'refs' => [ 'Stream$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.

', 'StreamSummary$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.

', ], ], 'String' => [ 'base' => NULL, 'refs' => [ 'AudioConfiguration$codec' => '

Codec used for the audio encoding.

', 'StreamEvent$name' => '

Name that identifies the stream event within a type.

', 'StreamEvent$type' => '

Logical group for certain events.

', 'VideoConfiguration$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.

', 'VideoConfiguration$avcProfile' => '

Indicates to the decoder the requirements for decoding the stream. For definitions of the valid values, see the H.264 specification.

', 'VideoConfiguration$codec' => '

Codec used for the video encoding.

', 'VideoConfiguration$encoder' => '

Software or hardware used to encode the video.

', ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'TagKeyList$member' => NULL, 'Tags$key' => NULL, ], ], 'TagKeyList' => [ 'base' => NULL, 'refs' => [ 'UntagResourceRequest$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.

', ], ], 'TagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'TagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'Tags$value' => NULL, ], ], 'Tags' => [ 'base' => NULL, 'refs' => [ 'Channel$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.

', 'ChannelSummary$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.

', 'CreateChannelRequest$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.

', 'CreateRecordingConfigurationRequest$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.

', 'CreateStreamKeyRequest$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.

', 'ImportPlaybackKeyPairRequest$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.

', 'ListTagsForResourceResponse$tags' => '

Tags attached to the resource. Array of maps, each of the form string:string (key:value).

', 'PlaybackKeyPair$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.

', 'PlaybackKeyPairSummary$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.

', 'RecordingConfiguration$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.

', 'RecordingConfigurationSummary$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.

', 'StreamKey$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.

', 'StreamKeySummary$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.

', 'TagResourceRequest$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.

', ], ], 'TargetIntervalSeconds' => [ 'base' => NULL, 'refs' => [ 'ThumbnailConfiguration$targetIntervalSeconds' => '

The targeted thumbnail-generation interval in seconds. This is configurable (and required) only if recordingMode is INTERVAL. Default: 60.

Important: For the BASIC channel type, 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.

', ], ], 'ThrottlingException' => [ 'base' => '

', 'refs' => [], ], 'ThumbnailConfiguration' => [ 'base' => '

An object representing a configuration of thumbnails for recorded video.

', 'refs' => [ 'CreateRecordingConfigurationRequest$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.

', 'RecordingConfiguration$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.

', ], ], 'ThumbnailConfigurationResolution' => [ 'base' => NULL, 'refs' => [ 'ThumbnailConfiguration$resolution' => '

Indicates the desired resolution of recorded thumbnails. Thumbnails are recorded at the selected resolution if the corresponding rendition is available during the stream; otherwise, they are recorded at source resolution. For more information about resolution values and their corresponding height and width dimensions, see Auto-Record to Amazon S3. Default: Null (source resolution is returned).

', ], ], 'ThumbnailConfigurationStorage' => [ 'base' => NULL, 'refs' => [ 'ThumbnailConfigurationStorageList$member' => NULL, ], ], 'ThumbnailConfigurationStorageList' => [ 'base' => NULL, 'refs' => [ 'ThumbnailConfiguration$storage' => '

Indicates the format in which thumbnails are recorded. SEQUENTIAL records all generated thumbnails in a serial manner, to the media/thumbnails directory. LATEST saves the latest thumbnail in media/latest_thumbnail/thumb.jpg and overwrites it at the interval specified by targetIntervalSeconds. You can enable both SEQUENTIAL and LATEST. Default: SEQUENTIAL.

', ], ], 'Time' => [ 'base' => NULL, 'refs' => [ 'StreamEvent$eventTime' => '

Time when the event occurred. This is an ISO 8601 timestamp; note that this is returned as a string.

', 'StreamSession$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.

', 'StreamSession$startTime' => '

Time when the channel went live. This is an ISO 8601 timestamp; note that this is returned as a string.

', 'StreamSessionSummary$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.

', 'StreamSessionSummary$startTime' => '

Time when the channel went live. This is an ISO 8601 timestamp; note that this is returned as a string.

', ], ], 'TranscodePreset' => [ 'base' => NULL, 'refs' => [ 'Channel$preset' => '

Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string ("").

', 'ChannelSummary$preset' => '

Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string ("").

', 'CreateChannelRequest$preset' => '

Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string ("").

', 'UpdateChannelRequest$preset' => '

Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string ("").

', ], ], 'UntagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UntagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateChannelRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateChannelResponse' => [ 'base' => NULL, 'refs' => [], ], 'ValidationException' => [ 'base' => '

', 'refs' => [], ], 'VideoConfiguration' => [ 'base' => '

Object specifying a stream’s video configuration, as set up by the broadcaster (usually in an encoder). This is part of the IngestConfiguration object and used for monitoring stream health.

', 'refs' => [ 'IngestConfiguration$video' => '

Encoder settings for video.

', ], ], 'ViewerId' => [ 'base' => NULL, 'refs' => [ 'BatchStartViewerSessionRevocationError$viewerId' => '

The ID of the viewer session to revoke.

', 'BatchStartViewerSessionRevocationViewerSession$viewerId' => '

The ID of the viewer associated with the viewer session to revoke. Do not use this field for personally identifying, confidential, or sensitive information.

', 'StartViewerSessionRevocationRequest$viewerId' => '

The ID of the viewer associated with the viewer session to revoke. Do not use this field for personally identifying, confidential, or sensitive information.

', ], ], 'ViewerSessionVersion' => [ 'base' => NULL, 'refs' => [ 'BatchStartViewerSessionRevocationViewerSession$viewerSessionVersionsLessThanOrEqualTo' => '

An optional filter on which versions of the viewer session to revoke. All versions less than or equal to the specified version will be revoked. Default: 0.

', 'StartViewerSessionRevocationRequest$viewerSessionVersionsLessThanOrEqualTo' => '

An optional filter on which versions of the viewer session to revoke. All versions less than or equal to the specified version will be revoked. Default: 0.

', ], ], 'errorCode' => [ 'base' => NULL, 'refs' => [ 'BatchError$code' => '

Error code.

', 'BatchStartViewerSessionRevocationError$code' => '

Error code.

', ], ], 'errorMessage' => [ 'base' => NULL, 'refs' => [ 'AccessDeniedException$exceptionMessage' => '

User does not have sufficient access to perform this action.

', 'BatchError$message' => '

Error message, determined by the application.

', 'BatchStartViewerSessionRevocationError$message' => '

Error message, determined by the application.

', 'ChannelNotBroadcasting$exceptionMessage' => '

The stream is offline for the given channel ARN.

', 'ConflictException$exceptionMessage' => '

Updating or deleting a resource can cause an inconsistent state.

', 'InternalServerException$exceptionMessage' => '

Unexpected error during processing of request.

', 'PendingVerification$exceptionMessage' => '

Your account is pending verification.

', 'ResourceNotFoundException$exceptionMessage' => '

Request references a resource which does not exist.

', 'ServiceQuotaExceededException$exceptionMessage' => '

Request would cause a service quota to be exceeded.

', 'StreamUnavailable$exceptionMessage' => '

The stream is temporarily unavailable.

', 'ThrottlingException$exceptionMessage' => '

Request was denied due to request throttling.

', 'ValidationException$exceptionMessage' => '

The input fails to satisfy the constraints specified by an Amazon Web Services service.

', ], ], ],];