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
NameTypeRequiredDescription
registryNameStringTrue

The name of the schema registry.

schemaNameStringTrue

The name of the schema.

Query parameters
NameTypeRequiredDescription
schemaVersionStringFalse

Specifying this limits the results to only this schema version.

Responses
Status codeResponse modelDescription
200DescribeSchemaOutput

200 response

400ErrorOutput

400 response

401ErrorOutput

401 response

403ErrorOutput

403 response

404ErrorOutput

404 response

500ErrorOutput

500 response

503ErrorOutput

503 response

POST

Operation ID: CreateSchema

Creates a schema definition.

Note

Inactive schemas will be deleted after two years.

Path parameters
NameTypeRequiredDescription
registryNameStringTrue

The name of the schema registry.

schemaNameStringTrue

The name of the schema.

Responses
Status codeResponse modelDescription
201SchemaOutput

201 response

400ErrorOutput

400 response

403ErrorOutput

403 response

500ErrorOutput

500 response

503ErrorOutput

503 response

PUT

Operation ID: UpdateSchema

Updates the schema definition

Note

Inactive schemas will be deleted after two years.

Path parameters
NameTypeRequiredDescription
registryNameStringTrue

The name of the schema registry.

schemaNameStringTrue

The name of the schema.

Responses
Status codeResponse modelDescription
200SchemaOutput

200 response

304None

304 response

400ErrorOutput

400 response

403ErrorOutput

403 response

404ErrorOutput

404 response

500ErrorOutput

500 response

503ErrorOutput

503 response

DELETE

Operation ID: DeleteSchema

Delete a schema definition.

Path parameters
NameTypeRequiredDescription
registryNameStringTrue

The name of the schema registry.

schemaNameStringTrue

The name of the schema.

Responses
Status codeResponse modelDescription
204None

204 response

400ErrorOutput

400 response

401ErrorOutput

401 response

403ErrorOutput

403 response

404ErrorOutput

404 response

500ErrorOutput

500 response

503ErrorOutput

503 response

OPTIONS

Path parameters
NameTypeRequiredDescription
registryNameStringTrue

The name of the schema registry.

schemaNameStringTrue

The name of the schema.

Responses
Status codeResponse modelDescription
200None

200 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

PropertyTypeRequiredDescription
Content

string

MinLength: 1

MaxLength: 100000

True

The source of the schema definition.

Description

string

MinLength: 0

MaxLength: 256

False

A description of the schema.

tags

Tags

False

Tags associated with the schema.

Type

Type

True

The type of schema.

Valid types include OpenApi3 and JSONSchemaDraft4.

DescribeSchemaOutput

PropertyTypeRequiredDescription
Content

string

False

The source of the schema definition.

Description

string

False

The description of the schema.

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.

SchemaVersion

string

False

The version number of the schema

tags

Tags

False

Tags associated with the resource.

Type

string

False

The type of the schema.

Valid types include OpenApi3 and JSONSchemaDraft4.

VersionCreatedDate

string

Format: date-time

False

The date the schema version was created.

ErrorOutput

PropertyTypeRequiredDescription
Code

string

True

The error code.

Message

string

True

The message string of the error output.

SchemaOutput

PropertyTypeRequiredDescription
Description

string

False

The description of the schema.

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.

SchemaVersion

string

False

The version number of the schema

tags

Tags

False
Type

string

False

The type of the schema.

Valid types include OpenApi3 and JSONSchemaDraft4.

VersionCreatedDate

string

Format: date-time

False

The date the schema version was created.

Tags

Key-value pairs associated with a resource.

PropertyTypeRequiredDescription

*

string

False

Type

The type of schema to export.

  • OpenApi3

  • JSONSchemaDraft4

UpdateSchemaInput

PropertyTypeRequiredDescription
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.

Description

string

MinLength: 0

MaxLength: 256

False

The description of the schema.

Type

Type

False

The schema type for the events schema.

Valid types include OpenApi3 and JSONSchemaDraft4.