ElastiCache#
Client#
- class ElastiCache.Client#
A low-level client representing Amazon ElastiCache
Amazon ElastiCache is a web service that makes it easier to set up, operate, and scale a distributed cache in the cloud.
With ElastiCache, customers get all of the benefits of a high-performance, in-memory cache with less of the administrative burden involved in launching and managing a distributed cache. The service makes setup, scaling, and cluster failure handling much simpler than in a self-managed cache deployment.
In addition, through integration with Amazon CloudWatch, customers get enhanced visibility into the key performance statistics associated with their cache and can receive alarms if a part of their cache runs hot.
client = session.create_client('elasticache')
These are the available methods:
- add_tags_to_resource
- authorize_cache_security_group_ingress
- batch_apply_update_action
- batch_stop_update_action
- can_paginate
- close
- complete_migration
- copy_serverless_cache_snapshot
- copy_snapshot
- create_cache_cluster
- create_cache_parameter_group
- create_cache_security_group
- create_cache_subnet_group
- create_global_replication_group
- create_replication_group
- create_serverless_cache
- create_serverless_cache_snapshot
- create_snapshot
- create_user
- create_user_group
- decrease_node_groups_in_global_replication_group
- decrease_replica_count
- delete_cache_cluster
- delete_cache_parameter_group
- delete_cache_security_group
- delete_cache_subnet_group
- delete_global_replication_group
- delete_replication_group
- delete_serverless_cache
- delete_serverless_cache_snapshot
- delete_snapshot
- delete_user
- delete_user_group
- describe_cache_clusters
- describe_cache_engine_versions
- describe_cache_parameter_groups
- describe_cache_parameters
- describe_cache_security_groups
- describe_cache_subnet_groups
- describe_engine_default_parameters
- describe_events
- describe_global_replication_groups
- describe_replication_groups
- describe_reserved_cache_nodes
- describe_reserved_cache_nodes_offerings
- describe_serverless_cache_snapshots
- describe_serverless_caches
- describe_service_updates
- describe_snapshots
- describe_update_actions
- describe_user_groups
- describe_users
- disassociate_global_replication_group
- export_serverless_cache_snapshot
- failover_global_replication_group
- get_paginator
- get_waiter
- increase_node_groups_in_global_replication_group
- increase_replica_count
- list_allowed_node_type_modifications
- list_tags_for_resource
- modify_cache_cluster
- modify_cache_parameter_group
- modify_cache_subnet_group
- modify_global_replication_group
- modify_replication_group
- modify_replication_group_shard_configuration
- modify_serverless_cache
- modify_user
- modify_user_group
- purchase_reserved_cache_nodes_offering
- rebalance_slots_in_global_replication_group
- reboot_cache_cluster
- remove_tags_from_resource
- reset_cache_parameter_group
- revoke_cache_security_group_ingress
- start_migration
- test_failover
- test_migration
Client Exceptions#
Client exceptions are available on a client instance via the exceptions
property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.
The available client exceptions are:
- APICallRateForCustomerExceededFault
- AuthorizationAlreadyExistsFault
- AuthorizationNotFoundFault
- CacheClusterAlreadyExistsFault
- CacheClusterNotFoundFault
- CacheParameterGroupAlreadyExistsFault
- CacheParameterGroupNotFoundFault
- CacheParameterGroupQuotaExceededFault
- CacheSecurityGroupAlreadyExistsFault
- CacheSecurityGroupNotFoundFault
- CacheSecurityGroupQuotaExceededFault
- CacheSubnetGroupAlreadyExistsFault
- CacheSubnetGroupInUse
- CacheSubnetGroupNotFoundFault
- CacheSubnetGroupQuotaExceededFault
- CacheSubnetQuotaExceededFault
- ClusterQuotaForCustomerExceededFault
- DefaultUserAssociatedToUserGroupFault
- DefaultUserRequired
- DuplicateUserNameFault
- GlobalReplicationGroupAlreadyExistsFault
- GlobalReplicationGroupNotFoundFault
- InsufficientCacheClusterCapacityFault
- InvalidARNFault
- InvalidCacheClusterStateFault
- InvalidCacheParameterGroupStateFault
- InvalidCacheSecurityGroupStateFault
- InvalidCredentialsException
- InvalidGlobalReplicationGroupStateFault
- InvalidKMSKeyFault
- InvalidParameterCombinationException
- InvalidParameterValueException
- InvalidReplicationGroupStateFault
- InvalidServerlessCacheSnapshotStateFault
- InvalidServerlessCacheStateFault
- InvalidSnapshotStateFault
- InvalidSubnet
- InvalidUserGroupStateFault
- InvalidUserStateFault
- InvalidVPCNetworkStateFault
- NoOperationFault
- NodeGroupNotFoundFault
- NodeGroupsPerReplicationGroupQuotaExceededFault
- NodeQuotaForClusterExceededFault
- NodeQuotaForCustomerExceededFault
- ReplicationGroupAlreadyExistsFault
- ReplicationGroupAlreadyUnderMigrationFault
- ReplicationGroupNotFoundFault
- ReplicationGroupNotUnderMigrationFault
- ReservedCacheNodeAlreadyExistsFault
- ReservedCacheNodeNotFoundFault
- ReservedCacheNodeQuotaExceededFault
- ReservedCacheNodesOfferingNotFoundFault
- ServerlessCacheAlreadyExistsFault
- ServerlessCacheNotFoundFault
- ServerlessCacheQuotaForCustomerExceededFault
- ServerlessCacheSnapshotAlreadyExistsFault
- ServerlessCacheSnapshotNotFoundFault
- ServerlessCacheSnapshotQuotaExceededFault
- ServiceLinkedRoleNotFoundFault
- ServiceUpdateNotFoundFault
- SnapshotAlreadyExistsFault
- SnapshotFeatureNotSupportedFault
- SnapshotNotFoundFault
- SnapshotQuotaExceededFault
- SubnetInUse
- SubnetNotAllowedFault
- TagNotFoundFault
- TagQuotaPerResourceExceeded
- TestFailoverNotAvailableFault
- UserAlreadyExistsFault
- UserGroupAlreadyExistsFault
- UserGroupNotFoundFault
- UserGroupQuotaExceededFault
- UserNotFoundFault
- UserQuotaExceededFault
Paginators#
Paginators are available on a client instance via the get_paginator
method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide.
The available paginators are:
- DescribeCacheClusters
- DescribeCacheEngineVersions
- DescribeCacheParameterGroups
- DescribeCacheParameters
- DescribeCacheSecurityGroups
- DescribeCacheSubnetGroups
- DescribeEngineDefaultParameters
- DescribeEvents
- DescribeGlobalReplicationGroups
- DescribeReplicationGroups
- DescribeReservedCacheNodes
- DescribeReservedCacheNodesOfferings
- DescribeServerlessCacheSnapshots
- DescribeServerlessCaches
- DescribeServiceUpdates
- DescribeSnapshots
- DescribeUpdateActions
- DescribeUserGroups
- DescribeUsers
Waiters#
Waiters are available on a client instance via the get_waiter
method. For more detailed instructions and examples on the usage or waiters, see the waiters user guide.
The available waiters are: