codegen-resources.service-2.json Maven / Gradle / Ivy
Show all versions of schemas Show documentation
{
"metadata": {
"apiVersion": "2019-12-02",
"endpointPrefix": "schemas",
"signingName": "schemas",
"serviceFullName": "Schemas",
"serviceId": "schemas",
"protocol": "rest-json",
"jsonVersion": "1.1",
"uid": "schemas-2019-12-02",
"signatureVersion": "v4"
},
"operations": {
"CreateDiscoverer": {
"name": "CreateDiscoverer",
"http": {
"method": "POST",
"requestUri": "/v1/discoverers",
"responseCode": 201
},
"input": {
"shape": "CreateDiscovererRequest"
},
"output": {
"shape": "CreateDiscovererResponse",
"documentation": "201 response
"
},
"errors": [
{
"shape": "BadRequestException",
"documentation": "400 response
"
},
{
"shape": "InternalServerErrorException",
"documentation": "500 response
"
},
{
"shape": "UnauthorizedException",
"documentation": "401 response
"
},
{
"shape": "ForbiddenException",
"documentation": "403 response
"
},
{
"shape": "ServiceUnavailableException",
"documentation": "503 response
"
},
{
"shape": "ConflictException",
"documentation": "409 response
"
}
],
"documentation": "Creates a discoverer.
"
},
"CreateRegistry": {
"name": "CreateRegistry",
"http": {
"method": "POST",
"requestUri": "/v1/registries/name/{registryName}",
"responseCode": 201
},
"input": {
"shape": "CreateRegistryRequest"
},
"output": {
"shape": "CreateRegistryResponse",
"documentation": "201 response
"
},
"errors": [
{
"shape": "BadRequestException",
"documentation": "400 response
"
},
{
"shape": "InternalServerErrorException",
"documentation": "500 response
"
},
{
"shape": "UnauthorizedException",
"documentation": "401 response
"
},
{
"shape": "ForbiddenException",
"documentation": "403 response
"
},
{
"shape": "ServiceUnavailableException",
"documentation": "503 response
"
},
{
"shape": "ConflictException",
"documentation": "409 response
"
}
],
"documentation": "Creates a registry.
"
},
"CreateSchema": {
"name": "CreateSchema",
"http": {
"method": "POST",
"requestUri": "/v1/registries/name/{registryName}/schemas/name/{schemaName}",
"responseCode": 201
},
"input": {
"shape": "CreateSchemaRequest"
},
"output": {
"shape": "CreateSchemaResponse",
"documentation": "201 response
"
},
"errors": [
{
"shape": "ServiceUnavailableException",
"documentation": "503 response
"
},
{
"shape": "BadRequestException",
"documentation": "400 response
"
},
{
"shape": "InternalServerErrorException",
"documentation": "500 response
"
},
{
"shape": "ForbiddenException",
"documentation": "403 response
"
}
],
"documentation": "Creates a schema definition.
Inactive schemas will be deleted after two years.
400 response
"
},
{
"shape": "UnauthorizedException",
"documentation": "401 response
"
},
{
"shape": "InternalServerErrorException",
"documentation": "500 response
"
},
{
"shape": "ForbiddenException",
"documentation": "403 response
"
},
{
"shape": "NotFoundException",
"documentation": "404 response
"
},
{
"shape": "ServiceUnavailableException",
"documentation": "503 response
"
}
],
"documentation": "Deletes a discoverer.
"
},
"DeleteRegistry": {
"name": "DeleteRegistry",
"http": {
"method": "DELETE",
"requestUri": "/v1/registries/name/{registryName}",
"responseCode": 204
},
"input": {
"shape": "DeleteRegistryRequest"
},
"errors": [
{
"shape": "BadRequestException",
"documentation": "400 response
"
},
{
"shape": "UnauthorizedException",
"documentation": "401 response
"
},
{
"shape": "InternalServerErrorException",
"documentation": "500 response
"
},
{
"shape": "ForbiddenException",
"documentation": "403 response
"
},
{
"shape": "NotFoundException",
"documentation": "404 response
"
},
{
"shape": "ServiceUnavailableException",
"documentation": "503 response
"
}
],
"documentation": "Deletes a Registry.
"
},
"DeleteResourcePolicy": {
"name": "DeleteResourcePolicy",
"http": {
"method": "DELETE",
"requestUri": "/v1/policy",
"responseCode": 204
},
"input": {
"shape": "DeleteResourcePolicyRequest"
},
"errors": [
{
"shape": "BadRequestException",
"documentation": "400 response
"
},
{
"shape": "UnauthorizedException",
"documentation": "401 response
"
},
{
"shape": "InternalServerErrorException",
"documentation": "500 response
"
},
{
"shape": "ForbiddenException",
"documentation": "403 response
"
},
{
"shape": "NotFoundException",
"documentation": "404 response
"
},
{
"shape": "ServiceUnavailableException",
"documentation": "503 response
"
}
],
"documentation": "Delete the resource-based policy attached to the specified registry.
"
},
"DeleteSchema": {
"name": "DeleteSchema",
"http": {
"method": "DELETE",
"requestUri": "/v1/registries/name/{registryName}/schemas/name/{schemaName}",
"responseCode": 204
},
"input": {
"shape": "DeleteSchemaRequest"
},
"errors": [
{
"shape": "BadRequestException",
"documentation": "400 response
"
},
{
"shape": "UnauthorizedException",
"documentation": "401 response
"
},
{
"shape": "InternalServerErrorException",
"documentation": "500 response
"
},
{
"shape": "ForbiddenException",
"documentation": "403 response
"
},
{
"shape": "NotFoundException",
"documentation": "404 response
"
},
{
"shape": "ServiceUnavailableException",
"documentation": "503 response
"
}
],
"documentation": "Delete a schema definition.
"
},
"DeleteSchemaVersion": {
"name": "DeleteSchemaVersion",
"http": {
"method": "DELETE",
"requestUri": "/v1/registries/name/{registryName}/schemas/name/{schemaName}/version/{schemaVersion}",
"responseCode": 204
},
"input": {
"shape": "DeleteSchemaVersionRequest"
},
"errors": [
{
"shape": "BadRequestException",
"documentation": "400 response
"
},
{
"shape": "UnauthorizedException",
"documentation": "401 response
"
},
{
"shape": "InternalServerErrorException",
"documentation": "500 response
"
},
{
"shape": "ForbiddenException",
"documentation": "403 response
"
},
{
"shape": "NotFoundException",
"documentation": "404 response
"
},
{
"shape": "ServiceUnavailableException",
"documentation": "503 response
"
}
],
"documentation": "Delete the schema version definition
"
},
"DescribeCodeBinding": {
"name": "DescribeCodeBinding",
"http": {
"method": "GET",
"requestUri": "/v1/registries/name/{registryName}/schemas/name/{schemaName}/language/{language}",
"responseCode": 200
},
"input": {
"shape": "DescribeCodeBindingRequest"
},
"output": {
"shape": "DescribeCodeBindingResponse",
"documentation": "200 response
"
},
"errors": [
{
"shape": "BadRequestException",
"documentation": "400 response
"
},
{
"shape": "UnauthorizedException",
"documentation": "401 response
"
},
{
"shape": "InternalServerErrorException",
"documentation": "500 response
"
},
{
"shape": "ForbiddenException",
"documentation": "403 response
"
},
{
"shape": "NotFoundException",
"documentation": "404 response
"
},
{
"shape": "TooManyRequestsException",
"documentation": "429 response
"
}
],
"documentation": "Describe the code binding URI.
"
},
"DescribeDiscoverer": {
"name": "DescribeDiscoverer",
"http": {
"method": "GET",
"requestUri": "/v1/discoverers/id/{discovererId}",
"responseCode": 200
},
"input": {
"shape": "DescribeDiscovererRequest"
},
"output": {
"shape": "DescribeDiscovererResponse",
"documentation": "200 response
"
},
"errors": [
{
"shape": "BadRequestException",
"documentation": "400 response
"
},
{
"shape": "UnauthorizedException",
"documentation": "401 response
"
},
{
"shape": "InternalServerErrorException",
"documentation": "500 response
"
},
{
"shape": "ForbiddenException",
"documentation": "403 response
"
},
{
"shape": "NotFoundException",
"documentation": "404 response
"
},
{
"shape": "ServiceUnavailableException",
"documentation": "503 response
"
}
],
"documentation": "Describes the discoverer.
"
},
"DescribeRegistry": {
"name": "DescribeRegistry",
"http": {
"method": "GET",
"requestUri": "/v1/registries/name/{registryName}",
"responseCode": 200
},
"input": {
"shape": "DescribeRegistryRequest"
},
"output": {
"shape": "DescribeRegistryResponse",
"documentation": "200 response
"
},
"errors": [
{
"shape": "BadRequestException",
"documentation": "400 response
"
},
{
"shape": "UnauthorizedException",
"documentation": "401 response
"
},
{
"shape": "InternalServerErrorException",
"documentation": "500 response
"
},
{
"shape": "ForbiddenException",
"documentation": "403 response
"
},
{
"shape": "NotFoundException",
"documentation": "404 response
"
},
{
"shape": "ServiceUnavailableException",
"documentation": "503 response
"
}
],
"documentation": "Describes the registry.
"
},
"DescribeSchema": {
"name": "DescribeSchema",
"http": {
"method": "GET",
"requestUri": "/v1/registries/name/{registryName}/schemas/name/{schemaName}",
"responseCode": 200
},
"input": {
"shape": "DescribeSchemaRequest"
},
"output": {
"shape": "DescribeSchemaResponse",
"documentation": "200 response
"
},
"errors": [
{
"shape": "BadRequestException",
"documentation": "400 response
"
},
{
"shape": "UnauthorizedException",
"documentation": "401 response
"
},
{
"shape": "InternalServerErrorException",
"documentation": "500 response
"
},
{
"shape": "ForbiddenException",
"documentation": "403 response
"
},
{
"shape": "NotFoundException",
"documentation": "404 response
"
},
{
"shape": "ServiceUnavailableException",
"documentation": "503 response
"
}
],
"documentation": "Retrieve the schema definition.
"
},
"ExportSchema": {
"name": "ExportSchema",
"http": {
"method": "GET",
"requestUri": "/v1/registries/name/{registryName}/schemas/name/{schemaName}/export",
"responseCode": 200
},
"input": {
"shape": "ExportSchemaRequest"
},
"output": {
"shape": "ExportSchemaResponse",
"documentation": "200 response
"
},
"errors": [
{
"shape": "BadRequestException",
"documentation": "400 response
"
},
{
"shape": "UnauthorizedException",
"documentation": "401 response
"
},
{
"shape": "InternalServerErrorException",
"documentation": "500 response
"
},
{
"shape": "ForbiddenException",
"documentation": "403 response
"
},
{
"shape": "NotFoundException",
"documentation": "404 response
"
},
{
"shape": "ServiceUnavailableException",
"documentation": "503 response
"
},
{
"shape": "TooManyRequestsException",
"documentation": "429 response
"
}
]
},
"GetCodeBindingSource": {
"name": "GetCodeBindingSource",
"http": {
"method": "GET",
"requestUri": "/v1/registries/name/{registryName}/schemas/name/{schemaName}/language/{language}/source",
"responseCode": 200
},
"input": {
"shape": "GetCodeBindingSourceRequest"
},
"output": {
"shape": "GetCodeBindingSourceResponse",
"documentation": "200 response
"
},
"errors": [
{
"shape": "BadRequestException",
"documentation": "400 response
"
},
{
"shape": "UnauthorizedException",
"documentation": "401 response
"
},
{
"shape": "InternalServerErrorException",
"documentation": "500 response
"
},
{
"shape": "ForbiddenException",
"documentation": "403 response
"
},
{
"shape": "NotFoundException",
"documentation": "404 response
"
},
{
"shape": "TooManyRequestsException",
"documentation": "429 response
"
}
],
"documentation": "Get the code binding source URI.
"
},
"GetDiscoveredSchema": {
"name": "GetDiscoveredSchema",
"http": {
"method": "POST",
"requestUri": "/v1/discover",
"responseCode": 200
},
"input": {
"shape": "GetDiscoveredSchemaRequest"
},
"output": {
"shape": "GetDiscoveredSchemaResponse",
"documentation": "200 response
"
},
"errors": [
{
"shape": "ServiceUnavailableException",
"documentation": "503 response
"
},
{
"shape": "BadRequestException",
"documentation": "400 response
"
},
{
"shape": "UnauthorizedException",
"documentation": "401 response
"
},
{
"shape": "InternalServerErrorException",
"documentation": "500 response
"
},
{
"shape": "ForbiddenException",
"documentation": "403 response
"
}
],
"documentation": "Get the discovered schema that was generated based on sampled events.
"
},
"GetResourcePolicy": {
"name": "GetResourcePolicy",
"http": {
"method": "GET",
"requestUri": "/v1/policy",
"responseCode": 200
},
"input": {
"shape": "GetResourcePolicyRequest"
},
"output": {
"shape": "GetResourcePolicyResponse",
"documentation": "Get Resource-Based Policy Response
"
},
"errors": [
{
"shape": "BadRequestException",
"documentation": "400 response
"
},
{
"shape": "UnauthorizedException",
"documentation": "401 response
"
},
{
"shape": "InternalServerErrorException",
"documentation": "500 response
"
},
{
"shape": "ForbiddenException",
"documentation": "403 response
"
},
{
"shape": "NotFoundException",
"documentation": "404 response
"
},
{
"shape": "ServiceUnavailableException",
"documentation": "503 response
"
}
],
"documentation": "Retrieves the resource-based policy attached to a given registry.
"
},
"ListDiscoverers": {
"name": "ListDiscoverers",
"http": {
"method": "GET",
"requestUri": "/v1/discoverers",
"responseCode": 200
},
"input": {
"shape": "ListDiscoverersRequest"
},
"output": {
"shape": "ListDiscoverersResponse",
"documentation": "200 response
"
},
"errors": [
{
"shape": "ServiceUnavailableException",
"documentation": "503 response
"
},
{
"shape": "BadRequestException",
"documentation": "400 response
"
},
{
"shape": "UnauthorizedException",
"documentation": "401 response
"
},
{
"shape": "InternalServerErrorException",
"documentation": "500 response
"
},
{
"shape": "ForbiddenException",
"documentation": "403 response
"
}
],
"documentation": "List the discoverers.
"
},
"ListRegistries": {
"name": "ListRegistries",
"http": {
"method": "GET",
"requestUri": "/v1/registries",
"responseCode": 200
},
"input": {
"shape": "ListRegistriesRequest"
},
"output": {
"shape": "ListRegistriesResponse",
"documentation": "200 response
"
},
"errors": [
{
"shape": "ServiceUnavailableException",
"documentation": "503 response
"
},
{
"shape": "BadRequestException",
"documentation": "400 response
"
},
{
"shape": "UnauthorizedException",
"documentation": "401 response
"
},
{
"shape": "InternalServerErrorException",
"documentation": "500 response
"
},
{
"shape": "ForbiddenException",
"documentation": "403 response
"
}
],
"documentation": "List the registries.
"
},
"ListSchemaVersions": {
"name": "ListSchemaVersions",
"http": {
"method": "GET",
"requestUri": "/v1/registries/name/{registryName}/schemas/name/{schemaName}/versions",
"responseCode": 200
},
"input": {
"shape": "ListSchemaVersionsRequest"
},
"output": {
"shape": "ListSchemaVersionsResponse",
"documentation": "200 response
"
},
"errors": [
{
"shape": "BadRequestException",
"documentation": "400 response
"
},
{
"shape": "UnauthorizedException",
"documentation": "401 response
"
},
{
"shape": "InternalServerErrorException",
"documentation": "500 response
"
},
{
"shape": "ForbiddenException",
"documentation": "403 response
"
},
{
"shape": "NotFoundException",
"documentation": "404 response
"
},
{
"shape": "ServiceUnavailableException",
"documentation": "503 response
"
}
],
"documentation": "Provides a list of the schema versions and related information.
"
},
"ListSchemas": {
"name": "ListSchemas",
"http": {
"method": "GET",
"requestUri": "/v1/registries/name/{registryName}/schemas",
"responseCode": 200
},
"input": {
"shape": "ListSchemasRequest"
},
"output": {
"shape": "ListSchemasResponse",
"documentation": "200 response
"
},
"errors": [
{
"shape": "ServiceUnavailableException",
"documentation": "503 response
"
},
{
"shape": "BadRequestException",
"documentation": "400 response
"
},
{
"shape": "UnauthorizedException",
"documentation": "401 response
"
},
{
"shape": "InternalServerErrorException",
"documentation": "500 response
"
},
{
"shape": "ForbiddenException",
"documentation": "403 response
"
}
],
"documentation": "List the schemas.
"
},
"ListTagsForResource": {
"name": "ListTagsForResource",
"http": {
"method": "GET",
"requestUri": "/tags/{resource-arn}",
"responseCode": 200
},
"input": {
"shape": "ListTagsForResourceRequest"
},
"output": {
"shape": "ListTagsForResourceResponse",
"documentation": "200 response
"
},
"errors": [
{
"shape": "NotFoundException",
"documentation": "404 response
"
},
{
"shape": "BadRequestException",
"documentation": "400 response
"
},
{
"shape": "InternalServerErrorException",
"documentation": "500 response
"
},
{
"shape": "ForbiddenException",
"documentation": "403 response
"
}
],
"documentation": "Get tags for resource.
"
},
"PutCodeBinding": {
"name": "PutCodeBinding",
"http": {
"method": "POST",
"requestUri": "/v1/registries/name/{registryName}/schemas/name/{schemaName}/language/{language}",
"responseCode": 202
},
"input": {
"shape": "PutCodeBindingRequest"
},
"output": {
"shape": "PutCodeBindingResponse",
"documentation": "202 response
"
},
"errors": [
{
"shape": "GoneException",
"documentation": "410 response
"
},
{
"shape": "BadRequestException",
"documentation": "400 response
"
},
{
"shape": "UnauthorizedException",
"documentation": "401 response
"
},
{
"shape": "InternalServerErrorException",
"documentation": "500 response
"
},
{
"shape": "ForbiddenException",
"documentation": "403 response
"
},
{
"shape": "NotFoundException",
"documentation": "404 response
"
},
{
"shape": "TooManyRequestsException",
"documentation": "429 response
"
}
],
"documentation": "Put code binding URI
"
},
"PutResourcePolicy": {
"name": "PutResourcePolicy",
"http": {
"method": "PUT",
"requestUri": "/v1/policy",
"responseCode": 200
},
"input": {
"shape": "PutResourcePolicyRequest"
},
"output": {
"shape": "PutResourcePolicyResponse",
"documentation": "200 response
"
},
"errors": [
{
"shape": "BadRequestException",
"documentation": "400 response
"
},
{
"shape": "UnauthorizedException",
"documentation": "401 response
"
},
{
"shape": "PreconditionFailedException",
"documentation": "412 response
"
},
{
"shape": "InternalServerErrorException",
"documentation": "500 response
"
},
{
"shape": "ForbiddenException",
"documentation": "403 response
"
},
{
"shape": "NotFoundException",
"documentation": "404 response
"
},
{
"shape": "ServiceUnavailableException",
"documentation": "503 response
"
}
],
"documentation": "The name of the policy.
"
},
"SearchSchemas": {
"name": "SearchSchemas",
"http": {
"method": "GET",
"requestUri": "/v1/registries/name/{registryName}/schemas/search",
"responseCode": 200
},
"input": {
"shape": "SearchSchemasRequest"
},
"output": {
"shape": "SearchSchemasResponse",
"documentation": "200 response
"
},
"errors": [
{
"shape": "ServiceUnavailableException",
"documentation": "503 response
"
},
{
"shape": "BadRequestException",
"documentation": "400 response
"
},
{
"shape": "UnauthorizedException",
"documentation": "401 response
"
},
{
"shape": "InternalServerErrorException",
"documentation": "500 response
"
},
{
"shape": "ForbiddenException",
"documentation": "403 response
"
}
],
"documentation": "Search the schemas
"
},
"StartDiscoverer": {
"name": "StartDiscoverer",
"http": {
"method": "POST",
"requestUri": "/v1/discoverers/id/{discovererId}/start",
"responseCode": 200
},
"input": {
"shape": "StartDiscovererRequest"
},
"output": {
"shape": "StartDiscovererResponse",
"documentation": "200 response
"
},
"errors": [
{
"shape": "BadRequestException",
"documentation": "400 response
"
},
{
"shape": "UnauthorizedException",
"documentation": "401 response
"
},
{
"shape": "InternalServerErrorException",
"documentation": "500 response
"
},
{
"shape": "ForbiddenException",
"documentation": "403 response
"
},
{
"shape": "NotFoundException",
"documentation": "404 response
"
},
{
"shape": "ServiceUnavailableException",
"documentation": "503 response
"
}
],
"documentation": "Starts the discoverer
"
},
"StopDiscoverer": {
"name": "StopDiscoverer",
"http": {
"method": "POST",
"requestUri": "/v1/discoverers/id/{discovererId}/stop",
"responseCode": 200
},
"input": {
"shape": "StopDiscovererRequest"
},
"output": {
"shape": "StopDiscovererResponse",
"documentation": "200 response
"
},
"errors": [
{
"shape": "BadRequestException",
"documentation": "400 response
"
},
{
"shape": "UnauthorizedException",
"documentation": "401 response
"
},
{
"shape": "InternalServerErrorException",
"documentation": "500 response
"
},
{
"shape": "ForbiddenException",
"documentation": "403 response
"
},
{
"shape": "NotFoundException",
"documentation": "404 response
"
},
{
"shape": "ServiceUnavailableException",
"documentation": "503 response
"
}
],
"documentation": "Stops the discoverer
"
},
"TagResource": {
"name": "TagResource",
"http": {
"method": "POST",
"requestUri": "/tags/{resource-arn}",
"responseCode": 204
},
"input": {
"shape": "TagResourceRequest"
},
"errors": [
{
"shape": "NotFoundException",
"documentation": "404 response
"
},
{
"shape": "BadRequestException",
"documentation": "400 response
"
},
{
"shape": "InternalServerErrorException",
"documentation": "500 response
"
},
{
"shape": "ForbiddenException",
"documentation": "403 response
"
}
],
"documentation": "Add tags to a resource.
"
},
"UntagResource": {
"name": "UntagResource",
"http": {
"method": "DELETE",
"requestUri": "/tags/{resource-arn}",
"responseCode": 204
},
"input": {
"shape": "UntagResourceRequest"
},
"errors": [
{
"shape": "NotFoundException",
"documentation": "404 response
"
},
{
"shape": "BadRequestException",
"documentation": "400 response
"
},
{
"shape": "InternalServerErrorException",
"documentation": "500 response
"
},
{
"shape": "ForbiddenException",
"documentation": "403 response
"
}
],
"documentation": "Removes tags from a resource.
"
},
"UpdateDiscoverer": {
"name": "UpdateDiscoverer",
"http": {
"method": "PUT",
"requestUri": "/v1/discoverers/id/{discovererId}",
"responseCode": 200
},
"input": {
"shape": "UpdateDiscovererRequest"
},
"output": {
"shape": "UpdateDiscovererResponse",
"documentation": "200 response
"
},
"errors": [
{
"shape": "BadRequestException",
"documentation": "400 response
"
},
{
"shape": "UnauthorizedException",
"documentation": "401 response
"
},
{
"shape": "InternalServerErrorException",
"documentation": "500 response
"
},
{
"shape": "ForbiddenException",
"documentation": "403 response
"
},
{
"shape": "NotFoundException",
"documentation": "404 response
"
},
{
"shape": "ServiceUnavailableException",
"documentation": "503 response
"
}
],
"documentation": "Updates the discoverer
"
},
"UpdateRegistry": {
"name": "UpdateRegistry",
"http": {
"method": "PUT",
"requestUri": "/v1/registries/name/{registryName}",
"responseCode": 200
},
"input": {
"shape": "UpdateRegistryRequest"
},
"output": {
"shape": "UpdateRegistryResponse",
"documentation": "200 response
"
},
"errors": [
{
"shape": "BadRequestException",
"documentation": "400 response
"
},
{
"shape": "UnauthorizedException",
"documentation": "401 response
"
},
{
"shape": "InternalServerErrorException",
"documentation": "500 response
"
},
{
"shape": "ForbiddenException",
"documentation": "403 response
"
},
{
"shape": "NotFoundException",
"documentation": "404 response
"
},
{
"shape": "ServiceUnavailableException",
"documentation": "503 response
"
}
],
"documentation": "Updates a registry.
"
},
"UpdateSchema": {
"name": "UpdateSchema",
"http": {
"method": "PUT",
"requestUri": "/v1/registries/name/{registryName}/schemas/name/{schemaName}",
"responseCode": 200
},
"input": {
"shape": "UpdateSchemaRequest"
},
"output": {
"shape": "UpdateSchemaResponse",
"documentation": "200 response
"
},
"errors": [
{
"shape": "BadRequestException",
"documentation": "400 response
"
},
{
"shape": "InternalServerErrorException",
"documentation": "500 response
"
},
{
"shape": "ForbiddenException",
"documentation": "403 response
"
},
{
"shape": "NotFoundException",
"documentation": "404 response
"
},
{
"shape": "ServiceUnavailableException",
"documentation": "503 response
"
}
],
"documentation": "Updates the schema definition
Inactive schemas will be deleted after two years.
The error code.
"
},
"Message": {
"shape": "__string",
"documentation": "The message string of the error output.
"
}
},
"required": [
"Message",
"Code"
],
"exception": true,
"error": {
"httpStatusCode": 400
}
},
"CodeBindingOutput": {
"type": "structure",
"members": {
"CreationDate": {
"shape": "__timestampIso8601",
"documentation": "The time and date that the code binding was created.
"
},
"LastModified": {
"shape": "__timestampIso8601",
"documentation": "The date and time that code bindings were modified.
"
},
"SchemaVersion": {
"shape": "__string",
"documentation": "The version number of the schema.
"
},
"Status": {
"shape": "CodeGenerationStatus",
"documentation": "The current status of code binding generation.
"
}
}
},
"CodeGenerationStatus": {
"type": "string",
"enum": [
"CREATE_IN_PROGRESS",
"CREATE_COMPLETE",
"CREATE_FAILED"
]
},
"ConflictException": {
"type": "structure",
"members": {
"Code": {
"shape": "__string",
"documentation": "The error code.
"
},
"Message": {
"shape": "__string",
"documentation": "The message string of the error output.
"
}
},
"required": [
"Message",
"Code"
],
"exception": true,
"error": {
"httpStatusCode": 409
}
},
"CreateDiscovererInput": {
"type": "structure",
"members": {
"Description": {
"shape": "__stringMin0Max256",
"documentation": "A description for the discoverer.
"
},
"SourceArn": {
"shape": "__stringMin20Max1600",
"documentation": "The ARN of the event bus.
"
},
"Tags": {
"shape": "Tags",
"locationName": "tags",
"documentation": "Tags associated with the resource.
"
}
},
"required": [
"SourceArn"
]
},
"CreateDiscovererRequest": {
"type": "structure",
"members": {
"Description": {
"shape": "__stringMin0Max256",
"documentation": "A description for the discoverer.
"
},
"SourceArn": {
"shape": "__stringMin20Max1600",
"documentation": "The ARN of the event bus.
"
},
"Tags": {
"shape": "Tags",
"locationName": "tags",
"documentation": "Tags associated with the resource.
"
}
},
"documentation": "",
"required": [
"SourceArn"
]
},
"CreateDiscovererResponse": {
"type": "structure",
"members": {
"Description": {
"shape": "__string",
"documentation": "The description of the discoverer.
"
},
"DiscovererArn": {
"shape": "__string",
"documentation": "The ARN of the discoverer.
"
},
"DiscovererId": {
"shape": "__string",
"documentation": "The ID of the discoverer.
"
},
"SourceArn": {
"shape": "__string",
"documentation": "The ARN of the event bus.
"
},
"State": {
"shape": "DiscovererState",
"documentation": "The state of the discoverer.
"
},
"Tags": {
"shape": "Tags",
"locationName": "tags",
"documentation": "Tags associated with the resource.
"
}
}
},
"CreateRegistryInput": {
"type": "structure",
"members": {
"Description": {
"shape": "__stringMin0Max256",
"documentation": "A description of the registry to be created.
"
},
"Tags": {
"shape": "Tags",
"locationName": "tags",
"documentation": "Tags to associate with the registry.
"
}
}
},
"CreateRegistryRequest": {
"type": "structure",
"members": {
"Description": {
"shape": "__stringMin0Max256",
"documentation": "A description of the registry to be created.
"
},
"RegistryName": {
"shape": "__string",
"location": "uri",
"locationName": "registryName",
"documentation": "The name of the registry.
"
},
"Tags": {
"shape": "Tags",
"locationName": "tags",
"documentation": "Tags to associate with the registry.
"
}
},
"required": [
"RegistryName"
]
},
"CreateRegistryResponse": {
"type": "structure",
"members": {
"Description": {
"shape": "__string",
"documentation": "The description of the registry.
"
},
"RegistryArn": {
"shape": "__string",
"documentation": "The ARN of the registry.
"
},
"RegistryName": {
"shape": "__string",
"documentation": "The name of the registry.
"
},
"Tags": {
"shape": "Tags",
"locationName": "tags",
"documentation": "Tags associated with the registry.
"
}
}
},
"CreateSchemaInput": {
"type": "structure",
"members": {
"Content": {
"shape": "__stringMin1Max100000",
"documentation": "The source of the schema definition.
"
},
"Description": {
"shape": "__stringMin0Max256",
"documentation": "A description of the schema.
"
},
"Tags": {
"shape": "Tags",
"locationName": "tags",
"documentation": "Tags associated with the schema.
"
},
"Type": {
"shape": "Type",
"documentation": "The type of schema.
"
}
},
"required": [
"Type",
"Content"
]
},
"CreateSchemaRequest": {
"type": "structure",
"members": {
"Content": {
"shape": "__stringMin1Max100000",
"documentation": "The source of the schema definition.
"
},
"Description": {
"shape": "__stringMin0Max256",
"documentation": "A description of the schema.
"
},
"RegistryName": {
"shape": "__string",
"location": "uri",
"locationName": "registryName",
"documentation": "The name of the registry.
"
},
"SchemaName": {
"shape": "__string",
"location": "uri",
"locationName": "schemaName",
"documentation": "The name of the schema.
"
},
"Tags": {
"shape": "Tags",
"locationName": "tags",
"documentation": "Tags associated with the schema.
"
},
"Type": {
"shape": "Type",
"documentation": "The type of schema.
"
}
},
"required": [
"RegistryName",
"SchemaName",
"Type",
"Content"
]
},
"CreateSchemaResponse": {
"type": "structure",
"members": {
"Description": {
"shape": "__string",
"documentation": "The description of the schema.
"
},
"LastModified": {
"shape": "__timestampIso8601",
"documentation": "The date and time that schema was modified.
"
},
"SchemaArn": {
"shape": "__string",
"documentation": "The ARN of the schema.
"
},
"SchemaName": {
"shape": "__string",
"documentation": "The name of the schema.
"
},
"SchemaVersion": {
"shape": "__string",
"documentation": "The version number of the schema
"
},
"Tags": {
"shape": "Tags",
"locationName": "tags"
},
"Type": {
"shape": "__string",
"documentation": "The type of the schema.
"
},
"VersionCreatedDate": {
"shape": "__timestampIso8601",
"documentation": "The date the schema version was created.
"
}
}
},
"DeleteDiscovererRequest": {
"type": "structure",
"members": {
"DiscovererId": {
"shape": "__string",
"location": "uri",
"locationName": "discovererId",
"documentation": "The ID of the discoverer.
"
}
},
"required": [
"DiscovererId"
]
},
"DeleteRegistryRequest": {
"type": "structure",
"members": {
"RegistryName": {
"shape": "__string",
"location": "uri",
"locationName": "registryName",
"documentation": "The name of the registry.
"
}
},
"required": [
"RegistryName"
]
},
"DeleteResourcePolicyRequest": {
"type": "structure",
"members": {
"RegistryName": {
"shape": "__string",
"location": "querystring",
"locationName": "registryName",
"documentation": "The name of the registry.
"
}
}
},
"DeleteSchemaRequest": {
"type": "structure",
"members": {
"RegistryName": {
"shape": "__string",
"location": "uri",
"locationName": "registryName",
"documentation": "The name of the registry.
"
},
"SchemaName": {
"shape": "__string",
"location": "uri",
"locationName": "schemaName",
"documentation": "The name of the schema.
"
}
},
"required": [
"RegistryName",
"SchemaName"
]
},
"DeleteSchemaVersionRequest": {
"type": "structure",
"members": {
"RegistryName": {
"shape": "__string",
"location": "uri",
"locationName": "registryName",
"documentation": "The name of the registry.
"
},
"SchemaName": {
"shape": "__string",
"location": "uri",
"locationName": "schemaName",
"documentation": "The name of the schema.
"
},
"SchemaVersion": {
"shape": "__string",
"location": "uri",
"locationName": "schemaVersion",
"documentation": "The version number of the schema"
}
},
"required": [
"SchemaVersion",
"RegistryName",
"SchemaName"
]
},
"DescribeCodeBindingRequest": {
"type": "structure",
"members": {
"Language": {
"shape": "__string",
"location": "uri",
"locationName": "language",
"documentation": "The language of the code binding.
"
},
"RegistryName": {
"shape": "__string",
"location": "uri",
"locationName": "registryName",
"documentation": "The name of the registry.
"
},
"SchemaName": {
"shape": "__string",
"location": "uri",
"locationName": "schemaName",
"documentation": "The name of the schema.
"
},
"SchemaVersion": {
"shape": "__string",
"location": "querystring",
"locationName": "schemaVersion",
"documentation": "Specifying this limits the results to only this schema version.
"
}
},
"required": [
"RegistryName",
"SchemaName",
"Language"
]
},
"DescribeCodeBindingResponse": {
"type": "structure",
"members": {
"CreationDate": {
"shape": "__timestampIso8601",
"documentation": "The time and date that the code binding was created.
"
},
"LastModified": {
"shape": "__timestampIso8601",
"documentation": "The date and time that code bindings were modified.
"
},
"SchemaVersion": {
"shape": "__string",
"documentation": "The version number of the schema.
"
},
"Status": {
"shape": "CodeGenerationStatus",
"documentation": "The current status of code binding generation.
"
}
}
},
"DescribeDiscovererRequest": {
"type": "structure",
"members": {
"DiscovererId": {
"shape": "__string",
"location": "uri",
"locationName": "discovererId",
"documentation": "The ID of the discoverer.
"
}
},
"required": [
"DiscovererId"
]
},
"DescribeDiscovererResponse": {
"type": "structure",
"members": {
"Description": {
"shape": "__string",
"documentation": "The description of the discoverer.
"
},
"DiscovererArn": {
"shape": "__string",
"documentation": "The ARN of the discoverer.
"
},
"DiscovererId": {
"shape": "__string",
"documentation": "The ID of the discoverer.
"
},
"SourceArn": {
"shape": "__string",
"documentation": "The ARN of the event bus.
"
},
"State": {
"shape": "DiscovererState",
"documentation": "The state of the discoverer.
"
},
"Tags": {
"shape": "Tags",
"locationName": "tags",
"documentation": "Tags associated with the resource.
"
}
}
},
"DescribeRegistryRequest": {
"type": "structure",
"members": {
"RegistryName": {
"shape": "__string",
"location": "uri",
"locationName": "registryName",
"documentation": "The name of the registry.
"
}
},
"required": [
"RegistryName"
]
},
"DescribeRegistryResponse": {
"type": "structure",
"members": {
"Description": {
"shape": "__string",
"documentation": "The description of the registry.
"
},
"RegistryArn": {
"shape": "__string",
"documentation": "The ARN of the registry.
"
},
"RegistryName": {
"shape": "__string",
"documentation": "The name of the registry.
"
},
"Tags": {
"shape": "Tags",
"locationName": "tags",
"documentation": "Tags associated with the registry.
"
}
}
},
"DescribeSchemaOutput": {
"type": "structure",
"members": {
"Content": {
"shape": "__string",
"documentation": "The source of the schema definition.
"
},
"Description": {
"shape": "__string",
"documentation": "The description of the schema.
"
},
"LastModified": {
"shape": "__timestampIso8601",
"documentation": "The date and time that schema was modified.
"
},
"SchemaArn": {
"shape": "__string",
"documentation": "The ARN of the schema.
"
},
"SchemaName": {
"shape": "__string",
"documentation": "The name of the schema.
"
},
"SchemaVersion": {
"shape": "__string",
"documentation": "The version number of the schema
"
},
"Tags": {
"shape": "Tags",
"locationName": "tags",
"documentation": "Tags associated with the resource.
"
},
"Type": {
"shape": "__string",
"documentation": "The type of the schema.
"
},
"VersionCreatedDate": {
"shape": "__timestampIso8601",
"documentation": "The date the schema version was created.
"
}
}
},
"DescribeSchemaRequest": {
"type": "structure",
"members": {
"RegistryName": {
"shape": "__string",
"location": "uri",
"locationName": "registryName",
"documentation": "The name of the registry.
"
},
"SchemaName": {
"shape": "__string",
"location": "uri",
"locationName": "schemaName",
"documentation": "The name of the schema.
"
},
"SchemaVersion": {
"shape": "__string",
"location": "querystring",
"locationName": "schemaVersion",
"documentation": "Specifying this limits the results to only this schema version.
"
}
},
"required": [
"RegistryName",
"SchemaName"
]
},
"DescribeSchemaResponse": {
"type": "structure",
"members": {
"Content": {
"shape": "__string",
"documentation": "The source of the schema definition.
"
},
"Description": {
"shape": "__string",
"documentation": "The description of the schema.
"
},
"LastModified": {
"shape": "__timestampIso8601",
"documentation": "The date and time that schema was modified.
"
},
"SchemaArn": {
"shape": "__string",
"documentation": "The ARN of the schema.
"
},
"SchemaName": {
"shape": "__string",
"documentation": "The name of the schema.
"
},
"SchemaVersion": {
"shape": "__string",
"documentation": "The version number of the schema
"
},
"Tags": {
"shape": "Tags",
"locationName": "tags",
"documentation": "Tags associated with the resource.
"
},
"Type": {
"shape": "__string",
"documentation": "The type of the schema.
"
},
"VersionCreatedDate": {
"shape": "__timestampIso8601",
"documentation": "The date the schema version was created.
"
}
}
},
"DiscovererOutput": {
"type": "structure",
"members": {
"Description": {
"shape": "__string",
"documentation": "The description of the discoverer.
"
},
"DiscovererArn": {
"shape": "__string",
"documentation": "The ARN of the discoverer.
"
},
"DiscovererId": {
"shape": "__string",
"documentation": "The ID of the discoverer.
"
},
"SourceArn": {
"shape": "__string",
"documentation": "The ARN of the event bus.
"
},
"State": {
"shape": "DiscovererState",
"documentation": "The state of the discoverer.
"
},
"Tags": {
"shape": "Tags",
"locationName": "tags",
"documentation": "Tags associated with the resource.
"
}
}
},
"DiscovererState": {
"type": "string",
"enum": [
"STARTED",
"STOPPED"
]
},
"DiscovererStateOutput": {
"type": "structure",
"members": {
"DiscovererId": {
"shape": "__string",
"documentation": "The ID of the discoverer.
"
},
"State": {
"shape": "DiscovererState",
"documentation": "The state of the discoverer.
"
}
}
},
"DiscovererSummary": {
"type": "structure",
"members": {
"DiscovererArn": {
"shape": "__string",
"documentation": "The ARN of the discoverer.
"
},
"DiscovererId": {
"shape": "__string",
"documentation": "The ID of the discoverer.
"
},
"SourceArn": {
"shape": "__string",
"documentation": "The ARN of the event bus.
"
},
"State": {
"shape": "DiscovererState",
"documentation": "The state of the discoverer.
"
},
"Tags": {
"shape": "Tags",
"locationName": "tags",
"documentation": "Tags associated with the resource.
"
}
}
},
"ErrorOutput": {
"type": "structure",
"members": {
"Code": {
"shape": "__string",
"documentation": "The error code.
"
},
"Message": {
"shape": "__string",
"documentation": "The message string of the error output.
"
}
},
"required": [
"Message",
"Code"
]
},
"ExportSchemaOutput": {
"type": "structure",
"members": {
"Content": {
"shape": "__string"
},
"SchemaArn": {
"shape": "__string"
},
"SchemaName": {
"shape": "__string"
},
"SchemaVersion": {
"shape": "__string"
},
"Type": {
"shape": "__string"
}
}
},
"ExportSchemaRequest": {
"type": "structure",
"members": {
"RegistryName": {
"shape": "__string",
"location": "uri",
"locationName": "registryName",
"documentation": "The name of the registry.
"
},
"SchemaName": {
"shape": "__string",
"location": "uri",
"locationName": "schemaName",
"documentation": "The name of the schema.
"
},
"SchemaVersion": {
"shape": "__string",
"location": "querystring",
"locationName": "schemaVersion",
"documentation": "Specifying this limits the results to only this schema version.
"
},
"Type": {
"shape": "__string",
"location": "querystring",
"locationName": "type"
}
},
"required": [
"RegistryName",
"SchemaName",
"Type"
]
},
"ExportSchemaResponse": {
"type": "structure",
"members": {
"Content": {
"shape": "__string"
},
"SchemaArn": {
"shape": "__string"
},
"SchemaName": {
"shape": "__string"
},
"SchemaVersion": {
"shape": "__string"
},
"Type": {
"shape": "__string"
}
}
},
"ForbiddenException": {
"type": "structure",
"members": {
"Code": {
"shape": "__string",
"documentation": "The error code.
"
},
"Message": {
"shape": "__string",
"documentation": "The message string of the error output.
"
}
},
"required": [
"Message",
"Code"
],
"exception": true,
"error": {
"httpStatusCode": 403
}
},
"GetCodeBindingSourceOutput": {
"type": "string"
},
"GetCodeBindingSourceRequest": {
"type": "structure",
"members": {
"Language": {
"shape": "__string",
"location": "uri",
"locationName": "language",
"documentation": "The language of the code binding.
"
},
"RegistryName": {
"shape": "__string",
"location": "uri",
"locationName": "registryName",
"documentation": "The name of the registry.
"
},
"SchemaName": {
"shape": "__string",
"location": "uri",
"locationName": "schemaName",
"documentation": "The name of the schema.
"
},
"SchemaVersion": {
"shape": "__string",
"location": "querystring",
"locationName": "schemaVersion",
"documentation": "Specifying this limits the results to only this schema version.
"
}
},
"required": [
"RegistryName",
"SchemaName",
"Language"
]
},
"GetCodeBindingSourceResponse": {
"type": "structure",
"members": {
"Body": {
"shape": "Body"
}
},
"payload": "Body"
},
"GetDiscoveredSchemaInput": {
"type": "structure",
"members": {
"Events": {
"shape": "__listOfGetDiscoveredSchemaVersionItemInput",
"documentation": "An array of strings where each string is a JSON event. These are the events that were used to generate the schema. The array includes a single type of event and has a maximum size of 10 events.
"
},
"Type": {
"shape": "Type",
"documentation": "The type of event.
"
}
},
"required": [
"Type",
"Events"
]
},
"GetDiscoveredSchemaOutput": {
"type": "structure",
"members": {
"Content": {
"shape": "__string",
"documentation": "The source of the schema definition.
"
}
},
"documentation": ""
},
"GetDiscoveredSchemaRequest": {
"type": "structure",
"members": {
"Events": {
"shape": "__listOfGetDiscoveredSchemaVersionItemInput",
"documentation": "An array of strings where each string is a JSON event. These are the events that were used to generate the schema. The array includes a single type of event and has a maximum size of 10 events.
"
},
"Type": {
"shape": "Type",
"documentation": "The type of event.
"
}
},
"required": [
"Type",
"Events"
]
},
"GetDiscoveredSchemaResponse": {
"type": "structure",
"members": {
"Content": {
"shape": "__string",
"documentation": "The source of the schema definition.
"
}
}
},
"GetDiscoveredSchemaVersionItemInput": {
"type": "string",
"min": 1,
"max": 100000
},
"GetResourcePolicyOutput": {
"type": "structure",
"members": {
"Policy": {
"shape": "__string",
"documentation": "The resource-based policy.
",
"jsonvalue": true
},
"RevisionId": {
"shape": "__string",
"documentation": "The revision ID.
"
}
},
"documentation": "Information about the policy.
"
},
"GetResourcePolicyRequest": {
"type": "structure",
"members": {
"RegistryName": {
"shape": "__string",
"location": "querystring",
"locationName": "registryName",
"documentation": "The name of the registry.
"
}
}
},
"GetResourcePolicyResponse": {
"type": "structure",
"members": {
"Policy": {
"shape": "__string",
"documentation": "The resource-based policy.
",
"jsonvalue": true
},
"RevisionId": {
"shape": "__string",
"documentation": "The revision ID.
"
}
}
},
"GoneException": {
"type": "structure",
"members": {
"Code": {
"shape": "__string",
"documentation": "The error code.
"
},
"Message": {
"shape": "__string",
"documentation": "The message string of the error output.
"
}
},
"required": [
"Message",
"Code"
],
"exception": true,
"error": {
"httpStatusCode": 410
}
},
"InternalServerErrorException": {
"type": "structure",
"members": {
"Code": {
"shape": "__string",
"documentation": "The error code.
"
},
"Message": {
"shape": "__string",
"documentation": "The message string of the error output.
"
}
},
"required": [
"Message",
"Code"
],
"exception": true,
"error": {
"httpStatusCode": 500
}
},
"Limit": {
"type": "integer",
"min": 1,
"max": 100
},
"ListDiscoverersOutput": {
"type": "structure",
"members": {
"Discoverers": {
"shape": "__listOfDiscovererSummary",
"documentation": "An array of DiscovererSummary information.
"
},
"NextToken": {
"shape": "__string",
"documentation": "The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.
"
}
}
},
"ListDiscoverersRequest": {
"type": "structure",
"members": {
"DiscovererIdPrefix": {
"shape": "__string",
"location": "querystring",
"locationName": "discovererIdPrefix",
"documentation": "Specifying this limits the results to only those discoverer IDs that start with the specified prefix.
"
},
"Limit": {
"shape": "__integer",
"location": "querystring",
"locationName": "limit"
},
"NextToken": {
"shape": "__string",
"location": "querystring",
"locationName": "nextToken",
"documentation": "The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.
"
},
"SourceArnPrefix": {
"shape": "__string",
"location": "querystring",
"locationName": "sourceArnPrefix",
"documentation": "Specifying this limits the results to only those ARNs that start with the specified prefix.
"
}
}
},
"ListDiscoverersResponse": {
"type": "structure",
"members": {
"Discoverers": {
"shape": "__listOfDiscovererSummary",
"documentation": "An array of DiscovererSummary information.
"
},
"NextToken": {
"shape": "__string",
"documentation": "The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.
"
}
}
},
"ListRegistriesOutput": {
"type": "structure",
"members": {
"NextToken": {
"shape": "__string",
"documentation": "The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.
"
},
"Registries": {
"shape": "__listOfRegistrySummary",
"documentation": "An array of registry summaries.
"
}
},
"documentation": "List the registries.
"
},
"ListRegistriesRequest": {
"type": "structure",
"members": {
"Limit": {
"shape": "__integer",
"location": "querystring",
"locationName": "limit"
},
"NextToken": {
"shape": "__string",
"location": "querystring",
"locationName": "nextToken",
"documentation": "The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.
"
},
"RegistryNamePrefix": {
"shape": "__string",
"location": "querystring",
"locationName": "registryNamePrefix",
"documentation": "Specifying this limits the results to only those registry names that start with the specified prefix.
"
},
"Scope": {
"shape": "__string",
"location": "querystring",
"locationName": "scope",
"documentation": "Can be set to Local or AWS to limit responses to your custom registries, or the ones provided by AWS.
"
}
}
},
"ListRegistriesResponse": {
"type": "structure",
"members": {
"NextToken": {
"shape": "__string",
"documentation": "The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.
"
},
"Registries": {
"shape": "__listOfRegistrySummary",
"documentation": "An array of registry summaries.
"
}
}
},
"ListSchemaVersionsOutput": {
"type": "structure",
"members": {
"NextToken": {
"shape": "__string",
"documentation": "The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.
"
},
"SchemaVersions": {
"shape": "__listOfSchemaVersionSummary",
"documentation": "An array of schema version summaries.
"
}
}
},
"ListSchemaVersionsRequest": {
"type": "structure",
"members": {
"Limit": {
"shape": "__integer",
"location": "querystring",
"locationName": "limit"
},
"NextToken": {
"shape": "__string",
"location": "querystring",
"locationName": "nextToken",
"documentation": "The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.
"
},
"RegistryName": {
"shape": "__string",
"location": "uri",
"locationName": "registryName",
"documentation": "The name of the registry.
"
},
"SchemaName": {
"shape": "__string",
"location": "uri",
"locationName": "schemaName",
"documentation": "The name of the schema.
"
}
},
"required": [
"RegistryName",
"SchemaName"
]
},
"ListSchemaVersionsResponse": {
"type": "structure",
"members": {
"NextToken": {
"shape": "__string",
"documentation": "The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.
"
},
"SchemaVersions": {
"shape": "__listOfSchemaVersionSummary",
"documentation": "An array of schema version summaries.
"
}
}
},
"ListSchemasOutput": {
"type": "structure",
"members": {
"NextToken": {
"shape": "__string",
"documentation": "The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.
"
},
"Schemas": {
"shape": "__listOfSchemaSummary",
"documentation": "An array of schema summaries.
"
}
}
},
"ListSchemasRequest": {
"type": "structure",
"members": {
"Limit": {
"shape": "__integer",
"location": "querystring",
"locationName": "limit"
},
"NextToken": {
"shape": "__string",
"location": "querystring",
"locationName": "nextToken",
"documentation": "The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.
"
},
"RegistryName": {
"shape": "__string",
"location": "uri",
"locationName": "registryName",
"documentation": "The name of the registry.
"
},
"SchemaNamePrefix": {
"shape": "__string",
"location": "querystring",
"locationName": "schemaNamePrefix",
"documentation": "Specifying this limits the results to only those schema names that start with the specified prefix.
"
}
},
"required": [
"RegistryName"
]
},
"ListSchemasResponse": {
"type": "structure",
"members": {
"NextToken": {
"shape": "__string",
"documentation": "The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.
"
},
"Schemas": {
"shape": "__listOfSchemaSummary",
"documentation": "An array of schema summaries.
"
}
}
},
"ListTagsForResourceOutput": {
"type": "structure",
"members": {
"Tags": {
"shape": "Tags",
"locationName": "tags"
}
}
},
"ListTagsForResourceRequest": {
"type": "structure",
"members": {
"ResourceArn": {
"shape": "__string",
"location": "uri",
"locationName": "resource-arn",
"documentation": "The ARN of the resource.
"
}
},
"required": [
"ResourceArn"
]
},
"ListTagsForResourceResponse": {
"type": "structure",
"members": {
"Tags": {
"shape": "Tags",
"locationName": "tags"
}
}
},
"LockServiceLinkedRoleInput": {
"type": "structure",
"members": {
"RoleArn": {
"shape": "__stringMin1Max1600"
},
"Timeout": {
"shape": "__integerMin1Max29000"
}
},
"required": [
"Timeout",
"RoleArn"
]
},
"LockServiceLinkedRoleOutput": {
"type": "structure",
"members": {
"CanBeDeleted": {
"shape": "__boolean"
},
"ReasonOfFailure": {
"shape": "__stringMin1Max1600"
},
"RelatedResources": {
"shape": "__listOfDiscovererSummary"
}
}
},
"LockServiceLinkedRoleRequest": {
"type": "structure",
"members": {
"RoleArn": {
"shape": "__stringMin1Max1600"
},
"Timeout": {
"shape": "__integerMin1Max29000"
}
},
"documentation": "",
"required": [
"Timeout",
"RoleArn"
]
},
"LockServiceLinkedRoleResponse": {
"type": "structure",
"members": {
"CanBeDeleted": {
"shape": "__boolean"
},
"ReasonOfFailure": {
"shape": "__stringMin1Max1600"
},
"RelatedResources": {
"shape": "__listOfDiscovererSummary"
}
}
},
"NotFoundException": {
"type": "structure",
"members": {
"Code": {
"shape": "__string",
"documentation": "The error code.
"
},
"Message": {
"shape": "__string",
"documentation": "The message string of the error output.
"
}
},
"required": [
"Message",
"Code"
],
"exception": true,
"error": {
"httpStatusCode": 404
}
},
"PreconditionFailedException": {
"type": "structure",
"members": {
"Code": {
"shape": "__string",
"documentation": "The error code.
"
},
"Message": {
"shape": "__string",
"documentation": "The message string of the error output.
"
}
},
"required": [
"Message",
"Code"
],
"exception": true,
"error": {
"httpStatusCode": 412
}
},
"PutCodeBindingRequest": {
"type": "structure",
"members": {
"Language": {
"shape": "__string",
"location": "uri",
"locationName": "language",
"documentation": "The language of the code binding.
"
},
"RegistryName": {
"shape": "__string",
"location": "uri",
"locationName": "registryName",
"documentation": "The name of the registry.
"
},
"SchemaName": {
"shape": "__string",
"location": "uri",
"locationName": "schemaName",
"documentation": "The name of the schema.
"
},
"SchemaVersion": {
"shape": "__string",
"location": "querystring",
"locationName": "schemaVersion",
"documentation": "Specifying this limits the results to only this schema version.
"
}
},
"required": [
"RegistryName",
"SchemaName",
"Language"
]
},
"PutCodeBindingResponse": {
"type": "structure",
"members": {
"CreationDate": {
"shape": "__timestampIso8601",
"documentation": "The time and date that the code binding was created.
"
},
"LastModified": {
"shape": "__timestampIso8601",
"documentation": "The date and time that code bindings were modified.
"
},
"SchemaVersion": {
"shape": "__string",
"documentation": "The version number of the schema.
"
},
"Status": {
"shape": "CodeGenerationStatus",
"documentation": "The current status of code binding generation.
"
}
}
},
"PutResourcePolicyInput": {
"type": "structure",
"members": {
"Policy": {
"shape": "__string",
"documentation": "The resource-based policy.
",
"jsonvalue": true
},
"RevisionId": {
"shape": "__string",
"documentation": "The revision ID of the policy.
"
}
},
"documentation": "Only update the policy if the revision ID matches the ID that's specified. Use this option to avoid modifying a policy that has changed since you last read it.
",
"required": [
"Policy"
]
},
"PutResourcePolicyOutput": {
"type": "structure",
"members": {
"Policy": {
"shape": "__string",
"documentation": "The resource-based policy.
",
"jsonvalue": true
},
"RevisionId": {
"shape": "__string",
"documentation": "The revision ID of the policy.
"
}
},
"documentation": "The resource-based policy.
"
},
"PutResourcePolicyRequest": {
"type": "structure",
"members": {
"Policy": {
"shape": "__string",
"documentation": "The resource-based policy.
",
"jsonvalue": true
},
"RegistryName": {
"shape": "__string",
"location": "querystring",
"locationName": "registryName",
"documentation": "The name of the registry.
"
},
"RevisionId": {
"shape": "__string",
"documentation": "The revision ID of the policy.
"
}
},
"documentation": "The name of the policy.
",
"required": [
"Policy"
]
},
"PutResourcePolicyResponse": {
"type": "structure",
"members": {
"Policy": {
"shape": "__string",
"documentation": "The resource-based policy.
",
"jsonvalue": true
},
"RevisionId": {
"shape": "__string",
"documentation": "The revision ID of the policy.
"
}
}
},
"RegistryOutput": {
"type": "structure",
"members": {
"Description": {
"shape": "__string",
"documentation": "The description of the registry.
"
},
"RegistryArn": {
"shape": "__string",
"documentation": "The ARN of the registry.
"
},
"RegistryName": {
"shape": "__string",
"documentation": "The name of the registry.
"
},
"Tags": {
"shape": "Tags",
"locationName": "tags",
"documentation": "Tags associated with the registry.
"
}
}
},
"RegistrySummary": {
"type": "structure",
"members": {
"RegistryArn": {
"shape": "__string",
"documentation": "The ARN of the registry.
"
},
"RegistryName": {
"shape": "__string",
"documentation": "The name of the registry.
"
},
"Tags": {
"shape": "Tags",
"locationName": "tags",
"documentation": "Tags associated with the registry.
"
}
}
},
"SchemaOutput": {
"type": "structure",
"members": {
"Description": {
"shape": "__string",
"documentation": "The description of the schema.
"
},
"LastModified": {
"shape": "__timestampIso8601",
"documentation": "The date and time that schema was modified.
"
},
"SchemaArn": {
"shape": "__string",
"documentation": "The ARN of the schema.
"
},
"SchemaName": {
"shape": "__string",
"documentation": "The name of the schema.
"
},
"SchemaVersion": {
"shape": "__string",
"documentation": "The version number of the schema
"
},
"Tags": {
"shape": "Tags",
"locationName": "tags"
},
"Type": {
"shape": "__string",
"documentation": "The type of the schema.
"
},
"VersionCreatedDate": {
"shape": "__timestampIso8601",
"documentation": "The date the schema version was created.
"
}
}
},
"SchemaSummary": {
"type": "structure",
"members": {
"LastModified": {
"shape": "__timestampIso8601",
"documentation": "The date and time that schema was modified.
"
},
"SchemaArn": {
"shape": "__string",
"documentation": "The ARN of the schema.
"
},
"SchemaName": {
"shape": "__string",
"documentation": "The name of the schema.
"
},
"Tags": {
"shape": "Tags",
"locationName": "tags",
"documentation": "Tags associated with the schema.
"
},
"VersionCount": {
"shape": "__long",
"documentation": "The number of versions available for the schema.
"
}
},
"documentation": "A summary of schema details.
"
},
"SchemaVersionSummary": {
"type": "structure",
"members": {
"SchemaArn": {
"shape": "__string",
"documentation": "The ARN of the schema version.
"
},
"SchemaName": {
"shape": "__string",
"documentation": "The name of the schema.
"
},
"SchemaVersion": {
"shape": "__string",
"documentation": "The version number of the schema.
"
},
"Type": {
"shape": "Type",
"documentation": "The type of schema.
"
}
}
},
"SearchSchemaSummary": {
"type": "structure",
"members": {
"RegistryName": {
"shape": "__string",
"documentation": "The name of the registry.
"
},
"SchemaArn": {
"shape": "__string",
"documentation": "The ARN of the schema.
"
},
"SchemaName": {
"shape": "__string",
"documentation": "The name of the schema.
"
},
"SchemaVersions": {
"shape": "__listOfSearchSchemaVersionSummary",
"documentation": "An array of schema version summaries.
"
}
}
},
"SearchSchemaVersionSummary": {
"type": "structure",
"members": {
"CreatedDate": {
"shape": "__timestampIso8601",
"documentation": "The date the schema version was created.
"
},
"SchemaVersion": {
"shape": "__string",
"documentation": "The version number of the schema
"
},
"Type": {
"shape": "Type",
"documentation": "The type of schema.
"
}
}
},
"SearchSchemasOutput": {
"type": "structure",
"members": {
"NextToken": {
"shape": "__string",
"documentation": "The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.
"
},
"Schemas": {
"shape": "__listOfSearchSchemaSummary",
"documentation": "An array of SearchSchemaSummary information.
"
}
}
},
"SearchSchemasRequest": {
"type": "structure",
"members": {
"Keywords": {
"shape": "__string",
"location": "querystring",
"locationName": "keywords",
"documentation": "Specifying this limits the results to only schemas that include the provided keywords.
"
},
"Limit": {
"shape": "__integer",
"location": "querystring",
"locationName": "limit"
},
"NextToken": {
"shape": "__string",
"location": "querystring",
"locationName": "nextToken",
"documentation": "The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.
"
},
"RegistryName": {
"shape": "__string",
"location": "uri",
"locationName": "registryName",
"documentation": "The name of the registry.
"
}
},
"required": [
"RegistryName",
"Keywords"
]
},
"SearchSchemasResponse": {
"type": "structure",
"members": {
"NextToken": {
"shape": "__string",
"documentation": "The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.
"
},
"Schemas": {
"shape": "__listOfSearchSchemaSummary",
"documentation": "An array of SearchSchemaSummary information.
"
}
}
},
"ServiceUnavailableException": {
"type": "structure",
"members": {
"Code": {
"shape": "__string",
"documentation": "The error code.
"
},
"Message": {
"shape": "__string",
"documentation": "The message string of the error output.
"
}
},
"required": [
"Message",
"Code"
],
"exception": true,
"error": {
"httpStatusCode": 503
}
},
"StartDiscovererRequest": {
"type": "structure",
"members": {
"DiscovererId": {
"shape": "__string",
"location": "uri",
"locationName": "discovererId",
"documentation": "The ID of the discoverer.
"
}
},
"required": [
"DiscovererId"
]
},
"StartDiscovererResponse": {
"type": "structure",
"members": {
"DiscovererId": {
"shape": "__string",
"documentation": "The ID of the discoverer.
"
},
"State": {
"shape": "DiscovererState",
"documentation": "The state of the discoverer.
"
}
}
},
"StopDiscovererRequest": {
"type": "structure",
"members": {
"DiscovererId": {
"shape": "__string",
"location": "uri",
"locationName": "discovererId",
"documentation": "The ID of the discoverer.
"
}
},
"required": [
"DiscovererId"
]
},
"StopDiscovererResponse": {
"type": "structure",
"members": {
"DiscovererId": {
"shape": "__string",
"documentation": "The ID of the discoverer.
"
},
"State": {
"shape": "DiscovererState",
"documentation": "The state of the discoverer.
"
}
}
},
"TagResourceInput": {
"type": "structure",
"members": {
"Tags": {
"shape": "Tags",
"locationName": "tags",
"documentation": "Tags associated with the resource.
"
}
},
"required": [
"Tags"
]
},
"TagResourceRequest": {
"type": "structure",
"members": {
"ResourceArn": {
"shape": "__string",
"location": "uri",
"locationName": "resource-arn",
"documentation": "The ARN of the resource.
"
},
"Tags": {
"shape": "Tags",
"locationName": "tags",
"documentation": "Tags associated with the resource.
"
}
},
"documentation": "",
"required": [
"ResourceArn",
"Tags"
]
},
"Tags": {
"type": "map",
"documentation": "Key-value pairs associated with a resource.
",
"key": {
"shape": "__string"
},
"value": {
"shape": "__string"
}
},
"TooManyRequestsException": {
"type": "structure",
"members": {
"Code": {
"shape": "__string",
"documentation": "The error code.
"
},
"Message": {
"shape": "__string",
"documentation": "The message string of the error output.
"
}
},
"required": [
"Message",
"Code"
],
"exception": true,
"error": {
"httpStatusCode": 429
}
},
"Type": {
"type": "string",
"enum": [
"OpenApi3",
"JSONSchemaDraft4"
]
},
"UnauthorizedException": {
"type": "structure",
"members": {
"Code": {
"shape": "__string",
"documentation": "The error code.
"
},
"Message": {
"shape": "__string",
"documentation": "The message string of the error output.
"
}
},
"required": [
"Message",
"Code"
],
"exception": true,
"error": {
"httpStatusCode": 401
}
},
"UnlockServiceLinkedRoleInput": {
"type": "structure",
"members": {
"RoleArn": {
"shape": "__stringMin1Max1600"
}
},
"required": [
"RoleArn"
]
},
"UnlockServiceLinkedRoleRequest": {
"type": "structure",
"members": {
"RoleArn": {
"shape": "__stringMin1Max1600"
}
},
"required": [
"RoleArn"
]
},
"UnlockServiceLinkedRoleResponse": {
"type": "structure",
"members": {}
},
"UntagResourceRequest": {
"type": "structure",
"members": {
"ResourceArn": {
"shape": "__string",
"location": "uri",
"locationName": "resource-arn",
"documentation": "The ARN of the resource.
"
},
"TagKeys": {
"shape": "__listOf__string",
"location": "querystring",
"locationName": "tagKeys",
"documentation": "Keys of key-value pairs.
"
}
},
"required": [
"TagKeys",
"ResourceArn"
]
},
"UpdateDiscovererInput": {
"type": "structure",
"members": {
"Description": {
"shape": "__stringMin0Max256",
"documentation": "The description of the discoverer to update.
"
}
}
},
"UpdateDiscovererRequest": {
"type": "structure",
"members": {
"Description": {
"shape": "__stringMin0Max256",
"documentation": "The description of the discoverer to update.
"
},
"DiscovererId": {
"shape": "__string",
"location": "uri",
"locationName": "discovererId",
"documentation": "The ID of the discoverer.
"
}
},
"required": [
"DiscovererId"
]
},
"UpdateDiscovererResponse": {
"type": "structure",
"members": {
"Description": {
"shape": "__string",
"documentation": "The description of the discoverer.
"
},
"DiscovererArn": {
"shape": "__string",
"documentation": "The ARN of the discoverer.
"
},
"DiscovererId": {
"shape": "__string",
"documentation": "The ID of the discoverer.
"
},
"SourceArn": {
"shape": "__string",
"documentation": "The ARN of the event bus.
"
},
"State": {
"shape": "DiscovererState",
"documentation": "The state of the discoverer.
"
},
"Tags": {
"shape": "Tags",
"locationName": "tags",
"documentation": "Tags associated with the resource.
"
}
}
},
"UpdateRegistryInput": {
"type": "structure",
"members": {
"Description": {
"shape": "__stringMin0Max256",
"documentation": "The description of the registry to update.
"
}
}
},
"UpdateRegistryRequest": {
"type": "structure",
"members": {
"Description": {
"shape": "__stringMin0Max256",
"documentation": "The description of the registry to update.
"
},
"RegistryName": {
"shape": "__string",
"location": "uri",
"locationName": "registryName",
"documentation": "The name of the registry.
"
}
},
"documentation": "Updates the registry.
",
"required": [
"RegistryName"
]
},
"UpdateRegistryResponse": {
"type": "structure",
"members": {
"Description": {
"shape": "__string",
"documentation": "The description of the registry.
"
},
"RegistryArn": {
"shape": "__string",
"documentation": "The ARN of the registry.
"
},
"RegistryName": {
"shape": "__string",
"documentation": "The name of the registry.
"
},
"Tags": {
"shape": "Tags",
"locationName": "tags",
"documentation": "Tags associated with the registry.
"
}
}
},
"UpdateSchemaInput": {
"type": "structure",
"members": {
"ClientTokenId": {
"shape": "__stringMin0Max36",
"documentation": "The ID of the client token.
",
"idempotencyToken": true
},
"Content": {
"shape": "__stringMin1Max100000",
"documentation": "The source of the schema definition.
"
},
"Description": {
"shape": "__stringMin0Max256",
"documentation": "The description of the schema.
"
},
"Type": {
"shape": "Type",
"documentation": "The schema type for the events schema.
"
}
}
},
"UpdateSchemaRequest": {
"type": "structure",
"members": {
"ClientTokenId": {
"shape": "__stringMin0Max36",
"documentation": "The ID of the client token.
",
"idempotencyToken": true
},
"Content": {
"shape": "__stringMin1Max100000",
"documentation": "The source of the schema definition.
"
},
"Description": {
"shape": "__stringMin0Max256",
"documentation": "The description of the schema.
"
},
"RegistryName": {
"shape": "__string",
"location": "uri",
"locationName": "registryName",
"documentation": "The name of the registry.
"
},
"SchemaName": {
"shape": "__string",
"location": "uri",
"locationName": "schemaName",
"documentation": "The name of the schema.
"
},
"Type": {
"shape": "Type",
"documentation": "The schema type for the events schema.
"
}
},
"required": [
"RegistryName",
"SchemaName"
]
},
"UpdateSchemaResponse": {
"type": "structure",
"members": {
"Description": {
"shape": "__string",
"documentation": "The description of the schema.
"
},
"LastModified": {
"shape": "__timestampIso8601",
"documentation": "The date and time that schema was modified.
"
},
"SchemaArn": {
"shape": "__string",
"documentation": "The ARN of the schema.
"
},
"SchemaName": {
"shape": "__string",
"documentation": "The name of the schema.
"
},
"SchemaVersion": {
"shape": "__string",
"documentation": "The version number of the schema
"
},
"Tags": {
"shape": "Tags",
"locationName": "tags"
},
"Type": {
"shape": "__string",
"documentation": "The type of the schema.
"
},
"VersionCreatedDate": {
"shape": "__timestampIso8601",
"documentation": "The date the schema version was created.
"
}
}
},
"__boolean": {
"type": "boolean"
},
"__double": {
"type": "double"
},
"__integer": {
"type": "integer"
},
"__integerMin1Max29000": {
"type": "integer",
"min": 1,
"max": 29000
},
"__listOfDiscovererSummary": {
"type": "list",
"member": {
"shape": "DiscovererSummary"
}
},
"__listOfGetDiscoveredSchemaVersionItemInput": {
"type": "list",
"min": 1,
"max": 10,
"member": {
"shape": "GetDiscoveredSchemaVersionItemInput"
}
},
"__listOfRegistrySummary": {
"type": "list",
"member": {
"shape": "RegistrySummary"
}
},
"__listOfSchemaSummary": {
"type": "list",
"member": {
"shape": "SchemaSummary"
}
},
"__listOfSchemaVersionSummary": {
"type": "list",
"member": {
"shape": "SchemaVersionSummary"
}
},
"__listOfSearchSchemaSummary": {
"type": "list",
"member": {
"shape": "SearchSchemaSummary"
}
},
"__listOfSearchSchemaVersionSummary": {
"type": "list",
"member": {
"shape": "SearchSchemaVersionSummary"
}
},
"__listOf__string": {
"type": "list",
"member": {
"shape": "__string"
}
},
"__long": {
"type": "long"
},
"__string": {
"type": "string"
},
"__stringMin0Max256": {
"type": "string",
"min": 0,
"max": 256
},
"__stringMin0Max36": {
"type": "string",
"min": 0,
"max": 36
},
"__stringMin1Max100000": {
"type": "string",
"min": 1,
"max": 100000
},
"__stringMin1Max1600": {
"type": "string",
"min": 1,
"max": 1600
},
"__stringMin20Max1600": {
"type": "string",
"min": 20,
"max": 1600
},
"__timestampIso8601": {
"type": "timestamp",
"timestampFormat": "iso8601"
},
"__timestampUnix": {
"type": "timestamp",
"timestampFormat": "unixTimestamp"
},
"Body": {
"type": "blob"
}
},
"documentation": "Amazon EventBridge Schema Registry
"
}