Creates a new channel and an associated stream key to start streaming.
" }, @@ -53,34 +57,36 @@ "name":"CreateRecordingConfiguration", "http":{ "method":"POST", - "requestUri":"/CreateRecordingConfiguration" + "requestUri":"/CreateRecordingConfiguration", + "responseCode":200 }, "input":{"shape":"CreateRecordingConfigurationRequest"}, "output":{"shape":"CreateRecordingConfigurationResponse"}, "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"}, {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, {"shape":"PendingVerification"}, - {"shape":"ServiceQuotaExceededException"}, - {"shape":"ValidationException"} + {"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 AWS 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.
" + "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" + "requestUri":"/CreateStreamKey", + "responseCode":200 }, "input":{"shape":"CreateStreamKeyRequest"}, "output":{"shape":"CreateStreamKeyResponse"}, "errors":[ - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, - {"shape":"ServiceQuotaExceededException"}, - {"shape":"PendingVerification"} + {"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.
" }, @@ -93,11 +99,11 @@ }, "input":{"shape":"DeleteChannelRequest"}, "errors":[ - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, - {"shape":"ConflictException"}, - {"shape":"PendingVerification"} + {"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 was changed from Live to Offline), then call DeleteChannel. (See Using EventBridge with Amazon IVS.)
" }, @@ -105,14 +111,15 @@ "name":"DeletePlaybackKeyPair", "http":{ "method":"POST", - "requestUri":"/DeletePlaybackKeyPair" + "requestUri":"/DeletePlaybackKeyPair", + "responseCode":200 }, "input":{"shape":"DeletePlaybackKeyPairRequest"}, "output":{"shape":"DeletePlaybackKeyPairResponse"}, "errors":[ - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, {"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 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.
" @@ -153,14 +161,15 @@ "name":"GetChannel", "http":{ "method":"POST", - "requestUri":"/GetChannel" + "requestUri":"/GetChannel", + "responseCode":200 }, "input":{"shape":"GetChannelRequest"}, "output":{"shape":"GetChannelResponse"}, "errors":[ - {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"ValidationException"} ], "documentation":"Gets the channel configuration for the specified channel ARN. See also BatchGetChannel.
" }, @@ -168,14 +177,15 @@ "name":"GetPlaybackKeyPair", "http":{ "method":"POST", - "requestUri":"/GetPlaybackKeyPair" + "requestUri":"/GetPlaybackKeyPair", + "responseCode":200 }, "input":{"shape":"GetPlaybackKeyPairRequest"}, "output":{"shape":"GetPlaybackKeyPairResponse"}, "errors":[ - {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"} + {"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 recording configuration for the specified ARN.
" @@ -199,14 +210,15 @@ "name":"GetStream", "http":{ "method":"POST", - "requestUri":"/GetStream" + "requestUri":"/GetStream", + "responseCode":200 }, "input":{"shape":"GetStreamRequest"}, "output":{"shape":"GetStreamResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, - {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, {"shape":"ChannelNotBroadcasting"} ], "documentation":"Gets information about the active (live) stream on a specified channel.
" @@ -215,14 +227,15 @@ "name":"GetStreamKey", "http":{ "method":"POST", - "requestUri":"/GetStreamKey" + "requestUri":"/GetStreamKey", + "responseCode":200 }, "input":{"shape":"GetStreamKeyRequest"}, "output":{"shape":"GetStreamKeyResponse"}, "errors":[ - {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"ValidationException"} ], "documentation":"Gets stream-key information for a specified ARN.
" }, @@ -230,16 +243,17 @@ "name":"ImportPlaybackKeyPair", "http":{ "method":"POST", - "requestUri":"/ImportPlaybackKeyPair" + "requestUri":"/ImportPlaybackKeyPair", + "responseCode":200 }, "input":{"shape":"ImportPlaybackKeyPairRequest"}, "output":{"shape":"ImportPlaybackKeyPairResponse"}, "errors":[ + {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, + {"shape":"PendingVerification"}, {"shape":"ConflictException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ServiceQuotaExceededException"}, - {"shape":"PendingVerification"} + {"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 AWS 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).
" + "documentation":"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" + "requestUri":"/ListPlaybackKeyPairs", + "responseCode":200 }, "input":{"shape":"ListPlaybackKeyPairsRequest"}, "output":{"shape":"ListPlaybackKeyPairsResponse"}, "errors":[ - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"} + {"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.
" }, @@ -276,29 +292,31 @@ "name":"ListRecordingConfigurations", "http":{ "method":"POST", - "requestUri":"/ListRecordingConfigurations" + "requestUri":"/ListRecordingConfigurations", + "responseCode":200 }, "input":{"shape":"ListRecordingConfigurationsRequest"}, "output":{"shape":"ListRecordingConfigurationsResponse"}, "errors":[ - {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, {"shape":"ValidationException"} ], - "documentation":"Gets summary information about all recording configurations in your account, in the AWS region where the API request is processed.
" + "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" + "requestUri":"/ListStreamKeys", + "responseCode":200 }, "input":{"shape":"ListStreamKeysRequest"}, "output":{"shape":"ListStreamKeysResponse"}, "errors":[ - {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"ValidationException"} ], "documentation":"Gets summary information about stream keys for the specified channel.
" }, @@ -306,59 +324,63 @@ "name":"ListStreams", "http":{ "method":"POST", - "requestUri":"/ListStreams" + "requestUri":"/ListStreams", + "responseCode":200 }, "input":{"shape":"ListStreamsRequest"}, "output":{"shape":"ListStreamsResponse"}, "errors":[ {"shape":"AccessDeniedException"} ], - "documentation":"Gets summary information about live streams in your account, in the AWS region where the API request is processed.
" + "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}" + "requestUri":"/tags/{resourceArn}", + "responseCode":200 }, "input":{"shape":"ListTagsForResourceRequest"}, "output":{"shape":"ListTagsForResourceResponse"}, "errors":[ + {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"ValidationException"} ], - "documentation":"Gets information about AWS tags for the specified ARN.
" + "documentation":"Gets information about Amazon Web Services tags for the specified ARN.
" }, "PutMetadata":{ "name":"PutMetadata", "http":{ "method":"POST", - "requestUri":"/PutMetadata" + "requestUri":"/PutMetadata", + "responseCode":200 }, "input":{"shape":"PutMetadataRequest"}, "errors":[ - {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"}, - {"shape":"ChannelNotBroadcasting"}, + {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"} + {"shape":"ChannelNotBroadcasting"}, + {"shape":"ThrottlingException"} ], - "documentation":"Inserts metadata into the active stream of the specified channel. A maximum of 5 requests per second per channel is 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.) Also see Embedding Metadata within a Video Stream in the Amazon IVS User Guide.
" + "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.
" }, "StopStream":{ "name":"StopStream", "http":{ "method":"POST", - "requestUri":"/StopStream" + "requestUri":"/StopStream", + "responseCode":200 }, "input":{"shape":"StopStreamRequest"}, "output":{"shape":"StopStreamResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, - {"shape":"ChannelNotBroadcasting"}, - {"shape":"ValidationException"}, {"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 AWS resource with the specified ARN.
" + "documentation":"Adds or updates tags for the Amazon Web Services resource with the specified ARN.
" }, "UntagResource":{ "name":"UntagResource", "http":{ "method":"DELETE", - "requestUri":"/tags/{resourceArn}" + "requestUri":"/tags/{resourceArn}", + "responseCode":200 }, "input":{"shape":"UntagResourceRequest"}, "output":{"shape":"UntagResourceResponse"}, "errors":[ + {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"ValidationException"} ], - "documentation":"Removes tags from the resource with the specified ARN.
" + "documentation":"Removes tags from the resource with the specified ARN.
", + "idempotent":true }, "UpdateChannel":{ "name":"UpdateChannel", "http":{ "method":"POST", - "requestUri":"/UpdateChannel" + "requestUri":"/UpdateChannel", + "responseCode":200 }, "input":{"shape":"UpdateChannelRequest"}, "output":{"shape":"UpdateChannelResponse"}, "errors":[ - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, - {"shape":"ConflictException"}, - {"shape":"PendingVerification"} + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"PendingVerification"}, + {"shape":"ConflictException"} ], "documentation":"Updates a channel's configuration. This does not affect an ongoing stream of this channel. You must stop and restart the stream for the changes to take effect.
" } @@ -420,7 +446,11 @@ "documentation":"User does not have sufficient access to perform this action.
" } }, - "error":{"httpStatusCode":403}, + "documentation":"", + "error":{ + "httpStatusCode":403, + "senderFault":true + }, "exception":true }, "BatchError":{ @@ -458,7 +488,10 @@ "BatchGetChannelResponse":{ "type":"structure", "members":{ - "channels":{"shape":"Channels"}, + "channels":{ + "shape":"Channels", + "documentation":"" + }, "errors":{ "shape":"BatchErrors", "documentation":"Each error object is related to a specific ARN in the request.
" @@ -478,8 +511,14 @@ "BatchGetStreamKeyResponse":{ "type":"structure", "members":{ - "streamKeys":{"shape":"StreamKeys"}, - "errors":{"shape":"BatchErrors"} + "errors":{ + "shape":"BatchErrors", + "documentation":"" + }, + "streamKeys":{ + "shape":"StreamKeys", + "documentation":"" + } } }, "Boolean":{"type":"boolean"}, @@ -490,37 +529,37 @@ "shape":"ChannelArn", "documentation":"Channel ARN.
" }, - "name":{ - "shape":"ChannelName", - "documentation":"Channel name.
" + "authorized":{ + "shape":"IsAuthorized", + "documentation":"Whether the channel is private (enabled for playback authorization). Default: false.
Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.
" }, "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. (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.)
Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. Valid values:
STANDARD: Multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Vertical resolution can be up to 1080 and bitrate can be up to 8.5 Mbps.
BASIC: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Vertical resolution can be up to 480 and bitrate can be up to 1.5 Mbps.
Recording-configuration ARN. A value other than an empty string indicates that recording is enabled. 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.
" + "name":{ + "shape":"ChannelName", + "documentation":"Channel name.
" }, "playbackUrl":{ "shape":"PlaybackURL", "documentation":"Channel playback URL.
" }, - "authorized":{ - "shape":"IsAuthorized", - "documentation":"Whether the channel is private (enabled for playback authorization). Default: false.
Recording-configuration ARN. A value other than an empty string indicates that recording is enabled. Default: \"\" (empty string, recording is disabled).
" }, "tags":{ "shape":"Tags", "documentation":"Array of 1-50 maps, each of the form string:string (key:value).
Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. Valid values:
STANDARD: Multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Resolution can be up to 1080p and bitrate can be up to 8.5 Mbps. Audio is transcoded only for renditions 360p and below; above that, audio is passed through.
BASIC: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Resolution can be up to 480p and bitrate can be up to 1.5 Mbps.
Object specifying a channel.
" @@ -562,7 +601,11 @@ "documentation":"The stream is offline for the given channel ARN.
" } }, - "error":{"httpStatusCode":404}, + "documentation":"", + "error":{ + "httpStatusCode":404, + "senderFault":true + }, "exception":true }, "ChannelRecordingConfigurationArn":{ @@ -578,17 +621,17 @@ "shape":"ChannelArn", "documentation":"Channel ARN.
" }, - "name":{ - "shape":"ChannelName", - "documentation":"Channel name.
" + "authorized":{ + "shape":"IsAuthorized", + "documentation":"Whether the channel is private (enabled for playback authorization). Default: false.
Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers. Default: LOW. (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.)
Whether the channel is private (enabled for playback authorization). Default: false.
Channel name.
" }, "recordingConfigurationArn":{ "shape":"ChannelRecordingConfigurationArn", @@ -620,27 +663,27 @@ "documentation":"Updating or deleting a resource can cause an inconsistent state.
" } }, - "error":{"httpStatusCode":409}, + "documentation":"", + "error":{ + "httpStatusCode":409, + "senderFault":true + }, "exception":true }, "CreateChannelRequest":{ "type":"structure", "members":{ - "name":{ - "shape":"ChannelName", - "documentation":"Channel name.
" + "authorized":{ + "shape":"Boolean", + "documentation":"Whether the channel is private (enabled for playback authorization). Default: false.
Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers. (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.) Default: LOW.
Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. Valid values:
STANDARD: Multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Vertical resolution can be up to 1080 and bitrate can be up to 8.5 Mbps.
BASIC: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Vertical resolution can be up to 480 and bitrate can be up to 1.5 Mbps.
Whether the channel is private (enabled for playback authorization). Default: false.
Channel name.
" }, "recordingConfigurationArn":{ "shape":"ChannelRecordingConfigurationArn", @@ -649,28 +692,38 @@ "tags":{ "shape":"Tags", "documentation":"Array of 1-50 maps, each of the form string:string (key:value).
Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. Valid values:
STANDARD: Multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Resolution can be up to 1080p and bitrate can be up to 8.5 Mbps. Audio is transcoded only for renditions 360p and below; above that, audio is passed through.
BASIC: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Resolution can be up to 480p and bitrate can be up to 1.5 Mbps.
An arbitrary string (a nickname) that helps the customer identify that resource. 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.
" }, + "name":{ + "shape":"RecordingConfigurationName", + "documentation":"Recording-configuration 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).
Playback-key-pair name. The value does not need to be unique.
" + }, "publicKeyMaterial":{ "shape":"PlaybackPublicKeyMaterial", "documentation":"The public portion of a customer-generated key pair.
" }, - "name":{ - "shape":"PlaybackKeyPairName", - "documentation":"An arbitrary string (a nickname) assigned to a playback key pair that helps the customer identify that resource. 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.
" @@ -862,7 +933,10 @@ "ImportPlaybackKeyPairResponse":{ "type":"structure", "members":{ - "keyPair":{"shape":"PlaybackKeyPair"} + "keyPair":{ + "shape":"PlaybackKeyPair", + "documentation":"" + } } }, "IngestEndpoint":{"type":"string"}, @@ -874,8 +948,10 @@ "documentation":"Unexpected error during processing of request.
" } }, + "documentation":"", "error":{"httpStatusCode":500}, - "exception":true + "exception":true, + "fault":true }, "IsAuthorized":{"type":"boolean"}, "ListChannelsRequest":{ @@ -889,13 +965,13 @@ "shape":"ChannelRecordingConfigurationArn", "documentation":"Filters the channel list to match the specified recording-configuration ARN.
" }, - "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: 50.
" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"The first channel to retrieve. This is used for pagination; see the nextToken response field.
Maximum number of key pairs to return.
" - }, "maxResults":{ "shape":"MaxPlaybackKeyPairResults", "documentation":"The first key pair to retrieve. This is used for pagination; see the nextToken response field. Default: 50.
Maximum number of key pairs to return.
" } } }, @@ -943,13 +1019,13 @@ "ListRecordingConfigurationsRequest":{ "type":"structure", "members":{ - "nextToken":{ - "shape":"PaginationToken", - "documentation":"The first recording configuration to retrieve. This is used for pagination; see the nextToken response field.
Maximum number of recording configurations to return. Default: 50.
" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"The first recording configuration to retrieve. This is used for pagination; see the nextToken response field.
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.
List of the matching recording configurations.
" } } }, @@ -975,13 +1051,13 @@ "shape":"ChannelArn", "documentation":"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: 50.
" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"The first stream key to retrieve. This is used for pagination; see the nextToken response field.
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.
List of stream keys.
" } } }, "ListStreamsRequest":{ "type":"structure", "members":{ - "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: 50.
" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"The first stream to retrieve. This is used for pagination; see the nextToken response field.
List of streams.
" - }, "nextToken":{ "shape":"PaginationToken", "documentation":"If there are more streams than maxResults, use nextToken in the request to get the next set.
List of streams.
" } } }, @@ -1035,14 +1111,6 @@ "documentation":"The ARN of the resource to be retrieved.
", "location":"uri", "locationName":"resourceArn" - }, - "nextToken":{ - "shape":"String", - "documentation":"The first tag to retrieve. This is used for pagination; see the nextToken response field.
Maximum number of tags to return. Default: 50.
" } } }, @@ -1050,10 +1118,9 @@ "type":"structure", "required":["tags"], "members":{ - "tags":{"shape":"Tags"}, - "nextToken":{ - "shape":"String", - "documentation":"If there are more tags than maxResults, use nextToken in the request to get the next set.
Your account is pending verification.
" } }, - "error":{"httpStatusCode":403}, + "documentation":"", + "error":{ + "httpStatusCode":403, + "senderFault":true + }, "exception":true }, "PlaybackKeyPair":{ @@ -1110,14 +1176,14 @@ "shape":"PlaybackKeyPairArn", "documentation":"Key-pair ARN.
" }, - "name":{ - "shape":"PlaybackKeyPairName", - "documentation":"An arbitrary string (a nickname) assigned to a playback key pair that helps the customer identify that resource. The value does not need to be unique.
" - }, "fingerprint":{ "shape":"PlaybackKeyPairFingerprint", "documentation":"Key-pair identifier.
" }, + "name":{ + "shape":"PlaybackKeyPairName", + "documentation":"Playback-key-pair 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).
An arbitrary string (a nickname) assigned to a playback key pair that helps the customer identify that resource. The value does not need to be unique.
" + "documentation":"Playback-key-pair name. The value does not need to be unique.
" }, "tags":{ "shape":"Tags", @@ -1191,14 +1257,14 @@ "shape":"RecordingConfigurationArn", "documentation":"Recording-configuration ARN.
" }, - "name":{ - "shape":"RecordingConfigurationName", - "documentation":"An arbitrary string (a nickname) assigned to a recording configuration that helps the customer identify that resource. 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.
" }, + "name":{ + "shape":"RecordingConfigurationName", + "documentation":"Recording-configuration name. The value does not need to be unique.
" + }, "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.
Recording-configuration ARN.
" }, - "name":{ - "shape":"RecordingConfigurationName", - "documentation":"An arbitrary string (a nickname) assigned to a recording configuration that helps the customer identify that resource. 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.
" }, + "name":{ + "shape":"RecordingConfigurationName", + "documentation":"Recording-configuration name. The value does not need to be unique.
" + }, "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.
Request references a resource which does not exist.
" } }, - "error":{"httpStatusCode":404}, + "documentation":"", + "error":{ + "httpStatusCode":404, + "senderFault":true + }, "exception":true }, "S3DestinationBucketName":{ @@ -1307,7 +1377,11 @@ "documentation":"Request would cause a service quota to be exceeded.
" } }, - "error":{"httpStatusCode":402}, + "documentation":"", + "error":{ + "httpStatusCode":402, + "senderFault":true + }, "exception":true }, "StopStreamRequest":{ @@ -1332,25 +1406,25 @@ "shape":"ChannelArn", "documentation":"Channel ARN for the stream.
" }, + "health":{ + "shape":"StreamHealth", + "documentation":"The stream’s health.
" + }, "playbackUrl":{ "shape":"PlaybackURL", "documentation":"URL of the master playlist, required by the video player to play the HLS stream.
" }, "startTime":{ "shape":"StreamStartTime", - "documentation":"ISO-8601 formatted timestamp of the stream’s start.
" + "documentation":"Time of the stream’s start. This is an ISO 8601 timestamp returned as a string.
" }, "state":{ "shape":"StreamState", "documentation":"The stream’s state.
" }, - "health":{ - "shape":"StreamHealth", - "documentation":"The stream’s health.
" - }, "viewerCount":{ "shape":"StreamViewerCount", - "documentation":"Number of current viewers of the stream. A value of -1 indicates that the request timed out; in this case, retry.
" + "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.
" @@ -1370,10 +1444,6 @@ "shape":"StreamKeyArn", "documentation":"Stream-key ARN.
" }, - "value":{ - "shape":"StreamKeyValue", - "documentation":"Stream-key value.
" - }, "channelArn":{ "shape":"ChannelArn", "documentation":"Channel ARN for the stream.
" @@ -1381,6 +1451,10 @@ "tags":{ "shape":"Tags", "documentation":"Array of 1-50 maps, each of the form string:string (key:value).
Stream-key value.
" } }, "documentation":"Object specifying a stream key.
" @@ -1419,7 +1493,10 @@ }, "documentation":"Summary information about a stream key.
" }, - "StreamKeyValue":{"type":"string"}, + "StreamKeyValue":{ + "type":"string", + "sensitive":true + }, "StreamKeys":{ "type":"list", "member":{"shape":"StreamKey"} @@ -1430,7 +1507,8 @@ }, "StreamMetadata":{ "type":"string", - "min":1 + "min":1, + "sensitive":true }, "StreamStartTime":{ "type":"timestamp", @@ -1450,21 +1528,21 @@ "shape":"ChannelArn", "documentation":"Channel ARN for the stream.
" }, - "state":{ - "shape":"StreamState", - "documentation":"The stream’s state.
" - }, "health":{ "shape":"StreamHealth", "documentation":"The stream’s health.
" }, - "viewerCount":{ - "shape":"StreamViewerCount", - "documentation":"Number of current viewers of the stream. A value of -1 indicates that the request timed out; in this case, retry.
" - }, "startTime":{ "shape":"StreamStartTime", - "documentation":"ISO-8601 formatted timestamp of the stream’s start.
" + "documentation":"Time of the stream’s start. This is an ISO 8601 timestamp returned as a string.
" + }, + "state":{ + "shape":"StreamState", + "documentation":"The stream’s state.
" + }, + "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.
Summary information about a stream.
" @@ -1477,11 +1555,12 @@ "documentation":"The stream is temporarily unavailable.
" } }, + "documentation":"", "error":{"httpStatusCode":503}, - "exception":true + "exception":true, + "fault":true }, "StreamViewerCount":{"type":"long"}, - "String":{"type":"string"}, "TagKey":{ "type":"string", "max":128, @@ -1519,7 +1598,8 @@ }, "TagValue":{ "type":"string", - "max":256 + "max":256, + "min":0 }, "Tags":{ "type":"map", @@ -1536,7 +1616,11 @@ "documentation":"Request was denied due to request throttling.
" } }, - "error":{"httpStatusCode":429}, + "documentation":"", + "error":{ + "httpStatusCode":429, + "senderFault":true + }, "exception":true }, "UntagResourceRequest":{ @@ -1573,25 +1657,25 @@ "shape":"ChannelArn", "documentation":"ARN of the channel to be updated.
" }, - "name":{ - "shape":"ChannelName", - "documentation":"Channel name.
" + "authorized":{ + "shape":"Boolean", + "documentation":"Whether the channel is private (enabled for playback authorization).
" }, "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. (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.)
Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately. Valid values:
STANDARD: Multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Vertical resolution can be up to 1080 and bitrate can be up to 8.5 Mbps.
BASIC: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Vertical resolution can be up to 480 and bitrate can be up to 1.5 Mbps.
Whether the channel is private (enabled for playback authorization).
" + "name":{ + "shape":"ChannelName", + "documentation":"Channel name.
" }, "recordingConfigurationArn":{ "shape":"ChannelRecordingConfigurationArn", "documentation":"Recording-configuration ARN. If this is set to an empty string, recording is disabled. A value other than an empty string indicates that recording is enabled
" + }, + "type":{ + "shape":"ChannelType", + "documentation":"Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately. Valid values:
STANDARD: Multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Resolution can be up to 1080p and bitrate can be up to 8.5 Mbps. Audio is transcoded only for renditions 360p and below; above that, audio is passed through.
BASIC: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Resolution can be up to 480p and bitrate can be up to 1.5 Mbps.
The input fails to satisfy the constraints specified by an AWS service.
" + "documentation":"The input fails to satisfy the constraints specified by an Amazon Web Services service.
" } }, - "error":{"httpStatusCode":400}, + "documentation":"", + "error":{ + "httpStatusCode":400, + "senderFault":true + }, "exception":true }, "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 AWS EventBridge event stream for responses. JSON is used for both requests and responses, including errors.
The API is an AWS regional service, currently in these regions: us-west-2, us-east-1, and eu-west-1.
All API request parameters and URLs are case sensitive.
For a summary of notable documentation changes in each release, see Document History.
Service Endpoints
The following are the Amazon IVS service endpoints (all HTTPS):
Region name: US West (Oregon)
Region: us-west-2
Endpoint: ivs.us-west-2.amazonaws.com
Region name: US East (Virginia)
Region: us-east-1
Endpoint: ivs.us-east-1.amazonaws.com
Region name: EU West (Dublin)
Region: eu-west-1
Endpoint: ivs.eu-west-1.amazonaws.com
Allowed Header Values
Accept: application/json
Accept-Encoding: gzip, deflate
Content-Type: application/json
Resources
The following resources contain information about your IVS live stream (see Getting Started with Amazon IVS):
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. See the Channel endpoints for more information.
Stream key — An identifier assigned by Amazon IVS when you create a channel, which is then used to authorize streaming. See the StreamKey endpoints for more information. 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. See the PlaybackKeyPair endpoints for more information.
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. See the Recording Configuration endpoints for more information.
Tagging
A tag is a metadata label that you assign to an AWS 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 AWS 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 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.
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. You need to be authorized 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 AWS 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 AWS credentials that have permission to perform the requested action. For example, you must sign PutMetadata requests with a signature generated from an IAM user account that has the ivs:PutMetadata permission.
For more information:
Authentication and generating signatures — See Authenticating Requests (AWS Signature Version 4) in the AWS General Reference.
Managing Amazon IVS permissions — See Identity and Access Management on the Security page of the Amazon IVS User Guide.
Channel Endpoints
CreateChannel — Creates a new channel and an associated stream key to start streaming.
GetChannel — Gets the channel configuration for the specified channel ARN (Amazon Resource Name).
BatchGetChannel — Performs GetChannel on multiple ARNs simultaneously.
ListChannels — Gets summary information about all channels in your account, in the AWS 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 Conflict Exception).
UpdateChannel — Updates a channel's configuration. This does not affect an ongoing stream of this channel. You must stop and restart the stream for the changes to take effect.
DeleteChannel — Deletes the specified channel.
StreamKey Endpoints
CreateStreamKey — Creates a stream key, used to initiate a stream, for the specified channel ARN.
GetStreamKey — Gets stream key information for the specified ARN.
BatchGetStreamKey — Performs GetStreamKey on multiple ARNs simultaneously.
ListStreamKeys — Gets summary information about stream keys for the specified channel.
DeleteStreamKey — Deletes the stream key for the specified ARN, so it can no longer be used to stream.
Stream Endpoints
GetStream — Gets information about the active (live) stream on a specified channel.
ListStreams — Gets summary information about live streams in your account, in the AWS region where the API request is processed.
StopStream — Disconnects the incoming RTMPS stream for the specified channel. Can be used in conjunction with DeleteStreamKey to prevent further streaming to a channel.
PutMetadata — Inserts metadata into the active stream of the specified channel. A maximum of 5 requests per second per channel is 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.)
PlaybackKeyPair Endpoints
For more information, see Setting Up Private Channels in the Amazon IVS User Guide.
ImportPlaybackKeyPair — Imports the public portion of a new key pair and returns its arn and fingerprint. The privateKey can then be used to generate viewer authorization tokens, to grant viewers access to private channels (channels enabled for playback authorization).
GetPlaybackKeyPair — Gets a specified playback authorization key pair and returns the arn and fingerprint. The privateKey held by the caller can be used to generate viewer authorization tokens, to grant viewers access to private channels.
ListPlaybackKeyPairs — Gets summary information about playback key pairs.
DeletePlaybackKeyPair — Deletes a specified authorization key pair. This invalidates future viewer tokens generated using the key pair’s privateKey.
RecordingConfiguration Endpoints
CreateRecordingConfiguration — Creates a new recording configuration, used to enable recording to Amazon S3.
GetRecordingConfiguration — Gets the recording-configuration metadata for the specified ARN.
ListRecordingConfigurations — Gets summary information about all recording configurations in your account, in the AWS region where the API request is processed.
DeleteRecordingConfiguration — Deletes the recording configuration for the specified ARN.
AWS Tags Endpoints
TagResource — Adds or updates tags for the AWS resource with the specified ARN.
UntagResource — Removes tags from the resource with the specified ARN.
ListTagsForResource — Gets information about AWS tags for the specified ARN.
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.
<p> <b>Allowed Header Values</b> </p> <ul> <li> <p> <code> <b>Accept:</b> </code> application/json</p> </li> <li> <p> <code> <b>Accept-Encoding:</b> </code> gzip, deflate</p> </li> <li> <p> <code> <b>Content-Type:</b> </code>application/json</p> </li> </ul> <p> <b>Resources</b> </p> <p>The following resources contain information about your IVS live stream (see <a href="https://docs.aws.amazon.com/ivs/latest/userguide/getting-started.html"> Getting Started with Amazon IVS</a>):</p> <ul> <li> <p>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. See the Channel endpoints for more information. </p> </li> <li> <p>Stream key — An identifier assigned by Amazon IVS when you create a channel, which is then used to authorize streaming. See the StreamKey endpoints for more information. <i> <b>Treat the stream key like a secret, since it allows anyone to stream to the channel.</b> </i> </p> </li> <li> <p>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. See the PlaybackKeyPair endpoints for more information.</p> </li> <li> <p>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. See the Recording Configuration endpoints for more information.</p> </li> </ul> <p> <b>Tagging</b> </p> <p>A <i>tag</i> is a metadata label that you assign to an Amazon Web Services resource. A tag comprises a <i>key</i> and a <i>value</i>, both set by you. For example, you might set a tag as <code>topic:nature</code> to label a particular video category. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a> for more information, including restrictions that apply to tags.</p> <p>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 <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html"> Access Tags</a>). </p> <p>The Amazon IVS API has these tag-related endpoints: <a>TagResource</a>, <a>UntagResource</a>, and <a>ListTagsForResource</a>. The following resources support tagging: Channels, Stream Keys, Playback Key Pairs, and Recording Configurations.</p> <p>At most 50 tags can be applied to a resource. </p> <p> <b>Authentication versus Authorization</b> </p> <p>Note the differences between these concepts:</p> <ul> <li> <p> <i>Authentication</i> is about verifying identity. You need to be authenticated to sign Amazon IVS API requests.</p> </li> <li> <p> <i>Authorization</i> is about granting permissions. You need to be authorized to view <a href="https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html">Amazon IVS private channels</a>. (Private channels are channels that are enabled for "playback authorization.")</p> </li> </ul> <p> <b>Authentication</b> </p> <p>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.</p> <p>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 an IAM user account that has the <code>ivs:PutMetadata</code> permission.</p> <p>For more information:</p> <ul> <li> <p>Authentication and generating signatures — See <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html">Authenticating Requests (Amazon Web Services Signature Version 4)</a> in the <i>Amazon Web Services General Reference</i>.</p> </li> <li> <p>Managing Amazon IVS permissions — See <a href="https://docs.aws.amazon.com/ivs/latest/userguide/security-iam.html">Identity and Access Management</a> on the Security page of the <i>Amazon IVS User Guide</i>.</p> </li> </ul> <p> <b>Channel Endpoints</b> </p> <ul> <li> <p> <a>CreateChannel</a> — Creates a new channel and an associated stream key to start streaming.</p> </li> <li> <p> <a>GetChannel</a> — Gets the channel configuration for the specified channel ARN (Amazon Resource Name).</p> </li> <li> <p> <a>BatchGetChannel</a> — Performs <a>GetChannel</a> on multiple ARNs simultaneously.</p> </li> <li> <p> <a>ListChannels</a> — 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 Conflict Exception).</p> </li> <li> <p> <a>UpdateChannel</a> — Updates a channel's configuration. This does not affect an ongoing stream of this channel. You must stop and restart the stream for the changes to take effect.</p> </li> <li> <p> <a>DeleteChannel</a> — Deletes the specified channel.</p> </li> </ul> <p> <b>StreamKey Endpoints</b> </p> <ul> <li> <p> <a>CreateStreamKey</a> — Creates a stream key, used to initiate a stream, for the specified channel ARN.</p> </li> <li> <p> <a>GetStreamKey</a> — Gets stream key information for the specified ARN.</p> </li> <li> <p> <a>BatchGetStreamKey</a> — Performs <a>GetStreamKey</a> on multiple ARNs simultaneously.</p> </li> <li> <p> <a>ListStreamKeys</a> — Gets summary information about stream keys for the specified channel.</p> </li> <li> <p> <a>DeleteStreamKey</a> — Deletes the stream key for the specified ARN, so it can no longer be used to stream.</p> </li> </ul> <p> <b>Stream Endpoints</b> </p> <ul> <li> <p> <a>GetStream</a> — Gets information about the active (live) stream on a specified channel.</p> </li> <li> <p> <a>ListStreams</a> — Gets summary information about live streams in your account, in the Amazon Web Services region where the API request is processed.</p> </li> <li> <p> <a>StopStream</a> — Disconnects the incoming RTMPS stream for the specified channel. Can be used in conjunction with <a>DeleteStreamKey</a> to prevent further streaming to a channel.</p> </li> <li> <p> <a>PutMetadata</a> — 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.</p> </li> </ul> <p> <b>PlaybackKeyPair Endpoints</b> </p> <p>For more information, see <a href="https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html">Setting Up Private Channels</a> in the <i>Amazon IVS User Guide</i>.</p> <ul> <li> <p> <a>ImportPlaybackKeyPair</a> — Imports the public portion of a new key pair and returns its <code>arn</code> and <code>fingerprint</code>. The <code>privateKey</code> can then be used to generate viewer authorization tokens, to grant viewers access to private channels (channels enabled for playback authorization).</p> </li> <li> <p> <a>GetPlaybackKeyPair</a> — Gets a specified playback authorization key pair and returns the <code>arn</code> and <code>fingerprint</code>. The <code>privateKey</code> held by the caller can be used to generate viewer authorization tokens, to grant viewers access to private channels.</p> </li> <li> <p> <a>ListPlaybackKeyPairs</a> — Gets summary information about playback key pairs.</p> </li> <li> <p> <a>DeletePlaybackKeyPair</a> — Deletes a specified authorization key pair. This invalidates future viewer tokens generated using the key pair’s <code>privateKey</code>.</p> </li> </ul> <p> <b>RecordingConfiguration Endpoints</b> </p> <ul> <li> <p> <a>CreateRecordingConfiguration</a> — Creates a new recording configuration, used to enable recording to Amazon S3.</p> </li> <li> <p> <a>GetRecordingConfiguration</a> — Gets the recording-configuration metadata for the specified ARN.</p> </li> <li> <p> <a>ListRecordingConfigurations</a> — Gets summary information about all recording configurations in your account, in the Amazon Web Services region where the API request is processed.</p> </li> <li> <p> <a>DeleteRecordingConfiguration</a> — Deletes the recording configuration for the specified ARN.</p> </li> </ul> <p> <b>Amazon Web Services Tags Endpoints</b> </p> <ul> <li> <p> <a>TagResource</a> — Adds or updates tags for the Amazon Web Services resource with the specified ARN.</p> </li> <li> <p> <a>UntagResource</a> — Removes tags from the resource with the specified ARN.</p> </li> <li> <p> <a>ListTagsForResource</a> — Gets information about Amazon Web Services tags for the specified ARN.</p> </li> </ul> Creates Amazon QuickSight customizations the current Amazon Web Services Region;. Currently, you can add a custom default theme by using the CreateAccountCustomization or UpdateAccountCustomization API operation. To further customize Amazon QuickSight by removing Amazon QuickSight sample assets and videos for all new users, see Customizing Amazon QuickSight in the Amazon QuickSight User Guide.
You can create customizations for your Amazon Web Services account or, if you specify a namespace, for a Amazon QuickSight namespace instead. Customizations that apply to a namespace always override customizations that apply to an Amazon Web Services account. To find out which customizations apply, use the DescribeAccountCustomization API operation.
Before you use the CreateAccountCustomization API operation to add a theme as the namespace default, make sure that you first share the theme with the namespace. If you don't share it with the namespace, the theme isn't visible to your users even if you make it the default theme. To check if the theme is shared, view the current permissions by using the DescribeThemePermissions API operation. To share the theme, grant permissions by using the UpdateThemePermissions API operation.
Creates Amazon QuickSight customizations the current Amazon Web Services Region. Currently, you can add a custom default theme by using the CreateAccountCustomization or UpdateAccountCustomization API operation. To further customize Amazon QuickSight by removing Amazon QuickSight sample assets and videos for all new users, see Customizing Amazon QuickSight in the Amazon QuickSight User Guide.
You can create customizations for your Amazon Web Services account or, if you specify a namespace, for a Amazon QuickSight namespace instead. Customizations that apply to a namespace always override customizations that apply to an Amazon Web Services account. To find out which customizations apply, use the DescribeAccountCustomization API operation.
Before you use the CreateAccountCustomization API operation to add a theme as the namespace default, make sure that you first share the theme with the namespace. If you don't share it with the namespace, the theme isn't visible to your users even if you make it the default theme. To check if the theme is shared, view the current permissions by using the DescribeThemePermissions API operation. To share the theme, grant permissions by using the UpdateThemePermissions API operation.
Deletes all Amazon QuickSight customizations in this Amazon Web Services Region; for the specified Amazon Web Services account and Amazon QuickSight namespace.
" + "documentation":"Deletes all Amazon QuickSight customizations in this Amazon Web Services Region for the specified Amazon Web Services account and Amazon QuickSight namespace.
" }, "DeleteAnalysis":{ "name":"DeleteAnalysis", @@ -678,7 +678,7 @@ {"shape":"InternalFailureException"}, {"shape":"ResourceUnavailableException"} ], - "documentation":"Describes the customizations associated with the provided Amazon Web Services account and Amazon Amazon QuickSight namespace in an Amazon Web Services Region;. The Amazon QuickSight console evaluates which customizations to apply by running this API operation with the Resolved flag included.
To determine what customizations display when you run this command, it can help to visualize the relationship of the entities involved.
Amazon Web Services account - The Amazon Web Services account exists at the top of the hierarchy. It has the potential to use all of the Amazon Web Services Regions; and AWS Services. When you subscribe to Amazon QuickSight, you choose one Amazon Web Services Region; to use as your home Region. That's where your free SPICE capacity is located. You can use Amazon QuickSight in any supported Amazon Web Services Region;.
Amazon Web Services Region; - In each Amazon Web Services Region; where you sign in to Amazon QuickSight at least once, Amazon QuickSight acts as a separate instance of the same service. If you have a user directory, it resides in us-east-1, which is the US East (N. Virginia). Generally speaking, these users have access to Amazon QuickSight in any Amazon Web Services Region;, unless they are constrained to a namespace.
To run the command in a different Amazon Web Services Region;, you change your Region settings. If you're using the AWS CLI, you can use one of the following options:
Use command line options.
Use named profiles.
Run aws configure to change your default Amazon Web Services Region;. Use Enter to key the same settings for your keys. For more information, see Configuring the AWS CLI.
Namespace - A Amazon QuickSight namespace is a partition that contains users and assets (data sources, datasets, dashboards, and so on). To access assets that are in a specific namespace, users and groups must also be part of the same namespace. People who share a namespace are completely isolated from users and assets in other namespaces, even if they are in the same Amazon Web Services account and Amazon Web Services Region;.
Applied customizations - Within an Amazon Web Services Region;, a set of Amazon QuickSight customizations can apply to an Amazon Web Services account or to a namespace. Settings that you apply to a namespace override settings that you apply to an Amazon Web Services account. All settings are isolated to a single Amazon Web Services Region;. To apply them in other Amazon Web Services Regions;, run the CreateAccountCustomization command in each Amazon Web Services Region; where you want to apply the same customizations.
Describes the customizations associated with the provided Amazon Web Services account and Amazon Amazon QuickSight namespace in an Amazon Web Services Region. The Amazon QuickSight console evaluates which customizations to apply by running this API operation with the Resolved flag included.
To determine what customizations display when you run this command, it can help to visualize the relationship of the entities involved.
Amazon Web Services account - The Amazon Web Services account exists at the top of the hierarchy. It has the potential to use all of the Amazon Web Services Regions and AWS Services. When you subscribe to Amazon QuickSight, you choose one Amazon Web Services Region to use as your home Region. That's where your free SPICE capacity is located. You can use Amazon QuickSight in any supported Amazon Web Services Region.
Amazon Web Services Region - In each Amazon Web Services Region where you sign in to Amazon QuickSight at least once, Amazon QuickSight acts as a separate instance of the same service. If you have a user directory, it resides in us-east-1, which is the US East (N. Virginia). Generally speaking, these users have access to Amazon QuickSight in any Amazon Web Services Region, unless they are constrained to a namespace.
To run the command in a different Amazon Web Services Region, you change your Region settings. If you're using the AWS CLI, you can use one of the following options:
Use command line options.
Use named profiles.
Run aws configure to change your default Amazon Web Services Region. Use Enter to key the same settings for your keys. For more information, see Configuring the AWS CLI.
Namespace - A Amazon QuickSight namespace is a partition that contains users and assets (data sources, datasets, dashboards, and so on). To access assets that are in a specific namespace, users and groups must also be part of the same namespace. People who share a namespace are completely isolated from users and assets in other namespaces, even if they are in the same Amazon Web Services account and Amazon Web Services Region.
Applied customizations - Within an Amazon Web Services Region, a set of Amazon QuickSight customizations can apply to an Amazon Web Services account or to a namespace. Settings that you apply to a namespace override settings that you apply to an Amazon Web Services account. All settings are isolated to a single Amazon Web Services Region. To apply them in other Amazon Web Services Regions, run the CreateAccountCustomization command in each Amazon Web Services Region where you want to apply the same customizations.
Describes a SPICE ingestion.
" }, + "DescribeIpRestriction":{ + "name":"DescribeIpRestriction", + "http":{ + "method":"GET", + "requestUri":"/accounts/{AwsAccountId}/ip-restriction" + }, + "input":{"shape":"DescribeIpRestrictionRequest"}, + "output":{"shape":"DescribeIpRestrictionResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"ThrottlingException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"Provides a summary and status of IP Rules.
" + }, "DescribeNamespace":{ "name":"DescribeNamespace", "http":{ @@ -1242,7 +1259,7 @@ {"shape":"InvalidNextTokenException"}, {"shape":"InternalFailureException"} ], - "documentation":"Lists all of the datasets belonging to the current Amazon Web Services account in an Amazon Web Services Region;.
The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/*.
Lists all of the datasets belonging to the current Amazon Web Services account in an Amazon Web Services Region.
The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/*.
Lists data sources in current Amazon Web Services Region; that belong to this Amazon Web Services account.
" + "documentation":"Lists data sources in current Amazon Web Services Region that belong to this Amazon Web Services account.
" }, "ListFolderMembers":{ "name":"ListFolderMembers", @@ -1726,7 +1743,7 @@ {"shape":"InternalFailureException"}, {"shape":"ResourceUnavailableException"} ], - "documentation":"Updates Amazon QuickSight customizations the current Amazon Web Services Region;. Currently, the only customization you can use is a theme.
You can use customizations for your Amazon Web Services account or, if you specify a namespace, for a Amazon QuickSight namespace instead. Customizations that apply to a namespace override customizations that apply to an Amazon Web Services account. To find out which customizations apply, use the DescribeAccountCustomization API operation.
Updates Amazon QuickSight customizations the current Amazon Web Services Region. Currently, the only customization you can use is a theme.
You can use customizations for your Amazon Web Services account or, if you specify a namespace, for a Amazon QuickSight namespace instead. Customizations that apply to a namespace override customizations that apply to an Amazon Web Services account. To find out which customizations apply, use the DescribeAccountCustomization API operation.
Updates an existing IAMpolicy assignment. This operation updates only the optional parameter or parameters that are specified in the request. This overwrites all of the users included in Identities.
Updates content and status of IP Rules.
" + }, "UpdateTemplate":{ "name":"UpdateTemplate", "http":{ @@ -2144,7 +2179,7 @@ "documentation":"The default theme for this Amazon QuickSight subscription.
" } }, - "documentation":"The Amazon QuickSight customizations associated with your Amazon Web Services account or a Amazon QuickSight namespace in a specific Amazon Web Services Region;.
" + "documentation":"The Amazon QuickSight customizations associated with your Amazon Web Services account or a Amazon QuickSight namespace in a specific Amazon Web Services Region.
" }, "AccountSettings":{ "type":"structure", @@ -2220,10 +2255,10 @@ "members":{ "Domain":{ "shape":"Domain", - "documentation":"The Elasticsearch domain.
" + "documentation":"The OpenSearch domain.
" } }, - "documentation":"The parameters for Elasticsearch.
" + "documentation":"The parameters for OpenSearch.
" }, "AmazonOpenSearchParameters":{ "type":"structure", @@ -2531,6 +2566,10 @@ }, "documentation":"The display options for tile borders for visuals.
" }, + "CIDR":{ + "type":"string", + "pattern":"^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\\/(3[0-2]|[1-2][0-9]|[1-9]))$" + }, "CalculatedColumn":{ "type":"structure", "required":[ @@ -2575,7 +2614,7 @@ "locationName":"AwsAccountId" }, "DataSetId":{ - "shape":"string", + "shape":"String", "documentation":"The ID of the dataset used in the ingestion.
", "location":"uri", "locationName":"DataSetId" @@ -2600,7 +2639,7 @@ "documentation":"An ID for the ingestion.
" }, "RequestId":{ - "shape":"string", + "shape":"String", "documentation":"The Amazon Web Services request ID for this operation.
" }, "Status":{ @@ -2867,7 +2906,7 @@ }, "AccountCustomization":{ "shape":"AccountCustomization", - "documentation":"The Amazon QuickSight customizations you're adding in the current Amazon Web Services Region;. You can add these to an Amazon Web Services account and a Amazon QuickSight namespace.
For example, you can add a default theme by setting AccountCustomization to the midnight theme: \"AccountCustomization\": { \"DefaultTheme\": \"arn:aws:quicksight::aws:theme/MIDNIGHT\" }. Or, you can add a custom theme by specifying \"AccountCustomization\": { \"DefaultTheme\": \"arn:aws:quicksight:us-west-2:111122223333:theme/bdb844d0-0fe9-4d9d-b520-0fe602d93639\" }.
The Amazon QuickSight customizations you're adding in the current Amazon Web Services Region. You can add these to an Amazon Web Services account and a Amazon QuickSight namespace.
For example, you can add a default theme by setting AccountCustomization to the midnight theme: \"AccountCustomization\": { \"DefaultTheme\": \"arn:aws:quicksight::aws:theme/MIDNIGHT\" }. Or, you can add a custom theme by specifying \"AccountCustomization\": { \"DefaultTheme\": \"arn:aws:quicksight:us-west-2:111122223333:theme/bdb844d0-0fe9-4d9d-b520-0fe602d93639\" }.
The Amazon QuickSight customizations you're adding in the current Amazon Web Services Region;.
" + "documentation":"The Amazon QuickSight customizations you're adding in the current Amazon Web Services Region.
" }, "RequestId":{ "shape":"String", @@ -3024,7 +3063,7 @@ }, "SourceEntity":{ "shape":"DashboardSourceEntity", - "documentation":"The entity that you are using as a source when you create the dashboard. In SourceEntity, you specify the type of object you're using as source. You can only create a dashboard from a template, so you use a SourceTemplate entity. If you need to create a dashboard from an analysis, first convert the analysis to a template by using the CreateTemplate API operation. For SourceTemplate, specify the Amazon Resource Name (ARN) of the source template. The SourceTemplateARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region;.
Use the DataSetReferences entity within SourceTemplate to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.
The entity that you are using as a source when you create the dashboard. In SourceEntity, you specify the type of object you're using as source. You can only create a dashboard from a template, so you use a SourceTemplate entity. If you need to create a dashboard from an analysis, first convert the analysis to a template by using the CreateTemplate API operation. For SourceTemplate, specify the Amazon Resource Name (ARN) of the source template. The SourceTemplateARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region.
Use the DataSetReferences entity within SourceTemplate to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.
An ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.
" + "documentation":"An ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
" }, "Name":{ "shape":"ResourceName", @@ -3150,7 +3189,7 @@ }, "DataSetId":{ "shape":"ResourceId", - "documentation":"The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.
" + "documentation":"The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
" }, "IngestionArn":{ "shape":"Arn", @@ -3188,7 +3227,7 @@ }, "DataSourceId":{ "shape":"ResourceId", - "documentation":"An ID for the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.
" + "documentation":"An ID for the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
" }, "Name":{ "shape":"ResourceName", @@ -3196,7 +3235,7 @@ }, "Type":{ "shape":"DataSourceType", - "documentation":"The type of the data source. To return a list of all data sources, use ListDataSources.
Use AMAZON_ELASTICSEARCH for Amazon Elasticsearch Service.
The type of the data source. To return a list of all data sources, use ListDataSources.
Use AMAZON_ELASTICSEARCH for Amazon OpenSearch Service.
The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.
" + "documentation":"The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
" }, "CreationStatus":{ "shape":"ResourceStatus", @@ -3550,7 +3589,7 @@ ], "members":{ "DataSetId":{ - "shape":"string", + "shape":"String", "documentation":"The ID of the dataset used in the ingestion.
", "location":"uri", "locationName":"DataSetId" @@ -3566,6 +3605,10 @@ "documentation":"The Amazon Web Services account ID.
", "location":"uri", "locationName":"AwsAccountId" + }, + "IngestionType":{ + "shape":"IngestionType", + "documentation":"The type of ingestion that you want to create.
" } } }, @@ -3585,7 +3628,7 @@ "documentation":"The ingestion status.
" }, "RequestId":{ - "shape":"string", + "shape":"String", "documentation":"The Amazon Web Services request ID for this operation.
" }, "Status":{ @@ -3738,7 +3781,7 @@ }, "SourceEntity":{ "shape":"TemplateSourceEntity", - "documentation":"The entity that you are using as a source when you create the template. In SourceEntity, you specify the type of object you're using as source: SourceTemplate for a template or SourceAnalysis for an analysis. Both of these require an Amazon Resource Name (ARN). For SourceTemplate, specify the ARN of the source template. For SourceAnalysis, specify the ARN of the source analysis. The SourceTemplate ARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region;.
Use the DataSetReferences entity within SourceTemplate or SourceAnalysis to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.
The entity that you are using as a source when you create the template. In SourceEntity, you specify the type of object you're using as source: SourceTemplate for a template or SourceAnalysis for an analysis. Both of these require an Amazon Resource Name (ARN). For SourceTemplate, specify the ARN of the source template. For SourceAnalysis, specify the ARN of the source analysis. The SourceTemplate ARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region.
Use the DataSetReferences entity within SourceTemplate or SourceAnalysis to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.
The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.
" + "documentation":"The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
" }, "Name":{ "shape":"ResourceName", @@ -4571,7 +4614,7 @@ "members":{ "AmazonElasticsearchParameters":{ "shape":"AmazonElasticsearchParameters", - "documentation":"The parameters for Elasticsearch.
" + "documentation":"The parameters for OpenSearch.
" }, "AthenaParameters":{ "shape":"AthenaParameters", @@ -4745,7 +4788,7 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID for the Amazon Web Services account that you want to delete Amazon QuickSight customizations from in this Amazon Web Services Region;.
", + "documentation":"The ID for the Amazon Web Services account that you want to delete Amazon QuickSight customizations from in this Amazon Web Services Region.
", "location":"uri", "locationName":"AwsAccountId" }, @@ -4894,7 +4937,7 @@ }, "DataSetId":{ "shape":"ResourceId", - "documentation":"The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.
", + "documentation":"The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
", "location":"uri", "locationName":"DataSetId" } @@ -4909,7 +4952,7 @@ }, "DataSetId":{ "shape":"ResourceId", - "documentation":"The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.
" + "documentation":"The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
" }, "RequestId":{ "shape":"String", @@ -4937,7 +4980,7 @@ }, "DataSourceId":{ "shape":"ResourceId", - "documentation":"The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.
", + "documentation":"The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
", "location":"uri", "locationName":"DataSourceId" } @@ -4952,7 +4995,7 @@ }, "DataSourceId":{ "shape":"ResourceId", - "documentation":"The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.
" + "documentation":"The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
" }, "RequestId":{ "shape":"String", @@ -5565,7 +5608,7 @@ }, "AccountCustomization":{ "shape":"AccountCustomization", - "documentation":"The Amazon QuickSight customizations that exist in the current Amazon Web Services Region;.
" + "documentation":"The Amazon QuickSight customizations that exist in the current Amazon Web Services Region.
" }, "RequestId":{ "shape":"String", @@ -5595,7 +5638,7 @@ "members":{ "AccountSettings":{ "shape":"AccountSettings", - "documentation":"The Amazon QuickSight settings for this Amazon Web Services account. This information includes the edition of Amazon Amazon QuickSight that you subscribed to (Standard or Enterprise) and the notification email for the Amazon QuickSight subscription. In the Amazon QuickSight console, the Amazon QuickSight subscription is sometimes referred to as a Amazon QuickSight \"account\" even though it's technically not an account by itself. Instead, it's a subscription to the Amazon QuickSight service for your Amazon Web Services account. The edition that you subscribe to applies to Amazon QuickSight in every Amazon Web Services Region; where you use it.
" + "documentation":"The Amazon QuickSight settings for this Amazon Web Services account. This information includes the edition of Amazon Amazon QuickSight that you subscribed to (Standard or Enterprise) and the notification email for the Amazon QuickSight subscription. In the Amazon QuickSight console, the Amazon QuickSight subscription is sometimes referred to as a Amazon QuickSight \"account\" even though it's technically not an account by itself. Instead, it's a subscription to the Amazon QuickSight service for your Amazon Web Services account. The edition that you subscribe to applies to Amazon QuickSight in every Amazon Web Services Region where you use it.
" }, "RequestId":{ "shape":"String", @@ -5807,7 +5850,7 @@ }, "DataSetId":{ "shape":"ResourceId", - "documentation":"The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.
", + "documentation":"The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
", "location":"uri", "locationName":"DataSetId" } @@ -5822,7 +5865,7 @@ }, "DataSetId":{ "shape":"ResourceId", - "documentation":"The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.
" + "documentation":"The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
" }, "Permissions":{ "shape":"ResourcePermissionList", @@ -5854,7 +5897,7 @@ }, "DataSetId":{ "shape":"ResourceId", - "documentation":"The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.
", + "documentation":"The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
", "location":"uri", "locationName":"DataSetId" } @@ -5893,7 +5936,7 @@ }, "DataSourceId":{ "shape":"ResourceId", - "documentation":"The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.
", + "documentation":"The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
", "location":"uri", "locationName":"DataSourceId" } @@ -5908,7 +5951,7 @@ }, "DataSourceId":{ "shape":"ResourceId", - "documentation":"The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.
" + "documentation":"The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
" }, "Permissions":{ "shape":"ResourcePermissionList", @@ -5940,7 +5983,7 @@ }, "DataSourceId":{ "shape":"ResourceId", - "documentation":"The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.
", + "documentation":"The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
", "location":"uri", "locationName":"DataSourceId" } @@ -6204,7 +6247,7 @@ "locationName":"AwsAccountId" }, "DataSetId":{ - "shape":"string", + "shape":"String", "documentation":"The ID of the dataset used in the ingestion.
", "location":"uri", "locationName":"DataSetId" @@ -6225,7 +6268,7 @@ "documentation":"Information about the ingestion.
" }, "RequestId":{ - "shape":"string", + "shape":"String", "documentation":"The Amazon Web Services request ID for this operation.
" }, "Status":{ @@ -6235,6 +6278,44 @@ } } }, + "DescribeIpRestrictionRequest":{ + "type":"structure", + "required":["AwsAccountId"], + "members":{ + "AwsAccountId":{ + "shape":"AwsAccountId", + "documentation":"Your AWS account ID.
", + "location":"uri", + "locationName":"AwsAccountId" + } + } + }, + "DescribeIpRestrictionResponse":{ + "type":"structure", + "members":{ + "AwsAccountId":{ + "shape":"AwsAccountId", + "documentation":"Your AWS account ID.
" + }, + "IpRestrictionRuleMap":{ + "shape":"IpRestrictionRuleMap", + "documentation":"Describes the IP rules with CIDR range and description.
" + }, + "Enabled":{ + "shape":"NullableBoolean", + "documentation":"Whether or not IP rules are enabled.
" + }, + "RequestId":{ + "shape":"String", + "documentation":"The ID of the describe request.
" + }, + "Status":{ + "shape":"StatusCode", + "documentation":"The status of a set of IP restrictions. A successful request returns a 200 status code.
", + "location":"statusCode" + } + } + }, "DescribeNamespaceRequest":{ "type":"structure", "required":[ @@ -6261,7 +6342,7 @@ "members":{ "Namespace":{ "shape":"NamespaceInfoV2", - "documentation":"The information about the namespace that you're describing. The response includes the namespace ARN, name, Amazon Web Services Region;, creation status, and identity store. DescribeNamespace also works for namespaces that are in the process of being created. For incomplete namespaces, this API operation lists the namespace error types and messages associated with the creation process.
The information about the namespace that you're describing. The response includes the namespace ARN, name, Amazon Web Services Region, creation status, and identity store. DescribeNamespace also works for namespaces that are in the process of being created. For incomplete namespaces, this API operation lists the namespace error types and messages associated with the creation process.
Error type.
" }, "Message":{ - "shape":"string", + "shape":"String", "documentation":"Error message.
" } }, @@ -7371,16 +7452,16 @@ "RowInfo":{"shape":"RowInfo"}, "QueueInfo":{"shape":"QueueInfo"}, "CreatedTime":{ - "shape":"timestamp", + "shape":"Timestamp", "documentation":"The time that this ingestion started.
" }, "IngestionTimeInSeconds":{ - "shape":"long", + "shape":"Long", "documentation":"The time that this ingestion took, measured in seconds.
", "box":true }, "IngestionSizeInBytes":{ - "shape":"long", + "shape":"Long", "documentation":"The size of the data ingested, in bytes.
", "box":true }, @@ -7437,7 +7518,11 @@ "DATA_SOURCE_AUTH_FAILED", "DATA_SOURCE_CONNECTION_FAILED", "FAILURE_TO_PROCESS_JSON_FILE", - "INTERNAL_SERVICE_ERROR" + "INTERNAL_SERVICE_ERROR", + "REFRESH_SUPPRESSED_BY_EDIT", + "PERMISSION_NOT_FOUND", + "ELASTICSEARCH_CURSOR_NOT_ENABLED", + "CURSOR_NOT_ENABLED" ] }, "IngestionId":{ @@ -7460,6 +7545,7 @@ }, "IngestionRequestType":{ "type":"string", + "documentation":"This defines the type of ingestion request. This is returned as part of create ingestion response.", "enum":[ "INITIAL_INGESTION", "EDIT", @@ -7478,6 +7564,14 @@ "CANCELLED" ] }, + "IngestionType":{ + "type":"string", + "documentation":"This defines the type of ingestion user wants to trigger. This is part of create ingestion request.", + "enum":[ + "INCREMENTAL_REFRESH", + "FULL_REFRESH" + ] + }, "Ingestions":{ "type":"list", "member":{"shape":"Ingestion"} @@ -7586,6 +7680,16 @@ "error":{"httpStatusCode":400}, "exception":true }, + "IpRestrictionRuleDescription":{ + "type":"string", + "max":150, + "min":0 + }, + "IpRestrictionRuleMap":{ + "type":"map", + "key":{"shape":"CIDR"}, + "value":{"shape":"IpRestrictionRuleDescription"} + }, "JiraParameters":{ "type":"structure", "required":["SiteBaseUrl"], @@ -8267,13 +8371,13 @@ ], "members":{ "DataSetId":{ - "shape":"string", + "shape":"String", "documentation":"The ID of the dataset used in the ingestion.
", "location":"uri", "locationName":"DataSetId" }, "NextToken":{ - "shape":"string", + "shape":"String", "documentation":"The token for the next set of results, or null if there are no more results.
", "location":"querystring", "locationName":"next-token" @@ -8301,11 +8405,11 @@ "documentation":"A list of the ingestions.
" }, "NextToken":{ - "shape":"string", + "shape":"String", "documentation":"The token for the next set of results, or null if there are no more results.
" }, "RequestId":{ - "shape":"string", + "shape":"String", "documentation":"The Amazon Web Services request ID for this operation.
" }, "Status":{ @@ -8345,7 +8449,7 @@ "members":{ "Namespaces":{ "shape":"Namespaces", - "documentation":"The information about the namespaces in this Amazon Web Services account. The response includes the namespace ARN, name, Amazon Web Services Region;, notification email address, creation status, and identity store.
" + "documentation":"The information about the namespaces in this Amazon Web Services account. The response includes the namespace ARN, name, Amazon Web Services Region, notification email address, creation status, and identity store.
" }, "NextToken":{ "shape":"String", @@ -9039,7 +9143,7 @@ }, "CapacityRegion":{ "shape":"String", - "documentation":"The namespace Amazon Web Services Region;.
" + "documentation":"The namespace Amazon Web Services Region.
" }, "CreationStatus":{ "shape":"NamespaceStatus", @@ -9074,6 +9178,7 @@ "type":"string", "pattern":".*\\S.*" }, + "NullableBoolean":{"type":"boolean"}, "OnClause":{ "type":"string", "max":512, @@ -9302,11 +9407,11 @@ ], "members":{ "WaitingOnIngestion":{ - "shape":"string", + "shape":"String", "documentation":"The ID of the queued ingestion.
" }, "QueuedIngestion":{ - "shape":"string", + "shape":"String", "documentation":"The ID of the ongoing ingestion. The queued ingestion is waiting for the ongoing ingestion to complete.
" } }, @@ -9712,14 +9817,19 @@ "type":"structure", "members":{ "RowsIngested":{ - "shape":"long", + "shape":"Long", "documentation":"The number of rows that were ingested.
", "box":true }, "RowsDropped":{ - "shape":"long", + "shape":"Long", "documentation":"The number of rows that were not ingested.
", "box":true + }, + "TotalRowsInDataset":{ + "shape":"Long", + "documentation":"The total number of rows in the dataset.
", + "box":true } }, "documentation":"Information about rows for a data set SPICE ingestion.
" @@ -10347,7 +10457,7 @@ }, "TemplateId":{ "shape":"RestrictiveResourceId", - "documentation":"The ID for the template. This is unique per Amazon Web Services Region; for each Amazon Web Services account.
" + "documentation":"The ID for the template. This is unique per Amazon Web Services Region for each Amazon Web Services account.
" }, "LastUpdatedTime":{ "shape":"Timestamp", @@ -10468,7 +10578,7 @@ }, "TemplateId":{ "shape":"RestrictiveResourceId", - "documentation":"The ID of the template. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.
" + "documentation":"The ID of the template. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
" }, "Name":{ "shape":"TemplateName", @@ -10710,7 +10820,7 @@ }, "ThemeId":{ "shape":"RestrictiveResourceId", - "documentation":"The ID of the theme. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.
" + "documentation":"The ID of the theme. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
" }, "LatestVersionNumber":{ "shape":"VersionNumber", @@ -11080,7 +11190,7 @@ }, "AccountCustomization":{ "shape":"AccountCustomization", - "documentation":"The Amazon QuickSight customizations you're updating in the current Amazon Web Services Region;.
" + "documentation":"The Amazon QuickSight customizations you're updating in the current Amazon Web Services Region.
" } } }, @@ -11101,7 +11211,7 @@ }, "AccountCustomization":{ "shape":"AccountCustomization", - "documentation":"The Amazon QuickSight customizations you're updating in the current Amazon Web Services Region;.
" + "documentation":"The Amazon QuickSight customizations you're updating in the current Amazon Web Services Region.
" }, "RequestId":{ "shape":"String", @@ -11403,7 +11513,7 @@ }, "SourceEntity":{ "shape":"DashboardSourceEntity", - "documentation":"The entity that you are using as a source when you update the dashboard. In SourceEntity, you specify the type of object you're using as source. You can only update a dashboard from a template, so you use a SourceTemplate entity. If you need to update a dashboard from an analysis, first convert the analysis to a template by using the CreateTemplate API operation. For SourceTemplate, specify the Amazon Resource Name (ARN) of the source template. The SourceTemplate ARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region;.
Use the DataSetReferences entity within SourceTemplate to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.
The entity that you are using as a source when you update the dashboard. In SourceEntity, you specify the type of object you're using as source. You can only update a dashboard from a template, so you use a SourceTemplate entity. If you need to update a dashboard from an analysis, first convert the analysis to a template by using the CreateTemplate API operation. For SourceTemplate, specify the Amazon Resource Name (ARN) of the source template. The SourceTemplate ARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region.
Use the DataSetReferences entity within SourceTemplate to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.
The ID for the dataset whose permissions you want to update. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.
", + "documentation":"The ID for the dataset whose permissions you want to update. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
", "location":"uri", "locationName":"DataSetId" }, @@ -11490,7 +11600,7 @@ }, "DataSetId":{ "shape":"ResourceId", - "documentation":"The ID for the dataset whose permissions you want to update. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.
" + "documentation":"The ID for the dataset whose permissions you want to update. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
" }, "RequestId":{ "shape":"String", @@ -11521,7 +11631,7 @@ }, "DataSetId":{ "shape":"ResourceId", - "documentation":"The ID for the dataset that you want to update. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.
", + "documentation":"The ID for the dataset that you want to update. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
", "location":"uri", "locationName":"DataSetId" }, @@ -11573,7 +11683,7 @@ }, "DataSetId":{ "shape":"ResourceId", - "documentation":"The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.
" + "documentation":"The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
" }, "IngestionArn":{ "shape":"Arn", @@ -11609,7 +11719,7 @@ }, "DataSourceId":{ "shape":"ResourceId", - "documentation":"The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.
", + "documentation":"The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
", "location":"uri", "locationName":"DataSourceId" }, @@ -11632,7 +11742,7 @@ }, "DataSourceId":{ "shape":"ResourceId", - "documentation":"The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.
" + "documentation":"The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
" }, "RequestId":{ "shape":"String", @@ -11661,7 +11771,7 @@ }, "DataSourceId":{ "shape":"ResourceId", - "documentation":"The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.
", + "documentation":"The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
", "location":"uri", "locationName":"DataSourceId" }, @@ -11696,7 +11806,7 @@ }, "DataSourceId":{ "shape":"ResourceId", - "documentation":"The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.
" + "documentation":"The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
" }, "UpdateStatus":{ "shape":"ResourceStatus", @@ -11939,6 +12049,44 @@ } } }, + "UpdateIpRestrictionRequest":{ + "type":"structure", + "required":["AwsAccountId"], + "members":{ + "AwsAccountId":{ + "shape":"AwsAccountId", + "documentation":"Your AWS account ID.
", + "location":"uri", + "locationName":"AwsAccountId" + }, + "IpRestrictionRuleMap":{ + "shape":"IpRestrictionRuleMap", + "documentation":"Describes updated IP rules.
" + }, + "Enabled":{ + "shape":"NullableBoolean", + "documentation":"Whether or not IP rules are enabled.
" + } + } + }, + "UpdateIpRestrictionResponse":{ + "type":"structure", + "members":{ + "AwsAccountId":{ + "shape":"AwsAccountId", + "documentation":"Your AWS account ID.
" + }, + "RequestId":{ + "shape":"String", + "documentation":"The ID of the update request.
" + }, + "Status":{ + "shape":"StatusCode", + "documentation":"The status of the updated IP rules. A successful request returns a 200 code.
", + "location":"statusCode" + } + } + }, "UpdateResourcePermissionList":{ "type":"list", "member":{"shape":"ResourcePermission"}, @@ -12495,10 +12643,7 @@ "max":128, "min":1 }, - "boolean":{"type":"boolean"}, - "long":{"type":"long"}, - "string":{"type":"string"}, - "timestamp":{"type":"timestamp"} + "boolean":{"type":"boolean"} }, "documentation":"Amazon QuickSight is a fully managed, serverless business intelligence service for the Amazon Web Services Cloud that makes it easy to extend data and insights to every user in your organization. This API reference contains documentation for a programming interface that you can use to manage Amazon QuickSight.
" } diff --git a/docs/source/conf.py b/docs/source/conf.py index 9b405f1946..bfd2ca97a8 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -54,7 +54,7 @@ # The short X.Y version. version = '1.21.' # The full version, including alpha/beta/rc tags. -release = '1.21.63' +release = '1.21.64' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/setup.cfg b/setup.cfg index fc9b6398b2..a1e7f45dba 100644 --- a/setup.cfg +++ b/setup.cfg @@ -8,7 +8,7 @@ requires_dist = urllib3>=1.25.4,<1.27 [options.extras_require] -crt = awscrt==0.11.24 +crt = awscrt==0.12.5 [flake8] ignore = E203,E226,E501,E731,W503,W504