@aws-sdk/client-chime-sdk-media-pipelines 3.295.0 → 3.297.0

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

@@ -1,9 +1,13 @@
 import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
 import { ChimeSDKMediaPipelinesServiceException as __BaseException } from "./ChimeSDKMediaPipelinesServiceException";
+/**
+ * @public
+ */
 export declare enum AudioArtifactsConcatenationState {
     Enabled = "Enabled"
 }
 /**
+ * @public
  * <p>The audio artifact concatenation configuration object.</p>
  */
 export interface AudioConcatenationConfiguration {
@@ -13,11 +17,15 @@ export interface AudioConcatenationConfiguration {
      */
     State: AudioArtifactsConcatenationState | string | undefined;
 }
+/**
+ * @public
+ */
 export declare enum ArtifactsConcatenationState {
     Disabled = "Disabled",
     Enabled = "Enabled"
 }
 /**
+ * @public
  * <p>The composited video configuration object for a specified
  *          media pipeline. <code>SourceType</code> must be
  *          <code>ChimeSdkMeeting</code>.</p>
@@ -29,6 +37,7 @@ export interface CompositedVideoConcatenationConfiguration {
     State: ArtifactsConcatenationState | string | undefined;
 }
 /**
+ * @public
  * <p>The composited content configuration object for a specified
  *          media pipeline. </p>
  */
@@ -39,6 +48,7 @@ export interface ContentConcatenationConfiguration {
     State: ArtifactsConcatenationState | string | undefined;
 }
 /**
+ * @public
  * <p>The content configuration object's data channel.</p>
  */
 export interface DataChannelConcatenationConfiguration {
@@ -48,6 +58,7 @@ export interface DataChannelConcatenationConfiguration {
     State: ArtifactsConcatenationState | string | undefined;
 }
 /**
+ * @public
  * <p>The configuration object for an event concatenation pipeline.</p>
  */
 export interface MeetingEventsConcatenationConfiguration {
@@ -57,6 +68,7 @@ export interface MeetingEventsConcatenationConfiguration {
     State: ArtifactsConcatenationState | string | undefined;
 }
 /**
+ * @public
  * <p>The configuration object for concatenating transcription messages.</p>
  */
 export interface TranscriptionMessagesConcatenationConfiguration {
@@ -66,6 +78,7 @@ export interface TranscriptionMessagesConcatenationConfiguration {
     State: ArtifactsConcatenationState | string | undefined;
 }
 /**
+ * @public
  * <p>The configuration object of a video contacatentation pipeline.</p>
  */
 export interface VideoConcatenationConfiguration {
@@ -75,6 +88,7 @@ export interface VideoConcatenationConfiguration {
     State: ArtifactsConcatenationState | string | undefined;
 }
 /**
+ * @public
  * <p>The configuration for the artifacts concatenation.</p>
  */
 export interface ArtifactsConcatenationConfiguration {
@@ -107,12 +121,16 @@ export interface ArtifactsConcatenationConfiguration {
      */
     CompositedVideo: CompositedVideoConcatenationConfiguration | undefined;
 }
+/**
+ * @public
+ */
 export declare enum AudioMuxType {
     AudioOnly = "AudioOnly",
     AudioWithActiveSpeakerVideo = "AudioWithActiveSpeakerVideo",
     AudioWithCompositedVideo = "AudioWithCompositedVideo"
 }
 /**
+ * @public
  * <p>The audio artifact configuration object.</p>
  */
 export interface AudioArtifactsConfiguration {
@@ -121,11 +139,17 @@ export interface AudioArtifactsConfiguration {
      */
     MuxType: AudioMuxType | string | undefined;
 }
+/**
+ * @public
+ */
 export declare enum ContentShareLayoutOption {
     Horizontal = "Horizontal",
     PresenterOnly = "PresenterOnly",
     Vertical = "Vertical"
 }
+/**
+ * @public
+ */
 export declare enum PresenterPosition {
     BottomLeft = "BottomLeft",
     BottomRight = "BottomRight",
@@ -133,6 +157,7 @@ export declare enum PresenterPosition {
     TopRight = "TopRight"
 }
 /**
+ * @public
  * <p>Defines the configuration for a presenter only video tile.</p>
  */
 export interface PresenterOnlyConfiguration {
@@ -142,6 +167,7 @@ export interface PresenterOnlyConfiguration {
     PresenterPosition?: PresenterPosition | string;
 }
 /**
+ * @public
  * <p>Specifies the type of grid layout.</p>
  */
 export interface GridViewConfiguration {
@@ -154,14 +180,21 @@ export interface GridViewConfiguration {
      */
     PresenterOnlyConfiguration?: PresenterOnlyConfiguration;
 }
+/**
+ * @public
+ */
 export declare enum LayoutOption {
     GridView = "GridView"
 }
+/**
+ * @public
+ */
 export declare enum ResolutionOption {
     FHD = "FHD",
     HD = "HD"
 }
 /**
+ * @public
  * <p>Describes the configuration for the composited video artifacts.</p>
  */
 export interface CompositedVideoArtifactsConfiguration {
@@ -178,14 +211,21 @@ export interface CompositedVideoArtifactsConfiguration {
      */
     GridViewConfiguration: GridViewConfiguration | undefined;
 }
+/**
+ * @public
+ */
 export declare enum ContentMuxType {
     ContentOnly = "ContentOnly"
 }
+/**
+ * @public
+ */
 export declare enum ArtifactsState {
     Disabled = "Disabled",
     Enabled = "Enabled"
 }
 /**
+ * @public
  * <p>The content artifact object.</p>
  */
 export interface ContentArtifactsConfiguration {
@@ -198,10 +238,14 @@ export interface ContentArtifactsConfiguration {
      */
     MuxType?: ContentMuxType | string;
 }
+/**
+ * @public
+ */
 export declare enum VideoMuxType {
     VideoOnly = "VideoOnly"
 }
 /**
+ * @public
  * <p>The video artifact configuration object.</p>
  */
 export interface VideoArtifactsConfiguration {
@@ -215,6 +259,7 @@ export interface VideoArtifactsConfiguration {
     MuxType?: VideoMuxType | string;
 }
 /**
+ * @public
  * <p>The configuration for the artifacts.</p>
  */
 export interface ArtifactsConfiguration {
@@ -235,10 +280,16 @@ export interface ArtifactsConfiguration {
      */
     CompositedVideo?: CompositedVideoArtifactsConfiguration;
 }
+/**
+ * @public
+ */
 export declare enum AudioChannelsOption {
     Mono = "Mono",
     Stereo = "Stereo"
 }
+/**
+ * @public
+ */
 export declare enum ErrorCode {
     BadRequest = "BadRequest",
     Forbidden = "Forbidden",
@@ -249,6 +300,7 @@ export declare enum ErrorCode {
     Throttling = "Throttling"
 }
 /**
+ * @public
  * <p>The input parameters don't match the service's restrictions.</p>
  */
 export declare class BadRequestException extends __BaseException {
@@ -266,6 +318,7 @@ export declare class BadRequestException extends __BaseException {
     constructor(opts: __ExceptionOptionType<BadRequestException, __BaseException>);
 }
 /**
+ * @public
  * <p>The video streams for a specified media pipeline. The total number of
  *          video streams can't exceed 25.</p>
  */
@@ -280,6 +333,7 @@ export interface SelectedVideoStreams {
     ExternalUserIds?: string[];
 }
 /**
+ * @public
  * <p>Source configuration for a specified media pipeline.</p>
  */
 export interface SourceConfiguration {
@@ -290,6 +344,7 @@ export interface SourceConfiguration {
     SelectedVideoStreams?: SelectedVideoStreams;
 }
 /**
+ * @public
  * <p>The configuration object of the Amazon Chime SDK meeting for a specified media pipeline. <code>SourceType</code> must be <code>ChimeSdkMeeting</code>.</p>
  */
 export interface ChimeSdkMeetingConfiguration {
@@ -302,13 +357,20 @@ export interface ChimeSdkMeetingConfiguration {
      */
     ArtifactsConfiguration?: ArtifactsConfiguration;
 }
+/**
+ * @public
+ */
 export declare enum MediaPipelineSinkType {
     S3Bucket = "S3Bucket"
 }
+/**
+ * @public
+ */
 export declare enum MediaPipelineSourceType {
     ChimeSdkMeeting = "ChimeSdkMeeting"
 }
 /**
+ * @public
  * <p>A key/value pair that grants users access to meeting resources.</p>
  */
 export interface Tag {
@@ -321,6 +383,9 @@ export interface Tag {
      */
     Value: string | undefined;
 }
+/**
+ * @public
+ */
 export interface CreateMediaCapturePipelineRequest {
     /**
      * <p>Source type from which the media artifacts are captured. A Chime SDK Meeting is the only
@@ -353,6 +418,9 @@ export interface CreateMediaCapturePipelineRequest {
      */
     Tags?: Tag[];
 }
+/**
+ * @public
+ */
 export declare enum MediaPipelineStatus {
     Failed = "Failed",
     InProgress = "InProgress",
@@ -361,6 +429,7 @@ export declare enum MediaPipelineStatus {
     Stopping = "Stopping"
 }
 /**
+ * @public
  * <p>A media pipeline object consisting of an ID, source type, source ARN, a sink
  *          type, a sink ARN, and a configuration object.</p>
  */
@@ -409,6 +478,9 @@ export interface MediaCapturePipeline {
      */
     ChimeSdkMeetingConfiguration?: ChimeSdkMeetingConfiguration;
 }
+/**
+ * @public
+ */
 export interface CreateMediaCapturePipelineResponse {
     /**
      * <p>A media pipeline object, the ID, source type, source ARN, sink type, and sink
@@ -417,6 +489,7 @@ export interface CreateMediaCapturePipelineResponse {
     MediaCapturePipeline?: MediaCapturePipeline;
 }
 /**
+ * @public
  * <p>The client is permanently forbidden from making the request.</p>
  */
 export declare class ForbiddenException extends __BaseException {
@@ -434,6 +507,7 @@ export declare class ForbiddenException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ForbiddenException, __BaseException>);
 }
 /**
+ * @public
  * <p>The request exceeds the resource limit.</p>
  */
 export declare class ResourceLimitExceededException extends __BaseException {
@@ -451,6 +525,7 @@ export declare class ResourceLimitExceededException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ResourceLimitExceededException, __BaseException>);
 }
 /**
+ * @public
  * <p>The service encountered an unexpected error.</p>
  */
 export declare class ServiceFailureException extends __BaseException {
@@ -468,6 +543,7 @@ export declare class ServiceFailureException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ServiceFailureException, __BaseException>);
 }
 /**
+ * @public
  * <p>The service is currently unavailable.</p>
  */
 export declare class ServiceUnavailableException extends __BaseException {
@@ -485,6 +561,7 @@ export declare class ServiceUnavailableException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ServiceUnavailableException, __BaseException>);
 }
 /**
+ * @public
  * <p>The client exceeded its request rate limit.</p>
  */
 export declare class ThrottledClientException extends __BaseException {
@@ -502,6 +579,7 @@ export declare class ThrottledClientException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ThrottledClientException, __BaseException>);
 }
 /**
+ * @public
  * <p>The client is not currently authorized to make the request.</p>
  */
 export declare class UnauthorizedClientException extends __BaseException {
@@ -519,6 +597,7 @@ export declare class UnauthorizedClientException extends __BaseException {
     constructor(opts: __ExceptionOptionType<UnauthorizedClientException, __BaseException>);
 }
 /**
+ * @public
  * <p>The configuration settings for the S3 bucket.</p>
  */
 export interface S3BucketSinkConfiguration {
@@ -527,10 +606,14 @@ export interface S3BucketSinkConfiguration {
      */
     Destination: string | undefined;
 }
+/**
+ * @public
+ */
 export declare enum ConcatenationSinkType {
     S3Bucket = "S3Bucket"
 }
 /**
+ * @public
  * <p>The data sink of the configuration object.</p>
  */
 export interface ConcatenationSink {
@@ -544,6 +627,7 @@ export interface ConcatenationSink {
     S3BucketSinkConfiguration: S3BucketSinkConfiguration | undefined;
 }
 /**
+ * @public
  * <p>The configuration object of the Amazon Chime SDK meeting concatenation for a specified
  *          media pipeline.</p>
  */
@@ -554,6 +638,7 @@ export interface ChimeSdkMeetingConcatenationConfiguration {
     ArtifactsConfiguration: ArtifactsConcatenationConfiguration | undefined;
 }
 /**
+ * @public
  * <p>The source configuration object of a media capture pipeline.</p>
  */
 export interface MediaCapturePipelineSourceConfiguration {
@@ -566,10 +651,14 @@ export interface MediaCapturePipelineSourceConfiguration {
      */
     ChimeSdkMeetingConfiguration: ChimeSdkMeetingConcatenationConfiguration | undefined;
 }
+/**
+ * @public
+ */
 export declare enum ConcatenationSourceType {
     MediaCapturePipeline = "MediaCapturePipeline"
 }
 /**
+ * @public
  * <p>The source type and media pipeline configuration settings in a configuration object.</p>
  */
 export interface ConcatenationSource {
@@ -582,6 +671,9 @@ export interface ConcatenationSource {
      */
     MediaCapturePipelineSourceConfiguration: MediaCapturePipelineSourceConfiguration | undefined;
 }
+/**
+ * @public
+ */
 export interface CreateMediaConcatenationPipelineRequest {
     /**
      * <p>An object that specifies the sources for the media concatenation pipeline.</p>
@@ -602,6 +694,7 @@ export interface CreateMediaConcatenationPipelineRequest {
     Tags?: Tag[];
 }
 /**
+ * @public
  * <p>Concatenates audio and video data from one or more data streams.</p>
  */
 export interface MediaConcatenationPipeline {
@@ -634,6 +727,9 @@ export interface MediaConcatenationPipeline {
      */
     UpdatedTimestamp?: Date;
 }
+/**
+ * @public
+ */
 export interface CreateMediaConcatenationPipelineResponse {
     /**
      * <p>A media concatenation pipeline object, the ID, source type, <code>MediaPipelineARN</code>, and sink of a
@@ -642,6 +738,7 @@ export interface CreateMediaConcatenationPipelineResponse {
     MediaConcatenationPipeline?: MediaConcatenationPipeline;
 }
 /**
+ * @public
  * <p>The media pipeline's RTMP configuration object.</p>
  */
 export interface LiveConnectorRTMPConfiguration {
@@ -658,10 +755,14 @@ export interface LiveConnectorRTMPConfiguration {
      */
     AudioSampleRate?: string;
 }
+/**
+ * @public
+ */
 export declare enum LiveConnectorSinkType {
     RTMP = "RTMP"
 }
 /**
+ * @public
  * <p>The media pipeline's sink configuration settings.</p>
  */
 export interface LiveConnectorSinkConfiguration {
@@ -674,11 +775,15 @@ export interface LiveConnectorSinkConfiguration {
      */
     RTMPConfiguration: LiveConnectorRTMPConfiguration | undefined;
 }
+/**
+ * @public
+ */
 export declare enum LiveConnectorMuxType {
     AudioWithActiveSpeakerVideo = "AudioWithActiveSpeakerVideo",
     AudioWithCompositedVideo = "AudioWithCompositedVideo"
 }
 /**
+ * @public
  * <p>The media pipeline's configuration object.</p>
  */
 export interface ChimeSdkMeetingLiveConnectorConfiguration {
@@ -699,10 +804,14 @@ export interface ChimeSdkMeetingLiveConnectorConfiguration {
      */
     SourceConfiguration?: SourceConfiguration;
 }
+/**
+ * @public
+ */
 export declare enum LiveConnectorSourceType {
     ChimeSdkMeeting = "ChimeSdkMeeting"
 }
 /**
+ * @public
  * <p>The data source configuration object of a streaming media pipeline.</p>
  */
 export interface LiveConnectorSourceConfiguration {
@@ -715,6 +824,9 @@ export interface LiveConnectorSourceConfiguration {
      */
     ChimeSdkMeetingLiveConnectorConfiguration: ChimeSdkMeetingLiveConnectorConfiguration | undefined;
 }
+/**
+ * @public
+ */
 export interface CreateMediaLiveConnectorPipelineRequest {
     /**
      * <p>The media pipeline's data sources.</p>
@@ -734,6 +846,7 @@ export interface CreateMediaLiveConnectorPipelineRequest {
     Tags?: Tag[];
 }
 /**
+ * @public
  * <p>The connector pipeline.</p>
  */
 export interface MediaLiveConnectorPipeline {
@@ -766,12 +879,18 @@ export interface MediaLiveConnectorPipeline {
      */
     UpdatedTimestamp?: Date;
 }
+/**
+ * @public
+ */
 export interface CreateMediaLiveConnectorPipelineResponse {
     /**
      * <p>The new media pipeline.</p>
      */
     MediaLiveConnectorPipeline?: MediaLiveConnectorPipeline;
 }
+/**
+ * @public
+ */
 export interface DeleteMediaCapturePipelineRequest {
     /**
      * <p>The ID of the media pipeline being deleted. </p>
@@ -779,6 +898,7 @@ export interface DeleteMediaCapturePipelineRequest {
     MediaPipelineId: string | undefined;
 }
 /**
+ * @public
  * <p>One or more of the resources in the request does not exist in the system.</p>
  */
 export declare class NotFoundException extends __BaseException {
@@ -795,24 +915,36 @@ export declare class NotFoundException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<NotFoundException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface DeleteMediaPipelineRequest {
     /**
      * <p>The ID of the media pipeline to delete.</p>
      */
     MediaPipelineId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface GetMediaCapturePipelineRequest {
     /**
      * <p>The ID of the pipeline that you want to get.</p>
      */
     MediaPipelineId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface GetMediaCapturePipelineResponse {
     /**
      * <p>The media pipeline object.</p>
      */
     MediaCapturePipeline?: MediaCapturePipeline;
 }
+/**
+ * @public
+ */
 export interface GetMediaPipelineRequest {
     /**
      * <p>The ID of the pipeline that you want to get.</p>
@@ -820,6 +952,7 @@ export interface GetMediaPipelineRequest {
     MediaPipelineId: string | undefined;
 }
 /**
+ * @public
  * <p>A pipeline consisting of a media capture, media concatenation, or live-streaming pipeline.</p>
  */
 export interface MediaPipeline {
@@ -836,12 +969,18 @@ export interface MediaPipeline {
      */
     MediaConcatenationPipeline?: MediaConcatenationPipeline;
 }
+/**
+ * @public
+ */
 export interface GetMediaPipelineResponse {
     /**
      * <p>The media pipeline object.</p>
      */
     MediaPipeline?: MediaPipeline;
 }
+/**
+ * @public
+ */
 export interface ListMediaCapturePipelinesRequest {
     /**
      * <p>The token used to retrieve the next page of results.</p>
@@ -853,6 +992,7 @@ export interface ListMediaCapturePipelinesRequest {
     MaxResults?: number;
 }
 /**
+ * @public
  * <p>The summary data of a media capture pipeline.</p>
  */
 export interface MediaCapturePipelineSummary {
@@ -865,6 +1005,9 @@ export interface MediaCapturePipelineSummary {
      */
     MediaPipelineArn?: string;
 }
+/**
+ * @public
+ */
 export interface ListMediaCapturePipelinesResponse {
     /**
      * <p>The media pipeline objects in the list.</p>
@@ -875,6 +1018,9 @@ export interface ListMediaCapturePipelinesResponse {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export interface ListMediaPipelinesRequest {
     /**
      * <p>The token used to retrieve the next page of results.</p>
@@ -886,6 +1032,7 @@ export interface ListMediaPipelinesRequest {
     MaxResults?: number;
 }
 /**
+ * @public
  * <p>The summary of the media pipeline.</p>
  */
 export interface MediaPipelineSummary {
@@ -898,6 +1045,9 @@ export interface MediaPipelineSummary {
      */
     MediaPipelineArn?: string;
 }
+/**
+ * @public
+ */
 export interface ListMediaPipelinesResponse {
     /**
      * <p>The media pipeline objects in the list.</p>
@@ -908,18 +1058,27 @@ export interface ListMediaPipelinesResponse {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export interface ListTagsForResourceRequest {
     /**
      * <p>The ARN of the media pipeline associated with any tags. The ARN consists of the pipeline's region, resource ID, and pipeline ID.</p>
      */
     ResourceARN: string | undefined;
 }
+/**
+ * @public
+ */
 export interface ListTagsForResourceResponse {
     /**
      * <p>The tags associated with the specified media pipeline.</p>
      */
     Tags?: Tag[];
 }
+/**
+ * @public
+ */
 export interface TagResourceRequest {
     /**
      * <p>The ARN of the media pipeline associated with any tags. The ARN consists of the pipeline's endpoint region, resource ID, and pipeline ID.</p>
@@ -930,8 +1089,14 @@ export interface TagResourceRequest {
      */
     Tags: Tag[] | undefined;
 }
+/**
+ * @public
+ */
 export interface TagResourceResponse {
 }
+/**
+ * @public
+ */
 export interface UntagResourceRequest {
     /**
      * <p>The ARN of the pipeline that you want to untag.</p>
@@ -942,6 +1107,9 @@ export interface UntagResourceRequest {
      */
     TagKeys: string[] | undefined;
 }
+/**
+ * @public
+ */
 export interface UntagResourceResponse {
 }
 /**

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

@@ -1,5 +1,8 @@
 import { PaginationConfiguration } from "@aws-sdk/types";
 import { ChimeSDKMediaPipelinesClient } from "../ChimeSDKMediaPipelinesClient";
+/**
+ * @public
+ */
 export interface ChimeSDKMediaPipelinesPaginationConfiguration extends PaginationConfiguration {
     client: ChimeSDKMediaPipelinesClient;
 }

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

@@ -1,4 +1,7 @@
 import { Paginator } from "@aws-sdk/types";
 import { ListMediaCapturePipelinesCommandInput, ListMediaCapturePipelinesCommandOutput } from "../commands/ListMediaCapturePipelinesCommand";
 import { ChimeSDKMediaPipelinesPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
 export declare function paginateListMediaCapturePipelines(config: ChimeSDKMediaPipelinesPaginationConfiguration, input: ListMediaCapturePipelinesCommandInput, ...additionalArguments: any): Paginator<ListMediaCapturePipelinesCommandOutput>;

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

@@ -1,4 +1,7 @@
 import { Paginator } from "@aws-sdk/types";
 import { ListMediaPipelinesCommandInput, ListMediaPipelinesCommandOutput } from "../commands/ListMediaPipelinesCommand";
 import { ChimeSDKMediaPipelinesPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
 export declare function paginateListMediaPipelines(config: ChimeSDKMediaPipelinesPaginationConfiguration, input: ListMediaPipelinesCommandInput, ...additionalArguments: any): Paginator<ListMediaPipelinesCommandOutput>;