@aws-sdk/client-ivs 3.296.0 → 3.297.0

package/dist-types/Ivs.d.ts

@@ -29,6 +29,7 @@ import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./command
 import { UpdateChannelCommandInput, UpdateChannelCommandOutput } from "./commands/UpdateChannelCommand";
 import { IvsClient } from "./IvsClient";
 /**
+ * @public
  * <p>
  *             <b>Introduction</b>
  *          </p>
@@ -355,24 +356,28 @@ import { IvsClient } from "./IvsClient";
  */
 export declare class Ivs extends IvsClient {
     /**
+     * @public
      * <p>Performs <a>GetChannel</a> on multiple ARNs simultaneously.</p>
      */
     batchGetChannel(args: BatchGetChannelCommandInput, options?: __HttpHandlerOptions): Promise<BatchGetChannelCommandOutput>;
     batchGetChannel(args: BatchGetChannelCommandInput, cb: (err: any, data?: BatchGetChannelCommandOutput) => void): void;
     batchGetChannel(args: BatchGetChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetChannelCommandOutput) => void): void;
     /**
+     * @public
      * <p>Performs <a>GetStreamKey</a> on multiple ARNs simultaneously.</p>
      */
     batchGetStreamKey(args: BatchGetStreamKeyCommandInput, options?: __HttpHandlerOptions): Promise<BatchGetStreamKeyCommandOutput>;
     batchGetStreamKey(args: BatchGetStreamKeyCommandInput, cb: (err: any, data?: BatchGetStreamKeyCommandOutput) => void): void;
     batchGetStreamKey(args: BatchGetStreamKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetStreamKeyCommandOutput) => void): void;
     /**
+     * @public
      * <p>Creates a new channel and an associated stream key to start streaming.</p>
      */
     createChannel(args: CreateChannelCommandInput, options?: __HttpHandlerOptions): Promise<CreateChannelCommandOutput>;
     createChannel(args: CreateChannelCommandInput, cb: (err: any, data?: CreateChannelCommandOutput) => void): void;
     createChannel(args: CreateChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateChannelCommandOutput) => void): void;
     /**
+     * @public
      * <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
@@ -390,6 +395,7 @@ export declare class Ivs extends IvsClient {
     createRecordingConfiguration(args: CreateRecordingConfigurationCommandInput, cb: (err: any, data?: CreateRecordingConfigurationCommandOutput) => void): void;
     createRecordingConfiguration(args: CreateRecordingConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRecordingConfigurationCommandOutput) => void): void;
     /**
+     * @public
      * <p>Creates a stream key, used to initiate a stream, for the specified channel ARN.</p>
      *          <p>Note that <a>CreateChannel</a> creates a stream key. If you subsequently use
      *       CreateStreamKey on the same channel, it will fail because a stream key already exists and
@@ -399,6 +405,7 @@ export declare class Ivs extends IvsClient {
     createStreamKey(args: CreateStreamKeyCommandInput, cb: (err: any, data?: CreateStreamKeyCommandOutput) => void): void;
     createStreamKey(args: CreateStreamKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateStreamKeyCommandOutput) => void): void;
     /**
+     * @public
      * <p>Deletes the specified channel and its associated stream keys.</p>
      *          <p>If you try to delete a live channel, you will get an error (409 ConflictException). To
      *       delete a channel that is live, call <a>StopStream</a>, wait for the Amazon
@@ -409,6 +416,7 @@ export declare class Ivs extends IvsClient {
     deleteChannel(args: DeleteChannelCommandInput, cb: (err: any, data?: DeleteChannelCommandOutput) => void): void;
     deleteChannel(args: DeleteChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteChannelCommandOutput) => void): void;
     /**
+     * @public
      * <p>Deletes a specified authorization key pair. This invalidates future viewer tokens
      *       generated using the key pair’s <code>privateKey</code>. 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>
@@ -417,6 +425,7 @@ export declare class Ivs extends IvsClient {
     deletePlaybackKeyPair(args: DeletePlaybackKeyPairCommandInput, cb: (err: any, data?: DeletePlaybackKeyPairCommandOutput) => void): void;
     deletePlaybackKeyPair(args: DeletePlaybackKeyPairCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePlaybackKeyPairCommandOutput) => void): void;
     /**
+     * @public
      * <p>Deletes the recording configuration for the specified ARN.</p>
      *          <p>If you try to delete a recording configuration that is associated with a channel, you will
      *       get an error (409 ConflictException). To avoid this, for all channels that reference the
@@ -428,6 +437,7 @@ export declare class Ivs extends IvsClient {
     deleteRecordingConfiguration(args: DeleteRecordingConfigurationCommandInput, cb: (err: any, data?: DeleteRecordingConfigurationCommandOutput) => void): void;
     deleteRecordingConfiguration(args: DeleteRecordingConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRecordingConfigurationCommandOutput) => void): void;
     /**
+     * @public
      * <p>Deletes the stream key for the specified ARN, so it can no longer be used to
      *       stream.</p>
      */
@@ -435,12 +445,14 @@ export declare class Ivs extends IvsClient {
     deleteStreamKey(args: DeleteStreamKeyCommandInput, cb: (err: any, data?: DeleteStreamKeyCommandOutput) => void): void;
     deleteStreamKey(args: DeleteStreamKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteStreamKeyCommandOutput) => void): void;
     /**
+     * @public
      * <p>Gets the channel configuration for the specified channel ARN. See also <a>BatchGetChannel</a>.</p>
      */
     getChannel(args: GetChannelCommandInput, options?: __HttpHandlerOptions): Promise<GetChannelCommandOutput>;
     getChannel(args: GetChannelCommandInput, cb: (err: any, data?: GetChannelCommandOutput) => void): void;
     getChannel(args: GetChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetChannelCommandOutput) => void): void;
     /**
+     * @public
      * <p>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. For more
@@ -451,30 +463,35 @@ export declare class Ivs extends IvsClient {
     getPlaybackKeyPair(args: GetPlaybackKeyPairCommandInput, cb: (err: any, data?: GetPlaybackKeyPairCommandOutput) => void): void;
     getPlaybackKeyPair(args: GetPlaybackKeyPairCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPlaybackKeyPairCommandOutput) => void): void;
     /**
+     * @public
      * <p>Gets the recording configuration for the specified ARN.</p>
      */
     getRecordingConfiguration(args: GetRecordingConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<GetRecordingConfigurationCommandOutput>;
     getRecordingConfiguration(args: GetRecordingConfigurationCommandInput, cb: (err: any, data?: GetRecordingConfigurationCommandOutput) => void): void;
     getRecordingConfiguration(args: GetRecordingConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRecordingConfigurationCommandOutput) => void): void;
     /**
+     * @public
      * <p>Gets information about the active (live) stream on a specified channel.</p>
      */
     getStream(args: GetStreamCommandInput, options?: __HttpHandlerOptions): Promise<GetStreamCommandOutput>;
     getStream(args: GetStreamCommandInput, cb: (err: any, data?: GetStreamCommandOutput) => void): void;
     getStream(args: GetStreamCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetStreamCommandOutput) => void): void;
     /**
+     * @public
      * <p>Gets stream-key information for a specified ARN.</p>
      */
     getStreamKey(args: GetStreamKeyCommandInput, options?: __HttpHandlerOptions): Promise<GetStreamKeyCommandOutput>;
     getStreamKey(args: GetStreamKeyCommandInput, cb: (err: any, data?: GetStreamKeyCommandOutput) => void): void;
     getStreamKey(args: GetStreamKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetStreamKeyCommandOutput) => void): void;
     /**
+     * @public
      * <p>Gets metadata on a specified stream.</p>
      */
     getStreamSession(args: GetStreamSessionCommandInput, options?: __HttpHandlerOptions): Promise<GetStreamSessionCommandOutput>;
     getStreamSession(args: GetStreamSessionCommandInput, cb: (err: any, data?: GetStreamSessionCommandOutput) => void): void;
     getStreamSession(args: GetStreamSessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetStreamSessionCommandOutput) => void): void;
     /**
+     * @public
      * <p>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. For more information, see
@@ -485,6 +502,7 @@ export declare class Ivs extends IvsClient {
     importPlaybackKeyPair(args: ImportPlaybackKeyPairCommandInput, cb: (err: any, data?: ImportPlaybackKeyPairCommandOutput) => void): void;
     importPlaybackKeyPair(args: ImportPlaybackKeyPairCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ImportPlaybackKeyPairCommandOutput) => void): void;
     /**
+     * @public
      * <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
@@ -494,6 +512,7 @@ export declare class Ivs extends IvsClient {
     listChannels(args: ListChannelsCommandInput, cb: (err: any, data?: ListChannelsCommandOutput) => void): void;
     listChannels(args: ListChannelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListChannelsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Gets summary information about playback key pairs. 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>
      */
@@ -501,6 +520,7 @@ export declare class Ivs extends IvsClient {
     listPlaybackKeyPairs(args: ListPlaybackKeyPairsCommandInput, cb: (err: any, data?: ListPlaybackKeyPairsCommandOutput) => void): void;
     listPlaybackKeyPairs(args: ListPlaybackKeyPairsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPlaybackKeyPairsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Gets summary information about all recording configurations in your account, in the
      *         Amazon Web Services region where the API request is processed.</p>
      */
@@ -508,12 +528,14 @@ export declare class Ivs extends IvsClient {
     listRecordingConfigurations(args: ListRecordingConfigurationsCommandInput, cb: (err: any, data?: ListRecordingConfigurationsCommandOutput) => void): void;
     listRecordingConfigurations(args: ListRecordingConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRecordingConfigurationsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Gets summary information about stream keys for the specified channel.</p>
      */
     listStreamKeys(args: ListStreamKeysCommandInput, options?: __HttpHandlerOptions): Promise<ListStreamKeysCommandOutput>;
     listStreamKeys(args: ListStreamKeysCommandInput, cb: (err: any, data?: ListStreamKeysCommandOutput) => void): void;
     listStreamKeys(args: ListStreamKeysCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListStreamKeysCommandOutput) => void): void;
     /**
+     * @public
      * <p>Gets summary information about live streams in your account, in the Amazon Web Services
      *       region where the API request is processed.</p>
      */
@@ -521,6 +543,7 @@ export declare class Ivs extends IvsClient {
     listStreams(args: ListStreamsCommandInput, cb: (err: any, data?: ListStreamsCommandOutput) => void): void;
     listStreams(args: ListStreamsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListStreamsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Gets a summary of current and previous streams for a specified channel in your account, in
      *       the AWS region where the API request is processed.</p>
      */
@@ -528,12 +551,14 @@ export declare class Ivs extends IvsClient {
     listStreamSessions(args: ListStreamSessionsCommandInput, cb: (err: any, data?: ListStreamSessionsCommandOutput) => void): void;
     listStreamSessions(args: ListStreamSessionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListStreamSessionsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Gets information about Amazon Web Services tags for the specified ARN.</p>
      */
     listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
     listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
     listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
     /**
+     * @public
      * <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
@@ -544,6 +569,7 @@ export declare class Ivs extends IvsClient {
     putMetadata(args: PutMetadataCommandInput, cb: (err: any, data?: PutMetadataCommandOutput) => void): void;
     putMetadata(args: PutMetadataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutMetadataCommandOutput) => void): void;
     /**
+     * @public
      * <p>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>
@@ -557,18 +583,21 @@ export declare class Ivs extends IvsClient {
     stopStream(args: StopStreamCommandInput, cb: (err: any, data?: StopStreamCommandOutput) => void): void;
     stopStream(args: StopStreamCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopStreamCommandOutput) => void): void;
     /**
+     * @public
      * <p>Adds or updates tags for the Amazon Web Services resource with the specified ARN.</p>
      */
     tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
     tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
     tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
     /**
+     * @public
      * <p>Removes tags from the resource with the specified ARN.</p>
      */
     untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
     untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
     untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
     /**
+     * @public
      * <p>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>
      */

package/dist-types/IvsClient.d.ts

@@ -36,15 +36,24 @@ import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/Ta
 import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
 import { UpdateChannelCommandInput, UpdateChannelCommandOutput } from "./commands/UpdateChannelCommand";
 import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
+/**
+ * @public
+ */
 export type ServiceInputTypes = BatchGetChannelCommandInput | BatchGetStreamKeyCommandInput | CreateChannelCommandInput | CreateRecordingConfigurationCommandInput | CreateStreamKeyCommandInput | DeleteChannelCommandInput | DeletePlaybackKeyPairCommandInput | DeleteRecordingConfigurationCommandInput | DeleteStreamKeyCommandInput | GetChannelCommandInput | GetPlaybackKeyPairCommandInput | GetRecordingConfigurationCommandInput | GetStreamCommandInput | GetStreamKeyCommandInput | GetStreamSessionCommandInput | ImportPlaybackKeyPairCommandInput | ListChannelsCommandInput | ListPlaybackKeyPairsCommandInput | ListRecordingConfigurationsCommandInput | ListStreamKeysCommandInput | ListStreamSessionsCommandInput | ListStreamsCommandInput | ListTagsForResourceCommandInput | PutMetadataCommandInput | StopStreamCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateChannelCommandInput;
+/**
+ * @public
+ */
 export type ServiceOutputTypes = BatchGetChannelCommandOutput | BatchGetStreamKeyCommandOutput | CreateChannelCommandOutput | CreateRecordingConfigurationCommandOutput | CreateStreamKeyCommandOutput | DeleteChannelCommandOutput | DeletePlaybackKeyPairCommandOutput | DeleteRecordingConfigurationCommandOutput | DeleteStreamKeyCommandOutput | GetChannelCommandOutput | GetPlaybackKeyPairCommandOutput | GetRecordingConfigurationCommandOutput | GetStreamCommandOutput | GetStreamKeyCommandOutput | GetStreamSessionCommandOutput | ImportPlaybackKeyPairCommandOutput | ListChannelsCommandOutput | ListPlaybackKeyPairsCommandOutput | ListRecordingConfigurationsCommandOutput | ListStreamKeysCommandOutput | ListStreamSessionsCommandOutput | ListStreamsCommandOutput | ListTagsForResourceCommandOutput | PutMetadataCommandOutput | StopStreamCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateChannelCommandOutput;
+/**
+ * @public
+ */
 export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
     /**
      * The HTTP handler to use. Fetch in browser and Https in Nodejs.
      */
     requestHandler?: __HttpHandler;
     /**
-     * A constructor for a class implementing the {@link __Checksum} interface
+     * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
      * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
      * @internal
      */
@@ -134,23 +143,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
      */
     logger?: __Logger;
     /**
-     * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
+     * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
      */
     defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
 }
+/**
+ * @public
+ */
 type IvsClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
 /**
- * The configuration interface of IvsClient class constructor that set the region, credentials and other options.
+ * @public
+ *
+ *  The configuration interface of IvsClient class constructor that set the region, credentials and other options.
  */
 export interface IvsClientConfig extends IvsClientConfigType {
 }
+/**
+ * @public
+ */
 type IvsClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
 /**
- * The resolved configuration interface of IvsClient class. This is resolved and normalized from the {@link IvsClientConfig | constructor configuration interface}.
+ * @public
+ *
+ *  The resolved configuration interface of IvsClient class. This is resolved and normalized from the {@link IvsClientConfig | constructor configuration interface}.
  */
 export interface IvsClientResolvedConfig extends IvsClientResolvedConfigType {
 }
 /**
+ * @public
  * <p>
  *             <b>Introduction</b>
  *          </p>

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { IvsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IvsClient";
 import { BatchGetChannelRequest, BatchGetChannelResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link BatchGetChannelCommand}.
  */
 export interface BatchGetChannelCommandInput extends BatchGetChannelRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link BatchGetChannelCommand}.
  */
 export interface BatchGetChannelCommandOutput extends BatchGetChannelResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Performs <a>GetChannel</a> on multiple ARNs simultaneously.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface BatchGetChannelCommandOutput extends BatchGetChannelResponse, _
  * const response = await client.send(command);
  * ```
  *
+ * @param BatchGetChannelCommandInput - {@link BatchGetChannelCommandInput}
+ * @returns {@link BatchGetChannelCommandOutput}
  * @see {@link BatchGetChannelCommandInput} for command's `input` shape.
  * @see {@link BatchGetChannelCommandOutput} for command's `response` shape.
  * @see {@link IvsClientResolvedConfig | config} for IvsClient's `config` shape.
@@ -34,11 +41,20 @@ export interface BatchGetChannelCommandOutput extends BatchGetChannelResponse, _
 export declare class BatchGetChannelCommand extends $Command<BatchGetChannelCommandInput, BatchGetChannelCommandOutput, IvsClientResolvedConfig> {
     readonly input: BatchGetChannelCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: BatchGetChannelCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IvsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<BatchGetChannelCommandInput, BatchGetChannelCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { IvsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IvsClient";
 import { BatchGetStreamKeyRequest, BatchGetStreamKeyResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link BatchGetStreamKeyCommand}.
  */
 export interface BatchGetStreamKeyCommandInput extends BatchGetStreamKeyRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link BatchGetStreamKeyCommand}.
  */
 export interface BatchGetStreamKeyCommandOutput extends BatchGetStreamKeyResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Performs <a>GetStreamKey</a> on multiple ARNs simultaneously.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface BatchGetStreamKeyCommandOutput extends BatchGetStreamKeyRespons
  * const response = await client.send(command);
  * ```
  *
+ * @param BatchGetStreamKeyCommandInput - {@link BatchGetStreamKeyCommandInput}
+ * @returns {@link BatchGetStreamKeyCommandOutput}
  * @see {@link BatchGetStreamKeyCommandInput} for command's `input` shape.
  * @see {@link BatchGetStreamKeyCommandOutput} for command's `response` shape.
  * @see {@link IvsClientResolvedConfig | config} for IvsClient's `config` shape.
@@ -34,11 +41,20 @@ export interface BatchGetStreamKeyCommandOutput extends BatchGetStreamKeyRespons
 export declare class BatchGetStreamKeyCommand extends $Command<BatchGetStreamKeyCommandInput, BatchGetStreamKeyCommandOutput, IvsClientResolvedConfig> {
     readonly input: BatchGetStreamKeyCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: BatchGetStreamKeyCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IvsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<BatchGetStreamKeyCommandInput, BatchGetStreamKeyCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { IvsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IvsClient";
 import { CreateChannelRequest, CreateChannelResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link CreateChannelCommand}.
  */
 export interface CreateChannelCommandInput extends CreateChannelRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link CreateChannelCommand}.
  */
 export interface CreateChannelCommandOutput extends CreateChannelResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Creates a new channel and an associated stream key to start streaming.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface CreateChannelCommandOutput extends CreateChannelResponse, __Met
  * const response = await client.send(command);
  * ```
  *
+ * @param CreateChannelCommandInput - {@link CreateChannelCommandInput}
+ * @returns {@link CreateChannelCommandOutput}
  * @see {@link CreateChannelCommandInput} for command's `input` shape.
  * @see {@link CreateChannelCommandOutput} for command's `response` shape.
  * @see {@link IvsClientResolvedConfig | config} for IvsClient's `config` shape.
@@ -49,11 +56,20 @@ export interface CreateChannelCommandOutput extends CreateChannelResponse, __Met
 export declare class CreateChannelCommand extends $Command<CreateChannelCommandInput, CreateChannelCommandOutput, IvsClientResolvedConfig> {
     readonly input: CreateChannelCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: CreateChannelCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IvsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateChannelCommandInput, CreateChannelCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { IvsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IvsClient";
 import { CreateRecordingConfigurationRequest, CreateRecordingConfigurationResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link CreateRecordingConfigurationCommand}.
  */
 export interface CreateRecordingConfigurationCommandInput extends CreateRecordingConfigurationRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link CreateRecordingConfigurationCommand}.
  */
 export interface CreateRecordingConfigurationCommandOutput extends CreateRecordingConfigurationResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <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
@@ -36,6 +41,8 @@ export interface CreateRecordingConfigurationCommandOutput extends CreateRecordi
  * const response = await client.send(command);
  * ```
  *
+ * @param CreateRecordingConfigurationCommandInput - {@link CreateRecordingConfigurationCommandInput}
+ * @returns {@link CreateRecordingConfigurationCommandOutput}
  * @see {@link CreateRecordingConfigurationCommandInput} for command's `input` shape.
  * @see {@link CreateRecordingConfigurationCommandOutput} for command's `response` shape.
  * @see {@link IvsClientResolvedConfig | config} for IvsClient's `config` shape.
@@ -63,11 +70,20 @@ export interface CreateRecordingConfigurationCommandOutput extends CreateRecordi
 export declare class CreateRecordingConfigurationCommand extends $Command<CreateRecordingConfigurationCommandInput, CreateRecordingConfigurationCommandOutput, IvsClientResolvedConfig> {
     readonly input: CreateRecordingConfigurationCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: CreateRecordingConfigurationCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IvsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateRecordingConfigurationCommandInput, CreateRecordingConfigurationCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { IvsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IvsClient";
 import { CreateStreamKeyRequest, CreateStreamKeyResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link CreateStreamKeyCommand}.
  */
 export interface CreateStreamKeyCommandInput extends CreateStreamKeyRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link CreateStreamKeyCommand}.
  */
 export interface CreateStreamKeyCommandOutput extends CreateStreamKeyResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Creates a stream key, used to initiate a stream, for the specified channel ARN.</p>
  *          <p>Note that <a>CreateChannel</a> creates a stream key. If you subsequently use
  *       CreateStreamKey on the same channel, it will fail because a stream key already exists and
@@ -28,6 +33,8 @@ export interface CreateStreamKeyCommandOutput extends CreateStreamKeyResponse, _
  * const response = await client.send(command);
  * ```
  *
+ * @param CreateStreamKeyCommandInput - {@link CreateStreamKeyCommandInput}
+ * @returns {@link CreateStreamKeyCommandOutput}
  * @see {@link CreateStreamKeyCommandInput} for command's `input` shape.
  * @see {@link CreateStreamKeyCommandOutput} for command's `response` shape.
  * @see {@link IvsClientResolvedConfig | config} for IvsClient's `config` shape.
@@ -52,11 +59,20 @@ export interface CreateStreamKeyCommandOutput extends CreateStreamKeyResponse, _
 export declare class CreateStreamKeyCommand extends $Command<CreateStreamKeyCommandInput, CreateStreamKeyCommandOutput, IvsClientResolvedConfig> {
     readonly input: CreateStreamKeyCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: CreateStreamKeyCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IvsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateStreamKeyCommandInput, CreateStreamKeyCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { IvsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IvsClient";
 import { DeleteChannelRequest } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link DeleteChannelCommand}.
  */
 export interface DeleteChannelCommandInput extends DeleteChannelRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link DeleteChannelCommand}.
  */
 export interface DeleteChannelCommandOutput extends __MetadataBearer {
 }
 /**
+ * @public
  * <p>Deletes the specified channel and its associated stream keys.</p>
  *          <p>If you try to delete a live channel, you will get an error (409 ConflictException). To
  *       delete a channel that is live, call <a>StopStream</a>, wait for the Amazon
@@ -29,6 +34,8 @@ export interface DeleteChannelCommandOutput extends __MetadataBearer {
  * const response = await client.send(command);
  * ```
  *
+ * @param DeleteChannelCommandInput - {@link DeleteChannelCommandInput}
+ * @returns {@link DeleteChannelCommandOutput}
  * @see {@link DeleteChannelCommandInput} for command's `input` shape.
  * @see {@link DeleteChannelCommandOutput} for command's `response` shape.
  * @see {@link IvsClientResolvedConfig | config} for IvsClient's `config` shape.
@@ -53,11 +60,20 @@ export interface DeleteChannelCommandOutput extends __MetadataBearer {
 export declare class DeleteChannelCommand extends $Command<DeleteChannelCommandInput, DeleteChannelCommandOutput, IvsClientResolvedConfig> {
     readonly input: DeleteChannelCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: DeleteChannelCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IvsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteChannelCommandInput, DeleteChannelCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { IvsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IvsClient";
 import { DeletePlaybackKeyPairRequest, DeletePlaybackKeyPairResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link DeletePlaybackKeyPairCommand}.
  */
 export interface DeletePlaybackKeyPairCommandInput extends DeletePlaybackKeyPairRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link DeletePlaybackKeyPairCommand}.
  */
 export interface DeletePlaybackKeyPairCommandOutput extends DeletePlaybackKeyPairResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Deletes a specified authorization key pair. This invalidates future viewer tokens
  *       generated using the key pair’s <code>privateKey</code>. 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>
@@ -27,6 +32,8 @@ export interface DeletePlaybackKeyPairCommandOutput extends DeletePlaybackKeyPai
  * const response = await client.send(command);
  * ```
  *
+ * @param DeletePlaybackKeyPairCommandInput - {@link DeletePlaybackKeyPairCommandInput}
+ * @returns {@link DeletePlaybackKeyPairCommandOutput}
  * @see {@link DeletePlaybackKeyPairCommandInput} for command's `input` shape.
  * @see {@link DeletePlaybackKeyPairCommandOutput} for command's `response` shape.
  * @see {@link IvsClientResolvedConfig | config} for IvsClient's `config` shape.
@@ -48,11 +55,20 @@ export interface DeletePlaybackKeyPairCommandOutput extends DeletePlaybackKeyPai
 export declare class DeletePlaybackKeyPairCommand extends $Command<DeletePlaybackKeyPairCommandInput, DeletePlaybackKeyPairCommandOutput, IvsClientResolvedConfig> {
     readonly input: DeletePlaybackKeyPairCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: DeletePlaybackKeyPairCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IvsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeletePlaybackKeyPairCommandInput, DeletePlaybackKeyPairCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }