media_capture_pipelines

Creates, updates, deletes, gets or lists a media_capture_pipelines resource.

Overview

Name	media_capture_pipelines
Type	Resource
Id	aws.chime_sdk_media_pipelines.media_capture_pipelines

Fields

The following fields are returned by SELECT queries:

get_media_capture_pipeline

Name	Datatype	Description
chime_sdk_meeting_configuration	object	The configuration object of the Amazon Chime SDK meeting for a specified media pipeline. SourceType must be ChimeSdkMeeting.
created_timestamp	string (date-time)	The time at which the pipeline was created, in ISO 8601 format.
media_pipeline_arn	string	The ARN of the media capture pipeline (pattern: <code>^arn[/:-_.a-zA-Z0-9]+$</code>)
media_pipeline_id	string	The ID of a media pipeline. (pattern: <code>[a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}</code>)
sink_arn	string	ARN of the destination to which the media artifacts are saved. (pattern: <code>^arn[/:-_.a-zA-Z0-9]+$</code>)
sink_iam_role_arn	string	The Amazon Resource Name (ARN) of the sink role to be used with AwsKmsKeyId in SseAwsKeyManagementParams. (pattern: <code>^arn[/:-_.a-zA-Z0-9]+$</code>)
sink_type	string	Destination type to which the media artifacts are saved. You must use an S3 Bucket. (S3Bucket)
source_arn	string	ARN of the source from which the media artifacts are saved. (pattern: <code>^arn[/:-_.a-zA-Z0-9]+$</code>)
source_type	string	Source type from which media artifacts are saved. You must use ChimeMeeting. (ChimeSdkMeeting)
sse_aws_key_management_params	object	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.
status	string	The status of the media pipeline. (Initializing, InProgress, Failed, Stopping, Stopped, Paused, NotStarted)
updated_timestamp	string (date-time)	The time at which the pipeline was updated, in ISO 8601 format.

list_media_capture_pipelines

Name	Datatype	Description
media_capture_pipelines	array	The media pipeline objects in the list.
next_token	string	The token used to retrieve the next page of results. (pattern: <code>.*</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_media_capture_pipeline	select	media_pipeline_id, region		Gets an existing media pipeline.
list_media_capture_pipelines	select	region	next-token, max-results	Returns a list of media pipelines.
create_media_capture_pipeline	insert	region, SourceType, SourceArn, SinkType, SinkArn		Creates a media pipeline.
delete_media_capture_pipeline	delete	media_pipeline_id, region		Deletes the media pipeline.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
media_pipeline_id	string	The ID of the media pipeline being deleted.
region	string	AWS region (default: us-east-1)
max-results	integer	The maximum number of results to return in a single call. Valid Range: 1 - 99.
next-token	string	The token used to retrieve the next page of results.

SELECT examples

get_media_capture_pipeline

Gets an existing media pipeline.

SELECT
chime_sdk_meeting_configuration,
created_timestamp,
media_pipeline_arn,
media_pipeline_id,
sink_arn,
sink_iam_role_arn,
sink_type,
source_arn,
source_type,
sse_aws_key_management_params,
status,
updated_timestamp
FROM aws.chime_sdk_media_pipelines.media_capture_pipelines
WHERE media_pipeline_id = '{{ media_pipeline_id }}' -- required
AND region = '{{ region }}' -- required
;

list_media_capture_pipelines

Returns a list of media pipelines.

SELECT
media_capture_pipelines,
next_token
FROM aws.chime_sdk_media_pipelines.media_capture_pipelines
WHERE region = '{{ region }}' -- required
AND `next-token` = '{{ next-token }}'
AND `max-results` = '{{ max-results }}'
;

INSERT examples

create_media_capture_pipeline

Creates a media pipeline.

INSERT INTO aws.chime_sdk_media_pipelines.media_capture_pipelines (
SourceType,
SourceArn,
SinkType,
SinkArn,
ClientRequestToken,
ChimeSdkMeetingConfiguration,
SseAwsKeyManagementParams,
SinkIamRoleArn,
Tags,
region
)
SELECT 
'{{ SourceType }}' /* required */,
'{{ SourceArn }}' /* required */,
'{{ SinkType }}' /* required */,
'{{ SinkArn }}' /* required */,
'{{ ClientRequestToken }}',
'{{ ChimeSdkMeetingConfiguration }}',
'{{ SseAwsKeyManagementParams }}',
'{{ SinkIamRoleArn }}',
'{{ Tags }}',
'{{ region }}'
RETURNING
media_capture_pipeline
;

Manifest

# Description fields are for documentation purposes
- name: media_capture_pipelines
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the media_capture_pipelines resource.
  - name: SourceType
    value: "{{ SourceType }}"
    valid_values: ['ChimeSdkMeeting']
  - name: SourceArn
    value: "{{ SourceArn }}"
  - name: SinkType
    value: "{{ SinkType }}"
    valid_values: ['S3Bucket']
  - name: SinkArn
    value: "{{ SinkArn }}"
  - name: ClientRequestToken
    value: "{{ ClientRequestToken }}"
  - name: ChimeSdkMeetingConfiguration
    description: |
      The configuration object of the Amazon Chime SDK meeting for a specified media pipeline. SourceType must be ChimeSdkMeeting.
    value:
      SourceConfiguration:
        SelectedVideoStreams:
          AttendeeIds:
            - "{{ AttendeeIds }}"
          ExternalUserIds:
            - "{{ ExternalUserIds }}"
      ArtifactsConfiguration:
        Audio:
          MuxType: "{{ MuxType }}"
        Video:
          State: "{{ State }}"
          MuxType: "{{ MuxType }}"
        Content:
          State: "{{ State }}"
          MuxType: "{{ MuxType }}"
        CompositedVideo:
          Layout: "{{ Layout }}"
          Resolution: "{{ Resolution }}"
          GridViewConfiguration:
            ContentShareLayout: "{{ ContentShareLayout }}"
            PresenterOnlyConfiguration:
              PresenterPosition: "{{ PresenterPosition }}"
            ActiveSpeakerOnlyConfiguration:
              ActiveSpeakerPosition: "{{ ActiveSpeakerPosition }}"
            HorizontalLayoutConfiguration:
              TileOrder: "{{ TileOrder }}"
              TilePosition: "{{ TilePosition }}"
              TileCount: {{ TileCount }}
              TileAspectRatio: "{{ TileAspectRatio }}"
            VerticalLayoutConfiguration:
              TileOrder: "{{ TileOrder }}"
              TilePosition: "{{ TilePosition }}"
              TileCount: {{ TileCount }}
              TileAspectRatio: "{{ TileAspectRatio }}"
            VideoAttribute:
              CornerRadius: {{ CornerRadius }}
              BorderColor: "{{ BorderColor }}"
              HighlightColor: "{{ HighlightColor }}"
              BorderThickness: {{ BorderThickness }}
            CanvasOrientation: "{{ CanvasOrientation }}"
  - name: SseAwsKeyManagementParams
    description: |
      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.
    value:
      AwsKmsKeyId: "{{ AwsKmsKeyId }}"
      AwsKmsEncryptionContext: "{{ AwsKmsEncryptionContext }}"
  - name: SinkIamRoleArn
    value: "{{ SinkIamRoleArn }}"
  - name: Tags
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

DELETE examples

delete_media_capture_pipeline

Deletes the media pipeline.

DELETE FROM aws.chime_sdk_media_pipelines.media_capture_pipelines
WHERE media_pipeline_id = '{{ media_pipeline_id }}' --required
AND region = '{{ region }}' --required
;