Skip to content

Type definitions#

Index > AuroraDSQL > Type definitions

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

ClusterSummaryTypeDef#

# ClusterSummaryTypeDef definition

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

CreateClusterInputRequestTypeDef#

# CreateClusterInputRequestTypeDef definition

class CreateClusterInputRequestTypeDef(TypedDict):
    deletionProtectionEnabled: NotRequired[bool],
    tags: NotRequired[Mapping[str, str]],
    clientToken: NotRequired[str],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

LinkedClusterPropertiesTypeDef#

# LinkedClusterPropertiesTypeDef definition

class LinkedClusterPropertiesTypeDef(TypedDict):
    deletionProtectionEnabled: NotRequired[bool],
    tags: NotRequired[Mapping[str, str]],

DeleteClusterInputRequestTypeDef#

# DeleteClusterInputRequestTypeDef definition

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

DeleteMultiRegionClustersInputRequestTypeDef#

# DeleteMultiRegionClustersInputRequestTypeDef definition

class DeleteMultiRegionClustersInputRequestTypeDef(TypedDict):
    linkedClusterArns: Sequence[str],
    clientToken: NotRequired[str],

GetClusterInputRequestTypeDef#

# GetClusterInputRequestTypeDef definition

class GetClusterInputRequestTypeDef(TypedDict):
    identifier: str,

WaiterConfigTypeDef#

# WaiterConfigTypeDef definition

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

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

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

ListClustersInputRequestTypeDef#

# ListClustersInputRequestTypeDef definition

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

ListTagsForResourceInputRequestTypeDef#

# ListTagsForResourceInputRequestTypeDef definition

class ListTagsForResourceInputRequestTypeDef(TypedDict):
    resourceArn: str,

TagResourceInputRequestTypeDef#

# TagResourceInputRequestTypeDef definition

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

UntagResourceInputRequestTypeDef#

# UntagResourceInputRequestTypeDef definition

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

UpdateClusterInputRequestTypeDef#

# UpdateClusterInputRequestTypeDef definition

class UpdateClusterInputRequestTypeDef(TypedDict):
    identifier: str,
    deletionProtectionEnabled: NotRequired[bool],
    clientToken: NotRequired[str],

CreateClusterOutputTypeDef#

# CreateClusterOutputTypeDef definition

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

CreateMultiRegionClustersOutputTypeDef#

# CreateMultiRegionClustersOutputTypeDef definition

class CreateMultiRegionClustersOutputTypeDef(TypedDict):
    linkedClusterArns: list[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteClusterOutputTypeDef#

# DeleteClusterOutputTypeDef definition

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

EmptyResponseMetadataTypeDef#

# EmptyResponseMetadataTypeDef definition

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

GetClusterOutputTypeDef#

# GetClusterOutputTypeDef definition

class GetClusterOutputTypeDef(TypedDict):
    identifier: str,
    arn: str,
    status: ClusterStatusType,  # (1)
    creationTime: datetime,
    deletionProtectionEnabled: bool,
    witnessRegion: str,
    linkedClusterArns: list[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ClusterStatusType
  2. See ResponseMetadataTypeDef

ListClustersOutputTypeDef#

# ListClustersOutputTypeDef definition

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

ListTagsForResourceOutputTypeDef#

# ListTagsForResourceOutputTypeDef definition

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

UpdateClusterOutputTypeDef#

# UpdateClusterOutputTypeDef definition

class UpdateClusterOutputTypeDef(TypedDict):
    identifier: str,
    arn: str,
    status: ClusterStatusType,  # (1)
    creationTime: datetime,
    deletionProtectionEnabled: bool,
    witnessRegion: str,
    linkedClusterArns: list[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ClusterStatusType
  2. See ResponseMetadataTypeDef

CreateMultiRegionClustersInputRequestTypeDef#

# CreateMultiRegionClustersInputRequestTypeDef definition

class CreateMultiRegionClustersInputRequestTypeDef(TypedDict):
    linkedRegionList: Sequence[str],
    witnessRegion: str,
    clusterProperties: NotRequired[Mapping[str, LinkedClusterPropertiesTypeDef]],  # (1)
    clientToken: NotRequired[str],
  1. See LinkedClusterPropertiesTypeDef

GetClusterInputWaitTypeDef#

# GetClusterInputWaitTypeDef definition

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

ListClustersInputPaginateTypeDef#

# ListClustersInputPaginateTypeDef definition

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