BatchGetSchemaAnalysisRule - AWS Clean Rooms


Retrieves multiple analysis rule schemas.

Request Syntax

POST /collaborations/collaborationIdentifier/batch-schema-analysis-rule HTTP/1.1 Content-type: application/json { "schemaAnalysisRuleRequests": [ { "name": "string", "type": "string" } ] }

URI Request Parameters

The request uses the following URI parameters.


The unique identifier of the collaboration that contains the schema analysis rule.

Length Constraints: Fixed length of 36.

Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Required: Yes

Request Body

The request accepts the following data in JSON format.


The information that's necessary to retrieve a schema analysis rule.

Type: Array of SchemaAnalysisRuleRequest objects

Array Members: Minimum number of 1 item. Maximum number of 25 items.

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "analysisRules": [ { "collaborationId": "string", "createTime": number, "name": "string", "policy": { ... }, "type": "string", "updateTime": number } ], "errors": [ { "code": "string", "message": "string", "name": "string", "type": "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.


The retrieved list of analysis rules.

Type: Array of AnalysisRule objects

Array Members: Minimum number of 0 items. Maximum number of 25 items.


Error reasons for schemas that could not be retrieved. One error is returned for every schema that could not be retrieved.

Type: Array of BatchGetSchemaAnalysisRuleError objects

Array Members: Minimum number of 0 items. Maximum number of 25 items.


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


Caller does not have sufficient access to perform this action.

HTTP Status Code: 403


Unexpected error during processing of request.

HTTP Status Code: 500


Request references a resource which does not exist.

HTTP Status Code: 404


Request was denied due to request throttling.

HTTP Status Code: 429


The input fails to satisfy the specified constraints.

HTTP Status Code: 400

See Also

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