ListRecordingConfigurations - Amazon IVS

ListRecordingConfigurations

Gets summary information about all recording configurations in your account, in the AWS region where the API request is processed.

Request Syntax

POST /ListRecordingConfigurations HTTP/1.1 Content-type: application/json { "maxResults": number, "nextToken": "string" }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

maxResults

Maximum number of recording configurations to return. Default: 50.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 50.

Required: No

nextToken

The first recording configuration to retrieve. This is used for pagination; see the nextToken response field.

Type: String

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

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "nextToken": "string", "recordingConfigurations": [ { "arn": "string", "destinationConfiguration": { "s3": { "bucketName": "string" } }, "name": "string", "state": "string", "tags": { "string" : "string" } } ] }

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.

nextToken

If there are more recording configurations than maxResults, use nextToken in the request to get the next set.

Type: String

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

recordingConfigurations

List of the matching recording configurations.

Type: Array of RecordingConfigurationSummary objects

Errors

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

AccessDeniedException

HTTP Status Code: 403

InternalServerException

HTTP Status Code: 500

ValidationException

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: