Skip to content

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)
    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 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[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 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[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

create_media_pipeline_kinesis_video_stream_pool#

Creates an Kinesis video stream pool for the media pipeline.

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 DeleteMediaPipelineRequestRe