Creates a new recording configuration, used to enable recording to Amazon S3.
Known issue: In the us-east-1 region, if you use the Amazon Web Services CLI to create a recording configuration, it returns success even if the S3 bucket is in a different region. In this case, the
state
of the recording configuration isCREATE_FAILED
(instead ofACTIVE
). (In other regions, the CLI correctly returns failure if the bucket is in a different region.)Workaround: Ensure that your S3 bucket is in the same region as the recording configuration. If you create a recording configuration in a different region as your S3 bucket, delete that recording configuration and create a new one with an S3 bucket from the correct region.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
create-recording-configuration
--destination-configuration <value>
[--name <value>]
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
--destination-configuration
(structure)
A complex type that contains a destination configuration for 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.
Shorthand Syntax:
s3={bucketName=string}
JSON Syntax:
{
"s3": {
"bucketName": "string"
}
}
--name
(string)
Recording-configuration name. The value does not need to be unique.
--tags
(map)
Array of 1-50 maps, each of the form
string:string (key:value)
.key -> (string)
value -> (string)
Shorthand Syntax:
KeyName1=string,KeyName2=string
JSON Syntax:
{"string": "string"
...}
--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 create a RecordingConfiguration resource
The following create-recording-configuration
example creates RecordingConfiguration resource to enable recording to Amazon S3.
aws ivs create-recording-configuration \
--name test-recording-config \
--destination-configuration S3={bucketName=demo-recording-bucket}
Output:
{
"recordingConfiguration": {
"arn": "arn:aws:ivs:us-west-2:123456789012:recording-configuration/ABcdef34ghIJ",
"name": "test-recording-config",
"destinationConfiguration": {
"s3": {
"bucketName": "demo-recording-bucket"
}
},
"state": "CREATING",
"tags": {}
}
}
For more information, see Record to Amazon S3 in the Amazon Interactive Video Service User Guide.
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)