{ "version": "2.0", "metadata": { "apiVersion": "2020-07-14", "auth": [ "aws.auth#sigv4" ], "endpointPrefix": "ivs", "protocol": "rest-json", "protocols": [ "rest-json" ], "serviceAbbreviation": "Amazon IVS", "serviceFullName": "Amazon Interactive Video Service", "serviceId": "ivs", "signatureVersion": "v4", "signingName": "ivs", "uid": "ivs-2020-07-14" }, "operations": { "BatchGetChannel": { "name": "BatchGetChannel", "http": { "method": "POST", "requestUri": "/BatchGetChannel", "responseCode": 200 }, "input": { "shape": "BatchGetChannelRequest" }, "output": { "shape": "BatchGetChannelResponse" }, "documentation": "
Performs GetChannel on multiple ARNs simultaneously.
" }, "BatchGetStreamKey": { "name": "BatchGetStreamKey", "http": { "method": "POST", "requestUri": "/BatchGetStreamKey", "responseCode": 200 }, "input": { "shape": "BatchGetStreamKeyRequest" }, "output": { "shape": "BatchGetStreamKeyResponse" }, "documentation": "Performs GetStreamKey on multiple ARNs simultaneously.
" }, "BatchStartViewerSessionRevocation": { "name": "BatchStartViewerSessionRevocation", "http": { "method": "POST", "requestUri": "/BatchStartViewerSessionRevocation", "responseCode": 200 }, "input": { "shape": "BatchStartViewerSessionRevocationRequest" }, "output": { "shape": "BatchStartViewerSessionRevocationResponse" }, "errors": [ { "shape": "AccessDeniedException" }, { "shape": "ValidationException" }, { "shape": "PendingVerification" }, { "shape": "ThrottlingException" } ], "documentation": "Performs StartViewerSessionRevocation on multiple channel ARN and viewer ID pairs simultaneously.
" }, "CreateChannel": { "name": "CreateChannel", "http": { "method": "POST", "requestUri": "/CreateChannel", "responseCode": 200 }, "input": { "shape": "CreateChannelRequest" }, "output": { "shape": "CreateChannelResponse" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "AccessDeniedException" }, { "shape": "ValidationException" }, { "shape": "PendingVerification" }, { "shape": "ServiceQuotaExceededException" } ], "documentation": "Creates a new channel and an associated stream key to start streaming.
" }, "CreatePlaybackRestrictionPolicy": { "name": "CreatePlaybackRestrictionPolicy", "http": { "method": "POST", "requestUri": "/CreatePlaybackRestrictionPolicy", "responseCode": 200 }, "input": { "shape": "CreatePlaybackRestrictionPolicyRequest" }, "output": { "shape": "CreatePlaybackRestrictionPolicyResponse" }, "errors": [ { "shape": "AccessDeniedException" }, { "shape": "ValidationException" }, { "shape": "PendingVerification" }, { "shape": "ThrottlingException" }, { "shape": "ServiceQuotaExceededException" } ], "documentation": "Creates a new playback restriction policy, for constraining playback by countries and/or origins.
" }, "CreateRecordingConfiguration": { "name": "CreateRecordingConfiguration", "http": { "method": "POST", "requestUri": "/CreateRecordingConfiguration", "responseCode": 200 }, "input": { "shape": "CreateRecordingConfigurationRequest" }, "output": { "shape": "CreateRecordingConfigurationResponse" }, "errors": [ { "shape": "InternalServerException" }, { "shape": "AccessDeniedException" }, { "shape": "ValidationException" }, { "shape": "PendingVerification" }, { "shape": "ConflictException" }, { "shape": "ServiceQuotaExceededException" } ], "documentation": "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": { "name": "CreateStreamKey", "http": { "method": "POST", "requestUri": "/CreateStreamKey", "responseCode": 200 }, "input": { "shape": "CreateStreamKeyRequest" }, "output": { "shape": "CreateStreamKeyResponse" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "AccessDeniedException" }, { "shape": "ValidationException" }, { "shape": "PendingVerification" }, { "shape": "ServiceQuotaExceededException" } ], "documentation": "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": { "name": "DeleteChannel", "http": { "method": "POST", "requestUri": "/DeleteChannel", "responseCode": 204 }, "input": { "shape": "DeleteChannelRequest" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "AccessDeniedException" }, { "shape": "ValidationException" }, { "shape": "PendingVerification" }, { "shape": "ConflictException" } ], "documentation": "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": { "name": "DeletePlaybackKeyPair", "http": { "method": "POST", "requestUri": "/DeletePlaybackKeyPair", "responseCode": 200 }, "input": { "shape": "DeletePlaybackKeyPairRequest" }, "output": { "shape": "DeletePlaybackKeyPairResponse" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "AccessDeniedException" }, { "shape": "ValidationException" }, { "shape": "PendingVerification" } ], "documentation": "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.
Deletes the specified playback restriction policy.
" }, "DeleteRecordingConfiguration": { "name": "DeleteRecordingConfiguration", "http": { "method": "POST", "requestUri": "/DeleteRecordingConfiguration", "responseCode": 204 }, "input": { "shape": "DeleteRecordingConfigurationRequest" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "InternalServerException" }, { "shape": "AccessDeniedException" }, { "shape": "ValidationException" }, { "shape": "ConflictException" } ], "documentation": "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.
Deletes the stream key for the specified ARN, so it can no longer be used to stream.
" }, "GetChannel": { "name": "GetChannel", "http": { "method": "POST", "requestUri": "/GetChannel", "responseCode": 200 }, "input": { "shape": "GetChannelRequest" }, "output": { "shape": "GetChannelResponse" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "AccessDeniedException" }, { "shape": "ValidationException" } ], "documentation": "Gets the channel configuration for the specified channel ARN. See also BatchGetChannel.
" }, "GetPlaybackKeyPair": { "name": "GetPlaybackKeyPair", "http": { "method": "POST", "requestUri": "/GetPlaybackKeyPair", "responseCode": 200 }, "input": { "shape": "GetPlaybackKeyPairRequest" }, "output": { "shape": "GetPlaybackKeyPairResponse" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "AccessDeniedException" }, { "shape": "ValidationException" } ], "documentation": "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.
Gets the specified playback restriction policy.
" }, "GetRecordingConfiguration": { "name": "GetRecordingConfiguration", "http": { "method": "POST", "requestUri": "/GetRecordingConfiguration", "responseCode": 200 }, "input": { "shape": "GetRecordingConfigurationRequest" }, "output": { "shape": "GetRecordingConfigurationResponse" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "InternalServerException" }, { "shape": "AccessDeniedException" }, { "shape": "ValidationException" } ], "documentation": "Gets the recording configuration for the specified ARN.
" }, "GetStream": { "name": "GetStream", "http": { "method": "POST", "requestUri": "/GetStream", "responseCode": 200 }, "input": { "shape": "GetStreamRequest" }, "output": { "shape": "GetStreamResponse" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "AccessDeniedException" }, { "shape": "ValidationException" }, { "shape": "ChannelNotBroadcasting" } ], "documentation": "Gets information about the active (live) stream on a specified channel.
" }, "GetStreamKey": { "name": "GetStreamKey", "http": { "method": "POST", "requestUri": "/GetStreamKey", "responseCode": 200 }, "input": { "shape": "GetStreamKeyRequest" }, "output": { "shape": "GetStreamKeyResponse" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "AccessDeniedException" }, { "shape": "ValidationException" } ], "documentation": "Gets stream-key information for a specified ARN.
" }, "GetStreamSession": { "name": "GetStreamSession", "http": { "method": "POST", "requestUri": "/GetStreamSession", "responseCode": 200 }, "input": { "shape": "GetStreamSessionRequest" }, "output": { "shape": "GetStreamSessionResponse" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "AccessDeniedException" }, { "shape": "ValidationException" } ], "documentation": "Gets metadata on a specified stream.
" }, "ImportPlaybackKeyPair": { "name": "ImportPlaybackKeyPair", "http": { "method": "POST", "requestUri": "/ImportPlaybackKeyPair", "responseCode": 200 }, "input": { "shape": "ImportPlaybackKeyPairRequest" }, "output": { "shape": "ImportPlaybackKeyPairResponse" }, "errors": [ { "shape": "AccessDeniedException" }, { "shape": "ValidationException" }, { "shape": "PendingVerification" }, { "shape": "ConflictException" }, { "shape": "ServiceQuotaExceededException" } ], "documentation": "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.
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": { "name": "ListPlaybackKeyPairs", "http": { "method": "POST", "requestUri": "/ListPlaybackKeyPairs", "responseCode": 200 }, "input": { "shape": "ListPlaybackKeyPairsRequest" }, "output": { "shape": "ListPlaybackKeyPairsResponse" }, "errors": [ { "shape": "AccessDeniedException" }, { "shape": "ValidationException" } ], "documentation": "Gets summary information about playback key pairs. For more information, see Setting Up Private Channels in the Amazon IVS User Guide.
" }, "ListPlaybackRestrictionPolicies": { "name": "ListPlaybackRestrictionPolicies", "http": { "method": "POST", "requestUri": "/ListPlaybackRestrictionPolicies", "responseCode": 200 }, "input": { "shape": "ListPlaybackRestrictionPoliciesRequest" }, "output": { "shape": "ListPlaybackRestrictionPoliciesResponse" }, "errors": [ { "shape": "AccessDeniedException" }, { "shape": "ValidationException" }, { "shape": "PendingVerification" }, { "shape": "ConflictException" } ], "documentation": "Gets summary information about playback restriction policies.
" }, "ListRecordingConfigurations": { "name": "ListRecordingConfigurations", "http": { "method": "POST", "requestUri": "/ListRecordingConfigurations", "responseCode": 200 }, "input": { "shape": "ListRecordingConfigurationsRequest" }, "output": { "shape": "ListRecordingConfigurationsResponse" }, "errors": [ { "shape": "InternalServerException" }, { "shape": "AccessDeniedException" }, { "shape": "ValidationException" } ], "documentation": "Gets summary information about all recording configurations in your account, in the Amazon Web Services region where the API request is processed.
" }, "ListStreamKeys": { "name": "ListStreamKeys", "http": { "method": "POST", "requestUri": "/ListStreamKeys", "responseCode": 200 }, "input": { "shape": "ListStreamKeysRequest" }, "output": { "shape": "ListStreamKeysResponse" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "AccessDeniedException" }, { "shape": "ValidationException" } ], "documentation": "Gets summary information about stream keys for the specified channel.
" }, "ListStreamSessions": { "name": "ListStreamSessions", "http": { "method": "POST", "requestUri": "/ListStreamSessions", "responseCode": 200 }, "input": { "shape": "ListStreamSessionsRequest" }, "output": { "shape": "ListStreamSessionsResponse" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "AccessDeniedException" }, { "shape": "ValidationException" } ], "documentation": "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": { "name": "ListStreams", "http": { "method": "POST", "requestUri": "/ListStreams", "responseCode": 200 }, "input": { "shape": "ListStreamsRequest" }, "output": { "shape": "ListStreamsResponse" }, "errors": [ { "shape": "AccessDeniedException" }, { "shape": "ValidationException" } ], "documentation": "Gets summary information about live streams in your account, in the Amazon Web Services region where the API request is processed.
" }, "ListTagsForResource": { "name": "ListTagsForResource", "http": { "method": "GET", "requestUri": "/tags/{resourceArn}", "responseCode": 200 }, "input": { "shape": "ListTagsForResourceRequest" }, "output": { "shape": "ListTagsForResourceResponse" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "InternalServerException" }, { "shape": "ValidationException" } ], "documentation": "Gets information about Amazon Web Services tags for the specified ARN.
" }, "PutMetadata": { "name": "PutMetadata", "http": { "method": "POST", "requestUri": "/PutMetadata", "responseCode": 204 }, "input": { "shape": "PutMetadataRequest" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "AccessDeniedException" }, { "shape": "ValidationException" }, { "shape": "ChannelNotBroadcasting" }, { "shape": "ThrottlingException" } ], "documentation": "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": { "name": "StartViewerSessionRevocation", "http": { "method": "POST", "requestUri": "/StartViewerSessionRevocation", "responseCode": 200 }, "input": { "shape": "StartViewerSessionRevocationRequest" }, "output": { "shape": "StartViewerSessionRevocationResponse" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "InternalServerException" }, { "shape": "AccessDeniedException" }, { "shape": "ValidationException" }, { "shape": "PendingVerification" }, { "shape": "ThrottlingException" } ], "documentation": "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": { "name": "StopStream", "http": { "method": "POST", "requestUri": "/StopStream", "responseCode": 200 }, "input": { "shape": "StopStreamRequest" }, "output": { "shape": "StopStreamResponse" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "AccessDeniedException" }, { "shape": "ValidationException" }, { "shape": "ChannelNotBroadcasting" }, { "shape": "StreamUnavailable" } ], "documentation": "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.
Adds or updates tags for the Amazon Web Services resource with the specified ARN.
" }, "UntagResource": { "name": "UntagResource", "http": { "method": "DELETE", "requestUri": "/tags/{resourceArn}", "responseCode": 200 }, "input": { "shape": "UntagResourceRequest" }, "output": { "shape": "UntagResourceResponse" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "InternalServerException" }, { "shape": "ValidationException" } ], "documentation": "Removes tags from the resource with the specified ARN.
", "idempotent": true }, "UpdateChannel": { "name": "UpdateChannel", "http": { "method": "POST", "requestUri": "/UpdateChannel", "responseCode": 200 }, "input": { "shape": "UpdateChannelRequest" }, "output": { "shape": "UpdateChannelResponse" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "AccessDeniedException" }, { "shape": "ValidationException" }, { "shape": "PendingVerification" }, { "shape": "ConflictException" } ], "documentation": "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.
" }, "UpdatePlaybackRestrictionPolicy": { "name": "UpdatePlaybackRestrictionPolicy", "http": { "method": "POST", "requestUri": "/UpdatePlaybackRestrictionPolicy", "responseCode": 200 }, "input": { "shape": "UpdatePlaybackRestrictionPolicyRequest" }, "output": { "shape": "UpdatePlaybackRestrictionPolicyResponse" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "AccessDeniedException" }, { "shape": "ValidationException" }, { "shape": "PendingVerification" }, { "shape": "ConflictException" } ], "documentation": "Updates a specified playback restriction policy.
" } }, "shapes": { "AudioConfiguration": { "type": "structure", "members": { "codec": { "shape": "String", "documentation": "Codec used for the audio encoding.
" }, "targetBitrate": { "shape": "Integer", "documentation": "The expected ingest bitrate (bits per second). This is configured in the encoder.
" }, "sampleRate": { "shape": "Integer", "documentation": "Number of audio samples recorded per second.
" }, "channels": { "shape": "Integer", "documentation": "Number of audio channels.
" } }, "documentation": "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.
" }, "BatchError": { "type": "structure", "members": { "arn": { "shape": "ResourceArn", "documentation": "ARN of an IVS resource; e.g., channel.
" }, "code": { "shape": "errorCode", "documentation": "Error code.
" }, "message": { "shape": "errorMessage", "documentation": "Error message, determined by the application.
" } }, "documentation": "Error related to a specific channel, specified by its ARN.
" }, "BatchErrors": { "type": "list", "member": { "shape": "BatchError" } }, "BatchGetChannelRequest": { "type": "structure", "required": [ "arns" ], "members": { "arns": { "shape": "ChannelArnList", "documentation": "Array of ARNs, one per channel.
" } } }, "BatchGetChannelResponse": { "type": "structure", "members": { "channels": { "shape": "Channels", "documentation": "" }, "errors": { "shape": "BatchErrors", "documentation": "Each error object is related to a specific ARN in the request.
" } } }, "BatchGetStreamKeyRequest": { "type": "structure", "required": [ "arns" ], "members": { "arns": { "shape": "StreamKeyArnList", "documentation": "Array of ARNs, one per stream key.
" } } }, "BatchGetStreamKeyResponse": { "type": "structure", "members": { "streamKeys": { "shape": "StreamKeys", "documentation": "" }, "errors": { "shape": "BatchErrors", "documentation": "" } } }, "BatchStartViewerSessionRevocationError": { "type": "structure", "required": [ "channelArn", "viewerId" ], "members": { "channelArn": { "shape": "ChannelArn", "documentation": "Channel ARN.
" }, "viewerId": { "shape": "ViewerId", "documentation": "The ID of the viewer session to revoke.
" }, "code": { "shape": "errorCode", "documentation": "Error code.
" }, "message": { "shape": "errorMessage", "documentation": "Error message, determined by the application.
" } }, "documentation": "Error for a request in the batch for BatchStartViewerSessionRevocation. Each error is related to a specific channel-ARN and viewer-ID pair.
" }, "BatchStartViewerSessionRevocationErrors": { "type": "list", "member": { "shape": "BatchStartViewerSessionRevocationError" } }, "BatchStartViewerSessionRevocationRequest": { "type": "structure", "required": [ "viewerSessions" ], "members": { "viewerSessions": { "shape": "BatchStartViewerSessionRevocationViewerSessionList", "documentation": "Array of viewer sessions, one per channel-ARN and viewer-ID pair.
" } } }, "BatchStartViewerSessionRevocationResponse": { "type": "structure", "members": { "errors": { "shape": "BatchStartViewerSessionRevocationErrors", "documentation": "Each error object is related to a specific channelArn
and viewerId
pair in the request.
The ARN of the channel associated with the viewer session to revoke.
" }, "viewerId": { "shape": "ViewerId", "documentation": "The ID of the viewer associated with the viewer session to revoke. Do not use this field for personally identifying, confidential, or sensitive information.
" }, "viewerSessionVersionsLessThanOrEqualTo": { "shape": "ViewerSessionVersion", "documentation": "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.
" } }, "documentation": "A viewer session to revoke in the call to BatchStartViewerSessionRevocation.
" }, "BatchStartViewerSessionRevocationViewerSessionList": { "type": "list", "member": { "shape": "BatchStartViewerSessionRevocationViewerSession" }, "max": 20, "min": 1 }, "Boolean": { "type": "boolean" }, "Channel": { "type": "structure", "members": { "arn": { "shape": "ChannelArn", "documentation": "Channel ARN.
" }, "name": { "shape": "ChannelName", "documentation": "Channel name.
" }, "latencyMode": { "shape": "ChannelLatencyMode", "documentation": "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
.
Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD
. For details, see Channel Types.
Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables recording. Default: \"\" (empty string, recording is disabled).
" }, "ingestEndpoint": { "shape": "IngestEndpoint", "documentation": "Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.
" }, "playbackUrl": { "shape": "PlaybackURL", "documentation": "Channel playback URL.
" }, "authorized": { "shape": "IsAuthorized", "documentation": "Whether the channel is private (enabled for playback authorization). Default: false
.
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.
Whether the channel allows insecure RTMP ingest. Default: false
.
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 (\"\"
).
Specifies the endpoint and optional passphrase for streaming with the SRT protocol.
" }, "playbackRestrictionPolicyArn": { "shape": "ChannelPlaybackRestrictionPolicyArn", "documentation": "Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction. Default: \"\" (empty string, no playback restriction policy is applied).
" } }, "documentation": "Object specifying a channel.
" }, "ChannelArn": { "type": "string", "max": 128, "min": 1, "pattern": "arn:aws:ivs:[a-z0-9-]+:[0-9]+:channel/[a-zA-Z0-9-]+" }, "ChannelArnList": { "type": "list", "member": { "shape": "ChannelArn" }, "max": 50, "min": 1 }, "ChannelLatencyMode": { "type": "string", "enum": [ "NORMAL", "LOW" ] }, "ChannelList": { "type": "list", "member": { "shape": "ChannelSummary" } }, "ChannelName": { "type": "string", "max": 128, "min": 0, "pattern": "[a-zA-Z0-9-_]*" }, "ChannelPlaybackRestrictionPolicyArn": { "type": "string", "max": 128, "min": 0, "pattern": "^$|^arn:aws:ivs:[a-z0-9-]+:[0-9]+:playback-restriction-policy/[a-zA-Z0-9-]+$" }, "ChannelRecordingConfigurationArn": { "type": "string", "max": 128, "min": 0, "pattern": "^$|^arn:aws:ivs:[a-z0-9-]+:[0-9]+:recording-configuration/[a-zA-Z0-9-]+$" }, "ChannelSummary": { "type": "structure", "members": { "arn": { "shape": "ChannelArn", "documentation": "Channel ARN.
" }, "name": { "shape": "ChannelName", "documentation": "Channel name.
" }, "latencyMode": { "shape": "ChannelLatencyMode", "documentation": "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
.
Whether the channel is private (enabled for playback authorization). Default: false
.
Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables recording. Default: \"\" (empty string, recording is disabled).
" }, "tags": { "shape": "Tags", "documentation": "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.
Whether the channel allows insecure RTMP ingest. Default: false
.
Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD
. For details, see Channel Types.
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 (\"\"
).
Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction. Default: \"\" (empty string, no playback restriction policy is applied).
" } }, "documentation": "Summary information about a channel.
" }, "ChannelType": { "type": "string", "enum": [ "BASIC", "STANDARD", "ADVANCED_SD", "ADVANCED_HD" ] }, "Channels": { "type": "list", "member": { "shape": "Channel" } }, "CreateChannelRequest": { "type": "structure", "members": { "name": { "shape": "ChannelName", "documentation": "Channel name.
" }, "latencyMode": { "shape": "ChannelLatencyMode", "documentation": "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
.
Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD
. For details, see Channel Types.
Whether the channel is private (enabled for playback authorization). Default: false
.
Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables recording. Default: \"\" (empty string, recording is disabled).
" }, "tags": { "shape": "Tags", "documentation": "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.
Whether the channel allows insecure RTMP and SRT ingest. Default: false
.
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 (\"\"
).
Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction. Default: \"\" (empty string, no playback restriction policy is applied).
" } } }, "CreateChannelResponse": { "type": "structure", "members": { "channel": { "shape": "Channel", "documentation": "" }, "streamKey": { "shape": "StreamKey", "documentation": "" } } }, "CreatePlaybackRestrictionPolicyRequest": { "type": "structure", "members": { "allowedCountries": { "shape": "PlaybackRestrictionPolicyAllowedCountryList", "documentation": "A list of country codes that control geoblocking restriction. Allowed values are the officially assigned ISO 3166-1 alpha-2 codes. Default: All countries (an empty array).
" }, "allowedOrigins": { "shape": "PlaybackRestrictionPolicyAllowedOriginList", "documentation": "A list of origin sites that control CORS restriction. Allowed values are the same as valid values of the Origin header defined at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin. Default: All origins (an empty array).
" }, "enableStrictOriginEnforcement": { "shape": "PlaybackRestrictionPolicyEnableStrictOriginEnforcement", "documentation": "Whether channel playback is constrained by origin site. Default: false
.
Playback-restriction-policy name. The value does not need to be unique.
" }, "tags": { "shape": "Tags", "documentation": "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.
Recording-configuration name. The value does not need to be unique.
" }, "destinationConfiguration": { "shape": "DestinationConfiguration", "documentation": "A complex type that contains a destination configuration for where recorded video will be stored.
" }, "tags": { "shape": "Tags", "documentation": "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.
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.
" }, "recordingReconnectWindowSeconds": { "shape": "RecordingReconnectWindowSeconds", "documentation": "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": { "shape": "RenditionConfiguration", "documentation": "Object that describes which renditions should be recorded for a stream.
" } } }, "CreateRecordingConfigurationResponse": { "type": "structure", "members": { "recordingConfiguration": { "shape": "RecordingConfiguration", "documentation": "ARN of the channel for which to create the stream key.
" }, "tags": { "shape": "Tags", "documentation": "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.
Stream key used to authenticate an RTMPS stream for ingestion.
" } } }, "DeleteChannelRequest": { "type": "structure", "required": [ "arn" ], "members": { "arn": { "shape": "ChannelArn", "documentation": "ARN of the channel to be deleted.
" } } }, "DeletePlaybackKeyPairRequest": { "type": "structure", "required": [ "arn" ], "members": { "arn": { "shape": "PlaybackKeyPairArn", "documentation": "ARN of the key pair to be deleted.
" } } }, "DeletePlaybackKeyPairResponse": { "type": "structure", "members": {} }, "DeletePlaybackRestrictionPolicyRequest": { "type": "structure", "required": [ "arn" ], "members": { "arn": { "shape": "PlaybackRestrictionPolicyArn", "documentation": "ARN of the playback restriction policy to be deleted.
" } } }, "DeleteRecordingConfigurationRequest": { "type": "structure", "required": [ "arn" ], "members": { "arn": { "shape": "RecordingConfigurationArn", "documentation": "ARN of the recording configuration to be deleted.
" } } }, "DeleteStreamKeyRequest": { "type": "structure", "required": [ "arn" ], "members": { "arn": { "shape": "StreamKeyArn", "documentation": "ARN of the stream key to be deleted.
" } } }, "DestinationConfiguration": { "type": "structure", "members": { "s3": { "shape": "S3DestinationConfiguration", "documentation": "An S3 destination configuration where recorded videos will be stored.
" } }, "documentation": "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.
" }, "GetChannelRequest": { "type": "structure", "required": [ "arn" ], "members": { "arn": { "shape": "ChannelArn", "documentation": "ARN of the channel for which the configuration is to be retrieved.
" } } }, "GetChannelResponse": { "type": "structure", "members": { "channel": { "shape": "Channel", "documentation": "" } } }, "GetPlaybackKeyPairRequest": { "type": "structure", "required": [ "arn" ], "members": { "arn": { "shape": "PlaybackKeyPairArn", "documentation": "ARN of the key pair to be returned.
" } } }, "GetPlaybackKeyPairResponse": { "type": "structure", "members": { "keyPair": { "shape": "PlaybackKeyPair", "documentation": "ARN of the playback restriction policy to be returned.
" } } }, "GetPlaybackRestrictionPolicyResponse": { "type": "structure", "members": { "playbackRestrictionPolicy": { "shape": "PlaybackRestrictionPolicy", "documentation": "" } } }, "GetRecordingConfigurationRequest": { "type": "structure", "required": [ "arn" ], "members": { "arn": { "shape": "RecordingConfigurationArn", "documentation": "ARN of the recording configuration to be retrieved.
" } } }, "GetRecordingConfigurationResponse": { "type": "structure", "members": { "recordingConfiguration": { "shape": "RecordingConfiguration", "documentation": "ARN for the stream key to be retrieved.
" } } }, "GetStreamKeyResponse": { "type": "structure", "members": { "streamKey": { "shape": "StreamKey", "documentation": "Channel ARN for stream to be accessed.
" } } }, "GetStreamResponse": { "type": "structure", "members": { "stream": { "shape": "Stream", "documentation": "" } } }, "GetStreamSessionRequest": { "type": "structure", "required": [ "channelArn" ], "members": { "channelArn": { "shape": "ChannelArn", "documentation": "ARN of the channel resource
" }, "streamId": { "shape": "StreamId", "documentation": "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.
List of stream details.
" } } }, "ImportPlaybackKeyPairRequest": { "type": "structure", "required": [ "publicKeyMaterial" ], "members": { "publicKeyMaterial": { "shape": "PlaybackPublicKeyMaterial", "documentation": "The public portion of a customer-generated key pair.
" }, "name": { "shape": "PlaybackKeyPairName", "documentation": "Playback-key-pair name. The value does not need to be unique.
" }, "tags": { "shape": "Tags", "documentation": "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.
" } } }, "ImportPlaybackKeyPairResponse": { "type": "structure", "members": { "keyPair": { "shape": "PlaybackKeyPair", "documentation": "" } } }, "IngestConfiguration": { "type": "structure", "members": { "video": { "shape": "VideoConfiguration", "documentation": "Encoder settings for video.
" }, "audio": { "shape": "AudioConfiguration", "documentation": "Encoder settings for audio.
" } }, "documentation": "Object specifying the ingest configuration set up by the broadcaster, usually in an encoder.
" }, "IngestEndpoint": { "type": "string" }, "InsecureIngest": { "type": "boolean" }, "Integer": { "type": "long" }, "IsAuthorized": { "type": "boolean" }, "ListChannelsRequest": { "type": "structure", "members": { "filterByName": { "shape": "ChannelName", "documentation": "Filters the channel list to match the specified name.
" }, "filterByRecordingConfigurationArn": { "shape": "ChannelRecordingConfigurationArn", "documentation": "Filters the channel list to match the specified recording-configuration ARN.
" }, "filterByPlaybackRestrictionPolicyArn": { "shape": "ChannelPlaybackRestrictionPolicyArn", "documentation": "Filters the channel list to match the specified policy.
" }, "nextToken": { "shape": "PaginationToken", "documentation": "The first channel to retrieve. This is used for pagination; see the nextToken
response field.
Maximum number of channels to return. Default: 100.
" } } }, "ListChannelsResponse": { "type": "structure", "required": [ "channels" ], "members": { "channels": { "shape": "ChannelList", "documentation": "List of the matching channels.
" }, "nextToken": { "shape": "PaginationToken", "documentation": "If there are more channels than maxResults
, use nextToken
in the request to get the next set.
The first key pair to retrieve. This is used for pagination; see the nextToken
response field.
Maximum number of key pairs to return. Default: your service quota or 100, whichever is smaller.
" } } }, "ListPlaybackKeyPairsResponse": { "type": "structure", "required": [ "keyPairs" ], "members": { "keyPairs": { "shape": "PlaybackKeyPairList", "documentation": "List of key pairs.
" }, "nextToken": { "shape": "PaginationToken", "documentation": "If there are more key pairs than maxResults
, use nextToken
in the request to get the next set.
The first policy to retrieve. This is used for pagination; see the nextToken
response field.
Maximum number of policies to return. Default: 1.
" } } }, "ListPlaybackRestrictionPoliciesResponse": { "type": "structure", "required": [ "playbackRestrictionPolicies" ], "members": { "playbackRestrictionPolicies": { "shape": "PlaybackRestrictionPolicyList", "documentation": "List of the matching policies.
" }, "nextToken": { "shape": "PaginationToken", "documentation": "If there are more channels than maxResults
, use nextToken
in the request to get the next set.
The first recording configuration to retrieve. This is used for pagination; see the nextToken
response field.
Maximum number of recording configurations to return. Default: your service quota or 100, whichever is smaller.
" } } }, "ListRecordingConfigurationsResponse": { "type": "structure", "required": [ "recordingConfigurations" ], "members": { "recordingConfigurations": { "shape": "RecordingConfigurationList", "documentation": "List of the matching recording configurations.
" }, "nextToken": { "shape": "PaginationToken", "documentation": "If there are more recording configurations than maxResults
, use nextToken
in the request to get the next set.
Channel ARN used to filter the list.
" }, "nextToken": { "shape": "PaginationToken", "documentation": "The first stream key to retrieve. This is used for pagination; see the nextToken
response field.
Maximum number of streamKeys to return. Default: 1.
" } } }, "ListStreamKeysResponse": { "type": "structure", "required": [ "streamKeys" ], "members": { "streamKeys": { "shape": "StreamKeyList", "documentation": "List of stream keys.
" }, "nextToken": { "shape": "PaginationToken", "documentation": "If there are more stream keys than maxResults
, use nextToken
in the request to get the next set.
Channel ARN used to filter the list.
" }, "nextToken": { "shape": "PaginationToken", "documentation": "The first stream to retrieve. This is used for pagination; see the nextToken
response field.
Maximum number of streams to return. Default: 100.
" } } }, "ListStreamSessionsResponse": { "type": "structure", "required": [ "streamSessions" ], "members": { "streamSessions": { "shape": "StreamSessionList", "documentation": "List of stream sessions.
" }, "nextToken": { "shape": "PaginationToken", "documentation": "If there are more streams than maxResults
, use nextToken
in the request to get the next set.
Filters the stream list to match the specified criterion.
" }, "nextToken": { "shape": "PaginationToken", "documentation": "The first stream to retrieve. This is used for pagination; see the nextToken
response field.
Maximum number of streams to return. Default: 100.
" } } }, "ListStreamsResponse": { "type": "structure", "required": [ "streams" ], "members": { "streams": { "shape": "StreamList", "documentation": "List of streams.
" }, "nextToken": { "shape": "PaginationToken", "documentation": "If there are more streams than maxResults
, use nextToken
in the request to get the next set.
The ARN of the resource to be retrieved. The ARN must be URL-encoded.
", "location": "uri", "locationName": "resourceArn" } } }, "ListTagsForResourceResponse": { "type": "structure", "required": [ "tags" ], "members": { "tags": { "shape": "Tags", "documentation": "Tags attached to the resource. Array of maps, each of the form string:string (key:value)
.
Key-pair ARN.
" }, "name": { "shape": "PlaybackKeyPairName", "documentation": "Playback-key-pair name. The value does not need to be unique.
" }, "fingerprint": { "shape": "PlaybackKeyPairFingerprint", "documentation": "Key-pair identifier.
" }, "tags": { "shape": "Tags", "documentation": "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.
A key pair used to sign and validate a playback authorization token.
" }, "PlaybackKeyPairArn": { "type": "string", "max": 128, "min": 1, "pattern": "arn:aws:ivs:[a-z0-9-]+:[0-9]+:playback-key/[a-zA-Z0-9-]+" }, "PlaybackKeyPairFingerprint": { "type": "string" }, "PlaybackKeyPairList": { "type": "list", "member": { "shape": "PlaybackKeyPairSummary" } }, "PlaybackKeyPairName": { "type": "string", "max": 128, "min": 0, "pattern": "[a-zA-Z0-9-_]*" }, "PlaybackKeyPairSummary": { "type": "structure", "members": { "arn": { "shape": "PlaybackKeyPairArn", "documentation": "Key-pair ARN.
" }, "name": { "shape": "PlaybackKeyPairName", "documentation": "Playback-key-pair name. The value does not need to be unique.
" }, "tags": { "shape": "Tags", "documentation": "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.
Summary information about a playback key pair.
" }, "PlaybackPublicKeyMaterial": { "type": "string" }, "PlaybackRestrictionPolicy": { "type": "structure", "required": [ "arn", "allowedCountries", "allowedOrigins" ], "members": { "arn": { "shape": "PlaybackRestrictionPolicyArn", "documentation": "Playback-restriction-policy ARN
" }, "allowedCountries": { "shape": "PlaybackRestrictionPolicyAllowedCountryList", "documentation": "A list of country codes that control geoblocking restriction. Allowed values are the officially assigned ISO 3166-1 alpha-2 codes. Default: All countries (an empty array).
" }, "allowedOrigins": { "shape": "PlaybackRestrictionPolicyAllowedOriginList", "documentation": "A list of origin sites that control CORS restriction. Allowed values are the same as valid values of the Origin header defined at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin. Default: All origins (an empty array).
" }, "enableStrictOriginEnforcement": { "shape": "PlaybackRestrictionPolicyEnableStrictOriginEnforcement", "documentation": "Whether channel playback is constrained by origin site. Default: false
.
Playback-restriction-policy name. The value does not need to be unique.
" }, "tags": { "shape": "Tags", "documentation": "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.
An object representing a policy to constrain playback by country and/or origin sites.
" }, "PlaybackRestrictionPolicyAllowedCountry": { "type": "string", "max": 2, "min": 2 }, "PlaybackRestrictionPolicyAllowedCountryList": { "type": "list", "member": { "shape": "PlaybackRestrictionPolicyAllowedCountry" } }, "PlaybackRestrictionPolicyAllowedOrigin": { "type": "string", "max": 128, "min": 0 }, "PlaybackRestrictionPolicyAllowedOriginList": { "type": "list", "member": { "shape": "PlaybackRestrictionPolicyAllowedOrigin" } }, "PlaybackRestrictionPolicyArn": { "type": "string", "max": 128, "min": 1, "pattern": "arn:aws:ivs:[a-z0-9-]+:[0-9]+:playback-restriction-policy/[a-zA-Z0-9-]+" }, "PlaybackRestrictionPolicyEnableStrictOriginEnforcement": { "type": "boolean", "box": true }, "PlaybackRestrictionPolicyList": { "type": "list", "member": { "shape": "PlaybackRestrictionPolicySummary" } }, "PlaybackRestrictionPolicyName": { "type": "string", "max": 128, "min": 0, "pattern": "[a-zA-Z0-9-_]*" }, "PlaybackRestrictionPolicySummary": { "type": "structure", "required": [ "arn", "allowedCountries", "allowedOrigins" ], "members": { "arn": { "shape": "PlaybackRestrictionPolicyArn", "documentation": "Playback-restriction-policy ARN
" }, "allowedCountries": { "shape": "PlaybackRestrictionPolicyAllowedCountryList", "documentation": "A list of country codes that control geoblocking restriction. Allowed values are the officially assigned ISO 3166-1 alpha-2 codes. Default: All countries (an empty array).
" }, "allowedOrigins": { "shape": "PlaybackRestrictionPolicyAllowedOriginList", "documentation": "A list of origin sites that control CORS restriction. Allowed values are the same as valid values of the Origin header defined at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin. Default: All origins (an empty array).
" }, "enableStrictOriginEnforcement": { "shape": "PlaybackRestrictionPolicyEnableStrictOriginEnforcement", "documentation": "Whether channel playback is constrained by origin site. Default: false
.
Playback-restriction-policy name. The value does not need to be unique.
" }, "tags": { "shape": "Tags", "documentation": "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.
Summary information about a PlaybackRestrictionPolicy.
" }, "PlaybackURL": { "type": "string" }, "PutMetadataRequest": { "type": "structure", "required": [ "channelArn", "metadata" ], "members": { "channelArn": { "shape": "ChannelArn", "documentation": "ARN of the channel into which metadata is inserted. This channel must have an active stream.
" }, "metadata": { "shape": "StreamMetadata", "documentation": "Metadata to insert into the stream. Maximum: 1 KB per request.
" } } }, "RecordingConfiguration": { "type": "structure", "required": [ "arn", "destinationConfiguration", "state" ], "members": { "arn": { "shape": "RecordingConfigurationArn", "documentation": "Recording-configuration ARN.
" }, "name": { "shape": "RecordingConfigurationName", "documentation": "Recording-configuration name. The value does not need to be unique.
" }, "destinationConfiguration": { "shape": "DestinationConfiguration", "documentation": "A complex type that contains information about where recorded video will be stored.
" }, "state": { "shape": "RecordingConfigurationState", "documentation": "Indicates the current state of the recording configuration. When the state is ACTIVE
, the configuration is ready for recording a channel stream.
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.
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.
" }, "recordingReconnectWindowSeconds": { "shape": "RecordingReconnectWindowSeconds", "documentation": "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": { "shape": "RenditionConfiguration", "documentation": "Object that describes which renditions should be recorded for a stream.
" } }, "documentation": "An object representing a configuration to record a channel stream.
" }, "RecordingConfigurationArn": { "type": "string", "max": 128, "min": 0, "pattern": "arn:aws:ivs:[a-z0-9-]+:[0-9]+:recording-configuration/[a-zA-Z0-9-]+" }, "RecordingConfigurationList": { "type": "list", "member": { "shape": "RecordingConfigurationSummary" } }, "RecordingConfigurationName": { "type": "string", "max": 128, "min": 0, "pattern": "[a-zA-Z0-9-_]*" }, "RecordingConfigurationState": { "type": "string", "enum": [ "CREATING", "CREATE_FAILED", "ACTIVE" ] }, "RecordingConfigurationSummary": { "type": "structure", "required": [ "arn", "destinationConfiguration", "state" ], "members": { "arn": { "shape": "RecordingConfigurationArn", "documentation": "Recording-configuration ARN.
" }, "name": { "shape": "RecordingConfigurationName", "documentation": "Recording-configuration name. The value does not need to be unique.
" }, "destinationConfiguration": { "shape": "DestinationConfiguration", "documentation": "A complex type that contains information about where recorded video will be stored.
" }, "state": { "shape": "RecordingConfigurationState", "documentation": "Indicates the current state of the recording configuration. When the state is ACTIVE
, the configuration is ready for recording a channel stream.
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.
Summary information about a RecordingConfiguration.
" }, "RecordingMode": { "type": "string", "enum": [ "DISABLED", "INTERVAL" ] }, "RecordingReconnectWindowSeconds": { "type": "integer", "max": 300, "min": 0 }, "RenditionConfiguration": { "type": "structure", "members": { "renditionSelection": { "shape": "RenditionConfigurationRenditionSelection", "documentation": "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
.
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.
Object that describes which renditions should be recorded for a stream.
" }, "RenditionConfigurationRendition": { "type": "string", "enum": [ "SD", "HD", "FULL_HD", "LOWEST_RESOLUTION" ] }, "RenditionConfigurationRenditionList": { "type": "list", "member": { "shape": "RenditionConfigurationRendition" } }, "RenditionConfigurationRenditionSelection": { "type": "string", "enum": [ "ALL", "NONE", "CUSTOM" ] }, "ResourceArn": { "type": "string", "max": 128, "min": 1, "pattern": "arn:aws:ivs:[a-z0-9-]+:[0-9]+:[a-z-]/[a-zA-Z0-9-]+" }, "S3DestinationBucketName": { "type": "string", "max": 63, "min": 3, "pattern": "[a-z0-9-.]+" }, "S3DestinationConfiguration": { "type": "structure", "required": [ "bucketName" ], "members": { "bucketName": { "shape": "S3DestinationBucketName", "documentation": "Location (S3 bucket name) where recorded videos will be stored.
" } }, "documentation": "A complex type that describes an S3 location where recorded videos will be stored.
" }, "Srt": { "type": "structure", "members": { "endpoint": { "shape": "SrtEndpoint", "documentation": "The endpoint to be used when streaming with IVS using the SRT protocol.
" }, "passphrase": { "shape": "SrtPassphrase", "documentation": "Auto-generated passphrase to enable encryption. This field is applicable only if the end user has not enabled the insecureIngest
option for the channel.
Specifies information needed to stream using the SRT protocol.
" }, "SrtEndpoint": { "type": "string" }, "SrtPassphrase": { "type": "string", "sensitive": true }, "StartViewerSessionRevocationRequest": { "type": "structure", "required": [ "channelArn", "viewerId" ], "members": { "channelArn": { "shape": "ChannelArn", "documentation": "The ARN of the channel associated with the viewer session to revoke.
" }, "viewerId": { "shape": "ViewerId", "documentation": "The ID of the viewer associated with the viewer session to revoke. Do not use this field for personally identifying, confidential, or sensitive information.
" }, "viewerSessionVersionsLessThanOrEqualTo": { "shape": "ViewerSessionVersion", "documentation": "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.
" } } }, "StartViewerSessionRevocationResponse": { "type": "structure", "members": {} }, "StopStreamRequest": { "type": "structure", "required": [ "channelArn" ], "members": { "channelArn": { "shape": "ChannelArn", "documentation": "ARN of the channel for which the stream is to be stopped.
" } } }, "StopStreamResponse": { "type": "structure", "members": {} }, "Stream": { "type": "structure", "members": { "channelArn": { "shape": "ChannelArn", "documentation": "Channel ARN for the stream.
" }, "streamId": { "shape": "StreamId", "documentation": "Unique identifier for a live or previously live stream in the specified channel.
" }, "playbackUrl": { "shape": "PlaybackURL", "documentation": "URL of the master playlist, required by the video player to play the HLS stream.
" }, "startTime": { "shape": "StreamStartTime", "documentation": "Time of the stream’s start. This is an ISO 8601 timestamp; note that this is returned as a string.
" }, "state": { "shape": "StreamState", "documentation": "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.
The stream’s health.
" }, "viewerCount": { "shape": "StreamViewerCount", "documentation": "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.
Specifies a live video stream that has been ingested and distributed.
" }, "StreamEvent": { "type": "structure", "members": { "name": { "shape": "String", "documentation": "Name that identifies the stream event within a type
.
Logical group for certain events.
" }, "eventTime": { "shape": "Time", "documentation": "Time when the event occurred. This is an ISO 8601 timestamp; note that this is returned as a string.
" } }, "documentation": "Object specifying a stream’s events. For a list of events, see Using Amazon EventBridge with Amazon IVS.
" }, "StreamEvents": { "type": "list", "member": { "shape": "StreamEvent" }, "max": 500, "min": 0 }, "StreamFilters": { "type": "structure", "members": { "health": { "shape": "StreamHealth", "documentation": "The stream’s health.
" } }, "documentation": "Object specifying the stream attribute on which to filter.
" }, "StreamHealth": { "type": "string", "enum": [ "HEALTHY", "STARVING", "UNKNOWN" ] }, "StreamId": { "type": "string", "max": 26, "min": 26, "pattern": "st-[a-zA-Z0-9]+" }, "StreamKey": { "type": "structure", "members": { "arn": { "shape": "StreamKeyArn", "documentation": "Stream-key ARN.
" }, "value": { "shape": "StreamKeyValue", "documentation": "Stream-key value.
" }, "channelArn": { "shape": "ChannelArn", "documentation": "Channel ARN for the stream.
" }, "tags": { "shape": "Tags", "documentation": "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.
Object specifying a stream key.
" }, "StreamKeyArn": { "type": "string", "max": 128, "min": 1, "pattern": "arn:aws:ivs:[a-z0-9-]+:[0-9]+:stream-key/[a-zA-Z0-9-]+" }, "StreamKeyArnList": { "type": "list", "member": { "shape": "StreamKeyArn" }, "max": 50, "min": 1 }, "StreamKeyList": { "type": "list", "member": { "shape": "StreamKeySummary" } }, "StreamKeySummary": { "type": "structure", "members": { "arn": { "shape": "StreamKeyArn", "documentation": "Stream-key ARN.
" }, "channelArn": { "shape": "ChannelArn", "documentation": "Channel ARN for the stream.
" }, "tags": { "shape": "Tags", "documentation": "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.
Summary information about a stream key.
" }, "StreamKeyValue": { "type": "string", "sensitive": true }, "StreamKeys": { "type": "list", "member": { "shape": "StreamKey" } }, "StreamList": { "type": "list", "member": { "shape": "StreamSummary" } }, "StreamMetadata": { "type": "string", "min": 1, "sensitive": true }, "StreamSession": { "type": "structure", "members": { "streamId": { "shape": "StreamId", "documentation": "Unique identifier for a live or previously live stream in the specified channel.
" }, "startTime": { "shape": "Time", "documentation": "Time when the channel went live. This is an ISO 8601 timestamp; note that this is returned as a string.
" }, "endTime": { "shape": "Time", "documentation": "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
.
The properties of the channel at the time of going live.
" }, "ingestConfiguration": { "shape": "IngestConfiguration", "documentation": "The properties of the incoming RTMP stream for the stream.
" }, "recordingConfiguration": { "shape": "RecordingConfiguration", "documentation": "The properties of recording the live stream.
" }, "truncatedEvents": { "shape": "StreamEvents", "documentation": "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.
" } }, "documentation": "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.
" }, "StreamSessionList": { "type": "list", "member": { "shape": "StreamSessionSummary" } }, "StreamSessionSummary": { "type": "structure", "members": { "streamId": { "shape": "StreamId", "documentation": "Unique identifier for a live or previously live stream in the specified channel.
" }, "startTime": { "shape": "Time", "documentation": "Time when the channel went live. This is an ISO 8601 timestamp; note that this is returned as a string.
" }, "endTime": { "shape": "Time", "documentation": "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
.
If true
, this stream encountered a quota breach or failure.
Summary information about a stream session.
" }, "StreamStartTime": { "type": "timestamp", "timestampFormat": "iso8601" }, "StreamState": { "type": "string", "enum": [ "LIVE", "OFFLINE" ] }, "StreamSummary": { "type": "structure", "members": { "channelArn": { "shape": "ChannelArn", "documentation": "Channel ARN for the stream.
" }, "streamId": { "shape": "StreamId", "documentation": "Unique identifier for a live or previously live stream in the specified channel.
" }, "state": { "shape": "StreamState", "documentation": "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.
The stream’s health.
" }, "viewerCount": { "shape": "StreamViewerCount", "documentation": "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.
Time of the stream’s start. This is an ISO 8601 timestamp; note that this is returned as a string.
" } }, "documentation": "Summary information about a stream.
" }, "StreamViewerCount": { "type": "long" }, "String": { "type": "string" }, "TagKey": { "type": "string", "max": 128, "min": 1 }, "TagKeyList": { "type": "list", "member": { "shape": "TagKey" }, "max": 50, "min": 0 }, "TagResourceRequest": { "type": "structure", "required": [ "resourceArn", "tags" ], "members": { "resourceArn": { "shape": "ResourceArn", "documentation": "ARN of the resource for which tags are to be added or updated. The ARN must be URL-encoded.
", "location": "uri", "locationName": "resourceArn" }, "tags": { "shape": "Tags", "documentation": "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.
Thumbnail recording mode. Default: INTERVAL
.
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.
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).
" }, "storage": { "shape": "ThumbnailConfigurationStorageList", "documentation": "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
.
An object representing a configuration of thumbnails for recorded video.
" }, "ThumbnailConfigurationResolution": { "type": "string", "enum": [ "SD", "HD", "FULL_HD", "LOWEST_RESOLUTION" ] }, "ThumbnailConfigurationStorage": { "type": "string", "enum": [ "SEQUENTIAL", "LATEST" ] }, "ThumbnailConfigurationStorageList": { "type": "list", "member": { "shape": "ThumbnailConfigurationStorage" } }, "Time": { "type": "timestamp", "timestampFormat": "iso8601" }, "TranscodePreset": { "type": "string", "enum": [ "HIGHER_BANDWIDTH_DELIVERY", "CONSTRAINED_BANDWIDTH_DELIVERY" ] }, "UntagResourceRequest": { "type": "structure", "required": [ "resourceArn", "tagKeys" ], "members": { "resourceArn": { "shape": "ResourceArn", "documentation": "ARN of the resource for which tags are to be removed. The ARN must be URL-encoded.
", "location": "uri", "locationName": "resourceArn" }, "tagKeys": { "shape": "TagKeyList", "documentation": "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.
ARN of the channel to be updated.
" }, "name": { "shape": "ChannelName", "documentation": "Channel name.
" }, "latencyMode": { "shape": "ChannelLatencyMode", "documentation": "Channel latency mode. Use NORMAL
to broadcast and deliver live video up to Full HD. Use LOW
for near-real-time interaction with viewers.
Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD
. For details, see Channel Types.
Whether the channel is private (enabled for playback authorization).
" }, "recordingConfigurationArn": { "shape": "ChannelRecordingConfigurationArn", "documentation": "Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables recording. If this is set to an empty string, recording is disabled.
" }, "insecureIngest": { "shape": "Boolean", "documentation": "Whether the channel allows insecure RTMP and SRT ingest. Default: false
.
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 (\"\"
).
Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction. If this is set to an empty string, playback restriction policy is disabled.
" } } }, "UpdateChannelResponse": { "type": "structure", "members": { "channel": { "shape": "Channel", "documentation": "Object specifying the updated channel.
" } } }, "UpdatePlaybackRestrictionPolicyRequest": { "type": "structure", "required": [ "arn" ], "members": { "arn": { "shape": "PlaybackRestrictionPolicyArn", "documentation": "ARN of the playback-restriction-policy to be updated.
" }, "allowedCountries": { "shape": "PlaybackRestrictionPolicyAllowedCountryList", "documentation": "A list of country codes that control geoblocking restriction. Allowed values are the officially assigned ISO 3166-1 alpha-2 codes. Default: All countries (an empty array).
" }, "allowedOrigins": { "shape": "PlaybackRestrictionPolicyAllowedOriginList", "documentation": "A list of origin sites that control CORS restriction. Allowed values are the same as valid values of the Origin header defined at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin. Default: All origins (an empty array).
" }, "enableStrictOriginEnforcement": { "shape": "PlaybackRestrictionPolicyEnableStrictOriginEnforcement", "documentation": "Whether channel playback is constrained by origin site. Default: false
.
Playback-restriction-policy name. The value does not need to be unique.
" } } }, "UpdatePlaybackRestrictionPolicyResponse": { "type": "structure", "members": { "playbackRestrictionPolicy": { "shape": "PlaybackRestrictionPolicy", "documentation": "Object specifying the updated policy.
" } } }, "VideoConfiguration": { "type": "structure", "members": { "avcProfile": { "shape": "String", "documentation": "Indicates to the decoder the requirements for decoding the stream. For definitions of the valid values, see the H.264 specification.
" }, "avcLevel": { "shape": "String", "documentation": "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.
" }, "codec": { "shape": "String", "documentation": "Codec used for the video encoding.
" }, "encoder": { "shape": "String", "documentation": "Software or hardware used to encode the video.
" }, "targetBitrate": { "shape": "Integer", "documentation": "The expected ingest bitrate (bits per second). This is configured in the encoder.
" }, "targetFramerate": { "shape": "Integer", "documentation": "The expected ingest framerate. This is configured in the encoder.
" }, "videoHeight": { "shape": "Integer", "documentation": "Video-resolution height in pixels.
" }, "videoWidth": { "shape": "Integer", "documentation": "Video-resolution width in pixels.
" } }, "documentation": "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.
" }, "ViewerId": { "type": "string", "max": 40, "min": 1 }, "ViewerSessionVersion": { "type": "integer", "min": 0 }, "errorCode": { "type": "string" }, "errorMessage": { "type": "string" } }, "documentation": "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
Accept:
application/json
Accept-Encoding:
gzip, deflate
Content-Type:
application/json
Key Concepts
Channel — Stores configuration data related to your live stream. You first create a channel and then use the channel’s stream key to start your live stream.
Stream key — An identifier assigned by Amazon IVS when you create a channel, which is then used to authorize streaming. Treat the stream key like a secret, since it allows anyone to stream to the channel.
Playback key pair — Video playback may be restricted using playback-authorization tokens, which use public-key encryption. A playback key pair is the public-private pair of keys used to sign and validate the playback-authorization token.
Recording configuration — Stores configuration related to recording a live stream and where to store the recorded content. Multiple channels can reference the same recording configuration.
Playback restriction policy — Restricts playback by countries and/or origin sites.
For more information about your IVS live stream, also see Getting Started with IVS Low-Latency Streaming.
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 is about verifying identity. You need to be authenticated to sign Amazon IVS API requests.
Authorization is about granting permissions. Your IAM roles need to have permissions for Amazon IVS API requests. In addition, authorization is needed to view Amazon IVS private channels. (Private channels are channels that are enabled for \"playback authorization.\")
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:
Authentication and generating signatures — See Authenticating Requests (Amazon Web Services Signature Version 4) in the Amazon Web Services General Reference.
Managing Amazon IVS permissions — See Identity and Access Management on the Security page of the Amazon IVS User Guide.
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.
" }