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
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.
client = boto3.client("schemas")
try:
do_something(client)
except (
client.BadRequestException,
client.ClientError,
client.ConflictException,
client.ForbiddenException,
client.GoneException,
client.InternalServerErrorException,
client.NotFoundException,
client.PreconditionFailedException,
client.ServiceUnavailableException,
client.TooManyRequestsException,
client.UnauthorizedException,
) as e:
print(e)
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
close
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("schemas").close
method.
boto3 documentation
create_discoverer
Creates a discoverer.
Type annotations and code completion for boto3.client("schemas").create_discoverer
method.
boto3 documentation
def create_discoverer(
self,
*,
SourceArn: str,
Description: str = ...,
CrossAccount: bool = ...,
Tags: Mapping[str, str] = ...,
) -> CreateDiscovererResponseTypeDef: # (1)
...
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
def create_registry(
self,
*,
RegistryName: str,
Description: str = ...,
Tags: Mapping[str, str] = ...,
) -> CreateRegistryResponseTypeDef: # (1)
...
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
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
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
def delete_discoverer(
self,
*,
DiscovererId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
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
def delete_registry(
self,
*,
RegistryName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
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
def delete_resource_policy(
self,
*,
RegistryName: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
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
def delete_schema(
self,
*,
RegistryName: str,
SchemaName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
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
def delete_schema_version(
self,
*,
RegistryName: str,
SchemaName: str,
SchemaVersion: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
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
def describe_code_binding(
self,
*,
Language: str,
RegistryName: str,
SchemaName: str,
SchemaVersion: str = ...,
) -> DescribeCodeBindingResponseTypeDef: # (1)
...
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
def describe_discoverer(
self,
*,
DiscovererId: str,
) -> DescribeDiscovererResponseTypeDef: # (1)
...
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
def describe_registry(
self,
*,
RegistryName: str,
) -> DescribeRegistryResponseTypeDef: # (1)
...
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
def describe_schema(
self,
*,
RegistryName: str,
SchemaName: str,
SchemaVersion: str = ...,
) -> DescribeSchemaResponseTypeDef: # (1)
...
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
def export_schema(
self,
*,
RegistryName: str,
SchemaName: str,
Type: str,
SchemaVersion: str = ...,
) -> ExportSchemaResponseTypeDef: # (1)
...
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
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
def get_code_binding_source(
self,
*,
Language: str,
RegistryName: str,
SchemaName: str,
SchemaVersion: str = ...,
) -> GetCodeBindingSourceResponseTypeDef: # (1)
...
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.
boto3 documentation
def get_discovered_schema(
self,
*,
Events: Sequence[str],
Type: TypeType, # (1)
) -> GetDiscoveredSchemaResponseTypeDef: # (2)
...
kwargs: GetDiscoveredSchemaRequestRequestTypeDef = { # (1)
"Events": ...,
"Type": ...,
}
parent.get_discovered_schema(**kwargs)
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
def get_resource_policy(
self,
*,
RegistryName: str = ...,
) -> GetResourcePolicyResponseTypeDef: # (1)
...
kwargs: GetResourcePolicyRequestRequestTypeDef = { # (1)
"RegistryName": ...,
}
parent.get_resource_policy(**kwargs)
list_discoverers
List the discoverers.
Type annotations and code completion for boto3.client("schemas").list_discoverers
method.
boto3 documentation
def list_discoverers(
self,
*,
DiscovererIdPrefix: str = ...,
Limit: int = ...,
NextToken: str = ...,
SourceArnPrefix: str = ...,
) -> ListDiscoverersResponseTypeDef: # (1)
...
kwargs: ListDiscoverersRequestRequestTypeDef = { # (1)
"DiscovererIdPrefix": ...,
}
parent.list_discoverers(**kwargs)
list_registries
List the registries.
Type annotations and code completion for boto3.client("schemas").list_registries
method.
boto3 documentation
def list_registries(
self,
*,
Limit: int = ...,
NextToken: str = ...,
RegistryNamePrefix: str = ...,
Scope: str = ...,
) -> ListRegistriesResponseTypeDef: # (1)
...
kwargs: ListRegistriesRequestRequestTypeDef = { # (1)
"Limit": ...,
}
parent.list_registries(**kwargs)
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
def list_schema_versions(
self,
*,
RegistryName: str,
SchemaName: str,
Limit: int = ...,
NextToken: str = ...,
) -> ListSchemaVersionsResponseTypeDef: # (1)
...
kwargs: ListSchemaVersionsRequestRequestTypeDef = { # (1)
"RegistryName": ...,
"SchemaName": ...,
}
parent.list_schema_versions(**kwargs)
list_schemas
List the schemas.
Type annotations and code completion for boto3.client("schemas").list_schemas
method.
boto3 documentation
def list_schemas(
self,
*,
RegistryName: str,
Limit: int = ...,
NextToken: str = ...,
SchemaNamePrefix: str = ...,
) -> ListSchemasResponseTypeDef: # (1)
...
kwargs: ListSchemasRequestRequestTypeDef = { # (1)
"RegistryName": ...,
}
parent.list_schemas(**kwargs)
list_tags_for_resource
Get tags for resource.
Type annotations and code completion for boto3.client("schemas").list_tags_for_resource
method.
boto3 documentation
def list_tags_for_resource(
self,
*,
ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef: # (1)
...
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)
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
def put_code_binding(
self,
*,
Language: str,
RegistryName: str,
SchemaName: str,
SchemaVersion: str = ...,
) -> PutCodeBindingResponseTypeDef: # (1)
...
kwargs: PutCodeBindingRequestRequestTypeDef = { # (1)
"Language": ...,
"RegistryName": ...,
"SchemaName": ...,
}
parent.put_code_binding(**kwargs)
put_resource_policy
The name of the policy.
Type annotations and code completion for boto3.client("schemas").put_resource_policy
method.
boto3 documentation
def put_resource_policy(
self,
*,
Policy: str,
RegistryName: str = ...,
RevisionId: str = ...,
) -> PutResourcePolicyResponseTypeDef: # (1)
...
kwargs: PutResourcePolicyRequestRequestTypeDef = { # (1)
"Policy": ...,
}
parent.put_resource_policy(**kwargs)
search_schemas
Search the schemas See also: AWS API Documentation.
Type annotations and code completion for boto3.client("schemas").search_schemas
method.
boto3 documentation
def search_schemas(
self,
*,
Keywords: str,
RegistryName: str,
Limit: int = ...,
NextToken: str = ...,
) -> SearchSchemasResponseTypeDef: # (1)
...
kwargs: SearchSchemasRequestRequestTypeDef = { # (1)
"Keywords": ...,
"RegistryName": ...,
}
parent.search_schemas(**kwargs)
start_discoverer
Starts the discoverer See also: AWS API Documentation.
Type annotations and code completion for boto3.client("schemas").start_discoverer
method.
boto3 documentation
def start_discoverer(
self,
*,
DiscovererId: str,
) -> StartDiscovererResponseTypeDef: # (1)
...
kwargs: StartDiscovererRequestRequestTypeDef = { # (1)
"DiscovererId": ...,
}
parent.start_discoverer(**kwargs)
stop_discoverer
Stops the discoverer See also: AWS API Documentation.
Type annotations and code completion for boto3.client("schemas").stop_discoverer
method.
boto3 documentation
def stop_discoverer(
self,
*,
DiscovererId: str,
) -> StopDiscovererResponseTypeDef: # (1)
...
kwargs: StopDiscovererRequestRequestTypeDef = { # (1)
"DiscovererId": ...,
}
parent.stop_discoverer(**kwargs)
tag_resource
Add tags to a resource.
Type annotations and code completion for boto3.client("schemas").tag_resource
method.
boto3 documentation
def tag_resource(
self,
*,
ResourceArn: str,
Tags: Mapping[str, str],
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
"Tags": ...,
}
parent.tag_resource(**kwargs)
untag_resource
Removes tags from a resource.
Type annotations and code completion for boto3.client("schemas").untag_resource
method.
boto3 documentation
def untag_resource(
self,
*,
ResourceArn: str,
TagKeys: Sequence[str],
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: UntagResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
"TagKeys": ...,
}
parent.untag_resource(**kwargs)
update_discoverer
Updates the discoverer See also: AWS API Documentation.
Type annotations and code completion for boto3.client("schemas").update_discoverer
method.
boto3 documentation
def update_discoverer(
self,
*,
DiscovererId: str,
Description: str = ...,
CrossAccount: bool = ...,
) -> UpdateDiscovererResponseTypeDef: # (1)
...
kwargs: UpdateDiscovererRequestRequestTypeDef = { # (1)
"DiscovererId": ...,
}
parent.update_discoverer(**kwargs)
update_registry
Updates a registry.
Type annotations and code completion for boto3.client("schemas").update_registry
method.
boto3 documentation
def update_registry(
self,
*,
RegistryName: str,
Description: str = ...,
) -> UpdateRegistryResponseTypeDef: # (1)
...
kwargs: UpdateRegistryRequestRequestTypeDef = { # (1)
"RegistryName": ...,
}
parent.update_registry(**kwargs)
update_schema
Updates the schema definition .
Type annotations and code completion for boto3.client("schemas").update_schema
method.
boto3 documentation
def update_schema(
self,
*,
RegistryName: str,
SchemaName: str,
ClientTokenId: str = ...,
Content: str = ...,
Description: str = ...,
Type: TypeType = ..., # (1)
) -> UpdateSchemaResponseTypeDef: # (2)
...
- See TypeType
- See UpdateSchemaResponseTypeDef
kwargs: UpdateSchemaRequestRequestTypeDef = { # (1)
"RegistryName": ...,
"SchemaName": ...,
}
parent.update_schema(**kwargs)
get_paginator
Type annotations and code completion for boto3.client("schemas").get_paginator
method with overloads.
client.get_paginator("list_discoverers")
-> ListDiscoverersPaginatorclient.get_paginator("list_registries")
-> ListRegistriesPaginatorclient.get_paginator("list_schema_versions")
-> ListSchemaVersionsPaginatorclient.get_paginator("list_schemas")
-> ListSchemasPaginatorclient.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