Registry - Amazon EventBridge Schemas

Registry

URI

/v1/registries/name/registryName

HTTP methods

GET

Operation ID: DescribeRegistry

Describes the registry.

Path parameters
NameTypeRequiredDescription
registryNameStringTrue

The name of the schema registry.

Responses
Status codeResponse modelDescription
200RegistryOutput

200 response

400ErrorOutput

400 response

401ErrorOutput

401 response

403ErrorOutput

403 response

404ErrorOutput

404 response

500ErrorOutput

500 response

503ErrorOutput

503 response

POST

Operation ID: CreateRegistry

Creates a registry.

Path parameters
NameTypeRequiredDescription
registryNameStringTrue

The name of the schema registry.

Responses
Status codeResponse modelDescription
201RegistryOutput

201 response

400ErrorOutput

400 response

401ErrorOutput

401 response

403ErrorOutput

403 response

409ErrorOutput

409 response

500ErrorOutput

500 response

503ErrorOutput

503 response

PUT

Operation ID: UpdateRegistry

Path parameters
NameTypeRequiredDescription
registryNameStringTrue

The name of the schema registry.

Responses
Status codeResponse modelDescription
200RegistryOutput

200 response

400ErrorOutput

400 response

401ErrorOutput

401 response

403ErrorOutput

403 response

404ErrorOutput

404 response

500ErrorOutput

500 response

503ErrorOutput

503 response

DELETE

Operation ID: DeleteRegistry

Deletes a Registry.

Path parameters
NameTypeRequiredDescription
registryNameStringTrue

The name of the schema registry.

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.

Responses
Status codeResponse modelDescription
200None

200 response

Schemas

Request bodies

{ "Description": "string", "tags": { } }
{ "Description": "string" }

Response bodies

{ "Description": "string", "RegistryName": "string", "RegistryArn": "string", "tags": { } }
{ "Message": "string", "Code": "string" }

Properties

CreateRegistryInput

PropertyTypeRequiredDescription
Description

string

MinLength: 0

MaxLength: 256

False

A description of the registry to be created.

tags

Tags

False

Tags to associate with the registry.

ErrorOutput

PropertyTypeRequiredDescription
Code

string

True

The error code.

Message

string

True

The message string of the error output.

RegistryOutput

PropertyTypeRequiredDescription
Description

string

False

The description of the registry.

RegistryArn

string

False

The ARN of the registry.

RegistryName

string

False

The name of the registry.

tags

Tags

False

Tags associated with the registry.

Tags

Key-value pairs associated with a resource.

PropertyTypeRequiredDescription

*

string

False

UpdateRegistryInput

PropertyTypeRequiredDescription
Description

string

MinLength: 0

MaxLength: 256

False

The description of the registry to update.