@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.
- package/README.md +184 -5
- package/dist-cjs/IVSRealTime.js +24 -0
- package/dist-cjs/commands/CreateEncoderConfigurationCommand.js +51 -0
- package/dist-cjs/commands/CreateStorageConfigurationCommand.js +51 -0
- package/dist-cjs/commands/DeleteEncoderConfigurationCommand.js +51 -0
- package/dist-cjs/commands/DeleteStorageConfigurationCommand.js +51 -0
- package/dist-cjs/commands/GetCompositionCommand.js +51 -0
- package/dist-cjs/commands/GetEncoderConfigurationCommand.js +51 -0
- package/dist-cjs/commands/GetStorageConfigurationCommand.js +51 -0
- package/dist-cjs/commands/ListCompositionsCommand.js +51 -0
- package/dist-cjs/commands/ListEncoderConfigurationsCommand.js +51 -0
- package/dist-cjs/commands/ListStorageConfigurationsCommand.js +51 -0
- package/dist-cjs/commands/StartCompositionCommand.js +51 -0
- package/dist-cjs/commands/StopCompositionCommand.js +51 -0
- package/dist-cjs/commands/index.js +12 -0
- package/dist-cjs/models/models_0.js +51 -33
- package/dist-cjs/pagination/ListCompositionsPaginator.js +29 -0
- package/dist-cjs/pagination/ListEncoderConfigurationsPaginator.js +29 -0
- package/dist-cjs/pagination/ListStorageConfigurationsPaginator.js +29 -0
- package/dist-cjs/pagination/index.js +3 -0
- package/dist-cjs/protocols/Aws_restJson1.js +1036 -101
- package/dist-es/IVSRealTime.js +24 -0
- package/dist-es/commands/CreateEncoderConfigurationCommand.js +47 -0
- package/dist-es/commands/CreateStorageConfigurationCommand.js +47 -0
- package/dist-es/commands/DeleteEncoderConfigurationCommand.js +47 -0
- package/dist-es/commands/DeleteStorageConfigurationCommand.js +47 -0
- package/dist-es/commands/GetCompositionCommand.js +47 -0
- package/dist-es/commands/GetEncoderConfigurationCommand.js +47 -0
- package/dist-es/commands/GetStorageConfigurationCommand.js +47 -0
- package/dist-es/commands/ListCompositionsCommand.js +47 -0
- package/dist-es/commands/ListEncoderConfigurationsCommand.js +47 -0
- package/dist-es/commands/ListStorageConfigurationsCommand.js +47 -0
- package/dist-es/commands/StartCompositionCommand.js +47 -0
- package/dist-es/commands/StopCompositionCommand.js +47 -0
- package/dist-es/commands/index.js +12 -0
- package/dist-es/models/models_0.js +48 -30
- package/dist-es/pagination/ListCompositionsPaginator.js +25 -0
- package/dist-es/pagination/ListEncoderConfigurationsPaginator.js +25 -0
- package/dist-es/pagination/ListStorageConfigurationsPaginator.js +25 -0
- package/dist-es/pagination/index.js +3 -0
- package/dist-es/protocols/Aws_restJson1.js +1002 -92
- package/dist-types/IVSRealTime.d.ts +172 -5
- package/dist-types/IVSRealTimeClient.d.ts +102 -7
- package/dist-types/commands/CreateEncoderConfigurationCommand.d.ts +115 -0
- package/dist-types/commands/CreateStorageConfigurationCommand.d.ts +111 -0
- package/dist-types/commands/DeleteEncoderConfigurationCommand.d.ts +90 -0
- package/dist-types/commands/DeleteStorageConfigurationCommand.d.ts +92 -0
- package/dist-types/commands/GetCompositionCommand.d.ts +134 -0
- package/dist-types/commands/GetEncoderConfigurationCommand.d.ts +103 -0
- package/dist-types/commands/GetStorageConfigurationCommand.d.ts +100 -0
- package/dist-types/commands/ListCompositionsCommand.d.ts +112 -0
- package/dist-types/commands/ListEncoderConfigurationsCommand.d.ts +99 -0
- package/dist-types/commands/ListStorageConfigurationsCommand.d.ts +102 -0
- package/dist-types/commands/StartCompositionCommand.d.ts +187 -0
- package/dist-types/commands/StopCompositionCommand.d.ts +90 -0
- package/dist-types/commands/index.d.ts +12 -0
- package/dist-types/index.d.ts +88 -5
- package/dist-types/models/models_0.d.ts +908 -92
- package/dist-types/pagination/ListCompositionsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListEncoderConfigurationsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListStorageConfigurationsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +3 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +108 -0
- package/dist-types/ts3.4/IVSRealTime.d.ts +204 -0
- package/dist-types/ts3.4/IVSRealTimeClient.d.ts +72 -0
- package/dist-types/ts3.4/commands/CreateEncoderConfigurationCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/CreateStorageConfigurationCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/DeleteEncoderConfigurationCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/DeleteStorageConfigurationCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/GetCompositionCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/GetEncoderConfigurationCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/GetStorageConfigurationCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/ListCompositionsCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/ListEncoderConfigurationsCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/ListStorageConfigurationsCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/StartCompositionCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/StopCompositionCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/index.d.ts +12 -0
- package/dist-types/ts3.4/models/models_0.d.ts +234 -34
- package/dist-types/ts3.4/pagination/ListCompositionsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListEncoderConfigurationsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListStorageConfigurationsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +3 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +144 -0
- package/package.json +4 -2
|
@@ -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 { DeleteEncoderConfigurationRequest, DeleteEncoderConfigurationResponse } from "../models/models_0";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export { __MetadataBearer, $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link DeleteEncoderConfigurationCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface DeleteEncoderConfigurationCommandInput extends DeleteEncoderConfigurationRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link DeleteEncoderConfigurationCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface DeleteEncoderConfigurationCommandOutput extends DeleteEncoderConfigurationResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>Deletes an EncoderConfiguration resource. Ensures that no Compositions are using this
|
|
27
|
+
* template; otherwise, returns an error.</p>
|
|
28
|
+
* @example
|
|
29
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
30
|
+
* ```javascript
|
|
31
|
+
* import { IVSRealTimeClient, DeleteEncoderConfigurationCommand } from "@aws-sdk/client-ivs-realtime"; // ES Modules import
|
|
32
|
+
* // const { IVSRealTimeClient, DeleteEncoderConfigurationCommand } = require("@aws-sdk/client-ivs-realtime"); // CommonJS import
|
|
33
|
+
* const client = new IVSRealTimeClient(config);
|
|
34
|
+
* const input = { // DeleteEncoderConfigurationRequest
|
|
35
|
+
* arn: "STRING_VALUE", // required
|
|
36
|
+
* };
|
|
37
|
+
* const command = new DeleteEncoderConfigurationCommand(input);
|
|
38
|
+
* const response = await client.send(command);
|
|
39
|
+
* // {};
|
|
40
|
+
*
|
|
41
|
+
* ```
|
|
42
|
+
*
|
|
43
|
+
* @param DeleteEncoderConfigurationCommandInput - {@link DeleteEncoderConfigurationCommandInput}
|
|
44
|
+
* @returns {@link DeleteEncoderConfigurationCommandOutput}
|
|
45
|
+
* @see {@link DeleteEncoderConfigurationCommandInput} for command's `input` shape.
|
|
46
|
+
* @see {@link DeleteEncoderConfigurationCommandOutput} 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 DeleteEncoderConfigurationCommand extends $Command<DeleteEncoderConfigurationCommandInput, DeleteEncoderConfigurationCommandOutput, IVSRealTimeClientResolvedConfig> {
|
|
72
|
+
readonly input: DeleteEncoderConfigurationCommandInput;
|
|
73
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
74
|
+
/**
|
|
75
|
+
* @public
|
|
76
|
+
*/
|
|
77
|
+
constructor(input: DeleteEncoderConfigurationCommandInput);
|
|
78
|
+
/**
|
|
79
|
+
* @internal
|
|
80
|
+
*/
|
|
81
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IVSRealTimeClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteEncoderConfigurationCommandInput, DeleteEncoderConfigurationCommandOutput>;
|
|
82
|
+
/**
|
|
83
|
+
* @internal
|
|
84
|
+
*/
|
|
85
|
+
private serialize;
|
|
86
|
+
/**
|
|
87
|
+
* @internal
|
|
88
|
+
*/
|
|
89
|
+
private deserialize;
|
|
90
|
+
}
|
|
@@ -0,0 +1,92 @@
|
|
|
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 { DeleteStorageConfigurationRequest, DeleteStorageConfigurationResponse } from "../models/models_0";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export { __MetadataBearer, $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link DeleteStorageConfigurationCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface DeleteStorageConfigurationCommandInput extends DeleteStorageConfigurationRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link DeleteStorageConfigurationCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface DeleteStorageConfigurationCommandOutput extends DeleteStorageConfigurationResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>Deletes the storage configuration for the specified ARN.</p>
|
|
27
|
+
* <p>If you try to delete a storage configuration that is used by a Composition, you will get an error (409 ConflictException).
|
|
28
|
+
* To avoid this, for all Compositions that reference the storage configuration, first use <a>StopComposition</a> and wait for it to complete,
|
|
29
|
+
* then use DeleteStorageConfiguration.</p>
|
|
30
|
+
* @example
|
|
31
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
32
|
+
* ```javascript
|
|
33
|
+
* import { IVSRealTimeClient, DeleteStorageConfigurationCommand } from "@aws-sdk/client-ivs-realtime"; // ES Modules import
|
|
34
|
+
* // const { IVSRealTimeClient, DeleteStorageConfigurationCommand } = require("@aws-sdk/client-ivs-realtime"); // CommonJS import
|
|
35
|
+
* const client = new IVSRealTimeClient(config);
|
|
36
|
+
* const input = { // DeleteStorageConfigurationRequest
|
|
37
|
+
* arn: "STRING_VALUE", // required
|
|
38
|
+
* };
|
|
39
|
+
* const command = new DeleteStorageConfigurationCommand(input);
|
|
40
|
+
* const response = await client.send(command);
|
|
41
|
+
* // {};
|
|
42
|
+
*
|
|
43
|
+
* ```
|
|
44
|
+
*
|
|
45
|
+
* @param DeleteStorageConfigurationCommandInput - {@link DeleteStorageConfigurationCommandInput}
|
|
46
|
+
* @returns {@link DeleteStorageConfigurationCommandOutput}
|
|
47
|
+
* @see {@link DeleteStorageConfigurationCommandInput} for command's `input` shape.
|
|
48
|
+
* @see {@link DeleteStorageConfigurationCommandOutput} for command's `response` shape.
|
|
49
|
+
* @see {@link IVSRealTimeClientResolvedConfig | config} for IVSRealTimeClient's `config` shape.
|
|
50
|
+
*
|
|
51
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
52
|
+
* <p/>
|
|
53
|
+
*
|
|
54
|
+
* @throws {@link ConflictException} (client fault)
|
|
55
|
+
* <p/>
|
|
56
|
+
*
|
|
57
|
+
* @throws {@link InternalServerException} (server fault)
|
|
58
|
+
* <p/>
|
|
59
|
+
*
|
|
60
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
61
|
+
* <p/>
|
|
62
|
+
*
|
|
63
|
+
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
64
|
+
* <p/>
|
|
65
|
+
*
|
|
66
|
+
* @throws {@link ValidationException} (client fault)
|
|
67
|
+
* <p/>
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link IVSRealTimeServiceException}
|
|
70
|
+
* <p>Base exception class for all service exceptions from IVSRealTime service.</p>
|
|
71
|
+
*
|
|
72
|
+
*/
|
|
73
|
+
export declare class DeleteStorageConfigurationCommand extends $Command<DeleteStorageConfigurationCommandInput, DeleteStorageConfigurationCommandOutput, IVSRealTimeClientResolvedConfig> {
|
|
74
|
+
readonly input: DeleteStorageConfigurationCommandInput;
|
|
75
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
76
|
+
/**
|
|
77
|
+
* @public
|
|
78
|
+
*/
|
|
79
|
+
constructor(input: DeleteStorageConfigurationCommandInput);
|
|
80
|
+
/**
|
|
81
|
+
* @internal
|
|
82
|
+
*/
|
|
83
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IVSRealTimeClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteStorageConfigurationCommandInput, DeleteStorageConfigurationCommandOutput>;
|
|
84
|
+
/**
|
|
85
|
+
* @internal
|
|
86
|
+
*/
|
|
87
|
+
private serialize;
|
|
88
|
+
/**
|
|
89
|
+
* @internal
|
|
90
|
+
*/
|
|
91
|
+
private deserialize;
|
|
92
|
+
}
|
|
@@ -0,0 +1,134 @@
|
|
|
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 { GetCompositionRequest, GetCompositionResponse } from "../models/models_0";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export { __MetadataBearer, $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetCompositionCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetCompositionCommandInput extends GetCompositionRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetCompositionCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetCompositionCommandOutput extends GetCompositionResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>Get information about the specified Composition resource.</p>
|
|
27
|
+
* @example
|
|
28
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
29
|
+
* ```javascript
|
|
30
|
+
* import { IVSRealTimeClient, GetCompositionCommand } from "@aws-sdk/client-ivs-realtime"; // ES Modules import
|
|
31
|
+
* // const { IVSRealTimeClient, GetCompositionCommand } = require("@aws-sdk/client-ivs-realtime"); // CommonJS import
|
|
32
|
+
* const client = new IVSRealTimeClient(config);
|
|
33
|
+
* const input = { // GetCompositionRequest
|
|
34
|
+
* arn: "STRING_VALUE", // required
|
|
35
|
+
* };
|
|
36
|
+
* const command = new GetCompositionCommand(input);
|
|
37
|
+
* const response = await client.send(command);
|
|
38
|
+
* // { // GetCompositionResponse
|
|
39
|
+
* // composition: { // Composition
|
|
40
|
+
* // arn: "STRING_VALUE", // required
|
|
41
|
+
* // stageArn: "STRING_VALUE", // required
|
|
42
|
+
* // state: "STRING_VALUE", // required
|
|
43
|
+
* // layout: { // LayoutConfiguration
|
|
44
|
+
* // grid: { // GridConfiguration
|
|
45
|
+
* // featuredParticipantAttribute: "STRING_VALUE",
|
|
46
|
+
* // },
|
|
47
|
+
* // },
|
|
48
|
+
* // destinations: [ // DestinationList // required
|
|
49
|
+
* // { // Destination
|
|
50
|
+
* // id: "STRING_VALUE", // required
|
|
51
|
+
* // state: "STRING_VALUE", // required
|
|
52
|
+
* // startTime: new Date("TIMESTAMP"),
|
|
53
|
+
* // endTime: new Date("TIMESTAMP"),
|
|
54
|
+
* // configuration: { // DestinationConfiguration
|
|
55
|
+
* // name: "STRING_VALUE",
|
|
56
|
+
* // channel: { // ChannelDestinationConfiguration
|
|
57
|
+
* // channelArn: "STRING_VALUE", // required
|
|
58
|
+
* // encoderConfigurationArn: "STRING_VALUE",
|
|
59
|
+
* // },
|
|
60
|
+
* // s3: { // S3DestinationConfiguration
|
|
61
|
+
* // storageConfigurationArn: "STRING_VALUE", // required
|
|
62
|
+
* // encoderConfigurationArns: [ // EncoderConfigurationArnList // required
|
|
63
|
+
* // "STRING_VALUE",
|
|
64
|
+
* // ],
|
|
65
|
+
* // recordingConfiguration: { // RecordingConfiguration
|
|
66
|
+
* // format: "STRING_VALUE",
|
|
67
|
+
* // },
|
|
68
|
+
* // },
|
|
69
|
+
* // },
|
|
70
|
+
* // detail: { // DestinationDetail
|
|
71
|
+
* // s3: { // S3Detail
|
|
72
|
+
* // recordingPrefix: "STRING_VALUE", // required
|
|
73
|
+
* // },
|
|
74
|
+
* // },
|
|
75
|
+
* // },
|
|
76
|
+
* // ],
|
|
77
|
+
* // tags: { // Tags
|
|
78
|
+
* // "<keys>": "STRING_VALUE",
|
|
79
|
+
* // },
|
|
80
|
+
* // startTime: new Date("TIMESTAMP"),
|
|
81
|
+
* // endTime: new Date("TIMESTAMP"),
|
|
82
|
+
* // },
|
|
83
|
+
* // };
|
|
84
|
+
*
|
|
85
|
+
* ```
|
|
86
|
+
*
|
|
87
|
+
* @param GetCompositionCommandInput - {@link GetCompositionCommandInput}
|
|
88
|
+
* @returns {@link GetCompositionCommandOutput}
|
|
89
|
+
* @see {@link GetCompositionCommandInput} for command's `input` shape.
|
|
90
|
+
* @see {@link GetCompositionCommandOutput} for command's `response` shape.
|
|
91
|
+
* @see {@link IVSRealTimeClientResolvedConfig | config} for IVSRealTimeClient's `config` shape.
|
|
92
|
+
*
|
|
93
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
94
|
+
* <p/>
|
|
95
|
+
*
|
|
96
|
+
* @throws {@link ConflictException} (client fault)
|
|
97
|
+
* <p/>
|
|
98
|
+
*
|
|
99
|
+
* @throws {@link InternalServerException} (server fault)
|
|
100
|
+
* <p/>
|
|
101
|
+
*
|
|
102
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
103
|
+
* <p/>
|
|
104
|
+
*
|
|
105
|
+
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
106
|
+
* <p/>
|
|
107
|
+
*
|
|
108
|
+
* @throws {@link ValidationException} (client fault)
|
|
109
|
+
* <p/>
|
|
110
|
+
*
|
|
111
|
+
* @throws {@link IVSRealTimeServiceException}
|
|
112
|
+
* <p>Base exception class for all service exceptions from IVSRealTime service.</p>
|
|
113
|
+
*
|
|
114
|
+
*/
|
|
115
|
+
export declare class GetCompositionCommand extends $Command<GetCompositionCommandInput, GetCompositionCommandOutput, IVSRealTimeClientResolvedConfig> {
|
|
116
|
+
readonly input: GetCompositionCommandInput;
|
|
117
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
118
|
+
/**
|
|
119
|
+
* @public
|
|
120
|
+
*/
|
|
121
|
+
constructor(input: GetCompositionCommandInput);
|
|
122
|
+
/**
|
|
123
|
+
* @internal
|
|
124
|
+
*/
|
|
125
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IVSRealTimeClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetCompositionCommandInput, GetCompositionCommandOutput>;
|
|
126
|
+
/**
|
|
127
|
+
* @internal
|
|
128
|
+
*/
|
|
129
|
+
private serialize;
|
|
130
|
+
/**
|
|
131
|
+
* @internal
|
|
132
|
+
*/
|
|
133
|
+
private deserialize;
|
|
134
|
+
}
|
|
@@ -0,0 +1,103 @@
|
|
|
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 { GetEncoderConfigurationRequest, GetEncoderConfigurationResponse } from "../models/models_0";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export { __MetadataBearer, $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetEncoderConfigurationCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetEncoderConfigurationCommandInput extends GetEncoderConfigurationRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetEncoderConfigurationCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetEncoderConfigurationCommandOutput extends GetEncoderConfigurationResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>Gets information about the specified EncoderConfiguration resource. </p>
|
|
27
|
+
* @example
|
|
28
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
29
|
+
* ```javascript
|
|
30
|
+
* import { IVSRealTimeClient, GetEncoderConfigurationCommand } from "@aws-sdk/client-ivs-realtime"; // ES Modules import
|
|
31
|
+
* // const { IVSRealTimeClient, GetEncoderConfigurationCommand } = require("@aws-sdk/client-ivs-realtime"); // CommonJS import
|
|
32
|
+
* const client = new IVSRealTimeClient(config);
|
|
33
|
+
* const input = { // GetEncoderConfigurationRequest
|
|
34
|
+
* arn: "STRING_VALUE", // required
|
|
35
|
+
* };
|
|
36
|
+
* const command = new GetEncoderConfigurationCommand(input);
|
|
37
|
+
* const response = await client.send(command);
|
|
38
|
+
* // { // GetEncoderConfigurationResponse
|
|
39
|
+
* // encoderConfiguration: { // EncoderConfiguration
|
|
40
|
+
* // arn: "STRING_VALUE", // required
|
|
41
|
+
* // name: "STRING_VALUE",
|
|
42
|
+
* // video: { // Video
|
|
43
|
+
* // width: Number("int"),
|
|
44
|
+
* // height: Number("int"),
|
|
45
|
+
* // framerate: Number("float"),
|
|
46
|
+
* // bitrate: Number("int"),
|
|
47
|
+
* // },
|
|
48
|
+
* // tags: { // Tags
|
|
49
|
+
* // "<keys>": "STRING_VALUE",
|
|
50
|
+
* // },
|
|
51
|
+
* // },
|
|
52
|
+
* // };
|
|
53
|
+
*
|
|
54
|
+
* ```
|
|
55
|
+
*
|
|
56
|
+
* @param GetEncoderConfigurationCommandInput - {@link GetEncoderConfigurationCommandInput}
|
|
57
|
+
* @returns {@link GetEncoderConfigurationCommandOutput}
|
|
58
|
+
* @see {@link GetEncoderConfigurationCommandInput} for command's `input` shape.
|
|
59
|
+
* @see {@link GetEncoderConfigurationCommandOutput} for command's `response` shape.
|
|
60
|
+
* @see {@link IVSRealTimeClientResolvedConfig | config} for IVSRealTimeClient's `config` shape.
|
|
61
|
+
*
|
|
62
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
63
|
+
* <p/>
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link ConflictException} (client fault)
|
|
66
|
+
* <p/>
|
|
67
|
+
*
|
|
68
|
+
* @throws {@link InternalServerException} (server fault)
|
|
69
|
+
* <p/>
|
|
70
|
+
*
|
|
71
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
72
|
+
* <p/>
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
75
|
+
* <p/>
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link ValidationException} (client fault)
|
|
78
|
+
* <p/>
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link IVSRealTimeServiceException}
|
|
81
|
+
* <p>Base exception class for all service exceptions from IVSRealTime service.</p>
|
|
82
|
+
*
|
|
83
|
+
*/
|
|
84
|
+
export declare class GetEncoderConfigurationCommand extends $Command<GetEncoderConfigurationCommandInput, GetEncoderConfigurationCommandOutput, IVSRealTimeClientResolvedConfig> {
|
|
85
|
+
readonly input: GetEncoderConfigurationCommandInput;
|
|
86
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
87
|
+
/**
|
|
88
|
+
* @public
|
|
89
|
+
*/
|
|
90
|
+
constructor(input: GetEncoderConfigurationCommandInput);
|
|
91
|
+
/**
|
|
92
|
+
* @internal
|
|
93
|
+
*/
|
|
94
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IVSRealTimeClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetEncoderConfigurationCommandInput, GetEncoderConfigurationCommandOutput>;
|
|
95
|
+
/**
|
|
96
|
+
* @internal
|
|
97
|
+
*/
|
|
98
|
+
private serialize;
|
|
99
|
+
/**
|
|
100
|
+
* @internal
|
|
101
|
+
*/
|
|
102
|
+
private deserialize;
|
|
103
|
+
}
|
|
@@ -0,0 +1,100 @@
|
|
|
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 { GetStorageConfigurationRequest, GetStorageConfigurationResponse } from "../models/models_0";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export { __MetadataBearer, $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetStorageConfigurationCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetStorageConfigurationCommandInput extends GetStorageConfigurationRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetStorageConfigurationCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetStorageConfigurationCommandOutput extends GetStorageConfigurationResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>Gets the storage configuration for the specified ARN.</p>
|
|
27
|
+
* @example
|
|
28
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
29
|
+
* ```javascript
|
|
30
|
+
* import { IVSRealTimeClient, GetStorageConfigurationCommand } from "@aws-sdk/client-ivs-realtime"; // ES Modules import
|
|
31
|
+
* // const { IVSRealTimeClient, GetStorageConfigurationCommand } = require("@aws-sdk/client-ivs-realtime"); // CommonJS import
|
|
32
|
+
* const client = new IVSRealTimeClient(config);
|
|
33
|
+
* const input = { // GetStorageConfigurationRequest
|
|
34
|
+
* arn: "STRING_VALUE", // required
|
|
35
|
+
* };
|
|
36
|
+
* const command = new GetStorageConfigurationCommand(input);
|
|
37
|
+
* const response = await client.send(command);
|
|
38
|
+
* // { // GetStorageConfigurationResponse
|
|
39
|
+
* // storageConfiguration: { // StorageConfiguration
|
|
40
|
+
* // arn: "STRING_VALUE", // required
|
|
41
|
+
* // name: "STRING_VALUE",
|
|
42
|
+
* // s3: { // S3StorageConfiguration
|
|
43
|
+
* // bucketName: "STRING_VALUE", // required
|
|
44
|
+
* // },
|
|
45
|
+
* // tags: { // Tags
|
|
46
|
+
* // "<keys>": "STRING_VALUE",
|
|
47
|
+
* // },
|
|
48
|
+
* // },
|
|
49
|
+
* // };
|
|
50
|
+
*
|
|
51
|
+
* ```
|
|
52
|
+
*
|
|
53
|
+
* @param GetStorageConfigurationCommandInput - {@link GetStorageConfigurationCommandInput}
|
|
54
|
+
* @returns {@link GetStorageConfigurationCommandOutput}
|
|
55
|
+
* @see {@link GetStorageConfigurationCommandInput} for command's `input` shape.
|
|
56
|
+
* @see {@link GetStorageConfigurationCommandOutput} for command's `response` shape.
|
|
57
|
+
* @see {@link IVSRealTimeClientResolvedConfig | config} for IVSRealTimeClient's `config` shape.
|
|
58
|
+
*
|
|
59
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
60
|
+
* <p/>
|
|
61
|
+
*
|
|
62
|
+
* @throws {@link ConflictException} (client fault)
|
|
63
|
+
* <p/>
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link InternalServerException} (server fault)
|
|
66
|
+
* <p/>
|
|
67
|
+
*
|
|
68
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
69
|
+
* <p/>
|
|
70
|
+
*
|
|
71
|
+
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
72
|
+
* <p/>
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link ValidationException} (client fault)
|
|
75
|
+
* <p/>
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link IVSRealTimeServiceException}
|
|
78
|
+
* <p>Base exception class for all service exceptions from IVSRealTime service.</p>
|
|
79
|
+
*
|
|
80
|
+
*/
|
|
81
|
+
export declare class GetStorageConfigurationCommand extends $Command<GetStorageConfigurationCommandInput, GetStorageConfigurationCommandOutput, IVSRealTimeClientResolvedConfig> {
|
|
82
|
+
readonly input: GetStorageConfigurationCommandInput;
|
|
83
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
84
|
+
/**
|
|
85
|
+
* @public
|
|
86
|
+
*/
|
|
87
|
+
constructor(input: GetStorageConfigurationCommandInput);
|
|
88
|
+
/**
|
|
89
|
+
* @internal
|
|
90
|
+
*/
|
|
91
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IVSRealTimeClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetStorageConfigurationCommandInput, GetStorageConfigurationCommandOutput>;
|
|
92
|
+
/**
|
|
93
|
+
* @internal
|
|
94
|
+
*/
|
|
95
|
+
private serialize;
|
|
96
|
+
/**
|
|
97
|
+
* @internal
|
|
98
|
+
*/
|
|
99
|
+
private deserialize;
|
|
100
|
+
}
|
|
@@ -0,0 +1,112 @@
|
|
|
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 { ListCompositionsRequest, ListCompositionsResponse } from "../models/models_0";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export { __MetadataBearer, $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ListCompositionsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListCompositionsCommandInput extends ListCompositionsRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListCompositionsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListCompositionsCommandOutput extends ListCompositionsResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>Gets summary information about all Compositions in your account, in the AWS region
|
|
27
|
+
* 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, ListCompositionsCommand } from "@aws-sdk/client-ivs-realtime"; // ES Modules import
|
|
32
|
+
* // const { IVSRealTimeClient, ListCompositionsCommand } = require("@aws-sdk/client-ivs-realtime"); // CommonJS import
|
|
33
|
+
* const client = new IVSRealTimeClient(config);
|
|
34
|
+
* const input = { // ListCompositionsRequest
|
|
35
|
+
* filterByStageArn: "STRING_VALUE",
|
|
36
|
+
* filterByEncoderConfigurationArn: "STRING_VALUE",
|
|
37
|
+
* nextToken: "STRING_VALUE",
|
|
38
|
+
* maxResults: Number("int"),
|
|
39
|
+
* };
|
|
40
|
+
* const command = new ListCompositionsCommand(input);
|
|
41
|
+
* const response = await client.send(command);
|
|
42
|
+
* // { // ListCompositionsResponse
|
|
43
|
+
* // compositions: [ // CompositionSummaryList // required
|
|
44
|
+
* // { // CompositionSummary
|
|
45
|
+
* // arn: "STRING_VALUE", // required
|
|
46
|
+
* // stageArn: "STRING_VALUE", // required
|
|
47
|
+
* // destinations: [ // DestinationSummaryList // required
|
|
48
|
+
* // { // DestinationSummary
|
|
49
|
+
* // id: "STRING_VALUE", // required
|
|
50
|
+
* // state: "STRING_VALUE", // required
|
|
51
|
+
* // startTime: new Date("TIMESTAMP"),
|
|
52
|
+
* // endTime: new Date("TIMESTAMP"),
|
|
53
|
+
* // },
|
|
54
|
+
* // ],
|
|
55
|
+
* // state: "STRING_VALUE", // required
|
|
56
|
+
* // tags: { // Tags
|
|
57
|
+
* // "<keys>": "STRING_VALUE",
|
|
58
|
+
* // },
|
|
59
|
+
* // startTime: new Date("TIMESTAMP"),
|
|
60
|
+
* // endTime: new Date("TIMESTAMP"),
|
|
61
|
+
* // },
|
|
62
|
+
* // ],
|
|
63
|
+
* // nextToken: "STRING_VALUE",
|
|
64
|
+
* // };
|
|
65
|
+
*
|
|
66
|
+
* ```
|
|
67
|
+
*
|
|
68
|
+
* @param ListCompositionsCommandInput - {@link ListCompositionsCommandInput}
|
|
69
|
+
* @returns {@link ListCompositionsCommandOutput}
|
|
70
|
+
* @see {@link ListCompositionsCommandInput} for command's `input` shape.
|
|
71
|
+
* @see {@link ListCompositionsCommandOutput} for command's `response` shape.
|
|
72
|
+
* @see {@link IVSRealTimeClientResolvedConfig | config} for IVSRealTimeClient's `config` shape.
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
75
|
+
* <p/>
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link ConflictException} (client fault)
|
|
78
|
+
* <p/>
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link InternalServerException} (server fault)
|
|
81
|
+
* <p/>
|
|
82
|
+
*
|
|
83
|
+
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
84
|
+
* <p/>
|
|
85
|
+
*
|
|
86
|
+
* @throws {@link ValidationException} (client fault)
|
|
87
|
+
* <p/>
|
|
88
|
+
*
|
|
89
|
+
* @throws {@link IVSRealTimeServiceException}
|
|
90
|
+
* <p>Base exception class for all service exceptions from IVSRealTime service.</p>
|
|
91
|
+
*
|
|
92
|
+
*/
|
|
93
|
+
export declare class ListCompositionsCommand extends $Command<ListCompositionsCommandInput, ListCompositionsCommandOutput, IVSRealTimeClientResolvedConfig> {
|
|
94
|
+
readonly input: ListCompositionsCommandInput;
|
|
95
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
96
|
+
/**
|
|
97
|
+
* @public
|
|
98
|
+
*/
|
|
99
|
+
constructor(input: ListCompositionsCommandInput);
|
|
100
|
+
/**
|
|
101
|
+
* @internal
|
|
102
|
+
*/
|
|
103
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IVSRealTimeClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListCompositionsCommandInput, ListCompositionsCommandOutput>;
|
|
104
|
+
/**
|
|
105
|
+
* @internal
|
|
106
|
+
*/
|
|
107
|
+
private serialize;
|
|
108
|
+
/**
|
|
109
|
+
* @internal
|
|
110
|
+
*/
|
|
111
|
+
private deserialize;
|
|
112
|
+
}
|