Skip to content

aws.chime_sdk_media_pipelines.get_media_capture_pipeline

Example SQL Queries

SELECT * FROM
aws.chime_sdk_media_pipelines.get_media_capture_pipeline
WHERE
"media_pipeline_id" = 'VALUE';

Description

Gets an existing media pipeline.

Table Definition

Column NameColumn Data Type
media_pipeline_id Required Input Column

The ID of the pipeline that you want to get.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

media_capture_pipeline

The media pipeline object.

STRUCT(
"media_pipeline_id" VARCHAR,
"media_pipeline_arn" VARCHAR,
"source_type" VARCHAR,
"source_arn" VARCHAR,
"status" VARCHAR,
"sink_type" VARCHAR,
"sink_arn" VARCHAR,
"created_timestamp" TIMESTAMP_S,
"updated_timestamp" TIMESTAMP_S,
"chime_sdk_meeting_configuration" STRUCT(
"source_configuration" STRUCT(
"selected_video_streams" STRUCT(
"attendee_ids" VARCHAR[],
"external_user_ids" VARCHAR[]
)
),
"artifacts_configuration" STRUCT(
"audio" STRUCT(
"mux_type" VARCHAR
),
"video" STRUCT(
"state" VARCHAR,
"mux_type" VARCHAR
),
"content" STRUCT(
"state" VARCHAR,
"mux_type" VARCHAR
),
"composited_video" STRUCT(
"layout" VARCHAR,
"resolution" VARCHAR,
"grid_view_configuration" STRUCT(
"content_share_layout" VARCHAR,
"presenter_only_configuration" STRUCT(
"presenter_position" VARCHAR
),
"active_speaker_only_configuration" STRUCT(
"active_speaker_position" VARCHAR
),
"horizontal_layout_configuration" STRUCT(
"tile_order" VARCHAR,
"tile_position" VARCHAR,
"tile_count" BIGINT,
"tile_aspect_ratio" VARCHAR
),
"vertical_layout_configuration" STRUCT(
"tile_order" VARCHAR,
"tile_position" VARCHAR,
"tile_count" BIGINT,
"tile_aspect_ratio" VARCHAR
),
"video_attribute" STRUCT(
"corner_radius" BIGINT,
"border_color" VARCHAR,
"highlight_color" VARCHAR,
"border_thickness" BIGINT
),
"canvas_orientation" VARCHAR
)
)
)
)
)
Show child fields
media_capture_pipeline.chime_sdk_meeting_configuration

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

Show child fields
media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration

The configuration for the artifacts in an Amazon Chime SDK meeting.

Show child fields
media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.audio

The configuration for the audio artifacts.

Show child fields
media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.audio.mux_type

The MUX type of the audio artifact configuration object.

media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.composited_video

Enables video compositing.

Show child fields
media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.composited_video.grid_view_configuration

The GridView configuration setting.

Show child fields
media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.composited_video.grid_view_configuration.active_speaker_only_configuration

The configuration settings for an ActiveSpeakerOnly video tile.

Show child fields
media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.composited_video.grid_view_configuration.active_speaker_only_configuration.active_speaker_position

The position of the ActiveSpeakerOnly video tile.

media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.composited_video.grid_view_configuration.canvas_orientation

The orientation setting, horizontal or vertical.

media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.composited_video.grid_view_configuration.content_share_layout

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

media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.composited_video.grid_view_configuration.horizontal_layout_configuration

The configuration settings for a horizontal layout.

Show child fields
media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.composited_video.grid_view_configuration.horizontal_layout_configuration.tile_aspect_ratio

Specifies the aspect ratio of all video tiles.

media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.composited_video.grid_view_configuration.horizontal_layout_configuration.tile_count

The maximum number of video tiles to display.

media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.composited_video.grid_view_configuration.horizontal_layout_configuration.tile_order

Sets the automatic ordering of the video tiles.

media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.composited_video.grid_view_configuration.horizontal_layout_configuration.tile_position

Sets the position of horizontal tiles.

media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.composited_video.grid_view_configuration.presenter_only_configuration

Defines the configuration options for a presenter only video tile.

Show child fields
media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.composited_video.grid_view_configuration.presenter_only_configuration.presenter_position

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

media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.composited_video.grid_view_configuration.vertical_layout_configuration

The configuration settings for a vertical layout.

Show child fields
media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.composited_video.grid_view_configuration.vertical_layout_configuration.tile_aspect_ratio

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

media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.composited_video.grid_view_configuration.vertical_layout_configuration.tile_count

The maximum number of tiles to display.

media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.composited_video.grid_view_configuration.vertical_layout_configuration.tile_order

Sets the automatic ordering of the video tiles.

media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.composited_video.grid_view_configuration.vertical_layout_configuration.tile_position

Sets the position of vertical tiles.

media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.composited_video.grid_view_configuration.video_attribute

The attribute settings for the video tiles.

Show child fields
media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.composited_video.grid_view_configuration.video_attribute.border_color

Defines the border color of all video tiles.

media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.composited_video.grid_view_configuration.video_attribute.border_thickness

Defines the border thickness for all video tiles.

media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.composited_video.grid_view_configuration.video_attribute.corner_radius

Sets the corner radius of all video tiles.

media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.composited_video.grid_view_configuration.video_attribute.highlight_color

Defines the highlight color for the active video tile.

media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.composited_video.layout

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

media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.composited_video.resolution

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

media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.content

The configuration for the content artifacts.

Show child fields
media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.content.mux_type

The MUX type of the artifact configuration.

media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.content.state

Indicates whether the content artifact is enabled or disabled.

media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.video

The configuration for the video artifacts.

Show child fields
media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.video.mux_type

The MUX type of the video artifact configuration object.

media_capture_pipeline.chime_sdk_meeting_configuration.artifacts_configuration.video.state

Indicates whether the video artifact is enabled or disabled.

media_capture_pipeline.chime_sdk_meeting_configuration.source_configuration

The source configuration for a specified media pipeline.

Show child fields
media_capture_pipeline.chime_sdk_meeting_configuration.source_configuration.selected_video_streams

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

Show child fields
media_capture_pipeline.chime_sdk_meeting_configuration.source_configuration.selected_video_streams.attendee_ids[]
media_capture_pipeline.chime_sdk_meeting_configuration.source_configuration.selected_video_streams.external_user_ids[]
media_capture_pipeline.created_timestamp

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

media_capture_pipeline.media_pipeline_arn

The ARN of the media capture pipeline

media_capture_pipeline.media_pipeline_id

The ID of a media pipeline.

media_capture_pipeline.sink_arn

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

media_capture_pipeline.sink_type

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

media_capture_pipeline.source_arn

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

media_capture_pipeline.source_type

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

media_capture_pipeline.status

The status of the media pipeline.

media_capture_pipeline.updated_timestamp

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