SchemasClient

Index > Schemas > SchemasClient

Auto-generated documentation for Schemas type annotations stubs module mypy-boto3-schemas.

SchemasClient

Type annotations and code completion for boto3.client("schemas"). boto3 documentation

# SchemasClient usage example

from boto3.session import Session
from mypy_boto3_schemas.client import SchemasClient

def get_schemas_client() -> SchemasClient:
    return Session().client("schemas")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("schemas").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("schemas")

try:
    do_something(client)
except (
    client.exceptions.BadRequestException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.ForbiddenException,
    client.exceptions.GoneException,
    client.exceptions.InternalServerErrorException,
    client.exceptions.NotFoundException,
    client.exceptions.PreconditionFailedException,
    client.exceptions.ServiceUnavailableException,
    client.exceptions.TooManyRequestsException,
    client.exceptions.UnauthorizedException,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from mypy_boto3_schemas.client import Exceptions

def handle_error(exc: Exceptions.BadRequestException) -> None:
    ...

Methods

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("schemas").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("schemas").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

create_discoverer

Creates a discoverer.

Type annotations and code completion for boto3.client("schemas").create_discoverer method. boto3 documentation

# create_discoverer method definition

def create_discoverer(
    self,
    *,
    SourceArn: str,
    Description: str = ...,
    CrossAccount: bool = ...,
    Tags: Mapping[str, str] = ...,
) -> CreateDiscovererResponseTypeDef:  # (1)
    ...

1. See CreateDiscovererResponseTypeDef

# create_discoverer method usage example with argument unpacking

kwargs: CreateDiscovererRequestRequestTypeDef = {  # (1)
    "SourceArn": ...,
}

parent.create_discoverer(**kwargs)

1. See CreateDiscovererRequestRequestTypeDef

create_registry

Creates a registry.

Type annotations and code completion for boto3.client("schemas").create_registry method. boto3 documentation

# create_registry method definition

def create_registry(
    self,
    *,
    RegistryName: str,
    Description: str = ...,
    Tags: Mapping[str, str] = ...,
) -> CreateRegistryResponseTypeDef:  # (1)
    ...

1. See CreateRegistryResponseTypeDef

# create_registry method usage example with argument unpacking

kwargs: CreateRegistryRequestRequestTypeDef = {  # (1)
    "RegistryName": ...,
}

parent.create_registry(**kwargs)

1. See CreateRegistryRequestRequestTypeDef

create_schema

Creates a schema definition.

Type annotations and code completion for boto3.client("schemas").create_schema method. boto3 documentation

# create_schema method definition

def create_schema(
    self,
    *,
    Content: str,
    RegistryName: str,
    SchemaName: str,
    Type: TypeType,  # (1)
    Description: str = ...,
    Tags: Mapping[str, str] = ...,
) -> CreateSchemaResponseTypeDef:  # (2)
    ...

1. See TypeType
2. See CreateSchemaResponseTypeDef

# create_schema method usage example with argument unpacking

kwargs: CreateSchemaRequestRequestTypeDef = {  # (1)
    "Content": ...,
    "RegistryName": ...,
    "SchemaName": ...,
    "Type": ...,
}

parent.create_schema(**kwargs)

1. See CreateSchemaRequestRequestTypeDef

delete_discoverer

Deletes a discoverer.

Type annotations and code completion for boto3.client("schemas").delete_discoverer method. boto3 documentation

# delete_discoverer method definition

def delete_discoverer(
    self,
    *,
    DiscovererId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_discoverer method usage example with argument unpacking

kwargs: DeleteDiscovererRequestRequestTypeDef = {  # (1)
    "DiscovererId": ...,
}

parent.delete_discoverer(**kwargs)

1. See DeleteDiscovererRequestRequestTypeDef

delete_registry

Deletes a Registry.

Type annotations and code completion for boto3.client("schemas").delete_registry method. boto3 documentation

# delete_registry method definition

def delete_registry(
    self,
    *,
    RegistryName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_registry method usage example with argument unpacking

kwargs: DeleteRegistryRequestRequestTypeDef = {  # (1)
    "RegistryName": ...,
}

parent.delete_registry(**kwargs)

1. See DeleteRegistryRequestRequestTypeDef

delete_resource_policy

Delete the resource-based policy attached to the specified registry.

Type annotations and code completion for boto3.client("schemas").delete_resource_policy method. boto3 documentation

# delete_resource_policy method definition

def delete_resource_policy(
    self,
    *,
    RegistryName: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_resource_policy method usage example with argument unpacking

kwargs: DeleteResourcePolicyRequestRequestTypeDef = {  # (1)
    "RegistryName": ...,
}

parent.delete_resource_policy(**kwargs)

1. See DeleteResourcePolicyRequestRequestTypeDef

delete_schema

Delete a schema definition.

Type annotations and code completion for boto3.client("schemas").delete_schema method. boto3 documentation

# delete_schema method definition

def delete_schema(
    self,
    *,
    RegistryName: str,
    SchemaName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_schema method usage example with argument unpacking

kwargs: DeleteSchemaRequestRequestTypeDef = {  # (1)
    "RegistryName": ...,
    "SchemaName": ...,
}

parent.delete_schema(**kwargs)

1. See DeleteSchemaRequestRequestTypeDef

delete_schema_version

Delete the schema version definition See also: AWS API Documentation.

Type annotations and code completion for boto3.client("schemas").delete_schema_version method. boto3 documentation

# delete_schema_version method definition

def delete_schema_version(
    self,
    *,
    RegistryName: str,
    SchemaName: str,
    SchemaVersion: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_schema_version method usage example with argument unpacking

kwargs: DeleteSchemaVersionRequestRequestTypeDef = {  # (1)
    "RegistryName": ...,
    "SchemaName": ...,
    "SchemaVersion": ...,
}

parent.delete_schema_version(**kwargs)

1. See DeleteSchemaVersionRequestRequestTypeDef

describe_code_binding

Describe the code binding URI.

Type annotations and code completion for boto3.client("schemas").describe_code_binding method. boto3 documentation

# describe_code_binding method definition

def describe_code_binding(
    self,
    *,
    Language: str,
    RegistryName: str,
    SchemaName: str,
    SchemaVersion: str = ...,
) -> DescribeCodeBindingResponseTypeDef:  # (1)
    ...

1. See DescribeCodeBindingResponseTypeDef

# describe_code_binding method usage example with argument unpacking

kwargs: DescribeCodeBindingRequestRequestTypeDef = {  # (1)
    "Language": ...,
    "RegistryName": ...,
    "SchemaName": ...,
}

parent.describe_code_binding(**kwargs)

1. See DescribeCodeBindingRequestRequestTypeDef

describe_discoverer

Describes the discoverer.

Type annotations and code completion for boto3.client("schemas").describe_discoverer method. boto3 documentation

# describe_discoverer method definition

def describe_discoverer(
    self,
    *,
    DiscovererId: str,
) -> DescribeDiscovererResponseTypeDef:  # (1)
    ...

1. See DescribeDiscovererResponseTypeDef

# describe_discoverer method usage example with argument unpacking

kwargs: DescribeDiscovererRequestRequestTypeDef = {  # (1)
    "DiscovererId": ...,
}

parent.describe_discoverer(**kwargs)

1. See DescribeDiscovererRequestRequestTypeDef

describe_registry

Describes the registry.

Type annotations and code completion for boto3.client("schemas").describe_registry method. boto3 documentation

# describe_registry method definition

def describe_registry(
    self,
    *,
    RegistryName: str,
) -> DescribeRegistryResponseTypeDef:  # (1)
    ...

1. See DescribeRegistryResponseTypeDef

# describe_registry method usage example with argument unpacking

kwargs: DescribeRegistryRequestRequestTypeDef = {  # (1)
    "RegistryName": ...,
}

parent.describe_registry(**kwargs)

1. See DescribeRegistryRequestRequestTypeDef

describe_schema

Retrieve the schema definition.

Type annotations and code completion for boto3.client("schemas").describe_schema method. boto3 documentation

# describe_schema method definition

def describe_schema(
    self,
    *,
    RegistryName: str,
    SchemaName: str,
    SchemaVersion: str = ...,
) -> DescribeSchemaResponseTypeDef:  # (1)
    ...

1. See DescribeSchemaResponseTypeDef

# describe_schema method usage example with argument unpacking

kwargs: DescribeSchemaRequestRequestTypeDef = {  # (1)
    "RegistryName": ...,
    "SchemaName": ...,
}

parent.describe_schema(**kwargs)

1. See DescribeSchemaRequestRequestTypeDef

export_schema

See also: AWS API Documentation.

Type annotations and code completion for boto3.client("schemas").export_schema method. boto3 documentation

# export_schema method definition

def export_schema(
    self,
    *,
    RegistryName: str,
    SchemaName: str,
    Type: str,
    SchemaVersion: str = ...,
) -> ExportSchemaResponseTypeDef:  # (1)
    ...

1. See ExportSchemaResponseTypeDef

# export_schema method usage example with argument unpacking

kwargs: ExportSchemaRequestRequestTypeDef = {  # (1)
    "RegistryName": ...,
    "SchemaName": ...,
    "Type": ...,
}

parent.export_schema(**kwargs)

1. See ExportSchemaRequestRequestTypeDef

generate_presigned_url

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

Type annotations and code completion for boto3.client("schemas").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

get_code_binding_source

Get the code binding source URI.

Type annotations and code completion for boto3.client("schemas").get_code_binding_source method. boto3 documentation

# get_code_binding_source method definition

def get_code_binding_source(
    self,
    *,
    Language: str,
    RegistryName: str,
    SchemaName: str,
    SchemaVersion: str = ...,
) -> GetCodeBindingSourceResponseTypeDef:  # (1)
    ...

1. See GetCodeBindingSourceResponseTypeDef

# get_code_binding_source method usage example with argument unpacking

kwargs: GetCodeBindingSourceRequestRequestTypeDef = {  # (1)
    "Language": ...,
    "RegistryName": ...,
    "SchemaName": ...,
}

parent.get_code_binding_source(**kwargs)

1. See GetCodeBindingSourceRequestRequestTypeDef

get_discovered_schema

Get the discovered schema that was generated based on sampled events.

Type annotations and code completion for boto3.client("schemas").get_discovered_schema method. boto3 documentation

# get_discovered_schema method definition

def get_discovered_schema(
    self,
    *,
    Events: Sequence[str],
    Type: TypeType,  # (1)
) -> GetDiscoveredSchemaResponseTypeDef:  # (2)
    ...

1. See TypeType
2. See GetDiscoveredSchemaResponseTypeDef

# get_discovered_schema method usage example with argument unpacking

kwargs: GetDiscoveredSchemaRequestRequestTypeDef = {  # (1)
    "Events": ...,
    "Type": ...,
}

parent.get_discovered_schema(**kwargs)

1. See GetDiscoveredSchemaRequestRequestTypeDef

get_resource_policy

Retrieves the resource-based policy attached to a given registry.

Type annotations and code completion for boto3.client("schemas").get_resource_policy method. boto3 documentation

# get_resource_policy method definition

def get_resource_policy(
    self,
    *,
    RegistryName: str = ...,
) -> GetResourcePolicyResponseTypeDef:  # (1)
    ...

1. See GetResourcePolicyResponseTypeDef

# get_resource_policy method usage example with argument unpacking

kwargs: GetResourcePolicyRequestRequestTypeDef = {  # (1)
    "RegistryName": ...,
}

parent.get_resource_policy(**kwargs)

1. See GetResourcePolicyRequestRequestTypeDef

list_discoverers

List the discoverers.

Type annotations and code completion for boto3.client("schemas").list_discoverers method. boto3 documentation

# list_discoverers method definition

def list_discoverers(
    self,
    *,
    DiscovererIdPrefix: str = ...,
    Limit: int = ...,
    NextToken: str = ...,
    SourceArnPrefix: str = ...,
) -> ListDiscoverersResponseTypeDef:  # (1)
    ...

1. See ListDiscoverersResponseTypeDef

# list_discoverers method usage example with argument unpacking

kwargs: ListDiscoverersRequestRequestTypeDef = {  # (1)
    "DiscovererIdPrefix": ...,
}

parent.list_discoverers(**kwargs)

1. See ListDiscoverersRequestRequestTypeDef

list_registries

List the registries.

Type annotations and code completion for boto3.client("schemas").list_registries method. boto3 documentation

# list_registries method definition

def list_registries(
    self,
    *,
    Limit: int = ...,
    NextToken: str = ...,
    RegistryNamePrefix: str = ...,
    Scope: str = ...,
) -> ListRegistriesResponseTypeDef:  # (1)
    ...

1. See ListRegistriesResponseTypeDef

# list_registries method usage example with argument unpacking

kwargs: ListRegistriesRequestRequestTypeDef = {  # (1)
    "Limit": ...,
}

parent.list_registries(**kwargs)

1. See ListRegistriesRequestRequestTypeDef

list_schema_versions

Provides a list of the schema versions and related information.

Type annotations and code completion for boto3.client("schemas").list_schema_versions method. boto3 documentation

# list_schema_versions method definition

def list_schema_versions(
    self,
    *,
    RegistryName: str,
    SchemaName: str,
    Limit: int = ...,
    NextToken: str = ...,
) -> ListSchemaVersionsResponseTypeDef:  # (1)
    ...

1. See ListSchemaVersionsResponseTypeDef

# list_schema_versions method usage example with argument unpacking

kwargs: ListSchemaVersionsRequestRequestTypeDef = {  # (1)
    "RegistryName": ...,
    "SchemaName": ...,
}

parent.list_schema_versions(**kwargs)

1. See ListSchemaVersionsRequestRequestTypeDef

list_schemas

List the schemas.

Type annotations and code completion for boto3.client("schemas").list_schemas method. boto3 documentation

# list_schemas method definition

def list_schemas(
    self,
    *,
    RegistryName: str,
    Limit: int = ...,
    NextToken: str = ...,
    SchemaNamePrefix: str = ...,
) -> ListSchemasResponseTypeDef:  # (1)
    ...

1. See ListSchemasResponseTypeDef

# list_schemas method usage example with argument unpacking

kwargs: ListSchemasRequestRequestTypeDef = {  # (1)
    "RegistryName": ...,
}

parent.list_schemas(**kwargs)

1. See ListSchemasRequestRequestTypeDef

list_tags_for_resource

Get tags for resource.

Type annotations and code completion for boto3.client("schemas").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...

1. See ListTagsForResourceResponseTypeDef

# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestRequestTypeDef

put_code_binding

Put code binding URI See also: AWS API Documentation.

Type annotations and code completion for boto3.client("schemas").put_code_binding method. boto3 documentation

# put_code_binding method definition

def put_code_binding(
    self,
    *,
    Language: str,
    RegistryName: str,
    SchemaName: str,
    SchemaVersion: str = ...,
) -> PutCodeBindingResponseTypeDef:  # (1)
    ...

1. See PutCodeBindingResponseTypeDef

# put_code_binding method usage example with argument unpacking

kwargs: PutCodeBindingRequestRequestTypeDef = {  # (1)
    "Language": ...,
    "RegistryName": ...,
    "SchemaName": ...,
}

parent.put_code_binding(**kwargs)

1. See PutCodeBindingRequestRequestTypeDef

put_resource_policy

The name of the policy.

Type annotations and code completion for boto3.client("schemas").put_resource_policy method. boto3 documentation

# put_resource_policy method definition

def put_resource_policy(
    self,
    *,
    Policy: str,
    RegistryName: str = ...,
    RevisionId: str = ...,
) -> PutResourcePolicyResponseTypeDef:  # (1)
    ...

1. See PutResourcePolicyResponseTypeDef

# put_resource_policy method usage example with argument unpacking

kwargs: PutResourcePolicyRequestRequestTypeDef = {  # (1)
    "Policy": ...,
}

parent.put_resource_policy(**kwargs)

1. See PutResourcePolicyRequestRequestTypeDef

search_schemas

Search the schemas See also: AWS API Documentation.

Type annotations and code completion for boto3.client("schemas").search_schemas method. boto3 documentation

# search_schemas method definition

def search_schemas(
    self,
    *,
    Keywords: str,
    RegistryName: str,
    Limit: int = ...,
    NextToken: str = ...,
) -> SearchSchemasResponseTypeDef:  # (1)
    ...

1. See SearchSchemasResponseTypeDef

# search_schemas method usage example with argument unpacking

kwargs: SearchSchemasRequestRequestTypeDef = {  # (1)
    "Keywords": ...,
    "RegistryName": ...,
}

parent.search_schemas(**kwargs)

1. See SearchSchemasRequestRequestTypeDef

start_discoverer

Starts the discoverer See also: AWS API Documentation.

Type annotations and code completion for boto3.client("schemas").start_discoverer method. boto3 documentation

# start_discoverer method definition

def start_discoverer(
    self,
    *,
    DiscovererId: str,
) -> StartDiscovererResponseTypeDef:  # (1)
    ...

1. See StartDiscovererResponseTypeDef

# start_discoverer method usage example with argument unpacking

kwargs: StartDiscovererRequestRequestTypeDef = {  # (1)
    "DiscovererId": ...,
}

parent.start_discoverer(**kwargs)

1. See StartDiscovererRequestRequestTypeDef

stop_discoverer

Stops the discoverer See also: AWS API Documentation.

Type annotations and code completion for boto3.client("schemas").stop_discoverer method. boto3 documentation

# stop_discoverer method definition

def stop_discoverer(
    self,
    *,
    DiscovererId: str,
) -> StopDiscovererResponseTypeDef:  # (1)
    ...

1. See StopDiscovererResponseTypeDef

# stop_discoverer method usage example with argument unpacking

kwargs: StopDiscovererRequestRequestTypeDef = {  # (1)
    "DiscovererId": ...,
}

parent.stop_discoverer(**kwargs)

1. See StopDiscovererRequestRequestTypeDef

tag_resource

Add tags to a resource.

Type annotations and code completion for boto3.client("schemas").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    ResourceArn: str,
    Tags: Mapping[str, str],
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestRequestTypeDef

untag_resource

Removes tags from a resource.

Type annotations and code completion for boto3.client("schemas").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    ResourceArn: str,
    TagKeys: Sequence[str],
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestRequestTypeDef

update_discoverer

Updates the discoverer See also: AWS API Documentation.

Type annotations and code completion for boto3.client("schemas").update_discoverer method. boto3 documentation

# update_discoverer method definition

def update_discoverer(
    self,
    *,
    DiscovererId: str,
    Description: str = ...,
    CrossAccount: bool = ...,
) -> UpdateDiscovererResponseTypeDef:  # (1)
    ...

1. See UpdateDiscovererResponseTypeDef

# update_discoverer method usage example with argument unpacking

kwargs: UpdateDiscovererRequestRequestTypeDef = {  # (1)
    "DiscovererId": ...,
}

parent.update_discoverer(**kwargs)

1. See UpdateDiscovererRequestRequestTypeDef

update_registry

Updates a registry.

Type annotations and code completion for boto3.client("schemas").update_registry method. boto3 documentation

# update_registry method definition

def update_registry(
    self,
    *,
    RegistryName: str,
    Description: str = ...,
) -> UpdateRegistryResponseTypeDef:  # (1)
    ...

1. See UpdateRegistryResponseTypeDef

# update_registry method usage example with argument unpacking

kwargs: UpdateRegistryRequestRequestTypeDef = {  # (1)
    "RegistryName": ...,
}

parent.update_registry(**kwargs)

1. See UpdateRegistryRequestRequestTypeDef

update_schema

Updates the schema definition .

Type annotations and code completion for boto3.client("schemas").update_schema method. boto3 documentation

# update_schema method definition

def update_schema(
    self,
    *,
    RegistryName: str,
    SchemaName: str,
    ClientTokenId: str = ...,
    Content: str = ...,
    Description: str = ...,
    Type: TypeType = ...,  # (1)
) -> UpdateSchemaResponseTypeDef:  # (2)
    ...

1. See TypeType
2. See UpdateSchemaResponseTypeDef

# update_schema method usage example with argument unpacking

kwargs: UpdateSchemaRequestRequestTypeDef = {  # (1)
    "RegistryName": ...,
    "SchemaName": ...,
}

parent.update_schema(**kwargs)

1. See UpdateSchemaRequestRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("schemas").get_paginator method with overloads.

• client.get_paginator("list_discoverers") -> ListDiscoverersPaginator
• client.get_paginator("list_registries") -> ListRegistriesPaginator
• client.get_paginator("list_schema_versions") -> ListSchemaVersionsPaginator
• client.get_paginator("list_schemas") -> ListSchemasPaginator
• client.get_paginator("search_schemas") -> SearchSchemasPaginator

get_waiter

Type annotations and code completion for boto3.client("schemas").get_waiter method with overloads.

• client.get_waiter("code_binding_exists") -> CodeBindingExistsWaiter