Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . chime-sdk-media-pipelines ]

create-media-capture-pipeline

Description

Creates a media pipeline.

See also: AWS API Documentation

Synopsis

  create-media-capture-pipeline
--source-type <value>
--source-arn <value>
--sink-type <value>
--sink-arn <value>
[--client-request-token <value>]
[--chime-sdk-meeting-configuration <value>]
[--tags <value>]
[--cli-input-json <value>]
[--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>]

Options

--source-type (string)

Source type from which the media artifacts are captured. A Chime SDK Meeting is the only supported source.

Possible values:

  • ChimeSdkMeeting

--source-arn (string)

ARN of the source from which the media artifacts are captured.

--sink-type (string)

Destination type to which the media artifacts are saved. You must use an S3 bucket.

Possible values:

  • S3Bucket

--sink-arn (string)

The ARN of the sink type.

--client-request-token (string)

The unique identifier for the client request. The token makes the API request idempotent. Use a unique token for each media pipeline request.

--chime-sdk-meeting-configuration (structure)

The configuration for a specified media pipeline. SourceType must be ChimeSdkMeeting .

SourceConfiguration -> (structure)

The source configuration for a specified media pipline.

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)

The MUX type of the audio artifact configuration object.

Video -> (structure)

The configuration for the video artifacts.

State -> (string)

Indicates whether the video artifact is enabled or disabled.

MuxType -> (string)

The MUX type of the video artifact configuration object.

Content -> (structure)

The configuration for the content artifacts.

State -> (string)

Indicates whether the content artifact is enabled or disabled.

MuxType -> (string)

The MUX type of the artifact configuration.

CompositedVideo -> (structure)

Enables video compositing.

Layout -> (string)

The layout setting, such as GridView in the configuration object.

Resolution -> (string)

The video resolution setting in the configuration object. Default: HD at 1280 x 720. FHD resolution: 1920 x 1080.

GridViewConfiguration -> (structure)

The GridView configuration setting.

ContentShareLayout -> (string)

Defines the layout of the video tiles when content sharing is enabled.

PresenterOnlyConfiguration -> (structure)

Defines the configuration options for a presenter only video tile.

PresenterPosition -> (string)

Defines the position of the presenter video tile. Default: TopRight .

JSON Syntax:

{
  "SourceConfiguration": {
    "SelectedVideoStreams": {
      "AttendeeIds": ["string", ...],
      "ExternalUserIds": ["string", ...]
    }
  },
  "ArtifactsConfiguration": {
    "Audio": {
      "MuxType": "AudioOnly"|"AudioWithActiveSpeakerVideo"|"AudioWithCompositedVideo"
    },
    "Video": {
      "State": "Enabled"|"Disabled",
      "MuxType": "VideoOnly"
    },
    "Content": {
      "State": "Enabled"|"Disabled",
      "MuxType": "ContentOnly"
    },
    "CompositedVideo": {
      "Layout": "GridView",
      "Resolution": "HD"|"FHD",
      "GridViewConfiguration": {
        "ContentShareLayout": "PresenterOnly"|"Horizontal"|"Vertical",
        "PresenterOnlyConfiguration": {
          "PresenterPosition": "TopLeft"|"TopRight"|"BottomLeft"|"BottomRight"
        }
      }
    }
  }
}

--tags (list)

The tag key-value pairs.

(structure)

A key/value pair that grants users access to meeting resources.

Key -> (string)

The key half of a tag.

Value -> (string)

The value half of a tag.

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

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.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--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.

Output

MediaCapturePipeline -> (structure)

A media pipeline object, the ID, source type, source ARN, sink type, and sink ARN of a media pipeline object.

MediaPipelineId -> (string)

The ID of a media pipeline.

MediaPipelineArn -> (string)

The ARN of the media capture pipeline

SourceType -> (string)

Source type from which media artifacts are saved. You must use ChimeMeeting .

SourceArn -> (string)

ARN of the source from which the media artifacts are saved.

Status -> (string)

The status of the media pipeline.

SinkType -> (string)

Destination type to which the media artifacts are saved. You must use an S3 Bucket.

SinkArn -> (string)

ARN of the destination to which the media artifacts are saved.

CreatedTimestamp -> (timestamp)

The time at which the pipeline was created, in ISO 8601 format.

UpdatedTimestamp -> (timestamp)

The time at which the pipeline was updated, in ISO 8601 format.

ChimeSdkMeetingConfiguration -> (structure)

The configuration for a specified media pipeline. SourceType must be ChimeSdkMeeting .

SourceConfiguration -> (structure)

The source configuration for a specified media pipline.

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)

The MUX type of the audio artifact configuration object.

Video -> (structure)

The configuration for the video artifacts.

State -> (string)

Indicates whether the video artifact is enabled or disabled.

MuxType -> (string)

The MUX type of the video artifact configuration object.

Content -> (structure)

The configuration for the content artifacts.

State -> (string)

Indicates whether the content artifact is enabled or disabled.

MuxType -> (string)

The MUX type of the artifact configuration.

CompositedVideo -> (structure)

Enables video compositing.

Layout -> (string)

The layout setting, such as GridView in the configuration object.

Resolution -> (string)

The video resolution setting in the configuration object. Default: HD at 1280 x 720. FHD resolution: 1920 x 1080.

GridViewConfiguration -> (structure)

The GridView configuration setting.

ContentShareLayout -> (string)

Defines the layout of the video tiles when content sharing is enabled.

PresenterOnlyConfiguration -> (structure)

Defines the configuration options for a presenter only video tile.

PresenterPosition -> (string)

Defines the position of the presenter video tile. Default: TopRight .