ChimeSDKMediaPipelinesClient

Index > ChimeSDKMediaPipelines > ChimeSDKMediaPipelinesClient

Auto-generated documentation for ChimeSDKMediaPipelines type annotations stubs module mypy-boto3-chime-sdk-media-pipelines.

ChimeSDKMediaPipelinesClient

Type annotations and code completion for boto3.client("chime-sdk-media-pipelines"). boto3 documentation

# ChimeSDKMediaPipelinesClient usage example

from boto3.session import Session
from mypy_boto3_chime_sdk_media_pipelines.client import ChimeSDKMediaPipelinesClient

def get_chime-sdk-media-pipelines_client() -> ChimeSDKMediaPipelinesClient:
    return Session().client("chime-sdk-media-pipelines")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("chime-sdk-media-pipelines").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("chime-sdk-media-pipelines")

try:
    do_something(client)
except (
    client.exceptions.BadRequestException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.ForbiddenException,
    client.exceptions.NotFoundException,
    client.exceptions.ResourceLimitExceededException,
    client.exceptions.ServiceFailureException,
    client.exceptions.ServiceUnavailableException,
    client.exceptions.ThrottledClientException,
    client.exceptions.UnauthorizedClientException,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from mypy_boto3_chime_sdk_media_pipelines.client import Exceptions

def handle_error(exc: Exceptions.BadRequestException) -> None:
    ...

Methods

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("chime-sdk-media-pipelines").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("chime-sdk-media-pipelines").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

create_media_capture_pipeline

Creates a media pipeline.

Type annotations and code completion for boto3.client("chime-sdk-media-pipelines").create_media_capture_pipeline method. boto3 documentation

# create_media_capture_pipeline method definition

def create_media_capture_pipeline(
    self,
    *,
    SourceType: MediaPipelineSourceTypeType,  # (1)
    SourceArn: str,
    SinkType: MediaPipelineSinkTypeType,  # (2)
    SinkArn: str,
    ClientRequestToken: str = ...,
    ChimeSdkMeetingConfiguration: ChimeSdkMeetingConfigurationTypeDef = ...,  # (3)
    SseAwsKeyManagementParams: SseAwsKeyManagementParamsTypeDef = ...,  # (4)
    SinkIamRoleArn: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (5)
) -> CreateMediaCapturePipelineResponseTypeDef:  # (6)
    ...

1. See MediaPipelineSourceTypeType
2. See MediaPipelineSinkTypeType
3. See ChimeSdkMeetingConfigurationTypeDef
4. See SseAwsKeyManagementParamsTypeDef
5. See TagTypeDef
6. See CreateMediaCapturePipelineResponseTypeDef

# create_media_capture_pipeline method usage example with argument unpacking

kwargs: CreateMediaCapturePipelineRequestRequestTypeDef = {  # (1)
    "SourceType": ...,
    "SourceArn": ...,
    "SinkType": ...,
    "SinkArn": ...,
}

parent.create_media_capture_pipeline(**kwargs)

1. See CreateMediaCapturePipelineRequestRequestTypeDef

create_media_concatenation_pipeline

Creates a media concatenation pipeline.

Type annotations and code completion for boto3.client("chime-sdk-media-pipelines").create_media_concatenation_pipeline method. boto3 documentation

# create_media_concatenation_pipeline method definition

def create_media_concatenation_pipeline(
    self,
    *,
    Sources: Sequence[ConcatenationSourceTypeDef],  # (1)
    Sinks: Sequence[ConcatenationSinkTypeDef],  # (2)
    ClientRequestToken: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (3)
) -> CreateMediaConcatenationPipelineResponseTypeDef:  # (4)
    ...

1. See ConcatenationSourceTypeDef
2. See ConcatenationSinkTypeDef
3. See TagTypeDef
4. See CreateMediaConcatenationPipelineResponseTypeDef

# create_media_concatenation_pipeline method usage example with argument unpacking

kwargs: CreateMediaConcatenationPipelineRequestRequestTypeDef = {  # (1)
    "Sources": ...,
    "Sinks": ...,
}

parent.create_media_concatenation_pipeline(**kwargs)

1. See CreateMediaConcatenationPipelineRequestRequestTypeDef

create_media_insights_pipeline

Creates a media insights pipeline.

Type annotations and code completion for boto3.client("chime-sdk-media-pipelines").create_media_insights_pipeline method. boto3 documentation

# create_media_insights_pipeline method definition

def create_media_insights_pipeline(
    self,
    *,
    MediaInsightsPipelineConfigurationArn: str,
    KinesisVideoStreamSourceRuntimeConfiguration: KinesisVideoStreamSourceRuntimeConfigurationTypeDef = ...,  # (1)
    MediaInsightsRuntimeMetadata: Mapping[str, str] = ...,
    KinesisVideoStreamRecordingSourceRuntimeConfiguration: KinesisVideoStreamRecordingSourceRuntimeConfigurationTypeDef = ...,  # (2)
    S3RecordingSinkRuntimeConfiguration: S3RecordingSinkRuntimeConfigurationTypeDef = ...,  # (3)
    Tags: Sequence[TagTypeDef] = ...,  # (4)
    ClientRequestToken: str = ...,
) -> CreateMediaInsightsPipelineResponseTypeDef:  # (5)
    ...

1. See KinesisVideoStreamSourceRuntimeConfigurationTypeDef
2. See KinesisVideoStreamRecordingSourceRuntimeConfigurationTypeDef
3. See S3RecordingSinkRuntimeConfigurationTypeDef
4. See TagTypeDef
5. See CreateMediaInsightsPipelineResponseTypeDef

# create_media_insights_pipeline method usage example with argument unpacking

kwargs: CreateMediaInsightsPipelineRequestRequestTypeDef = {  # (1)
    "MediaInsightsPipelineConfigurationArn": ...,
}

parent.create_media_insights_pipeline(**kwargs)

1. See CreateMediaInsightsPipelineRequestRequestTypeDef

create_media_insights_pipeline_configuration

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

Type annotations and code completion for boto3.client("chime-sdk-media-pipelines").create_media_insights_pipeline_configuration method. boto3 documentation

# create_media_insights_pipeline_configuration method definition

def create_media_insights_pipeline_configuration(
    self,
    *,
    MediaInsightsPipelineConfigurationName: str,
    ResourceAccessRoleArn: str,
    Elements: Sequence[MediaInsightsPipelineConfigurationElementUnionTypeDef],  # (1)
    RealTimeAlertConfiguration: RealTimeAlertConfigurationTypeDef = ...,  # (2)
    Tags: Sequence[TagTypeDef] = ...,  # (3)
    ClientRequestToken: str = ...,
) -> CreateMediaInsightsPipelineConfigurationResponseTypeDef:  # (4)
    ...

1. See MediaInsightsPipelineConfigurationElementTypeDef MediaInsightsPipelineConfigurationElementOutputTypeDef
2. See RealTimeAlertConfigurationTypeDef
3. See TagTypeDef
4. See CreateMediaInsightsPipelineConfigurationResponseTypeDef

# create_media_insights_pipeline_configuration method usage example with argument unpacking

kwargs: CreateMediaInsightsPipelineConfigurationRequestRequestTypeDef = {  # (1)
    "MediaInsightsPipelineConfigurationName": ...,
    "ResourceAccessRoleArn": ...,
    "Elements": ...,
}

parent.create_media_insights_pipeline_configuration(**kwargs)

1. See CreateMediaInsightsPipelineConfigurationRequestRequestTypeDef

create_media_live_connector_pipeline

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

Type annotations and code completion for boto3.client("chime-sdk-media-pipelines").create_media_live_connector_pipeline method. boto3 documentation

# create_media_live_connector_pipeline method definition

def create_media_live_connector_pipeline(
    self,
    *,
    Sources: Sequence[LiveConnectorSourceConfigurationUnionTypeDef],  # (1)
    Sinks: Sequence[LiveConnectorSinkConfigurationTypeDef],  # (2)
    ClientRequestToken: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (3)
) -> CreateMediaLiveConnectorPipelineResponseTypeDef:  # (4)
    ...

1. See LiveConnectorSourceConfigurationTypeDef LiveConnectorSourceConfigurationOutputTypeDef
2. See LiveConnectorSinkConfigurationTypeDef
3. See TagTypeDef
4. See CreateMediaLiveConnectorPipelineResponseTypeDef

# create_media_live_connector_pipeline method usage example with argument unpacking

kwargs: CreateMediaLiveConnectorPipelineRequestRequestTypeDef = {  # (1)
    "Sources": ...,
    "Sinks": ...,
}

parent.create_media_live_connector_pipeline(**kwargs)

1. See CreateMediaLiveConnectorPipelineRequestRequestTypeDef

create_media_pipeline_kinesis_video_stream_pool

Creates an Amazon Kinesis Video Stream pool for use with media stream pipelines.

Type annotations and code completion for boto3.client("chime-sdk-media-pipelines").create_media_pipeline_kinesis_video_stream_pool method. boto3 documentation

# create_media_pipeline_kinesis_video_stream_pool method definition

def create_media_pipeline_kinesis_video_stream_pool(
    self,
    *,
    StreamConfiguration: KinesisVideoStreamConfigurationTypeDef,  # (1)
    PoolName: str,
    ClientRequestToken: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateMediaPipelineKinesisVideoStreamPoolResponseTypeDef:  # (3)
    ...

1. See KinesisVideoStreamConfigurationTypeDef
2. See TagTypeDef
3. See CreateMediaPipelineKinesisVideoStreamPoolResponseTypeDef

# create_media_pipeline_kinesis_video_stream_pool method usage example with argument unpacking

kwargs: CreateMediaPipelineKinesisVideoStreamPoolRequestRequestTypeDef = {  # (1)
    "StreamConfiguration": ...,
    "PoolName": ...,
}

parent.create_media_pipeline_kinesis_video_stream_pool(**kwargs)

1. See CreateMediaPipelineKinesisVideoStreamPoolRequestRequestTypeDef

create_media_stream_pipeline

Creates a streaming media pipeline.

Type annotations and code completion for boto3.client("chime-sdk-media-pipelines").create_media_stream_pipeline method. boto3 documentation

# create_media_stream_pipeline method definition

def create_media_stream_pipeline(
    self,
    *,
    Sources: Sequence[MediaStreamSourceTypeDef],  # (1)
    Sinks: Sequence[MediaStreamSinkTypeDef],  # (2)
    ClientRequestToken: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (3)
) -> CreateMediaStreamPipelineResponseTypeDef:  # (4)
    ...

1. See MediaStreamSourceTypeDef
2. See MediaStreamSinkTypeDef
3. See TagTypeDef
4. See CreateMediaStreamPipelineResponseTypeDef

# create_media_stream_pipeline method usage example with argument unpacking

kwargs: CreateMediaStreamPipelineRequestRequestTypeDef = {  # (1)
    "Sources": ...,
    "Sinks": ...,
}

parent.create_media_stream_pipeline(**kwargs)

1. See CreateMediaStreamPipelineRequestRequestTypeDef

delete_media_capture_pipeline

Deletes the media pipeline.

Type annotations and code completion for boto3.client("chime-sdk-media-pipelines").delete_media_capture_pipeline method. boto3 documentation

# delete_media_capture_pipeline method definition

def delete_media_capture_pipeline(
    self,
    *,
    MediaPipelineId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_media_capture_pipeline method usage example with argument unpacking

kwargs: DeleteMediaCapturePipelineRequestRequestTypeDef = {  # (1)
    "MediaPipelineId": ...,
}

parent.delete_media_capture_pipeline(**kwargs)

1. See DeleteMediaCapturePipelineRequestRequestTypeDef

delete_media_insights_pipeline_configuration

Deletes the specified configuration settings.

Type annotations and code completion for boto3.client("chime-sdk-media-pipelines").delete_media_insights_pipeline_configuration method. boto3 documentation

# delete_media_insights_pipeline_configuration method definition

def delete_media_insights_pipeline_configuration(
    self,
    *,
    Identifier: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_media_insights_pipeline_configuration method usage example with argument unpacking

kwargs: DeleteMediaInsightsPipelineConfigurationRequestRequestTypeDef = {  # (1)
    "Identifier": ...,
}

parent.delete_media_insights_pipeline_configuration(**kwargs)

1. See DeleteMediaInsightsPipelineConfigurationRequestRequestTypeDef

delete_media_pipeline

Deletes the media pipeline.

Type annotations and code completion for boto3.client("chime-sdk-media-pipelines").delete_media_pipeline method. boto3 documentation

# delete_media_pipeline method definition

def delete_media_pipeline(
    self,
    *,
    MediaPipelineId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_media_pipeline method usage example with argument unpacking

kwargs: DeleteMediaPipelineRequestRequestTypeDef = {  # (1)
    "MediaPipelineId": ...,
}

parent.delete_media_pipeline(**kwargs)

1. See DeleteMediaPipelineRequestRequestTypeDef

delete_media_pipeline_kinesis_video_stream_pool

Deletes an Amazon Kinesis Video Stream pool.

Type annotations and code completion for boto3.client("chime-sdk-media-pipelines").delete_media_pipeline_kinesis_video_stream_pool method. boto3 documentation

# delete_media_pipeline_kinesis_video_stream_pool method definition

def delete_media_pipeline_kinesis_video_stream_pool(
    self,
    *,
    Identifier: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_media_pipeline_kinesis_video_stream_pool method usage example with argument unpacking

kwargs: DeleteMediaPipelineKinesisVideoStreamPoolRequestRequestTypeDef = {  # (1)
    "Identifier": ...,
}

parent.delete_media_pipeline_kinesis_video_stream_pool(**kwargs)

1. See DeleteMediaPipelineKinesisVideoStreamPoolRequestRequestTypeDef

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("chime-sdk-media-pipelines").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

get_media_capture_pipeline

Gets an existing media pipeline.

Type annotations and code completion for boto3.client("chime-sdk-media-pipelines").get_media_capture_pipeline method. boto3 documentation

# get_media_capture_pipeline method definition

def get_media_capture_pipeline(
    self,
    *,
    MediaPipelineId: str,
) -> GetMediaCapturePipelineResponseTypeDef:  # (1)
    ...

1. See GetMediaCapturePipelineResponseTypeDef

# get_media_capture_pipeline method usage example with argument unpacking

kwargs: GetMediaCapturePipelineRequestRequestTypeDef = {  # (1)
    "MediaPipelineId": ...,
}

parent.get_media_capture_pipeline(**kwargs)

1. See GetMediaCapturePipelineRequestRequestTypeDef

get_media_insights_pipeline_configuration

Gets the configuration settings for a media insights pipeline.

Type annotations and code completion for boto3.client("chime-sdk-media-pipelines").get_media_insights_pipeline_configuration method. boto3 documentation

# get_media_insights_pipeline_configuration method definition

def get_media_insights_pipeline_configuration(
    self,
    *,
    Identifier: str,
) -> GetMediaInsightsPipelineConfigurationResponseTypeDef:  # (1)
    ...

1. See GetMediaInsightsPipelineConfigurationResponseTypeDef

# get_media_insights_pipeline_configuration method usage example with argument unpacking

kwargs: GetMediaInsightsPipelineConfigurationRequestRequestTypeDef = {  # (1)
    "Identifier": ...,
}

parent.get_media_insights_pipeline_configuration(**kwargs)

1. See GetMediaInsightsPipelineConfigurationRequestRequestTypeDef

get_media_pipeline

Gets an existing media pipeline.

Type annotations and code completion for boto3.client("chime-sdk-media-pipelines").get_media_pipeline method. boto3 documentation

# get_media_pipeline method definition

def get_media_pipeline(
    self,
    *,
    MediaPipelineId: str,
) -> GetMediaPipelineResponseTypeDef:  # (1)
    ...

1. See GetMediaPipelineResponseTypeDef

# get_media_pipeline method usage example with argument unpacking

kwargs: GetMediaPipelineRequestRequestTypeDef = {  # (1)
    "MediaPipelineId": ...,
}

parent.get_media_pipeline(**kwargs)

1. See GetMediaPipelineRequestRequestTypeDef

get_media_pipeline_kinesis_video_stream_pool

Gets an Kinesis video stream pool.

Type annotations and code completion for boto3.client("chime-sdk-media-pipelines").get_media_pipeline_kinesis_video_stream_pool method. boto3 documentation

# get_media_pipeline_kinesis_video_stream_pool method definition

def get_media_pipeline_kinesis_video_stream_pool(
    self,
    *,
    Identifier: str,
) -> GetMediaPipelineKinesisVideoStreamPoolResponseTypeDef:  # (1)
    ...

1. See GetMediaPipelineKinesisVideoStreamPoolResponseTypeDef

# get_media_pipeline_kinesis_video_stream_pool method usage example with argument unpacking

kwargs: GetMediaPipelineKinesisVideoStreamPoolRequestRequestTypeDef = {  # (1)
    "Identifier": ...,
}

parent.get_media_pipeline_kinesis_video_stream_pool(**kwargs)

1. See GetMediaPipelineKinesisVideoStreamPoolRequestRequestTypeDef

get_speaker_search_task

Retrieves the details of the specified speaker search task.

Type annotations and code completion for boto3.client("chime-sdk-media-pipelines").get_speaker_search_task method. boto3 documentation

# get_speaker_search_task method definition

def get_speaker_search_task(
    self,
    *,
    Identifier: str,
    SpeakerSearchTaskId: str,
) -> GetSpeakerSearchTaskResponseTypeDef:  # (1)
    ...

1. See GetSpeakerSearchTaskResponseTypeDef

# get_speaker_search_task method usage example with argument unpacking

kwargs: GetSpeakerSearchTaskRequestRequestTypeDef = {  # (1)
    "Identifier": ...,
    "SpeakerSearchTaskId": ...,
}

parent.get_speaker_search_task(**kwargs)

1. See GetSpeakerSearchTaskRequestRequestTypeDef

get_voice_tone_analysis_task

Retrieves the details of a voice tone analysis task.

Type annotations and code completion for boto3.client("chime-sdk-media-pipelines").get_voice_tone_analysis_task method. boto3 documentation

# get_voice_tone_analysis_task method definition

def get_voice_tone_analysis_task(
    self,
    *,
    Identifier: str,
    VoiceToneAnalysisTaskId: str,
) -> GetVoiceToneAnalysisTaskResponseTypeDef:  # (1)
    ...

1. See GetVoiceToneAnalysisTaskResponseTypeDef

# get_voice_tone_analysis_task method usage example with argument unpacking

kwargs: GetVoiceToneAnalysisTaskRequestRequestTypeDef = {  # (1)
    "Identifier": ...,
    "VoiceToneAnalysisTaskId": ...,
}

parent.get_voice_tone_analysis_task(**kwargs)

1. See GetVoiceToneAnalysisTaskRequestRequestTypeDef

list_media_capture_pipelines

Returns a list of media pipelines.

Type annotations and code completion for boto3.client("chime-sdk-media-pipelines").list_media_capture_pipelines method. boto3 documentation

# list_media_capture_pipelines method definition

def list_media_capture_pipelines(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListMediaCapturePipelinesResponseTypeDef:  # (1)
    ...

1. See ListMediaCapturePipelinesResponseTypeDef

# list_media_capture_pipelines method usage example with argument unpacking

kwargs: ListMediaCapturePipelinesRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_media_capture_pipelines(**kwargs)

1. See ListMediaCapturePipelinesRequestRequestTypeDef

list_media_insights_pipeline_configurations

Lists the available media insights pipeline configurations.

Type annotations and code completion for boto3.client("chime-sdk-media-pipelines").list_media_insights_pipeline_configurations method. boto3 documentation

# list_media_insights_pipeline_configurations method definition

def list_media_insights_pipeline_configurations(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListMediaInsightsPipelineConfigurationsResponseTypeDef:  # (1)
    ...

1. See ListMediaInsightsPipelineConfigurationsResponseTypeDef

# list_media_insights_pipeline_configurations method usage example with argument unpacking

kwargs: ListMediaInsightsPipelineConfigurationsRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_media_insights_pipeline_configurations(**kwargs)

1. See ListMediaInsightsPipelineConfigurationsRequestRequestTypeDef

list_media_pipeline_kinesis_video_stream_pools

Lists the video stream pools in the media pipeline.

Type annotations and code completion for boto3.client("chime-sdk-media-pipelines").list_media_pipeline_kinesis_video_stream_pools method. boto3 documentation

# list_media_pipeline_kinesis_video_stream_pools method definition

def list_media_pipeline_kinesis_video_stream_pools(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListMediaPipelineKinesisVideoStreamPoolsResponseTypeDef:  # (1)
    ...

1. See ListMediaPipelineKinesisVideoStreamPoolsResponseTypeDef

# list_media_pipeline_kinesis_video_stream_pools method usage example with argument unpacking

kwargs: ListMediaPipelineKinesisVideoStreamPoolsRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_media_pipeline_kinesis_video_stream_pools(**kwargs)

1. See ListMediaPipelineKinesisVideoStreamPoolsRequestRequestTypeDef

list_media_pipelines

Returns a list of media pipelines.

Type annotations and code completion for boto3.client("chime-sdk-media-pipelines").list_media_pipelines method. boto3 documentation

# list_media_pipelines method definition

def list_media_pipelines(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListMediaPipelinesResponseTypeDef:  # (1)
    ...

1. See ListMediaPipelinesResponseTypeDef

# list_media_pipelines method usage example with argument unpacking

kwargs: ListMediaPipelinesRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_media_pipelines(**kwargs)

1. See ListMediaPipelinesRequestRequestTypeDef

list_tags_for_resource

Lists the tags available for a media pipeline.

Type annotations and code completion for boto3.client("chime-sdk-media-pipelines").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    ResourceARN: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...

1. See ListTagsForResourceResponseTypeDef

# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "ResourceARN": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestRequestTypeDef

start_speaker_search_task

Starts a speaker search task.

Type annotations and code completion for boto3.client("chime-sdk-media-pipelines").start_speaker_search_task method. boto3 documentation

# start_speaker_search_task method definition

def start_speaker_search_task(
    self,
    *,
    Identifier: str,
    VoiceProfileDomainArn: str,
    KinesisVideoStreamSourceTaskConfiguration: KinesisVideoStreamSourceTaskConfigurationTypeDef = ...,  # (1)
    ClientRequestToken: str = ...,
) -> StartSpeakerSearchTaskResponseTypeDef:  # (2)
    ...

1. See KinesisVideoStreamSourceTaskConfigurationTypeDef
2. See StartSpeakerSearchTaskResponseTypeDef

# start_speaker_search_task method usage example with argument unpacking

kwargs: StartSpeakerSearchTaskRequestRequestTypeDef = {  # (1)
    "Identifier": ...,
    "VoiceProfileDomainArn": ...,
}

parent.start_speaker_search_task(**kwargs)

1. See StartSpeakerSearchTaskRequestRequestTypeDef

start_voice_tone_analysis_task

Starts a voice tone analysis task.

Type annotations and code completion for boto3.client("chime-sdk-media-pipelines").start_voice_tone_analysis_task method. boto3 documentation

# start_voice_tone_analysis_task method definition

def start_voice_tone_analysis_task(
    self,
    *,
    Identifier: str,
    LanguageCode: VoiceAnalyticsLanguageCodeType,  # (1)
    KinesisVideoStreamSourceTaskConfiguration: KinesisVideoStreamSourceTaskConfigurationTypeDef = ...,  # (2)
    ClientRequestToken: str = ...,
) -> StartVoiceToneAnalysisTaskResponseTypeDef:  # (3)
    ...

1. See VoiceAnalyticsLanguageCodeType
2. See KinesisVideoStreamSourceTaskConfigurationTypeDef
3. See StartVoiceToneAnalysisTaskResponseTypeDef

# start_voice_tone_analysis_task method usage example with argument unpacking

kwargs: StartVoiceToneAnalysisTaskRequestRequestTypeDef = {  # (1)
    "Identifier": ...,
    "LanguageCode": ...,
}

parent.start_voice_tone_analysis_task(**kwargs)

1. See StartVoiceToneAnalysisTaskRequestRequestTypeDef

stop_speaker_search_task

Stops a speaker search task.

Type annotations and code completion for boto3.client("chime-sdk-media-pipelines").stop_speaker_search_task method. boto3 documentation

# stop_speaker_search_task method definition

def stop_speaker_search_task(
    self,
    *,
    Identifier: str,
    SpeakerSearchTaskId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# stop_speaker_search_task method usage example with argument unpacking

kwargs: StopSpeakerSearchTaskRequestRequestTypeDef = {  # (1)
    "Identifier": ...,
    "SpeakerSearchTaskId": ...,
}

parent.stop_speaker_search_task(**kwargs)

1. See StopSpeakerSearchTaskRequestRequestTypeDef

stop_voice_tone_analysis_task

Stops a voice tone analysis task.

Type annotations and code completion for boto3.client("chime-sdk-media-pipelines").stop_voice_tone_analysis_task method. boto3 documentation

# stop_voice_tone_analysis_task method definition

def stop_voice_tone_analysis_task(
    self,
    *,
    Identifier: str,
    VoiceToneAnalysisTaskId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# stop_voice_tone_analysis_task method usage example with argument unpacking

kwargs: StopVoiceToneAnalysisTaskRequestRequestTypeDef = {  # (1)
    "Identifier": ...,
    "VoiceToneAnalysisTaskId": ...,
}

parent.stop_voice_tone_analysis_task(**kwargs)

1. See StopVoiceToneAnalysisTaskRequestRequestTypeDef

tag_resource

The ARN of the media pipeline that you want to tag.

Type annotations and code completion for boto3.client("chime-sdk-media-pipelines").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    ResourceARN: str,
    Tags: Sequence[TagTypeDef],  # (1)
) -> Dict[str, Any]:
    ...

1. See TagTypeDef

# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "ResourceARN": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestRequestTypeDef

untag_resource

Removes any tags from a media pipeline.

Type annotations and code completion for boto3.client("chime-sdk-media-pipelines").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    ResourceARN: str,
    TagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...

# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "ResourceARN": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestRequestTypeDef

update_media_insights_pipeline_configuration

Updates the media insights pipeline's configuration settings.

Type annotations and code completion for boto3.client("chime-sdk-media-pipelines").update_media_insights_pipeline_configuration method. boto3 documentation

# update_media_insights_pipeline_configuration method definition

def update_media_insights_pipeline_configuration(
    self,
    *,
    Identifier: str,
    ResourceAccessRoleArn: str,
    Elements: Sequence[MediaInsightsPipelineConfigurationElementTypeDef],  # (1)
    RealTimeAlertConfiguration: RealTimeAlertConfigurationTypeDef = ...,  # (2)
) -> UpdateMediaInsightsPipelineConfigurationResponseTypeDef:  # (3)
    ...

1. See MediaInsightsPipelineConfigurationElementTypeDef
2. See RealTimeAlertConfigurationTypeDef
3. See UpdateMediaInsightsPipelineConfigurationResponseTypeDef

# update_media_insights_pipeline_configuration method usage example with argument unpacking

kwargs: UpdateMediaInsightsPipelineConfigurationRequestRequestTypeDef = {  # (1)
    "Identifier": ...,
    "ResourceAccessRoleArn": ...,
    "Elements": ...,
}

parent.update_media_insights_pipeline_configuration(**kwargs)

1. See UpdateMediaInsightsPipelineConfigurationRequestRequestTypeDef

update_media_insights_pipeline_status

Updates the status of a media insights pipeline.

Type annotations and code completion for boto3.client("chime-sdk-media-pipelines").update_media_insights_pipeline_status method. boto3 documentation

# update_media_insights_pipeline_status method definition

def update_media_insights_pipeline_status(
    self,
    *,
    Identifier: str,
    UpdateStatus: MediaPipelineStatusUpdateType,  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

1. See MediaPipelineStatusUpdateType
2. See EmptyResponseMetadataTypeDef

# update_media_insights_pipeline_status method usage example with argument unpacking

kwargs: UpdateMediaInsightsPipelineStatusRequestRequestTypeDef = {  # (1)
    "Identifier": ...,
    "UpdateStatus": ...,
}

parent.update_media_insights_pipeline_status(**kwargs)

1. See UpdateMediaInsightsPipelineStatusRequestRequestTypeDef

update_media_pipeline_kinesis_video_stream_pool

Updates an Amazon Kinesis Video Stream pool in a media pipeline.

Type annotations and code completion for boto3.client("chime-sdk-media-pipelines").update_media_pipeline_kinesis_video_stream_pool method. boto3 documentation

# update_media_pipeline_kinesis_video_stream_pool method definition

def update_media_pipeline_kinesis_video_stream_pool(
    self,
    *,
    Identifier: str,
    StreamConfiguration: KinesisVideoStreamConfigurationUpdateTypeDef = ...,  # (1)
) -> UpdateMediaPipelineKinesisVideoStreamPoolResponseTypeDef:  # (2)
    ...

1. See KinesisVideoStreamConfigurationUpdateTypeDef
2. See UpdateMediaPipelineKinesisVideoStreamPoolResponseTypeDef

# update_media_pipeline_kinesis_video_stream_pool method usage example with argument unpacking

kwargs: UpdateMediaPipelineKinesisVideoStreamPoolRequestRequestTypeDef = {  # (1)
    "Identifier": ...,
}

parent.update_media_pipeline_kinesis_video_stream_pool(**kwargs)

1. See UpdateMediaPipelineKinesisVideoStreamPoolRequestRequestTypeDef