ElastiCache module#
Index > ElastiCache
Auto-generated documentation for ElastiCache type annotations stubs module mypy-boto3-elasticache.
How to install#
VSCode extension#
Add AWS Boto3
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.
# 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#
python -m pip uninstall -y mypy-boto3-elasticache
Usage#
Code samples can be found in Examples.
ElastiCacheClient#
Type annotations and code completion for boto3.client("elasticache")
as ElastiCacheClient
boto3 documentation
# ElastiCacheClient usage example
from boto3.session import Session
from mypy_boto3_elasticache.client import ElastiCacheClient
def get_client() -> ElastiCacheClient:
return Session().client("elasticache")
Paginators#
Type annotations and code completion for paginators
from boto3.client("elasticache").get_paginator("...")
.
# DescribeCacheClustersPaginator usage example
from boto3.session import Session
from mypy_boto3_elasticache.paginator import DescribeCacheClustersPaginator
def get_describe_cache_clusters_paginator() -> DescribeCacheClustersPaginator:
return Session().client("elasticache").get_paginator("describe_cache_clusters"))
- DescribeCacheClustersPaginator
- DescribeCacheEngineVersionsPaginator
- DescribeCacheParameterGroupsPaginator
- DescribeCacheParametersPaginator
- DescribeCacheSecurityGroupsPaginator
- DescribeCacheSubnetGroupsPaginator
- DescribeEngineDefaultParametersPaginator
- DescribeEventsPaginator
- DescribeGlobalReplicationGroupsPaginator
- DescribeReplicationGroupsPaginator
- DescribeReservedCacheNodesPaginator
- DescribeReservedCacheNodesOfferingsPaginator
- DescribeServiceUpdatesPaginator
- DescribeSnapshotsPaginator
- DescribeUpdateActionsPaginator
- DescribeUserGroupsPaginator
- DescribeUsersPaginator
Waiters#
Type annotations and code completion for waiters
from boto3.client("elasticache").get_waiter("...")
.
# CacheClusterAvailableWaiter usage example
from boto3.session import Session
from mypy_boto3_elasticache.waiter import CacheClusterAvailableWaiter
def get_cache_cluster_available_waiter() -> CacheClusterAvailableWaiter:
return Session().client("elasticache").get_waiter("cache_cluster_available")
- CacheClusterAvailableWaiter
- CacheClusterDeletedWaiter
- ReplicationGroupAvailableWaiter
- ReplicationGroupDeletedWaiter
Literals#
Type annotations for literals used in methods and schemas.
# AZModeType usage example
from mypy_boto3_elasticache.literals import AZModeType
def get_value() -> AZModeType:
return "cross-az"
- AZModeType
- AuthTokenUpdateStatusType
- AuthTokenUpdateStrategyTypeType
- AuthenticationTypeType
- AutomaticFailoverStatusType
- CacheClusterAvailableWaiterName
- CacheClusterDeletedWaiterName
- ChangeTypeType
- ClusterModeType
- 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
Typed dictionaries#
Type annotations for typed dictionaries used in methods and schema.
# TagTypeDef usage example
from mypy_boto3_elasticache.type_defs import TagTypeDef
def get_value() -> TagTypeDef:
return {
"Key": ...,
}
- TagTypeDef
- AllowedNodeTypeModificationsMessageTypeDef
- AuthenticationModeTypeDef
- AuthenticationTypeDef
- AuthorizeCacheSecurityGroupIngressMessageRequestTypeDef
- AvailabilityZoneTypeDef
- BatchApplyUpdateActionMessageRequestTypeDef
- BatchStopUpdateActionMessageRequestTypeDef
- CacheParameterGroupStatusTypeDef
- CacheSecurityGroupMembershipTypeDef
- EndpointTypeDef
- NotificationConfigurationTypeDef
- SecurityGroupMembershipTypeDef
- CacheEngineVersionTypeDef
- CacheNodeTypeSpecificValueTypeDef
- CacheNodeUpdateStatusTypeDef
- ParameterTypeDef
- CacheParameterGroupNameMessageTypeDef
- CacheParameterGroupTypeDef
- EC2SecurityGroupTypeDef
- CloudWatchLogsDestinationDetailsTypeDef
- CompleteMigrationMessageRequestTypeDef
- ConfigureShardTypeDef
- CreateGlobalReplicationGroupMessageRequestTypeDef
- NodeGroupConfigurationTypeDef
- CustomerNodeEndpointTypeDef
- DecreaseNodeGroupsInGlobalReplicationGroupMessageRequestTypeDef
- DeleteCacheClusterMessageRequestTypeDef
- DeleteCacheParameterGroupMessageRequestTypeDef
- DeleteCacheSecurityGroupMessageRequestTypeDef
- DeleteCacheSubnetGroupMessageRequestTypeDef
- DeleteGlobalReplicationGroupMessageRequestTypeDef
- DeleteReplicationGroupMessageRequestTypeDef
- DeleteSnapshotMessageRequestTypeDef
- DeleteUserGroupMessageRequestTypeDef
- DeleteUserMessageRequestTypeDef
- WaiterConfigTypeDef
- DescribeCacheClustersMessageDescribeCacheClustersPaginateTypeDef
- DescribeCacheClustersMessageRequestTypeDef
- DescribeCacheEngineVersionsMessageDescribeCacheEngineVersionsPaginateTypeDef
- DescribeCacheEngineVersionsMessageRequestTypeDef
- DescribeCacheParameterGroupsMessageDescribeCacheParameterGroupsPaginateTypeDef
- DescribeCacheParameterGroupsMessageRequestTypeDef
- DescribeCacheParametersMessageDescribeCacheParametersPaginateTypeDef
- DescribeCacheParametersMessageRequestTypeDef
- DescribeCacheSecurityGroupsMessageDescribeCacheSecurityGroupsPaginateTypeDef
- DescribeCacheSecurityGroupsMessageRequestTypeDef
- DescribeCacheSubnetGroupsMessageDescribeCacheSubnetGroupsPaginateTypeDef
- DescribeCacheSubnetGroupsMessageRequestTypeDef
- DescribeEngineDefaultParametersMessageDescribeEngineDefaultParametersPaginateTypeDef
- DescribeEngineDefaultParametersMessageRequestTypeDef
- DescribeEventsMessageDescribeEventsPaginateTypeDef
- DescribeEventsMessageRequestTypeDef
- DescribeGlobalReplicationGroupsMessageDescribeGlobalReplicationGroupsPaginateTypeDef
- DescribeGlobalReplicationGroupsMessageRequestTypeDef
- DescribeReplicationGroupsMessageDescribeReplicationGroupsPaginateTypeDef
- DescribeReplicationGroupsMessageRequestTypeDef
- DescribeReservedCacheNodesMessageDescribeReservedCacheNodesPaginateTypeDef
- DescribeReservedCacheNodesMessageRequestTypeDef
- DescribeReservedCacheNodesOfferingsMessageDescribeReservedCacheNodesOfferingsPaginateTypeDef
- DescribeReservedCacheNodesOfferingsMessageRequestTypeDef
- DescribeServiceUpdatesMessageDescribeServiceUpdatesPaginateTypeDef
- DescribeServiceUpdatesMessageRequestTypeDef
- DescribeSnapshotsMessageDescribeSnapshotsPaginateTypeDef
- DescribeSnapshotsMessageRequestTypeDef
- TimeRangeFilterTypeDef
- DescribeUserGroupsMessageDescribeUserGroupsPaginateTypeDef
- DescribeUserGroupsMessageRequestTypeDef
- FilterTypeDef
- KinesisFirehoseDestinationDetailsTypeDef
- DisassociateGlobalReplicationGroupMessageRequestTypeDef
- EmptyResponseMetadataTypeDef
- EventTypeDef
- FailoverGlobalReplicationGroupMessageRequestTypeDef
- GlobalNodeGroupTypeDef
- GlobalReplicationGroupInfoTypeDef
- GlobalReplicationGroupMemberTypeDef
- ListAllowedNodeTypeModificationsMessageRequestTypeDef
- ListTagsForResourceMessageRequestTypeDef
- ParameterNameValueTypeDef
- ModifyCacheSubnetGroupMessageRequestTypeDef
- ModifyGlobalReplicationGroupMessageRequestTypeDef
- ReshardingConfigurationTypeDef
- ModifyUserGroupMessageRequestTypeDef
- NodeGroupMemberUpdateStatusTypeDef
- PaginatorConfigTypeDef
- ProcessedUpdateActionTypeDef
- RebalanceSlotsInGlobalReplicationGroupMessageRequestTypeDef
- RebootCacheClusterMessageRequestTypeDef
- RecurringChargeTypeDef
- RemoveTagsFromResourceMessageRequestTypeDef
- UserGroupsUpdateStatusTypeDef
- SlotMigrationTypeDef
- ResponseMetadataTypeDef
- RevokeCacheSecurityGroupIngressMessageRequestTypeDef
- ServiceUpdateTypeDef
- SubnetOutpostTypeDef
- TestFailoverMessageRequestTypeDef
- UnprocessedUpdateActionTypeDef
- UserGroupPendingChangesTypeDef
- AddTagsToResourceMessageRequestTypeDef
- CopySnapshotMessageRequestTypeDef
- CreateCacheParameterGroupMessageRequestTypeDef
- CreateCacheSecurityGroupMessageRequestTypeDef
- CreateCacheSubnetGroupMessageRequestTypeDef
- CreateSnapshotMessageRequestTypeDef
- CreateUserGroupMessageRequestTypeDef
- PurchaseReservedCacheNodesOfferingMessageRequestTypeDef
- TagListMessageTypeDef
- CreateUserMessageRequestTypeDef
- ModifyUserMessageRequestTypeDef
- UserResponseMetadataTypeDef
- UserTypeDef
- CacheNodeTypeDef
- NodeGroupMemberTypeDef
- CacheEngineVersionMessageTypeDef
- CacheNodeTypeSpecificParameterTypeDef
- CacheParameterGroupsMessageTypeDef
- CreateCacheParameterGroupResultTypeDef
- CacheSecurityGroupTypeDef
- DecreaseReplicaCountMessageRequestTypeDef
- IncreaseReplicaCountMessageRequestTypeDef
- NodeSnapshotTypeDef
- StartMigrationMessageRequestTypeDef
- DescribeCacheClustersMessageCacheClusterAvailableWaitTypeDef
- DescribeCacheClustersMessageCacheClusterDeletedWaitTypeDef
- DescribeReplicationGroupsMessageReplicationGroupAvailableWaitTypeDef
- DescribeReplicationGroupsMessageReplicationGroupDeletedWaitTypeDef
- 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