@aws-sdk/client-ivs-realtime 3.602.0 → 3.606.0

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
  */

package/dist-types/models/models_0.d.ts

@@ -340,12 +340,12 @@ export declare const ParticipantRecordingMediaType: {
  */
 export type ParticipantRecordingMediaType = (typeof ParticipantRecordingMediaType)[keyof typeof ParticipantRecordingMediaType];
 /**
- * <p>Object specifying an auto-participant-recording configuration.</p>
+ * <p>Object specifying a configuration for individual participant recording.</p>
  * @public
  */
 export interface AutoParticipantRecordingConfiguration {
     /**
-     * <p>ARN of the <a>StorageConfiguration</a> resource to use for auto participant recording. Default: "" (empty string, no storage configuration is specified).  Individual participant recording cannot be started unless a storage configuration is specified, when a  <a>Stage</a> is created or updated.</p>
+     * <p>ARN of the <a>StorageConfiguration</a> resource to use for individual participant recording. Default: <code>""</code> (empty string, no storage configuration is specified). Individual participant recording cannot be started unless a storage configuration is specified, when a  <a>Stage</a> is created or updated.</p>
      * @public
      */
     storageConfigurationArn: string | undefined;
@@ -415,11 +415,27 @@ export interface CreateStageRequest {
      */
     tags?: Record<string, string>;
     /**
-     * <p>Auto participant recording configuration object attached to the stage.</p>
+     * <p>Configuration object for individual participant recording, to attach to the new stage.</p>
      * @public
      */
     autoParticipantRecordingConfiguration?: AutoParticipantRecordingConfiguration;
 }
+/**
+ * <p>Summary information about various endpoints for a stage.</p>
+ * @public
+ */
+export interface StageEndpoints {
+    /**
+     * <p>Events endpoint.</p>
+     * @public
+     */
+    events?: string;
+    /**
+     * <p>WHIP endpoint.</p>
+     * @public
+     */
+    whip?: string;
+}
 /**
  * <p>Object specifying a stage.</p>
  * @public
@@ -450,10 +466,15 @@ export interface Stage {
      */
     tags?: Record<string, string>;
     /**
-     * <p>Auto-participant-recording configuration object attached to the stage.</p>
+     * <p>Configuration object for individual participant recording, attached to the stage.</p>
      * @public
      */
     autoParticipantRecordingConfiguration?: AutoParticipantRecordingConfiguration;
+    /**
+     * <p>Summary information about various endpoints for a stage.</p>
+     * @public
+     */
+    endpoints?: StageEndpoints;
 }
 /**
  * @public
@@ -562,6 +583,21 @@ export interface DeleteEncoderConfigurationRequest {
  */
 export interface DeleteEncoderConfigurationResponse {
 }
+/**
+ * @public
+ */
+export interface DeletePublicKeyRequest {
+    /**
+     * <p>ARN of the public key to be deleted.</p>
+     * @public
+     */
+    arn: string | undefined;
+}
+/**
+ * @public
+ */
+export interface DeletePublicKeyResponse {
+}
 /**
  * @public
  */
@@ -828,7 +864,7 @@ export interface GridConfiguration {
     /**
      * <p>This attribute name identifies the featured slot. A participant with this attribute set
      *          to <code>"true"</code> (as a string value) in <a>ParticipantTokenConfiguration</a> is placed in the featured
-     *          slot.</p>
+     *          slot. Default: <code>""</code> (no featured participant).</p>
      * @public
      */
     featuredParticipantAttribute?: string;
@@ -838,14 +874,15 @@ export interface GridConfiguration {
      */
     omitStoppedVideo?: boolean;
     /**
-     * <p>Sets the non-featured participant display mode. Default: <code>VIDEO</code>.</p>
+     * <p>Sets the non-featured participant display mode, to control the aspect ratio of video tiles. <code>VIDEO</code> is 16:9, <code>SQUARE</code> is 1:1, and <code>PORTRAIT</code> is 3:4. Default: <code>VIDEO</code>.</p>
      * @public
      */
     videoAspectRatio?: VideoAspectRatio;
     /**
-     * <p>Defines how video fits within the participant tile. When not set,
-     * 	  <code>videoFillMode</code> defaults to <code>COVER</code> fill mode for participants in the grid
-     * 	  and to <code>CONTAIN</code> fill mode for featured participants.</p>
+     * <p>Defines how video content fits within the participant tile: <code>FILL</code> (stretched), <code>COVER</code> (cropped),
+     *       or <code>CONTAIN</code> (letterboxed). When not set,
+     *       <code>videoFillMode</code> defaults to <code>COVER</code> fill mode for participants in the grid
+     *       and to <code>CONTAIN</code> fill mode for featured participants.</p>
      * @public
      */
     videoFillMode?: VideoFillMode;
@@ -891,7 +928,7 @@ export interface PipConfiguration {
     /**
      * <p>This attribute name identifies the featured slot. A participant with this attribute set
      *          to <code>"true"</code> (as a string value) in <a>ParticipantTokenConfiguration</a> is placed in the featured
-     *          slot.</p>
+     *          slot. Default: <code>""</code> (no featured participant).</p>
      * @public
      */
     featuredParticipantAttribute?: string;
@@ -901,8 +938,8 @@ export interface PipConfiguration {
      */
     omitStoppedVideo?: boolean;
     /**
-     * <p>Defines how video fits within the participant tile. Default: <code>COVER</code>.
-     * </p>
+     * <p>Defines how video content fits within the participant tile: <code>FILL</code> (stretched),
+     * 	  <code>COVER</code> (cropped), or <code>CONTAIN</code> (letterboxed). Default: <code>COVER</code>.</p>
      * @public
      */
     videoFillMode?: VideoFillMode;
@@ -912,14 +949,14 @@ export interface PipConfiguration {
      */
     gridGap?: number;
     /**
-     * <p>Identifies the PiP slot. A participant with this attribute set
+     * <p>Specifies the participant for the PiP window. A participant with this attribute set
      *          to <code>"true"</code> (as a string value) in <a>ParticipantTokenConfiguration</a>
-     * 		 is placed in the PiP slot.</p>
+     * 	 is placed in the PiP slot. Default: <code>""</code> (no PiP participant).</p>
      * @public
      */
     pipParticipantAttribute?: string;
     /**
-     * <p>Defines PiP behavior when all participants have left. Default: <code>STATIC</code>.</p>
+     * <p>Defines PiP behavior when all participants have left: <code>STATIC</code> (maintains original position/size) or <code>DYNAMIC</code> (expands to full composition). Default: <code>STATIC</code>.</p>
      * @public
      */
     pipBehavior?: PipBehavior;
@@ -1184,17 +1221,17 @@ export interface Participant {
      */
     sdkVersion?: string;
     /**
-     * <p>Name of the S3 bucket to where the participant is being recorded, if individual participant recording is enabled, or "" (empty string), if recording is not enabled.</p>
+     * <p>Name of the S3 bucket to where the participant is being recorded, if individual participant recording is enabled, or <code>""</code> (empty string), if recording is not enabled.</p>
      * @public
      */
     recordingS3BucketName?: string;
     /**
-     * <p>S3 prefix of the S3 bucket to where the participant is being recorded, if individual participant recording is enabled, or "" (empty string), if recording is not enabled.</p>
+     * <p>S3 prefix of the S3 bucket where the participant is being recorded, if individual participant recording is enabled, or <code>""</code> (empty string), if recording is not enabled.</p>
      * @public
      */
     recordingS3Prefix?: string;
     /**
-     * <p>Participant’s recording state.</p>
+     * <p>The participant’s recording state.</p>
      * @public
      */
     recordingState?: ParticipantRecordingState;
@@ -1209,6 +1246,61 @@ export interface GetParticipantResponse {
      */
     participant?: Participant;
 }
+/**
+ * @public
+ */
+export interface GetPublicKeyRequest {
+    /**
+     * <p>ARN of the public key for which the information is to be retrieved.</p>
+     * @public
+     */
+    arn: string | undefined;
+}
+/**
+ * <p>Object specifying a public key used to sign stage participant tokens.</p>
+ * @public
+ */
+export interface PublicKey {
+    /**
+     * <p>Public key ARN.</p>
+     * @public
+     */
+    arn?: string;
+    /**
+     * <p>Public key name.</p>
+     * @public
+     */
+    name?: string;
+    /**
+     * <p>Public key material.</p>
+     * @public
+     */
+    publicKeyMaterial?: string;
+    /**
+     * <p>The public key fingerprint, a short string used to identify or verify the full public key.</p>
+     * @public
+     */
+    fingerprint?: string;
+    /**
+     * <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
+     *             (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS
+     *             Resources</a> for details, including restrictions that apply to tags and "Tag naming
+     *          limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
+     *          there.</p>
+     * @public
+     */
+    tags?: Record<string, string>;
+}
+/**
+ * @public
+ */
+export interface GetPublicKeyResponse {
+    /**
+     * <p>The public key that is returned.</p>
+     * @public
+     */
+    publicKey?: PublicKey;
+}
 /**
  * @public
  */
@@ -1299,6 +1391,40 @@ export interface GetStorageConfigurationResponse {
      */
     storageConfiguration?: StorageConfiguration;
 }
+/**
+ * @public
+ */
+export interface ImportPublicKeyRequest {
+    /**
+     * <p>The content of the public key to be imported.</p>
+     * @public
+     */
+    publicKeyMaterial: string | undefined;
+    /**
+     * <p>Name of the public key to be imported.</p>
+     * @public
+     */
+    name?: string;
+    /**
+     * <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
+     *             (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS
+     *             Resources</a> for details, including restrictions that apply to tags and "Tag naming
+     *          limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
+     *          there.</p>
+     * @public
+     */
+    tags?: Record<string, string>;
+}
+/**
+ * @public
+ */
+export interface ImportPublicKeyResponse {
+    /**
+     * <p>The public key that was imported.</p>
+     * @public
+     */
+    publicKey?: PublicKey;
+}
 /**
  * @public
  */
@@ -1701,7 +1827,7 @@ export interface ParticipantSummary {
      */
     published?: boolean;
     /**
-     * <p>Participant’s recording state.</p>
+     * <p>The participant’s recording state.</p>
      * @public
      */
     recordingState?: ParticipantRecordingState;
@@ -1722,6 +1848,61 @@ export interface ListParticipantsResponse {
      */
     nextToken?: string;
 }
+/**
+ * @public
+ */
+export interface ListPublicKeysRequest {
+    /**
+     * <p>The first public key to retrieve. This is used for pagination; see the <code>nextToken</code> response field.</p>
+     * @public
+     */
+    nextToken?: string;
+    /**
+     * <p>Maximum number of results to return. Default: 50.</p>
+     * @public
+     */
+    maxResults?: number;
+}
+/**
+ * <p>Summary information about a public key.</p>
+ * @public
+ */
+export interface PublicKeySummary {
+    /**
+     * <p>Public key ARN.</p>
+     * @public
+     */
+    arn?: string;
+    /**
+     * <p>Public key name.</p>
+     * @public
+     */
+    name?: string;
+    /**
+     * <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
+     *             (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS
+     *             Resources</a> for details, including restrictions that apply to tags and "Tag naming
+     *          limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
+     *          there.</p>
+     * @public
+     */
+    tags?: Record<string, string>;
+}
+/**
+ * @public
+ */
+export interface ListPublicKeysResponse {
+    /**
+     * <p>List of the matching public keys (summary information only).</p>
+     * @public
+     */
+    publicKeys: PublicKeySummary[] | undefined;
+    /**
+     * <p>If there are more public keys than <code>maxResults</code>, use <code>nextToken</code> in the request to get the next set.</p>
+     * @public
+     */
+    nextToken?: string;
+}
 /**
  * @public
  */
@@ -2049,8 +2230,7 @@ export interface UpdateStageRequest {
      */
     name?: string;
     /**
-     * <p>Auto-participant-recording configuration object to attach to the stage.
-     *       Auto-participant-recording configuration cannot be updated while recording is active.</p>
+     * <p>Configuration object for individual participant recording, to attach to the stage. Note that this cannot be updated while recording is active.</p>
      * @public
      */
     autoParticipantRecordingConfiguration?: AutoParticipantRecordingConfiguration;

package/dist-types/pagination/ListPublicKeysPaginator.d.ts

@@ -0,0 +1,7 @@
+import { Paginator } from "@smithy/types";
+import { ListPublicKeysCommandInput, ListPublicKeysCommandOutput } from "../commands/ListPublicKeysCommand";
+import { IVSRealTimePaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
+export declare const paginateListPublicKeys: (config: IVSRealTimePaginationConfiguration, input: ListPublicKeysCommandInput, ...rest: any[]) => Paginator<ListPublicKeysCommandOutput>;

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

@@ -3,6 +3,7 @@ export * from "./ListCompositionsPaginator";
 export * from "./ListEncoderConfigurationsPaginator";
 export * from "./ListParticipantEventsPaginator";
 export * from "./ListParticipantsPaginator";
+export * from "./ListPublicKeysPaginator";
 export * from "./ListStageSessionsPaginator";
 export * from "./ListStagesPaginator";
 export * from "./ListStorageConfigurationsPaginator";