@aws-sdk/client-ivs-realtime 3.637.0 → 3.648.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 (47) hide show
  1. package/README.md +45 -5
  2. package/dist-cjs/index.js +315 -2
  3. package/dist-es/IVSRealTime.js +10 -0
  4. package/dist-es/commands/CreateIngestConfigurationCommand.js +25 -0
  5. package/dist-es/commands/DeleteIngestConfigurationCommand.js +24 -0
  6. package/dist-es/commands/GetIngestConfigurationCommand.js +25 -0
  7. package/dist-es/commands/ListIngestConfigurationsCommand.js +24 -0
  8. package/dist-es/commands/UpdateIngestConfigurationCommand.js +25 -0
  9. package/dist-es/commands/index.js +5 -0
  10. package/dist-es/models/models_0.js +44 -0
  11. package/dist-es/pagination/ListIngestConfigurationsPaginator.js +4 -0
  12. package/dist-es/pagination/index.js +1 -0
  13. package/dist-es/protocols/Aws_restJson1.js +144 -0
  14. package/dist-types/IVSRealTime.d.ts +41 -5
  15. package/dist-types/IVSRealTimeClient.d.ts +12 -7
  16. package/dist-types/commands/CreateIngestConfigurationCommand.d.ts +97 -0
  17. package/dist-types/commands/CreateStageCommand.d.ts +2 -0
  18. package/dist-types/commands/DeleteIngestConfigurationCommand.d.ts +74 -0
  19. package/dist-types/commands/DeleteStageCommand.d.ts +3 -1
  20. package/dist-types/commands/DisconnectParticipantCommand.d.ts +3 -2
  21. package/dist-types/commands/GetIngestConfigurationCommand.d.ts +84 -0
  22. package/dist-types/commands/GetParticipantCommand.d.ts +1 -0
  23. package/dist-types/commands/GetStageCommand.d.ts +2 -0
  24. package/dist-types/commands/ListIngestConfigurationsCommand.d.ts +80 -0
  25. package/dist-types/commands/ListParticipantEventsCommand.d.ts +1 -1
  26. package/dist-types/commands/StartCompositionCommand.d.ts +1 -1
  27. package/dist-types/commands/UpdateIngestConfigurationCommand.d.ts +91 -0
  28. package/dist-types/commands/UpdateStageCommand.d.ts +2 -0
  29. package/dist-types/commands/index.d.ts +5 -0
  30. package/dist-types/index.d.ts +5 -5
  31. package/dist-types/models/models_0.d.ts +398 -60
  32. package/dist-types/pagination/ListIngestConfigurationsPaginator.d.ts +7 -0
  33. package/dist-types/pagination/index.d.ts +1 -0
  34. package/dist-types/protocols/Aws_restJson1.d.ts +45 -0
  35. package/dist-types/ts3.4/IVSRealTime.d.ts +86 -0
  36. package/dist-types/ts3.4/IVSRealTimeClient.d.ts +30 -0
  37. package/dist-types/ts3.4/commands/CreateIngestConfigurationCommand.d.ts +40 -0
  38. package/dist-types/ts3.4/commands/DeleteIngestConfigurationCommand.d.ts +40 -0
  39. package/dist-types/ts3.4/commands/GetIngestConfigurationCommand.d.ts +40 -0
  40. package/dist-types/ts3.4/commands/ListIngestConfigurationsCommand.d.ts +40 -0
  41. package/dist-types/ts3.4/commands/UpdateIngestConfigurationCommand.d.ts +40 -0
  42. package/dist-types/ts3.4/commands/index.d.ts +5 -0
  43. package/dist-types/ts3.4/models/models_0.d.ts +104 -0
  44. package/dist-types/ts3.4/pagination/ListIngestConfigurationsPaginator.d.ts +11 -0
  45. package/dist-types/ts3.4/pagination/index.d.ts +1 -0
  46. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +60 -0
  47. package/package.json +6 -6
@@ -8,16 +8,19 @@ import { Client as __Client, DefaultsMode as __DefaultsMode, SmithyConfiguration
8
8
  import { AwsCredentialIdentityProvider, BodyLengthCalculator as __BodyLengthCalculator, CheckOptionalClientConfig as __CheckOptionalClientConfig, ChecksumConstructor as __ChecksumConstructor, Decoder as __Decoder, Encoder as __Encoder, HashConstructor as __HashConstructor, HttpHandlerOptions as __HttpHandlerOptions, Logger as __Logger, Provider as __Provider, Provider, StreamCollector as __StreamCollector, UrlParser as __UrlParser, UserAgent as __UserAgent } from "@smithy/types";
9
9
  import { HttpAuthSchemeInputConfig, HttpAuthSchemeResolvedConfig } from "./auth/httpAuthSchemeProvider";
10
10
  import { CreateEncoderConfigurationCommandInput, CreateEncoderConfigurationCommandOutput } from "./commands/CreateEncoderConfigurationCommand";
11
+ import { CreateIngestConfigurationCommandInput, CreateIngestConfigurationCommandOutput } from "./commands/CreateIngestConfigurationCommand";
11
12
  import { CreateParticipantTokenCommandInput, CreateParticipantTokenCommandOutput } from "./commands/CreateParticipantTokenCommand";
12
13
  import { CreateStageCommandInput, CreateStageCommandOutput } from "./commands/CreateStageCommand";
13
14
  import { CreateStorageConfigurationCommandInput, CreateStorageConfigurationCommandOutput } from "./commands/CreateStorageConfigurationCommand";
14
15
  import { DeleteEncoderConfigurationCommandInput, DeleteEncoderConfigurationCommandOutput } from "./commands/DeleteEncoderConfigurationCommand";
16
+ import { DeleteIngestConfigurationCommandInput, DeleteIngestConfigurationCommandOutput } from "./commands/DeleteIngestConfigurationCommand";
15
17
  import { DeletePublicKeyCommandInput, DeletePublicKeyCommandOutput } from "./commands/DeletePublicKeyCommand";
16
18
  import { DeleteStageCommandInput, DeleteStageCommandOutput } from "./commands/DeleteStageCommand";
17
19
  import { DeleteStorageConfigurationCommandInput, DeleteStorageConfigurationCommandOutput } from "./commands/DeleteStorageConfigurationCommand";
18
20
  import { DisconnectParticipantCommandInput, DisconnectParticipantCommandOutput } from "./commands/DisconnectParticipantCommand";
19
21
  import { GetCompositionCommandInput, GetCompositionCommandOutput } from "./commands/GetCompositionCommand";
20
22
  import { GetEncoderConfigurationCommandInput, GetEncoderConfigurationCommandOutput } from "./commands/GetEncoderConfigurationCommand";
23
+ import { GetIngestConfigurationCommandInput, GetIngestConfigurationCommandOutput } from "./commands/GetIngestConfigurationCommand";
21
24
  import { GetParticipantCommandInput, GetParticipantCommandOutput } from "./commands/GetParticipantCommand";
22
25
  import { GetPublicKeyCommandInput, GetPublicKeyCommandOutput } from "./commands/GetPublicKeyCommand";
23
26
  import { GetStageCommandInput, GetStageCommandOutput } from "./commands/GetStageCommand";
@@ -26,6 +29,7 @@ import { GetStorageConfigurationCommandInput, GetStorageConfigurationCommandOutp
26
29
  import { ImportPublicKeyCommandInput, ImportPublicKeyCommandOutput } from "./commands/ImportPublicKeyCommand";
27
30
  import { ListCompositionsCommandInput, ListCompositionsCommandOutput } from "./commands/ListCompositionsCommand";
28
31
  import { ListEncoderConfigurationsCommandInput, ListEncoderConfigurationsCommandOutput } from "./commands/ListEncoderConfigurationsCommand";
32
+ import { ListIngestConfigurationsCommandInput, ListIngestConfigurationsCommandOutput } from "./commands/ListIngestConfigurationsCommand";
29
33
  import { ListParticipantEventsCommandInput, ListParticipantEventsCommandOutput } from "./commands/ListParticipantEventsCommand";
30
34
  import { ListParticipantsCommandInput, ListParticipantsCommandOutput } from "./commands/ListParticipantsCommand";
31
35
  import { ListPublicKeysCommandInput, ListPublicKeysCommandOutput } from "./commands/ListPublicKeysCommand";
@@ -37,6 +41,7 @@ import { StartCompositionCommandInput, StartCompositionCommandOutput } from "./c
37
41
  import { StopCompositionCommandInput, StopCompositionCommandOutput } from "./commands/StopCompositionCommand";
38
42
  import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand";
39
43
  import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
44
+ import { UpdateIngestConfigurationCommandInput, UpdateIngestConfigurationCommandOutput } from "./commands/UpdateIngestConfigurationCommand";
40
45
  import { UpdateStageCommandInput, UpdateStageCommandOutput } from "./commands/UpdateStageCommand";
41
46
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
42
47
  import { RuntimeExtension, RuntimeExtensionsConfig } from "./runtimeExtensions";
@@ -44,11 +49,11 @@ export { __Client };
44
49
  /**
45
50
  * @public
46
51
  */
47
- export type ServiceInputTypes = CreateEncoderConfigurationCommandInput | CreateParticipantTokenCommandInput | CreateStageCommandInput | CreateStorageConfigurationCommandInput | DeleteEncoderConfigurationCommandInput | DeletePublicKeyCommandInput | DeleteStageCommandInput | DeleteStorageConfigurationCommandInput | DisconnectParticipantCommandInput | GetCompositionCommandInput | GetEncoderConfigurationCommandInput | GetParticipantCommandInput | GetPublicKeyCommandInput | GetStageCommandInput | GetStageSessionCommandInput | GetStorageConfigurationCommandInput | ImportPublicKeyCommandInput | ListCompositionsCommandInput | ListEncoderConfigurationsCommandInput | ListParticipantEventsCommandInput | ListParticipantsCommandInput | ListPublicKeysCommandInput | ListStageSessionsCommandInput | ListStagesCommandInput | ListStorageConfigurationsCommandInput | ListTagsForResourceCommandInput | StartCompositionCommandInput | StopCompositionCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateStageCommandInput;
52
+ export type ServiceInputTypes = CreateEncoderConfigurationCommandInput | CreateIngestConfigurationCommandInput | CreateParticipantTokenCommandInput | CreateStageCommandInput | CreateStorageConfigurationCommandInput | DeleteEncoderConfigurationCommandInput | DeleteIngestConfigurationCommandInput | DeletePublicKeyCommandInput | DeleteStageCommandInput | DeleteStorageConfigurationCommandInput | DisconnectParticipantCommandInput | GetCompositionCommandInput | GetEncoderConfigurationCommandInput | GetIngestConfigurationCommandInput | GetParticipantCommandInput | GetPublicKeyCommandInput | GetStageCommandInput | GetStageSessionCommandInput | GetStorageConfigurationCommandInput | ImportPublicKeyCommandInput | ListCompositionsCommandInput | ListEncoderConfigurationsCommandInput | ListIngestConfigurationsCommandInput | ListParticipantEventsCommandInput | ListParticipantsCommandInput | ListPublicKeysCommandInput | ListStageSessionsCommandInput | ListStagesCommandInput | ListStorageConfigurationsCommandInput | ListTagsForResourceCommandInput | StartCompositionCommandInput | StopCompositionCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateIngestConfigurationCommandInput | UpdateStageCommandInput;
48
53
  /**
49
54
  * @public
50
55
  */
51
- export type ServiceOutputTypes = CreateEncoderConfigurationCommandOutput | CreateParticipantTokenCommandOutput | CreateStageCommandOutput | CreateStorageConfigurationCommandOutput | DeleteEncoderConfigurationCommandOutput | DeletePublicKeyCommandOutput | DeleteStageCommandOutput | DeleteStorageConfigurationCommandOutput | DisconnectParticipantCommandOutput | GetCompositionCommandOutput | GetEncoderConfigurationCommandOutput | GetParticipantCommandOutput | GetPublicKeyCommandOutput | GetStageCommandOutput | GetStageSessionCommandOutput | GetStorageConfigurationCommandOutput | ImportPublicKeyCommandOutput | ListCompositionsCommandOutput | ListEncoderConfigurationsCommandOutput | ListParticipantEventsCommandOutput | ListParticipantsCommandOutput | ListPublicKeysCommandOutput | ListStageSessionsCommandOutput | ListStagesCommandOutput | ListStorageConfigurationsCommandOutput | ListTagsForResourceCommandOutput | StartCompositionCommandOutput | StopCompositionCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateStageCommandOutput;
56
+ export type ServiceOutputTypes = CreateEncoderConfigurationCommandOutput | CreateIngestConfigurationCommandOutput | CreateParticipantTokenCommandOutput | CreateStageCommandOutput | CreateStorageConfigurationCommandOutput | DeleteEncoderConfigurationCommandOutput | DeleteIngestConfigurationCommandOutput | DeletePublicKeyCommandOutput | DeleteStageCommandOutput | DeleteStorageConfigurationCommandOutput | DisconnectParticipantCommandOutput | GetCompositionCommandOutput | GetEncoderConfigurationCommandOutput | GetIngestConfigurationCommandOutput | GetParticipantCommandOutput | GetPublicKeyCommandOutput | GetStageCommandOutput | GetStageSessionCommandOutput | GetStorageConfigurationCommandOutput | ImportPublicKeyCommandOutput | ListCompositionsCommandOutput | ListEncoderConfigurationsCommandOutput | ListIngestConfigurationsCommandOutput | ListParticipantEventsCommandOutput | ListParticipantsCommandOutput | ListPublicKeysCommandOutput | ListStageSessionsCommandOutput | ListStagesCommandOutput | ListStorageConfigurationsCommandOutput | ListTagsForResourceCommandOutput | StartCompositionCommandOutput | StopCompositionCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateIngestConfigurationCommandOutput | UpdateStageCommandOutput;
52
57
  /**
53
58
  * @public
54
59
  */
@@ -213,7 +218,7 @@ export interface IVSRealTimeClientResolvedConfig extends IVSRealTimeClientResolv
213
218
  * <p>
214
219
  * <b>Composition process</b> — Composites participants
215
220
  * of a stage into a single video and forwards it to a set of outputs (e.g., IVS channels).
216
- * Composition endpoints support this process.</p>
221
+ * Composition operations support this process.</p>
217
222
  * </li>
218
223
  * <li>
219
224
  * <p>
@@ -228,13 +233,13 @@ export interface IVSRealTimeClientResolvedConfig extends IVSRealTimeClientResolv
228
233
  * <p>A <i>tag</i> is a metadata label that you assign to an AWS resource. A tag
229
234
  * comprises a <i>key</i> and a <i>value</i>, both set by you. For
230
235
  * example, you might set a tag as <code>topic:nature</code> to label a particular video
231
- * category. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS Resources</a> for more information, including restrictions that apply to
232
- * tags and "Tag naming limits and requirements"; Amazon IVS stages has no service-specific
233
- * constraints beyond what is documented there.</p>
236
+ * category. See <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html">Best practices and strategies</a>
237
+ * in <i>Tagging AWS Resources and Tag Editor</i> for details, including restrictions that apply to tags and "Tag naming
238
+ * limits and requirements"; Amazon IVS stages has no service-specific constraints beyond what is documented there.</p>
234
239
  * <p>Tags can help you identify and organize your AWS resources. For example, you can use the
235
240
  * same tag for different resources to indicate that they are related. You can also use tags to
236
241
  * manage access (see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html">Access Tags</a>).</p>
237
- * <p>The Amazon IVS real-time API has these tag-related endpoints: <a>TagResource</a>, <a>UntagResource</a>, and
242
+ * <p>The Amazon IVS real-time API has these tag-related operations: <a>TagResource</a>, <a>UntagResource</a>, and
238
243
  * <a>ListTagsForResource</a>. The following resource supports tagging: Stage.</p>
239
244
  * <p>At most 50 tags can be applied to a resource.</p>
240
245
  * @public
@@ -0,0 +1,97 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { IVSRealTimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IVSRealTimeClient";
4
+ import { CreateIngestConfigurationRequest, CreateIngestConfigurationResponse } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link CreateIngestConfigurationCommand}.
14
+ */
15
+ export interface CreateIngestConfigurationCommandInput extends CreateIngestConfigurationRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link CreateIngestConfigurationCommand}.
21
+ */
22
+ export interface CreateIngestConfigurationCommandOutput extends CreateIngestConfigurationResponse, __MetadataBearer {
23
+ }
24
+ declare const CreateIngestConfigurationCommand_base: {
25
+ new (input: CreateIngestConfigurationCommandInput): import("@smithy/smithy-client").CommandImpl<CreateIngestConfigurationCommandInput, CreateIngestConfigurationCommandOutput, IVSRealTimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: CreateIngestConfigurationCommandInput): import("@smithy/smithy-client").CommandImpl<CreateIngestConfigurationCommandInput, CreateIngestConfigurationCommandOutput, IVSRealTimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Creates a new IngestConfiguration resource, used to specify the ingest protocol for a stage.</p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { IVSRealTimeClient, CreateIngestConfigurationCommand } from "@aws-sdk/client-ivs-realtime"; // ES Modules import
35
+ * // const { IVSRealTimeClient, CreateIngestConfigurationCommand } = require("@aws-sdk/client-ivs-realtime"); // CommonJS import
36
+ * const client = new IVSRealTimeClient(config);
37
+ * const input = { // CreateIngestConfigurationRequest
38
+ * name: "STRING_VALUE",
39
+ * stageArn: "STRING_VALUE",
40
+ * userId: "STRING_VALUE",
41
+ * attributes: { // ParticipantAttributes
42
+ * "<keys>": "STRING_VALUE",
43
+ * },
44
+ * ingestProtocol: "RTMP" || "RTMPS", // required
45
+ * insecureIngest: true || false,
46
+ * tags: { // Tags
47
+ * "<keys>": "STRING_VALUE",
48
+ * },
49
+ * };
50
+ * const command = new CreateIngestConfigurationCommand(input);
51
+ * const response = await client.send(command);
52
+ * // { // CreateIngestConfigurationResponse
53
+ * // ingestConfiguration: { // IngestConfiguration
54
+ * // name: "STRING_VALUE",
55
+ * // arn: "STRING_VALUE", // required
56
+ * // ingestProtocol: "RTMP" || "RTMPS", // required
57
+ * // streamKey: "STRING_VALUE", // required
58
+ * // stageArn: "STRING_VALUE", // required
59
+ * // participantId: "STRING_VALUE", // required
60
+ * // state: "STRING_VALUE", // required
61
+ * // userId: "STRING_VALUE",
62
+ * // attributes: { // ParticipantAttributes
63
+ * // "<keys>": "STRING_VALUE",
64
+ * // },
65
+ * // tags: { // Tags
66
+ * // "<keys>": "STRING_VALUE",
67
+ * // },
68
+ * // },
69
+ * // };
70
+ *
71
+ * ```
72
+ *
73
+ * @param CreateIngestConfigurationCommandInput - {@link CreateIngestConfigurationCommandInput}
74
+ * @returns {@link CreateIngestConfigurationCommandOutput}
75
+ * @see {@link CreateIngestConfigurationCommandInput} for command's `input` shape.
76
+ * @see {@link CreateIngestConfigurationCommandOutput} for command's `response` shape.
77
+ * @see {@link IVSRealTimeClientResolvedConfig | config} for IVSRealTimeClient's `config` shape.
78
+ *
79
+ * @throws {@link AccessDeniedException} (client fault)
80
+ * <p/>
81
+ *
82
+ * @throws {@link PendingVerification} (client fault)
83
+ * <p/>
84
+ *
85
+ * @throws {@link ServiceQuotaExceededException} (client fault)
86
+ * <p/>
87
+ *
88
+ * @throws {@link ValidationException} (client fault)
89
+ * <p/>
90
+ *
91
+ * @throws {@link IVSRealTimeServiceException}
92
+ * <p>Base exception class for all service exceptions from IVSRealTime service.</p>
93
+ *
94
+ * @public
95
+ */
96
+ export declare class CreateIngestConfigurationCommand extends CreateIngestConfigurationCommand_base {
97
+ }
@@ -77,6 +77,8 @@ declare const CreateStageCommand_base: {
77
77
  * // endpoints: { // StageEndpoints
78
78
  * // events: "STRING_VALUE",
79
79
  * // whip: "STRING_VALUE",
80
+ * // rtmp: "STRING_VALUE",
81
+ * // rtmps: "STRING_VALUE",
80
82
  * // },
81
83
  * // },
82
84
  * // participantTokens: [ // ParticipantTokenList
@@ -0,0 +1,74 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { IVSRealTimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IVSRealTimeClient";
4
+ import { DeleteIngestConfigurationRequest, DeleteIngestConfigurationResponse } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link DeleteIngestConfigurationCommand}.
14
+ */
15
+ export interface DeleteIngestConfigurationCommandInput extends DeleteIngestConfigurationRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link DeleteIngestConfigurationCommand}.
21
+ */
22
+ export interface DeleteIngestConfigurationCommandOutput extends DeleteIngestConfigurationResponse, __MetadataBearer {
23
+ }
24
+ declare const DeleteIngestConfigurationCommand_base: {
25
+ new (input: DeleteIngestConfigurationCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteIngestConfigurationCommandInput, DeleteIngestConfigurationCommandOutput, IVSRealTimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: DeleteIngestConfigurationCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteIngestConfigurationCommandInput, DeleteIngestConfigurationCommandOutput, IVSRealTimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Deletes a specified IngestConfiguration, so it can no longer be used to broadcast. An IngestConfiguration cannot be deleted if the publisher is actively streaming to a stage, unless <code>force</code> is set to <code>true</code>.</p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { IVSRealTimeClient, DeleteIngestConfigurationCommand } from "@aws-sdk/client-ivs-realtime"; // ES Modules import
35
+ * // const { IVSRealTimeClient, DeleteIngestConfigurationCommand } = require("@aws-sdk/client-ivs-realtime"); // CommonJS import
36
+ * const client = new IVSRealTimeClient(config);
37
+ * const input = { // DeleteIngestConfigurationRequest
38
+ * arn: "STRING_VALUE", // required
39
+ * force: true || false,
40
+ * };
41
+ * const command = new DeleteIngestConfigurationCommand(input);
42
+ * const response = await client.send(command);
43
+ * // {};
44
+ *
45
+ * ```
46
+ *
47
+ * @param DeleteIngestConfigurationCommandInput - {@link DeleteIngestConfigurationCommandInput}
48
+ * @returns {@link DeleteIngestConfigurationCommandOutput}
49
+ * @see {@link DeleteIngestConfigurationCommandInput} for command's `input` shape.
50
+ * @see {@link DeleteIngestConfigurationCommandOutput} for command's `response` shape.
51
+ * @see {@link IVSRealTimeClientResolvedConfig | config} for IVSRealTimeClient's `config` shape.
52
+ *
53
+ * @throws {@link AccessDeniedException} (client fault)
54
+ * <p/>
55
+ *
56
+ * @throws {@link ConflictException} (client fault)
57
+ * <p/>
58
+ *
59
+ * @throws {@link PendingVerification} (client fault)
60
+ * <p/>
61
+ *
62
+ * @throws {@link ResourceNotFoundException} (client fault)
63
+ * <p/>
64
+ *
65
+ * @throws {@link ValidationException} (client fault)
66
+ * <p/>
67
+ *
68
+ * @throws {@link IVSRealTimeServiceException}
69
+ * <p>Base exception class for all service exceptions from IVSRealTime service.</p>
70
+ *
71
+ * @public
72
+ */
73
+ export declare class DeleteIngestConfigurationCommand extends DeleteIngestConfigurationCommand_base {
74
+ }
@@ -27,7 +27,9 @@ declare const DeleteStageCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Shuts down and deletes the specified stage (disconnecting all participants).</p>
30
+ * <p>Shuts down and deletes the specified stage (disconnecting all participants). This operation also
31
+ * removes the <code>stageArn</code> from the associated <a>IngestConfiguration</a>, if there are participants
32
+ * using the IngestConfiguration to publish to the stage.</p>
31
33
  * @example
32
34
  * Use a bare-bones client and the command you need to make an API call.
33
35
  * ```javascript
@@ -27,8 +27,9 @@ declare const DisconnectParticipantCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Disconnects a specified participant and revokes the participant permanently from a
31
- * specified stage.</p>
30
+ * <p>Disconnects a specified participant from a specified stage. If the participant is publishing using
31
+ * an <a>IngestConfiguration</a>, DisconnectParticipant also updates the <code>stageArn</code>
32
+ * in the IngestConfiguration to be an empty string.</p>
32
33
  * @example
33
34
  * Use a bare-bones client and the command you need to make an API call.
34
35
  * ```javascript
@@ -0,0 +1,84 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { IVSRealTimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IVSRealTimeClient";
4
+ import { GetIngestConfigurationRequest, GetIngestConfigurationResponse } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link GetIngestConfigurationCommand}.
14
+ */
15
+ export interface GetIngestConfigurationCommandInput extends GetIngestConfigurationRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link GetIngestConfigurationCommand}.
21
+ */
22
+ export interface GetIngestConfigurationCommandOutput extends GetIngestConfigurationResponse, __MetadataBearer {
23
+ }
24
+ declare const GetIngestConfigurationCommand_base: {
25
+ new (input: GetIngestConfigurationCommandInput): import("@smithy/smithy-client").CommandImpl<GetIngestConfigurationCommandInput, GetIngestConfigurationCommandOutput, IVSRealTimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: GetIngestConfigurationCommandInput): import("@smithy/smithy-client").CommandImpl<GetIngestConfigurationCommandInput, GetIngestConfigurationCommandOutput, IVSRealTimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Gets information about the specified IngestConfiguration.</p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { IVSRealTimeClient, GetIngestConfigurationCommand } from "@aws-sdk/client-ivs-realtime"; // ES Modules import
35
+ * // const { IVSRealTimeClient, GetIngestConfigurationCommand } = require("@aws-sdk/client-ivs-realtime"); // CommonJS import
36
+ * const client = new IVSRealTimeClient(config);
37
+ * const input = { // GetIngestConfigurationRequest
38
+ * arn: "STRING_VALUE", // required
39
+ * };
40
+ * const command = new GetIngestConfigurationCommand(input);
41
+ * const response = await client.send(command);
42
+ * // { // GetIngestConfigurationResponse
43
+ * // ingestConfiguration: { // IngestConfiguration
44
+ * // name: "STRING_VALUE",
45
+ * // arn: "STRING_VALUE", // required
46
+ * // ingestProtocol: "RTMP" || "RTMPS", // required
47
+ * // streamKey: "STRING_VALUE", // required
48
+ * // stageArn: "STRING_VALUE", // required
49
+ * // participantId: "STRING_VALUE", // required
50
+ * // state: "STRING_VALUE", // required
51
+ * // userId: "STRING_VALUE",
52
+ * // attributes: { // ParticipantAttributes
53
+ * // "<keys>": "STRING_VALUE",
54
+ * // },
55
+ * // tags: { // Tags
56
+ * // "<keys>": "STRING_VALUE",
57
+ * // },
58
+ * // },
59
+ * // };
60
+ *
61
+ * ```
62
+ *
63
+ * @param GetIngestConfigurationCommandInput - {@link GetIngestConfigurationCommandInput}
64
+ * @returns {@link GetIngestConfigurationCommandOutput}
65
+ * @see {@link GetIngestConfigurationCommandInput} for command's `input` shape.
66
+ * @see {@link GetIngestConfigurationCommandOutput} for command's `response` shape.
67
+ * @see {@link IVSRealTimeClientResolvedConfig | config} for IVSRealTimeClient's `config` shape.
68
+ *
69
+ * @throws {@link AccessDeniedException} (client fault)
70
+ * <p/>
71
+ *
72
+ * @throws {@link ResourceNotFoundException} (client fault)
73
+ * <p/>
74
+ *
75
+ * @throws {@link ValidationException} (client fault)
76
+ * <p/>
77
+ *
78
+ * @throws {@link IVSRealTimeServiceException}
79
+ * <p>Base exception class for all service exceptions from IVSRealTime service.</p>
80
+ *
81
+ * @public
82
+ */
83
+ export declare class GetIngestConfigurationCommand extends GetIngestConfigurationCommand_base {
84
+ }
@@ -60,6 +60,7 @@ declare const GetParticipantCommand_base: {
60
60
  * // recordingS3BucketName: "STRING_VALUE",
61
61
  * // recordingS3Prefix: "STRING_VALUE",
62
62
  * // recordingState: "STRING_VALUE",
63
+ * // protocol: "UNKNOWN" || "WHIP" || "RTMP" || "RTMPS",
63
64
  * // },
64
65
  * // };
65
66
  *
@@ -56,6 +56,8 @@ declare const GetStageCommand_base: {
56
56
  * // endpoints: { // StageEndpoints
57
57
  * // events: "STRING_VALUE",
58
58
  * // whip: "STRING_VALUE",
59
+ * // rtmp: "STRING_VALUE",
60
+ * // rtmps: "STRING_VALUE",
59
61
  * // },
60
62
  * // },
61
63
  * // };
@@ -0,0 +1,80 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { IVSRealTimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IVSRealTimeClient";
4
+ import { ListIngestConfigurationsRequest, ListIngestConfigurationsResponse } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link ListIngestConfigurationsCommand}.
14
+ */
15
+ export interface ListIngestConfigurationsCommandInput extends ListIngestConfigurationsRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link ListIngestConfigurationsCommand}.
21
+ */
22
+ export interface ListIngestConfigurationsCommandOutput extends ListIngestConfigurationsResponse, __MetadataBearer {
23
+ }
24
+ declare const ListIngestConfigurationsCommand_base: {
25
+ new (input: ListIngestConfigurationsCommandInput): import("@smithy/smithy-client").CommandImpl<ListIngestConfigurationsCommandInput, ListIngestConfigurationsCommandOutput, IVSRealTimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (...[input]: [] | [ListIngestConfigurationsCommandInput]): import("@smithy/smithy-client").CommandImpl<ListIngestConfigurationsCommandInput, ListIngestConfigurationsCommandOutput, IVSRealTimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Lists all IngestConfigurations in your account, in the AWS region where the API request is processed.</p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { IVSRealTimeClient, ListIngestConfigurationsCommand } from "@aws-sdk/client-ivs-realtime"; // ES Modules import
35
+ * // const { IVSRealTimeClient, ListIngestConfigurationsCommand } = require("@aws-sdk/client-ivs-realtime"); // CommonJS import
36
+ * const client = new IVSRealTimeClient(config);
37
+ * const input = { // ListIngestConfigurationsRequest
38
+ * filterByStageArn: "STRING_VALUE",
39
+ * filterByState: "STRING_VALUE",
40
+ * nextToken: "STRING_VALUE",
41
+ * maxResults: Number("int"),
42
+ * };
43
+ * const command = new ListIngestConfigurationsCommand(input);
44
+ * const response = await client.send(command);
45
+ * // { // ListIngestConfigurationsResponse
46
+ * // ingestConfigurations: [ // IngestConfigurationList // required
47
+ * // { // IngestConfigurationSummary
48
+ * // name: "STRING_VALUE",
49
+ * // arn: "STRING_VALUE", // required
50
+ * // ingestProtocol: "RTMP" || "RTMPS", // required
51
+ * // stageArn: "STRING_VALUE", // required
52
+ * // participantId: "STRING_VALUE", // required
53
+ * // state: "STRING_VALUE", // required
54
+ * // userId: "STRING_VALUE",
55
+ * // },
56
+ * // ],
57
+ * // nextToken: "STRING_VALUE",
58
+ * // };
59
+ *
60
+ * ```
61
+ *
62
+ * @param ListIngestConfigurationsCommandInput - {@link ListIngestConfigurationsCommandInput}
63
+ * @returns {@link ListIngestConfigurationsCommandOutput}
64
+ * @see {@link ListIngestConfigurationsCommandInput} for command's `input` shape.
65
+ * @see {@link ListIngestConfigurationsCommandOutput} for command's `response` shape.
66
+ * @see {@link IVSRealTimeClientResolvedConfig | config} for IVSRealTimeClient's `config` shape.
67
+ *
68
+ * @throws {@link AccessDeniedException} (client fault)
69
+ * <p/>
70
+ *
71
+ * @throws {@link ValidationException} (client fault)
72
+ * <p/>
73
+ *
74
+ * @throws {@link IVSRealTimeServiceException}
75
+ * <p>Base exception class for all service exceptions from IVSRealTime service.</p>
76
+ *
77
+ * @public
78
+ */
79
+ export declare class ListIngestConfigurationsCommand extends ListIngestConfigurationsCommand_base {
80
+ }
@@ -51,7 +51,7 @@ declare const ListParticipantEventsCommand_base: {
51
51
  * // participantId: "STRING_VALUE",
52
52
  * // eventTime: new Date("TIMESTAMP"),
53
53
  * // remoteParticipantId: "STRING_VALUE",
54
- * // errorCode: "STRING_VALUE",
54
+ * // errorCode: "INSUFFICIENT_CAPABILITIES" || "QUOTA_EXCEEDED" || "PUBLISHER_NOT_FOUND" || "BITRATE_EXCEEDED" || "RESOLUTION_EXCEEDED" || "STREAM_DURATION_EXCEEDED" || "INVALID_AUDIO_CODEC" || "INVALID_VIDEO_CODEC" || "INVALID_PROTOCOL" || "INVALID_STREAM_KEY" || "REUSE_OF_STREAM_KEY",
55
55
  * // },
56
56
  * // ],
57
57
  * // nextToken: "STRING_VALUE",
@@ -29,7 +29,7 @@ declare const StartCompositionCommand_base: {
29
29
  /**
30
30
  * <p>Starts a Composition from a stage based on the configuration provided in the
31
31
  * request.</p>
32
- * <p>A Composition is an ephemeral resource that exists after this endpoint returns
32
+ * <p>A Composition is an ephemeral resource that exists after this operation returns
33
33
  * successfully. Composition stops and the resource is deleted:</p>
34
34
  * <ul>
35
35
  * <li>
@@ -0,0 +1,91 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { IVSRealTimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IVSRealTimeClient";
4
+ import { UpdateIngestConfigurationRequest, UpdateIngestConfigurationResponse } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link UpdateIngestConfigurationCommand}.
14
+ */
15
+ export interface UpdateIngestConfigurationCommandInput extends UpdateIngestConfigurationRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link UpdateIngestConfigurationCommand}.
21
+ */
22
+ export interface UpdateIngestConfigurationCommandOutput extends UpdateIngestConfigurationResponse, __MetadataBearer {
23
+ }
24
+ declare const UpdateIngestConfigurationCommand_base: {
25
+ new (input: UpdateIngestConfigurationCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateIngestConfigurationCommandInput, UpdateIngestConfigurationCommandOutput, IVSRealTimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: UpdateIngestConfigurationCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateIngestConfigurationCommandInput, UpdateIngestConfigurationCommandOutput, IVSRealTimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Updates a specified IngestConfiguration. Only the stage ARN attached to the IngestConfiguration can be updated. An IngestConfiguration that is active cannot be updated.</p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { IVSRealTimeClient, UpdateIngestConfigurationCommand } from "@aws-sdk/client-ivs-realtime"; // ES Modules import
35
+ * // const { IVSRealTimeClient, UpdateIngestConfigurationCommand } = require("@aws-sdk/client-ivs-realtime"); // CommonJS import
36
+ * const client = new IVSRealTimeClient(config);
37
+ * const input = { // UpdateIngestConfigurationRequest
38
+ * arn: "STRING_VALUE", // required
39
+ * stageArn: "STRING_VALUE",
40
+ * };
41
+ * const command = new UpdateIngestConfigurationCommand(input);
42
+ * const response = await client.send(command);
43
+ * // { // UpdateIngestConfigurationResponse
44
+ * // ingestConfiguration: { // IngestConfiguration
45
+ * // name: "STRING_VALUE",
46
+ * // arn: "STRING_VALUE", // required
47
+ * // ingestProtocol: "RTMP" || "RTMPS", // required
48
+ * // streamKey: "STRING_VALUE", // required
49
+ * // stageArn: "STRING_VALUE", // required
50
+ * // participantId: "STRING_VALUE", // required
51
+ * // state: "STRING_VALUE", // required
52
+ * // userId: "STRING_VALUE",
53
+ * // attributes: { // ParticipantAttributes
54
+ * // "<keys>": "STRING_VALUE",
55
+ * // },
56
+ * // tags: { // Tags
57
+ * // "<keys>": "STRING_VALUE",
58
+ * // },
59
+ * // },
60
+ * // };
61
+ *
62
+ * ```
63
+ *
64
+ * @param UpdateIngestConfigurationCommandInput - {@link UpdateIngestConfigurationCommandInput}
65
+ * @returns {@link UpdateIngestConfigurationCommandOutput}
66
+ * @see {@link UpdateIngestConfigurationCommandInput} for command's `input` shape.
67
+ * @see {@link UpdateIngestConfigurationCommandOutput} for command's `response` shape.
68
+ * @see {@link IVSRealTimeClientResolvedConfig | config} for IVSRealTimeClient's `config` shape.
69
+ *
70
+ * @throws {@link AccessDeniedException} (client fault)
71
+ * <p/>
72
+ *
73
+ * @throws {@link ConflictException} (client fault)
74
+ * <p/>
75
+ *
76
+ * @throws {@link PendingVerification} (client fault)
77
+ * <p/>
78
+ *
79
+ * @throws {@link ResourceNotFoundException} (client fault)
80
+ * <p/>
81
+ *
82
+ * @throws {@link ValidationException} (client fault)
83
+ * <p/>
84
+ *
85
+ * @throws {@link IVSRealTimeServiceException}
86
+ * <p>Base exception class for all service exceptions from IVSRealTime service.</p>
87
+ *
88
+ * @public
89
+ */
90
+ export declare class UpdateIngestConfigurationCommand extends UpdateIngestConfigurationCommand_base {
91
+ }
@@ -63,6 +63,8 @@ declare const UpdateStageCommand_base: {
63
63
  * // endpoints: { // StageEndpoints
64
64
  * // events: "STRING_VALUE",
65
65
  * // whip: "STRING_VALUE",
66
+ * // rtmp: "STRING_VALUE",
67
+ * // rtmps: "STRING_VALUE",
66
68
  * // },
67
69
  * // },
68
70
  * // };
@@ -1,14 +1,17 @@
1
1
  export * from "./CreateEncoderConfigurationCommand";
2
+ export * from "./CreateIngestConfigurationCommand";
2
3
  export * from "./CreateParticipantTokenCommand";
3
4
  export * from "./CreateStageCommand";
4
5
  export * from "./CreateStorageConfigurationCommand";
5
6
  export * from "./DeleteEncoderConfigurationCommand";
7
+ export * from "./DeleteIngestConfigurationCommand";
6
8
  export * from "./DeletePublicKeyCommand";
7
9
  export * from "./DeleteStageCommand";
8
10
  export * from "./DeleteStorageConfigurationCommand";
9
11
  export * from "./DisconnectParticipantCommand";
10
12
  export * from "./GetCompositionCommand";
11
13
  export * from "./GetEncoderConfigurationCommand";
14
+ export * from "./GetIngestConfigurationCommand";
12
15
  export * from "./GetParticipantCommand";
13
16
  export * from "./GetPublicKeyCommand";
14
17
  export * from "./GetStageCommand";
@@ -17,6 +20,7 @@ export * from "./GetStorageConfigurationCommand";
17
20
  export * from "./ImportPublicKeyCommand";
18
21
  export * from "./ListCompositionsCommand";
19
22
  export * from "./ListEncoderConfigurationsCommand";
23
+ export * from "./ListIngestConfigurationsCommand";
20
24
  export * from "./ListParticipantEventsCommand";
21
25
  export * from "./ListParticipantsCommand";
22
26
  export * from "./ListPublicKeysCommand";
@@ -28,4 +32,5 @@ export * from "./StartCompositionCommand";
28
32
  export * from "./StopCompositionCommand";
29
33
  export * from "./TagResourceCommand";
30
34
  export * from "./UntagResourceCommand";
35
+ export * from "./UpdateIngestConfigurationCommand";
31
36
  export * from "./UpdateStageCommand";