# mypy-boto3-appsync
[![PyPI - mypy-boto3-appsync](https://img.shields.io/pypi/v/mypy-boto3-appsync.svg?color=blue)](https://pypi.org/project/mypy-boto3-appsync)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mypy-boto3-appsync.svg?color=blue)](https://pypi.org/project/mypy-boto3-appsync)
[![Docs](https://img.shields.io/readthedocs/mypy-boto3-builder.svg?color=blue)](https://mypy-boto3-builder.readthedocs.io/)
![boto3.typed](https://github.com/vemel/mypy_boto3_builder/raw/master/logo.png)
Type annotations for
[boto3.AppSync 1.16.48](https://boto3.amazonaws.com/v1/documentation/api/1.16.48/reference/services/appsync.html#AppSync) service
compatible with
[VSCode](https://code.visualstudio.com/),
[PyCharm](https://www.jetbrains.com/pycharm/),
[Emacs](https://www.gnu.org/software/emacs/),
[Sublime Text](https://www.sublimetext.com/),
[mypy](https://github.com/python/mypy),
[pyright](https://github.com/microsoft/pyright)
and other tools.
Generated by [mypy-boto3-buider 4.3.1](https://github.com/vemel/mypy_boto3_builder).
More information can be found on [boto3-stubs](https://pypi.org/project/boto3-stubs/) page.
See how it helps to find and fix potential bugs:
![boto3-stubs demo](https://github.com/vemel/mypy_boto3_builder/raw/master/demo.gif)
- [mypy-boto3-appsync](#mypy-boto3-appsync)
- [How to install](#how-to-install)
- [Usage](#usage)
- [VSCode](#vscode)
- [PyCharm](#pycharm)
- [Other IDEs](#other-ides)
- [mypy](#mypy)
- [pyright](#pyright)
- [Explicit type annotations](#explicit-type-annotations)
- [Client annotations](#client-annotations)
- [Paginators annotations](#paginators-annotations)
- [Waiters annotations](#waiters-annotations)
- [Service Resource annotations](#service-resource-annotations)
- [Other resources annotations](#other-resources-annotations)
- [Collections annotations](#collections-annotations)
- [Typed dictionations](#typed-dictionations)
## How to install
Install `boto3-stubs` for `AppSync` service.
```bash
python -m pip install boto3-stubs[appsync]
```
## Usage
### VSCode
- Install [Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python)
- Install [Pylance extension](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance)
- Set `Pylance` as your Python Language Server
- Install `boto-stubs[appsync]` in your environment: `python -m pip install 'boto3-stubs[appsync]'`
Both type checking and auto-complete should work for `AppSync` service.
No explicit type annotations required, write your `boto3` code as usual.
### PyCharm
- Install `boto-stubs[appsync]` in your environment: `python -m pip install 'boto3-stubs[appsync]'`
Both type checking and auto-complete should work for `AppSync` service.
No explicit type annotations required, write your `boto3` code as usual.
Auto-complete can be slow on big projects or if you have a lot of installed `boto3-stubs` submodules.
### Other IDEs
Not tested, but as long as your IDE support `mypy` or `pyright`, everything should work.
### mypy
- Install `mypy`: `python -m pip install mypy`
- Install `boto-stubs[appsync]` in your environment: `python -m pip install 'boto3-stubs[appsync]'`
- Run `mypy` as usual
Type checking should work for `AppSync` service.
No explicit type annotations required, write your `boto3` code as usual.
### pyright
- Install `pyright`: `yarn global add pyright`
- Install `boto-stubs[appsync]` in your environment: `python -m pip install 'boto3-stubs[appsync]'`
- Optionally, you can install `boto3-stubs` to `typings` folder.
Type checking should work for `AppSync` service.
No explicit type annotations required, write your `boto3` code as usual.
## Explicit type annotations
### Client annotations
`AppSyncClient` provides annotations for `boto3.client("appsync")`.
```python
import boto3
from mypy_boto3_appsync import AppSyncClient
client: AppSyncClient = boto3.client("appsync")
# now client usage is checked by mypy and IDE should provide code auto-complete
# works for session as well
session = boto3.session.Session(region="us-west-1")
session_client: AppSyncClient = session.client("appsync")
```
### Paginators annotations
`mypy_boto3_appsync.paginator` module contains type annotations for all paginators.
```python
from mypy_boto3_appsync import AppSyncClient
from mypy_boto3_appsync.paginator import (
ListApiKeysPaginator,
ListDataSourcesPaginator,
ListFunctionsPaginator,
ListGraphqlApisPaginator,
ListResolversByFunctionPaginator,
ListResolversPaginator,
ListTypesPaginator,
)
client: AppSyncClient = boto3.client("appsync")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
list_api_keys_paginator: ListApiKeysPaginator = client.get_paginator("list_api_keys")
list_data_sources_paginator: ListDataSourcesPaginator = client.get_paginator("list_data_sources")
list_functions_paginator: ListFunctionsPaginator = client.get_paginator("list_functions")
list_graphql_apis_paginator: ListGraphqlApisPaginator = client.get_paginator("list_graphql_apis")
list_resolvers_paginator: ListResolversPaginator = client.get_paginator("list_resolvers")
list_resolvers_by_function_paginator: ListResolversByFunctionPaginator = client.get_paginator("list_resolvers_by_function")
list_types_paginator: ListTypesPaginator = client.get_paginator("list_types")
```
### Typed dictionations
`mypy_boto3_appsync.type_defs` module contains structures and shapes assembled
to typed dictionaries for additional type checking.
```python
from mypy_boto3_appsync.type_defs import (
AdditionalAuthenticationProviderTypeDef,
ApiCacheTypeDef,
ApiKeyTypeDef,
AuthorizationConfigTypeDef,
AwsIamConfigTypeDef,
CachingConfigTypeDef,
CognitoUserPoolConfigTypeDef,
CreateApiCacheResponseTypeDef,
CreateApiKeyResponseTypeDef,
CreateDataSourceResponseTypeDef,
CreateFunctionResponseTypeDef,
CreateGraphqlApiResponseTypeDef,
CreateResolverResponseTypeDef,
CreateTypeResponseTypeDef,
DataSourceTypeDef,
DeltaSyncConfigTypeDef,
DynamodbDataSourceConfigTypeDef,
ElasticsearchDataSourceConfigTypeDef,
FunctionConfigurationTypeDef,
GetApiCacheResponseTypeDef,
GetDataSourceResponseTypeDef,
GetFunctionResponseTypeDef,
GetGraphqlApiResponseTypeDef,
GetIntrospectionSchemaResponseTypeDef,
GetResolverResponseTypeDef,
GetSchemaCreationStatusResponseTypeDef,
GetTypeResponseTypeDef,
GraphqlApiTypeDef,
HttpDataSourceConfigTypeDef,
LambdaConflictHandlerConfigTypeDef,
LambdaDataSourceConfigTypeDef,
ListApiKeysResponseTypeDef,
ListDataSourcesResponseTypeDef,
ListFunctionsResponseTypeDef,
ListGraphqlApisResponseTypeDef,
ListResolversByFunctionResponseTypeDef,
ListResolversResponseTypeDef,
ListTagsForResourceResponseTypeDef,
ListTypesResponseTypeDef,
LogConfigTypeDef,
OpenIDConnectConfigTypeDef,
PaginatorConfigTypeDef,
PipelineConfigTypeDef,
RdsHttpEndpointConfigTypeDef,
RelationalDatabaseDataSourceConfigTypeDef,
ResolverTypeDef,
StartSchemaCreationResponseTypeDef,
SyncConfigTypeDef,
TypeTypeDef,
UpdateApiCacheResponseTypeDef,
UpdateApiKeyResponseTypeDef,
UpdateDataSourceResponseTypeDef,
UpdateFunctionResponseTypeDef,
UpdateGraphqlApiResponseTypeDef,
UpdateResolverResponseTypeDef,
UpdateTypeResponseTypeDef,
UserPoolConfigTypeDef,
)
def get_structure() -> AdditionalAuthenticationProviderTypeDef:
return {
...
}
```
挣扎的蓝藻
- 粉丝: 14w+
- 资源: 15万+
最新资源
- 基于Go和React的高质量企业微信私域流量管理系统 。遵守Apache2.0协议,全网唯一免费商用。企业微信、私域流量、SCRM。详细文档+优秀项目+全部资料.zip
- 基于Go和React的企业微信的开源 SCRM 系统。企微,个微,微信,聚合聊天,自动回复,加好友。详细文档+优秀项目+全部资料.zip
- 基于go语言的搜索引擎,信息检索系统详细文档+优秀项目+全部资料.zip
- 基于Go语言,Beego框架开发的简单的文章发布管理系统。详细文档+优秀项目+全部资料.zip
- 基于Go语言的轻量级高性能的分布式日志系统详细文档+优秀项目+全部资料.zip
- 基于go语言简单的用户管理系统详细文档+优秀项目+全部资料.zip
- 基于Go语言的一个秒杀系统详细文档+优秀项目+全部资料.zip
- 基于Go语言的一个简易blog系统详细文档+优秀项目+全部资料.zip
- 基于Go语言开发,具备高安全性、高性能和易扩展性的企业级内容管理系统,详细文档+优秀项目+全部资料.zip
- 基于Go语言实现的单点登录系统详细文档+优秀项目+全部资料.zip
- 基于Go语言实现的微服务电商系统详细文档+优秀项目+全部资料.zip
- 基于python和sql server2014做的商品学生信息管理系统,有界面,利用的sql server数据库详细文档+优秀项目+全部资料.zip
- 基于OWTP协议库,封装所有与openw-server钱包服务API交互方法。用于集成到go语言开发下的应用方系统。详细文档+优秀项目+全部资料.zip
- 基于Quasar和Go语言的功能全面的管理系统详细文档+优秀项目+全部资料.zip
- 基于SpringBoot 开发的员工的季度绩效考核系统详细文档+优秀项目+全部资料.zip
- 四足机器人技术发展及其应用场景概述
资源上传下载、课程学习等过程中有任何疑问或建议,欢迎提出宝贵意见哦~我们会及时处理!
点击此处反馈