Schemas module#
Index > Schemas
Auto-generated documentation for Schemas type annotations stubs module mypy-boto3-schemas.
How to install#
VSCode extension#
Add AWS Boto3
extension to your VSCode and run AWS boto3: Quick Start
command.
Click Modify
and select boto3 common
and Schemas
.
From PyPI with pip#
Install boto3-stubs
for Schemas
service.
# install with boto3 type annotations
python -m pip install 'boto3-stubs[schemas]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[schemas]'
# standalone installation
python -m pip install mypy-boto3-schemas
How to uninstall#
python -m pip uninstall -y mypy-boto3-schemas
Usage#
Code samples can be found in Examples.
SchemasClient#
Type annotations and code completion for boto3.client("schemas")
as SchemasClient
boto3 documentation
# SchemasClient usage example
from boto3.session import Session
from mypy_boto3_schemas.client import SchemasClient
def get_client() -> SchemasClient:
return Session().client("schemas")
Paginators#
Type annotations and code completion for paginators
from boto3.client("schemas").get_paginator("...")
.
# ListDiscoverersPaginator usage example
from boto3.session import Session
from mypy_boto3_schemas.paginator import ListDiscoverersPaginator
def get_list_discoverers_paginator() -> ListDiscoverersPaginator:
return Session().client("schemas").get_paginator("list_discoverers"))
- ListDiscoverersPaginator
- ListRegistriesPaginator
- ListSchemaVersionsPaginator
- ListSchemasPaginator
- SearchSchemasPaginator
Waiters#
Type annotations and code completion for waiters
from boto3.client("schemas").get_waiter("...")
.
# CodeBindingExistsWaiter usage example
from boto3.session import Session
from mypy_boto3_schemas.waiter import CodeBindingExistsWaiter
def get_code_binding_exists_waiter() -> CodeBindingExistsWaiter:
return Session().client("schemas").get_waiter("code_binding_exists")
Literals#
Type annotations for literals used in methods and schemas.
# CodeBindingExistsWaiterName usage example
from mypy_boto3_schemas.literals import CodeBindingExistsWaiterName
def get_value() -> CodeBindingExistsWaiterName:
return "code_binding_exists"
- CodeBindingExistsWaiterName
- CodeGenerationStatusType
- DiscovererStateType
- ListDiscoverersPaginatorName
- ListRegistriesPaginatorName
- ListSchemaVersionsPaginatorName
- ListSchemasPaginatorName
- SearchSchemasPaginatorName
- TypeType
- SchemasServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- WaiterName
- RegionName
Typed dictionaries#
Type annotations for typed dictionaries used in methods and schema.
# CreateDiscovererRequestRequestTypeDef usage example
from mypy_boto3_schemas.type_defs import CreateDiscovererRequestRequestTypeDef
def get_value() -> CreateDiscovererRequestRequestTypeDef:
return {
"SourceArn": ...,
}
- CreateDiscovererRequestRequestTypeDef
- CreateDiscovererResponseTypeDef
- CreateRegistryRequestRequestTypeDef
- CreateRegistryResponseTypeDef
- CreateSchemaRequestRequestTypeDef
- CreateSchemaResponseTypeDef
- DeleteDiscovererRequestRequestTypeDef
- DeleteRegistryRequestRequestTypeDef
- DeleteResourcePolicyRequestRequestTypeDef
- DeleteSchemaRequestRequestTypeDef
- DeleteSchemaVersionRequestRequestTypeDef
- WaiterConfigTypeDef
- DescribeCodeBindingRequestRequestTypeDef
- DescribeCodeBindingResponseTypeDef
- DescribeDiscovererRequestRequestTypeDef
- DescribeDiscovererResponseTypeDef
- DescribeRegistryRequestRequestTypeDef
- DescribeRegistryResponseTypeDef
- DescribeSchemaRequestRequestTypeDef
- DescribeSchemaResponseTypeDef
- DiscovererSummaryTypeDef
- EmptyResponseMetadataTypeDef
- ExportSchemaRequestRequestTypeDef
- ExportSchemaResponseTypeDef
- GetCodeBindingSourceRequestRequestTypeDef
- GetCodeBindingSourceResponseTypeDef
- GetDiscoveredSchemaRequestRequestTypeDef
- GetDiscoveredSchemaResponseTypeDef
- GetResourcePolicyRequestRequestTypeDef
- GetResourcePolicyResponseTypeDef
- ListDiscoverersRequestListDiscoverersPaginateTypeDef
- ListDiscoverersRequestRequestTypeDef
- ListRegistriesRequestListRegistriesPaginateTypeDef
- ListRegistriesRequestRequestTypeDef
- RegistrySummaryTypeDef
- ListSchemaVersionsRequestListSchemaVersionsPaginateTypeDef
- ListSchemaVersionsRequestRequestTypeDef
- SchemaVersionSummaryTypeDef
- ListSchemasRequestListSchemasPaginateTypeDef
- ListSchemasRequestRequestTypeDef
- SchemaSummaryTypeDef
- ListTagsForResourceRequestRequestTypeDef
- ListTagsForResourceResponseTypeDef
- PaginatorConfigTypeDef
- PutCodeBindingRequestRequestTypeDef
- PutCodeBindingResponseTypeDef
- PutResourcePolicyRequestRequestTypeDef
- PutResourcePolicyResponseTypeDef
- ResponseMetadataTypeDef
- SearchSchemaVersionSummaryTypeDef
- SearchSchemasRequestRequestTypeDef
- SearchSchemasRequestSearchSchemasPaginateTypeDef
- StartDiscovererRequestRequestTypeDef
- StartDiscovererResponseTypeDef
- StopDiscovererRequestRequestTypeDef
- StopDiscovererResponseTypeDef
- TagResourceRequestRequestTypeDef
- UntagResourceRequestRequestTypeDef
- UpdateDiscovererRequestRequestTypeDef
- UpdateDiscovererResponseTypeDef
- UpdateRegistryRequestRequestTypeDef
- UpdateRegistryResponseTypeDef
- UpdateSchemaRequestRequestTypeDef
- UpdateSchemaResponseTypeDef
- DescribeCodeBindingRequestCodeBindingExistsWaitTypeDef
- ListDiscoverersResponseTypeDef
- ListRegistriesResponseTypeDef
- ListSchemaVersionsResponseTypeDef
- ListSchemasResponseTypeDef
- SearchSchemaSummaryTypeDef
- SearchSchemasResponseTypeDef