Table of Contents
ElastiCache.Client¶A low-level client representing Amazon ElastiCache:
client = session.create_client('elasticache')
These are the available methods:
add_tags_to_resource()authorize_cache_security_group_ingress()can_paginate()copy_snapshot()create_cache_cluster()create_cache_parameter_group()create_cache_security_group()create_cache_subnet_group()create_replication_group()create_snapshot()delete_cache_cluster()delete_cache_parameter_group()delete_cache_security_group()delete_cache_subnet_group()delete_replication_group()delete_snapshot()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_replication_groups()describe_reserved_cache_nodes()describe_reserved_cache_nodes_offerings()describe_snapshots()generate_presigned_url()get_paginator()get_waiter()list_allowed_node_type_modifications()list_tags_for_resource()modify_cache_cluster()modify_cache_parameter_group()modify_cache_subnet_group()modify_replication_group()purchase_reserved_cache_nodes_offering()reboot_cache_cluster()remove_tags_from_resource()reset_cache_parameter_group()revoke_cache_security_group_ingress()test_failover()Adds up to 50 cost allocation tags to the named resource. A cost allocation tag is a key-value pair where the key and value are case-sensitive. You can use cost allocation tags to categorize and track your AWS costs.
When you apply tags to your ElastiCache resources, AWS generates a cost allocation report as a comma-separated value (CSV) file with your usage and costs aggregated by your tags. You can apply tags that represent business categories (such as cost centers, application names, or owners) to organize your costs across multiple services. For more information, see Using Cost Allocation Tags in Amazon ElastiCache in the ElastiCache User Guide .
See also: AWS API Documentation
Request Syntax
response = client.add_tags_to_resource(
ResourceName='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
|
Allows network ingress to a cache security group. Applications using ElastiCache must be running on Amazon EC2, and Amazon EC2 security groups are used as the authorization mechanism.
Note
You cannot authorize ingress from an Amazon EC2 security group in one region to an ElastiCache cluster in another region.
See also: AWS API Documentation
Request Syntax
response = client.authorize_cache_security_group_ingress(
CacheSecurityGroupName='string',
EC2SecurityGroupName='string',
EC2SecurityGroupOwnerId='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'CacheSecurityGroup': {
'OwnerId': 'string',
'CacheSecurityGroupName': 'string',
'Description': 'string',
'EC2SecurityGroups': [
{
'Status': 'string',
'EC2SecurityGroupName': 'string',
'EC2SecurityGroupOwnerId': 'string'
},
]
}
}
Response Structure
|
can_paginate(operation_name)¶Check if an operation can be paginated.
| Parameters: | operation_name (string) – The operation name. This is the same name
as the method name on the client. For example, if the
method name is create_foo, and you’d normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo"). |
|---|---|
| Returns: | True if the operation can be paginated,
False otherwise. |
copy_snapshot(**kwargs)¶Makes a copy of an existing snapshot.
Note
This operation is valid for Redis only.
Warning
Users or groups that have permissions to use the CopySnapshot operation can create their own Amazon S3 buckets and copy snapshots to it. To control access to your snapshots, use an IAM policy to control who has the ability to use the CopySnapshot operation. For more information about using IAM to control the use of ElastiCache operations, see Exporting Snapshots and Authentication Access Control .
You could receive the following error messages.
Error Messages
TargetSnapshotName a new and unique value. If exporting a snapshot, you could alternatively create a new Amazon S3 bucket and use this same value for TargetSnapshotName .See also: AWS API Documentation
Request Syntax
response = client.copy_snapshot(
SourceSnapshotName='string',
TargetSnapshotName='string',
TargetBucket='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'Snapshot': {
'SnapshotName': 'string',
'ReplicationGroupId': 'string',
'ReplicationGroupDescription': 'string',
'CacheClusterId': 'string',
'SnapshotStatus': 'string',
'SnapshotSource': 'string',
'CacheNodeType': 'string',
'Engine': 'string',
'EngineVersion': 'string',
'NumCacheNodes': 123,
'PreferredAvailabilityZone': 'string',
'CacheClusterCreateTime': datetime(2015, 1, 1),
'PreferredMaintenanceWindow': 'string',
'TopicArn': 'string',
'Port': 123,
'CacheParameterGroupName': 'string',
'CacheSubnetGroupName': 'string',
'VpcId': 'string',
'AutoMinorVersionUpgrade': True|False,
'SnapshotRetentionLimit': 123,
'SnapshotWindow': 'string',
'NumNodeGroups': 123,
'AutomaticFailover': 'enabled'|'disabled'|'enabling'|'disabling',
'NodeSnapshots': [
{
'CacheClusterId': 'string',
'NodeGroupId': 'string',
'CacheNodeId': 'string',
'NodeGroupConfiguration': {
'Slots': 'string',
'ReplicaCount': 123,
'PrimaryAvailabilityZone': 'string',
'ReplicaAvailabilityZones': [
'string',
]
},
'CacheSize': 'string',
'CacheNodeCreateTime': datetime(2015, 1, 1),
'SnapshotCreateTime': datetime(2015, 1, 1)
},
]
}
}
Response Structure
|
create_cache_cluster(**kwargs)¶Creates a cache cluster. All nodes in the cache cluster run the same protocol-compliant cache engine software, either Memcached or Redis.
Warning
Due to current limitations on Redis (cluster mode disabled), this operation or parameter is not supported on Redis (cluster mode enabled) replication groups.
See also: AWS API Documentation
Request Syntax
response = client.create_cache_cluster(
CacheClusterId='string',
ReplicationGroupId='string',
AZMode='single-az'|'cross-az',
PreferredAvailabilityZone='string',
PreferredAvailabilityZones=[
'string',
],
NumCacheNodes=123,
CacheNodeType='string',
Engine='string',
EngineVersion='string',
CacheParameterGroupName='string',
CacheSubnetGroupName='string',
CacheSecurityGroupNames=[
'string',
],
SecurityGroupIds=[
'string',
],
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
SnapshotArns=[
'string',
],
SnapshotName='string',
PreferredMaintenanceWindow='string',
Port=123,
NotificationTopicArn='string',
AutoMinorVersionUpgrade=True|False,
SnapshotRetentionLimit=123,
SnapshotWindow='string',
AuthToken='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'CacheCluster': {
'CacheClusterId': 'string',
'ConfigurationEndpoint': {
'Address': 'string',
'Port': 123
},
'ClientDownloadLandingPage': 'string',
'CacheNodeType': 'string',
'Engine': 'string',
'EngineVersion': 'string',
'CacheClusterStatus': 'string',
'NumCacheNodes': 123,
'PreferredAvailabilityZone': 'string',
'CacheClusterCreateTime': datetime(2015, 1, 1),
'PreferredMaintenanceWindow': 'string',
'PendingModifiedValues': {
'NumCacheNodes': 123,
'CacheNodeIdsToRemove': [
'string',
],
'EngineVersion': 'string',
'CacheNodeType': 'string'
},
'NotificationConfiguration': {
'TopicArn': 'string',
'TopicStatus': 'string'
},
'CacheSecurityGroups': [
{
'CacheSecurityGroupName': 'string',
'Status': 'string'
},
],
'CacheParameterGroup': {
'CacheParameterGroupName': 'string',
'ParameterApplyStatus': 'string',
'CacheNodeIdsToReboot': [
'string',
]
},
'CacheSubnetGroupName': 'string',
'CacheNodes': [
{
'CacheNodeId': 'string',
'CacheNodeStatus': 'string',
'CacheNodeCreateTime': datetime(2015, 1, 1),
'Endpoint': {
'Address': 'string',
'Port': 123
},
'ParameterGroupStatus': 'string',
'SourceCacheNodeId': 'string',
'CustomerAvailabilityZone': 'string'
},
],
'AutoMinorVersionUpgrade': True|False,
'SecurityGroups': [
{
'SecurityGroupId': 'string',
'Status': 'string'
},
],
'ReplicationGroupId': 'string',
'SnapshotRetentionLimit': 123,
'SnapshotWindow': 'string'
}
}
Response Structure
|
create_cache_parameter_group(**kwargs)¶Creates a new Amazon ElastiCache cache parameter group. An ElastiCache cache parameter group is a collection of parameters and their values that are applied to all of the nodes in any cache cluster or replication group using the CacheParameterGroup.
A newly created CacheParameterGroup is an exact duplicate of the default parameter group for the CacheParameterGroupFamily. To customize the newly created CacheParameterGroup you can change the values of specific parameters. For more information, see:
See also: AWS API Documentation
Request Syntax
response = client.create_cache_parameter_group(
CacheParameterGroupName='string',
CacheParameterGroupFamily='string',
Description='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'CacheParameterGroup': {
'CacheParameterGroupName': 'string',
'CacheParameterGroupFamily': 'string',
'Description': 'string'
}
}
Response Structure
|
create_cache_security_group(**kwargs)¶Creates a new cache security group. Use a cache security group to control access to one or more cache clusters.
Cache security groups are only used when you are creating a cache cluster outside of an Amazon Virtual Private Cloud (Amazon VPC). If you are creating a cache cluster inside of a VPC, use a cache subnet group instead. For more information, see CreateCacheSubnetGroup .
See also: AWS API Documentation
Request Syntax
response = client.create_cache_security_group(
CacheSecurityGroupName='string',
Description='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'CacheSecurityGroup': {
'OwnerId': 'string',
'CacheSecurityGroupName': 'string',
'Description': 'string',
'EC2SecurityGroups': [
{
'Status': 'string',
'EC2SecurityGroupName': 'string',
'EC2SecurityGroupOwnerId': 'string'
},
]
}
}
Response Structure
|
create_cache_subnet_group(**kwargs)¶Creates a new cache subnet group.
Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).
See also: AWS API Documentation
Request Syntax
response = client.create_cache_subnet_group(
CacheSubnetGroupName='string',
CacheSubnetGroupDescription='string',
SubnetIds=[
'string',
]
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'CacheSubnetGroup': {
'CacheSubnetGroupName': 'string',
'CacheSubnetGroupDescription': 'string',
'VpcId': 'string',
'Subnets': [
{
'SubnetIdentifier': 'string',
'SubnetAvailabilityZone': {
'Name': 'string'
}
},
]
}
}
Response Structure
|
create_replication_group(**kwargs)¶Creates a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group.
A Redis (cluster mode disabled) replication group is a collection of cache clusters, where one of the cache clusters is a read/write primary and the others are read-only replicas. Writes to the primary are asynchronously propagated to the replicas.
A Redis (cluster mode enabled) replication group is a collection of 1 to 15 node groups (shards). Each node group (shard) has one read/write primary node and up to 5 read-only replica nodes. Writes to the primary are asynchronously propagated to the replicas. Redis (cluster mode enabled) replication groups partition the data across node groups (shards).
When a Redis (cluster mode disabled) replication group has been successfully created, you can add one or more read replicas to it, up to a total of 5 read replicas. You cannot alter a Redis (cluster mode enabled) replication group after it has been created. However, if you need to increase or decrease the number of node groups (console: shards), you can avail yourself of ElastiCache for Redis’ enhanced backup and restore. For more information, see Restoring From a Backup with Cluster Resizing in the ElastiCache User Guide .
Note
This operation is valid for Redis only.
See also: AWS API Documentation
Request Syntax
response = client.create_replication_group(
ReplicationGroupId='string',
ReplicationGroupDescription='string',
PrimaryClusterId='string',
AutomaticFailoverEnabled=True|False,
NumCacheClusters=123,
PreferredCacheClusterAZs=[
'string',
],
NumNodeGroups=123,
ReplicasPerNodeGroup=123,
NodeGroupConfiguration=[
{
'Slots': 'string',
'ReplicaCount': 123,
'PrimaryAvailabilityZone': 'string',
'ReplicaAvailabilityZones': [
'string',
]
},
],
CacheNodeType='string',
Engine='string',
EngineVersion='string',
CacheParameterGroupName='string',
CacheSubnetGroupName='string',
CacheSecurityGroupNames=[
'string',
],
SecurityGroupIds=[
'string',
],
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
SnapshotArns=[
'string',
],
SnapshotName='string',
PreferredMaintenanceWindow='string',
Port=123,
NotificationTopicArn='string',
AutoMinorVersionUpgrade=True|False,
SnapshotRetentionLimit=123,
SnapshotWindow='string',
AuthToken='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'ReplicationGroup': {
'ReplicationGroupId': 'string',
'Description': 'string',
'Status': 'string',
'PendingModifiedValues': {
'PrimaryClusterId': 'string',
'AutomaticFailoverStatus': 'enabled'|'disabled'
},
'MemberClusters': [
'string',
],
'NodeGroups': [
{
'NodeGroupId': 'string',
'Status': 'string',
'PrimaryEndpoint': {
'Address': 'string',
'Port': 123
},
'Slots': 'string',
'NodeGroupMembers': [
{
'CacheClusterId': 'string',
'CacheNodeId': 'string',
'ReadEndpoint': {
'Address': 'string',
'Port': 123
},
'PreferredAvailabilityZone': 'string',
'CurrentRole': 'string'
},
]
},
],
'SnapshottingClusterId': 'string',
'AutomaticFailover': 'enabled'|'disabled'|'enabling'|'disabling',
'ConfigurationEndpoint': {
'Address': 'string',
'Port': 123
},
'SnapshotRetentionLimit': 123,
'SnapshotWindow': 'string',
'ClusterEnabled': True|False,
'CacheNodeType': 'string'
}
}
Response Structure
|
create_snapshot(**kwargs)¶Creates a copy of an entire cache cluster or replication group at a specific moment in time.
Note
This operation is valid for Redis only.
See also: AWS API Documentation
Request Syntax
response = client.create_snapshot(
ReplicationGroupId='string',
CacheClusterId='string',
SnapshotName='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'Snapshot': {
'SnapshotName': 'string',
'ReplicationGroupId': 'string',
'ReplicationGroupDescription': 'string',
'CacheClusterId': 'string',
'SnapshotStatus': 'string',
'SnapshotSource': 'string',
'CacheNodeType': 'string',
'Engine': 'string',
'EngineVersion': 'string',
'NumCacheNodes': 123,
'PreferredAvailabilityZone': 'string',
'CacheClusterCreateTime': datetime(2015, 1, 1),
'PreferredMaintenanceWindow': 'string',
'TopicArn': 'string',
'Port': 123,
'CacheParameterGroupName': 'string',
'CacheSubnetGroupName': 'string',
'VpcId': 'string',
'AutoMinorVersionUpgrade': True|False,
'SnapshotRetentionLimit': 123,
'SnapshotWindow': 'string',
'NumNodeGroups': 123,
'AutomaticFailover': 'enabled'|'disabled'|'enabling'|'disabling',
'NodeSnapshots': [
{
'CacheClusterId': 'string',
'NodeGroupId': 'string',
'CacheNodeId': 'string',
'NodeGroupConfiguration': {
'Slots': 'string',
'ReplicaCount': 123,
'PrimaryAvailabilityZone': 'string',
'ReplicaAvailabilityZones': [
'string',
]
},
'CacheSize': 'string',
'CacheNodeCreateTime': datetime(2015, 1, 1),
'SnapshotCreateTime': datetime(2015, 1, 1)
},
]
}
}
Response Structure
|
delete_cache_cluster(**kwargs)¶Deletes a previously provisioned cache cluster. DeleteCacheCluster deletes all associated cache nodes, node endpoints and the cache cluster itself. When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the cache cluster; you cannot cancel or revert this operation.
This operation cannot be used to delete a cache cluster that is the last read replica of a replication group or node group (shard) that has Multi-AZ mode enabled or a cache cluster from a Redis (cluster mode enabled) replication group.
Warning
Due to current limitations on Redis (cluster mode disabled), this operation or parameter is not supported on Redis (cluster mode enabled) replication groups.
See also: AWS API Documentation
Request Syntax
response = client.delete_cache_cluster(
CacheClusterId='string',
FinalSnapshotIdentifier='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'CacheCluster': {
'CacheClusterId': 'string',
'ConfigurationEndpoint': {
'Address': 'string',
'Port': 123
},
'ClientDownloadLandingPage': 'string',
'CacheNodeType': 'string',
'Engine': 'string',
'EngineVersion': 'string',
'CacheClusterStatus': 'string',
'NumCacheNodes': 123,
'PreferredAvailabilityZone': 'string',
'CacheClusterCreateTime': datetime(2015, 1, 1),
'PreferredMaintenanceWindow': 'string',
'PendingModifiedValues': {
'NumCacheNodes': 123,
'CacheNodeIdsToRemove': [
'string',
],
'EngineVersion': 'string',
'CacheNodeType': 'string'
},
'NotificationConfiguration': {
'TopicArn': 'string',
'TopicStatus': 'string'
},
'CacheSecurityGroups': [
{
'CacheSecurityGroupName': 'string',
'Status': 'string'
},
],
'CacheParameterGroup': {
'CacheParameterGroupName': 'string',
'ParameterApplyStatus': 'string',
'CacheNodeIdsToReboot': [
'string',
]
},
'CacheSubnetGroupName': 'string',
'CacheNodes': [
{
'CacheNodeId': 'string',
'CacheNodeStatus': 'string',
'CacheNodeCreateTime': datetime(2015, 1, 1),
'Endpoint': {
'Address': 'string',
'Port': 123
},
'ParameterGroupStatus': 'string',
'SourceCacheNodeId': 'string',
'CustomerAvailabilityZone': 'string'
},
],
'AutoMinorVersionUpgrade': True|False,
'SecurityGroups': [
{
'SecurityGroupId': 'string',
'Status': 'string'
},
],
'ReplicationGroupId': 'string',
'SnapshotRetentionLimit': 123,
'SnapshotWindow': 'string'
}
}
Response Structure
|
delete_cache_parameter_group(**kwargs)¶Deletes the specified cache parameter group. You cannot delete a cache parameter group if it is associated with any cache clusters.
See also: AWS API Documentation
Request Syntax
response = client.delete_cache_parameter_group(
CacheParameterGroupName='string'
)
| Parameters: | CacheParameterGroupName (string) – [REQUIRED] The name of the cache parameter group to delete. Note The specified cache security group must not be associated with any cache clusters. |
|---|---|
| Returns: | None |
delete_cache_security_group(**kwargs)¶Deletes a cache security group.
Note
You cannot delete a cache security group if it is associated with any cache clusters.
See also: AWS API Documentation
Request Syntax
response = client.delete_cache_security_group(
CacheSecurityGroupName='string'
)
| Parameters: | CacheSecurityGroupName (string) – [REQUIRED] The name of the cache security group to delete. Note You cannot delete the default security group. |
|---|---|
| Returns: | None |
delete_cache_subnet_group(**kwargs)¶Deletes a cache subnet group.
Note
You cannot delete a cache subnet group if it is associated with any cache clusters.
See also: AWS API Documentation
Request Syntax
response = client.delete_cache_subnet_group(
CacheSubnetGroupName='string'
)
| Parameters: | CacheSubnetGroupName (string) – [REQUIRED] The name of the cache subnet group to delete. Constraints: Must contain no more than 255 alphanumeric characters or hyphens. |
|---|---|
| Returns: | None |
delete_replication_group(**kwargs)¶Deletes an existing replication group. By default, this operation deletes the entire replication group, including the primary/primaries and all of the read replicas. If the replication group has only one primary, you can optionally delete only the read replicas, while retaining the primary by setting RetainPrimaryCluster=true .
When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the selected resources; you cannot cancel or revert this operation.
Note
This operation is valid for Redis only.
See also: AWS API Documentation
Request Syntax
response = client.delete_replication_group(
ReplicationGroupId='string',
RetainPrimaryCluster=True|False,
FinalSnapshotIdentifier='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'ReplicationGroup': {
'ReplicationGroupId': 'string',
'Description': 'string',
'Status': 'string',
'PendingModifiedValues': {
'PrimaryClusterId': 'string',
'AutomaticFailoverStatus': 'enabled'|'disabled'
},
'MemberClusters': [
'string',
],
'NodeGroups': [
{
'NodeGroupId': 'string',
'Status': 'string',
'PrimaryEndpoint': {
'Address': 'string',
'Port': 123
},
'Slots': 'string',
'NodeGroupMembers': [
{
'CacheClusterId': 'string',
'CacheNodeId': 'string',
'ReadEndpoint': {
'Address': 'string',
'Port': 123
},
'PreferredAvailabilityZone': 'string',
'CurrentRole': 'string'
},
]
},
],
'SnapshottingClusterId': 'string',
'AutomaticFailover': 'enabled'|'disabled'|'enabling'|'disabling',
'ConfigurationEndpoint': {
'Address': 'string',
'Port': 123
},
'SnapshotRetentionLimit': 123,
'SnapshotWindow': 'string',
'ClusterEnabled': True|False,
'CacheNodeType': 'string'
}
}
Response Structure
|
delete_snapshot(**kwargs)¶Deletes an existing snapshot. When you receive a successful response from this operation, ElastiCache immediately begins deleting the snapshot; you cannot cancel or revert this operation.
Note
This operation is valid for Redis only.
See also: AWS API Documentation
Request Syntax
response = client.delete_snapshot(
SnapshotName='string'
)
| Parameters: | SnapshotName (string) – [REQUIRED] The name of the snapshot to be deleted. |
|---|---|
| Return type: | dict |
| Returns: | Response Syntax{
'Snapshot': {
'SnapshotName': 'string',
'ReplicationGroupId': 'string',
'ReplicationGroupDescription': 'string',
'CacheClusterId': 'string',
'SnapshotStatus': 'string',
'SnapshotSource': 'string',
'CacheNodeType': 'string',
'Engine': 'string',
'EngineVersion': 'string',
'NumCacheNodes': 123,
'PreferredAvailabilityZone': 'string',
'CacheClusterCreateTime': datetime(2015, 1, 1),
'PreferredMaintenanceWindow': 'string',
'TopicArn': 'string',
'Port': 123,
'CacheParameterGroupName': 'string',
'CacheSubnetGroupName': 'string',
'VpcId': 'string',
'AutoMinorVersionUpgrade': True|False,
'SnapshotRetentionLimit': 123,
'SnapshotWindow': 'string',
'NumNodeGroups': 123,
'AutomaticFailover': 'enabled'|'disabled'|'enabling'|'disabling',
'NodeSnapshots': [
{
'CacheClusterId': 'string',
'NodeGroupId': 'string',
'CacheNodeId': 'string',
'NodeGroupConfiguration': {
'Slots': 'string',
'ReplicaCount': 123,
'PrimaryAvailabilityZone': 'string',
'ReplicaAvailabilityZones': [
'string',
]
},
'CacheSize': 'string',
'CacheNodeCreateTime': datetime(2015, 1, 1),
'SnapshotCreateTime': datetime(2015, 1, 1)
},
]
}
}
Response Structure
|
describe_cache_clusters(**kwargs)¶Returns information about all provisioned cache clusters if no cache cluster identifier is specified, or about a specific cache cluster if a cache cluster identifier is supplied.
By default, abbreviated information about the cache clusters is returned. You can use the optional ShowCacheNodeInfo flag to retrieve detailed information about the cache nodes associated with the cache clusters. These details include the DNS address and port for the cache node endpoint.
If the cluster is in the creating state, only cluster-level information is displayed until all of the nodes are successfully provisioned.
If the cluster is in the deleting state, only cluster-level information is displayed.
If cache nodes are currently being added to the cache cluster, node endpoint information and creation time for the additional nodes are not displayed until they are completely provisioned. When the cache cluster state is available , the cluster is ready for use.
If cache nodes are currently being removed from the cache cluster, no endpoint information for the removed nodes is displayed.
See also: AWS API Documentation
Request Syntax
response = client.describe_cache_clusters(
CacheClusterId='string',
MaxRecords=123,
Marker='string',
ShowCacheNodeInfo=True|False,
ShowCacheClustersNotInReplicationGroups=True|False
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'Marker': 'string',
'CacheClusters': [
{
'CacheClusterId': 'string',
'ConfigurationEndpoint': {
'Address': 'string',
'Port': 123
},
'ClientDownloadLandingPage': 'string',
'CacheNodeType': 'string',
'Engine': 'string',
'EngineVersion': 'string',
'CacheClusterStatus': 'string',
'NumCacheNodes': 123,
'PreferredAvailabilityZone': 'string',
'CacheClusterCreateTime': datetime(2015, 1, 1),
'PreferredMaintenanceWindow': 'string',
'PendingModifiedValues': {
'NumCacheNodes': 123,
'CacheNodeIdsToRemove': [
'string',
],
'EngineVersion': 'string',
'CacheNodeType': 'string'
},
'NotificationConfiguration': {
'TopicArn': 'string',
'TopicStatus': 'string'
},
'CacheSecurityGroups': [
{
'CacheSecurityGroupName': 'string',
'Status': 'string'
},
],
'CacheParameterGroup': {
'CacheParameterGroupName': 'string',
'ParameterApplyStatus': 'string',
'CacheNodeIdsToReboot': [
'string',
]
},
'CacheSubnetGroupName': 'string',
'CacheNodes': [
{
'CacheNodeId': 'string',
'CacheNodeStatus': 'string',
'CacheNodeCreateTime': datetime(2015, 1, 1),
'Endpoint': {
'Address': 'string',
'Port': 123
},
'ParameterGroupStatus': 'string',
'SourceCacheNodeId': 'string',
'CustomerAvailabilityZone': 'string'
},
],
'AutoMinorVersionUpgrade': True|False,
'SecurityGroups': [
{
'SecurityGroupId': 'string',
'Status': 'string'
},
],
'ReplicationGroupId': 'string',
'SnapshotRetentionLimit': 123,
'SnapshotWindow': 'string'
},
]
}
Response Structure
|
describe_cache_engine_versions(**kwargs)¶Returns a list of the available cache engines and their versions.
See also: AWS API Documentation
Request Syntax
response = client.describe_cache_engine_versions(
Engine='string',
EngineVersion='string',
CacheParameterGroupFamily='string',
MaxRecords=123,
Marker='string',
DefaultOnly=True|False
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'Marker': 'string',
'CacheEngineVersions': [
{
'Engine': 'string',
'EngineVersion': 'string',
'CacheParameterGroupFamily': 'string',
'CacheEngineDescription': 'string',
'CacheEngineVersionDescription': 'string'
},
]
}
Response Structure
|
describe_cache_parameter_groups(**kwargs)¶Returns a list of cache parameter group descriptions. If a cache parameter group name is specified, the list contains only the descriptions for that group.
See also: AWS API Documentation
Request Syntax
response = client.describe_cache_parameter_groups(
CacheParameterGroupName='string',
MaxRecords=123,
Marker='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'Marker': 'string',
'CacheParameterGroups': [
{
'CacheParameterGroupName': 'string',
'CacheParameterGroupFamily': 'string',
'Description': 'string'
},
]
}
Response Structure
|
describe_cache_parameters(**kwargs)¶Returns the detailed parameter list for a particular cache parameter group.
See also: AWS API Documentation
Request Syntax
response = client.describe_cache_parameters(
CacheParameterGroupName='string',
Source='string',
MaxRecords=123,
Marker='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'Marker': 'string',
'Parameters': [
{
'ParameterName': 'string',
'ParameterValue': 'string',
'Description': 'string',
'Source': 'string',
'DataType': 'string',
'AllowedValues': 'string',
'IsModifiable': True|False,
'MinimumEngineVersion': 'string',
'ChangeType': 'immediate'|'requires-reboot'
},
],
'CacheNodeTypeSpecificParameters': [
{
'ParameterName': 'string',
'Description': 'string',
'Source': 'string',
'DataType': 'string',
'AllowedValues': 'string',
'IsModifiable': True|False,
'MinimumEngineVersion': 'string',
'CacheNodeTypeSpecificValues': [
{
'CacheNodeType': 'string',
'Value': 'string'
},
],
'ChangeType': 'immediate'|'requires-reboot'
},
]
}
Response Structure
|
describe_cache_security_groups(**kwargs)¶Returns a list of cache security group descriptions. If a cache security group name is specified, the list contains only the description of that group.
See also: AWS API Documentation
Request Syntax
response = client.describe_cache_security_groups(
CacheSecurityGroupName='string',
MaxRecords=123,
Marker='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'Marker': 'string',
'CacheSecurityGroups': [
{
'OwnerId': 'string',
'CacheSecurityGroupName': 'string',
'Description': 'string',
'EC2SecurityGroups': [
{
'Status': 'string',
'EC2SecurityGroupName': 'string',
'EC2SecurityGroupOwnerId': 'string'
},
]
},
]
}
Response Structure
|
describe_cache_subnet_groups(**kwargs)¶Returns a list of cache subnet group descriptions. If a subnet group name is specified, the list contains only the description of that group.
See also: AWS API Documentation
Request Syntax
response = client.describe_cache_subnet_groups(
CacheSubnetGroupName='string',
MaxRecords=123,
Marker='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'Marker': 'string',
'CacheSubnetGroups': [
{
'CacheSubnetGroupName': 'string',
'CacheSubnetGroupDescription': 'string',
'VpcId': 'string',
'Subnets': [
{
'SubnetIdentifier': 'string',
'SubnetAvailabilityZone': {
'Name': 'string'
}
},
]
},
]
}
Response Structure
|
describe_engine_default_parameters(**kwargs)¶Returns the default engine and system parameter information for the specified cache engine.
See also: AWS API Documentation
Request Syntax
response = client.describe_engine_default_parameters(
CacheParameterGroupFamily='string',
MaxRecords=123,
Marker='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'EngineDefaults': {
'CacheParameterGroupFamily': 'string',
'Marker': 'string',
'Parameters': [
{
'ParameterName': 'string',
'ParameterValue': 'string',
'Description': 'string',
'Source': 'string',
'DataType': 'string',
'AllowedValues': 'string',
'IsModifiable': True|False,
'MinimumEngineVersion': 'string',
'ChangeType': 'immediate'|'requires-reboot'
},
],
'CacheNodeTypeSpecificParameters': [
{
'ParameterName': 'string',
'Description': 'string',
'Source': 'string',
'DataType': 'string',
'AllowedValues': 'string',
'IsModifiable': True|False,
'MinimumEngineVersion': 'string',
'CacheNodeTypeSpecificValues': [
{
'CacheNodeType': 'string',
'Value': 'string'
},
],
'ChangeType': 'immediate'|'requires-reboot'
},
]
}
}
Response Structure
|
describe_events(**kwargs)¶Returns events related to cache clusters, cache security groups, and cache parameter groups. You can obtain events specific to a particular cache cluster, cache security group, or cache parameter group by providing the name as a parameter.
By default, only the events occurring within the last hour are returned; however, you can retrieve up to 14 days’ worth of events if necessary.
See also: AWS API Documentation
Request Syntax
response = client.describe_events(
SourceIdentifier='string',
SourceType='cache-cluster'|'cache-parameter-group'|'cache-security-group'|'cache-subnet-group'|'replication-group',
StartTime=datetime(2015, 1, 1),
EndTime=datetime(2015, 1, 1),
Duration=123,
MaxRecords=123,
Marker='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'Marker': 'string',
'Events': [
{
'SourceIdentifier': 'string',
'SourceType': 'cache-cluster'|'cache-parameter-group'|'cache-security-group'|'cache-subnet-group'|'replication-group',
'Message': 'string',
'Date': datetime(2015, 1, 1)
},
]
}
Response Structure
|
describe_replication_groups(**kwargs)¶Returns information about a particular replication group. If no identifier is specified, DescribeReplicationGroups returns information about all replication groups.
Note
This operation is valid for Redis only.
See also: AWS API Documentation
Request Syntax
response = client.describe_replication_groups(
ReplicationGroupId='string',
MaxRecords=123,
Marker='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'Marker': 'string',
'ReplicationGroups': [
{
'ReplicationGroupId': 'string',
'Description': 'string',
'Status': 'string',
'PendingModifiedValues': {
'PrimaryClusterId': 'string',
'AutomaticFailoverStatus': 'enabled'|'disabled'
},
'MemberClusters': [
'string',
],
'NodeGroups': [
{
'NodeGroupId': 'string',
'Status': 'string',
'PrimaryEndpoint': {
'Address': 'string',
'Port': 123
},
'Slots': 'string',
'NodeGroupMembers': [
{
'CacheClusterId': 'string',
'CacheNodeId': 'string',
'ReadEndpoint': {
'Address': 'string',
'Port': 123
},
'PreferredAvailabilityZone': 'string',
'CurrentRole': 'string'
},
]
},
],
'SnapshottingClusterId': 'string',
'AutomaticFailover': 'enabled'|'disabled'|'enabling'|'disabling',
'ConfigurationEndpoint': {
'Address': 'string',
'Port': 123
},
'SnapshotRetentionLimit': 123,
'SnapshotWindow': 'string',
'ClusterEnabled': True|False,
'CacheNodeType': 'string'
},
]
}
Response Structure
|
describe_reserved_cache_nodes(**kwargs)¶Returns information about reserved cache nodes for this account, or about a specified reserved cache node.
See also: AWS API Documentation
Request Syntax
response = client.describe_reserved_cache_nodes(
ReservedCacheNodeId='string',
ReservedCacheNodesOfferingId='string',
CacheNodeType='string',
Duration='string',
ProductDescription='string',
OfferingType='string',
MaxRecords=123,
Marker='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'Marker': 'string',
'ReservedCacheNodes': [
{
'ReservedCacheNodeId': 'string',
'ReservedCacheNodesOfferingId': 'string',
'CacheNodeType': 'string',
'StartTime': datetime(2015, 1, 1),
'Duration': 123,
'FixedPrice': 123.0,
'UsagePrice': 123.0,
'CacheNodeCount': 123,
'ProductDescription': 'string',
'OfferingType': 'string',
'State': 'string',
'RecurringCharges': [
{
'RecurringChargeAmount': 123.0,
'RecurringChargeFrequency': 'string'
},
]
},
]
}
Response Structure
|
describe_reserved_cache_nodes_offerings(**kwargs)¶Lists available reserved cache node offerings.
See also: AWS API Documentation
Request Syntax
response = client.describe_reserved_cache_nodes_offerings(
ReservedCacheNodesOfferingId='string',
CacheNodeType='string',
Duration='string',
ProductDescription='string',
OfferingType='string',
MaxRecords=123,
Marker='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'Marker': 'string',
'ReservedCacheNodesOfferings': [
{
'ReservedCacheNodesOfferingId': 'string',
'CacheNodeType': 'string',
'Duration': 123,
'FixedPrice': 123.0,
'UsagePrice': 123.0,
'ProductDescription': 'string',
'OfferingType': 'string',
'RecurringCharges': [
{
'RecurringChargeAmount': 123.0,
'RecurringChargeFrequency': 'string'
},
]
},
]
}
Response Structure
|
describe_snapshots(**kwargs)¶Returns information about cache cluster or replication group snapshots. By default, DescribeSnapshots lists all of your snapshots; it can optionally describe a single snapshot, or just the snapshots associated with a particular cache cluster.
Note
This operation is valid for Redis only.
See also: AWS API Documentation
Request Syntax
response = client.describe_snapshots(
ReplicationGroupId='string',
CacheClusterId='string',
SnapshotName='string',
SnapshotSource='string',
Marker='string',
MaxRecords=123,
ShowNodeGroupConfig=True|False
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'Marker': 'string',
'Snapshots': [
{
'SnapshotName': 'string',
'ReplicationGroupId': 'string',
'ReplicationGroupDescription': 'string',
'CacheClusterId': 'string',
'SnapshotStatus': 'string',
'SnapshotSource': 'string',
'CacheNodeType': 'string',
'Engine': 'string',
'EngineVersion': 'string',
'NumCacheNodes': 123,
'PreferredAvailabilityZone': 'string',
'CacheClusterCreateTime': datetime(2015, 1, 1),
'PreferredMaintenanceWindow': 'string',
'TopicArn': 'string',
'Port': 123,
'CacheParameterGroupName': 'string',
'CacheSubnetGroupName': 'string',
'VpcId': 'string',
'AutoMinorVersionUpgrade': True|False,
'SnapshotRetentionLimit': 123,
'SnapshotWindow': 'string',
'NumNodeGroups': 123,
'AutomaticFailover': 'enabled'|'disabled'|'enabling'|'disabling',
'NodeSnapshots': [
{
'CacheClusterId': 'string',
'NodeGroupId': 'string',
'CacheNodeId': 'string',
'NodeGroupConfiguration': {
'Slots': 'string',
'ReplicaCount': 123,
'PrimaryAvailabilityZone': 'string',
'ReplicaAvailabilityZones': [
'string',
]
},
'CacheSize': 'string',
'CacheNodeCreateTime': datetime(2015, 1, 1),
'SnapshotCreateTime': datetime(2015, 1, 1)
},
]
},
]
}
Response Structure
|
generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)¶Generate a presigned url given a client, its method, and arguments
| Parameters: |
|
|---|---|
| Returns: | The presigned url |
get_paginator(operation_name)¶Create a paginator for an operation.
| Parameters: | operation_name (string) – The operation name. This is the same name
as the method name on the client. For example, if the
method name is create_foo, and you’d normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo"). |
|---|---|
| Raises: | OperationNotPageableError – Raised if the operation is not
pageable. You can use the client.can_paginate method to
check if an operation is pageable. |
| Return type: | L{botocore.paginate.Paginator} |
| Returns: | A paginator object. |
get_waiter(waiter_name)¶list_allowed_node_type_modifications(**kwargs)¶Lists all available node types that you can scale your Redis cluster’s or replication group’s current node type up to.
When you use the ModifyCacheCluster or ModifyReplicationGroup operations to scale up your cluster or replication group, the value of the CacheNodeType parameter must be one of the node types returned by this operation.
See also: AWS API Documentation
Request Syntax
response = client.list_allowed_node_type_modifications(
CacheClusterId='string',
ReplicationGroupId='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'ScaleUpModifications': [
'string',
]
}
Response Structure
|
Lists all cost allocation tags currently on the named resource. A cost allocation tag is a key-value pair where the key is case-sensitive and the value is optional. You can use cost allocation tags to categorize and track your AWS costs.
You can have a maximum of 50 cost allocation tags on an ElastiCache resource. For more information, see Using Cost Allocation Tags in Amazon ElastiCache .
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
ResourceName='string'
)
| Parameters: | ResourceName (string) – [REQUIRED] The Amazon Resource Name (ARN) of the resource for which you want the list of tags, for example For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces . |
|---|---|
| Return type: | dict |
| Returns: | Response Syntax{
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
|
modify_cache_cluster(**kwargs)¶Modifies the settings for a cache cluster. You can use this operation to change one or more cluster configuration parameters by specifying the parameters and the new values.
See also: AWS API Documentation
Request Syntax
response = client.modify_cache_cluster(
CacheClusterId='string',
NumCacheNodes=123,
CacheNodeIdsToRemove=[
'string',
],
AZMode='single-az'|'cross-az',
NewAvailabilityZones=[
'string',
],
CacheSecurityGroupNames=[
'string',
],
SecurityGroupIds=[
'string',
],
PreferredMaintenanceWindow='string',
NotificationTopicArn='string',
CacheParameterGroupName='string',
NotificationTopicStatus='string',
ApplyImmediately=True|False,
EngineVersion='string',
AutoMinorVersionUpgrade=True|False,
SnapshotRetentionLimit=123,
SnapshotWindow='string',
CacheNodeType='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'CacheCluster': {
'CacheClusterId': 'string',
'ConfigurationEndpoint': {
'Address': 'string',
'Port': 123
},
'ClientDownloadLandingPage': 'string',
'CacheNodeType': 'string',
'Engine': 'string',
'EngineVersion': 'string',
'CacheClusterStatus': 'string',
'NumCacheNodes': 123,
'PreferredAvailabilityZone': 'string',
'CacheClusterCreateTime': datetime(2015, 1, 1),
'PreferredMaintenanceWindow': 'string',
'PendingModifiedValues': {
'NumCacheNodes': 123,
'CacheNodeIdsToRemove': [
'string',
],
'EngineVersion': 'string',
'CacheNodeType': 'string'
},
'NotificationConfiguration': {
'TopicArn': 'string',
'TopicStatus': 'string'
},
'CacheSecurityGroups': [
{
'CacheSecurityGroupName': 'string',
'Status': 'string'
},
],
'CacheParameterGroup': {
'CacheParameterGroupName': 'string',
'ParameterApplyStatus': 'string',
'CacheNodeIdsToReboot': [
'string',
]
},
'CacheSubnetGroupName': 'string',
'CacheNodes': [
{
'CacheNodeId': 'string',
'CacheNodeStatus': 'string',
'CacheNodeCreateTime': datetime(2015, 1, 1),
'Endpoint': {
'Address': 'string',
'Port': 123
},
'ParameterGroupStatus': 'string',
'SourceCacheNodeId': 'string',
'CustomerAvailabilityZone': 'string'
},
],
'AutoMinorVersionUpgrade': True|False,
'SecurityGroups': [
{
'SecurityGroupId': 'string',
'Status': 'string'
},
],
'ReplicationGroupId': 'string',
'SnapshotRetentionLimit': 123,
'SnapshotWindow': 'string'
}
}
Response Structure
|
modify_cache_parameter_group(**kwargs)¶Modifies the parameters of a cache parameter group. You can modify up to 20 parameters in a single request by submitting a list parameter name and value pairs.
See also: AWS API Documentation
Request Syntax
response = client.modify_cache_parameter_group(
CacheParameterGroupName='string',
ParameterNameValues=[
{
'ParameterName': 'string',
'ParameterValue': 'string'
},
]
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'CacheParameterGroupName': 'string'
}
Response Structure
|
modify_cache_subnet_group(**kwargs)¶Modifies an existing cache subnet group.
See also: AWS API Documentation
Request Syntax
response = client.modify_cache_subnet_group(
CacheSubnetGroupName='string',
CacheSubnetGroupDescription='string',
SubnetIds=[
'string',
]
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'CacheSubnetGroup': {
'CacheSubnetGroupName': 'string',
'CacheSubnetGroupDescription': 'string',
'VpcId': 'string',
'Subnets': [
{
'SubnetIdentifier': 'string',
'SubnetAvailabilityZone': {
'Name': 'string'
}
},
]
}
}
Response Structure
|
modify_replication_group(**kwargs)¶Modifies the settings for a replication group.
Warning
Due to current limitations on Redis (cluster mode disabled), this operation or parameter is not supported on Redis (cluster mode enabled) replication groups.
Note
This operation is valid for Redis only.
See also: AWS API Documentation
Request Syntax
response = client.modify_replication_group(
ReplicationGroupId='string',
ReplicationGroupDescription='string',
PrimaryClusterId='string',
SnapshottingClusterId='string',
AutomaticFailoverEnabled=True|False,
CacheSecurityGroupNames=[
'string',
],
SecurityGroupIds=[
'string',
],
PreferredMaintenanceWindow='string',
NotificationTopicArn='string',
CacheParameterGroupName='string',
NotificationTopicStatus='string',
ApplyImmediately=True|False,
EngineVersion='string',
AutoMinorVersionUpgrade=True|False,
SnapshotRetentionLimit=123,
SnapshotWindow='string',
CacheNodeType='string',
NodeGroupId='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'ReplicationGroup': {
'ReplicationGroupId': 'string',
'Description': 'string',
'Status': 'string',
'PendingModifiedValues': {
'PrimaryClusterId': 'string',
'AutomaticFailoverStatus': 'enabled'|'disabled'
},
'MemberClusters': [
'string',
],
'NodeGroups': [
{
'NodeGroupId': 'string',
'Status': 'string',
'PrimaryEndpoint': {
'Address': 'string',
'Port': 123
},
'Slots': 'string',
'NodeGroupMembers': [
{
'CacheClusterId': 'string',
'CacheNodeId': 'string',
'ReadEndpoint': {
'Address': 'string',
'Port': 123
},
'PreferredAvailabilityZone': 'string',
'CurrentRole': 'string'
},
]
},
],
'SnapshottingClusterId': 'string',
'AutomaticFailover': 'enabled'|'disabled'|'enabling'|'disabling',
'ConfigurationEndpoint': {
'Address': 'string',
'Port': 123
},
'SnapshotRetentionLimit': 123,
'SnapshotWindow': 'string',
'ClusterEnabled': True|False,
'CacheNodeType': 'string'
}
}
Response Structure
|
purchase_reserved_cache_nodes_offering(**kwargs)¶Allows you to purchase a reserved cache node offering.
See also: AWS API Documentation
Request Syntax
response = client.purchase_reserved_cache_nodes_offering(
ReservedCacheNodesOfferingId='string',
ReservedCacheNodeId='string',
CacheNodeCount=123
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'ReservedCacheNode': {
'ReservedCacheNodeId': 'string',
'ReservedCacheNodesOfferingId': 'string',
'CacheNodeType': 'string',
'StartTime': datetime(2015, 1, 1),
'Duration': 123,
'FixedPrice': 123.0,
'UsagePrice': 123.0,
'CacheNodeCount': 123,
'ProductDescription': 'string',
'OfferingType': 'string',
'State': 'string',
'RecurringCharges': [
{
'RecurringChargeAmount': 123.0,
'RecurringChargeFrequency': 'string'
},
]
}
}
Response Structure
|
reboot_cache_cluster(**kwargs)¶Reboots some, or all, of the cache nodes within a provisioned cache cluster. This operation applies any modified cache parameter groups to the cache cluster. The reboot operation takes place as soon as possible, and results in a momentary outage to the cache cluster. During the reboot, the cache cluster status is set to REBOOTING.
The reboot causes the contents of the cache (for each cache node being rebooted) to be lost.
When the reboot is complete, a cache cluster event is created.
See also: AWS API Documentation
Request Syntax
response = client.reboot_cache_cluster(
CacheClusterId='string',
CacheNodeIdsToReboot=[
'string',
]
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'CacheCluster': {
'CacheClusterId': 'string',
'ConfigurationEndpoint': {
'Address': 'string',
'Port': 123
},
'ClientDownloadLandingPage': 'string',
'CacheNodeType': 'string',
'Engine': 'string',
'EngineVersion': 'string',
'CacheClusterStatus': 'string',
'NumCacheNodes': 123,
'PreferredAvailabilityZone': 'string',
'CacheClusterCreateTime': datetime(2015, 1, 1),
'PreferredMaintenanceWindow': 'string',
'PendingModifiedValues': {
'NumCacheNodes': 123,
'CacheNodeIdsToRemove': [
'string',
],
'EngineVersion': 'string',
'CacheNodeType': 'string'
},
'NotificationConfiguration': {
'TopicArn': 'string',
'TopicStatus': 'string'
},
'CacheSecurityGroups': [
{
'CacheSecurityGroupName': 'string',
'Status': 'string'
},
],
'CacheParameterGroup': {
'CacheParameterGroupName': 'string',
'ParameterApplyStatus': 'string',
'CacheNodeIdsToReboot': [
'string',
]
},
'CacheSubnetGroupName': 'string',
'CacheNodes': [
{
'CacheNodeId': 'string',
'CacheNodeStatus': 'string',
'CacheNodeCreateTime': datetime(2015, 1, 1),
'Endpoint': {
'Address': 'string',
'Port': 123
},
'ParameterGroupStatus': 'string',
'SourceCacheNodeId': 'string',
'CustomerAvailabilityZone': 'string'
},
],
'AutoMinorVersionUpgrade': True|False,
'SecurityGroups': [
{
'SecurityGroupId': 'string',
'Status': 'string'
},
],
'ReplicationGroupId': 'string',
'SnapshotRetentionLimit': 123,
'SnapshotWindow': 'string'
}
}
Response Structure
|
Removes the tags identified by the TagKeys list from the named resource.
See also: AWS API Documentation
Request Syntax
response = client.remove_tags_from_resource(
ResourceName='string',
TagKeys=[
'string',
]
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
|
reset_cache_parameter_group(**kwargs)¶Modifies the parameters of a cache parameter group to the engine or system default value. You can reset specific parameters by submitting a list of parameter names. To reset the entire cache parameter group, specify the ResetAllParameters and CacheParameterGroupName parameters.
See also: AWS API Documentation
Request Syntax
response = client.reset_cache_parameter_group(
CacheParameterGroupName='string',
ResetAllParameters=True|False,
ParameterNameValues=[
{
'ParameterName': 'string',
'ParameterValue': 'string'
},
]
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'CacheParameterGroupName': 'string'
}
Response Structure
|
revoke_cache_security_group_ingress(**kwargs)¶Revokes ingress from a cache security group. Use this operation to disallow access from an Amazon EC2 security group that had been previously authorized.
See also: AWS API Documentation
Request Syntax
response = client.revoke_cache_security_group_ingress(
CacheSecurityGroupName='string',
EC2SecurityGroupName='string',
EC2SecurityGroupOwnerId='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'CacheSecurityGroup': {
'OwnerId': 'string',
'CacheSecurityGroupName': 'string',
'Description': 'string',
'EC2SecurityGroups': [
{
'Status': 'string',
'EC2SecurityGroupName': 'string',
'EC2SecurityGroupOwnerId': 'string'
},
]
}
}
Response Structure
|
test_failover(**kwargs)¶Represents the input of a TestFailover operation which test automatic failover on a specified node group (called shard in the console) in a replication group (called cluster in the console).
Note the following
Test Failover API called for node group node-group-idFailover from master node primary-node-idto replica node node-idcompletedFailover from master node primary-node-idto replica node node-idcompletedRecovering cache nodes node-idFinished recovery for cache nodes node-idFor more information see:
- Viewing ElastiCache Events in the ElastiCache User Guide
- DescribeEvents in the ElastiCache API Reference
Also see, Testing Multi-AZ with Automatic Failover in the ElastiCache User Guide .
See also: AWS API Documentation
Request Syntax
response = client.test_failover(
ReplicationGroupId='string',
NodeGroupId='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'ReplicationGroup': {
'ReplicationGroupId': 'string',
'Description': 'string',
'Status': 'string',
'PendingModifiedValues': {
'PrimaryClusterId': 'string',
'AutomaticFailoverStatus': 'enabled'|'disabled'
},
'MemberClusters': [
'string',
],
'NodeGroups': [
{
'NodeGroupId': 'string',
'Status': 'string',
'PrimaryEndpoint': {
'Address': 'string',
'Port': 123
},
'Slots': 'string',
'NodeGroupMembers': [
{
'CacheClusterId': 'string',
'CacheNodeId': 'string',
'ReadEndpoint': {
'Address': 'string',
'Port': 123
},
'PreferredAvailabilityZone': 'string',
'CurrentRole': 'string'
},
]
},
],
'SnapshottingClusterId': 'string',
'AutomaticFailover': 'enabled'|'disabled'|'enabling'|'disabling',
'ConfigurationEndpoint': {
'Address': 'string',
'Port': 123
},
'SnapshotRetentionLimit': 123,
'SnapshotWindow': 'string',
'ClusterEnabled': True|False,
'CacheNodeType': 'string'
}
}
Response Structure
|
The available paginators are:
ElastiCache.Paginator.DescribeCacheClustersElastiCache.Paginator.DescribeCacheEngineVersionsElastiCache.Paginator.DescribeCacheParameterGroupsElastiCache.Paginator.DescribeCacheParametersElastiCache.Paginator.DescribeCacheSecurityGroupsElastiCache.Paginator.DescribeCacheSubnetGroupsElastiCache.Paginator.DescribeEngineDefaultParametersElastiCache.Paginator.DescribeEventsElastiCache.Paginator.DescribeReplicationGroupsElastiCache.Paginator.DescribeReservedCacheNodesElastiCache.Paginator.DescribeReservedCacheNodesOfferingsElastiCache.Paginator.DescribeSnapshotsElastiCache.Paginator.DescribeCacheClusters¶paginator = client.get_paginator('describe_cache_clusters')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from ElastiCache.Client.describe_cache_clusters().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
CacheClusterId='string',
ShowCacheNodeInfo=True|False,
ShowCacheClustersNotInReplicationGroups=True|False,
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'CacheClusters': [
{
'CacheClusterId': 'string',
'ConfigurationEndpoint': {
'Address': 'string',
'Port': 123
},
'ClientDownloadLandingPage': 'string',
'CacheNodeType': 'string',
'Engine': 'string',
'EngineVersion': 'string',
'CacheClusterStatus': 'string',
'NumCacheNodes': 123,
'PreferredAvailabilityZone': 'string',
'CacheClusterCreateTime': datetime(2015, 1, 1),
'PreferredMaintenanceWindow': 'string',
'PendingModifiedValues': {
'NumCacheNodes': 123,
'CacheNodeIdsToRemove': [
'string',
],
'EngineVersion': 'string',
'CacheNodeType': 'string'
},
'NotificationConfiguration': {
'TopicArn': 'string',
'TopicStatus': 'string'
},
'CacheSecurityGroups': [
{
'CacheSecurityGroupName': 'string',
'Status': 'string'
},
],
'CacheParameterGroup': {
'CacheParameterGroupName': 'string',
'ParameterApplyStatus': 'string',
'CacheNodeIdsToReboot': [
'string',
]
},
'CacheSubnetGroupName': 'string',
'CacheNodes': [
{
'CacheNodeId': 'string',
'CacheNodeStatus': 'string',
'CacheNodeCreateTime': datetime(2015, 1, 1),
'Endpoint': {
'Address': 'string',
'Port': 123
},
'ParameterGroupStatus': 'string',
'SourceCacheNodeId': 'string',
'CustomerAvailabilityZone': 'string'
},
],
'AutoMinorVersionUpgrade': True|False,
'SecurityGroups': [
{
'SecurityGroupId': 'string',
'Status': 'string'
},
],
'ReplicationGroupId': 'string',
'SnapshotRetentionLimit': 123,
'SnapshotWindow': 'string'
},
],
'NextToken': 'string'
}
Response Structure
|
ElastiCache.Paginator.DescribeCacheEngineVersions¶paginator = client.get_paginator('describe_cache_engine_versions')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from ElastiCache.Client.describe_cache_engine_versions().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Engine='string',
EngineVersion='string',
CacheParameterGroupFamily='string',
DefaultOnly=True|False,
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'CacheEngineVersions': [
{
'Engine': 'string',
'EngineVersion': 'string',
'CacheParameterGroupFamily': 'string',
'CacheEngineDescription': 'string',
'CacheEngineVersionDescription': 'string'
},
],
'NextToken': 'string'
}
Response Structure
|
ElastiCache.Paginator.DescribeCacheParameterGroups¶paginator = client.get_paginator('describe_cache_parameter_groups')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from ElastiCache.Client.describe_cache_parameter_groups().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
CacheParameterGroupName='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'CacheParameterGroups': [
{
'CacheParameterGroupName': 'string',
'CacheParameterGroupFamily': 'string',
'Description': 'string'
},
],
'NextToken': 'string'
}
Response Structure
|
ElastiCache.Paginator.DescribeCacheParameters¶paginator = client.get_paginator('describe_cache_parameters')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from ElastiCache.Client.describe_cache_parameters().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
CacheParameterGroupName='string',
Source='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'Parameters': [
{
'ParameterName': 'string',
'ParameterValue': 'string',
'Description': 'string',
'Source': 'string',
'DataType': 'string',
'AllowedValues': 'string',
'IsModifiable': True|False,
'MinimumEngineVersion': 'string',
'ChangeType': 'immediate'|'requires-reboot'
},
],
'CacheNodeTypeSpecificParameters': [
{
'ParameterName': 'string',
'Description': 'string',
'Source': 'string',
'DataType': 'string',
'AllowedValues': 'string',
'IsModifiable': True|False,
'MinimumEngineVersion': 'string',
'CacheNodeTypeSpecificValues': [
{
'CacheNodeType': 'string',
'Value': 'string'
},
],
'ChangeType': 'immediate'|'requires-reboot'
},
],
'NextToken': 'string'
}
Response Structure
|
ElastiCache.Paginator.DescribeCacheSecurityGroups¶paginator = client.get_paginator('describe_cache_security_groups')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from ElastiCache.Client.describe_cache_security_groups().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
CacheSecurityGroupName='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'CacheSecurityGroups': [
{
'OwnerId': 'string',
'CacheSecurityGroupName': 'string',
'Description': 'string',
'EC2SecurityGroups': [
{
'Status': 'string',
'EC2SecurityGroupName': 'string',
'EC2SecurityGroupOwnerId': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
|
ElastiCache.Paginator.DescribeCacheSubnetGroups¶paginator = client.get_paginator('describe_cache_subnet_groups')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from ElastiCache.Client.describe_cache_subnet_groups().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
CacheSubnetGroupName='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'CacheSubnetGroups': [
{
'CacheSubnetGroupName': 'string',
'CacheSubnetGroupDescription': 'string',
'VpcId': 'string',
'Subnets': [
{
'SubnetIdentifier': 'string',
'SubnetAvailabilityZone': {
'Name': 'string'
}
},
]
},
],
'NextToken': 'string'
}
Response Structure
|
ElastiCache.Paginator.DescribeEngineDefaultParameters¶paginator = client.get_paginator('describe_engine_default_parameters')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from ElastiCache.Client.describe_engine_default_parameters().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
CacheParameterGroupFamily='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'EngineDefaults': {
'CacheParameterGroupFamily': 'string',
'Marker': 'string',
'Parameters': [
{
'ParameterName': 'string',
'ParameterValue': 'string',
'Description': 'string',
'Source': 'string',
'DataType': 'string',
'AllowedValues': 'string',
'IsModifiable': True|False,
'MinimumEngineVersion': 'string',
'ChangeType': 'immediate'|'requires-reboot'
},
],
'CacheNodeTypeSpecificParameters': [
{
'ParameterName': 'string',
'Description': 'string',
'Source': 'string',
'DataType': 'string',
'AllowedValues': 'string',
'IsModifiable': True|False,
'MinimumEngineVersion': 'string',
'CacheNodeTypeSpecificValues': [
{
'CacheNodeType': 'string',
'Value': 'string'
},
],
'ChangeType': 'immediate'|'requires-reboot'
},
]
},
'NextToken': 'string'
}
Response Structure
|
ElastiCache.Paginator.DescribeEvents¶paginator = client.get_paginator('describe_events')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from ElastiCache.Client.describe_events().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
SourceIdentifier='string',
SourceType='cache-cluster'|'cache-parameter-group'|'cache-security-group'|'cache-subnet-group'|'replication-group',
StartTime=datetime(2015, 1, 1),
EndTime=datetime(2015, 1, 1),
Duration=123,
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'Events': [
{
'SourceIdentifier': 'string',
'SourceType': 'cache-cluster'|'cache-parameter-group'|'cache-security-group'|'cache-subnet-group'|'replication-group',
'Message': 'string',
'Date': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
|
ElastiCache.Paginator.DescribeReplicationGroups¶paginator = client.get_paginator('describe_replication_groups')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from ElastiCache.Client.describe_replication_groups().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ReplicationGroupId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'ReplicationGroups': [
{
'ReplicationGroupId': 'string',
'Description': 'string',
'Status': 'string',
'PendingModifiedValues': {
'PrimaryClusterId': 'string',
'AutomaticFailoverStatus': 'enabled'|'disabled'
},
'MemberClusters': [
'string',
],
'NodeGroups': [
{
'NodeGroupId': 'string',
'Status': 'string',
'PrimaryEndpoint': {
'Address': 'string',
'Port': 123
},
'Slots': 'string',
'NodeGroupMembers': [
{
'CacheClusterId': 'string',
'CacheNodeId': 'string',
'ReadEndpoint': {
'Address': 'string',
'Port': 123
},
'PreferredAvailabilityZone': 'string',
'CurrentRole': 'string'
},
]
},
],
'SnapshottingClusterId': 'string',
'AutomaticFailover': 'enabled'|'disabled'|'enabling'|'disabling',
'ConfigurationEndpoint': {
'Address': 'string',
'Port': 123
},
'SnapshotRetentionLimit': 123,
'SnapshotWindow': 'string',
'ClusterEnabled': True|False,
'CacheNodeType': 'string'
},
],
'NextToken': 'string'
}
Response Structure
|
ElastiCache.Paginator.DescribeReservedCacheNodes¶paginator = client.get_paginator('describe_reserved_cache_nodes')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from ElastiCache.Client.describe_reserved_cache_nodes().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ReservedCacheNodeId='string',
ReservedCacheNodesOfferingId='string',
CacheNodeType='string',
Duration='string',
ProductDescription='string',
OfferingType='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'ReservedCacheNodes': [
{
'ReservedCacheNodeId': 'string',
'ReservedCacheNodesOfferingId': 'string',
'CacheNodeType': 'string',
'StartTime': datetime(2015, 1, 1),
'Duration': 123,
'FixedPrice': 123.0,
'UsagePrice': 123.0,
'CacheNodeCount': 123,
'ProductDescription': 'string',
'OfferingType': 'string',
'State': 'string',
'RecurringCharges': [
{
'RecurringChargeAmount': 123.0,
'RecurringChargeFrequency': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
|
ElastiCache.Paginator.DescribeReservedCacheNodesOfferings¶paginator = client.get_paginator('describe_reserved_cache_nodes_offerings')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from ElastiCache.Client.describe_reserved_cache_nodes_offerings().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ReservedCacheNodesOfferingId='string',
CacheNodeType='string',
Duration='string',
ProductDescription='string',
OfferingType='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'ReservedCacheNodesOfferings': [
{
'ReservedCacheNodesOfferingId': 'string',
'CacheNodeType': 'string',
'Duration': 123,
'FixedPrice': 123.0,
'UsagePrice': 123.0,
'ProductDescription': 'string',
'OfferingType': 'string',
'RecurringCharges': [
{
'RecurringChargeAmount': 123.0,
'RecurringChargeFrequency': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
|
ElastiCache.Paginator.DescribeSnapshots¶paginator = client.get_paginator('describe_snapshots')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from ElastiCache.Client.describe_snapshots().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ReplicationGroupId='string',
CacheClusterId='string',
SnapshotName='string',
SnapshotSource='string',
ShowNodeGroupConfig=True|False,
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'Snapshots': [
{
'SnapshotName': 'string',
'ReplicationGroupId': 'string',
'ReplicationGroupDescription': 'string',
'CacheClusterId': 'string',
'SnapshotStatus': 'string',
'SnapshotSource': 'string',
'CacheNodeType': 'string',
'Engine': 'string',
'EngineVersion': 'string',
'NumCacheNodes': 123,
'PreferredAvailabilityZone': 'string',
'CacheClusterCreateTime': datetime(2015, 1, 1),
'PreferredMaintenanceWindow': 'string',
'TopicArn': 'string',
'Port': 123,
'CacheParameterGroupName': 'string',
'CacheSubnetGroupName': 'string',
'VpcId': 'string',
'AutoMinorVersionUpgrade': True|False,
'SnapshotRetentionLimit': 123,
'SnapshotWindow': 'string',
'NumNodeGroups': 123,
'AutomaticFailover': 'enabled'|'disabled'|'enabling'|'disabling',
'NodeSnapshots': [
{
'CacheClusterId': 'string',
'NodeGroupId': 'string',
'CacheNodeId': 'string',
'NodeGroupConfiguration': {
'Slots': 'string',
'ReplicaCount': 123,
'PrimaryAvailabilityZone': 'string',
'ReplicaAvailabilityZones': [
'string',
]
},
'CacheSize': 'string',
'CacheNodeCreateTime': datetime(2015, 1, 1),
'SnapshotCreateTime': datetime(2015, 1, 1)
},
]
},
],
'NextToken': 'string'
}
Response Structure
|
The available waiters are:
ElastiCache.Waiter.CacheClusterAvailableElastiCache.Waiter.CacheClusterDeletedElastiCache.Waiter.ReplicationGroupAvailableElastiCache.Waiter.ReplicationGroupDeletedElastiCache.Waiter.CacheClusterAvailable¶waiter = client.get_waiter('cache_cluster_available')
wait(**kwargs)¶Polls ElastiCache.Client.describe_cache_clusters() every 30 seconds until a successful state is reached. An error is returned after 60 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
CacheClusterId='string',
MaxRecords=123,
Marker='string',
ShowCacheNodeInfo=True|False,
ShowCacheClustersNotInReplicationGroups=True|False
)
| Parameters: |
|
|---|---|
| Returns: | None |
ElastiCache.Waiter.CacheClusterDeleted¶waiter = client.get_waiter('cache_cluster_deleted')
wait(**kwargs)¶Polls ElastiCache.Client.describe_cache_clusters() every 30 seconds until a successful state is reached. An error is returned after 60 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
CacheClusterId='string',
MaxRecords=123,
Marker='string',
ShowCacheNodeInfo=True|False,
ShowCacheClustersNotInReplicationGroups=True|False
)
| Parameters: |
|
|---|---|
| Returns: | None |
ElastiCache.Waiter.ReplicationGroupAvailable¶waiter = client.get_waiter('replication_group_available')
wait(**kwargs)¶Polls ElastiCache.Client.describe_replication_groups() every 30 seconds until a successful state is reached. An error is returned after 60 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
ReplicationGroupId='string',
MaxRecords=123,
Marker='string'
)
| Parameters: |
|
|---|---|
| Returns: | None |
ElastiCache.Waiter.ReplicationGroupDeleted¶waiter = client.get_waiter('replication_group_deleted')
wait(**kwargs)¶Polls ElastiCache.Client.describe_replication_groups() every 30 seconds until a successful state is reached. An error is returned after 60 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
ReplicationGroupId='string',
MaxRecords=123,
Marker='string'
)
| Parameters: |
|
|---|---|
| Returns: | None |