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)
...
# create_discoverer method usage example with argument unpacking
kwargs: CreateDiscovererRequestRequestTypeDef = { # (1)
"SourceArn": ...,
}
parent.create_discoverer(**kwargs)
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)
...
# create_registry method usage example with argument unpacking
kwargs: CreateRegistryRequestRequestTypeDef = { # (1)
"RegistryName": ...,
}
parent.create_registry(**kwargs)
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)
...
- See TypeType
- See CreateSchemaResponseTypeDef
# create_schema method usage example with argument unpacking
kwargs: CreateSchemaRequestRequestTypeDef = { # (1)
"Content": ...,
"RegistryName": ...,
"SchemaName": ...,
"Type": ...,
}
parent.create_schema(**kwargs)
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)
...
# delete_discoverer method usage example with argument unpacking
kwargs: DeleteDiscovererRequestRequestTypeDef = { # (1)
"DiscovererId": ...,
}
parent.delete_discoverer(**kwargs)
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)
...
# delete_registry method usage example with argument unpacking
kwargs: DeleteRegistryRequestRequestTypeDef = { # (1)
"RegistryName": ...,
}
parent.delete_registry(**kwargs)
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)
...
# delete_resource_policy method usage example with argument unpacking
kwargs: DeleteResourcePolicyRequestRequestTypeDef = { # (1)
"RegistryName": ...,
}
parent.delete_resource_policy(**kwargs)
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)
...
# delete_schema method usage example with argument unpacking
kwargs: DeleteSchemaRequestRequestTypeDef = { # (1)
"RegistryName": ...,
"SchemaName": ...,
}
parent.delete_schema(**kwargs)
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)
...
# delete_schema_version method usage example with argument unpacking
kwargs: DeleteSchemaVersionRequestRequestTypeDef = { # (1)
"RegistryName": ...,
"SchemaName": ...,
"SchemaVersion": ...,
}
parent.delete_schema_version(**kwargs)
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)
...
# describe_code_binding method usage example with argument unpacking
kwargs: DescribeCodeBindingRequestRequestTypeDef = { # (1)
"Language": ...,
"RegistryName": ...,
"SchemaName": ...,
}
parent.describe_code_binding(**kwargs)
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)
...
# describe_discoverer method usage example with argument unpacking
kwargs: DescribeDiscovererRequestRequestTypeDef = { # (1)
"DiscovererId": ...,
}
parent.describe_discoverer(**kwargs)
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)
...
# describe_registry method usage example with argument unpacking
kwargs: DescribeRegistryRequestRequestTypeDef = { # (1)
"RegistryName": ...,
}
parent.describe_registry(**kwargs)
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)
...
# describe_schema method usage example with argument unpacking
kwargs: DescribeSchemaRequestRequestTypeDef = { # (1)
"RegistryName": ...,
"SchemaName": ...,
}
parent.describe_schema(**kwargs)
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)
...
# export_schema method usage example with argument unpacking
kwargs: ExportSchemaRequestRequestTypeDef = { # (1)
"RegistryName": ...,
"SchemaName": ...,
"Type": ...,
}
parent.export_schema(**kwargs)
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)
...
# get_code_binding_source method usage example with argument unpacking
kwargs: GetCodeBindingSourceRequestRequestTypeDef = { # (1)
"Language": ...,
"RegistryName": ...,
"SchemaName": ...,
}
parent.get_code_binding_source(**kwargs)
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.