BatchGetSchema - AWS Clean Rooms

BatchGetSchema

Retrieves multiple schemas by their identifiers.

Request Syntax

POST /collaborations/collaborationIdentifier/batch-schema HTTP/1.1 Content-type: application/json { "names": [ "string" ] }

URI Request Parameters

The request uses the following URI parameters.

collaborationIdentifier

A unique identifier for the collaboration that the schemas belong to. Currently accepts collaboration ID.

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.

names

The names for the schema objects to retrieve.

Type: Array of strings

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

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

Pattern: [a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "errors": [ { "code": "string", "message": "string", "name": "string" } ], "schemas": [ { "analysisMethod": "string", "analysisRuleTypes": [ "string" ], "collaborationArn": "string", "collaborationId": "string", "columns": [ { "name": "string", "type": "string" } ], "createTime": number, "creatorAccountId": "string", "description": "string", "name": "string", "partitionKeys": [ { "name": "string", "type": "string" } ], "schemaStatusDetails": [ { "analysisRuleType": "string", "configurations": [ "string" ], "reasons": [ { "code": "string", "message": "string" } ], "status": "string" } ], "type": "string", "updateTime": 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.

errors

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

Type: Array of BatchGetSchemaError objects

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

schemas

The retrieved list of schemas.

Type: Array of Schema objects

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

Errors

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

AccessDeniedException

Caller does not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

Unexpected error during processing of request.

HTTP Status Code: 500

ResourceNotFoundException

Request references a resource which does not exist.

HTTP Status Code: 404

ThrottlingException

Request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

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: