Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListSchemas

Returns a list of schemas with minimal details. Schemas in Deleting status will not be included in the results. Empty results will be returned if there are no schemas available.

When the RegistryId is not provided, all the schemas across registries will be part of the API response.

Request Syntax


{
   "MaxResults": number,
   "NextToken": "string",
   "RegistryId": { 
      "RegistryArn": "string",
      "RegistryName": "string"
   }
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

MaxResults

Maximum number of results required per page. If the value is not supplied, this will be defaulted to 25 per page.

Type: Integer

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

Required: No

NextToken

A continuation token, if this is a continuation call.

Type: String

Required: No

RegistryId

A wrapper structure that may contain the registry name and Amazon Resource Name (ARN).

Type: RegistryId object

Required: No

Response Syntax


{
   "NextToken": "string",
   "Schemas": [ 
      { 
         "CreatedTime": "string",
         "Description": "string",
         "RegistryName": "string",
         "SchemaArn": "string",
         "SchemaName": "string",
         "SchemaStatus": "string",
         "UpdatedTime": "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

A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.

Type: String

Schemas

An array of SchemaListItem objects containing details of each schema.

Type: Array of SchemaListItem objects

Errors

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

AccessDeniedException

Access to a resource was denied.

HTTP Status Code: 400

EntityNotFoundException

A specified entity does not exist

HTTP Status Code: 400

InternalServiceException

An internal service error occurred.

HTTP Status Code: 500

InvalidInputException

The input provided was not valid.

HTTP Status Code: 400