User does not have sufficient access to perform this action.
" } } }, "traits": { "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.ivs#AmazonInteractiveVideoService": { "type": "service", "version": "2020-07-14", "operations": [ { "target": "com.amazonaws.ivs#BatchGetChannel" }, { "target": "com.amazonaws.ivs#BatchGetStreamKey" }, { "target": "com.amazonaws.ivs#CreateChannel" }, { "target": "com.amazonaws.ivs#CreateRecordingConfiguration" }, { "target": "com.amazonaws.ivs#CreateStreamKey" }, { "target": "com.amazonaws.ivs#DeleteChannel" }, { "target": "com.amazonaws.ivs#DeletePlaybackKeyPair" }, { "target": "com.amazonaws.ivs#DeleteRecordingConfiguration" }, { "target": "com.amazonaws.ivs#DeleteStreamKey" }, { "target": "com.amazonaws.ivs#GetChannel" }, { "target": "com.amazonaws.ivs#GetPlaybackKeyPair" }, { "target": "com.amazonaws.ivs#GetRecordingConfiguration" }, { "target": "com.amazonaws.ivs#GetStream" }, { "target": "com.amazonaws.ivs#GetStreamKey" }, { "target": "com.amazonaws.ivs#ImportPlaybackKeyPair" }, { "target": "com.amazonaws.ivs#ListChannels" }, { "target": "com.amazonaws.ivs#ListPlaybackKeyPairs" }, { "target": "com.amazonaws.ivs#ListRecordingConfigurations" }, { "target": "com.amazonaws.ivs#ListStreamKeys" }, { "target": "com.amazonaws.ivs#ListStreams" }, { "target": "com.amazonaws.ivs#ListTagsForResource" }, { "target": "com.amazonaws.ivs#PutMetadata" }, { "target": "com.amazonaws.ivs#StopStream" }, { "target": "com.amazonaws.ivs#TagResource" }, { "target": "com.amazonaws.ivs#UntagResource" }, { "target": "com.amazonaws.ivs#UpdateChannel" } ], "traits": { "aws.api#service": { "sdkId": "ivs", "arnNamespace": "ivs", "cloudFormationName": "Ivs", "cloudTrailEventSource": "ivs.amazonaws.com", "endpointPrefix": "ivs" }, "aws.auth#sigv4": { "name": "ivs" }, "aws.protocols#restJson1": {}, "smithy.api#documentation": "\n Introduction\n
\n\nThe Amazon Interactive Video Service (IVS) API is REST compatible, using a standard HTTP\n API and an AWS EventBridge event stream for responses. JSON is used for both requests and\n responses, including errors.
\n\nThe API is an AWS regional service, currently in these regions: us-west-2, us-east-1, and\n eu-west-1.
\n\n \n All API request parameters and URLs are case sensitive.\n \n \n
\n\nFor a summary of notable documentation changes in each release, see Document\n History.
\n\n\n Service Endpoints\n
\nThe following are the Amazon IVS service endpoints (all HTTPS):
\nRegion name: US West (Oregon)
\nRegion: us-west-2\n
Endpoint: ivs.us-west-2.amazonaws.com\n
Region name: US East (Virginia)
\nRegion: us-east-1\n
Endpoint: ivs.us-east-1.amazonaws.com\n
Region name: EU West (Dublin)
\nRegion: eu-west-1\n
Endpoint: ivs.eu-west-1.amazonaws.com\n
\n Allowed Header Values\n
\n\n\n \n Accept:\n application/json
\n \n Accept-Encoding:\n gzip, deflate
\n \n Content-Type:\n application/json
\n Resources\n
\nThe following resources contain information about your IVS live stream (see Getting Started with Amazon\n IVS):
\n\nChannel — Stores configuration data related to your live stream. You first create a\n channel and then use the channel’s stream key to start your live stream. See the Channel\n endpoints for more information.
\nStream key — An identifier assigned by Amazon IVS when you create a channel, which is\n then used to authorize streaming. See the StreamKey endpoints for more information.\n \n Treat the stream key like a secret, since it allows\n anyone to stream to the channel.\n \n
\nPlayback key pair — Video playback may be restricted using playback-authorization\n tokens, which use public-key encryption. A playback key pair is the public-private pair of\n keys used to sign and validate the playback-authorization token. See the PlaybackKeyPair\n endpoints for more information.
\nRecording configuration — Stores configuration related to recording a live stream and\n where to store the recorded content. Multiple channels can reference the same recording\n configuration. See the Recording Configuration endpoints for more information.
\n\n Tagging\n
\n\nA tag is a metadata label that you assign to an AWS resource. A tag\n comprises a key and a value, both set by you. For\n example, you might set a tag as topic:nature to label a particular video\n category. See Tagging AWS\n Resources for more information, including restrictions that apply to tags.
Tags can help you identify and organize your AWS resources. For example, you can use the\n same tag for different resources to indicate that they are related. You can also use tags to\n manage access (see \n Access Tags).
\n\nThe Amazon IVS API has these tag-related endpoints: TagResource, UntagResource, and ListTagsForResource. The following\n resources support tagging: Channels, Stream Keys, Playback Key Pairs, and Recording\n Configurations.
\n\n\n Authentication versus Authorization\n
\nNote the differences between these concepts:
\n\n Authentication is about verifying identity. You need to be authenticated to sign Amazon IVS\n API requests.
\n\n Authorization is about granting permissions. You need to be authorized to\n view Amazon IVS private channels. (Private channels are channels that are enabled for\n \"playback authorization.\")
\n\n Authentication\n
\nAll Amazon IVS API requests must be authenticated with a signature. The AWS Command-Line\n Interface (CLI) and Amazon IVS Player SDKs take care of signing the underlying API calls for\n you. However, if your application calls the Amazon IVS API directly, it’s your responsibility\n to sign the requests.
\nYou generate a signature using valid AWS credentials that have permission to perform the\n requested action. For example, you must sign PutMetadata requests with a signature generated\n from an IAM user account that has the ivs:PutMetadata permission.
For more information:
\nAuthentication and generating signatures — See Authenticating Requests (AWS Signature Version\n 4) in the AWS General Reference.
\nManaging Amazon IVS permissions — See Identity and Access Management on the Security page of\n the Amazon IVS User Guide.
\n\n Channel Endpoints\n
\n\n CreateChannel — Creates a new channel and an associated stream\n key to start streaming.
\n\n GetChannel — Gets the channel configuration for the specified\n channel ARN (Amazon Resource Name).
\n\n BatchGetChannel — Performs GetChannel on\n multiple ARNs simultaneously.
\n\n ListChannels — Gets summary information about all channels in\n your account, in the AWS region where the API request is processed. This list can be\n filtered to match a specified name or recording-configuration ARN. Filters are mutually\n exclusive and cannot be used together. If you try to use both filters, you will get an\n error (409 Conflict Exception).
\n\n UpdateChannel — Updates a channel's configuration. This does\n not affect an ongoing stream of this channel. You must stop and restart the stream for the\n changes to take effect.
\n\n DeleteChannel — Deletes the specified channel.
\n\n StreamKey Endpoints\n
\n\n CreateStreamKey — Creates a stream key, used to initiate a\n stream, for the specified channel ARN.
\n\n GetStreamKey — Gets stream key information for the specified\n ARN.
\n\n BatchGetStreamKey — Performs GetStreamKey on\n multiple ARNs simultaneously.
\n\n ListStreamKeys — Gets summary information about stream keys\n for the specified channel.
\n\n DeleteStreamKey — Deletes the stream key for the specified\n ARN, so it can no longer be used to stream.
\n\n Stream Endpoints\n
\n\n GetStream — Gets information about the active (live) stream on\n a specified channel.
\n\n ListStreams — Gets summary information about live streams in\n your account, in the AWS region where the API request is processed.
\n\n StopStream — Disconnects the incoming RTMPS stream for the\n specified channel. Can be used in conjunction with DeleteStreamKey to\n prevent further streaming to a channel.
\n\n PutMetadata — Inserts metadata into the active stream of the\n specified channel. A maximum of 5 requests per second per channel is allowed, each with a\n maximum 1 KB payload. (If 5 TPS is not sufficient for your needs, we recommend batching\n your data into a single PutMetadata call.)
\n\n PlaybackKeyPair Endpoints\n
\nFor more information, see Setting Up Private Channels in the\n Amazon IVS User Guide.
\n\n ImportPlaybackKeyPair — Imports the public portion of a new\n key pair and returns its arn and fingerprint. The\n privateKey can then be used to generate viewer authorization tokens, to\n grant viewers access to private channels (channels enabled for playback\n authorization).
\n GetPlaybackKeyPair — Gets a specified playback authorization\n key pair and returns the arn and fingerprint. The\n privateKey held by the caller can be used to generate viewer authorization\n tokens, to grant viewers access to private channels.
\n ListPlaybackKeyPairs — Gets summary information about playback\n key pairs.
\n\n DeletePlaybackKeyPair — Deletes a specified authorization key\n pair. This invalidates future viewer tokens generated using the key pair’s\n privateKey.
\n RecordingConfiguration Endpoints\n
\n\n CreateRecordingConfiguration — Creates a new recording configuration,\n used to enable recording to Amazon S3.
\n\n GetRecordingConfiguration — Gets the recording-configuration metadata\n for the specified ARN.
\n\n ListRecordingConfigurations — Gets summary information about all\n recording configurations in your account, in the AWS region where the API request is\n processed.
\n\n DeleteRecordingConfiguration — Deletes the recording\n configuration for the specified ARN.
\n\n AWS Tags Endpoints\n
\n\n TagResource — Adds or updates tags for the AWS resource with\n the specified ARN.
\n\n UntagResource — Removes tags from the resource with the\n specified ARN.
\n\n ListTagsForResource — Gets information about AWS tags for the\n specified ARN.
\nChannel ARN.
" } }, "code": { "target": "com.amazonaws.ivs#errorCode", "traits": { "smithy.api#documentation": "Error code.
" } }, "message": { "target": "com.amazonaws.ivs#errorMessage", "traits": { "smithy.api#documentation": "Error message, determined by the application.
" } } }, "traits": { "smithy.api#documentation": "Error related to a specific channel, specified by its ARN.
" } }, "com.amazonaws.ivs#BatchErrors": { "type": "list", "member": { "target": "com.amazonaws.ivs#BatchError" } }, "com.amazonaws.ivs#BatchGetChannel": { "type": "operation", "input": { "target": "com.amazonaws.ivs#BatchGetChannelRequest" }, "output": { "target": "com.amazonaws.ivs#BatchGetChannelResponse" }, "traits": { "smithy.api#documentation": "Performs GetChannel on multiple ARNs simultaneously.
", "smithy.api#http": { "method": "POST", "uri": "/BatchGetChannel", "code": 200 } } }, "com.amazonaws.ivs#BatchGetChannelRequest": { "type": "structure", "members": { "arns": { "target": "com.amazonaws.ivs#ChannelArnList", "traits": { "smithy.api#documentation": "Array of ARNs, one per channel.
", "smithy.api#required": {} } } } }, "com.amazonaws.ivs#BatchGetChannelResponse": { "type": "structure", "members": { "channels": { "target": "com.amazonaws.ivs#Channels" }, "errors": { "target": "com.amazonaws.ivs#BatchErrors", "traits": { "smithy.api#documentation": "Each error object is related to a specific ARN in the request.
" } } } }, "com.amazonaws.ivs#BatchGetStreamKey": { "type": "operation", "input": { "target": "com.amazonaws.ivs#BatchGetStreamKeyRequest" }, "output": { "target": "com.amazonaws.ivs#BatchGetStreamKeyResponse" }, "traits": { "smithy.api#documentation": "Performs GetStreamKey on multiple ARNs simultaneously.
", "smithy.api#http": { "method": "POST", "uri": "/BatchGetStreamKey", "code": 200 } } }, "com.amazonaws.ivs#BatchGetStreamKeyRequest": { "type": "structure", "members": { "arns": { "target": "com.amazonaws.ivs#StreamKeyArnList", "traits": { "smithy.api#documentation": "Array of ARNs, one per channel.
", "smithy.api#required": {} } } } }, "com.amazonaws.ivs#BatchGetStreamKeyResponse": { "type": "structure", "members": { "streamKeys": { "target": "com.amazonaws.ivs#StreamKeys" }, "errors": { "target": "com.amazonaws.ivs#BatchErrors" } } }, "com.amazonaws.ivs#Boolean": { "type": "boolean" }, "com.amazonaws.ivs#Channel": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.ivs#ChannelArn", "traits": { "smithy.api#documentation": "Channel ARN.
" } }, "name": { "target": "com.amazonaws.ivs#ChannelName", "traits": { "smithy.api#documentation": "Channel name.
" } }, "latencyMode": { "target": "com.amazonaws.ivs#ChannelLatencyMode", "traits": { "smithy.api#documentation": "Channel latency mode. Use NORMAL to broadcast and deliver live video up to\n Full HD. Use LOW for near-real-time interaction with viewers. Default: LOW. (Note: In the Amazon IVS console, LOW and\n NORMAL correspond to Ultra-low and Standard, respectively.)
Channel type, which determines the allowable resolution and bitrate. If you\n exceed the allowable resolution or bitrate, the stream probably will disconnect\n immediately. Default: STANDARD. Valid values:
\n STANDARD: Multiple qualities are generated from the original input, to\n automatically give viewers the best experience for their devices and network conditions.\n Vertical resolution can be up to 1080 and bitrate can be up to 8.5 Mbps.
\n BASIC: Amazon IVS delivers the original input to viewers. The viewer’s\n video-quality choice is limited to the original input. Vertical resolution can be up to\n 480 and bitrate can be up to 1.5 Mbps.
Recording-configuration ARN. A value other than an empty string indicates that recording\n is enabled. Default: \"\" (empty string, recording is disabled).
" } }, "ingestEndpoint": { "target": "com.amazonaws.ivs#IngestEndpoint", "traits": { "smithy.api#documentation": "Channel ingest endpoint, part of the definition of an ingest server, used when you set up\n streaming software.
" } }, "playbackUrl": { "target": "com.amazonaws.ivs#PlaybackURL", "traits": { "smithy.api#documentation": "Channel playback URL.
" } }, "authorized": { "target": "com.amazonaws.ivs#IsAuthorized", "traits": { "smithy.api#documentation": "Whether the channel is private (enabled for playback authorization). Default:\n false.
Array of 1-50 maps, each of the form string:string (key:value).
Object specifying a channel.
" } }, "com.amazonaws.ivs#ChannelArn": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^arn:aws:[is]vs:[a-z0-9-]+:[0-9]+:channel/[a-zA-Z0-9-]+$" } }, "com.amazonaws.ivs#ChannelArnList": { "type": "list", "member": { "target": "com.amazonaws.ivs#ChannelArn" }, "traits": { "smithy.api#length": { "min": 1, "max": 50 } } }, "com.amazonaws.ivs#ChannelLatencyMode": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "NORMAL", "name": "NormalLatency" }, { "value": "LOW", "name": "LowLatency" } ] } }, "com.amazonaws.ivs#ChannelList": { "type": "list", "member": { "target": "com.amazonaws.ivs#ChannelSummary" } }, "com.amazonaws.ivs#ChannelName": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 128 }, "smithy.api#pattern": "^[a-zA-Z0-9-_]*$" } }, "com.amazonaws.ivs#ChannelNotBroadcasting": { "type": "structure", "members": { "exceptionMessage": { "target": "com.amazonaws.ivs#errorMessage", "traits": { "smithy.api#documentation": "The stream is offline for the given channel ARN.
" } } }, "traits": { "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.ivs#ChannelRecordingConfigurationArn": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 128 }, "smithy.api#pattern": "^$|^arn:aws:ivs:[a-z0-9-]+:[0-9]+:recording-configuration/[a-zA-Z0-9-]+$" } }, "com.amazonaws.ivs#ChannelSummary": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.ivs#ChannelArn", "traits": { "smithy.api#documentation": "Channel ARN.
" } }, "name": { "target": "com.amazonaws.ivs#ChannelName", "traits": { "smithy.api#documentation": "Channel name.
" } }, "latencyMode": { "target": "com.amazonaws.ivs#ChannelLatencyMode", "traits": { "smithy.api#documentation": "Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use\n LOW for near-real-time interaction with viewers. Default: LOW. (Note: In the Amazon IVS\n console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.)
Whether the channel is private (enabled for playback authorization). Default: false.
Recording-configuration ARN. A value other than an empty string indicates that recording\n is enabled. Default: \"\" (empty string, recording is disabled).
" } }, "tags": { "target": "com.amazonaws.ivs#Tags", "traits": { "smithy.api#documentation": "Array of 1-50 maps, each of the form string:string (key:value).
Summary information about a channel.
" } }, "com.amazonaws.ivs#ChannelType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "BASIC", "name": "BasicChannelType" }, { "value": "STANDARD", "name": "StandardChannelType" } ] } }, "com.amazonaws.ivs#Channels": { "type": "list", "member": { "target": "com.amazonaws.ivs#Channel" } }, "com.amazonaws.ivs#ConflictException": { "type": "structure", "members": { "exceptionMessage": { "target": "com.amazonaws.ivs#errorMessage", "traits": { "smithy.api#documentation": "Updating or deleting a resource can cause an inconsistent state.
" } } }, "traits": { "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.ivs#CreateChannel": { "type": "operation", "input": { "target": "com.amazonaws.ivs#CreateChannelRequest" }, "output": { "target": "com.amazonaws.ivs#CreateChannelResponse" }, "errors": [ { "target": "com.amazonaws.ivs#AccessDeniedException" }, { "target": "com.amazonaws.ivs#PendingVerification" }, { "target": "com.amazonaws.ivs#ResourceNotFoundException" }, { "target": "com.amazonaws.ivs#ServiceQuotaExceededException" }, { "target": "com.amazonaws.ivs#ValidationException" } ], "traits": { "smithy.api#documentation": "Creates a new channel and an associated stream key to start streaming.
", "smithy.api#http": { "method": "POST", "uri": "/CreateChannel", "code": 200 } } }, "com.amazonaws.ivs#CreateChannelRequest": { "type": "structure", "members": { "name": { "target": "com.amazonaws.ivs#ChannelName", "traits": { "smithy.api#documentation": "Channel name.
" } }, "latencyMode": { "target": "com.amazonaws.ivs#ChannelLatencyMode", "traits": { "smithy.api#documentation": "Channel latency mode. Use NORMAL to broadcast and deliver live video up to\n Full HD. Use LOW for near-real-time interaction with viewers. (Note: In the\n Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.)\n Default: LOW.
Channel type, which determines the allowable resolution and bitrate. If you\n exceed the allowable resolution or bitrate, the stream probably will disconnect\n immediately. Default: STANDARD. Valid values:
\n STANDARD: Multiple qualities are generated from the original input, to\n automatically give viewers the best experience for their devices and network conditions.\n Vertical resolution can be up to 1080 and bitrate can be up to 8.5 Mbps.
\n BASIC: Amazon IVS delivers the original input to viewers. The viewer’s\n video-quality choice is limited to the original input. Vertical resolution can be up to\n 480 and bitrate can be up to 1.5 Mbps.
Whether the channel is private (enabled for playback authorization). Default:\n false.
Recording-configuration ARN. Default: \"\" (empty string, recording is disabled).
" } }, "tags": { "target": "com.amazonaws.ivs#Tags", "traits": { "smithy.api#documentation": "Array of 1-50 maps, each of the form string:string (key:value).
Creates a new recording configuration, used to enable recording to Amazon S3.
\n\n Known issue: In the us-east-1 region, if you use the AWS\n CLI to create a recording configuration, it returns success even if the S3 bucket is in a\n different region. In this case, the state of the recording configuration is\n CREATE_FAILED (instead of ACTIVE). (In other regions, the CLI\n correctly returns failure if the bucket is in a different region.)
\n Workaround: Ensure that your S3 bucket is in the same region as the recording\n configuration. If you create a recording configuration in a different region as your S3\n bucket, delete that recording configuration and create a new one with an S3 bucket from the\n correct region.
", "smithy.api#http": { "method": "POST", "uri": "/CreateRecordingConfiguration", "code": 200 } } }, "com.amazonaws.ivs#CreateRecordingConfigurationRequest": { "type": "structure", "members": { "name": { "target": "com.amazonaws.ivs#RecordingConfigurationName", "traits": { "smithy.api#documentation": "An arbitrary string (a nickname) that helps the customer identify that resource. The value\n does not need to be unique.
" } }, "destinationConfiguration": { "target": "com.amazonaws.ivs#DestinationConfiguration", "traits": { "smithy.api#documentation": "A complex type that contains a destination configuration for where recorded video will be\n stored.
", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.ivs#Tags", "traits": { "smithy.api#documentation": "Array of 1-50 maps, each of the form string:string (key:value).
Creates a stream key, used to initiate a stream, for the specified channel ARN.
\nNote that CreateChannel creates a stream key. If you subsequently use\n CreateStreamKey on the same channel, it will fail because a stream key already exists and\n there is a limit of 1 stream key per channel. To reset the stream key on a channel, use DeleteStreamKey and then CreateStreamKey.
", "smithy.api#http": { "method": "POST", "uri": "/CreateStreamKey", "code": 200 } } }, "com.amazonaws.ivs#CreateStreamKeyRequest": { "type": "structure", "members": { "channelArn": { "target": "com.amazonaws.ivs#ChannelArn", "traits": { "smithy.api#documentation": "ARN of the channel for which to create the stream key.
", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.ivs#Tags", "traits": { "smithy.api#documentation": "Array of 1-50 maps, each of the form string:string (key:value).
Stream key used to authenticate an RTMPS stream for ingestion.
" } } } }, "com.amazonaws.ivs#DeleteChannel": { "type": "operation", "input": { "target": "com.amazonaws.ivs#DeleteChannelRequest" }, "errors": [ { "target": "com.amazonaws.ivs#AccessDeniedException" }, { "target": "com.amazonaws.ivs#ConflictException" }, { "target": "com.amazonaws.ivs#PendingVerification" }, { "target": "com.amazonaws.ivs#ResourceNotFoundException" }, { "target": "com.amazonaws.ivs#ValidationException" } ], "traits": { "smithy.api#documentation": "Deletes the specified channel and its associated stream keys.
\nIf you try to delete a live channel, you will get an error (409 ConflictException). To\n delete a channel that is live, call StopStream, wait for the Amazon\n EventBridge \"Stream End\" event (to verify that the stream's state was changed from Live to\n Offline), then call DeleteChannel. (See Using EventBridge with Amazon IVS.)
", "smithy.api#http": { "method": "POST", "uri": "/DeleteChannel", "code": 204 } } }, "com.amazonaws.ivs#DeleteChannelRequest": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.ivs#ChannelArn", "traits": { "smithy.api#documentation": "ARN of the channel to be deleted.
", "smithy.api#required": {} } } } }, "com.amazonaws.ivs#DeletePlaybackKeyPair": { "type": "operation", "input": { "target": "com.amazonaws.ivs#DeletePlaybackKeyPairRequest" }, "output": { "target": "com.amazonaws.ivs#DeletePlaybackKeyPairResponse" }, "errors": [ { "target": "com.amazonaws.ivs#AccessDeniedException" }, { "target": "com.amazonaws.ivs#PendingVerification" }, { "target": "com.amazonaws.ivs#ResourceNotFoundException" }, { "target": "com.amazonaws.ivs#ValidationException" } ], "traits": { "smithy.api#documentation": "Deletes a specified authorization key pair. This invalidates future viewer tokens\n generated using the key pair’s privateKey. For more information, see Setting Up Private\n Channels in the Amazon IVS User Guide.
ARN of the key pair to be deleted.
", "smithy.api#required": {} } } } }, "com.amazonaws.ivs#DeletePlaybackKeyPairResponse": { "type": "structure", "members": {} }, "com.amazonaws.ivs#DeleteRecordingConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.ivs#DeleteRecordingConfigurationRequest" }, "errors": [ { "target": "com.amazonaws.ivs#AccessDeniedException" }, { "target": "com.amazonaws.ivs#ConflictException" }, { "target": "com.amazonaws.ivs#InternalServerException" }, { "target": "com.amazonaws.ivs#ResourceNotFoundException" }, { "target": "com.amazonaws.ivs#ValidationException" } ], "traits": { "smithy.api#documentation": "Deletes the recording configuration for the specified ARN.
\nIf you try to delete a recording configuration that is associated with a channel, you will\n get an error (409 ConflictException). To avoid this, for all channels that reference the\n recording configuration, first use UpdateChannel to set the\n recordingConfigurationArn field to an empty string, then use\n DeleteRecordingConfiguration.
ARN of the recording configuration to be deleted.
", "smithy.api#required": {} } } } }, "com.amazonaws.ivs#DeleteStreamKey": { "type": "operation", "input": { "target": "com.amazonaws.ivs#DeleteStreamKeyRequest" }, "errors": [ { "target": "com.amazonaws.ivs#AccessDeniedException" }, { "target": "com.amazonaws.ivs#PendingVerification" }, { "target": "com.amazonaws.ivs#ResourceNotFoundException" }, { "target": "com.amazonaws.ivs#ValidationException" } ], "traits": { "smithy.api#documentation": "Deletes the stream key for the specified ARN, so it can no longer be used to\n stream.
", "smithy.api#http": { "method": "POST", "uri": "/DeleteStreamKey", "code": 204 } } }, "com.amazonaws.ivs#DeleteStreamKeyRequest": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.ivs#StreamKeyArn", "traits": { "smithy.api#documentation": "ARN of the stream key to be deleted.
", "smithy.api#required": {} } } } }, "com.amazonaws.ivs#DestinationConfiguration": { "type": "structure", "members": { "s3": { "target": "com.amazonaws.ivs#S3DestinationConfiguration", "traits": { "smithy.api#documentation": "An S3 destination configuration where recorded videos will be stored.
" } } }, "traits": { "smithy.api#documentation": "A complex type that describes a location where recorded videos will be stored. Each member\n represents a type of destination configuration. For recording, you define one and only one\n type of destination configuration.
" } }, "com.amazonaws.ivs#GetChannel": { "type": "operation", "input": { "target": "com.amazonaws.ivs#GetChannelRequest" }, "output": { "target": "com.amazonaws.ivs#GetChannelResponse" }, "errors": [ { "target": "com.amazonaws.ivs#AccessDeniedException" }, { "target": "com.amazonaws.ivs#ResourceNotFoundException" }, { "target": "com.amazonaws.ivs#ValidationException" } ], "traits": { "smithy.api#documentation": "Gets the channel configuration for the specified channel ARN. See also BatchGetChannel.
", "smithy.api#http": { "method": "POST", "uri": "/GetChannel", "code": 200 } } }, "com.amazonaws.ivs#GetChannelRequest": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.ivs#ChannelArn", "traits": { "smithy.api#documentation": "ARN of the channel for which the configuration is to be retrieved.
", "smithy.api#required": {} } } } }, "com.amazonaws.ivs#GetChannelResponse": { "type": "structure", "members": { "channel": { "target": "com.amazonaws.ivs#Channel" } } }, "com.amazonaws.ivs#GetPlaybackKeyPair": { "type": "operation", "input": { "target": "com.amazonaws.ivs#GetPlaybackKeyPairRequest" }, "output": { "target": "com.amazonaws.ivs#GetPlaybackKeyPairResponse" }, "errors": [ { "target": "com.amazonaws.ivs#AccessDeniedException" }, { "target": "com.amazonaws.ivs#ResourceNotFoundException" }, { "target": "com.amazonaws.ivs#ValidationException" } ], "traits": { "smithy.api#documentation": "Gets a specified playback authorization key pair and returns the arn and\n fingerprint. The privateKey held by the caller can be used to\n generate viewer authorization tokens, to grant viewers access to private channels. For more\n information, see Setting Up Private Channels in the Amazon IVS User\n Guide.
ARN of the key pair to be returned.
", "smithy.api#required": {} } } } }, "com.amazonaws.ivs#GetPlaybackKeyPairResponse": { "type": "structure", "members": { "keyPair": { "target": "com.amazonaws.ivs#PlaybackKeyPair" } } }, "com.amazonaws.ivs#GetRecordingConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.ivs#GetRecordingConfigurationRequest" }, "output": { "target": "com.amazonaws.ivs#GetRecordingConfigurationResponse" }, "errors": [ { "target": "com.amazonaws.ivs#AccessDeniedException" }, { "target": "com.amazonaws.ivs#InternalServerException" }, { "target": "com.amazonaws.ivs#ResourceNotFoundException" }, { "target": "com.amazonaws.ivs#ValidationException" } ], "traits": { "smithy.api#documentation": "Gets the recording configuration for the specified ARN.
", "smithy.api#http": { "method": "POST", "uri": "/GetRecordingConfiguration", "code": 200 } } }, "com.amazonaws.ivs#GetRecordingConfigurationRequest": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.ivs#RecordingConfigurationArn", "traits": { "smithy.api#documentation": "ARN of the recording configuration to be retrieved.
", "smithy.api#required": {} } } } }, "com.amazonaws.ivs#GetRecordingConfigurationResponse": { "type": "structure", "members": { "recordingConfiguration": { "target": "com.amazonaws.ivs#RecordingConfiguration" } } }, "com.amazonaws.ivs#GetStream": { "type": "operation", "input": { "target": "com.amazonaws.ivs#GetStreamRequest" }, "output": { "target": "com.amazonaws.ivs#GetStreamResponse" }, "errors": [ { "target": "com.amazonaws.ivs#AccessDeniedException" }, { "target": "com.amazonaws.ivs#ChannelNotBroadcasting" }, { "target": "com.amazonaws.ivs#ResourceNotFoundException" }, { "target": "com.amazonaws.ivs#ValidationException" } ], "traits": { "smithy.api#documentation": "Gets information about the active (live) stream on a specified channel.
", "smithy.api#http": { "method": "POST", "uri": "/GetStream", "code": 200 } } }, "com.amazonaws.ivs#GetStreamKey": { "type": "operation", "input": { "target": "com.amazonaws.ivs#GetStreamKeyRequest" }, "output": { "target": "com.amazonaws.ivs#GetStreamKeyResponse" }, "errors": [ { "target": "com.amazonaws.ivs#AccessDeniedException" }, { "target": "com.amazonaws.ivs#ResourceNotFoundException" }, { "target": "com.amazonaws.ivs#ValidationException" } ], "traits": { "smithy.api#documentation": "Gets stream-key information for a specified ARN.
", "smithy.api#http": { "method": "POST", "uri": "/GetStreamKey", "code": 200 } } }, "com.amazonaws.ivs#GetStreamKeyRequest": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.ivs#StreamKeyArn", "traits": { "smithy.api#documentation": "ARN for the stream key to be retrieved.
", "smithy.api#required": {} } } } }, "com.amazonaws.ivs#GetStreamKeyResponse": { "type": "structure", "members": { "streamKey": { "target": "com.amazonaws.ivs#StreamKey" } } }, "com.amazonaws.ivs#GetStreamRequest": { "type": "structure", "members": { "channelArn": { "target": "com.amazonaws.ivs#ChannelArn", "traits": { "smithy.api#documentation": "Channel ARN for stream to be accessed.
", "smithy.api#required": {} } } } }, "com.amazonaws.ivs#GetStreamResponse": { "type": "structure", "members": { "stream": { "target": "com.amazonaws.ivs#Stream" } } }, "com.amazonaws.ivs#ImportPlaybackKeyPair": { "type": "operation", "input": { "target": "com.amazonaws.ivs#ImportPlaybackKeyPairRequest" }, "output": { "target": "com.amazonaws.ivs#ImportPlaybackKeyPairResponse" }, "errors": [ { "target": "com.amazonaws.ivs#AccessDeniedException" }, { "target": "com.amazonaws.ivs#ConflictException" }, { "target": "com.amazonaws.ivs#PendingVerification" }, { "target": "com.amazonaws.ivs#ServiceQuotaExceededException" }, { "target": "com.amazonaws.ivs#ValidationException" } ], "traits": { "smithy.api#documentation": "Imports the public portion of a new key pair and returns its arn and\n fingerprint. The privateKey can then be used to generate viewer\n authorization tokens, to grant viewers access to private channels. For more information, see\n Setting Up\n Private Channels in the Amazon IVS User Guide.
The public portion of a customer-generated key pair.
", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.ivs#PlaybackKeyPairName", "traits": { "smithy.api#documentation": "An arbitrary string (a nickname) assigned to a playback key pair that helps the customer\n identify that resource. The value does not need to be unique.
" } }, "tags": { "target": "com.amazonaws.ivs#Tags", "traits": { "smithy.api#documentation": "Any tags provided with the request are added to the playback key pair tags.
" } } } }, "com.amazonaws.ivs#ImportPlaybackKeyPairResponse": { "type": "structure", "members": { "keyPair": { "target": "com.amazonaws.ivs#PlaybackKeyPair" } } }, "com.amazonaws.ivs#IngestEndpoint": { "type": "string" }, "com.amazonaws.ivs#InternalServerException": { "type": "structure", "members": { "exceptionMessage": { "target": "com.amazonaws.ivs#errorMessage", "traits": { "smithy.api#documentation": "Unexpected error during processing of request.
" } } }, "traits": { "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.ivs#IsAuthorized": { "type": "boolean" }, "com.amazonaws.ivs#ListChannels": { "type": "operation", "input": { "target": "com.amazonaws.ivs#ListChannelsRequest" }, "output": { "target": "com.amazonaws.ivs#ListChannelsResponse" }, "errors": [ { "target": "com.amazonaws.ivs#AccessDeniedException" }, { "target": "com.amazonaws.ivs#ConflictException" }, { "target": "com.amazonaws.ivs#ValidationException" } ], "traits": { "smithy.api#documentation": "Gets summary information about all channels in your account, in the AWS region where the\n API request is processed. This list can be filtered to match a specified name or\n recording-configuration ARN. Filters are mutually exclusive and cannot be used together. If\n you try to use both filters, you will get an error (409 ConflictException).
", "smithy.api#http": { "method": "POST", "uri": "/ListChannels", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults" } } }, "com.amazonaws.ivs#ListChannelsRequest": { "type": "structure", "members": { "filterByName": { "target": "com.amazonaws.ivs#ChannelName", "traits": { "smithy.api#documentation": "Filters the channel list to match the specified name.
" } }, "filterByRecordingConfigurationArn": { "target": "com.amazonaws.ivs#ChannelRecordingConfigurationArn", "traits": { "smithy.api#documentation": "Filters the channel list to match the specified recording-configuration ARN.
" } }, "nextToken": { "target": "com.amazonaws.ivs#PaginationToken", "traits": { "smithy.api#documentation": "The first channel to retrieve. This is used for pagination; see the nextToken\n response field.
Maximum number of channels to return. Default: 50.
" } } } }, "com.amazonaws.ivs#ListChannelsResponse": { "type": "structure", "members": { "channels": { "target": "com.amazonaws.ivs#ChannelList", "traits": { "smithy.api#documentation": "List of the matching channels.
", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.ivs#PaginationToken", "traits": { "smithy.api#documentation": "If there are more channels than maxResults, use nextToken in the\n request to get the next set.
Gets summary information about playback key pairs. For more information, see Setting Up Private\n Channels in the Amazon IVS User Guide.
", "smithy.api#http": { "method": "POST", "uri": "/ListPlaybackKeyPairs", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults" } } }, "com.amazonaws.ivs#ListPlaybackKeyPairsRequest": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.ivs#PaginationToken", "traits": { "smithy.api#documentation": "Maximum number of key pairs to return.
" } }, "maxResults": { "target": "com.amazonaws.ivs#MaxPlaybackKeyPairResults", "traits": { "smithy.api#documentation": "The first key pair to retrieve. This is used for pagination; see the\n nextToken response field. Default: 50.
List of key pairs.
", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.ivs#PaginationToken", "traits": { "smithy.api#documentation": "If there are more key pairs than maxResults, use nextToken in\n the request to get the next set.
Gets summary information about all recording configurations in your account, in the AWS\n region where the API request is processed.
", "smithy.api#http": { "method": "POST", "uri": "/ListRecordingConfigurations", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults" } } }, "com.amazonaws.ivs#ListRecordingConfigurationsRequest": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.ivs#PaginationToken", "traits": { "smithy.api#documentation": "The first recording configuration to retrieve. This is used for pagination; see the\n nextToken response field.
Maximum number of recording configurations to return. Default: 50.
" } } } }, "com.amazonaws.ivs#ListRecordingConfigurationsResponse": { "type": "structure", "members": { "recordingConfigurations": { "target": "com.amazonaws.ivs#RecordingConfigurationList", "traits": { "smithy.api#documentation": "List of the matching recording configurations.
", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.ivs#PaginationToken", "traits": { "smithy.api#documentation": "If there are more recording configurations than maxResults, use\n nextToken in the request to get the next set.
Gets summary information about stream keys for the specified channel.
", "smithy.api#http": { "method": "POST", "uri": "/ListStreamKeys", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults" } } }, "com.amazonaws.ivs#ListStreamKeysRequest": { "type": "structure", "members": { "channelArn": { "target": "com.amazonaws.ivs#ChannelArn", "traits": { "smithy.api#documentation": "Channel ARN used to filter the list.
", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.ivs#PaginationToken", "traits": { "smithy.api#documentation": "The first stream key to retrieve. This is used for pagination; see the\n nextToken response field.
Maximum number of streamKeys to return. Default: 50.
" } } } }, "com.amazonaws.ivs#ListStreamKeysResponse": { "type": "structure", "members": { "streamKeys": { "target": "com.amazonaws.ivs#StreamKeyList", "traits": { "smithy.api#documentation": "List of stream keys.
", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.ivs#PaginationToken", "traits": { "smithy.api#documentation": "If there are more stream keys than maxResults, use nextToken in\n the request to get the next set.
Gets summary information about live streams in your account, in the AWS region where the\n API request is processed.
", "smithy.api#http": { "method": "POST", "uri": "/ListStreams", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults" } } }, "com.amazonaws.ivs#ListStreamsRequest": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.ivs#PaginationToken", "traits": { "smithy.api#documentation": "The first stream to retrieve. This is used for pagination; see the nextToken\n response field.
Maximum number of streams to return. Default: 50.
" } } } }, "com.amazonaws.ivs#ListStreamsResponse": { "type": "structure", "members": { "streams": { "target": "com.amazonaws.ivs#StreamList", "traits": { "smithy.api#documentation": "List of streams.
", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.ivs#PaginationToken", "traits": { "smithy.api#documentation": "If there are more streams than maxResults, use nextToken in the\n request to get the next set.
Gets information about AWS tags for the specified ARN.
", "smithy.api#http": { "method": "GET", "uri": "/tags/{resourceArn}", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults" } } }, "com.amazonaws.ivs#ListTagsForResourceRequest": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.ivs#ResourceArn", "traits": { "smithy.api#documentation": "The ARN of the resource to be retrieved.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.ivs#String", "traits": { "smithy.api#documentation": "The first tag to retrieve. This is used for pagination; see the nextToken\n response field.
Maximum number of tags to return. Default: 50.
" } } } }, "com.amazonaws.ivs#ListTagsForResourceResponse": { "type": "structure", "members": { "tags": { "target": "com.amazonaws.ivs#Tags", "traits": { "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.ivs#String", "traits": { "smithy.api#documentation": "If there are more tags than maxResults, use nextToken in the\n request to get the next set.
Your account is pending verification.
" } } }, "traits": { "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.ivs#PlaybackKeyPair": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.ivs#PlaybackKeyPairArn", "traits": { "smithy.api#documentation": "Key-pair ARN.
" } }, "name": { "target": "com.amazonaws.ivs#PlaybackKeyPairName", "traits": { "smithy.api#documentation": "An arbitrary string (a nickname) assigned to a playback key pair that helps the customer\n identify that resource. The value does not need to be unique.
" } }, "fingerprint": { "target": "com.amazonaws.ivs#PlaybackKeyPairFingerprint", "traits": { "smithy.api#documentation": "Key-pair identifier.
" } }, "tags": { "target": "com.amazonaws.ivs#Tags", "traits": { "smithy.api#documentation": "Array of 1-50 maps, each of the form string:string (key:value).
A key pair used to sign and validate a playback authorization token.
" } }, "com.amazonaws.ivs#PlaybackKeyPairArn": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^arn:aws:[is]vs:[a-z0-9-]+:[0-9]+:playback-key/[a-zA-Z0-9-]+$" } }, "com.amazonaws.ivs#PlaybackKeyPairFingerprint": { "type": "string" }, "com.amazonaws.ivs#PlaybackKeyPairList": { "type": "list", "member": { "target": "com.amazonaws.ivs#PlaybackKeyPairSummary" } }, "com.amazonaws.ivs#PlaybackKeyPairName": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 128 }, "smithy.api#pattern": "^[a-zA-Z0-9-_]*$" } }, "com.amazonaws.ivs#PlaybackKeyPairSummary": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.ivs#PlaybackKeyPairArn", "traits": { "smithy.api#documentation": "Key-pair ARN.
" } }, "name": { "target": "com.amazonaws.ivs#PlaybackKeyPairName", "traits": { "smithy.api#documentation": "An arbitrary string (a nickname) assigned to a playback key pair that helps the customer\n identify that resource. The value does not need to be unique.
" } }, "tags": { "target": "com.amazonaws.ivs#Tags", "traits": { "smithy.api#documentation": "Array of 1-50 maps, each of the form string:string (key:value).
Summary information about a playback key pair.
" } }, "com.amazonaws.ivs#PlaybackPublicKeyMaterial": { "type": "string" }, "com.amazonaws.ivs#PlaybackURL": { "type": "string" }, "com.amazonaws.ivs#PutMetadata": { "type": "operation", "input": { "target": "com.amazonaws.ivs#PutMetadataRequest" }, "errors": [ { "target": "com.amazonaws.ivs#AccessDeniedException" }, { "target": "com.amazonaws.ivs#ChannelNotBroadcasting" }, { "target": "com.amazonaws.ivs#ResourceNotFoundException" }, { "target": "com.amazonaws.ivs#ThrottlingException" }, { "target": "com.amazonaws.ivs#ValidationException" } ], "traits": { "smithy.api#documentation": "Inserts metadata into the active stream of the specified channel. A maximum of 5 requests\n per second per channel is allowed, each with a maximum 1 KB payload. (If 5 TPS is not\n sufficient for your needs, we recommend batching your data into a single PutMetadata call.)\n\n Also see Embedding Metadata\n\n within a Video Stream in the Amazon IVS User Guide.
", "smithy.api#http": { "method": "POST", "uri": "/PutMetadata", "code": 200 } } }, "com.amazonaws.ivs#PutMetadataRequest": { "type": "structure", "members": { "channelArn": { "target": "com.amazonaws.ivs#ChannelArn", "traits": { "smithy.api#documentation": "ARN of the channel into which metadata is inserted. This channel must have an active\n stream.
", "smithy.api#required": {} } }, "metadata": { "target": "com.amazonaws.ivs#StreamMetadata", "traits": { "smithy.api#documentation": "Metadata to insert into the stream. Maximum: 1 KB per request.
", "smithy.api#required": {} } } } }, "com.amazonaws.ivs#RecordingConfiguration": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.ivs#RecordingConfigurationArn", "traits": { "smithy.api#documentation": "Recording-configuration ARN.
", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.ivs#RecordingConfigurationName", "traits": { "smithy.api#documentation": "An arbitrary string (a nickname) assigned to a recording configuration that helps the\n customer identify that resource. The value does not need to be unique.
" } }, "destinationConfiguration": { "target": "com.amazonaws.ivs#DestinationConfiguration", "traits": { "smithy.api#documentation": "A complex type that contains information about where recorded video will be stored.
", "smithy.api#required": {} } }, "state": { "target": "com.amazonaws.ivs#RecordingConfigurationState", "traits": { "smithy.api#documentation": "Indicates the current state of the recording configuration. When the state is\n ACTIVE, the configuration is ready for recording a channel stream.
Array of 1-50 maps, each of the form string:string (key:value).
An object representing a configuration to record a channel stream.
" } }, "com.amazonaws.ivs#RecordingConfigurationArn": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 128 }, "smithy.api#pattern": "^arn:aws:ivs:[a-z0-9-]+:[0-9]+:recording-configuration/[a-zA-Z0-9-]+$" } }, "com.amazonaws.ivs#RecordingConfigurationList": { "type": "list", "member": { "target": "com.amazonaws.ivs#RecordingConfigurationSummary" } }, "com.amazonaws.ivs#RecordingConfigurationName": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 128 }, "smithy.api#pattern": "^[a-zA-Z0-9-_]*$" } }, "com.amazonaws.ivs#RecordingConfigurationState": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "CREATING", "name": "Creating" }, { "value": "CREATE_FAILED", "name": "CreateFailed" }, { "value": "ACTIVE", "name": "Active" } ] } }, "com.amazonaws.ivs#RecordingConfigurationSummary": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.ivs#RecordingConfigurationArn", "traits": { "smithy.api#documentation": "Recording-configuration ARN.
", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.ivs#RecordingConfigurationName", "traits": { "smithy.api#documentation": "An arbitrary string (a nickname) assigned to a recording configuration that helps the\n customer identify that resource. The value does not need to be unique.
" } }, "destinationConfiguration": { "target": "com.amazonaws.ivs#DestinationConfiguration", "traits": { "smithy.api#documentation": "A complex type that contains information about where recorded video will be stored.
", "smithy.api#required": {} } }, "state": { "target": "com.amazonaws.ivs#RecordingConfigurationState", "traits": { "smithy.api#documentation": "Indicates the current state of the recording configuration. When the state is\n ACTIVE, the configuration is ready for recording a channel stream.
Array of 1-50 maps, each of the form string:string (key:value).
Summary information about a RecordingConfiguration.
" } }, "com.amazonaws.ivs#ResourceArn": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^arn:aws:[is]vs:[a-z0-9-]+:[0-9]+:[a-z-]/[a-zA-Z0-9-]+$" } }, "com.amazonaws.ivs#ResourceNotFoundException": { "type": "structure", "members": { "exceptionMessage": { "target": "com.amazonaws.ivs#errorMessage", "traits": { "smithy.api#documentation": "Request references a resource which does not exist.
" } } }, "traits": { "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.ivs#S3DestinationBucketName": { "type": "string", "traits": { "smithy.api#length": { "min": 3, "max": 63 }, "smithy.api#pattern": "^[a-z0-9-.]+$" } }, "com.amazonaws.ivs#S3DestinationConfiguration": { "type": "structure", "members": { "bucketName": { "target": "com.amazonaws.ivs#S3DestinationBucketName", "traits": { "smithy.api#documentation": "Location (S3 bucket name) where recorded videos will be stored.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A complex type that describes an S3 location where recorded videos will be stored.
" } }, "com.amazonaws.ivs#ServiceQuotaExceededException": { "type": "structure", "members": { "exceptionMessage": { "target": "com.amazonaws.ivs#errorMessage", "traits": { "smithy.api#documentation": "Request would cause a service quota to be exceeded.
" } } }, "traits": { "smithy.api#error": "client", "smithy.api#httpError": 402 } }, "com.amazonaws.ivs#StopStream": { "type": "operation", "input": { "target": "com.amazonaws.ivs#StopStreamRequest" }, "output": { "target": "com.amazonaws.ivs#StopStreamResponse" }, "errors": [ { "target": "com.amazonaws.ivs#AccessDeniedException" }, { "target": "com.amazonaws.ivs#ChannelNotBroadcasting" }, { "target": "com.amazonaws.ivs#ResourceNotFoundException" }, { "target": "com.amazonaws.ivs#StreamUnavailable" }, { "target": "com.amazonaws.ivs#ValidationException" } ], "traits": { "smithy.api#documentation": "Disconnects the incoming RTMPS stream for the specified channel. Can be used in\n conjunction with DeleteStreamKey to prevent further streaming to a\n channel.
\nMany streaming client-software libraries automatically reconnect a dropped RTMPS\n session, so to stop the stream permanently, you may want to first revoke the\n streamKey attached to the channel.
ARN of the channel for which the stream is to be stopped.
", "smithy.api#required": {} } } } }, "com.amazonaws.ivs#StopStreamResponse": { "type": "structure", "members": {} }, "com.amazonaws.ivs#Stream": { "type": "structure", "members": { "channelArn": { "target": "com.amazonaws.ivs#ChannelArn", "traits": { "smithy.api#documentation": "Channel ARN for the stream.
" } }, "playbackUrl": { "target": "com.amazonaws.ivs#PlaybackURL", "traits": { "smithy.api#documentation": "URL of the master playlist, required by the video player to play the HLS stream.
" } }, "startTime": { "target": "com.amazonaws.ivs#StreamStartTime", "traits": { "smithy.api#documentation": "ISO-8601 formatted timestamp of the stream’s start.
" } }, "state": { "target": "com.amazonaws.ivs#StreamState", "traits": { "smithy.api#documentation": "The stream’s state.
" } }, "health": { "target": "com.amazonaws.ivs#StreamHealth", "traits": { "smithy.api#documentation": "The stream’s health.
" } }, "viewerCount": { "target": "com.amazonaws.ivs#StreamViewerCount", "traits": { "smithy.api#documentation": "Number of current viewers of the stream. A value of -1 indicates that the request timed\n out; in this case, retry.
" } } }, "traits": { "smithy.api#documentation": "Specifies a live video stream that has been ingested and distributed.
" } }, "com.amazonaws.ivs#StreamHealth": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "HEALTHY", "name": "StreamHealthy" }, { "value": "STARVING", "name": "Starving" }, { "value": "UNKNOWN", "name": "Unknown" } ] } }, "com.amazonaws.ivs#StreamKey": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.ivs#StreamKeyArn", "traits": { "smithy.api#documentation": "Stream-key ARN.
" } }, "value": { "target": "com.amazonaws.ivs#StreamKeyValue", "traits": { "smithy.api#documentation": "Stream-key value.
" } }, "channelArn": { "target": "com.amazonaws.ivs#ChannelArn", "traits": { "smithy.api#documentation": "Channel ARN for the stream.
" } }, "tags": { "target": "com.amazonaws.ivs#Tags", "traits": { "smithy.api#documentation": "Array of 1-50 maps, each of the form string:string (key:value).
Object specifying a stream key.
" } }, "com.amazonaws.ivs#StreamKeyArn": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^arn:aws:[is]vs:[a-z0-9-]+:[0-9]+:stream-key/[a-zA-Z0-9-]+$" } }, "com.amazonaws.ivs#StreamKeyArnList": { "type": "list", "member": { "target": "com.amazonaws.ivs#StreamKeyArn" }, "traits": { "smithy.api#length": { "min": 1, "max": 50 } } }, "com.amazonaws.ivs#StreamKeyList": { "type": "list", "member": { "target": "com.amazonaws.ivs#StreamKeySummary" } }, "com.amazonaws.ivs#StreamKeySummary": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.ivs#StreamKeyArn", "traits": { "smithy.api#documentation": "Stream-key ARN.
" } }, "channelArn": { "target": "com.amazonaws.ivs#ChannelArn", "traits": { "smithy.api#documentation": "Channel ARN for the stream.
" } }, "tags": { "target": "com.amazonaws.ivs#Tags", "traits": { "smithy.api#documentation": "Array of 1-50 maps, each of the form string:string (key:value).
Summary information about a stream key.
" } }, "com.amazonaws.ivs#StreamKeyValue": { "type": "string" }, "com.amazonaws.ivs#StreamKeys": { "type": "list", "member": { "target": "com.amazonaws.ivs#StreamKey" } }, "com.amazonaws.ivs#StreamList": { "type": "list", "member": { "target": "com.amazonaws.ivs#StreamSummary" } }, "com.amazonaws.ivs#StreamMetadata": { "type": "string", "traits": { "smithy.api#length": { "min": 1 } } }, "com.amazonaws.ivs#StreamStartTime": { "type": "timestamp", "traits": { "smithy.api#timestampFormat": "date-time" } }, "com.amazonaws.ivs#StreamState": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "LIVE", "name": "StreamLive" }, { "value": "OFFLINE", "name": "StreamOffline" } ] } }, "com.amazonaws.ivs#StreamSummary": { "type": "structure", "members": { "channelArn": { "target": "com.amazonaws.ivs#ChannelArn", "traits": { "smithy.api#documentation": "Channel ARN for the stream.
" } }, "state": { "target": "com.amazonaws.ivs#StreamState", "traits": { "smithy.api#documentation": "The stream’s state.
" } }, "health": { "target": "com.amazonaws.ivs#StreamHealth", "traits": { "smithy.api#documentation": "The stream’s health.
" } }, "viewerCount": { "target": "com.amazonaws.ivs#StreamViewerCount", "traits": { "smithy.api#documentation": "Number of current viewers of the stream. A value of -1 indicates that the request timed\n out; in this case, retry.
" } }, "startTime": { "target": "com.amazonaws.ivs#StreamStartTime", "traits": { "smithy.api#documentation": "ISO-8601 formatted timestamp of the stream’s start.
" } } }, "traits": { "smithy.api#documentation": "Summary information about a stream.
" } }, "com.amazonaws.ivs#StreamUnavailable": { "type": "structure", "members": { "exceptionMessage": { "target": "com.amazonaws.ivs#errorMessage", "traits": { "smithy.api#documentation": "The stream is temporarily unavailable.
" } } }, "traits": { "smithy.api#error": "server", "smithy.api#httpError": 503 } }, "com.amazonaws.ivs#StreamViewerCount": { "type": "long" }, "com.amazonaws.ivs#String": { "type": "string" }, "com.amazonaws.ivs#TagKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 } } }, "com.amazonaws.ivs#TagKeyList": { "type": "list", "member": { "target": "com.amazonaws.ivs#TagKey" }, "traits": { "smithy.api#length": { "min": 0, "max": 50 } } }, "com.amazonaws.ivs#TagResource": { "type": "operation", "input": { "target": "com.amazonaws.ivs#TagResourceRequest" }, "output": { "target": "com.amazonaws.ivs#TagResourceResponse" }, "errors": [ { "target": "com.amazonaws.ivs#InternalServerException" }, { "target": "com.amazonaws.ivs#ResourceNotFoundException" }, { "target": "com.amazonaws.ivs#ValidationException" } ], "traits": { "smithy.api#documentation": "Adds or updates tags for the AWS resource with the specified ARN.
", "smithy.api#http": { "method": "POST", "uri": "/tags/{resourceArn}", "code": 200 } } }, "com.amazonaws.ivs#TagResourceRequest": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.ivs#ResourceArn", "traits": { "smithy.api#documentation": "ARN of the resource for which tags are to be added or updated.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.ivs#Tags", "traits": { "smithy.api#documentation": "Array of tags to be added or updated.
", "smithy.api#required": {} } } } }, "com.amazonaws.ivs#TagResourceResponse": { "type": "structure", "members": {} }, "com.amazonaws.ivs#TagValue": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 } } }, "com.amazonaws.ivs#Tags": { "type": "map", "key": { "target": "com.amazonaws.ivs#TagKey" }, "value": { "target": "com.amazonaws.ivs#TagValue" }, "traits": { "smithy.api#length": { "min": 0, "max": 50 } } }, "com.amazonaws.ivs#ThrottlingException": { "type": "structure", "members": { "exceptionMessage": { "target": "com.amazonaws.ivs#errorMessage", "traits": { "smithy.api#documentation": "Request was denied due to request throttling.
" } } }, "traits": { "smithy.api#error": "client", "smithy.api#httpError": 429 } }, "com.amazonaws.ivs#UntagResource": { "type": "operation", "input": { "target": "com.amazonaws.ivs#UntagResourceRequest" }, "output": { "target": "com.amazonaws.ivs#UntagResourceResponse" }, "errors": [ { "target": "com.amazonaws.ivs#InternalServerException" }, { "target": "com.amazonaws.ivs#ResourceNotFoundException" }, { "target": "com.amazonaws.ivs#ValidationException" } ], "traits": { "smithy.api#documentation": "Removes tags from the resource with the specified ARN.
", "smithy.api#http": { "method": "DELETE", "uri": "/tags/{resourceArn}", "code": 200 } } }, "com.amazonaws.ivs#UntagResourceRequest": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.ivs#ResourceArn", "traits": { "smithy.api#documentation": "ARN of the resource for which tags are to be removed.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "tagKeys": { "target": "com.amazonaws.ivs#TagKeyList", "traits": { "smithy.api#documentation": "Array of tags to be removed.
", "smithy.api#httpQuery": "tagKeys", "smithy.api#required": {} } } } }, "com.amazonaws.ivs#UntagResourceResponse": { "type": "structure", "members": {} }, "com.amazonaws.ivs#UpdateChannel": { "type": "operation", "input": { "target": "com.amazonaws.ivs#UpdateChannelRequest" }, "output": { "target": "com.amazonaws.ivs#UpdateChannelResponse" }, "errors": [ { "target": "com.amazonaws.ivs#AccessDeniedException" }, { "target": "com.amazonaws.ivs#ConflictException" }, { "target": "com.amazonaws.ivs#PendingVerification" }, { "target": "com.amazonaws.ivs#ResourceNotFoundException" }, { "target": "com.amazonaws.ivs#ValidationException" } ], "traits": { "smithy.api#documentation": "Updates a channel's configuration. This does not affect an ongoing stream of this channel.\n You must stop and restart the stream for the changes to take effect.
", "smithy.api#http": { "method": "POST", "uri": "/UpdateChannel", "code": 200 } } }, "com.amazonaws.ivs#UpdateChannelRequest": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.ivs#ChannelArn", "traits": { "smithy.api#documentation": "ARN of the channel to be updated.
", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.ivs#ChannelName", "traits": { "smithy.api#documentation": "Channel name.
" } }, "latencyMode": { "target": "com.amazonaws.ivs#ChannelLatencyMode", "traits": { "smithy.api#documentation": "Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use\n LOW for near-real-time interaction with viewers. (Note: In the Amazon IVS console,\n LOW and NORMAL correspond to Ultra-low and Standard,\n respectively.)
Channel type, which determines the allowable resolution and bitrate. If you\n exceed the allowable resolution or bitrate, the stream probably will disconnect\n immediately. Valid values:
\n\n STANDARD: Multiple qualities are generated from the original input, to\n automatically give viewers the best experience for their devices and network conditions.\n Vertical resolution can be up to 1080 and bitrate can be up to 8.5 Mbps.
\n BASIC: Amazon IVS delivers the original input to viewers. The viewer’s\n video-quality choice is limited to the original input. Vertical resolution can be up to\n 480 and bitrate can be up to 1.5 Mbps.
Whether the channel is private (enabled for playback authorization).
" } }, "recordingConfigurationArn": { "target": "com.amazonaws.ivs#ChannelRecordingConfigurationArn", "traits": { "smithy.api#documentation": "Recording-configuration ARN. If this is set to an empty string, recording is disabled. A\n value other than an empty string indicates that recording is enabled
" } } } }, "com.amazonaws.ivs#UpdateChannelResponse": { "type": "structure", "members": { "channel": { "target": "com.amazonaws.ivs#Channel" } } }, "com.amazonaws.ivs#ValidationException": { "type": "structure", "members": { "exceptionMessage": { "target": "com.amazonaws.ivs#errorMessage", "traits": { "smithy.api#documentation": "The input fails to satisfy the constraints specified by an AWS service.
" } } }, "traits": { "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.ivs#errorCode": { "type": "string" }, "com.amazonaws.ivs#errorMessage": { "type": "string" } } }