2019/12/02 - Schemas - 29 new api methods
Changes This release introduces support for Amazon EventBridge schema registry, making it easy to discover and write code for events in EventBridge.
Retrieve the schema definition.
See also: AWS API Documentation
Request Syntax
client.describe_schema(
RegistryName='string',
SchemaName='string',
SchemaVersion='string'
)
string
[REQUIRED]
string
[REQUIRED]
string
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) --
Content (string) --
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.
(string) --
(string) --
Type (string) --
The type of the schema.
VersionCreatedDate (datetime) --
The date the schema version was created.
Get the code binding source URI.
See also: AWS API Documentation
Request Syntax
client.get_code_binding_source(
Language='string',
RegistryName='string',
SchemaName='string',
SchemaVersion='string'
)
string
[REQUIRED]
string
[REQUIRED]
string
[REQUIRED]
string
dict
Response Syntax
{
'Body': StreamingBody()
}
Response Structure
(dict) --
Body (:class:`.StreamingBody`) --
See also: AWS API Documentation
Request Syntax
client.unlock_service_linked_role(
RoleArn='string'
)
string
[REQUIRED]
dict
Response Syntax
{}
Response Structure
(dict) --
List the discoverers.
See also: AWS API Documentation
Request Syntax
client.list_discoverers(
DiscovererIdPrefix='string',
Limit=123,
NextToken='string',
SourceArnPrefix='string'
)
string
integer
string
string
dict
Response Syntax
{
'Discoverers': [
{
'DiscovererArn': 'string',
'DiscovererId': 'string',
'SourceArn': 'string',
'State': 'STARTED'|'STOPPED',
'Tags': {
'string': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
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) --
Tags (dict) --
Tags associated with the resource.
(string) --
(string) --
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.
Creates a registry.
See also: AWS API Documentation
Request Syntax
client.create_registry(
Description='string',
RegistryName='string',
Tags={
'string': 'string'
}
)
string
A description of the registry to be created.
string
[REQUIRED]
dict
Tags to associate with the registry.
(string) --
(string) --
dict
Response Syntax
{
'Description': 'string',
'RegistryArn': 'string',
'RegistryName': 'string',
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
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.
(string) --
(string) --
Updates the schema definition
See also: AWS API Documentation
Request Syntax
client.update_schema(
ClientTokenId='string',
Content='string',
Description='string',
RegistryName='string',
SchemaName='string',
Type='OpenApi3'
)
string
The ID of the client token.
This field is autopopulated if not provided.
string
The source of the schema definition.
string
The description of the schema.
string
[REQUIRED]
string
[REQUIRED]
string
The schema type for the events 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) --
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.
(string) --
(string) --
Type (string) --
The type of the schema.
VersionCreatedDate (datetime) --
The date the schema version was created.
Add tags to a resource.
See also: AWS API Documentation
Request Syntax
client.tag_resource(
ResourceArn='string',
Tags={
'string': 'string'
}
)
string
[REQUIRED]
dict
[REQUIRED]
Key-value pairs associated with a resource.
(string) --
(string) --
None
Delete a schema definition.
See also: AWS API Documentation
Request Syntax
client.delete_schema(
RegistryName='string',
SchemaName='string'
)
string
[REQUIRED]
string
[REQUIRED]
None
Put code binding URI
See also: AWS API Documentation
Request Syntax
client.put_code_binding(
Language='string',
RegistryName='string',
SchemaName='string',
SchemaVersion='string'
)
string
[REQUIRED]
string
[REQUIRED]
string
[REQUIRED]
string
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) --
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.
Describes the discoverer.
See also: AWS API Documentation
Request Syntax
client.describe_discoverer(
DiscovererId='string'
)
string
[REQUIRED]
dict
Response Syntax
{
'Description': 'string',
'DiscovererArn': 'string',
'DiscovererId': 'string',
'SourceArn': 'string',
'State': 'STARTED'|'STOPPED',
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
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.
Tags (dict) --
Tags associated with the resource.
(string) --
(string) --
Get tags for resource.
See also: AWS API Documentation
Request Syntax
client.list_tags_for_resource(
ResourceArn='string'
)
string
[REQUIRED]
dict
Response Syntax
{
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
Tags (dict) --
Key-value pairs associated with a resource.
(string) --
(string) --
Deletes a Registry.
See also: AWS API Documentation
Request Syntax
client.delete_registry(
RegistryName='string'
)
string
[REQUIRED]
None
Delete the schema version definition
See also: AWS API Documentation
Request Syntax
client.delete_schema_version(
RegistryName='string',
SchemaName='string',
SchemaVersion='string'
)
string
[REQUIRED]
string
[REQUIRED]
string
[REQUIRED]
None
Starts the discoverer
See also: AWS API Documentation
Request Syntax
client.start_discoverer(
DiscovererId='string'
)
string
[REQUIRED]
dict
Response Syntax
{
'DiscovererId': 'string',
'State': 'STARTED'|'STOPPED'
}
Response Structure
(dict) --
DiscovererId (string) --
The ID of the discoverer.
State (string) --
The state of the discoverer.
Describe the code binding URI.
See also: AWS API Documentation
Request Syntax
client.describe_code_binding(
Language='string',
RegistryName='string',
SchemaName='string',
SchemaVersion='string'
)
string
[REQUIRED]
string
[REQUIRED]
string
[REQUIRED]
string
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) --
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.
Removes tags from a resource.
See also: AWS API Documentation
Request Syntax
client.untag_resource(
ResourceArn='string',
TagKeys=[
'string',
]
)
string
[REQUIRED]
list
[REQUIRED]
(string) --
None
Search the schemas
See also: AWS API Documentation
Request Syntax
client.search_schemas(
Keywords='string',
Limit=123,
NextToken='string',
RegistryName='string'
)
string
[REQUIRED]
integer
string
string
[REQUIRED]
dict
Response Syntax
{
'NextToken': 'string',
'Schemas': [
{
'RegistryName': 'string',
'SchemaArn': 'string',
'SchemaName': 'string',
'SchemaVersions': [
{
'CreatedDate': datetime(2015, 1, 1),
'SchemaVersion': 'string'
},
]
},
]
}
Response Structure
(dict) --
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) --
SchemaVersion (string) --
The version number of the schema
Stops the discoverer
See also: AWS API Documentation
Request Syntax
client.stop_discoverer(
DiscovererId='string'
)
string
[REQUIRED]
dict
Response Syntax
{
'DiscovererId': 'string',
'State': 'STARTED'|'STOPPED'
}
Response Structure
(dict) --
DiscovererId (string) --
The ID of the discoverer.
State (string) --
The state of the discoverer.
Deletes a discoverer.
See also: AWS API Documentation
Request Syntax
client.delete_discoverer(
DiscovererId='string'
)
string
[REQUIRED]
None
Describes the registry.
See also: AWS API Documentation
Request Syntax
client.describe_registry(
RegistryName='string'
)
string
[REQUIRED]
dict
Response Syntax
{
'Description': 'string',
'RegistryArn': 'string',
'RegistryName': 'string',
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
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.
(string) --
(string) --
Get the discovered schema that was generated based on sampled events.
See also: AWS API Documentation
Request Syntax
client.get_discovered_schema(
Events=[
'string',
],
Type='OpenApi3'
)
list
[REQUIRED]
An array of strings that
(string) --
string
[REQUIRED]
The type of event.
dict
Response Syntax
{
'Content': 'string'
}
Response Structure
(dict) --
Content (string) --
List the schemas.
See also: AWS API Documentation
Request Syntax
client.list_schemas(
Limit=123,
NextToken='string',
RegistryName='string',
SchemaNamePrefix='string'
)
integer
string
string
[REQUIRED]
string
dict
Response Syntax
{
'NextToken': 'string',
'Schemas': [
{
'LastModified': datetime(2015, 1, 1),
'SchemaArn': 'string',
'SchemaName': 'string',
'Tags': {
'string': 'string'
},
'VersionCount': 123
},
]
}
Response Structure
(dict) --
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.
(string) --
(string) --
VersionCount (integer) --
The number of versions available for the schema.
Updates a registry.
See also: AWS API Documentation
Request Syntax
client.update_registry(
Description='string',
RegistryName='string'
)
string
The description of the registry to update.
string
[REQUIRED]
dict
Response Syntax
{
'Description': 'string',
'RegistryArn': 'string',
'RegistryName': 'string',
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
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.
(string) --
(string) --
Provides a list of the schema versions and related information.
See also: AWS API Documentation
Request Syntax
client.list_schema_versions(
Limit=123,
NextToken='string',
RegistryName='string',
SchemaName='string'
)
integer
string
string
[REQUIRED]
string
[REQUIRED]
dict
Response Syntax
{
'NextToken': 'string',
'SchemaVersions': [
{
'SchemaArn': 'string',
'SchemaName': 'string',
'SchemaVersion': 'string'
},
]
}
Response Structure
(dict) --
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.
See also: AWS API Documentation
Request Syntax
client.lock_service_linked_role(
RoleArn='string',
Timeout=123
)
string
[REQUIRED]
integer
[REQUIRED]
dict
Response Syntax
{
'CanBeDeleted': True|False,
'ReasonOfFailure': 'string',
'RelatedResources': [
{
'DiscovererArn': 'string',
'DiscovererId': 'string',
'SourceArn': 'string',
'State': 'STARTED'|'STOPPED',
'Tags': {
'string': 'string'
}
},
]
}
Response Structure
(dict) --
CanBeDeleted (boolean) --
ReasonOfFailure (string) --
RelatedResources (list) --
(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) --
Tags (dict) --
Tags associated with the resource.
(string) --
(string) --
Creates a schema definition.
See also: AWS API Documentation
Request Syntax
client.create_schema(
Content='string',
Description='string',
RegistryName='string',
SchemaName='string',
Tags={
'string': 'string'
},
Type='OpenApi3'
)
string
[REQUIRED]
string
A description of the schema.
string
[REQUIRED]
string
[REQUIRED]
dict
Tags associated with the schema.
(string) --
(string) --
string
[REQUIRED]
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) --
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.
(string) --
(string) --
Type (string) --
The type of the schema.
VersionCreatedDate (datetime) --
The date the schema version was created.
Creates a discoverer.
See also: AWS API Documentation
Request Syntax
client.create_discoverer(
Description='string',
SourceArn='string',
Tags={
'string': 'string'
}
)
string
A description for the discoverer.
string
[REQUIRED]
The ARN of the event bus.
dict
Tags associated with the resource.
(string) --
(string) --
dict
Response Syntax
{
'Description': 'string',
'DiscovererArn': 'string',
'DiscovererId': 'string',
'SourceArn': 'string',
'State': 'STARTED'|'STOPPED',
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
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.
Tags (dict) --
Tags associated with the resource.
(string) --
(string) --
List the registries.
See also: AWS API Documentation
Request Syntax
client.list_registries(
Limit=123,
NextToken='string',
RegistryNamePrefix='string',
Scope='string'
)
integer
string
string
string
dict
Response Syntax
{
'NextToken': 'string',
'Registries': [
{
'RegistryArn': 'string',
'RegistryName': 'string',
'Tags': {
'string': 'string'
}
},
]
}
Response Structure
(dict) --
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.
(string) --
(string) --
Updates the discoverer
See also: AWS API Documentation
Request Syntax
client.update_discoverer(
Description='string',
DiscovererId='string'
)
string
The description of the discoverer to update.
string
[REQUIRED]
dict
Response Syntax
{
'Description': 'string',
'DiscovererArn': 'string',
'DiscovererId': 'string',
'SourceArn': 'string',
'State': 'STARTED'|'STOPPED',
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
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.
Tags (dict) --
Tags associated with the resource.
(string) --
(string) --