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