[ aws . chime-sdk-media-pipelines ]
get-media-capture-pipeline
Description
Gets an existing media pipeline.
See also: AWS API Documentation
Synopsis
get-media-capture-pipeline
--media-pipeline-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
Options
--media-pipeline-id (string)
--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
Global Options
--debug (boolean)
Turn on debug logging.
--endpoint-url (string)
Override command’s default URL with the given URL.
--no-verify-ssl (boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate (boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output (string)
The formatting style for command output.
- json
- text
- table
- yaml
- yaml-stream
--query (string)
A JMESPath query to use in filtering the response data.
--profile (string)
Use a specific profile from your credential file.
--region (string)
The region to use. Overrides config/env settings.
--version (string)
Display the version of this tool.
--color (string)
Turn on/off color output.
- on
- off
- auto
--no-sign-request (boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle (string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout (int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout (int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
--cli-binary-format (string)
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.
- base64
- raw-in-base64-out
--no-cli-pager (boolean)
Disable cli pager for output.
--cli-auto-prompt (boolean)
Automatically prompt for CLI input parameters.
--no-cli-auto-prompt (boolean)
Disable automatically prompt for CLI input parameters.
Output
MediaCapturePipeline -> (structure)
The media pipeline object.
MediaPipelineId -> (string)
MediaPipelineArn -> (string)
SourceType -> (string)
ChimeMeeting .SourceArn -> (string)
Status -> (string)
SinkType -> (string)
SinkArn -> (string)
CreatedTimestamp -> (timestamp)
UpdatedTimestamp -> (timestamp)
ChimeSdkMeetingConfiguration -> (structure)
The configuration for a specified media pipeline. SourceType must be ChimeSdkMeeting .
SourceConfiguration -> (structure)
The source configuration for a specified media pipeline.
SelectedVideoStreams -> (structure)
The selected video streams for a specified media pipeline. The number of video streams can’t exceed 25.
AttendeeIds -> (list)
The attendee IDs of the streams selected for a media pipeline.
(string)
ExternalUserIds -> (list)
The external user IDs of the streams selected for a media pipeline.
(string)
ArtifactsConfiguration -> (structure)
The configuration for the artifacts in an Amazon Chime SDK meeting.
Audio -> (structure)
The configuration for the audio artifacts.
MuxType -> (string)
Video -> (structure)
The configuration for the video artifacts.
State -> (string)
MuxType -> (string)
Content -> (structure)
The configuration for the content artifacts.
State -> (string)
MuxType -> (string)
CompositedVideo -> (structure)
Enables video compositing.
Layout -> (string)
GridView in the configuration object.Resolution -> (string)
GridViewConfiguration -> (structure)
The GridView configuration setting.
ContentShareLayout -> (string)
PresenterOnlyConfiguration -> (structure)
Defines the configuration options for a presenter only video tile.
PresenterPosition -> (string)
TopRight .ActiveSpeakerOnlyConfiguration -> (structure)
The configuration settings for an ActiveSpeakerOnly video tile.
ActiveSpeakerPosition -> (string)
ActiveSpeakerOnly video tile.HorizontalLayoutConfiguration -> (structure)
The configuration settings for a horizontal layout.
TileOrder -> (string)
TilePosition -> (string)
TileCount -> (integer)
TileAspectRatio -> (string)
VerticalLayoutConfiguration -> (structure)
The configuration settings for a vertical layout.
TileOrder -> (string)
TilePosition -> (string)
TileCount -> (integer)
TileAspectRatio -> (string)
VideoAttribute -> (structure)
The attribute settings for the video tiles.
CornerRadius -> (integer)
BorderColor -> (string)
HighlightColor -> (string)
BorderThickness -> (integer)
CanvasOrientation -> (string)
SseAwsKeyManagementParams -> (structure)
An object that contains server side encryption parameters to be used by media capture pipeline. The parameters can also be used by media concatenation pipeline taking media capture pipeline as a media source.
AwsKmsKeyId -> (string)
The KMS key you want to use to encrypt your media pipeline output. Decryption is required for concatenation pipeline. If using a key located in the current Amazon Web Services account, you can specify your KMS key in one of four ways:
- Use the KMS key ID itself. For example,
1234abcd-12ab-34cd-56ef-1234567890ab. - Use an alias for the KMS key ID. For example,
alias/ExampleAlias. - Use the Amazon Resource Name (ARN) for the KMS key ID. For example,
arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab. - Use the ARN for the KMS key alias. For example,
arn:aws:kms:region:account-ID:alias/ExampleAlias.
If using a key located in a different Amazon Web Services account than the current Amazon Web Services account, you can specify your KMS key in one of two ways:
- Use the ARN for the KMS key ID. For example,
arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab. - Use the ARN for the KMS key alias. For example,
arn:aws:kms:region:account-ID:alias/ExampleAlias.
If you don’t specify an encryption key, your output is encrypted with the default Amazon S3 key (SSE-S3).
Note that the role specified in the SinkIamRoleArn request parameter must have permission to use the specified KMS key.
AwsKmsEncryptionContext -> (string)
SinkIamRoleArn -> (string)
AwsKmsKeyId in SseAwsKeyManagementParams .
© Copyright 2025, Amazon Web Services. Created using Sphinx.