ChimeSDKMediaPipelines / Client / get_media_pipeline_kinesis_video_stream_pool

get_media_pipeline_kinesis_video_stream_pool#

ChimeSDKMediaPipelines.Client.get_media_pipeline_kinesis_video_stream_pool(**kwargs)#

Gets an Kinesis video stream pool.

Request Syntax

response = client.get_media_pipeline_kinesis_video_stream_pool(
    Identifier='string'
)

Parameters:

Identifier (string) –

[REQUIRED]

The unique identifier of the requested resource. Valid values include the name and ARN of the media pipeline Kinesis Video Stream pool.

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

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