DAXClient

Index > DAX > DAXClient

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

DAXClient

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

# DAXClient usage example

from boto3.session import Session
from mypy_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.SubnetQuotaExceededFault,
    client.exceptions.TagNotFoundFault,
    client.exceptions.TagQuotaPerResourceExceeded,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from mypy_boto3_dax.client import Exceptions

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

Methods

can_paginate

Check if an operation can be paginated.

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:
    ...

close

Closes underlying endpoint connections.

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

# close method definition

def close(
    self,
) -> None:
    ...

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)
) -> CreateClusterResponseTypeDef:  # (4)
    ...

1. See TagTypeDef
2. See SSESpecificationTypeDef
3. See ClusterEndpointEncryptionTypeType
4. See CreateClusterResponseTypeDef

# create_cluster method usage example with argument unpacking

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

parent.create_cluster(**kwargs)

1. See CreateClusterRequestRequestTypeDef

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: CreateParameterGroupRequestRequestTypeDef = {  # (1)
    "ParameterGroupName": ...,
}

parent.create_parameter_group(**kwargs)

1. See CreateParameterGroupRequestRequestTypeDef

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: CreateSubnetGroupRequestRequestTypeDef = {  # (1)
    "SubnetGroupName": ...,
    "SubnetIds": ...,
}

parent.create_subnet_group(**kwargs)

1. See CreateSubnetGroupRequestRequestTypeDef

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: DecreaseReplicationFactorRequestRequestTypeDef = {  # (1)
    "ClusterName": ...,
    "NewReplicationFactor": ...,
}

parent.decrease_replication_factor(**kwargs)

1. See DecreaseReplicationFactorRequestRequestTypeDef

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: 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("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: DeleteParameterGroupRequestRequestTypeDef = {  # (1)
    "ParameterGroupName": ...,
}

parent.delete_parameter_group(**kwargs)

1. See