@aws-sdk/client-ivs 3.145.0 → 3.154.0

package/CHANGELOG.md

@@ -3,6 +3,33 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [3.154.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.153.0...v3.154.0) (2022-08-19)
+
+**Note:** Version bump only for package @aws-sdk/client-ivs
+
+
+
+
+
+# [3.150.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.149.0...v3.150.0) (2022-08-15)
+
+**Note:** Version bump only for package @aws-sdk/client-ivs
+
+
+
+
+
+# [3.149.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.148.0...v3.149.0) (2022-08-12)
+
+
+### Features
+
+* **client-ivs:** Updates various list api MaxResults ranges ([807e21e](https://github.com/aws/aws-sdk-js-v3/commit/807e21e70ae1cd9b55e757f7fce8eb2c8e362224))
+
+
+
+
+
 # [3.145.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.144.0...v3.145.0) (2022-08-08)
 
 **Note:** Version bump only for package @aws-sdk/client-ivs

package/README.md

@@ -88,7 +88,9 @@ configuration. See the Recording Configuration endpoints for more information.</
 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>
+more information, including restrictions that apply to tags and "Tag naming limits and
+requirements"; Amazon IVS has no service-specific constraints beyond what is documented
+there.</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>
@@ -108,9 +110,11 @@ 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. Your IAM roles need
+to have permissions for Amazon IVS API requests. In addition, authorization is needed 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>

package/dist-types/Ivs.d.ts

@@ -108,7 +108,9 @@ import { IvsClient } from "./IvsClient";
  *       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>
+ *       more information, including restrictions that apply to tags and "Tag naming limits and
+ *       requirements"; Amazon IVS has no service-specific constraints beyond what is documented
+ *       there.</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>
@@ -128,9 +130,11 @@ import { IvsClient } from "./IvsClient";
  *             </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. Your IAM roles need
+ *           to have permissions for Amazon IVS API requests. In addition, authorization is needed 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>

package/dist-types/IvsClient.d.ts

@@ -233,7 +233,9 @@ export interface IvsClientResolvedConfig extends IvsClientResolvedConfigType {
  *       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>
+ *       more information, including restrictions that apply to tags and "Tag naming limits and
+ *       requirements"; Amazon IVS has no service-specific constraints beyond what is documented
+ *       there.</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>
@@ -253,9 +255,11 @@ export interface IvsClientResolvedConfig extends IvsClientResolvedConfigType {
  *             </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. Your IAM roles need
+ *           to have permissions for Amazon IVS API requests. In addition, authorization is needed 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>

package/dist-types/models/models_0.d.ts

@@ -89,7 +89,10 @@ export interface Channel {
      */
     authorized?: boolean;
     /**
-     * <p>Array of 1-50 maps, each of the form <code>string:string (key:value)</code>.</p>
+     * <p>Array of 1-50 maps, each of the form <code>string:string (key:value)</code>. 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 and "Tag naming limits and
+     *       requirements"; Amazon IVS has no service-specific constraints beyond what is documented
+     *       there.</p>
      */
     tags?: Record<string, string>;
 }
@@ -143,7 +146,10 @@ export interface StreamKey {
      */
     channelArn?: string;
     /**
-     * <p>Array of 1-50 maps, each of the form <code>string:string (key:value)</code>.</p>
+     * <p>Array of 1-50 maps, each of the form <code>string:string (key:value)</code>. 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 and "Tag naming limits and
+     *       requirements"; Amazon IVS has no service-specific constraints beyond what is documented
+     *       there.</p>
      */
     tags?: Record<string, string>;
 }
@@ -200,7 +206,10 @@ export interface CreateChannelRequest {
      */
     recordingConfigurationArn?: string;
     /**
-     * <p>Array of 1-50 maps, each of the form <code>string:string (key:value)</code>.</p>
+     * <p>Array of 1-50 maps, each of the form <code>string:string (key:value)</code>. 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 and "Tag naming limits and
+     *       requirements"; Amazon IVS has no service-specific constraints beyond what is documented
+     *       there.</p>
      */
     tags?: Record<string, string>;
 }
@@ -344,7 +353,10 @@ export interface CreateRecordingConfigurationRequest {
      */
     destinationConfiguration: DestinationConfiguration | undefined;
     /**
-     * <p>Array of 1-50 maps, each of the form <code>string:string (key:value)</code>.</p>
+     * <p>Array of 1-50 maps, each of the form <code>string:string (key:value)</code>. 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 and "Tag naming limits and
+     *       requirements"; Amazon IVS has no service-specific constraints beyond what is documented
+     *       there.</p>
      */
     tags?: Record<string, string>;
     /**
@@ -380,7 +392,10 @@ export interface RecordingConfiguration {
      */
     state: RecordingConfigurationState | string | undefined;
     /**
-     * <p>Array of 1-50 maps, each of the form <code>string:string (key:value)</code>.</p>
+     * <p>Array of 1-50 maps, each of the form <code>string:string (key:value)</code>. 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 and "Tag naming limits and
+     *       requirements"; Amazon IVS has no service-specific constraints beyond what is documented
+     *       there.</p>
      */
     tags?: Record<string, string>;
     /**
@@ -416,7 +431,10 @@ export interface CreateStreamKeyRequest {
      */
     channelArn: string | undefined;
     /**
-     * <p>Array of 1-50 maps, each of the form <code>string:string (key:value)</code>.</p>
+     * <p>Array of 1-50 maps, each of the form <code>string:string (key:value)</code>. 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 and "Tag naming limits and
+     *       requirements"; Amazon IVS has no service-specific constraints beyond what is documented
+     *       there.</p>
      */
     tags?: Record<string, string>;
 }
@@ -487,7 +505,10 @@ export interface PlaybackKeyPair {
      */
     fingerprint?: string;
     /**
-     * <p>Array of 1-50 maps, each of the form <code>string:string (key:value)</code>.</p>
+     * <p>Array of 1-50 maps, each of the form <code>string:string (key:value)</code>. 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 and "Tag naming limits and
+     *       requirements"; Amazon IVS has no service-specific constraints beyond what is documented
+     *       there.</p>
      */
     tags?: Record<string, string>;
 }
@@ -556,7 +577,8 @@ export interface _Stream {
      */
     playbackUrl?: string;
     /**
-     * <p>Time of the stream’s start. This is an ISO 8601 timestamp returned as a string.</p>
+     * <p>Time of the stream’s start. This is an ISO 8601 timestamp; <i>note that this is
+     *         returned as a string</i>.</p>
      */
     startTime?: Date;
     /**
@@ -606,7 +628,9 @@ export interface GetStreamSessionRequest {
     streamId?: string;
 }
 /**
- * <p>Object specifying a stream’s audio configuration.</p>
+ * <p>Object specifying a stream’s audio configuration, as set up by the broadcaster (usually in
+ *       an encoder). This is part of the <a>IngestConfiguration</a> object and used for
+ *       monitoring stream health.</p>
  */
 export interface AudioConfiguration {
     /**
@@ -627,7 +651,9 @@ export interface AudioConfiguration {
     channels?: number;
 }
 /**
- * <p>Object specifying a stream’s video configuration.</p>
+ * <p>Object specifying a stream’s video configuration, as set up by the broadcaster (usually in
+ *       an encoder). This is part of the <a>IngestConfiguration</a> object and used for
+ *       monitoring stream health.</p>
  */
 export interface VideoConfiguration {
     /**
@@ -693,7 +719,8 @@ export interface StreamEvent {
      */
     type?: string;
     /**
-     * <p>UTC ISO-8601 formatted timestamp of when the event occurred.</p>
+     * <p>Time when the event occurred. This is an ISO 8601 timestamp; <i>note that this is
+     *         returned as a string</i>.</p>
      */
     eventTime?: Date;
 }
@@ -708,12 +735,13 @@ export interface StreamSession {
      */
     streamId?: string;
     /**
-     * <p>UTC ISO-8601 formatted timestamp of when the channel went live.</p>
+     * <p>Time when the channel went live. This is an ISO 8601 timestamp; <i>note that this
+     *         is returned as a string</i>.</p>
      */
     startTime?: Date;
     /**
-     * <p>UTC ISO-8601 formatted timestamp of when the channel went offline. For live streams, this
-     *       is <code>NULL</code>.</p>
+     * <p>Time when the channel went offline. This is an ISO 8601 timestamp; <i>note that
+     *         this is returned as a string</i>. For live streams, this is <code>NULL</code>.</p>
      */
     endTime?: Date;
     /**
@@ -751,7 +779,10 @@ export interface ImportPlaybackKeyPairRequest {
      */
     name?: string;
     /**
-     * <p>Any tags provided with the request are added to the playback key pair tags.</p>
+     * <p>Any tags provided with the request are added to the playback key pair tags. 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 and "Tag naming limits and
+     *       requirements"; Amazon IVS has no service-specific constraints beyond what is documented
+     *       there.</p>
      */
     tags?: Record<string, string>;
 }
@@ -776,7 +807,7 @@ export interface ListChannelsRequest {
      */
     nextToken?: string;
     /**
-     * <p>Maximum number of channels to return. Default: 50.</p>
+     * <p>Maximum number of channels to return. Default: 100.</p>
      */
     maxResults?: number;
 }
@@ -810,7 +841,10 @@ export interface ChannelSummary {
      */
     recordingConfigurationArn?: string;
     /**
-     * <p>Array of 1-50 maps, each of the form <code>string:string (key:value)</code>.</p>
+     * <p>Array of 1-50 maps, each of the form <code>string:string (key:value)</code>. 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 and "Tag naming limits and
+     *       requirements"; Amazon IVS has no service-specific constraints beyond what is documented
+     *       there.</p>
      */
     tags?: Record<string, string>;
 }
@@ -827,12 +861,13 @@ export interface ListChannelsResponse {
 }
 export interface ListPlaybackKeyPairsRequest {
     /**
-     * <p>Maximum number of key pairs to return.</p>
+     * <p>The first key pair to retrieve. This is used for pagination; see the
+     *         <code>nextToken</code> response field.</p>
      */
     nextToken?: string;
     /**
-     * <p>The first key pair to retrieve. This is used for pagination; see the
-     *         <code>nextToken</code> response field. Default: 50.</p>
+     * <p>Maximum number of key pairs to return. Default: your service quota or 100, whichever is
+     *       smaller.</p>
      */
     maxResults?: number;
 }
@@ -849,7 +884,10 @@ export interface PlaybackKeyPairSummary {
      */
     name?: string;
     /**
-     * <p>Array of 1-50 maps, each of the form <code>string:string (key:value)</code>.</p>
+     * <p>Array of 1-50 maps, each of the form <code>string:string (key:value)</code>. 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 and "Tag naming limits and
+     *       requirements"; Amazon IVS has no service-specific constraints beyond what is documented
+     *       there.</p>
      */
     tags?: Record<string, string>;
 }
@@ -871,7 +909,8 @@ export interface ListRecordingConfigurationsRequest {
      */
     nextToken?: string;
     /**
-     * <p>Maximum number of recording configurations to return. Default: 50. </p>
+     * <p>Maximum number of recording configurations to return. Default: your service quota or 100,
+     *       whichever is smaller. </p>
      */
     maxResults?: number;
 }
@@ -897,7 +936,10 @@ export interface RecordingConfigurationSummary {
      */
     state: RecordingConfigurationState | string | undefined;
     /**
-     * <p>Array of 1-50 maps, each of the form <code>string:string (key:value)</code>.</p>
+     * <p>Array of 1-50 maps, each of the form <code>string:string (key:value)</code>. 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 and "Tag naming limits and
+     *       requirements"; Amazon IVS has no service-specific constraints beyond what is documented
+     *       there.</p>
      */
     tags?: Record<string, string>;
 }
@@ -923,7 +965,7 @@ export interface ListStreamKeysRequest {
      */
     nextToken?: string;
     /**
-     * <p>Maximum number of streamKeys to return. Default: 50.</p>
+     * <p>Maximum number of streamKeys to return. Default: 1.</p>
      */
     maxResults?: number;
 }
@@ -940,7 +982,10 @@ export interface StreamKeySummary {
      */
     channelArn?: string;
     /**
-     * <p>Array of 1-50 maps, each of the form <code>string:string (key:value)</code>.</p>
+     * <p>Array of 1-50 maps, each of the form <code>string:string (key:value)</code>. 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 and "Tag naming limits and
+     *       requirements"; Amazon IVS has no service-specific constraints beyond what is documented
+     *       there.</p>
      */
     tags?: Record<string, string>;
 }
@@ -975,7 +1020,7 @@ export interface ListStreamsRequest {
      */
     nextToken?: string;
     /**
-     * <p>Maximum number of streams to return. Default: 50.</p>
+     * <p>Maximum number of streams to return. Default: 100.</p>
      */
     maxResults?: number;
 }
@@ -1007,7 +1052,8 @@ export interface StreamSummary {
      */
     viewerCount?: number;
     /**
-     * <p>Time of the stream’s start. This is an ISO 8601 timestamp returned as a string.</p>
+     * <p>Time of the stream’s start. This is an ISO 8601 timestamp; <i>note that this is
+     *         returned as a string</i>. </p>
      */
     startTime?: Date;
 }
@@ -1033,7 +1079,7 @@ export interface ListStreamSessionsRequest {
      */
     nextToken?: string;
     /**
-     * <p>Maximum number of streams to return. Default: 50.</p>
+     * <p>Maximum number of streams to return. Default: 100.</p>
      */
     maxResults?: number;
 }
@@ -1046,12 +1092,13 @@ export interface StreamSessionSummary {
      */
     streamId?: string;
     /**
-     * <p>UTC ISO-8601 formatted timestamp of when the channel went live.</p>
+     * <p>Time when the channel went live. This is an ISO 8601 timestamp; <i>note that this
+     *         is returned as a string</i>.</p>
      */
     startTime?: Date;
     /**
-     * <p>UTC ISO-8601 formatted timestamp of when the channel went offline. For live streams, this
-     *       is <code>NULL</code>.</p>
+     * <p>Time when the channel went offline. This is an ISO 8601 timestamp; <i>note that
+     *         this is returned as a string</i>. For live streams, this is <code>NULL</code>.</p>
      */
     endTime?: Date;
     /**
@@ -1072,7 +1119,7 @@ export interface ListStreamSessionsResponse {
 }
 export interface ListTagsForResourceRequest {
     /**
-     * <p>The ARN of the resource to be retrieved.</p>
+     * <p>The ARN of the resource to be retrieved. The ARN must be URL-encoded.</p>
      */
     resourceArn: string | undefined;
 }
@@ -1133,11 +1180,15 @@ export declare class StreamUnavailable extends __BaseException {
 }
 export interface TagResourceRequest {
     /**
-     * <p>ARN of the resource for which tags are to be added or updated.</p>
+     * <p>ARN of the resource for which tags are to be added or updated. The ARN must be
+     *       URL-encoded.</p>
      */
     resourceArn: string | undefined;
     /**
-     * <p>Array of tags to be added or updated.</p>
+     * <p>Array of tags to be added or updated. 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 and "Tag naming limits and
+     *       requirements"; Amazon IVS has no service-specific constraints beyond what is documented
+     *       there.</p>
      */
     tags: Record<string, string> | undefined;
 }
@@ -1145,11 +1196,14 @@ export interface TagResourceResponse {
 }
 export interface UntagResourceRequest {
     /**
-     * <p>ARN of the resource for which tags are to be removed.</p>
+     * <p>ARN of the resource for which tags are to be removed. The ARN must be URL-encoded.</p>
      */
     resourceArn: string | undefined;
     /**
-     * <p>Array of tags to be removed.</p>
+     * <p>Array of tags to be removed. 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 and "Tag naming limits and
+     *       requirements"; Amazon IVS has no service-specific constraints beyond what is documented
+     *       there.</p>
      */
     tagKeys: string[] | undefined;
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-ivs",
   "description": "AWS SDK for JavaScript Ivs Client for Node.js, Browser and React Native",
-  "version": "3.145.0",
+  "version": "3.154.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -18,9 +18,9 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "2.0.0",
     "@aws-crypto/sha256-js": "2.0.0",
-    "@aws-sdk/client-sts": "3.145.0",
+    "@aws-sdk/client-sts": "3.154.0",
     "@aws-sdk/config-resolver": "3.130.0",
-    "@aws-sdk/credential-provider-node": "3.145.0",
+    "@aws-sdk/credential-provider-node": "3.154.0",
     "@aws-sdk/fetch-http-handler": "3.131.0",
     "@aws-sdk/hash-node": "3.127.0",
     "@aws-sdk/invalid-dependency": "3.127.0",
@@ -41,7 +41,7 @@
     "@aws-sdk/url-parser": "3.127.0",
     "@aws-sdk/util-base64-browser": "3.109.0",
     "@aws-sdk/util-base64-node": "3.55.0",
-    "@aws-sdk/util-body-length-browser": "3.55.0",
+    "@aws-sdk/util-body-length-browser": "3.154.0",
     "@aws-sdk/util-body-length-node": "3.55.0",
     "@aws-sdk/util-defaults-mode-browser": "3.142.0",
     "@aws-sdk/util-defaults-mode-node": "3.142.0",