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> Performs GetChannel on multiple ARNs simultaneously.
", "BatchGetStreamKey": "Performs GetStreamKey on multiple ARNs simultaneously.
", "CreateChannel": "Creates a new channel and an associated stream key to start streaming.
", - "CreateRecordingConfiguration": "Creates a new recording configuration, used to enable recording to Amazon S3.
Known issue: In the us-east-1 region, if you use the 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.
", + "CreateRecordingConfiguration": "Creates a new recording configuration, used to enable recording to Amazon S3.
Known issue: In the us-east-1 region, if you use the Amazon Web Services CLI to create a recording configuration, it returns success even if the S3 bucket is in a different region. In this case, the state of the recording configuration is CREATE_FAILED (instead of ACTIVE). (In other regions, the CLI correctly returns failure if the bucket is in a different region.)
Workaround: Ensure that your S3 bucket is in the same region as the recording configuration. If you create a recording configuration in a different region as your S3 bucket, delete that recording configuration and create a new one with an S3 bucket from the correct region.
", "CreateStreamKey": "Creates a stream key, used to initiate a stream, for the specified channel ARN.
Note that CreateChannel creates a stream key. If you subsequently use CreateStreamKey on the same channel, it will fail because a stream key already exists and there is a limit of 1 stream key per channel. To reset the stream key on a channel, use DeleteStreamKey and then CreateStreamKey.
", "DeleteChannel": "Deletes the specified channel and its associated stream keys.
If you try to delete a live channel, you will get an error (409 ConflictException). To delete a channel that is live, call StopStream, wait for the Amazon EventBridge \"Stream End\" event (to verify that the stream's state was changed from Live to Offline), then call DeleteChannel. (See Using EventBridge with Amazon IVS.)
", "DeletePlaybackKeyPair": "Deletes a specified authorization key pair. This invalidates future viewer tokens generated using the key pair’s privateKey. For more information, see Setting Up Private Channels in the Amazon IVS User Guide.
Gets information about the active (live) stream on a specified channel.
", "GetStreamKey": "Gets stream-key information for a specified ARN.
", "ImportPlaybackKeyPair": "Imports the public portion of a new key pair and returns its arn and fingerprint. The privateKey can then be used to generate viewer authorization tokens, to grant viewers access to private channels. For more information, see Setting Up Private Channels in the Amazon IVS User Guide.
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).
", + "ListChannels": "Gets summary information about all channels in your account, in the Amazon Web Services region where the API request is processed. This list can be filtered to match a specified name or recording-configuration ARN. Filters are mutually exclusive and cannot be used together. If you try to use both filters, you will get an error (409 ConflictException).
", "ListPlaybackKeyPairs": "Gets summary information about playback key pairs. For more information, see Setting Up Private Channels in the Amazon IVS User Guide.
", - "ListRecordingConfigurations": "Gets summary information about all recording configurations in your account, in the AWS region where the API request is processed.
", + "ListRecordingConfigurations": "Gets summary information about all recording configurations in your account, in the Amazon Web Services region where the API request is processed.
", "ListStreamKeys": "Gets summary information about stream keys for the specified channel.
", - "ListStreams": "Gets summary information about live streams in your account, in the AWS region where the API request is processed.
", - "ListTagsForResource": "Gets information about AWS tags for the specified ARN.
", - "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.) Also see Embedding Metadata within a Video Stream in the Amazon IVS User Guide.
", + "ListStreams": "Gets summary information about live streams in your account, in the Amazon Web Services region where the API request is processed.
", + "ListTagsForResource": "Gets information about Amazon Web Services tags for the specified ARN.
", + "PutMetadata": "Inserts metadata into the active stream of the specified channel. At most 5 requests per second per channel are allowed, each with a maximum 1 KB payload. (If 5 TPS is not sufficient for your needs, we recommend batching your data into a single PutMetadata call.) At most 155 requests per second per account are allowed. Also see Embedding Metadata within a Video Stream in the Amazon IVS User Guide.
", "StopStream": "Disconnects the incoming RTMPS stream for the specified channel. Can be used in conjunction with DeleteStreamKey to prevent further streaming to a channel.
Many streaming client-software libraries automatically reconnect a dropped RTMPS session, so to stop the stream permanently, you may want to first revoke the streamKey attached to the channel.
Adds or updates tags for the AWS resource with the specified ARN.
", + "TagResource": "Adds or updates tags for the Amazon Web Services resource with the specified ARN.
", "UntagResource": "Removes tags from the resource with the specified ARN.
", "UpdateChannel": "Updates a channel's configuration. This does not affect an ongoing stream of this channel. You must stop and restart the stream for the changes to take effect.
" }, "shapes": { "AccessDeniedException": { - "base": null, + "base": "", "refs": { } }, @@ -45,7 +45,7 @@ "base": null, "refs": { "BatchGetChannelResponse$errors": "Each error object is related to a specific ARN in the request.
", - "BatchGetStreamKeyResponse$errors": null + "BatchGetStreamKeyResponse$errors": "" } }, "BatchGetChannelRequest": { @@ -79,8 +79,8 @@ "base": "Object specifying a channel.
", "refs": { "Channels$member": null, - "CreateChannelResponse$channel": null, - "GetChannelResponse$channel": null, + "CreateChannelResponse$channel": "", + "GetChannelResponse$channel": "", "UpdateChannelResponse$channel": null } }, @@ -136,7 +136,7 @@ } }, "ChannelNotBroadcasting": { - "base": null, + "base": "", "refs": { } }, @@ -159,19 +159,19 @@ "ChannelType": { "base": null, "refs": { - "Channel$type": "Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. Valid values:
STANDARD: 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.
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.
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.
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.
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.
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.
Maximum number of streams to return. Default: 50.
" } }, - "MaxTagResults": { - "base": null, - "refs": { - "ListTagsForResourceRequest$maxResults": "Maximum number of tags to return. Default: 50.
" - } - }, "PaginationToken": { "base": null, "refs": { @@ -428,15 +422,15 @@ } }, "PendingVerification": { - "base": null, + "base": "", "refs": { } }, "PlaybackKeyPair": { "base": "A key pair used to sign and validate a playback authorization token.
", "refs": { - "GetPlaybackKeyPairResponse$keyPair": null, - "ImportPlaybackKeyPairResponse$keyPair": null + "GetPlaybackKeyPairResponse$keyPair": "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.
", - "PlaybackKeyPair$name": "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.
", - "PlaybackKeyPairSummary$name": "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.
" + "ImportPlaybackKeyPairRequest$name": "Playback-key-pair name. The value does not need to be unique.
", + "PlaybackKeyPair$name": "Playback-key-pair name. The value does not need to be unique.
", + "PlaybackKeyPairSummary$name": "Playback-key-pair name. The value does not need to be unique.
" } }, "PlaybackKeyPairSummary": { @@ -495,8 +489,8 @@ "RecordingConfiguration": { "base": "An object representing a configuration to record a channel stream.
", "refs": { - "CreateRecordingConfigurationResponse$recordingConfiguration": null, - "GetRecordingConfigurationResponse$recordingConfiguration": null + "CreateRecordingConfigurationResponse$recordingConfiguration": "An arbitrary string (a nickname) that helps the customer identify that resource. The value does not need to be unique.
", - "RecordingConfiguration$name": "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.
", - "RecordingConfigurationSummary$name": "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.
" + "CreateRecordingConfigurationRequest$name": "Recording-configuration name. The value does not need to be unique.
", + "RecordingConfiguration$name": "Recording-configuration name. The value does not need to be unique.
", + "RecordingConfigurationSummary$name": "Recording-configuration name. The value does not need to be unique.
" } }, "RecordingConfigurationState": { @@ -545,7 +539,7 @@ } }, "ResourceNotFoundException": { - "base": null, + "base": "", "refs": { } }, @@ -562,7 +556,7 @@ } }, "ServiceQuotaExceededException": { - "base": null, + "base": "", "refs": { } }, @@ -579,7 +573,7 @@ "Stream": { "base": "Specifies a live video stream that has been ingested and distributed.
", "refs": { - "GetStreamResponse$stream": null + "GetStreamResponse$stream": "" } }, "StreamHealth": { @@ -592,9 +586,9 @@ "StreamKey": { "base": "Object specifying a stream key.
", "refs": { - "CreateChannelResponse$streamKey": null, + "CreateChannelResponse$streamKey": "", "CreateStreamKeyResponse$streamKey": "Stream key used to authenticate an RTMPS stream for ingestion.
", - "GetStreamKeyResponse$streamKey": null, + "GetStreamKeyResponse$streamKey": "ISO-8601 formatted timestamp of the stream’s start.
", - "StreamSummary$startTime": "ISO-8601 formatted timestamp of the stream’s start.
" + "Stream$startTime": "Time of the stream’s start. This is an ISO 8601 timestamp returned as a string.
", + "StreamSummary$startTime": "Time of the stream’s start. This is an ISO 8601 timestamp returned as a string.
" } }, "StreamState": { @@ -671,22 +665,15 @@ } }, "StreamUnavailable": { - "base": null, + "base": "", "refs": { } }, "StreamViewerCount": { "base": null, "refs": { - "Stream$viewerCount": "Number of current viewers of the stream. A value of -1 indicates that the request timed out; in this case, retry.
", - "StreamSummary$viewerCount": "Number of current viewers of the stream. A value of -1 indicates that the request timed out; in this case, retry.
" - } - }, - "String": { - "base": null, - "refs": { - "ListTagsForResourceRequest$nextToken": "The first tag to retrieve. This is used for pagination; see the nextToken response field.
If there are more tags than maxResults, use nextToken in the request to get the next set.
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.
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.
Array of 1-50 maps, each of the form string:string (key:value).
Array of 1-50 maps, each of the form string:string (key:value).
Any tags provided with the request are added to the playback key pair tags.
", - "ListTagsForResourceResponse$tags": null, + "ListTagsForResourceResponse$tags": "", "PlaybackKeyPair$tags": "Array of 1-50 maps, each of the form string:string (key:value).
Array of 1-50 maps, each of the form string:string (key:value).
Array of 1-50 maps, each of the form string:string (key:value).
Request would cause a service quota to be exceeded.
", "StreamUnavailable$exceptionMessage": "The stream is temporarily unavailable.
", "ThrottlingException$exceptionMessage": "Request was denied due to request throttling.
", - "ValidationException$exceptionMessage": "The input fails to satisfy the constraints specified by an AWS service.
" + "ValidationException$exceptionMessage": "The input fails to satisfy the constraints specified by an Amazon Web Services service.
" } } } diff --git a/models/apis/ivs/2020-07-14/paginators-1.json b/models/apis/ivs/2020-07-14/paginators-1.json index fda89743f27..9a14986bb87 100644 --- a/models/apis/ivs/2020-07-14/paginators-1.json +++ b/models/apis/ivs/2020-07-14/paginators-1.json @@ -3,34 +3,24 @@ "ListChannels": { "input_token": "nextToken", "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "channels" + "limit_key": "maxResults" }, "ListPlaybackKeyPairs": { "input_token": "nextToken", "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "keyPairs" + "limit_key": "maxResults" }, "ListRecordingConfigurations": { "input_token": "nextToken", "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "recordingConfigurations" + "limit_key": "maxResults" }, "ListStreamKeys": { "input_token": "nextToken", "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "streamKeys" + "limit_key": "maxResults" }, "ListStreams": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "streams" - }, - "ListTagsForResource": { "input_token": "nextToken", "output_token": "nextToken", "limit_key": "maxResults" diff --git a/models/apis/quicksight/2018-04-01/api-2.json b/models/apis/quicksight/2018-04-01/api-2.json index 2e59921a57c..839fc47a015 100644 --- a/models/apis/quicksight/2018-04-01/api-2.json +++ b/models/apis/quicksight/2018-04-01/api-2.json @@ -895,6 +895,22 @@ {"shape":"InternalFailureException"} ] }, + "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"} + ] + }, "DescribeNamespace":{ "name":"DescribeNamespace", "http":{ @@ -1883,6 +1899,23 @@ {"shape":"InternalFailureException"} ] }, + "UpdateIpRestriction":{ + "name":"UpdateIpRestriction", + "http":{ + "method":"POST", + "requestUri":"/accounts/{AwsAccountId}/ip-restriction" + }, + "input":{"shape":"UpdateIpRestrictionRequest"}, + "output":{"shape":"UpdateIpRestrictionResponse"}, + "errors":[ + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"ThrottlingException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalFailureException"} + ] + }, "UpdateTemplate":{ "name":"UpdateTemplate", "http":{ @@ -2266,6 +2299,10 @@ } } }, + "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":[ @@ -2299,7 +2336,7 @@ "locationName":"AwsAccountId" }, "DataSetId":{ - "shape":"string", + "shape":"String", "location":"uri", "locationName":"DataSetId" }, @@ -2315,7 +2352,7 @@ "members":{ "Arn":{"shape":"Arn"}, "IngestionId":{"shape":"IngestionId"}, - "RequestId":{"shape":"string"}, + "RequestId":{"shape":"String"}, "Status":{ "shape":"StatusCode", "location":"statusCode" @@ -2906,7 +2943,7 @@ ], "members":{ "DataSetId":{ - "shape":"string", + "shape":"String", "location":"uri", "locationName":"DataSetId" }, @@ -2919,7 +2956,8 @@ "shape":"AwsAccountId", "location":"uri", "locationName":"AwsAccountId" - } + }, + "IngestionType":{"shape":"IngestionType"} } }, "CreateIngestionResponse":{ @@ -2928,7 +2966,7 @@ "Arn":{"shape":"Arn"}, "IngestionId":{"shape":"IngestionId"}, "IngestionStatus":{"shape":"IngestionStatus"}, - "RequestId":{"shape":"string"}, + "RequestId":{"shape":"String"}, "Status":{ "shape":"StatusCode", "location":"statusCode" @@ -4653,7 +4691,7 @@ "locationName":"AwsAccountId" }, "DataSetId":{ - "shape":"string", + "shape":"String", "location":"uri", "locationName":"DataSetId" }, @@ -4668,7 +4706,31 @@ "type":"structure", "members":{ "Ingestion":{"shape":"Ingestion"}, - "RequestId":{"shape":"string"}, + "RequestId":{"shape":"String"}, + "Status":{ + "shape":"StatusCode", + "location":"statusCode" + } + } + }, + "DescribeIpRestrictionRequest":{ + "type":"structure", + "required":["AwsAccountId"], + "members":{ + "AwsAccountId":{ + "shape":"AwsAccountId", + "location":"uri", + "locationName":"AwsAccountId" + } + } + }, + "DescribeIpRestrictionResponse":{ + "type":"structure", + "members":{ + "AwsAccountId":{"shape":"AwsAccountId"}, + "IpRestrictionRuleMap":{"shape":"IpRestrictionRuleMap"}, + "Enabled":{"shape":"NullableBoolean"}, + "RequestId":{"shape":"String"}, "Status":{ "shape":"StatusCode", "location":"statusCode" @@ -5009,7 +5071,7 @@ "type":"structure", "members":{ "Type":{"shape":"IngestionErrorType"}, - "Message":{"shape":"string"} + "Message":{"shape":"String"} } }, "ExceptionResourceType":{ @@ -5492,13 +5554,13 @@ "ErrorInfo":{"shape":"ErrorInfo"}, "RowInfo":{"shape":"RowInfo"}, "QueueInfo":{"shape":"QueueInfo"}, - "CreatedTime":{"shape":"timestamp"}, + "CreatedTime":{"shape":"Timestamp"}, "IngestionTimeInSeconds":{ - "shape":"long", + "shape":"Long", "box":true }, "IngestionSizeInBytes":{ - "shape":"long", + "shape":"Long", "box":true }, "RequestSource":{"shape":"IngestionRequestSource"}, @@ -5547,7 +5609,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":{ @@ -5588,6 +5654,13 @@ "CANCELLED" ] }, + "IngestionType":{ + "type":"string", + "enum":[ + "INCREMENTAL_REFRESH", + "FULL_REFRESH" + ] + }, "Ingestions":{ "type":"list", "member":{"shape":"Ingestion"} @@ -5670,6 +5743,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"], @@ -6165,12 +6248,12 @@ ], "members":{ "DataSetId":{ - "shape":"string", + "shape":"String", "location":"uri", "locationName":"DataSetId" }, "NextToken":{ - "shape":"string", + "shape":"String", "location":"querystring", "locationName":"next-token" }, @@ -6191,8 +6274,8 @@ "type":"structure", "members":{ "Ingestions":{"shape":"Ingestions"}, - "NextToken":{"shape":"string"}, - "RequestId":{"shape":"string"}, + "NextToken":{"shape":"String"}, + "RequestId":{"shape":"String"}, "Status":{ "shape":"StatusCode", "location":"statusCode" @@ -6743,6 +6826,7 @@ "type":"string", "pattern":".*\\S.*" }, + "NullableBoolean":{"type":"boolean"}, "OnClause":{ "type":"string", "max":512, @@ -6899,8 +6983,8 @@ "QueuedIngestion" ], "members":{ - "WaitingOnIngestion":{"shape":"string"}, - "QueuedIngestion":{"shape":"string"} + "WaitingOnIngestion":{"shape":"String"}, + "QueuedIngestion":{"shape":"String"} } }, "QuickSightUserNotFoundException":{ @@ -7159,11 +7243,15 @@ "type":"structure", "members":{ "RowsIngested":{ - "shape":"long", + "shape":"Long", "box":true }, "RowsDropped":{ - "shape":"long", + "shape":"Long", + "box":true + }, + "TotalRowsInDataset":{ + "shape":"Long", "box":true } } @@ -8497,6 +8585,30 @@ } } }, + "UpdateIpRestrictionRequest":{ + "type":"structure", + "required":["AwsAccountId"], + "members":{ + "AwsAccountId":{ + "shape":"AwsAccountId", + "location":"uri", + "locationName":"AwsAccountId" + }, + "IpRestrictionRuleMap":{"shape":"IpRestrictionRuleMap"}, + "Enabled":{"shape":"NullableBoolean"} + } + }, + "UpdateIpRestrictionResponse":{ + "type":"structure", + "members":{ + "AwsAccountId":{"shape":"AwsAccountId"}, + "RequestId":{"shape":"String"}, + "Status":{ + "shape":"StatusCode", + "location":"statusCode" + } + } + }, "UpdateResourcePermissionList":{ "type":"list", "member":{"shape":"ResourcePermission"}, @@ -8847,9 +8959,6 @@ "max":128, "min":1 }, - "boolean":{"type":"boolean"}, - "long":{"type":"long"}, - "string":{"type":"string"}, - "timestamp":{"type":"timestamp"} + "boolean":{"type":"boolean"} } } diff --git a/models/apis/quicksight/2018-04-01/docs-2.json b/models/apis/quicksight/2018-04-01/docs-2.json index 73ee32972d7..e7e92a24934 100644 --- a/models/apis/quicksight/2018-04-01/docs-2.json +++ b/models/apis/quicksight/2018-04-01/docs-2.json @@ -3,7 +3,7 @@ "service": "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.
", "operations": { "CancelIngestion": "Cancels an ongoing ingestion of data into SPICE.
", - "CreateAccountCustomization": "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.
Creates an analysis in Amazon QuickSight.
", "CreateDashboard": "Creates a dashboard from a template. To first create a template, see the CreateTemplate API operation.
A dashboard is an entity in Amazon QuickSight that identifies Amazon QuickSight reports, created from analyses. You can share Amazon QuickSight dashboards. With the right permissions, you can create scheduled email reports from them. If you have the correct permissions, you can create a dashboard from a template that exists in a different Amazon Web Services account.
", "CreateDataSet": "Creates a dataset.
", @@ -19,7 +19,7 @@ "CreateTemplateAlias": "Creates a template alias for a template.
", "CreateTheme": "Creates a theme.
A theme is set of configuration options for color and layout. Themes apply to analyses and dashboards. For more information, see Using Themes in Amazon QuickSight in the Amazon QuickSight User Guide.
", "CreateThemeAlias": "Creates a theme alias for a theme.
", - "DeleteAccountCustomization": "Deletes all Amazon QuickSight customizations in this Amazon Web Services Region; for the specified Amazon Web Services account and Amazon QuickSight namespace.
", + "DeleteAccountCustomization": "Deletes all Amazon QuickSight customizations in this Amazon Web Services Region for the specified Amazon Web Services account and Amazon QuickSight namespace.
", "DeleteAnalysis": "Deletes an analysis from Amazon QuickSight. You can optionally include a recovery window during which you can restore the analysis. If you don't specify a recovery window value, the operation defaults to 30 days. Amazon QuickSight attaches a DeletionTime stamp to the response that specifies the end of the recovery window. At the end of the recovery window, Amazon QuickSight deletes the analysis permanently.
At any time before recovery window ends, you can use the RestoreAnalysis API operation to remove the DeletionTime stamp and cancel the deletion of the analysis. The analysis remains visible in the API until it's deleted, so you can describe it but you can't make a template from it.
An analysis that's scheduled for deletion isn't accessible in the Amazon QuickSight console. To access it in the console, restore it. Deleting an analysis doesn't delete the dashboards that you publish from it.
", "DeleteDashboard": "Deletes a dashboard.
", "DeleteDataSet": "Deletes a dataset.
", @@ -36,7 +36,7 @@ "DeleteThemeAlias": "Deletes the version of the theme that the specified theme alias points to. If you provide a specific alias, you delete the version of the theme that the alias points to.
", "DeleteUser": "Deletes the Amazon QuickSight user that is associated with the identity of the Identity and Access Management (IAM) user or role that's making the call. The IAM user isn't deleted as a result of this call.
", "DeleteUserByPrincipalId": "Deletes a user identified by its principal ID.
", - "DescribeAccountCustomization": "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 the settings that were used when your Amazon QuickSight subscription was first created in this Amazon Web Services account.
", "DescribeAnalysis": "Provides a summary of the metadata for an analysis.
", "DescribeAnalysisPermissions": "Provides the read and write permissions for an analysis.
", @@ -52,6 +52,7 @@ "DescribeGroup": "Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN).
", "DescribeIAMPolicyAssignment": "Describes an existing IAMpolicy assignment, as specified by the assignment name.
", "DescribeIngestion": "Describes a SPICE ingestion.
", + "DescribeIpRestriction": "Provides a summary and status of IP Rules.
", "DescribeNamespace": "Describes the current namespace.
", "DescribeTemplate": "Describes a template's metadata.
", "DescribeTemplateAlias": "Describes the template alias for a template.
", @@ -67,8 +68,8 @@ "ListAnalyses": "Lists Amazon QuickSight analyses that exist in the specified Amazon Web Services account.
", "ListDashboardVersions": "Lists all the versions of the dashboards in the Amazon QuickSight subscription.
", "ListDashboards": "Lists dashboards in an Amazon Web Services account.
", - "ListDataSets": "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.
", + "ListDataSets": "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.
", "ListFolderMembers": "List all assets (DASHBOARD, ANALYSIS, and DATASET) in a folder.
Lists all folders in an account.
", "ListGroupMemberships": "Lists member users in a group.
", @@ -93,7 +94,7 @@ "SearchFolders": "Searches the subfolders in a folder.
", "TagResource": "Assigns one or more tags (key-value pairs) to the specified Amazon QuickSight resource.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values. You can use the TagResource operation with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.
You can associate as many as 50 tags with a resource. Amazon QuickSight supports tagging on data set, data source, dashboard, and template.
Tagging for Amazon QuickSight works in a similar way to tagging for other AWS services, except for the following:
You can't use tags to track AWS costs for Amazon QuickSight. This restriction is because Amazon QuickSight costs are based on users and SPICE capacity, which aren't taggable resources.
Amazon QuickSight doesn't currently support the Tag Editor for Resource Groups.
Removes a tag or tags from a resource.
", - "UpdateAccountCustomization": "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 the Amazon QuickSight settings in your Amazon Web Services account.
", "UpdateAnalysis": "Updates an analysis in Amazon QuickSight
", "UpdateAnalysisPermissions": "Updates the read and write permissions for an analysis.
", @@ -108,6 +109,7 @@ "UpdateFolderPermissions": "Updates permissions of a folder.
", "UpdateGroup": "Changes a group description.
", "UpdateIAMPolicyAssignment": "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": "Updates a template from an existing Amazon QuickSight analysis or another template.
", "UpdateTemplateAlias": "Updates the template alias of a template.
", "UpdateTemplatePermissions": "Updates the resource permissions for a template.
", @@ -123,19 +125,19 @@ } }, "AccountCustomization": { - "base": "The Amazon QuickSight customizations associated with your Amazon Web Services account or a Amazon QuickSight namespace in a specific Amazon Web Services Region;.
", + "base": "The Amazon QuickSight customizations associated with your Amazon Web Services account or a Amazon QuickSight namespace in a specific Amazon Web Services Region.
", "refs": { - "CreateAccountCustomizationRequest$AccountCustomization": "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;.
", - "DescribeAccountCustomizationResponse$AccountCustomization": "The Amazon QuickSight customizations that exist in the current Amazon Web Services Region;.
", - "UpdateAccountCustomizationRequest$AccountCustomization": "The Amazon QuickSight customizations you're updating in the current Amazon Web Services Region;.
", - "UpdateAccountCustomizationResponse$AccountCustomization": "The Amazon QuickSight customizations you're updating in the current Amazon Web Services Region;.
" + "CreateAccountCustomizationRequest$AccountCustomization": "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.
", + "DescribeAccountCustomizationResponse$AccountCustomization": "The Amazon QuickSight customizations that exist in the current Amazon Web Services Region.
", + "UpdateAccountCustomizationRequest$AccountCustomization": "The Amazon QuickSight customizations you're updating in the current Amazon Web Services Region.
", + "UpdateAccountCustomizationResponse$AccountCustomization": "The Amazon QuickSight customizations you're updating in the current Amazon Web Services Region.
" } }, "AccountSettings": { "base": "The Amazon QuickSight settings associated with your Amazon Web Services account.
", "refs": { - "DescribeAccountSettingsResponse$AccountSettings": "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.
" + "DescribeAccountSettingsResponse$AccountSettings": "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.
" } }, "ActionList": { @@ -189,9 +191,9 @@ } }, "AmazonElasticsearchParameters": { - "base": "The parameters for Elasticsearch.
", + "base": "The parameters for OpenSearch.
", "refs": { - "DataSourceParameters$AmazonElasticsearchParameters": "The parameters for Elasticsearch.
" + "DataSourceParameters$AmazonElasticsearchParameters": "The parameters for OpenSearch.
" } }, "AmazonOpenSearchParameters": { @@ -469,7 +471,7 @@ "CreateTemplateRequest$AwsAccountId": "The ID for the Amazon Web Services account that the group is in. You use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
", "CreateThemeAliasRequest$AwsAccountId": "The ID of the Amazon Web Services account that contains the theme for the new theme alias.
", "CreateThemeRequest$AwsAccountId": "The ID of the Amazon Web Services account where you want to store the new theme.
", - "DeleteAccountCustomizationRequest$AwsAccountId": "The ID for the Amazon Web Services account that you want to delete Amazon QuickSight customizations from in this Amazon Web Services Region;.
", + "DeleteAccountCustomizationRequest$AwsAccountId": "The ID for the Amazon Web Services account that you want to delete Amazon QuickSight customizations from in this Amazon Web Services Region.
", "DeleteAnalysisRequest$AwsAccountId": "The ID of the Amazon Web Services account where you want to delete an analysis.
", "DeleteDashboardRequest$AwsAccountId": "The ID of the Amazon Web Services account that contains the dashboard that you're deleting.
", "DeleteDataSetRequest$AwsAccountId": "The Amazon Web Services account ID.
", @@ -503,6 +505,8 @@ "DescribeGroupRequest$AwsAccountId": "The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
", "DescribeIAMPolicyAssignmentRequest$AwsAccountId": "The ID of the Amazon Web Services account that contains the assignment that you want to describe.
", "DescribeIngestionRequest$AwsAccountId": "The Amazon Web Services account ID.
", + "DescribeIpRestrictionRequest$AwsAccountId": "Your AWS account ID.
", + "DescribeIpRestrictionResponse$AwsAccountId": "Your AWS account ID.
", "DescribeNamespaceRequest$AwsAccountId": "The ID for the Amazon Web Services account that contains the Amazon QuickSight namespace that you want to describe.
", "DescribeTemplateAliasRequest$AwsAccountId": "The ID of the Amazon Web Services account that contains the template alias that you're describing.
", "DescribeTemplatePermissionsRequest$AwsAccountId": "The ID of the Amazon Web Services account that contains the template that you're describing.
", @@ -557,6 +561,8 @@ "UpdateFolderRequest$AwsAccountId": "The AWS account ID.
", "UpdateGroupRequest$AwsAccountId": "The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
", "UpdateIAMPolicyAssignmentRequest$AwsAccountId": "The ID of the Amazon Web Services account that contains the IAMpolicy assignment.
", + "UpdateIpRestrictionRequest$AwsAccountId": "Your AWS account ID.
", + "UpdateIpRestrictionResponse$AwsAccountId": "Your AWS account ID.
", "UpdateTemplateAliasRequest$AwsAccountId": "The ID of the Amazon Web Services account that contains the template alias that you're updating.
", "UpdateTemplatePermissionsRequest$AwsAccountId": "The ID of the Amazon Web Services account that contains the template.
", "UpdateTemplateRequest$AwsAccountId": "The ID of the Amazon Web Services account that contains the template that you're updating.
", @@ -601,6 +607,12 @@ "TileStyle$Border": "The border around a tile.
" } }, + "CIDR": { + "base": null, + "refs": { + "IpRestrictionRuleMap$key": null + } + }, "CalculatedColumn": { "base": "A calculated column for a dataset.
", "refs": { @@ -1062,8 +1074,8 @@ "DashboardSourceEntity": { "base": "Dashboard source entity.
", "refs": { - "CreateDashboardRequest$SourceEntity": "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 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 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 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 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 type of the data source. This type indicates which database engine the data source connects to.
" } }, @@ -1626,6 +1638,16 @@ "refs": { } }, + "DescribeIpRestrictionRequest": { + "base": null, + "refs": { + } + }, + "DescribeIpRestrictionResponse": { + "base": null, + "refs": { + } + }, "DescribeNamespaceRequest": { "base": null, "refs": { @@ -1709,7 +1731,7 @@ "Domain": { "base": null, "refs": { - "AmazonElasticsearchParameters$Domain": "The Elasticsearch domain.
", + "AmazonElasticsearchParameters$Domain": "The OpenSearch domain.
", "AmazonOpenSearchParameters$Domain": null } }, @@ -2183,7 +2205,7 @@ } }, "IngestionRequestType": { - "base": null, + "base": "This defines the type of ingestion request. This is returned as part of create ingestion response.", "refs": { "Ingestion$RequestType": "Type of this ingestion.
" } @@ -2195,6 +2217,12 @@ "Ingestion$IngestionStatus": "Ingestion status.
" } }, + "IngestionType": { + "base": "This defines the type of ingestion user wants to trigger. This is part of create ingestion request.", + "refs": { + "CreateIngestionRequest$IngestionType": "The type of ingestion that you want to create.
" + } + }, "Ingestions": { "base": null, "refs": { @@ -2254,6 +2282,19 @@ "refs": { } }, + "IpRestrictionRuleDescription": { + "base": null, + "refs": { + "IpRestrictionRuleMap$value": null + } + }, + "IpRestrictionRuleMap": { + "base": null, + "refs": { + "DescribeIpRestrictionResponse$IpRestrictionRuleMap": "Describes the IP rules with CIDR range and description.
", + "UpdateIpRestrictionRequest$IpRestrictionRuleMap": "Describes updated IP rules.
" + } + }, "JiraParameters": { "base": "The parameters for Jira.
", "refs": { @@ -2542,7 +2583,12 @@ "base": null, "refs": { "DataSet$ConsumedSpiceCapacityInBytes": "The amount of SPICE capacity used by this dataset. This is 0 if the dataset isn't imported into SPICE.
", - "LongList$member": null + "Ingestion$IngestionTimeInSeconds": "The time that this ingestion took, measured in seconds.
", + "Ingestion$IngestionSizeInBytes": "The size of the data ingested, in bytes.
", + "LongList$member": null, + "RowInfo$RowsIngested": "The number of rows that were ingested.
", + "RowInfo$RowsDropped": "The number of rows that were not ingested.
", + "RowInfo$TotalRowsInDataset": "The total number of rows in the dataset.
" } }, "LongList": { @@ -2675,7 +2721,7 @@ "NamespaceInfoV2": { "base": "The error type.
", "refs": { - "DescribeNamespaceResponse$Namespace": "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.
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.
" + "ListNamespacesResponse$Namespaces": "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.
" } }, "NonEmptyString": { @@ -2707,6 +2753,13 @@ "ThemeError$Message": "The error message.
" } }, + "NullableBoolean": { + "base": null, + "refs": { + "DescribeIpRestrictionResponse$Enabled": "Whether or not IP rules are enabled.
", + "UpdateIpRestrictionRequest$Enabled": "Whether or not IP rules are enabled.
" + } + }, "OnClause": { "base": null, "refs": { @@ -2943,33 +2996,33 @@ "ResourceId": { "base": null, "refs": { - "CreateDataSetRequest$DataSetId": "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.
", - "CreateDataSetResponse$DataSetId": "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.
", + "CreateDataSetRequest$DataSetId": "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.
", + "CreateDataSetResponse$DataSetId": "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.
", "CreateDataSetResponse$IngestionId": "The ID of the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE.
", - "CreateDataSourceRequest$DataSourceId": "An ID for the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.
", - "CreateDataSourceResponse$DataSourceId": "The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.
", + "CreateDataSourceRequest$DataSourceId": "An ID for the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
", + "CreateDataSourceResponse$DataSourceId": "The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
", "DataSet$DataSetId": "The ID of the dataset.
", "DataSetSummary$DataSetId": "The ID of the dataset.
", - "DataSource$DataSourceId": "The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.
", - "DeleteDataSetRequest$DataSetId": "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.
", - "DeleteDataSetResponse$DataSetId": "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.
", - "DeleteDataSourceRequest$DataSourceId": "The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.
", - "DeleteDataSourceResponse$DataSourceId": "The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.
", - "DescribeDataSetPermissionsRequest$DataSetId": "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.
", - "DescribeDataSetPermissionsResponse$DataSetId": "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.
", - "DescribeDataSetRequest$DataSetId": "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.
", - "DescribeDataSourcePermissionsRequest$DataSourceId": "The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.
", - "DescribeDataSourcePermissionsResponse$DataSourceId": "The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.
", - "DescribeDataSourceRequest$DataSourceId": "The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.
", - "UpdateDataSetPermissionsRequest$DataSetId": "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.
", - "UpdateDataSetPermissionsResponse$DataSetId": "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.
", - "UpdateDataSetRequest$DataSetId": "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.
", - "UpdateDataSetResponse$DataSetId": "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.
", + "DataSource$DataSourceId": "The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
", + "DeleteDataSetRequest$DataSetId": "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.
", + "DeleteDataSetResponse$DataSetId": "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.
", + "DeleteDataSourceRequest$DataSourceId": "The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
", + "DeleteDataSourceResponse$DataSourceId": "The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
", + "DescribeDataSetPermissionsRequest$DataSetId": "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.
", + "DescribeDataSetPermissionsResponse$DataSetId": "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.
", + "DescribeDataSetRequest$DataSetId": "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.
", + "DescribeDataSourcePermissionsRequest$DataSourceId": "The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
", + "DescribeDataSourcePermissionsResponse$DataSourceId": "The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
", + "DescribeDataSourceRequest$DataSourceId": "The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
", + "UpdateDataSetPermissionsRequest$DataSetId": "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.
", + "UpdateDataSetPermissionsResponse$DataSetId": "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.
", + "UpdateDataSetRequest$DataSetId": "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.
", + "UpdateDataSetResponse$DataSetId": "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.
", "UpdateDataSetResponse$IngestionId": "The ID of the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE.
", - "UpdateDataSourcePermissionsRequest$DataSourceId": "The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.
", - "UpdateDataSourcePermissionsResponse$DataSourceId": "The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.
", - "UpdateDataSourceRequest$DataSourceId": "The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.
", - "UpdateDataSourceResponse$DataSourceId": "The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.
" + "UpdateDataSourcePermissionsRequest$DataSourceId": "The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
", + "UpdateDataSourcePermissionsResponse$DataSourceId": "The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
", + "UpdateDataSourceRequest$DataSourceId": "The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
", + "UpdateDataSourceResponse$DataSourceId": "The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
" } }, "ResourceName": { @@ -3140,10 +3193,10 @@ "RestoreAnalysisRequest$AnalysisId": "The ID of the analysis that you're restoring.
", "RestoreAnalysisResponse$AnalysisId": "The ID of the analysis that you're restoring.
", "Sheet$SheetId": "The unique identifier associated with a sheet.
", - "Template$TemplateId": "The ID for the template. This is unique per Amazon Web Services Region; for each Amazon Web Services account.
", - "TemplateSummary$TemplateId": "The ID of the template. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.
", + "Template$TemplateId": "The ID for the template. This is unique per Amazon Web Services Region for each Amazon Web Services account.
", + "TemplateSummary$TemplateId": "The ID of the template. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
", "Theme$ThemeId": "The identifier that the user gives to the theme.
", - "ThemeSummary$ThemeId": "The ID of the theme. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.
", + "ThemeSummary$ThemeId": "The ID of the theme. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
", "ThemeVersion$BaseThemeId": "The Amazon QuickSight-defined ID of the theme that a custom theme inherits from. All themes initially inherit from a default Amazon QuickSight theme.
", "UpdateAnalysisPermissionsRequest$AnalysisId": "The ID of the analysis whose permissions you're updating. The ID is part of the analysis URL.
", "UpdateAnalysisPermissionsResponse$AnalysisId": "The ID of the analysis that you updated permissions for.
", @@ -3464,6 +3517,7 @@ "DescribeGroupResponse$Status": "The HTTP status of the request.
", "DescribeIAMPolicyAssignmentResponse$Status": "The HTTP status of the request.
", "DescribeIngestionResponse$Status": "The HTTP status of the request.
", + "DescribeIpRestrictionResponse$Status": "The status of a set of IP restrictions. A successful request returns a 200 status code.
", "DescribeNamespaceResponse$Status": "The HTTP status of the request.
", "DescribeTemplateAliasResponse$Status": "The HTTP status of the request.
", "DescribeTemplatePermissionsResponse$Status": "The HTTP status of the request.
", @@ -3520,6 +3574,7 @@ "UpdateFolderResponse$Status": "The status. If succeeded, the status is SC_OK.
The HTTP status of the request.
", "UpdateIAMPolicyAssignmentResponse$Status": "The HTTP status of the request.
", + "UpdateIpRestrictionResponse$Status": "The status of the updated IP rules. A successful request returns a 200 code.
", "UpdateTemplateAliasResponse$Status": "The HTTP status of the request.
", "UpdateTemplatePermissionsResponse$Status": "The HTTP status of the request.
", "UpdateTemplateResponse$Status": "The HTTP status of the request.
", @@ -3538,6 +3593,8 @@ "AccountSettings$NotificationEmail": "The main notification email for your Amazon QuickSight subscription.
", "ActionList$member": null, "AnalysisSearchFilter$Value": "The value of the named item, in this case QUICKSIGHT_USER, that you want to use as a filter, for example \"Value\". An example is \"arn:aws:quicksight:us-east-1:1:user/default/UserName1\".
The ID of the dataset used in the ingestion.
", + "CancelIngestionResponse$RequestId": "The Amazon Web Services request ID for this operation.
", "ColumnGroupColumnSchema$Name": "The name of the column group's column schema.
", "ColumnGroupSchema$Name": "The name of the column group schema.
", "ColumnNameList$member": null, @@ -3559,6 +3616,8 @@ "CreateGroupResponse$RequestId": "The Amazon Web Services request ID for this operation.
", "CreateIAMPolicyAssignmentResponse$AssignmentId": "The ID for the assignment.
", "CreateIAMPolicyAssignmentResponse$RequestId": "The Amazon Web Services request ID for this operation.
", + "CreateIngestionRequest$DataSetId": "The ID of the dataset used in the ingestion.
", + "CreateIngestionResponse$RequestId": "The Amazon Web Services request ID for this operation.
", "CreateNamespaceResponse$CapacityRegion": "The Amazon Web Services Region; that you want to use for the free SPICE capacity for the new namespace. This is set to the region that you run CreateNamespace in.
", "CreateNamespaceResponse$RequestId": "The Amazon Web Services request ID for this operation.
", "CreateTemplateAliasResponse$RequestId": "The Amazon Web Services request ID for this operation.
", @@ -3601,6 +3660,9 @@ "DescribeFolderResponse$RequestId": "The request ID.
", "DescribeGroupResponse$RequestId": "The Amazon Web Services request ID for this operation.
", "DescribeIAMPolicyAssignmentResponse$RequestId": "The Amazon Web Services request ID for this operation.
", + "DescribeIngestionRequest$DataSetId": "The ID of the dataset used in the ingestion.
", + "DescribeIngestionResponse$RequestId": "The Amazon Web Services request ID for this operation.
", + "DescribeIpRestrictionResponse$RequestId": "The ID of the describe request.
", "DescribeNamespaceResponse$RequestId": "The Amazon Web Services request ID for this operation.
", "DescribeTemplateAliasResponse$RequestId": "The Amazon Web Services request ID for this operation.
", "DescribeTemplatePermissionsResponse$RequestId": "The Amazon Web Services request ID for this operation.
", @@ -3611,6 +3673,7 @@ "DescribeUserResponse$RequestId": "The Amazon Web Services request ID for this operation.
", "DomainNotWhitelistedException$Message": null, "DomainNotWhitelistedException$RequestId": "The Amazon Web Services request ID for this request.
", + "ErrorInfo$Message": "Error message.
", "FolderColumnList$member": null, "FolderSearchFilter$Value": "The value of the named item (in this example, PARENT_FOLDER_ARN), that you want to use as a filter. For example, \"Value\": \"arn:aws:quicksight:us-east-1:1:folder/folderId\".
The Amazon Web Services request ID for this operation.
", @@ -3663,6 +3726,10 @@ "ListIAMPolicyAssignmentsRequest$NextToken": "The token for the next set of results, or null if there are no more results.
", "ListIAMPolicyAssignmentsResponse$NextToken": "The token for the next set of results, or null if there are no more results.
", "ListIAMPolicyAssignmentsResponse$RequestId": "The Amazon Web Services request ID for this operation.
", + "ListIngestionsRequest$DataSetId": "The ID of the dataset used in the ingestion.
", + "ListIngestionsRequest$NextToken": "The token for the next set of results, or null if there are no more results.
", + "ListIngestionsResponse$NextToken": "The token for the next set of results, or null if there are no more results.
", + "ListIngestionsResponse$RequestId": "The Amazon Web Services request ID for this operation.
", "ListNamespacesRequest$NextToken": "A pagination token that can be used in a subsequent request.
", "ListNamespacesResponse$NextToken": "A pagination token that can be used in a subsequent request.
", "ListNamespacesResponse$RequestId": "The Amazon Web Services request ID for this operation.
", @@ -3692,11 +3759,13 @@ "ListUsersResponse$NextToken": "A pagination token that can be used in a subsequent request.
", "ListUsersResponse$RequestId": "The Amazon Web Services request ID for this operation.
", "NamespaceError$Message": "The message for the error.
", - "NamespaceInfoV2$CapacityRegion": "The namespace Amazon Web Services Region;.
", + "NamespaceInfoV2$CapacityRegion": "The namespace Amazon Web Services Region.
", "PreconditionNotMetException$Message": null, "PreconditionNotMetException$RequestId": "The Amazon Web Services request ID for this request.
", "PrincipalList$member": null, "ProjectedColumnList$member": null, + "QueueInfo$WaitingOnIngestion": "The ID of the queued ingestion.
", + "QueueInfo$QueuedIngestion": "The ID of the ongoing ingestion. The queued ingestion is waiting for the ongoing ingestion to complete.
", "QuickSightUserNotFoundException$Message": null, "QuickSightUserNotFoundException$RequestId": "The Amazon Web Services request ID for this request.
", "RegisterUserRequest$Email": "The email address of the user that you want to register.
", @@ -3751,6 +3820,7 @@ "UpdateGroupResponse$RequestId": "The Amazon Web Services request ID for this operation.
", "UpdateIAMPolicyAssignmentResponse$AssignmentId": "The ID of the assignment.
", "UpdateIAMPolicyAssignmentResponse$RequestId": "The Amazon Web Services request ID for this operation.
", + "UpdateIpRestrictionResponse$RequestId": "The ID of the update request.
", "UpdateTemplateAliasResponse$RequestId": "The Amazon Web Services request ID for this operation.
", "UpdateTemplatePermissionsResponse$RequestId": "The Amazon Web Services request ID for this operation.
", "UpdateTemplateResponse$RequestId": "The Amazon Web Services request ID for this operation.
", @@ -3901,7 +3971,7 @@ "TemplateSourceEntity": { "base": "The source entity of the template.
", "refs": { - "CreateTemplateRequest$SourceEntity": "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 entity that you are using as a source when you update 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 time that the folder was last updated.
", "FolderSummary$CreatedTime": "The time that the folder was created.
", "FolderSummary$LastUpdatedTime": "The time that the folder was last updated.
", + "Ingestion$CreatedTime": "The time that this ingestion started.
", "Template$LastUpdatedTime": "Time when this was last updated.
", "Template$CreatedTime": "Time when this was created.
", "TemplateSummary$CreatedTime": "The last time that this template was created.
", @@ -4316,6 +4387,16 @@ "refs": { } }, + "UpdateIpRestrictionRequest": { + "base": null, + "refs": { + } + }, + "UpdateIpRestrictionResponse": { + "base": null, + "refs": { + } + }, "UpdateResourcePermissionList": { "base": null, "refs": { @@ -4519,39 +4600,6 @@ "GutterStyle$Show": "This Boolean value controls whether to display a gutter space between sheet tiles.
", "MarginStyle$Show": "This Boolean value controls whether to display sheet margins.
" } - }, - "long": { - "base": null, - "refs": { - "Ingestion$IngestionTimeInSeconds": "The time that this ingestion took, measured in seconds.
", - "Ingestion$IngestionSizeInBytes": "The size of the data ingested, in bytes.
", - "RowInfo$RowsIngested": "The number of rows that were ingested.
", - "RowInfo$RowsDropped": "The number of rows that were not ingested.
" - } - }, - "string": { - "base": null, - "refs": { - "CancelIngestionRequest$DataSetId": "The ID of the dataset used in the ingestion.
", - "CancelIngestionResponse$RequestId": "The Amazon Web Services request ID for this operation.
", - "CreateIngestionRequest$DataSetId": "The ID of the dataset used in the ingestion.
", - "CreateIngestionResponse$RequestId": "The Amazon Web Services request ID for this operation.
", - "DescribeIngestionRequest$DataSetId": "The ID of the dataset used in the ingestion.
", - "DescribeIngestionResponse$RequestId": "The Amazon Web Services request ID for this operation.
", - "ErrorInfo$Message": "Error message.
", - "ListIngestionsRequest$DataSetId": "The ID of the dataset used in the ingestion.
", - "ListIngestionsRequest$NextToken": "The token for the next set of results, or null if there are no more results.
", - "ListIngestionsResponse$NextToken": "The token for the next set of results, or null if there are no more results.
", - "ListIngestionsResponse$RequestId": "The Amazon Web Services request ID for this operation.
", - "QueueInfo$WaitingOnIngestion": "The ID of the queued ingestion.
", - "QueueInfo$QueuedIngestion": "The ID of the ongoing ingestion. The queued ingestion is waiting for the ongoing ingestion to complete.
" - } - }, - "timestamp": { - "base": null, - "refs": { - "Ingestion$CreatedTime": "The time that this ingestion started.
" - } } } } diff --git a/service/ivs/api.go b/service/ivs/api.go index 570827c427e..29a008f13e0 100644 --- a/service/ivs/api.go +++ b/service/ivs/api.go @@ -215,16 +215,16 @@ func (c *IVS) CreateChannelRequest(input *CreateChannelInput) (req *request.Requ // API operation CreateChannel for usage and error information. // // Returned Error Types: -// * ValidationException +// * ResourceNotFoundException // // * AccessDeniedException // -// * ResourceNotFoundException -// -// * ServiceQuotaExceededException +// * ValidationException // // * PendingVerification // +// * ServiceQuotaExceededException +// // See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/CreateChannel func (c *IVS) CreateChannel(input *CreateChannelInput) (*CreateChannelOutput, error) { req, out := c.CreateChannelRequest(input) @@ -294,11 +294,11 @@ func (c *IVS) CreateRecordingConfigurationRequest(input *CreateRecordingConfigur // 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.) +// 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 @@ -313,17 +313,17 @@ func (c *IVS) CreateRecordingConfigurationRequest(input *CreateRecordingConfigur // API operation CreateRecordingConfiguration for usage and error information. // // Returned Error Types: -// * AccessDeniedException +// * InternalServerException // -// * ConflictException +// * AccessDeniedException // -// * InternalServerException +// * ValidationException // // * PendingVerification // -// * ServiceQuotaExceededException +// * ConflictException // -// * ValidationException +// * ServiceQuotaExceededException // // See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/CreateRecordingConfiguration func (c *IVS) CreateRecordingConfiguration(input *CreateRecordingConfigurationInput) (*CreateRecordingConfigurationOutput, error) { @@ -407,16 +407,16 @@ func (c *IVS) CreateStreamKeyRequest(input *CreateStreamKeyInput) (req *request. // API operation CreateStreamKey for usage and error information. // // Returned Error Types: -// * ValidationException +// * ResourceNotFoundException // // * AccessDeniedException // -// * ResourceNotFoundException -// -// * ServiceQuotaExceededException +// * ValidationException // // * PendingVerification // +// * ServiceQuotaExceededException +// // See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/CreateStreamKey func (c *IVS) CreateStreamKey(input *CreateStreamKeyInput) (*CreateStreamKeyOutput, error) { req, out := c.CreateStreamKeyRequest(input) @@ -500,16 +500,16 @@ func (c *IVS) DeleteChannelRequest(input *DeleteChannelInput) (req *request.Requ // API operation DeleteChannel for usage and error information. // // Returned Error Types: -// * ValidationException +// * ResourceNotFoundException // // * AccessDeniedException // -// * ResourceNotFoundException -// -// * ConflictException +// * ValidationException // // * PendingVerification // +// * ConflictException +// // See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/DeleteChannel func (c *IVS) DeleteChannel(input *DeleteChannelInput) (*DeleteChannelOutput, error) { req, out := c.DeleteChannelRequest(input) @@ -590,11 +590,11 @@ func (c *IVS) DeletePlaybackKeyPairRequest(input *DeletePlaybackKeyPairInput) (r // API operation DeletePlaybackKeyPair for usage and error information. // // Returned Error Types: -// * ValidationException +// * ResourceNotFoundException // // * AccessDeniedException // -// * ResourceNotFoundException +// * ValidationException // // * PendingVerification // @@ -680,16 +680,16 @@ func (c *IVS) DeleteRecordingConfigurationRequest(input *DeleteRecordingConfigur // API operation DeleteRecordingConfiguration for usage and error information. // // Returned Error Types: -// * AccessDeniedException -// -// * ConflictException +// * ResourceNotFoundException // // * InternalServerException // -// * ResourceNotFoundException +// * AccessDeniedException // // * ValidationException // +// * ConflictException +// // See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/DeleteRecordingConfiguration func (c *IVS) DeleteRecordingConfiguration(input *DeleteRecordingConfigurationInput) (*DeleteRecordingConfigurationOutput, error) { req, out := c.DeleteRecordingConfigurationRequest(input) @@ -768,11 +768,11 @@ func (c *IVS) DeleteStreamKeyRequest(input *DeleteStreamKeyInput) (req *request. // API operation DeleteStreamKey for usage and error information. // // Returned Error Types: -// * ValidationException +// * ResourceNotFoundException // // * AccessDeniedException // -// * ResourceNotFoundException +// * ValidationException // // * PendingVerification // @@ -852,11 +852,11 @@ func (c *IVS) GetChannelRequest(input *GetChannelInput) (req *request.Request, o // API operation GetChannel for usage and error information. // // Returned Error Types: -// * ValidationException +// * ResourceNotFoundException // // * AccessDeniedException // -// * ResourceNotFoundException +// * ValidationException // // See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/GetChannel func (c *IVS) GetChannel(input *GetChannelInput) (*GetChannelOutput, error) { @@ -938,11 +938,11 @@ func (c *IVS) GetPlaybackKeyPairRequest(input *GetPlaybackKeyPairInput) (req *re // API operation GetPlaybackKeyPair for usage and error information. // // Returned Error Types: -// * ValidationException +// * ResourceNotFoundException // // * AccessDeniedException // -// * ResourceNotFoundException +// * ValidationException // // See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/GetPlaybackKeyPair func (c *IVS) GetPlaybackKeyPair(input *GetPlaybackKeyPairInput) (*GetPlaybackKeyPairOutput, error) { @@ -1020,11 +1020,11 @@ func (c *IVS) GetRecordingConfigurationRequest(input *GetRecordingConfigurationI // API operation GetRecordingConfiguration for usage and error information. // // Returned Error Types: -// * AccessDeniedException +// * ResourceNotFoundException // // * InternalServerException // -// * ResourceNotFoundException +// * AccessDeniedException // // * ValidationException // @@ -1106,10 +1106,10 @@ func (c *IVS) GetStreamRequest(input *GetStreamInput) (req *request.Request, out // Returned Error Types: // * ResourceNotFoundException // -// * ValidationException -// // * AccessDeniedException // +// * ValidationException +// // * ChannelNotBroadcasting // // See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/GetStream @@ -1188,11 +1188,11 @@ func (c *IVS) GetStreamKeyRequest(input *GetStreamKeyInput) (req *request.Reques // API operation GetStreamKey for usage and error information. // // Returned Error Types: -// * ValidationException +// * ResourceNotFoundException // // * AccessDeniedException // -// * ResourceNotFoundException +// * ValidationException // // See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/GetStreamKey func (c *IVS) GetStreamKey(input *GetStreamKeyInput) (*GetStreamKeyOutput, error) { @@ -1274,16 +1274,16 @@ func (c *IVS) ImportPlaybackKeyPairRequest(input *ImportPlaybackKeyPairInput) (r // API operation ImportPlaybackKeyPair for usage and error information. // // Returned Error Types: +// * AccessDeniedException +// // * ValidationException // -// * ConflictException +// * PendingVerification // -// * AccessDeniedException +// * ConflictException // // * ServiceQuotaExceededException // -// * PendingVerification -// // See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ImportPlaybackKeyPair func (c *IVS) ImportPlaybackKeyPair(input *ImportPlaybackKeyPairInput) (*ImportPlaybackKeyPairOutput, error) { req, out := c.ImportPlaybackKeyPairRequest(input) @@ -1356,11 +1356,11 @@ func (c *IVS) ListChannelsRequest(input *ListChannelsInput) (req *request.Reques // ListChannels API operation for Amazon Interactive Video Service. // -// 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). +// 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). // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1370,10 +1370,10 @@ func (c *IVS) ListChannelsRequest(input *ListChannelsInput) (req *request.Reques // API operation ListChannels for usage and error information. // // Returned Error Types: -// * ValidationException -// // * AccessDeniedException // +// * ValidationException +// // * ConflictException // // See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListChannels @@ -1512,10 +1512,10 @@ func (c *IVS) ListPlaybackKeyPairsRequest(input *ListPlaybackKeyPairsInput) (req // API operation ListPlaybackKeyPairs for usage and error information. // // Returned Error Types: -// * ValidationException -// // * AccessDeniedException // +// * ValidationException +// // See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListPlaybackKeyPairs func (c *IVS) ListPlaybackKeyPairs(input *ListPlaybackKeyPairsInput) (*ListPlaybackKeyPairsOutput, error) { req, out := c.ListPlaybackKeyPairsRequest(input) @@ -1641,7 +1641,7 @@ func (c *IVS) ListRecordingConfigurationsRequest(input *ListRecordingConfigurati // ListRecordingConfigurations API operation for Amazon Interactive Video Service. // // Gets summary information about all recording configurations in your account, -// in the AWS region where the API request is processed. +// in the Amazon Web Services region where the API request is processed. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1651,10 +1651,10 @@ func (c *IVS) ListRecordingConfigurationsRequest(input *ListRecordingConfigurati // API operation ListRecordingConfigurations for usage and error information. // // Returned Error Types: -// * AccessDeniedException -// // * InternalServerException // +// * AccessDeniedException +// // * ValidationException // // See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListRecordingConfigurations @@ -1791,11 +1791,11 @@ func (c *IVS) ListStreamKeysRequest(input *ListStreamKeysInput) (req *request.Re // API operation ListStreamKeys for usage and error information. // // Returned Error Types: -// * ValidationException +// * ResourceNotFoundException // // * AccessDeniedException // -// * ResourceNotFoundException +// * ValidationException // // See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListStreamKeys func (c *IVS) ListStreamKeys(input *ListStreamKeysInput) (*ListStreamKeysOutput, error) { @@ -1921,8 +1921,8 @@ func (c *IVS) ListStreamsRequest(input *ListStreamsInput) (req *request.Request, // ListStreams API operation for Amazon Interactive Video Service. // -// Gets summary information about live streams in your account, in the AWS region -// where the API request is processed. +// Gets summary information about live streams in your account, in the Amazon +// Web Services region where the API request is processed. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2039,12 +2039,6 @@ func (c *IVS) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req * Name: opListTagsForResource, HTTPMethod: "GET", HTTPPath: "/tags/{resourceArn}", - Paginator: &request.Paginator{ - InputTokens: []string{"nextToken"}, - OutputTokens: []string{"nextToken"}, - LimitToken: "maxResults", - TruncationToken: "", - }, } if input == nil { @@ -2058,7 +2052,7 @@ func (c *IVS) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req * // ListTagsForResource API operation for Amazon Interactive Video Service. // -// Gets information about AWS tags for the specified ARN. +// Gets information about Amazon Web Services tags for the specified ARN. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2068,12 +2062,12 @@ func (c *IVS) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req * // API operation ListTagsForResource for usage and error information. // // Returned Error Types: +// * ResourceNotFoundException +// // * InternalServerException // // * ValidationException // -// * ResourceNotFoundException -// // See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListTagsForResource func (c *IVS) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error) { req, out := c.ListTagsForResourceRequest(input) @@ -2096,58 +2090,6 @@ func (c *IVS) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsFor return out, req.Send() } -// ListTagsForResourcePages iterates over the pages of a ListTagsForResource operation, -// calling the "fn" function with the response data for each page. To stop -// iterating, return false from the fn function. -// -// See ListTagsForResource method for more information on how to use this operation. -// -// Note: This operation can generate multiple requests to a service. -// -// // Example iterating over at most 3 pages of a ListTagsForResource operation. -// pageNum := 0 -// err := client.ListTagsForResourcePages(params, -// func(page *ivs.ListTagsForResourceOutput, lastPage bool) bool { -// pageNum++ -// fmt.Println(page) -// return pageNum <= 3 -// }) -// -func (c *IVS) ListTagsForResourcePages(input *ListTagsForResourceInput, fn func(*ListTagsForResourceOutput, bool) bool) error { - return c.ListTagsForResourcePagesWithContext(aws.BackgroundContext(), input, fn) -} - -// ListTagsForResourcePagesWithContext same as ListTagsForResourcePages except -// it takes a Context and allows setting request options on the pages. -// -// The context must be non-nil and will be used for request cancellation. If -// the context is nil a panic will occur. In the future the SDK may create -// sub-contexts for http.Requests. See https://golang.org/pkg/context/ -// for more information on using Contexts. -func (c *IVS) ListTagsForResourcePagesWithContext(ctx aws.Context, input *ListTagsForResourceInput, fn func(*ListTagsForResourceOutput, bool) bool, opts ...request.Option) error { - p := request.Pagination{ - NewRequest: func() (*request.Request, error) { - var inCpy *ListTagsForResourceInput - if input != nil { - tmp := *input - inCpy = &tmp - } - req, _ := c.ListTagsForResourceRequest(inCpy) - req.SetContext(ctx) - req.ApplyOptions(opts...) - return req, nil - }, - } - - for p.Next() { - if !fn(p.Page().(*ListTagsForResourceOutput), !p.HasNextPage()) { - break - } - } - - return p.Err() -} - const opPutMetadata = "PutMetadata" // PutMetadataRequest generates a "aws/request.Request" representing the @@ -2193,11 +2135,11 @@ func (c *IVS) PutMetadataRequest(input *PutMetadataInput) (req *request.Request, // PutMetadata API operation for Amazon Interactive Video Service. // -// 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 (https://docs.aws.amazon.com/ivs/latest/userguide/metadata.html) +// 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 (https://docs.aws.amazon.com/ivs/latest/userguide/metadata.html) // in the Amazon IVS User Guide. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -2208,15 +2150,15 @@ func (c *IVS) PutMetadataRequest(input *PutMetadataInput) (req *request.Request, // API operation PutMetadata for usage and error information. // // Returned Error Types: -// * ThrottlingException -// // * ResourceNotFoundException // -// * ChannelNotBroadcasting +// * AccessDeniedException // // * ValidationException // -// * AccessDeniedException +// * ChannelNotBroadcasting +// +// * ThrottlingException // // See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/PutMetadata func (c *IVS) PutMetadata(input *PutMetadataInput) (*PutMetadataOutput, error) { @@ -2302,11 +2244,11 @@ func (c *IVS) StopStreamRequest(input *StopStreamInput) (req *request.Request, o // Returned Error Types: // * ResourceNotFoundException // -// * ChannelNotBroadcasting +// * AccessDeniedException // // * ValidationException // -// * AccessDeniedException +// * ChannelNotBroadcasting // // * StreamUnavailable // @@ -2377,7 +2319,8 @@ func (c *IVS) TagResourceRequest(input *TagResourceInput) (req *request.Request, // TagResource API operation for Amazon Interactive Video Service. // -// Adds or updates tags for the AWS resource with the specified ARN. +// Adds or updates tags for the Amazon Web Services resource with the specified +// ARN. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2387,12 +2330,12 @@ func (c *IVS) TagResourceRequest(input *TagResourceInput) (req *request.Request, // API operation TagResource for usage and error information. // // Returned Error Types: +// * ResourceNotFoundException +// // * InternalServerException // // * ValidationException // -// * ResourceNotFoundException -// // See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/TagResource func (c *IVS) TagResource(input *TagResourceInput) (*TagResourceOutput, error) { req, out := c.TagResourceRequest(input) @@ -2470,12 +2413,12 @@ func (c *IVS) UntagResourceRequest(input *UntagResourceInput) (req *request.Requ // API operation UntagResource for usage and error information. // // Returned Error Types: +// * ResourceNotFoundException +// // * InternalServerException // // * ValidationException // -// * ResourceNotFoundException -// // See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/UntagResource func (c *IVS) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error) { req, out := c.UntagResourceRequest(input) @@ -2554,16 +2497,16 @@ func (c *IVS) UpdateChannelRequest(input *UpdateChannelInput) (req *request.Requ // API operation UpdateChannel for usage and error information. // // Returned Error Types: -// * ValidationException +// * ResourceNotFoundException // // * AccessDeniedException // -// * ResourceNotFoundException -// -// * ConflictException +// * ValidationException // // * PendingVerification // +// * ConflictException +// // See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/UpdateChannel func (c *IVS) UpdateChannel(input *UpdateChannelInput) (*UpdateChannelOutput, error) { req, out := c.UpdateChannelRequest(input) @@ -2917,12 +2860,13 @@ type Channel struct { // // * 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. + // 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. Vertical resolution - // can be up to 480 and bitrate can be up to 1.5 Mbps. + // video-quality choice is limited to the original input. Resolution can + // be up to 480p and bitrate can be up to 1.5 Mbps. Type *string `locationName:"type" type:"string" enum:"ChannelType"` } @@ -3240,12 +3184,13 @@ type CreateChannelInput struct { // // * 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. + // 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. Vertical resolution - // can be up to 480 and bitrate can be up to 1.5 Mbps. + // video-quality choice is limited to the original input. Resolution can + // be up to 480p and bitrate can be up to 1.5 Mbps. Type *string `locationName:"type" type:"string" enum:"ChannelType"` } @@ -3352,8 +3297,7 @@ type CreateRecordingConfigurationInput struct { // DestinationConfiguration is a required field DestinationConfiguration *DestinationConfiguration `locationName:"destinationConfiguration" type:"structure" required:"true"` - // An arbitrary string (a nickname) that helps the customer identify that resource. - // The value does not need to be unique. + // Recording-configuration name. The value does not need to be unique. Name *string `locationName:"name" type:"string"` // Array of 1-50 maps, each of the form string:string (key:value). @@ -4264,8 +4208,7 @@ func (s *GetStreamOutput) SetStream(v *Stream) *GetStreamOutput { type ImportPlaybackKeyPairInput struct { _ struct{} `type:"structure"` - // 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. + // Playback-key-pair name. The value does not need to be unique. Name *string `locationName:"name" type:"string"` // The public portion of a customer-generated key pair. @@ -4944,14 +4887,7 @@ func (s *ListStreamsOutput) SetStreams(v []*StreamSummary) *ListStreamsOutput { } type ListTagsForResourceInput struct { - _ struct{} `type:"structure"` - - // Maximum number of tags to return. Default: 50. - MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"` - - // The first tag to retrieve. This is used for pagination; see the nextToken - // response field. - NextToken *string `locationName:"nextToken" type:"string"` + _ struct{} `type:"structure" nopayload:"true"` // The ARN of the resource to be retrieved. // @@ -4980,9 +4916,6 @@ func (s ListTagsForResourceInput) GoString() string { // Validate inspects the fields of the type to determine if they are valid. func (s *ListTagsForResourceInput) Validate() error { invalidParams := request.ErrInvalidParams{Context: "ListTagsForResourceInput"} - if s.MaxResults != nil && *s.MaxResults < 1 { - invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) - } if s.ResourceArn == nil { invalidParams.Add(request.NewErrParamRequired("ResourceArn")) } @@ -4996,18 +4929,6 @@ func (s *ListTagsForResourceInput) Validate() error { return nil } -// SetMaxResults sets the MaxResults field's value. -func (s *ListTagsForResourceInput) SetMaxResults(v int64) *ListTagsForResourceInput { - s.MaxResults = &v - return s -} - -// SetNextToken sets the NextToken field's value. -func (s *ListTagsForResourceInput) SetNextToken(v string) *ListTagsForResourceInput { - s.NextToken = &v - return s -} - // SetResourceArn sets the ResourceArn field's value. func (s *ListTagsForResourceInput) SetResourceArn(v string) *ListTagsForResourceInput { s.ResourceArn = &v @@ -5017,10 +4938,6 @@ func (s *ListTagsForResourceInput) SetResourceArn(v string) *ListTagsForResource type ListTagsForResourceOutput struct { _ struct{} `type:"structure"` - // If there are more tags than maxResults, use nextToken in the request to get - // the next set. - NextToken *string `locationName:"nextToken" type:"string"` - // Tags is a required field Tags map[string]*string `locationName:"tags" type:"map" required:"true"` } @@ -5043,12 +4960,6 @@ func (s ListTagsForResourceOutput) GoString() string { return s.String() } -// SetNextToken sets the NextToken field's value. -func (s *ListTagsForResourceOutput) SetNextToken(v string) *ListTagsForResourceOutput { - s.NextToken = &v - return s -} - // SetTags sets the Tags field's value. func (s *ListTagsForResourceOutput) SetTags(v map[string]*string) *ListTagsForResourceOutput { s.Tags = v @@ -5131,8 +5042,7 @@ type PlaybackKeyPair struct { // Key-pair identifier. Fingerprint *string `locationName:"fingerprint" type:"string"` - // 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. + // Playback-key-pair name. The value does not need to be unique. Name *string `locationName:"name" type:"string"` // Array of 1-50 maps, each of the form string:string (key:value). @@ -5188,8 +5098,7 @@ type PlaybackKeyPairSummary struct { // Key-pair ARN. Arn *string `locationName:"arn" min:"1" type:"string"` - // 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. + // Playback-key-pair name. The value does not need to be unique. Name *string `locationName:"name" type:"string"` // Array of 1-50 maps, each of the form string:string (key:value). @@ -5243,8 +5152,12 @@ type PutMetadataInput struct { // Metadata to insert into the stream. Maximum: 1 KB per request. // + // Metadata is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by PutMetadataInput's + // String and GoString methods. + // // Metadata is a required field - Metadata *string `locationName:"metadata" min:"1" type:"string" required:"true"` + Metadata *string `locationName:"metadata" min:"1" type:"string" required:"true" sensitive:"true"` } // String returns the string representation. @@ -5336,9 +5249,7 @@ type RecordingConfiguration struct { // DestinationConfiguration is a required field DestinationConfiguration *DestinationConfiguration `locationName:"destinationConfiguration" type:"structure" required:"true"` - // 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. + // Recording-configuration name. The value does not need to be unique. Name *string `locationName:"name" type:"string"` // Indicates the current state of the recording configuration. When the state @@ -5414,9 +5325,7 @@ type RecordingConfigurationSummary struct { // DestinationConfiguration is a required field DestinationConfiguration *DestinationConfiguration `locationName:"destinationConfiguration" type:"structure" required:"true"` - // 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. + // Recording-configuration name. The value does not need to be unique. Name *string `locationName:"name" type:"string"` // Indicates the current state of the recording configuration. When the state @@ -5745,14 +5654,17 @@ type Stream struct { // stream. PlaybackUrl *string `locationName:"playbackUrl" type:"string"` - // ISO-8601 formatted timestamp of the stream’s start. + // Time of the stream’s start. This is an ISO 8601 timestamp returned as a + // string. StartTime *time.Time `locationName:"startTime" type:"timestamp" timestampFormat:"iso8601"` // The stream’s state. State *string `locationName:"state" type:"string" enum:"StreamState"` - // Number of current viewers of the stream. A value of -1 indicates that the - // request timed out; in this case, retry. + // 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. ViewerCount *int64 `locationName:"viewerCount" type:"long"` } @@ -5824,7 +5736,11 @@ type StreamKey struct { Tags map[string]*string `locationName:"tags" type:"map"` // Stream-key value. - Value *string `locationName:"value" type:"string"` + // + // Value is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by StreamKey's + // String and GoString methods. + Value *string `locationName:"value" type:"string" sensitive:"true"` } // String returns the string representation. @@ -5929,14 +5845,17 @@ type StreamSummary struct { // The stream’s health. Health *string `locationName:"health" type:"string" enum:"StreamHealth"` - // ISO-8601 formatted timestamp of the stream’s start. + // Time of the stream’s start. This is an ISO 8601 timestamp returned as a + // string. StartTime *time.Time `locationName:"startTime" type:"timestamp" timestampFormat:"iso8601"` // The stream’s state. State *string `locationName:"state" type:"string" enum:"StreamState"` - // Number of current viewers of the stream. A value of -1 indicates that the - // request timed out; in this case, retry. + // 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. ViewerCount *int64 `locationName:"viewerCount" type:"long"` } @@ -6321,12 +6240,13 @@ type UpdateChannelInput struct { // // * 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. + // 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. Vertical resolution - // can be up to 480 and bitrate can be up to 1.5 Mbps. + // video-quality choice is limited to the original input. Resolution can + // be up to 480p and bitrate can be up to 1.5 Mbps. Type *string `locationName:"type" type:"string" enum:"ChannelType"` } @@ -6435,7 +6355,8 @@ type ValidationException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` - // The input fails to satisfy the constraints specified by an AWS service. + // The input fails to satisfy the constraints specified by an Amazon Web Services + // service. ExceptionMessage *string `locationName:"exceptionMessage" type:"string"` Message_ *string `locationName:"message" type:"string"` diff --git a/service/ivs/doc.go b/service/ivs/doc.go index bf706e9547f..14a61a1367b 100644 --- a/service/ivs/doc.go +++ b/service/ivs/doc.go @@ -6,220 +6,138 @@ // 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. +// 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 AWS regional service, currently in these regions: us-west-2, -// us-east-1, and eu-west-1. +// 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 (https://docs.aws.amazon.com/general/latest/gr/ivs.html) +// 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 (https://docs.aws.amazon.com/ivs/latest/userguide/doc-history.html). // -// 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 (https://docs.aws.amazon.com/ivs/latest/userguide/getting-started.html)): -// -// * 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 +//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 +// 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 (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) -// 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 (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html)). -// -// 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 (https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html). -// (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) (https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html) -// in the AWS General Reference. -// -// * Managing Amazon IVS permissions — See Identity and Access Management -// (https://docs.aws.amazon.com/ivs/latest/userguide/security-iam.html) 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 +// endpoints for more information.
Tagging
+//A tag is a metadata label that you assign to an Amazon Web Services
+// resource. A tag comprises a key and a value, both set by
+// you. For example, you might set a tag as topic:nature to
+// label a particular video category. See Tagging
+// Amazon Web Services Resources for more information, including restrictions
+// that apply to tags.
Tags can help you identify and organize your +// Amazon Web Services resources. For example, you can use the same tag for +// different resources to indicate that they are related. You can also use +// tags to manage access (see +// Access Tags).
The Amazon IVS API has these tag-related endpoints: +// TagResource, UntagResource, and ListTagsForResource. +// The following resources support tagging: Channels, Stream Keys, Playback +// Key Pairs, and Recording Configurations.
At most 50 tags can be +// applied to a resource.
Authentication versus Authorization +//
Note the differences between these concepts:
+// Authentication is about verifying identity. You need to be authenticated +// to sign Amazon IVS API requests.
Authorization +// is about granting permissions. 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 Amazon Web Services Command-Line Interface (CLI) and Amazon IVS Player +// SDKs take care of signing the underlying API calls for you. However, if +// your application calls the Amazon IVS API directly, it’s your responsibility +// to sign the requests.
You generate a signature using valid Amazon
+// Web Services credentials that have permission to perform the requested
+// action. For example, you must sign PutMetadata requests with a signature
+// generated from an IAM user account that has the ivs:PutMetadata
+// permission.
For more information:
Authentication +// and generating signatures — See Authenticating +// Requests (Amazon Web Services Signature Version 4) in the Amazon +// Web Services General Reference.
Managing Amazon +// IVS permissions — See Identity +// and Access Management on the Security page of the Amazon IVS User +// Guide.
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 +// 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). -// -// * 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 (https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html) -// 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. +// 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 Amazon +// Web Services 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. +// 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.
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 Amazon Web Services region where the API request is processed.
+//DeleteRecordingConfiguration — Deletes the recording +// configuration for the specified ARN.
Amazon Web +// Services Tags Endpoints
TagResource — +// Adds or updates tags for the Amazon Web Services resource with the specified +// ARN.
UntagResource — Removes tags from the +// resource with the specified ARN.
ListTagsForResource +// — Gets information about Amazon Web Services tags for the specified +// ARN.