ChimeSDKMediaPipelines ¶

Table of Contents

ChimeSDKMediaPipelines
- Client
- Paginators

Client ¶

class ChimeSDKMediaPipelines.Client¶

A low-level client representing Amazon Chime SDK Media Pipelines

The Amazon Chime SDK media pipeline APIs in this section allow software developers to create Amazon Chime SDK media pipelines and capture audio, video, events, and data messages from Amazon Chime SDK meetings. For more information about media pipleines, see Amzon Chime SDK media pipelines .

import boto3

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

These are the available methods:

can_paginate()
close()
create_media_capture_pipeline()
delete_media_capture_pipeline()
get_media_capture_pipeline()
get_paginator()
get_waiter()
list_media_capture_pipelines()
list_tags_for_resource()
tag_resource()
untag_resource()

can_paginate(operation_name)¶

Check if an operation can be paginated.

Parameters: operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns: True if the operation can be paginated, False otherwise.

close()¶: Closes underlying endpoint connections.

create_media_capture_pipeline(**kwargs)¶

Creates a media capture pipeline.

See also: AWS API Documentation

Request Syntax

response = client.create_media_capture_pipeline(
    SourceType='ChimeSdkMeeting',
    SourceArn='string',
    SinkType='S3Bucket',
    SinkArn='string',
    ClientRequestToken='string',
    ChimeSdkMeetingConfiguration={
        'SourceConfiguration': {
            'SelectedVideoStreams': {
                'AttendeeIds': [
                    'string',
                ],
                'ExternalUserIds': [
                    'string',
                ]
            }
        },
        'ArtifactsConfiguration': {
            'Audio': {
                'MuxType': 'AudioOnly'|'AudioWithActiveSpeakerVideo'
            },
            'Video': {
                'State': 'Enabled'|'Disabled',
                'MuxType': 'VideoOnly'
            },
            'Content': {
                'State': 'Enabled'|'Disabled',
                'MuxType': 'ContentOnly'
            }
        }
    },
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

Parameters

SourceType (string) --
[REQUIRED]

Source type from which the media artifacts are captured. A Chime SDK Meeting is the only supported source.
SourceArn (string) --
[REQUIRED]

ARN of the source from which the media artifacts are captured.
SinkType (string) --
[REQUIRED]

Destination type to which the media artifacts are saved. You must use an S3 bucket.
SinkArn (string) --
[REQUIRED]

The ARN of the sink type.
ClientRequestToken (string) --
The token assigned to the client making the pipeline request.

This field is autopopulated if not provided.
ChimeSdkMeetingConfiguration (dict) --
The configuration for a specified media capture pipeline. SourceType must be ChimeSdkMeeting .
- SourceConfiguration (dict) --
  The source configuration for a specified media capture pipline.
  - SelectedVideoStreams (dict) --
    The selected video streams to capture for a specified media capture pipeline. The number of video streams can't exceed 25.
    - AttendeeIds (list) --
      The attendee IDs of the streams selected for a media capture pipeline.
      - (string) --
    - ExternalUserIds (list) --
      The external user IDs of the streams selected for a media capture pipeline.
      - (string) --
- ArtifactsConfiguration (dict) --
  The configuration for the artifacts in an Amazon Chime SDK meeting.
  - Audio (dict) -- [REQUIRED]
    The configuration for the audio artifacts.
    - MuxType (string) -- [REQUIRED]
      The MUX type of the audio artifact configuration object.
  - Video (dict) -- [REQUIRED]
    The configuration for the video artifacts.
    - State (string) -- [REQUIRED]
      Indicates whether the video artifact is enabled or disabled.
    - MuxType (string) --
      The MUX type of the video artifact configuration object.
  - Content (dict) -- [REQUIRED]
    The configuration for the content artifacts.
    - State (string) -- [REQUIRED]
      Indicates whether the content artifact is enabled or disabled.
    - MuxType (string) --
      The MUX type of the artifact configuration.
Tags (list) --
The list of tags.
- (dict) --
  Describes a tag applied to a resource.
  - Key (string) -- [REQUIRED]
    The key of the tag.
  - Value (string) -- [REQUIRED]
    The value of the tag.

Return type

dict

Returns

Response Syntax

{
    'MediaCapturePipeline': {
        'MediaPipelineId': 'string',
        'MediaPipelineArn': 'string',
        'SourceType': 'ChimeSdkMeeting',
        'SourceArn': 'string',
        'Status': 'Initializing'|'InProgress'|'Failed'|'Stopping'|'Stopped',
        'SinkType': 'S3Bucket',
        'SinkArn': 'string',
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1),
        'ChimeSdkMeetingConfiguration': {
            'SourceConfiguration': {
                'SelectedVideoStreams': {
                    'AttendeeIds': [
                        'string',
                    ],
                    'ExternalUserIds': [
                        'string',
                    ]
                }
            },
            'ArtifactsConfiguration': {
                'Audio': {
                    'MuxType': 'AudioOnly'|'AudioWithActiveSpeakerVideo'
                },
                'Video': {
                    'State': 'Enabled'|'Disabled',
                    'MuxType': 'VideoOnly'
                },
                'Content': {
                    'State': 'Enabled'|'Disabled',
                    'MuxType': 'ContentOnly'
                }
            }
        }
    }
}

Response Structure

(dict) --
- MediaCapturePipeline (dict) --
  
  A media capture pipeline object, the ID, source type, source ARN, sink type, and sink ARN of a media capture pipeline object.
  - MediaPipelineId (string) --
    
    The ID of a media capture pipeline.
  - MediaPipelineArn (string) --
    
    The ARN of a media capture pipeline.
  - SourceType (string) --
    
    Source type from which media artifacts are saved. You must use ChimeMeeting .
  - SourceArn (string) --
    
    ARN of the source from which the media artifacts are saved.
  - Status (string) --
    
    The status of the media capture pipeline.
  - SinkType (string) --
    
    Destination type to which the media artifacts are saved. You must use an S3 Bucket.
  - SinkArn (string) --
    
    ARN of the destination to which the media artifacts are saved.
  - CreatedTimestamp (datetime) --
    
    The time at which the capture pipeline was created, in ISO 8601 format.
  - UpdatedTimestamp (datetime) --
    
    The time at which the capture pipeline was updated, in ISO 8601 format.
  - ChimeSdkMeetingConfiguration (dict) --
    
    The configuration for a specified media capture pipeline. SourceType must be ChimeSdkMeeting .
    - SourceConfiguration (dict) --
      
      The source configuration for a specified media capture pipline.
      - SelectedVideoStreams (dict) --
        
        The selected video streams to capture for a specified media capture pipeline. The number of video streams can't exceed 25.
        
        AttendeeIds (list) --
        
        The attendee IDs of the streams selected for a media capture pipeline.
        
        (string) --
        
        ExternalUserIds (list) --
        
        The external user IDs of the streams selected for a media capture pipeline.
        
        (string) --
    - ArtifactsConfiguration (dict) --
      
      The configuration for the artifacts in an Amazon Chime SDK meeting.
      - Audio (dict) --
        
        The configuration for the audio artifacts.
        
        MuxType (string) --
        
        The MUX type of the audio artifact configuration object.
      - Video (dict) --
        
        The configuration for the video artifacts.
        
        State (string) --
        
        Indicates whether the video artifact is enabled or disabled.
        
        MuxType (string) --
        
        The MUX type of the video artifact configuration object.
      - Content (dict) --
        
        The configuration for the content artifacts.
        
        State (string) --
        
        Indicates whether the content artifact is enabled or disabled.
        
        MuxType (string) --
        
        The MUX type of the artifact configuration.

Exceptions

ChimeSDKMediaPipelines.Client.exceptions.BadRequestException
ChimeSDKMediaPipelines.Client.exceptions.ForbiddenException
ChimeSDKMediaPipelines.Client.exceptions.UnauthorizedClientException
ChimeSDKMediaPipelines.Client.exceptions.ThrottledClientException
ChimeSDKMediaPipelines.Client.exceptions.ResourceLimitExceededException
ChimeSDKMediaPipelines.Client.exceptions.ServiceUnavailableException
ChimeSDKMediaPipelines.Client.exceptions.ServiceFailureException

delete_media_capture_pipeline(**kwargs)¶

Deletes the media capture pipeline.

See also: AWS API Documentation

Request Syntax

response = client.delete_media_capture_pipeline(
    MediaPipelineId='string'
)

Parameters

MediaPipelineId (string) --

[REQUIRED]

The ID of the media capture pipeline being deleted.

Returns

None

Exceptions

ChimeSDKMediaPipelines.Client.exceptions.BadRequestException
ChimeSDKMediaPipelines.Client.exceptions.ForbiddenException
ChimeSDKMediaPipelines.Client.exceptions.ThrottledClientException
ChimeSDKMediaPipelines.Client.exceptions.NotFoundException
ChimeSDKMediaPipelines.Client.exceptions.UnauthorizedClientException
ChimeSDKMediaPipelines.Client.exceptions.ServiceUnavailableException
ChimeSDKMediaPipelines.Client.exceptions.ServiceFailureException

get_media_capture_pipeline(**kwargs)¶

Gets an existing media capture pipeline.

See also: AWS API Documentation

Request Syntax

response = client.get_media_capture_pipeline(
    MediaPipelineId='string'
)

Parameters

MediaPipelineId (string) --

[REQUIRED]

The ID of the pipeline that you want to get.

Return type

dict

Returns

Response Syntax

{
    'MediaCapturePipeline': {
        'MediaPipelineId': 'string',
        'MediaPipelineArn': 'string',
        'SourceType': 'ChimeSdkMeeting',
        'SourceArn': 'string',
        'Status': 'Initializing'|'InProgress'|'Failed'|'Stopping'|'Stopped',
        'SinkType': 'S3Bucket',
        'SinkArn': 'string',
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1),
        'ChimeSdkMeetingConfiguration': {
            'SourceConfiguration': {
                'SelectedVideoStreams': {
                    'AttendeeIds': [
                        'string',
                    ],
                    'ExternalUserIds': [
                        'string',
                    ]
                }
            },
            'ArtifactsConfiguration': {
                'Audio': {
                    'MuxType': 'AudioOnly'|'AudioWithActiveSpeakerVideo'
                },
                'Video': {
                    'State': 'Enabled'|'Disabled',
                    'MuxType': 'VideoOnly'
                },
                'Content': {
                    'State': 'Enabled'|'Disabled',
                    'MuxType': 'ContentOnly'
                }
            }
        }
    }
}

Response Structure

(dict) --
- MediaCapturePipeline (dict) --
  The media capture pipeline object.
  - MediaPipelineId (string) --
    The ID of a media capture pipeline.
  - MediaPipelineArn (string) --
    The ARN of a media capture pipeline.
  - SourceType (string) --
    Source type from which media artifacts are saved. You must use ChimeMeeting .
  - SourceArn (string) --
    ARN of the source from which the media artifacts are saved.
  - Status (string) --
    The status of the media capture pipeline.
  - SinkType (string) --
    Destination type to which the media artifacts are saved. You must use an S3 Bucket.
  - SinkArn (string) --
    ARN of the destination to which the media artifacts are saved.
  - CreatedTimestamp (datetime) --
    The time at which the capture pipeline was created, in ISO 8601 format.
  - UpdatedTimestamp (datetime) --
    The time at which the capture pipeline was updated, in ISO 8601 format.
  - ChimeSdkMeetingConfiguration (dict) --
    The configuration for a specified media capture pipeline. SourceType must be ChimeSdkMeeting .
    - SourceConfiguration (dict) --
      The source configuration for a specified media capture pipline.
      - SelectedVideoStreams (dict) --
        The selected video streams to capture for a specified media capture pipeline. The number of video streams can't exceed 25.
        
        AttendeeIds (list) --
        The attendee IDs of the streams selected for a media capture pipeline.
        
        (string) --
        
        ExternalUserIds (list) --
        The external user IDs of the streams selected for a media capture pipeline.
        
        (string) --
    - ArtifactsConfiguration (dict) --
      The configuration for the artifacts in an Amazon Chime SDK meeting.
      - Audio (dict) --
        The configuration for the audio artifacts.
        
        MuxType (string) --
        The MUX type of the audio artifact configuration object.
      - Video (dict) --
        The configuration for the video artifacts.
        
        State (string) --
        Indicates whether the video artifact is enabled or disabled.
        
        MuxType (string) --
        The MUX type of the video artifact configuration object.
      - Content (dict) --
        The configuration for the content artifacts.
        
        State (string) --
        Indicates whether the content artifact is enabled or disabled.
        
        MuxType (string) --
        The MUX type of the artifact configuration.

Exceptions

ChimeSDKMediaPipelines.Client.exceptions.BadRequestException
ChimeSDKMediaPipelines.Client.exceptions.ForbiddenException
ChimeSDKMediaPipelines.Client.exceptions.UnauthorizedClientException
ChimeSDKMediaPipelines.Client.exceptions.ThrottledClientException
ChimeSDKMediaPipelines.Client.exceptions.NotFoundException
ChimeSDKMediaPipelines.Client.exceptions.ServiceUnavailableException
ChimeSDKMediaPipelines.Client.exceptions.ServiceFailureException

get_paginator(operation_name)¶

Create a paginator for an operation.

Parameters: operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError: Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type: L{botocore.paginate.Paginator}
Returns: A paginator object.

get_waiter(waiter_name)¶

Returns an object that can wait for some condition.

Parameters: waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns: The specified waiter object.
Return type: botocore.waiter.Waiter

list_media_capture_pipelines(**kwargs)¶

Returns a list of media capture pipelines.

See also: AWS API Documentation

Request Syntax

response = client.list_media_capture_pipelines(
    NextToken='string',
    MaxResults=123
)

Parameters

NextToken (string) -- The token used to retrieve the next page of results.
MaxResults (integer) -- The maximum number of results to return in a single call. Valid Range: 1 - 99.

Return type

dict

Returns

Response Syntax

{
    'MediaCapturePipelines': [
        {
            'MediaPipelineId': 'string',
            'MediaPipelineArn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- MediaCapturePipelines (list) --
  
  The media capture pipeline objects in the list.
  - (dict) --
    
    A summary of a media capture pipeline.
    - MediaPipelineId (string) --
      
      The ID of a media capture pipeline.
    - MediaPipelineArn (string) --
      
      The ARN of a media capture pipeline.
- NextToken (string) --
  
  The token used to retrieve the next page of results.

Exceptions

ChimeSDKMediaPipelines.Client.exceptions.BadRequestException
ChimeSDKMediaPipelines.Client.exceptions.ForbiddenException
ChimeSDKMediaPipelines.Client.exceptions.UnauthorizedClientException
ChimeSDKMediaPipelines.Client.exceptions.ThrottledClientException
ChimeSDKMediaPipelines.Client.exceptions.ResourceLimitExceededException
ChimeSDKMediaPipelines.Client.exceptions.ServiceUnavailableException
ChimeSDKMediaPipelines.Client.exceptions.ServiceFailureException

list_tags_for_resource(**kwargs)¶

Lists the tags applied to an Amazon Chime SDK media capture pipeline.

See also: AWS API Documentation

Request Syntax

response = client.list_tags_for_resource(
    ResourceARN='string'
)

Parameters

ResourceARN (string) --

[REQUIRED]

The resource ARN.

Return type

dict

Returns

Response Syntax

{
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
}

Response Structure

(dict) --
- Tags (list) --
  The tag key-value pairs.
  - (dict) --
    Describes a tag applied to a resource.
    - Key (string) --
      The key of the tag.
    - Value (string) --
      The value of the tag.

Exceptions

ChimeSDKMediaPipelines.Client.exceptions.NotFoundException
ChimeSDKMediaPipelines.Client.exceptions.BadRequestException
ChimeSDKMediaPipelines.Client.exceptions.ForbiddenException
ChimeSDKMediaPipelines.Client.exceptions.UnauthorizedClientException
ChimeSDKMediaPipelines.Client.exceptions.ThrottledClientException
ChimeSDKMediaPipelines.Client.exceptions.ServiceUnavailableException
ChimeSDKMediaPipelines.Client.exceptions.ServiceFailureException

tag_resource(**kwargs)¶

Applies the specified tags to the specified Amazon Chime SDK media capture pipeline.

See also: AWS API Documentation

Request Syntax

response = client.tag_resource(
    ResourceARN='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

Parameters

ResourceARN (string) --
[REQUIRED]

The resource ARN.
Tags (list) --
[REQUIRED]

The tag key-value pairs.
- (dict) --
  Describes a tag applied to a resource.
  - Key (string) -- [REQUIRED]
    The key of the tag.
  - Value (string) -- [REQUIRED]
    The value of the tag.

Return type

dict

Returns

Response Syntax

{}

Response Structure

(dict) --

Exceptions

ChimeSDKMediaPipelines.Client.exceptions.NotFoundException
ChimeSDKMediaPipelines.Client.exceptions.BadRequestException
ChimeSDKMediaPipelines.Client.exceptions.ForbiddenException
ChimeSDKMediaPipelines.Client.exceptions.UnauthorizedClientException
ChimeSDKMediaPipelines.Client.exceptions.ThrottledClientException
ChimeSDKMediaPipelines.Client.exceptions.ServiceUnavailableException
ChimeSDKMediaPipelines.Client.exceptions.ServiceFailureException

untag_resource(**kwargs)¶

Removes the specified tags from the specified Amazon Chime SDK media capture pipeline.

See also: AWS API Documentation

Request Syntax

response = client.untag_resource(
    ResourceARN='string',
    TagKeys=[
        'string',
    ]
)

Parameters

ResourceARN (string) --
[REQUIRED]

The resource ARN.
TagKeys (list) --
[REQUIRED]

The tag keys.
- (string) --

Return type

dict

Returns

Response Syntax

{}

Response Structure

(dict) --

Exceptions

ChimeSDKMediaPipelines.Client.exceptions.NotFoundException
ChimeSDKMediaPipelines.Client.exceptions.BadRequestException
ChimeSDKMediaPipelines.Client.exceptions.ForbiddenException
ChimeSDKMediaPipelines.Client.exceptions.UnauthorizedClientException
ChimeSDKMediaPipelines.Client.exceptions.ThrottledClientException
ChimeSDKMediaPipelines.Client.exceptions.ServiceUnavailableException
ChimeSDKMediaPipelines.Client.exceptions.ServiceFailureException

Paginators ¶

The available paginators are:

Table Of Contents

ChimeSDKMediaPipelines¶

Client¶

Paginators¶

ChimeSDKMediaPipelines ¶

Client ¶

Paginators ¶