KinesisVideo / Client / get_data_endpoint

get_data_endpoint#

KinesisVideo.Client.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'|'GET_HLS_STREAMING_SESSION_URL'|'GET_DASH_STREAMING_SESSION_URL'|'GET_CLIP'|'GET_IMAGES'
)
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.

Exceptions

  • KinesisVideo.Client.exceptions.InvalidArgumentException

  • KinesisVideo.Client.exceptions.ResourceNotFoundException

  • KinesisVideo.Client.exceptions.ClientLimitExceededException

  • KinesisVideo.Client.exceptions.NotAuthorizedException