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
Usage
Code samples can be found in Examples.
SchemasClient
Type annotations and code completion for boto3.client("schemas")
as SchemasClient
boto3 documentation
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("...")
.
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("...")
.
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.
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.
Usage example
from mypy_boto3_schemas.type_defs import CreateDiscovererRequestRequestTypeDef
def get_value() -> CreateDiscovererRequestRequestTypeDef:
return {
"SourceArn": ...,
}
- CreateDiscovererRequestRequestTypeDef
- ResponseMetadataTypeDef
- CreateRegistryRequestRequestTypeDef
- CreateSchemaRequestRequestTypeDef
- DeleteDiscovererRequestRequestTypeDef
- DeleteRegistryRequestRequestTypeDef
- DeleteResourcePolicyRequestRequestTypeDef
- DeleteSchemaRequestRequestTypeDef
- DeleteSchemaVersionRequestRequestTypeDef
- WaiterConfigTypeDef
- DescribeCodeBindingRequestRequestTypeDef
- DescribeDiscovererRequestRequestTypeDef
- DescribeRegistryRequestRequestTypeDef
- DescribeSchemaRequestRequestTypeDef
- DiscovererSummaryTypeDef
- ExportSchemaRequestRequestTypeDef
- GetCodeBindingSourceRequestRequestTypeDef
- GetDiscoveredSchemaRequestRequestTypeDef
- GetResourcePolicyRequestRequestTypeDef
- PaginatorConfigTypeDef
- ListDiscoverersRequestRequestTypeDef
- ListRegistriesRequestRequestTypeDef
- RegistrySummaryTypeDef
- ListSchemaVersionsRequestRequestTypeDef
- SchemaVersionSummaryTypeDef
- ListSchemasRequestRequestTypeDef
- SchemaSummaryTypeDef
- ListTagsForResourceRequestRequestTypeDef
- PutCodeBindingRequestRequestTypeDef
- PutResourcePolicyRequestRequestTypeDef
- SearchSchemaVersionSummaryTypeDef
- SearchSchemasRequestRequestTypeDef
- StartDiscovererRequestRequestTypeDef
- StopDiscovererRequestRequestTypeDef
- TagResourceRequestRequestTypeDef
- UntagResourceRequestRequestTypeDef
- UpdateDiscovererRequestRequestTypeDef
- UpdateRegistryRequestRequestTypeDef
- UpdateSchemaRequestRequestTypeDef
- CreateDiscovererResponseTypeDef
- CreateRegistryResponseTypeDef
- CreateSchemaResponseTypeDef
- DescribeCodeBindingResponseTypeDef
- DescribeDiscovererResponseTypeDef
- DescribeRegistryResponseTypeDef
- DescribeSchemaResponseTypeDef
- EmptyResponseMetadataTypeDef
- ExportSchemaResponseTypeDef
- GetCodeBindingSourceResponseTypeDef
- GetDiscoveredSchemaResponseTypeDef
- GetResourcePolicyResponseTypeDef
- ListTagsForResourceResponseTypeDef
- PutCodeBindingResponseTypeDef
- PutResourcePolicyResponseTypeDef
- StartDiscovererResponseTypeDef
- StopDiscovererResponseTypeDef
- UpdateDiscovererResponseTypeDef
- UpdateRegistryResponseTypeDef
- UpdateSchemaResponseTypeDef
- DescribeCodeBindingRequestCodeBindingExistsWaitTypeDef
- ListDiscoverersResponseTypeDef
- ListDiscoverersRequestListDiscoverersPaginateTypeDef
- ListRegistriesRequestListRegistriesPaginateTypeDef
- ListSchemaVersionsRequestListSchemaVersionsPaginateTypeDef
- ListSchemasRequestListSchemasPaginateTypeDef
- SearchSchemasRequestSearchSchemasPaginateTypeDef
- ListRegistriesResponseTypeDef
- ListSchemaVersionsResponseTypeDef
- ListSchemasResponseTypeDef
- SearchSchemaSummaryTypeDef
- SearchSchemasResponseTypeDef