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

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.

Usage example
client = boto3.client("elasticache")

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

Method definition
def add_tags_to_resource(
    self,
    *,
    ResourceName: str,
    Tags: Sequence[TagTypeDef],  # (1)
) -> TagListMessageTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See TagListMessageTypeDef
Usage example with kwargs
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

Method definition
def authorize_cache_security_group_ingress(
    self,
    *,
    CacheSecurityGroupName: str,
    EC2SecurityGroupName: str,
    EC2SecurityGroupOwnerId: str,
) -> AuthorizeCacheSecurityGroupIngressResultTypeDef:  # (1)
    ...
  1. See AuthorizeCacheSecurityGroupIngressResultTypeDef
Usage example with kwargs
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

Method definition
def batch_apply_update_action(
    self,
    *,
    ServiceUpdateName: str,
    ReplicationGroupIds: Sequence[str] = ...,
    CacheClusterIds: Sequence[str] = ...,
) -> UpdateActionResultsMessageTypeDef:  # (1)
    ...
  1. See UpdateActionResultsMessageTypeDef
Usage example with kwargs
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

Method definition
def batch_stop_update_action(
    self,
    *,
    ServiceUpdateName: str,
    ReplicationGroupIds: Sequence[str] = ...,
    CacheClusterIds: Sequence[str] = ...,
) -> UpdateActionResultsMessageTypeDef:  # (1)
    ...
  1. See UpdateActionResultsMessageTypeDef
Usage example with kwargs
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

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

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

Method definition
def complete_migration(
    self,
    *,
    ReplicationGroupId: str,
    Force: bool = ...,
) -> CompleteMigrationResponseTypeDef:  # (1)
    ...
  1. See CompleteMigrationResponseTypeDef
Usage example with kwargs
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

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
Usage example with kwargs
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

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 = ...,
) -> CreateCacheClusterResultTypeDef:  # (5)
    ...
  1. See AZModeType
  2. See TagTypeDef
  3. See OutpostModeType
  4. See LogDeliveryConfigurationRequestTypeDef
  5. See CreateCacheClusterResultTypeDef
Usage example with kwargs
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

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
Usage example with kwargs
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

Method definition
def create_cache_security_group(
    self,
    *,
    CacheSecurityGroupName: str,
    Description: str,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateCacheSecurityGroupResultTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CreateCacheSecurityGroupResultTypeDef
Usage example with kwargs
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

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
Usage example with kwargs
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

Method definition
def create_global_replication_group(
    self,
    *,
    GlobalReplicationGroupIdSuffix: str,
    PrimaryReplicationGroupId: str,
    GlobalReplicationGroupDescription: str = ...,
) -> CreateGlobalReplicationGroupResultTypeDef:  # (1)
    ...
  1. See CreateGlobalReplicationGroupResultTypeDef
Usage example with kwargs
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

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 = ...,
) -> CreateReplicationGroupResultTypeDef:  # (4)
    ...
  1. See NodeGroupConfigurationTypeDef
  2. See TagTypeDef
  3. See LogDeliveryConfigurationRequestTypeDef
  4. See CreateReplicationGroupResultTypeDef
Usage example with kwargs
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

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
Usage example with kwargs
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

Method definition
def create_user(
    self,
    *,
    UserId: str,
    UserName: str,
    Engine: str,
    AccessString: str,
    Passwords: Sequence[str] = ...,
    NoPasswordRequired: bool = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> UserResponseMetadataTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See UserResponseMetadataTypeDef
Usage example with kwargs
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

Method definition
def create_user_group(
    self,
    *,
    UserGroupId: str,
    Engine: str,
    UserIds: Sequence[str] = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> UserGroupResponseMetadataTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See UserGroupResponseMetadataTypeDef
Usage example with kwargs
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

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
Usage example with kwargs
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

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
Usage example with kwargs
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

Method definition
def delete_cache_cluster(
    self,
    *,
    CacheClusterId: str,
    FinalSnapshotIdentifier: str = ...,
) -> DeleteCacheClusterResultTypeDef:  # (1)
    ...
  1. See DeleteCacheClusterResultTypeDef
Usage example with kwargs
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

Method definition
def delete_cache_parameter_group(
    self,
    *,
    CacheParameterGroupName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
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

Method definition
def delete_cache_security_group(
    self,
    *,
    CacheSecurityGroupName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
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

Method definition
def delete_cache_subnet_group(
    self,
    *,
    CacheSubnetGroupName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
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

Method definition
def delete_global_replication_group(
    self,
    *,
    GlobalReplicationGroupId: str,
    RetainPrimaryReplicationGroup: bool,
) -> DeleteGlobalReplicationGroupResultTypeDef:  # (1)
    ...
  1. See DeleteGlobalReplicationGroupResultTypeDef
Usage example with kwargs
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. boto3 documentation

Method definition
def delete_replication_group(
    self,
    *,
    ReplicationGroupId: str,
    RetainPrimaryCluster: bool = ...,
    FinalSnapshotIdentifier: str = ...,
) -> DeleteReplicationGroupResultTypeDef:  # (1)
    ...
  1. See DeleteReplicationGroupResultTypeDef
Usage example with kwargs
kwargs: DeleteReplicationGroupMessageRequestTypeDef = {  # (1)
    "ReplicationGroupId": ...,
}

parent.delete_replication_group(**kwargs)
  1. See DeleteReplicationGroupMessageRequestTypeDef

delete_snapshot

Deletes an existing snapshot.

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

Method definition
def delete_snapshot(
    self,
    *,
    SnapshotName: str,
) -> DeleteSnapshotResultTypeDef:  # (1)
    ...
  1. See DeleteSnapshotResultTypeDef
Usage example with kwargs
kwargs: DeleteSnapshotMessageRequestTypeDef = {  # (1)
    "SnapshotName": ...,
}

parent.delete_snapshot(**kwargs)
  1. See DeleteSnapshotMessageRequestTypeDef

delete_user

For Redis engine version 6.0 onwards: Deletes a user.

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

Method definition
def delete_user(
    self,
    *,
    UserId: str,
) -> UserResponseMetadataTypeDef:  # (1)
    ...
  1. See UserResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteUserMessageRequestTypeDef = {  # (1)
    "UserId": ...,
}

parent.delete_user(**kwargs)
  1. See DeleteUserMessageRequestTypeDef

delete_user_group

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

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

Method definition
def delete_user_group(
    self,
    *,
    UserGroupId: str,
) -> UserGroupResponseMetadataTypeDef:  # (1)
    ...
  1. See UserGroupResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteUserGroupMessageRequestTypeDef = {  # (1)
    "UserGroupId": ...,
}

parent.delete_user_group(**kwargs)
  1. See DeleteUserGroupMessageRequestTypeDef

describe_cache_clusters

Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific cache cluster if a cluster identifier is supplied.

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

Method definition
def describe_cache_clusters(
    self,
    *,
    CacheClusterId: str = ...,
    MaxRecords: int = ...,
    Marker: str = ...,
    ShowCacheNodeInfo: bool = ...,
    ShowCacheClustersNotInReplicationGroups: bool = ...,
) -> CacheClusterMessageTypeDef:  # (1)
    ...
  1. See CacheClusterMessageTypeDef
Usage example with kwargs
kwargs: DescribeCacheClustersMessageRequestTypeDef = {  # (1)
    "CacheClusterId": ...,
}

parent.describe_cache_clusters(**kwargs)
  1. See DescribeCacheClustersMessageRequestTypeDef

describe_cache_engine_versions

Returns a list of the available cache engines and their versions.

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

Method definition
def describe_cache_engine_versions(
    self,
    *,
    Engine: str = ...,
    EngineVersion: str = ...,
    CacheParameterGroupFamily: str = ...,
    MaxRecords: int = ...,
    Marker: str = ...,
    DefaultOnly: bool = ...,
) -> CacheEngineVersionMessageTypeDef:  # (1)
    ...
  1. See CacheEngineVersionMessageTypeDef
Usage example with kwargs
kwargs: DescribeCacheEngineVersionsMessageRequestTypeDef = {  # (1)
    "Engine": ...,
}

parent.describe_cache_engine_versions(**kwargs)
  1. See DescribeCacheEngineVersionsMessageRequestTypeDef

describe_cache_parameter_groups

Returns a list of cache parameter group descriptions.

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

Method definition
def describe_cache_parameter_groups(
    self,
    *,
    CacheParameterGroupName: str = ...,
    MaxRecords: int = ...,
    Marker: str = ...,
) -> CacheParameterGroupsMessageTypeDef:  # (1)
    ...
  1. See CacheParameterGroupsMessageTypeDef
Usage example with kwargs
kwargs: DescribeCacheParameterGroupsMessageRequestTypeDef = {  # (1)
    "CacheParameterGroupName": ...,
}

parent.describe_cache_parameter_groups(**kwargs)
  1. See DescribeCacheParameterGroupsMessageRequestTypeDef

describe_cache_parameters

Returns the detailed parameter list for a particular cache parameter group.

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

Method definition
def describe_cache_parameters(
    self,
    *,
    CacheParameterGroupName: str,
    Source: str = ...,
    MaxRecords: int = ...,
    Marker: str = ...,
) -> CacheParameterGroupDetailsTypeDef:  # (1)
    ...
  1. See CacheParameterGroupDetailsTypeDef
Usage example with kwargs
kwargs: DescribeCacheParametersMessageRequestTypeDef = {  # (1)
    "CacheParameterGroupName": ...,
}

parent.describe_cache_parameters(**kwargs)
  1. See DescribeCacheParametersMessageRequestTypeDef

describe_cache_security_groups

Returns a list of cache security group descriptions.

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

Method definition
def describe_cache_security_groups(
    self,
    *,
    CacheSecurityGroupName: str = ...,
    MaxRecords: int = ...,
    Marker: str = ...,
) -> CacheSecurityGroupMessageTypeDef:  # (1)
    ...
  1. See CacheSecurityGroupMessageTypeDef
Usage example with kwargs
kwargs: DescribeCacheSecurityGroupsMessageRequestTypeDef = {  # (1)
    "CacheSecurityGroupName": ...,
}

parent.describe_cache_security_groups(**kwargs)
  1. See DescribeCacheSecurityGroupsMessageRequestTypeDef

describe_cache_subnet_groups

Returns a list of cache subnet group descriptions.

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

Method definition
def describe_cache_subnet_groups(
    self,
    *,
    CacheSubnetGroupName: str = ...,
    MaxRecords: int = ...,
    Marker: str = ...,
) -> CacheSubnetGroupMessageTypeDef:  # (1)
    ...
  1. See CacheSubnetGroupMessageTypeDef
Usage example with kwargs
kwargs: DescribeCacheSubnetGroupsMessageRequestTypeDef = {  # (1)
    "CacheSubnetGroupName": ...,
}

parent.describe_cache_subnet_groups(**kwargs)
  1. See DescribeCacheSubnetGroupsMessageRequestTypeDef

describe_engine_default_parameters

Returns the default engine and system parameter information for the specified cache engine.

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

Method definition
def describe_engine_default_parameters(
    self,
    *,
    CacheParameterGroupFamily: str,
    MaxRecords: int = ...,
    Marker: str = ...,
) -> DescribeEngineDefaultParametersResultTypeDef:  # (1)
    ...
  1. See DescribeEngineDefaultParametersResultTypeDef
Usage example with kwargs
kwargs: DescribeEngineDefaultParametersMessageRequestTypeDef = {  # (1)
    "CacheParameterGroupFamily": ...,
}

parent.describe_engine_default_parameters(**kwargs)
  1. See DescribeEngineDefaultParametersMessageRequestTypeDef

describe_events

Returns events related to clusters, cache security groups, and cache parameter groups.

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

Method definition
def describe_events(
    self,
    *,
    SourceIdentifier: str = ...,
    SourceType: SourceTypeType = ...,  # (1)
    StartTime: Union[datetime, str] = ...,
    EndTime: Union[datetime, str] = ...,
    Duration: int = ...,
    MaxRecords: int = ...,
    Marker: str = ...,
) -> EventsMessageTypeDef:  # (2)
    ...
  1. See SourceTypeType
  2. See EventsMessageTypeDef
Usage example with kwargs
kwargs: DescribeEventsMessageRequestTypeDef = {  # (1)
    "SourceIdentifier": ...,
}

parent.describe_events(**kwargs)
  1. See DescribeEventsMessageRequestTypeDef

describe_global_replication_groups

Returns information about a particular global replication group.

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

Method definition
def describe_global_replication_groups(
    self,
    *,
    GlobalReplicationGroupId: str = ...,
    MaxRecords: int = ...,
    Marker: str = ...,
    ShowMemberInfo: bool = ...,
) -> DescribeGlobalReplicationGroupsResultTypeDef:  # (1)
    ...
  1. See DescribeGlobalReplicationGroupsResultTypeDef
Usage example with kwargs
kwargs: DescribeGlobalReplicationGroupsMessageRequestTypeDef = {  # (1)
    "GlobalReplicationGroupId": ...,
}

parent.describe_global_replication_groups(**kwargs)
  1. See DescribeGlobalReplicationGroupsMessageRequestTypeDef

describe_replication_groups

Returns information about a particular replication group.

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

Method definition
def describe_replication_groups(
    self,
    *,
    ReplicationGroupId: str = ...,
    MaxRecords: int = ...,
    Marker: str = ...,
) -> ReplicationGroupMessageTypeDef:  # (1)
    ...
  1. See ReplicationGroupMessageTypeDef
Usage example with kwargs
kwargs: DescribeReplicationGroupsMessageRequestTypeDef = {  # (1)
    "ReplicationGroupId": ...,
}

parent.describe_replication_groups(**kwargs)
  1. See DescribeReplicationGroupsMessageRequestTypeDef

describe_reserved_cache_nodes

Returns information about reserved cache nodes for this account, or about a specified reserved cache node.

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

Method definition
def describe_reserved_cache_nodes(
    self,
    *,
    ReservedCacheNodeId: str = ...,
    ReservedCacheNodesOfferingId: str = ...,
    CacheNodeType: str = ...,
    Duration: str = ...,
    ProductDescription: str = ...,
    OfferingType: str = ...,
    MaxRecords: int = ...,
    Marker: str = ...,
) -> ReservedCacheNodeMessageTypeDef:  # (1)
    ...
  1. See ReservedCacheNodeMessageTypeDef
Usage example with kwargs
kwargs: DescribeReservedCacheNodesMessageRequestTypeDef = {  # (1)
    "ReservedCacheNodeId": ...,
}

parent.describe_reserved_cache_nodes(**kwargs)
  1. See DescribeReservedCacheNodesMessageRequestTypeDef

describe_reserved_cache_nodes_offerings

Lists available reserved cache node offerings.

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

Method definition
def describe_reserved_cache_nodes_offerings(
    self,
    *,
    ReservedCacheNodesOfferingId: str = ...,
    CacheNodeType: str = ...,
    Duration: str = ...,
    ProductDescription: str = ...,
    OfferingType: str = ...,
    MaxRecords: int = ...,
    Marker: str = ...,
) -> ReservedCacheNodesOfferingMessageTypeDef:  # (1)
    ...
  1. See ReservedCacheNodesOfferingMessageTypeDef
Usage example with kwargs
kwargs: DescribeReservedCacheNodesOfferingsMessageRequestTypeDef = {  # (1)
    "ReservedCacheNodesOfferingId": ...,
}

parent.describe_reserved_cache_nodes_offerings(**kwargs)
  1. See DescribeReservedCacheNodesOfferingsMessageRequestTypeDef

describe_service_updates

Returns details of the service updates See also: AWS API Documentation.

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

Method definition
def describe_service_updates(
    self,
    *,
    ServiceUpdateName: str = ...,
    ServiceUpdateStatus: Sequence[ServiceUpdateStatusType] = ...,  # (1)
    MaxRecords: int = ...,
    Marker: str = ...,
) -> ServiceUpdatesMessageTypeDef:  # (2)
    ...
  1. See ServiceUpdateStatusType
  2. See ServiceUpdatesMessageTypeDef
Usage example with kwargs
kwargs: DescribeServiceUpdatesMessageRequestTypeDef = {  # (1)
    "ServiceUpdateName": ...,
}

parent.describe_service_updates(**kwargs)
  1. See DescribeServiceUpdatesMessageRequestTypeDef

describe_snapshots

Returns information about cluster or replication group snapshots.

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

Method definition
def describe_snapshots(
    self,
    *,
    ReplicationGroupId: str = ...,
    CacheClusterId: str = ...,
    SnapshotName: str = ...,
    SnapshotSource: str = ...,
    Marker: str = ...,
    MaxRecords: int = ...,
    ShowNodeGroupConfig: bool = ...,
) -> DescribeSnapshotsListMessageTypeDef:  # (1)
    ...
  1. See DescribeSnapshotsListMessageTypeDef
Usage example with kwargs
kwargs: DescribeSnapshotsMessageRequestTypeDef = {  # (1)
    "ReplicationGroupId": ...,
}

parent.describe_snapshots(**kwargs)
  1. See DescribeSnapshotsMessageRequestTypeDef

describe_update_actions

Returns details of the update actions See also: AWS API Documentation.

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

Method definition
def describe_update_actions(
    self,
    *,
    ServiceUpdateName: str = ...,
    ReplicationGroupIds: Sequence[str] = ...,
    CacheClusterIds: Sequence[str] = ...,
    Engine: str = ...,
    ServiceUpdateStatus: Sequence[ServiceUpdateStatusType] = ...,  # (1)
    ServiceUpdateTimeRange: TimeRangeFilterTypeDef = ...,  # (2)
    UpdateActionStatus: Sequence[UpdateActionStatusType] = ...,  # (3)
    ShowNodeLevelUpdateStatus: bool = ...,
    MaxRecords: int = ...,
    Marker: str = ...,
) -> UpdateActionsMessageTypeDef:  # (4)
    ...
  1. See ServiceUpdateStatusType
  2. See TimeRangeFilterTypeDef
  3. See UpdateActionStatusType
  4. See UpdateActionsMessageTypeDef
Usage example with kwargs
kwargs: DescribeUpdateActionsMessageRequestTypeDef = {  # (1)
    "ServiceUpdateName": ...,
}

parent.describe_update_actions(**kwargs)
  1. See DescribeUpdateActionsMessageRequestTypeDef

describe_user_groups

Returns a list of user groups.

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

Method definition
def describe_user_groups(
    self,
    *,
    UserGroupId: str = ...,
    MaxRecords: int = ...,
    Marker: str = ...,
) -> DescribeUserGroupsResultTypeDef:  # (1)
    ...
  1. See DescribeUserGroupsResultTypeDef
Usage example with kwargs
kwargs: DescribeUserGroupsMessageRequestTypeDef = {  # (1)
    "UserGroupId": ...,
}

parent.describe_user_groups(**kwargs)
  1. See DescribeUserGroupsMessageRequestTypeDef

describe_users

Returns a list of users.

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

Method definition
def describe_users(
    self,
    *,
    Engine: str = ...,
    UserId: str = ...,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
    MaxRecords: int = ...,
    Marker: str = ...,
) -> DescribeUsersResultTypeDef:  # (2)
    ...
  1. See FilterTypeDef
  2. See DescribeUsersResultTypeDef
Usage example with kwargs
kwargs: DescribeUsersMessageRequestTypeDef = {  # (1)
    "Engine": ...,
}

parent.describe_users(**kwargs)
  1. See DescribeUsersMessageRequestTypeDef

disassociate_global_replication_group

Remove a secondary cluster from the Global datastore using the Global datastore name.

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

Method definition
def disassociate_global_replication_group(
    self,
    *,
    GlobalReplicationGroupId: str,
    ReplicationGroupId: str,
    ReplicationGroupRegion: str,
) -> DisassociateGlobalReplicationGroupResultTypeDef:  # (1)
    ...
  1. See DisassociateGlobalReplicationGroupResultTypeDef
Usage example with kwargs
kwargs: DisassociateGlobalReplicationGroupMessageRequestTypeDef = {  # (1)
    "GlobalReplicationGroupId": ...,
    "ReplicationGroupId": ...,
    "ReplicationGroupRegion": ...,
}

parent.disassociate_global_replication_group(**kwargs)
  1. See DisassociateGlobalReplicationGroupMessageRequestTypeDef

failover_global_replication_group

Used to failover the primary region to a selected secondary region.

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

Method definition
def failover_global_replication_group(
    self,
    *,
    GlobalReplicationGroupId: str,
    PrimaryRegion: str,
    PrimaryReplicationGroupId: str,
) -> FailoverGlobalReplicationGroupResultTypeDef:  # (1)
    ...
  1. See FailoverGlobalReplicationGroupResultTypeDef
Usage example with kwargs
kwargs: FailoverGlobalReplicationGroupMessageRequestTypeDef = {  # (1)
    "GlobalReplicationGroupId": ...,
    "PrimaryRegion": ...,
    "PrimaryReplicationGroupId": ...,
}

parent.failover_global_replication_group(**kwargs)
  1. See FailoverGlobalReplicationGroupMessageRequestTypeDef

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

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