ChimeSDKMediaPipelines / Client / update_media_pipeline_kinesis_video_stream_pool

update_media_pipeline_kinesis_video_stream_pool#

ChimeSDKMediaPipelines.Client.update_media_pipeline_kinesis_video_stream_pool(**kwargs)#

Updates an Kinesis video stream pool in a media pipeline.

See also: AWS API Documentation

Request Syntax

response = client.update_media_pipeline_kinesis_video_stream_pool(
    Identifier='string',
    StreamConfiguration={
        'DataRetentionInHours': 123
    }
)
Parameters:

  • Identifier (string) –

    [REQUIRED]

    The ID of the video stream pool.

  • StreamConfiguration (dict) –

    The configuration settings for the video stream.

    • DataRetentionInHours (integer) –

      The updated time that data is retained.

Return type:

dict

Returns:

Response Syntax

{
    'KinesisVideoStreamPoolConfiguration': {
        'PoolArn': 'string',
        'PoolName': 'string',
        'PoolId': 'string',
        'PoolStatus': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'FAILED',
        'PoolSize': 123,
        'StreamConfiguration': {
            'Region': 'string',
            'DataRetentionInHours': 123
        },
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) –

    • KinesisVideoStreamPoolConfiguration (dict) –

      The video stream pool configuration object.

      • PoolArn (string) –

        The ARN of the video stream pool configuration.

      • PoolName (string) –

        The name of the video stream pool configuration.

      • PoolId (string) –

        The ID of the video stream pool in the configuration.

      • PoolStatus (string) –

        The status of the video stream pool in the configuration.

      • PoolSize (integer) –

        The size of the video stream pool in the configuration.

      • StreamConfiguration (dict) –

        The Kinesis video stream pool configuration object.

        • Region (string) –

          The Amazon Web Services Region of the video stream.

        • DataRetentionInHours (integer) –

          The amount of time that data is retained.

      • CreatedTimestamp (datetime) –

        The time at which the configuration was created.

      • UpdatedTimestamp (datetime) –

        The time at which the configuration was updated.

Exceptions