Search Schemas - Amazon EventBridge Schemas

Search Schemas

URI

/v1/registries/name/registryName/schemas/search

HTTP methods

GET

Operation ID: SearchSchemas

Search the schemas

Path parameters
Name Type Required Description
registryName String True

The name of the schema registry.

Query parameters
Name Type Required Description
keywords String True

Specifying this limits the results to only schemas that include the provided keywords.

limit String False

The maximum number of results to return per page.

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.

Responses
Status code Response model Description
200 SearchSchemasOutput

200 response

400 ErrorOutput

400 response

401 ErrorOutput

401 response

403 ErrorOutput

403 response

500 ErrorOutput

500 response

503 ErrorOutput

503 response

Schemas

Response bodies

{ "NextToken": "string", "Schemas": [ { "Type": "string", "RegistryName": "string", "SchemaVersions": [ { "SchemaVersion": "string", "CreatedDate": "string" } ], "SchemaName": "string", "SchemaArn": "string" } ] }
{ "Message": "string", "Code": "string" }

Properties

ErrorOutput

Property Type Required Description
Message

string

True

The message string of the error output.

Code

string

True

The error code.

SearchSchemaSummary

Property Type Required Description
Type

string

False

The type of schema to export.

RegistryName

string

False

The name of the registry.

SchemaVersions

Array of type SearchSchemaVersionSummary

False

An array of schema version summaries.

SchemaName

string

False

The name of the schema.

SchemaArn

string

False

The ARN of the schema.

SearchSchemaVersionSummary

Property Type Required Description
SchemaVersion

string

False

The version number of the schema

CreatedDate

string

Format: date-time

False

The date the schema version was created.

SearchSchemasOutput

Property Type Required Description
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 SearchSchemaSummary

False

An array of SearchSchemaSummary information.