MemoryDBClient#
Auto-generated documentation for MemoryDB type annotations stubs module mypy-boto3-memorydb.
MemoryDBClient#
Type annotations and code completion for boto3.client("memorydb")
.
boto3 documentation
# MemoryDBClient usage example
from boto3.session import Session
from mypy_boto3_memorydb.client import MemoryDBClient
def get_memorydb_client() -> MemoryDBClient:
return Session().client("memorydb")
Exceptions#
boto3
client exceptions are generated in runtime.
This class provides code completion for boto3.client("memorydb").exceptions
structure.
# Exceptions.exceptions usage example
client = boto3.client("memorydb")
try:
do_something(client)
except (
client.exceptions.ACLAlreadyExistsFault,
client.exceptions.ACLNotFoundFault,
client.exceptions.ACLQuotaExceededFault,
client.exceptions.APICallRateForCustomerExceededFault,
client.exceptions.ClientError,
client.exceptions.ClusterAlreadyExistsFault,
client.exceptions.ClusterNotFoundFault,
client.exceptions.ClusterQuotaForCustomerExceededFault,
client.exceptions.DefaultUserRequired,
client.exceptions.DuplicateUserNameFault,
client.exceptions.InsufficientClusterCapacityFault,
client.exceptions.InvalidACLStateFault,
client.exceptions.InvalidARNFault,
client.exceptions.InvalidClusterStateFault,
client.exceptions.InvalidCredentialsException,
client.exceptions.InvalidKMSKeyFault,
client.exceptions.InvalidNodeStateFault,
client.exceptions.InvalidParameterCombinationException,
client.exceptions.InvalidParameterGroupStateFault,
client.exceptions.InvalidParameterValueException,
client.exceptions.InvalidSnapshotStateFault,
client.exceptions.InvalidSubnet,
client.exceptions.InvalidUserStateFault,
client.exceptions.InvalidVPCNetworkStateFault,
client.exceptions.NoOperationFault,
client.exceptions.NodeQuotaForClusterExceededFault,
client.exceptions.NodeQuotaForCustomerExceededFault,
client.exceptions.ParameterGroupAlreadyExistsFault,
client.exceptions.ParameterGroupNotFoundFault,
client.exceptions.ParameterGroupQuotaExceededFault,
client.exceptions.ReservedNodeAlreadyExistsFault,
client.exceptions.ReservedNodeNotFoundFault,
client.exceptions.ReservedNodeQuotaExceededFault,
client.exceptions.ReservedNodesOfferingNotFoundFault,
client.exceptions.ServiceLinkedRoleNotFoundFault,
client.exceptions.ServiceUpdateNotFoundFault,
client.exceptions.ShardNotFoundFault,
client.exceptions.ShardsPerClusterQuotaExceededFault,
client.exceptions.SnapshotAlreadyExistsFault,
client.exceptions.SnapshotNotFoundFault,
client.exceptions.SnapshotQuotaExceededFault,
client.exceptions.SubnetGroupAlreadyExistsFault,
client.exceptions.SubnetGroupInUseFault,
client.exceptions.SubnetGroupNotFoundFault,
client.exceptions.SubnetGroupQuotaExceededFault,
client.exceptions.SubnetInUse,
client.exceptions.SubnetNotAllowedFault,
client.exceptions.SubnetQuotaExceededFault,
client.exceptions.TagNotFoundFault,
client.exceptions.TagQuotaPerResourceExceeded,
client.exceptions.TestFailoverNotAvailableFault,
client.exceptions.UserAlreadyExistsFault,
client.exceptions.UserNotFoundFault,
client.exceptions.UserQuotaExceededFault,
) as e:
print(e)
# Exceptions.exceptions type checking example
from mypy_boto3_memorydb.client import Exceptions
def handle_error(exc: Exceptions.ACLAlreadyExistsFault) -> None:
...
Methods#
batch_update_cluster#
Apply the service update to a list of clusters supplied.
Type annotations and code completion for boto3.client("memorydb").batch_update_cluster
method.
boto3 documentation
# batch_update_cluster method definition
def batch_update_cluster(
self,
*,
ClusterNames: Sequence[str],
ServiceUpdate: ServiceUpdateRequestTypeDef = ..., # (1)
) -> BatchUpdateClusterResponseTypeDef: # (2)
...
# batch_update_cluster method usage example with argument unpacking
kwargs: BatchUpdateClusterRequestRequestTypeDef = { # (1)
"ClusterNames": ...,
}
parent.batch_update_cluster(**kwargs)
can_paginate#
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("memorydb").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("memorydb").close
method.
boto3 documentation
# close method definition
def close(
self,
) -> None:
...
copy_snapshot#
Makes a copy of an existing snapshot.
Type annotations and code completion for boto3.client("memorydb").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)
) -> CopySnapshotResponseTypeDef: # (2)
...
# copy_snapshot method usage example with argument unpacking
kwargs: CopySnapshotRequestRequestTypeDef = { # (1)
"SourceSnapshotName": ...,
"TargetSnapshotName": ...,
}
parent.copy_snapshot(**kwargs)
create_acl#
Creates an Access Control List.
Type annotations and code completion for boto3.client("memorydb").create_acl
method.
boto3 documentation
# create_acl method definition
def create_acl(
self,
*,
ACLName: str,
UserNames: Sequence[str] = ...,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateACLResponseTypeDef: # (2)
...
- See TagTypeDef
- See CreateACLResponseTypeDef
# create_acl method usage example with argument unpacking
kwargs: CreateACLRequestRequestTypeDef = { # (1)
"ACLName": ...,
}
parent.create_acl(**kwargs)
create_cluster#
Creates a cluster.
Type annotations and code completion for boto3.client("memorydb").create_cluster
method.
boto3 documentation
# create_cluster method definition
def create_cluster(
self,
*,
ClusterName: str,
NodeType: str,
ACLName: str,
ParameterGroupName: str = ...,
Description: str = ...,
NumShards: int = ...,
NumReplicasPerShard: int = ...,
SubnetGroupName: str = ...,
SecurityGroupIds: Sequence[str] = ...,
MaintenanceWindow: str = ...,
Port: int = ...,
SnsTopicArn: str = ...,
TLSEnabled: bool = ...,
KmsKeyId: str = ...,
SnapshotArns: Sequence[str] = ...,
SnapshotName: str = ...,
SnapshotRetentionLimit: int = ...,
Tags: Sequence[TagTypeDef] = ..., # (1)
SnapshotWindow: str = ...,
EngineVersion: str = ...,
AutoMinorVersionUpgrade: bool = ...,
DataTiering: bool = ...,
) -> CreateClusterResponseTypeDef: # (2)
...
# create_cluster method usage example with argument unpacking
kwargs: CreateClusterRequestRequestTypeDef = { # (1)
"ClusterName": ...,
"NodeType": ...,
"ACLName": ...,
}
parent.create_cluster(**kwargs)
create_parameter_group#
Creates a new MemoryDB parameter group.
Type annotations and code completion for boto3.client("memorydb").create_parameter_group
method.
boto3 documentation
# create_parameter_group method definition
def create_parameter_group(
self,
*,
ParameterGroupName: str,
Family: str,
Description: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateParameterGroupResponseTypeDef: # (2)
...
# create_parameter_group method usage example with argument unpacking
kwargs: CreateParameterGroupRequestRequestTypeDef = { # (1)
"ParameterGroupName": ...,
"Family": ...,
}
parent.create_parameter_group(**kwargs)
create_snapshot#
Creates a copy of an entire cluster at a specific moment in time.
Type annotations and code completion for boto3.client("memorydb").create_snapshot
method.
boto3 documentation
# create_snapshot method definition
def create_snapshot(
self,
*,
ClusterName: str,
SnapshotName: str,
KmsKeyId: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateSnapshotResponseTypeDef: # (2)
...
# create_snapshot method usage example with argument unpacking
kwargs: CreateSnapshotRequestRequestTypeDef = { # (1)
"ClusterName": ...,
"SnapshotName": ...,
}
parent.create_snapshot(**kwargs)
create_subnet_group#
Creates a subnet group.
Type annotations and code completion for boto3.client("memorydb").create_subnet_group
method.
boto3 documentation
# create_subnet_group method definition
def create_subnet_group(
self,
*,
SubnetGroupName: str,
SubnetIds: Sequence[str],
Description: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateSubnetGroupResponseTypeDef: # (2)
...
# create_subnet_group method usage example with argument unpacking
kwargs: CreateSubnetGroupRequestRequestTypeDef = { # (1)
"SubnetGroupName": ...,
"SubnetIds": ...,
}
parent.create_subnet_group(**kwargs)
create_user#
Creates a MemoryDB user.
Type annotations and code completion for boto3.client("memorydb").create_user
method.
boto3 documentation
# create_user method definition
def create_user(
self,
*,
UserName: str,
AuthenticationMode: AuthenticationModeTypeDef, # (1)
AccessString: str,
Tags: Sequence[TagTypeDef] = ..., # (2)
) -> CreateUserResponseTypeDef: # (3)
...
# create_user method usage example with argument unpacking
kwargs: CreateUserRequestRequestTypeDef = { # (1)
"UserName": ...,
"AuthenticationMode": ...,
"AccessString": ...,
}
parent.create_user(**kwargs)
delete_acl#
Deletes an Access Control List.
Type annotations and code completion for boto3.client("memorydb").delete_acl
method.
boto3 documentation
# delete_acl method definition
def delete_acl(
self,
*,
ACLName: str,
) -> DeleteACLResponseTypeDef: # (1)
...
# delete_acl method usage example with argument unpacking
kwargs: DeleteACLRequestRequestTypeDef = { # (1)
"ACLName": ...,
}
parent.delete_acl(**kwargs)
delete_cluster#
Deletes a cluster.
Type annotations and code completion for boto3.client("memorydb").delete_cluster
method.
boto3 documentation
# delete_cluster method definition
def delete_cluster(
self,
*,
ClusterName: str,
FinalSnapshotName: str = ...,
) -> DeleteClusterResponseTypeDef: # (1)
...
# delete_cluster method usage example with argument unpacking
kwargs: DeleteClusterRequestRequestTypeDef = { # (1)
"ClusterName": ...,
}
parent.delete_cluster(**kwargs)
delete_parameter_group#
Deletes the specified parameter group.
Type annotations and code completion for boto3.client("memorydb").delete_parameter_group
method.
boto3 documentation
# delete_parameter_group method definition
def delete_parameter_group(
self,
*,
ParameterGroupName: str,
) -> DeleteParameterGroupResponseTypeDef: # (1)
...
# delete_parameter_group method usage example with argument unpacking
kwargs: DeleteParameterGroupRequestRequestTypeDef = { # (1)
"ParameterGroupName": ...,
}
parent.delete_parameter_group(**kwargs)
delete_snapshot#
Deletes an existing snapshot.
Type annotations and code completion for boto3.client("memorydb").delete_snapshot
method.
boto3 documentation
# delete_snapshot method definition
def delete_snapshot(
self,
*,
SnapshotName: str,
) -> DeleteSnapshotResponseTypeDef: # (1)
...
# delete_snapshot method usage example with argument unpacking
kwargs: DeleteSnapshotRequestRequestTypeDef = { # (1)
"SnapshotName": ...,
}
parent.delete_snapshot(**kwargs)
delete_subnet_group#
Deletes a subnet group.
Type annotations and code completion for boto3.client("memorydb").delete_subnet_group
method.
boto3 documentation
# delete_subnet_group method definition
def delete_subnet_group(
self,
*,
SubnetGroupName: str,
) -> DeleteSubnetGroupResponseTypeDef: # (1)
...
# delete_subnet_group method usage example with argument unpacking
kwargs: DeleteSubnetGroupRequestRequestTypeDef = { # (1)
"SubnetGroupName": ...,
}
parent.delete_subnet_group(**kwargs)
delete_user#
Deletes a user.
Type annotations and code completion for boto3.client("memorydb").delete_user
method.
boto3 documentation
# delete_user method definition
def delete_user(
self,
*,
UserName: str,
) -> DeleteUserResponseTypeDef: # (1)
...
# delete_user method usage example with argument unpacking
kwargs: DeleteUserRequestRequestTypeDef = { # (1)
"UserName": ...,
}
parent.delete_user(**kwargs)
describe_acls#
Returns a list of ACLs See also: AWS API Documentation.
Type annotations and code completion for boto3.client("memorydb").describe_acls
method.
boto3 documentation
# describe_acls method definition
def describe_acls(
self,
*,
ACLName: str = ...,
MaxResults: int = ...,
NextToken: str = ...,
) -> DescribeACLsResponseTypeDef: # (1)
...
# describe_acls method usage example with argument unpacking
kwargs: DescribeACLsRequestRequestTypeDef = { # (1)
"ACLName": ...,
}
parent.describe_acls(**kwargs)
describe_clusters#
Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific cluster if a cluster name is supplied.
Type annotations and code completion for boto3.client("memorydb").describe_clusters
method.
boto3 documentation
# describe_clusters method definition
def describe_clusters(
self,
*,
ClusterName: str = ...,
MaxResults: int = ...,
NextToken: str = ...,
ShowShardDetails: bool = ...,
) -> DescribeClustersResponseTypeDef: # (1)
...
# describe_clusters method usage example with argument unpacking
kwargs: DescribeClustersRequestRequestTypeDef = { # (1)
"ClusterName": ...,
}
parent.describe_clusters(**kwargs)
describe_engine_versions#
Returns a list of the available Redis engine versions.
Type annotations and code completion for boto3.client("memorydb").describe_engine_versions
method.
boto3 documentation
# describe_engine_versions method definition
def describe_engine_versions(
self,
*,
EngineVersion: str = ...,
ParameterGroupFamily: str = ...,
MaxResults: int = ...,
NextToken: str = ...,
DefaultOnly: bool = ...,
) -> DescribeEngineVersionsResponseTypeDef: # (1)
...
# describe_engine_versions method usage example with argument unpacking
kwargs: DescribeEngineVersionsRequestRequestTypeDef = { # (1)
"EngineVersion": ...,
}
parent.describe_engine_versions(**kwargs)
describe_events#
Returns events related to clusters, security groups, and parameter groups.
Type annotations and code completion for boto3.client("memorydb").describe_events
method.
boto3 documentation
# describe_events method definition
def describe_events(
self,
*,
SourceName: str = ...,
SourceType: SourceTypeType = ..., # (1)
StartTime: Union[datetime, str] = ...,
EndTime: Union[datetime, str] = ...,
Duration: int = ...,
MaxResults: int = ...,
NextToken: str = ...,
) -> DescribeEventsResponseTypeDef: # (2)
...
# describe_events method usage example with argument unpacking
kwargs: DescribeEventsRequestRequestTypeDef = { # (1)
"SourceName": ...,
}
parent.describe_events(**kwargs)
describe_parameter_groups#
Returns a list of parameter group descriptions.
Type annotations and code completion for boto3.client("memorydb").describe_parameter_groups
method.
boto3 documentation
# describe_parameter_groups method definition
def describe_parameter_groups(
self,
*,
ParameterGroupName: str = ...,
MaxResults: int = ...,
NextToken: str = ...,
) -> DescribeParameterGroupsResponseTypeDef: # (1)
...
# describe_parameter_groups method usage example with argument unpacking
kwargs: DescribeParameterGroupsRequestRequestTypeDef = { # (1)
"ParameterGroupName": ...,
}
parent.describe_parameter_groups(**kwargs)
describe_parameters#
Returns the detailed parameter list for a particular parameter group.
Type annotations and code completion for boto3.client("memorydb").describe_parameters
method.
boto3 documentation
# describe_parameters method definition
def describe_parameters(
self,
*,
ParameterGroupName: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> DescribeParametersResponseTypeDef: # (1)
...
# describe_parameters method usage example with argument unpacking
kwargs: DescribeParametersRequestRequestTypeDef = { # (1)
"ParameterGroupName": ...,
}
parent.describe_parameters(**kwargs)
describe_reserved_nodes#
Returns information about reserved nodes for this account, or about a specified reserved node.
Type annotations and code completion for boto3.client("memorydb").describe_reserved_nodes
method.
boto3 documentation
# describe_reserved_nodes method definition
def describe_reserved_nodes(
self,
*,
ReservationId: str = ...,
ReservedNodesOfferingId: str = ...,
NodeType: str = ...,
Duration: str = ...,
OfferingType: str = ...,
MaxResults: int = ...,
NextToken: str = ...,
) -> DescribeReservedNodesResponseTypeDef: # (1)
...
# describe_reserved_nodes method usage example with argument unpacking
kwargs: DescribeReservedNodesRequestRequestTypeDef = { # (1)
"ReservationId": ...,
}
parent.describe_reserved_nodes(**kwargs)
describe_reserved_nodes_offerings#
Lists available reserved node offerings.
Type annotations and code completion for boto3.client("memorydb").describe_reserved_nodes_offerings
method.
boto3 documentation
# describe_reserved_nodes_offerings method definition
def describe_reserved_nodes_offerings(
self,
*,
ReservedNodesOfferingId: str = ...,
NodeType: str = ...,
Duration: str = ...,
OfferingType: str = ...,
MaxResults: int = ...,
NextToken: str = ...,
) -> DescribeReservedNodesOfferingsResponseTypeDef: # (1)
...
# describe_reserved_nodes_offerings method usage example with argument unpacking
kwargs: DescribeReservedNodesOfferingsRequestRequestTypeDef = { # (1)
"ReservedNodesOfferingId": ...,
}
parent.describe_reserved_nodes_offerings(**kwargs)
describe_service_updates#
Returns details of the service updates See also: AWS API Documentation.
Type annotations and code completion for boto3.client("memorydb").describe_service_updates
method.
boto3 documentation
# describe_service_updates method definition
def describe_service_updates(
self,
*,
ServiceUpdateName: str = ...,
ClusterNames: Sequence[str] = ...,
Status: Sequence[ServiceUpdateStatusType] = ..., # (1)
MaxResults: int = ...,
NextToken: str = ...,
) -> DescribeServiceUpdatesResponseTypeDef: # (2)
...
# describe_service_updates method usage example with argument unpacking
kwargs: DescribeServiceUpdatesRequestRequestTypeDef = { # (1)
"ServiceUpdateName": ...,
}
parent.describe_service_updates(**kwargs)
describe_snapshots#
Returns information about cluster snapshots.
Type annotations and code completion for boto3.client("memorydb").describe_snapshots
method.
boto3 documentation
# describe_snapshots method definition
def describe_snapshots(
self,
*,
ClusterName: str = ...,
SnapshotName: str = ...,
Source: str = ...,
NextToken: str = ...,
MaxResults: int = ...,
ShowDetail: bool = ...,
) -> DescribeSnapshotsResponseTypeDef: # (1)
...
# describe_snapshots method usage example with argument unpacking
kwargs: DescribeSnapshotsRequestRequestTypeDef = { # (1)
"ClusterName": ...,
}
parent.describe_snapshots(**kwargs)
describe_subnet_groups#
Returns a list of subnet group descriptions.
Type annotations and code completion for boto3.client("memorydb").describe_subnet_groups
method.
boto3 documentation
# describe_subnet_groups method definition
def describe_subnet_groups(
self,
*,
SubnetGroupName: str = ...,
MaxResults: int = ...,
NextToken: str = ...,
) -> DescribeSubnetGroupsResponseTypeDef: # (1)
...
# describe_subnet_groups method usage example with argument unpacking
kwargs: DescribeSubnetGroupsRequestRequestTypeDef = { # (1)
"SubnetGroupName": ...,
}
parent.describe_subnet_groups(**kwargs)
describe_users#
Returns a list of users.
Type annotations and code completion for boto3.client("memorydb").describe_users
method.
boto3 documentation
# describe_users method definition
def describe_users(
self,
*,
UserName: str = ...,
Filters: Sequence[FilterTypeDef] = ..., # (1)
MaxResults: int = ...,
NextToken: str = ...,
) -> DescribeUsersResponseTypeDef: # (2)
...
# describe_users method usage example with argument unpacking
kwargs: DescribeUsersRequestRequestTypeDef = { # (1)
"UserName": ...,
}
parent.describe_users(**kwargs)
failover_shard#
Used to failover a shard.
Type annotations and code completion for boto3.client("memorydb").failover_shard
method.
boto3 documentation
# failover_shard method definition
def failover_shard(
self,
*,
ClusterName: str,
S