[ aws . chime-sdk-media-pipelines ]

create-media-capture-pipeline

Description

Creates a media capture pipeline.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

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 | --cli-input-yaml]
[--generate-cli-skeleton <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 token assigned to the client making the pipeline request.

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

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

SourceConfiguration -> (structure)

The source configuration for a specified media capture pipline.

SelectedVideoStreams -> (structure)

The selected video streams to capture for a specified media capture pipeline. The number of video streams can’t exceed 25.

AttendeeIds -> (list)

The attendee IDs of the streams selected for a media capture pipeline.

(string)

ExternalUserIds -> (list)

The external user IDs of the streams selected for a media capture 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.

JSON Syntax:

{
  "SourceConfiguration": {
    "SelectedVideoStreams": {
      "AttendeeIds": ["string", ...],
      "ExternalUserIds": ["string", ...]
    }
  },
  "ArtifactsConfiguration": {
    "Audio": {
      "MuxType": "AudioOnly"|"AudioWithActiveSpeakerVideo"
    },
    "Video": {
      "State": "Enabled"|"Disabled",
      "MuxType": "VideoOnly"
    },
    "Content": {
      "State": "Enabled"|"Disabled",
      "MuxType": "ContentOnly"
    }
  }
}

--tags (list)

The list of tags.

(structure)

Describes a tag applied to a resource.

Key -> (string)

The key of the tag.

Value -> (string)

The value of the tag.

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "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.

See ‘aws help’ for descriptions of global parameters.

Output

MediaCapturePipeline -> (structure)

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

MediaPipelineId -> (string)

The ID of a media capture pipeline.

MediaPipelineArn -> (string)

The ARN of a 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 capture 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 capture pipeline was created, in ISO 8601 format.

UpdatedTimestamp -> (timestamp)

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

ChimeSdkMeetingConfiguration -> (structure)

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

SourceConfiguration -> (structure)

The source configuration for a specified media capture pipline.

SelectedVideoStreams -> (structure)

The selected video streams to capture for a specified media capture pipeline. The number of video streams can’t exceed 25.

AttendeeIds -> (list)

The attendee IDs of the streams selected for a media capture pipeline.

(string)

ExternalUserIds -> (list)

The external user IDs of the streams selected for a media capture 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.