Navigation

Table Of Contents

  1. Docs
  2. Available Services
  3. Schemas

Schemas

Table of Contents

Client

class Schemas.Client

A low-level client representing Schemas:

import boto3

client = boto3.client('schemas')

These are the available methods:

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is 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").
Returns
True if the operation can be paginated, False otherwise.
create_discoverer(**kwargs)

Creates a discoverer.

See also: AWS API Documentation

Request Syntax

response = client.create_discoverer(
    Description='string',
    SourceArn='string',
    Tags={
        'string': 'string'
    }
)
Parameters
  • Description (string) -- A description for the discoverer.
  • SourceArn (string) --

    [REQUIRED]

    The ARN of the event bus.

  • Tags (dict) --

    Tags associated with the resource.

    • (string) --
      • (string) --
Return type

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

create_registry(**kwargs)

Creates a registry.

See also: AWS API Documentation

Request Syntax

response = client.create_registry(
    Description='string',
    RegistryName='string',
    Tags={
        'string': 'string'
    }
)
Parameters
  • Description (string) -- A description of the registry to be created.
  • RegistryName (string) -- [REQUIRED]
  • Tags (dict) --

    Tags to associate with the registry.

    • (string) --
      • (string) --
Return type

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

create_schema(**kwargs)

Creates a schema definition.

See also: AWS API Documentation

Request Syntax

response = client.create_schema(
    Content='string',
    Description='string',
    RegistryName='string',
    SchemaName='string',
    Tags={
        'string': 'string'
    },
    Type='OpenApi3'
)
Parameters
  • Content (string) -- [REQUIRED]
  • Description (string) -- A description of the schema.
  • RegistryName (string) -- [REQUIRED]
  • SchemaName (string) -- [REQUIRED]
  • Tags (dict) --

    Tags associated with the schema.

    • (string) --
      • (string) --
  • Type (string) -- [REQUIRED]
Return type

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.

delete_discoverer(**kwargs)

Deletes a discoverer.

See also: AWS API Documentation

Request Syntax

response = client.delete_discoverer(
    DiscovererId='string'
)
Parameters
DiscovererId (string) -- [REQUIRED]
Returns
None
delete_registry(**kwargs)

Deletes a Registry.

See also: AWS API Documentation

Request Syntax

response = client.delete_registry(
    RegistryName='string'
)
Parameters
RegistryName (string) -- [REQUIRED]
Returns
None
delete_schema(**kwargs)

Delete a schema definition.

See also: AWS API Documentation

Request Syntax

response = client.delete_schema(
    RegistryName='string',
    SchemaName='string'
)
Parameters
  • RegistryName (string) -- [REQUIRED]
  • SchemaName (string) -- [REQUIRED]
Returns

None

delete_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'
)
Parameters
  • RegistryName (string) -- [REQUIRED]
  • SchemaName (string) -- [REQUIRED]
  • SchemaVersion (string) -- [REQUIRED]
Returns

None

describe_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'
)
Parameters
  • Language (string) -- [REQUIRED]
  • RegistryName (string) -- [REQUIRED]
  • SchemaName (string) -- [REQUIRED]
  • SchemaVersion (string) --
Return type

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.

describe_discoverer(**kwargs)

Describes the discoverer.

See also: AWS API Documentation

Request Syntax

response = client.describe_discoverer(
    DiscovererId='string'
)
Parameters
DiscovererId (string) -- [REQUIRED]
Return type
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) --
describe_registry(**kwargs)

Describes the registry.

See also: AWS API Documentation

Request Syntax

response = client.describe_registry(
    RegistryName='string'
)
Parameters
RegistryName (string) -- [REQUIRED]
Return type
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) --
describe_schema(**kwargs)

Retrieve the schema definition.

See also: AWS API Documentation

Request Syntax

response = client.describe_schema(
    RegistryName='string',
    SchemaName='string',
    SchemaVersion='string'
)
Parameters
  • RegistryName (string) -- [REQUIRED]
  • SchemaName (string) -- [REQUIRED]
  • SchemaVersion (string) --
Return type

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.

generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)

Generate a presigned url given a client, its method, and arguments

Parameters
  • ClientMethod (string) -- The client method to presign for
  • Params (dict) -- The parameters normally passed to ClientMethod.
  • ExpiresIn (int) -- The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
  • HttpMethod (string) -- The http method to use on the generated url. By default, the http method is whatever is used in the method's model.
Returns

The presigned url

get_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'
)
Parameters
  • Language (string) -- [REQUIRED]
  • RegistryName (string) -- [REQUIRED]
  • SchemaName (string) -- [REQUIRED]
  • SchemaVersion (string) --
Return type

dict

Returns

Response Syntax

{
    'Body': StreamingBody()
}

Response Structure

  • (dict) --
    • Body (StreamingBody) --

get_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'
)
Parameters
  • Events (list) --

    [REQUIRED]

    An array of strings that

    • (string) --
  • Type (string) --

    [REQUIRED]

    The type of event.

Return type

dict

Returns

Response Syntax

{
    'Content': 'string'
}

Response Structure

  • (dict) --
    • Content (string) --

get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is 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").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
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'
)
Parameters
  • DiscovererIdPrefix (string) --
  • Limit (integer) --
  • NextToken (string) --
  • SourceArnPrefix (string) --
Return type

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.

list_registries(**kwargs)

List the registries.

See also: AWS API Documentation

Request Syntax

response = client.list_registries(
    Limit=123,
    NextToken='string',
    RegistryNamePrefix='string',
    Scope='string'
)
Parameters
  • Limit (integer) --
  • NextToken (string) --
  • RegistryNamePrefix (string) --
  • Scope (string) --
Return type

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

list_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'
)
Parameters
  • Limit (integer) --
  • NextToken (string) --
  • RegistryName (string) -- [REQUIRED]
  • SchemaName (string) -- [REQUIRED]
Return type

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.

list_schemas(**kwargs)

List the schemas.

See also: AWS API Documentation

Request Syntax

response = client.list_schemas(
    Limit=123,
    NextToken='string',
    RegistryName='string',
    SchemaNamePrefix='string'
)
Parameters
  • Limit (integer) --
  • NextToken (string) --
  • RegistryName (string) -- [REQUIRED]
  • SchemaNamePrefix (string) --
Return type

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.

list_tags_for_resource(**kwargs)

Get tags for resource.

See also: AWS API Documentation

Request Syntax

response = client.list_tags_for_resource(
    ResourceArn='string'
)
Parameters
ResourceArn (string) -- [REQUIRED]
Return type
dict
Returns
Response Syntax
{
    'Tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --
    • Tags (dict) --

      Key-value pairs associated with a resource.

      • (string) --
        • (string) --
lock_service_linked_role(**kwargs)

See also: AWS API Documentation

Request Syntax

response = client.lock_service_linked_role(
    RoleArn='string',
    Timeout=123
)
Parameters
  • RoleArn (string) -- [REQUIRED]
  • Timeout (integer) -- [REQUIRED]
Return type

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

put_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'
)
Parameters
  • Language (string) -- [REQUIRED]
  • RegistryName (string) -- [REQUIRED]
  • SchemaName (string) -- [REQUIRED]
  • SchemaVersion (string) --
Return type

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.

search_schemas(**kwargs)

Search the schemas

See also: AWS API Documentation

Request Syntax

response = client.search_schemas(
    Keywords='string',
    Limit=123,
    NextToken='string',
    RegistryName='string'
)
Parameters
  • Keywords (string) -- [REQUIRED]
  • Limit (integer) --
  • NextToken (string) --
  • RegistryName (string) -- [REQUIRED]
Return type

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

start_discoverer(**kwargs)

Starts the discoverer

See also: AWS API Documentation

Request Syntax

response = client.start_discoverer(
    DiscovererId='string'
)
Parameters
DiscovererId (string) -- [REQUIRED]
Return type
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.

stop_discoverer(**kwargs)

Stops the discoverer

See also: AWS API Documentation

Request Syntax

response = client.stop_discoverer(
    DiscovererId='string'
)
Parameters
DiscovererId (string) -- [REQUIRED]
Return type
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.

tag_resource(**kwargs)

Add tags to a resource.

See also: AWS API Documentation

Request Syntax

response = client.tag_resource(
    ResourceArn='string',
    Tags={
        'string': 'string'
    }
)
Parameters
  • ResourceArn (string) -- [REQUIRED]
  • Tags (dict) --

    [REQUIRED]

    Key-value pairs associated with a resource.

    • (string) --
      • (string) --
Returns

None

unlock_service_linked_role(**kwargs)

See also: AWS API Documentation

Request Syntax

response = client.unlock_service_linked_role(
    RoleArn='string'
)
Parameters
RoleArn (string) -- [REQUIRED]
Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --
untag_resource(**kwargs)

Removes tags from a resource.

See also: AWS API Documentation

Request Syntax

response = client.untag_resource(
    ResourceArn='string',
    TagKeys=[
        'string',
    ]
)
Parameters
  • ResourceArn (string) -- [REQUIRED]
  • TagKeys (list) --

    [REQUIRED]

    • (string) --
Returns

None

update_discoverer(**kwargs)

Updates the discoverer

See also: AWS API Documentation

Request Syntax

response = client.update_discoverer(
    Description='string',
    DiscovererId='string'
)
Parameters
  • Description (string) -- The description of the discoverer to update.
  • DiscovererId (string) -- [REQUIRED]
Return type

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

update_registry(**kwargs)

Updates a registry.

See also: AWS API Documentation

Request Syntax

response = client.update_registry(
    Description='string',
    RegistryName='string'
)
Parameters
  • Description (string) -- The description of the registry to update.
  • RegistryName (string) -- [REQUIRED]
Return type

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

update_schema(**kwargs)

Updates the schema definition

See also: AWS API Documentation

Request Syntax

response = client.update_schema(
    ClientTokenId='string',
    Content='string',
    Description='string',
    RegistryName='string',
    SchemaName='string',
    Type='OpenApi3'
)
Parameters
  • ClientTokenId (string) --

    The ID of the client token.

    This field is autopopulated if not provided.

  • Content (string) -- The source of the schema definition.
  • Description (string) -- The description of the schema.
  • RegistryName (string) -- [REQUIRED]
  • SchemaName (string) -- [REQUIRED]
  • Type (string) -- The schema type for the events schema.
Return type

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.

Paginators

The available paginators are:

class Schemas.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'
    }
)
Parameters
  • DiscovererIdPrefix (string) --
  • SourceArnPrefix (string) --
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      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.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'Discoverers': [
        {
            'DiscovererArn': 'string',
            'DiscovererId': 'string',
            'SourceArn': 'string',
            'State': 'STARTED'|'STOPPED',
            'Tags': {
                'string': '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) --

class 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'
    }
)
Parameters
  • RegistryNamePrefix (string) --
  • Scope (string) --
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      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.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'Registries': [
        {
            'RegistryArn': 'string',
            'RegistryName': 'string',
            'Tags': {
                'string': 'string'
            }
        },
    ]
}

Response Structure

  • (dict) --

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

class 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'
    }
)
Parameters
  • RegistryName (string) -- [REQUIRED]
  • SchemaName (string) -- [REQUIRED]
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      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.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'SchemaVersions': [
        {
            'SchemaArn': 'string',
            'SchemaName': 'string',
            'SchemaVersion': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • 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.

class 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'
    }
)
Parameters
  • RegistryName (string) -- [REQUIRED]
  • SchemaNamePrefix (string) --
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      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.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'Schemas': [
        {
            'LastModified': datetime(2015, 1, 1),
            'SchemaArn': 'string',
            'SchemaName': 'string',
            'Tags': {
                'string': 'string'
            },
            'VersionCount': 123
        },
    ]
}

Response Structure

  • (dict) --

    • 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.

class 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'
    }
)
Parameters
  • Keywords (string) -- [REQUIRED]
  • RegistryName (string) -- [REQUIRED]
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      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.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'Schemas': [
        {
            'RegistryName': 'string',
            'SchemaArn': 'string',
            'SchemaName': 'string',
            'SchemaVersions': [
                {
                    'CreatedDate': datetime(2015, 1, 1),
                    'SchemaVersion': 'string'
                },
            ]
        },
    ]
}

Response Structure

  • (dict) --

    • 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

Waiters

The available waiters are:

class 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
    }
)
Parameters
  • Language (string) -- [REQUIRED]
  • RegistryName (string) -- [REQUIRED]
  • SchemaName (string) -- [REQUIRED]
  • SchemaVersion (string) --
  • WaiterConfig (dict) --

    A dictionary that provides parameters to control waiting behavior.

    • Delay (integer) --

      The amount of time in seconds to wait between attempts. Default: 2

    • MaxAttempts (integer) --

      The maximum number of attempts to be made. Default: 30

Returns

None

SavingsPlans
SimpleDB

Navigation

© Copyright 2019, Amazon Web Services, Inc. Created using Sphinx.