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
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.
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)
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
def add_tags_to_resource(
self,
*,
ResourceName: str,
Tags: Sequence[TagTypeDef], # (1)
) -> TagListMessageTypeDef: # (2)
...
- See TagTypeDef
- See TagListMessageTypeDef
kwargs: AddTagsToResourceMessageRequestTypeDef = { # (1)
"ResourceName": ...,
"Tags": ...,
}
parent.add_tags_to_resource(**kwargs)
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
def authorize_cache_security_group_ingress(
self,
*,
CacheSecurityGroupName: str,
EC2SecurityGroupName: str,
EC2SecurityGroupOwnerId: str,
) -> AuthorizeCacheSecurityGroupIngressResultTypeDef: # (1)
...
kwargs: AuthorizeCacheSecurityGroupIngressMessageRequestTypeDef = { # (1)
"CacheSecurityGroupName": ...,
"EC2SecurityGroupName": ...,
"EC2SecurityGroupOwnerId": ...,
}
parent.authorize_cache_security_group_ingress(**kwargs)
batch_apply_update_action
Apply the service update.
Type annotations and code completion for boto3.client("elasticache").batch_apply_update_action
method.
boto3 documentation
def batch_apply_update_action(
self,
*,
ServiceUpdateName: str,
ReplicationGroupIds: Sequence[str] = ...,
CacheClusterIds: Sequence[str] = ...,
) -> UpdateActionResultsMessageTypeDef: # (1)
...
kwargs: BatchApplyUpdateActionMessageRequestTypeDef = { # (1)
"ServiceUpdateName": ...,
}
parent.batch_apply_update_action(**kwargs)
batch_stop_update_action
Stop the service update.
Type annotations and code completion for boto3.client("elasticache").batch_stop_update_action
method.
boto3 documentation
def batch_stop_update_action(
self,
*,
ServiceUpdateName: str,
ReplicationGroupIds: Sequence[str] = ...,
CacheClusterIds: Sequence[str] = ...,
) -> UpdateActionResultsMessageTypeDef: # (1)
...
kwargs: BatchStopUpdateActionMessageRequestTypeDef = { # (1)
"ServiceUpdateName": ...,
}
parent.batch_stop_update_action(**kwargs)
can_paginate
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("elasticache").can_paginate
method.
boto3 documentation
close
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("elasticache").close
method.
boto3 documentation
complete_migration
Complete the migration of data.
Type annotations and code completion for boto3.client("elasticache").complete_migration
method.
boto3 documentation
def complete_migration(
self,
*,
ReplicationGroupId: str,
Force: bool = ...,
) -> CompleteMigrationResponseTypeDef: # (1)
...
kwargs: CompleteMigrationMessageRequestTypeDef = { # (1)
"ReplicationGroupId": ...,
}
parent.complete_migration(**kwargs)
copy_snapshot
Makes a copy of an existing snapshot.
Type annotations and code completion for boto3.client("elasticache").copy_snapshot
method.
boto3 documentation
def copy_snapshot(
self,
*,
SourceSnapshotName: str,
TargetSnapshotName: str,
TargetBucket: str = ...,
KmsKeyId: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CopySnapshotResultTypeDef: # (2)
...
- See TagTypeDef
- See CopySnapshotResultTypeDef
kwargs: CopySnapshotMessageRequestTypeDef = { # (1)
"SourceSnapshotName": ...,
"TargetSnapshotName": ...,
}
parent.copy_snapshot(**kwargs)
create_cache_cluster
Creates a cluster.
Type annotations and code completion for boto3.client("elasticache").create_cache_cluster
method.
boto3 documentation
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)
...
- See AZModeType
- See TagTypeDef
- See OutpostModeType
- See LogDeliveryConfigurationRequestTypeDef
- See NetworkTypeType
- See IpDiscoveryType
- See CreateCacheClusterResultTypeDef
kwargs: CreateCacheClusterMessageRequestTypeDef = { # (1)
"CacheClusterId": ...,
}
parent.create_cache_cluster(**kwargs)
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
def create_cache_parameter_group(
self,
*,
CacheParameterGroupName: str,
CacheParameterGroupFamily: str,
Description: str,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateCacheParameterGroupResultTypeDef: # (2)
...
kwargs: CreateCacheParameterGroupMessageRequestTypeDef = { # (1)
"CacheParameterGroupName": ...,
"CacheParameterGroupFamily": ...,
"Description": ...,
}
parent.create_cache_parameter_group(**kwargs)
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
def create_cache_security_group(
self,
*,
CacheSecurityGroupName: str,
Description: str,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateCacheSecurityGroupResultTypeDef: # (2)
...
kwargs: CreateCacheSecurityGroupMessageRequestTypeDef = { # (1)
"CacheSecurityGroupName": ...,
"Description": ...,
}
parent.create_cache_security_group(**kwargs)
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
def create_cache_subnet_group(
self,
*,
CacheSubnetGroupName: str,
CacheSubnetGroupDescription: str,
SubnetIds: Sequence[str],
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateCacheSubnetGroupResultTypeDef: # (2)
...
kwargs: CreateCacheSubnetGroupMessageRequestTypeDef = { # (1)
"CacheSubnetGroupName": ...,
"CacheSubnetGroupDescription": ...,
"SubnetIds": ...,
}
parent.create_cache_subnet_group(**kwargs)
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
def create_global_replication_group(
self,
*,
GlobalReplicationGroupIdSuffix: str,
PrimaryReplicationGroupId: str,
GlobalReplicationGroupDescription: str = ...,
) -> CreateGlobalReplicationGroupResultTypeDef: # (1)
...
kwargs: CreateGlobalReplicationGroupMessageRequestTypeDef = { # (1)
"GlobalReplicationGroupIdSuffix": ...,
"PrimaryReplicationGroupId": ...,
}
parent.create_global_replication_group(**kwargs)
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
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)
) -> CreateReplicationGroupResultTypeDef: # (7)
...
- See NodeGroupConfigurationTypeDef
- See TagTypeDef
- See LogDeliveryConfigurationRequestTypeDef
- See NetworkTypeType
- See IpDiscoveryType
- See TransitEncryptionModeType
- See CreateReplicationGroupResultTypeDef
kwargs: CreateReplicationGroupMessageRequestTypeDef = { # (1)
"ReplicationGroupId": ...,
"ReplicationGroupDescription": ...,
}
parent.create_replication_group(**kwargs)
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
def create_snapshot(
self,
*,
SnapshotName: str,
ReplicationGroupId: str = ...,
CacheClusterId: str = ...,
KmsKeyId: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateSnapshotResultTypeDef: # (2)
...
kwargs: CreateSnapshotMessageRequestTypeDef = { # (1)
"SnapshotName": ...,
}
parent.create_snapshot(**kwargs)
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
def create_user(
self,
*,
UserId: str,
UserName: str,
Engine: str,
AccessString: str,
Passwords: Sequence[str] = ...,
NoPasswordRequired: bool = ...,
Tags: Sequence[TagTypeDef] = ..., # (1)
AuthenticationMode: AuthenticationModeTypeDef = ..., # (2)
) -> UserResponseMetadataTypeDef: # (3)
...
kwargs: CreateUserMessageRequestTypeDef = { # (1)
"UserId": ...,
"UserName": ...,
"Engine": ...,
"AccessString": ...,
}
parent.create_user(**kwargs)
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
def create_user_group(
self,
*,
UserGroupId: str,
Engine: str,
UserIds: Sequence[str] = ...,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> UserGroupResponseMetadataTypeDef: # (2)
...
kwargs: CreateUserGroupMessageRequestTypeDef = { # (1)
"UserGroupId": ...,
"Engine": ...,
}
parent.create_user_group(**kwargs)
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
def decrease_node_groups_in_global_replication_group(
self,
*,
GlobalReplicationGroupId: str,
NodeGroupCount: int,
ApplyImmediately: bool,
GlobalNodeGroupsToRemove: Sequence[str] = ...,
GlobalNodeGroupsToRetain: Sequence[str] = ...,
) -> DecreaseNodeGroupsInGlobalReplicationGroupResultTypeDef: # (1)
...
kwargs: DecreaseNodeGroupsInGlobalReplicationGroupMessageRequestTypeDef = { # (1)
"GlobalReplicationGroupId": ...,
"NodeGroupCount": ...,
"ApplyImmediately": ...,
}
parent.decrease_node_groups_in_global_replication_group(**kwargs)
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
def decrease_replica_count(
self,
*,
ReplicationGroupId: str,
ApplyImmediately: bool,
NewReplicaCount: int = ...,
ReplicaConfiguration: Sequence[ConfigureShardTypeDef] = ..., # (1)
ReplicasToRemove: Sequence[str] = ...,
) -> DecreaseReplicaCountResultTypeDef: # (2)
...
kwargs: DecreaseReplicaCountMessageRequestTypeDef = { # (1)
"ReplicationGroupId": ...,
"ApplyImmediately": ...,
}
parent.decrease_replica_count(**kwargs)
delete_cache_cluster
Deletes a previously provisioned cluster.
Type annotations and code completion for boto3.client("elasticache").delete_cache_cluster
method.
boto3 documentation
def delete_cache_cluster(
self,
*,
CacheClusterId: str,
FinalSnapshotIdentifier: str = ...,
) -> DeleteCacheClusterResultTypeDef: # (1)
...
kwargs: DeleteCacheClusterMessageRequestTypeDef = { # (1)
"CacheClusterId": ...,
}
parent.delete_cache_cluster(**kwargs)
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
def delete_cache_parameter_group(
self,
*,
CacheParameterGroupName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteCacheParameterGroupMessageRequestTypeDef = { # (1)
"CacheParameterGroupName": ...,
}
parent.delete_cache_parameter_group(**kwargs)
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
def delete_cache_security_group(
self,
*,
CacheSecurityGroupName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteCacheSecurityGroupMessageRequestTypeDef = { # (1)
"CacheSecurityGroupName": ...,
}
parent.delete_cache_security_group(**kwargs)
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
def delete_cache_subnet_group(
self,
*,
CacheSubnetGroupName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteCacheSubnetGroupMessageRequestTypeDef = { # (1)
"CacheSubnetGroupName": ...,
}
parent.delete_cache_subnet_group(**kwargs)
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
def delete_global_replication_group(
self,
*,
GlobalReplicationGroupId: str,
RetainPrimaryReplicationGroup: bool,
) -> DeleteGlobalReplicationGroupResultTypeDef: # (1)
...
kwargs: DeleteGlobalReplicationGroupMessageRequestTypeDef = { # (1)
"GlobalReplicationGroupId": ...,
"RetainPrimaryReplicationGroup": ...,
}
parent.delete_global_replication_group(**kwargs)
delete_replication_group
Deletes an existing replication group.
Type annotations and code completion for boto3.client("elasticache").delete_replication_group
method.
boto3 documentation
def delete_replication_group(
self,
*,
ReplicationGroupId: str,
RetainPrimaryCluster: bool = ...,
FinalSnapshotIdentifier: str = ...,
) -> DeleteReplicationGroupResultTypeDef: # (1)
...
kwargs: DeleteReplicationGroupMessageRequestTypeDef = { # (1)
"ReplicationGroupId": ...,
}
parent.delete_replication_group(**kwargs)
delete_snapshot
Deletes an existing snapshot.
Type annotations and code completion for boto3.client("elasticache").delete_snapshot
method.
boto3 documentation
def delete_snapshot(
self,
*,
SnapshotName: str,
) -> DeleteSnapshotResultTypeDef: # (1)
...
kwargs: DeleteSnapshotMessageRequestTypeDef = { # (1)
"SnapshotName": ...,
}
parent.delete_snapshot(**kwargs)
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
kwargs: DeleteUserMessageRequestTypeDef = { # (1)
"UserId": ...,
}
parent.delete_user(**kwargs)
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
def delete_user_group(
self,
*,
UserGroupId: str,
) -> UserGroupResponseMetadataTypeDef: # (1)
...
kwargs: DeleteUserGroupMessageRequestTypeDef = { # (1)
"UserGroupId": ...,
}
parent.delete_user_group(**kwargs)
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
def describe_cache_clusters(
self,
*,
CacheClusterId: str = ...,
MaxRecords: int = ...,
Marker: str = ...,
ShowCacheNodeInfo: bool = ...,
ShowCacheClustersNotInReplicationGroups: bool = ...,
) -> CacheClusterMessageTypeDef: # (1)
...
kwargs: DescribeCacheClustersMessageRequestTypeDef = { # (1)
"CacheClusterId": ...,
}
parent.describe_cache_clusters(**kwargs)
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
def describe_cache_engine_versions(
self,
*,
Engine: str = ...,
EngineVersion: str = ...,
CacheParameterGroupFamily: str = ...,
MaxRecords: int = ...,
Marker: str = ...,
DefaultOnly: bool = ...,
) -> CacheEngineVersionMessageTypeDef: # (1)
...
kwargs: DescribeCacheEngineVersionsMessageRequestTypeDef = { # (1)
"Engine": ...,
}
parent.describe_cache_engine_versions(**kwargs)
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
def describe_cache_parameter_groups(
self,
*,
CacheParameterGroupName: str = ...,
MaxRecords: int = ...,
Marker: str = ...,
) -> CacheParameterGroupsMessageTypeDef: # (1)
...
kwargs: DescribeCacheParameterGroupsMessageRequestTypeDef = { # (1)
"CacheParameterGroupName": ...,
}
parent.describe_cache_parameter_groups(**kwargs)
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
def describe_cache_parameters(
self,
*,
CacheParameterGroupName: str,
Source: str = ...,
MaxRecords: int = ...,
Marker: str = ...,
) -> CacheParameterGroupDetailsTypeDef: # (1)
...
kwargs: DescribeCacheParametersMessageRequestTypeDef = { # (1)
"CacheParameterGroupName": ...,
}
parent.describe_cache_parameters(**kwargs)
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
def describe_cache_security_groups(
self,
*,
CacheSecurityGroupName: str = ...,
MaxRecords: int = ...,
Marker: str = ...,
) -> CacheSecurityGroupMessageTypeDef: # (1)
...
kwargs: DescribeCacheSecurityGroupsMessageRequestTypeDef = { # (1)
"CacheSecurityGroupName": ...,
}
parent.describe_cache_security_groups(**kwargs)
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
def describe_cache_subnet_groups(
self,
*,
CacheSubnetGroupName: str = ...,
MaxRecords: int = ...,
Marker: str = ...,
) -> CacheSubnetGroupMessageTypeDef: # (1)
...
kwargs: DescribeCacheSubnetGroupsMessageRequestTypeDef = { # (1)
"CacheSubnetGroupName": ...,
}
parent.describe_cache_subnet_groups(**kwargs)
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
def describe_engine_default_parameters(
self,
*,
CacheParameterGroupFamily: str,
MaxRecords: int = ...,
Marker: str = ...,
) -> DescribeEngineDefaultParametersResultTypeDef: # (1)
...
kwargs: DescribeEngineDefaultParametersMessageRequestTypeDef = { # (1)
"CacheParameterGroupFamily": ...,
}
parent.describe_engine_default_parameters(**kwargs)
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
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)
...
- See SourceTypeType
- See EventsMessageTypeDef
kwargs: DescribeEventsMessageRequestTypeDef = { # (1)
"SourceIdentifier": ...,
}
parent.describe_events(**kwargs)
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
def describe_global_replication_groups(
self,
*,
GlobalReplicationGroupId: str = ...,
MaxRecords: int = ...,
Marker: str = ...,
ShowMemberInfo: bool = ...,
) -> DescribeGlobalReplicationGroupsResultTypeDef: # (1)
...
kwargs: DescribeGlobalReplicationGroupsMessageRequestTypeDef = { # (1)
"GlobalReplicationGroupId": ...,
}
parent.describe_global_replication_groups(**kwargs)
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
def describe_replication_groups(
self,
*,
ReplicationGroupId: str = ...,
MaxRecords: int = ...,
Marker: str = ...,
) -> ReplicationGroupMessageTypeDef: # (1)
...
kwargs: DescribeReplicationGroupsMessageRequestTypeDef = { # (1)
"ReplicationGroupId": ...,
}
parent.describe_replication_groups(**kwargs)
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
def describe_reserved_cache_nodes(
self,
*,
ReservedCacheNodeId: str = ...,
ReservedCacheNodesOfferingId: str = ...,
CacheNodeType: str = ...,
Duration: str = ...,
ProductDescription: str = ...,
OfferingType: str = ...,
MaxRecords: int = ...,
Marker: str = ...,
) -> ReservedCacheNodeMessageTypeDef: # (1)
...
kwargs: DescribeReservedCacheNodesMessageRequestTypeDef = { # (1)
"ReservedCacheNodeId": ...,
}
parent.describe_reserved_cache_nodes(**kwargs)
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.