@aws-sdk/client-ivs 3.35.0 → 3.38.0

package/CHANGELOG.md

@@ -3,6 +3,54 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [3.38.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.37.0...v3.38.0) (2021-10-22)
+
+
+### Features
+
+* **client-documentation-generator:** rename package ([#2916](https://github.com/aws/aws-sdk-js-v3/issues/2916)) ([1a80bfd](https://github.com/aws/aws-sdk-js-v3/commit/1a80bfd2dfc583001ddb4a21b6432eaaad699aa7))
+* **clients:** export folder from index.ts ([#2912](https://github.com/aws/aws-sdk-js-v3/issues/2912)) ([183b46d](https://github.com/aws/aws-sdk-js-v3/commit/183b46dde7f5613128038bf1c076f3c0b693203b))
+* **clients:** update clients as of 2021/10/22 ([#2924](https://github.com/aws/aws-sdk-js-v3/issues/2924)) ([4d79819](https://github.com/aws/aws-sdk-js-v3/commit/4d798196e652f8cfdc1c155a46ac6b6aa31b2656))
+
+
+
+
+
+# [3.37.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.36.1...v3.37.0) (2021-10-15)
+
+
+### Features
+
+* **clients:** update clients as of 10/15/2021 ([#2902](https://github.com/aws/aws-sdk-js-v3/issues/2902)) ([2730b54](https://github.com/aws/aws-sdk-js-v3/commit/2730b5424377944a5a2ad5e1ad7d3ca4135dae1c))
+
+
+
+
+
+## [3.36.1](https://github.com/aws/aws-sdk-js-v3/compare/v3.36.0...v3.36.1) (2021-10-12)
+
+
+### Bug Fixes
+
+* **clients:** emitDeclarationOnly in tsconfig.types.json ([#2893](https://github.com/aws/aws-sdk-js-v3/issues/2893)) ([6dc3d56](https://github.com/aws/aws-sdk-js-v3/commit/6dc3d56c20809c90cbdc4dd48627eeebc64af99d))
+
+
+
+
+
+# [3.36.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.35.0...v3.36.0) (2021-10-08)
+
+
+### Features
+
+* publish files in dist-* only ([#2873](https://github.com/aws/aws-sdk-js-v3/issues/2873)) ([53b4243](https://github.com/aws/aws-sdk-js-v3/commit/53b4243b066f25ff2412d5f0dea1036054b2df32))
+* **codegen:** ts-ignore packageInfo imports in codegen ([#2875](https://github.com/aws/aws-sdk-js-v3/issues/2875)) ([99d9267](https://github.com/aws/aws-sdk-js-v3/commit/99d926762193e83a354edec6e9de2b0543449704))
+* **tsconfig:** remove sourceMap ([#2867](https://github.com/aws/aws-sdk-js-v3/issues/2867)) ([d25f526](https://github.com/aws/aws-sdk-js-v3/commit/d25f526627a02a2ca28675fecce66c76b6c97966))
+
+
+
+
+
 # [3.35.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.34.0...v3.35.0) (2021-10-04)
 
 

package/README.md

@@ -10,65 +10,24 @@ AWS SDK for JavaScript Ivs Client for Node.js, Browser and React Native.
 <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>
@@ -89,13 +48,11 @@ History</a>.</p>
 </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
@@ -123,26 +80,21 @@ where to store the recorded content. Multiple channels can reference the same re
 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>
@@ -150,39 +102,39 @@ Configurations.</p>
 <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>
@@ -205,10 +157,10 @@ multiple ARNs simultaneously.</p>
 <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>
@@ -221,7 +173,6 @@ changes to take effect.</p>
 <a>DeleteChannel</a> — Deletes the specified channel.</p>
 </li>
 </ul>
-
 <p>
 <b>StreamKey Endpoints</b>
 </p>
@@ -252,7 +203,6 @@ for the specified channel.</p>
 ARN, so it can no longer be used to stream.</p>
 </li>
 </ul>
-
 <p>
 <b>Stream Endpoints</b>
 </p>
@@ -265,7 +215,7 @@ a specified channel.</p>
 <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>
@@ -276,12 +226,12 @@ prevent further streaming to a channel.</p>
 <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>
@@ -293,7 +243,7 @@ your data into a single PutMetadata call.)</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
+grant viewers access to private channels (channels enabled for playback
 authorization).</p>
 </li>
 <li>
@@ -315,26 +265,25 @@ 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>
+<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>
@@ -342,15 +291,14 @@ processed.</p>
 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>
@@ -359,8 +307,7 @@ specified ARN.</p>
 </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>