Skip to content

Type definitions#

Index > AuroraDSQL > Type definitions

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

MultiRegionPropertiesUnionTypeDef#

# MultiRegionPropertiesUnionTypeDef Union usage example

from types_boto3_dsql.type_defs import MultiRegionPropertiesUnionTypeDef


def get_value() -> MultiRegionPropertiesUnionTypeDef:
    return ...


# MultiRegionPropertiesUnionTypeDef definition

MultiRegionPropertiesUnionTypeDef = Union[
    MultiRegionPropertiesTypeDef,  # (1)
    MultiRegionPropertiesOutputTypeDef,  # (2)
]
  1. See MultiRegionPropertiesTypeDef
  2. See MultiRegionPropertiesOutputTypeDef

ClusterSummaryTypeDef#

# ClusterSummaryTypeDef TypedDict usage example

from types_boto3_dsql.type_defs import ClusterSummaryTypeDef


def get_value() -> ClusterSummaryTypeDef:
    return {
        "identifier": ...,
    }


# ClusterSummaryTypeDef definition

class ClusterSummaryTypeDef(TypedDict):
    identifier: str,
    arn: str,

EncryptionDetailsTypeDef#

# EncryptionDetailsTypeDef TypedDict usage example

from types_boto3_dsql.type_defs import EncryptionDetailsTypeDef


def get_value() -> EncryptionDetailsTypeDef:
    return {
        "encryptionType": ...,
    }


# EncryptionDetailsTypeDef definition

class EncryptionDetailsTypeDef(TypedDict):
    encryptionType: EncryptionTypeType,  # (1)
    encryptionStatus: EncryptionStatusType,  # (2)
    kmsKeyArn: NotRequired[str],
  1. See EncryptionTypeType
  2. See EncryptionStatusType

MultiRegionPropertiesOutputTypeDef#

# MultiRegionPropertiesOutputTypeDef TypedDict usage example

from types_boto3_dsql.type_defs import MultiRegionPropertiesOutputTypeDef


def get_value() -> MultiRegionPropertiesOutputTypeDef:
    return {
        "witnessRegion": ...,
    }


# MultiRegionPropertiesOutputTypeDef definition

class MultiRegionPropertiesOutputTypeDef(TypedDict):
    witnessRegion: NotRequired[str],
    clusters: NotRequired[List[str]],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef TypedDict usage example

from types_boto3_dsql.type_defs import ResponseMetadataTypeDef


def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
    }


# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

DeleteClusterInputTypeDef#

# DeleteClusterInputTypeDef TypedDict usage example

from types_boto3_dsql.type_defs import DeleteClusterInputTypeDef


def get_value() -> DeleteClusterInputTypeDef:
    return {
        "identifier": ...,
    }


# DeleteClusterInputTypeDef definition

class DeleteClusterInputTypeDef(TypedDict):
    identifier: str,
    clientToken: NotRequired[str],

DeleteClusterPolicyInputTypeDef#

# DeleteClusterPolicyInputTypeDef TypedDict usage example

from types_boto3_dsql.type_defs import DeleteClusterPolicyInputTypeDef


def get_value() -> DeleteClusterPolicyInputTypeDef:
    return {
        "identifier": ...,
    }


# DeleteClusterPolicyInputTypeDef definition

class DeleteClusterPolicyInputTypeDef(TypedDict):
    identifier: str,
    expectedPolicyVersion: NotRequired[str],
    clientToken: NotRequired[str],

GetClusterInputTypeDef#

# GetClusterInputTypeDef TypedDict usage example

from types_boto3_dsql.type_defs import GetClusterInputTypeDef


def get_value() -> GetClusterInputTypeDef:
    return {
        "identifier": ...,
    }


# GetClusterInputTypeDef definition

class GetClusterInputTypeDef(TypedDict):
    identifier: str,

WaiterConfigTypeDef#

# WaiterConfigTypeDef TypedDict usage example

from types_boto3_dsql.type_defs import WaiterConfigTypeDef


def get_value() -> WaiterConfigTypeDef:
    return {
        "Delay": ...,
    }


# WaiterConfigTypeDef definition

class WaiterConfigTypeDef(TypedDict):
    Delay: NotRequired[int],
    MaxAttempts: NotRequired[int],

GetClusterPolicyInputTypeDef#

# GetClusterPolicyInputTypeDef TypedDict usage example

from types_boto3_dsql.type_defs import GetClusterPolicyInputTypeDef


def get_value() -> GetClusterPolicyInputTypeDef:
    return {
        "identifier": ...,
    }


# GetClusterPolicyInputTypeDef definition

class GetClusterPolicyInputTypeDef(TypedDict):
    identifier: str,

GetVpcEndpointServiceNameInputTypeDef#

# GetVpcEndpointServiceNameInputTypeDef TypedDict usage example

from types_boto3_dsql.type_defs import GetVpcEndpointServiceNameInputTypeDef


def get_value() -> GetVpcEndpointServiceNameInputTypeDef:
    return {
        "identifier": ...,
    }


# GetVpcEndpointServiceNameInputTypeDef definition

class GetVpcEndpointServiceNameInputTypeDef(TypedDict):
    identifier: str,

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef TypedDict usage example

from types_boto3_dsql.type_defs import PaginatorConfigTypeDef


def get_value() -> PaginatorConfigTypeDef:
    return {
        "MaxItems": ...,
    }


# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ListClustersInputTypeDef#

# ListClustersInputTypeDef TypedDict usage example

from types_boto3_dsql.type_defs import ListClustersInputTypeDef


def get_value() -> ListClustersInputTypeDef:
    return {
        "maxResults": ...,
    }


# ListClustersInputTypeDef definition

class ListClustersInputTypeDef(TypedDict):
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

ListTagsForResourceInputTypeDef#

# ListTagsForResourceInputTypeDef TypedDict usage example

from types_boto3_dsql.type_defs import ListTagsForResourceInputTypeDef


def get_value() -> ListTagsForResourceInputTypeDef:
    return {
        "resourceArn": ...,
    }


# ListTagsForResourceInputTypeDef definition

class ListTagsForResourceInputTypeDef(TypedDict):
    resourceArn: str,

MultiRegionPropertiesTypeDef#

# MultiRegionPropertiesTypeDef TypedDict usage example

from types_boto3_dsql.type_defs import MultiRegionPropertiesTypeDef


def get_value() -> MultiRegionPropertiesTypeDef:
    return {
        "witnessRegion": ...,
    }


# MultiRegionPropertiesTypeDef definition

class MultiRegionPropertiesTypeDef(TypedDict):
    witnessRegion: NotRequired[str],
    clusters: NotRequired[Sequence[str]],

PutClusterPolicyInputTypeDef#

# PutClusterPolicyInputTypeDef TypedDict usage example

from types_boto3_dsql.type_defs import PutClusterPolicyInputTypeDef


def get_value() -> PutClusterPolicyInputTypeDef:
    return {
        "identifier": ...,
    }


# PutClusterPolicyInputTypeDef definition

class PutClusterPolicyInputTypeDef(TypedDict):
    identifier: str,
    policy: str,
    bypassPolicyLockoutSafetyCheck: NotRequired[bool],
    expectedPolicyVersion: NotRequired[str],
    clientToken: NotRequired[str],

TagResourceInputTypeDef#

# TagResourceInputTypeDef TypedDict usage example

from types_boto3_dsql.type_defs import TagResourceInputTypeDef


def get_value() -> TagResourceInputTypeDef:
    return {
        "resourceArn": ...,
    }


# TagResourceInputTypeDef definition

class TagResourceInputTypeDef(TypedDict):
    resourceArn: str,
    tags: Mapping[str, str],

UntagResourceInputTypeDef#

# UntagResourceInputTypeDef TypedDict usage example

from types_boto3_dsql.type_defs import UntagResourceInputTypeDef


def get_value() -> UntagResourceInputTypeDef:
    return {
        "resourceArn": ...,
    }


# UntagResourceInputTypeDef definition

class UntagResourceInputTypeDef(TypedDict):
    resourceArn: str,
    tagKeys: Sequence[str],

CreateClusterOutputTypeDef#

# CreateClusterOutputTypeDef TypedDict usage example

from types_boto3_dsql.type_defs import CreateClusterOutputTypeDef


def get_value() -> CreateClusterOutputTypeDef:
    return {
        "identifier": ...,
    }


# CreateClusterOutputTypeDef definition

class CreateClusterOutputTypeDef(TypedDict):
    identifier: str,
    arn: str,
    status: ClusterStatusType,  # (1)
    creationTime: datetime.datetime,
    multiRegionProperties: MultiRegionPropertiesOutputTypeDef,  # (2)
    encryptionDetails: EncryptionDetailsTypeDef,  # (3)
    deletionProtectionEnabled: bool,
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See ClusterStatusType
  2. See MultiRegionPropertiesOutputTypeDef
  3. See EncryptionDetailsTypeDef
  4. See ResponseMetadataTypeDef

DeleteClusterOutputTypeDef#

# DeleteClusterOutputTypeDef TypedDict usage example

from types_boto3_dsql.type_defs import DeleteClusterOutputTypeDef


def get_value() -> DeleteClusterOutputTypeDef:
    return {
        "identifier": ...,
    }


# DeleteClusterOutputTypeDef definition

class DeleteClusterOutputTypeDef(TypedDict):
    identifier: str,
    arn: str,
    status: ClusterStatusType,  # (1)
    creationTime: datetime.datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ClusterStatusType
  2. See ResponseMetadataTypeDef

DeleteClusterPolicyOutputTypeDef#

# DeleteClusterPolicyOutputTypeDef TypedDict usage example

from types_boto3_dsql.type_defs import DeleteClusterPolicyOutputTypeDef


def get_value() -> DeleteClusterPolicyOutputTypeDef:
    return {
        "policyVersion": ...,
    }


# DeleteClusterPolicyOutputTypeDef definition

class DeleteClusterPolicyOutputTypeDef(TypedDict):
    policyVersion: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

EmptyResponseMetadataTypeDef#

# EmptyResponseMetadataTypeDef TypedDict usage example

from types_boto3_dsql.type_defs import EmptyResponseMetadataTypeDef


def get_value() -> EmptyResponseMetadataTypeDef:
    return {
        "ResponseMetadata": ...,
    }


# EmptyResponseMetadataTypeDef definition

class EmptyResponseMetadataTypeDef(TypedDict):
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetClusterOutputTypeDef#

# GetClusterOutputTypeDef TypedDict usage example

from types_boto3_dsql.type_defs import GetClusterOutputTypeDef


def get_value() -> GetClusterOutputTypeDef:
    return {
        "identifier": ...,
    }


# GetClusterOutputTypeDef definition

class GetClusterOutputTypeDef(TypedDict):
    identifier: str,
    arn: str,
    status: ClusterStatusType,  # (1)
    creationTime: datetime.datetime,
    deletionProtectionEnabled: bool,
    multiRegionProperties: MultiRegionPropertiesOutputTypeDef,  # (2)
    tags: Dict[str, str],
    encryptionDetails: EncryptionDetailsTypeDef,  # (3)
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See ClusterStatusType
  2. See MultiRegionPropertiesOutputTypeDef
  3. See EncryptionDetailsTypeDef
  4. See ResponseMetadataTypeDef

GetClusterPolicyOutputTypeDef#

# GetClusterPolicyOutputTypeDef TypedDict usage example

from types_boto3_dsql.type_defs import GetClusterPolicyOutputTypeDef


def get_value() -> GetClusterPolicyOutputTypeDef:
    return {
        "policy": ...,
    }


# GetClusterPolicyOutputTypeDef definition

class GetClusterPolicyOutputTypeDef(TypedDict):
    policy: str,
    policyVersion: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetVpcEndpointServiceNameOutputTypeDef#

# GetVpcEndpointServiceNameOutputTypeDef TypedDict usage example

from types_boto3_dsql.type_defs import GetVpcEndpointServiceNameOutputTypeDef


def get_value() -> GetVpcEndpointServiceNameOutputTypeDef:
    return {
        "serviceName": ...,
    }


# GetVpcEndpointServiceNameOutputTypeDef definition

class GetVpcEndpointServiceNameOutputTypeDef(TypedDict):
    serviceName: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListClustersOutputTypeDef#

# ListClustersOutputTypeDef TypedDict usage example

from types_boto3_dsql.type_defs import ListClustersOutputTypeDef


def get_value() -> ListClustersOutputTypeDef:
    return {
        "nextToken": ...,
    }


# ListClustersOutputTypeDef definition

class ListClustersOutputTypeDef(TypedDict):
    clusters: List[ClusterSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See List[ClusterSummaryTypeDef]
  2. See ResponseMetadataTypeDef

ListTagsForResourceOutputTypeDef#

# ListTagsForResourceOutputTypeDef TypedDict usage example

from types_boto3_dsql.type_defs import ListTagsForResourceOutputTypeDef


def get_value() -> ListTagsForResourceOutputTypeDef:
    return {
        "tags": ...,
    }


# ListTagsForResourceOutputTypeDef definition

class ListTagsForResourceOutputTypeDef(TypedDict):
    tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

PutClusterPolicyOutputTypeDef#

# PutClusterPolicyOutputTypeDef TypedDict usage example

from types_boto3_dsql.type_defs import PutClusterPolicyOutputTypeDef


def get_value() -> PutClusterPolicyOutputTypeDef:
    return {
        "policyVersion": ...,
    }


# PutClusterPolicyOutputTypeDef definition

class PutClusterPolicyOutputTypeDef(TypedDict):
    policyVersion: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateClusterOutputTypeDef#

# UpdateClusterOutputTypeDef TypedDict usage example

from types_boto3_dsql.type_defs import UpdateClusterOutputTypeDef


def get_value() -> UpdateClusterOutputTypeDef:
    return {
        "identifier": ...,
    }


# UpdateClusterOutputTypeDef definition

class UpdateClusterOutputTypeDef(TypedDict):
    identifier: str,
    arn: str,
    status: ClusterStatusType,  # (1)
    creationTime: datetime.datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ClusterStatusType
  2. See ResponseMetadataTypeDef

GetClusterInputWaitExtraTypeDef#

# GetClusterInputWaitExtraTypeDef TypedDict usage example

from types_boto3_dsql.type_defs import GetClusterInputWaitExtraTypeDef


def get_value() -> GetClusterInputWaitExtraTypeDef:
    return {
        "identifier": ...,
    }


# GetClusterInputWaitExtraTypeDef definition

class GetClusterInputWaitExtraTypeDef(TypedDict):
    identifier: str,
    WaiterConfig: NotRequired[WaiterConfigTypeDef],  # (1)
  1. See WaiterConfigTypeDef

GetClusterInputWaitTypeDef#

# GetClusterInputWaitTypeDef TypedDict usage example

from types_boto3_dsql.type_defs import GetClusterInputWaitTypeDef


def get_value() -> GetClusterInputWaitTypeDef:
    return {
        "identifier": ...,
    }


# GetClusterInputWaitTypeDef definition

class GetClusterInputWaitTypeDef(TypedDict):
    identifier: str,
    WaiterConfig: NotRequired[WaiterConfigTypeDef],  # (1)
  1. See WaiterConfigTypeDef

ListClustersInputPaginateTypeDef#

# ListClustersInputPaginateTypeDef TypedDict usage example

from types_boto3_dsql.type_defs import ListClustersInputPaginateTypeDef


def get_value() -> ListClustersInputPaginateTypeDef:
    return {
        "PaginationConfig": ...,
    }


# ListClustersInputPaginateTypeDef definition

class ListClustersInputPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

CreateClusterInputTypeDef#

# CreateClusterInputTypeDef TypedDict usage example

from types_boto3_dsql.type_defs import CreateClusterInputTypeDef


def get_value() -> CreateClusterInputTypeDef:
    return {
        "deletionProtectionEnabled": ...,
    }


# CreateClusterInputTypeDef definition

class CreateClusterInputTypeDef(TypedDict):
    deletionProtectionEnabled: NotRequired[bool],
    kmsEncryptionKey: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],
    clientToken: NotRequired[str],
    multiRegionProperties: NotRequired[MultiRegionPropertiesUnionTypeDef],  # (1)
    policy: NotRequired[str],
    bypassPolicyLockoutSafetyCheck: NotRequired[bool],
  1. See MultiRegionPropertiesUnionTypeDef

UpdateClusterInputTypeDef#

# UpdateClusterInputTypeDef TypedDict usage example

from types_boto3_dsql.type_defs import UpdateClusterInputTypeDef


def get_value() -> UpdateClusterInputTypeDef:
    return {
        "identifier": ...,
    }


# UpdateClusterInputTypeDef definition

class UpdateClusterInputTypeDef(TypedDict):
    identifier: str,
    deletionProtectionEnabled: NotRequired[bool],
    kmsEncryptionKey: NotRequired[str],
    clientToken: NotRequired[str],
    multiRegionProperties: NotRequired[MultiRegionPropertiesUnionTypeDef],  # (1)
  1. See MultiRegionPropertiesUnionTypeDef