@aws-sdk/client-ivs 3.35.0 → 3.38.0

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

@@ -1,4 +1,7 @@
 import { MetadataBearer as $MetadataBearer, SmithyException as __SmithyException } from "@aws-sdk/types";
+/**
+ * <p/>
+ */
 export interface AccessDeniedException extends __SmithyException, $MetadataBearer {
     name: "AccessDeniedException";
     $fault: "client";
@@ -47,8 +50,9 @@ export interface Channel {
     name?: string;
     /**
      * <p>Channel latency mode. Use <code>NORMAL</code> to broadcast and deliver live video up to
-     *       Full HD. Use <code>LOW</code> for near-real-time interaction with viewers. Default: <code>LOW</code>. (Note: In the Amazon IVS console, <code>LOW</code> and
-     *       <code>NORMAL</code> correspond to Ultra-low and Standard, respectively.)</p>
+     *       Full HD. Use <code>LOW</code> for near-real-time interaction with viewers. Default:
+     *         <code>LOW</code>. (Note: In the Amazon IVS console, <code>LOW</code> and <code>NORMAL</code>
+     *       correspond to Ultra-low and Standard, respectively.)</p>
      */
     latencyMode?: ChannelLatencyMode | string;
     /**
@@ -60,13 +64,14 @@ export interface Channel {
      *                <p>
      *                   <code>STANDARD</code>: 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.</p>
+     *           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.</p>
      *             </li>
      *             <li>
      *                <p>
      *                   <code>BASIC</code>: 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.</p>
+     *           video-quality choice is limited to the original input. Resolution can be up to 480p and
+     *           bitrate can be up to 1.5 Mbps.</p>
      *             </li>
      *          </ul>
      */
@@ -127,6 +132,9 @@ export declare namespace BatchError {
     const filterSensitiveLog: (obj: BatchError) => any;
 }
 export interface BatchGetChannelResponse {
+    /**
+     * <p/>
+     */
     channels?: Channel[];
     /**
      * <p>Each error object is related to a specific ARN in the request.</p>
@@ -181,7 +189,13 @@ export declare namespace StreamKey {
     const filterSensitiveLog: (obj: StreamKey) => any;
 }
 export interface BatchGetStreamKeyResponse {
+    /**
+     * <p/>
+     */
     streamKeys?: StreamKey[];
+    /**
+     * <p/>
+     */
     errors?: BatchError[];
 }
 export declare namespace BatchGetStreamKeyResponse {
@@ -198,8 +212,8 @@ export interface CreateChannelRequest {
     /**
      * <p>Channel latency mode. Use <code>NORMAL</code> to broadcast and deliver live video up to
      *       Full HD. Use <code>LOW</code> for near-real-time interaction with viewers. (Note: In the
-     *       Amazon IVS console, <code>LOW</code> and <code>NORMAL</code> correspond to Ultra-low and Standard, respectively.)
-     *       Default: <code>LOW</code>.</p>
+     *       Amazon IVS console, <code>LOW</code> and <code>NORMAL</code> correspond to Ultra-low and Standard,
+     *       respectively.) Default: <code>LOW</code>.</p>
      */
     latencyMode?: ChannelLatencyMode | string;
     /**
@@ -211,13 +225,14 @@ export interface CreateChannelRequest {
      *                <p>
      *                   <code>STANDARD</code>: 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.</p>
+     *           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.</p>
      *             </li>
      *             <li>
      *                <p>
      *                   <code>BASIC</code>: 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.</p>
+     *           video-quality choice is limited to the original input. Resolution can be up to 480p and
+     *           bitrate can be up to 1.5 Mbps.</p>
      *             </li>
      *          </ul>
      */
@@ -246,11 +261,11 @@ export declare namespace CreateChannelRequest {
 }
 export interface CreateChannelResponse {
     /**
-     * <p>Object specifying a channel.</p>
+     * <p/>
      */
     channel?: Channel;
     /**
-     * <p>Object specifying a stream key.</p>
+     * <p/>
      */
     streamKey?: StreamKey;
 }
@@ -260,6 +275,9 @@ export declare namespace CreateChannelResponse {
      */
     const filterSensitiveLog: (obj: CreateChannelResponse) => any;
 }
+/**
+ * <p/>
+ */
 export interface PendingVerification extends __SmithyException, $MetadataBearer {
     name: "PendingVerification";
     $fault: "client";
@@ -274,6 +292,9 @@ export declare namespace PendingVerification {
      */
     const filterSensitiveLog: (obj: PendingVerification) => any;
 }
+/**
+ * <p/>
+ */
 export interface ResourceNotFoundException extends __SmithyException, $MetadataBearer {
     name: "ResourceNotFoundException";
     $fault: "client";
@@ -288,6 +309,9 @@ export declare namespace ResourceNotFoundException {
      */
     const filterSensitiveLog: (obj: ResourceNotFoundException) => any;
 }
+/**
+ * <p/>
+ */
 export interface ServiceQuotaExceededException extends __SmithyException, $MetadataBearer {
     name: "ServiceQuotaExceededException";
     $fault: "client";
@@ -302,11 +326,14 @@ export declare namespace ServiceQuotaExceededException {
      */
     const filterSensitiveLog: (obj: ServiceQuotaExceededException) => any;
 }
+/**
+ * <p/>
+ */
 export interface ValidationException extends __SmithyException, $MetadataBearer {
     name: "ValidationException";
     $fault: "client";
     /**
-     * <p>The input fails to satisfy the constraints specified by an AWS service.</p>
+     * <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
      */
     exceptionMessage?: string;
 }
@@ -316,6 +343,9 @@ export declare namespace ValidationException {
      */
     const filterSensitiveLog: (obj: ValidationException) => any;
 }
+/**
+ * <p/>
+ */
 export interface ConflictException extends __SmithyException, $MetadataBearer {
     name: "ConflictException";
     $fault: "client";
@@ -364,8 +394,7 @@ export declare namespace DestinationConfiguration {
 }
 export interface CreateRecordingConfigurationRequest {
     /**
-     * <p>An arbitrary string (a nickname) that helps the customer identify that resource. The value
-     *       does not need to be unique.</p>
+     * <p>Recording-configuration name. The value does not need to be unique.</p>
      */
     name?: string;
     /**
@@ -400,8 +429,7 @@ export interface RecordingConfiguration {
      */
     arn: string | undefined;
     /**
-     * <p>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.</p>
+     * <p>Recording-configuration name. The value does not need to be unique.</p>
      */
     name?: string;
     /**
@@ -428,7 +456,7 @@ export declare namespace RecordingConfiguration {
 }
 export interface CreateRecordingConfigurationResponse {
     /**
-     * <p>An object representing a configuration to record a channel stream.</p>
+     *
      */
     recordingConfiguration?: RecordingConfiguration;
 }
@@ -438,6 +466,9 @@ export declare namespace CreateRecordingConfigurationResponse {
      */
     const filterSensitiveLog: (obj: CreateRecordingConfigurationResponse) => any;
 }
+/**
+ * <p/>
+ */
 export interface InternalServerException extends __SmithyException, $MetadataBearer {
     name: "InternalServerException";
     $fault: "server";
@@ -552,7 +583,7 @@ export declare namespace GetChannelRequest {
 }
 export interface GetChannelResponse {
     /**
-     * <p>Object specifying a channel.</p>
+     * <p/>
      */
     channel?: Channel;
 }
@@ -583,8 +614,7 @@ export interface PlaybackKeyPair {
      */
     arn?: string;
     /**
-     * <p>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.</p>
+     * <p>Playback-key-pair name. The value does not need to be unique.</p>
      */
     name?: string;
     /**
@@ -606,7 +636,7 @@ export declare namespace PlaybackKeyPair {
 }
 export interface GetPlaybackKeyPairResponse {
     /**
-     * <p>A key pair used to sign and validate a playback authorization token.</p>
+     *
      */
     keyPair?: PlaybackKeyPair;
 }
@@ -630,7 +660,7 @@ export declare namespace GetRecordingConfigurationRequest {
 }
 export interface GetRecordingConfigurationResponse {
     /**
-     * <p>An object representing a configuration to record a channel stream.</p>
+     *
      */
     recordingConfiguration?: RecordingConfiguration;
 }
@@ -640,6 +670,9 @@ export declare namespace GetRecordingConfigurationResponse {
      */
     const filterSensitiveLog: (obj: GetRecordingConfigurationResponse) => any;
 }
+/**
+ * <p/>
+ */
 export interface ChannelNotBroadcasting extends __SmithyException, $MetadataBearer {
     name: "ChannelNotBroadcasting";
     $fault: "client";
@@ -688,7 +721,7 @@ export interface _Stream {
      */
     playbackUrl?: string;
     /**
-     * <p>ISO-8601 formatted timestamp of the stream’s start.</p>
+     * <p>Time of the stream’s start. This is an ISO 8601 timestamp returned as a string.</p>
      */
     startTime?: Date;
     /**
@@ -700,8 +733,10 @@ export interface _Stream {
      */
     health?: StreamHealth | string;
     /**
-     * <p>Number of current viewers of the stream. A value of -1 indicates that the request timed
-     *       out; in this case, retry.</p>
+     * <p>A count of concurrent views of the stream. Typically, a new view appears in
+     *         <code>viewerCount</code> within 15 seconds of when video playback starts and a view is
+     *       removed from <code>viewerCount</code> within 1 minute of when video playback ends. A value of
+     *       -1 indicates that the request timed out; in this case, retry.</p>
      */
     viewerCount?: number;
 }
@@ -713,7 +748,7 @@ export declare namespace _Stream {
 }
 export interface GetStreamResponse {
     /**
-     * <p>Specifies a live video stream that has been ingested and distributed.</p>
+     * <p/>
      */
     stream?: _Stream;
 }
@@ -737,7 +772,7 @@ export declare namespace GetStreamKeyRequest {
 }
 export interface GetStreamKeyResponse {
     /**
-     * <p>Object specifying a stream key.</p>
+     *
      */
     streamKey?: StreamKey;
 }
@@ -753,8 +788,7 @@ export interface ImportPlaybackKeyPairRequest {
      */
     publicKeyMaterial: string | undefined;
     /**
-     * <p>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.</p>
+     * <p>Playback-key-pair name. The value does not need to be unique.</p>
      */
     name?: string;
     /**
@@ -772,7 +806,7 @@ export declare namespace ImportPlaybackKeyPairRequest {
 }
 export interface ImportPlaybackKeyPairResponse {
     /**
-     * <p>A key pair used to sign and validate a playback authorization token.</p>
+     * <p/>
      */
     keyPair?: PlaybackKeyPair;
 }
@@ -820,13 +854,15 @@ export interface ChannelSummary {
      */
     name?: string;
     /**
-     * <p>Channel latency mode. Use <code>NORMAL</code> to broadcast and deliver live video up to Full HD. Use
-     *       <code>LOW</code> for near-real-time interaction with viewers. Default: <code>LOW</code>. (Note: In the Amazon IVS
-     *       console, <code>LOW</code> and <code>NORMAL</code> correspond to Ultra-low and Standard, respectively.)</p>
+     * <p>Channel latency mode. Use <code>NORMAL</code> to broadcast and deliver live video up to
+     *       Full HD. Use <code>LOW</code> for near-real-time interaction with viewers. Default:
+     *         <code>LOW</code>. (Note: In the Amazon IVS console, <code>LOW</code> and <code>NORMAL</code>
+     *       correspond to Ultra-low and Standard, respectively.)</p>
      */
     latencyMode?: ChannelLatencyMode | string;
     /**
-     * <p>Whether the channel is private (enabled for playback authorization). Default: <code>false</code>.</p>
+     * <p>Whether the channel is private (enabled for playback authorization). Default:
+     *         <code>false</code>.</p>
      */
     authorized?: boolean;
     /**
@@ -890,8 +926,7 @@ export interface PlaybackKeyPairSummary {
      */
     arn?: string;
     /**
-     * <p>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.</p>
+     * <p>Playback-key-pair name. The value does not need to be unique.</p>
      */
     name?: string;
     /**
@@ -950,8 +985,7 @@ export interface RecordingConfigurationSummary {
      */
     arn: string | undefined;
     /**
-     * <p>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.</p>
+     * <p>Recording-configuration name. The value does not need to be unique.</p>
      */
     name?: string;
     /**
@@ -960,7 +994,7 @@ export interface RecordingConfigurationSummary {
     destinationConfiguration: DestinationConfiguration | undefined;
     /**
      * <p>Indicates the current state of the recording configuration. When the state is
-     *       <code>ACTIVE</code>, the configuration is ready for recording a channel stream.</p>
+     *         <code>ACTIVE</code>, the configuration is ready for recording a channel stream.</p>
      */
     state: RecordingConfigurationState | string | undefined;
     /**
@@ -1090,12 +1124,14 @@ export interface StreamSummary {
      */
     health?: StreamHealth | string;
     /**
-     * <p>Number of current viewers of the stream. A value of -1 indicates that the request timed
-     *       out; in this case, retry.</p>
+     * <p>A count of concurrent views of the stream. Typically, a new view appears in
+     *         <code>viewerCount</code> within 15 seconds of when video playback starts and a view is
+     *       removed from <code>viewerCount</code> within 1 minute of when video playback ends. A value of
+     *       -1 indicates that the request timed out; in this case, retry.</p>
      */
     viewerCount?: number;
     /**
-     * <p>ISO-8601 formatted timestamp of the stream’s start.</p>
+     * <p>Time of the stream’s start. This is an ISO 8601 timestamp returned as a string.</p>
      */
     startTime?: Date;
 }
@@ -1127,15 +1163,6 @@ export interface ListTagsForResourceRequest {
      * <p>The ARN of the resource to be retrieved.</p>
      */
     resourceArn: string | undefined;
-    /**
-     * <p>The first tag to retrieve. This is used for pagination; see the <code>nextToken</code>
-     *       response field.</p>
-     */
-    nextToken?: string;
-    /**
-     * <p>Maximum number of tags to return. Default: 50.</p>
-     */
-    maxResults?: number;
 }
 export declare namespace ListTagsForResourceRequest {
     /**
@@ -1144,14 +1171,12 @@ export declare namespace ListTagsForResourceRequest {
     const filterSensitiveLog: (obj: ListTagsForResourceRequest) => any;
 }
 export interface ListTagsForResourceResponse {
+    /**
+     * <p/>
+     */
     tags: {
         [key: string]: string;
     } | undefined;
-    /**
-     * <p>If there are more tags than <code>maxResults</code>, use <code>nextToken</code> in the
-     *       request to get the next set.</p>
-     */
-    nextToken?: string;
 }
 export declare namespace ListTagsForResourceResponse {
     /**
@@ -1176,6 +1201,9 @@ export declare namespace PutMetadataRequest {
      */
     const filterSensitiveLog: (obj: PutMetadataRequest) => any;
 }
+/**
+ * <p/>
+ */
 export interface ThrottlingException extends __SmithyException, $MetadataBearer {
     name: "ThrottlingException";
     $fault: "client";
@@ -1210,6 +1238,9 @@ export declare namespace StopStreamResponse {
      */
     const filterSensitiveLog: (obj: StopStreamResponse) => any;
 }
+/**
+ * <p/>
+ */
 export interface StreamUnavailable extends __SmithyException, $MetadataBearer {
     name: "StreamUnavailable";
     $fault: "server";
@@ -1299,13 +1330,14 @@ export interface UpdateChannelRequest {
      *                <p>
      *                   <code>STANDARD</code>: 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.</p>
+     *           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.</p>
      *             </li>
      *             <li>
      *                <p>
      *                   <code>BASIC</code>: 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.</p>
+     *           video-quality choice is limited to the original input. Resolution can be up to 480p and
+     *           bitrate can be up to 1.5 Mbps.</p>
      *             </li>
      *          </ul>
      */

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

@@ -0,0 +1,6 @@
+export * from "./Interfaces";
+export * from "./ListChannelsPaginator";
+export * from "./ListPlaybackKeyPairsPaginator";
+export * from "./ListRecordingConfigurationsPaginator";
+export * from "./ListStreamKeysPaginator";
+export * from "./ListStreamsPaginator";