Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics, so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can choose “Customize” or “Decline” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To accept or decline all non-essential cookies, choose “Accept” or “Decline.” To make more detailed choices, choose “Customize.”

Schemas - Amazon EventBridge Schemas

Schemas

URI

/v1/registries/name/registryName/schemas

HTTP methods

GET

Operation ID: ListSchemas

List the schemas.

Path parameters
NameTypeRequiredDescription
registryNameStringTrue

The name of the schema registry.

Query parameters
NameTypeRequiredDescription
schemaNamePrefixStringFalse

Specifying this limits the results to only those schema names that start with the specified prefix.

limitStringFalse

The maximum number of results to return per page.

nextTokenStringFalse

The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.

Responses
Status codeResponse modelDescription
200ListSchemasOutput

200 response

400ErrorOutput

400 response

401ErrorOutput

401 response

403ErrorOutput

403 response

500ErrorOutput

500 response

503ErrorOutput

503 response

OPTIONS

Path parameters
NameTypeRequiredDescription
registryNameStringTrue

The name of the schema registry.

Responses
Status codeResponse modelDescription
200None

200 response

Schemas

Response bodies

{ "NextToken": "string", "Schemas": [ { "LastModified": "string", "VersionCount": integer, "SchemaName": "string", "SchemaArn": "string", "tags": { } } ] }

ListSchemasOutput schema

{ "NextToken": "string", "Schemas": [ { "LastModified": "string", "VersionCount": integer, "SchemaName": "string", "SchemaArn": "string", "tags": { } } ] }
{ "Message": "string", "Code": "string" }

ErrorOutput schema

{ "Message": "string", "Code": "string" }

Properties

ErrorOutput

PropertyTypeRequiredDescription
Code

string

True

The error code.

Message

string

True

The message string of the error output.

ListSchemasOutput

PropertyTypeRequiredDescription
NextToken

string

False

The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.

Schemas

Array of type SchemaSummary

False

An array of schema summaries.

SchemaSummary

A summary of schema details.

PropertyTypeRequiredDescription
LastModified

string

Format: date-time

False

The date and time that schema was modified.

SchemaArn

string

False

The ARN of the schema.

SchemaName

string

False

The name of the schema.

tags

Tags

False

Tags associated with the schema.

VersionCount

integer

Format: int64

False

The number of versions available for the schema.

Tags

Key-value pairs associated with a resource.

PropertyTypeRequiredDescription

*

string

False
PrivacySite termsCookie preferences
© 2024, Amazon Web Services, Inc. or its affiliates. All rights reserved.