ElastiCache module
Index > ElastiCache
Auto-generated documentation for ElastiCache type annotations stubs module types-aiobotocore-elasticache.
How to install
From PyPI with pip
Install types-aioboto3
for ElastiCache
service.
# install with aioboto3 type annotations
python -m pip install 'types-aioboto3[elasticache]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'types-aioboto3-lite[elasticache]'
# standalone installation
python -m pip install types-aiobotocore-elasticache
How to uninstall
Usage
Code samples can be found in Examples.
ElastiCacheClient
Type annotations and code completion for session.client("elasticache")
as ElastiCacheClient
boto3 documentation
Usage example
from aioboto3.session import Session
from types_aiobotocore_elasticache.client import ElastiCacheClient
session = Session()
async with session.client("elasticache") as client:
client: ElastiCacheClient
Paginators
Type annotations and code completion for
paginators
from session.client("elasticache").get_paginator("...")
.
Usage example
from types_aiobotocore_elasticache.paginator import DescribeCacheClustersPaginator
def get_describe_cache_clusters_paginator() -> DescribeCacheClustersPaginator:
return client.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 session.client("elasticache").get_waiter("...")
.
Usage example
from types_aiobotocore_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 schema.
Usage example
from types_aiobotocore_elasticache.literals import AZModeType
def get_value() -> AZModeType:
return "cross-az"
- 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
- LogDeliveryConfigurationStatusType
- LogFormatType
- LogTypeType
- MultiAZStatusType
- NodeUpdateInitiatedByType
- NodeUpdateStatusType
- OutpostModeType
- PendingAutomaticFailoverStatusType
- ReplicationGroupAvailableWaiterName
- ReplicationGroupDeletedWaiterName
- ServiceUpdateSeverityType
- ServiceUpdateStatusType
- ServiceUpdateTypeType
- SlaMetType
- SourceTypeType
- UpdateActionStatusType
- ElastiCacheServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- WaiterName
- RegionName
Typed dictionaries
Type annotations for typed dictionaries used in methods and schema.
Usage example
from types_aiobotocore_elasticache.type_defs import TagTypeDef
def get_value() -> TagTypeDef:
return {
"Key": ...,
}
- TagTypeDef
- ResponseMetadataTypeDef
- 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
- ModifyUserMessageRequestTypeDef
- NodeGroupMemberUpdateStatusTypeDef
- ProcessedUpdateActionTypeDef
- RebalanceSlotsInGlobalReplicationGroupMessageRequestTypeDef
- RebootCacheClusterMessageRequestTypeDef
- RecurringChargeTypeDef
- RemoveTagsFromResourceMessageRequestTypeDef
- UserGroupsUpdateStatusTypeDef
- SlotMigrationTypeDef
- RevokeCacheSecurityGroupIngressMessageRequestTypeDef
- ServiceUpdateTypeDef
- SubnetOutpostTypeDef
- TestFailoverMessageRequestTypeDef
- UnprocessedUpdateActionTypeDef
- UserGroupPendingChangesTypeDef
- AddTagsToResourceMessageRequestTypeDef
- CopySnapshotMessageRequestTypeDef
- CreateCacheParameterGroupMessageRequestTypeDef
- CreateCacheSecurityGroupMessageRequestTypeDef
- CreateCacheSubnetGroupMessageRequestTypeDef
- CreateSnapshotMessageRequestTypeDef
- CreateUserGroupMessageRequestTypeDef
- CreateUserMessageRequestTypeDef
- PurchaseReservedCacheNodesOfferingMessageRequestTypeDef
- AllowedNodeTypeModificationsMessageTypeDef
- CacheParameterGroupNameMessageTypeDef
- EmptyResponseMetadataTypeDef
- TagListMessageTypeDef
- 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