Amazon Kinesis Video Streams

Associates a SignalingChannel to a stream to store the media. There are two signaling modes that can specified :

• If the StorageStatus is disabled, no data will be stored, and the StreamARN parameter will not be needed.

• If the StorageStatus is enabled, the data will be stored in the StreamARN provided.

See also: AWS API Documentation

Request Syntax

client.update_media_storage_configuration(
    ChannelARN='string',
    MediaStorageConfiguration={
        'StreamARN': 'string',
        'Status': 'ENABLED'|'DISABLED'
    }
)

type ChannelARN

string

param ChannelARN

[REQUIRED]

The Amazon Resource Name (ARN) of the channel.

type MediaStorageConfiguration

dict

param MediaStorageConfiguration

[REQUIRED]

A structure that encapsulates, or contains, the media storage configuration properties.

• StreamARN (string) --

  The Amazon Resource Name (ARN) of the stream

• Status (string) -- [REQUIRED]

  The status of the media storage configuration.

rtype

dict

returns

Response Syntax

{}

Response Structure

• (dict) --

Returns the most current information about the channel. Specify the ChannelName or ChannelARN in the input.

See also: AWS API Documentation

Request Syntax

client.describe_media_storage_configuration(
    ChannelName='string',
    ChannelARN='string'
)

type ChannelName

string

param ChannelName

The name of the channel.

type ChannelARN

string

param ChannelARN

The Amazon Resource Name (ARN) of the channel.

rtype

dict

returns

Response Syntax

{
    'MediaStorageConfiguration': {
        'StreamARN': 'string',
        'Status': 'ENABLED'|'DISABLED'
    }
}

Response Structure

• (dict) --

  • MediaStorageConfiguration (dict) --

    A structure that encapsulates, or contains, the media storage configuration properties.

    • StreamARN (string) --

      The Amazon Resource Name (ARN) of the stream

    • Status (string) --

      The status of the media storage configuration.

Returns the most current information about the stream. Either streamName or streamARN should be provided in the input.

Returns the most current information about the stream. The streamName or streamARN should be provided in the input.

See also: AWS API Documentation

Request Syntax

client.describe_mapped_resource_configuration(
    StreamName='string',
    StreamARN='string',
    MaxResults=123,
    NextToken='string'
)

type StreamName

string

param StreamName

The name of the stream.

type StreamARN

string

param StreamARN

The Amazon Resource Name (ARN) of the stream.

type MaxResults

integer

param MaxResults

The maximum number of results to return in the response.

type NextToken

string

param NextToken

The token to provide in your next request, to get another batch of results.

rtype

dict

returns

Response Syntax

{
    'MappedResourceConfigurationList': [
        {
            'Type': 'string',
            'ARN': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • MappedResourceConfigurationList (list) --

    A structure that encapsulates, or contains, the media storage configuration properties.

    • (dict) --

      A structure that encapsulates, or contains, the media storage configuration properties.

      • Type (string) --

        The type of the associated resource for the kinesis video stream.

      • ARN (string) --

        The Amazon Resource Name (ARN) of the Kinesis Video Stream resource, associated with the stream.

  • NextToken (string) --

    The token that was used in the NextToken request to fetch the next set of results.

{'SingleMasterChannelEndpointConfiguration': {'Protocols': {'WEBRTC'}}}

{'ResourceEndpointList': {'Protocol': {'WEBRTC'}}}

Provides an endpoint for the specified signaling channel to send and receive messages. This API uses the SingleMasterChannelEndpointConfiguration input parameter, which consists of the Protocols and Role properties.

Protocols is used to determine the communication mechanism. For example, if you specify WSS as the protocol, this API produces a secure websocket endpoint. If you specify HTTPS as the protocol, this API generates an HTTPS endpoint.

Role determines the messaging permissions. A MASTER role results in this API generating an endpoint that a client can use to communicate with any of the viewers on the channel. A VIEWER role results in this API generating an endpoint that a client can use to communicate only with a MASTER .

See also: AWS API Documentation

Request Syntax

client.get_signaling_channel_endpoint(
    ChannelARN='string',
    SingleMasterChannelEndpointConfiguration={
        'Protocols': [
            'WSS'|'HTTPS'|'WEBRTC',
        ],
        'Role': 'MASTER'|'VIEWER'
    }
)

type ChannelARN

string

param ChannelARN

[REQUIRED]

The Amazon Resource Name (ARN) of the signalling channel for which you want to get an endpoint.

type SingleMasterChannelEndpointConfiguration

dict

param SingleMasterChannelEndpointConfiguration

A structure containing the endpoint configuration for the SINGLE_MASTER channel type.

• Protocols (list) --

  This property is used to determine the nature of communication over this SINGLE_MASTER signaling channel. If WSS is specified, this API returns a websocket endpoint. If HTTPS is specified, this API returns an HTTPS endpoint.

  • (string) --

• Role (string) --

  This property is used to determine messaging permissions in this SINGLE_MASTER signaling channel. If MASTER is specified, this API returns an endpoint that a client can use to receive offers from and send answers to any of the viewers on this signaling channel. If VIEWER is specified, this API returns an endpoint that a client can use only to send offers to another MASTER client on this signaling channel.

rtype

dict

returns

Response Syntax

{
    'ResourceEndpointList': [
        {
            'Protocol': 'WSS'|'HTTPS'|'WEBRTC',
            'ResourceEndpoint': 'string'
        },
    ]
}

Response Structure

• (dict) --

  • ResourceEndpointList (list) --

    A list of endpoints for the specified signaling channel.

    • (dict) --

      An object that describes the endpoint of the signaling channel returned by the GetSignalingChannelEndpoint API.

      • Protocol (string) --

        The protocol of the signaling channel returned by the GetSignalingChannelEndpoint API.

      • ResourceEndpoint (string) --

        The endpoint of the signaling channel returned by the GetSignalingChannelEndpoint API.