@aws-sdk/client-ivs-realtime 3.451.0 → 3.453.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 (85) hide show
  1. package/README.md +184 -5
  2. package/dist-cjs/IVSRealTime.js +24 -0
  3. package/dist-cjs/commands/CreateEncoderConfigurationCommand.js +51 -0
  4. package/dist-cjs/commands/CreateStorageConfigurationCommand.js +51 -0
  5. package/dist-cjs/commands/DeleteEncoderConfigurationCommand.js +51 -0
  6. package/dist-cjs/commands/DeleteStorageConfigurationCommand.js +51 -0
  7. package/dist-cjs/commands/GetCompositionCommand.js +51 -0
  8. package/dist-cjs/commands/GetEncoderConfigurationCommand.js +51 -0
  9. package/dist-cjs/commands/GetStorageConfigurationCommand.js +51 -0
  10. package/dist-cjs/commands/ListCompositionsCommand.js +51 -0
  11. package/dist-cjs/commands/ListEncoderConfigurationsCommand.js +51 -0
  12. package/dist-cjs/commands/ListStorageConfigurationsCommand.js +51 -0
  13. package/dist-cjs/commands/StartCompositionCommand.js +51 -0
  14. package/dist-cjs/commands/StopCompositionCommand.js +51 -0
  15. package/dist-cjs/commands/index.js +12 -0
  16. package/dist-cjs/models/models_0.js +51 -33
  17. package/dist-cjs/pagination/ListCompositionsPaginator.js +29 -0
  18. package/dist-cjs/pagination/ListEncoderConfigurationsPaginator.js +29 -0
  19. package/dist-cjs/pagination/ListStorageConfigurationsPaginator.js +29 -0
  20. package/dist-cjs/pagination/index.js +3 -0
  21. package/dist-cjs/protocols/Aws_restJson1.js +1036 -101
  22. package/dist-es/IVSRealTime.js +24 -0
  23. package/dist-es/commands/CreateEncoderConfigurationCommand.js +47 -0
  24. package/dist-es/commands/CreateStorageConfigurationCommand.js +47 -0
  25. package/dist-es/commands/DeleteEncoderConfigurationCommand.js +47 -0
  26. package/dist-es/commands/DeleteStorageConfigurationCommand.js +47 -0
  27. package/dist-es/commands/GetCompositionCommand.js +47 -0
  28. package/dist-es/commands/GetEncoderConfigurationCommand.js +47 -0
  29. package/dist-es/commands/GetStorageConfigurationCommand.js +47 -0
  30. package/dist-es/commands/ListCompositionsCommand.js +47 -0
  31. package/dist-es/commands/ListEncoderConfigurationsCommand.js +47 -0
  32. package/dist-es/commands/ListStorageConfigurationsCommand.js +47 -0
  33. package/dist-es/commands/StartCompositionCommand.js +47 -0
  34. package/dist-es/commands/StopCompositionCommand.js +47 -0
  35. package/dist-es/commands/index.js +12 -0
  36. package/dist-es/models/models_0.js +48 -30
  37. package/dist-es/pagination/ListCompositionsPaginator.js +25 -0
  38. package/dist-es/pagination/ListEncoderConfigurationsPaginator.js +25 -0
  39. package/dist-es/pagination/ListStorageConfigurationsPaginator.js +25 -0
  40. package/dist-es/pagination/index.js +3 -0
  41. package/dist-es/protocols/Aws_restJson1.js +1002 -92
  42. package/dist-types/IVSRealTime.d.ts +172 -5
  43. package/dist-types/IVSRealTimeClient.d.ts +102 -7
  44. package/dist-types/commands/CreateEncoderConfigurationCommand.d.ts +115 -0
  45. package/dist-types/commands/CreateStorageConfigurationCommand.d.ts +111 -0
  46. package/dist-types/commands/DeleteEncoderConfigurationCommand.d.ts +90 -0
  47. package/dist-types/commands/DeleteStorageConfigurationCommand.d.ts +92 -0
  48. package/dist-types/commands/GetCompositionCommand.d.ts +134 -0
  49. package/dist-types/commands/GetEncoderConfigurationCommand.d.ts +103 -0
  50. package/dist-types/commands/GetStorageConfigurationCommand.d.ts +100 -0
  51. package/dist-types/commands/ListCompositionsCommand.d.ts +112 -0
  52. package/dist-types/commands/ListEncoderConfigurationsCommand.d.ts +99 -0
  53. package/dist-types/commands/ListStorageConfigurationsCommand.d.ts +102 -0
  54. package/dist-types/commands/StartCompositionCommand.d.ts +187 -0
  55. package/dist-types/commands/StopCompositionCommand.d.ts +90 -0
  56. package/dist-types/commands/index.d.ts +12 -0
  57. package/dist-types/index.d.ts +88 -5
  58. package/dist-types/models/models_0.d.ts +908 -92
  59. package/dist-types/pagination/ListCompositionsPaginator.d.ts +7 -0
  60. package/dist-types/pagination/ListEncoderConfigurationsPaginator.d.ts +7 -0
  61. package/dist-types/pagination/ListStorageConfigurationsPaginator.d.ts +7 -0
  62. package/dist-types/pagination/index.d.ts +3 -0
  63. package/dist-types/protocols/Aws_restJson1.d.ts +108 -0
  64. package/dist-types/ts3.4/IVSRealTime.d.ts +204 -0
  65. package/dist-types/ts3.4/IVSRealTimeClient.d.ts +72 -0
  66. package/dist-types/ts3.4/commands/CreateEncoderConfigurationCommand.d.ts +42 -0
  67. package/dist-types/ts3.4/commands/CreateStorageConfigurationCommand.d.ts +42 -0
  68. package/dist-types/ts3.4/commands/DeleteEncoderConfigurationCommand.d.ts +42 -0
  69. package/dist-types/ts3.4/commands/DeleteStorageConfigurationCommand.d.ts +42 -0
  70. package/dist-types/ts3.4/commands/GetCompositionCommand.d.ts +38 -0
  71. package/dist-types/ts3.4/commands/GetEncoderConfigurationCommand.d.ts +42 -0
  72. package/dist-types/ts3.4/commands/GetStorageConfigurationCommand.d.ts +42 -0
  73. package/dist-types/ts3.4/commands/ListCompositionsCommand.d.ts +38 -0
  74. package/dist-types/ts3.4/commands/ListEncoderConfigurationsCommand.d.ts +42 -0
  75. package/dist-types/ts3.4/commands/ListStorageConfigurationsCommand.d.ts +42 -0
  76. package/dist-types/ts3.4/commands/StartCompositionCommand.d.ts +38 -0
  77. package/dist-types/ts3.4/commands/StopCompositionCommand.d.ts +38 -0
  78. package/dist-types/ts3.4/commands/index.d.ts +12 -0
  79. package/dist-types/ts3.4/models/models_0.d.ts +234 -34
  80. package/dist-types/ts3.4/pagination/ListCompositionsPaginator.d.ts +11 -0
  81. package/dist-types/ts3.4/pagination/ListEncoderConfigurationsPaginator.d.ts +11 -0
  82. package/dist-types/ts3.4/pagination/ListStorageConfigurationsPaginator.d.ts +11 -0
  83. package/dist-types/ts3.4/pagination/index.d.ts +3 -0
  84. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +144 -0
  85. package/package.json +4 -2
@@ -0,0 +1,99 @@
1
+ import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
2
+ import { Command as $Command } from "@smithy/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
4
+ import { IVSRealTimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IVSRealTimeClient";
5
+ import { ListEncoderConfigurationsRequest, ListEncoderConfigurationsResponse } from "../models/models_0";
6
+ /**
7
+ * @public
8
+ */
9
+ export { __MetadataBearer, $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link ListEncoderConfigurationsCommand}.
14
+ */
15
+ export interface ListEncoderConfigurationsCommandInput extends ListEncoderConfigurationsRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link ListEncoderConfigurationsCommand}.
21
+ */
22
+ export interface ListEncoderConfigurationsCommandOutput extends ListEncoderConfigurationsResponse, __MetadataBearer {
23
+ }
24
+ /**
25
+ * @public
26
+ * <p>Gets summary information about all EncoderConfigurations in your account, in the AWS
27
+ * region where the API request is processed.</p>
28
+ * @example
29
+ * Use a bare-bones client and the command you need to make an API call.
30
+ * ```javascript
31
+ * import { IVSRealTimeClient, ListEncoderConfigurationsCommand } from "@aws-sdk/client-ivs-realtime"; // ES Modules import
32
+ * // const { IVSRealTimeClient, ListEncoderConfigurationsCommand } = require("@aws-sdk/client-ivs-realtime"); // CommonJS import
33
+ * const client = new IVSRealTimeClient(config);
34
+ * const input = { // ListEncoderConfigurationsRequest
35
+ * nextToken: "STRING_VALUE",
36
+ * maxResults: Number("int"),
37
+ * };
38
+ * const command = new ListEncoderConfigurationsCommand(input);
39
+ * const response = await client.send(command);
40
+ * // { // ListEncoderConfigurationsResponse
41
+ * // encoderConfigurations: [ // EncoderConfigurationSummaryList // required
42
+ * // { // EncoderConfigurationSummary
43
+ * // arn: "STRING_VALUE", // required
44
+ * // name: "STRING_VALUE",
45
+ * // tags: { // Tags
46
+ * // "<keys>": "STRING_VALUE",
47
+ * // },
48
+ * // },
49
+ * // ],
50
+ * // nextToken: "STRING_VALUE",
51
+ * // };
52
+ *
53
+ * ```
54
+ *
55
+ * @param ListEncoderConfigurationsCommandInput - {@link ListEncoderConfigurationsCommandInput}
56
+ * @returns {@link ListEncoderConfigurationsCommandOutput}
57
+ * @see {@link ListEncoderConfigurationsCommandInput} for command's `input` shape.
58
+ * @see {@link ListEncoderConfigurationsCommandOutput} for command's `response` shape.
59
+ * @see {@link IVSRealTimeClientResolvedConfig | config} for IVSRealTimeClient's `config` shape.
60
+ *
61
+ * @throws {@link AccessDeniedException} (client fault)
62
+ * <p/>
63
+ *
64
+ * @throws {@link ConflictException} (client fault)
65
+ * <p/>
66
+ *
67
+ * @throws {@link InternalServerException} (server fault)
68
+ * <p/>
69
+ *
70
+ * @throws {@link ServiceQuotaExceededException} (client fault)
71
+ * <p/>
72
+ *
73
+ * @throws {@link ValidationException} (client fault)
74
+ * <p/>
75
+ *
76
+ * @throws {@link IVSRealTimeServiceException}
77
+ * <p>Base exception class for all service exceptions from IVSRealTime service.</p>
78
+ *
79
+ */
80
+ export declare class ListEncoderConfigurationsCommand extends $Command<ListEncoderConfigurationsCommandInput, ListEncoderConfigurationsCommandOutput, IVSRealTimeClientResolvedConfig> {
81
+ readonly input: ListEncoderConfigurationsCommandInput;
82
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
83
+ /**
84
+ * @public
85
+ */
86
+ constructor(input: ListEncoderConfigurationsCommandInput);
87
+ /**
88
+ * @internal
89
+ */
90
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IVSRealTimeClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListEncoderConfigurationsCommandInput, ListEncoderConfigurationsCommandOutput>;
91
+ /**
92
+ * @internal
93
+ */
94
+ private serialize;
95
+ /**
96
+ * @internal
97
+ */
98
+ private deserialize;
99
+ }
@@ -0,0 +1,102 @@
1
+ import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
2
+ import { Command as $Command } from "@smithy/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
4
+ import { IVSRealTimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IVSRealTimeClient";
5
+ import { ListStorageConfigurationsRequest, ListStorageConfigurationsResponse } from "../models/models_0";
6
+ /**
7
+ * @public
8
+ */
9
+ export { __MetadataBearer, $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link ListStorageConfigurationsCommand}.
14
+ */
15
+ export interface ListStorageConfigurationsCommandInput extends ListStorageConfigurationsRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link ListStorageConfigurationsCommand}.
21
+ */
22
+ export interface ListStorageConfigurationsCommandOutput extends ListStorageConfigurationsResponse, __MetadataBearer {
23
+ }
24
+ /**
25
+ * @public
26
+ * <p>Gets summary information about all storage configurations in your account,
27
+ * in the AWS region where the API request is processed.</p>
28
+ * @example
29
+ * Use a bare-bones client and the command you need to make an API call.
30
+ * ```javascript
31
+ * import { IVSRealTimeClient, ListStorageConfigurationsCommand } from "@aws-sdk/client-ivs-realtime"; // ES Modules import
32
+ * // const { IVSRealTimeClient, ListStorageConfigurationsCommand } = require("@aws-sdk/client-ivs-realtime"); // CommonJS import
33
+ * const client = new IVSRealTimeClient(config);
34
+ * const input = { // ListStorageConfigurationsRequest
35
+ * nextToken: "STRING_VALUE",
36
+ * maxResults: Number("int"),
37
+ * };
38
+ * const command = new ListStorageConfigurationsCommand(input);
39
+ * const response = await client.send(command);
40
+ * // { // ListStorageConfigurationsResponse
41
+ * // storageConfigurations: [ // StorageConfigurationSummaryList // required
42
+ * // { // StorageConfigurationSummary
43
+ * // arn: "STRING_VALUE", // required
44
+ * // name: "STRING_VALUE",
45
+ * // s3: { // S3StorageConfiguration
46
+ * // bucketName: "STRING_VALUE", // required
47
+ * // },
48
+ * // tags: { // Tags
49
+ * // "<keys>": "STRING_VALUE",
50
+ * // },
51
+ * // },
52
+ * // ],
53
+ * // nextToken: "STRING_VALUE",
54
+ * // };
55
+ *
56
+ * ```
57
+ *
58
+ * @param ListStorageConfigurationsCommandInput - {@link ListStorageConfigurationsCommandInput}
59
+ * @returns {@link ListStorageConfigurationsCommandOutput}
60
+ * @see {@link ListStorageConfigurationsCommandInput} for command's `input` shape.
61
+ * @see {@link ListStorageConfigurationsCommandOutput} for command's `response` shape.
62
+ * @see {@link IVSRealTimeClientResolvedConfig | config} for IVSRealTimeClient's `config` shape.
63
+ *
64
+ * @throws {@link AccessDeniedException} (client fault)
65
+ * <p/>
66
+ *
67
+ * @throws {@link ConflictException} (client fault)
68
+ * <p/>
69
+ *
70
+ * @throws {@link InternalServerException} (server fault)
71
+ * <p/>
72
+ *
73
+ * @throws {@link ServiceQuotaExceededException} (client fault)
74
+ * <p/>
75
+ *
76
+ * @throws {@link ValidationException} (client fault)
77
+ * <p/>
78
+ *
79
+ * @throws {@link IVSRealTimeServiceException}
80
+ * <p>Base exception class for all service exceptions from IVSRealTime service.</p>
81
+ *
82
+ */
83
+ export declare class ListStorageConfigurationsCommand extends $Command<ListStorageConfigurationsCommandInput, ListStorageConfigurationsCommandOutput, IVSRealTimeClientResolvedConfig> {
84
+ readonly input: ListStorageConfigurationsCommandInput;
85
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
86
+ /**
87
+ * @public
88
+ */
89
+ constructor(input: ListStorageConfigurationsCommandInput);
90
+ /**
91
+ * @internal
92
+ */
93
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IVSRealTimeClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListStorageConfigurationsCommandInput, ListStorageConfigurationsCommandOutput>;
94
+ /**
95
+ * @internal
96
+ */
97
+ private serialize;
98
+ /**
99
+ * @internal
100
+ */
101
+ private deserialize;
102
+ }
@@ -0,0 +1,187 @@
1
+ import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
2
+ import { Command as $Command } from "@smithy/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
4
+ import { IVSRealTimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IVSRealTimeClient";
5
+ import { StartCompositionRequest, StartCompositionResponse } from "../models/models_0";
6
+ /**
7
+ * @public
8
+ */
9
+ export { __MetadataBearer, $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link StartCompositionCommand}.
14
+ */
15
+ export interface StartCompositionCommandInput extends StartCompositionRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link StartCompositionCommand}.
21
+ */
22
+ export interface StartCompositionCommandOutput extends StartCompositionResponse, __MetadataBearer {
23
+ }
24
+ /**
25
+ * @public
26
+ * <p>Starts a Composition from a stage based on the configuration provided in the
27
+ * request.</p>
28
+ * <p>A Composition is an ephemeral resource that exists after this endpoint returns
29
+ * successfully. Composition stops and the resource is deleted:</p>
30
+ * <ul>
31
+ * <li>
32
+ * <p>When <a>StopComposition</a> is called.</p>
33
+ * </li>
34
+ * <li>
35
+ * <p>After a 1-minute timeout, when all participants are disconnected from the
36
+ * stage.</p>
37
+ * </li>
38
+ * <li>
39
+ * <p>After a 1-minute timeout, if there are no participants in the stage when
40
+ * StartComposition is called.</p>
41
+ * </li>
42
+ * <li>
43
+ * <p>When broadcasting to the IVS channel fails and all retries are exhausted.</p>
44
+ * </li>
45
+ * <li>
46
+ * <p>When broadcasting is disconnected and all attempts to reconnect are
47
+ * exhausted.</p>
48
+ * </li>
49
+ * </ul>
50
+ * @example
51
+ * Use a bare-bones client and the command you need to make an API call.
52
+ * ```javascript
53
+ * import { IVSRealTimeClient, StartCompositionCommand } from "@aws-sdk/client-ivs-realtime"; // ES Modules import
54
+ * // const { IVSRealTimeClient, StartCompositionCommand } = require("@aws-sdk/client-ivs-realtime"); // CommonJS import
55
+ * const client = new IVSRealTimeClient(config);
56
+ * const input = { // StartCompositionRequest
57
+ * stageArn: "STRING_VALUE", // required
58
+ * idempotencyToken: "STRING_VALUE",
59
+ * layout: { // LayoutConfiguration
60
+ * grid: { // GridConfiguration
61
+ * featuredParticipantAttribute: "STRING_VALUE",
62
+ * },
63
+ * },
64
+ * destinations: [ // DestinationConfigurationList // required
65
+ * { // DestinationConfiguration
66
+ * name: "STRING_VALUE",
67
+ * channel: { // ChannelDestinationConfiguration
68
+ * channelArn: "STRING_VALUE", // required
69
+ * encoderConfigurationArn: "STRING_VALUE",
70
+ * },
71
+ * s3: { // S3DestinationConfiguration
72
+ * storageConfigurationArn: "STRING_VALUE", // required
73
+ * encoderConfigurationArns: [ // EncoderConfigurationArnList // required
74
+ * "STRING_VALUE",
75
+ * ],
76
+ * recordingConfiguration: { // RecordingConfiguration
77
+ * format: "STRING_VALUE",
78
+ * },
79
+ * },
80
+ * },
81
+ * ],
82
+ * tags: { // Tags
83
+ * "<keys>": "STRING_VALUE",
84
+ * },
85
+ * };
86
+ * const command = new StartCompositionCommand(input);
87
+ * const response = await client.send(command);
88
+ * // { // StartCompositionResponse
89
+ * // composition: { // Composition
90
+ * // arn: "STRING_VALUE", // required
91
+ * // stageArn: "STRING_VALUE", // required
92
+ * // state: "STRING_VALUE", // required
93
+ * // layout: { // LayoutConfiguration
94
+ * // grid: { // GridConfiguration
95
+ * // featuredParticipantAttribute: "STRING_VALUE",
96
+ * // },
97
+ * // },
98
+ * // destinations: [ // DestinationList // required
99
+ * // { // Destination
100
+ * // id: "STRING_VALUE", // required
101
+ * // state: "STRING_VALUE", // required
102
+ * // startTime: new Date("TIMESTAMP"),
103
+ * // endTime: new Date("TIMESTAMP"),
104
+ * // configuration: { // DestinationConfiguration
105
+ * // name: "STRING_VALUE",
106
+ * // channel: { // ChannelDestinationConfiguration
107
+ * // channelArn: "STRING_VALUE", // required
108
+ * // encoderConfigurationArn: "STRING_VALUE",
109
+ * // },
110
+ * // s3: { // S3DestinationConfiguration
111
+ * // storageConfigurationArn: "STRING_VALUE", // required
112
+ * // encoderConfigurationArns: [ // EncoderConfigurationArnList // required
113
+ * // "STRING_VALUE",
114
+ * // ],
115
+ * // recordingConfiguration: { // RecordingConfiguration
116
+ * // format: "STRING_VALUE",
117
+ * // },
118
+ * // },
119
+ * // },
120
+ * // detail: { // DestinationDetail
121
+ * // s3: { // S3Detail
122
+ * // recordingPrefix: "STRING_VALUE", // required
123
+ * // },
124
+ * // },
125
+ * // },
126
+ * // ],
127
+ * // tags: { // Tags
128
+ * // "<keys>": "STRING_VALUE",
129
+ * // },
130
+ * // startTime: new Date("TIMESTAMP"),
131
+ * // endTime: new Date("TIMESTAMP"),
132
+ * // },
133
+ * // };
134
+ *
135
+ * ```
136
+ *
137
+ * @param StartCompositionCommandInput - {@link StartCompositionCommandInput}
138
+ * @returns {@link StartCompositionCommandOutput}
139
+ * @see {@link StartCompositionCommandInput} for command's `input` shape.
140
+ * @see {@link StartCompositionCommandOutput} for command's `response` shape.
141
+ * @see {@link IVSRealTimeClientResolvedConfig | config} for IVSRealTimeClient's `config` shape.
142
+ *
143
+ * @throws {@link AccessDeniedException} (client fault)
144
+ * <p/>
145
+ *
146
+ * @throws {@link ConflictException} (client fault)
147
+ * <p/>
148
+ *
149
+ * @throws {@link InternalServerException} (server fault)
150
+ * <p/>
151
+ *
152
+ * @throws {@link PendingVerification} (client fault)
153
+ * <p/>
154
+ *
155
+ * @throws {@link ResourceNotFoundException} (client fault)
156
+ * <p/>
157
+ *
158
+ * @throws {@link ServiceQuotaExceededException} (client fault)
159
+ * <p/>
160
+ *
161
+ * @throws {@link ValidationException} (client fault)
162
+ * <p/>
163
+ *
164
+ * @throws {@link IVSRealTimeServiceException}
165
+ * <p>Base exception class for all service exceptions from IVSRealTime service.</p>
166
+ *
167
+ */
168
+ export declare class StartCompositionCommand extends $Command<StartCompositionCommandInput, StartCompositionCommandOutput, IVSRealTimeClientResolvedConfig> {
169
+ readonly input: StartCompositionCommandInput;
170
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
171
+ /**
172
+ * @public
173
+ */
174
+ constructor(input: StartCompositionCommandInput);
175
+ /**
176
+ * @internal
177
+ */
178
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IVSRealTimeClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StartCompositionCommandInput, StartCompositionCommandOutput>;
179
+ /**
180
+ * @internal
181
+ */
182
+ private serialize;
183
+ /**
184
+ * @internal
185
+ */
186
+ private deserialize;
187
+ }
@@ -0,0 +1,90 @@
1
+ import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
2
+ import { Command as $Command } from "@smithy/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
4
+ import { IVSRealTimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IVSRealTimeClient";
5
+ import { StopCompositionRequest, StopCompositionResponse } from "../models/models_0";
6
+ /**
7
+ * @public
8
+ */
9
+ export { __MetadataBearer, $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link StopCompositionCommand}.
14
+ */
15
+ export interface StopCompositionCommandInput extends StopCompositionRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link StopCompositionCommand}.
21
+ */
22
+ export interface StopCompositionCommandOutput extends StopCompositionResponse, __MetadataBearer {
23
+ }
24
+ /**
25
+ * @public
26
+ * <p>Stops and deletes a Composition resource. Any broadcast from the Composition resource
27
+ * is stopped.</p>
28
+ * @example
29
+ * Use a bare-bones client and the command you need to make an API call.
30
+ * ```javascript
31
+ * import { IVSRealTimeClient, StopCompositionCommand } from "@aws-sdk/client-ivs-realtime"; // ES Modules import
32
+ * // const { IVSRealTimeClient, StopCompositionCommand } = require("@aws-sdk/client-ivs-realtime"); // CommonJS import
33
+ * const client = new IVSRealTimeClient(config);
34
+ * const input = { // StopCompositionRequest
35
+ * arn: "STRING_VALUE", // required
36
+ * };
37
+ * const command = new StopCompositionCommand(input);
38
+ * const response = await client.send(command);
39
+ * // {};
40
+ *
41
+ * ```
42
+ *
43
+ * @param StopCompositionCommandInput - {@link StopCompositionCommandInput}
44
+ * @returns {@link StopCompositionCommandOutput}
45
+ * @see {@link StopCompositionCommandInput} for command's `input` shape.
46
+ * @see {@link StopCompositionCommandOutput} for command's `response` shape.
47
+ * @see {@link IVSRealTimeClientResolvedConfig | config} for IVSRealTimeClient's `config` shape.
48
+ *
49
+ * @throws {@link AccessDeniedException} (client fault)
50
+ * <p/>
51
+ *
52
+ * @throws {@link ConflictException} (client fault)
53
+ * <p/>
54
+ *
55
+ * @throws {@link InternalServerException} (server fault)
56
+ * <p/>
57
+ *
58
+ * @throws {@link ResourceNotFoundException} (client fault)
59
+ * <p/>
60
+ *
61
+ * @throws {@link ServiceQuotaExceededException} (client fault)
62
+ * <p/>
63
+ *
64
+ * @throws {@link ValidationException} (client fault)
65
+ * <p/>
66
+ *
67
+ * @throws {@link IVSRealTimeServiceException}
68
+ * <p>Base exception class for all service exceptions from IVSRealTime service.</p>
69
+ *
70
+ */
71
+ export declare class StopCompositionCommand extends $Command<StopCompositionCommandInput, StopCompositionCommandOutput, IVSRealTimeClientResolvedConfig> {
72
+ readonly input: StopCompositionCommandInput;
73
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
74
+ /**
75
+ * @public
76
+ */
77
+ constructor(input: StopCompositionCommandInput);
78
+ /**
79
+ * @internal
80
+ */
81
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IVSRealTimeClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StopCompositionCommandInput, StopCompositionCommandOutput>;
82
+ /**
83
+ * @internal
84
+ */
85
+ private serialize;
86
+ /**
87
+ * @internal
88
+ */
89
+ private deserialize;
90
+ }
@@ -1,15 +1,27 @@
1
+ export * from "./CreateEncoderConfigurationCommand";
1
2
  export * from "./CreateParticipantTokenCommand";
2
3
  export * from "./CreateStageCommand";
4
+ export * from "./CreateStorageConfigurationCommand";
5
+ export * from "./DeleteEncoderConfigurationCommand";
3
6
  export * from "./DeleteStageCommand";
7
+ export * from "./DeleteStorageConfigurationCommand";
4
8
  export * from "./DisconnectParticipantCommand";
9
+ export * from "./GetCompositionCommand";
10
+ export * from "./GetEncoderConfigurationCommand";
5
11
  export * from "./GetParticipantCommand";
6
12
  export * from "./GetStageCommand";
7
13
  export * from "./GetStageSessionCommand";
14
+ export * from "./GetStorageConfigurationCommand";
15
+ export * from "./ListCompositionsCommand";
16
+ export * from "./ListEncoderConfigurationsCommand";
8
17
  export * from "./ListParticipantEventsCommand";
9
18
  export * from "./ListParticipantsCommand";
10
19
  export * from "./ListStageSessionsCommand";
11
20
  export * from "./ListStagesCommand";
21
+ export * from "./ListStorageConfigurationsCommand";
12
22
  export * from "./ListTagsForResourceCommand";
23
+ export * from "./StartCompositionCommand";
24
+ export * from "./StopCompositionCommand";
13
25
  export * from "./TagResourceCommand";
14
26
  export * from "./UntagResourceCommand";
15
27
  export * from "./UpdateStageCommand";
@@ -15,11 +15,20 @@
15
15
  * <p>A <i>participant token</i> is a token that authenticates a participant when they join a stage.</p>
16
16
  * </li>
17
17
  * <li>
18
- * <p>A <i>participant object</i> represents participants
19
- * (people) in the stage and contains information about them. When a token is created, it
20
- * includes a participant ID; when a participant uses that token to join a stage, the
21
- * participant is associated with that participant ID There is a 1:1 mapping between
22
- * participant tokens and participants.</p>
18
+ * <p>A <i>participant object</i> represents participants (people) in the stage and
19
+ * contains information about them. When a token is created, it includes a participant ID;
20
+ * when a participant uses that token to join a stage, the participant is associated with
21
+ * that participant ID. There is a 1:1 mapping between participant tokens and
22
+ * participants.</p>
23
+ * </li>
24
+ * <li>
25
+ * <p>Server-side composition: The <i>composition</i> process composites participants
26
+ * of a stage into a single video and forwards it to a set of outputs (e.g., IVS channels).
27
+ * Composition endpoints support this process.</p>
28
+ * </li>
29
+ * <li>
30
+ * <p>Server-side composition: A <i>composition</i> controls the look of the outputs,
31
+ * including how participants are positioned in the video.</p>
23
32
  * </li>
24
33
  * </ul>
25
34
  * <p>
@@ -105,6 +114,80 @@
105
114
  * </li>
106
115
  * </ul>
107
116
  * <p>
117
+ * <b>Composition Endpoints</b>
118
+ * </p>
119
+ * <ul>
120
+ * <li>
121
+ * <p>
122
+ * <a>GetComposition</a> — Gets information about the specified
123
+ * Composition resource.</p>
124
+ * </li>
125
+ * <li>
126
+ * <p>
127
+ * <a>ListCompositions</a> — Gets summary information about all
128
+ * Compositions in your account, in the AWS region where the API request is processed.</p>
129
+ * </li>
130
+ * <li>
131
+ * <p>
132
+ * <a>StartComposition</a> — Starts a Composition from a stage based on
133
+ * the configuration provided in the request.</p>
134
+ * </li>
135
+ * <li>
136
+ * <p>
137
+ * <a>StopComposition</a> — Stops and deletes a Composition resource.
138
+ * Any broadcast from the Composition resource is stopped.</p>
139
+ * </li>
140
+ * </ul>
141
+ * <p>
142
+ * <b>EncoderConfiguration Endpoints</b>
143
+ * </p>
144
+ * <ul>
145
+ * <li>
146
+ * <p>
147
+ * <a>CreateEncoderConfiguration</a> — Creates an EncoderConfiguration object.</p>
148
+ * </li>
149
+ * <li>
150
+ * <p>
151
+ * <a>DeleteEncoderConfiguration</a> — Deletes an EncoderConfiguration
152
+ * resource. Ensures that no Compositions are using this template; otherwise, returns an
153
+ * error.</p>
154
+ * </li>
155
+ * <li>
156
+ * <p>
157
+ * <a>GetEncoderConfiguration</a> — Gets information about the specified
158
+ * EncoderConfiguration resource.</p>
159
+ * </li>
160
+ * <li>
161
+ * <p>
162
+ * <a>ListEncoderConfigurations</a> — Gets summary information about all
163
+ * EncoderConfigurations in your account, in the AWS region where the API request is
164
+ * processed.</p>
165
+ * </li>
166
+ * </ul>
167
+ * <p>
168
+ * <b>StorageConfiguration Endpoints</b>
169
+ * </p>
170
+ * <ul>
171
+ * <li>
172
+ * <p>
173
+ * <a>CreateStorageConfiguration</a> — Creates a new storage configuration, used to enable
174
+ * recording to Amazon S3.</p>
175
+ * </li>
176
+ * <li>
177
+ * <p>
178
+ * <a>DeleteStorageConfiguration</a> — Deletes the storage configuration for the specified ARN.</p>
179
+ * </li>
180
+ * <li>
181
+ * <p>
182
+ * <a>GetStorageConfiguration</a> — Gets the storage configuration for the specified ARN.</p>
183
+ * </li>
184
+ * <li>
185
+ * <p>
186
+ * <a>ListStorageConfigurations</a> — Gets summary information about all storage configurations in your
187
+ * account, in the AWS region where the API request is processed.</p>
188
+ * </li>
189
+ * </ul>
190
+ * <p>
108
191
  * <b>Tags Endpoints</b>
109
192
  * </p>
110
193
  * <ul>