@aws-sdk/client-ivs-realtime 3.298.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 (115) hide show
  1. package/LICENSE +201 -0
  2. package/README.md +373 -0
  3. package/dist-cjs/IVSRealTime.js +157 -0
  4. package/dist-cjs/IVSRealTimeClient.js +40 -0
  5. package/dist-cjs/commands/CreateParticipantTokenCommand.js +45 -0
  6. package/dist-cjs/commands/CreateStageCommand.js +45 -0
  7. package/dist-cjs/commands/DeleteStageCommand.js +45 -0
  8. package/dist-cjs/commands/DisconnectParticipantCommand.js +45 -0
  9. package/dist-cjs/commands/GetStageCommand.js +45 -0
  10. package/dist-cjs/commands/ListStagesCommand.js +45 -0
  11. package/dist-cjs/commands/ListTagsForResourceCommand.js +45 -0
  12. package/dist-cjs/commands/TagResourceCommand.js +45 -0
  13. package/dist-cjs/commands/UntagResourceCommand.js +45 -0
  14. package/dist-cjs/commands/UpdateStageCommand.js +45 -0
  15. package/dist-cjs/commands/index.js +13 -0
  16. package/dist-cjs/endpoint/EndpointParameters.js +12 -0
  17. package/dist-cjs/endpoint/endpointResolver.js +12 -0
  18. package/dist-cjs/endpoint/ruleset.js +7 -0
  19. package/dist-cjs/index.js +11 -0
  20. package/dist-cjs/models/IVSRealTimeServiceException.js +11 -0
  21. package/dist-cjs/models/index.js +4 -0
  22. package/dist-cjs/models/models_0.js +107 -0
  23. package/dist-cjs/pagination/Interfaces.js +2 -0
  24. package/dist-cjs/pagination/ListStagesPaginator.js +29 -0
  25. package/dist-cjs/pagination/index.js +5 -0
  26. package/dist-cjs/protocols/Aws_restJson1.js +922 -0
  27. package/dist-cjs/runtimeConfig.browser.js +39 -0
  28. package/dist-cjs/runtimeConfig.js +48 -0
  29. package/dist-cjs/runtimeConfig.native.js +15 -0
  30. package/dist-cjs/runtimeConfig.shared.js +21 -0
  31. package/dist-es/IVSRealTime.js +153 -0
  32. package/dist-es/IVSRealTimeClient.js +36 -0
  33. package/dist-es/commands/CreateParticipantTokenCommand.js +41 -0
  34. package/dist-es/commands/CreateStageCommand.js +41 -0
  35. package/dist-es/commands/DeleteStageCommand.js +41 -0
  36. package/dist-es/commands/DisconnectParticipantCommand.js +41 -0
  37. package/dist-es/commands/GetStageCommand.js +41 -0
  38. package/dist-es/commands/ListStagesCommand.js +41 -0
  39. package/dist-es/commands/ListTagsForResourceCommand.js +41 -0
  40. package/dist-es/commands/TagResourceCommand.js +41 -0
  41. package/dist-es/commands/UntagResourceCommand.js +41 -0
  42. package/dist-es/commands/UpdateStageCommand.js +41 -0
  43. package/dist-es/commands/index.js +10 -0
  44. package/dist-es/endpoint/EndpointParameters.js +8 -0
  45. package/dist-es/endpoint/endpointResolver.js +8 -0
  46. package/dist-es/endpoint/ruleset.js +4 -0
  47. package/dist-es/index.js +6 -0
  48. package/dist-es/models/IVSRealTimeServiceException.js +7 -0
  49. package/dist-es/models/index.js +1 -0
  50. package/dist-es/models/models_0.js +97 -0
  51. package/dist-es/pagination/Interfaces.js +1 -0
  52. package/dist-es/pagination/ListStagesPaginator.js +25 -0
  53. package/dist-es/pagination/index.js +2 -0
  54. package/dist-es/protocols/Aws_restJson1.js +899 -0
  55. package/dist-es/runtimeConfig.browser.js +34 -0
  56. package/dist-es/runtimeConfig.js +43 -0
  57. package/dist-es/runtimeConfig.native.js +11 -0
  58. package/dist-es/runtimeConfig.shared.js +17 -0
  59. package/dist-types/IVSRealTime.d.ts +175 -0
  60. package/dist-types/IVSRealTimeClient.d.ts +256 -0
  61. package/dist-types/commands/CreateParticipantTokenCommand.d.ts +77 -0
  62. package/dist-types/commands/CreateStageCommand.d.ts +72 -0
  63. package/dist-types/commands/DeleteStageCommand.d.ts +75 -0
  64. package/dist-types/commands/DisconnectParticipantCommand.d.ts +72 -0
  65. package/dist-types/commands/GetStageCommand.d.ts +69 -0
  66. package/dist-types/commands/ListStagesCommand.d.ts +69 -0
  67. package/dist-types/commands/ListTagsForResourceCommand.d.ts +69 -0
  68. package/dist-types/commands/TagResourceCommand.d.ts +69 -0
  69. package/dist-types/commands/UntagResourceCommand.d.ts +69 -0
  70. package/dist-types/commands/UpdateStageCommand.d.ts +75 -0
  71. package/dist-types/commands/index.d.ts +10 -0
  72. package/dist-types/endpoint/EndpointParameters.d.ts +19 -0
  73. package/dist-types/endpoint/endpointResolver.d.ts +5 -0
  74. package/dist-types/endpoint/ruleset.d.ts +2 -0
  75. package/dist-types/index.d.ts +6 -0
  76. package/dist-types/models/IVSRealTimeServiceException.d.ts +12 -0
  77. package/dist-types/models/index.d.ts +1 -0
  78. package/dist-types/models/models_0.d.ts +477 -0
  79. package/dist-types/pagination/Interfaces.d.ts +8 -0
  80. package/dist-types/pagination/ListStagesPaginator.d.ts +7 -0
  81. package/dist-types/pagination/index.d.ts +2 -0
  82. package/dist-types/protocols/Aws_restJson1.d.ts +32 -0
  83. package/dist-types/runtimeConfig.browser.d.ts +42 -0
  84. package/dist-types/runtimeConfig.d.ts +42 -0
  85. package/dist-types/runtimeConfig.native.d.ts +41 -0
  86. package/dist-types/runtimeConfig.shared.d.ts +18 -0
  87. package/dist-types/ts3.4/IVSRealTime.d.ts +174 -0
  88. package/dist-types/ts3.4/IVSRealTimeClient.d.ts +172 -0
  89. package/dist-types/ts3.4/commands/CreateParticipantTokenCommand.d.ts +41 -0
  90. package/dist-types/ts3.4/commands/CreateStageCommand.d.ts +34 -0
  91. package/dist-types/ts3.4/commands/DeleteStageCommand.d.ts +34 -0
  92. package/dist-types/ts3.4/commands/DisconnectParticipantCommand.d.ts +41 -0
  93. package/dist-types/ts3.4/commands/GetStageCommand.d.ts +34 -0
  94. package/dist-types/ts3.4/commands/ListStagesCommand.d.ts +34 -0
  95. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +38 -0
  96. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +34 -0
  97. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +37 -0
  98. package/dist-types/ts3.4/commands/UpdateStageCommand.d.ts +34 -0
  99. package/dist-types/ts3.4/commands/index.d.ts +10 -0
  100. package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +33 -0
  101. package/dist-types/ts3.4/endpoint/endpointResolver.d.ts +8 -0
  102. package/dist-types/ts3.4/endpoint/ruleset.d.ts +2 -0
  103. package/dist-types/ts3.4/index.d.ts +6 -0
  104. package/dist-types/ts3.4/models/IVSRealTimeServiceException.d.ts +7 -0
  105. package/dist-types/ts3.4/models/index.d.ts +1 -0
  106. package/dist-types/ts3.4/models/models_0.d.ts +153 -0
  107. package/dist-types/ts3.4/pagination/Interfaces.d.ts +6 -0
  108. package/dist-types/ts3.4/pagination/ListStagesPaginator.d.ts +11 -0
  109. package/dist-types/ts3.4/pagination/index.d.ts +2 -0
  110. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +125 -0
  111. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +91 -0
  112. package/dist-types/ts3.4/runtimeConfig.d.ts +91 -0
  113. package/dist-types/ts3.4/runtimeConfig.native.d.ts +80 -0
  114. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +18 -0
  115. package/package.json +98 -0
@@ -0,0 +1,5 @@
1
+ import { EndpointV2, Logger } from "@aws-sdk/types";
2
+ import { EndpointParameters } from "./EndpointParameters";
3
+ export declare const defaultEndpointResolver: (endpointParams: EndpointParameters, context?: {
4
+ logger?: Logger;
5
+ }) => EndpointV2;
@@ -0,0 +1,2 @@
1
+ import { RuleSetObject } from "@aws-sdk/util-endpoints";
2
+ export declare const ruleSet: RuleSetObject;
@@ -0,0 +1,6 @@
1
+ export * from "./IVSRealTime";
2
+ export * from "./IVSRealTimeClient";
3
+ export * from "./commands";
4
+ export * from "./models";
5
+ export * from "./pagination";
6
+ export { IVSRealTimeServiceException } from "./models/IVSRealTimeServiceException";
@@ -0,0 +1,12 @@
1
+ import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
2
+ /**
3
+ * @public
4
+ *
5
+ * Base exception class for all service exceptions from IVSRealTime service.
6
+ */
7
+ export declare class IVSRealTimeServiceException extends __ServiceException {
8
+ /**
9
+ * @internal
10
+ */
11
+ constructor(options: __ServiceExceptionOptions);
12
+ }
@@ -0,0 +1 @@
1
+ export * from "./models_0";
@@ -0,0 +1,477 @@
1
+ import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
2
+ import { IVSRealTimeServiceException as __BaseException } from "./IVSRealTimeServiceException";
3
+ /**
4
+ * @public
5
+ * <p/>
6
+ */
7
+ export declare class AccessDeniedException extends __BaseException {
8
+ readonly name: "AccessDeniedException";
9
+ readonly $fault: "client";
10
+ /**
11
+ * <p>User does not have sufficient access to perform this action.</p>
12
+ */
13
+ exceptionMessage?: string;
14
+ /**
15
+ * @internal
16
+ */
17
+ constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
18
+ }
19
+ /**
20
+ * @public
21
+ */
22
+ export declare enum ParticipantTokenCapability {
23
+ PUBLISH = "PUBLISH",
24
+ SUBSCRIBE = "SUBSCRIBE"
25
+ }
26
+ /**
27
+ * @public
28
+ */
29
+ export interface CreateParticipantTokenRequest {
30
+ /**
31
+ * <p>ARN of the stage to which this token is scoped.</p>
32
+ */
33
+ stageArn: string | undefined;
34
+ /**
35
+ * <p>Duration (in minutes), after which the token expires. Default: 60 (1 hour).</p>
36
+ */
37
+ duration?: number;
38
+ /**
39
+ * <p>Name that can be specified to help identify the token. This can be any UTF-8 encoded text. <i>This field is exposed to all stage
40
+ * participants and should not be used for personally identifying, confidential, or sensitive information.</i>
41
+ * </p>
42
+ */
43
+ userId?: string;
44
+ /**
45
+ * <p>Application-provided attributes to encode into the token and attach to a stage. Map keys and values can contain UTF-8
46
+ * encoded text. The maximum length of this field is 1 KB total. <i>This field is exposed to all stage participants and
47
+ * should not be used for personally identifying, confidential, or sensitive information.</i>
48
+ * </p>
49
+ */
50
+ attributes?: Record<string, string>;
51
+ /**
52
+ * <p>Set of capabilities that the user is allowed to perform in the stage. Default: <code>PUBLISH, SUBSCRIBE</code>.</p>
53
+ */
54
+ capabilities?: (ParticipantTokenCapability | string)[];
55
+ }
56
+ /**
57
+ * @public
58
+ * <p>Object specifying a participant token in a stage.</p>
59
+ */
60
+ export interface ParticipantToken {
61
+ /**
62
+ * <p>Unique identifier for this participant token, assigned by IVS.</p>
63
+ */
64
+ participantId?: string;
65
+ /**
66
+ * <p>The issued client token, encrypted.</p>
67
+ */
68
+ token?: string;
69
+ /**
70
+ * <p>Name to help identify the token. This can be any UTF-8 encoded text. <i>This field is exposed to all
71
+ * stage participants and should not be used for personally identifying, confidential, or sensitive information.</i>
72
+ * </p>
73
+ */
74
+ userId?: string;
75
+ /**
76
+ * <p>Application-provided attributes to encode into the token and attach to a stage. <i>This field is exposed to all
77
+ * stage participants and should not be used for personally identifying, confidential, or sensitive information.</i>
78
+ * </p>
79
+ */
80
+ attributes?: Record<string, string>;
81
+ /**
82
+ * <p>Duration (in minutes), after which the participant token expires. Default: 60 (1 hour).</p>
83
+ */
84
+ duration?: number;
85
+ /**
86
+ * <p>Set of capabilities that the user is allowed to perform in the stage.</p>
87
+ */
88
+ capabilities?: (ParticipantTokenCapability | string)[];
89
+ /**
90
+ * <p>ISO 8601 timestamp (returned as a string) for when this token expires.</p>
91
+ */
92
+ expirationTime?: Date;
93
+ }
94
+ /**
95
+ * @public
96
+ */
97
+ export interface CreateParticipantTokenResponse {
98
+ /**
99
+ * <p>The participant token that was created.</p>
100
+ */
101
+ participantToken?: ParticipantToken;
102
+ }
103
+ /**
104
+ * @public
105
+ * <p/>
106
+ */
107
+ export declare class PendingVerification extends __BaseException {
108
+ readonly name: "PendingVerification";
109
+ readonly $fault: "client";
110
+ /**
111
+ * <p> Your account is pending verification. </p>
112
+ */
113
+ exceptionMessage?: string;
114
+ /**
115
+ * @internal
116
+ */
117
+ constructor(opts: __ExceptionOptionType<PendingVerification, __BaseException>);
118
+ }
119
+ /**
120
+ * @public
121
+ * <p/>
122
+ */
123
+ export declare class ResourceNotFoundException extends __BaseException {
124
+ readonly name: "ResourceNotFoundException";
125
+ readonly $fault: "client";
126
+ /**
127
+ * <p>Request references a resource which does not exist.</p>
128
+ */
129
+ exceptionMessage?: string;
130
+ /**
131
+ * @internal
132
+ */
133
+ constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
134
+ }
135
+ /**
136
+ * @public
137
+ * <p/>
138
+ */
139
+ export declare class ServiceQuotaExceededException extends __BaseException {
140
+ readonly name: "ServiceQuotaExceededException";
141
+ readonly $fault: "client";
142
+ /**
143
+ * <p>Request would cause a service quota to be exceeded.</p>
144
+ */
145
+ exceptionMessage?: string;
146
+ /**
147
+ * @internal
148
+ */
149
+ constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
150
+ }
151
+ /**
152
+ * @public
153
+ * <p/>
154
+ */
155
+ export declare class ValidationException extends __BaseException {
156
+ readonly name: "ValidationException";
157
+ readonly $fault: "client";
158
+ /**
159
+ * <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
160
+ */
161
+ exceptionMessage?: string;
162
+ /**
163
+ * @internal
164
+ */
165
+ constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
166
+ }
167
+ /**
168
+ * @public
169
+ * <p>Object specifying a participant token configuration in a stage.</p>
170
+ */
171
+ export interface ParticipantTokenConfiguration {
172
+ /**
173
+ * <p>Duration (in minutes), after which the corresponding participant token expires. Default: 60 (1 hour).</p>
174
+ */
175
+ duration?: number;
176
+ /**
177
+ * <p>Name that can be specified to help identify the corresponding participant token. This can be any UTF-8 encoded text. <i>This field is exposed to all
178
+ * stage participants and should not be used for personally identifying, confidential, or sensitive information.</i>
179
+ * </p>
180
+ */
181
+ userId?: string;
182
+ /**
183
+ * <p>Application-provided attributes to encode into the corresponding participant token and attach to a stage. Map keys and values can contain UTF-8 encoded text.
184
+ * The maximum length of this field is 1 KB total. <i>This field is exposed to all stage participants and should not be used for personally
185
+ * identifying, confidential, or sensitive information.</i>
186
+ * </p>
187
+ */
188
+ attributes?: Record<string, string>;
189
+ /**
190
+ * <p>Set of capabilities that the user is allowed to perform in the stage.</p>
191
+ */
192
+ capabilities?: (ParticipantTokenCapability | string)[];
193
+ }
194
+ /**
195
+ * @public
196
+ */
197
+ export interface CreateStageRequest {
198
+ /**
199
+ * <p>Optional name that can be specified for the stage being created.</p>
200
+ */
201
+ name?: string;
202
+ /**
203
+ * <p>Array of participant token configuration objects to attach to the new stage.</p>
204
+ */
205
+ participantTokenConfigurations?: ParticipantTokenConfiguration[];
206
+ /**
207
+ * <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
208
+ * (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS
209
+ * Resources</a> for details, including restrictions that apply to tags and "Tag naming
210
+ * limits and requirements"; Amazon IVS has no constraints on tags beyond what is
211
+ * documented there.
212
+ * </p>
213
+ */
214
+ tags?: Record<string, string>;
215
+ }
216
+ /**
217
+ * @public
218
+ * <p>Object specifying a stage.</p>
219
+ */
220
+ export interface Stage {
221
+ /**
222
+ * <p>Stage ARN.</p>
223
+ */
224
+ arn: string | undefined;
225
+ /**
226
+ * <p>Stage name.</p>
227
+ */
228
+ name?: string;
229
+ /**
230
+ * <p>ID of the active session within the stage.</p>
231
+ */
232
+ activeSessionId?: string;
233
+ /**
234
+ * <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
235
+ * (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS
236
+ * Resources</a> for details, including restrictions that apply to tags and "Tag naming
237
+ * limits and requirements"; Amazon IVS has no constraints on tags beyond what is
238
+ * documented there.</p>
239
+ */
240
+ tags?: Record<string, string>;
241
+ }
242
+ /**
243
+ * @public
244
+ */
245
+ export interface CreateStageResponse {
246
+ /**
247
+ * <p>The stage that was created.</p>
248
+ */
249
+ stage?: Stage;
250
+ /**
251
+ * <p>Participant tokens attached to the stage. These correspond to the <code>participants</code> in the request.</p>
252
+ */
253
+ participantTokens?: ParticipantToken[];
254
+ }
255
+ /**
256
+ * @public
257
+ * <p/>
258
+ */
259
+ export declare class ConflictException extends __BaseException {
260
+ readonly name: "ConflictException";
261
+ readonly $fault: "client";
262
+ /**
263
+ * <p>Updating or deleting a resource can cause an inconsistent state.</p>
264
+ */
265
+ exceptionMessage?: string;
266
+ /**
267
+ * @internal
268
+ */
269
+ constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
270
+ }
271
+ /**
272
+ * @public
273
+ */
274
+ export interface DeleteStageRequest {
275
+ /**
276
+ * <p>ARN of the stage to be deleted.</p>
277
+ */
278
+ arn: string | undefined;
279
+ }
280
+ /**
281
+ * @public
282
+ */
283
+ export interface DeleteStageResponse {
284
+ }
285
+ /**
286
+ * @public
287
+ */
288
+ export interface DisconnectParticipantRequest {
289
+ /**
290
+ * <p>ARN of the stage to which the participant is attached.</p>
291
+ */
292
+ stageArn: string | undefined;
293
+ /**
294
+ * <p>Identifier of the participant to be disconnected. This is returned by <a>CreateParticipantToken</a>.</p>
295
+ */
296
+ participantId: string | undefined;
297
+ /**
298
+ * <p>Description of why this participant is being disconnected.</p>
299
+ */
300
+ reason?: string;
301
+ }
302
+ /**
303
+ * @public
304
+ */
305
+ export interface DisconnectParticipantResponse {
306
+ }
307
+ /**
308
+ * @public
309
+ */
310
+ export interface GetStageRequest {
311
+ /**
312
+ * <p>ARN of the stage for which the information is to be retrieved.</p>
313
+ */
314
+ arn: string | undefined;
315
+ }
316
+ /**
317
+ * @public
318
+ */
319
+ export interface GetStageResponse {
320
+ /**
321
+ * <p/>
322
+ */
323
+ stage?: Stage;
324
+ }
325
+ /**
326
+ * @public
327
+ */
328
+ export interface ListStagesRequest {
329
+ /**
330
+ * <p>The first stage to retrieve. This is used for pagination; see the <code>nextToken</code> response field.</p>
331
+ */
332
+ nextToken?: string;
333
+ /**
334
+ * <p>Maximum number of results to return. Default: 50.</p>
335
+ */
336
+ maxResults?: number;
337
+ }
338
+ /**
339
+ * @public
340
+ * <p>Summary information about a stage.</p>
341
+ */
342
+ export interface StageSummary {
343
+ /**
344
+ * <p>Stage ARN.</p>
345
+ */
346
+ arn: string | undefined;
347
+ /**
348
+ * <p>Stage name.</p>
349
+ */
350
+ name?: string;
351
+ /**
352
+ * <p>ID of the active session within the stage.</p>
353
+ */
354
+ activeSessionId?: string;
355
+ /**
356
+ * <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
357
+ * (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS
358
+ * Resources</a> for details, including restrictions that apply to tags and "Tag naming
359
+ * limits and requirements"; Amazon IVS has no constraints on tags beyond what is
360
+ * documented there.</p>
361
+ */
362
+ tags?: Record<string, string>;
363
+ }
364
+ /**
365
+ * @public
366
+ */
367
+ export interface ListStagesResponse {
368
+ /**
369
+ * <p>List of the matching stages (summary information only).</p>
370
+ */
371
+ stages: StageSummary[] | undefined;
372
+ /**
373
+ * <p>If there are more rooms than <code>maxResults</code>, use <code>nextToken</code> in the request to get the next set.</p>
374
+ */
375
+ nextToken?: string;
376
+ }
377
+ /**
378
+ * @public
379
+ * <p/>
380
+ */
381
+ export declare class InternalServerException extends __BaseException {
382
+ readonly name: "InternalServerException";
383
+ readonly $fault: "server";
384
+ /**
385
+ * <p>Unexpected error during processing of request.</p>
386
+ */
387
+ exceptionMessage?: string;
388
+ /**
389
+ * @internal
390
+ */
391
+ constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
392
+ }
393
+ /**
394
+ * @public
395
+ */
396
+ export interface ListTagsForResourceRequest {
397
+ /**
398
+ * <p>The ARN of the resource to be retrieved. The ARN must be URL-encoded.</p>
399
+ */
400
+ resourceArn: string | undefined;
401
+ }
402
+ /**
403
+ * @public
404
+ */
405
+ export interface ListTagsForResourceResponse {
406
+ /**
407
+ * <p>Tags attached to the resource. Array of maps, each of the form <code>string:string (key:value)</code>.</p>
408
+ */
409
+ tags: Record<string, string> | undefined;
410
+ }
411
+ /**
412
+ * @public
413
+ */
414
+ export interface TagResourceRequest {
415
+ /**
416
+ * <p>The ARN of the resource to be tagged. The ARN must be URL-encoded.</p>
417
+ */
418
+ resourceArn: string | undefined;
419
+ /**
420
+ * <p>Array of tags to be added or updated. Array of maps, each of the form
421
+ * <code>string:string (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS
422
+ * Resources</a> for details, including restrictions that apply to tags and "Tag naming
423
+ * limits and requirements"; Amazon IVS has no constraints beyond what is documented
424
+ * there.</p>
425
+ */
426
+ tags: Record<string, string> | undefined;
427
+ }
428
+ /**
429
+ * @public
430
+ */
431
+ export interface TagResourceResponse {
432
+ }
433
+ /**
434
+ * @public
435
+ */
436
+ export interface UntagResourceRequest {
437
+ /**
438
+ * <p>The ARN of the resource to be untagged. The ARN must be URL-encoded.</p>
439
+ */
440
+ resourceArn: string | undefined;
441
+ /**
442
+ * <p>Array of tags to be removed. Array of maps, each of the form <code>string:string
443
+ * (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS
444
+ * Resources</a> for details, including restrictions that apply to tags and "Tag naming
445
+ * limits and requirements"; Amazon IVS has no constraints beyond what is documented
446
+ * there.</p>
447
+ */
448
+ tagKeys: string[] | undefined;
449
+ }
450
+ /**
451
+ * @public
452
+ */
453
+ export interface UntagResourceResponse {
454
+ }
455
+ /**
456
+ * @public
457
+ */
458
+ export interface UpdateStageRequest {
459
+ /**
460
+ * <p>ARN of the stage to be updated.</p>
461
+ */
462
+ arn: string | undefined;
463
+ /**
464
+ * <p>Name of the stage to be updated.</p>
465
+ */
466
+ name?: string;
467
+ }
468
+ /**
469
+ * @public
470
+ */
471
+ export interface UpdateStageResponse {
472
+ /**
473
+ * <p>The updated stage.
474
+ * </p>
475
+ */
476
+ stage?: Stage;
477
+ }
@@ -0,0 +1,8 @@
1
+ import { PaginationConfiguration } from "@aws-sdk/types";
2
+ import { IVSRealTimeClient } from "../IVSRealTimeClient";
3
+ /**
4
+ * @public
5
+ */
6
+ export interface IVSRealTimePaginationConfiguration extends PaginationConfiguration {
7
+ client: IVSRealTimeClient;
8
+ }
@@ -0,0 +1,7 @@
1
+ import { Paginator } from "@aws-sdk/types";
2
+ import { ListStagesCommandInput, ListStagesCommandOutput } from "../commands/ListStagesCommand";
3
+ import { IVSRealTimePaginationConfiguration } from "./Interfaces";
4
+ /**
5
+ * @public
6
+ */
7
+ export declare function paginateListStages(config: IVSRealTimePaginationConfiguration, input: ListStagesCommandInput, ...additionalArguments: any): Paginator<ListStagesCommandOutput>;
@@ -0,0 +1,2 @@
1
+ export * from "./Interfaces";
2
+ export * from "./ListStagesPaginator";
@@ -0,0 +1,32 @@
1
+ import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@aws-sdk/protocol-http";
2
+ import { SerdeContext as __SerdeContext } from "@aws-sdk/types";
3
+ import { CreateParticipantTokenCommandInput, CreateParticipantTokenCommandOutput } from "../commands/CreateParticipantTokenCommand";
4
+ import { CreateStageCommandInput, CreateStageCommandOutput } from "../commands/CreateStageCommand";
5
+ import { DeleteStageCommandInput, DeleteStageCommandOutput } from "../commands/DeleteStageCommand";
6
+ import { DisconnectParticipantCommandInput, DisconnectParticipantCommandOutput } from "../commands/DisconnectParticipantCommand";
7
+ import { GetStageCommandInput, GetStageCommandOutput } from "../commands/GetStageCommand";
8
+ import { ListStagesCommandInput, ListStagesCommandOutput } from "../commands/ListStagesCommand";
9
+ import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } from "../commands/ListTagsForResourceCommand";
10
+ import { TagResourceCommandInput, TagResourceCommandOutput } from "../commands/TagResourceCommand";
11
+ import { UntagResourceCommandInput, UntagResourceCommandOutput } from "../commands/UntagResourceCommand";
12
+ import { UpdateStageCommandInput, UpdateStageCommandOutput } from "../commands/UpdateStageCommand";
13
+ export declare const serializeAws_restJson1CreateParticipantTokenCommand: (input: CreateParticipantTokenCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
14
+ export declare const serializeAws_restJson1CreateStageCommand: (input: CreateStageCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
15
+ export declare const serializeAws_restJson1DeleteStageCommand: (input: DeleteStageCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
16
+ export declare const serializeAws_restJson1DisconnectParticipantCommand: (input: DisconnectParticipantCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
17
+ export declare const serializeAws_restJson1GetStageCommand: (input: GetStageCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
18
+ export declare const serializeAws_restJson1ListStagesCommand: (input: ListStagesCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
19
+ export declare const serializeAws_restJson1ListTagsForResourceCommand: (input: ListTagsForResourceCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
20
+ export declare const serializeAws_restJson1TagResourceCommand: (input: TagResourceCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
21
+ export declare const serializeAws_restJson1UntagResourceCommand: (input: UntagResourceCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
22
+ export declare const serializeAws_restJson1UpdateStageCommand: (input: UpdateStageCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
23
+ export declare const deserializeAws_restJson1CreateParticipantTokenCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<CreateParticipantTokenCommandOutput>;
24
+ export declare const deserializeAws_restJson1CreateStageCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<CreateStageCommandOutput>;
25
+ export declare const deserializeAws_restJson1DeleteStageCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<DeleteStageCommandOutput>;
26
+ export declare const deserializeAws_restJson1DisconnectParticipantCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<DisconnectParticipantCommandOutput>;
27
+ export declare const deserializeAws_restJson1GetStageCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<GetStageCommandOutput>;
28
+ export declare const deserializeAws_restJson1ListStagesCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<ListStagesCommandOutput>;
29
+ export declare const deserializeAws_restJson1ListTagsForResourceCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<ListTagsForResourceCommandOutput>;
30
+ export declare const deserializeAws_restJson1TagResourceCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<TagResourceCommandOutput>;
31
+ export declare const deserializeAws_restJson1UntagResourceCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<UntagResourceCommandOutput>;
32
+ export declare const deserializeAws_restJson1UpdateStageCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<UpdateStageCommandOutput>;
@@ -0,0 +1,42 @@
1
+ import { FetchHttpHandler as RequestHandler } from "@aws-sdk/fetch-http-handler";
2
+ import { IVSRealTimeClientConfig } from "./IVSRealTimeClient";
3
+ /**
4
+ * @internal
5
+ */
6
+ export declare const getRuntimeConfig: (config: IVSRealTimeClientConfig) => {
7
+ runtime: string;
8
+ defaultsMode: import("@aws-sdk/types").Provider<import("@aws-sdk/smithy-client").ResolvedDefaultsMode>;
9
+ bodyLengthChecker: import("@aws-sdk/types").BodyLengthCalculator;
10
+ credentialDefaultProvider: (input: any) => import("@aws-sdk/types").Provider<import("@aws-sdk/types").Credentials>;
11
+ defaultUserAgentProvider: import("@aws-sdk/types").Provider<import("@aws-sdk/types").UserAgent>;
12
+ maxAttempts: number | import("@aws-sdk/types").Provider<number>;
13
+ region: string | import("@aws-sdk/types").Provider<any>;
14
+ requestHandler: (import("@aws-sdk/types").RequestHandler<any, any, import("@aws-sdk/types").HttpHandlerOptions> & import("@aws-sdk/protocol-http").HttpHandler) | RequestHandler;
15
+ retryMode: string | import("@aws-sdk/types").Provider<string>;
16
+ sha256: import("@aws-sdk/types").HashConstructor;
17
+ streamCollector: import("@aws-sdk/types").StreamCollector;
18
+ useDualstackEndpoint: boolean | import("@aws-sdk/types").Provider<boolean>;
19
+ useFipsEndpoint: boolean | import("@aws-sdk/types").Provider<boolean>;
20
+ apiVersion: string;
21
+ urlParser: import("@aws-sdk/types").UrlParser;
22
+ base64Decoder: import("@aws-sdk/types").Decoder;
23
+ base64Encoder: import("@aws-sdk/types").Encoder;
24
+ utf8Decoder: import("@aws-sdk/types").Decoder;
25
+ utf8Encoder: import("@aws-sdk/types").Encoder;
26
+ disableHostPrefix: boolean;
27
+ serviceId: string;
28
+ logger: import("@aws-sdk/types").Logger;
29
+ endpoint?: ((string | import("@aws-sdk/types").Endpoint | import("@aws-sdk/types").Provider<import("@aws-sdk/types").Endpoint> | import("@aws-sdk/types").EndpointV2 | import("@aws-sdk/types").Provider<import("@aws-sdk/types").EndpointV2>) & (string | import("@aws-sdk/types").Provider<string> | import("@aws-sdk/types").Endpoint | import("@aws-sdk/types").Provider<import("@aws-sdk/types").Endpoint> | import("@aws-sdk/types").EndpointV2 | import("@aws-sdk/types").Provider<import("@aws-sdk/types").EndpointV2>)) | undefined;
30
+ endpointProvider: (endpointParams: import("./endpoint/EndpointParameters").EndpointParameters, context?: {
31
+ logger?: import("@aws-sdk/types").Logger | undefined;
32
+ }) => import("@aws-sdk/types").EndpointV2;
33
+ tls?: boolean | undefined;
34
+ retryStrategy?: import("@aws-sdk/types").RetryStrategy | import("@aws-sdk/types").RetryStrategyV2 | undefined;
35
+ credentials?: import("@aws-sdk/types").AwsCredentialIdentity | import("@aws-sdk/types").Provider<import("@aws-sdk/types").AwsCredentialIdentity> | undefined;
36
+ signer?: import("@aws-sdk/types").RequestSigner | ((authScheme?: import("@aws-sdk/types").AuthScheme | undefined) => Promise<import("@aws-sdk/types").RequestSigner>) | undefined;
37
+ signingEscapePath?: boolean | undefined;
38
+ systemClockOffset?: number | undefined;
39
+ signingRegion?: string | undefined;
40
+ signerConstructor?: (new (options: import("@aws-sdk/signature-v4").SignatureV4Init & import("@aws-sdk/signature-v4").SignatureV4CryptoInit) => import("@aws-sdk/types").RequestSigner) | undefined;
41
+ customUserAgent?: string | import("@aws-sdk/types").UserAgent | undefined;
42
+ };
@@ -0,0 +1,42 @@
1
+ import { NodeHttpHandler as RequestHandler } from "@aws-sdk/node-http-handler";
2
+ import { IVSRealTimeClientConfig } from "./IVSRealTimeClient";
3
+ /**
4
+ * @internal
5
+ */
6
+ export declare const getRuntimeConfig: (config: IVSRealTimeClientConfig) => {
7
+ runtime: string;
8
+ defaultsMode: import("@aws-sdk/types").Provider<import("@aws-sdk/smithy-client").ResolvedDefaultsMode>;
9
+ bodyLengthChecker: import("@aws-sdk/types").BodyLengthCalculator;
10
+ credentialDefaultProvider: (input: any) => import("@aws-sdk/types").Provider<import("@aws-sdk/types").Credentials>;
11
+ defaultUserAgentProvider: import("@aws-sdk/types").Provider<import("@aws-sdk/types").UserAgent>;
12
+ maxAttempts: number | import("@aws-sdk/types").Provider<number>;
13
+ region: string | import("@aws-sdk/types").Provider<string>;
14
+ requestHandler: (import("@aws-sdk/types").RequestHandler<any, any, import("@aws-sdk/types").HttpHandlerOptions> & import("@aws-sdk/protocol-http").HttpHandler) | RequestHandler;
15
+ retryMode: string | import("@aws-sdk/types").Provider<string>;
16
+ sha256: import("@aws-sdk/types").HashConstructor;
17
+ streamCollector: import("@aws-sdk/types").StreamCollector;
18
+ useDualstackEndpoint: boolean | import("@aws-sdk/types").Provider<boolean>;
19
+ useFipsEndpoint: boolean | import("@aws-sdk/types").Provider<boolean>;
20
+ apiVersion: string;
21
+ urlParser: import("@aws-sdk/types").UrlParser;
22
+ base64Decoder: import("@aws-sdk/types").Decoder;
23
+ base64Encoder: import("@aws-sdk/types").Encoder;
24
+ utf8Decoder: import("@aws-sdk/types").Decoder;
25
+ utf8Encoder: import("@aws-sdk/types").Encoder;
26
+ disableHostPrefix: boolean;
27
+ serviceId: string;
28
+ logger: import("@aws-sdk/types").Logger;
29
+ endpoint?: ((string | import("@aws-sdk/types").Endpoint | import("@aws-sdk/types").Provider<import("@aws-sdk/types").Endpoint> | import("@aws-sdk/types").EndpointV2 | import("@aws-sdk/types").Provider<import("@aws-sdk/types").EndpointV2>) & (string | import("@aws-sdk/types").Provider<string> | import("@aws-sdk/types").Endpoint | import("@aws-sdk/types").Provider<import("@aws-sdk/types").Endpoint> | import("@aws-sdk/types").EndpointV2 | import("@aws-sdk/types").Provider<import("@aws-sdk/types").EndpointV2>)) | undefined;
30
+ endpointProvider: (endpointParams: import("./endpoint/EndpointParameters").EndpointParameters, context?: {
31
+ logger?: import("@aws-sdk/types").Logger | undefined;
32
+ }) => import("@aws-sdk/types").EndpointV2;
33
+ tls?: boolean | undefined;
34
+ retryStrategy?: import("@aws-sdk/types").RetryStrategy | import("@aws-sdk/types").RetryStrategyV2 | undefined;
35
+ credentials?: import("@aws-sdk/types").AwsCredentialIdentity | import("@aws-sdk/types").Provider<import("@aws-sdk/types").AwsCredentialIdentity> | undefined;
36
+ signer?: import("@aws-sdk/types").RequestSigner | ((authScheme?: import("@aws-sdk/types").AuthScheme | undefined) => Promise<import("@aws-sdk/types").RequestSigner>) | undefined;
37
+ signingEscapePath?: boolean | undefined;
38
+ systemClockOffset?: number | undefined;
39
+ signingRegion?: string | undefined;
40
+ signerConstructor?: (new (options: import("@aws-sdk/signature-v4").SignatureV4Init & import("@aws-sdk/signature-v4").SignatureV4CryptoInit) => import("@aws-sdk/types").RequestSigner) | undefined;
41
+ customUserAgent?: string | import("@aws-sdk/types").UserAgent | undefined;
42
+ };