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

GetRecordingConfiguration

Gets the recording configuration for the specified ARN.

Request Syntax


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

{
   "arn": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

arn

ARN of the recording configuration to be retrieved.

Type: String

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

Pattern: arn:aws:ivs:[a-z0-9-]+:[0-9]+:recording-configuration/[a-zA-Z0-9-]+

Required: Yes

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

InternalServerException

exceptionMessage: Unexpected error during processing of request.

HTTP Status Code: 500

ResourceNotFoundException

exceptionMessage: Request references a resource which does not exist.

HTTP Status Code: 404

ValidationException

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

HTTP Status Code: 400