media_pipelines

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

Overview

Name	media_pipelines
Type	Resource
Id	aws.chime_sdk_media_pipelines.media_pipelines

Fields

The following fields are returned by SELECT queries:

get_media_pipeline

Name	Datatype	Description
media_capture_pipeline	object	A pipeline that enables users to capture audio and video.
media_concatenation_pipeline	object	The media concatenation pipeline in a media pipeline.
media_insights_pipeline	object	The media insights pipeline of a media pipeline.
media_live_connector_pipeline	object	The connector pipeline of the media pipeline.
media_stream_pipeline	object	Designates a media pipeline as a media stream pipeline.

list_media_pipelines

Name	Datatype	Description
media_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_pipeline	select	media_pipeline_id, region		Gets an existing media pipeline.
list_media_pipelines	select	region	next-token, max-results	Returns a list of media pipelines.
delete_media_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 to delete.
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_pipeline

Gets an existing media pipeline.

SELECT
media_capture_pipeline,
media_concatenation_pipeline,
media_insights_pipeline,
media_live_connector_pipeline,
media_stream_pipeline
FROM aws.chime_sdk_media_pipelines.media_pipelines
WHERE media_pipeline_id = '{{ media_pipeline_id }}' -- required
AND region = '{{ region }}' -- required
;

list_media_pipelines

Returns a list of media pipelines.

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

DELETE examples

delete_media_pipeline

Deletes the media pipeline.

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