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

ListSchemas

Lists the schemas for relations within a collaboration.

Request Syntax


GET /collaborations/collaborationIdentifier/schemas?maxResults=maxResults&nextToken=nextToken&schemaType=schemaType HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

collaborationIdentifier

A unique identifier for the collaboration that the schema belongs to. Currently accepts a 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

maxResults

The maximum size of the results that is returned per call.

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

nextToken

The token value retrieved from a previous call to access the next page of results.

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

schemaType

If present, filter schemas by schema type. The only valid schema type is currently `TABLE`.

Valid Values: TABLE

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "schemaSummaries": [ 
      { 
         "analysisMethod": "string",
         "analysisRuleTypes": [ "string" ],
         "collaborationArn": "string",
         "collaborationId": "string",
         "createTime": number,
         "creatorAccountId": "string",
         "name": "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.

nextToken

The token value retrieved from a previous call to access the next page of results.

Type: String

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

schemaSummaries

The retrieved list of schemas.

Type: Array of SchemaSummary objects

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