Export - Amazon EventBridge Schemas

Export

Exports a schema.

URI

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

HTTP methods

GET

Operation ID: ExportSchema

Exports a schema.

Path parameters
NameTypeRequiredDescription
registryNameStringTrue

The name of the schema registry.

schemaNameStringTrue

The name of the schema.

Query parameters
NameTypeRequiredDescription
typeStringTrue

The type of schema to export.

schemaVersionStringFalse

Specifying this limits the results to only this schema version.

Responses
Status codeResponse modelDescription
200ExportSchemaOutput

200 response

400ErrorOutput

400 response

401ErrorOutput

401 response

403ErrorOutput

403 response

404ErrorOutput

404 response

429ErrorOutput

429 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

Response bodies

{ "Type": "string", "SchemaVersion": "string", "Content": "string", "SchemaName": "string", "SchemaArn": "string" }
{ "Message": "string", "Code": "string" }

Properties

ErrorOutput

PropertyTypeRequiredDescription
Code

string

True

The error code.

Message

string

True

The message string of the error output.

ExportSchemaOutput

The schema to export.

PropertyTypeRequiredDescription
Content

string

False

The content of the schema.

SchemaArn

string

False

The ARN of the schema to export.

SchemaName

string

False

The name of the schema to export.

SchemaVersion

string

False

The version of the schema to export.

Type

string

False

The type of schema to export.