%global _empty_manifest_terminate_build 0
Name: python-mypy-boto3-elasticache
Version: 1.26.39
Release: 1
Summary: Type annotations for boto3.ElastiCache 1.26.39 service generated with mypy-boto3-builder 7.12.2
License: MIT License
URL: https://github.com/youtype/mypy_boto3_builder
Source0: https://mirrors.nju.edu.cn/pypi/web/packages/62/80/1de61b7ee427d8bd607432c0e45ac42038eefdd4408b6a1fb5372842dc77/mypy-boto3-elasticache-1.26.39.tar.gz
BuildArch: noarch
Requires: python3-typing-extensions
%description
# mypy-boto3-elasticache
[![PyPI - mypy-boto3-elasticache](https://img.shields.io/pypi/v/mypy-boto3-elasticache.svg?color=blue)](https://pypi.org/project/mypy-boto3-elasticache)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mypy-boto3-elasticache.svg?color=blue)](https://pypi.org/project/mypy-boto3-elasticache)
[![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/dm/mypy-boto3-elasticache?color=blue)](https://pypistats.org/packages/mypy-boto3-elasticache)
![boto3.typed](https://github.com/youtype/mypy_boto3_builder/raw/main/logo.png)
Type annotations for
[boto3.ElastiCache 1.26.39](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/elasticache.html#ElastiCache)
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-builder 7.12.2](https://github.com/youtype/mypy_boto3_builder).
More information can be found on
[boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in
[mypy-boto3-elasticache docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_elasticache/).
See how it helps to find and fix potential bugs:
![boto3-stubs demo](https://github.com/youtype/mypy_boto3_builder/raw/main/demo.gif)
- [mypy-boto3-elasticache](#mypy-boto3-elasticache)
- [How to install](#how-to-install)
- [VSCode extension](#vscode-extension)
- [From PyPI with pip](#from-pypi-with-pip)
- [How to uninstall](#how-to-uninstall)
- [Usage](#usage)
- [VSCode](#vscode)
- [PyCharm](#pycharm)
- [Emacs](#emacs)
- [Sublime Text](#sublime-text)
- [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)
- [Literals](#literals)
- [Typed dictionaries](#typed-dictionaries)
- [How it works](#how-it-works)
- [What's new](#what's-new)
- [Implemented features](#implemented-features)
- [Latest changes](#latest-changes)
- [Versioning](#versioning)
- [Thank you](#thank-you)
- [Documentation](#documentation)
- [Support and contributing](#support-and-contributing)
## How to install
### VSCode extension
Add
[AWS Boto3](https://marketplace.visualstudio.com/items?itemName=Boto3typed.boto3-ide)
extension to your VSCode and run `AWS boto3: Quick Start` command.
Click `Modify` and select `boto3 common` and `ElastiCache`.
### From PyPI with pip
Install `boto3-stubs` for `ElastiCache` service.
```bash
# install with boto3 type annotations
python -m pip install 'boto3-stubs[elasticache]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[elasticache]'
# standalone installation
python -m pip install mypy-boto3-elasticache
```
## How to uninstall
```bash
python -m pip uninstall -y mypy-boto3-elasticache
```
## 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 `boto3-stubs[elasticache]` in your environment:
```bash
python -m pip install 'boto3-stubs[elasticache]'
```
Both type checking and code completion should now work. No explicit type
annotations required, write your `boto3` code as usual.
### PyCharm
Install `boto3-stubs-lite[elasticache]` in your environment:
```bash
python -m pip install 'boto3-stubs-lite[elasticache]'`
```
Both type checking and code completion should now work. Explicit type
annotations **are required**.
Use `boto3-stubs` package instead for implicit type discovery.
### Emacs
- Install `boto3-stubs` with services you use in your environment:
```bash
python -m pip install 'boto3-stubs[elasticache]'
```
- Install [use-package](https://github.com/jwiegley/use-package),
[lsp](https://github.com/emacs-lsp/lsp-mode/),
[company](https://github.com/company-mode/company-mode) and
[flycheck](https://github.com/flycheck/flycheck) packages
- Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package
```elisp
(use-package lsp-pyright
:ensure t
:hook (python-mode . (lambda ()
(require 'lsp-pyright)
(lsp))) ; or lsp-deferred
:init (when (executable-find "python3")
(setq lsp-pyright-python-executable-cmd "python3"))
)
```
- Make sure emacs uses the environment where you have installed `boto3-stubs`
Type checking should now work. No explicit type annotations required, write
your `boto3` code as usual.
### Sublime Text
- Install `boto3-stubs[elasticache]` with services you use in your environment:
```bash
python -m pip install 'boto3-stubs[elasticache]'
```
- Install [LSP-pyright](https://github.com/sublimelsp/LSP-pyright) package
Type checking should now work. No explicit type annotations required, write
your `boto3` code as usual.
### Other IDEs
Not tested, but as long as your IDE supports `mypy` or `pyright`, everything
should work.
### mypy
- Install `mypy`: `python -m pip install mypy`
- Install `boto3-stubs[elasticache]` in your environment:
```bash
python -m pip install 'boto3-stubs[elasticache]'`
```
Type checking should now work. No explicit type annotations required, write
your `boto3` code as usual.
### pyright
- Install `pyright`: `npm i -g pyright`
- Install `boto3-stubs[elasticache]` in your environment:
```bash
python -m pip install 'boto3-stubs[elasticache]'
```
Optionally, you can install `boto3-stubs` to `typings` folder.
Type checking should now work. No explicit type annotations required, write
your `boto3` code as usual.
## Explicit type annotations
### Client annotations
`ElastiCacheClient` provides annotations for `boto3.client("elasticache")`.
```python
from boto3.session import Session
from mypy_boto3_elasticache import ElastiCacheClient
client: ElastiCacheClient = Session().client("elasticache")
# now client usage is checked by mypy and IDE should provide code completion
```
### Paginators annotations
`mypy_boto3_elasticache.paginator` module contains type annotations for all
paginators.
```python
from boto3.session import Session
from mypy_boto3_elasticache import ElastiCacheClient
from mypy_boto3_elasticache.paginator import (
DescribeCacheClustersPaginator,
DescribeCacheEngineVersionsPaginator,
DescribeCacheParameterGroupsPaginator,
DescribeCacheParametersPaginator,
DescribeCacheSecurityGroupsPaginator,
DescribeCacheSubnetGroupsPaginator,
DescribeEngineDefaultParametersPaginator,
DescribeEventsPaginator,
DescribeGlobalReplicationGroupsPaginator,
DescribeReplicationGroupsPaginator,
DescribeReservedCacheNodesPaginator,
DescribeReservedCacheNodesOfferingsPaginator,
DescribeServiceUpdatesPaginator,
DescribeSnapshotsPaginator,
DescribeUpdateActionsPaginator,
DescribeUserGroupsPaginator,
DescribeUsersPaginator,
)
client: ElastiCacheClient = Session().client("elasticache")
# Explicit type annotations are optional here
# Types should be correctly discovered by mypy and IDEs
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"
)
describe_user_groups_paginator: DescribeUserGroupsPaginator = client.get_paginator(
"describe_user_groups"
)
describe_users_paginator: DescribeUsersPaginator = client.get_paginator("describe_users")
```
### Waiters annotations
`mypy_boto3_elasticache.waiter` module contains type annotations for all
waiters.
```python
from boto3.session import Session
from mypy_boto3_elasticache import ElastiCacheClient
from mypy_boto3_elasticache.waiter import (
CacheClusterAvailableWaiter,
CacheClusterDeletedWaiter,
ReplicationGroupAvailableWaiter,
ReplicationGroupDeletedWaiter,
)
client: ElastiCacheClient = Session().client("elasticache")
# Explicit type annotations are optional here
# Types should be correctly discovered by mypy and IDEs
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"
)
```
### Literals
`mypy_boto3_elasticache.literals` module contains literals extracted from
shapes that can be used in user code for type checking.
```python
from mypy_boto3_elasticache.literals import (
AZModeType,
AuthTokenUpdateStatusType,
AuthTokenUpdateStrategyTypeType,
AuthenticationTypeType,
AutomaticFailoverStatusType,
CacheClusterAvailableWaiterName,
CacheClusterDeletedWaiterName,
ChangeTypeType,
DataTieringStatusType,
DescribeCacheClustersPaginatorName,
DescribeCacheEngineVersionsPaginatorName,
DescribeCacheParameterGroupsPaginatorName,
DescribeCacheParametersPaginatorName,
DescribeCacheSecurityGroupsPaginatorName,
DescribeCacheSubnetGroupsPaginatorName,
DescribeEngineDefaultParametersPaginatorName,
DescribeEventsPaginatorName,
DescribeGlobalReplicationGroupsPaginatorName,
DescribeReplicationGroupsPaginatorName,
DescribeReservedCacheNodesOfferingsPaginatorName,
DescribeReservedCacheNodesPaginatorName,
DescribeServiceUpdatesPaginatorName,
DescribeSnapshotsPaginatorName,
DescribeUpdateActionsPaginatorName,
DescribeUserGroupsPaginatorName,
DescribeUsersPaginatorName,
DestinationTypeType,
InputAuthenticationTypeType,
IpDiscoveryType,
LogDeliveryConfigurationStatusType,
LogFormatType,
LogTypeType,
MultiAZStatusType,
NetworkTypeType,
NodeUpdateInitiatedByType,
NodeUpdateStatusType,
OutpostModeType,
PendingAutomaticFailoverStatusType,
ReplicationGroupAvailableWaiterName,
ReplicationGroupDeletedWaiterName,
ServiceUpdateSeverityType,
ServiceUpdateStatusType,
ServiceUpdateTypeType,
SlaMetType,
SourceTypeType,
TransitEncryptionModeType,
UpdateActionStatusType,
ElastiCacheServiceName,
ServiceName,
ResourceServiceName,
PaginatorName,
WaiterName,
RegionName,
)
def check_value(value: AZModeType) -> bool:
...
```
### Typed dictionaries
`mypy_boto3_elasticache.type_defs` module contains structures and shapes
assembled to typed dictionaries for additional type checking.
```python
from mypy_boto3_elasticache.type_defs import (
TagTypeDef,
ResponseMetadataTypeDef,
AuthenticationModeTypeDef,
AuthenticationTypeDef,
AuthorizeCacheSecurityGroupIngressMessageRequestTypeDef,
AvailabilityZoneTypeDef,
BatchApplyUpdateActionMessageRequestTypeDef,
BatchStopUpdateActionMessageRequestTypeDef,
CacheParameterGroupStatusTypeDef,
CacheSecurityGroupMembershipTypeDef,
EndpointTypeDef,
NotificationConfigurationTypeDef,
SecurityGroupMembershipTypeDef,
CacheEngineVersionTypeDef,
CacheNodeTypeSpecificValueTypeDef,
CacheNodeUpdateStatusTypeDef,
ParameterTypeDef,
CacheParameterGroupTypeDef,
EC2SecurityGroupTypeDef,
CloudWatchLogsDestinationDetailsTypeDef,
CompleteMigrationMessageRequestTypeDef,
ConfigureShardTypeDef,
CreateGlobalReplicationGroupMessageRequestTypeDef,
NodeGroupConfigurationTypeDef,
CustomerNodeEndpointTypeDef,
DecreaseNodeGroupsInGlobalReplicationGroupMessageRequestTypeDef,
DeleteCacheClusterMessageRequestTypeDef,
DeleteCacheParameterGroupMessageRequestTypeDef,
DeleteCacheSecurityGroupMessageRequestTypeDef,
DeleteCacheSubnetGroupMessageRequestTypeDef,
DeleteGlobalReplicationGroupMessageRequestTypeDef,
DeleteReplicationGroupMessageRequestTypeDef,
DeleteSnapshotMessageRequestTypeDef,
DeleteUserGroupMessageRequestTypeDef,
DeleteUserMessageRequestTypeDef,
WaiterConfigTypeDef,
PaginatorConfigTypeDef,
DescribeCacheClustersMessageRequestTypeDef,
DescribeCacheEngineVersionsMessageRequestTypeDef,
DescribeCacheParameterGroupsMessageRequestTypeDef,
DescribeCacheParametersMessageRequestTypeDef,
DescribeCacheSecurityGroupsMessageRequestTypeDef,
DescribeCacheSubnetGroupsMessageRequestTypeDef,
DescribeEngineDefaultParametersMessageRequestTypeDef,
DescribeEventsMessageRequestTypeDef,
DescribeGlobalReplicationGroupsMessageRequestTypeDef,
DescribeReplicationGroupsMessageRequestTypeDef,
DescribeReservedCacheNodesMessageRequestTypeDef,
DescribeReservedCacheNodesOfferingsMessageRequestTypeDef,
DescribeServiceUpdatesMessageRequestTypeDef,
DescribeSnapshotsMessageRequestTypeDef,
TimeRangeFilterTypeDef,
DescribeUserGroupsMessageRequestTypeDef,
FilterTypeDef,
KinesisFirehoseDestinationDetailsTypeDef,
DisassociateGlobalReplicationGroupMessageRequestTypeDef,
EventTypeDef,
FailoverGlobalReplicationGroupMessageRequestTypeDef,
GlobalNodeGroupTypeDef,
GlobalReplicationGroupInfoTypeDef,
GlobalReplicationGroupMemberTypeDef,
ListAllowedNodeTypeModificationsMessageRequestTypeDef,
ListTagsForResourceMessageRequestTypeDef,
ParameterNameValueTypeDef,
ModifyCacheSubnetGroupMessageRequestTypeDef,
ModifyGlobalReplicationGroupMessageRequestTypeDef,
ReshardingConfigurationTypeDef,
ModifyUserGroupMessageRequestTypeDef,
NodeGroupMemberUpdateStatusTypeDef,
ProcessedUpdateActionTypeDef,
RebalanceSlotsInGlobalReplicationGroupMessageRequestTypeDef,
RebootCacheClusterMessageRequestTypeDef,
RecurringChargeTypeDef,
RemoveTagsFromResourceMessageRequestTypeDef,
UserGroupsUpdateStatusTypeDef,
SlotMigrationTypeDef,
RevokeCacheSecurityGroupIngressMessageRequestTypeDef,
ServiceUpdateTypeDef,
SubnetOutpostTypeDef,
TestFailoverMessageRequestTypeDef,
UnprocessedUpdateActionTypeDef,
UserGroupPendingChangesTypeDef,
AddTagsToResourceMessageRequestTypeDef,
CopySnapshotMessageRequestTypeDef,
CreateCacheParameterGroupMessageRequestTypeDef,
CreateCacheSecurityGroupMessageRequestTypeDef,
CreateCacheSubnetGroupMessageRequestTypeDef,
CreateSnapshotMessageRequestTypeDef,
CreateUserGroupMessageRequestTypeDef,
PurchaseReservedCacheNodesOfferingMessageRequestTypeDef,
AllowedNodeTypeModificationsMessageTypeDef,
CacheParameterGroupNameMessageTypeDef,
EmptyResponseMetadataTypeDef,
TagListMessageTypeDef,
CreateUserMessageRequestTypeDef,
ModifyUserMessageRequestTypeDef,
UserResponseMetadataTypeDef,
UserTypeDef,
CacheNodeTypeDef,
NodeGroupMemberTypeDef,
CacheEngineVersionMessageTypeDef,
CacheNodeTypeSpecificParameterTypeDef,
CacheParameterGroupsMessageTypeDef,
CreateCacheParameterGroupResultTypeDef,
CacheSecurityGroupTypeDef,
DecreaseReplicaCountMessageRequestTypeDef,
IncreaseReplicaCountMessageRequestTypeDef,
NodeSnapshotTypeDef,
StartMigrationMessageRequestTypeDef,
DescribeCacheClustersMessageCacheClusterAvailableWaitTypeDef,
DescribeCacheClustersMessageCacheClusterDeletedWaitTypeDef,
DescribeReplicationGroupsMessageReplicationGroupAvailableWaitTypeDef,
DescribeReplicationGroupsMessageReplicationGroupDeletedWaitTypeDef,
DescribeCacheClustersMessageDescribeCacheClustersPaginateTypeDef,
DescribeCacheEngineVersionsMessageDescribeCacheEngineVersionsPaginateTypeDef,
DescribeCacheParameterGroupsMessageDescribeCacheParameterGroupsPaginateTypeDef,
DescribeCacheParametersMessageDescribeCacheParametersPaginateTypeDef,
DescribeCacheSecurityGroupsMessageDescribeCacheSecurityGroupsPaginateTypeDef,
DescribeCacheSubnetGroupsMessageDescribeCacheSubnetGroupsPaginateTypeDef,
DescribeEngineDefaultParametersMessageDescribeEngineDefaultParametersPaginateTypeDef,
DescribeEventsMessageDescribeEventsPaginateTypeDef,
DescribeGlobalReplicationGroupsMessageDescribeGlobalReplicationGroupsPaginateTypeDef,
DescribeReplicationGroupsMessageDescribeReplicationGroupsPaginateTypeDef,
DescribeReservedCacheNodesMessageDescribeReservedCacheNodesPaginateTypeDef,
DescribeReservedCacheNodesOfferingsMessageDescribeReservedCacheNodesOfferingsPaginateTypeDef,
DescribeServiceUpdatesMessageDescribeServiceUpdatesPaginateTypeDef,
DescribeSnapshotsMessageDescribeSnapshotsPaginateTypeDef,
DescribeUserGroupsMessageDescribeUserGroupsPaginateTypeDef,
DescribeUpdateActionsMessageDescribeUpdateActionsPaginateTypeDef,
DescribeUpdateActionsMessageRequestTypeDef,
DescribeUsersMessageDescribeUsersPaginateTypeDef,
DescribeUsersMessageRequestTypeDef,
DestinationDetailsTypeDef,
EventsMessageTypeDef,
GlobalReplicationGroupTypeDef,
ModifyCacheParameterGroupMessageRequestTypeDef,
ResetCacheParameterGroupMessageRequestTypeDef,
ModifyReplicationGroupShardConfigurationMessageRequestTypeDef,
RegionalConfigurationTypeDef,
NodeGroupUpdateStatusTypeDef,
ReservedCacheNodeTypeDef,
ReservedCacheNodesOfferingTypeDef,
ReshardingStatusTypeDef,
ServiceUpdatesMessageTypeDef,
SubnetTypeDef,
UpdateActionResultsMessageTypeDef,
UserGroupResponseMetadataTypeDef,
UserGroupTypeDef,
DescribeUsersResultTypeDef,
NodeGroupTypeDef,
CacheParameterGroupDetailsTypeDef,
EngineDefaultsTypeDef,
AuthorizeCacheSecurityGroupIngressResultTypeDef,
CacheSecurityGroupMessageTypeDef,
CreateCacheSecurityGroupResultTypeDef,
RevokeCacheSecurityGroupIngressResultTypeDef,
SnapshotTypeDef,
LogDeliveryConfigurationRequestTypeDef,
LogDeliveryConfigurationTypeDef,
PendingLogDeliveryConfigurationTypeDef,
CreateGlobalReplicationGroupResultTypeDef,
DecreaseNodeGroupsInGlobalReplicationGroupResultTypeDef,
DeleteGlobalReplicationGroupResultTypeDef,
DescribeGlobalReplicationGroupsResultTypeDef,
DisassociateGlobalReplicationGroupResultTypeDef,
FailoverGlobalReplicationGroupResultTypeDef,
IncreaseNodeGroupsInGlobalReplicationGroupResultTypeDef,
ModifyGlobalReplicationGroupResultTypeDef,
RebalanceSlotsInGlobalReplicationGroupResultTypeDef,
IncreaseNodeGroupsInGlobalReplicationGroupMessageRequestTypeDef,
UpdateActionTypeDef,
PurchaseReservedCacheNodesOfferingResultTypeDef,
ReservedCacheNodeMessageTypeDef,
ReservedCacheNodesOfferingMessageTypeDef,
CacheSubnetGroupTypeDef,
DescribeUserGroupsResultTypeDef,
DescribeEngineDefaultParametersResultTypeDef,
CopySnapshotResultTypeDef,
CreateSnapshotResultTypeDef,
DeleteSnapshotResultTypeDef,
DescribeSnapshotsListMessageTypeDef,
CreateCacheClusterMessageRequestTypeDef,
CreateReplicationGroupMessageRequestTypeDef,
ModifyCacheClusterMessageRequestTypeDef,
ModifyReplicationGroupMessageRequestTypeDef,
PendingModifiedValuesTypeDef,
ReplicationGroupPendingModifiedValuesTypeDef,
UpdateActionsMessageTypeDef,
CacheSubnetGroupMessageTypeDef,
CreateCacheSubnetGroupResultTypeDef,
ModifyCacheSubnetGroupResultTypeDef,
CacheClusterTypeDef,
ReplicationGroupTypeDef,
CacheClusterMessageTypeDef,
CreateCacheClusterResultTypeDef,
DeleteCacheClusterResultTypeDef,
ModifyCacheClusterResultTypeDef,
RebootCacheClusterResultTypeDef,
CompleteMigrationResponseTypeDef,
CreateReplicationGroupResultTypeDef,
DecreaseReplicaCountResultTypeDef,
DeleteReplicationGroupResultTypeDef,
IncreaseReplicaCountResultTypeDef,
ModifyReplicationGroupResultTypeDef,
ModifyReplicationGroupShardConfigurationResultTypeDef,
ReplicationGroupMessageTypeDef,
StartMigrationResponseTypeDef,
TestFailoverResultTypeDef,
)
def get_structure() -> TagTypeDef:
return {...}
```
## How it works
Fully automated
[mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder) carefully
generates type annotations for each service, patiently waiting for `boto3`
updates. It delivers a drop-in type annotations for you and makes sure that:
- All available `boto3` services are covered.
- Each public class and method of every `boto3` service gets valid type
annotations extracted from the documentation (blame `botocore` docs if types
are incorrect).
- Type annotations include up-to-date documentation.
- Link to documentation is provided for every method.
- Code is processed by [black](https://github.com/psf/black) and
[isort](https://github.com/PyCQA/isort) for readability.
## What's new
### Implemented features
- Fully type annotated `boto3`, `botocore` and `aiobotocore` libraries
- `mypy`, `pyright`, `VSCode`, `PyCharm`, `Sublime Text` and `Emacs`
compatibility
- `Client`, `ServiceResource`, `Resource`, `Waiter` `Paginator` type
annotations for each service
- Generated `TypeDefs` for each service
- Generated `Literals` for each service
- Auto discovery of types for `boto3.client` and `boto3.session` calls
- Auto discovery of types for `session.client` and `session.session` calls
- Auto discovery of types for `client.get_waiter` and `client.get_paginator`
calls
- Auto discovery of types for `ServiceResource` and `Resource` collections
- Auto discovery of types for `aiobotocore.Session.create_client` calls
### Latest changes
Builder changelog can be found in
[Releases](https://github.com/youtype/mypy_boto3_builder/releases).
## Versioning
`mypy-boto3-elasticache` version is the same as related `boto3` version and
follows [PEP 440](https://www.python.org/dev/peps/pep-0440/) format.
## Thank you
- [Allie Fitter](https://github.com/alliefitter) for
[boto3-type-annotations](https://pypi.org/project/boto3-type-annotations/),
this package is based on top of his work
- [black](https://github.com/psf/black) developers for an awesome formatting
tool
- [Timothy Edmund Crosley](https://github.com/timothycrosley) for
[isort](https://github.com/PyCQA/isort) and how flexible it is
- [mypy](https://github.com/python/mypy) developers for doing all dirty work
for us
- [pyright](https://github.com/microsoft/pyright) team for the new era of typed
Python
## Documentation
All services type annotations can be found in
[boto3 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_elasticache/)
## Support and contributing
This package is auto-generated. Please reports any bugs or request new features
in [mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder/issues/)
repository.
%package -n python3-mypy-boto3-elasticache
Summary: Type annotations for boto3.ElastiCache 1.26.39 service generated with mypy-boto3-builder 7.12.2
Provides: python-mypy-boto3-elasticache
BuildRequires: python3-devel
BuildRequires: python3-setuptools
BuildRequires: python3-pip
%description -n python3-mypy-boto3-elasticache
# mypy-boto3-elasticache
[![PyPI - mypy-boto3-elasticache](https://img.shields.io/pypi/v/mypy-boto3-elasticache.svg?color=blue)](https://pypi.org/project/mypy-boto3-elasticache)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mypy-boto3-elasticache.svg?color=blue)](https://pypi.org/project/mypy-boto3-elasticache)
[![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/dm/mypy-boto3-elasticache?color=blue)](https://pypistats.org/packages/mypy-boto3-elasticache)
![boto3.typed](https://github.com/youtype/mypy_boto3_builder/raw/main/logo.png)
Type annotations for
[boto3.ElastiCache 1.26.39](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/elasticache.html#ElastiCache)
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-builder 7.12.2](https://github.com/youtype/mypy_boto3_builder).
More information can be found on
[boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in
[mypy-boto3-elasticache docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_elasticache/).
See how it helps to find and fix potential bugs:
![boto3-stubs demo](https://github.com/youtype/mypy_boto3_builder/raw/main/demo.gif)
- [mypy-boto3-elasticache](#mypy-boto3-elasticache)
- [How to install](#how-to-install)
- [VSCode extension](#vscode-extension)
- [From PyPI with pip](#from-pypi-with-pip)
- [How to uninstall](#how-to-uninstall)
- [Usage](#usage)
- [VSCode](#vscode)
- [PyCharm](#pycharm)
- [Emacs](#emacs)
- [Sublime Text](#sublime-text)
- [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)
- [Literals](#literals)
- [Typed dictionaries](#typed-dictionaries)
- [How it works](#how-it-works)
- [What's new](#what's-new)
- [Implemented features](#implemented-features)
- [Latest changes](#latest-changes)
- [Versioning](#versioning)
- [Thank you](#thank-you)
- [Documentation](#documentation)
- [Support and contributing](#support-and-contributing)
## How to install
### VSCode extension
Add
[AWS Boto3](https://marketplace.visualstudio.com/items?itemName=Boto3typed.boto3-ide)
extension to your VSCode and run `AWS boto3: Quick Start` command.
Click `Modify` and select `boto3 common` and `ElastiCache`.
### From PyPI with pip
Install `boto3-stubs` for `ElastiCache` service.
```bash
# install with boto3 type annotations
python -m pip install 'boto3-stubs[elasticache]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[elasticache]'
# standalone installation
python -m pip install mypy-boto3-elasticache
```
## How to uninstall
```bash
python -m pip uninstall -y mypy-boto3-elasticache
```
## 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 `boto3-stubs[elasticache]` in your environment:
```bash
python -m pip install 'boto3-stubs[elasticache]'
```
Both type checking and code completion should now work. No explicit type
annotations required, write your `boto3` code as usual.
### PyCharm
Install `boto3-stubs-lite[elasticache]` in your environment:
```bash
python -m pip install 'boto3-stubs-lite[elasticache]'`
```
Both type checking and code completion should now work. Explicit type
annotations **are required**.
Use `boto3-stubs` package instead for implicit type discovery.
### Emacs
- Install `boto3-stubs` with services you use in your environment:
```bash
python -m pip install 'boto3-stubs[elasticache]'
```
- Install [use-package](https://github.com/jwiegley/use-package),
[lsp](https://github.com/emacs-lsp/lsp-mode/),
[company](https://github.com/company-mode/company-mode) and
[flycheck](https://github.com/flycheck/flycheck) packages
- Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package
```elisp
(use-package lsp-pyright
:ensure t
:hook (python-mode . (lambda ()
(require 'lsp-pyright)
(lsp))) ; or lsp-deferred
:init (when (executable-find "python3")
(setq lsp-pyright-python-executable-cmd "python3"))
)
```
- Make sure emacs uses the environment where you have installed `boto3-stubs`
Type checking should now work. No explicit type annotations required, write
your `boto3` code as usual.
### Sublime Text
- Install `boto3-stubs[elasticache]` with services you use in your environment:
```bash
python -m pip install 'boto3-stubs[elasticache]'
```
- Install [LSP-pyright](https://github.com/sublimelsp/LSP-pyright) package
Type checking should now work. No explicit type annotations required, write
your `boto3` code as usual.
### Other IDEs
Not tested, but as long as your IDE supports `mypy` or `pyright`, everything
should work.
### mypy
- Install `mypy`: `python -m pip install mypy`
- Install `boto3-stubs[elasticache]` in your environment:
```bash
python -m pip install 'boto3-stubs[elasticache]'`
```
Type checking should now work. No explicit type annotations required, write
your `boto3` code as usual.
### pyright
- Install `pyright`: `npm i -g pyright`
- Install `boto3-stubs[elasticache]` in your environment:
```bash
python -m pip install 'boto3-stubs[elasticache]'
```
Optionally, you can install `boto3-stubs` to `typings` folder.
Type checking should now work. No explicit type annotations required, write
your `boto3` code as usual.
## Explicit type annotations
### Client annotations
`ElastiCacheClient` provides annotations for `boto3.client("elasticache")`.
```python
from boto3.session import Session
from mypy_boto3_elasticache import ElastiCacheClient
client: ElastiCacheClient = Session().client("elasticache")
# now client usage is checked by mypy and IDE should provide code completion
```
### Paginators annotations
`mypy_boto3_elasticache.paginator` module contains type annotations for all
paginators.
```python
from boto3.session import Session
from mypy_boto3_elasticache import ElastiCacheClient
from mypy_boto3_elasticache.paginator import (
DescribeCacheClustersPaginator,
DescribeCacheEngineVersionsPaginator,
DescribeCacheParameterGroupsPaginator,
DescribeCacheParametersPaginator,
DescribeCacheSecurityGroupsPaginator,
DescribeCacheSubnetGroupsPaginator,
DescribeEngineDefaultParametersPaginator,
DescribeEventsPaginator,
DescribeGlobalReplicationGroupsPaginator,
DescribeReplicationGroupsPaginator,
DescribeReservedCacheNodesPaginator,
DescribeReservedCacheNodesOfferingsPaginator,
DescribeServiceUpdatesPaginator,
DescribeSnapshotsPaginator,
DescribeUpdateActionsPaginator,
DescribeUserGroupsPaginator,
DescribeUsersPaginator,
)
client: ElastiCacheClient = Session().client("elasticache")
# Explicit type annotations are optional here
# Types should be correctly discovered by mypy and IDEs
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"
)
describe_user_groups_paginator: DescribeUserGroupsPaginator = client.get_paginator(
"describe_user_groups"
)
describe_users_paginator: DescribeUsersPaginator = client.get_paginator("describe_users")
```
### Waiters annotations
`mypy_boto3_elasticache.waiter` module contains type annotations for all
waiters.
```python
from boto3.session import Session
from mypy_boto3_elasticache import ElastiCacheClient
from mypy_boto3_elasticache.waiter import (
CacheClusterAvailableWaiter,
CacheClusterDeletedWaiter,
ReplicationGroupAvailableWaiter,
ReplicationGroupDeletedWaiter,
)
client: ElastiCacheClient = Session().client("elasticache")
# Explicit type annotations are optional here
# Types should be correctly discovered by mypy and IDEs
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"
)
```
### Literals
`mypy_boto3_elasticache.literals` module contains literals extracted from
shapes that can be used in user code for type checking.
```python
from mypy_boto3_elasticache.literals import (
AZModeType,
AuthTokenUpdateStatusType,
AuthTokenUpdateStrategyTypeType,
AuthenticationTypeType,
AutomaticFailoverStatusType,
CacheClusterAvailableWaiterName,
CacheClusterDeletedWaiterName,
ChangeTypeType,
DataTieringStatusType,
DescribeCacheClustersPaginatorName,
DescribeCacheEngineVersionsPaginatorName,
DescribeCacheParameterGroupsPaginatorName,
DescribeCacheParametersPaginatorName,
DescribeCacheSecurityGroupsPaginatorName,
DescribeCacheSubnetGroupsPaginatorName,
DescribeEngineDefaultParametersPaginatorName,
DescribeEventsPaginatorName,
DescribeGlobalReplicationGroupsPaginatorName,
DescribeReplicationGroupsPaginatorName,
DescribeReservedCacheNodesOfferingsPaginatorName,
DescribeReservedCacheNodesPaginatorName,
DescribeServiceUpdatesPaginatorName,
DescribeSnapshotsPaginatorName,
DescribeUpdateActionsPaginatorName,
DescribeUserGroupsPaginatorName,
DescribeUsersPaginatorName,
DestinationTypeType,
InputAuthenticationTypeType,
IpDiscoveryType,
LogDeliveryConfigurationStatusType,
LogFormatType,
LogTypeType,
MultiAZStatusType,
NetworkTypeType,
NodeUpdateInitiatedByType,
NodeUpdateStatusType,
OutpostModeType,
PendingAutomaticFailoverStatusType,
ReplicationGroupAvailableWaiterName,
ReplicationGroupDeletedWaiterName,
ServiceUpdateSeverityType,
ServiceUpdateStatusType,
ServiceUpdateTypeType,
SlaMetType,
SourceTypeType,
TransitEncryptionModeType,
UpdateActionStatusType,
ElastiCacheServiceName,
ServiceName,
ResourceServiceName,
PaginatorName,
WaiterName,
RegionName,
)
def check_value(value: AZModeType) -> bool:
...
```
### Typed dictionaries
`mypy_boto3_elasticache.type_defs` module contains structures and shapes
assembled to typed dictionaries for additional type checking.
```python
from mypy_boto3_elasticache.type_defs import (
TagTypeDef,
ResponseMetadataTypeDef,
AuthenticationModeTypeDef,
AuthenticationTypeDef,
AuthorizeCacheSecurityGroupIngressMessageRequestTypeDef,
AvailabilityZoneTypeDef,
BatchApplyUpdateActionMessageRequestTypeDef,
BatchStopUpdateActionMessageRequestTypeDef,
CacheParameterGroupStatusTypeDef,
CacheSecurityGroupMembershipTypeDef,
EndpointTypeDef,
NotificationConfigurationTypeDef,
SecurityGroupMembershipTypeDef,
CacheEngineVersionTypeDef,
CacheNodeTypeSpecificValueTypeDef,
CacheNodeUpdateStatusTypeDef,
ParameterTypeDef,
CacheParameterGroupTypeDef,
EC2SecurityGroupTypeDef,
CloudWatchLogsDestinationDetailsTypeDef,
CompleteMigrationMessageRequestTypeDef,
ConfigureShardTypeDef,
CreateGlobalReplicationGroupMessageRequestTypeDef,
NodeGroupConfigurationTypeDef,
CustomerNodeEndpointTypeDef,
DecreaseNodeGroupsInGlobalReplicationGroupMessageRequestTypeDef,
DeleteCacheClusterMessageRequestTypeDef,
DeleteCacheParameterGroupMessageRequestTypeDef,
DeleteCacheSecurityGroupMessageRequestTypeDef,
DeleteCacheSubnetGroupMessageRequestTypeDef,
DeleteGlobalReplicationGroupMessageRequestTypeDef,
DeleteReplicationGroupMessageRequestTypeDef,
DeleteSnapshotMessageRequestTypeDef,
DeleteUserGroupMessageRequestTypeDef,
DeleteUserMessageRequestTypeDef,
WaiterConfigTypeDef,
PaginatorConfigTypeDef,
DescribeCacheClustersMessageRequestTypeDef,
DescribeCacheEngineVersionsMessageRequestTypeDef,
DescribeCacheParameterGroupsMessageRequestTypeDef,
DescribeCacheParametersMessageRequestTypeDef,
DescribeCacheSecurityGroupsMessageRequestTypeDef,
DescribeCacheSubnetGroupsMessageRequestTypeDef,
DescribeEngineDefaultParametersMessageRequestTypeDef,
DescribeEventsMessageRequestTypeDef,
DescribeGlobalReplicationGroupsMessageRequestTypeDef,
DescribeReplicationGroupsMessageRequestTypeDef,
DescribeReservedCacheNodesMessageRequestTypeDef,
DescribeReservedCacheNodesOfferingsMessageRequestTypeDef,
DescribeServiceUpdatesMessageRequestTypeDef,
DescribeSnapshotsMessageRequestTypeDef,
TimeRangeFilterTypeDef,
DescribeUserGroupsMessageRequestTypeDef,
FilterTypeDef,
KinesisFirehoseDestinationDetailsTypeDef,
DisassociateGlobalReplicationGroupMessageRequestTypeDef,
EventTypeDef,
FailoverGlobalReplicationGroupMessageRequestTypeDef,
GlobalNodeGroupTypeDef,
GlobalReplicationGroupInfoTypeDef,
GlobalReplicationGroupMemberTypeDef,
ListAllowedNodeTypeModificationsMessageRequestTypeDef,
ListTagsForResourceMessageRequestTypeDef,
ParameterNameValueTypeDef,
ModifyCacheSubnetGroupMessageRequestTypeDef,
ModifyGlobalReplicationGroupMessageRequestTypeDef,
ReshardingConfigurationTypeDef,
ModifyUserGroupMessageRequestTypeDef,
NodeGroupMemberUpdateStatusTypeDef,
ProcessedUpdateActionTypeDef,
RebalanceSlotsInGlobalReplicationGroupMessageRequestTypeDef,
RebootCacheClusterMessageRequestTypeDef,
RecurringChargeTypeDef,
RemoveTagsFromResourceMessageRequestTypeDef,
UserGroupsUpdateStatusTypeDef,
SlotMigrationTypeDef,
RevokeCacheSecurityGroupIngressMessageRequestTypeDef,
ServiceUpdateTypeDef,
SubnetOutpostTypeDef,
TestFailoverMessageRequestTypeDef,
UnprocessedUpdateActionTypeDef,
UserGroupPendingChangesTypeDef,
AddTagsToResourceMessageRequestTypeDef,
CopySnapshotMessageRequestTypeDef,
CreateCacheParameterGroupMessageRequestTypeDef,
CreateCacheSecurityGroupMessageRequestTypeDef,
CreateCacheSubnetGroupMessageRequestTypeDef,
CreateSnapshotMessageRequestTypeDef,
CreateUserGroupMessageRequestTypeDef,
PurchaseReservedCacheNodesOfferingMessageRequestTypeDef,
AllowedNodeTypeModificationsMessageTypeDef,
CacheParameterGroupNameMessageTypeDef,
EmptyResponseMetadataTypeDef,
TagListMessageTypeDef,
CreateUserMessageRequestTypeDef,
ModifyUserMessageRequestTypeDef,
UserResponseMetadataTypeDef,
UserTypeDef,
CacheNodeTypeDef,
NodeGroupMemberTypeDef,
CacheEngineVersionMessageTypeDef,
CacheNodeTypeSpecificParameterTypeDef,
CacheParameterGroupsMessageTypeDef,
CreateCacheParameterGroupResultTypeDef,
CacheSecurityGroupTypeDef,
DecreaseReplicaCountMessageRequestTypeDef,
IncreaseReplicaCountMessageRequestTypeDef,
NodeSnapshotTypeDef,
StartMigrationMessageRequestTypeDef,
DescribeCacheClustersMessageCacheClusterAvailableWaitTypeDef,
DescribeCacheClustersMessageCacheClusterDeletedWaitTypeDef,
DescribeReplicationGroupsMessageReplicationGroupAvailableWaitTypeDef,
DescribeReplicationGroupsMessageReplicationGroupDeletedWaitTypeDef,
DescribeCacheClustersMessageDescribeCacheClustersPaginateTypeDef,
DescribeCacheEngineVersionsMessageDescribeCacheEngineVersionsPaginateTypeDef,
DescribeCacheParameterGroupsMessageDescribeCacheParameterGroupsPaginateTypeDef,
DescribeCacheParametersMessageDescribeCacheParametersPaginateTypeDef,
DescribeCacheSecurityGroupsMessageDescribeCacheSecurityGroupsPaginateTypeDef,
DescribeCacheSubnetGroupsMessageDescribeCacheSubnetGroupsPaginateTypeDef,
DescribeEngineDefaultParametersMessageDescribeEngineDefaultParametersPaginateTypeDef,
DescribeEventsMessageDescribeEventsPaginateTypeDef,
DescribeGlobalReplicationGroupsMessageDescribeGlobalReplicationGroupsPaginateTypeDef,
DescribeReplicationGroupsMessageDescribeReplicationGroupsPaginateTypeDef,
DescribeReservedCacheNodesMessageDescribeReservedCacheNodesPaginateTypeDef,
DescribeReservedCacheNodesOfferingsMessageDescribeReservedCacheNodesOfferingsPaginateTypeDef,
DescribeServiceUpdatesMessageDescribeServiceUpdatesPaginateTypeDef,
DescribeSnapshotsMessageDescribeSnapshotsPaginateTypeDef,
DescribeUserGroupsMessageDescribeUserGroupsPaginateTypeDef,
DescribeUpdateActionsMessageDescribeUpdateActionsPaginateTypeDef,
DescribeUpdateActionsMessageRequestTypeDef,
DescribeUsersMessageDescribeUsersPaginateTypeDef,
DescribeUsersMessageRequestTypeDef,
DestinationDetailsTypeDef,
EventsMessageTypeDef,
GlobalReplicationGroupTypeDef,
ModifyCacheParameterGroupMessageRequestTypeDef,
ResetCacheParameterGroupMessageRequestTypeDef,
ModifyReplicationGroupShardConfigurationMessageRequestTypeDef,
RegionalConfigurationTypeDef,
NodeGroupUpdateStatusTypeDef,
ReservedCacheNodeTypeDef,
ReservedCacheNodesOfferingTypeDef,
ReshardingStatusTypeDef,
ServiceUpdatesMessageTypeDef,
SubnetTypeDef,
UpdateActionResultsMessageTypeDef,
UserGroupResponseMetadataTypeDef,
UserGroupTypeDef,
DescribeUsersResultTypeDef,
NodeGroupTypeDef,
CacheParameterGroupDetailsTypeDef,
EngineDefaultsTypeDef,
AuthorizeCacheSecurityGroupIngressResultTypeDef,
CacheSecurityGroupMessageTypeDef,
CreateCacheSecurityGroupResultTypeDef,
RevokeCacheSecurityGroupIngressResultTypeDef,
SnapshotTypeDef,
LogDeliveryConfigurationRequestTypeDef,
LogDeliveryConfigurationTypeDef,
PendingLogDeliveryConfigurationTypeDef,
CreateGlobalReplicationGroupResultTypeDef,
DecreaseNodeGroupsInGlobalReplicationGroupResultTypeDef,
DeleteGlobalReplicationGroupResultTypeDef,
DescribeGlobalReplicationGroupsResultTypeDef,
DisassociateGlobalReplicationGroupResultTypeDef,
FailoverGlobalReplicationGroupResultTypeDef,
IncreaseNodeGroupsInGlobalReplicationGroupResultTypeDef,
ModifyGlobalReplicationGroupResultTypeDef,
RebalanceSlotsInGlobalReplicationGroupResultTypeDef,
IncreaseNodeGroupsInGlobalReplicationGroupMessageRequestTypeDef,
UpdateActionTypeDef,
PurchaseReservedCacheNodesOfferingResultTypeDef,
ReservedCacheNodeMessageTypeDef,
ReservedCacheNodesOfferingMessageTypeDef,
CacheSubnetGroupTypeDef,
DescribeUserGroupsResultTypeDef,
DescribeEngineDefaultParametersResultTypeDef,
CopySnapshotResultTypeDef,
CreateSnapshotResultTypeDef,
DeleteSnapshotResultTypeDef,
DescribeSnapshotsListMessageTypeDef,
CreateCacheClusterMessageRequestTypeDef,
CreateReplicationGroupMessageRequestTypeDef,
ModifyCacheClusterMessageRequestTypeDef,
ModifyReplicationGroupMessageRequestTypeDef,
PendingModifiedValuesTypeDef,
ReplicationGroupPendingModifiedValuesTypeDef,
UpdateActionsMessageTypeDef,
CacheSubnetGroupMessageTypeDef,
CreateCacheSubnetGroupResultTypeDef,
ModifyCacheSubnetGroupResultTypeDef,
CacheClusterTypeDef,
ReplicationGroupTypeDef,
CacheClusterMessageTypeDef,
CreateCacheClusterResultTypeDef,
DeleteCacheClusterResultTypeDef,
ModifyCacheClusterResultTypeDef,
RebootCacheClusterResultTypeDef,
CompleteMigrationResponseTypeDef,
CreateReplicationGroupResultTypeDef,
DecreaseReplicaCountResultTypeDef,
DeleteReplicationGroupResultTypeDef,
IncreaseReplicaCountResultTypeDef,
ModifyReplicationGroupResultTypeDef,
ModifyReplicationGroupShardConfigurationResultTypeDef,
ReplicationGroupMessageTypeDef,
StartMigrationResponseTypeDef,
TestFailoverResultTypeDef,
)
def get_structure() -> TagTypeDef:
return {...}
```
## How it works
Fully automated
[mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder) carefully
generates type annotations for each service, patiently waiting for `boto3`
updates. It delivers a drop-in type annotations for you and makes sure that:
- All available `boto3` services are covered.
- Each public class and method of every `boto3` service gets valid type
annotations extracted from the documentation (blame `botocore` docs if types
are incorrect).
- Type annotations include up-to-date documentation.
- Link to documentation is provided for every method.
- Code is processed by [black](https://github.com/psf/black) and
[isort](https://github.com/PyCQA/isort) for readability.
## What's new
### Implemented features
- Fully type annotated `boto3`, `botocore` and `aiobotocore` libraries
- `mypy`, `pyright`, `VSCode`, `PyCharm`, `Sublime Text` and `Emacs`
compatibility
- `Client`, `ServiceResource`, `Resource`, `Waiter` `Paginator` type
annotations for each service
- Generated `TypeDefs` for each service
- Generated `Literals` for each service
- Auto discovery of types for `boto3.client` and `boto3.session` calls
- Auto discovery of types for `session.client` and `session.session` calls
- Auto discovery of types for `client.get_waiter` and `client.get_paginator`
calls
- Auto discovery of types for `ServiceResource` and `Resource` collections
- Auto discovery of types for `aiobotocore.Session.create_client` calls
### Latest changes
Builder changelog can be found in
[Releases](https://github.com/youtype/mypy_boto3_builder/releases).
## Versioning
`mypy-boto3-elasticache` version is the same as related `boto3` version and
follows [PEP 440](https://www.python.org/dev/peps/pep-0440/) format.
## Thank you
- [Allie Fitter](https://github.com/alliefitter) for
[boto3-type-annotations](https://pypi.org/project/boto3-type-annotations/),
this package is based on top of his work
- [black](https://github.com/psf/black) developers for an awesome formatting
tool
- [Timothy Edmund Crosley](https://github.com/timothycrosley) for
[isort](https://github.com/PyCQA/isort) and how flexible it is
- [mypy](https://github.com/python/mypy) developers for doing all dirty work
for us
- [pyright](https://github.com/microsoft/pyright) team for the new era of typed
Python
## Documentation
All services type annotations can be found in
[boto3 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_elasticache/)
## Support and contributing
This package is auto-generated. Please reports any bugs or request new features
in [mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder/issues/)
repository.
%package help
Summary: Development documents and examples for mypy-boto3-elasticache
Provides: python3-mypy-boto3-elasticache-doc
%description help
# mypy-boto3-elasticache
[![PyPI - mypy-boto3-elasticache](https://img.shields.io/pypi/v/mypy-boto3-elasticache.svg?color=blue)](https://pypi.org/project/mypy-boto3-elasticache)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mypy-boto3-elasticache.svg?color=blue)](https://pypi.org/project/mypy-boto3-elasticache)
[![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/dm/mypy-boto3-elasticache?color=blue)](https://pypistats.org/packages/mypy-boto3-elasticache)
![boto3.typed](https://github.com/youtype/mypy_boto3_builder/raw/main/logo.png)
Type annotations for
[boto3.ElastiCache 1.26.39](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/elasticache.html#ElastiCache)
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-builder 7.12.2](https://github.com/youtype/mypy_boto3_builder).
More information can be found on
[boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in
[mypy-boto3-elasticache docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_elasticache/).
See how it helps to find and fix potential bugs:
![boto3-stubs demo](https://github.com/youtype/mypy_boto3_builder/raw/main/demo.gif)
- [mypy-boto3-elasticache](#mypy-boto3-elasticache)
- [How to install](#how-to-install)
- [VSCode extension](#vscode-extension)
- [From PyPI with pip](#from-pypi-with-pip)
- [How to uninstall](#how-to-uninstall)
- [Usage](#usage)
- [VSCode](#vscode)
- [PyCharm](#pycharm)
- [Emacs](#emacs)
- [Sublime Text](#sublime-text)
- [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)
- [Literals](#literals)
- [Typed dictionaries](#typed-dictionaries)
- [How it works](#how-it-works)
- [What's new](#what's-new)
- [Implemented features](#implemented-features)
- [Latest changes](#latest-changes)
- [Versioning](#versioning)
- [Thank you](#thank-you)
- [Documentation](#documentation)
- [Support and contributing](#support-and-contributing)
## How to install
### VSCode extension
Add
[AWS Boto3](https://marketplace.visualstudio.com/items?itemName=Boto3typed.boto3-ide)
extension to your VSCode and run `AWS boto3: Quick Start` command.
Click `Modify` and select `boto3 common` and `ElastiCache`.
### From PyPI with pip
Install `boto3-stubs` for `ElastiCache` service.
```bash
# install with boto3 type annotations
python -m pip install 'boto3-stubs[elasticache]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[elasticache]'
# standalone installation
python -m pip install mypy-boto3-elasticache
```
## How to uninstall
```bash
python -m pip uninstall -y mypy-boto3-elasticache
```
## 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 `boto3-stubs[elasticache]` in your environment:
```bash
python -m pip install 'boto3-stubs[elasticache]'
```
Both type checking and code completion should now work. No explicit type
annotations required, write your `boto3` code as usual.
### PyCharm
Install `boto3-stubs-lite[elasticache]` in your environment:
```bash
python -m pip install 'boto3-stubs-lite[elasticache]'`
```
Both type checking and code completion should now work. Explicit type
annotations **are required**.
Use `boto3-stubs` package instead for implicit type discovery.
### Emacs
- Install `boto3-stubs` with services you use in your environment:
```bash
python -m pip install 'boto3-stubs[elasticache]'
```
- Install [use-package](https://github.com/jwiegley/use-package),
[lsp](https://github.com/emacs-lsp/lsp-mode/),
[company](https://github.com/company-mode/company-mode) and
[flycheck](https://github.com/flycheck/flycheck) packages
- Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package
```elisp
(use-package lsp-pyright
:ensure t
:hook (python-mode . (lambda ()
(require 'lsp-pyright)
(lsp))) ; or lsp-deferred
:init (when (executable-find "python3")
(setq lsp-pyright-python-executable-cmd "python3"))
)
```
- Make sure emacs uses the environment where you have installed `boto3-stubs`
Type checking should now work. No explicit type annotations required, write
your `boto3` code as usual.
### Sublime Text
- Install `boto3-stubs[elasticache]` with services you use in your environment:
```bash
python -m pip install 'boto3-stubs[elasticache]'
```
- Install [LSP-pyright](https://github.com/sublimelsp/LSP-pyright) package
Type checking should now work. No explicit type annotations required, write
your `boto3` code as usual.
### Other IDEs
Not tested, but as long as your IDE supports `mypy` or `pyright`, everything
should work.
### mypy
- Install `mypy`: `python -m pip install mypy`
- Install `boto3-stubs[elasticache]` in your environment:
```bash
python -m pip install 'boto3-stubs[elasticache]'`
```
Type checking should now work. No explicit type annotations required, write
your `boto3` code as usual.
### pyright
- Install `pyright`: `npm i -g pyright`
- Install `boto3-stubs[elasticache]` in your environment:
```bash
python -m pip install 'boto3-stubs[elasticache]'
```
Optionally, you can install `boto3-stubs` to `typings` folder.
Type checking should now work. No explicit type annotations required, write
your `boto3` code as usual.
## Explicit type annotations
### Client annotations
`ElastiCacheClient` provides annotations for `boto3.client("elasticache")`.
```python
from boto3.session import Session
from mypy_boto3_elasticache import ElastiCacheClient
client: ElastiCacheClient = Session().client("elasticache")
# now client usage is checked by mypy and IDE should provide code completion
```
### Paginators annotations
`mypy_boto3_elasticache.paginator` module contains type annotations for all
paginators.
```python
from boto3.session import Session
from mypy_boto3_elasticache import ElastiCacheClient
from mypy_boto3_elasticache.paginator import (
DescribeCacheClustersPaginator,
DescribeCacheEngineVersionsPaginator,
DescribeCacheParameterGroupsPaginator,
DescribeCacheParametersPaginator,
DescribeCacheSecurityGroupsPaginator,
DescribeCacheSubnetGroupsPaginator,
DescribeEngineDefaultParametersPaginator,
DescribeEventsPaginator,
DescribeGlobalReplicationGroupsPaginator,
DescribeReplicationGroupsPaginator,
DescribeReservedCacheNodesPaginator,
DescribeReservedCacheNodesOfferingsPaginator,
DescribeServiceUpdatesPaginator,
DescribeSnapshotsPaginator,
DescribeUpdateActionsPaginator,
DescribeUserGroupsPaginator,
DescribeUsersPaginator,
)
client: ElastiCacheClient = Session().client("elasticache")
# Explicit type annotations are optional here
# Types should be correctly discovered by mypy and IDEs
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"
)
describe_user_groups_paginator: DescribeUserGroupsPaginator = client.get_paginator(
"describe_user_groups"
)
describe_users_paginator: DescribeUsersPaginator = client.get_paginator("describe_users")
```
### Waiters annotations
`mypy_boto3_elasticache.waiter` module contains type annotations for all
waiters.
```python
from boto3.session import Session
from mypy_boto3_elasticache import ElastiCacheClient
from mypy_boto3_elasticache.waiter import (
CacheClusterAvailableWaiter,
CacheClusterDeletedWaiter,
ReplicationGroupAvailableWaiter,
ReplicationGroupDeletedWaiter,
)
client: ElastiCacheClient = Session().client("elasticache")
# Explicit type annotations are optional here
# Types should be correctly discovered by mypy and IDEs
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"
)
```
### Literals
`mypy_boto3_elasticache.literals` module contains literals extracted from
shapes that can be used in user code for type checking.
```python
from mypy_boto3_elasticache.literals import (
AZModeType,
AuthTokenUpdateStatusType,
AuthTokenUpdateStrategyTypeType,
AuthenticationTypeType,
AutomaticFailoverStatusType,
CacheClusterAvailableWaiterName,
CacheClusterDeletedWaiterName,
ChangeTypeType,
DataTieringStatusType,
DescribeCacheClustersPaginatorName,
DescribeCacheEngineVersionsPaginatorName,
DescribeCacheParameterGroupsPaginatorName,
DescribeCacheParametersPaginatorName,
DescribeCacheSecurityGroupsPaginatorName,
DescribeCacheSubnetGroupsPaginatorName,
DescribeEngineDefaultParametersPaginatorName,
DescribeEventsPaginatorName,
DescribeGlobalReplicationGroupsPaginatorName,
DescribeReplicationGroupsPaginatorName,
DescribeReservedCacheNodesOfferingsPaginatorName,
DescribeReservedCacheNodesPaginatorName,
DescribeServiceUpdatesPaginatorName,
DescribeSnapshotsPaginatorName,
DescribeUpdateActionsPaginatorName,
DescribeUserGroupsPaginatorName,
DescribeUsersPaginatorName,
DestinationTypeType,
InputAuthenticationTypeType,
IpDiscoveryType,
LogDeliveryConfigurationStatusType,
LogFormatType,
LogTypeType,
MultiAZStatusType,
NetworkTypeType,
NodeUpdateInitiatedByType,
NodeUpdateStatusType,
OutpostModeType,
PendingAutomaticFailoverStatusType,
ReplicationGroupAvailableWaiterName,
ReplicationGroupDeletedWaiterName,
ServiceUpdateSeverityType,
ServiceUpdateStatusType,
ServiceUpdateTypeType,
SlaMetType,
SourceTypeType,
TransitEncryptionModeType,
UpdateActionStatusType,
ElastiCacheServiceName,
ServiceName,
ResourceServiceName,
PaginatorName,
WaiterName,
RegionName,
)
def check_value(value: AZModeType) -> bool:
...
```
### Typed dictionaries
`mypy_boto3_elasticache.type_defs` module contains structures and shapes
assembled to typed dictionaries for additional type checking.
```python
from mypy_boto3_elasticache.type_defs import (
TagTypeDef,
ResponseMetadataTypeDef,
AuthenticationModeTypeDef,
AuthenticationTypeDef,
AuthorizeCacheSecurityGroupIngressMessageRequestTypeDef,
AvailabilityZoneTypeDef,
BatchApplyUpdateActionMessageRequestTypeDef,
BatchStopUpdateActionMessageRequestTypeDef,
CacheParameterGroupStatusTypeDef,
CacheSecurityGroupMembershipTypeDef,
EndpointTypeDef,
NotificationConfigurationTypeDef,
SecurityGroupMembershipTypeDef,
CacheEngineVersionTypeDef,
CacheNodeTypeSpecificValueTypeDef,
CacheNodeUpdateStatusTypeDef,
ParameterTypeDef,
CacheParameterGroupTypeDef,
EC2SecurityGroupTypeDef,
CloudWatchLogsDestinationDetailsTypeDef,
CompleteMigrationMessageRequestTypeDef,
ConfigureShardTypeDef,
CreateGlobalReplicationGroupMessageRequestTypeDef,
NodeGroupConfigurationTypeDef,
CustomerNodeEndpointTypeDef,
DecreaseNodeGroupsInGlobalReplicationGroupMessageRequestTypeDef,
DeleteCacheClusterMessageRequestTypeDef,
DeleteCacheParameterGroupMessageRequestTypeDef,
DeleteCacheSecurityGroupMessageRequestTypeDef,
DeleteCacheSubnetGroupMessageRequestTypeDef,
DeleteGlobalReplicationGroupMessageRequestTypeDef,
DeleteReplicationGroupMessageRequestTypeDef,
DeleteSnapshotMessageRequestTypeDef,
DeleteUserGroupMessageRequestTypeDef,
DeleteUserMessageRequestTypeDef,
WaiterConfigTypeDef,
PaginatorConfigTypeDef,
DescribeCacheClustersMessageRequestTypeDef,
DescribeCacheEngineVersionsMessageRequestTypeDef,
DescribeCacheParameterGroupsMessageRequestTypeDef,
DescribeCacheParametersMessageRequestTypeDef,
DescribeCacheSecurityGroupsMessageRequestTypeDef,
DescribeCacheSubnetGroupsMessageRequestTypeDef,
DescribeEngineDefaultParametersMessageRequestTypeDef,
DescribeEventsMessageRequestTypeDef,
DescribeGlobalReplicationGroupsMessageRequestTypeDef,
DescribeReplicationGroupsMessageRequestTypeDef,
DescribeReservedCacheNodesMessageRequestTypeDef,
DescribeReservedCacheNodesOfferingsMessageRequestTypeDef,
DescribeServiceUpdatesMessageRequestTypeDef,
DescribeSnapshotsMessageRequestTypeDef,
TimeRangeFilterTypeDef,
DescribeUserGroupsMessageRequestTypeDef,
FilterTypeDef,
KinesisFirehoseDestinationDetailsTypeDef,
DisassociateGlobalReplicationGroupMessageRequestTypeDef,
EventTypeDef,
FailoverGlobalReplicationGroupMessageRequestTypeDef,
GlobalNodeGroupTypeDef,
GlobalReplicationGroupInfoTypeDef,
GlobalReplicationGroupMemberTypeDef,
ListAllowedNodeTypeModificationsMessageRequestTypeDef,
ListTagsForResourceMessageRequestTypeDef,
ParameterNameValueTypeDef,
ModifyCacheSubnetGroupMessageRequestTypeDef,
ModifyGlobalReplicationGroupMessageRequestTypeDef,
ReshardingConfigurationTypeDef,
ModifyUserGroupMessageRequestTypeDef,
NodeGroupMemberUpdateStatusTypeDef,
ProcessedUpdateActionTypeDef,
RebalanceSlotsInGlobalReplicationGroupMessageRequestTypeDef,
RebootCacheClusterMessageRequestTypeDef,
RecurringChargeTypeDef,
RemoveTagsFromResourceMessageRequestTypeDef,
UserGroupsUpdateStatusTypeDef,
SlotMigrationTypeDef,
RevokeCacheSecurityGroupIngressMessageRequestTypeDef,
ServiceUpdateTypeDef,
SubnetOutpostTypeDef,
TestFailoverMessageRequestTypeDef,
UnprocessedUpdateActionTypeDef,
UserGroupPendingChangesTypeDef,
AddTagsToResourceMessageRequestTypeDef,
CopySnapshotMessageRequestTypeDef,
CreateCacheParameterGroupMessageRequestTypeDef,
CreateCacheSecurityGroupMessageRequestTypeDef,
CreateCacheSubnetGroupMessageRequestTypeDef,
CreateSnapshotMessageRequestTypeDef,
CreateUserGroupMessageRequestTypeDef,
PurchaseReservedCacheNodesOfferingMessageRequestTypeDef,
AllowedNodeTypeModificationsMessageTypeDef,
CacheParameterGroupNameMessageTypeDef,
EmptyResponseMetadataTypeDef,
TagListMessageTypeDef,
CreateUserMessageRequestTypeDef,
ModifyUserMessageRequestTypeDef,
UserResponseMetadataTypeDef,
UserTypeDef,
CacheNodeTypeDef,
NodeGroupMemberTypeDef,
CacheEngineVersionMessageTypeDef,
CacheNodeTypeSpecificParameterTypeDef,
CacheParameterGroupsMessageTypeDef,
CreateCacheParameterGroupResultTypeDef,
CacheSecurityGroupTypeDef,
DecreaseReplicaCountMessageRequestTypeDef,
IncreaseReplicaCountMessageRequestTypeDef,
NodeSnapshotTypeDef,
StartMigrationMessageRequestTypeDef,
DescribeCacheClustersMessageCacheClusterAvailableWaitTypeDef,
DescribeCacheClustersMessageCacheClusterDeletedWaitTypeDef,
DescribeReplicationGroupsMessageReplicationGroupAvailableWaitTypeDef,
DescribeReplicationGroupsMessageReplicationGroupDeletedWaitTypeDef,
DescribeCacheClustersMessageDescribeCacheClustersPaginateTypeDef,
DescribeCacheEngineVersionsMessageDescribeCacheEngineVersionsPaginateTypeDef,
DescribeCacheParameterGroupsMessageDescribeCacheParameterGroupsPaginateTypeDef,
DescribeCacheParametersMessageDescribeCacheParametersPaginateTypeDef,
DescribeCacheSecurityGroupsMessageDescribeCacheSecurityGroupsPaginateTypeDef,
DescribeCacheSubnetGroupsMessageDescribeCacheSubnetGroupsPaginateTypeDef,
DescribeEngineDefaultParametersMessageDescribeEngineDefaultParametersPaginateTypeDef,
DescribeEventsMessageDescribeEventsPaginateTypeDef,
DescribeGlobalReplicationGroupsMessageDescribeGlobalReplicationGroupsPaginateTypeDef,
DescribeReplicationGroupsMessageDescribeReplicationGroupsPaginateTypeDef,
DescribeReservedCacheNodesMessageDescribeReservedCacheNodesPaginateTypeDef,
DescribeReservedCacheNodesOfferingsMessageDescribeReservedCacheNodesOfferingsPaginateTypeDef,
DescribeServiceUpdatesMessageDescribeServiceUpdatesPaginateTypeDef,
DescribeSnapshotsMessageDescribeSnapshotsPaginateTypeDef,
DescribeUserGroupsMessageDescribeUserGroupsPaginateTypeDef,
DescribeUpdateActionsMessageDescribeUpdateActionsPaginateTypeDef,
DescribeUpdateActionsMessageRequestTypeDef,
DescribeUsersMessageDescribeUsersPaginateTypeDef,
DescribeUsersMessageRequestTypeDef,
DestinationDetailsTypeDef,
EventsMessageTypeDef,
GlobalReplicationGroupTypeDef,
ModifyCacheParameterGroupMessageRequestTypeDef,
ResetCacheParameterGroupMessageRequestTypeDef,
ModifyReplicationGroupShardConfigurationMessageRequestTypeDef,
RegionalConfigurationTypeDef,
NodeGroupUpdateStatusTypeDef,
ReservedCacheNodeTypeDef,
ReservedCacheNodesOfferingTypeDef,
ReshardingStatusTypeDef,
ServiceUpdatesMessageTypeDef,
SubnetTypeDef,
UpdateActionResultsMessageTypeDef,
UserGroupResponseMetadataTypeDef,
UserGroupTypeDef,
DescribeUsersResultTypeDef,
NodeGroupTypeDef,
CacheParameterGroupDetailsTypeDef,
EngineDefaultsTypeDef,
AuthorizeCacheSecurityGroupIngressResultTypeDef,
CacheSecurityGroupMessageTypeDef,
CreateCacheSecurityGroupResultTypeDef,
RevokeCacheSecurityGroupIngressResultTypeDef,
SnapshotTypeDef,
LogDeliveryConfigurationRequestTypeDef,
LogDeliveryConfigurationTypeDef,
PendingLogDeliveryConfigurationTypeDef,
CreateGlobalReplicationGroupResultTypeDef,
DecreaseNodeGroupsInGlobalReplicationGroupResultTypeDef,
DeleteGlobalReplicationGroupResultTypeDef,
DescribeGlobalReplicationGroupsResultTypeDef,
DisassociateGlobalReplicationGroupResultTypeDef,
FailoverGlobalReplicationGroupResultTypeDef,
IncreaseNodeGroupsInGlobalReplicationGroupResultTypeDef,
ModifyGlobalReplicationGroupResultTypeDef,
RebalanceSlotsInGlobalReplicationGroupResultTypeDef,
IncreaseNodeGroupsInGlobalReplicationGroupMessageRequestTypeDef,
UpdateActionTypeDef,
PurchaseReservedCacheNodesOfferingResultTypeDef,
ReservedCacheNodeMessageTypeDef,
ReservedCacheNodesOfferingMessageTypeDef,
CacheSubnetGroupTypeDef,
DescribeUserGroupsResultTypeDef,
DescribeEngineDefaultParametersResultTypeDef,
CopySnapshotResultTypeDef,
CreateSnapshotResultTypeDef,
DeleteSnapshotResultTypeDef,
DescribeSnapshotsListMessageTypeDef,
CreateCacheClusterMessageRequestTypeDef,
CreateReplicationGroupMessageRequestTypeDef,
ModifyCacheClusterMessageRequestTypeDef,
ModifyReplicationGroupMessageRequestTypeDef,
PendingModifiedValuesTypeDef,
ReplicationGroupPendingModifiedValuesTypeDef,
UpdateActionsMessageTypeDef,
CacheSubnetGroupMessageTypeDef,
CreateCacheSubnetGroupResultTypeDef,
ModifyCacheSubnetGroupResultTypeDef,
CacheClusterTypeDef,
ReplicationGroupTypeDef,
CacheClusterMessageTypeDef,
CreateCacheClusterResultTypeDef,
DeleteCacheClusterResultTypeDef,
ModifyCacheClusterResultTypeDef,
RebootCacheClusterResultTypeDef,
CompleteMigrationResponseTypeDef,
CreateReplicationGroupResultTypeDef,
DecreaseReplicaCountResultTypeDef,
DeleteReplicationGroupResultTypeDef,
IncreaseReplicaCountResultTypeDef,
ModifyReplicationGroupResultTypeDef,
ModifyReplicationGroupShardConfigurationResultTypeDef,
ReplicationGroupMessageTypeDef,
StartMigrationResponseTypeDef,
TestFailoverResultTypeDef,
)
def get_structure() -> TagTypeDef:
return {...}
```
## How it works
Fully automated
[mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder) carefully
generates type annotations for each service, patiently waiting for `boto3`
updates. It delivers a drop-in type annotations for you and makes sure that:
- All available `boto3` services are covered.
- Each public class and method of every `boto3` service gets valid type
annotations extracted from the documentation (blame `botocore` docs if types
are incorrect).
- Type annotations include up-to-date documentation.
- Link to documentation is provided for every method.
- Code is processed by [black](https://github.com/psf/black) and
[isort](https://github.com/PyCQA/isort) for readability.
## What's new
### Implemented features
- Fully type annotated `boto3`, `botocore` and `aiobotocore` libraries
- `mypy`, `pyright`, `VSCode`, `PyCharm`, `Sublime Text` and `Emacs`
compatibility
- `Client`, `ServiceResource`, `Resource`, `Waiter` `Paginator` type
annotations for each service
- Generated `TypeDefs` for each service
- Generated `Literals` for each service
- Auto discovery of types for `boto3.client` and `boto3.session` calls
- Auto discovery of types for `session.client` and `session.session` calls
- Auto discovery of types for `client.get_waiter` and `client.get_paginator`
calls
- Auto discovery of types for `ServiceResource` and `Resource` collections
- Auto discovery of types for `aiobotocore.Session.create_client` calls
### Latest changes
Builder changelog can be found in
[Releases](https://github.com/youtype/mypy_boto3_builder/releases).
## Versioning
`mypy-boto3-elasticache` version is the same as related `boto3` version and
follows [PEP 440](https://www.python.org/dev/peps/pep-0440/) format.
## Thank you
- [Allie Fitter](https://github.com/alliefitter) for
[boto3-type-annotations](https://pypi.org/project/boto3-type-annotations/),
this package is based on top of his work
- [black](https://github.com/psf/black) developers for an awesome formatting
tool
- [Timothy Edmund Crosley](https://github.com/timothycrosley) for
[isort](https://github.com/PyCQA/isort) and how flexible it is
- [mypy](https://github.com/python/mypy) developers for doing all dirty work
for us
- [pyright](https://github.com/microsoft/pyright) team for the new era of typed
Python
## Documentation
All services type annotations can be found in
[boto3 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_elasticache/)
## Support and contributing
This package is auto-generated. Please reports any bugs or request new features
in [mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder/issues/)
repository.
%prep
%autosetup -n mypy-boto3-elasticache-1.26.39
%build
%py3_build
%install
%py3_install
install -d -m755 %{buildroot}/%{_pkgdocdir}
if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
pushd %{buildroot}
if [ -d usr/lib ]; then
find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/lib64 ]; then
find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/bin ]; then
find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/sbin ]; then
find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst
fi
touch doclist.lst
if [ -d usr/share/man ]; then
find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst
fi
popd
mv %{buildroot}/filelist.lst .
mv %{buildroot}/doclist.lst .
%files -n python3-mypy-boto3-elasticache -f filelist.lst
%dir %{python3_sitelib}/*
%files help -f doclist.lst
%{_docdir}/*
%changelog
* Tue Apr 11 2023 Python_Bot - 1.26.39-1
- Package Spec generated