Code Binding - Amazon EventBridge Schemas

Code Binding

URI

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

HTTP methods

GET

Operation ID: DescribeCodeBinding

Describe the code binding URI.

Path parameters
NameTypeRequiredDescription
registryNameStringTrue

The name of the schema registry.

schemaNameStringTrue

The name of the schema.

languageStringTrue

The language of the code binding. The supported languages and corresponding values are as follows:

  • Java: Java8

  • Python: Python36

  • TypeScript: TypeScript3

  • Golang: Go1

Query parameters
NameTypeRequiredDescription
schemaVersionStringFalse

Specifying this limits the results to only this schema version.

Responses
Status codeResponse modelDescription
200CodeBindingOutput

200 response

400ErrorOutput

400 response

401ErrorOutput

401 response

403ErrorOutput

403 response

404ErrorOutput

404 response

429ErrorOutput

429 response

500ErrorOutput

500 response

POST

Operation ID: PutCodeBinding

Put code binding URI

Path parameters
NameTypeRequiredDescription
registryNameStringTrue

The name of the schema registry.

schemaNameStringTrue

The name of the schema.

languageStringTrue

The language of the code binding. The supported languages and corresponding values are as follows:

  • Java: Java8

  • Python: Python36

  • TypeScript: TypeScript3

  • Golang: Go1

Query parameters
NameTypeRequiredDescription
schemaVersionStringFalse

Specifying this limits the results to only this schema version.

Responses
Status codeResponse modelDescription
202CodeBindingOutput

202 response

400ErrorOutput

400 response

401ErrorOutput

401 response

403ErrorOutput

403 response

404ErrorOutput

404 response

410ErrorOutput

410 response

429ErrorOutput

429 response

500ErrorOutput

500 response

OPTIONS

Path parameters
NameTypeRequiredDescription
registryNameStringTrue

The name of the schema registry.

schemaNameStringTrue

The name of the schema.

languageStringTrue

The language of the code binding. The supported languages and corresponding values are as follows:

  • Java: Java8

  • Python: Python36

  • TypeScript: TypeScript3

  • Golang: Go1

Query parameters
NameTypeRequiredDescription
schemaVersionStringFalse

Specifying this limits the results to only this schema version.

Responses
Status codeResponse modelDescription
200None

200 response

Schemas

Response bodies

{ "Status": enum, "LastModified": "string", "CreationDate": "string", "SchemaVersion": "string" }
{ "Message": "string", "Code": "string" }

Properties

CodeBindingOutput

PropertyTypeRequiredDescription
CreationDate

string

Format: date-time

False

The time and date that the code binding was created.

LastModified

string

Format: date-time

False

The date and time that code bindings were modified.

SchemaVersion

string

False

The version number of the schema.

Status

CodeGenerationStatus

False

The current status of code binding generation.

CodeGenerationStatus

  • CREATE_IN_PROGRESS

  • CREATE_COMPLETE

  • CREATE_FAILED

ErrorOutput

PropertyTypeRequiredDescription
Code

string

True

The error code.

Message

string

True

The message string of the error output.