data_endpoints

Creates, updates, deletes, gets or lists a data_endpoints resource.

Overview

Name	data_endpoints
Type	Resource
Id	aws.kinesisvideo.data_endpoints

Fields

The following fields are returned by SELECT queries:

get_data_endpoint

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

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_data_endpoint	select	region		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). 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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_data_endpoint

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). 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.

SELECT
data_endpoint
FROM aws.kinesisvideo.data_endpoints
WHERE region = '{{ region }}' -- required
;