Skip to content

AuroraDSQLClient#

Index > AuroraDSQL > AuroraDSQLClient

Auto-generated documentation for AuroraDSQL type annotations stubs module types-boto3-dsql.

AuroraDSQLClient#

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

# AuroraDSQLClient usage example

from boto3.session import Session
from types_boto3_dsql.client import AuroraDSQLClient

def get_dsql_client() -> AuroraDSQLClient:
    return Session().client("dsql")

Exceptions#

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

# Exceptions.exceptions usage example

client = boto3.client("dsql")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalServerException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ThrottlingException,
    client.exceptions.ValidationException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from types_boto3_dsql.client import Exceptions

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

Methods#

can_paginate#

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

The CreateCluster API allows you to create both single-Region clusters and multi-Region clusters.

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

# create_cluster method definition

def create_cluster(
    self,
    *,
    deletionProtectionEnabled: bool = ...,
    kmsEncryptionKey: str = ...,
    tags: Mapping[str, str] = ...,
    clientToken: str = ...,
    multiRegionProperties: MultiRegionPropertiesUnionTypeDef = ...,  # (1)
    policy: str = ...,
    bypassPolicyLockoutSafetyCheck: bool = ...,
) -> CreateClusterOutputTypeDef:  # (2)
    ...
  1. See MultiRegionPropertiesUnionTypeDef
  2. See CreateClusterOutputTypeDef
# create_cluster method usage example with argument unpacking

kwargs: CreateClusterInputTypeDef = {  # (1)
    "deletionProtectionEnabled": ...,
}

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

delete_cluster#

Deletes a cluster in Amazon Aurora DSQL.

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

# delete_cluster method definition

def delete_cluster(
    self,
    *,
    identifier: str,
    clientToken: str = ...,
) -> DeleteClusterOutputTypeDef:  # (1)
    ...
  1. See DeleteClusterOutputTypeDef
# delete_cluster method usage example with argument unpacking

kwargs: DeleteClusterInputTypeDef = {  # (1)
    "identifier": ...,
}

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

delete_cluster_policy#

Deletes the resource-based policy attached to a cluster.

Type annotations and code completion for boto3.client("dsql").delete_cluster_policy method. boto3 documentation

# delete_cluster_policy method definition

def delete_cluster_policy(
    self,
    *,
    identifier: str,
    expectedPolicyVersion: str = ...,
    clientToken: str = ...,
) -> DeleteClusterPolicyOutputTypeDef:  # (1)
    ...
  1. See DeleteClusterPolicyOutputTypeDef
# delete_cluster_policy method usage example with argument unpacking

kwargs: DeleteClusterPolicyInputTypeDef = {  # (1)
    "identifier": ...,
}

parent.delete_cluster_policy(**kwargs)
  1. See DeleteClusterPolicyInputTypeDef

get_cluster#

Retrieves information about a cluster.

Type annotations and code completion for boto3.client("dsql").get_cluster method. boto3 documentation

# get_cluster method definition

def get_cluster(
    self,
    *,
    identifier: str,
) -> GetClusterOutputTypeDef:  # (1)
    ...
  1. See GetClusterOutputTypeDef
# get_cluster method usage example with argument unpacking

kwargs: GetClusterInputTypeDef = {  # (1)
    "identifier": ...,
}

parent.get_cluster(**kwargs)
  1. See GetClusterInputTypeDef

get_cluster_policy#

Retrieves the resource-based policy document attached to a cluster.

Type annotations and code completion for boto3.client("dsql").get_cluster_policy method. boto3 documentation

# get_cluster_policy method definition

def get_cluster_policy(
    self,
    *,
    identifier: str,
) -> GetClusterPolicyOutputTypeDef:  # (1)
    ...
  1. See GetClusterPolicyOutputTypeDef
# get_cluster_policy method usage example with argument unpacking

kwargs: GetClusterPolicyInputTypeDef = {  # (1)
    "identifier": ...,
}

parent.get_cluster_policy(**kwargs)
  1. See GetClusterPolicyInputTypeDef

get_vpc_endpoint_service_name#

Retrieves the VPC endpoint service name.

Type annotations and code completion for boto3.client("dsql").get_vpc_endpoint_service_name method. boto3 documentation

# get_vpc_endpoint_service_name method definition

def get_vpc_endpoint_service_name(
    self,
    *,
    identifier: str,
) -> GetVpcEndpointServiceNameOutputTypeDef:  # (1)
    ...
  1. See GetVpcEndpointServiceNameOutputTypeDef
# get_vpc_endpoint_service_name method usage example with argument unpacking

kwargs: GetVpcEndpointServiceNameInputTypeDef = {  # (1)
    "identifier": ...,
}

parent.get_vpc_endpoint_service_name(**kwargs)
  1. See GetVpcEndpointServiceNameInputTypeDef

list_clusters#

Retrieves information about a list of clusters.

Type annotations and code completion for boto3.client("dsql").list_clusters method. boto3 documentation

# list_clusters method definition

def list_clusters(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListClustersOutputTypeDef:  # (1)
    ...
  1. See ListClustersOutputTypeDef
# list_clusters method usage example with argument unpacking

kwargs: ListClustersInputTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_clusters(**kwargs)
  1. See ListClustersInputTypeDef

list_tags_for_resource#

Lists all of the tags for a resource.

Type annotations and code completion for boto3.client("dsql").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceOutputTypeDef:  # (1)
    ...
  1. See ListTagsForResourceOutputTypeDef
# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceInputTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceInputTypeDef

put_cluster_policy#

Attaches a resource-based policy to a cluster.

Type annotations and code completion for boto3.client("dsql").put_cluster_policy method. boto3 documentation

# put_cluster_policy method definition

def put_cluster_policy(
    self,
    *,
    identifier: str,
    policy: str,
    bypassPolicyLockoutSafetyCheck: bool = ...,
    expectedPolicyVersion: str = ...,
    clientToken: str = ...,
) -> PutClusterPolicyOutputTypeDef:  # (1)
    ...
  1. See PutClusterPolicyOutputTypeDef
# put_cluster_policy method usage example with argument unpacking

kwargs: PutClusterPolicyInputTypeDef = {  # (1)
    "identifier": ...,
    "policy": ...,
}

parent.put_cluster_policy(**kwargs)
  1. See PutClusterPolicyInputTypeDef

tag_resource#

Tags a resource with a map of key and value pairs.

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

# tag_resource method definition

def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Mapping[str, str],
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# tag_resource method usage example with argument unpacking

kwargs: TagResourceInputTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

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

untag_resource#

Removes a tag from a resource.

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

# untag_resource method definition

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

kwargs: UntagResourceInputTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

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

update_cluster#

The UpdateCluster API allows you to modify both single-Region and multi-Region cluster configurations.

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

# update_cluster method definition

def update_cluster(
    self,
    *,
    identifier: str,
    deletionProtectionEnabled: bool = ...,
    kmsEncryptionKey: str = ...,
    clientToken: str = ...,
    multiRegionProperties: MultiRegionPropertiesUnionTypeDef = ...,  # (1)
) -> UpdateClusterOutputTypeDef:  # (2)
    ...
  1. See MultiRegionPropertiesUnionTypeDef
  2. See UpdateClusterOutputTypeDef
# update_cluster method usage example with argument unpacking

kwargs: UpdateClusterInputTypeDef = {  # (1)
    "identifier": ...,
}

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

get_paginator#

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

get_waiter#

Type annotations and code completion for boto3.client("dsql").get_waiter method with overloads.