[ aws . ivs ]

get-recording-configuration

Description

Gets the recording configuration for the specified ARN.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-recording-configuration
--arn <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--arn (string)

ARN of the recording configuration 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.

Examples

To get information about a RecordingConfiguration resource

The following get-recording-configuration example gets information about the RecordingConfiguration resource for the specified ARN.

aws ivs get-recording-configuration \
    --arn "arn:aws:ivs:us-west-2:123456789012:recording-configuration/ABcdef34ghIJ"

Output:

{
    "recordingConfiguration": {
        "arn": "arn:aws:ivs:us-west-2:123456789012:recording-configuration/ABcdef34ghIJ",
        "name": "test-recording-config",
        "destinationConfiguration": {
            "s3": {
                "bucketName": "demo-recording-bucket"
            }
        },
        "state": "ACTIVE",
        "tags": {}
    }
}

For more information, see Record to Amazon S3 in the Amazon Interactive Video Service User Guide.

Output

recordingConfiguration -> (structure)

arn -> (string)

Recording-configuration ARN.

destinationConfiguration -> (structure)

A complex type that contains information about where recorded video will be stored.

s3 -> (structure)

An S3 destination configuration where recorded videos will be stored.

bucketName -> (string)

Location (S3 bucket name) where recorded videos will be stored.

name -> (string)

Recording-configuration name. The value does not need to be unique.

state -> (string)

Indicates the current state of the recording configuration. When the state is ACTIVE , the configuration is ready for recording a channel stream.

tags -> (map)

Array of 1-50 maps, each of the form string:string (key:value) .

key -> (string)

value -> (string)