import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { GetMediaPipelineRequest, GetMediaPipelineResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link GetMediaPipelineCommand}. */ export interface GetMediaPipelineCommandInput extends GetMediaPipelineRequest { } /** * @public * * The output of {@link GetMediaPipelineCommand}. */ export interface GetMediaPipelineCommandOutput extends GetMediaPipelineResponse, __MetadataBearer { } declare const GetMediaPipelineCommand_base: { new (input: GetMediaPipelineCommandInput): import("@smithy/core/client").CommandImpl; new (input: GetMediaPipelineCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** *

Gets an existing media pipeline.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { ChimeSDKMediaPipelinesClient, GetMediaPipelineCommand } from "@aws-sdk/client-chime-sdk-media-pipelines"; // ES Modules import * // const { ChimeSDKMediaPipelinesClient, GetMediaPipelineCommand } = 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 = { // GetMediaPipelineRequest * MediaPipelineId: "STRING_VALUE", // required * }; * const command = new GetMediaPipelineCommand(input); * const response = await client.send(command); * // { // GetMediaPipelineResponse * // MediaPipeline: { // MediaPipeline * // 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", * // }, * // MediaLiveConnectorPipeline: { // MediaLiveConnectorPipeline * // Sources: [ // LiveConnectorSourceList * // { // LiveConnectorSourceConfiguration * // SourceType: "ChimeSdkMeeting", // required * // ChimeSdkMeetingLiveConnectorConfiguration: { // ChimeSdkMeetingLiveConnectorConfiguration * // Arn: "STRING_VALUE", // required * // MuxType: "AudioWithCompositedVideo" || "AudioWithActiveSpeakerVideo", // required * // CompositedVideo: { * // Layout: "GridView", * // Resolution: "HD" || "FHD", * // GridViewConfiguration: { * // ContentShareLayout: "PresenterOnly" || "Horizontal" || "Vertical" || "ActiveSpeakerOnly", // required * // PresenterOnlyConfiguration: { * // PresenterPosition: "TopLeft" || "TopRight" || "BottomLeft" || "BottomRight", * // }, * // ActiveSpeakerOnlyConfiguration: { * // ActiveSpeakerPosition: "TopLeft" || "TopRight" || "BottomLeft" || "BottomRight", * // }, * // HorizontalLayoutConfiguration: { * // TileOrder: "JoinSequence" || "SpeakerSequence", * // TilePosition: "Top" || "Bottom", * // TileCount: Number("int"), * // TileAspectRatio: "STRING_VALUE", * // }, * // VerticalLayoutConfiguration: { * // TileOrder: "JoinSequence" || "SpeakerSequence", * // TilePosition: "Left" || "Right", * // TileCount: Number("int"), * // TileAspectRatio: "STRING_VALUE", * // }, * // VideoAttribute: { * // CornerRadius: Number("int"), * // BorderColor: "Black" || "Blue" || "Red" || "Green" || "White" || "Yellow", * // HighlightColor: "Black" || "Blue" || "Red" || "Green" || "White" || "Yellow", * // BorderThickness: Number("int"), * // }, * // CanvasOrientation: "Landscape" || "Portrait", * // }, * // }, * // SourceConfiguration: { * // SelectedVideoStreams: { * // AttendeeIds: [ * // "STRING_VALUE", * // ], * // ExternalUserIds: [ * // "STRING_VALUE", * // ], * // }, * // }, * // }, * // }, * // ], * // Sinks: [ // LiveConnectorSinkList * // { // LiveConnectorSinkConfiguration * // SinkType: "RTMP", // required * // RTMPConfiguration: { // LiveConnectorRTMPConfiguration * // Url: "STRING_VALUE", // required * // AudioChannels: "Stereo" || "Mono", * // AudioSampleRate: "STRING_VALUE", * // }, * // }, * // ], * // MediaPipelineId: "STRING_VALUE", * // MediaPipelineArn: "STRING_VALUE", * // Status: "Initializing" || "InProgress" || "Failed" || "Stopping" || "Stopped" || "Paused" || "NotStarted", * // CreatedTimestamp: new Date("TIMESTAMP"), * // UpdatedTimestamp: new Date("TIMESTAMP"), * // }, * // MediaConcatenationPipeline: { // MediaConcatenationPipeline * // MediaPipelineId: "STRING_VALUE", * // MediaPipelineArn: "STRING_VALUE", * // Sources: [ // ConcatenationSourceList * // { // ConcatenationSource * // Type: "MediaCapturePipeline", // required * // MediaCapturePipelineSourceConfiguration: { // MediaCapturePipelineSourceConfiguration * // MediaPipelineArn: "STRING_VALUE", // required * // ChimeSdkMeetingConfiguration: { // ChimeSdkMeetingConcatenationConfiguration * // ArtifactsConfiguration: { // ArtifactsConcatenationConfiguration * // Audio: { // AudioConcatenationConfiguration * // State: "Enabled", // required * // }, * // Video: { // VideoConcatenationConfiguration * // State: "Enabled" || "Disabled", // required * // }, * // Content: { // ContentConcatenationConfiguration * // State: "Enabled" || "Disabled", // required * // }, * // DataChannel: { // DataChannelConcatenationConfiguration * // State: "Enabled" || "Disabled", // required * // }, * // TranscriptionMessages: { // TranscriptionMessagesConcatenationConfiguration * // State: "Enabled" || "Disabled", // required * // }, * // MeetingEvents: { // MeetingEventsConcatenationConfiguration * // State: "Enabled" || "Disabled", // required * // }, * // CompositedVideo: { // CompositedVideoConcatenationConfiguration * // State: "Enabled" || "Disabled", // required * // }, * // }, * // }, * // }, * // }, * // ], * // Sinks: [ // ConcatenationSinkList * // { // ConcatenationSink * // Type: "S3Bucket", // required * // S3BucketSinkConfiguration: { // S3BucketSinkConfiguration * // Destination: "STRING_VALUE", // required * // }, * // }, * // ], * // Status: "Initializing" || "InProgress" || "Failed" || "Stopping" || "Stopped" || "Paused" || "NotStarted", * // CreatedTimestamp: new Date("TIMESTAMP"), * // UpdatedTimestamp: new Date("TIMESTAMP"), * // }, * // MediaInsightsPipeline: { // MediaInsightsPipeline * // MediaPipelineId: "STRING_VALUE", * // MediaPipelineArn: "STRING_VALUE", * // MediaInsightsPipelineConfigurationArn: "STRING_VALUE", * // Status: "Initializing" || "InProgress" || "Failed" || "Stopping" || "Stopped" || "Paused" || "NotStarted", * // KinesisVideoStreamSourceRuntimeConfiguration: { // KinesisVideoStreamSourceRuntimeConfiguration * // Streams: [ // Streams // required * // { // StreamConfiguration * // StreamArn: "STRING_VALUE", // required * // FragmentNumber: "STRING_VALUE", * // StreamChannelDefinition: { // StreamChannelDefinition * // NumberOfChannels: Number("int"), // required * // ChannelDefinitions: [ // ChannelDefinitions * // { // ChannelDefinition * // ChannelId: Number("int"), // required * // ParticipantRole: "AGENT" || "CUSTOMER", * // }, * // ], * // }, * // }, * // ], * // MediaEncoding: "pcm", // required * // MediaSampleRate: Number("int"), // required * // }, * // MediaInsightsRuntimeMetadata: { // MediaInsightsRuntimeMetadata * // "": "STRING_VALUE", * // }, * // KinesisVideoStreamRecordingSourceRuntimeConfiguration: { // KinesisVideoStreamRecordingSourceRuntimeConfiguration * // Streams: [ // RecordingStreamList // required * // { // RecordingStreamConfiguration * // StreamArn: "STRING_VALUE", * // }, * // ], * // FragmentSelector: { // FragmentSelector * // FragmentSelectorType: "ProducerTimestamp" || "ServerTimestamp", // required * // TimestampRange: { // TimestampRange * // StartTimestamp: new Date("TIMESTAMP"), // required * // EndTimestamp: new Date("TIMESTAMP"), // required * // }, * // }, * // }, * // S3RecordingSinkRuntimeConfiguration: { // S3RecordingSinkRuntimeConfiguration * // Destination: "STRING_VALUE", // required * // RecordingFileFormat: "Wav" || "Opus", // required * // }, * // CreatedTimestamp: new Date("TIMESTAMP"), * // ElementStatuses: [ // MediaInsightsPipelineElementStatuses * // { // MediaInsightsPipelineElementStatus * // Type: "AmazonTranscribeCallAnalyticsProcessor" || "VoiceAnalyticsProcessor" || "AmazonTranscribeProcessor" || "KinesisDataStreamSink" || "LambdaFunctionSink" || "SqsQueueSink" || "SnsTopicSink" || "S3RecordingSink" || "VoiceEnhancementSink", * // Status: "NotStarted" || "NotSupported" || "Initializing" || "InProgress" || "Failed" || "Stopping" || "Stopped" || "Paused", * // }, * // ], * // }, * // MediaStreamPipeline: { // MediaStreamPipeline * // MediaPipelineId: "STRING_VALUE", * // MediaPipelineArn: "STRING_VALUE", * // CreatedTimestamp: new Date("TIMESTAMP"), * // UpdatedTimestamp: new Date("TIMESTAMP"), * // Status: "Initializing" || "InProgress" || "Failed" || "Stopping" || "Stopped" || "Paused" || "NotStarted", * // Sources: [ // MediaStreamSourceList * // { // MediaStreamSource * // SourceType: "ChimeSdkMeeting", // required * // SourceArn: "STRING_VALUE", // required * // }, * // ], * // Sinks: [ // MediaStreamSinkList * // { // MediaStreamSink * // SinkArn: "STRING_VALUE", // required * // SinkType: "KinesisVideoStreamPool", // required * // ReservedStreamCapacity: Number("int"), // required * // MediaStreamType: "MixedAudio" || "IndividualAudio", // required * // }, * // ], * // }, * // }, * // }; * * ``` * * @param GetMediaPipelineCommandInput - {@link GetMediaPipelineCommandInput} * @returns {@link GetMediaPipelineCommandOutput} * @see {@link GetMediaPipelineCommandInput} for command's `input` shape. * @see {@link GetMediaPipelineCommandOutput} 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 NotFoundException} (client fault) *

One or more of the resources in the request does not exist in the system.

* * @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 GetMediaPipelineCommand extends GetMediaPipelineCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: GetMediaPipelineRequest; output: GetMediaPipelineResponse; }; sdk: { input: GetMediaPipelineCommandInput; output: GetMediaPipelineCommandOutput; }; }; }