[ aws . kinesisvideo ]

get-data-endpoint

Description

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

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-data-endpoint
[--stream-name <value>]
[--stream-arn <value>]
--api-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--stream-name (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.

--stream-arn (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.

--api-name (string)

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

Possible values:

• PUT_MEDIA

• GET_MEDIA

• LIST_FRAGMENTS

• GET_MEDIA_FOR_FRAGMENT_LIST

• GET_HLS_STREAMING_SESSION_URL

• GET_DASH_STREAMING_SESSION_URL

• GET_CLIP

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Output

DataEndpoint -> (string)

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