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

ListSchemaMappings

Returns a list of all the SchemaMappings that have been created for an AWS account.

Request Syntax


GET /schemas?maxResults=maxResults&nextToken=nextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

maxResults

The maximum number of objects returned per page.

Valid Range: Maximum value of 25.

nextToken

The pagination token from the previous API call.

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

Pattern: ^[a-zA-Z_0-9-=+/]*$

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "schemaList": [ 
      { 
         "createdAt": number,
         "hasWorkflows": boolean,
         "schemaArn": "string",
         "schemaName": "string",
         "updatedAt": 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 pagination token from the previous API call.

Type: String

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

Pattern: ^[a-zA-Z_0-9-=+/]*$

schemaList

A list of SchemaMappingSummary objects, each of which contain the fields SchemaName, SchemaArn, CreatedAt, UpdatedAt.

Type: Array of SchemaMappingSummary objects

Errors

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

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

This exception occurs when there is an internal failure in the AWS Entity Resolution service.

HTTP Status Code: 500

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by AWS Entity Resolution.

HTTP Status Code: 400