Skip to content

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 d