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

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.

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

try:
    do_something(client)
except (
    client.BadRequestException,
    client.ClientError,
    client.ForbiddenException,
    client.NotFoundException,
    client.ResourceLimitExceededException,
    client.ServiceFailureException,
    client.ServiceUnavailableException,
    client.ThrottledClientException,
    client.UnauthorizedClientException,
) as e:
    print(e)
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

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

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

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
Usage example with kwargs
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

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
Usage example with kwargs
kwargs: CreateMediaConcatenationPipelineRequestRequestTypeDef = {  # (1)
    "Sources": ...,
    "Sinks": ...,
}

parent.create_media_concatenation_pipeline(**kwargs)
  1. See CreateMediaConcatenationPipelineRequestRequestTypeDef

create_media_live_connector_pipeline

Creates a streaming media 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

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
Usage example with kwargs
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 boto3.client("chime-sdk-media-pipelines").delete_media_capture_pipeline method. boto3 documentation

Method definition
def delete_media_capture_pipeline(
    self,
    *,
    MediaPipelineId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteMediaCapturePipelineRequestRequestTypeDef = {  # (1)
    "MediaPipelineId": ...,
}

parent.delete_media_capture_pipeline(**kwargs)
  1. See DeleteMediaCapturePipelineRequestRequestTypeDef

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

Method definition
def delete_media_pipeline(
    self,
    *,
    MediaPipelineId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
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 boto3.client("chime-sdk-media-pipelines").generate_presigned_url method. boto3 documentation

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

Method definition
def get_media_capture_pipeline(
    self,
    *,
    MediaPipelineId: str,
) -> GetMediaCapturePipelineResponseTypeDef:  # (1)
    ...
  1. See GetMediaCapturePipelineResponseTypeDef
Usage example with kwargs
kwargs: GetMediaCapturePipelineRequestRequestTypeDef = {  # (1)
    "MediaPipelineId": ...,
}

parent.get_media_capture_pipeline(**kwargs)
  1. See GetMediaCapturePipelineRequestRequestTypeDef

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

Method definition
def get_media_pipeline(
    self,
    *,
    MediaPipelineId: str,
) -> GetMediaPipelineResponseTypeDef:  # (1)
    ...
  1. See GetMediaPipelineResponseTypeDef
Usage example with kwargs
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 boto3.client("chime-sdk-media-pipelines").list_media_capture_pipelines method. boto3 documentation

Method definition
def list_media_capture_pipelines(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListMediaCapturePipelinesResponseTypeDef:  # (1)
    ...
  1. See ListMediaCapturePipelinesResponseTypeDef
Usage example with kwargs
kwargs: ListMediaCapturePipelinesRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_media_capture_pipelines(**kwargs)
  1. See ListMediaCapturePipelinesRequestRequestTypeDef

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

Method definition
def list_media_pipelines(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListMediaPipelinesResponseTypeDef:  # (1)
    ...
  1. See ListMediaPipelinesResponseTypeDef
Usage example with kwargs
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

Method definition
def list_tags_for_resource(
    self,
    *,
    ResourceARN: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef
Usage example with kwargs
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 boto3.client("chime-sdk-media-pipelines").tag_resource method. boto3 documentation

Method definition
def tag_resource(
    self,
    *,
    ResourceARN: str,
    Tags: Sequence[TagTypeDef],  # (1)
) -> Dict[str, Any]:
    ...
  1. See TagTypeDef
Usage example with kwargs
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

Method definition
def untag_resource(
    self,
    *,
    ResourceARN: str,
    TagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "ResourceARN": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceRequestRequestTypeDef