Type annotations for boto3.ElastiCache 1.14.42 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-elasticache
Type annotations for boto3.ElastiCache 1.14.42 service compatible with mypy, VSCode, PyCharm and other tools.
Generated by mypy-boto3-buider 2.2.0.
More information can be found on boto3-stubs page.
How to install
Make sure you have mypy installed and activated in your IDE.
Install boto3-stubs
for ElastiCache
service.
python -m pip install boto3-stubs[elasticache]
How to use
Client annotations
ElastiCacheClient
provides annotations for boto3.client("elasticache")
.
import boto3
from mypy_boto3_elasticache import ElastiCacheClient
from mypy_boto3_elasticache.paginator import (
DescribeCacheClustersPaginator,
DescribeCacheEngineVersionsPaginator,
DescribeCacheParameterGroupsPaginator,
DescribeCacheParametersPaginator,
DescribeCacheSecurityGroupsPaginator,
DescribeCacheSubnetGroupsPaginator,
DescribeEngineDefaultParametersPaginator,
DescribeEventsPaginator,
DescribeGlobalReplicationGroupsPaginator,
DescribeReplicationGroupsPaginator,
DescribeReservedCacheNodesOfferingsPaginator,
DescribeReservedCacheNodesPaginator,
DescribeServiceUpdatesPaginator,
DescribeSnapshotsPaginator,
DescribeUpdateActionsPaginator,
)
from mypy_boto3_elasticache.type_defs import AvailabilityZoneTypeDef, ...
from mypy_boto3_elasticache.waiter import (
CacheClusterAvailableWaiter,
CacheClusterDeletedWaiter,
ReplicationGroupAvailableWaiter,
ReplicationGroupDeletedWaiter,
)
client: ElastiCacheClient = boto3.client("elasticache")
# 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: ElastiCacheClient = session.client("elasticache")
Paginators annotations
mypy_boto3_elasticache.paginator
module contains type annotations for all paginators.
client: ElastiCacheClient = boto3.client("elasticache")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
describe_cache_clusters_paginator: DescribeCacheClustersPaginator = client.get_paginator("describe_cache_clusters")
describe_cache_engine_versions_paginator: DescribeCacheEngineVersionsPaginator = client.get_paginator("describe_cache_engine_versions")
describe_cache_parameter_groups_paginator: DescribeCacheParameterGroupsPaginator = client.get_paginator("describe_cache_parameter_groups")
describe_cache_parameters_paginator: DescribeCacheParametersPaginator = client.get_paginator("describe_cache_parameters")
describe_cache_security_groups_paginator: DescribeCacheSecurityGroupsPaginator = client.get_paginator("describe_cache_security_groups")
describe_cache_subnet_groups_paginator: DescribeCacheSubnetGroupsPaginator = client.get_paginator("describe_cache_subnet_groups")
describe_engine_default_parameters_paginator: DescribeEngineDefaultParametersPaginator = client.get_paginator("describe_engine_default_parameters")
describe_events_paginator: DescribeEventsPaginator = client.get_paginator("describe_events")
describe_global_replication_groups_paginator: DescribeGlobalReplicationGroupsPaginator = client.get_paginator("describe_global_replication_groups")
describe_replication_groups_paginator: DescribeReplicationGroupsPaginator = client.get_paginator("describe_replication_groups")
describe_reserved_cache_nodes_paginator: DescribeReservedCacheNodesPaginator = client.get_paginator("describe_reserved_cache_nodes")
describe_reserved_cache_nodes_offerings_paginator: DescribeReservedCacheNodesOfferingsPaginator = client.get_paginator("describe_reserved_cache_nodes_offerings")
describe_service_updates_paginator: DescribeServiceUpdatesPaginator = client.get_paginator("describe_service_updates")
describe_snapshots_paginator: DescribeSnapshotsPaginator = client.get_paginator("describe_snapshots")
describe_update_actions_paginator: DescribeUpdateActionsPaginator = client.get_paginator("describe_update_actions")
Waiters annotations
mypy_boto3_elasticache.waiter
module contains type annotations for all waiters.
client: ElastiCacheClient = boto3.client("elasticache")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
cache_cluster_available_waiter: CacheClusterAvailableWaiter = client.get_waiter("cache_cluster_available")
cache_cluster_deleted_waiter: CacheClusterDeletedWaiter = client.get_waiter("cache_cluster_deleted")
replication_group_available_waiter: ReplicationGroupAvailableWaiter = client.get_waiter("replication_group_available")
replication_group_deleted_waiter: ReplicationGroupDeletedWaiter = client.get_waiter("replication_group_deleted")
Typed dictionations
mypy_boto3_elasticache.type_defs
module contains structures and shapes assembled
to typed dictionaries for additional type checking.
def get_structure() -> AvailabilityZoneTypeDef:
return {
...
}
Dynamic type annotations
mypy_boto3
command generates boto3.client/resource
type annotations for
mypy_boto3_elasticache
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
# Type is discovered correctly by mypy and PyCharm
# VSCode still needs explicit type annotations
client = boto3.client("elasticache")
session_client = boto3.Session().client("elasticache")
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-elasticache-1.14.42.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9390934845abe3f50060fa02a45d07c62784caf51ab3e0671e12431d39740ca7 |
|
MD5 | 89f76774b91d255ddcc41fe2bda2d1ca |
|
BLAKE2b-256 | a0d80ab3d7c88ed17676cc9d801c643aa66704e2e5480c0c07431dc98659ef6e |
Hashes for mypy_boto3_elasticache-1.14.42.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 830fea4b5b7871942bbcb5768e5f4ee5bac02c86427200d0c2a2ab3ce0d617af |
|
MD5 | 7b7fedd94af94b5acab60f2c51fce7b6 |
|
BLAKE2b-256 | 2cefa3d0a53c5584c05dea7be7a1bf5857df9f7b6960179214f6c5391aab36ef |