Struct Client 

pub struct Client { /* private fields */ }

Client for Amazon Chime SDK Media Pipelines

Client for invoking operations on Amazon Chime SDK Media Pipelines. Each operation on Amazon Chime SDK Media Pipelines is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_chimesdkmediapipelines::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Builder struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_chimesdkmediapipelines::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the CreateMediaCapturePipeline operation has a Client::create_media_capture_pipeline, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.create_media_capture_pipeline()
    .source_type("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations

impl Client

pub fn create_media_capture_pipeline( &self, ) -> CreateMediaCapturePipelineFluentBuilder

Constructs a fluent builder for the CreateMediaCapturePipeline operation.

• The fluent builder is configurable:
  • source_type(MediaPipelineSourceType) / set_source_type(Option<MediaPipelineSourceType>):
    required: true
    

    Source type from which the media artifacts are captured. A Chime SDK Meeting is the only supported source.

    
    
  • source_arn(impl Into<String>) / set_source_arn(Option<String>):
    required: true
    

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

    
    
  • sink_type(MediaPipelineSinkType) / set_sink_type(Option<MediaPipelineSinkType>):
    required: true
    

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

    
    
  • sink_arn(impl Into<String>) / set_sink_arn(Option<String>):
    required: true
    

    The ARN of the sink type.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: false
    

    The unique identifier for the client request. The token makes the API request idempotent. Use a unique token for each media pipeline request.

    
    
  • chime_sdk_meeting_configuration(ChimeSdkMeetingConfiguration) / set_chime_sdk_meeting_configuration(Option<ChimeSdkMeetingConfiguration>):
    required: false
    

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

    
    
  • sse_aws_key_management_params(SseAwsKeyManagementParams) / set_sse_aws_key_management_params(Option<SseAwsKeyManagementParams>):
    required: false
    

    An object that 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.

    
    
  • sink_iam_role_arn(impl Into<String>) / set_sink_iam_role_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the sink role to be used with AwsKmsKeyId in SseAwsKeyManagementParams. Can only interact with S3Bucket sink type. The role must belong to the caller’s account and be able to act on behalf of the caller during the API call. All minimum policy permissions requirements for the caller to perform sink-related actions are the same for SinkIamRoleArn.

    Additionally, the role must have permission to kms:GenerateDataKey using KMS key supplied as AwsKmsKeyId in SseAwsKeyManagementParams. If media concatenation will be required later, the role must also have permission to kms:Decrypt for the same KMS key.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    The tag key-value pairs.

    
    
• On success, responds with CreateMediaCapturePipelineOutput with field(s):
  • media_capture_pipeline(Option<MediaCapturePipeline>):

    A media pipeline object, the ID, source type, source ARN, sink type, and sink ARN of a media pipeline object.

• On failure, responds with SdkError<CreateMediaCapturePipelineError>

impl Client

pub fn create_media_concatenation_pipeline( &self, ) -> CreateMediaConcatenationPipelineFluentBuilder

Constructs a fluent builder for the CreateMediaConcatenationPipeline operation.

• The fluent builder is configurable:
  • sources(ConcatenationSource) / set_sources(Option<Vec::<ConcatenationSource>>):
    required: true
    

    An object that specifies the sources for the media concatenation pipeline.

    
    
  • sinks(ConcatenationSink) / set_sinks(Option<Vec::<ConcatenationSink>>):
    required: true
    

    An object that specifies the data sinks for the media concatenation pipeline.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: false
    

    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(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    The tags associated with the media concatenation pipeline.

    
    
• On success, responds with CreateMediaConcatenationPipelineOutput with field(s):
  • media_concatenation_pipeline(Option<MediaConcatenationPipeline>):

    A media concatenation pipeline object, the ID, source type, MediaPipelineARN, and sink of a media concatenation pipeline object.

• On failure, responds with SdkError<CreateMediaConcatenationPipelineError>

impl Client

pub fn create_media_insights_pipeline( &self, ) -> CreateMediaInsightsPipelineFluentBuilder

Constructs a fluent builder for the CreateMediaInsightsPipeline operation.

• The fluent builder is configurable:
  • media_insights_pipeline_configuration_arn(impl Into<String>) / set_media_insights_pipeline_configuration_arn(Option<String>):
    required: true
    

    The ARN of the pipeline’s configuration.

    
    
  • kinesis_video_stream_source_runtime_configuration(KinesisVideoStreamSourceRuntimeConfiguration) / set_kinesis_video_stream_source_runtime_configuration(Option<KinesisVideoStreamSourceRuntimeConfiguration>):
    required: false
    

    The runtime configuration for the Kinesis video stream source of the media insights pipeline.

    
    
  • media_insights_runtime_metadata(impl Into<String>, impl Into<String>) / set_media_insights_runtime_metadata(Option<HashMap::<String, String>>):
    required: false
    

    The runtime metadata for the media insights pipeline. Consists of a key-value map of strings.

    
    
  • kinesis_video_stream_recording_source_runtime_configuration(KinesisVideoStreamRecordingSourceRuntimeConfiguration) / set_kinesis_video_stream_recording_source_runtime_configuration(Option<KinesisVideoStreamRecordingSourceRuntimeConfiguration>):
    required: false
    

    The runtime configuration for the Kinesis video recording stream source.

    
    
  • s3_recording_sink_runtime_configuration(S3RecordingSinkRuntimeConfiguration) / set_s3_recording_sink_runtime_configuration(Option<S3RecordingSinkRuntimeConfiguration>):
    required: false
    

    The runtime configuration for the S3 recording sink. If specified, the settings in this structure override any settings in S3RecordingSinkConfiguration.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    The tags assigned to the media insights pipeline.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: false
    

    The unique identifier for the media insights pipeline request.

    
    
• On success, responds with CreateMediaInsightsPipelineOutput with field(s):
  • media_insights_pipeline(Option<MediaInsightsPipeline>):

    The media insights pipeline object.

• On failure, responds with SdkError<CreateMediaInsightsPipelineError>

impl Client

pub fn create_media_insights_pipeline_configuration( &self, ) -> CreateMediaInsightsPipelineConfigurationFluentBuilder

Constructs a fluent builder for the CreateMediaInsightsPipelineConfiguration operation.

• The fluent builder is configurable:
  • media_insights_pipeline_configuration_name(impl Into<String>) / set_media_insights_pipeline_configuration_name(Option<String>):
    required: true
    

    The name of the media insights pipeline configuration.

    
    
  • resource_access_role_arn(impl Into<String>) / set_resource_access_role_arn(Option<String>):
    required: true
    

    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.

    
    
  • real_time_alert_configuration(RealTimeAlertConfiguration) / set_real_time_alert_configuration(Option<RealTimeAlertConfiguration>):
    required: false
    

    The configuration settings for the real-time alerts in a media insights pipeline configuration.

    
    
  • elements(MediaInsightsPipelineConfigurationElement) / set_elements(Option<Vec::<MediaInsightsPipelineConfigurationElement>>):
    required: true
    

    The elements in the request, such as a processor for Amazon Transcribe or a sink for a Kinesis Data Stream.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    The tags assigned to the media insights pipeline configuration.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: false
    

    The unique identifier for the media insights pipeline configuration request.

    
    
• On success, responds with CreateMediaInsightsPipelineConfigurationOutput with field(s):
  • media_insights_pipeline_configuration(Option<MediaInsightsPipelineConfiguration>):

    The configuration settings for the media insights pipeline.

• On failure, responds with SdkError<CreateMediaInsightsPipelineConfigurationError>

impl Client

pub fn create_media_live_connector_pipeline( &self, ) -> CreateMediaLiveConnectorPipelineFluentBuilder

Constructs a fluent builder for the CreateMediaLiveConnectorPipeline operation.

• The fluent builder is configurable:
  • sources(LiveConnectorSourceConfiguration) / set_sources(Option<Vec::<LiveConnectorSourceConfiguration>>):
    required: true
    

    The media live connector pipeline’s data sources.

    
    
  • sinks(LiveConnectorSinkConfiguration) / set_sinks(Option<Vec::<LiveConnectorSinkConfiguration>>):
    required: true
    

    The media live connector pipeline’s data sinks.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: false
    

    The token assigned to the client making the request.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    The tags associated with the media live connector pipeline.

    
    
• On success, responds with CreateMediaLiveConnectorPipelineOutput with field(s):
  • media_live_connector_pipeline(Option<MediaLiveConnectorPipeline>):

    The new media live connector pipeline.

• On failure, responds with SdkError<CreateMediaLiveConnectorPipelineError>

impl Client

pub fn create_media_pipeline_kinesis_video_stream_pool( &self, ) -> CreateMediaPipelineKinesisVideoStreamPoolFluentBuilder

Constructs a fluent builder for the CreateMediaPipelineKinesisVideoStreamPool operation.

• The fluent builder is configurable:
  • stream_configuration(KinesisVideoStreamConfiguration) / set_stream_configuration(Option<KinesisVideoStreamConfiguration>):
    required: true
    

    The configuration settings for the stream.

    
    
  • pool_name(impl Into<String>) / set_pool_name(Option<String>):
    required: true
    

    The name of the pool.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: false
    

    The token assigned to the client making the request.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    The tags assigned to the stream pool.

    
    
• On success, responds with CreateMediaPipelineKinesisVideoStreamPoolOutput with field(s):
  • kinesis_video_stream_pool_configuration(Option<KinesisVideoStreamPoolConfiguration>):

    The configuration for applying the streams to the pool.

• On failure, responds with SdkError<CreateMediaPipelineKinesisVideoStreamPoolError>

impl Client

pub fn create_media_stream_pipeline( &self, ) -> CreateMediaStreamPipelineFluentBuilder

Constructs a fluent builder for the CreateMediaStreamPipeline operation.

• The fluent builder is configurable:
  • sources(MediaStreamSource) / set_sources(Option<Vec::<MediaStreamSource>>):
    required: true
    

    The data sources for the media pipeline.

    
    
  • sinks(MediaStreamSink) / set_sinks(Option<Vec::<MediaStreamSink>>):
    required: true
    

    The data sink for the media pipeline.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: false
    

    The token assigned to the client making the request.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    The tags assigned to the media pipeline.

    
    
• On success, responds with CreateMediaStreamPipelineOutput with field(s):
  • media_stream_pipeline(Option<MediaStreamPipeline>):

    The requested media pipeline.

• On failure, responds with SdkError<CreateMediaStreamPipelineError>

impl Client

pub fn delete_media_capture_pipeline( &self, ) -> DeleteMediaCapturePipelineFluentBuilder

Constructs a fluent builder for the DeleteMediaCapturePipeline operation.

• The fluent builder is configurable:
  • media_pipeline_id(impl Into<String>) / set_media_pipeline_id(Option<String>):
    required: true
    

    The ID of the media pipeline being deleted.

    
    
• On success, responds with DeleteMediaCapturePipelineOutput
• On failure, responds with SdkError<DeleteMediaCapturePipelineError>

impl Client

pub fn delete_media_insights_pipeline_configuration( &self, ) -> DeleteMediaInsightsPipelineConfigurationFluentBuilder

Constructs a fluent builder for the DeleteMediaInsightsPipelineConfiguration operation.

• The fluent builder is configurable:
  • identifier(impl Into<String>) / set_identifier(Option<String>):
    required: true
    

    The unique identifier of the resource to be deleted. Valid values include the name and ARN of the media insights pipeline configuration.

    
    
• On success, responds with DeleteMediaInsightsPipelineConfigurationOutput
• On failure, responds with SdkError<DeleteMediaInsightsPipelineConfigurationError>

impl Client

pub fn delete_media_pipeline(&self) -> DeleteMediaPipelineFluentBuilder

Constructs a fluent builder for the DeleteMediaPipeline operation.

• The fluent builder is configurable:
  • media_pipeline_id(impl Into<String>) / set_media_pipeline_id(Option<String>):
    required: true
    

    The ID of the media pipeline to delete.

    
    
• On success, responds with DeleteMediaPipelineOutput
• On failure, responds with SdkError<DeleteMediaPipelineError>

impl Client

pub fn delete_media_pipeline_kinesis_video_stream_pool( &self, ) -> DeleteMediaPipelineKinesisVideoStreamPoolFluentBuilder

Constructs a fluent builder for the DeleteMediaPipelineKinesisVideoStreamPool operation.

• The fluent builder is configurable:
  • identifier(impl Into<String>) / set_identifier(Option<String>):
    required: true
    

    The unique identifier of the requested resource. Valid values include the name and ARN of the media pipeline Kinesis Video Stream pool.

    
    
• On success, responds with DeleteMediaPipelineKinesisVideoStreamPoolOutput
• On failure, responds with SdkError<DeleteMediaPipelineKinesisVideoStreamPoolError>

impl Client

pub fn get_media_capture_pipeline(&self) -> GetMediaCapturePipelineFluentBuilder

Constructs a fluent builder for the GetMediaCapturePipeline operation.

• The fluent builder is configurable:
  • media_pipeline_id(impl Into<String>) / set_media_pipeline_id(Option<String>):
    required: true
    

    The ID of the pipeline that you want to get.

    
    
• On success, responds with GetMediaCapturePipelineOutput with field(s):
  • media_capture_pipeline(Option<MediaCapturePipeline>):

    The media pipeline object.

• On failure, responds with SdkError<GetMediaCapturePipelineError>

impl Client

pub fn get_media_insights_pipeline_configuration( &self, ) -> GetMediaInsightsPipelineConfigurationFluentBuilder

Constructs a fluent builder for the GetMediaInsightsPipelineConfiguration operation.

• The fluent builder is configurable:
  • identifier(impl Into<String>) / set_identifier(Option<String>):
    required: true
    

    The unique identifier of the requested resource. Valid values include the name and ARN of the media insights pipeline configuration.

    
    
• On success, responds with GetMediaInsightsPipelineConfigurationOutput with field(s):
  • media_insights_pipeline_configuration(Option<MediaInsightsPipelineConfiguration>):

    The requested media insights pipeline configuration.

• On failure, responds with SdkError<GetMediaInsightsPipelineConfigurationError>

impl Client

pub fn get_media_pipeline(&self) -> GetMediaPipelineFluentBuilder

Constructs a fluent builder for the GetMediaPipeline operation.

• The fluent builder is configurable:
  • media_pipeline_id(impl Into<String>) / set_media_pipeline_id(Option<String>):
    required: true
    

    The ID of the pipeline that you want to get.

    
    
• On success, responds with GetMediaPipelineOutput with field(s):
  • media_pipeline(Option<MediaPipeline>):

    The media pipeline object.

• On failure, responds with SdkError<GetMediaPipelineError>

impl Client

pub fn get_media_pipeline_kinesis_video_stream_pool( &self, ) -> GetMediaPipelineKinesisVideoStreamPoolFluentBuilder

Constructs a fluent builder for the GetMediaPipelineKinesisVideoStreamPool operation.

• The fluent builder is configurable:
  • identifier(impl Into<String>) / set_identifier(Option<String>):
    required: true
    

    The unique identifier of the requested resource. Valid values include the name and ARN of the media pipeline Kinesis Video Stream pool.

    
    
• On success, responds with GetMediaPipelineKinesisVideoStreamPoolOutput with field(s):
  • kinesis_video_stream_pool_configuration(Option<KinesisVideoStreamPoolConfiguration>):

    The video stream pool configuration object.

• On failure, responds with SdkError<GetMediaPipelineKinesisVideoStreamPoolError>

impl Client

pub fn get_speaker_search_task(&self) -> GetSpeakerSearchTaskFluentBuilder

Constructs a fluent builder for the GetSpeakerSearchTask operation.

• The fluent builder is configurable:
  • identifier(impl Into<String>) / set_identifier(Option<String>):
    required: true
    

    The unique identifier of the resource to be updated. Valid values include the ID and ARN of the media insights pipeline.

    
    
  • speaker_search_task_id(impl Into<String>) / set_speaker_search_task_id(Option<String>):
    required: true
    

    The ID of the speaker search task.

    
    
• On success, responds with GetSpeakerSearchTaskOutput with field(s):
  • speaker_search_task(Option<SpeakerSearchTask>):

    The details of the speaker search task.

• On failure, responds with SdkError<GetSpeakerSearchTaskError>

impl Client

pub fn get_voice_tone_analysis_task( &self, ) -> GetVoiceToneAnalysisTaskFluentBuilder

Constructs a fluent builder for the GetVoiceToneAnalysisTask operation.

• The fluent builder is configurable:
  • identifier(impl Into<String>) / set_identifier(Option<String>):
    required: true
    

    The unique identifier of the resource to be updated. Valid values include the ID and ARN of the media insights pipeline.

    
    
  • voice_tone_analysis_task_id(impl Into<String>) / set_voice_tone_analysis_task_id(Option<String>):
    required: true
    

    The ID of the voice tone analysis task.

    
    
• On success, responds with GetVoiceToneAnalysisTaskOutput with field(s):
  • voice_tone_analysis_task(Option<VoiceToneAnalysisTask>):

    The details of the voice tone analysis task.

• On failure, responds with SdkError<GetVoiceToneAnalysisTaskError>

impl Client

pub fn list_media_capture_pipelines( &self, ) -> ListMediaCapturePipelinesFluentBuilder

Constructs a fluent builder for the ListMediaCapturePipelines operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token used to retrieve the next page of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in a single call. Valid Range: 1 - 99.

    
    
• On success, responds with ListMediaCapturePipelinesOutput with field(s):
  • media_capture_pipelines(Option<Vec::<MediaCapturePipelineSummary>>):

    The media pipeline objects in the list.

  • next_token(Option<String>):

    The token used to retrieve the next page of results.

• On failure, responds with SdkError<ListMediaCapturePipelinesError>

impl Client

pub fn list_media_insights_pipeline_configurations( &self, ) -> ListMediaInsightsPipelineConfigurationsFluentBuilder

Constructs a fluent builder for the ListMediaInsightsPipelineConfigurations operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token used to return the next page of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in a single call.

    
    
• On success, responds with ListMediaInsightsPipelineConfigurationsOutput with field(s):
  • media_insights_pipeline_configurations(Option<Vec::<MediaInsightsPipelineConfigurationSummary>>):

    The requested list of media insights pipeline configurations.

  • next_token(Option<String>):

    The token used to return the next page of results.

• On failure, responds with SdkError<ListMediaInsightsPipelineConfigurationsError>

impl Client

pub fn list_media_pipeline_kinesis_video_stream_pools( &self, ) -> ListMediaPipelineKinesisVideoStreamPoolsFluentBuilder

Constructs a fluent builder for the ListMediaPipelineKinesisVideoStreamPools operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token used to return the next page of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in a single call.

    
    
• On success, responds with ListMediaPipelineKinesisVideoStreamPoolsOutput with field(s):
  • kinesis_video_stream_pools(Option<Vec::<KinesisVideoStreamPoolSummary>>):

    The list of video stream pools.

  • next_token(Option<String>):

    The token used to return the next page of results.

• On failure, responds with SdkError<ListMediaPipelineKinesisVideoStreamPoolsError>

impl Client

pub fn list_media_pipelines(&self) -> ListMediaPipelinesFluentBuilder

Constructs a fluent builder for the ListMediaPipelines operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token used to retrieve the next page of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in a single call. Valid Range: 1 - 99.

    
    
• On success, responds with ListMediaPipelinesOutput with field(s):
  • media_pipelines(Option<Vec::<MediaPipelineSummary>>):

    The media pipeline objects in the list.

  • next_token(Option<String>):

    The token used to retrieve the next page of results.

• On failure, responds with SdkError<ListMediaPipelinesError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The ARN of the media pipeline associated with any tags. The ARN consists of the pipeline’s region, resource ID, and pipeline ID.

    
    
• On success, responds with ListTagsForResourceOutput with field(s):
  • tags(Option<Vec::<Tag>>):

    The tags associated with the specified media pipeline.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn start_speaker_search_task(&self) -> StartSpeakerSearchTaskFluentBuilder

Constructs a fluent builder for the StartSpeakerSearchTask operation.

• The fluent builder is configurable:
  • identifier(impl Into<String>) / set_identifier(Option<String>):
    required: true
    

    The unique identifier of the resource to be updated. Valid values include the ID and ARN of the media insights pipeline.

    
    
  • voice_profile_domain_arn(impl Into<String>) / set_voice_profile_domain_arn(Option<String>):
    required: true
    

    The ARN of the voice profile domain that will store the voice profile.

    
    
  • kinesis_video_stream_source_task_configuration(KinesisVideoStreamSourceTaskConfiguration) / set_kinesis_video_stream_source_task_configuration(Option<KinesisVideoStreamSourceTaskConfiguration>):
    required: false
    

    The task configuration for the Kinesis video stream source of the media insights pipeline.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: false
    

    The unique identifier for the client request. Use a different token for different speaker search tasks.

    
    
• On success, responds with StartSpeakerSearchTaskOutput with field(s):
  • speaker_search_task(Option<SpeakerSearchTask>):

    The details of the speaker search task.

• On failure, responds with SdkError<StartSpeakerSearchTaskError>

impl Client

pub fn start_voice_tone_analysis_task( &self, ) -> StartVoiceToneAnalysisTaskFluentBuilder

Constructs a fluent builder for the StartVoiceToneAnalysisTask operation.

• The fluent builder is configurable:
  • identifier(impl Into<String>) / set_identifier(Option<String>):
    required: true
    

    The unique identifier of the resource to be updated. Valid values include the ID and ARN of the media insights pipeline.

    
    
  • language_code(VoiceAnalyticsLanguageCode) / set_language_code(Option<VoiceAnalyticsLanguageCode>):
    required: true
    

    The language code.

    
    
  • kinesis_video_stream_source_task_configuration(KinesisVideoStreamSourceTaskConfiguration) / set_kinesis_video_stream_source_task_configuration(Option<KinesisVideoStreamSourceTaskConfiguration>):
    required: false
    

    The task configuration for the Kinesis video stream source of the media insights pipeline.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: false
    

    The unique identifier for the client request. Use a different token for different voice tone analysis tasks.

    
    
• On success, responds with StartVoiceToneAnalysisTaskOutput with field(s):
  • voice_tone_analysis_task(Option<VoiceToneAnalysisTask>):

    The details of the voice tone analysis task.

• On failure, responds with SdkError<StartVoiceToneAnalysisTaskError>

impl Client

pub fn stop_speaker_search_task(&self) -> StopSpeakerSearchTaskFluentBuilder

Constructs a fluent builder for the StopSpeakerSearchTask operation.

• The fluent builder is configurable:
  • identifier(impl Into<String>) / set_identifier(Option<String>):
    required: true
    

    The unique identifier of the resource to be updated. Valid values include the ID and ARN of the media insights pipeline.

    
    
  • speaker_search_task_id(impl Into<String>) / set_speaker_search_task_id(Option<String>):
    required: true
    

    The speaker search task ID.

    
    
• On success, responds with StopSpeakerSearchTaskOutput
• On failure, responds with SdkError<StopSpeakerSearchTaskError>

impl Client

pub fn stop_voice_tone_analysis_task( &self, ) -> StopVoiceToneAnalysisTaskFluentBuilder

Constructs a fluent builder for the StopVoiceToneAnalysisTask operation.

• The fluent builder is configurable:
  • identifier(impl Into<String>) / set_identifier(Option<String>):
    required: true
    

    The unique identifier of the resource to be updated. Valid values include the ID and ARN of the media insights pipeline.

    
    
  • voice_tone_analysis_task_id(impl Into<String>) / set_voice_tone_analysis_task_id(Option<String>):
    required: true
    

    The ID of the voice tone analysis task.

    
    
• On success, responds with StopVoiceToneAnalysisTaskOutput
• On failure, responds with SdkError<StopVoiceToneAnalysisTaskError>

impl Client

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    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(Tag) / set_tags(Option<Vec::<Tag>>):
    required: true
    

    The tags associated with the specified media pipeline.

    
    
• On success, responds with TagResourceOutput
• On failure, responds with SdkError<TagResourceError>

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The ARN of the pipeline that you want to untag.

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: true
    

    The key/value pairs in the tag that you want to remove.

    
    
• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

impl Client

pub fn update_media_insights_pipeline_configuration( &self, ) -> UpdateMediaInsightsPipelineConfigurationFluentBuilder

Constructs a fluent builder for the UpdateMediaInsightsPipelineConfiguration operation.

• The fluent builder is configurable:
  • identifier(impl Into<String>) / set_identifier(Option<String>):
    required: true
    

    The unique identifier for the resource to be updated. Valid values include the name and ARN of the media insights pipeline configuration.

    
    
  • resource_access_role_arn(impl Into<String>) / set_resource_access_role_arn(Option<String>):
    required: true
    

    The ARN of the role used by the service to access Amazon Web Services resources.

    
    
  • real_time_alert_configuration(RealTimeAlertConfiguration) / set_real_time_alert_configuration(Option<RealTimeAlertConfiguration>):
    required: false
    

    The configuration settings for real-time alerts for the media insights pipeline.

    
    
  • elements(MediaInsightsPipelineConfigurationElement) / set_elements(Option<Vec::<MediaInsightsPipelineConfigurationElement>>):
    required: true
    

    The elements in the request, such as a processor for Amazon Transcribe or a sink for a Kinesis Data Stream..

    
    
• On success, responds with UpdateMediaInsightsPipelineConfigurationOutput with field(s):
  • media_insights_pipeline_configuration(Option<MediaInsightsPipelineConfiguration>):

    The updated configuration settings.

• On failure, responds with SdkError<UpdateMediaInsightsPipelineConfigurationError>

impl Client

pub fn update_media_insights_pipeline_status( &self, ) -> UpdateMediaInsightsPipelineStatusFluentBuilder

Constructs a fluent builder for the UpdateMediaInsightsPipelineStatus operation.

• The fluent builder is configurable:
  • identifier(impl Into<String>) / set_identifier(Option<String>):
    required: true
    

    The unique identifier of the resource to be updated. Valid values include the ID and ARN of the media insights pipeline.

    
    
  • update_status(MediaPipelineStatusUpdate) / set_update_status(Option<MediaPipelineStatusUpdate>):
    required: true
    

    The requested status of the media insights pipeline.

    
    
• On success, responds with UpdateMediaInsightsPipelineStatusOutput
• On failure, responds with SdkError<UpdateMediaInsightsPipelineStatusError>

impl Client

pub fn update_media_pipeline_kinesis_video_stream_pool( &self, ) -> UpdateMediaPipelineKinesisVideoStreamPoolFluentBuilder

Constructs a fluent builder for the UpdateMediaPipelineKinesisVideoStreamPool operation.

• The fluent builder is configurable:
  • identifier(impl Into<String>) / set_identifier(Option<String>):
    required: true
    

    The unique identifier of the requested resource. Valid values include the name and ARN of the media pipeline Kinesis Video Stream pool.

    
    
  • stream_configuration(KinesisVideoStreamConfigurationUpdate) / set_stream_configuration(Option<KinesisVideoStreamConfigurationUpdate>):
    required: false
    

    The configuration settings for the video stream.

    
    
• On success, responds with UpdateMediaPipelineKinesisVideoStreamPoolOutput with field(s):
  • kinesis_video_stream_pool_configuration(Option<KinesisVideoStreamPoolConfiguration>):

    The video stream pool configuration object.

• On failure, responds with SdkError<UpdateMediaPipelineKinesisVideoStreamPoolError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.