Type annotations for boto3.ElasticsearchService 1.14.0 service, generated by mypy-boto3-buider 2.0.4
Project description
mypy-boto3-es
Type annotations for boto3.ElasticsearchService 1.14.0 service compatible with mypy, VSCode, PyCharm and other tools.
Generated by mypy-boto3-buider 2.0.4.
More information can be found on boto3-stubs page.
How to use
Make sure you have mypy installed and activated in your IDE.
Install boto3-stubs
for ElasticsearchService
service.
python -m pip install boto3-stubs[es]
Use boto3
with mypy_boto3_es
in your project and enjoy type checking and auto-complete.
import boto3
from mypy_boto3_es import ElasticsearchServiceClient
# Now mypy can check if your code is valid.
client: ElasticsearchServiceClient = boto3.client("es")
# works for session as well
session = boto3.session.Session(region="us-west-1")
session_client: ElasticsearchServiceClient = session.client("es")
# Annotated paginators are included as well
import mypy_boto3_es.paginator as es_paginators
describe_reserved_elasticsearch_instance_offerings_paginator: es_paginators.DescribeReservedElasticsearchInstanceOfferingsPaginator = client.get_paginator("describe_reserved_elasticsearch_instance_offerings")
describe_reserved_elasticsearch_instances_paginator: es_paginators.DescribeReservedElasticsearchInstancesPaginator = client.get_paginator("describe_reserved_elasticsearch_instances")
get_upgrade_history_paginator: es_paginators.GetUpgradeHistoryPaginator = client.get_paginator("get_upgrade_history")
list_elasticsearch_instance_types_paginator: es_paginators.ListElasticsearchInstanceTypesPaginator = client.get_paginator("list_elasticsearch_instance_types")
list_elasticsearch_versions_paginator: es_paginators.ListElasticsearchVersionsPaginator = client.get_paginator("list_elasticsearch_versions")
Dynamic type annotations
mypy_boto3
command generates boto3.client/resource
type annotations for
mypy_boto3_es
and other installed services.
# Run this command after you add or remove service packages
python -m mypy_boto3
Generated type annotations provide overloads for boto3.client
and boto3.resource
,
boto3.Session.client
and boto3.Session.resource
functions,
so explicit type annotations are not needed.
mypy
supports function overloads as expectedPyCharm
also supports function overloads, but consumes a lot of RAM, use carefully if you have many services installedVSCode
does not currently support function overloads, use explicit type annotations
import boto3
# Type is discovered correctly by mypy and PyCharm
# VSCode still needs explicit type annotations
client = boto3.client("es")
session_client = boto3.Session().client("es")
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for mypy_boto3_es-1.14.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b3819745d1e735a6e1e487c3a548b280107e0689f36b3eee1dbfe3d5c197962f |
|
MD5 | ece593f1495fc6303def9d9691864f86 |
|
BLAKE2b-256 | b90dd6b31fe4a03326cb804586bff188434d593dbdd29cf245d628c7885a2313 |