Skip to content

MemoryDBClient#

Index > MemoryDB > 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)
    ...
  1. See ServiceUpdateRequestTypeDef
  2. See BatchUpdateClusterResponseTypeDef 
# batch_update_cluster method usage example with argument unpacking

kwargs: BatchUpdateClusterRequestRequestTypeDef = {  # (1)
    "ClusterNames": ...,
}

parent.batch_update_cluster(**kwargs)
  1. See BatchUpdateClusterRequestRequestTypeDef

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)
    ...
  1. See TagTypeDef
  2. See CopySnapshotResponseTypeDef 
# copy_snapshot method usage example with argument unpacking

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

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

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)
    ...
  1. See TagTypeDef
  2. See CreateACLResponseTypeDef 
# create_acl method usage example with argument unpacking

kwargs: CreateACLRequestRequestTypeDef = {  # (1)
    "ACLName": ...,
}

parent.create_acl(**kwargs)
  1. See CreateACLRequestRequestTypeDef

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)
    ...
  1. See TagTypeDef
  2. See CreateClusterResponseTypeDef 
# create_cluster method usage example with argument unpacking

kwargs: CreateClusterRequestRequestTypeDef = {  # (1)
    "ClusterName": ...,
    "NodeType": ...,
    "ACLName": ...,
}

parent.create_cluster(**kwargs)
  1. See CreateClusterRequestRequestTypeDef

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)
    ...
  1. See TagTypeDef
  2. See CreateParameterGroupResponseTypeDef 
# create_parameter_group method usage example with argument unpacking

kwargs: CreateParameterGroupRequestRequestTypeDef = {  # (1)
    "ParameterGroupName": ...,
    "Family": ...,
}

parent.create_parameter_group(**kwargs)
  1. See CreateParameterGroupRequestRequestTypeDef

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)
    ...
  1. See TagTypeDef
  2. See CreateSnapshotResponseTypeDef 
# create_snapshot method usage example with argument unpacking

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

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

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)
    ...
  1. See TagTypeDef
  2. See CreateSubnetGroupResponseTypeDef 
# create_subnet_group method usage example with argument unpacking

kwargs: CreateSubnetGroupRequestRequestTypeDef = {  # (1)
    "SubnetGroupName": ...,
    "SubnetIds": ...,
}

parent.create_subnet_group(**kwargs)
  1. See CreateSubnetGroupRequestRequestTypeDef

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)
    ...
  1. See AuthenticationModeTypeDef
  2. See TagTypeDef
  3. See CreateUserResponseTypeDef 
# create_user method usage example with argument unpacking

kwargs: CreateUserRequestRequestTypeDef = {  # (1)
    "UserName": ...,
    "AuthenticationMode": ...,
    "AccessString": ...,
}

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

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)
    ...
  1. See DeleteACLResponseTypeDef 
# delete_acl method usage example with argument unpacking

kwargs: DeleteACLRequestRequestTypeDef = {  # (1)
    "ACLName": ...,
}

parent.delete_acl(**kwargs)
  1. See DeleteACLRequestRequestTypeDef

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)
    ...
  1. See DeleteClusterResponseTypeDef 
# delete_cluster method usage example with argument unpacking

kwargs: DeleteClusterRequestRequestTypeDef = {  # (1)
    "ClusterName": ...,
}

parent.delete_cluster(**kwargs)
  1. See DeleteClusterRequestRequestTypeDef

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)
    ...
  1. See DeleteParameterGroupResponseTypeDef 
# delete_parameter_group method usage example with argument unpacking

kwargs: DeleteParameterGroupRequestRequestTypeDef = {  # (1)
    "ParameterGroupName": ...,
}

parent.delete_parameter_group(**kwargs)
  1. See DeleteParameterGroupRequestRequestTypeDef

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)
    ...
  1. See DeleteSnapshotResponseTypeDef 
# delete_snapshot method usage example with argument unpacking

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

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

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)
    ...
  1. See DeleteSubnetGroupResponseTypeDef 
# delete_subnet_group method usage example with argument unpacking

kwargs: DeleteSubnetGroupRequestRequestTypeDef = {  # (1)
    "SubnetGroupName": ...,
}

parent.delete_subnet_group(**kwargs)
  1. See DeleteSubnetGroupRequestRequestTypeDef

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)
    ...
  1. See DeleteUserResponseTypeDef 
# delete_user method usage example with argument unpacking

kwargs: DeleteUserRequestRequestTypeDef = {  # (1)
    "UserName": ...,
}

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

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)
    ...
  1. See DescribeACLsResponseTypeDef 
# describe_acls method usage example with argument unpacking

kwargs: DescribeACLsRequestRequestTypeDef = {  # (1)
    "ACLName": ...,
}

parent.describe_acls(**kwargs)
  1. See DescribeACLsRequestRequestTypeDef

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)
    ...
  1. See DescribeClustersResponseTypeDef 
# describe_clusters method usage example with argument unpacking

kwargs: DescribeClustersRequestRequestTypeDef = {  # (1)
    "ClusterName": ...,
}

parent.describe_clusters(**kwargs)
  1. See DescribeClustersRequestRequestTypeDef

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)
    ...
  1. See DescribeEngineVersionsResponseTypeDef 
# describe_engine_versions method usage example with argument unpacking

kwargs: DescribeEngineVersionsRequestRequestTypeDef = {  # (1)
    "EngineVersion": ...,
}

parent.describe_engine_versions(**kwargs)
  1. See DescribeEngineVersionsRequestRequestTypeDef

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)
    ...
  1. See SourceTypeType
  2. See DescribeEventsResponseTypeDef 
# describe_events method usage example with argument unpacking

kwargs: DescribeEventsRequestRequestTypeDef = {  # (1)
    "SourceName": ...,
}

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

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)
    ...
  1. See DescribeParameterGroupsResponseTypeDef 
# describe_parameter_groups method usage example with argument unpacking

kwargs: DescribeParameterGroupsRequestRequestTypeDef = {  # (1)
    "ParameterGroupName": ...,
}

parent.describe_parameter_groups(**kwargs)
  1. See DescribeParameterGroupsRequestRequestTypeDef

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)
    ...
  1. See DescribeParametersResponseTypeDef 
# describe_parameters method usage example with argument unpacking

kwargs: DescribeParametersRequestRequestTypeDef = {  # (1)
    "ParameterGroupName": ...,
}

parent.describe_parameters(**kwargs)
  1. See DescribeParametersRequestRequestTypeDef

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)
    ...
  1. See DescribeReservedNodesResponseTypeDef 
# describe_reserved_nodes method usage example with argument unpacking

kwargs: DescribeReservedNodesRequestRequestTypeDef = {  # (1)
    "ReservationId": ...,
}

parent.describe_reserved_nodes(**kwargs)
  1. See DescribeReservedNodesRequestRequestTypeDef

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)
    ...
  1. See DescribeReservedNodesOfferingsResponseTypeDef 
# describe_reserved_nodes_offerings method usage example with argument unpacking

kwargs: DescribeReservedNodesOfferingsRequestRequestTypeDef = {  # (1)
    "ReservedNodesOfferingId": ...,
}

parent.describe_reserved_nodes_offerings(**kwargs)
  1. See DescribeReservedNodesOfferingsRequestRequestTypeDef

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)
    ...
  1. See ServiceUpdateStatusType
  2. See DescribeServiceUpdatesResponseTypeDef 
# describe_service_updates method usage example with argument unpacking

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

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

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)
    ...
  1. See DescribeSnapshotsResponseTypeDef 
# describe_snapshots method usage example with argument unpacking

kwargs: DescribeSnapshotsRequestRequestTypeDef = {  # (1)
    "ClusterName": ...,
}

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

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)
    ...
  1. See DescribeSubnetGroupsResponseTypeDef 
# describe_subnet_groups method usage example with argument unpacking

kwargs: DescribeSubnetGroupsRequestRequestTypeDef = {  # (1)
    "SubnetGroupName": ...,
}

parent.describe_subnet_groups(**kwargs)
  1. See DescribeSubnetGroupsRequestRequestTypeDef

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)
    ...
  1. See FilterTypeDef
  2. See DescribeUsersResponseTypeDef 
# describe_users method usage example with argument unpacking

kwargs: DescribeUsersRequestRequestTypeDef = {  # (1)
    "UserName": ...,
}

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

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,
    ShardName: str,
) -> FailoverShardResponseTypeDef:  # (1)
    ...
  1. See FailoverShardResponseTypeDef 
# failover_shard method usage example with argument unpacking

kwargs: FailoverShardRequestRequestTypeDef = {  # (1)
    "ClusterName": ...,
    "ShardName": ...,
}

parent.failover_shard(**kwargs)
  1. See FailoverShardRequestRequestTypeDef

generate_presigned_url#

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

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

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

list_allowed_node_type_updates#

Lists all available node types that you can scale to from your cluster's current node type.

Type annotations and code completion for boto3.client("memorydb").list_allowed_node_type_updates method. boto3 documentation

# list_allowed_node_type_updates method definition

def list_allowed_node_type_updates(
    self,
    *,
    ClusterName: str,
) -> ListAllowedNodeTypeUpdatesResponseTypeDef:  # (1)
    ...
  1. See ListAllowedNodeTypeUpdatesResponseTypeDef 
# list_allowed_node_type_updates method usage example with argument unpacking

kwargs: ListAllowedNodeTypeUpdatesRequestRequestTypeDef = {  # (1)
    "ClusterName": ...,
}

parent.list_allowed_node_type_updates(**kwargs)
  1. See ListAllowedNodeTypeUpdatesRequestRequestTypeDef

list_tags#

Lists all tags currently on a named resource.

Type annotations and code completion for boto3.client("memorydb").list_tags method. boto3 documentation

# list_tags method definition

def list_tags(
    self,
    *,
    ResourceArn: str,
) -> ListTagsResponseTypeDef:  # (1)
    ...
  1. See ListTagsResponseTypeDef 
# list_tags method usage example with argument unpacking

kwargs: ListTagsRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.list_tags(**kwargs)
  1. See ListTagsRequestRequestTypeDef

purchase_reserved_nodes_offering#

Allows you to purchase a reserved node offering.

Type annotations and code completion for boto3.client("memorydb").purchase_reserved_nodes_offering method. boto3 documentation

# purchase_reserved_nodes_offering method definition

def purchase_reserved_nodes_offering(
    self,
    *,
    ReservedNodesOfferingId: str,
    ReservationId: str = ...,
    NodeCount: int = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> PurchaseReservedNodesOfferingResponseTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See PurchaseReservedNodesOfferingResponseTypeDef 
# purchase_reserved_nodes_offering method usage example with argument unpacking

kwargs: PurchaseReservedNodesOfferingRequestRequestTypeDef = {  # (1)
    "ReservedNodesOfferingId": ...,
}

parent.purchase_reserved_nodes_offering(**kwargs)
  1. See PurchaseReservedNodesOfferingRequestRequestTypeDef

reset_parameter_group#

Modifies the parameters of a parameter group to the engine or system default value.

Type annotations and code completion for boto3.client("memorydb").reset_parameter_group method. boto3 documentation

# reset_parameter_group method definition

def reset_parameter_group(
    self,
    *,
    ParameterGroupName: str,
    AllParameters: bool = ...,
    ParameterNames: Sequence[str] = ...,
) -> ResetParameterGroupResponseTypeDef:  # (1)
    ...
  1. See ResetParameterGroupResponseTypeDef 
# reset_parameter_group method usage example with argument unpacking

kwargs: ResetParameterGroupRequestRequestTypeDef = {  # (1)
    "ParameterGroupName": ...,
}

parent.reset_parameter_group(**kwargs)
  1. See ResetParameterGroupRequestRequestTypeDef

tag_resource#

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

Type annotations and code completion for boto3.client("memorydb").tag_resource method. boto3 documentation

# tag_resource method definition

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

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceRequestRequestTypeDef

untag_resource#

Use this operation to remove tags on a resource See also: AWS API Documentation.

Type annotations and code completion for boto3.client("memorydb").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    ResourceArn: str,
    TagKeys: Sequence[str],
) -> UntagResourceResponseTypeDef:  # (1)
    ...
  1. See UntagResourceResponseTypeDef 
# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceRequestRequestTypeDef

update_acl#

Changes the list of users that belong to the Access Control List.

Type annotations and code completion for boto3.client("memorydb").update_acl method. boto3 documentation

# update_acl method definition

def update_acl(
    self,
    *,
    ACLName: str,
    UserNamesToAdd: Sequence[str] = ...,
    UserNamesToRemove: Sequence[str] = ...,
) -> UpdateACLResponseTypeDef:  # (1)
    ...
  1. See UpdateACLResponseTypeDef 
# update_acl method usage example with argument unpacking

kwargs: UpdateACLRequestRequestTypeDef = {  # (1)
    "ACLName": ...,
}

parent.update_acl(**kwargs)
  1. See UpdateACLRequestRequestTypeDef

update_cluster#

Modifies the settings for a cluster.

Type annotations and code completion for boto3.client("memorydb").update_cluster method. boto3 documentation

# update_cluster method definition

def update_cluster(
    self,
    *,
    ClusterName: str,
    Description: str = ...,
    SecurityGroupIds: Sequence[str] = ...,
    MaintenanceWindow: str = ...,
    SnsTopicArn: str = ...,
    SnsTopicStatus: str = ...,
    ParameterGroupName: str = ...,
    SnapshotWindow: str = ...,
    SnapshotRetentionLimit: int = ...,
    NodeType: str = ...,
    EngineVersion: str = ...,
    ReplicaConfiguration: ReplicaConfigurationRequestTypeDef = ...,  # (1)
    ShardConfiguration: ShardConfigurationRequestTypeDef = ...,  # (2)
    ACLName: str = ...,
) -> UpdateClusterResponseTypeDef:  # (3)
    ...
  1. See ReplicaConfigurationRequestTypeDef
  2. See ShardConfigurationRequestTypeDef
  3. See UpdateClusterResponseTypeDef 
# update_cluster method usage example with argument unpacking

kwargs: UpdateClusterRequestRequestTypeDef = {  # (1)
    "ClusterName": ...,
}

parent.update_cluster(**kwargs)
  1. See UpdateClusterRequestRequestTypeDef

update_parameter_group#

Updates the parameters of a parameter group.

Type annotations and code completion for boto3.client("memorydb").update_parameter_group method. boto3 documentation

# update_parameter_group method definition

def update_parameter_group(
    self,
    *,
    ParameterGroupName: str,
    ParameterNameValues: Sequence[ParameterNameValueTypeDef],  # (1)
) -> UpdateParameterGroupResponseTypeDef:  # (2)
    ...
  1. See ParameterNameValueTypeDef
  2. See UpdateParameterGroupResponseTypeDef 
# update_parameter_group method usage example with argument unpacking

kwargs: UpdateParameterGroupRequestRequestTypeDef = {  # (1)
    "ParameterGroupName": ...,
    "ParameterNameValues": ...,
}

parent.update_parameter_group(**kwargs)
  1. See UpdateParameterGroupRequestRequestTypeDef

update_subnet_group#

Updates a subnet group.

Type annotations and code completion for boto3.client("memorydb").update_subnet_group method. boto3 documentation

# update_subnet_group method definition

def update_subnet_group(
    self,
    *,
    SubnetGroupName: str,
    Description: str = ...,
    SubnetIds: Sequence[str] = ...,
) -> UpdateSubnetGroupResponseTypeDef:  # (1)
    ...
  1. See UpdateSubnetGroupResponseTypeDef 
# update_subnet_group method usage example with argument unpacking

kwargs: UpdateSubnetGroupRequestRequestTypeDef = {  # (1)
    "SubnetGroupName": ...,
}

parent.update_subnet_group(**kwargs)
  1. See UpdateSubnetGroupRequestRequestTypeDef

update_user#

Changes user password(s) and/or access string.

Type annotations and code completion for boto3.client("memorydb").update_user method. boto3 documentation

# update_user method definition

def update_user(
    self,
    *,
    UserName: str,
    AuthenticationMode: AuthenticationModeTypeDef = ...,  # (1)
    AccessString: str = ...,
) -> UpdateUserResponseTypeDef:  # (2)
    ...
  1. See AuthenticationModeTypeDef
  2. See UpdateUserResponseTypeDef 
# update_user method usage example with argument unpacking

kwargs: UpdateUserRequestRequestTypeDef = {  # (1)
    "UserName": ...,
}

parent.update_user(**kwargs)
  1. See UpdateUserRequestRequestTypeDef

get_paginator#

Type annotations and code completion for boto3.client("memorydb").get_paginator method with overloads.