KinesisVideo

Table of Contents

Client

class KinesisVideo.Client

A low-level client representing Amazon Kinesis Video Streams:

import boto3

client = boto3.client('kinesisvideo')

These are the available methods:

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
create_stream(**kwargs)

Creates a new Kinesis video stream.

When you create a new stream, Kinesis Video Streams assigns it a version number. When you change the stream's metadata, Kinesis Video Streams updates the version.

CreateStream is an asynchronous operation.

For information about how the service works, see How it Works .

You must have permissions for the KinesisVideo:CreateStream action.

See also: AWS API Documentation

Request Syntax

response = client.create_stream(
    DeviceName='string',
    StreamName='string',
    MediaType='string',
    KmsKeyId='string',
    DataRetentionInHours=123
)
Parameters
  • DeviceName (string) --

    The name of the device that is writing to the stream.

    Note

    In the current implementation, Kinesis Video Streams does not use this name.

  • StreamName (string) --

    [REQUIRED]

    A name for the stream that you are creating.

    The stream name is an identifier for the stream, and must be unique for each account and region.

  • MediaType (string) --

    The media type of the stream. Consumers of the stream can use this information when processing the stream. For more information about media types, see Media Types . If you choose to specify the MediaType , see Naming Requirements for guidelines.

    To play video on the console, the media must be H.264 encoded, and you need to specify this video type in this parameter as video/h264 .

    This parameter is optional; the default value is null (or empty in JSON).

  • KmsKeyId (string) --

    The ID of the AWS Key Management Service (AWS KMS) key that you want Kinesis Video Streams to use to encrypt stream data.

    If no key ID is specified, the default, Kinesis Video-managed key (aws/kinesisvideo ) is used.

    For more information, see DescribeKey .

  • DataRetentionInHours (integer) --

    The number of hours that you want to retain the data in the stream. Kinesis Video Streams retains the data in a data store that is associated with the stream.

    The default value is 0, indicating that the stream does not persist data.

Return type

dict

Returns

Response Syntax

{
    'StreamARN': 'string'
}

Response Structure

  • (dict) --

    • StreamARN (string) --

      The Amazon Resource Name (ARN) of the stream.

delete_stream(**kwargs)

Deletes a Kinesis video stream and the data contained in the stream.

This method marks the stream for deletion, and makes the data in the stream inaccessible immediately.

To ensure that you have the latest version of the stream before deleting it, you can specify the stream version. Kinesis Video Streams assigns a version to each stream. When you update a stream, Kinesis Video Streams assigns a new version number. To get the latest stream version, use the DescribeStream API.

This operation requires permission for the KinesisVideo:DeleteStream action.

See also: AWS API Documentation

Request Syntax

response = client.delete_stream(
    StreamARN='string',
    CurrentVersion='string'
)
Parameters
  • StreamARN (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the stream that you want to delete.

  • CurrentVersion (string) --

    Optional: The version of the stream that you want to delete.

    Specify the version as a safeguard to ensure that your are deleting the correct stream. To get the stream version, use the DescribeStream API.

    If not specified, only the CreationTime is checked before deleting the stream.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

describe_stream(**kwargs)

Returns the most current information about the specified stream. You must specify either the StreamName or the StreamARN .

See also: AWS API Documentation

Request Syntax

response = client.describe_stream(
    StreamName='string',
    StreamARN='string'
)
Parameters
  • StreamName (string) -- The name of the stream.
  • StreamARN (string) -- The Amazon Resource Name (ARN) of the stream.
Return type

dict

Returns

Response Syntax

{
    'StreamInfo': {
        'DeviceName': 'string',
        'StreamName': 'string',
        'StreamARN': 'string',
        'MediaType': 'string',
        'KmsKeyId': 'string',
        'Version': 'string',
        'Status': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING',
        'CreationTime': datetime(2015, 1, 1),
        'DataRetentionInHours': 123
    }
}

Response Structure

  • (dict) --

    • StreamInfo (dict) --

      An object that describes the stream.

      • DeviceName (string) --

        The name of the device that is associated with the stream.

      • StreamName (string) --

        The name of the stream.

      • StreamARN (string) --

        The Amazon Resource Name (ARN) of the stream.

      • MediaType (string) --

        The MediaType of the stream.

      • KmsKeyId (string) --

        The ID of the AWS Key Management Service (AWS KMS) key that Kinesis Video Streams uses to encrypt data on the stream.

      • Version (string) --

        The version of the stream.

      • Status (string) --

        The status of the stream.

      • CreationTime (datetime) --

        A time stamp that indicates when the stream was created.

      • DataRetentionInHours (integer) --

        How long the stream retains data, in hours.

generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)

Generate a presigned url given a client, its method, and arguments

Parameters
  • ClientMethod (string) -- The client method to presign for
  • Params (dict) -- The parameters normally passed to ClientMethod.
  • ExpiresIn (int) -- The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
  • HttpMethod (string) -- The http method to use on the generated url. By default, the http method is whatever is used in the method's model.
Returns

The presigned url

get_data_endpoint(**kwargs)

Gets an endpoint for a specified stream for either reading or writing. Use this endpoint in your application to read from the specified stream (using the GetMedia or GetMediaForFragmentList operations) or write to it (using the PutMedia operation).

Note

The returned endpoint does not have the API name appended. The client needs to add the API name to the returned endpoint.

In the request, specify the stream either by StreamName or StreamARN .

See also: AWS API Documentation

Request Syntax

response = client.get_data_endpoint(
    StreamName='string',
    StreamARN='string',
    APIName='PUT_MEDIA'|'GET_MEDIA'|'LIST_FRAGMENTS'|'GET_MEDIA_FOR_FRAGMENT_LIST'
)
Parameters
  • StreamName (string) -- The name of the stream that you want to get the endpoint for. You must specify either this parameter or a StreamARN in the request.
  • StreamARN (string) -- The Amazon Resource Name (ARN) of the stream that you want to get the endpoint for. You must specify either this parameter or a StreamName in the request.
  • APIName (string) --

    [REQUIRED]

    The name of the API action for which to get an endpoint.

Return type

dict

Returns

Response Syntax

{
    'DataEndpoint': 'string'
}

Response Structure

  • (dict) --

    • DataEndpoint (string) --

      The endpoint value. To read data from the stream or to write data to it, specify this endpoint in your application.

get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_waiter(waiter_name)
list_streams(**kwargs)

Returns an array of StreamInfo objects. Each object describes a stream. To retrieve only streams that satisfy a specific condition, you can specify a StreamNameCondition .

See also: AWS API Documentation

Request Syntax

response = client.list_streams(
    MaxResults=123,
    NextToken='string',
    StreamNameCondition={
        'ComparisonOperator': 'BEGINS_WITH',
        'ComparisonValue': 'string'
    }
)
Parameters
  • MaxResults (integer) -- The maximum number of streams to return in the response. The default is 10,000.
  • NextToken (string) -- If you specify this parameter, when the result of a ListStreams operation is truncated, the call returns the NextToken in the response. To get another batch of streams, provide this token in your next request.
  • StreamNameCondition (dict) --

    Optional: Returns only streams that satisfy a specific condition. Currently, you can specify only the prefix of a stream name as a condition.

    • ComparisonOperator (string) --

      A comparison operator. Currently, you can specify only the BEGINS_WITH operator, which finds streams whose names start with a given prefix.

    • ComparisonValue (string) --

      A value to compare.

Return type

dict

Returns

Response Syntax

{
    'StreamInfoList': [
        {
            'DeviceName': 'string',
            'StreamName': 'string',
            'StreamARN': 'string',
            'MediaType': 'string',
            'KmsKeyId': 'string',
            'Version': 'string',
            'Status': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING',
            'CreationTime': datetime(2015, 1, 1),
            'DataRetentionInHours': 123
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • StreamInfoList (list) --

      An array of StreamInfo objects.

      • (dict) --

        An object describing a Kinesis video stream.

        • DeviceName (string) --

          The name of the device that is associated with the stream.

        • StreamName (string) --

          The name of the stream.

        • StreamARN (string) --

          The Amazon Resource Name (ARN) of the stream.

        • MediaType (string) --

          The MediaType of the stream.

        • KmsKeyId (string) --

          The ID of the AWS Key Management Service (AWS KMS) key that Kinesis Video Streams uses to encrypt data on the stream.

        • Version (string) --

          The version of the stream.

        • Status (string) --

          The status of the stream.

        • CreationTime (datetime) --

          A time stamp that indicates when the stream was created.

        • DataRetentionInHours (integer) --

          How long the stream retains data, in hours.

    • NextToken (string) --

      If the response is truncated, the call returns this element with a token. To get the next batch of streams, use this token in your next request.

list_tags_for_stream(**kwargs)

Returns a list of tags associated with the specified stream.

In the request, you must specify either the StreamName or the StreamARN .

See also: AWS API Documentation

Request Syntax

response = client.list_tags_for_stream(
    NextToken='string',
    StreamARN='string',
    StreamName='string'
)
Parameters
  • NextToken (string) -- If you specify this parameter and the result of a ListTagsForStream call is truncated, the response includes a token that you can use in the next request to fetch the next batch of tags.
  • StreamARN (string) -- The Amazon Resource Name (ARN) of the stream that you want to list tags for.
  • StreamName (string) -- The name of the stream that you want to list tags for.
Return type

dict

Returns

Response Syntax

{
    'NextToken': 'string',
    'Tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --

    • NextToken (string) --

      If you specify this parameter and the result of a ListTags call is truncated, the response includes a token that you can use in the next request to fetch the next set of tags.

    • Tags (dict) --

      A map of tag keys and values associated with the specified stream.

      • (string) --
        • (string) --

tag_stream(**kwargs)

Adds one or more tags to a stream. A tag is a key-value pair (the value is optional) that you can define and assign to AWS resources. If you specify a tag that already exists, the tag value is replaced with the value that you specify in the request. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide .

You must provide either the StreamName or the StreamARN .

This operation requires permission for the KinesisVideo:TagStream action.

Kinesis video streams support up to 50 tags.

See also: AWS API Documentation

Request Syntax

response = client.tag_stream(
    StreamARN='string',
    StreamName='string',
    Tags={
        'string': 'string'
    }
)
Parameters
  • StreamARN (string) -- The Amazon Resource Name (ARN) of the resource that you want to add the tag or tags to.
  • StreamName (string) -- The name of the stream that you want to add the tag or tags to.
  • Tags (dict) --

    [REQUIRED]

    A list of tags to associate with the specified stream. Each tag is a key-value pair (the value is optional).

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

untag_stream(**kwargs)

Removes one or more tags from a stream. In the request, specify only a tag key or keys; don't specify the value. If you specify a tag key that does not exist, it's ignored.

In the request, you must provide the StreamName or StreamARN .

See also: AWS API Documentation

Request Syntax

response = client.untag_stream(
    StreamARN='string',
    StreamName='string',
    TagKeyList=[
        'string',
    ]
)
Parameters
  • StreamARN (string) -- The Amazon Resource Name (ARN) of the stream that you want to remove tags from.
  • StreamName (string) -- The name of the stream that you want to remove tags from.
  • TagKeyList (list) --

    [REQUIRED]

    A list of the keys of the tags that you want to remove.

    • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

update_data_retention(**kwargs)

Increases or decreases the stream's data retention period by the value that you specify. To indicate whether you want to increase or decrease the data retention period, specify the Operation parameter in the request body. In the request, you must specify either the StreamName or the StreamARN .

Note

The retention period that you specify replaces the current value.

This operation requires permission for the KinesisVideo:UpdateDataRetention action.

Changing the data retention period affects the data in the stream as follows:

  • If the data retention period is increased, existing data is retained for the new retention period. For example, if the data retention period is increased from one hour to seven hours, all existing data is retained for seven hours.
  • If the data retention period is decreased, existing data is retained for the new retention period. For example, if the data retention period is decreased from seven hours to one hour, all existing data is retained for one hour, and any data older than one hour is deleted immediately.

See also: AWS API Documentation

Request Syntax

response = client.update_data_retention(
    StreamName='string',
    StreamARN='string',
    CurrentVersion='string',
    Operation='INCREASE_DATA_RETENTION'|'DECREASE_DATA_RETENTION',
    DataRetentionChangeInHours=123
)
Parameters
  • StreamName (string) -- The name of the stream whose retention period you want to change.
  • StreamARN (string) -- The Amazon Resource Name (ARN) of the stream whose retention period you want to change.
  • CurrentVersion (string) --

    [REQUIRED]

    The version of the stream whose retention period you want to change. To get the version, call either the DescribeStream or the ListStreams API.

  • Operation (string) --

    [REQUIRED]

    Indicates whether you want to increase or decrease the retention period.

  • DataRetentionChangeInHours (integer) --

    [REQUIRED]

    The retention period, in hours. The value you specify replaces the current value.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

update_stream(**kwargs)

Updates stream metadata, such as the device name and media type.

You must provide the stream name or the Amazon Resource Name (ARN) of the stream.

To make sure that you have the latest version of the stream before updating it, you can specify the stream version. Kinesis Video Streams assigns a version to each stream. When you update a stream, Kinesis Video Streams assigns a new version number. To get the latest stream version, use the DescribeStream API.

UpdateStream is an asynchronous operation, and takes time to complete.

See also: AWS API Documentation

Request Syntax

response = client.update_stream(
    StreamName='string',
    StreamARN='string',
    CurrentVersion='string',
    DeviceName='string',
    MediaType='string'
)
Parameters
  • StreamName (string) --

    The name of the stream whose metadata you want to update.

    The stream name is an identifier for the stream, and must be unique for each account and region.

  • StreamARN (string) -- The ARN of the stream whose metadata you want to update.
  • CurrentVersion (string) --

    [REQUIRED]

    The version of the stream whose metadata you want to update.

  • DeviceName (string) --

    The name of the device that is writing to the stream.

    Note

    In the current implementation, Kinesis Video Streams does not use this name.

  • MediaType (string) --

    The stream's media type. Use MediaType to specify the type of content that the stream contains to the consumers of the stream. For more information about media types, see Media Types . If you choose to specify the MediaType , see Naming Requirements .

    To play video on the console, you must specify the correct video type. For example, if the video in the stream is H.264, specify video/h264 as the MediaType .

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Paginators

The available paginators are: