Chime Sdk Media Pipelines
This page documents function available when using the Chime_Sdk_Media_Pipelines module, created with @service Chime_Sdk_Media_Pipelines.
Index
Main.Chime_Sdk_Media_Pipelines.create_media_capture_pipelineMain.Chime_Sdk_Media_Pipelines.create_media_concatenation_pipelineMain.Chime_Sdk_Media_Pipelines.create_media_live_connector_pipelineMain.Chime_Sdk_Media_Pipelines.delete_media_capture_pipelineMain.Chime_Sdk_Media_Pipelines.delete_media_pipelineMain.Chime_Sdk_Media_Pipelines.get_media_capture_pipelineMain.Chime_Sdk_Media_Pipelines.get_media_pipelineMain.Chime_Sdk_Media_Pipelines.list_media_capture_pipelinesMain.Chime_Sdk_Media_Pipelines.list_media_pipelinesMain.Chime_Sdk_Media_Pipelines.list_tags_for_resourceMain.Chime_Sdk_Media_Pipelines.tag_resourceMain.Chime_Sdk_Media_Pipelines.untag_resource
Documentation
Main.Chime_Sdk_Media_Pipelines.create_media_capture_pipeline — Methodcreate_media_capture_pipeline(sink_arn, sink_type, source_arn, source_type)
create_media_capture_pipeline(sink_arn, sink_type, source_arn, source_type, params::Dict{String,<:Any})Creates a media pipeline.
Arguments
sink_arn: The ARN of the sink type.sink_type: Destination type to which the media artifacts are saved. You must use an S3 bucket.source_arn: ARN of the source from which the media artifacts are captured.source_type: Source type from which the media artifacts are captured. A Chime SDK Meeting is the only supported source.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"ChimeSdkMeetingConfiguration": The configuration for a specified media pipeline. SourceType must be ChimeSdkMeeting."ClientRequestToken": The unique identifier for the client request. The token makes the API request idempotent. Use a unique token for each media pipeline request."Tags": The tag key-value pairs.
Main.Chime_Sdk_Media_Pipelines.create_media_concatenation_pipeline — Methodcreate_media_concatenation_pipeline(sinks, sources)
create_media_concatenation_pipeline(sinks, sources, params::Dict{String,<:Any})Creates a media concatenation pipeline.
Arguments
sinks: An object that specifies the data sinks for the media concatenation pipeline.sources: An object that specifies the sources for the media concatenation pipeline.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"ClientRequestToken": The unique identifier for the client request. The token makes the API request idempotent. Use a unique token for each media concatenation pipeline request."Tags": The tags associated with the media concatenation pipeline.
Main.Chime_Sdk_Media_Pipelines.create_media_live_connector_pipeline — Methodcreate_media_live_connector_pipeline(sinks, sources)
create_media_live_connector_pipeline(sinks, sources, params::Dict{String,<:Any})Creates a streaming media pipeline in an Amazon Chime SDK meeting.
Arguments
sinks: The media pipeline's data sinks.sources: The media pipeline's data sources.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"ClientRequestToken": The token assigned to the client making the request."Tags": The tags associated with the media pipeline.
Main.Chime_Sdk_Media_Pipelines.delete_media_capture_pipeline — Methoddelete_media_capture_pipeline(media_pipeline_id)
delete_media_capture_pipeline(media_pipeline_id, params::Dict{String,<:Any})Deletes the media pipeline.
Arguments
media_pipeline_id: The ID of the media pipeline being deleted.
Main.Chime_Sdk_Media_Pipelines.delete_media_pipeline — Methoddelete_media_pipeline(media_pipeline_id)
delete_media_pipeline(media_pipeline_id, params::Dict{String,<:Any})Deletes the media pipeline.
Arguments
media_pipeline_id: The ID of the media pipeline to delete.
Main.Chime_Sdk_Media_Pipelines.get_media_capture_pipeline — Methodget_media_capture_pipeline(media_pipeline_id)
get_media_capture_pipeline(media_pipeline_id, params::Dict{String,<:Any})Gets an existing media pipeline.
Arguments
media_pipeline_id: The ID of the pipeline that you want to get.
Main.Chime_Sdk_Media_Pipelines.get_media_pipeline — Methodget_media_pipeline(media_pipeline_id)
get_media_pipeline(media_pipeline_id, params::Dict{String,<:Any})Gets an existing media pipeline.
Arguments
media_pipeline_id: The ID of the pipeline that you want to get.
Main.Chime_Sdk_Media_Pipelines.list_media_capture_pipelines — Methodlist_media_capture_pipelines()
list_media_capture_pipelines(params::Dict{String,<:Any})Returns a list of media pipelines.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"max-results": The maximum number of results to return in a single call. Valid Range: 1"next-token": The token used to retrieve the next page of results.
Main.Chime_Sdk_Media_Pipelines.list_media_pipelines — Methodlist_media_pipelines()
list_media_pipelines(params::Dict{String,<:Any})Returns a list of media pipelines.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"max-results": The maximum number of results to return in a single call. Valid Range: 1"next-token": The token used to retrieve the next page of results.
Main.Chime_Sdk_Media_Pipelines.list_tags_for_resource — Methodlist_tags_for_resource(arn)
list_tags_for_resource(arn, params::Dict{String,<:Any})Lists the tags available for a media pipeline.
Arguments
arn: The ARN of the media pipeline associated with any tags. The ARN consists of the pipeline's region, resource ID, and pipeline ID.
Main.Chime_Sdk_Media_Pipelines.tag_resource — Methodtag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})The ARN of the media pipeline that you want to tag. Consists of he pipeline's endpoint region, resource ID, and pipeline ID.
Arguments
resource_arn: The ARN of the media pipeline associated with any tags. The ARN consists of the pipeline's endpoint region, resource ID, and pipeline ID.tags: The tags associated with the specified media pipeline.
Main.Chime_Sdk_Media_Pipelines.untag_resource — Methoduntag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})Removes any tags from a media pipeline.
Arguments
resource_arn: The ARN of the pipeline that you want to untag.tag_keys: The key/value pairs in the tag that you want to remove.