@aws-sdk/client-ivs-realtime 3.450.0 → 3.453.0

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

@@ -8,30 +8,39 @@ export declare class AccessDeniedException extends __BaseException {
     opts: __ExceptionOptionType<AccessDeniedException, __BaseException>
   );
 }
-export declare const ParticipantTokenCapability: {
-  readonly PUBLISH: "PUBLISH";
-  readonly SUBSCRIBE: "SUBSCRIBE";
-};
-export type ParticipantTokenCapability =
-  (typeof ParticipantTokenCapability)[keyof typeof ParticipantTokenCapability];
-export interface CreateParticipantTokenRequest {
-  stageArn: string | undefined;
-  duration?: number;
-  userId?: string;
-  attributes?: Record<string, string>;
-  capabilities?: ParticipantTokenCapability[];
+export declare class ConflictException extends __BaseException {
+  readonly name: "ConflictException";
+  readonly $fault: "client";
+  exceptionMessage?: string;
+  constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
 }
-export interface ParticipantToken {
-  participantId?: string;
-  token?: string;
-  userId?: string;
-  attributes?: Record<string, string>;
-  duration?: number;
-  capabilities?: ParticipantTokenCapability[];
-  expirationTime?: Date;
+export interface Video {
+  width?: number;
+  height?: number;
+  framerate?: number;
+  bitrate?: number;
 }
-export interface CreateParticipantTokenResponse {
-  participantToken?: ParticipantToken;
+export interface CreateEncoderConfigurationRequest {
+  name?: string;
+  video?: Video;
+  tags?: Record<string, string>;
+}
+export interface EncoderConfiguration {
+  arn: string | undefined;
+  name?: string;
+  video?: Video;
+  tags?: Record<string, string>;
+}
+export interface CreateEncoderConfigurationResponse {
+  encoderConfiguration?: EncoderConfiguration;
+}
+export declare class InternalServerException extends __BaseException {
+  readonly name: "InternalServerException";
+  readonly $fault: "server";
+  exceptionMessage?: string;
+  constructor(
+    opts: __ExceptionOptionType<InternalServerException, __BaseException>
+  );
 }
 export declare class PendingVerification extends __BaseException {
   readonly name: "PendingVerification";
@@ -65,6 +74,31 @@ export declare class ValidationException extends __BaseException {
     opts: __ExceptionOptionType<ValidationException, __BaseException>
   );
 }
+export declare const ParticipantTokenCapability: {
+  readonly PUBLISH: "PUBLISH";
+  readonly SUBSCRIBE: "SUBSCRIBE";
+};
+export type ParticipantTokenCapability =
+  (typeof ParticipantTokenCapability)[keyof typeof ParticipantTokenCapability];
+export interface CreateParticipantTokenRequest {
+  stageArn: string | undefined;
+  duration?: number;
+  userId?: string;
+  attributes?: Record<string, string>;
+  capabilities?: ParticipantTokenCapability[];
+}
+export interface ParticipantToken {
+  participantId?: string;
+  token?: string;
+  userId?: string;
+  attributes?: Record<string, string>;
+  duration?: number;
+  capabilities?: ParticipantTokenCapability[];
+  expirationTime?: Date;
+}
+export interface CreateParticipantTokenResponse {
+  participantToken?: ParticipantToken;
+}
 export interface ParticipantTokenConfiguration {
   duration?: number;
   userId?: string;
@@ -86,22 +120,124 @@ export interface CreateStageResponse {
   stage?: Stage;
   participantTokens?: ParticipantToken[];
 }
-export declare class ConflictException extends __BaseException {
-  readonly name: "ConflictException";
-  readonly $fault: "client";
-  exceptionMessage?: string;
-  constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
+export interface S3StorageConfiguration {
+  bucketName: string | undefined;
 }
+export interface CreateStorageConfigurationRequest {
+  name?: string;
+  s3: S3StorageConfiguration | undefined;
+  tags?: Record<string, string>;
+}
+export interface StorageConfiguration {
+  arn: string | undefined;
+  name?: string;
+  s3?: S3StorageConfiguration;
+  tags?: Record<string, string>;
+}
+export interface CreateStorageConfigurationResponse {
+  storageConfiguration?: StorageConfiguration;
+}
+export interface DeleteEncoderConfigurationRequest {
+  arn: string | undefined;
+}
+export interface DeleteEncoderConfigurationResponse {}
 export interface DeleteStageRequest {
   arn: string | undefined;
 }
 export interface DeleteStageResponse {}
+export interface DeleteStorageConfigurationRequest {
+  arn: string | undefined;
+}
+export interface DeleteStorageConfigurationResponse {}
 export interface DisconnectParticipantRequest {
   stageArn: string | undefined;
   participantId: string | undefined;
   reason?: string;
 }
 export interface DisconnectParticipantResponse {}
+export interface GetCompositionRequest {
+  arn: string | undefined;
+}
+export interface ChannelDestinationConfiguration {
+  channelArn: string | undefined;
+  encoderConfigurationArn?: string;
+}
+export declare const RecordingConfigurationFormat: {
+  readonly HLS: "HLS";
+};
+export type RecordingConfigurationFormat =
+  (typeof RecordingConfigurationFormat)[keyof typeof RecordingConfigurationFormat];
+export interface RecordingConfiguration {
+  format?: RecordingConfigurationFormat;
+}
+export interface S3DestinationConfiguration {
+  storageConfigurationArn: string | undefined;
+  encoderConfigurationArns: string[] | undefined;
+  recordingConfiguration?: RecordingConfiguration;
+}
+export interface DestinationConfiguration {
+  name?: string;
+  channel?: ChannelDestinationConfiguration;
+  s3?: S3DestinationConfiguration;
+}
+export interface S3Detail {
+  recordingPrefix: string | undefined;
+}
+export interface DestinationDetail {
+  s3?: S3Detail;
+}
+export declare const DestinationState: {
+  readonly ACTIVE: "ACTIVE";
+  readonly FAILED: "FAILED";
+  readonly RECONNECTING: "RECONNECTING";
+  readonly STARTING: "STARTING";
+  readonly STOPPED: "STOPPED";
+  readonly STOPPING: "STOPPING";
+};
+export type DestinationState =
+  (typeof DestinationState)[keyof typeof DestinationState];
+export interface Destination {
+  id: string | undefined;
+  state: DestinationState | undefined;
+  startTime?: Date;
+  endTime?: Date;
+  configuration: DestinationConfiguration | undefined;
+  detail?: DestinationDetail;
+}
+export interface GridConfiguration {
+  featuredParticipantAttribute?: string;
+}
+export interface LayoutConfiguration {
+  grid?: GridConfiguration;
+}
+export declare const CompositionState: {
+  readonly ACTIVE: "ACTIVE";
+  readonly FAILED: "FAILED";
+  readonly STARTING: "STARTING";
+  readonly STOPPED: "STOPPED";
+  readonly STOPPING: "STOPPING";
+};
+export type CompositionState =
+  (typeof CompositionState)[keyof typeof CompositionState];
+export interface Composition {
+  arn: string | undefined;
+  stageArn: string | undefined;
+  state: CompositionState | undefined;
+  layout: LayoutConfiguration | undefined;
+  destinations: Destination[] | undefined;
+  tags?: Record<string, string>;
+  startTime?: Date;
+  endTime?: Date;
+}
+export interface GetCompositionResponse {
+  composition?: Composition;
+}
+export interface GetEncoderConfigurationRequest {
+  arn: string | undefined;
+}
+export interface GetEncoderConfigurationResponse {
+  encoderConfiguration?: EncoderConfiguration;
+}
 export interface GetParticipantRequest {
   stageArn: string | undefined;
   sessionId: string | undefined;
@@ -148,6 +284,50 @@ export interface StageSession {
 export interface GetStageSessionResponse {
   stageSession?: StageSession;
 }
+export interface GetStorageConfigurationRequest {
+  arn: string | undefined;
+}
+export interface GetStorageConfigurationResponse {
+  storageConfiguration?: StorageConfiguration;
+}
+export interface ListCompositionsRequest {
+  filterByStageArn?: string;
+  filterByEncoderConfigurationArn?: string;
+  nextToken?: string;
+  maxResults?: number;
+}
+export interface DestinationSummary {
+  id: string | undefined;
+  state: DestinationState | undefined;
+  startTime?: Date;
+  endTime?: Date;
+}
+export interface CompositionSummary {
+  arn: string | undefined;
+  stageArn: string | undefined;
+  destinations: DestinationSummary[] | undefined;
+  state: CompositionState | undefined;
+  tags?: Record<string, string>;
+  startTime?: Date;
+  endTime?: Date;
+}
+export interface ListCompositionsResponse {
+  compositions: CompositionSummary[] | undefined;
+  nextToken?: string;
+}
+export interface ListEncoderConfigurationsRequest {
+  nextToken?: string;
+  maxResults?: number;
+}
+export interface EncoderConfigurationSummary {
+  arn: string | undefined;
+  name?: string;
+  tags?: Record<string, string>;
+}
+export interface ListEncoderConfigurationsResponse {
+  encoderConfigurations: EncoderConfigurationSummary[] | undefined;
+  nextToken?: string;
+}
 export interface ListParticipantEventsRequest {
   stageArn: string | undefined;
   sessionId: string | undefined;
@@ -233,13 +413,19 @@ export interface ListStageSessionsResponse {
   stageSessions: StageSessionSummary[] | undefined;
   nextToken?: string;
 }
-export declare class InternalServerException extends __BaseException {
-  readonly name: "InternalServerException";
-  readonly $fault: "server";
-  exceptionMessage?: string;
-  constructor(
-    opts: __ExceptionOptionType<InternalServerException, __BaseException>
-  );
+export interface ListStorageConfigurationsRequest {
+  nextToken?: string;
+  maxResults?: number;
+}
+export interface StorageConfigurationSummary {
+  arn: string | undefined;
+  name?: string;
+  s3?: S3StorageConfiguration;
+  tags?: Record<string, string>;
+}
+export interface ListStorageConfigurationsResponse {
+  storageConfigurations: StorageConfigurationSummary[] | undefined;
+  nextToken?: string;
 }
 export interface ListTagsForResourceRequest {
   resourceArn: string | undefined;
@@ -247,6 +433,20 @@ export interface ListTagsForResourceRequest {
 export interface ListTagsForResourceResponse {
   tags: Record<string, string> | undefined;
 }
+export interface StartCompositionRequest {
+  stageArn: string | undefined;
+  idempotencyToken?: string;
+  layout?: LayoutConfiguration;
+  destinations: DestinationConfiguration[] | undefined;
+  tags?: Record<string, string>;
+}
+export interface StartCompositionResponse {
+  composition?: Composition;
+}
+export interface StopCompositionRequest {
+  arn: string | undefined;
+}
+export interface StopCompositionResponse {}
 export interface TagResourceRequest {
   resourceArn: string | undefined;
   tags: Record<string, string> | undefined;

package/dist-types/ts3.4/pagination/ListCompositionsPaginator.d.ts

@@ -0,0 +1,11 @@
+import { Paginator } from "@smithy/types";
+import {
+  ListCompositionsCommandInput,
+  ListCompositionsCommandOutput,
+} from "../commands/ListCompositionsCommand";
+import { IVSRealTimePaginationConfiguration } from "./Interfaces";
+export declare function paginateListCompositions(
+  config: IVSRealTimePaginationConfiguration,
+  input: ListCompositionsCommandInput,
+  ...additionalArguments: any
+): Paginator<ListCompositionsCommandOutput>;

package/dist-types/ts3.4/pagination/ListEncoderConfigurationsPaginator.d.ts

@@ -0,0 +1,11 @@
+import { Paginator } from "@smithy/types";
+import {
+  ListEncoderConfigurationsCommandInput,
+  ListEncoderConfigurationsCommandOutput,
+} from "../commands/ListEncoderConfigurationsCommand";
+import { IVSRealTimePaginationConfiguration } from "./Interfaces";
+export declare function paginateListEncoderConfigurations(
+  config: IVSRealTimePaginationConfiguration,
+  input: ListEncoderConfigurationsCommandInput,
+  ...additionalArguments: any
+): Paginator<ListEncoderConfigurationsCommandOutput>;

package/dist-types/ts3.4/pagination/ListStorageConfigurationsPaginator.d.ts

@@ -0,0 +1,11 @@
+import { Paginator } from "@smithy/types";
+import {
+  ListStorageConfigurationsCommandInput,
+  ListStorageConfigurationsCommandOutput,
+} from "../commands/ListStorageConfigurationsCommand";
+import { IVSRealTimePaginationConfiguration } from "./Interfaces";
+export declare function paginateListStorageConfigurations(
+  config: IVSRealTimePaginationConfiguration,
+  input: ListStorageConfigurationsCommandInput,
+  ...additionalArguments: any
+): Paginator<ListStorageConfigurationsCommandOutput>;

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

@@ -1,5 +1,8 @@
 export * from "./Interfaces";
+export * from "./ListCompositionsPaginator";
+export * from "./ListEncoderConfigurationsPaginator";
 export * from "./ListParticipantEventsPaginator";
 export * from "./ListParticipantsPaginator";
 export * from "./ListStageSessionsPaginator";
 export * from "./ListStagesPaginator";
+export * from "./ListStorageConfigurationsPaginator";

package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts

@@ -3,6 +3,10 @@ import {
   HttpResponse as __HttpResponse,
 } from "@smithy/protocol-http";
 import { SerdeContext as __SerdeContext } from "@smithy/types";
+import {
+  CreateEncoderConfigurationCommandInput,
+  CreateEncoderConfigurationCommandOutput,
+} from "../commands/CreateEncoderConfigurationCommand";
 import {
   CreateParticipantTokenCommandInput,
   CreateParticipantTokenCommandOutput,
@@ -11,14 +15,34 @@ import {
   CreateStageCommandInput,
   CreateStageCommandOutput,
 } from "../commands/CreateStageCommand";
+import {
+  CreateStorageConfigurationCommandInput,
+  CreateStorageConfigurationCommandOutput,
+} from "../commands/CreateStorageConfigurationCommand";
+import {
+  DeleteEncoderConfigurationCommandInput,
+  DeleteEncoderConfigurationCommandOutput,
+} from "../commands/DeleteEncoderConfigurationCommand";
 import {
   DeleteStageCommandInput,
   DeleteStageCommandOutput,
 } from "../commands/DeleteStageCommand";
+import {
+  DeleteStorageConfigurationCommandInput,
+  DeleteStorageConfigurationCommandOutput,
+} from "../commands/DeleteStorageConfigurationCommand";
 import {
   DisconnectParticipantCommandInput,
   DisconnectParticipantCommandOutput,
 } from "../commands/DisconnectParticipantCommand";
+import {
+  GetCompositionCommandInput,
+  GetCompositionCommandOutput,
+} from "../commands/GetCompositionCommand";
+import {
+  GetEncoderConfigurationCommandInput,
+  GetEncoderConfigurationCommandOutput,
+} from "../commands/GetEncoderConfigurationCommand";
 import {
   GetParticipantCommandInput,
   GetParticipantCommandOutput,
@@ -31,6 +55,18 @@ import {
   GetStageSessionCommandInput,
   GetStageSessionCommandOutput,
 } from "../commands/GetStageSessionCommand";
+import {
+  GetStorageConfigurationCommandInput,
+  GetStorageConfigurationCommandOutput,
+} from "../commands/GetStorageConfigurationCommand";
+import {
+  ListCompositionsCommandInput,
+  ListCompositionsCommandOutput,
+} from "../commands/ListCompositionsCommand";
+import {
+  ListEncoderConfigurationsCommandInput,
+  ListEncoderConfigurationsCommandOutput,
+} from "../commands/ListEncoderConfigurationsCommand";
 import {
   ListParticipantEventsCommandInput,
   ListParticipantEventsCommandOutput,
@@ -47,10 +83,22 @@ import {
   ListStageSessionsCommandInput,
   ListStageSessionsCommandOutput,
 } from "../commands/ListStageSessionsCommand";
+import {
+  ListStorageConfigurationsCommandInput,
+  ListStorageConfigurationsCommandOutput,
+} from "../commands/ListStorageConfigurationsCommand";
 import {
   ListTagsForResourceCommandInput,
   ListTagsForResourceCommandOutput,
 } from "../commands/ListTagsForResourceCommand";
+import {
+  StartCompositionCommandInput,
+  StartCompositionCommandOutput,
+} from "../commands/StartCompositionCommand";
+import {
+  StopCompositionCommandInput,
+  StopCompositionCommandOutput,
+} from "../commands/StopCompositionCommand";
 import {
   TagResourceCommandInput,
   TagResourceCommandOutput,
@@ -63,6 +111,10 @@ import {
   UpdateStageCommandInput,
   UpdateStageCommandOutput,
 } from "../commands/UpdateStageCommand";
+export declare const se_CreateEncoderConfigurationCommand: (
+  input: CreateEncoderConfigurationCommandInput,
+  context: __SerdeContext
+) => Promise<__HttpRequest>;
 export declare const se_CreateParticipantTokenCommand: (
   input: CreateParticipantTokenCommandInput,
   context: __SerdeContext
@@ -71,14 +123,34 @@ export declare const se_CreateStageCommand: (
   input: CreateStageCommandInput,
   context: __SerdeContext
 ) => Promise<__HttpRequest>;
+export declare const se_CreateStorageConfigurationCommand: (
+  input: CreateStorageConfigurationCommandInput,
+  context: __SerdeContext
+) => Promise<__HttpRequest>;
+export declare const se_DeleteEncoderConfigurationCommand: (
+  input: DeleteEncoderConfigurationCommandInput,
+  context: __SerdeContext
+) => Promise<__HttpRequest>;
 export declare const se_DeleteStageCommand: (
   input: DeleteStageCommandInput,
   context: __SerdeContext
 ) => Promise<__HttpRequest>;
+export declare const se_DeleteStorageConfigurationCommand: (
+  input: DeleteStorageConfigurationCommandInput,
+  context: __SerdeContext
+) => Promise<__HttpRequest>;
 export declare const se_DisconnectParticipantCommand: (
   input: DisconnectParticipantCommandInput,
   context: __SerdeContext
 ) => Promise<__HttpRequest>;
+export declare const se_GetCompositionCommand: (
+  input: GetCompositionCommandInput,
+  context: __SerdeContext
+) => Promise<__HttpRequest>;
+export declare const se_GetEncoderConfigurationCommand: (
+  input: GetEncoderConfigurationCommandInput,
+  context: __SerdeContext
+) => Promise<__HttpRequest>;
 export declare const se_GetParticipantCommand: (
   input: GetParticipantCommandInput,
   context: __SerdeContext
@@ -91,6 +163,18 @@ export declare const se_GetStageSessionCommand: (
   input: GetStageSessionCommandInput,
   context: __SerdeContext
 ) => Promise<__HttpRequest>;
+export declare const se_GetStorageConfigurationCommand: (
+  input: GetStorageConfigurationCommandInput,
+  context: __SerdeContext
+) => Promise<__HttpRequest>;
+export declare const se_ListCompositionsCommand: (
+  input: ListCompositionsCommandInput,
+  context: __SerdeContext
+) => Promise<__HttpRequest>;
+export declare const se_ListEncoderConfigurationsCommand: (
+  input: ListEncoderConfigurationsCommandInput,
+  context: __SerdeContext
+) => Promise<__HttpRequest>;
 export declare const se_ListParticipantEventsCommand: (
   input: ListParticipantEventsCommandInput,
   context: __SerdeContext
@@ -107,10 +191,22 @@ export declare const se_ListStageSessionsCommand: (
   input: ListStageSessionsCommandInput,
   context: __SerdeContext
 ) => Promise<__HttpRequest>;
+export declare const se_ListStorageConfigurationsCommand: (
+  input: ListStorageConfigurationsCommandInput,
+  context: __SerdeContext
+) => Promise<__HttpRequest>;
 export declare const se_ListTagsForResourceCommand: (
   input: ListTagsForResourceCommandInput,
   context: __SerdeContext
 ) => Promise<__HttpRequest>;
+export declare const se_StartCompositionCommand: (
+  input: StartCompositionCommandInput,
+  context: __SerdeContext
+) => Promise<__HttpRequest>;
+export declare const se_StopCompositionCommand: (
+  input: StopCompositionCommandInput,
+  context: __SerdeContext
+) => Promise<__HttpRequest>;
 export declare const se_TagResourceCommand: (
   input: TagResourceCommandInput,
   context: __SerdeContext
@@ -123,6 +219,10 @@ export declare const se_UpdateStageCommand: (
   input: UpdateStageCommandInput,
   context: __SerdeContext
 ) => Promise<__HttpRequest>;
+export declare const de_CreateEncoderConfigurationCommand: (
+  output: __HttpResponse,
+  context: __SerdeContext
+) => Promise<CreateEncoderConfigurationCommandOutput>;
 export declare const de_CreateParticipantTokenCommand: (
   output: __HttpResponse,
   context: __SerdeContext
@@ -131,14 +231,34 @@ export declare const de_CreateStageCommand: (
   output: __HttpResponse,
   context: __SerdeContext
 ) => Promise<CreateStageCommandOutput>;
+export declare const de_CreateStorageConfigurationCommand: (
+  output: __HttpResponse,
+  context: __SerdeContext
+) => Promise<CreateStorageConfigurationCommandOutput>;
+export declare const de_DeleteEncoderConfigurationCommand: (
+  output: __HttpResponse,
+  context: __SerdeContext
+) => Promise<DeleteEncoderConfigurationCommandOutput>;
 export declare const de_DeleteStageCommand: (
   output: __HttpResponse,
   context: __SerdeContext
 ) => Promise<DeleteStageCommandOutput>;
+export declare const de_DeleteStorageConfigurationCommand: (
+  output: __HttpResponse,
+  context: __SerdeContext
+) => Promise<DeleteStorageConfigurationCommandOutput>;
 export declare const de_DisconnectParticipantCommand: (
   output: __HttpResponse,
   context: __SerdeContext
 ) => Promise<DisconnectParticipantCommandOutput>;
+export declare const de_GetCompositionCommand: (
+  output: __HttpResponse,
+  context: __SerdeContext
+) => Promise<GetCompositionCommandOutput>;
+export declare const de_GetEncoderConfigurationCommand: (
+  output: __HttpResponse,
+  context: __SerdeContext
+) => Promise<GetEncoderConfigurationCommandOutput>;
 export declare const de_GetParticipantCommand: (
   output: __HttpResponse,
   context: __SerdeContext
@@ -151,6 +271,18 @@ export declare const de_GetStageSessionCommand: (
   output: __HttpResponse,
   context: __SerdeContext
 ) => Promise<GetStageSessionCommandOutput>;
+export declare const de_GetStorageConfigurationCommand: (
+  output: __HttpResponse,
+  context: __SerdeContext
+) => Promise<GetStorageConfigurationCommandOutput>;
+export declare const de_ListCompositionsCommand: (
+  output: __HttpResponse,
+  context: __SerdeContext
+) => Promise<ListCompositionsCommandOutput>;
+export declare const de_ListEncoderConfigurationsCommand: (
+  output: __HttpResponse,
+  context: __SerdeContext
+) => Promise<ListEncoderConfigurationsCommandOutput>;
 export declare const de_ListParticipantEventsCommand: (
   output: __HttpResponse,
   context: __SerdeContext
@@ -167,10 +299,22 @@ export declare const de_ListStageSessionsCommand: (
   output: __HttpResponse,
   context: __SerdeContext
 ) => Promise<ListStageSessionsCommandOutput>;
+export declare const de_ListStorageConfigurationsCommand: (
+  output: __HttpResponse,
+  context: __SerdeContext
+) => Promise<ListStorageConfigurationsCommandOutput>;
 export declare const de_ListTagsForResourceCommand: (
   output: __HttpResponse,
   context: __SerdeContext
 ) => Promise<ListTagsForResourceCommandOutput>;
+export declare const de_StartCompositionCommand: (
+  output: __HttpResponse,
+  context: __SerdeContext
+) => Promise<StartCompositionCommandOutput>;
+export declare const de_StopCompositionCommand: (
+  output: __HttpResponse,
+  context: __SerdeContext
+) => Promise<StopCompositionCommandOutput>;
 export declare const de_TagResourceCommand: (
   output: __HttpResponse,
   context: __SerdeContext