ChimeSDKMediaPipelines / Client / create_media_pipeline_kinesis_video_stream_pool

create_media_pipeline_kinesis_video_stream_pool#

ChimeSDKMediaPipelines.Client.create_media_pipeline_kinesis_video_stream_pool(**kwargs)#

Creates an Amazon Kinesis Video Stream pool for use with media stream pipelines.

Note

If a meeting uses an opt-in Region as its MediaRegion, the KVS stream must be in that same Region. For example, if a meeting uses the af-south-1 Region, the KVS stream must also be in af-south-1. However, if the meeting uses a Region that AWS turns on by default, the KVS stream can be in any available Region, including an opt-in Region. For example, if the meeting uses ca-central-1, the KVS stream can be in eu-west-2, us-east-1, af-south-1, or any other Region that the Amazon Chime SDK supports.

To learn which AWS Region a meeting uses, call the GetMeeting API and use the MediaRegion parameter from the response.

For more information about opt-in Regions, refer to Available Regions in the Amazon Chime SDK Developer Guide, and Specify which AWS Regions your account can use, in the AWS Account Management Reference Guide.

See also: AWS API Documentation

Request Syntax

response = client.create_media_pipeline_kinesis_video_stream_pool(
    StreamConfiguration={
        'Region': 'string',
        'DataRetentionInHours': 123
    },
    PoolName='string',
    ClientRequestToken='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters:

  • StreamConfiguration (dict) –

    [REQUIRED]

    The configuration settings for the stream.

    • Region (string) – [REQUIRED]

      The Amazon Web Services Region of the video stream.

    • DataRetentionInHours (integer) –

      The amount of time that data is retained.

  • PoolName (string) –

    [REQUIRED]

    The name of the pool.

  • ClientRequestToken (string) –

    The token assigned to the client making the request.

    This field is autopopulated if not provided.

  • Tags (list) –

    The tags assigned to the stream pool.

    • (dict) –

      A key/value pair that grants users access to meeting resources.

      • Key (string) – [REQUIRED]

        The key half of a tag.

      • Value (string) – [REQUIRED]

        The value half of a tag.

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 configuration for applying the streams to the pool.

      • 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.UnauthorizedClientException

  • ChimeSDKMediaPipelines.Client.exceptions.ThrottledClientException

  • ChimeSDKMediaPipelines.Client.exceptions.ResourceLimitExceededException

  • ChimeSDKMediaPipelines.Client.exceptions.ConflictException

  • ChimeSDKMediaPipelines.Client.exceptions.ServiceUnavailableException

  • ChimeSDKMediaPipelines.Client.exceptions.ServiceFailureException