@aws-sdk/client-ivs 3.295.0 → 3.297.0

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 (40) hide show
  1. package/dist-types/Ivs.d.ts +29 -0
  2. package/dist-types/IvsClient.d.ts +24 -4
  3. package/dist-types/commands/BatchGetChannelCommand.d.ts +16 -0
  4. package/dist-types/commands/BatchGetStreamKeyCommand.d.ts +16 -0
  5. package/dist-types/commands/CreateChannelCommand.d.ts +16 -0
  6. package/dist-types/commands/CreateRecordingConfigurationCommand.d.ts +16 -0
  7. package/dist-types/commands/CreateStreamKeyCommand.d.ts +16 -0
  8. package/dist-types/commands/DeleteChannelCommand.d.ts +16 -0
  9. package/dist-types/commands/DeletePlaybackKeyPairCommand.d.ts +16 -0
  10. package/dist-types/commands/DeleteRecordingConfigurationCommand.d.ts +16 -0
  11. package/dist-types/commands/DeleteStreamKeyCommand.d.ts +16 -0
  12. package/dist-types/commands/GetChannelCommand.d.ts +16 -0
  13. package/dist-types/commands/GetPlaybackKeyPairCommand.d.ts +16 -0
  14. package/dist-types/commands/GetRecordingConfigurationCommand.d.ts +16 -0
  15. package/dist-types/commands/GetStreamCommand.d.ts +16 -0
  16. package/dist-types/commands/GetStreamKeyCommand.d.ts +16 -0
  17. package/dist-types/commands/GetStreamSessionCommand.d.ts +16 -0
  18. package/dist-types/commands/ImportPlaybackKeyPairCommand.d.ts +16 -0
  19. package/dist-types/commands/ListChannelsCommand.d.ts +16 -0
  20. package/dist-types/commands/ListPlaybackKeyPairsCommand.d.ts +16 -0
  21. package/dist-types/commands/ListRecordingConfigurationsCommand.d.ts +16 -0
  22. package/dist-types/commands/ListStreamKeysCommand.d.ts +16 -0
  23. package/dist-types/commands/ListStreamSessionsCommand.d.ts +16 -0
  24. package/dist-types/commands/ListStreamsCommand.d.ts +16 -0
  25. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  26. package/dist-types/commands/PutMetadataCommand.d.ts +16 -0
  27. package/dist-types/commands/StopStreamCommand.d.ts +16 -0
  28. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  29. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  30. package/dist-types/commands/UpdateChannelCommand.d.ts +16 -0
  31. package/dist-types/models/IvsServiceException.d.ts +2 -0
  32. package/dist-types/models/models_0.d.ts +205 -0
  33. package/dist-types/pagination/Interfaces.d.ts +3 -0
  34. package/dist-types/pagination/ListChannelsPaginator.d.ts +3 -0
  35. package/dist-types/pagination/ListPlaybackKeyPairsPaginator.d.ts +3 -0
  36. package/dist-types/pagination/ListRecordingConfigurationsPaginator.d.ts +3 -0
  37. package/dist-types/pagination/ListStreamKeysPaginator.d.ts +3 -0
  38. package/dist-types/pagination/ListStreamSessionsPaginator.d.ts +3 -0
  39. package/dist-types/pagination/ListStreamsPaginator.d.ts +3 -0
  40. package/package.json +29 -29
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IvsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IvsClient";
5
5
  import { DeleteRecordingConfigurationRequest } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteRecordingConfigurationCommand}.
8
10
  */
9
11
  export interface DeleteRecordingConfigurationCommandInput extends DeleteRecordingConfigurationRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteRecordingConfigurationCommand}.
13
17
  */
14
18
  export interface DeleteRecordingConfigurationCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes the recording configuration for the specified ARN.</p>
18
23
  * <p>If you try to delete a recording configuration that is associated with a channel, you will
19
24
  * get an error (409 ConflictException). To avoid this, for all channels that reference the
@@ -30,6 +35,8 @@ export interface DeleteRecordingConfigurationCommandOutput extends __MetadataBea
30
35
  * const response = await client.send(command);
31
36
  * ```
32
37
  *
38
+ * @param DeleteRecordingConfigurationCommandInput - {@link DeleteRecordingConfigurationCommandInput}
39
+ * @returns {@link DeleteRecordingConfigurationCommandOutput}
33
40
  * @see {@link DeleteRecordingConfigurationCommandInput} for command's `input` shape.
34
41
  * @see {@link DeleteRecordingConfigurationCommandOutput} for command's `response` shape.
35
42
  * @see {@link IvsClientResolvedConfig | config} for IvsClient's `config` shape.
@@ -54,11 +61,20 @@ export interface DeleteRecordingConfigurationCommandOutput extends __MetadataBea
54
61
  export declare class DeleteRecordingConfigurationCommand extends $Command<DeleteRecordingConfigurationCommandInput, DeleteRecordingConfigurationCommandOutput, IvsClientResolvedConfig> {
55
62
  readonly input: DeleteRecordingConfigurationCommandInput;
56
63
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
64
+ /**
65
+ * @public
66
+ */
57
67
  constructor(input: DeleteRecordingConfigurationCommandInput);
58
68
  /**
59
69
  * @internal
60
70
  */
61
71
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IvsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteRecordingConfigurationCommandInput, DeleteRecordingConfigurationCommandOutput>;
72
+ /**
73
+ * @internal
74
+ */
62
75
  private serialize;
76
+ /**
77
+ * @internal
78
+ */
63
79
  private deserialize;
64
80
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IvsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IvsClient";
5
5
  import { DeleteStreamKeyRequest } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteStreamKeyCommand}.
8
10
  */
9
11
  export interface DeleteStreamKeyCommandInput extends DeleteStreamKeyRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteStreamKeyCommand}.
13
17
  */
14
18
  export interface DeleteStreamKeyCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes the stream key for the specified ARN, so it can no longer be used to
18
23
  * stream.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface DeleteStreamKeyCommandOutput extends __MetadataBearer {
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param DeleteStreamKeyCommandInput - {@link DeleteStreamKeyCommandInput}
35
+ * @returns {@link DeleteStreamKeyCommandOutput}
29
36
  * @see {@link DeleteStreamKeyCommandInput} for command's `input` shape.
30
37
  * @see {@link DeleteStreamKeyCommandOutput} for command's `response` shape.
31
38
  * @see {@link IvsClientResolvedConfig | config} for IvsClient's `config` shape.
@@ -47,11 +54,20 @@ export interface DeleteStreamKeyCommandOutput extends __MetadataBearer {
47
54
  export declare class DeleteStreamKeyCommand extends $Command<DeleteStreamKeyCommandInput, DeleteStreamKeyCommandOutput, IvsClientResolvedConfig> {
48
55
  readonly input: DeleteStreamKeyCommandInput;
49
56
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
57
+ /**
58
+ * @public
59
+ */
50
60
  constructor(input: DeleteStreamKeyCommandInput);
51
61
  /**
52
62
  * @internal
53
63
  */
54
64
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IvsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteStreamKeyCommandInput, DeleteStreamKeyCommandOutput>;
65
+ /**
66
+ * @internal
67
+ */
55
68
  private serialize;
69
+ /**
70
+ * @internal
71
+ */
56
72
  private deserialize;
57
73
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IvsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IvsClient";
5
5
  import { GetChannelRequest, GetChannelResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetChannelCommand}.
8
10
  */
9
11
  export interface GetChannelCommandInput extends GetChannelRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetChannelCommand}.
13
17
  */
14
18
  export interface GetChannelCommandOutput extends GetChannelResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Gets the channel configuration for the specified channel ARN. See also <a>BatchGetChannel</a>.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface GetChannelCommandOutput extends GetChannelResponse, __MetadataB
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param GetChannelCommandInput - {@link GetChannelCommandInput}
34
+ * @returns {@link GetChannelCommandOutput}
28
35
  * @see {@link GetChannelCommandInput} for command's `input` shape.
29
36
  * @see {@link GetChannelCommandOutput} for command's `response` shape.
30
37
  * @see {@link IvsClientResolvedConfig | config} for IvsClient's `config` shape.
@@ -43,11 +50,20 @@ export interface GetChannelCommandOutput extends GetChannelResponse, __MetadataB
43
50
  export declare class GetChannelCommand extends $Command<GetChannelCommandInput, GetChannelCommandOutput, IvsClientResolvedConfig> {
44
51
  readonly input: GetChannelCommandInput;
45
52
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
53
+ /**
54
+ * @public
55
+ */
46
56
  constructor(input: GetChannelCommandInput);
47
57
  /**
48
58
  * @internal
49
59
  */
50
60
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IvsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetChannelCommandInput, GetChannelCommandOutput>;
61
+ /**
62
+ * @internal
63
+ */
51
64
  private serialize;
65
+ /**
66
+ * @internal
67
+ */
52
68
  private deserialize;
53
69
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IvsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IvsClient";
5
5
  import { GetPlaybackKeyPairRequest, GetPlaybackKeyPairResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetPlaybackKeyPairCommand}.
8
10
  */
9
11
  export interface GetPlaybackKeyPairCommandInput extends GetPlaybackKeyPairRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetPlaybackKeyPairCommand}.
13
17
  */
14
18
  export interface GetPlaybackKeyPairCommandOutput extends GetPlaybackKeyPairResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Gets a specified playback authorization key pair and returns the <code>arn</code> and
18
23
  * <code>fingerprint</code>. The <code>privateKey</code> held by the caller can be used to
19
24
  * generate viewer authorization tokens, to grant viewers access to private channels. For more
@@ -29,6 +34,8 @@ export interface GetPlaybackKeyPairCommandOutput extends GetPlaybackKeyPairRespo
29
34
  * const response = await client.send(command);
30
35
  * ```
31
36
  *
37
+ * @param GetPlaybackKeyPairCommandInput - {@link GetPlaybackKeyPairCommandInput}
38
+ * @returns {@link GetPlaybackKeyPairCommandOutput}
32
39
  * @see {@link GetPlaybackKeyPairCommandInput} for command's `input` shape.
33
40
  * @see {@link GetPlaybackKeyPairCommandOutput} for command's `response` shape.
34
41
  * @see {@link IvsClientResolvedConfig | config} for IvsClient's `config` shape.
@@ -47,11 +54,20 @@ export interface GetPlaybackKeyPairCommandOutput extends GetPlaybackKeyPairRespo
47
54
  export declare class GetPlaybackKeyPairCommand extends $Command<GetPlaybackKeyPairCommandInput, GetPlaybackKeyPairCommandOutput, IvsClientResolvedConfig> {
48
55
  readonly input: GetPlaybackKeyPairCommandInput;
49
56
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
57
+ /**
58
+ * @public
59
+ */
50
60
  constructor(input: GetPlaybackKeyPairCommandInput);
51
61
  /**
52
62
  * @internal
53
63
  */
54
64
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IvsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetPlaybackKeyPairCommandInput, GetPlaybackKeyPairCommandOutput>;
65
+ /**
66
+ * @internal
67
+ */
55
68
  private serialize;
69
+ /**
70
+ * @internal
71
+ */
56
72
  private deserialize;
57
73
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IvsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IvsClient";
5
5
  import { GetRecordingConfigurationRequest, GetRecordingConfigurationResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetRecordingConfigurationCommand}.
8
10
  */
9
11
  export interface GetRecordingConfigurationCommandInput extends GetRecordingConfigurationRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetRecordingConfigurationCommand}.
13
17
  */
14
18
  export interface GetRecordingConfigurationCommandOutput extends GetRecordingConfigurationResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Gets the recording configuration for the specified ARN.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface GetRecordingConfigurationCommandOutput extends GetRecordingConf
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param GetRecordingConfigurationCommandInput - {@link GetRecordingConfigurationCommandInput}
34
+ * @returns {@link GetRecordingConfigurationCommandOutput}
28
35
  * @see {@link GetRecordingConfigurationCommandInput} for command's `input` shape.
29
36
  * @see {@link GetRecordingConfigurationCommandOutput} for command's `response` shape.
30
37
  * @see {@link IvsClientResolvedConfig | config} for IvsClient's `config` shape.
@@ -46,11 +53,20 @@ export interface GetRecordingConfigurationCommandOutput extends GetRecordingConf
46
53
  export declare class GetRecordingConfigurationCommand extends $Command<GetRecordingConfigurationCommandInput, GetRecordingConfigurationCommandOutput, IvsClientResolvedConfig> {
47
54
  readonly input: GetRecordingConfigurationCommandInput;
48
55
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
56
+ /**
57
+ * @public
58
+ */
49
59
  constructor(input: GetRecordingConfigurationCommandInput);
50
60
  /**
51
61
  * @internal
52
62
  */
53
63
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IvsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetRecordingConfigurationCommandInput, GetRecordingConfigurationCommandOutput>;
64
+ /**
65
+ * @internal
66
+ */
54
67
  private serialize;
68
+ /**
69
+ * @internal
70
+ */
55
71
  private deserialize;
56
72
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IvsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IvsClient";
5
5
  import { GetStreamRequest, GetStreamResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetStreamCommand}.
8
10
  */
9
11
  export interface GetStreamCommandInput extends GetStreamRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetStreamCommand}.
13
17
  */
14
18
  export interface GetStreamCommandOutput extends GetStreamResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Gets information about the active (live) stream on a specified channel.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface GetStreamCommandOutput extends GetStreamResponse, __MetadataBea
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param GetStreamCommandInput - {@link GetStreamCommandInput}
34
+ * @returns {@link GetStreamCommandOutput}
28
35
  * @see {@link GetStreamCommandInput} for command's `input` shape.
29
36
  * @see {@link GetStreamCommandOutput} for command's `response` shape.
30
37
  * @see {@link IvsClientResolvedConfig | config} for IvsClient's `config` shape.
@@ -46,11 +53,20 @@ export interface GetStreamCommandOutput extends GetStreamResponse, __MetadataBea
46
53
  export declare class GetStreamCommand extends $Command<GetStreamCommandInput, GetStreamCommandOutput, IvsClientResolvedConfig> {
47
54
  readonly input: GetStreamCommandInput;
48
55
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
56
+ /**
57
+ * @public
58
+ */
49
59
  constructor(input: GetStreamCommandInput);
50
60
  /**
51
61
  * @internal
52
62
  */
53
63
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IvsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetStreamCommandInput, GetStreamCommandOutput>;
64
+ /**
65
+ * @internal
66
+ */
54
67
  private serialize;
68
+ /**
69
+ * @internal
70
+ */
55
71
  private deserialize;
56
72
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IvsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IvsClient";
5
5
  import { GetStreamKeyRequest, GetStreamKeyResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetStreamKeyCommand}.
8
10
  */
9
11
  export interface GetStreamKeyCommandInput extends GetStreamKeyRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetStreamKeyCommand}.
13
17
  */
14
18
  export interface GetStreamKeyCommandOutput extends GetStreamKeyResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Gets stream-key information for a specified ARN.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface GetStreamKeyCommandOutput extends GetStreamKeyResponse, __Metad
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param GetStreamKeyCommandInput - {@link GetStreamKeyCommandInput}
34
+ * @returns {@link GetStreamKeyCommandOutput}
28
35
  * @see {@link GetStreamKeyCommandInput} for command's `input` shape.
29
36
  * @see {@link GetStreamKeyCommandOutput} for command's `response` shape.
30
37
  * @see {@link IvsClientResolvedConfig | config} for IvsClient's `config` shape.
@@ -43,11 +50,20 @@ export interface GetStreamKeyCommandOutput extends GetStreamKeyResponse, __Metad
43
50
  export declare class GetStreamKeyCommand extends $Command<GetStreamKeyCommandInput, GetStreamKeyCommandOutput, IvsClientResolvedConfig> {
44
51
  readonly input: GetStreamKeyCommandInput;
45
52
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
53
+ /**
54
+ * @public
55
+ */
46
56
  constructor(input: GetStreamKeyCommandInput);
47
57
  /**
48
58
  * @internal
49
59
  */
50
60
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IvsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetStreamKeyCommandInput, GetStreamKeyCommandOutput>;
61
+ /**
62
+ * @internal
63
+ */
51
64
  private serialize;
65
+ /**
66
+ * @internal
67
+ */
52
68
  private deserialize;
53
69
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IvsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IvsClient";
5
5
  import { GetStreamSessionRequest, GetStreamSessionResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetStreamSessionCommand}.
8
10
  */
9
11
  export interface GetStreamSessionCommandInput extends GetStreamSessionRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetStreamSessionCommand}.
13
17
  */
14
18
  export interface GetStreamSessionCommandOutput extends GetStreamSessionResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Gets metadata on a specified stream.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface GetStreamSessionCommandOutput extends GetStreamSessionResponse,
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param GetStreamSessionCommandInput - {@link GetStreamSessionCommandInput}
34
+ * @returns {@link GetStreamSessionCommandOutput}
28
35
  * @see {@link GetStreamSessionCommandInput} for command's `input` shape.
29
36
  * @see {@link GetStreamSessionCommandOutput} for command's `response` shape.
30
37
  * @see {@link IvsClientResolvedConfig | config} for IvsClient's `config` shape.
@@ -43,11 +50,20 @@ export interface GetStreamSessionCommandOutput extends GetStreamSessionResponse,
43
50
  export declare class GetStreamSessionCommand extends $Command<GetStreamSessionCommandInput, GetStreamSessionCommandOutput, IvsClientResolvedConfig> {
44
51
  readonly input: GetStreamSessionCommandInput;
45
52
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
53
+ /**
54
+ * @public
55
+ */
46
56
  constructor(input: GetStreamSessionCommandInput);
47
57
  /**
48
58
  * @internal
49
59
  */
50
60
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IvsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetStreamSessionCommandInput, GetStreamSessionCommandOutput>;
61
+ /**
62
+ * @internal
63
+ */
51
64
  private serialize;
65
+ /**
66
+ * @internal
67
+ */
52
68
  private deserialize;
53
69
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IvsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IvsClient";
5
5
  import { ImportPlaybackKeyPairRequest, ImportPlaybackKeyPairResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ImportPlaybackKeyPairCommand}.
8
10
  */
9
11
  export interface ImportPlaybackKeyPairCommandInput extends ImportPlaybackKeyPairRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ImportPlaybackKeyPairCommand}.
13
17
  */
14
18
  export interface ImportPlaybackKeyPairCommandOutput extends ImportPlaybackKeyPairResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Imports the public portion of a new key pair and returns its <code>arn</code> and
18
23
  * <code>fingerprint</code>. The <code>privateKey</code> can then be used to generate viewer
19
24
  * authorization tokens, to grant viewers access to private channels. For more information, see
@@ -29,6 +34,8 @@ export interface ImportPlaybackKeyPairCommandOutput extends ImportPlaybackKeyPai
29
34
  * const response = await client.send(command);
30
35
  * ```
31
36
  *
37
+ * @param ImportPlaybackKeyPairCommandInput - {@link ImportPlaybackKeyPairCommandInput}
38
+ * @returns {@link ImportPlaybackKeyPairCommandOutput}
32
39
  * @see {@link ImportPlaybackKeyPairCommandInput} for command's `input` shape.
33
40
  * @see {@link ImportPlaybackKeyPairCommandOutput} for command's `response` shape.
34
41
  * @see {@link IvsClientResolvedConfig | config} for IvsClient's `config` shape.
@@ -53,11 +60,20 @@ export interface ImportPlaybackKeyPairCommandOutput extends ImportPlaybackKeyPai
53
60
  export declare class ImportPlaybackKeyPairCommand extends $Command<ImportPlaybackKeyPairCommandInput, ImportPlaybackKeyPairCommandOutput, IvsClientResolvedConfig> {
54
61
  readonly input: ImportPlaybackKeyPairCommandInput;
55
62
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
63
+ /**
64
+ * @public
65
+ */
56
66
  constructor(input: ImportPlaybackKeyPairCommandInput);
57
67
  /**
58
68
  * @internal
59
69
  */
60
70
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IvsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ImportPlaybackKeyPairCommandInput, ImportPlaybackKeyPairCommandOutput>;
71
+ /**
72
+ * @internal
73
+ */
61
74
  private serialize;
75
+ /**
76
+ * @internal
77
+ */
62
78
  private deserialize;
63
79
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IvsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IvsClient";
5
5
  import { ListChannelsRequest, ListChannelsResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListChannelsCommand}.
8
10
  */
9
11
  export interface ListChannelsCommandInput extends ListChannelsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListChannelsCommand}.
13
17
  */
14
18
  export interface ListChannelsCommandOutput extends ListChannelsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Gets summary information about all channels in your account, in the Amazon Web Services
18
23
  * region where the API request is processed. This list can be filtered to match a specified name
19
24
  * or recording-configuration ARN. Filters are mutually exclusive and cannot be used together. If
@@ -28,6 +33,8 @@ export interface ListChannelsCommandOutput extends ListChannelsResponse, __Metad
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param ListChannelsCommandInput - {@link ListChannelsCommandInput}
37
+ * @returns {@link ListChannelsCommandOutput}
31
38
  * @see {@link ListChannelsCommandInput} for command's `input` shape.
32
39
  * @see {@link ListChannelsCommandOutput} for command's `response` shape.
33
40
  * @see {@link IvsClientResolvedConfig | config} for IvsClient's `config` shape.
@@ -46,11 +53,20 @@ export interface ListChannelsCommandOutput extends ListChannelsResponse, __Metad
46
53
  export declare class ListChannelsCommand extends $Command<ListChannelsCommandInput, ListChannelsCommandOutput, IvsClientResolvedConfig> {
47
54
  readonly input: ListChannelsCommandInput;
48
55
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
56
+ /**
57
+ * @public
58
+ */
49
59
  constructor(input: ListChannelsCommandInput);
50
60
  /**
51
61
  * @internal
52
62
  */
53
63
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IvsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListChannelsCommandInput, ListChannelsCommandOutput>;
64
+ /**
65
+ * @internal
66
+ */
54
67
  private serialize;
68
+ /**
69
+ * @internal
70
+ */
55
71
  private deserialize;
56
72
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IvsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IvsClient";
5
5
  import { ListPlaybackKeyPairsRequest, ListPlaybackKeyPairsResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListPlaybackKeyPairsCommand}.
8
10
  */
9
11
  export interface ListPlaybackKeyPairsCommandInput extends ListPlaybackKeyPairsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListPlaybackKeyPairsCommand}.
13
17
  */
14
18
  export interface ListPlaybackKeyPairsCommandOutput extends ListPlaybackKeyPairsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <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
18
23
  * Channels</a> in the <i>Amazon IVS User Guide</i>.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface ListPlaybackKeyPairsCommandOutput extends ListPlaybackKeyPairsR
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param ListPlaybackKeyPairsCommandInput - {@link ListPlaybackKeyPairsCommandInput}
35
+ * @returns {@link ListPlaybackKeyPairsCommandOutput}
29
36
  * @see {@link ListPlaybackKeyPairsCommandInput} for command's `input` shape.
30
37
  * @see {@link ListPlaybackKeyPairsCommandOutput} for command's `response` shape.
31
38
  * @see {@link IvsClientResolvedConfig | config} for IvsClient's `config` shape.
@@ -41,11 +48,20 @@ export interface ListPlaybackKeyPairsCommandOutput extends ListPlaybackKeyPairsR
41
48
  export declare class ListPlaybackKeyPairsCommand extends $Command<ListPlaybackKeyPairsCommandInput, ListPlaybackKeyPairsCommandOutput, IvsClientResolvedConfig> {
42
49
  readonly input: ListPlaybackKeyPairsCommandInput;
43
50
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
51
+ /**
52
+ * @public
53
+ */
44
54
  constructor(input: ListPlaybackKeyPairsCommandInput);
45
55
  /**
46
56
  * @internal
47
57
  */
48
58
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IvsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListPlaybackKeyPairsCommandInput, ListPlaybackKeyPairsCommandOutput>;
59
+ /**
60
+ * @internal
61
+ */
49
62
  private serialize;
63
+ /**
64
+ * @internal
65
+ */
50
66
  private deserialize;
51
67
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IvsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IvsClient";
5
5
  import { ListRecordingConfigurationsRequest, ListRecordingConfigurationsResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListRecordingConfigurationsCommand}.
8
10
  */
9
11
  export interface ListRecordingConfigurationsCommandInput extends ListRecordingConfigurationsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListRecordingConfigurationsCommand}.
13
17
  */
14
18
  export interface ListRecordingConfigurationsCommandOutput extends ListRecordingConfigurationsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Gets summary information about all recording configurations in your account, in the
18
23
  * Amazon Web Services region where the API request is processed.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface ListRecordingConfigurationsCommandOutput extends ListRecordingC
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param ListRecordingConfigurationsCommandInput - {@link ListRecordingConfigurationsCommandInput}
35
+ * @returns {@link ListRecordingConfigurationsCommandOutput}
29
36
  * @see {@link ListRecordingConfigurationsCommandInput} for command's `input` shape.
30
37
  * @see {@link ListRecordingConfigurationsCommandOutput} for command's `response` shape.
31
38
  * @see {@link IvsClientResolvedConfig | config} for IvsClient's `config` shape.
@@ -44,11 +51,20 @@ export interface ListRecordingConfigurationsCommandOutput extends ListRecordingC
44
51
  export declare class ListRecordingConfigurationsCommand extends $Command<ListRecordingConfigurationsCommandInput, ListRecordingConfigurationsCommandOutput, IvsClientResolvedConfig> {
45
52
  readonly input: ListRecordingConfigurationsCommandInput;
46
53
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
54
+ /**
55
+ * @public
56
+ */
47
57
  constructor(input: ListRecordingConfigurationsCommandInput);
48
58
  /**
49
59
  * @internal
50
60
  */
51
61
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IvsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListRecordingConfigurationsCommandInput, ListRecordingConfigurationsCommandOutput>;
62
+ /**
63
+ * @internal
64
+ */
52
65
  private serialize;
66
+ /**
67
+ * @internal
68
+ */
53
69
  private deserialize;
54
70
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IvsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IvsClient";
5
5
  import { ListStreamKeysRequest, ListStreamKeysResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListStreamKeysCommand}.
8
10
  */
9
11
  export interface ListStreamKeysCommandInput extends ListStreamKeysRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListStreamKeysCommand}.
13
17
  */
14
18
  export interface ListStreamKeysCommandOutput extends ListStreamKeysResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Gets summary information about stream keys for the specified channel.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface ListStreamKeysCommandOutput extends ListStreamKeysResponse, __M
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ListStreamKeysCommandInput - {@link ListStreamKeysCommandInput}
34
+ * @returns {@link ListStreamKeysCommandOutput}
28
35
  * @see {@link ListStreamKeysCommandInput} for command's `input` shape.
29
36
  * @see {@link ListStreamKeysCommandOutput} for command's `response` shape.
30
37
  * @see {@link IvsClientResolvedConfig | config} for IvsClient's `config` shape.
@@ -43,11 +50,20 @@ export interface ListStreamKeysCommandOutput extends ListStreamKeysResponse, __M
43
50
  export declare class ListStreamKeysCommand extends $Command<ListStreamKeysCommandInput, ListStreamKeysCommandOutput, IvsClientResolvedConfig> {
44
51
  readonly input: ListStreamKeysCommandInput;
45
52
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
53
+ /**
54
+ * @public
55
+ */
46
56
  constructor(input: ListStreamKeysCommandInput);
47
57
  /**
48
58
  * @internal
49
59
  */
50
60
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IvsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListStreamKeysCommandInput, ListStreamKeysCommandOutput>;
61
+ /**
62
+ * @internal
63
+ */
51
64
  private serialize;
65
+ /**
66
+ * @internal
67
+ */
52
68
  private deserialize;
53
69
  }