Skip to content

ChimeSDKMediaPipelinesClient#

Index > ChimeSDKMediaPipelines > ChimeSDKMediaPipelinesClient

Auto-generated documentation for ChimeSDKMediaPipelines type annotations stubs module types-aiobotocore-chime-sdk-media-pipelines.

ChimeSDKMediaPipelinesClient#

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

ChimeSDKMediaPipelinesClient usage example

from aiobotocore.session import get_session
from types_aiobotocore_chime_sdk_media_pipelines.client import ChimeSDKMediaPipelinesClient

session = get_session()
async with session.create_client("chime-sdk-media-pipelines") as client:
    client: ChimeSDKMediaPipelinesClient

Exceptions#

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

ChimeSDKMediaPipelinesClient.exceptions usage example

async with session.create_client("chime-sdk-media-pipelines") as client:
    try:
        do_something(client)
    except (
            client.BadRequestException,
        client.ClientError,
        client.ConflictException,
        client.ForbiddenException,
        client.NotFoundException,
        client.ResourceLimitExceededException,
        client.ServiceFailureException,
        client.ServiceUnavailableException,
        client.ThrottledClientException,
        client.UnauthorizedClientException,
    ) as e:
        print(e)
ChimeSDKMediaPipelinesClient usage type checking example

from types_aiobotocore_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 session.create_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 session.create_client("chime-sdk-media-pipelines").close method. boto3 documentation

# close method definition

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

create_media_capture_pipeline#

Creates a media pipeline.

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

# create_media_capture_pipeline method definition

await def create_media_capture_pipeline(
    self,
    *,
    SourceType: MediaPipelineSourceTypeType,  # (1)
    SourceArn: str,
    SinkType: MediaPipelineSinkTypeType,  # (2)
    SinkArn: str,
    ClientRequestToken: str = ...,
    ChimeSdkMeetingConfiguration: ChimeSdkMeetingConfigurationTypeDef = ...,  # (3)
    Tags: Sequence[TagTypeDef] = ...,  # (4)
) -> CreateMediaCapturePipelineResponseTypeDef:  # (5)
    ...
  1. See MediaPipelineSourceTypeType
  2. See MediaPipelineSinkTypeType
  3. See ChimeSdkMeetingConfigurationTypeDef
  4. See TagTypeDef
  5. 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 session.create_client("chime-sdk-media-pipelines").create_media_concatenation_pipeline method. boto3 documentation

# create_media_concatenation_pipeline method definition

await 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 session.create_client("chime-sdk-media-pipelines").create_media_insights_pipeline method. boto3 documentation

# create_media_insights_pipeline method definition

await 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 session.create_client("chime-sdk-media-pipelines").create_media_insights_pipeline_configuration method. boto3 documentation

# create_media_insights_pipeline_configuration method definition

await def create_media_insights_pipeline_configuration(
    self,
    *,
    MediaInsightsPipelineConfigurationName: str,
    ResourceAccessRoleArn: str,
    Elements: Sequence[MediaInsightsPipelineConfigurationElementTypeDef],  # (1)
    RealTimeAlertConfiguration: RealTimeAlertConfigurationTypeDef = ...,  # (2)
    Tags: Sequence[TagTypeDef] = ...,  # (3)
    ClientRequestToken: str = ...,
) -> CreateMediaInsightsPipelineConfigurationResponseTypeDef:  # (4)
    ...
  1. See MediaInsightsPipelineConfigurationElementTypeDef
  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 session.create_client("chime-sdk-media-pipelines").create_media_live_connector_pipeline method. boto3 documentation

# create_media_live_connector_pipeline method definition

await def create_media_live_connector_pipeline(
    self,
    *,
    Sources: Sequence[LiveConnectorSourceConfigurationTypeDef],  # (1)
    Sinks: Sequence[LiveConnectorSinkConfigurationTypeDef],  # (2)
    ClientRequestToken: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (3)
) -> CreateMediaLiveConnectorPipelineResponseTypeDef:  # (4)
    ...
  1. See LiveConnectorSourceConfigurationTypeDef
  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

delete_media_capture_pipeline#

Deletes the media pipeline.

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

# delete_media_capture_pipeline method definition

await 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 session.create_client("chime-sdk-media-pipelines").delete_media_insights_pipeline_configuration method. boto3 documentation

# delete_media_insights_pipeline_configuration method definition

await 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 session.create_client("chime-sdk-media-pipelines").delete_media_pipeline method. boto3 documentation

# delete_media_pipeline method definition

await 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

generate_presigned_url#

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

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

# generate_presigned_url method definition

await 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 session.create_client("chime-sdk-media-pipelines").get_media_capture_pipeline method. boto3 documentation

# get_media_capture_pipeline method definition

await 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 session.create_client("chime-sdk-media-pipelines").get_media_insights_pipeline_configuration method. boto3 documentation

# get_media_insights_pipeline_configuration method definition

await 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 session.create_client("chime-sdk-media-pipelines").get_media_pipeline method. boto3 documentation

# get_media_pipeline method definition

await 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

list_media_capture_pipelines#

Returns a list of media pipelines.

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

# list_media_capture_pipelines method definition

await 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 session.create_client("chime-sdk-media-pipelines").list_media_insights_pipeline_configurations method. boto3 documentation

# list_media_insights_pipeline_configurations method definition

await 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_pipelines#

Returns a list of media pipelines.

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

# list_media_pipelines method definition

await 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 session.create_client("chime-sdk-media-pipelines").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

await 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

tag_resource#

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

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

# tag_resource method definition

await 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 session.create_client("chime-sdk-media-pipelines").untag_resource method. boto3 documentation

# untag_resource method definition

await 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 session.create_client("chime-sdk-media-pipelines").update_media_insights_pipeline_configuration method. boto3 documentation

# update_media_insights_pipeline_configuration method definition

await 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 session.create_client("chime-sdk-media-pipelines").update_media_insights_pipeline_status method. boto3 documentation

# update_media_insights_pipeline_status method definition

await 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

__aenter__#

Type annotations and code completion for session.create_client("chime-sdk-media-pipelines").__aenter__ method. boto3 documentation

# __aenter__ method definition

await def __aenter__(
    self,
) -> ChimeSDKMediaPipelinesClient:
    ...

__aexit__#

Type annotations and code completion for session.create_client("chime-sdk-media-pipelines").__aexit__ method. boto3 documentation

# __aexit__ method definition

await def __aexit__(
    self,
    exc_type: Any,
    exc_val: Any,
    exc_tb: Any,
) -> Any:
    ...