Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListSchemaVersions

Returns a list of schema versions that you have created, with minimal information. Schema versions in Deleted status will not be included in the results. Empty results will be returned if there are no schema versions available.

Request Syntax


{
   "MaxResults": number,
   "NextToken": "string",
   "SchemaId": { 
      "RegistryName": "string",
      "SchemaArn": "string",
      "SchemaName": "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

SchemaId

This is a wrapper structure to contain schema identity fields. The structure contains:

SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. Either SchemaArn or SchemaName and RegistryName has to be provided.
SchemaId$SchemaName: The name of the schema. Either SchemaArn or SchemaName and RegistryName has to be provided.

Type: SchemaId object

Required: Yes

Response Syntax


{
   "NextToken": "string",
   "Schemas": [ 
      { 
         "CreatedTime": "string",
         "SchemaArn": "string",
         "SchemaVersionId": "string",
         "Status": "string",
         "VersionNumber": 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

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 SchemaVersionList objects containing details of each schema version.

Type: Array of SchemaVersionListItem 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