list_media_capture_pipelines

ChimeSDKMediaPipelines.Client.list_media_capture_pipelines(**kwargs)

Returns a list of media 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 pipeline objects in the list.

    • (dict) --

      The summary data of a media capture pipeline.

      • MediaPipelineId (string) --

        The ID of the media pipeline in the summary.

      • MediaPipelineArn (string) --

        The ARN of the media pipeline in the summary.

  • 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