[ aws . chime-sdk-media-pipelines ]

create-media-live-connector-pipeline

Description

Creates a media live connector pipeline in an Amazon Chime SDK meeting.

See also: AWS API Documentation

Synopsis

  create-media-live-connector-pipeline
--sources <value>
--sinks <value>
[--client-request-token <value>]
[--tags <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

--sources (list)

The media live connector pipeline’s data sources.

(structure)

The data source configuration object of a streaming media pipeline.

SourceType -> (string)

The source configuration’s media source type.

ChimeSdkMeetingLiveConnectorConfiguration -> (structure)

The configuration settings of the connector pipeline.

Arn -> (string)

The configuration object’s Chime SDK meeting ARN.

MuxType -> (string)

The configuration object’s multiplex type.

CompositedVideo -> (structure)

The media pipeline’s composited video.

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 .

ActiveSpeakerOnlyConfiguration -> (structure)

The configuration settings for an ActiveSpeakerOnly video tile.

ActiveSpeakerPosition -> (string)

The position of the ActiveSpeakerOnly video tile.

HorizontalLayoutConfiguration -> (structure)

The configuration settings for a horizontal layout.

TileOrder -> (string)

Sets the automatic ordering of the video tiles.

TilePosition -> (string)

Sets the position of horizontal tiles.

TileCount -> (integer)

The maximum number of video tiles to display.

TileAspectRatio -> (string)

Specifies the aspect ratio of all video tiles.

VerticalLayoutConfiguration -> (structure)

The configuration settings for a vertical layout.

TileOrder -> (string)

Sets the automatic ordering of the video tiles.

TilePosition -> (string)

Sets the position of vertical tiles.

TileCount -> (integer)

The maximum number of tiles to display.

TileAspectRatio -> (string)

Sets the aspect ratio of the video tiles, such as 16:9.

VideoAttribute -> (structure)

The attribute settings for the video tiles.

CornerRadius -> (integer)

Sets the corner radius of all video tiles.

BorderColor -> (string)

Defines the border color of all video tiles.

HighlightColor -> (string)

Defines the highlight color for the active video tile.

BorderThickness -> (integer)

Defines the border thickness for all video tiles.

CanvasOrientation -> (string)

The orientation setting, horizontal or vertical.

SourceConfiguration -> (structure)

The source configuration settings of the media pipeline’s configuration object.

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)

JSON Syntax:

[
  {
    "SourceType": "ChimeSdkMeeting",
    "ChimeSdkMeetingLiveConnectorConfiguration": {
      "Arn": "string",
      "MuxType": "AudioWithCompositedVideo"|"AudioWithActiveSpeakerVideo",
      "CompositedVideo": {
        "Layout": "GridView",
        "Resolution": "HD"|"FHD",
        "GridViewConfiguration": {
          "ContentShareLayout": "PresenterOnly"|"Horizontal"|"Vertical"|"ActiveSpeakerOnly",
          "PresenterOnlyConfiguration": {
            "PresenterPosition": "TopLeft"|"TopRight"|"BottomLeft"|"BottomRight"
          },
          "ActiveSpeakerOnlyConfiguration": {
            "ActiveSpeakerPosition": "TopLeft"|"TopRight"|"BottomLeft"|"BottomRight"
          },
          "HorizontalLayoutConfiguration": {
            "TileOrder": "JoinSequence"|"SpeakerSequence",
            "TilePosition": "Top"|"Bottom",
            "TileCount": integer,
            "TileAspectRatio": "string"
          },
          "VerticalLayoutConfiguration": {
            "TileOrder": "JoinSequence"|"SpeakerSequence",
            "TilePosition": "Left"|"Right",
            "TileCount": integer,
            "TileAspectRatio": "string"
          },
          "VideoAttribute": {
            "CornerRadius": integer,
            "BorderColor": "Black"|"Blue"|"Red"|"Green"|"White"|"Yellow",
            "HighlightColor": "Black"|"Blue"|"Red"|"Green"|"White"|"Yellow",
            "BorderThickness": integer
          },
          "CanvasOrientation": "Landscape"|"Portrait"
        }
      },
      "SourceConfiguration": {
        "SelectedVideoStreams": {
          "AttendeeIds": ["string", ...],
          "ExternalUserIds": ["string", ...]
        }
      }
    }
  }
  ...
]

--sinks (list)

The media live connector pipeline’s data sinks.

(structure)

The media pipeline’s sink configuration settings.

SinkType -> (string)

The sink configuration’s sink type.

RTMPConfiguration -> (structure)

The sink configuration’s RTMP configuration settings.

Url -> (string)

The URL of the RTMP configuration.

AudioChannels -> (string)

The audio channels set for the RTMP configuration

AudioSampleRate -> (string)

The audio sample rate set for the RTMP configuration. Default: 48000.

Shorthand Syntax:

SinkType=string,RTMPConfiguration={Url=string,AudioChannels=string,AudioSampleRate=string} ...

JSON Syntax:

[
  {
    "SinkType": "RTMP",
    "RTMPConfiguration": {
      "Url": "string",
      "AudioChannels": "Stereo"|"Mono",
      "AudioSampleRate": "string"
    }
  }
  ...
]

--client-request-token (string)

The token assigned to the client making the request.

--tags (list)

The tags associated with the media live connector pipeline.

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

MediaLiveConnectorPipeline -> (structure)

The new media live connector pipeline.

Sources -> (list)

The connector pipeline’s data sources.

(structure)

The data source configuration object of a streaming media pipeline.

SourceType -> (string)

The source configuration’s media source type.

ChimeSdkMeetingLiveConnectorConfiguration -> (structure)

The configuration settings of the connector pipeline.

Arn -> (string)

The configuration object’s Chime SDK meeting ARN.

MuxType -> (string)

The configuration object’s multiplex type.

CompositedVideo -> (structure)

The media pipeline’s composited video.

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 .

ActiveSpeakerOnlyConfiguration -> (structure)

The configuration settings for an ActiveSpeakerOnly video tile.

ActiveSpeakerPosition -> (string)

The position of the ActiveSpeakerOnly video tile.

HorizontalLayoutConfiguration -> (structure)

The configuration settings for a horizontal layout.

TileOrder -> (string)

Sets the automatic ordering of the video tiles.

TilePosition -> (string)

Sets the position of horizontal tiles.

TileCount -> (integer)

The maximum number of video tiles to display.

TileAspectRatio -> (string)

Specifies the aspect ratio of all video tiles.

VerticalLayoutConfiguration -> (structure)

The configuration settings for a vertical layout.

TileOrder -> (string)

Sets the automatic ordering of the video tiles.

TilePosition -> (string)

Sets the position of vertical tiles.

TileCount -> (integer)

The maximum number of tiles to display.

TileAspectRatio -> (string)

Sets the aspect ratio of the video tiles, such as 16:9.

VideoAttribute -> (structure)

The attribute settings for the video tiles.

CornerRadius -> (integer)

Sets the corner radius of all video tiles.

BorderColor -> (string)

Defines the border color of all video tiles.

HighlightColor -> (string)

Defines the highlight color for the active video tile.

BorderThickness -> (integer)

Defines the border thickness for all video tiles.

CanvasOrientation -> (string)

The orientation setting, horizontal or vertical.

SourceConfiguration -> (structure)

The source configuration settings of the media pipeline’s configuration object.

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)

Sinks -> (list)

The connector pipeline’s data sinks.

(structure)

The media pipeline’s sink configuration settings.

SinkType -> (string)

The sink configuration’s sink type.

RTMPConfiguration -> (structure)

The sink configuration’s RTMP configuration settings.

Url -> (string)

The URL of the RTMP configuration.

AudioChannels -> (string)

The audio channels set for the RTMP configuration

AudioSampleRate -> (string)

The audio sample rate set for the RTMP configuration. Default: 48000.

MediaPipelineId -> (string)

The connector pipeline’s ID.

MediaPipelineArn -> (string)

The connector pipeline’s ARN.

Status -> (string)

The connector pipeline’s status.

CreatedTimestamp -> (timestamp)

The time at which the connector pipeline was created.

UpdatedTimestamp -> (timestamp)

The time at which the connector pipeline was last updated.