Schemas

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.

LockServiceLinkedRole (new) Link ¶

See also: AWS API Documentation

Request Syntax

client.lock_service_linked_role(
    RoleArn='string',
    Timeout=123
)
type RoleArn

string

param RoleArn

[REQUIRED]

type Timeout

integer

param Timeout

[REQUIRED]

rtype

dict

returns

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) --

StopDiscoverer (new) Link ¶

Stops the discoverer

See also: AWS API Documentation

Request Syntax

client.stop_discoverer(
    DiscovererId='string'
)
type DiscovererId

string

param DiscovererId

[REQUIRED]

rtype

dict

returns

Response Syntax

{
    'DiscovererId': 'string',
    'State': 'STARTED'|'STOPPED'
}

Response Structure

  • (dict) --

    • DiscovererId (string) --

      The ID of the discoverer.

    • State (string) --

      The state of the discoverer.

SearchSchemas (new) Link ¶

Search the schemas

See also: AWS API Documentation

Request Syntax

client.search_schemas(
    Keywords='string',
    Limit=123,
    NextToken='string',
    RegistryName='string'
)
type Keywords

string

param Keywords

[REQUIRED]

type Limit

integer

param Limit

type NextToken

string

param NextToken

type RegistryName

string

param RegistryName

[REQUIRED]

rtype

dict

returns

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

DescribeSchema (new) Link ¶

Retrieve the schema definition.

See also: AWS API Documentation

Request Syntax

client.describe_schema(
    RegistryName='string',
    SchemaName='string',
    SchemaVersion='string'
)
type RegistryName

string

param RegistryName

[REQUIRED]

type SchemaName

string

param SchemaName

[REQUIRED]

type SchemaVersion

string

param SchemaVersion

rtype

dict

returns

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.

UntagResource (new) Link ¶

Removes tags from a resource.

See also: AWS API Documentation

Request Syntax

client.untag_resource(
    ResourceArn='string',
    TagKeys=[
        'string',
    ]
)
type ResourceArn

string

param ResourceArn

[REQUIRED]

type TagKeys

list

param TagKeys

[REQUIRED]

  • (string) --

returns

None

UpdateRegistry (new) Link ¶

Updates a registry.

See also: AWS API Documentation

Request Syntax

client.update_registry(
    Description='string',
    RegistryName='string'
)
type Description

string

param Description

The description of the registry to update.

type RegistryName

string

param RegistryName

[REQUIRED]

rtype

dict

returns

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) --

GetCodeBindingSource (new) Link ¶

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'
)
type Language

string

param Language

[REQUIRED]

type RegistryName

string

param RegistryName

[REQUIRED]

type SchemaName

string

param SchemaName

[REQUIRED]

type SchemaVersion

string

param SchemaVersion

rtype

dict

returns

Response Syntax

{
    'Body': StreamingBody()
}

Response Structure

GetDiscoveredSchema (new) Link ¶

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'
)
type Events

list

param Events

[REQUIRED]

An array of strings that

  • (string) --

type Type

string

param Type

[REQUIRED]

The type of event.

rtype

dict

returns

Response Syntax

{
    'Content': 'string'
}

Response Structure

  • (dict) --

    • Content (string) --

PutCodeBinding (new) Link ¶

Put code binding URI

See also: AWS API Documentation

Request Syntax

client.put_code_binding(
    Language='string',
    RegistryName='string',
    SchemaName='string',
    SchemaVersion='string'
)
type Language

string

param Language

[REQUIRED]

type RegistryName

string

param RegistryName

[REQUIRED]

type SchemaName

string

param SchemaName

[REQUIRED]

type SchemaVersion

string

param SchemaVersion

rtype

dict

returns

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.

DeleteRegistry (new) Link ¶

Deletes a Registry.

See also: AWS API Documentation

Request Syntax

client.delete_registry(
    RegistryName='string'
)
type RegistryName

string

param RegistryName

[REQUIRED]

returns

None

ListSchemas (new) Link ¶

List the schemas.

See also: AWS API Documentation

Request Syntax

client.list_schemas(
    Limit=123,
    NextToken='string',
    RegistryName='string',
    SchemaNamePrefix='string'
)
type Limit

integer

param Limit

type NextToken

string

param NextToken

type RegistryName

string

param RegistryName

[REQUIRED]

type SchemaNamePrefix

string

param SchemaNamePrefix

rtype

dict

returns

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.

UpdateDiscoverer (new) Link ¶

Updates the discoverer

See also: AWS API Documentation

Request Syntax

client.update_discoverer(
    Description='string',
    DiscovererId='string'
)
type Description

string

param Description

The description of the discoverer to update.

type DiscovererId

string

param DiscovererId

[REQUIRED]

rtype

dict

returns

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) --

DescribeCodeBinding (new) Link ¶

Describe the code binding URI.

See also: AWS API Documentation

Request Syntax

client.describe_code_binding(
    Language='string',
    RegistryName='string',
    SchemaName='string',
    SchemaVersion='string'
)
type Language

string

param Language

[REQUIRED]

type RegistryName

string

param RegistryName

[REQUIRED]

type SchemaName

string

param SchemaName

[REQUIRED]

type SchemaVersion

string

param SchemaVersion

rtype

dict

returns

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.

ListTagsForResource (new) Link ¶

Get tags for resource.

See also: AWS API Documentation

Request Syntax

client.list_tags_for_resource(
    ResourceArn='string'
)
type ResourceArn

string

param ResourceArn

[REQUIRED]

rtype

dict

returns

Response Syntax

{
    'Tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --

    • Tags (dict) --

      Key-value pairs associated with a resource.

      • (string) --

        • (string) --

DeleteSchemaVersion (new) Link ¶

Delete the schema version definition

See also: AWS API Documentation

Request Syntax

client.delete_schema_version(
    RegistryName='string',
    SchemaName='string',
    SchemaVersion='string'
)
type RegistryName

string

param RegistryName

[REQUIRED]

type SchemaName

string

param SchemaName

[REQUIRED]

type SchemaVersion

string

param SchemaVersion

[REQUIRED]

returns

None

ListDiscoverers (new) Link ¶

List the discoverers.

See also: AWS API Documentation

Request Syntax

client.list_discoverers(
    DiscovererIdPrefix='string',
    Limit=123,
    NextToken='string',
    SourceArnPrefix='string'
)
type DiscovererIdPrefix

string

param DiscovererIdPrefix

type Limit

integer

param Limit

type NextToken

string

param NextToken

type SourceArnPrefix

string

param SourceArnPrefix

rtype

dict

returns

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.

TagResource (new) Link ¶

Add tags to a resource.

See also: AWS API Documentation

Request Syntax

client.tag_resource(
    ResourceArn='string',
    Tags={
        'string': 'string'
    }
)
type ResourceArn

string

param ResourceArn

[REQUIRED]

type Tags

dict

param Tags

[REQUIRED]

Key-value pairs associated with a resource.

  • (string) --

    • (string) --

returns

None

DeleteDiscoverer (new) Link ¶

Deletes a discoverer.

See also: AWS API Documentation

Request Syntax

client.delete_discoverer(
    DiscovererId='string'
)
type DiscovererId

string

param DiscovererId

[REQUIRED]

returns

None

DescribeRegistry (new) Link ¶

Describes the registry.

See also: AWS API Documentation

Request Syntax

client.describe_registry(
    RegistryName='string'
)
type RegistryName

string

param RegistryName

[REQUIRED]

rtype

dict

returns

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) --

UnlockServiceLinkedRole (new) Link ¶

See also: AWS API Documentation

Request Syntax

client.unlock_service_linked_role(
    RoleArn='string'
)
type RoleArn

string

param RoleArn

[REQUIRED]

rtype

dict

returns

Response Syntax

{}

Response Structure

  • (dict) --

DescribeDiscoverer (new) Link ¶

Describes the discoverer.

See also: AWS API Documentation

Request Syntax

client.describe_discoverer(
    DiscovererId='string'
)
type DiscovererId

string

param DiscovererId

[REQUIRED]

rtype

dict

returns

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) --

CreateDiscoverer (new) Link ¶

Creates a discoverer.

See also: AWS API Documentation

Request Syntax

client.create_discoverer(
    Description='string',
    SourceArn='string',
    Tags={
        'string': 'string'
    }
)
type Description

string

param Description

A description for the discoverer.

type SourceArn

string

param SourceArn

[REQUIRED]

The ARN of the event bus.

type Tags

dict

param Tags

Tags associated with the resource.

  • (string) --

    • (string) --

rtype

dict

returns

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) --

CreateRegistry (new) Link ¶

Creates a registry.

See also: AWS API Documentation

Request Syntax

client.create_registry(
    Description='string',
    RegistryName='string',
    Tags={
        'string': 'string'
    }
)
type Description

string

param Description

A description of the registry to be created.

type RegistryName

string

param RegistryName

[REQUIRED]

type Tags

dict

param Tags

Tags to associate with the registry.

  • (string) --

    • (string) --

rtype

dict

returns

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) --

UpdateSchema (new) Link ¶

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'
)
type ClientTokenId

string

param ClientTokenId

The ID of the client token.

This field is autopopulated if not provided.

type Content

string

param Content

The source of the schema definition.

type Description

string

param Description

The description of the schema.

type RegistryName

string

param RegistryName

[REQUIRED]

type SchemaName

string

param SchemaName

[REQUIRED]

type Type

string

param Type

The schema type for the events schema.

rtype

dict

returns

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.

CreateSchema (new) Link ¶

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'
)
type Content

string

param Content

[REQUIRED]

type Description

string

param Description

A description of the schema.

type RegistryName

string

param RegistryName

[REQUIRED]

type SchemaName

string

param SchemaName

[REQUIRED]

type Tags

dict

param Tags

Tags associated with the schema.

  • (string) --

    • (string) --

type Type

string

param Type

[REQUIRED]

rtype

dict

returns

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.

StartDiscoverer (new) Link ¶

Starts the discoverer

See also: AWS API Documentation

Request Syntax

client.start_discoverer(
    DiscovererId='string'
)
type DiscovererId

string

param DiscovererId

[REQUIRED]

rtype

dict

returns

Response Syntax

{
    'DiscovererId': 'string',
    'State': 'STARTED'|'STOPPED'
}

Response Structure

  • (dict) --

    • DiscovererId (string) --

      The ID of the discoverer.

    • State (string) --

      The state of the discoverer.

ListSchemaVersions (new) Link ¶

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'
)
type Limit

integer

param Limit

type NextToken

string

param NextToken

type RegistryName

string

param RegistryName

[REQUIRED]

type SchemaName

string

param SchemaName

[REQUIRED]

rtype

dict

returns

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.

DeleteSchema (new) Link ¶

Delete a schema definition.

See also: AWS API Documentation

Request Syntax

client.delete_schema(
    RegistryName='string',
    SchemaName='string'
)
type RegistryName

string

param RegistryName

[REQUIRED]

type SchemaName

string

param SchemaName

[REQUIRED]

returns

None

ListRegistries (new) Link ¶

List the registries.

See also: AWS API Documentation

Request Syntax

client.list_registries(
    Limit=123,
    NextToken='string',
    RegistryNamePrefix='string',
    Scope='string'
)
type Limit

integer

param Limit

type NextToken

string

param NextToken

type RegistryNamePrefix

string

param RegistryNamePrefix

type Scope

string

param Scope

rtype

dict

returns

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) --