@aws-sdk/client-ivs 3.35.0 → 3.38.0

package/dist-types/IvsClient.d.ts

@@ -143,65 +143,24 @@ export interface IvsClientResolvedConfig extends IvsClientResolvedConfigType {
  * <p>
  *             <b>Introduction</b>
  *          </p>
- *
  *          <p>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.</p>
- *
- *          <p>The API is an AWS regional service, currently in these regions: us-west-2, us-east-1, and
- *       eu-west-1.</p>
+ *       API and an Amazon Web Services EventBridge event stream for responses. JSON is used for both
+ *       requests and responses, including errors.</p>
+ *          <p>The API is an Amazon Web Services regional service. For a list of supported regions and
+ *       Amazon IVS HTTPS service endpoints, see the <a href="https://docs.aws.amazon.com/general/latest/gr/ivs.html">Amazon IVS page</a> in the
+ *           <i>Amazon Web Services General Reference</i>.</p>
  *          <p>
  *             <i>
  *                <b>All API request parameters and URLs are case sensitive.
  *         </b>
  *             </i>
  *          </p>
- *
  *          <p>For a summary of notable documentation changes in each release, see <a href="https://docs.aws.amazon.com/ivs/latest/userguide/doc-history.html"> Document
  *       History</a>.</p>
  *
  *          <p>
- *             <b>Service Endpoints</b>
- *          </p>
- *          <p>The following are the Amazon IVS service endpoints (all HTTPS): </p>
- *          <p>Region name: US West (Oregon)</p>
- *          <ul>
- *             <li>
- *                <p>Region: <code>us-west-2</code>
- *                </p>
- *             </li>
- *             <li>
- *                <p>Endpoint: <code>ivs.us-west-2.amazonaws.com</code>
- *                </p>
- *             </li>
- *          </ul>
- *          <p>Region name: US East (Virginia)</p>
- *          <ul>
- *             <li>
- *                <p>Region: <code>us-east-1</code>
- *                </p>
- *             </li>
- *             <li>
- *                <p>Endpoint: <code>ivs.us-east-1.amazonaws.com</code>
- *                </p>
- *             </li>
- *          </ul>
- *          <p>Region name: EU West (Dublin)</p>
- *          <ul>
- *             <li>
- *                <p>Region: <code>eu-west-1</code>
- *                </p>
- *             </li>
- *             <li>
- *                <p>Endpoint: <code>ivs.eu-west-1.amazonaws.com</code>
- *                </p>
- *             </li>
- *          </ul>
- *
- *          <p>
  *             <b>Allowed Header Values</b>
  *          </p>
- *
  *          <ul>
  *             <li>
  *                <p>
@@ -222,13 +181,11 @@ export interface IvsClientResolvedConfig extends IvsClientResolvedConfigType {
  *                   </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>
- *
+ *          <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
@@ -256,28 +213,21 @@ export interface IvsClientResolvedConfig extends IvsClientResolvedConfigType {
  *           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 AWS 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 AWS
- *         Resources</a> for more information, including restrictions that apply to tags.</p>
- *
- *          <p>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 <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html">
- *         Access Tags</a>). </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>
@@ -285,40 +235,39 @@ export interface IvsClientResolvedConfig extends IvsClientResolvedConfigType {
  *          <ul>
  *             <li>
  *                <p>
- *                   <i>Authentication</i> is about verifying identity. You need to be authenticated to sign Amazon IVS
- *           API requests.</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>
+ *                   <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 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.</p>
- *          <p>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 <code>ivs:PutMetadata</code> permission.</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 (AWS Signature Version
- *         4)</a> in the <i>AWS General Reference</i>.</p>
+ *                <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>
+ *                <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>
@@ -341,10 +290,10 @@ export interface IvsClientResolvedConfig extends IvsClientResolvedConfigType {
  *             <li>
  *                <p>
  *                   <a>ListChannels</a> — 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).</p>
+ *           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>
@@ -357,7 +306,6 @@ export interface IvsClientResolvedConfig extends IvsClientResolvedConfigType {
  *                   <a>DeleteChannel</a> — Deletes the specified channel.</p>
  *             </li>
  *          </ul>
- *
  *          <p>
  *             <b>StreamKey Endpoints</b>
  *          </p>
@@ -388,8 +336,6 @@ export interface IvsClientResolvedConfig extends IvsClientResolvedConfigType {
  *           ARN, so it can no longer be used to stream.</p>
  *             </li>
  *          </ul>
- *
- *
  *          <p>
  *             <b>Stream Endpoints</b>
  *          </p>
@@ -402,7 +348,7 @@ export interface IvsClientResolvedConfig extends IvsClientResolvedConfigType {
  *             <li>
  *                <p>
  *                   <a>ListStreams</a> — Gets summary information about live streams in
- *           your account, in the AWS region where the API request is processed.</p>
+ *           your account, in the Amazon Web Services region where the API request is processed.</p>
  *             </li>
  *             <li>
  *                <p>
@@ -413,12 +359,12 @@ export interface IvsClientResolvedConfig extends IvsClientResolvedConfigType {
  *             <li>
  *                <p>
  *                   <a>PutMetadata</a> — Inserts metadata into the active stream of the
- *           specified channel. A maximum of 5 requests per second per channel is allowed, each with a
+ *           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.)</p>
+ *           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>
@@ -430,7 +376,7 @@ export interface IvsClientResolvedConfig extends IvsClientResolvedConfigType {
  *                   <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
+ *           grant viewers access to private channels (channels enabled for playback
  *           authorization).</p>
  *             </li>
  *             <li>
@@ -452,26 +398,25 @@ export interface IvsClientResolvedConfig extends IvsClientResolvedConfigType {
  *             <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>
+ *                   <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>
+ *                   <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 AWS region where the API request is
- *           processed.</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>
@@ -479,15 +424,14 @@ export interface IvsClientResolvedConfig extends IvsClientResolvedConfigType {
  *           configuration for the specified ARN.</p>
  *             </li>
  *          </ul>
- *
  *          <p>
- *             <b>AWS Tags Endpoints</b>
+ *             <b>Amazon Web Services Tags Endpoints</b>
  *          </p>
  *          <ul>
  *             <li>
  *                <p>
- *                   <a>TagResource</a> — Adds or updates tags for the AWS resource with
- *           the specified ARN.</p>
+ *                   <a>TagResource</a> — Adds or updates tags for the Amazon Web Services
+ *           resource with the specified ARN.</p>
  *             </li>
  *             <li>
  *                <p>
@@ -496,8 +440,7 @@ export interface IvsClientResolvedConfig extends IvsClientResolvedConfigType {
  *             </li>
  *             <li>
  *                <p>
- *                   <a>ListTagsForResource</a> — Gets information about AWS tags for the
- *           specified ARN.</p>
+ *                   <a>ListTagsForResource</a> — Gets information about Amazon Web Services tags for the specified ARN.</p>
  *             </li>
  *          </ul>
  */

package/dist-types/commands/CreateRecordingConfigurationCommand.d.ts

@@ -9,7 +9,7 @@ export interface CreateRecordingConfigurationCommandOutput extends CreateRecordi
 /**
  * <p>Creates a new recording configuration, used to enable recording to Amazon S3.</p>
  *          <p>
- *             <b>Known issue:</b> In the us-east-1 region, if you use the AWS
+ *             <b>Known issue:</b> 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 <code>state</code> of the recording configuration is
  *         <code>CREATE_FAILED</code> (instead of <code>ACTIVE</code>). (In other regions, the CLI

package/dist-types/commands/ListChannelsCommand.d.ts

@@ -7,7 +7,7 @@ export interface ListChannelsCommandInput extends ListChannelsRequest {
 export interface ListChannelsCommandOutput extends ListChannelsResponse, __MetadataBearer {
 }
 /**
- * <p>Gets summary information about all channels in your account, in the AWS region where the
+ * <p>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).</p>

package/dist-types/commands/ListRecordingConfigurationsCommand.d.ts

@@ -7,7 +7,7 @@ export interface ListRecordingConfigurationsCommandInput extends ListRecordingCo
 export interface ListRecordingConfigurationsCommandOutput extends ListRecordingConfigurationsResponse, __MetadataBearer {
 }
 /**
- * <p>Gets summary information about all recording configurations in your account, in the AWS
+ * <p>Gets summary information about all recording configurations in your account, in the Amazon Web Services
  *       region where the API request is processed.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

package/dist-types/commands/ListStreamsCommand.d.ts

@@ -7,7 +7,7 @@ export interface ListStreamsCommandInput extends ListStreamsRequest {
 export interface ListStreamsCommandOutput extends ListStreamsResponse, __MetadataBearer {
 }
 /**
- * <p>Gets summary information about live streams in your account, in the AWS region where the
+ * <p>Gets summary information about live streams in your account, in the Amazon Web Services region where the
  *       API request is processed.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

package/dist-types/commands/ListTagsForResourceCommand.d.ts

@@ -7,7 +7,7 @@ export interface ListTagsForResourceCommandInput extends ListTagsForResourceRequ
 export interface ListTagsForResourceCommandOutput extends ListTagsForResourceResponse, __MetadataBearer {
 }
 /**
- * <p>Gets information about AWS tags for the specified ARN.</p>
+ * <p>Gets information about Amazon Web Services tags for the specified ARN.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/PutMetadataCommand.d.ts

@@ -7,13 +7,11 @@ export interface PutMetadataCommandInput extends PutMetadataRequest {
 export interface PutMetadataCommandOutput extends __MetadataBearer {
 }
 /**
- * <p>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 <a href="https://docs.aws.amazon.com/ivs/latest/userguide/metadata.html">Embedding Metadata
- *
- *         within a Video Stream</a> in the <i>Amazon IVS User Guide</i>.</p>
+ * <p>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 <a href="https://docs.aws.amazon.com/ivs/latest/userguide/metadata.html">Embedding Metadata within a Video Stream</a> in
+ *       the <i>Amazon IVS User Guide</i>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/TagResourceCommand.d.ts

@@ -7,7 +7,7 @@ export interface TagResourceCommandInput extends TagResourceRequest {
 export interface TagResourceCommandOutput extends TagResourceResponse, __MetadataBearer {
 }
 /**
- * <p>Adds or updates tags for the AWS resource with the specified ARN.</p>
+ * <p>Adds or updates tags for the Amazon Web Services resource with the specified ARN.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/index.d.ts

@@ -0,0 +1,26 @@
+export * from "./BatchGetChannelCommand";
+export * from "./BatchGetStreamKeyCommand";
+export * from "./CreateChannelCommand";
+export * from "./CreateRecordingConfigurationCommand";
+export * from "./CreateStreamKeyCommand";
+export * from "./DeleteChannelCommand";
+export * from "./DeletePlaybackKeyPairCommand";
+export * from "./DeleteRecordingConfigurationCommand";
+export * from "./DeleteStreamKeyCommand";
+export * from "./GetChannelCommand";
+export * from "./GetPlaybackKeyPairCommand";
+export * from "./GetRecordingConfigurationCommand";
+export * from "./GetStreamCommand";
+export * from "./GetStreamKeyCommand";
+export * from "./ImportPlaybackKeyPairCommand";
+export * from "./ListChannelsCommand";
+export * from "./ListPlaybackKeyPairsCommand";
+export * from "./ListRecordingConfigurationsCommand";
+export * from "./ListStreamKeysCommand";
+export * from "./ListStreamsCommand";
+export * from "./ListTagsForResourceCommand";
+export * from "./PutMetadataCommand";
+export * from "./StopStreamCommand";
+export * from "./TagResourceCommand";
+export * from "./UntagResourceCommand";
+export * from "./UpdateChannelCommand";

package/dist-types/index.d.ts

@@ -1,36 +1,5 @@
-export * from "./IvsClient";
 export * from "./Ivs";
-export * from "./commands/BatchGetChannelCommand";
-export * from "./commands/BatchGetStreamKeyCommand";
-export * from "./commands/CreateChannelCommand";
-export * from "./commands/CreateRecordingConfigurationCommand";
-export * from "./commands/CreateStreamKeyCommand";
-export * from "./commands/DeleteChannelCommand";
-export * from "./commands/DeletePlaybackKeyPairCommand";
-export * from "./commands/DeleteRecordingConfigurationCommand";
-export * from "./commands/DeleteStreamKeyCommand";
-export * from "./commands/GetChannelCommand";
-export * from "./commands/GetPlaybackKeyPairCommand";
-export * from "./commands/GetRecordingConfigurationCommand";
-export * from "./commands/GetStreamCommand";
-export * from "./commands/GetStreamKeyCommand";
-export * from "./commands/ImportPlaybackKeyPairCommand";
-export * from "./commands/ListChannelsCommand";
-export * from "./pagination/ListChannelsPaginator";
-export * from "./commands/ListPlaybackKeyPairsCommand";
-export * from "./pagination/ListPlaybackKeyPairsPaginator";
-export * from "./commands/ListRecordingConfigurationsCommand";
-export * from "./pagination/ListRecordingConfigurationsPaginator";
-export * from "./commands/ListStreamKeysCommand";
-export * from "./pagination/ListStreamKeysPaginator";
-export * from "./commands/ListStreamsCommand";
-export * from "./pagination/ListStreamsPaginator";
-export * from "./commands/ListTagsForResourceCommand";
-export * from "./pagination/ListTagsForResourcePaginator";
-export * from "./commands/PutMetadataCommand";
-export * from "./commands/StopStreamCommand";
-export * from "./commands/TagResourceCommand";
-export * from "./commands/UntagResourceCommand";
-export * from "./commands/UpdateChannelCommand";
-export * from "./pagination/Interfaces";
-export * from "./models/index";
+export * from "./IvsClient";
+export * from "./commands";
+export * from "./models";
+export * from "./pagination";