feat(client-ivs-realtime): IVS Real-Time now offers customers the abi…

…lity to record individual stage participants to S3.
aws · Jun 20, 2024 · b3374d1 · b3374d1
1 parent 52a0e8f
commit b3374d1
Show file tree

Hide file tree

Showing 8 changed files with 371 additions and 14 deletions.
diff --git a/clients/client-ivs-realtime/src/commands/CreateStageCommand.ts b/clients/client-ivs-realtime/src/commands/CreateStageCommand.ts
@@ -52,6 +52,12 @@ export interface CreateStageCommandOutput extends CreateStageResponse, __Metadat
  *   tags: { // Tags
  *     "<keys>": "STRING_VALUE",
  *   },
+ *   autoParticipantRecordingConfiguration: { // AutoParticipantRecordingConfiguration
+ *     storageConfigurationArn: "STRING_VALUE", // required
+ *     mediaTypes: [ // ParticipantRecordingMediaTypeList
+ *       "STRING_VALUE",
+ *     ],
+ *   },
  * };
  * const command = new CreateStageCommand(input);
  * const response = await client.send(command);
@@ -63,6 +69,12 @@ export interface CreateStageCommandOutput extends CreateStageResponse, __Metadat
  * //     tags: { // Tags
  * //       "<keys>": "STRING_VALUE",
  * //     },
+ * //     autoParticipantRecordingConfiguration: { // AutoParticipantRecordingConfiguration
+ * //       storageConfigurationArn: "STRING_VALUE", // required
+ * //       mediaTypes: [ // ParticipantRecordingMediaTypeList
+ * //         "STRING_VALUE",
+ * //       ],
+ * //     },
  * //   },
  * //   participantTokens: [ // ParticipantTokenList
  * //     { // ParticipantToken

diff --git a/clients/client-ivs-realtime/src/commands/GetParticipantCommand.ts b/clients/client-ivs-realtime/src/commands/GetParticipantCommand.ts
@@ -58,6 +58,9 @@ export interface GetParticipantCommandOutput extends GetParticipantResponse, __M
  * //     browserName: "STRING_VALUE",
  * //     browserVersion: "STRING_VALUE",
  * //     sdkVersion: "STRING_VALUE",
+ * //     recordingS3BucketName: "STRING_VALUE",
+ * //     recordingS3Prefix: "STRING_VALUE",
+ * //     recordingState: "STRING_VALUE",
  * //   },
  * // };
  *

diff --git a/clients/client-ivs-realtime/src/commands/GetStageCommand.ts b/clients/client-ivs-realtime/src/commands/GetStageCommand.ts
@@ -48,6 +48,12 @@ export interface GetStageCommandOutput extends GetStageResponse, __MetadataBeare
  * //     tags: { // Tags
  * //       "<keys>": "STRING_VALUE",
  * //     },
+ * //     autoParticipantRecordingConfiguration: { // AutoParticipantRecordingConfiguration
+ * //       storageConfigurationArn: "STRING_VALUE", // required
+ * //       mediaTypes: [ // ParticipantRecordingMediaTypeList
+ * //         "STRING_VALUE",
+ * //       ],
+ * //     },
  * //   },
  * // };
  *

diff --git a/clients/client-ivs-realtime/src/commands/ListParticipantsCommand.ts b/clients/client-ivs-realtime/src/commands/ListParticipantsCommand.ts
@@ -43,6 +43,7 @@ export interface ListParticipantsCommandOutput extends ListParticipantsResponse,
  *   filterByState: "STRING_VALUE",
  *   nextToken: "STRING_VALUE",
  *   maxResults: Number("int"),
+ *   filterByRecordingState: "STRING_VALUE",
  * };
  * const command = new ListParticipantsCommand(input);
  * const response = await client.send(command);
@@ -54,6 +55,7 @@ export interface ListParticipantsCommandOutput extends ListParticipantsResponse,
  * //       state: "STRING_VALUE",
  * //       firstJoinTime: new Date("TIMESTAMP"),
  * //       published: true || false,
+ * //       recordingState: "STRING_VALUE",
  * //     },
  * //   ],
  * //   nextToken: "STRING_VALUE",

diff --git a/clients/client-ivs-realtime/src/commands/UpdateStageCommand.ts b/clients/client-ivs-realtime/src/commands/UpdateStageCommand.ts
@@ -38,6 +38,12 @@ export interface UpdateStageCommandOutput extends UpdateStageResponse, __Metadat
  * 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);
@@ -49,6 +55,12 @@ export interface UpdateStageCommandOutput extends UpdateStageResponse, __Metadat
  * //     tags: { // Tags
  * //       "<keys>": "STRING_VALUE",
  * //     },
+ * //     autoParticipantRecordingConfiguration: { // AutoParticipantRecordingConfiguration
+ * //       storageConfigurationArn: "STRING_VALUE", // required
+ * //       mediaTypes: [ // ParticipantRecordingMediaTypeList
+ * //         "STRING_VALUE",
+ * //       ],
+ * //     },
  * //   },
  * // };
  *

diff --git a/clients/client-ivs-realtime/src/models/models_0.ts b/clients/client-ivs-realtime/src/models/models_0.ts
@@ -420,6 +420,39 @@ export interface CreateParticipantTokenResponse {
   participantToken?: ParticipantToken;
 }
 
+/**
+ * @public
+ * @enum
+ */
+export const ParticipantRecordingMediaType = {
+  AUDIO_ONLY: "AUDIO_ONLY",
+  AUDIO_VIDEO: "AUDIO_VIDEO",
+} as const;
+
+/**
+ * @public
+ */
+export type ParticipantRecordingMediaType =
+  (typeof ParticipantRecordingMediaType)[keyof typeof ParticipantRecordingMediaType];
+
+/**
+ * <p>Object specifying an auto-participant-recording configuration.</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>
+   * @public
+   */
+  storageConfigurationArn: string | undefined;
+
+  /**
+   * <p>Types of media to be recorded. Default: <code>AUDIO_VIDEO</code>.</p>
+   * @public
+   */
+  mediaTypes?: ParticipantRecordingMediaType[];
+}
+
 /**
  * <p>Object specifying a participant token configuration in a stage.</p>
  * @public
@@ -485,6 +518,12 @@ export interface CreateStageRequest {
    * @public
    */
   tags?: Record<string, string>;
+
+  /**
+   * <p>Auto participant recording configuration object attached to the stage.</p>
+   * @public
+   */
+  autoParticipantRecordingConfiguration?: AutoParticipantRecordingConfiguration;
 }
 
 /**
@@ -519,6 +558,12 @@ export interface Stage {
    * @public
    */
   tags?: Record<string, string>;
+
+  /**
+   * <p>Auto-participant-recording configuration object attached to the stage.</p>
+   * @public
+   */
+  autoParticipantRecordingConfiguration?: AutoParticipantRecordingConfiguration;
 }
 
 /**
@@ -1230,6 +1275,24 @@ export interface GetParticipantRequest {
   participantId: string | undefined;
 }
 
+/**
+ * @public
+ * @enum
+ */
+export const ParticipantRecordingState = {
+  ACTIVE: "ACTIVE",
+  DISABLED: "DISABLED",
+  FAILED: "FAILED",
+  STARTING: "STARTING",
+  STOPPED: "STOPPED",
+  STOPPING: "STOPPING",
+} as const;
+
+/**
+ * @public
+ */
+export type ParticipantRecordingState = (typeof ParticipantRecordingState)[keyof typeof ParticipantRecordingState];
+
 /**
  * @public
  * @enum
@@ -1327,6 +1390,24 @@ export interface Participant {
    * @public
    */
   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>
+   * @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>
+   * @public
+   */
+  recordingS3Prefix?: string;
+
+  /**
+   * <p>Participant’s recording state.</p>
+   * @public
+   */
+  recordingState?: ParticipantRecordingState;
 }
 
 /**
@@ -1775,6 +1856,24 @@ export interface ListParticipantEventsResponse {
   nextToken?: string;
 }
 
+/**
+ * @public
+ * @enum
+ */
+export const ParticipantRecordingFilterByRecordingState = {
+  ACTIVE: "ACTIVE",
+  FAILED: "FAILED",
+  STARTING: "STARTING",
+  STOPPED: "STOPPED",
+  STOPPING: "STOPPING",
+} as const;
+
+/**
+ * @public
+ */
+export type ParticipantRecordingFilterByRecordingState =
+  (typeof ParticipantRecordingFilterByRecordingState)[keyof typeof ParticipantRecordingFilterByRecordingState];
+
 /**
  * @public
  */
@@ -1792,27 +1891,28 @@ export interface ListParticipantsRequest {
   sessionId: string | undefined;
 
   /**
-   * <p>Filters the response list to match the specified user ID. Only one of
-   *             <code>filterByUserId</code>, <code>filterByPublished</code>, or
-   *             <code>filterByState</code> can be provided per request. A <code>userId</code> is a
-   *          customer-assigned name to help identify the token; this can be used to link a participant
-   *          to a user in the customer’s own systems.</p>
+   * <p>Filters the response list to match the specified user ID.
+   *             Only one of <code>filterByUserId</code>, <code>filterByPublished</code>,
+   *             <code>filterByState</code>, or <code>filterByRecordingState</code> can be provided per request.
+   * 	    A <code>userId</code> is a
+   *             customer-assigned name to help identify the token; this can be used to link a participant
+   *             to a user in the customer’s own systems.</p>
    * @public
    */
   filterByUserId?: string;
 
   /**
-   * <p>Filters the response list to only show participants who published during the stage
-   *          session. Only one of <code>filterByUserId</code>, <code>filterByPublished</code>, or
-   *             <code>filterByState</code> can be provided per request.</p>
+   * <p>Filters the response list to only show participants who published during the stage session.
+   *             Only one of <code>filterByUserId</code>, <code>filterByPublished</code>,
+   *             <code>filterByState</code>, or <code>filterByRecordingState</code> can be provided per request.</p>
    * @public
    */
   filterByPublished?: boolean;
 
   /**
-   * <p>Filters the response list to only show participants in the specified state. Only one of
-   *             <code>filterByUserId</code>, <code>filterByPublished</code>, or
-   *             <code>filterByState</code> can be provided per request.</p>
+   * <p>Filters the response list to only show participants in the specified state.
+   *             Only one of <code>filterByUserId</code>, <code>filterByPublished</code>,
+   *             <code>filterByState</code>, or <code>filterByRecordingState</code> can be provided per request.</p>
    * @public
    */
   filterByState?: ParticipantState;
@@ -1829,6 +1929,14 @@ export interface ListParticipantsRequest {
    * @public
    */
   maxResults?: number;
+
+  /**
+   * <p>Filters the response list to only show participants with the specified recording state.
+   *             Only one of <code>filterByUserId</code>, <code>filterByPublished</code>,
+   *             <code>filterByState</code>, or <code>filterByRecordingState</code> can be provided per request.</p>
+   * @public
+   */
+  filterByRecordingState?: ParticipantRecordingFilterByRecordingState;
 }
 
 /**
@@ -1869,6 +1977,12 @@ export interface ParticipantSummary {
    * @public
    */
   published?: boolean;
+
+  /**
+   * <p>Participant’s recording state.</p>
+   * @public
+   */
+  recordingState?: ParticipantRecordingState;
 }
 
 /**
@@ -2253,6 +2367,13 @@ export interface UpdateStageRequest {
    * @public
    */
   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>
+   * @public
+   */
+  autoParticipantRecordingConfiguration?: AutoParticipantRecordingConfiguration;
 }
 
 /**