@aws-sdk/client-ivs-realtime 3.600.0 → 3.605.0

package/dist-types/commands/ListPublicKeysCommand.d.ts

@@ -0,0 +1,76 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { IVSRealTimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IVSRealTimeClient";
+import { ListPublicKeysRequest, ListPublicKeysResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link ListPublicKeysCommand}.
+ */
+export interface ListPublicKeysCommandInput extends ListPublicKeysRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListPublicKeysCommand}.
+ */
+export interface ListPublicKeysCommandOutput extends ListPublicKeysResponse, __MetadataBearer {
+}
+declare const ListPublicKeysCommand_base: {
+    new (input: ListPublicKeysCommandInput): import("@smithy/smithy-client").CommandImpl<ListPublicKeysCommandInput, ListPublicKeysCommandOutput, IVSRealTimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (...[input]: [] | [ListPublicKeysCommandInput]): import("@smithy/smithy-client").CommandImpl<ListPublicKeysCommandInput, ListPublicKeysCommandOutput, IVSRealTimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Gets summary information about all public keys in your account, in the AWS region where the API request is processed.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { IVSRealTimeClient, ListPublicKeysCommand } from "@aws-sdk/client-ivs-realtime"; // ES Modules import
+ * // const { IVSRealTimeClient, ListPublicKeysCommand } = require("@aws-sdk/client-ivs-realtime"); // CommonJS import
+ * const client = new IVSRealTimeClient(config);
+ * const input = { // ListPublicKeysRequest
+ *   nextToken: "STRING_VALUE",
+ *   maxResults: Number("int"),
+ * };
+ * const command = new ListPublicKeysCommand(input);
+ * const response = await client.send(command);
+ * // { // ListPublicKeysResponse
+ * //   publicKeys: [ // PublicKeyList // required
+ * //     { // PublicKeySummary
+ * //       arn: "STRING_VALUE",
+ * //       name: "STRING_VALUE",
+ * //       tags: { // Tags
+ * //         "<keys>": "STRING_VALUE",
+ * //       },
+ * //     },
+ * //   ],
+ * //   nextToken: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param ListPublicKeysCommandInput - {@link ListPublicKeysCommandInput}
+ * @returns {@link ListPublicKeysCommandOutput}
+ * @see {@link ListPublicKeysCommandInput} for command's `input` shape.
+ * @see {@link ListPublicKeysCommandOutput} for command's `response` shape.
+ * @see {@link IVSRealTimeClientResolvedConfig | config} for IVSRealTimeClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p/>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p/>
+ *
+ * @throws {@link IVSRealTimeServiceException}
+ * <p>Base exception class for all service exceptions from IVSRealTime service.</p>
+ *
+ * @public
+ */
+export declare class ListPublicKeysCommand extends ListPublicKeysCommand_base {
+}

package/dist-types/commands/UpdateStageCommand.d.ts

@@ -37,6 +37,12 @@ declare const UpdateStageCommand_base: {
  * const input = { // UpdateStageRequest
  *   arn: "STRING_VALUE", // required
  *   name: "STRING_VALUE",
+ *   autoParticipantRecordingConfiguration: { // AutoParticipantRecordingConfiguration
+ *     storageConfigurationArn: "STRING_VALUE", // required
+ *     mediaTypes: [ // ParticipantRecordingMediaTypeList
+ *       "STRING_VALUE",
+ *     ],
+ *   },
  * };
  * const command = new UpdateStageCommand(input);
  * const response = await client.send(command);
@@ -48,6 +54,16 @@ declare const UpdateStageCommand_base: {
  * //     tags: { // Tags
  * //       "<keys>": "STRING_VALUE",
  * //     },
+ * //     autoParticipantRecordingConfiguration: { // AutoParticipantRecordingConfiguration
+ * //       storageConfigurationArn: "STRING_VALUE", // required
+ * //       mediaTypes: [ // ParticipantRecordingMediaTypeList
+ * //         "STRING_VALUE",
+ * //       ],
+ * //     },
+ * //     endpoints: { // StageEndpoints
+ * //       events: "STRING_VALUE",
+ * //       whip: "STRING_VALUE",
+ * //     },
  * //   },
  * // };
  *

package/dist-types/commands/index.d.ts

@@ -3,19 +3,23 @@ export * from "./CreateParticipantTokenCommand";
 export * from "./CreateStageCommand";
 export * from "./CreateStorageConfigurationCommand";
 export * from "./DeleteEncoderConfigurationCommand";
+export * from "./DeletePublicKeyCommand";
 export * from "./DeleteStageCommand";
 export * from "./DeleteStorageConfigurationCommand";
 export * from "./DisconnectParticipantCommand";
 export * from "./GetCompositionCommand";
 export * from "./GetEncoderConfigurationCommand";
 export * from "./GetParticipantCommand";
+export * from "./GetPublicKeyCommand";
 export * from "./GetStageCommand";
 export * from "./GetStageSessionCommand";
 export * from "./GetStorageConfigurationCommand";
+export * from "./ImportPublicKeyCommand";
 export * from "./ListCompositionsCommand";
 export * from "./ListEncoderConfigurationsCommand";
 export * from "./ListParticipantEventsCommand";
 export * from "./ListParticipantsCommand";
+export * from "./ListPublicKeysCommand";
 export * from "./ListStageSessionsCommand";
 export * from "./ListStagesCommand";
 export * from "./ListStorageConfigurationsCommand";

package/dist-types/index.d.ts

@@ -1,46 +1,44 @@
 /**
- * <p>
- *             <b>Introduction</b>
- *          </p>
- *          <p>The Amazon Interactive Video Service (IVS) real-time API is REST compatible, using a standard HTTP
+ * <p>The Amazon Interactive Video Service (IVS) real-time API is REST compatible, using a standard HTTP
  * 	  API and an AWS EventBridge event stream for responses. JSON is used for both requests and responses,
  * 	  including errors.
  *     </p>
- *          <p>Terminology:</p>
+ *          <p>
+ *             <b>Key Concepts</b>
+ *          </p>
  *          <ul>
  *             <li>
- *                <p>A <i>stage</i>  is a virtual space where participants can exchange video in real time.</p>
- *             </li>
- *             <li>
- *                <p>A <i>participant token</i> is a token that authenticates a participant when they join a stage.</p>
- *             </li>
- *             <li>
- *                <p>A <i>participant object</i> represents participants (people) in the stage and
- *           contains information about them. When a token is created, it includes a participant ID;
- *           when a participant uses that token to join a stage, the participant is associated with
- *           that participant ID. There is a 1:1 mapping between participant tokens and
- *           participants.</p>
+ *                <p>
+ *                   <b>Stage</b> — A virtual space where participants can exchange video in real time.</p>
  *             </li>
  *             <li>
- *                <p>Server-side composition: The <i>composition</i> process composites participants
- *           of a stage into a single video and forwards it to a set of outputs (e.g., IVS channels).
- *           Composition endpoints support this process.</p>
+ *                <p>
+ *                   <b>Participant token</b> — A token that authenticates a participant when they join a stage.</p>
  *             </li>
  *             <li>
- *                <p>Server-side composition: A <i>composition</i> controls the look of the outputs,
- *           including how participants are positioned in the video.</p>
+ *                <p>
+ *                   <b>Participant object</b> — Represents participants (people) in the stage and
+ *             contains information about them. When a token is created, it includes a participant ID;
+ *             when a participant uses that token to join a stage, the participant is associated with
+ *             that participant ID. There is a 1:1 mapping between participant tokens and
+ *             participants.</p>
  *             </li>
  *          </ul>
- *          <p>
- *             <b>Resources</b>
- *          </p>
- *          <p>The following resources contain information about your IVS live stream (see <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/getting-started.html">Getting Started with Amazon IVS Real-Time Streaming</a>):</p>
+ *          <p>For server-side composition:</p>
  *          <ul>
  *             <li>
  *                <p>
- *                   <b>Stage</b> — A stage is a virtual space where participants can exchange video in real time.</p>
+ *                   <b>Composition process</b> — Composites participants
+ *             of a stage into a single video and forwards it to a set of outputs (e.g., IVS channels).
+ *             Composition endpoints support this process.</p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <b>Composition</b> — Controls the look of the outputs,
+ *             including how participants are positioned in the video.</p>
  *             </li>
  *          </ul>
+ *          <p>For more information about your IVS live stream, also see <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/getting-started.html">Getting Started with Amazon IVS Real-Time Streaming</a>.</p>
  *          <p>
  *             <b>Tagging</b>
  *          </p>
@@ -56,157 +54,6 @@
  *          <p>The Amazon IVS real-time API has these tag-related endpoints: <a>TagResource</a>, <a>UntagResource</a>, and
  *       <a>ListTagsForResource</a>. The following resource supports tagging: Stage.</p>
  *          <p>At most 50 tags can be applied to a resource.</p>
- *          <p>
- *             <b>Stages Endpoints</b>
- *          </p>
- *          <ul>
- *             <li>
- *                <p>
- *                   <a>CreateParticipantToken</a> — Creates an additional token for a specified stage. This can be done after stage creation or when tokens expire.</p>
- *             </li>
- *             <li>
- *                <p>
- *                   <a>CreateStage</a> — Creates a new stage (and optionally participant tokens).</p>
- *             </li>
- *             <li>
- *                <p>
- *                   <a>DeleteStage</a> — Shuts down and deletes the specified stage (disconnecting all participants).</p>
- *             </li>
- *             <li>
- *                <p>
- *                   <a>DisconnectParticipant</a> — Disconnects a specified participant and revokes the participant permanently from a specified stage.</p>
- *             </li>
- *             <li>
- *                <p>
- *                   <a>GetParticipant</a> — Gets information about the specified
- *           participant token.</p>
- *             </li>
- *             <li>
- *                <p>
- *                   <a>GetStage</a> — Gets information for the specified stage.</p>
- *             </li>
- *             <li>
- *                <p>
- *                   <a>GetStageSession</a> — Gets information for the specified stage
- *           session.</p>
- *             </li>
- *             <li>
- *                <p>
- *                   <a>ListParticipantEvents</a> — Lists events for a specified
- *           participant that occurred during a specified stage session.</p>
- *             </li>
- *             <li>
- *                <p>
- *                   <a>ListParticipants</a> — Lists all participants in a specified stage
- *           session.</p>
- *             </li>
- *             <li>
- *                <p>
- *                   <a>ListStages</a> — Gets summary information about all stages in your account, in the AWS region where the API request is processed.</p>
- *             </li>
- *             <li>
- *                <p>
- *                   <a>ListStageSessions</a> — Gets all sessions for a specified stage.</p>
- *             </li>
- *             <li>
- *                <p>
- *                   <a>UpdateStage</a> — Updates a stage’s configuration.</p>
- *             </li>
- *          </ul>
- *          <p>
- *             <b>Composition Endpoints</b>
- *          </p>
- *          <ul>
- *             <li>
- *                <p>
- *                   <a>GetComposition</a> — Gets information about the specified
- *           Composition resource.</p>
- *             </li>
- *             <li>
- *                <p>
- *                   <a>ListCompositions</a> — Gets summary information about all
- *           Compositions in your account, in the AWS region where the API request is processed.</p>
- *             </li>
- *             <li>
- *                <p>
- *                   <a>StartComposition</a> — Starts a Composition from a stage based on
- *           the configuration provided in the request.</p>
- *             </li>
- *             <li>
- *                <p>
- *                   <a>StopComposition</a> — Stops and deletes a Composition resource.
- *           Any broadcast from the Composition resource is stopped.</p>
- *             </li>
- *          </ul>
- *          <p>
- *             <b>EncoderConfiguration Endpoints</b>
- *          </p>
- *          <ul>
- *             <li>
- *                <p>
- *                   <a>CreateEncoderConfiguration</a> — Creates an EncoderConfiguration object.</p>
- *             </li>
- *             <li>
- *                <p>
- *                   <a>DeleteEncoderConfiguration</a> — Deletes an EncoderConfiguration
- *           resource. Ensures that no Compositions are using this template; otherwise, returns an
- *           error.</p>
- *             </li>
- *             <li>
- *                <p>
- *                   <a>GetEncoderConfiguration</a> — Gets information about the specified
- *           EncoderConfiguration resource.</p>
- *             </li>
- *             <li>
- *                <p>
- *                   <a>ListEncoderConfigurations</a> — Gets summary information about all
- *           EncoderConfigurations in your account, in the AWS region where the API request is
- *           processed.</p>
- *             </li>
- *          </ul>
- *          <p>
- *             <b>StorageConfiguration Endpoints</b>
- *          </p>
- *          <ul>
- *             <li>
- *                <p>
- *                   <a>CreateStorageConfiguration</a> — Creates a new storage configuration, used to enable
- * 		recording to Amazon S3.</p>
- *             </li>
- *             <li>
- *                <p>
- *                   <a>DeleteStorageConfiguration</a> — Deletes the storage configuration for the specified ARN.</p>
- *             </li>
- *             <li>
- *                <p>
- *                   <a>GetStorageConfiguration</a> — Gets the storage configuration for the specified ARN.</p>
- *             </li>
- *             <li>
- *                <p>
- *                   <a>ListStorageConfigurations</a> — Gets summary information about all storage configurations in your
- * 		account, in the AWS region where the API request is processed.</p>
- *             </li>
- *          </ul>
- *          <p>
- *             <b>Tags Endpoints</b>
- *          </p>
- *          <ul>
- *             <li>
- *                <p>
- *                   <a>ListTagsForResource</a> — Gets information about AWS tags for the
- *           specified ARN.</p>
- *             </li>
- *             <li>
- *                <p>
- *                   <a>TagResource</a> — Adds or updates tags for the AWS resource with
- *           the specified ARN.</p>
- *             </li>
- *             <li>
- *                <p>
- *                   <a>UntagResource</a> — Removes tags from the resource with the
- *           specified ARN.</p>
- *             </li>
- *          </ul>
  *
  * @packageDocumentation
  */