ChimeSDKMediaPipelines / Client / list_media_pipeline_kinesis_video_stream_pools

list_media_pipeline_kinesis_video_stream_pools#

ChimeSDKMediaPipelines.Client.list_media_pipeline_kinesis_video_stream_pools(**kwargs)#

Lists the video stream pools in the media pipeline.

See also: AWS API Documentation

Request Syntax

response = client.list_media_pipeline_kinesis_video_stream_pools(
    NextToken='string',
    MaxResults=123
)
Parameters:
  • NextToken (string) – The token used to return the next page of results.

  • MaxResults (integer) – The maximum number of results to return in a single call.

Return type:

dict

Returns:

Response Syntax

{
    'KinesisVideoStreamPools': [
        {
            'PoolName': 'string',
            'PoolId': 'string',
            'PoolArn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • KinesisVideoStreamPools (list) –

      The list of video stream pools.

      • (dict) –

        A summary of the Kinesis video stream pool.

        • PoolName (string) –

          The name of the video stream pool.

        • PoolId (string) –

          The ID of the video stream pool.

        • PoolArn (string) –

          The ARN of the video stream pool.

    • NextToken (string) –

      The token used to return the next page of results.

Exceptions