Registry - Amazon EventBridge Schemas

Registry

URI

/v1/registries/name/registryName

HTTP methods

GET

Operation ID: DescribeRegistry

Describes the registry.

Path parameters
Name Type Required Description
registryName String True

The name of the schema registry.

Responses
Status code Response model Description
200 RegistryOutput

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: CreateRegistry

Creates a registry.

Path parameters
Name Type Required Description
registryName String True

The name of the schema registry.

Responses
Status code Response model Description
201 RegistryOutput

201 response

400 ErrorOutput

400 response

401 ErrorOutput

401 response

403 ErrorOutput

403 response

409 ErrorOutput

409 response

500 ErrorOutput

500 response

503 ErrorOutput

503 response

PUT

Operation ID: UpdateRegistry

Path parameters
Name Type Required Description
registryName String True

The name of the schema registry.

Responses
Status code Response model Description
200 RegistryOutput

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

DELETE

Operation ID: DeleteRegistry

Deletes a Registry.

Path parameters
Name Type Required Description
registryName String True

The name of the schema registry.

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

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

Response bodies

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

Properties

CreateRegistryInput

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

Property Type Required Description
Message

string

True

The message string of the error output.

Code

string

True

The error code.

RegistryOutput

Property Type Required Description
Description

string

False

The description of the registry.

RegistryName

string

False

The name of the registry.

RegistryArn

string

False

The ARN of the registry.

tags

Tags

False

Tags associated with the registry.

Tags

Key-value pairs associated with a resource.

Property Type Required Description

*

string

False

UpdateRegistryInput

Property Type Required Description
Description

string

MinLength: 0

MaxLength: 256

False

The description of the registry to update.