@aws-sdk/client-ivs 3.360.0 → 3.361.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 (29) hide show
  1. package/README.md +29 -1
  2. package/dist-cjs/Ivs.js +4 -0
  3. package/dist-cjs/commands/BatchStartViewerSessionRevocationCommand.js +46 -0
  4. package/dist-cjs/commands/StartViewerSessionRevocationCommand.js +46 -0
  5. package/dist-cjs/commands/index.js +2 -0
  6. package/dist-cjs/models/models_0.js +15 -15
  7. package/dist-cjs/protocols/Aws_restJson1.js +119 -2
  8. package/dist-es/Ivs.js +4 -0
  9. package/dist-es/commands/BatchStartViewerSessionRevocationCommand.js +42 -0
  10. package/dist-es/commands/StartViewerSessionRevocationCommand.js +42 -0
  11. package/dist-es/commands/index.js +2 -0
  12. package/dist-es/models/models_0.js +13 -13
  13. package/dist-es/protocols/Aws_restJson1.js +113 -0
  14. package/dist-types/Ivs.d.ts +27 -1
  15. package/dist-types/IvsClient.d.ts +17 -3
  16. package/dist-types/commands/BatchStartViewerSessionRevocationCommand.d.ts +90 -0
  17. package/dist-types/commands/StartViewerSessionRevocationCommand.d.ts +89 -0
  18. package/dist-types/commands/index.d.ts +2 -0
  19. package/dist-types/index.d.ts +13 -1
  20. package/dist-types/models/models_0.d.ts +106 -19
  21. package/dist-types/protocols/Aws_restJson1.d.ts +18 -0
  22. package/dist-types/ts3.4/Ivs.d.ts +40 -0
  23. package/dist-types/ts3.4/IvsClient.d.ts +12 -0
  24. package/dist-types/ts3.4/commands/BatchStartViewerSessionRevocationCommand.d.ts +42 -0
  25. package/dist-types/ts3.4/commands/StartViewerSessionRevocationCommand.d.ts +42 -0
  26. package/dist-types/ts3.4/commands/index.d.ts +2 -0
  27. package/dist-types/ts3.4/models/models_0.d.ts +31 -8
  28. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +24 -0
  29. package/package.json +1 -1
@@ -42,6 +42,26 @@ export const se_BatchGetStreamKeyCommand = async (input, context) => {
42
42
  body,
43
43
  });
44
44
  };
45
+ export const se_BatchStartViewerSessionRevocationCommand = async (input, context) => {
46
+ const { hostname, protocol = "https", port, path: basePath } = await context.endpoint();
47
+ const headers = {
48
+ "content-type": "application/json",
49
+ };
50
+ const resolvedPath = `${basePath?.endsWith("/") ? basePath.slice(0, -1) : basePath || ""}` + "/BatchStartViewerSessionRevocation";
51
+ let body;
52
+ body = JSON.stringify(take(input, {
53
+ viewerSessions: (_) => _json(_),
54
+ }));
55
+ return new __HttpRequest({
56
+ protocol,
57
+ hostname,
58
+ port,
59
+ method: "POST",
60
+ headers,
61
+ path: resolvedPath,
62
+ body,
63
+ });
64
+ };
45
65
  export const se_CreateChannelCommand = async (input, context) => {
46
66
  const { hostname, protocol = "https", port, path: basePath } = await context.endpoint();
47
67
  const headers = {
@@ -505,6 +525,28 @@ export const se_PutMetadataCommand = async (input, context) => {
505
525
  body,
506
526
  });
507
527
  };
528
+ export const se_StartViewerSessionRevocationCommand = async (input, context) => {
529
+ const { hostname, protocol = "https", port, path: basePath } = await context.endpoint();
530
+ const headers = {
531
+ "content-type": "application/json",
532
+ };
533
+ const resolvedPath = `${basePath?.endsWith("/") ? basePath.slice(0, -1) : basePath || ""}` + "/StartViewerSessionRevocation";
534
+ let body;
535
+ body = JSON.stringify(take(input, {
536
+ channelArn: [],
537
+ viewerId: [],
538
+ viewerSessionVersionsLessThanOrEqualTo: [],
539
+ }));
540
+ return new __HttpRequest({
541
+ protocol,
542
+ hostname,
543
+ port,
544
+ method: "POST",
545
+ headers,
546
+ path: resolvedPath,
547
+ body,
548
+ });
549
+ };
508
550
  export const se_StopStreamCommand = async (input, context) => {
509
551
  const { hostname, protocol = "https", port, path: basePath } = await context.endpoint();
510
552
  const headers = {
@@ -652,6 +694,39 @@ const de_BatchGetStreamKeyCommandError = async (output, context) => {
652
694
  errorCode,
653
695
  });
654
696
  };
697
+ export const de_BatchStartViewerSessionRevocationCommand = async (output, context) => {
698
+ if (output.statusCode !== 200 && output.statusCode >= 300) {
699
+ return de_BatchStartViewerSessionRevocationCommandError(output, context);
700
+ }
701
+ const contents = map({
702
+ $metadata: deserializeMetadata(output),
703
+ });
704
+ const data = __expectNonNull(__expectObject(await parseBody(output.body, context)), "body");
705
+ const doc = take(data, {
706
+ errors: _json,
707
+ });
708
+ Object.assign(contents, doc);
709
+ return contents;
710
+ };
711
+ const de_BatchStartViewerSessionRevocationCommandError = async (output, context) => {
712
+ const parsedOutput = {
713
+ ...output,
714
+ body: await parseErrorBody(output.body, context),
715
+ };
716
+ const errorCode = loadRestJsonErrorCode(output, parsedOutput.body);
717
+ switch (errorCode) {
718
+ case "ValidationException":
719
+ case "com.amazonaws.ivs#ValidationException":
720
+ throw await de_ValidationExceptionRes(parsedOutput, context);
721
+ default:
722
+ const parsedBody = parsedOutput.body;
723
+ return throwDefaultError({
724
+ output,
725
+ parsedBody,
726
+ errorCode,
727
+ });
728
+ }
729
+ };
655
730
  export const de_CreateChannelCommand = async (output, context) => {
656
731
  if (output.statusCode !== 200 && output.statusCode >= 300) {
657
732
  return de_CreateChannelCommandError(output, context);
@@ -1548,6 +1623,44 @@ const de_PutMetadataCommandError = async (output, context) => {
1548
1623
  });
1549
1624
  }
1550
1625
  };
1626
+ export const de_StartViewerSessionRevocationCommand = async (output, context) => {
1627
+ if (output.statusCode !== 200 && output.statusCode >= 300) {
1628
+ return de_StartViewerSessionRevocationCommandError(output, context);
1629
+ }
1630
+ const contents = map({
1631
+ $metadata: deserializeMetadata(output),
1632
+ });
1633
+ await collectBody(output.body, context);
1634
+ return contents;
1635
+ };
1636
+ const de_StartViewerSessionRevocationCommandError = async (output, context) => {
1637
+ const parsedOutput = {
1638
+ ...output,
1639
+ body: await parseErrorBody(output.body, context),
1640
+ };
1641
+ const errorCode = loadRestJsonErrorCode(output, parsedOutput.body);
1642
+ switch (errorCode) {
1643
+ case "AccessDeniedException":
1644
+ case "com.amazonaws.ivs#AccessDeniedException":
1645
+ throw await de_AccessDeniedExceptionRes(parsedOutput, context);
1646
+ case "InternalServerException":
1647
+ case "com.amazonaws.ivs#InternalServerException":
1648
+ throw await de_InternalServerExceptionRes(parsedOutput, context);
1649
+ case "ThrottlingException":
1650
+ case "com.amazonaws.ivs#ThrottlingException":
1651
+ throw await de_ThrottlingExceptionRes(parsedOutput, context);
1652
+ case "ValidationException":
1653
+ case "com.amazonaws.ivs#ValidationException":
1654
+ throw await de_ValidationExceptionRes(parsedOutput, context);
1655
+ default:
1656
+ const parsedBody = parsedOutput.body;
1657
+ return throwDefaultError({
1658
+ output,
1659
+ parsedBody,
1660
+ errorCode,
1661
+ });
1662
+ }
1663
+ };
1551
1664
  export const de_StopStreamCommand = async (output, context) => {
1552
1665
  if (output.statusCode !== 200 && output.statusCode >= 300) {
1553
1666
  return de_StopStreamCommandError(output, context);
@@ -1,6 +1,7 @@
1
1
  import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types";
2
2
  import { BatchGetChannelCommandInput, BatchGetChannelCommandOutput } from "./commands/BatchGetChannelCommand";
3
3
  import { BatchGetStreamKeyCommandInput, BatchGetStreamKeyCommandOutput } from "./commands/BatchGetStreamKeyCommand";
4
+ import { BatchStartViewerSessionRevocationCommandInput, BatchStartViewerSessionRevocationCommandOutput } from "./commands/BatchStartViewerSessionRevocationCommand";
4
5
  import { CreateChannelCommandInput, CreateChannelCommandOutput } from "./commands/CreateChannelCommand";
5
6
  import { CreateRecordingConfigurationCommandInput, CreateRecordingConfigurationCommandOutput } from "./commands/CreateRecordingConfigurationCommand";
6
7
  import { CreateStreamKeyCommandInput, CreateStreamKeyCommandOutput } from "./commands/CreateStreamKeyCommand";
@@ -23,6 +24,7 @@ import { ListStreamsCommandInput, ListStreamsCommandOutput } from "./commands/Li
23
24
  import { ListStreamSessionsCommandInput, ListStreamSessionsCommandOutput } from "./commands/ListStreamSessionsCommand";
24
25
  import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } from "./commands/ListTagsForResourceCommand";
25
26
  import { PutMetadataCommandInput, PutMetadataCommandOutput } from "./commands/PutMetadataCommand";
27
+ import { StartViewerSessionRevocationCommandInput, StartViewerSessionRevocationCommandOutput } from "./commands/StartViewerSessionRevocationCommand";
26
28
  import { StopStreamCommandInput, StopStreamCommandOutput } from "./commands/StopStreamCommand";
27
29
  import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand";
28
30
  import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
@@ -41,6 +43,12 @@ export interface Ivs {
41
43
  batchGetStreamKey(args: BatchGetStreamKeyCommandInput, options?: __HttpHandlerOptions): Promise<BatchGetStreamKeyCommandOutput>;
42
44
  batchGetStreamKey(args: BatchGetStreamKeyCommandInput, cb: (err: any, data?: BatchGetStreamKeyCommandOutput) => void): void;
43
45
  batchGetStreamKey(args: BatchGetStreamKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetStreamKeyCommandOutput) => void): void;
46
+ /**
47
+ * @see {@link BatchStartViewerSessionRevocationCommand}
48
+ */
49
+ batchStartViewerSessionRevocation(args: BatchStartViewerSessionRevocationCommandInput, options?: __HttpHandlerOptions): Promise<BatchStartViewerSessionRevocationCommandOutput>;
50
+ batchStartViewerSessionRevocation(args: BatchStartViewerSessionRevocationCommandInput, cb: (err: any, data?: BatchStartViewerSessionRevocationCommandOutput) => void): void;
51
+ batchStartViewerSessionRevocation(args: BatchStartViewerSessionRevocationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchStartViewerSessionRevocationCommandOutput) => void): void;
44
52
  /**
45
53
  * @see {@link CreateChannelCommand}
46
54
  */
@@ -173,6 +181,12 @@ export interface Ivs {
173
181
  putMetadata(args: PutMetadataCommandInput, options?: __HttpHandlerOptions): Promise<PutMetadataCommandOutput>;
174
182
  putMetadata(args: PutMetadataCommandInput, cb: (err: any, data?: PutMetadataCommandOutput) => void): void;
175
183
  putMetadata(args: PutMetadataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutMetadataCommandOutput) => void): void;
184
+ /**
185
+ * @see {@link StartViewerSessionRevocationCommand}
186
+ */
187
+ startViewerSessionRevocation(args: StartViewerSessionRevocationCommandInput, options?: __HttpHandlerOptions): Promise<StartViewerSessionRevocationCommandOutput>;
188
+ startViewerSessionRevocation(args: StartViewerSessionRevocationCommandInput, cb: (err: any, data?: StartViewerSessionRevocationCommandOutput) => void): void;
189
+ startViewerSessionRevocation(args: StartViewerSessionRevocationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartViewerSessionRevocationCommandOutput) => void): void;
176
190
  /**
177
191
  * @see {@link StopStreamCommand}
178
192
  */
@@ -450,7 +464,7 @@ export interface Ivs {
450
464
  * </li>
451
465
  * </ul>
452
466
  * <p>
453
- * <b>PlaybackKeyPair Endpoints</b>
467
+ * <b>Private Channel Endpoints</b>
454
468
  * </p>
455
469
  * <p>For more information, see <a href="https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html">Setting Up Private Channels</a> in the
456
470
  * <i>Amazon IVS User Guide</i>.</p>
@@ -481,6 +495,18 @@ export interface Ivs {
481
495
  * pair. This invalidates future viewer tokens generated using the key pair’s
482
496
  * <code>privateKey</code>.</p>
483
497
  * </li>
498
+ * <li>
499
+ * <p>
500
+ * <a>StartViewerSessionRevocation</a> — Starts the process of revoking
501
+ * the viewer session associated with a specified channel ARN and viewer ID. Optionally, you
502
+ * can provide a version to revoke viewer sessions less than and including that
503
+ * version.</p>
504
+ * </li>
505
+ * <li>
506
+ * <p>
507
+ * <a>BatchStartViewerSessionRevocation</a> — Performs <a>StartViewerSessionRevocation</a> on multiple channel ARN and viewer ID pairs
508
+ * simultaneously.</p>
509
+ * </li>
484
510
  * </ul>
485
511
  * <p>
486
512
  * <b>RecordingConfiguration Endpoints</b>
@@ -10,6 +10,7 @@ import { HttpHandler as __HttpHandler } from "@smithy/protocol-http";
10
10
  import { Decoder as __Decoder, Encoder as __Encoder, Provider as __Provider, StreamCollector as __StreamCollector } from "@smithy/types";
11
11
  import { BatchGetChannelCommandInput, BatchGetChannelCommandOutput } from "./commands/BatchGetChannelCommand";
12
12
  import { BatchGetStreamKeyCommandInput, BatchGetStreamKeyCommandOutput } from "./commands/BatchGetStreamKeyCommand";
13
+ import { BatchStartViewerSessionRevocationCommandInput, BatchStartViewerSessionRevocationCommandOutput } from "./commands/BatchStartViewerSessionRevocationCommand";
13
14
  import { CreateChannelCommandInput, CreateChannelCommandOutput } from "./commands/CreateChannelCommand";
14
15
  import { CreateRecordingConfigurationCommandInput, CreateRecordingConfigurationCommandOutput } from "./commands/CreateRecordingConfigurationCommand";
15
16
  import { CreateStreamKeyCommandInput, CreateStreamKeyCommandOutput } from "./commands/CreateStreamKeyCommand";
@@ -32,6 +33,7 @@ import { ListStreamsCommandInput, ListStreamsCommandOutput } from "./commands/Li
32
33
  import { ListStreamSessionsCommandInput, ListStreamSessionsCommandOutput } from "./commands/ListStreamSessionsCommand";
33
34
  import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } from "./commands/ListTagsForResourceCommand";
34
35
  import { PutMetadataCommandInput, PutMetadataCommandOutput } from "./commands/PutMetadataCommand";
36
+ import { StartViewerSessionRevocationCommandInput, StartViewerSessionRevocationCommandOutput } from "./commands/StartViewerSessionRevocationCommand";
35
37
  import { StopStreamCommandInput, StopStreamCommandOutput } from "./commands/StopStreamCommand";
36
38
  import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand";
37
39
  import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
@@ -41,11 +43,11 @@ export { __Client };
41
43
  /**
42
44
  * @public
43
45
  */
44
- export type ServiceInputTypes = BatchGetChannelCommandInput | BatchGetStreamKeyCommandInput | CreateChannelCommandInput | CreateRecordingConfigurationCommandInput | CreateStreamKeyCommandInput | DeleteChannelCommandInput | DeletePlaybackKeyPairCommandInput | DeleteRecordingConfigurationCommandInput | DeleteStreamKeyCommandInput | GetChannelCommandInput | GetPlaybackKeyPairCommandInput | GetRecordingConfigurationCommandInput | GetStreamCommandInput | GetStreamKeyCommandInput | GetStreamSessionCommandInput | ImportPlaybackKeyPairCommandInput | ListChannelsCommandInput | ListPlaybackKeyPairsCommandInput | ListRecordingConfigurationsCommandInput | ListStreamKeysCommandInput | ListStreamSessionsCommandInput | ListStreamsCommandInput | ListTagsForResourceCommandInput | PutMetadataCommandInput | StopStreamCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateChannelCommandInput;
46
+ export type ServiceInputTypes = BatchGetChannelCommandInput | BatchGetStreamKeyCommandInput | BatchStartViewerSessionRevocationCommandInput | CreateChannelCommandInput | CreateRecordingConfigurationCommandInput | CreateStreamKeyCommandInput | DeleteChannelCommandInput | DeletePlaybackKeyPairCommandInput | DeleteRecordingConfigurationCommandInput | DeleteStreamKeyCommandInput | GetChannelCommandInput | GetPlaybackKeyPairCommandInput | GetRecordingConfigurationCommandInput | GetStreamCommandInput | GetStreamKeyCommandInput | GetStreamSessionCommandInput | ImportPlaybackKeyPairCommandInput | ListChannelsCommandInput | ListPlaybackKeyPairsCommandInput | ListRecordingConfigurationsCommandInput | ListStreamKeysCommandInput | ListStreamSessionsCommandInput | ListStreamsCommandInput | ListTagsForResourceCommandInput | PutMetadataCommandInput | StartViewerSessionRevocationCommandInput | StopStreamCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateChannelCommandInput;
45
47
  /**
46
48
  * @public
47
49
  */
48
- export type ServiceOutputTypes = BatchGetChannelCommandOutput | BatchGetStreamKeyCommandOutput | CreateChannelCommandOutput | CreateRecordingConfigurationCommandOutput | CreateStreamKeyCommandOutput | DeleteChannelCommandOutput | DeletePlaybackKeyPairCommandOutput | DeleteRecordingConfigurationCommandOutput | DeleteStreamKeyCommandOutput | GetChannelCommandOutput | GetPlaybackKeyPairCommandOutput | GetRecordingConfigurationCommandOutput | GetStreamCommandOutput | GetStreamKeyCommandOutput | GetStreamSessionCommandOutput | ImportPlaybackKeyPairCommandOutput | ListChannelsCommandOutput | ListPlaybackKeyPairsCommandOutput | ListRecordingConfigurationsCommandOutput | ListStreamKeysCommandOutput | ListStreamSessionsCommandOutput | ListStreamsCommandOutput | ListTagsForResourceCommandOutput | PutMetadataCommandOutput | StopStreamCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateChannelCommandOutput;
50
+ export type ServiceOutputTypes = BatchGetChannelCommandOutput | BatchGetStreamKeyCommandOutput | BatchStartViewerSessionRevocationCommandOutput | CreateChannelCommandOutput | CreateRecordingConfigurationCommandOutput | CreateStreamKeyCommandOutput | DeleteChannelCommandOutput | DeletePlaybackKeyPairCommandOutput | DeleteRecordingConfigurationCommandOutput | DeleteStreamKeyCommandOutput | GetChannelCommandOutput | GetPlaybackKeyPairCommandOutput | GetRecordingConfigurationCommandOutput | GetStreamCommandOutput | GetStreamKeyCommandOutput | GetStreamSessionCommandOutput | ImportPlaybackKeyPairCommandOutput | ListChannelsCommandOutput | ListPlaybackKeyPairsCommandOutput | ListRecordingConfigurationsCommandOutput | ListStreamKeysCommandOutput | ListStreamSessionsCommandOutput | ListStreamsCommandOutput | ListTagsForResourceCommandOutput | PutMetadataCommandOutput | StartViewerSessionRevocationCommandOutput | StopStreamCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateChannelCommandOutput;
49
51
  /**
50
52
  * @public
51
53
  */
@@ -423,7 +425,7 @@ export interface IvsClientResolvedConfig extends IvsClientResolvedConfigType {
423
425
  * </li>
424
426
  * </ul>
425
427
  * <p>
426
- * <b>PlaybackKeyPair Endpoints</b>
428
+ * <b>Private Channel Endpoints</b>
427
429
  * </p>
428
430
  * <p>For more information, see <a href="https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html">Setting Up Private Channels</a> in the
429
431
  * <i>Amazon IVS User Guide</i>.</p>
@@ -454,6 +456,18 @@ export interface IvsClientResolvedConfig extends IvsClientResolvedConfigType {
454
456
  * pair. This invalidates future viewer tokens generated using the key pair’s
455
457
  * <code>privateKey</code>.</p>
456
458
  * </li>
459
+ * <li>
460
+ * <p>
461
+ * <a>StartViewerSessionRevocation</a> — Starts the process of revoking
462
+ * the viewer session associated with a specified channel ARN and viewer ID. Optionally, you
463
+ * can provide a version to revoke viewer sessions less than and including that
464
+ * version.</p>
465
+ * </li>
466
+ * <li>
467
+ * <p>
468
+ * <a>BatchStartViewerSessionRevocation</a> — Performs <a>StartViewerSessionRevocation</a> on multiple channel ARN and viewer ID pairs
469
+ * simultaneously.</p>
470
+ * </li>
457
471
  * </ul>
458
472
  * <p>
459
473
  * <b>RecordingConfiguration Endpoints</b>
@@ -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 { IvsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IvsClient";
5
+ import { BatchStartViewerSessionRevocationRequest, BatchStartViewerSessionRevocationResponse } from "../models/models_0";
6
+ /**
7
+ * @public
8
+ */
9
+ export { __MetadataBearer, $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link BatchStartViewerSessionRevocationCommand}.
14
+ */
15
+ export interface BatchStartViewerSessionRevocationCommandInput extends BatchStartViewerSessionRevocationRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link BatchStartViewerSessionRevocationCommand}.
21
+ */
22
+ export interface BatchStartViewerSessionRevocationCommandOutput extends BatchStartViewerSessionRevocationResponse, __MetadataBearer {
23
+ }
24
+ /**
25
+ * @public
26
+ * <p>Performs <a>StartViewerSessionRevocation</a> on multiple channel ARN and viewer
27
+ * ID pairs simultaneously.</p>
28
+ * @example
29
+ * Use a bare-bones client and the command you need to make an API call.
30
+ * ```javascript
31
+ * import { IvsClient, BatchStartViewerSessionRevocationCommand } from "@aws-sdk/client-ivs"; // ES Modules import
32
+ * // const { IvsClient, BatchStartViewerSessionRevocationCommand } = require("@aws-sdk/client-ivs"); // CommonJS import
33
+ * const client = new IvsClient(config);
34
+ * const input = { // BatchStartViewerSessionRevocationRequest
35
+ * viewerSessions: [ // BatchStartViewerSessionRevocationViewerSessionList // required
36
+ * { // BatchStartViewerSessionRevocationViewerSession
37
+ * channelArn: "STRING_VALUE", // required
38
+ * viewerId: "STRING_VALUE", // required
39
+ * viewerSessionVersionsLessThanOrEqualTo: Number("int"),
40
+ * },
41
+ * ],
42
+ * };
43
+ * const command = new BatchStartViewerSessionRevocationCommand(input);
44
+ * const response = await client.send(command);
45
+ * // { // BatchStartViewerSessionRevocationResponse
46
+ * // errors: [ // BatchStartViewerSessionRevocationErrors
47
+ * // { // BatchStartViewerSessionRevocationError
48
+ * // channelArn: "STRING_VALUE", // required
49
+ * // viewerId: "STRING_VALUE", // required
50
+ * // code: "STRING_VALUE",
51
+ * // message: "STRING_VALUE",
52
+ * // },
53
+ * // ],
54
+ * // };
55
+ *
56
+ * ```
57
+ *
58
+ * @param BatchStartViewerSessionRevocationCommandInput - {@link BatchStartViewerSessionRevocationCommandInput}
59
+ * @returns {@link BatchStartViewerSessionRevocationCommandOutput}
60
+ * @see {@link BatchStartViewerSessionRevocationCommandInput} for command's `input` shape.
61
+ * @see {@link BatchStartViewerSessionRevocationCommandOutput} for command's `response` shape.
62
+ * @see {@link IvsClientResolvedConfig | config} for IvsClient's `config` shape.
63
+ *
64
+ * @throws {@link ValidationException} (client fault)
65
+ * <p/>
66
+ *
67
+ * @throws {@link IvsServiceException}
68
+ * <p>Base exception class for all service exceptions from Ivs service.</p>
69
+ *
70
+ */
71
+ export declare class BatchStartViewerSessionRevocationCommand extends $Command<BatchStartViewerSessionRevocationCommandInput, BatchStartViewerSessionRevocationCommandOutput, IvsClientResolvedConfig> {
72
+ readonly input: BatchStartViewerSessionRevocationCommandInput;
73
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
74
+ /**
75
+ * @public
76
+ */
77
+ constructor(input: BatchStartViewerSessionRevocationCommandInput);
78
+ /**
79
+ * @internal
80
+ */
81
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IvsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<BatchStartViewerSessionRevocationCommandInput, BatchStartViewerSessionRevocationCommandOutput>;
82
+ /**
83
+ * @internal
84
+ */
85
+ private serialize;
86
+ /**
87
+ * @internal
88
+ */
89
+ private deserialize;
90
+ }
@@ -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 { IvsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IvsClient";
5
+ import { StartViewerSessionRevocationRequest, StartViewerSessionRevocationResponse } from "../models/models_0";
6
+ /**
7
+ * @public
8
+ */
9
+ export { __MetadataBearer, $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link StartViewerSessionRevocationCommand}.
14
+ */
15
+ export interface StartViewerSessionRevocationCommandInput extends StartViewerSessionRevocationRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link StartViewerSessionRevocationCommand}.
21
+ */
22
+ export interface StartViewerSessionRevocationCommandOutput extends StartViewerSessionRevocationResponse, __MetadataBearer {
23
+ }
24
+ /**
25
+ * @public
26
+ * <p>Starts the process of revoking the viewer session associated with a specified channel ARN
27
+ * and viewer ID. Optionally, you can provide a version to revoke viewer sessions less than and
28
+ * including that version. For instructions on associating a viewer ID with a viewer session, see
29
+ * <a href="https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html">Setting Up
30
+ * Private Channels</a>.</p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { IvsClient, StartViewerSessionRevocationCommand } from "@aws-sdk/client-ivs"; // ES Modules import
35
+ * // const { IvsClient, StartViewerSessionRevocationCommand } = require("@aws-sdk/client-ivs"); // CommonJS import
36
+ * const client = new IvsClient(config);
37
+ * const input = { // StartViewerSessionRevocationRequest
38
+ * channelArn: "STRING_VALUE", // required
39
+ * viewerId: "STRING_VALUE", // required
40
+ * viewerSessionVersionsLessThanOrEqualTo: Number("int"),
41
+ * };
42
+ * const command = new StartViewerSessionRevocationCommand(input);
43
+ * const response = await client.send(command);
44
+ * // {};
45
+ *
46
+ * ```
47
+ *
48
+ * @param StartViewerSessionRevocationCommandInput - {@link StartViewerSessionRevocationCommandInput}
49
+ * @returns {@link StartViewerSessionRevocationCommandOutput}
50
+ * @see {@link StartViewerSessionRevocationCommandInput} for command's `input` shape.
51
+ * @see {@link StartViewerSessionRevocationCommandOutput} for command's `response` shape.
52
+ * @see {@link IvsClientResolvedConfig | config} for IvsClient's `config` shape.
53
+ *
54
+ * @throws {@link AccessDeniedException} (client fault)
55
+ * <p/>
56
+ *
57
+ * @throws {@link InternalServerException} (server fault)
58
+ * <p/>
59
+ *
60
+ * @throws {@link ThrottlingException} (client fault)
61
+ * <p/>
62
+ *
63
+ * @throws {@link ValidationException} (client fault)
64
+ * <p/>
65
+ *
66
+ * @throws {@link IvsServiceException}
67
+ * <p>Base exception class for all service exceptions from Ivs service.</p>
68
+ *
69
+ */
70
+ export declare class StartViewerSessionRevocationCommand extends $Command<StartViewerSessionRevocationCommandInput, StartViewerSessionRevocationCommandOutput, IvsClientResolvedConfig> {
71
+ readonly input: StartViewerSessionRevocationCommandInput;
72
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
73
+ /**
74
+ * @public
75
+ */
76
+ constructor(input: StartViewerSessionRevocationCommandInput);
77
+ /**
78
+ * @internal
79
+ */
80
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IvsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StartViewerSessionRevocationCommandInput, StartViewerSessionRevocationCommandOutput>;
81
+ /**
82
+ * @internal
83
+ */
84
+ private serialize;
85
+ /**
86
+ * @internal
87
+ */
88
+ private deserialize;
89
+ }
@@ -1,5 +1,6 @@
1
1
  export * from "./BatchGetChannelCommand";
2
2
  export * from "./BatchGetStreamKeyCommand";
3
+ export * from "./BatchStartViewerSessionRevocationCommand";
3
4
  export * from "./CreateChannelCommand";
4
5
  export * from "./CreateRecordingConfigurationCommand";
5
6
  export * from "./CreateStreamKeyCommand";
@@ -22,6 +23,7 @@ export * from "./ListStreamSessionsCommand";
22
23
  export * from "./ListStreamsCommand";
23
24
  export * from "./ListTagsForResourceCommand";
24
25
  export * from "./PutMetadataCommand";
26
+ export * from "./StartViewerSessionRevocationCommand";
25
27
  export * from "./StopStreamCommand";
26
28
  export * from "./TagResourceCommand";
27
29
  export * from "./UntagResourceCommand";
@@ -249,7 +249,7 @@
249
249
  * </li>
250
250
  * </ul>
251
251
  * <p>
252
- * <b>PlaybackKeyPair Endpoints</b>
252
+ * <b>Private Channel Endpoints</b>
253
253
  * </p>
254
254
  * <p>For more information, see <a href="https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html">Setting Up Private Channels</a> in the
255
255
  * <i>Amazon IVS User Guide</i>.</p>
@@ -280,6 +280,18 @@
280
280
  * pair. This invalidates future viewer tokens generated using the key pair’s
281
281
  * <code>privateKey</code>.</p>
282
282
  * </li>
283
+ * <li>
284
+ * <p>
285
+ * <a>StartViewerSessionRevocation</a> — Starts the process of revoking
286
+ * the viewer session associated with a specified channel ARN and viewer ID. Optionally, you
287
+ * can provide a version to revoke viewer sessions less than and including that
288
+ * version.</p>
289
+ * </li>
290
+ * <li>
291
+ * <p>
292
+ * <a>BatchStartViewerSessionRevocation</a> — Performs <a>StartViewerSessionRevocation</a> on multiple channel ARN and viewer ID pairs
293
+ * simultaneously.</p>
294
+ * </li>
283
295
  * </ul>
284
296
  * <p>
285
297
  * <b>RecordingConfiguration Endpoints</b>
@@ -263,6 +263,84 @@ export interface BatchGetStreamKeyResponse {
263
263
  */
264
264
  errors?: BatchError[];
265
265
  }
266
+ /**
267
+ * @public
268
+ * <p>A viewer session to revoke in the call to <a>BatchStartViewerSessionRevocation</a>.</p>
269
+ */
270
+ export interface BatchStartViewerSessionRevocationViewerSession {
271
+ /**
272
+ * <p>The ARN of the channel associated with the viewer session to revoke.</p>
273
+ */
274
+ channelArn: string | undefined;
275
+ /**
276
+ * <p>The ID of the viewer associated with the viewer session to revoke. Do not use this field
277
+ * for personally identifying, confidential, or sensitive information.</p>
278
+ */
279
+ viewerId: string | undefined;
280
+ /**
281
+ * <p>An optional filter on which versions of the viewer session to revoke. All versions less
282
+ * than or equal to the specified version will be revoked. Default: 0.</p>
283
+ */
284
+ viewerSessionVersionsLessThanOrEqualTo?: number;
285
+ }
286
+ /**
287
+ * @public
288
+ */
289
+ export interface BatchStartViewerSessionRevocationRequest {
290
+ /**
291
+ * <p>Array of viewer sessions, one per channel-ARN and viewer-ID pair.</p>
292
+ */
293
+ viewerSessions: BatchStartViewerSessionRevocationViewerSession[] | undefined;
294
+ }
295
+ /**
296
+ * @public
297
+ * <p>Error for a request in the batch for BatchStartViewerSessionRevocation. Each error is
298
+ * related to a specific channel-ARN and viewer-ID pair.</p>
299
+ */
300
+ export interface BatchStartViewerSessionRevocationError {
301
+ /**
302
+ * <p>Channel ARN.</p>
303
+ */
304
+ channelArn: string | undefined;
305
+ /**
306
+ * <p>The ID of the viewer session to revoke.</p>
307
+ */
308
+ viewerId: string | undefined;
309
+ /**
310
+ * <p>Error code.</p>
311
+ */
312
+ code?: string;
313
+ /**
314
+ * <p>Error message, determined by the application.</p>
315
+ */
316
+ message?: string;
317
+ }
318
+ /**
319
+ * @public
320
+ */
321
+ export interface BatchStartViewerSessionRevocationResponse {
322
+ /**
323
+ * <p>Each error object is related to a specific <code>channelArn</code> and
324
+ * <code>viewerId</code> pair in the request.</p>
325
+ */
326
+ errors?: BatchStartViewerSessionRevocationError[];
327
+ }
328
+ /**
329
+ * @public
330
+ * <p/>
331
+ */
332
+ export declare class ValidationException extends __BaseException {
333
+ readonly name: "ValidationException";
334
+ readonly $fault: "client";
335
+ /**
336
+ * <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
337
+ */
338
+ exceptionMessage?: string;
339
+ /**
340
+ * @internal
341
+ */
342
+ constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
343
+ }
266
344
  /**
267
345
  * @public
268
346
  */
@@ -431,22 +509,6 @@ export declare class ServiceQuotaExceededException extends __BaseException {
431
509
  */
432
510
  constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
433
511
  }
434
- /**
435
- * @public
436
- * <p/>
437
- */
438
- export declare class ValidationException extends __BaseException {
439
- readonly name: "ValidationException";
440
- readonly $fault: "client";
441
- /**
442
- * <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
443
- */
444
- exceptionMessage?: string;
445
- /**
446
- * @internal
447
- */
448
- constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
449
- }
450
512
  /**
451
513
  * @public
452
514
  * <p/>
@@ -1579,6 +1641,30 @@ export declare class ThrottlingException extends __BaseException {
1579
1641
  */
1580
1642
  constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
1581
1643
  }
1644
+ /**
1645
+ * @public
1646
+ */
1647
+ export interface StartViewerSessionRevocationRequest {
1648
+ /**
1649
+ * <p>The ARN of the channel associated with the viewer session to revoke.</p>
1650
+ */
1651
+ channelArn: string | undefined;
1652
+ /**
1653
+ * <p>The ID of the viewer associated with the viewer session to revoke. Do not use this field
1654
+ * for personally identifying, confidential, or sensitive information.</p>
1655
+ */
1656
+ viewerId: string | undefined;
1657
+ /**
1658
+ * <p>An optional filter on which versions of the viewer session to revoke. All versions less
1659
+ * than or equal to the specified version will be revoked. Default: 0.</p>
1660
+ */
1661
+ viewerSessionVersionsLessThanOrEqualTo?: number;
1662
+ }
1663
+ /**
1664
+ * @public
1665
+ */
1666
+ export interface StartViewerSessionRevocationResponse {
1667
+ }
1582
1668
  /**
1583
1669
  * @public
1584
1670
  */
@@ -1748,9 +1834,10 @@ export interface UpdateChannelRequest {
1748
1834
  */
1749
1835
  insecureIngest?: boolean;
1750
1836
  /**
1751
- * <p>Optional transcode preset for the channel. This is selectable only for <code>ADVANCED_HD</code> and
1752
- * <code>ADVANCED_SD</code> channel types. For those channel types, the default <code>preset</code> is
1753
- * <code>HIGHER_BANDWIDTH_DELIVERY</code>. For other channel types (<code>BASIC</code> and <code>STANDARD</code>), <code>preset</code> is the empty
1837
+ * <p>Optional transcode preset for the channel. This is selectable only for
1838
+ * <code>ADVANCED_HD</code> and <code>ADVANCED_SD</code> channel types. For those channel
1839
+ * types, the default <code>preset</code> is <code>HIGHER_BANDWIDTH_DELIVERY</code>. For other
1840
+ * channel types (<code>BASIC</code> and <code>STANDARD</code>), <code>preset</code> is the empty
1754
1841
  * string (<code>""</code>).</p>
1755
1842
  */
1756
1843
  preset?: TranscodePreset | string;