# mypy-boto3-kendra
[![PyPI - mypy-boto3-kendra](https://img.shields.io/pypi/v/mypy-boto3-kendra.svg?color=blue)](https://pypi.org/project/mypy-boto3-kendra)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mypy-boto3-kendra.svg?color=blue)](https://pypi.org/project/mypy-boto3-kendra)
[![Docs](https://img.shields.io/readthedocs/mypy-boto3-builder.svg?color=blue)](https://mypy-boto3-builder.readthedocs.io/)
[![PyPI - Downloads](https://img.shields.io/pypi/dw/mypy-boto3-kendra?color=blue)](https://pypistats.org/packages/mypy-boto3-kendra)
![boto3.typed](https://github.com/vemel/mypy_boto3_builder/raw/master/logo.png)
Type annotations for
[boto3.Kendra 1.17.68](https://boto3.amazonaws.com/v1/documentation/api/1.17.68/reference/services/kendra.html#Kendra)
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.10.0](https://github.com/vemel/mypy_boto3_builder).
More information can be found on
[boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in
[mypy-boto3-kendra docs](https://github.com/vemel/mypy_boto3_builder/service_docs/mypy_boto3_kendra/README.md)
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-kendra](#mypy-boto3-kendra)
- [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)
- [Literals](#literals)
- [Typed dictionaries](#typed-dictionaries)
## How to install
Install `boto3-stubs` for `Kendra` service.
```bash
python -m pip install boto3-stubs[kendra]
```
## 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[kendra]` in your environment:
`python -m pip install 'boto3-stubs[kendra]'`
Both type checking and auto-complete should work for `Kendra` service. No
explicit type annotations required, write your `boto3` code as usual.
### PyCharm
- Install `boto-stubs[kendra]` in your environment:
`python -m pip install 'boto3-stubs[kendra]'`
Both type checking and auto-complete should work for `Kendra` 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[kendra]` in your environment:
`python -m pip install 'boto3-stubs[kendra]'`
- Run `mypy` as usual
Type checking should work for `Kendra` service. No explicit type annotations
required, write your `boto3` code as usual.
### pyright
- Install `pyright`: `yarn global add pyright`
- Install `boto-stubs[kendra]` in your environment:
`python -m pip install 'boto3-stubs[kendra]'`
- Optionally, you can install `boto3-stubs` to `typings` folder.
Type checking should work for `Kendra` service. No explicit type annotations
required, write your `boto3` code as usual.
## Explicit type annotations
### Client annotations
`KendraClient` provides annotations for `boto3.client("kendra")`.
```python
import boto3
from mypy_boto3_kendra import KendraClient
client: KendraClient = boto3.client("kendra")
# 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: KendraClient = session.client("kendra")
```
### Literals
`mypy_boto3_kendra.literals` module contains literals extracted from shapes
that can be used in user code for type checking.
```python
from mypy_boto3_kendra.literals import (
AdditionalResultAttributeValueType,
ConfluenceAttachmentFieldName,
ConfluenceBlogFieldName,
ConfluencePageFieldName,
ConfluenceSpaceFieldName,
ConfluenceVersion,
ContentType,
DataSourceStatus,
DataSourceSyncJobStatus,
DataSourceType,
DatabaseEngineType,
DocumentAttributeValueType,
ErrorCode,
FaqFileFormat,
FaqStatus,
HighlightType,
IndexEdition,
IndexStatus,
KeyLocation,
Order,
PrincipalType,
QueryIdentifiersEnclosingOption,
QueryResultType,
ReadAccessType,
RelevanceType,
SalesforceChatterFeedIncludeFilterType,
SalesforceKnowledgeArticleState,
SalesforceStandardObjectName,
ScoreConfidence,
ServiceNowAuthenticationType,
ServiceNowBuildVersionType,
SharePointVersion,
SortOrder,
ThesaurusStatus,
UserContextPolicy,
)
def check_value(value: AdditionalResultAttributeValueType) -> bool:
...
```
### Typed dictionaries
`mypy_boto3_kendra.type_defs` module contains structures and shapes assembled
to typed dictionaries for additional type checking.
```python
from mypy_boto3_kendra.type_defs import (
AccessControlListConfigurationTypeDef,
AclConfigurationTypeDef,
AdditionalResultAttributeTypeDef,
AdditionalResultAttributeValueTypeDef,
AttributeFilterTypeDef,
BatchDeleteDocumentResponseFailedDocumentTypeDef,
BatchDeleteDocumentResponseTypeDef,
BatchPutDocumentResponseFailedDocumentTypeDef,
BatchPutDocumentResponseTypeDef,
CapacityUnitsConfigurationTypeDef,
ClickFeedbackTypeDef,
ColumnConfigurationTypeDef,
ConfluenceAttachmentConfigurationTypeDef,
ConfluenceAttachmentToIndexFieldMappingTypeDef,
ConfluenceBlogConfigurationTypeDef,
ConfluenceBlogToIndexFieldMappingTypeDef,
ConfluenceConfigurationTypeDef,
ConfluencePageConfigurationTypeDef,
ConfluencePageToIndexFieldMappingTypeDef,
ConfluenceSpaceConfigurationTypeDef,
ConfluenceSpaceToIndexFieldMappingTypeDef,
ConnectionConfigurationTypeDef,
CreateDataSourceResponseTypeDef,
CreateFaqResponseTypeDef,
CreateIndexResponseTypeDef,
CreateThesaurusResponseTypeDef,
DataSourceConfigurationTypeDef,
DataSourceSummaryTypeDef,
DataSourceSyncJobMetricTargetTypeDef,
DataSourceSyncJobMetricsTypeDef,
DataSourceSyncJobTypeDef,
DataSourceToIndexFieldMappingTypeDef,
DataSourceVpcConfigurationTypeDef,
DatabaseConfigurationTypeDef,
DescribeDataSourceResponseTypeDef,
DescribeFaqResponseTypeDef,
DescribeIndexResponseTypeDef,
DescribeThesaurusResponseTypeDef,
DocumentAttributeTypeDef,
DocumentAttributeValueCountPairTypeDef,
DocumentAttributeValueTypeDef,
DocumentMetadataConfigurationTypeDef,
DocumentRelevanceConfigurationTypeDef,
DocumentTypeDef,
DocumentsMetadataConfigurationTypeDef,
FacetResultTypeDef,
FacetTypeDef,
FaqStatisticsTypeDef,
FaqSummaryTypeDef,
GoogleDriveConfigurationTypeDef,
HighlightTypeDef,
IndexConfigurationSummaryTypeDef,
IndexStatisticsTypeDef,
JsonTokenTypeConfigurationTypeDef,
JwtTokenTypeConfigurationTypeDef,
ListDataSourceSyncJobsResponseTypeDef,
ListDataSourcesResponseTypeDef,
ListFaqsResponseTypeDef,
ListIndicesResponseTypeDef,
ListTagsForResourceResponseTypeDef,
ListThesauriResponseTypeDef,
OneDriveConfigurationTypeDef,
OneDriveUsersTypeDef,
PrincipalTypeDef,
QueryResultItemTypeDef,
QueryResultTypeDef,
RelevanceFeedbackTypeDef,
RelevanceTypeDef,
S3DataSourceConfigurationTypeDef,
S3PathTypeDef,
SalesforceChatterFeedConfigura
没有合适的资源?快使用搜索试试~ 我知道了~
温馨提示
共21个文件
py:7个
txt:4个
pyi:4个
资源分类:Python库 所属语言:Python 资源全名:mypy-boto3-kendra-1.17.68.0.tar.gz 资源来源:官方 安装方法:https://lanzao.blog.csdn.net/article/details/101784059
资源推荐
资源详情
资源评论
收起资源包目录
mypy-boto3-kendra-1.17.68.0.tar.gz (21个子文件)
mypy-boto3-kendra-1.17.68.0
PKG-INFO 12KB
mypy_boto3_kendra.egg-info
PKG-INFO 12KB
requires.txt 45B
not-zip-safe 1B
SOURCES.txt 590B
top_level.txt 18B
dependency_links.txt 1B
setup.cfg 38B
mypy_boto3_kendra
type_defs.py 26KB
py.typed 0B
type_defs.pyi 26KB
literals.py 5KB
client.py 18KB
__main__.py 725B
__init__.py 426B
client.pyi 18KB
version.py 57B
literals.pyi 5KB
__init__.pyi 425B
setup.py 2KB
README.md 9KB
共 21 条
- 1
资源评论
挣扎的蓝藻
- 粉丝: 13w+
- 资源: 15万+
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功