Table of Contents
Schemas.Client¶A low-level client representing Schemas
Amazon EventBridge Schema Registry
import boto3
client = boto3.client('schemas')
These are the available methods:
can_paginate()close()create_discoverer()create_registry()create_schema()delete_discoverer()delete_registry()delete_resource_policy()delete_schema()delete_schema_version()describe_code_binding()describe_discoverer()describe_registry()describe_schema()export_schema()get_code_binding_source()get_discovered_schema()get_paginator()get_resource_policy()get_waiter()list_discoverers()list_registries()list_schema_versions()list_schemas()list_tags_for_resource()put_code_binding()put_resource_policy()search_schemas()start_discoverer()stop_discoverer()tag_resource()untag_resource()update_discoverer()update_registry()update_schema()can_paginate(operation_name)¶Check if an operation can be paginated.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").True if the operation can be paginated,
False otherwise.close()¶Closes underlying endpoint connections.
create_discoverer(**kwargs)¶Creates a discoverer.
See also: AWS API Documentation
Request Syntax
response = client.create_discoverer(
Description='string',
SourceArn='string',
CrossAccount=True|False,
Tags={
'string': 'string'
}
)
[REQUIRED]
The ARN of the event bus.
Tags associated with the resource.
dict
Response Syntax
{
'Description': 'string',
'DiscovererArn': 'string',
'DiscovererId': 'string',
'SourceArn': 'string',
'State': 'STARTED'|'STOPPED',
'CrossAccount': True|False,
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
201 response
Description (string) --
The description of the discoverer.
DiscovererArn (string) --
The ARN of the discoverer.
DiscovererId (string) --
The ID of the discoverer.
SourceArn (string) --
The ARN of the event bus.
State (string) --
The state of the discoverer.
CrossAccount (boolean) --
The Status if the discoverer will discover schemas from events sent from another account.
Tags (dict) --
Tags associated with the resource.
Exceptions
Schemas.Client.exceptions.BadRequestExceptionSchemas.Client.exceptions.InternalServerErrorExceptionSchemas.Client.exceptions.UnauthorizedExceptionSchemas.Client.exceptions.ForbiddenExceptionSchemas.Client.exceptions.ServiceUnavailableExceptionSchemas.Client.exceptions.ConflictExceptioncreate_registry(**kwargs)¶Creates a registry.
See also: AWS API Documentation
Request Syntax
response = client.create_registry(
Description='string',
RegistryName='string',
Tags={
'string': 'string'
}
)
[REQUIRED]
The name of the registry.
Tags to associate with the registry.
dict
Response Syntax
{
'Description': 'string',
'RegistryArn': 'string',
'RegistryName': 'string',
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
201 response
Description (string) --
The description of the registry.
RegistryArn (string) --
The ARN of the registry.
RegistryName (string) --
The name of the registry.
Tags (dict) --
Tags associated with the registry.
Exceptions
Schemas.Client.exceptions.BadRequestExceptionSchemas.Client.exceptions.InternalServerErrorExceptionSchemas.Client.exceptions.UnauthorizedExceptionSchemas.Client.exceptions.ForbiddenExceptionSchemas.Client.exceptions.ServiceUnavailableExceptionSchemas.Client.exceptions.ConflictExceptioncreate_schema(**kwargs)¶Creates a schema definition.
Note
Inactive schemas will be deleted after two years.
See also: AWS API Documentation
Request Syntax
response = client.create_schema(
Content='string',
Description='string',
RegistryName='string',
SchemaName='string',
Tags={
'string': 'string'
},
Type='OpenApi3'|'JSONSchemaDraft4'
)
[REQUIRED]
The source of the schema definition.
[REQUIRED]
The name of the registry.
[REQUIRED]
The name of the schema.
Tags associated with the schema.
[REQUIRED]
The type of schema.
dict
Response Syntax
{
'Description': 'string',
'LastModified': datetime(2015, 1, 1),
'SchemaArn': 'string',
'SchemaName': 'string',
'SchemaVersion': 'string',
'Tags': {
'string': 'string'
},
'Type': 'string',
'VersionCreatedDate': datetime(2015, 1, 1)
}
Response Structure
(dict) --
201 response
Description (string) --
The description of the schema.
LastModified (datetime) --
The date and time that schema was modified.
SchemaArn (string) --
The ARN of the schema.
SchemaName (string) --
The name of the schema.
SchemaVersion (string) --
The version number of the schema
Tags (dict) --
Key-value pairs associated with a resource.
Type (string) --
The type of the schema.
VersionCreatedDate (datetime) --
The date the schema version was created.
Exceptions
Schemas.Client.exceptions.ServiceUnavailableExceptionSchemas.Client.exceptions.BadRequestExceptionSchemas.Client.exceptions.InternalServerErrorExceptionSchemas.Client.exceptions.ForbiddenExceptiondelete_discoverer(**kwargs)¶Deletes a discoverer.
See also: AWS API Documentation
Request Syntax
response = client.delete_discoverer(
DiscovererId='string'
)
[REQUIRED]
The ID of the discoverer.
Exceptions
Schemas.Client.exceptions.BadRequestExceptionSchemas.Client.exceptions.UnauthorizedExceptionSchemas.Client.exceptions.InternalServerErrorExceptionSchemas.Client.exceptions.ForbiddenExceptionSchemas.Client.exceptions.NotFoundExceptionSchemas.Client.exceptions.ServiceUnavailableExceptiondelete_registry(**kwargs)¶Deletes a Registry.
See also: AWS API Documentation
Request Syntax
response = client.delete_registry(
RegistryName='string'
)
[REQUIRED]
The name of the registry.
Exceptions
Schemas.Client.exceptions.BadRequestExceptionSchemas.Client.exceptions.UnauthorizedExceptionSchemas.Client.exceptions.InternalServerErrorExceptionSchemas.Client.exceptions.ForbiddenExceptionSchemas.Client.exceptions.NotFoundExceptionSchemas.Client.exceptions.ServiceUnavailableExceptiondelete_resource_policy(**kwargs)¶Delete the resource-based policy attached to the specified registry.
See also: AWS API Documentation
Request Syntax
response = client.delete_resource_policy(
RegistryName='string'
)
Exceptions
Schemas.Client.exceptions.BadRequestExceptionSchemas.Client.exceptions.UnauthorizedExceptionSchemas.Client.exceptions.InternalServerErrorExceptionSchemas.Client.exceptions.ForbiddenExceptionSchemas.Client.exceptions.NotFoundExceptionSchemas.Client.exceptions.ServiceUnavailableExceptiondelete_schema(**kwargs)¶Delete a schema definition.
See also: AWS API Documentation
Request Syntax
response = client.delete_schema(
RegistryName='string',
SchemaName='string'
)
[REQUIRED]
The name of the registry.
[REQUIRED]
The name of the schema.
None
Exceptions
Schemas.Client.exceptions.BadRequestExceptionSchemas.Client.exceptions.UnauthorizedExceptionSchemas.Client.exceptions.InternalServerErrorExceptionSchemas.Client.exceptions.ForbiddenExceptionSchemas.Client.exceptions.NotFoundExceptionSchemas.Client.exceptions.ServiceUnavailableExceptiondelete_schema_version(**kwargs)¶Delete the schema version definition
See also: AWS API Documentation
Request Syntax
response = client.delete_schema_version(
RegistryName='string',
SchemaName='string',
SchemaVersion='string'
)
[REQUIRED]
The name of the registry.
[REQUIRED]
The name of the schema.
None
Exceptions
Schemas.Client.exceptions.BadRequestExceptionSchemas.Client.exceptions.UnauthorizedExceptionSchemas.Client.exceptions.InternalServerErrorExceptionSchemas.Client.exceptions.ForbiddenExceptionSchemas.Client.exceptions.NotFoundExceptionSchemas.Client.exceptions.ServiceUnavailableExceptiondescribe_code_binding(**kwargs)¶Describe the code binding URI.
See also: AWS API Documentation
Request Syntax
response = client.describe_code_binding(
Language='string',
RegistryName='string',
SchemaName='string',
SchemaVersion='string'
)
[REQUIRED]
The language of the code binding.
[REQUIRED]
The name of the registry.
[REQUIRED]
The name of the schema.
dict
Response Syntax
{
'CreationDate': datetime(2015, 1, 1),
'LastModified': datetime(2015, 1, 1),
'SchemaVersion': 'string',
'Status': 'CREATE_IN_PROGRESS'|'CREATE_COMPLETE'|'CREATE_FAILED'
}
Response Structure
(dict) --
200 response
CreationDate (datetime) --
The time and date that the code binding was created.
LastModified (datetime) --
The date and time that code bindings were modified.
SchemaVersion (string) --
The version number of the schema.
Status (string) --
The current status of code binding generation.
Exceptions
Schemas.Client.exceptions.BadRequestExceptionSchemas.Client.exceptions.UnauthorizedExceptionSchemas.Client.exceptions.InternalServerErrorExceptionSchemas.Client.exceptions.ForbiddenExceptionSchemas.Client.exceptions.NotFoundExceptionSchemas.Client.exceptions.TooManyRequestsExceptiondescribe_discoverer(**kwargs)¶Describes the discoverer.
See also: AWS API Documentation
Request Syntax
response = client.describe_discoverer(
DiscovererId='string'
)
[REQUIRED]
The ID of the discoverer.
{
'Description': 'string',
'DiscovererArn': 'string',
'DiscovererId': 'string',
'SourceArn': 'string',
'State': 'STARTED'|'STOPPED',
'CrossAccount': True|False,
'Tags': {
'string': 'string'
}
}
Response Structure
200 response
The description of the discoverer.
The ARN of the discoverer.
The ID of the discoverer.
The ARN of the event bus.
The state of the discoverer.
The Status if the discoverer will discover schemas from events sent from another account.
Tags associated with the resource.
Exceptions
Schemas.Client.exceptions.BadRequestExceptionSchemas.Client.exceptions.UnauthorizedExceptionSchemas.Client.exceptions.InternalServerErrorExceptionSchemas.Client.exceptions.ForbiddenExceptionSchemas.Client.exceptions.NotFoundExceptionSchemas.Client.exceptions.ServiceUnavailableExceptiondescribe_registry(**kwargs)¶Describes the registry.
See also: AWS API Documentation
Request Syntax
response = client.describe_registry(
RegistryName='string'
)
[REQUIRED]
The name of the registry.
{
'Description': 'string',
'RegistryArn': 'string',
'RegistryName': 'string',
'Tags': {
'string': 'string'
}
}
Response Structure
200 response
The description of the registry.
The ARN of the registry.
The name of the registry.
Tags associated with the registry.
Exceptions
Schemas.Client.exceptions.BadRequestExceptionSchemas.Client.exceptions.UnauthorizedExceptionSchemas.Client.exceptions.InternalServerErrorExceptionSchemas.Client.exceptions.ForbiddenExceptionSchemas.Client.exceptions.NotFoundExceptionSchemas.Client.exceptions.ServiceUnavailableExceptiondescribe_schema(**kwargs)¶Retrieve the schema definition.
See also: AWS API Documentation
Request Syntax
response = client.describe_schema(
RegistryName='string',
SchemaName='string',
SchemaVersion='string'
)
[REQUIRED]
The name of the registry.
[REQUIRED]
The name of the schema.
dict
Response Syntax
{
'Content': 'string',
'Description': 'string',
'LastModified': datetime(2015, 1, 1),
'SchemaArn': 'string',
'SchemaName': 'string',
'SchemaVersion': 'string',
'Tags': {
'string': 'string'
},
'Type': 'string',
'VersionCreatedDate': datetime(2015, 1, 1)
}
Response Structure
(dict) --
200 response
Content (string) --
The source of the schema definition.
Description (string) --
The description of the schema.
LastModified (datetime) --
The date and time that schema was modified.
SchemaArn (string) --
The ARN of the schema.
SchemaName (string) --
The name of the schema.
SchemaVersion (string) --
The version number of the schema
Tags (dict) --
Tags associated with the resource.
Type (string) --
The type of the schema.
VersionCreatedDate (datetime) --
The date the schema version was created.
Exceptions
Schemas.Client.exceptions.BadRequestExceptionSchemas.Client.exceptions.UnauthorizedExceptionSchemas.Client.exceptions.InternalServerErrorExceptionSchemas.Client.exceptions.ForbiddenExceptionSchemas.Client.exceptions.NotFoundExceptionSchemas.Client.exceptions.ServiceUnavailableExceptionexport_schema(**kwargs)¶See also: AWS API Documentation
Request Syntax
response = client.export_schema(
RegistryName='string',
SchemaName='string',
SchemaVersion='string',
Type='string'
)
[REQUIRED]
The name of the registry.
[REQUIRED]
The name of the schema.
dict
Response Syntax
{
'Content': 'string',
'SchemaArn': 'string',
'SchemaName': 'string',
'SchemaVersion': 'string',
'Type': 'string'
}
Response Structure
(dict) --
200 response
Exceptions
Schemas.Client.exceptions.BadRequestExceptionSchemas.Client.exceptions.UnauthorizedExceptionSchemas.Client.exceptions.InternalServerErrorExceptionSchemas.Client.exceptions.ForbiddenExceptionSchemas.Client.exceptions.NotFoundExceptionSchemas.Client.exceptions.ServiceUnavailableExceptionSchemas.Client.exceptions.TooManyRequestsExceptionget_code_binding_source(**kwargs)¶Get the code binding source URI.
See also: AWS API Documentation
Request Syntax
response = client.get_code_binding_source(
Language='string',
RegistryName='string',
SchemaName='string',
SchemaVersion='string'
)
[REQUIRED]
The language of the code binding.
[REQUIRED]
The name of the registry.
[REQUIRED]
The name of the schema.
dict
Response Syntax
{
'Body': StreamingBody()
}
Response Structure
(dict) --
200 response
StreamingBody) --Exceptions
Schemas.Client.exceptions.BadRequestExceptionSchemas.Client.exceptions.UnauthorizedExceptionSchemas.Client.exceptions.InternalServerErrorExceptionSchemas.Client.exceptions.ForbiddenExceptionSchemas.Client.exceptions.NotFoundExceptionSchemas.Client.exceptions.TooManyRequestsExceptionget_discovered_schema(**kwargs)¶Get the discovered schema that was generated based on sampled events.
See also: AWS API Documentation
Request Syntax
response = client.get_discovered_schema(
Events=[
'string',
],
Type='OpenApi3'|'JSONSchemaDraft4'
)
[REQUIRED]
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.
[REQUIRED]
The type of event.
dict
Response Syntax
{
'Content': 'string'
}
Response Structure
(dict) --
200 response
Content (string) --
The source of the schema definition.
Exceptions
Schemas.Client.exceptions.ServiceUnavailableExceptionSchemas.Client.exceptions.BadRequestExceptionSchemas.Client.exceptions.UnauthorizedExceptionSchemas.Client.exceptions.InternalServerErrorExceptionSchemas.Client.exceptions.ForbiddenExceptionget_paginator(operation_name)¶Create a paginator for an operation.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").client.can_paginate method to
check if an operation is pageable.get_resource_policy(**kwargs)¶Retrieves the resource-based policy attached to a given registry.
See also: AWS API Documentation
Request Syntax
response = client.get_resource_policy(
RegistryName='string'
)
{
'Policy': 'string',
'RevisionId': 'string'
}
Response Structure
Get Resource-Based Policy Response
The resource-based policy.
The revision ID.
Exceptions
Schemas.Client.exceptions.BadRequestExceptionSchemas.Client.exceptions.UnauthorizedExceptionSchemas.Client.exceptions.InternalServerErrorExceptionSchemas.Client.exceptions.ForbiddenExceptionSchemas.Client.exceptions.NotFoundExceptionSchemas.Client.exceptions.ServiceUnavailableExceptionget_waiter(waiter_name)¶Returns an object that can wait for some condition.
list_discoverers(**kwargs)¶List the discoverers.
See also: AWS API Documentation
Request Syntax
response = client.list_discoverers(
DiscovererIdPrefix='string',
Limit=123,
NextToken='string',
SourceArnPrefix='string'
)
dict
Response Syntax
{
'Discoverers': [
{
'DiscovererArn': 'string',
'DiscovererId': 'string',
'SourceArn': 'string',
'State': 'STARTED'|'STOPPED',
'CrossAccount': True|False,
'Tags': {
'string': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
200 response
Discoverers (list) --
An array of DiscovererSummary information.
(dict) --
DiscovererArn (string) --
The ARN of the discoverer.
DiscovererId (string) --
The ID of the discoverer.
SourceArn (string) --
The ARN of the event bus.
State (string) --
The state of the discoverer.
CrossAccount (boolean) --
The Status if the discoverer will discover schemas from events sent from another account.
Tags (dict) --
Tags associated with the resource.
NextToken (string) --
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.
Exceptions
Schemas.Client.exceptions.ServiceUnavailableExceptionSchemas.Client.exceptions.BadRequestExceptionSchemas.Client.exceptions.UnauthorizedExceptionSchemas.Client.exceptions.InternalServerErrorExceptionSchemas.Client.exceptions.ForbiddenExceptionlist_registries(**kwargs)¶List the registries.
See also: AWS API Documentation
Request Syntax
response = client.list_registries(
Limit=123,
NextToken='string',
RegistryNamePrefix='string',
Scope='string'
)
dict
Response Syntax
{
'NextToken': 'string',
'Registries': [
{
'RegistryArn': 'string',
'RegistryName': 'string',
'Tags': {
'string': 'string'
}
},
]
}
Response Structure
(dict) --
200 response
NextToken (string) --
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 (list) --
An array of registry summaries.
(dict) --
RegistryArn (string) --
The ARN of the registry.
RegistryName (string) --
The name of the registry.
Tags (dict) --
Tags associated with the registry.
Exceptions
Schemas.Client.exceptions.ServiceUnavailableExceptionSchemas.Client.exceptions.BadRequestExceptionSchemas.Client.exceptions.UnauthorizedExceptionSchemas.Client.exceptions.InternalServerErrorExceptionSchemas.Client.exceptions.ForbiddenExceptionlist_schema_versions(**kwargs)¶Provides a list of the schema versions and related information.
See also: AWS API Documentation
Request Syntax
response = client.list_schema_versions(
Limit=123,
NextToken='string',
RegistryName='string',
SchemaName='string'
)
[REQUIRED]
The name of the registry.
[REQUIRED]
The name of the schema.
dict
Response Syntax
{
'NextToken': 'string',
'SchemaVersions': [
{
'SchemaArn': 'string',
'SchemaName': 'string',
'SchemaVersion': 'string',
'Type': 'OpenApi3'|'JSONSchemaDraft4'
},
]
}
Response Structure
(dict) --
200 response
NextToken (string) --
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 (list) --
An array of schema version summaries.
(dict) --
SchemaArn (string) --
The ARN of the schema version.
SchemaName (string) --
The name of the schema.
SchemaVersion (string) --
The version number of the schema.
Type (string) --
The type of schema.
Exceptions
Schemas.Client.exceptions.BadRequestExceptionSchemas.Client.exceptions.UnauthorizedExceptionSchemas.Client.exceptions.InternalServerErrorExceptionSchemas.Client.exceptions.ForbiddenExceptionSchemas.Client.exceptions.NotFoundExceptionSchemas.Client.exceptions.ServiceUnavailableExceptionlist_schemas(**kwargs)¶List the schemas.
See also: AWS API Documentation
Request Syntax
response = client.list_schemas(
Limit=123,
NextToken='string',
RegistryName='string',
SchemaNamePrefix='string'
)
[REQUIRED]
The name of the registry.
dict
Response Syntax
{
'NextToken': 'string',
'Schemas': [
{
'LastModified': datetime(2015, 1, 1),
'SchemaArn': 'string',
'SchemaName': 'string',
'Tags': {
'string': 'string'
},
'VersionCount': 123
},
]
}
Response Structure
(dict) --
200 response
NextToken (string) --
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 (list) --
An array of schema summaries.
(dict) --
A summary of schema details.
LastModified (datetime) --
The date and time that schema was modified.
SchemaArn (string) --
The ARN of the schema.
SchemaName (string) --
The name of the schema.
Tags (dict) --
Tags associated with the schema.
VersionCount (integer) --
The number of versions available for the schema.
Exceptions
Schemas.Client.exceptions.ServiceUnavailableExceptionSchemas.Client.exceptions.BadRequestExceptionSchemas.Client.exceptions.UnauthorizedExceptionSchemas.Client.exceptions.InternalServerErrorExceptionSchemas.Client.exceptions.ForbiddenExceptionGet tags for resource.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
ResourceArn='string'
)
[REQUIRED]
The ARN of the resource.
{
'Tags': {
'string': 'string'
}
}
Response Structure
200 response
Key-value pairs associated with a resource.
Exceptions
Schemas.Client.exceptions.NotFoundExceptionSchemas.Client.exceptions.BadRequestExceptionSchemas.Client.exceptions.InternalServerErrorExceptionSchemas.Client.exceptions.ForbiddenExceptionput_code_binding(**kwargs)¶Put code binding URI
See also: AWS API Documentation
Request Syntax
response = client.put_code_binding(
Language='string',
RegistryName='string',
SchemaName='string',
SchemaVersion='string'
)
[REQUIRED]
The language of the code binding.
[REQUIRED]
The name of the registry.
[REQUIRED]
The name of the schema.
dict
Response Syntax
{
'CreationDate': datetime(2015, 1, 1),
'LastModified': datetime(2015, 1, 1),
'SchemaVersion': 'string',
'Status': 'CREATE_IN_PROGRESS'|'CREATE_COMPLETE'|'CREATE_FAILED'
}
Response Structure
(dict) --
202 response
CreationDate (datetime) --
The time and date that the code binding was created.
LastModified (datetime) --
The date and time that code bindings were modified.
SchemaVersion (string) --
The version number of the schema.
Status (string) --
The current status of code binding generation.
Exceptions
Schemas.Client.exceptions.GoneExceptionSchemas.Client.exceptions.BadRequestExceptionSchemas.Client.exceptions.UnauthorizedExceptionSchemas.Client.exceptions.InternalServerErrorExceptionSchemas.Client.exceptions.ForbiddenExceptionSchemas.Client.exceptions.NotFoundExceptionSchemas.Client.exceptions.TooManyRequestsExceptionput_resource_policy(**kwargs)¶The name of the policy.
See also: AWS API Documentation
Request Syntax
response = client.put_resource_policy(
Policy='string',
RegistryName='string',
RevisionId='string'
)
[REQUIRED]
The resource-based policy.
dict
Response Syntax
{
'Policy': 'string',
'RevisionId': 'string'
}
Response Structure
(dict) --
200 response
Policy (string) --
The resource-based policy.
RevisionId (string) --
The revision ID of the policy.
Exceptions
Schemas.Client.exceptions.BadRequestExceptionSchemas.Client.exceptions.UnauthorizedExceptionSchemas.Client.exceptions.PreconditionFailedExceptionSchemas.Client.exceptions.InternalServerErrorExceptionSchemas.Client.exceptions.ForbiddenExceptionSchemas.Client.exceptions.NotFoundExceptionSchemas.Client.exceptions.ServiceUnavailableExceptionsearch_schemas(**kwargs)¶Search the schemas
See also: AWS API Documentation
Request Syntax
response = client.search_schemas(
Keywords='string',
Limit=123,
NextToken='string',
RegistryName='string'
)
[REQUIRED]
Specifying this limits the results to only schemas that include the provided keywords.
[REQUIRED]
The name of the registry.
dict
Response Syntax
{
'NextToken': 'string',
'Schemas': [
{
'RegistryName': 'string',
'SchemaArn': 'string',
'SchemaName': 'string',
'SchemaVersions': [
{
'CreatedDate': datetime(2015, 1, 1),
'SchemaVersion': 'string',
'Type': 'OpenApi3'|'JSONSchemaDraft4'
},
]
},
]
}
Response Structure
(dict) --
200 response
NextToken (string) --
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 (list) --
An array of SearchSchemaSummary information.
(dict) --
RegistryName (string) --
The name of the registry.
SchemaArn (string) --
The ARN of the schema.
SchemaName (string) --
The name of the schema.
SchemaVersions (list) --
An array of schema version summaries.
(dict) --
CreatedDate (datetime) --
The date the schema version was created.
SchemaVersion (string) --
The version number of the schema
Type (string) --
The type of schema.
Exceptions
Schemas.Client.exceptions.ServiceUnavailableExceptionSchemas.Client.exceptions.BadRequestExceptionSchemas.Client.exceptions.UnauthorizedExceptionSchemas.Client.exceptions.InternalServerErrorExceptionSchemas.Client.exceptions.ForbiddenExceptionstart_discoverer(**kwargs)¶Starts the discoverer
See also: AWS API Documentation
Request Syntax
response = client.start_discoverer(
DiscovererId='string'
)
[REQUIRED]
The ID of the discoverer.
{
'DiscovererId': 'string',
'State': 'STARTED'|'STOPPED'
}
Response Structure
200 response
The ID of the discoverer.
The state of the discoverer.
Exceptions
Schemas.Client.exceptions.BadRequestExceptionSchemas.Client.exceptions.UnauthorizedExceptionSchemas.Client.exceptions.InternalServerErrorExceptionSchemas.Client.exceptions.ForbiddenExceptionSchemas.Client.exceptions.NotFoundExceptionSchemas.Client.exceptions.ServiceUnavailableExceptionstop_discoverer(**kwargs)¶Stops the discoverer
See also: AWS API Documentation
Request Syntax
response = client.stop_discoverer(
DiscovererId='string'
)
[REQUIRED]
The ID of the discoverer.
{
'DiscovererId': 'string',
'State': 'STARTED'|'STOPPED'
}
Response Structure
200 response
The ID of the discoverer.
The state of the discoverer.
Exceptions
Schemas.Client.exceptions.BadRequestExceptionSchemas.Client.exceptions.UnauthorizedExceptionSchemas.Client.exceptions.InternalServerErrorExceptionSchemas.Client.exceptions.ForbiddenExceptionSchemas.Client.exceptions.NotFoundExceptionSchemas.Client.exceptions.ServiceUnavailableExceptiontag_resource(**kwargs)¶Add tags to a resource.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
ResourceArn='string',
Tags={
'string': 'string'
}
)
[REQUIRED]
The ARN of the resource.
[REQUIRED]
Tags associated with the resource.
None
Exceptions
Schemas.Client.exceptions.NotFoundExceptionSchemas.Client.exceptions.BadRequestExceptionSchemas.Client.exceptions.InternalServerErrorExceptionSchemas.Client.exceptions.ForbiddenExceptionuntag_resource(**kwargs)¶Removes tags from a resource.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
ResourceArn='string',
TagKeys=[
'string',
]
)
[REQUIRED]
The ARN of the resource.
[REQUIRED]
Keys of key-value pairs.
None
Exceptions
Schemas.Client.exceptions.NotFoundExceptionSchemas.Client.exceptions.BadRequestExceptionSchemas.Client.exceptions.InternalServerErrorExceptionSchemas.Client.exceptions.ForbiddenExceptionupdate_discoverer(**kwargs)¶Updates the discoverer
See also: AWS API Documentation
Request Syntax
response = client.update_discoverer(
Description='string',
DiscovererId='string',
CrossAccount=True|False
)
[REQUIRED]
The ID of the discoverer.
dict
Response Syntax
{
'Description': 'string',
'DiscovererArn': 'string',
'DiscovererId': 'string',
'SourceArn': 'string',
'State': 'STARTED'|'STOPPED',
'CrossAccount': True|False,
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
200 response
Description (string) --
The description of the discoverer.
DiscovererArn (string) --
The ARN of the discoverer.
DiscovererId (string) --
The ID of the discoverer.
SourceArn (string) --
The ARN of the event bus.
State (string) --
The state of the discoverer.
CrossAccount (boolean) --
The Status if the discoverer will discover schemas from events sent from another account.
Tags (dict) --
Tags associated with the resource.
Exceptions
Schemas.Client.exceptions.BadRequestExceptionSchemas.Client.exceptions.UnauthorizedExceptionSchemas.Client.exceptions.InternalServerErrorExceptionSchemas.Client.exceptions.ForbiddenExceptionSchemas.Client.exceptions.NotFoundExceptionSchemas.Client.exceptions.ServiceUnavailableExceptionupdate_registry(**kwargs)¶Updates a registry.
See also: AWS API Documentation
Request Syntax
response = client.update_registry(
Description='string',
RegistryName='string'
)
[REQUIRED]
The name of the registry.
dict
Response Syntax
{
'Description': 'string',
'RegistryArn': 'string',
'RegistryName': 'string',
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
200 response
Description (string) --
The description of the registry.
RegistryArn (string) --
The ARN of the registry.
RegistryName (string) --
The name of the registry.
Tags (dict) --
Tags associated with the registry.
Exceptions
Schemas.Client.exceptions.BadRequestExceptionSchemas.Client.exceptions.UnauthorizedExceptionSchemas.Client.exceptions.InternalServerErrorExceptionSchemas.Client.exceptions.ForbiddenExceptionSchemas.Client.exceptions.NotFoundExceptionSchemas.Client.exceptions.ServiceUnavailableExceptionupdate_schema(**kwargs)¶Updates the schema definition
Note
Inactive schemas will be deleted after two years.
See also: AWS API Documentation
Request Syntax
response = client.update_schema(
ClientTokenId='string',
Content='string',
Description='string',
RegistryName='string',
SchemaName='string',
Type='OpenApi3'|'JSONSchemaDraft4'
)
The ID of the client token.
This field is autopopulated if not provided.
[REQUIRED]
The name of the registry.
[REQUIRED]
The name of the schema.
dict
Response Syntax
{
'Description': 'string',
'LastModified': datetime(2015, 1, 1),
'SchemaArn': 'string',
'SchemaName': 'string',
'SchemaVersion': 'string',
'Tags': {
'string': 'string'
},
'Type': 'string',
'VersionCreatedDate': datetime(2015, 1, 1)
}
Response Structure
(dict) --
200 response
Description (string) --
The description of the schema.
LastModified (datetime) --
The date and time that schema was modified.
SchemaArn (string) --
The ARN of the schema.
SchemaName (string) --
The name of the schema.
SchemaVersion (string) --
The version number of the schema
Tags (dict) --
Key-value pairs associated with a resource.
Type (string) --
The type of the schema.
VersionCreatedDate (datetime) --
The date the schema version was created.
Exceptions
Schemas.Client.exceptions.BadRequestExceptionSchemas.Client.exceptions.InternalServerErrorExceptionSchemas.Client.exceptions.ForbiddenExceptionSchemas.Client.exceptions.NotFoundExceptionSchemas.Client.exceptions.ServiceUnavailableExceptionThe available paginators are:
Schemas.Paginator.ListDiscoverersSchemas.Paginator.ListRegistriesSchemas.Paginator.ListSchemaVersionsSchemas.Paginator.ListSchemasSchemas.Paginator.SearchSchemasSchemas.Paginator.ListDiscoverers¶paginator = client.get_paginator('list_discoverers')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Schemas.Client.list_discoverers().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
DiscovererIdPrefix='string',
SourceArnPrefix='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Discoverers': [
{
'DiscovererArn': 'string',
'DiscovererId': 'string',
'SourceArn': 'string',
'State': 'STARTED'|'STOPPED',
'CrossAccount': True|False,
'Tags': {
'string': 'string'
}
},
],
}
Response Structure
(dict) --
200 response
Discoverers (list) --
An array of DiscovererSummary information.
(dict) --
DiscovererArn (string) --
The ARN of the discoverer.
DiscovererId (string) --
The ID of the discoverer.
SourceArn (string) --
The ARN of the event bus.
State (string) --
The state of the discoverer.
CrossAccount (boolean) --
The Status if the discoverer will discover schemas from events sent from another account.
Tags (dict) --
Tags associated with the resource.
Schemas.Paginator.ListRegistries¶paginator = client.get_paginator('list_registries')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Schemas.Client.list_registries().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
RegistryNamePrefix='string',
Scope='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Registries': [
{
'RegistryArn': 'string',
'RegistryName': 'string',
'Tags': {
'string': 'string'
}
},
]
}
Response Structure
(dict) --
200 response
Registries (list) --
An array of registry summaries.
(dict) --
RegistryArn (string) --
The ARN of the registry.
RegistryName (string) --
The name of the registry.
Tags (dict) --
Tags associated with the registry.
Schemas.Paginator.ListSchemaVersions¶paginator = client.get_paginator('list_schema_versions')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Schemas.Client.list_schema_versions().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
RegistryName='string',
SchemaName='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The name of the registry.
[REQUIRED]
The name of the schema.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'SchemaVersions': [
{
'SchemaArn': 'string',
'SchemaName': 'string',
'SchemaVersion': 'string',
'Type': 'OpenApi3'|'JSONSchemaDraft4'
},
]
}
Response Structure
(dict) --
200 response
SchemaVersions (list) --
An array of schema version summaries.
(dict) --
SchemaArn (string) --
The ARN of the schema version.
SchemaName (string) --
The name of the schema.
SchemaVersion (string) --
The version number of the schema.
Type (string) --
The type of schema.
Schemas.Paginator.ListSchemas¶paginator = client.get_paginator('list_schemas')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Schemas.Client.list_schemas().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
RegistryName='string',
SchemaNamePrefix='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The name of the registry.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Schemas': [
{
'LastModified': datetime(2015, 1, 1),
'SchemaArn': 'string',
'SchemaName': 'string',
'Tags': {
'string': 'string'
},
'VersionCount': 123
},
]
}
Response Structure
(dict) --
200 response
Schemas (list) --
An array of schema summaries.
(dict) --
A summary of schema details.
LastModified (datetime) --
The date and time that schema was modified.
SchemaArn (string) --
The ARN of the schema.
SchemaName (string) --
The name of the schema.
Tags (dict) --
Tags associated with the schema.
VersionCount (integer) --
The number of versions available for the schema.
Schemas.Paginator.SearchSchemas¶paginator = client.get_paginator('search_schemas')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Schemas.Client.search_schemas().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Keywords='string',
RegistryName='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
Specifying this limits the results to only schemas that include the provided keywords.
[REQUIRED]
The name of the registry.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Schemas': [
{
'RegistryName': 'string',
'SchemaArn': 'string',
'SchemaName': 'string',
'SchemaVersions': [
{
'CreatedDate': datetime(2015, 1, 1),
'SchemaVersion': 'string',
'Type': 'OpenApi3'|'JSONSchemaDraft4'
},
]
},
]
}
Response Structure
(dict) --
200 response
Schemas (list) --
An array of SearchSchemaSummary information.
(dict) --
RegistryName (string) --
The name of the registry.
SchemaArn (string) --
The ARN of the schema.
SchemaName (string) --
The name of the schema.
SchemaVersions (list) --
An array of schema version summaries.
(dict) --
CreatedDate (datetime) --
The date the schema version was created.
SchemaVersion (string) --
The version number of the schema
Type (string) --
The type of schema.
The available waiters are:
Schemas.Waiter.CodeBindingExists¶waiter = client.get_waiter('code_binding_exists')
wait(**kwargs)¶Polls Schemas.Client.describe_code_binding() every 2 seconds until a successful state is reached. An error is returned after 30 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
Language='string',
RegistryName='string',
SchemaName='string',
SchemaVersion='string',
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
[REQUIRED]
The language of the code binding.
[REQUIRED]
The name of the registry.
[REQUIRED]
The name of the schema.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 2
The maximum number of attempts to be made. Default: 30
None