Skip to content

ElastiCacheClient#

Index > ElastiCache > ElastiCacheClient

Auto-generated documentation for ElastiCache type annotations stubs module mypy-boto3-elasticache.

ElastiCacheClient#

Type annotations and code completion for boto3.client("elasticache"). boto3 documentation

# ElastiCacheClient usage example

from boto3.session import Session
from mypy_boto3_elasticache.client import ElastiCacheClient

def get_elasticache_client() -> ElastiCacheClient:
    return Session().client("elasticache")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("elasticache").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("elasticache")

try:
    do_something(client)
except (
    client.exceptions.APICallRateForCustomerExceededFault,
    client.exceptions.AuthorizationAlreadyExistsFault,
    client.exceptions.AuthorizationNotFoundFault,
    client.exceptions.CacheClusterAlreadyExistsFault,
    client.exceptions.CacheClusterNotFoundFault,
    client.exceptions.CacheParameterGroupAlreadyExistsFault,
    client.exceptions.CacheParameterGroupNotFoundFault,
    client.exceptions.CacheParameterGroupQuotaExceededFault,
    client.exceptions.CacheSecurityGroupAlreadyExistsFault,
    client.exceptions.CacheSecurityGroupNotFoundFault,
    client.exceptions.CacheSecurityGroupQuotaExceededFault,
    client.exceptions.CacheSubnetGroupAlreadyExistsFault,
    client.exceptions.CacheSubnetGroupInUse,
    client.exceptions.CacheSubnetGroupNotFoundFault,
    client.exceptions.CacheSubnetGroupQuotaExceededFault,
    client.exceptions.CacheSubnetQuotaExceededFault,
    client.exceptions.ClientError,
    client.exceptions.ClusterQuotaForCustomerExceededFault,
    client.exceptions.DefaultUserAssociatedToUserGroupFault,
    client.exceptions.DefaultUserRequired,
    client.exceptions.DuplicateUserNameFault,
    client.exceptions.GlobalReplicationGroupAlreadyExistsFault,
    client.exceptions.GlobalReplicationGroupNotFoundFault,
    client.exceptions.InsufficientCacheClusterCapacityFault,
    client.exceptions.InvalidARNFault,
    client.exceptions.InvalidCacheClusterStateFault,
    client.exceptions.InvalidCacheParameterGroupStateFault,
    client.exceptions.InvalidCacheSecurityGroupStateFault,
    client.exceptions.InvalidGlobalReplicationGroupStateFault,
    client.exceptions.InvalidKMSKeyFault,
    client.exceptions.InvalidParameterCombinationException,
    client.exceptions.InvalidParameterValueException,
    client.exceptions.InvalidReplicationGroupStateFault,
    client.exceptions.InvalidSnapshotStateFault,
    client.exceptions.InvalidSubnet,
    client.exceptions.InvalidUserGroupStateFault,
    client.exceptions.InvalidUserStateFault,
    client.exceptions.InvalidVPCNetworkStateFault,
    client.exceptions.NoOperationFault,
    client.exceptions.NodeGroupNotFoundFault,
    client.exceptions.NodeGroupsPerReplicationGroupQuotaExceededFault,
    client.exceptions.NodeQuotaForClusterExceededFault,
    client.exceptions.NodeQuotaForCustomerExceededFault,
    client.exceptions.ReplicationGroupAlreadyExistsFault,
    client.exceptions.ReplicationGroupAlreadyUnderMigrationFault,
    client.exceptions.ReplicationGroupNotFoundFault,
    client.exceptions.ReplicationGroupNotUnderMigrationFault,
    client.exceptions.ReservedCacheNodeAlreadyExistsFault,
    client.exceptions.ReservedCacheNodeNotFoundFault,
    client.exceptions.ReservedCacheNodeQuotaExceededFault,
    client.exceptions.ReservedCacheNodesOfferingNotFoundFault,
    client.exceptions.ServiceLinkedRoleNotFoundFault,
    client.exceptions.ServiceUpdateNotFoundFault,
    client.exceptions.SnapshotAlreadyExistsFault,
    client.exceptions.SnapshotFeatureNotSupportedFault,
    client.exceptions.SnapshotNotFoundFault,
    client.exceptions.SnapshotQuotaExceededFault,
    client.exceptions.SubnetInUse,
    client.exceptions.SubnetNotAllowedFault,
    client.exceptions.TagNotFoundFault,
    client.exceptions.TagQuotaPerResourceExceeded,
    client.exceptions.TestFailoverNotAvailableFault,
    client.exceptions.UserAlreadyExistsFault,
    client.exceptions.UserGroupAlreadyExistsFault,
    client.exceptions.UserGroupNotFoundFault,
    client.exceptions.UserGroupQuotaExceededFault,
    client.exceptions.UserNotFoundFault,
    client.exceptions.UserQuotaExceededFault,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_elasticache.client import Exceptions

def handle_error(exc: Exceptions.APICallRateForCustomerExceededFault) -> None:
    ...

Methods#

add_tags_to_resource#

A tag is a key-value pair where the key and value are case-sensitive.

Type annotations and code completion for boto3.client("elasticache").add_tags_to_resource method. boto3 documentation

# add_tags_to_resource method definition

def add_tags_to_resource(
    self,
    *,
    ResourceName: str,
    Tags: Sequence[TagTypeDef],  # (1)
) -> TagListMessageTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See TagListMessageTypeDef 
# add_tags_to_resource method usage example with argument unpacking

kwargs: AddTagsToResourceMessageRequestTypeDef = {  # (1)
    "ResourceName": ...,
    "Tags": ...,
}

parent.add_tags_to_resource(**kwargs)
  1. See AddTagsToResourceMessageRequestTypeDef

authorize_cache_security_group_ingress#

Allows network ingress to a cache security group.

Type annotations and code completion for boto3.client("elasticache").authorize_cache_security_group_ingress method. boto3 documentation

# authorize_cache_security_group_ingress method definition

def authorize_cache_security_group_ingress(
    self,
    *,
    CacheSecurityGroupName: str,
    EC2SecurityGroupName: str,
    EC2SecurityGroupOwnerId: str,
) -> AuthorizeCacheSecurityGroupIngressResultTypeDef:  # (1)
    ...
  1. See AuthorizeCacheSecurityGroupIngressResultTypeDef 
# authorize_cache_security_group_ingress method usage example with argument unpacking

kwargs: AuthorizeCacheSecurityGroupIngressMessageRequestTypeDef = {  # (1)
    "CacheSecurityGroupName": ...,
    "EC2SecurityGroupName": ...,
    "EC2SecurityGroupOwnerId": ...,
}

parent.authorize_cache_security_group_ingress(**kwargs)
  1. See AuthorizeCacheSecurityGroupIngressMessageRequestTypeDef

batch_apply_update_action#

Apply the service update.

Type annotations and code completion for boto3.client("elasticache").batch_apply_update_action method. boto3 documentation

# batch_apply_update_action method definition

def batch_apply_update_action(
    self,
    *,
    ServiceUpdateName: str,
    ReplicationGroupIds: Sequence[str] = ...,
    CacheClusterIds: Sequence[str] = ...,
) -> UpdateActionResultsMessageTypeDef:  # (1)
    ...
  1. See UpdateActionResultsMessageTypeDef 
# batch_apply_update_action method usage example with argument unpacking

kwargs: BatchApplyUpdateActionMessageRequestTypeDef = {  # (1)
    "ServiceUpdateName": ...,
}

parent.batch_apply_update_action(**kwargs)
  1. See BatchApplyUpdateActionMessageRequestTypeDef

batch_stop_update_action#

Stop the service update.

Type annotations and code completion for boto3.client("elasticache").batch_stop_update_action method. boto3 documentation

# batch_stop_update_action method definition

def batch_stop_update_action(
    self,
    *,
    ServiceUpdateName: str,
    ReplicationGroupIds: Sequence[str] = ...,
    CacheClusterIds: Sequence[str] = ...,
) -> UpdateActionResultsMessageTypeDef:  # (1)
    ...
  1. See UpdateActionResultsMessageTypeDef 
# batch_stop_update_action method usage example with argument unpacking

kwargs: BatchStopUpdateActionMessageRequestTypeDef = {  # (1)
    "ServiceUpdateName": ...,
}

parent.batch_stop_update_action(**kwargs)
  1. See BatchStopUpdateActionMessageRequestTypeDef

can_paginate#

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("elasticache").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close#

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("elasticache").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

complete_migration#

Complete the migration of data.

Type annotations and code completion for boto3.client("elasticache").complete_migration method. boto3 documentation

# complete_migration method definition

def complete_migration(
    self,
    *,
    ReplicationGroupId: str,
    Force: bool = ...,
) -> CompleteMigrationResponseTypeDef:  # (1)
    ...
  1. See CompleteMigrationResponseTypeDef 
# complete_migration method usage example with argument unpacking

kwargs: CompleteMigrationMessageRequestTypeDef = {  # (1)
    "ReplicationGroupId": ...,
}

parent.complete_migration(**kwargs)
  1. See CompleteMigrationMessageRequestTypeDef

copy_snapshot#

Makes a copy of an existing snapshot.

Type annotations and code completion for boto3.client("elasticache").copy_snapshot method. boto3 documentation

# copy_snapshot method definition

def copy_snapshot(
    self,
    *,
    SourceSnapshotName: str,
    TargetSnapshotName: str,
    TargetBucket: str = ...,
    KmsKeyId: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CopySnapshotResultTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CopySnapshotResultTypeDef 
# copy_snapshot method usage example with argument unpacking

kwargs: CopySnapshotMessageRequestTypeDef = {  # (1)
    "SourceSnapshotName": ...,
    "TargetSnapshotName": ...,
}

parent.copy_snapshot(**kwargs)
  1. See CopySnapshotMessageRequestTypeDef

create_cache_cluster#

Creates a cluster.

Type annotations and code completion for boto3.client("elasticache").create_cache_cluster method. boto3 documentation

# create_cache_cluster method definition

def create_cache_cluster(
    self,
    *,
    CacheClusterId: str,
    ReplicationGroupId: str = ...,
    AZMode: AZModeType = ...,  # (1)
    PreferredAvailabilityZone: str = ...,
    PreferredAvailabilityZones: Sequence[str] = ...,
    NumCacheNodes: int = ...,
    CacheNodeType: str = ...,
    Engine: str = ...,
    EngineVersion: str = ...,
    CacheParameterGroupName: str = ...,
    CacheSubnetGroupName: str = ...,
    CacheSecurityGroupNames: Sequence[str] = ...,
    SecurityGroupIds: Sequence[str] = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (2)
    SnapshotArns: Sequence[str] = ...,
    SnapshotName: str = ...,
    PreferredMaintenanceWindow: str = ...,
    Port: int = ...,
    NotificationTopicArn: str = ...,
    AutoMinorVersionUpgrade: bool = ...,
    SnapshotRetentionLimit: int = ...,
    SnapshotWindow: str = ...,
    AuthToken: str = ...,
    OutpostMode: OutpostModeType = ...,  # (3)
    PreferredOutpostArn: str = ...,
    PreferredOutpostArns: Sequence[str] = ...,
    LogDeliveryConfigurations: Sequence[LogDeliveryConfigurationRequestTypeDef] = ...,  # (4)
    TransitEncryptionEnabled: bool = ...,
    NetworkType: NetworkTypeType = ...,  # (5)
    IpDiscovery: IpDiscoveryType = ...,  # (6)
) -> CreateCacheClusterResultTypeDef:  # (7)
    ...
  1. See AZModeType
  2. See TagTypeDef
  3. See OutpostModeType
  4. See LogDeliveryConfigurationRequestTypeDef
  5. See NetworkTypeType
  6. See IpDiscoveryType
  7. See CreateCacheClusterResultTypeDef 
# create_cache_cluster method usage example with argument unpacking

kwargs: CreateCacheClusterMessageRequestTypeDef = {  # (1)
    "CacheClusterId": ...,
}

parent.create_cache_cluster(**kwargs)
  1. See CreateCacheClusterMessageRequestTypeDef

create_cache_parameter_group#

Creates a new Amazon ElastiCache cache parameter group.

Type annotations and code completion for boto3.client("elasticache").create_cache_parameter_group method. boto3 documentation

# create_cache_parameter_group method definition

def create_cache_parameter_group(
    self,
    *,
    CacheParameterGroupName: str,
    CacheParameterGroupFamily: str,
    Description: str,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateCacheParameterGroupResultTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CreateCacheParameterGroupResultTypeDef 
# create_cache_parameter_group method usage example with argument unpacking

kwargs: CreateCacheParameterGroupMessageRequestTypeDef = {  # (1)
    "CacheParameterGroupName": ...,
    "CacheParameterGroupFamily": ...,
    "Description": ...,
}

parent.create_cache_parameter_group(**kwargs)
  1. See CreateCacheParameterGroupMessageRequestTypeDef

create_cache_security_group#

Creates a new cache security group.

Type annotations and code completion for boto3.client("elasticache").create_cache_security_group method. boto3 documentation

# create_cache_security_group method definition

def create_cache_security_group(
    self,
    *,
    CacheSecurityGroupName: str,
    Description: str,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateCacheSecurityGroupResultTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CreateCacheSecurityGroupResultTypeDef 
# create_cache_security_group method usage example with argument unpacking

kwargs: CreateCacheSecurityGroupMessageRequestTypeDef = {  # (1)
    "CacheSecurityGroupName": ...,
    "Description": ...,
}

parent.create_cache_security_group(**kwargs)
  1. See CreateCacheSecurityGroupMessageRequestTypeDef

create_cache_subnet_group#

Creates a new cache subnet group.

Type annotations and code completion for boto3.client("elasticache").create_cache_subnet_group method. boto3 documentation

# create_cache_subnet_group method definition

def create_cache_subnet_group(
    self,
    *,
    CacheSubnetGroupName: str,
    CacheSubnetGroupDescription: str,
    SubnetIds: Sequence[str],
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateCacheSubnetGroupResultTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CreateCacheSubnetGroupResultTypeDef 
# create_cache_subnet_group method usage example with argument unpacking

kwargs: CreateCacheSubnetGroupMessageRequestTypeDef = {  # (1)
    "CacheSubnetGroupName": ...,
    "CacheSubnetGroupDescription": ...,
    "SubnetIds": ...,
}

parent.create_cache_subnet_group(**kwargs)
  1. See CreateCacheSubnetGroupMessageRequestTypeDef

create_global_replication_group#

Global Datastore for Redis offers fully managed, fast, reliable and secure cross-region replication.

Type annotations and code completion for boto3.client("elasticache").create_global_replication_group method. boto3 documentation

# create_global_replication_group method definition

def create_global_replication_group(
    self,
    *,
    GlobalReplicationGroupIdSuffix: str,
    PrimaryReplicationGroupId: str,
    GlobalReplicationGroupDescription: str = ...,
) -> CreateGlobalReplicationGroupResultTypeDef:  # (1)
    ...
  1. See CreateGlobalReplicationGroupResultTypeDef 
# create_global_replication_group method usage example with argument unpacking

kwargs: CreateGlobalReplicationGroupMessageRequestTypeDef = {  # (1)
    "GlobalReplicationGroupIdSuffix": ...,
    "PrimaryReplicationGroupId": ...,
}

parent.create_global_replication_group(**kwargs)
  1. See CreateGlobalReplicationGroupMessageRequestTypeDef

create_replication_group#

Creates a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group.

Type annotations and code completion for boto3.client("elasticache").create_replication_group method. boto3 documentation

# create_replication_group method definition

def create_replication_group(
    self,
    *,
    ReplicationGroupId: str,
    ReplicationGroupDescription: str,
    GlobalReplicationGroupId: str = ...,
    PrimaryClusterId: str = ...,
    AutomaticFailoverEnabled: bool = ...,
    MultiAZEnabled: bool = ...,
    NumCacheClusters: int = ...,
    PreferredCacheClusterAZs: Sequence[str] = ...,
    NumNodeGroups: int = ...,
    ReplicasPerNodeGroup: int = ...,
    NodeGroupConfiguration: Sequence[NodeGroupConfigurationTypeDef] = ...,  # (1)
    CacheNodeType: str = ...,
    Engine: str = ...,
    EngineVersion: str = ...,
    CacheParameterGroupName: str = ...,
    CacheSubnetGroupName: str = ...,
    CacheSecurityGroupNames: Sequence[str] = ...,
    SecurityGroupIds: Sequence[str] = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (2)
    SnapshotArns: Sequence[str] = ...,
    SnapshotName: str = ...,
    PreferredMaintenanceWindow: str = ...,
    Port: int = ...,
    NotificationTopicArn: str = ...,
    AutoMinorVersionUpgrade: bool = ...,
    SnapshotRetentionLimit: int = ...,
    SnapshotWindow: str = ...,
    AuthToken: str = ...,
    TransitEncryptionEnabled: bool = ...,
    AtRestEncryptionEnabled: bool = ...,
    KmsKeyId: str = ...,
    UserGroupIds: Sequence[str] = ...,
    LogDeliveryConfigurations: Sequence[LogDeliveryConfigurationRequestTypeDef] = ...,  # (3)
    DataTieringEnabled: bool = ...,
    NetworkType: NetworkTypeType = ...,  # (4)
    IpDiscovery: IpDiscoveryType = ...,  # (5)
    TransitEncryptionMode: TransitEncryptionModeType = ...,  # (6)
    ClusterMode: ClusterModeType = ...,  # (7)
) -> CreateReplicationGroupResultTypeDef:  # (8)
    ...
  1. See NodeGroupConfigurationTypeDef
  2. See TagTypeDef
  3. See LogDeliveryConfigurationRequestTypeDef
  4. See NetworkTypeType
  5. See IpDiscoveryType
  6. See TransitEncryptionModeType
  7. See ClusterModeType
  8. See CreateReplicationGroupResultTypeDef 
# create_replication_group method usage example with argument unpacking

kwargs: CreateReplicationGroupMessageRequestTypeDef = {  # (1)
    "ReplicationGroupId": ...,
    "ReplicationGroupDescription": ...,
}

parent.create_replication_group(**kwargs)
  1. See CreateReplicationGroupMessageRequestTypeDef

create_snapshot#

Creates a copy of an entire cluster or replication group at a specific moment in time.

Type annotations and code completion for boto3.client("elasticache").create_snapshot method. boto3 documentation

# create_snapshot method definition

def create_snapshot(
    self,
    *,
    SnapshotName: str,
    ReplicationGroupId: str = ...,
    CacheClusterId: str = ...,
    KmsKeyId: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateSnapshotResultTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CreateSnapshotResultTypeDef 
# create_snapshot method usage example with argument unpacking

kwargs: CreateSnapshotMessageRequestTypeDef = {  # (1)
    "SnapshotName": ...,
}

parent.create_snapshot(**kwargs)
  1. See CreateSnapshotMessageRequestTypeDef

create_user#

For Redis engine version 6.0 onwards: Creates a Redis user.

Type annotations and code completion for boto3.client("elasticache").create_user method. boto3 documentation

# create_user method definition

def create_user(
    self,
    *,
    UserId: str,
    UserName: str,
    Engine: str,
    AccessString: str,
    Passwords: Sequence[str] = ...,
    NoPasswordRequired: bool = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
    AuthenticationMode: AuthenticationModeTypeDef = ...,  # (2)
) -> UserResponseTypeDef:  # (3)
    ...
  1. See TagTypeDef
  2. See AuthenticationModeTypeDef
  3. See UserResponseTypeDef 
# create_user method usage example with argument unpacking

kwargs: CreateUserMessageRequestTypeDef = {  # (1)
    "UserId": ...,
    "UserName": ...,
    "Engine": ...,
    "AccessString": ...,
}

parent.create_user(**kwargs)
  1. See CreateUserMessageRequestTypeDef

create_user_group#

For Redis engine version 6.0 onwards: Creates a Redis user group.

Type annotations and code completion for boto3.client("elasticache").create_user_group method. boto3 documentation

# create_user_group method definition

def create_user_group(
    self,
    *,
    UserGroupId: str,
    Engine: str,
    UserIds: Sequence[str] = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> UserGroupResponseTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See UserGroupResponseTypeDef 
# create_user_group method usage example with argument unpacking

kwargs: CreateUserGroupMessageRequestTypeDef = {  # (1)
    "UserGroupId": ...,
    "Engine": ...,
}

parent.create_user_group(**kwargs)
  1. See CreateUserGroupMessageRequestTypeDef

decrease_node_groups_in_global_replication_group#

Decreases the number of node groups in a Global datastore See also: AWS API Documentation.

Type annotations and code completion for boto3.client("elasticache").decrease_node_groups_in_global_replication_group method. boto3 documentation

# decrease_node_groups_in_global_replication_group method definition

def decrease_node_groups_in_global_replication_group(
    self,
    *,
    GlobalReplicationGroupId: str,
    NodeGroupCount: int,
    ApplyImmediately: bool,
    GlobalNodeGroupsToRemove: Sequence[str] = ...,
    GlobalNodeGroupsToRetain: Sequence[str] = ...,
) -> DecreaseNodeGroupsInGlobalReplicationGroupResultTypeDef:  # (1)
    ...
  1. See DecreaseNodeGroupsInGlobalReplicationGroupResultTypeDef 
# decrease_node_groups_in_global_replication_group method usage example with argument unpacking

kwargs: DecreaseNodeGroupsInGlobalReplicationGroupMessageRequestTypeDef = {  # (1)
    "GlobalReplicationGroupId": ...,
    "NodeGroupCount": ...,
    "ApplyImmediately": ...,
}

parent.decrease_node_groups_in_global_replication_group(**kwargs)
  1. See DecreaseNodeGroupsInGlobalReplicationGroupMessageRequestTypeDef

decrease_replica_count#

Dynamically decreases the number of replicas in a Redis (cluster mode disabled) replication group or the number of replica nodes in one or more node groups (shards) of a Redis (cluster mode enabled) replication group.

Type annotations and code completion for boto3.client("elasticache").decrease_replica_count method. boto3 documentation

# decrease_replica_count method definition

def decrease_replica_count(
    self,
    *,
    ReplicationGroupId: str,
    ApplyImmediately: bool,
    NewReplicaCount: int = ...,
    ReplicaConfiguration: Sequence[ConfigureShardTypeDef] = ...,  # (1)
    ReplicasToRemove: Sequence[str] = ...,
) -> DecreaseReplicaCountResultTypeDef:  # (2)
    ...
  1. See ConfigureShardTypeDef
  2. See DecreaseReplicaCountResultTypeDef 
# decrease_replica_count method usage example with argument unpacking

kwargs: DecreaseReplicaCountMessageRequestTypeDef = {  # (1)
    "ReplicationGroupId": ...,
    "ApplyImmediately": ...,
}

parent.decrease_replica_count(**kwargs)
  1. See DecreaseReplicaCountMessageRequestTypeDef

delete_cache_cluster#

Deletes a previously provisioned cluster.

Type annotations and code completion for boto3.client("elasticache").delete_cache_cluster method. boto3 documentation

# delete_cache_cluster method definition

def delete_cache_cluster(
    self,
    *,
    CacheClusterId: str,
    FinalSnapshotIdentifier: str = ...,
) -> DeleteCacheClusterResultTypeDef:  # (1)
    ...
  1. See DeleteCacheClusterResultTypeDef 
# delete_cache_cluster method usage example with argument unpacking

kwargs: DeleteCacheClusterMessageRequestTypeDef = {  # (1)
    "CacheClusterId": ...,
}

parent.delete_cache_cluster(**kwargs)
  1. See DeleteCacheClusterMessageRequestTypeDef

delete_cache_parameter_group#

Deletes the specified cache parameter group.

Type annotations and code completion for boto3.client("elasticache").delete_cache_parameter_group method. boto3 documentation

# delete_cache_parameter_group method definition

def delete_cache_parameter_group(
    self,
    *,
    CacheParameterGroupName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# delete_cache_parameter_group method usage example with argument unpacking

kwargs: DeleteCacheParameterGroupMessageRequestTypeDef = {  # (1)
    "CacheParameterGroupName": ...,
}

parent.delete_cache_parameter_group(**kwargs)
  1. See DeleteCacheParameterGroupMessageRequestTypeDef

delete_cache_security_group#

Deletes a cache security group.

Type annotations and code completion for boto3.client("elasticache").delete_cache_security_group method. boto3 documentation

# delete_cache_security_group method definition

def delete_cache_security_group(
    self,
    *,
    CacheSecurityGroupName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# delete_cache_security_group method usage example with argument unpacking

kwargs: DeleteCacheSecurityGroupMessageRequestTypeDef = {  # (1)
    "CacheSecurityGroupName": ...,
}

parent.delete_cache_security_group(**kwargs)
  1. See DeleteCacheSecurityGroupMessageRequestTypeDef

delete_cache_subnet_group#

Deletes a cache subnet group.

Type annotations and code completion for boto3.client("elasticache").delete_cache_subnet_group method. boto3 documentation

# delete_cache_subnet_group method definition

def delete_cache_subnet_group(
    self,
    *,
    CacheSubnetGroupName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# delete_cache_subnet_group method usage example with argument unpacking

kwargs: DeleteCacheSubnetGroupMessageRequestTypeDef = {  # (1)
    "CacheSubnetGroupName": ...,
}

parent.delete_cache_subnet_group(**kwargs)
  1. See DeleteCacheSubnetGroupMessageRequestTypeDef

delete_global_replication_group#

Deleting a Global datastore is a two-step process: * First, you must DisassociateGlobalReplicationGroup to remove the secondary clusters in the Global datastore.

Type annotations and code completion for boto3.client("elasticache").delete_global_replication_group method. boto3 documentation

# delete_global_replication_group method definition

def delete_global_replication_group(
    self,
    *,
    GlobalReplicationGroupId: str,
    RetainPrimaryReplicationGroup: bool,
) -> DeleteGlobalReplicationGroupResultTypeDef:  # (1)
    ...
  1. See DeleteGlobalReplicationGroupResultTypeDef 
# delete_global_replication_group method usage example with argument unpacking

kwargs: DeleteGlobalReplicationGroupMessageRequestTypeDef = {  # (1)
    "GlobalReplicationGroupId": ...,
    "RetainPrimaryReplicationGroup": ...,
}

parent.delete_global_replication_group(**kwargs)
  1. See DeleteGlobalReplicationGroupMessageRequestTypeDef

delete_replication_group#

Deletes an existing replication group.

Type annotations and code completion for boto3.client("elasticache").delete_replication_group method.