Skip to content

DAXClient#

Index > DAX > DAXClient

Auto-generated documentation for DAX type annotations stubs module types-boto3-dax.

DAXClient#

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

# DAXClient usage example

from boto3.session import Session
from types_boto3_dax.client import DAXClient

def get_dax_client() -> DAXClient:
    return Session().client("dax")

Exceptions#

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

# Exceptions.exceptions usage example

client = boto3.client("dax")

try:
    do_something(client)
except (
    client.exceptions.ClientError,
    client.exceptions.ClusterAlreadyExistsFault,
    client.exceptions.ClusterNotFoundFault,
    client.exceptions.ClusterQuotaForCustomerExceededFault,
    client.exceptions.InsufficientClusterCapacityFault,
    client.exceptions.InvalidARNFault,
    client.exceptions.InvalidClusterStateFault,
    client.exceptions.InvalidParameterCombinationException,
    client.exceptions.InvalidParameterGroupStateFault,
    client.exceptions.InvalidParameterValueException,
    client.exceptions.InvalidSubnet,
    client.exceptions.InvalidVPCNetworkStateFault,
    client.exceptions.NodeNotFoundFault,
    client.exceptions.NodeQuotaForClusterExceededFault,
    client.exceptions.NodeQuotaForCustomerExceededFault,
    client.exceptions.ParameterGroupAlreadyExistsFault,
    client.exceptions.ParameterGroupNotFoundFault,
    client.exceptions.ParameterGroupQuotaExceededFault,
    client.exceptions.ServiceLinkedRoleNotFoundFault,
    client.exceptions.ServiceQuotaExceededException,
    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,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from types_boto3_dax.client import Exceptions

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

Methods#

can_paginate#

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

# can_paginate method definition

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

generate_presigned_url#

Type annotations and code completion for boto3.client("dax").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:
    ...

create_cluster#

Creates a DAX cluster.

Type annotations and code completion for boto3.client("dax").create_cluster method. boto3 documentation

# create_cluster method definition

def create_cluster(
    self,
    *,
    ClusterName: str,
    NodeType: str,
    ReplicationFactor: int,
    IamRoleArn: str,
    Description: str = ...,
    AvailabilityZones: Sequence[str] = ...,
    SubnetGroupName: str = ...,
    SecurityGroupIds: Sequence[str] = ...,
    PreferredMaintenanceWindow: str = ...,
    NotificationTopicArn: str = ...,
    ParameterGroupName: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
    SSESpecification: SSESpecificationTypeDef = ...,  # (2)
    ClusterEndpointEncryptionType: ClusterEndpointEncryptionTypeType = ...,  # (3)
    NetworkType: NetworkTypeType = ...,  # (4)
) -> CreateClusterResponseTypeDef:  # (5)
    ...
  1. See Sequence[TagTypeDef]
  2. See SSESpecificationTypeDef
  3. See ClusterEndpointEncryptionTypeType
  4. See NetworkTypeType
  5. See CreateClusterResponseTypeDef
# create_cluster method usage example with argument unpacking

kwargs: CreateClusterRequestTypeDef = {  # (1)
    "ClusterName": ...,
    "NodeType": ...,
    "ReplicationFactor": ...,
    "IamRoleArn": ...,
}

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

create_parameter_group#

Creates a new parameter group.

Type annotations and code completion for boto3.client("dax").create_parameter_group method. boto3 documentation

# create_parameter_group method definition

def create_parameter_group(
    self,
    *,
    ParameterGroupName: str,
    Description: str = ...,
) -> CreateParameterGroupResponseTypeDef:  # (1)
    ...
  1. See CreateParameterGroupResponseTypeDef
# create_parameter_group method usage example with argument unpacking

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

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

create_subnet_group#

Creates a new subnet group.

Type annotations and code completion for boto3.client("dax").create_subnet_group method. boto3 documentation

# create_subnet_group method definition

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

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

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

decrease_replication_factor#

Removes one or more nodes from a DAX cluster.

Type annotations and code completion for boto3.client("dax").decrease_replication_factor method. boto3 documentation

# decrease_replication_factor method definition

def decrease_replication_factor(
    self,
    *,
    ClusterName: str,
    NewReplicationFactor: int,
    AvailabilityZones: Sequence[str] = ...,
    NodeIdsToRemove: Sequence[str] = ...,
) -> DecreaseReplicationFactorResponseTypeDef:  # (1)
    ...
  1. See DecreaseReplicationFactorResponseTypeDef
# decrease_replication_factor method usage example with argument unpacking

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

parent.decrease_replication_factor(**kwargs)
  1. See DecreaseReplicationFactorRequestTypeDef

delete_cluster#

Deletes a previously provisioned DAX cluster.

Type annotations and code completion for boto3.client("dax").delete_cluster method. boto3 documentation

# delete_cluster method definition

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

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

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

delete_parameter_group#

Deletes the specified parameter group.

Type annotations and code completion for boto3.client("dax").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: DeleteParameterGroupRequestTypeDef = {  # (1)
    "ParameterGroupName": ...,
}

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

delete_subnet_group#

Deletes a subnet group.

Type annotations and code completion for boto3.client("dax").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: DeleteSubnetGroupRequestTypeDef = {  # (1)
    "SubnetGroupName": ...,
}

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

describe_clusters#

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

Type annotations and code completion for boto3.client("dax").describe_clusters method. boto3 documentation

# describe_clusters method definition

def describe_clusters(
    self,
    *,
    ClusterNames: Sequence[str] = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeClustersResponseTypeDef:  # (1)
    ...
  1. See DescribeClustersResponseTypeDef
# describe_clusters method usage example with argument unpacking

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

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

describe_default_parameters#

Returns the default system parameter information for the DAX caching software.

Type annotations and code completion for boto3.client("dax").describe_default_parameters method. boto3 documentation

# describe_default_parameters method definition

def describe_default_parameters(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeDefaultParametersResponseTypeDef:  # (1)
    ...
  1. See DescribeDefaultParametersResponseTypeDef
# describe_default_parameters method usage example with argument unpacking

kwargs: DescribeDefaultParametersRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.describe_default_parameters(**kwargs)
  1. See DescribeDefaultParametersRequestTypeDef

describe_events#

Returns events related to DAX clusters and parameter groups.

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

# describe_events method definition

def describe_events(
    self,
    *,
    SourceName: str = ...,
    SourceType: SourceTypeType = ...,  # (1)
    StartTime: TimestampTypeDef = ...,
    EndTime: TimestampTypeDef = ...,
    Duration: int = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeEventsResponseTypeDef:  # (2)
    ...
  1. See SourceTypeType
  2. See DescribeEventsResponseTypeDef
# describe_events method usage example with argument unpacking

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

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

describe_parameter_groups#

Returns a list of parameter group descriptions.

Type annotations and code completion for boto3.client("dax").describe_parameter_groups method. boto3 documentation

# describe_parameter_groups method definition

def describe_parameter_groups(
    self,
    *,
    ParameterGroupNames: Sequence[str] = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeParameterGroupsResponseTypeDef:  # (1)
    ...
  1. See DescribeParameterGroupsResponseTypeDef
# describe_parameter_groups method usage example with argument unpacking

kwargs: DescribeParameterGroupsRequestTypeDef = {  # (1)
    "ParameterGroupNames": ...,
}

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

describe_parameters#

Returns the detailed parameter list for a particular parameter group.

Type annotations and code completion for boto3.client("dax").describe_parameters method. boto3 documentation

# describe_parameters method definition

def describe_parameters(
    self,
    *,
    ParameterGroupName: str,
    Source: str = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeParametersResponseTypeDef:  # (1)
    ...
  1. See DescribeParametersResponseTypeDef
# describe_parameters method usage example with argument unpacking

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

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

describe_subnet_groups#

Returns a list of subnet group descriptions.

Type annotations and code completion for boto3.client("dax").describe_subnet_groups method. boto3 documentation

# describe_subnet_groups method definition

def describe_subnet_groups(
    self,
    *,
    SubnetGroupNames: Sequence[str] = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeSubnetGroupsResponseTypeDef:  # (1)
    ...
  1. See DescribeSubnetGroupsResponseTypeDef
# describe_subnet_groups method usage example with argument unpacking

kwargs: DescribeSubnetGroupsRequestTypeDef = {  # (1)
    "SubnetGroupNames": ...,
}

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

increase_replication_factor#

Adds one or more nodes to a DAX cluster.

Type annotations and code completion for boto3.client("dax").increase_replication_factor method. boto3 documentation

# increase_replication_factor method definition

def increase_replication_factor(
    self,
    *,
    ClusterName: str,
    NewReplicationFactor: int,
    AvailabilityZones: Sequence[str] = ...,
) -> IncreaseReplicationFactorResponseTypeDef:  # (1)
    ...
  1. See IncreaseReplicationFactorResponseTypeDef
# increase_replication_factor method usage example with argument unpacking

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

parent.increase_replication_factor(**kwargs)
  1. See IncreaseReplicationFactorRequestTypeDef

list_tags#

List all of the tags for a DAX cluster.

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

# list_tags method definition

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

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

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

reboot_node#

Reboots a single node of a DAX cluster.

Type annotations and code completion for boto3.client("dax").reboot_node method. boto3 documentation

# reboot_node method definition

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

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

parent.reboot_node(**kwargs)
  1. See RebootNodeRequestTypeDef

tag_resource#

Associates a set of tags with a DAX resource.

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

# tag_resource method definition

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

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

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

untag_resource#

Removes the association of tags from a DAX resource.

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

# untag_resource method definition

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

kwargs: UntagResourceRequestTypeDef = {  # (1)
    "ResourceName": ...,
    "TagKeys": ...,
}

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

update_cluster#

Modifies the settings for a DAX cluster.

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

# update_cluster method definition

def update_cluster(
    self,
    *,
    ClusterName: str,
    Description: str = ...,
    PreferredMaintenanceWindow: str = ...,
    NotificationTopicArn: str = ...,
    NotificationTopicStatus: str = ...,
    ParameterGroupName: str = ...,
    SecurityGroupIds: Sequence[str] = ...,
) -> UpdateClusterResponseTypeDef:  # (1)
    ...
  1. See UpdateClusterResponseTypeDef
# update_cluster method usage example with argument unpacking

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

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

update_parameter_group#

Modifies the parameters of a parameter group.

Type annotations and code completion for boto3.client("dax").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 Sequence[ParameterNameValueTypeDef]
  2. See UpdateParameterGroupResponseTypeDef
# update_parameter_group method usage example with argument unpacking

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

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

update_subnet_group#

Modifies an existing subnet group.

Type annotations and code completion for boto3.client("dax").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: UpdateSubnetGroupRequestTypeDef = {  # (1)
    "SubnetGroupName": ...,
}

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

get_paginator#

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