Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateRecordingConfiguration

Creates a new recording configuration, used to enable recording to Amazon S3.

Known issue: In the us-east-1 region, if you use the AWS 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 is CREATE_FAILED (instead of ACTIVE). (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.

Request Syntax


POST /CreateRecordingConfiguration HTTP/1.1
Content-type: application/json

{
   "destinationConfiguration": { 
      "s3": { 
         "bucketName": "string"
      }
   },
   "name": "string",
   "recordingReconnectWindowSeconds": number,
   "renditionConfiguration": { 
      "renditions": [ "string" ],
      "renditionSelection": "string"
   },
   "tags": { 
      "string" : "string" 
   },
   "thumbnailConfiguration": { 
      "recordingMode": "string",
      "resolution": "string",
      "storage": [ "string" ],
      "targetIntervalSeconds": number
   }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

destinationConfiguration

A complex type that contains a destination configuration for where recorded video will be stored.

Type: DestinationConfiguration object

Required: Yes

name

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

Type: String

Length Constraints: Minimum length of 0. Maximum length of 128.

Pattern: [a-zA-Z0-9-_]*

Required: No

recordingReconnectWindowSeconds

If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together. Default: 0.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 300.

Required: No

renditionConfiguration

Object that describes which renditions should be recorded for a stream.

Type: RenditionConfiguration object

Required: No

tags

Array of 1-50 maps, each of the form string:string (key:value). See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No

thumbnailConfiguration

A complex type that allows you to enable/disable the recording of thumbnails for a live session and modify the interval at which thumbnails are generated for the live session.

Type: ThumbnailConfiguration object

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "recordingConfiguration": { 
      "arn": "string",
      "destinationConfiguration": { 
         "s3": { 
            "bucketName": "string"
         }
      },
      "name": "string",
      "recordingReconnectWindowSeconds": number,
      "renditionConfiguration": { 
         "renditions": [ "string" ],
         "renditionSelection": "string"
      },
      "state": "string",
      "tags": { 
         "string" : "string" 
      },
      "thumbnailConfiguration": { 
         "recordingMode": "string",
         "resolution": "string",
         "storage": [ "string" ],
         "targetIntervalSeconds": number
      }
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

recordingConfiguration

An object representing a configuration to record a channel stream.

Type: RecordingConfiguration object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

exceptionMessage: User does not have sufficient access to perform this action.

HTTP Status Code: 403

ConflictException

exceptionMessage: Updating or deleting a resource can cause an inconsistent state.

HTTP Status Code: 409

InternalServerException

exceptionMessage: Unexpected error during processing of request.

HTTP Status Code: 500

PendingVerification

exceptionMessage: Your account is pending verification.

HTTP Status Code: 403

ServiceQuotaExceededException

exceptionMessage: Request would cause a service quota to be exceeded.

HTTP Status Code: 402

ValidationException

exceptionMessage: The input fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400