Schema - Amazon EventBridge Schemas

Schema

URI

/v1/registries/name/registryName/schemas/name/schemaName

HTTP methods

GET

Operation ID: DescribeSchema

Retrieve the schema definition.

Path parameters
Name Type Required Description
registryName String True

The name of the schema registry.

schemaName String True

The name of the schema.

Query parameters
Name Type Required Description
schemaVersion String False

Specifying this limits the results to only this schema version.

Responses
Status code Response model Description
200 DescribeSchemaOutput

200 response

400 ErrorOutput

400 response

401 ErrorOutput

401 response

403 ErrorOutput

403 response

404 ErrorOutput

404 response

500 ErrorOutput

500 response

503 ErrorOutput

503 response

POST

Operation ID: CreateSchema

Creates a schema definition.

Note

Inactive schemas will be deleted after two years.

Path parameters
Name Type Required Description
registryName String True

The name of the schema registry.

schemaName String True

The name of the schema.

Responses
Status code Response model Description
201 SchemaOutput

201 response

400 ErrorOutput

400 response

403 ErrorOutput

403 response

500 ErrorOutput

500 response

503 ErrorOutput

503 response

PUT

Operation ID: UpdateSchema

Updates the schema definition

Note

Inactive schemas will be deleted after two years.

Path parameters
Name Type Required Description
registryName String True

The name of the schema registry.

schemaName String True

The name of the schema.

Responses
Status code Response model Description
200 SchemaOutput

200 response

304 None

304 response

400 ErrorOutput

400 response

403 ErrorOutput

403 response

404 ErrorOutput

404 response

500 ErrorOutput

500 response

503 ErrorOutput

503 response

DELETE

Operation ID: DeleteSchema

Delete a schema definition.

Path parameters
Name Type Required Description
registryName String True

The name of the schema registry.

schemaName String True

The name of the schema.

Responses
Status code Response model Description
204 None

204 response

400 ErrorOutput

400 response

401 ErrorOutput

401 response

403 ErrorOutput

403 response

404 ErrorOutput

404 response

500 ErrorOutput

500 response

503 ErrorOutput

503 response

Schemas

Request bodies

{ "Type": enum, "Description": "string", "Content": "string", "tags": { } }
{ "Type": enum, "Description": "string", "ClientTokenId": "string", "Content": "string" }

Response bodies

{ "LastModified": "string", "Type": "string", "Description": "string", "SchemaVersion": "string", "Content": "string", "VersionCreatedDate": "string", "SchemaArn": "string", "SchemaName": "string", "tags": { } }
{ "LastModified": "string", "Type": "string", "Description": "string", "SchemaVersion": "string", "VersionCreatedDate": "string", "SchemaArn": "string", "SchemaName": "string", "tags": { } }
{ "Message": "string", "Code": "string" }

Properties

CreateSchemaInput

Property Type Required Description
Type

Type

True

The type of schema.

Description

string

MinLength: 0

MaxLength: 256

False

A description of the schema.

Content

string

MinLength: 1

MaxLength: 100000

True

The source of the schema definition.

tags

Tags

False

Tags associated with the schema.

DescribeSchemaOutput

Property Type Required Description
LastModified

string

Format: date-time

False

The date and time that schema was modified.

Type

string

False

The type of the schema.

Description

string

False

The description of the schema.

SchemaVersion

string

False

The version number of the schema

Content

string

False

The source of the schema definition.

VersionCreatedDate

string

Format: date-time

False

The date the schema version was created.

SchemaArn

string

False

The ARN of the schema.

SchemaName

string

False

The name of the schema.

tags

Tags

False

Tags associated with the resource.

ErrorOutput

Property Type Required Description
Message

string

True

The message string of the error output.

Code

string

True

The error code.

SchemaOutput

Property Type Required Description
LastModified

string

Format: date-time

False

The date and time that schema was modified.

Type

string

False

The type of the schema.

Description

string

False

The description of the schema.

SchemaVersion

string

False

The version number of the schema

VersionCreatedDate

string

Format: date-time

False

The date the schema version was created.

SchemaArn

string

False

The ARN of the schema.

SchemaName

string

False

The name of the schema.

tags

Tags

False

Tags

Key-value pairs associated with a resource.

Property Type Required Description

*

string

False

Type

The type of schema to export.

  • OpenApi3

  • JSONSchemaDraft4

UpdateSchemaInput

Property Type Required Description
Type

Type

False

The schema type for the events schema.

Description

string

MinLength: 0

MaxLength: 256

False

The description of the schema.

ClientTokenId

string

MinLength: 0

MaxLength: 36

False

The ID of the client token.

Content

string

MinLength: 1

MaxLength: 100000

False

The source of the schema definition.