import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { CreateMediaCapturePipelineRequest, CreateMediaCapturePipelineResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link CreateMediaCapturePipelineCommand}. */ export interface CreateMediaCapturePipelineCommandInput extends CreateMediaCapturePipelineRequest { } /** * @public * * The output of {@link CreateMediaCapturePipelineCommand}. */ export interface CreateMediaCapturePipelineCommandOutput extends CreateMediaCapturePipelineResponse, __MetadataBearer { } declare const CreateMediaCapturePipelineCommand_base: { new (input: CreateMediaCapturePipelineCommandInput): import("@smithy/core/client").CommandImpl; new (input: CreateMediaCapturePipelineCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** *

Creates a media pipeline.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { ChimeSDKMediaPipelinesClient, CreateMediaCapturePipelineCommand } from "@aws-sdk/client-chime-sdk-media-pipelines"; // ES Modules import * // const { ChimeSDKMediaPipelinesClient, CreateMediaCapturePipelineCommand } = require("@aws-sdk/client-chime-sdk-media-pipelines"); // CommonJS import * // import type { ChimeSDKMediaPipelinesClientConfig } from "@aws-sdk/client-chime-sdk-media-pipelines"; * const config = {}; // type is ChimeSDKMediaPipelinesClientConfig * const client = new ChimeSDKMediaPipelinesClient(config); * const input = { // CreateMediaCapturePipelineRequest * SourceType: "ChimeSdkMeeting", // required * SourceArn: "STRING_VALUE", // required * SinkType: "S3Bucket", // required * SinkArn: "STRING_VALUE", // required * ClientRequestToken: "STRING_VALUE", * ChimeSdkMeetingConfiguration: { // ChimeSdkMeetingConfiguration * SourceConfiguration: { // SourceConfiguration * SelectedVideoStreams: { // SelectedVideoStreams * AttendeeIds: [ // AttendeeIdList * "STRING_VALUE", * ], * ExternalUserIds: [ // ExternalUserIdList * "STRING_VALUE", * ], * }, * }, * ArtifactsConfiguration: { // ArtifactsConfiguration * Audio: { // AudioArtifactsConfiguration * MuxType: "AudioOnly" || "AudioWithActiveSpeakerVideo" || "AudioWithCompositedVideo", // required * }, * Video: { // VideoArtifactsConfiguration * State: "Enabled" || "Disabled", // required * MuxType: "VideoOnly", * }, * Content: { // ContentArtifactsConfiguration * State: "Enabled" || "Disabled", // required * MuxType: "ContentOnly", * }, * CompositedVideo: { // CompositedVideoArtifactsConfiguration * Layout: "GridView", * Resolution: "HD" || "FHD", * GridViewConfiguration: { // GridViewConfiguration * ContentShareLayout: "PresenterOnly" || "Horizontal" || "Vertical" || "ActiveSpeakerOnly", // required * PresenterOnlyConfiguration: { // PresenterOnlyConfiguration * PresenterPosition: "TopLeft" || "TopRight" || "BottomLeft" || "BottomRight", * }, * ActiveSpeakerOnlyConfiguration: { // ActiveSpeakerOnlyConfiguration * ActiveSpeakerPosition: "TopLeft" || "TopRight" || "BottomLeft" || "BottomRight", * }, * HorizontalLayoutConfiguration: { // HorizontalLayoutConfiguration * TileOrder: "JoinSequence" || "SpeakerSequence", * TilePosition: "Top" || "Bottom", * TileCount: Number("int"), * TileAspectRatio: "STRING_VALUE", * }, * VerticalLayoutConfiguration: { // VerticalLayoutConfiguration * TileOrder: "JoinSequence" || "SpeakerSequence", * TilePosition: "Left" || "Right", * TileCount: Number("int"), * TileAspectRatio: "STRING_VALUE", * }, * VideoAttribute: { // VideoAttribute * CornerRadius: Number("int"), * BorderColor: "Black" || "Blue" || "Red" || "Green" || "White" || "Yellow", * HighlightColor: "Black" || "Blue" || "Red" || "Green" || "White" || "Yellow", * BorderThickness: Number("int"), * }, * CanvasOrientation: "Landscape" || "Portrait", * }, * }, * }, * }, * SseAwsKeyManagementParams: { // SseAwsKeyManagementParams * AwsKmsKeyId: "STRING_VALUE", // required * AwsKmsEncryptionContext: "STRING_VALUE", * }, * SinkIamRoleArn: "STRING_VALUE", * Tags: [ // TagList * { // Tag * Key: "STRING_VALUE", // required * Value: "STRING_VALUE", // required * }, * ], * }; * const command = new CreateMediaCapturePipelineCommand(input); * const response = await client.send(command); * // { // CreateMediaCapturePipelineResponse * // MediaCapturePipeline: { // MediaCapturePipeline * // MediaPipelineId: "STRING_VALUE", * // MediaPipelineArn: "STRING_VALUE", * // SourceType: "ChimeSdkMeeting", * // SourceArn: "STRING_VALUE", * // Status: "Initializing" || "InProgress" || "Failed" || "Stopping" || "Stopped" || "Paused" || "NotStarted", * // SinkType: "S3Bucket", * // SinkArn: "STRING_VALUE", * // CreatedTimestamp: new Date("TIMESTAMP"), * // UpdatedTimestamp: new Date("TIMESTAMP"), * // ChimeSdkMeetingConfiguration: { // ChimeSdkMeetingConfiguration * // SourceConfiguration: { // SourceConfiguration * // SelectedVideoStreams: { // SelectedVideoStreams * // AttendeeIds: [ // AttendeeIdList * // "STRING_VALUE", * // ], * // ExternalUserIds: [ // ExternalUserIdList * // "STRING_VALUE", * // ], * // }, * // }, * // ArtifactsConfiguration: { // ArtifactsConfiguration * // Audio: { // AudioArtifactsConfiguration * // MuxType: "AudioOnly" || "AudioWithActiveSpeakerVideo" || "AudioWithCompositedVideo", // required * // }, * // Video: { // VideoArtifactsConfiguration * // State: "Enabled" || "Disabled", // required * // MuxType: "VideoOnly", * // }, * // Content: { // ContentArtifactsConfiguration * // State: "Enabled" || "Disabled", // required * // MuxType: "ContentOnly", * // }, * // CompositedVideo: { // CompositedVideoArtifactsConfiguration * // Layout: "GridView", * // Resolution: "HD" || "FHD", * // GridViewConfiguration: { // GridViewConfiguration * // ContentShareLayout: "PresenterOnly" || "Horizontal" || "Vertical" || "ActiveSpeakerOnly", // required * // PresenterOnlyConfiguration: { // PresenterOnlyConfiguration * // PresenterPosition: "TopLeft" || "TopRight" || "BottomLeft" || "BottomRight", * // }, * // ActiveSpeakerOnlyConfiguration: { // ActiveSpeakerOnlyConfiguration * // ActiveSpeakerPosition: "TopLeft" || "TopRight" || "BottomLeft" || "BottomRight", * // }, * // HorizontalLayoutConfiguration: { // HorizontalLayoutConfiguration * // TileOrder: "JoinSequence" || "SpeakerSequence", * // TilePosition: "Top" || "Bottom", * // TileCount: Number("int"), * // TileAspectRatio: "STRING_VALUE", * // }, * // VerticalLayoutConfiguration: { // VerticalLayoutConfiguration * // TileOrder: "JoinSequence" || "SpeakerSequence", * // TilePosition: "Left" || "Right", * // TileCount: Number("int"), * // TileAspectRatio: "STRING_VALUE", * // }, * // VideoAttribute: { // VideoAttribute * // CornerRadius: Number("int"), * // BorderColor: "Black" || "Blue" || "Red" || "Green" || "White" || "Yellow", * // HighlightColor: "Black" || "Blue" || "Red" || "Green" || "White" || "Yellow", * // BorderThickness: Number("int"), * // }, * // CanvasOrientation: "Landscape" || "Portrait", * // }, * // }, * // }, * // }, * // SseAwsKeyManagementParams: { // SseAwsKeyManagementParams * // AwsKmsKeyId: "STRING_VALUE", // required * // AwsKmsEncryptionContext: "STRING_VALUE", * // }, * // SinkIamRoleArn: "STRING_VALUE", * // }, * // }; * * ``` * * @param CreateMediaCapturePipelineCommandInput - {@link CreateMediaCapturePipelineCommandInput} * @returns {@link CreateMediaCapturePipelineCommandOutput} * @see {@link CreateMediaCapturePipelineCommandInput} for command's `input` shape. * @see {@link CreateMediaCapturePipelineCommandOutput} for command's `response` shape. * @see {@link ChimeSDKMediaPipelinesClientResolvedConfig | config} for ChimeSDKMediaPipelinesClient's `config` shape. * * @throws {@link BadRequestException} (client fault) *

The input parameters don't match the service's restrictions.

* * @throws {@link ForbiddenException} (client fault) *

The client is permanently forbidden from making the request.

* * @throws {@link ResourceLimitExceededException} (client fault) *

The request exceeds the resource limit.

* * @throws {@link ServiceFailureException} (server fault) *

The service encountered an unexpected error.

* * @throws {@link ServiceUnavailableException} (server fault) *

The service is currently unavailable.

* * @throws {@link ThrottledClientException} (client fault) *

The client exceeded its request rate limit.

* * @throws {@link UnauthorizedClientException} (client fault) *

The client is not currently authorized to make the request.

* * @throws {@link ChimeSDKMediaPipelinesServiceException} *

Base exception class for all service exceptions from ChimeSDKMediaPipelines service.

* * * @public */ export declare class CreateMediaCapturePipelineCommand extends CreateMediaCapturePipelineCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: CreateMediaCapturePipelineRequest; output: CreateMediaCapturePipelineResponse; }; sdk: { input: CreateMediaCapturePipelineCommandInput; output: CreateMediaCapturePipelineCommandOutput; }; }; }