@aws-sdk/client-ivs-realtime 3.329.0 → 3.332.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 +82 -1
- package/dist-cjs/IVSRealTime.js +10 -0
- package/dist-cjs/commands/GetParticipantCommand.js +45 -0
- package/dist-cjs/commands/GetStageSessionCommand.js +45 -0
- package/dist-cjs/commands/ListParticipantEventsCommand.js +45 -0
- package/dist-cjs/commands/ListParticipantsCommand.js +45 -0
- package/dist-cjs/commands/ListStageSessionsCommand.js +45 -0
- package/dist-cjs/commands/index.js +5 -0
- package/dist-cjs/models/models_0.js +19 -1
- package/dist-cjs/pagination/ListParticipantEventsPaginator.js +29 -0
- package/dist-cjs/pagination/ListParticipantsPaginator.js +29 -0
- package/dist-cjs/pagination/ListStageSessionsPaginator.js +29 -0
- package/dist-cjs/pagination/index.js +3 -0
- package/dist-cjs/protocols/Aws_restJson1.js +381 -1
- package/dist-es/IVSRealTime.js +10 -0
- package/dist-es/commands/GetParticipantCommand.js +41 -0
- package/dist-es/commands/GetStageSessionCommand.js +41 -0
- package/dist-es/commands/ListParticipantEventsCommand.js +41 -0
- package/dist-es/commands/ListParticipantsCommand.js +41 -0
- package/dist-es/commands/ListStageSessionsCommand.js +41 -0
- package/dist-es/commands/index.js +5 -0
- package/dist-es/models/models_0.js +18 -0
- package/dist-es/pagination/ListParticipantEventsPaginator.js +25 -0
- package/dist-es/pagination/ListParticipantsPaginator.js +25 -0
- package/dist-es/pagination/ListStageSessionsPaginator.js +25 -0
- package/dist-es/pagination/index.js +3 -0
- package/dist-es/protocols/Aws_restJson1.js +371 -1
- package/dist-types/IVSRealTime.d.ts +77 -1
- package/dist-types/IVSRealTimeClient.d.ts +49 -3
- package/dist-types/commands/CreateParticipantTokenCommand.d.ts +5 -3
- package/dist-types/commands/DisconnectParticipantCommand.d.ts +2 -1
- package/dist-types/commands/GetParticipantCommand.d.ts +89 -0
- package/dist-types/commands/GetStageSessionCommand.d.ts +83 -0
- package/dist-types/commands/ListParticipantEventsCommand.d.ts +89 -0
- package/dist-types/commands/ListParticipantsCommand.d.ts +90 -0
- package/dist-types/commands/ListStageSessionsCommand.d.ts +84 -0
- package/dist-types/commands/ListStagesCommand.d.ts +2 -1
- package/dist-types/commands/index.d.ts +5 -0
- package/dist-types/models/models_0.d.ts +405 -33
- package/dist-types/pagination/ListParticipantEventsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListParticipantsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListStageSessionsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +3 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +45 -0
- package/dist-types/ts3.4/IVSRealTime.d.ts +85 -0
- package/dist-types/ts3.4/IVSRealTimeClient.d.ts +30 -0
- package/dist-types/ts3.4/commands/GetParticipantCommand.d.ts +37 -0
- package/dist-types/ts3.4/commands/GetStageSessionCommand.d.ts +37 -0
- package/dist-types/ts3.4/commands/ListParticipantEventsCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/ListParticipantsCommand.d.ts +37 -0
- package/dist-types/ts3.4/commands/ListStageSessionsCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/index.d.ts +5 -0
- package/dist-types/ts3.4/models/models_0.d.ts +103 -0
- package/dist-types/ts3.4/pagination/ListParticipantEventsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListParticipantsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListStageSessionsPaginator.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 +60 -0
- package/package.json +5 -5
|
@@ -11,8 +11,13 @@ import { CreateParticipantTokenCommandInput, CreateParticipantTokenCommandOutput
|
|
|
11
11
|
import { CreateStageCommandInput, CreateStageCommandOutput } from "./commands/CreateStageCommand";
|
|
12
12
|
import { DeleteStageCommandInput, DeleteStageCommandOutput } from "./commands/DeleteStageCommand";
|
|
13
13
|
import { DisconnectParticipantCommandInput, DisconnectParticipantCommandOutput } from "./commands/DisconnectParticipantCommand";
|
|
14
|
+
import { GetParticipantCommandInput, GetParticipantCommandOutput } from "./commands/GetParticipantCommand";
|
|
14
15
|
import { GetStageCommandInput, GetStageCommandOutput } from "./commands/GetStageCommand";
|
|
16
|
+
import { GetStageSessionCommandInput, GetStageSessionCommandOutput } from "./commands/GetStageSessionCommand";
|
|
17
|
+
import { ListParticipantEventsCommandInput, ListParticipantEventsCommandOutput } from "./commands/ListParticipantEventsCommand";
|
|
18
|
+
import { ListParticipantsCommandInput, ListParticipantsCommandOutput } from "./commands/ListParticipantsCommand";
|
|
15
19
|
import { ListStagesCommandInput, ListStagesCommandOutput } from "./commands/ListStagesCommand";
|
|
20
|
+
import { ListStageSessionsCommandInput, ListStageSessionsCommandOutput } from "./commands/ListStageSessionsCommand";
|
|
16
21
|
import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } from "./commands/ListTagsForResourceCommand";
|
|
17
22
|
import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand";
|
|
18
23
|
import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
|
|
@@ -21,11 +26,11 @@ import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, Endpoi
|
|
|
21
26
|
/**
|
|
22
27
|
* @public
|
|
23
28
|
*/
|
|
24
|
-
export declare type ServiceInputTypes = CreateParticipantTokenCommandInput | CreateStageCommandInput | DeleteStageCommandInput | DisconnectParticipantCommandInput | GetStageCommandInput | ListStagesCommandInput | ListTagsForResourceCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateStageCommandInput;
|
|
29
|
+
export declare type ServiceInputTypes = CreateParticipantTokenCommandInput | CreateStageCommandInput | DeleteStageCommandInput | DisconnectParticipantCommandInput | GetParticipantCommandInput | GetStageCommandInput | GetStageSessionCommandInput | ListParticipantEventsCommandInput | ListParticipantsCommandInput | ListStageSessionsCommandInput | ListStagesCommandInput | ListTagsForResourceCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateStageCommandInput;
|
|
25
30
|
/**
|
|
26
31
|
* @public
|
|
27
32
|
*/
|
|
28
|
-
export declare type ServiceOutputTypes = CreateParticipantTokenCommandOutput | CreateStageCommandOutput | DeleteStageCommandOutput | DisconnectParticipantCommandOutput | GetStageCommandOutput | ListStagesCommandOutput | ListTagsForResourceCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateStageCommandOutput;
|
|
33
|
+
export declare type ServiceOutputTypes = CreateParticipantTokenCommandOutput | CreateStageCommandOutput | DeleteStageCommandOutput | DisconnectParticipantCommandOutput | GetParticipantCommandOutput | GetStageCommandOutput | GetStageSessionCommandOutput | ListParticipantEventsCommandOutput | ListParticipantsCommandOutput | ListStageSessionsCommandOutput | ListStagesCommandOutput | ListTagsForResourceCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateStageCommandOutput;
|
|
29
34
|
/**
|
|
30
35
|
* @public
|
|
31
36
|
*/
|
|
@@ -160,7 +165,24 @@ export interface IVSRealTimeClientResolvedConfig extends IVSRealTimeClientResolv
|
|
|
160
165
|
* API and an AWS EventBridge event stream for responses. JSON is used for both requests and responses,
|
|
161
166
|
* including errors.
|
|
162
167
|
* </p>
|
|
163
|
-
* <p>Terminology
|
|
168
|
+
* <p>Terminology:</p>
|
|
169
|
+
* <ul>
|
|
170
|
+
* <li>
|
|
171
|
+
* <p>The IVS stage API sometimes is referred to as the IVS <i>RealTime</i>
|
|
172
|
+
* API.</p>
|
|
173
|
+
* </li>
|
|
174
|
+
* <li>
|
|
175
|
+
* <p>A <i>participant token</i> is an authorization token used to publish/subscribe
|
|
176
|
+
* to a stage.</p>
|
|
177
|
+
* </li>
|
|
178
|
+
* <li>
|
|
179
|
+
* <p>A <i>participant object</i> represents participants
|
|
180
|
+
* (people) in the stage and contains information about them. When a token is created, it
|
|
181
|
+
* includes a participant ID; when a participant uses that token to join a stage, the
|
|
182
|
+
* participant is associated with that participant ID There is a 1:1 mapping between
|
|
183
|
+
* participant tokens and participants.</p>
|
|
184
|
+
* </li>
|
|
185
|
+
* </ul>
|
|
164
186
|
* <p>
|
|
165
187
|
* <b>Resources</b>
|
|
166
188
|
* </p>
|
|
@@ -208,14 +230,38 @@ export interface IVSRealTimeClientResolvedConfig extends IVSRealTimeClientResolv
|
|
|
208
230
|
* </li>
|
|
209
231
|
* <li>
|
|
210
232
|
* <p>
|
|
233
|
+
* <a>GetParticipant</a> — Gets information about the specified
|
|
234
|
+
* participant token.</p>
|
|
235
|
+
* </li>
|
|
236
|
+
* <li>
|
|
237
|
+
* <p>
|
|
211
238
|
* <a>GetStage</a> — Gets information for the specified stage.</p>
|
|
212
239
|
* </li>
|
|
213
240
|
* <li>
|
|
214
241
|
* <p>
|
|
242
|
+
* <a>GetStageSession</a> — Gets information for the specified stage
|
|
243
|
+
* session.</p>
|
|
244
|
+
* </li>
|
|
245
|
+
* <li>
|
|
246
|
+
* <p>
|
|
247
|
+
* <a>ListParticipantEvents</a> — Lists events for a specified
|
|
248
|
+
* participant that occurred during a specified stage session.</p>
|
|
249
|
+
* </li>
|
|
250
|
+
* <li>
|
|
251
|
+
* <p>
|
|
252
|
+
* <a>ListParticipants</a> — Lists all participants in a specified stage
|
|
253
|
+
* session.</p>
|
|
254
|
+
* </li>
|
|
255
|
+
* <li>
|
|
256
|
+
* <p>
|
|
215
257
|
* <a>ListStages</a> — Gets summary information about all stages in your account, in the AWS region where the API request is processed.</p>
|
|
216
258
|
* </li>
|
|
217
259
|
* <li>
|
|
218
260
|
* <p>
|
|
261
|
+
* <a>ListStageSessions</a> — Gets all sessions for a specified stage.</p>
|
|
262
|
+
* </li>
|
|
263
|
+
* <li>
|
|
264
|
+
* <p>
|
|
219
265
|
* <a>UpdateStage</a> — Updates a stage’s configuration.</p>
|
|
220
266
|
* </li>
|
|
221
267
|
* </ul>
|
|
@@ -19,9 +19,11 @@ export interface CreateParticipantTokenCommandOutput extends CreateParticipantTo
|
|
|
19
19
|
}
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
|
-
* <p>Creates an additional token for a specified stage. This can be done after stage creation
|
|
23
|
-
*
|
|
24
|
-
*
|
|
22
|
+
* <p>Creates an additional token for a specified stage. This can be done after stage creation
|
|
23
|
+
* or when tokens expire. Tokens always are scoped to the stage for which they are
|
|
24
|
+
* created.</p>
|
|
25
|
+
* <p>Encryption keys are owned by Amazon IVS and never used directly by your
|
|
26
|
+
* application.</p>
|
|
25
27
|
* @example
|
|
26
28
|
* Use a bare-bones client and the command you need to make an API call.
|
|
27
29
|
* ```javascript
|
|
@@ -19,7 +19,8 @@ export interface DisconnectParticipantCommandOutput extends DisconnectParticipan
|
|
|
19
19
|
}
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
|
-
* <p>Disconnects a specified participant and revokes the participant permanently from a
|
|
22
|
+
* <p>Disconnects a specified participant and revokes the participant permanently from a
|
|
23
|
+
* specified stage.</p>
|
|
23
24
|
* @example
|
|
24
25
|
* Use a bare-bones client and the command you need to make an API call.
|
|
25
26
|
* ```javascript
|
|
@@ -0,0 +1,89 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
4
|
+
import { IVSRealTimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IVSRealTimeClient";
|
|
5
|
+
import { GetParticipantRequest, GetParticipantResponse } from "../models/models_0";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
9
|
+
* The input for {@link GetParticipantCommand}.
|
|
10
|
+
*/
|
|
11
|
+
export interface GetParticipantCommandInput extends GetParticipantRequest {
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
16
|
+
* The output of {@link GetParticipantCommand}.
|
|
17
|
+
*/
|
|
18
|
+
export interface GetParticipantCommandOutput extends GetParticipantResponse, __MetadataBearer {
|
|
19
|
+
}
|
|
20
|
+
/**
|
|
21
|
+
* @public
|
|
22
|
+
* <p>Gets information about the specified participant token.</p>
|
|
23
|
+
* @example
|
|
24
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
25
|
+
* ```javascript
|
|
26
|
+
* import { IVSRealTimeClient, GetParticipantCommand } from "@aws-sdk/client-ivs-realtime"; // ES Modules import
|
|
27
|
+
* // const { IVSRealTimeClient, GetParticipantCommand } = require("@aws-sdk/client-ivs-realtime"); // CommonJS import
|
|
28
|
+
* const client = new IVSRealTimeClient(config);
|
|
29
|
+
* const input = { // GetParticipantRequest
|
|
30
|
+
* stageArn: "STRING_VALUE", // required
|
|
31
|
+
* sessionId: "STRING_VALUE", // required
|
|
32
|
+
* participantId: "STRING_VALUE", // required
|
|
33
|
+
* };
|
|
34
|
+
* const command = new GetParticipantCommand(input);
|
|
35
|
+
* const response = await client.send(command);
|
|
36
|
+
* // { // GetParticipantResponse
|
|
37
|
+
* // participant: { // Participant
|
|
38
|
+
* // participantId: "STRING_VALUE",
|
|
39
|
+
* // userId: "STRING_VALUE",
|
|
40
|
+
* // state: "STRING_VALUE",
|
|
41
|
+
* // firstJoinTime: new Date("TIMESTAMP"),
|
|
42
|
+
* // attributes: { // ParticipantAttributes
|
|
43
|
+
* // "<keys>": "STRING_VALUE",
|
|
44
|
+
* // },
|
|
45
|
+
* // published: true || false,
|
|
46
|
+
* // },
|
|
47
|
+
* // };
|
|
48
|
+
*
|
|
49
|
+
* ```
|
|
50
|
+
*
|
|
51
|
+
* @param GetParticipantCommandInput - {@link GetParticipantCommandInput}
|
|
52
|
+
* @returns {@link GetParticipantCommandOutput}
|
|
53
|
+
* @see {@link GetParticipantCommandInput} for command's `input` shape.
|
|
54
|
+
* @see {@link GetParticipantCommandOutput} for command's `response` shape.
|
|
55
|
+
* @see {@link IVSRealTimeClientResolvedConfig | config} for IVSRealTimeClient's `config` shape.
|
|
56
|
+
*
|
|
57
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
58
|
+
* <p/>
|
|
59
|
+
*
|
|
60
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
61
|
+
* <p/>
|
|
62
|
+
*
|
|
63
|
+
* @throws {@link ValidationException} (client fault)
|
|
64
|
+
* <p/>
|
|
65
|
+
*
|
|
66
|
+
* @throws {@link IVSRealTimeServiceException}
|
|
67
|
+
* <p>Base exception class for all service exceptions from IVSRealTime service.</p>
|
|
68
|
+
*
|
|
69
|
+
*/
|
|
70
|
+
export declare class GetParticipantCommand extends $Command<GetParticipantCommandInput, GetParticipantCommandOutput, IVSRealTimeClientResolvedConfig> {
|
|
71
|
+
readonly input: GetParticipantCommandInput;
|
|
72
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
73
|
+
/**
|
|
74
|
+
* @public
|
|
75
|
+
*/
|
|
76
|
+
constructor(input: GetParticipantCommandInput);
|
|
77
|
+
/**
|
|
78
|
+
* @internal
|
|
79
|
+
*/
|
|
80
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IVSRealTimeClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetParticipantCommandInput, GetParticipantCommandOutput>;
|
|
81
|
+
/**
|
|
82
|
+
* @internal
|
|
83
|
+
*/
|
|
84
|
+
private serialize;
|
|
85
|
+
/**
|
|
86
|
+
* @internal
|
|
87
|
+
*/
|
|
88
|
+
private deserialize;
|
|
89
|
+
}
|
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
4
|
+
import { IVSRealTimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IVSRealTimeClient";
|
|
5
|
+
import { GetStageSessionRequest, GetStageSessionResponse } from "../models/models_0";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
9
|
+
* The input for {@link GetStageSessionCommand}.
|
|
10
|
+
*/
|
|
11
|
+
export interface GetStageSessionCommandInput extends GetStageSessionRequest {
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
16
|
+
* The output of {@link GetStageSessionCommand}.
|
|
17
|
+
*/
|
|
18
|
+
export interface GetStageSessionCommandOutput extends GetStageSessionResponse, __MetadataBearer {
|
|
19
|
+
}
|
|
20
|
+
/**
|
|
21
|
+
* @public
|
|
22
|
+
* <p>Gets information for the specified stage session.</p>
|
|
23
|
+
* @example
|
|
24
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
25
|
+
* ```javascript
|
|
26
|
+
* import { IVSRealTimeClient, GetStageSessionCommand } from "@aws-sdk/client-ivs-realtime"; // ES Modules import
|
|
27
|
+
* // const { IVSRealTimeClient, GetStageSessionCommand } = require("@aws-sdk/client-ivs-realtime"); // CommonJS import
|
|
28
|
+
* const client = new IVSRealTimeClient(config);
|
|
29
|
+
* const input = { // GetStageSessionRequest
|
|
30
|
+
* stageArn: "STRING_VALUE", // required
|
|
31
|
+
* sessionId: "STRING_VALUE", // required
|
|
32
|
+
* };
|
|
33
|
+
* const command = new GetStageSessionCommand(input);
|
|
34
|
+
* const response = await client.send(command);
|
|
35
|
+
* // { // GetStageSessionResponse
|
|
36
|
+
* // stageSession: { // StageSession
|
|
37
|
+
* // sessionId: "STRING_VALUE",
|
|
38
|
+
* // startTime: new Date("TIMESTAMP"),
|
|
39
|
+
* // endTime: new Date("TIMESTAMP"),
|
|
40
|
+
* // },
|
|
41
|
+
* // };
|
|
42
|
+
*
|
|
43
|
+
* ```
|
|
44
|
+
*
|
|
45
|
+
* @param GetStageSessionCommandInput - {@link GetStageSessionCommandInput}
|
|
46
|
+
* @returns {@link GetStageSessionCommandOutput}
|
|
47
|
+
* @see {@link GetStageSessionCommandInput} for command's `input` shape.
|
|
48
|
+
* @see {@link GetStageSessionCommandOutput} 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 ResourceNotFoundException} (client fault)
|
|
55
|
+
* <p/>
|
|
56
|
+
*
|
|
57
|
+
* @throws {@link ValidationException} (client fault)
|
|
58
|
+
* <p/>
|
|
59
|
+
*
|
|
60
|
+
* @throws {@link IVSRealTimeServiceException}
|
|
61
|
+
* <p>Base exception class for all service exceptions from IVSRealTime service.</p>
|
|
62
|
+
*
|
|
63
|
+
*/
|
|
64
|
+
export declare class GetStageSessionCommand extends $Command<GetStageSessionCommandInput, GetStageSessionCommandOutput, IVSRealTimeClientResolvedConfig> {
|
|
65
|
+
readonly input: GetStageSessionCommandInput;
|
|
66
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
67
|
+
/**
|
|
68
|
+
* @public
|
|
69
|
+
*/
|
|
70
|
+
constructor(input: GetStageSessionCommandInput);
|
|
71
|
+
/**
|
|
72
|
+
* @internal
|
|
73
|
+
*/
|
|
74
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IVSRealTimeClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetStageSessionCommandInput, GetStageSessionCommandOutput>;
|
|
75
|
+
/**
|
|
76
|
+
* @internal
|
|
77
|
+
*/
|
|
78
|
+
private serialize;
|
|
79
|
+
/**
|
|
80
|
+
* @internal
|
|
81
|
+
*/
|
|
82
|
+
private deserialize;
|
|
83
|
+
}
|
|
@@ -0,0 +1,89 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
4
|
+
import { IVSRealTimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IVSRealTimeClient";
|
|
5
|
+
import { ListParticipantEventsRequest, ListParticipantEventsResponse } from "../models/models_0";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
9
|
+
* The input for {@link ListParticipantEventsCommand}.
|
|
10
|
+
*/
|
|
11
|
+
export interface ListParticipantEventsCommandInput extends ListParticipantEventsRequest {
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
16
|
+
* The output of {@link ListParticipantEventsCommand}.
|
|
17
|
+
*/
|
|
18
|
+
export interface ListParticipantEventsCommandOutput extends ListParticipantEventsResponse, __MetadataBearer {
|
|
19
|
+
}
|
|
20
|
+
/**
|
|
21
|
+
* @public
|
|
22
|
+
* <p>Lists events for a specified participant that occurred during a specified stage
|
|
23
|
+
* session.</p>
|
|
24
|
+
* @example
|
|
25
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
26
|
+
* ```javascript
|
|
27
|
+
* import { IVSRealTimeClient, ListParticipantEventsCommand } from "@aws-sdk/client-ivs-realtime"; // ES Modules import
|
|
28
|
+
* // const { IVSRealTimeClient, ListParticipantEventsCommand } = require("@aws-sdk/client-ivs-realtime"); // CommonJS import
|
|
29
|
+
* const client = new IVSRealTimeClient(config);
|
|
30
|
+
* const input = { // ListParticipantEventsRequest
|
|
31
|
+
* stageArn: "STRING_VALUE", // required
|
|
32
|
+
* sessionId: "STRING_VALUE", // required
|
|
33
|
+
* participantId: "STRING_VALUE", // required
|
|
34
|
+
* nextToken: "STRING_VALUE",
|
|
35
|
+
* maxResults: Number("int"),
|
|
36
|
+
* };
|
|
37
|
+
* const command = new ListParticipantEventsCommand(input);
|
|
38
|
+
* const response = await client.send(command);
|
|
39
|
+
* // { // ListParticipantEventsResponse
|
|
40
|
+
* // events: [ // EventList // required
|
|
41
|
+
* // { // Event
|
|
42
|
+
* // name: "STRING_VALUE",
|
|
43
|
+
* // participantId: "STRING_VALUE",
|
|
44
|
+
* // eventTime: new Date("TIMESTAMP"),
|
|
45
|
+
* // remoteParticipantId: "STRING_VALUE",
|
|
46
|
+
* // errorCode: "STRING_VALUE",
|
|
47
|
+
* // },
|
|
48
|
+
* // ],
|
|
49
|
+
* // nextToken: "STRING_VALUE",
|
|
50
|
+
* // };
|
|
51
|
+
*
|
|
52
|
+
* ```
|
|
53
|
+
*
|
|
54
|
+
* @param ListParticipantEventsCommandInput - {@link ListParticipantEventsCommandInput}
|
|
55
|
+
* @returns {@link ListParticipantEventsCommandOutput}
|
|
56
|
+
* @see {@link ListParticipantEventsCommandInput} for command's `input` shape.
|
|
57
|
+
* @see {@link ListParticipantEventsCommandOutput} for command's `response` shape.
|
|
58
|
+
* @see {@link IVSRealTimeClientResolvedConfig | config} for IVSRealTimeClient's `config` shape.
|
|
59
|
+
*
|
|
60
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
61
|
+
* <p/>
|
|
62
|
+
*
|
|
63
|
+
* @throws {@link ValidationException} (client fault)
|
|
64
|
+
* <p/>
|
|
65
|
+
*
|
|
66
|
+
* @throws {@link IVSRealTimeServiceException}
|
|
67
|
+
* <p>Base exception class for all service exceptions from IVSRealTime service.</p>
|
|
68
|
+
*
|
|
69
|
+
*/
|
|
70
|
+
export declare class ListParticipantEventsCommand extends $Command<ListParticipantEventsCommandInput, ListParticipantEventsCommandOutput, IVSRealTimeClientResolvedConfig> {
|
|
71
|
+
readonly input: ListParticipantEventsCommandInput;
|
|
72
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
73
|
+
/**
|
|
74
|
+
* @public
|
|
75
|
+
*/
|
|
76
|
+
constructor(input: ListParticipantEventsCommandInput);
|
|
77
|
+
/**
|
|
78
|
+
* @internal
|
|
79
|
+
*/
|
|
80
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IVSRealTimeClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListParticipantEventsCommandInput, ListParticipantEventsCommandOutput>;
|
|
81
|
+
/**
|
|
82
|
+
* @internal
|
|
83
|
+
*/
|
|
84
|
+
private serialize;
|
|
85
|
+
/**
|
|
86
|
+
* @internal
|
|
87
|
+
*/
|
|
88
|
+
private deserialize;
|
|
89
|
+
}
|
|
@@ -0,0 +1,90 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
4
|
+
import { IVSRealTimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IVSRealTimeClient";
|
|
5
|
+
import { ListParticipantsRequest, ListParticipantsResponse } from "../models/models_0";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
9
|
+
* The input for {@link ListParticipantsCommand}.
|
|
10
|
+
*/
|
|
11
|
+
export interface ListParticipantsCommandInput extends ListParticipantsRequest {
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
16
|
+
* The output of {@link ListParticipantsCommand}.
|
|
17
|
+
*/
|
|
18
|
+
export interface ListParticipantsCommandOutput extends ListParticipantsResponse, __MetadataBearer {
|
|
19
|
+
}
|
|
20
|
+
/**
|
|
21
|
+
* @public
|
|
22
|
+
* <p>Lists all participants in a specified stage session.</p>
|
|
23
|
+
* @example
|
|
24
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
25
|
+
* ```javascript
|
|
26
|
+
* import { IVSRealTimeClient, ListParticipantsCommand } from "@aws-sdk/client-ivs-realtime"; // ES Modules import
|
|
27
|
+
* // const { IVSRealTimeClient, ListParticipantsCommand } = require("@aws-sdk/client-ivs-realtime"); // CommonJS import
|
|
28
|
+
* const client = new IVSRealTimeClient(config);
|
|
29
|
+
* const input = { // ListParticipantsRequest
|
|
30
|
+
* stageArn: "STRING_VALUE", // required
|
|
31
|
+
* sessionId: "STRING_VALUE", // required
|
|
32
|
+
* filterByUserId: "STRING_VALUE",
|
|
33
|
+
* filterByPublished: true || false,
|
|
34
|
+
* filterByState: "STRING_VALUE",
|
|
35
|
+
* nextToken: "STRING_VALUE",
|
|
36
|
+
* maxResults: Number("int"),
|
|
37
|
+
* };
|
|
38
|
+
* const command = new ListParticipantsCommand(input);
|
|
39
|
+
* const response = await client.send(command);
|
|
40
|
+
* // { // ListParticipantsResponse
|
|
41
|
+
* // participants: [ // ParticipantList // required
|
|
42
|
+
* // { // ParticipantSummary
|
|
43
|
+
* // participantId: "STRING_VALUE",
|
|
44
|
+
* // userId: "STRING_VALUE",
|
|
45
|
+
* // state: "STRING_VALUE",
|
|
46
|
+
* // firstJoinTime: new Date("TIMESTAMP"),
|
|
47
|
+
* // published: true || false,
|
|
48
|
+
* // },
|
|
49
|
+
* // ],
|
|
50
|
+
* // nextToken: "STRING_VALUE",
|
|
51
|
+
* // };
|
|
52
|
+
*
|
|
53
|
+
* ```
|
|
54
|
+
*
|
|
55
|
+
* @param ListParticipantsCommandInput - {@link ListParticipantsCommandInput}
|
|
56
|
+
* @returns {@link ListParticipantsCommandOutput}
|
|
57
|
+
* @see {@link ListParticipantsCommandInput} for command's `input` shape.
|
|
58
|
+
* @see {@link ListParticipantsCommandOutput} 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 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 ListParticipantsCommand extends $Command<ListParticipantsCommandInput, ListParticipantsCommandOutput, IVSRealTimeClientResolvedConfig> {
|
|
72
|
+
readonly input: ListParticipantsCommandInput;
|
|
73
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
74
|
+
/**
|
|
75
|
+
* @public
|
|
76
|
+
*/
|
|
77
|
+
constructor(input: ListParticipantsCommandInput);
|
|
78
|
+
/**
|
|
79
|
+
* @internal
|
|
80
|
+
*/
|
|
81
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IVSRealTimeClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListParticipantsCommandInput, ListParticipantsCommandOutput>;
|
|
82
|
+
/**
|
|
83
|
+
* @internal
|
|
84
|
+
*/
|
|
85
|
+
private serialize;
|
|
86
|
+
/**
|
|
87
|
+
* @internal
|
|
88
|
+
*/
|
|
89
|
+
private deserialize;
|
|
90
|
+
}
|
|
@@ -0,0 +1,84 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
4
|
+
import { IVSRealTimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IVSRealTimeClient";
|
|
5
|
+
import { ListStageSessionsRequest, ListStageSessionsResponse } from "../models/models_0";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
9
|
+
* The input for {@link ListStageSessionsCommand}.
|
|
10
|
+
*/
|
|
11
|
+
export interface ListStageSessionsCommandInput extends ListStageSessionsRequest {
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
16
|
+
* The output of {@link ListStageSessionsCommand}.
|
|
17
|
+
*/
|
|
18
|
+
export interface ListStageSessionsCommandOutput extends ListStageSessionsResponse, __MetadataBearer {
|
|
19
|
+
}
|
|
20
|
+
/**
|
|
21
|
+
* @public
|
|
22
|
+
* <p>Gets all sessions for a specified stage.</p>
|
|
23
|
+
* @example
|
|
24
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
25
|
+
* ```javascript
|
|
26
|
+
* import { IVSRealTimeClient, ListStageSessionsCommand } from "@aws-sdk/client-ivs-realtime"; // ES Modules import
|
|
27
|
+
* // const { IVSRealTimeClient, ListStageSessionsCommand } = require("@aws-sdk/client-ivs-realtime"); // CommonJS import
|
|
28
|
+
* const client = new IVSRealTimeClient(config);
|
|
29
|
+
* const input = { // ListStageSessionsRequest
|
|
30
|
+
* stageArn: "STRING_VALUE", // required
|
|
31
|
+
* nextToken: "STRING_VALUE",
|
|
32
|
+
* maxResults: Number("int"),
|
|
33
|
+
* };
|
|
34
|
+
* const command = new ListStageSessionsCommand(input);
|
|
35
|
+
* const response = await client.send(command);
|
|
36
|
+
* // { // ListStageSessionsResponse
|
|
37
|
+
* // stageSessions: [ // StageSessionList // required
|
|
38
|
+
* // { // StageSessionSummary
|
|
39
|
+
* // sessionId: "STRING_VALUE",
|
|
40
|
+
* // startTime: new Date("TIMESTAMP"),
|
|
41
|
+
* // endTime: new Date("TIMESTAMP"),
|
|
42
|
+
* // },
|
|
43
|
+
* // ],
|
|
44
|
+
* // nextToken: "STRING_VALUE",
|
|
45
|
+
* // };
|
|
46
|
+
*
|
|
47
|
+
* ```
|
|
48
|
+
*
|
|
49
|
+
* @param ListStageSessionsCommandInput - {@link ListStageSessionsCommandInput}
|
|
50
|
+
* @returns {@link ListStageSessionsCommandOutput}
|
|
51
|
+
* @see {@link ListStageSessionsCommandInput} for command's `input` shape.
|
|
52
|
+
* @see {@link ListStageSessionsCommandOutput} for command's `response` shape.
|
|
53
|
+
* @see {@link IVSRealTimeClientResolvedConfig | config} for IVSRealTimeClient's `config` shape.
|
|
54
|
+
*
|
|
55
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
56
|
+
* <p/>
|
|
57
|
+
*
|
|
58
|
+
* @throws {@link ValidationException} (client fault)
|
|
59
|
+
* <p/>
|
|
60
|
+
*
|
|
61
|
+
* @throws {@link IVSRealTimeServiceException}
|
|
62
|
+
* <p>Base exception class for all service exceptions from IVSRealTime service.</p>
|
|
63
|
+
*
|
|
64
|
+
*/
|
|
65
|
+
export declare class ListStageSessionsCommand extends $Command<ListStageSessionsCommandInput, ListStageSessionsCommandOutput, IVSRealTimeClientResolvedConfig> {
|
|
66
|
+
readonly input: ListStageSessionsCommandInput;
|
|
67
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
68
|
+
/**
|
|
69
|
+
* @public
|
|
70
|
+
*/
|
|
71
|
+
constructor(input: ListStageSessionsCommandInput);
|
|
72
|
+
/**
|
|
73
|
+
* @internal
|
|
74
|
+
*/
|
|
75
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IVSRealTimeClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListStageSessionsCommandInput, ListStageSessionsCommandOutput>;
|
|
76
|
+
/**
|
|
77
|
+
* @internal
|
|
78
|
+
*/
|
|
79
|
+
private serialize;
|
|
80
|
+
/**
|
|
81
|
+
* @internal
|
|
82
|
+
*/
|
|
83
|
+
private deserialize;
|
|
84
|
+
}
|
|
@@ -19,7 +19,8 @@ export interface ListStagesCommandOutput extends ListStagesResponse, __MetadataB
|
|
|
19
19
|
}
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
|
-
* <p>Gets summary information about all stages in your account, in the AWS region where the
|
|
22
|
+
* <p>Gets summary information about all stages in your account, in the AWS region where the
|
|
23
|
+
* API request is processed.</p>
|
|
23
24
|
* @example
|
|
24
25
|
* Use a bare-bones client and the command you need to make an API call.
|
|
25
26
|
* ```javascript
|
|
@@ -2,7 +2,12 @@ export * from "./CreateParticipantTokenCommand";
|
|
|
2
2
|
export * from "./CreateStageCommand";
|
|
3
3
|
export * from "./DeleteStageCommand";
|
|
4
4
|
export * from "./DisconnectParticipantCommand";
|
|
5
|
+
export * from "./GetParticipantCommand";
|
|
5
6
|
export * from "./GetStageCommand";
|
|
7
|
+
export * from "./GetStageSessionCommand";
|
|
8
|
+
export * from "./ListParticipantEventsCommand";
|
|
9
|
+
export * from "./ListParticipantsCommand";
|
|
10
|
+
export * from "./ListStageSessionsCommand";
|
|
6
11
|
export * from "./ListStagesCommand";
|
|
7
12
|
export * from "./ListTagsForResourceCommand";
|
|
8
13
|
export * from "./TagResourceCommand";
|