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

Documentation

Main.Chime_Sdk_Media_Pipelines.create_media_capture_pipelineMethod
create_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_pipelineMethod
create_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_insights_pipelineMethod
create_media_insights_pipeline(media_insights_pipeline_configuration_arn)
create_media_insights_pipeline(media_insights_pipeline_configuration_arn, params::Dict{String,<:Any})

Creates a media insights pipeline.

Arguments

  • media_insights_pipeline_configuration_arn: The ARN of the pipeline's configuration.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ClientRequestToken": The unique identifier for the media insights pipeline request.
  • "KinesisVideoStreamRecordingSourceRuntimeConfiguration": The runtime configuration for the Kinesis video recording stream source.
  • "KinesisVideoStreamSourceRuntimeConfiguration": The runtime configuration for the Kinesis video stream source of the media insights pipeline.
  • "MediaInsightsRuntimeMetadata": The runtime metadata for the media insights pipeline. Consists of a key-value map of strings.
  • "S3RecordingSinkRuntimeConfiguration": The runtime configuration for the S3 recording sink.
  • "Tags": The tags assigned to the media insights pipeline.
Main.Chime_Sdk_Media_Pipelines.create_media_insights_pipeline_configurationMethod
create_media_insights_pipeline_configuration(elements, media_insights_pipeline_configuration_name, resource_access_role_arn)
create_media_insights_pipeline_configuration(elements, media_insights_pipeline_configuration_name, resource_access_role_arn, params::Dict{String,<:Any})

A structure that contains the static configurations for a media insights pipeline.

Arguments

  • elements: The elements in the request, such as a processor for Amazon Transcribe or a sink for a Kinesis Data Stream.
  • media_insights_pipeline_configuration_name: The name of the media insights pipeline configuration.
  • resource_access_role_arn: The ARN of the role used by the service to access Amazon Web Services resources, including Transcribe and Transcribe Call Analytics, on the caller’s behalf.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ClientRequestToken": The unique identifier for the media insights pipeline configuration request.
  • "RealTimeAlertConfiguration": The configuration settings for the real-time alerts in a media insights pipeline configuration.
  • "Tags": The tags assigned to the media insights pipeline configuration.
Main.Chime_Sdk_Media_Pipelines.create_media_live_connector_pipelineMethod
create_media_live_connector_pipeline(sinks, sources)
create_media_live_connector_pipeline(sinks, sources, params::Dict{String,<:Any})

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

Arguments

  • sinks: The media live connector pipeline's data sinks.
  • sources: The media live connector 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 live connector pipeline.
Main.Chime_Sdk_Media_Pipelines.delete_media_insights_pipeline_configurationMethod
delete_media_insights_pipeline_configuration(identifier)
delete_media_insights_pipeline_configuration(identifier, params::Dict{String,<:Any})

Deletes the specified configuration settings.

Arguments

  • identifier: The unique identifier of the resource to be deleted. Valid values include the name and ARN of the media insights pipeline configuration.
Main.Chime_Sdk_Media_Pipelines.delete_media_pipelineMethod
delete_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_pipelineMethod
get_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_insights_pipeline_configurationMethod
get_media_insights_pipeline_configuration(identifier)
get_media_insights_pipeline_configuration(identifier, params::Dict{String,<:Any})

Gets the configuration settings for a media insights pipeline.

Arguments

  • identifier: The unique identifier of the requested resource. Valid values include the name and ARN of the media insights pipeline configuration.
Main.Chime_Sdk_Media_Pipelines.get_media_pipelineMethod
get_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_pipelinesMethod
list_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_insights_pipeline_configurationsMethod
list_media_insights_pipeline_configurations()
list_media_insights_pipeline_configurations(params::Dict{String,<:Any})

Lists the available media insights pipeline configurations.

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.
  • "next-token": The token used to return the next page of results.
Main.Chime_Sdk_Media_Pipelines.list_media_pipelinesMethod
list_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_resourceMethod
list_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_resourceMethod
tag_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 the 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_resourceMethod
untag_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.
Main.Chime_Sdk_Media_Pipelines.update_media_insights_pipeline_configurationMethod
update_media_insights_pipeline_configuration(elements, resource_access_role_arn, identifier)
update_media_insights_pipeline_configuration(elements, resource_access_role_arn, identifier, params::Dict{String,<:Any})

Updates the media insights pipeline's configuration settings.

Arguments

  • elements: The elements in the request, such as a processor for Amazon Transcribe or a sink for a Kinesis Data Stream..
  • resource_access_role_arn: The ARN of the role used by the service to access Amazon Web Services resources.
  • identifier: The unique identifier for the resource to be updated. Valid values include the name and ARN of the media insights pipeline configuration.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "RealTimeAlertConfiguration": The configuration settings for real-time alerts for the media insights pipeline.
Main.Chime_Sdk_Media_Pipelines.update_media_insights_pipeline_statusMethod
update_media_insights_pipeline_status(update_status, identifier)
update_media_insights_pipeline_status(update_status, identifier, params::Dict{String,<:Any})

Updates the status of a media insights pipeline.

Arguments

  • update_status: The requested status of the media insights pipeline.
  • identifier: The unique identifier of the resource to be updated. Valid values include the ID and ARN of the media insights pipeline.