Type definitions#
Index > DocDBElastic > Type definitions
Auto-generated documentation for DocDBElastic type annotations stubs module mypy-boto3-docdb-elastic.
ClusterInListTypeDef#
# ClusterInListTypeDef definition
class ClusterInListTypeDef(TypedDict):
clusterArn: str,
clusterName: str,
status: StatusType, # (1)
- See StatusType
ClusterSnapshotInListTypeDef#
# ClusterSnapshotInListTypeDef definition
class ClusterSnapshotInListTypeDef(TypedDict):
clusterArn: str,
snapshotArn: str,
snapshotCreationTime: str,
snapshotName: str,
status: StatusType, # (1)
- See StatusType
ClusterSnapshotTypeDef#
# ClusterSnapshotTypeDef definition
class ClusterSnapshotTypeDef(TypedDict):
adminUserName: str,
clusterArn: str,
clusterCreationTime: str,
kmsKeyId: str,
snapshotArn: str,
snapshotCreationTime: str,
snapshotName: str,
status: StatusType, # (1)
subnetIds: List[str],
vpcSecurityGroupIds: List[str],
- See StatusType
ClusterTypeDef#
# ClusterTypeDef definition
class ClusterTypeDef(TypedDict):
adminUserName: str,
authType: AuthType, # (1)
clusterArn: str,
clusterEndpoint: str,
clusterName: str,
createTime: str,
kmsKeyId: str,
preferredMaintenanceWindow: str,
shardCapacity: int,
shardCount: int,
status: StatusType, # (2)
subnetIds: List[str],
vpcSecurityGroupIds: List[str],
- See AuthType
- See StatusType
CreateClusterInputRequestTypeDef#
# CreateClusterInputRequestTypeDef definition
class CreateClusterInputRequestTypeDef(TypedDict):
adminUserName: str,
adminUserPassword: str,
authType: AuthType, # (1)
clusterName: str,
shardCapacity: int,
shardCount: int,
clientToken: NotRequired[str],
kmsKeyId: NotRequired[str],
preferredMaintenanceWindow: NotRequired[str],
subnetIds: NotRequired[Sequence[str]],
tags: NotRequired[Mapping[str, str]],
vpcSecurityGroupIds: NotRequired[Sequence[str]],
- See AuthType
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
CreateClusterSnapshotInputRequestTypeDef#
# CreateClusterSnapshotInputRequestTypeDef definition
class CreateClusterSnapshotInputRequestTypeDef(TypedDict):
clusterArn: str,
snapshotName: str,
tags: NotRequired[Mapping[str, str]],
DeleteClusterInputRequestTypeDef#
# DeleteClusterInputRequestTypeDef definition
class DeleteClusterInputRequestTypeDef(TypedDict):
clusterArn: str,
DeleteClusterSnapshotInputRequestTypeDef#
# DeleteClusterSnapshotInputRequestTypeDef definition
class DeleteClusterSnapshotInputRequestTypeDef(TypedDict):
snapshotArn: str,
GetClusterInputRequestTypeDef#
# GetClusterInputRequestTypeDef definition
class GetClusterInputRequestTypeDef(TypedDict):
clusterArn: str,
GetClusterSnapshotInputRequestTypeDef#
# GetClusterSnapshotInputRequestTypeDef definition
class GetClusterSnapshotInputRequestTypeDef(TypedDict):
snapshotArn: str,
PaginatorConfigTypeDef#
# PaginatorConfigTypeDef definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
ListClusterSnapshotsInputRequestTypeDef#
# ListClusterSnapshotsInputRequestTypeDef definition
class ListClusterSnapshotsInputRequestTypeDef(TypedDict):
clusterArn: NotRequired[str],
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListClustersInputRequestTypeDef#
# ListClustersInputRequestTypeDef definition
class ListClustersInputRequestTypeDef(TypedDict):
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListTagsForResourceRequestRequestTypeDef#
# ListTagsForResourceRequestRequestTypeDef definition
class ListTagsForResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
RestoreClusterFromSnapshotInputRequestTypeDef#
# RestoreClusterFromSnapshotInputRequestTypeDef definition
class RestoreClusterFromSnapshotInputRequestTypeDef(TypedDict):
clusterName: str,
snapshotArn: str,
kmsKeyId: NotRequired[str],
subnetIds: NotRequired[Sequence[str]],
tags: NotRequired[Mapping[str, str]],
vpcSecurityGroupIds: NotRequired[Sequence[str]],
TagResourceRequestRequestTypeDef#
# TagResourceRequestRequestTypeDef definition
class TagResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
tags: Mapping[str, str],
UntagResourceRequestRequestTypeDef#
# UntagResourceRequestRequestTypeDef definition
class UntagResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
tagKeys: Sequence[str],
UpdateClusterInputRequestTypeDef#
# UpdateClusterInputRequestTypeDef definition
class UpdateClusterInputRequestTypeDef(TypedDict):
clusterArn: str,
adminUserPassword: NotRequired[str],
authType: NotRequired[AuthType], # (1)
clientToken: NotRequired[str],
preferredMaintenanceWindow: NotRequired[str],
shardCapacity: NotRequired[int],
shardCount: NotRequired[int],
subnetIds: NotRequired[Sequence[str]],
vpcSecurityGroupIds: NotRequired[Sequence[str]],
- See AuthType
CreateClusterOutputTypeDef#
# CreateClusterOutputTypeDef definition
class CreateClusterOutputTypeDef(TypedDict):
cluster: ClusterTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateClusterSnapshotOutputTypeDef#
# CreateClusterSnapshotOutputTypeDef definition
class CreateClusterSnapshotOutputTypeDef(TypedDict):
snapshot: ClusterSnapshotTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DeleteClusterOutputTypeDef#
# DeleteClusterOutputTypeDef definition
class DeleteClusterOutputTypeDef(TypedDict):
cluster: ClusterTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DeleteClusterSnapshotOutputTypeDef#
# DeleteClusterSnapshotOutputTypeDef definition
class DeleteClusterSnapshotOutputTypeDef(TypedDict):
snapshot: ClusterSnapshotTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetClusterOutputTypeDef#
# GetClusterOutputTypeDef definition
class GetClusterOutputTypeDef(TypedDict):
cluster: ClusterTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetClusterSnapshotOutputTypeDef#
# GetClusterSnapshotOutputTypeDef definition
class GetClusterSnapshotOutputTypeDef(TypedDict):
snapshot: ClusterSnapshotTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListClusterSnapshotsOutputTypeDef#
# ListClusterSnapshotsOutputTypeDef definition
class ListClusterSnapshotsOutputTypeDef(TypedDict):
nextToken: str,
snapshots: List[ClusterSnapshotInListTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListClustersOutputTypeDef#
# ListClustersOutputTypeDef definition
class ListClustersOutputTypeDef(TypedDict):
clusters: List[ClusterInListTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListTagsForResourceResponseTypeDef#
# ListTagsForResourceResponseTypeDef definition
class ListTagsForResourceResponseTypeDef(TypedDict):
tags: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
RestoreClusterFromSnapshotOutputTypeDef#
# RestoreClusterFromSnapshotOutputTypeDef definition
class RestoreClusterFromSnapshotOutputTypeDef(TypedDict):
cluster: ClusterTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateClusterOutputTypeDef#
# UpdateClusterOutputTypeDef definition
class UpdateClusterOutputTypeDef(TypedDict):
cluster: ClusterTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListClusterSnapshotsInputListClusterSnapshotsPaginateTypeDef#
# ListClusterSnapshotsInputListClusterSnapshotsPaginateTypeDef definition
class ListClusterSnapshotsInputListClusterSnapshotsPaginateTypeDef(TypedDict):
clusterArn: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListClustersInputListClustersPaginateTypeDef#
# ListClustersInputListClustersPaginateTypeDef definition
class ListClustersInputListClustersPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)