Schemas module#
Index > Schemas
Auto-generated documentation for Schemas type annotations stubs module types-boto3-schemas.
How to install#
Generate locally (recommended)#
You can generate type annotations for boto3
package locally with mypy_boto3_builder
.
Use uv for build isolation.
- Run mypy-boto3-builder in your package root directory:
uvx --with 'boto3==1.35.86' mypy_boto3_builder
- Select
boto3
AWS SDK. - Add
Schemas
service. - Use provided commands to install generated packages.
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 types-boto3
for Schemas
service.
# install with boto3 type annotations
python -m pip install 'types-boto3[schemas]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'types-boto3-lite[schemas]'
# standalone installation
python -m pip install types-boto3-schemas
How to uninstall#
python -m pip uninstall -y types-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 types_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 types_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 types_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 schema.
# CodeBindingExistsWaiterName usage example
from types_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
Type definitions#
Type annotations for type definitions used in methods and schema.
- CreateDiscovererRequestRequestTypeDef
- ResponseMetadataTypeDef
- CreateRegistryRequestRequestTypeDef
- CreateSchemaRequestRequestTypeDef
- DeleteDiscovererRequestRequestTypeDef
- DeleteRegistryRequestRequestTypeDef
- DeleteResourcePolicyRequestRequestTypeDef
- DeleteSchemaRequestRequestTypeDef
- DeleteSchemaVersionRequestRequestTypeDef
- DescribeCodeBindingRequestRequestTypeDef
- WaiterConfigTypeDef
- 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
- DescribeCodeBindingRequestWaitTypeDef
- ListDiscoverersResponseTypeDef
- ListDiscoverersRequestPaginateTypeDef
- ListRegistriesRequestPaginateTypeDef
- ListSchemaVersionsRequestPaginateTypeDef
- ListSchemasRequestPaginateTypeDef
- SearchSchemasRequestPaginateTypeDef
- ListRegistriesResponseTypeDef
- ListSchemaVersionsResponseTypeDef
- ListSchemasResponseTypeDef
- SearchSchemaSummaryTypeDef
- SearchSchemasResponseTypeDef