@aws-sdk/client-ivs 3.36.0 → 3.36.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (75) hide show
  1. package/CHANGELOG.md +11 -0
  2. package/dist-cjs/Ivs.js +0 -362
  3. package/dist-cjs/IvsClient.js +0 -367
  4. package/dist-cjs/commands/BatchGetChannelCommand.js +0 -24
  5. package/dist-cjs/commands/BatchGetStreamKeyCommand.js +0 -24
  6. package/dist-cjs/commands/CreateChannelCommand.js +0 -24
  7. package/dist-cjs/commands/CreateRecordingConfigurationCommand.js +0 -35
  8. package/dist-cjs/commands/CreateStreamKeyCommand.js +0 -27
  9. package/dist-cjs/commands/DeleteChannelCommand.js +0 -28
  10. package/dist-cjs/commands/DeletePlaybackKeyPairCommand.js +0 -26
  11. package/dist-cjs/commands/DeleteRecordingConfigurationCommand.js +0 -29
  12. package/dist-cjs/commands/DeleteStreamKeyCommand.js +0 -25
  13. package/dist-cjs/commands/GetChannelCommand.js +0 -24
  14. package/dist-cjs/commands/GetPlaybackKeyPairCommand.js +0 -28
  15. package/dist-cjs/commands/GetRecordingConfigurationCommand.js +0 -24
  16. package/dist-cjs/commands/GetStreamCommand.js +0 -24
  17. package/dist-cjs/commands/GetStreamKeyCommand.js +0 -24
  18. package/dist-cjs/commands/ImportPlaybackKeyPairCommand.js +0 -28
  19. package/dist-cjs/commands/ListChannelsCommand.js +0 -27
  20. package/dist-cjs/commands/ListPlaybackKeyPairsCommand.js +0 -25
  21. package/dist-cjs/commands/ListRecordingConfigurationsCommand.js +0 -25
  22. package/dist-cjs/commands/ListStreamKeysCommand.js +0 -24
  23. package/dist-cjs/commands/ListStreamsCommand.js +0 -25
  24. package/dist-cjs/commands/ListTagsForResourceCommand.js +0 -24
  25. package/dist-cjs/commands/PutMetadataCommand.js +0 -30
  26. package/dist-cjs/commands/StopStreamCommand.js +0 -31
  27. package/dist-cjs/commands/TagResourceCommand.js +0 -24
  28. package/dist-cjs/commands/UntagResourceCommand.js +0 -24
  29. package/dist-cjs/commands/UpdateChannelCommand.js +0 -25
  30. package/dist-cjs/models/models_0.js +0 -213
  31. package/dist-cjs/pagination/ListChannelsPaginator.js +0 -10
  32. package/dist-cjs/pagination/ListPlaybackKeyPairsPaginator.js +0 -10
  33. package/dist-cjs/pagination/ListRecordingConfigurationsPaginator.js +0 -10
  34. package/dist-cjs/pagination/ListStreamKeysPaginator.js +0 -10
  35. package/dist-cjs/pagination/ListStreamsPaginator.js +0 -10
  36. package/dist-cjs/pagination/ListTagsForResourcePaginator.js +0 -10
  37. package/dist-cjs/protocols/Aws_restJson1.js +0 -5
  38. package/dist-cjs/runtimeConfig.browser.js +1 -5
  39. package/dist-cjs/runtimeConfig.js +1 -5
  40. package/dist-cjs/runtimeConfig.native.js +0 -3
  41. package/dist-cjs/runtimeConfig.shared.js +0 -3
  42. package/dist-types/ts3.4/Ivs.d.ts +27 -494
  43. package/dist-types/ts3.4/IvsClient.d.ts +24 -448
  44. package/dist-types/ts3.4/commands/BatchGetChannelCommand.d.ts +2 -20
  45. package/dist-types/ts3.4/commands/BatchGetStreamKeyCommand.d.ts +2 -20
  46. package/dist-types/ts3.4/commands/CreateChannelCommand.d.ts +2 -20
  47. package/dist-types/ts3.4/commands/CreateRecordingConfigurationCommand.d.ts +2 -31
  48. package/dist-types/ts3.4/commands/CreateStreamKeyCommand.d.ts +2 -23
  49. package/dist-types/ts3.4/commands/DeleteChannelCommand.d.ts +2 -24
  50. package/dist-types/ts3.4/commands/DeletePlaybackKeyPairCommand.d.ts +2 -22
  51. package/dist-types/ts3.4/commands/DeleteRecordingConfigurationCommand.d.ts +2 -25
  52. package/dist-types/ts3.4/commands/DeleteStreamKeyCommand.d.ts +2 -21
  53. package/dist-types/ts3.4/commands/GetChannelCommand.d.ts +2 -20
  54. package/dist-types/ts3.4/commands/GetPlaybackKeyPairCommand.d.ts +2 -24
  55. package/dist-types/ts3.4/commands/GetRecordingConfigurationCommand.d.ts +2 -20
  56. package/dist-types/ts3.4/commands/GetStreamCommand.d.ts +2 -20
  57. package/dist-types/ts3.4/commands/GetStreamKeyCommand.d.ts +2 -20
  58. package/dist-types/ts3.4/commands/ImportPlaybackKeyPairCommand.d.ts +2 -24
  59. package/dist-types/ts3.4/commands/ListChannelsCommand.d.ts +2 -23
  60. package/dist-types/ts3.4/commands/ListPlaybackKeyPairsCommand.d.ts +2 -21
  61. package/dist-types/ts3.4/commands/ListRecordingConfigurationsCommand.d.ts +2 -21
  62. package/dist-types/ts3.4/commands/ListStreamKeysCommand.d.ts +2 -20
  63. package/dist-types/ts3.4/commands/ListStreamsCommand.d.ts +2 -21
  64. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +2 -20
  65. package/dist-types/ts3.4/commands/PutMetadataCommand.d.ts +2 -26
  66. package/dist-types/ts3.4/commands/StopStreamCommand.d.ts +2 -27
  67. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +2 -20
  68. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +2 -20
  69. package/dist-types/ts3.4/commands/UpdateChannelCommand.d.ts +2 -21
  70. package/dist-types/ts3.4/models/models_0.d.ts +226 -768
  71. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +1 -3
  72. package/dist-types/ts3.4/runtimeConfig.d.ts +1 -3
  73. package/dist-types/ts3.4/runtimeConfig.native.d.ts +1 -3
  74. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +1 -3
  75. package/package.json +3 -3
@@ -6,32 +6,11 @@ export interface CreateStreamKeyCommandInput extends CreateStreamKeyRequest {
6
6
  }
7
7
  export interface CreateStreamKeyCommandOutput extends CreateStreamKeyResponse, __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Creates a stream key, used to initiate a stream, for the specified channel ARN.</p>
11
- * <p>Note that <a>CreateChannel</a> creates a stream key. If you subsequently use
12
- * CreateStreamKey on the same channel, it will fail because a stream key already exists and
13
- * there is a limit of 1 stream key per channel. To reset the stream key on a channel, use <a>DeleteStreamKey</a> and then CreateStreamKey.</p>
14
- * @example
15
- * Use a bare-bones client and the command you need to make an API call.
16
- * ```javascript
17
- * import { IvsClient, CreateStreamKeyCommand } from "@aws-sdk/client-ivs"; // ES Modules import
18
- * // const { IvsClient, CreateStreamKeyCommand } = require("@aws-sdk/client-ivs"); // CommonJS import
19
- * const client = new IvsClient(config);
20
- * const command = new CreateStreamKeyCommand(input);
21
- * const response = await client.send(command);
22
- * ```
23
- *
24
- * @see {@link CreateStreamKeyCommandInput} for command's `input` shape.
25
- * @see {@link CreateStreamKeyCommandOutput} for command's `response` shape.
26
- * @see {@link IvsClientResolvedConfig | config} for command's `input` shape.
27
- *
28
- */
9
+
29
10
  export declare class CreateStreamKeyCommand extends $Command<CreateStreamKeyCommandInput, CreateStreamKeyCommandOutput, IvsClientResolvedConfig> {
30
11
  readonly input: CreateStreamKeyCommandInput;
31
12
  constructor(input: CreateStreamKeyCommandInput);
32
- /**
33
- * @internal
34
- */
13
+
35
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IvsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateStreamKeyCommandInput, CreateStreamKeyCommandOutput>;
36
15
  private serialize;
37
16
  private deserialize;
@@ -6,33 +6,11 @@ export interface DeleteChannelCommandInput extends DeleteChannelRequest {
6
6
  }
7
7
  export interface DeleteChannelCommandOutput extends __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Deletes the specified channel and its associated stream keys.</p>
11
- * <p>If you try to delete a live channel, you will get an error (409 ConflictException). To
12
- * delete a channel that is live, call <a>StopStream</a>, wait for the Amazon
13
- * EventBridge "Stream End" event (to verify that the stream's state was changed from Live to
14
- * Offline), then call DeleteChannel. (See <a href="https://docs.aws.amazon.com/ivs/latest/userguide/eventbridge.html"> Using EventBridge with Amazon IVS</a>.) </p>
15
- * @example
16
- * Use a bare-bones client and the command you need to make an API call.
17
- * ```javascript
18
- * import { IvsClient, DeleteChannelCommand } from "@aws-sdk/client-ivs"; // ES Modules import
19
- * // const { IvsClient, DeleteChannelCommand } = require("@aws-sdk/client-ivs"); // CommonJS import
20
- * const client = new IvsClient(config);
21
- * const command = new DeleteChannelCommand(input);
22
- * const response = await client.send(command);
23
- * ```
24
- *
25
- * @see {@link DeleteChannelCommandInput} for command's `input` shape.
26
- * @see {@link DeleteChannelCommandOutput} for command's `response` shape.
27
- * @see {@link IvsClientResolvedConfig | config} for command's `input` shape.
28
- *
29
- */
9
+
30
10
  export declare class DeleteChannelCommand extends $Command<DeleteChannelCommandInput, DeleteChannelCommandOutput, IvsClientResolvedConfig> {
31
11
  readonly input: DeleteChannelCommandInput;
32
12
  constructor(input: DeleteChannelCommandInput);
33
- /**
34
- * @internal
35
- */
13
+
36
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IvsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteChannelCommandInput, DeleteChannelCommandOutput>;
37
15
  private serialize;
38
16
  private deserialize;
@@ -6,31 +6,11 @@ export interface DeletePlaybackKeyPairCommandInput extends DeletePlaybackKeyPair
6
6
  }
7
7
  export interface DeletePlaybackKeyPairCommandOutput extends DeletePlaybackKeyPairResponse, __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Deletes a specified authorization key pair. This invalidates future viewer tokens
11
- * 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
12
- * Channels</a> in the <i>Amazon IVS User Guide</i>.</p>
13
- * @example
14
- * Use a bare-bones client and the command you need to make an API call.
15
- * ```javascript
16
- * import { IvsClient, DeletePlaybackKeyPairCommand } from "@aws-sdk/client-ivs"; // ES Modules import
17
- * // const { IvsClient, DeletePlaybackKeyPairCommand } = require("@aws-sdk/client-ivs"); // CommonJS import
18
- * const client = new IvsClient(config);
19
- * const command = new DeletePlaybackKeyPairCommand(input);
20
- * const response = await client.send(command);
21
- * ```
22
- *
23
- * @see {@link DeletePlaybackKeyPairCommandInput} for command's `input` shape.
24
- * @see {@link DeletePlaybackKeyPairCommandOutput} for command's `response` shape.
25
- * @see {@link IvsClientResolvedConfig | config} for command's `input` shape.
26
- *
27
- */
9
+
28
10
  export declare class DeletePlaybackKeyPairCommand extends $Command<DeletePlaybackKeyPairCommandInput, DeletePlaybackKeyPairCommandOutput, IvsClientResolvedConfig> {
29
11
  readonly input: DeletePlaybackKeyPairCommandInput;
30
12
  constructor(input: DeletePlaybackKeyPairCommandInput);
31
- /**
32
- * @internal
33
- */
13
+
34
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IvsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeletePlaybackKeyPairCommandInput, DeletePlaybackKeyPairCommandOutput>;
35
15
  private serialize;
36
16
  private deserialize;
@@ -6,34 +6,11 @@ export interface DeleteRecordingConfigurationCommandInput extends DeleteRecordin
6
6
  }
7
7
  export interface DeleteRecordingConfigurationCommandOutput extends __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Deletes the recording configuration for the specified ARN.</p>
11
- * <p>If you try to delete a recording configuration that is associated with a channel, you will
12
- * get an error (409 ConflictException). To avoid this, for all channels that reference the
13
- * recording configuration, first use <a>UpdateChannel</a> to set the
14
- * <code>recordingConfigurationArn</code> field to an empty string, then use
15
- * DeleteRecordingConfiguration.</p>
16
- * @example
17
- * Use a bare-bones client and the command you need to make an API call.
18
- * ```javascript
19
- * import { IvsClient, DeleteRecordingConfigurationCommand } from "@aws-sdk/client-ivs"; // ES Modules import
20
- * // const { IvsClient, DeleteRecordingConfigurationCommand } = require("@aws-sdk/client-ivs"); // CommonJS import
21
- * const client = new IvsClient(config);
22
- * const command = new DeleteRecordingConfigurationCommand(input);
23
- * const response = await client.send(command);
24
- * ```
25
- *
26
- * @see {@link DeleteRecordingConfigurationCommandInput} for command's `input` shape.
27
- * @see {@link DeleteRecordingConfigurationCommandOutput} for command's `response` shape.
28
- * @see {@link IvsClientResolvedConfig | config} for command's `input` shape.
29
- *
30
- */
9
+
31
10
  export declare class DeleteRecordingConfigurationCommand extends $Command<DeleteRecordingConfigurationCommandInput, DeleteRecordingConfigurationCommandOutput, IvsClientResolvedConfig> {
32
11
  readonly input: DeleteRecordingConfigurationCommandInput;
33
12
  constructor(input: DeleteRecordingConfigurationCommandInput);
34
- /**
35
- * @internal
36
- */
13
+
37
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IvsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteRecordingConfigurationCommandInput, DeleteRecordingConfigurationCommandOutput>;
38
15
  private serialize;
39
16
  private deserialize;
@@ -6,30 +6,11 @@ export interface DeleteStreamKeyCommandInput extends DeleteStreamKeyRequest {
6
6
  }
7
7
  export interface DeleteStreamKeyCommandOutput extends __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Deletes the stream key for the specified ARN, so it can no longer be used to
11
- * stream.</p>
12
- * @example
13
- * Use a bare-bones client and the command you need to make an API call.
14
- * ```javascript
15
- * import { IvsClient, DeleteStreamKeyCommand } from "@aws-sdk/client-ivs"; // ES Modules import
16
- * // const { IvsClient, DeleteStreamKeyCommand } = require("@aws-sdk/client-ivs"); // CommonJS import
17
- * const client = new IvsClient(config);
18
- * const command = new DeleteStreamKeyCommand(input);
19
- * const response = await client.send(command);
20
- * ```
21
- *
22
- * @see {@link DeleteStreamKeyCommandInput} for command's `input` shape.
23
- * @see {@link DeleteStreamKeyCommandOutput} for command's `response` shape.
24
- * @see {@link IvsClientResolvedConfig | config} for command's `input` shape.
25
- *
26
- */
9
+
27
10
  export declare class DeleteStreamKeyCommand extends $Command<DeleteStreamKeyCommandInput, DeleteStreamKeyCommandOutput, IvsClientResolvedConfig> {
28
11
  readonly input: DeleteStreamKeyCommandInput;
29
12
  constructor(input: DeleteStreamKeyCommandInput);
30
- /**
31
- * @internal
32
- */
13
+
33
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IvsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteStreamKeyCommandInput, DeleteStreamKeyCommandOutput>;
34
15
  private serialize;
35
16
  private deserialize;
@@ -6,29 +6,11 @@ export interface GetChannelCommandInput extends GetChannelRequest {
6
6
  }
7
7
  export interface GetChannelCommandOutput extends GetChannelResponse, __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Gets the channel configuration for the specified channel ARN. See also <a>BatchGetChannel</a>.</p>
11
- * @example
12
- * Use a bare-bones client and the command you need to make an API call.
13
- * ```javascript
14
- * import { IvsClient, GetChannelCommand } from "@aws-sdk/client-ivs"; // ES Modules import
15
- * // const { IvsClient, GetChannelCommand } = require("@aws-sdk/client-ivs"); // CommonJS import
16
- * const client = new IvsClient(config);
17
- * const command = new GetChannelCommand(input);
18
- * const response = await client.send(command);
19
- * ```
20
- *
21
- * @see {@link GetChannelCommandInput} for command's `input` shape.
22
- * @see {@link GetChannelCommandOutput} for command's `response` shape.
23
- * @see {@link IvsClientResolvedConfig | config} for command's `input` shape.
24
- *
25
- */
9
+
26
10
  export declare class GetChannelCommand extends $Command<GetChannelCommandInput, GetChannelCommandOutput, IvsClientResolvedConfig> {
27
11
  readonly input: GetChannelCommandInput;
28
12
  constructor(input: GetChannelCommandInput);
29
- /**
30
- * @internal
31
- */
13
+
32
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IvsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetChannelCommandInput, GetChannelCommandOutput>;
33
15
  private serialize;
34
16
  private deserialize;
@@ -6,33 +6,11 @@ export interface GetPlaybackKeyPairCommandInput extends GetPlaybackKeyPairReques
6
6
  }
7
7
  export interface GetPlaybackKeyPairCommandOutput extends GetPlaybackKeyPairResponse, __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Gets a specified playback authorization key pair and returns the <code>arn</code> and
11
- * <code>fingerprint</code>. The <code>privateKey</code> held by the caller can be used to
12
- * generate viewer authorization tokens, to grant viewers access to private channels. For more
13
- * 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
14
- * Guide</i>.</p>
15
- * @example
16
- * Use a bare-bones client and the command you need to make an API call.
17
- * ```javascript
18
- * import { IvsClient, GetPlaybackKeyPairCommand } from "@aws-sdk/client-ivs"; // ES Modules import
19
- * // const { IvsClient, GetPlaybackKeyPairCommand } = require("@aws-sdk/client-ivs"); // CommonJS import
20
- * const client = new IvsClient(config);
21
- * const command = new GetPlaybackKeyPairCommand(input);
22
- * const response = await client.send(command);
23
- * ```
24
- *
25
- * @see {@link GetPlaybackKeyPairCommandInput} for command's `input` shape.
26
- * @see {@link GetPlaybackKeyPairCommandOutput} for command's `response` shape.
27
- * @see {@link IvsClientResolvedConfig | config} for command's `input` shape.
28
- *
29
- */
9
+
30
10
  export declare class GetPlaybackKeyPairCommand extends $Command<GetPlaybackKeyPairCommandInput, GetPlaybackKeyPairCommandOutput, IvsClientResolvedConfig> {
31
11
  readonly input: GetPlaybackKeyPairCommandInput;
32
12
  constructor(input: GetPlaybackKeyPairCommandInput);
33
- /**
34
- * @internal
35
- */
13
+
36
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IvsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetPlaybackKeyPairCommandInput, GetPlaybackKeyPairCommandOutput>;
37
15
  private serialize;
38
16
  private deserialize;
@@ -6,29 +6,11 @@ export interface GetRecordingConfigurationCommandInput extends GetRecordingConfi
6
6
  }
7
7
  export interface GetRecordingConfigurationCommandOutput extends GetRecordingConfigurationResponse, __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Gets the recording configuration for the specified ARN.</p>
11
- * @example
12
- * Use a bare-bones client and the command you need to make an API call.
13
- * ```javascript
14
- * import { IvsClient, GetRecordingConfigurationCommand } from "@aws-sdk/client-ivs"; // ES Modules import
15
- * // const { IvsClient, GetRecordingConfigurationCommand } = require("@aws-sdk/client-ivs"); // CommonJS import
16
- * const client = new IvsClient(config);
17
- * const command = new GetRecordingConfigurationCommand(input);
18
- * const response = await client.send(command);
19
- * ```
20
- *
21
- * @see {@link GetRecordingConfigurationCommandInput} for command's `input` shape.
22
- * @see {@link GetRecordingConfigurationCommandOutput} for command's `response` shape.
23
- * @see {@link IvsClientResolvedConfig | config} for command's `input` shape.
24
- *
25
- */
9
+
26
10
  export declare class GetRecordingConfigurationCommand extends $Command<GetRecordingConfigurationCommandInput, GetRecordingConfigurationCommandOutput, IvsClientResolvedConfig> {
27
11
  readonly input: GetRecordingConfigurationCommandInput;
28
12
  constructor(input: GetRecordingConfigurationCommandInput);
29
- /**
30
- * @internal
31
- */
13
+
32
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IvsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetRecordingConfigurationCommandInput, GetRecordingConfigurationCommandOutput>;
33
15
  private serialize;
34
16
  private deserialize;
@@ -6,29 +6,11 @@ export interface GetStreamCommandInput extends GetStreamRequest {
6
6
  }
7
7
  export interface GetStreamCommandOutput extends GetStreamResponse, __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Gets information about the active (live) stream on a specified channel.</p>
11
- * @example
12
- * Use a bare-bones client and the command you need to make an API call.
13
- * ```javascript
14
- * import { IvsClient, GetStreamCommand } from "@aws-sdk/client-ivs"; // ES Modules import
15
- * // const { IvsClient, GetStreamCommand } = require("@aws-sdk/client-ivs"); // CommonJS import
16
- * const client = new IvsClient(config);
17
- * const command = new GetStreamCommand(input);
18
- * const response = await client.send(command);
19
- * ```
20
- *
21
- * @see {@link GetStreamCommandInput} for command's `input` shape.
22
- * @see {@link GetStreamCommandOutput} for command's `response` shape.
23
- * @see {@link IvsClientResolvedConfig | config} for command's `input` shape.
24
- *
25
- */
9
+
26
10
  export declare class GetStreamCommand extends $Command<GetStreamCommandInput, GetStreamCommandOutput, IvsClientResolvedConfig> {
27
11
  readonly input: GetStreamCommandInput;
28
12
  constructor(input: GetStreamCommandInput);
29
- /**
30
- * @internal
31
- */
13
+
32
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IvsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetStreamCommandInput, GetStreamCommandOutput>;
33
15
  private serialize;
34
16
  private deserialize;
@@ -6,29 +6,11 @@ export interface GetStreamKeyCommandInput extends GetStreamKeyRequest {
6
6
  }
7
7
  export interface GetStreamKeyCommandOutput extends GetStreamKeyResponse, __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Gets stream-key information for a specified ARN.</p>
11
- * @example
12
- * Use a bare-bones client and the command you need to make an API call.
13
- * ```javascript
14
- * import { IvsClient, GetStreamKeyCommand } from "@aws-sdk/client-ivs"; // ES Modules import
15
- * // const { IvsClient, GetStreamKeyCommand } = require("@aws-sdk/client-ivs"); // CommonJS import
16
- * const client = new IvsClient(config);
17
- * const command = new GetStreamKeyCommand(input);
18
- * const response = await client.send(command);
19
- * ```
20
- *
21
- * @see {@link GetStreamKeyCommandInput} for command's `input` shape.
22
- * @see {@link GetStreamKeyCommandOutput} for command's `response` shape.
23
- * @see {@link IvsClientResolvedConfig | config} for command's `input` shape.
24
- *
25
- */
9
+
26
10
  export declare class GetStreamKeyCommand extends $Command<GetStreamKeyCommandInput, GetStreamKeyCommandOutput, IvsClientResolvedConfig> {
27
11
  readonly input: GetStreamKeyCommandInput;
28
12
  constructor(input: GetStreamKeyCommandInput);
29
- /**
30
- * @internal
31
- */
13
+
32
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IvsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetStreamKeyCommandInput, GetStreamKeyCommandOutput>;
33
15
  private serialize;
34
16
  private deserialize;
@@ -6,33 +6,11 @@ export interface ImportPlaybackKeyPairCommandInput extends ImportPlaybackKeyPair
6
6
  }
7
7
  export interface ImportPlaybackKeyPairCommandOutput extends ImportPlaybackKeyPairResponse, __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Imports the public portion of a new key pair and returns its <code>arn</code> and
11
- * <code>fingerprint</code>. The <code>privateKey</code> can then be used to generate viewer
12
- * authorization tokens, to grant viewers access to private channels. For more information, see
13
- * <a href="https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html">Setting Up
14
- * Private Channels</a> in the <i>Amazon IVS User Guide</i>.</p>
15
- * @example
16
- * Use a bare-bones client and the command you need to make an API call.
17
- * ```javascript
18
- * import { IvsClient, ImportPlaybackKeyPairCommand } from "@aws-sdk/client-ivs"; // ES Modules import
19
- * // const { IvsClient, ImportPlaybackKeyPairCommand } = require("@aws-sdk/client-ivs"); // CommonJS import
20
- * const client = new IvsClient(config);
21
- * const command = new ImportPlaybackKeyPairCommand(input);
22
- * const response = await client.send(command);
23
- * ```
24
- *
25
- * @see {@link ImportPlaybackKeyPairCommandInput} for command's `input` shape.
26
- * @see {@link ImportPlaybackKeyPairCommandOutput} for command's `response` shape.
27
- * @see {@link IvsClientResolvedConfig | config} for command's `input` shape.
28
- *
29
- */
9
+
30
10
  export declare class ImportPlaybackKeyPairCommand extends $Command<ImportPlaybackKeyPairCommandInput, ImportPlaybackKeyPairCommandOutput, IvsClientResolvedConfig> {
31
11
  readonly input: ImportPlaybackKeyPairCommandInput;
32
12
  constructor(input: ImportPlaybackKeyPairCommandInput);
33
- /**
34
- * @internal
35
- */
13
+
36
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IvsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ImportPlaybackKeyPairCommandInput, ImportPlaybackKeyPairCommandOutput>;
37
15
  private serialize;
38
16
  private deserialize;
@@ -6,32 +6,11 @@ export interface ListChannelsCommandInput extends ListChannelsRequest {
6
6
  }
7
7
  export interface ListChannelsCommandOutput extends ListChannelsResponse, __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Gets summary information about all channels in your account, in the AWS region where the
11
- * API request is processed. This list can be filtered to match a specified name or
12
- * recording-configuration ARN. Filters are mutually exclusive and cannot be used together. If
13
- * you try to use both filters, you will get an error (409 ConflictException).</p>
14
- * @example
15
- * Use a bare-bones client and the command you need to make an API call.
16
- * ```javascript
17
- * import { IvsClient, ListChannelsCommand } from "@aws-sdk/client-ivs"; // ES Modules import
18
- * // const { IvsClient, ListChannelsCommand } = require("@aws-sdk/client-ivs"); // CommonJS import
19
- * const client = new IvsClient(config);
20
- * const command = new ListChannelsCommand(input);
21
- * const response = await client.send(command);
22
- * ```
23
- *
24
- * @see {@link ListChannelsCommandInput} for command's `input` shape.
25
- * @see {@link ListChannelsCommandOutput} for command's `response` shape.
26
- * @see {@link IvsClientResolvedConfig | config} for command's `input` shape.
27
- *
28
- */
9
+
29
10
  export declare class ListChannelsCommand extends $Command<ListChannelsCommandInput, ListChannelsCommandOutput, IvsClientResolvedConfig> {
30
11
  readonly input: ListChannelsCommandInput;
31
12
  constructor(input: ListChannelsCommandInput);
32
- /**
33
- * @internal
34
- */
13
+
35
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IvsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListChannelsCommandInput, ListChannelsCommandOutput>;
36
15
  private serialize;
37
16
  private deserialize;
@@ -6,30 +6,11 @@ export interface ListPlaybackKeyPairsCommandInput extends ListPlaybackKeyPairsRe
6
6
  }
7
7
  export interface ListPlaybackKeyPairsCommandOutput extends ListPlaybackKeyPairsResponse, __MetadataBearer {
8
8
  }
9
- /**
10
- * <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
11
- * Channels</a> in the <i>Amazon IVS User Guide</i>.</p>
12
- * @example
13
- * Use a bare-bones client and the command you need to make an API call.
14
- * ```javascript
15
- * import { IvsClient, ListPlaybackKeyPairsCommand } from "@aws-sdk/client-ivs"; // ES Modules import
16
- * // const { IvsClient, ListPlaybackKeyPairsCommand } = require("@aws-sdk/client-ivs"); // CommonJS import
17
- * const client = new IvsClient(config);
18
- * const command = new ListPlaybackKeyPairsCommand(input);
19
- * const response = await client.send(command);
20
- * ```
21
- *
22
- * @see {@link ListPlaybackKeyPairsCommandInput} for command's `input` shape.
23
- * @see {@link ListPlaybackKeyPairsCommandOutput} for command's `response` shape.
24
- * @see {@link IvsClientResolvedConfig | config} for command's `input` shape.
25
- *
26
- */
9
+
27
10
  export declare class ListPlaybackKeyPairsCommand extends $Command<ListPlaybackKeyPairsCommandInput, ListPlaybackKeyPairsCommandOutput, IvsClientResolvedConfig> {
28
11
  readonly input: ListPlaybackKeyPairsCommandInput;
29
12
  constructor(input: ListPlaybackKeyPairsCommandInput);
30
- /**
31
- * @internal
32
- */
13
+
33
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IvsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListPlaybackKeyPairsCommandInput, ListPlaybackKeyPairsCommandOutput>;
34
15
  private serialize;
35
16
  private deserialize;
@@ -6,30 +6,11 @@ export interface ListRecordingConfigurationsCommandInput extends ListRecordingCo
6
6
  }
7
7
  export interface ListRecordingConfigurationsCommandOutput extends ListRecordingConfigurationsResponse, __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Gets summary information about all recording configurations in your account, in the AWS
11
- * region where the API request is processed.</p>
12
- * @example
13
- * Use a bare-bones client and the command you need to make an API call.
14
- * ```javascript
15
- * import { IvsClient, ListRecordingConfigurationsCommand } from "@aws-sdk/client-ivs"; // ES Modules import
16
- * // const { IvsClient, ListRecordingConfigurationsCommand } = require("@aws-sdk/client-ivs"); // CommonJS import
17
- * const client = new IvsClient(config);
18
- * const command = new ListRecordingConfigurationsCommand(input);
19
- * const response = await client.send(command);
20
- * ```
21
- *
22
- * @see {@link ListRecordingConfigurationsCommandInput} for command's `input` shape.
23
- * @see {@link ListRecordingConfigurationsCommandOutput} for command's `response` shape.
24
- * @see {@link IvsClientResolvedConfig | config} for command's `input` shape.
25
- *
26
- */
9
+
27
10
  export declare class ListRecordingConfigurationsCommand extends $Command<ListRecordingConfigurationsCommandInput, ListRecordingConfigurationsCommandOutput, IvsClientResolvedConfig> {
28
11
  readonly input: ListRecordingConfigurationsCommandInput;
29
12
  constructor(input: ListRecordingConfigurationsCommandInput);
30
- /**
31
- * @internal
32
- */
13
+
33
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IvsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListRecordingConfigurationsCommandInput, ListRecordingConfigurationsCommandOutput>;
34
15
  private serialize;
35
16
  private deserialize;
@@ -6,29 +6,11 @@ export interface ListStreamKeysCommandInput extends ListStreamKeysRequest {
6
6
  }
7
7
  export interface ListStreamKeysCommandOutput extends ListStreamKeysResponse, __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Gets summary information about stream keys for the specified channel.</p>
11
- * @example
12
- * Use a bare-bones client and the command you need to make an API call.
13
- * ```javascript
14
- * import { IvsClient, ListStreamKeysCommand } from "@aws-sdk/client-ivs"; // ES Modules import
15
- * // const { IvsClient, ListStreamKeysCommand } = require("@aws-sdk/client-ivs"); // CommonJS import
16
- * const client = new IvsClient(config);
17
- * const command = new ListStreamKeysCommand(input);
18
- * const response = await client.send(command);
19
- * ```
20
- *
21
- * @see {@link ListStreamKeysCommandInput} for command's `input` shape.
22
- * @see {@link ListStreamKeysCommandOutput} for command's `response` shape.
23
- * @see {@link IvsClientResolvedConfig | config} for command's `input` shape.
24
- *
25
- */
9
+
26
10
  export declare class ListStreamKeysCommand extends $Command<ListStreamKeysCommandInput, ListStreamKeysCommandOutput, IvsClientResolvedConfig> {
27
11
  readonly input: ListStreamKeysCommandInput;
28
12
  constructor(input: ListStreamKeysCommandInput);
29
- /**
30
- * @internal
31
- */
13
+
32
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IvsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListStreamKeysCommandInput, ListStreamKeysCommandOutput>;
33
15
  private serialize;
34
16
  private deserialize;
@@ -6,30 +6,11 @@ export interface ListStreamsCommandInput extends ListStreamsRequest {
6
6
  }
7
7
  export interface ListStreamsCommandOutput extends ListStreamsResponse, __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Gets summary information about live streams in your account, in the AWS region where the
11
- * API request is processed.</p>
12
- * @example
13
- * Use a bare-bones client and the command you need to make an API call.
14
- * ```javascript
15
- * import { IvsClient, ListStreamsCommand } from "@aws-sdk/client-ivs"; // ES Modules import
16
- * // const { IvsClient, ListStreamsCommand } = require("@aws-sdk/client-ivs"); // CommonJS import
17
- * const client = new IvsClient(config);
18
- * const command = new ListStreamsCommand(input);
19
- * const response = await client.send(command);
20
- * ```
21
- *
22
- * @see {@link ListStreamsCommandInput} for command's `input` shape.
23
- * @see {@link ListStreamsCommandOutput} for command's `response` shape.
24
- * @see {@link IvsClientResolvedConfig | config} for command's `input` shape.
25
- *
26
- */
9
+
27
10
  export declare class ListStreamsCommand extends $Command<ListStreamsCommandInput, ListStreamsCommandOutput, IvsClientResolvedConfig> {
28
11
  readonly input: ListStreamsCommandInput;
29
12
  constructor(input: ListStreamsCommandInput);
30
- /**
31
- * @internal
32
- */
13
+
33
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IvsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListStreamsCommandInput, ListStreamsCommandOutput>;
34
15
  private serialize;
35
16
  private deserialize;
@@ -6,29 +6,11 @@ export interface ListTagsForResourceCommandInput extends ListTagsForResourceRequ
6
6
  }
7
7
  export interface ListTagsForResourceCommandOutput extends ListTagsForResourceResponse, __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Gets information about AWS tags for the specified ARN.</p>
11
- * @example
12
- * Use a bare-bones client and the command you need to make an API call.
13
- * ```javascript
14
- * import { IvsClient, ListTagsForResourceCommand } from "@aws-sdk/client-ivs"; // ES Modules import
15
- * // const { IvsClient, ListTagsForResourceCommand } = require("@aws-sdk/client-ivs"); // CommonJS import
16
- * const client = new IvsClient(config);
17
- * const command = new ListTagsForResourceCommand(input);
18
- * const response = await client.send(command);
19
- * ```
20
- *
21
- * @see {@link ListTagsForResourceCommandInput} for command's `input` shape.
22
- * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape.
23
- * @see {@link IvsClientResolvedConfig | config} for command's `input` shape.
24
- *
25
- */
9
+
26
10
  export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, IvsClientResolvedConfig> {
27
11
  readonly input: ListTagsForResourceCommandInput;
28
12
  constructor(input: ListTagsForResourceCommandInput);
29
- /**
30
- * @internal
31
- */
13
+
32
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IvsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput>;
33
15
  private serialize;
34
16
  private deserialize;
@@ -6,35 +6,11 @@ export interface PutMetadataCommandInput extends PutMetadataRequest {
6
6
  }
7
7
  export interface PutMetadataCommandOutput extends __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Inserts metadata into the active stream of the specified channel. A maximum of 5 requests
11
- * per second per channel is allowed, each with a maximum 1 KB payload. (If 5 TPS is not
12
- * sufficient for your needs, we recommend batching your data into a single PutMetadata call.)
13
- *
14
- * Also see <a href="https://docs.aws.amazon.com/ivs/latest/userguide/metadata.html">Embedding Metadata
15
- *
16
- * within a Video Stream</a> in the <i>Amazon IVS User Guide</i>.</p>
17
- * @example
18
- * Use a bare-bones client and the command you need to make an API call.
19
- * ```javascript
20
- * import { IvsClient, PutMetadataCommand } from "@aws-sdk/client-ivs"; // ES Modules import
21
- * // const { IvsClient, PutMetadataCommand } = require("@aws-sdk/client-ivs"); // CommonJS import
22
- * const client = new IvsClient(config);
23
- * const command = new PutMetadataCommand(input);
24
- * const response = await client.send(command);
25
- * ```
26
- *
27
- * @see {@link PutMetadataCommandInput} for command's `input` shape.
28
- * @see {@link PutMetadataCommandOutput} for command's `response` shape.
29
- * @see {@link IvsClientResolvedConfig | config} for command's `input` shape.
30
- *
31
- */
9
+
32
10
  export declare class PutMetadataCommand extends $Command<PutMetadataCommandInput, PutMetadataCommandOutput, IvsClientResolvedConfig> {
33
11
  readonly input: PutMetadataCommandInput;
34
12
  constructor(input: PutMetadataCommandInput);
35
- /**
36
- * @internal
37
- */
13
+
38
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IvsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutMetadataCommandInput, PutMetadataCommandOutput>;
39
15
  private serialize;
40
16
  private deserialize;