Gets stream-key information for a specified ARN.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
get-stream-key
--arn <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
--arn
(string)
ARN for the stream key to be retrieved.
--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.
See ‘aws help’ for descriptions of global parameters.
To get information about a stream
The following get-stream-key
example gets information about the specified stream key.
aws ivs get-stream-key \
--arn arn:aws:ivs:us-west-2:123456789012:stream-key/skSKABCDefgh \
--region=us-west-2
Output:
{
"streamKey": {
"arn": "arn:aws:ivs:us-west-2:123456789012:stream-key/skSKABCDefgh",
"value": "sk_us-west-2_abcdABCDefgh_567890abcdef",
"channelArn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh",
"tags": {}
}
}
For more information, see Create a Channel in the Amazon Interactive Video Service User Guide.
streamKey -> (structure)
arn -> (string)
Stream-key ARN.
channelArn -> (string)
Channel ARN for the stream.
tags -> (map)
Array of 1-50 maps, each of the form
string:string (key:value)
.key -> (string)
value -> (string)
value -> (string)
Stream-key value.