Skip to content

Typed dictionaries

Index > DocDBElastic > Typed dictionaries

Auto-generated documentation for DocDBElastic type annotations stubs module mypy-boto3-docdb-elastic.

ClusterInListTypeDef

Usage Example
from mypy_boto3_docdb_elastic.type_defs import ClusterInListTypeDef

def get_value() -> ClusterInListTypeDef:
    return {
        "clusterArn": ...,
        "clusterName": ...,
        "status": ...,
    }
Definition
class ClusterInListTypeDef(TypedDict):
    clusterArn: str,
    clusterName: str,
    status: StatusType,  # (1)
  1. See StatusType

ClusterSnapshotInListTypeDef

Usage Example
from mypy_boto3_docdb_elastic.type_defs import ClusterSnapshotInListTypeDef

def get_value() -> ClusterSnapshotInListTypeDef:
    return {
        "clusterArn": ...,
        "snapshotArn": ...,
        "snapshotCreationTime": ...,
        "snapshotName": ...,
        "status": ...,
    }
Definition
class ClusterSnapshotInListTypeDef(TypedDict):
    clusterArn: str,
    snapshotArn: str,
    snapshotCreationTime: str,
    snapshotName: str,
    status: StatusType,  # (1)
  1. See StatusType

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": ...,
    }
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],
  1. See StatusType

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": ...,
    }
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],
  1. See AuthType
  2. See StatusType

CreateClusterInputRequestTypeDef

Usage Example
from mypy_boto3_docdb_elastic.type_defs import CreateClusterInputRequestTypeDef

def get_value() -> CreateClusterInputRequestTypeDef:
    return {
        "adminUserName": ...,
        "adminUserPassword": ...,
        "authType": ...,
        "clusterName": ...,
        "shardCapacity": ...,
        "shardCount": ...,
    }
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]],
  1. See AuthType

ResponseMetadataTypeDef

Usage Example
from mypy_boto3_docdb_elastic.type_defs import ResponseMetadataTypeDef

def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
        "HostId": ...,
        "HTTPStatusCode": ...,
        "HTTPHeaders": ...,
        "RetryAttempts": ...,
    }
Definition
class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

CreateClusterSnapshotInputRequestTypeDef

Usage Example
from mypy_boto3_docdb_elastic.type_defs import CreateClusterSnapshotInputRequestTypeDef

def get_value() -> CreateClusterSnapshotInputRequestTypeDef:
    return {
        "clusterArn": ...,
        "snapshotName": ...,
    }
Definition
class CreateClusterSnapshotInputRequestTypeDef(TypedDict):
    clusterArn: str,
    snapshotName: str,
    tags: NotRequired[Mapping[str, str]],

DeleteClusterInputRequestTypeDef

Usage Example
from mypy_boto3_docdb_elastic.type_defs import DeleteClusterInputRequestTypeDef

def get_value() -> DeleteClusterInputRequestTypeDef:
    return {
        "clusterArn": ...,
    }
Definition
class DeleteClusterInputRequestTypeDef(TypedDict):
    clusterArn: str,

DeleteClusterSnapshotInputRequestTypeDef

Usage Example
from mypy_boto3_docdb_elastic.type_defs import DeleteClusterSnapshotInputRequestTypeDef

def get_value() -> DeleteClusterSnapshotInputRequestTypeDef:
    return {
        "snapshotArn": ...,
    }
Definition
class DeleteClusterSnapshotInputRequestTypeDef(TypedDict):
    snapshotArn: str,

GetClusterInputRequestTypeDef

Usage Example
from mypy_boto3_docdb_elastic.type_defs import GetClusterInputRequestTypeDef

def get_value() -> GetClusterInputRequestTypeDef:
    return {
        "clusterArn": ...,
    }
Definition
class GetClusterInputRequestTypeDef(TypedDict):
    clusterArn: str,

GetClusterSnapshotInputRequestTypeDef

Usage Example
from mypy_boto3_docdb_elastic.type_defs import GetClusterSnapshotInputRequestTypeDef

def get_value() -> GetClusterSnapshotInputRequestTypeDef:
    return {
        "snapshotArn": ...,
    }
Definition
class GetClusterSnapshotInputRequestTypeDef(TypedDict):
    snapshotArn: str,

PaginatorConfigTypeDef

Usage Example
from mypy_boto3_docdb_elastic.type_defs import PaginatorConfigTypeDef

def get_value() -> PaginatorConfigTypeDef:
    return {
        "MaxItems": ...,
    }
Definition
class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ListClusterSnapshotsInputRequestTypeDef

Usage Example
from mypy_boto3_docdb_elastic.type_defs import ListClusterSnapshotsInputRequestTypeDef

def get_value() -> ListClusterSnapshotsInputRequestTypeDef:
    return {
        "clusterArn": ...,
    }
Definition
class ListClusterSnapshotsInputRequestTypeDef(TypedDict):
    clusterArn: NotRequired[str],
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

ListClustersInputRequestTypeDef

Usage Example
from mypy_boto3_docdb_elastic.type_defs import ListClustersInputRequestTypeDef

def get_value() -> ListClustersInputRequestTypeDef:
    return {
        "maxResults": ...,
    }
Definition
class ListClustersInputRequestTypeDef(TypedDict):
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

ListTagsForResourceRequestRequestTypeDef

Usage Example
from mypy_boto3_docdb_elastic.type_defs import ListTagsForResourceRequestRequestTypeDef

def get_value() -> ListTagsForResourceRequestRequestTypeDef:
    return {
        "resourceArn": ...,
    }
Definition
class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,

RestoreClusterFromSnapshotInputRequestTypeDef

Usage Example
from mypy_boto3_docdb_elastic.type_defs import RestoreClusterFromSnapshotInputRequestTypeDef

def get_value() -> RestoreClusterFromSnapshotInputRequestTypeDef:
    return {
        "clusterName": ...,
        "snapshotArn": ...,
    }
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

Usage Example
from mypy_boto3_docdb_elastic.type_defs import TagResourceRequestRequestTypeDef

def get_value() -> TagResourceRequestRequestTypeDef:
    return {
        "resourceArn": ...,
        "tags": ...,
    }
Definition
class TagResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    tags: Mapping[str, str],

UntagResourceRequestRequestTypeDef

Usage Example
from mypy_boto3_docdb_elastic.type_defs import UntagResourceRequestRequestTypeDef

def get_value() -> UntagResourceRequestRequestTypeDef:
    return {
        "resourceArn": ...,
        "tagKeys": ...,
    }
Definition
class UntagResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    tagKeys: Sequence[str],

UpdateClusterInputRequestTypeDef

Usage Example
from mypy_boto3_docdb_elastic.type_defs import UpdateClusterInputRequestTypeDef

def get_value() -> UpdateClusterInputRequestTypeDef:
    return {
        "clusterArn": ...,
    }
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]],
  1. See AuthType

CreateClusterOutputTypeDef

Usage Example
from mypy_boto3_docdb_elastic.type_defs import CreateClusterOutputTypeDef

def get_value() -> CreateClusterOutputTypeDef:
    return {
        "cluster": ...,
        "ResponseMetadata": ...,
    }
Definition
class CreateClusterOutputTypeDef(TypedDict):
    cluster: ClusterTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ClusterTypeDef
  2. See ResponseMetadataTypeDef

CreateClusterSnapshotOutputTypeDef

Usage Example
from mypy_boto3_docdb_elastic.type_defs import CreateClusterSnapshotOutputTypeDef

def get_value() -> CreateClusterSnapshotOutputTypeDef:
    return {
        "snapshot": ...,
        "ResponseMetadata": ...,
    }
Definition
class CreateClusterSnapshotOutputTypeDef(TypedDict):
    snapshot: ClusterSnapshotTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ClusterSnapshotTypeDef
  2. See ResponseMetadataTypeDef

DeleteClusterOutputTypeDef

Usage Example
from mypy_boto3_docdb_elastic.type_defs import DeleteClusterOutputTypeDef

def get_value() -> DeleteClusterOutputTypeDef:
    return {
        "cluster": ...,
        "ResponseMetadata": ...,
    }
Definition
class DeleteClusterOutputTypeDef(TypedDict):
    cluster: ClusterTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ClusterTypeDef
  2. See ResponseMetadataTypeDef

DeleteClusterSnapshotOutputTypeDef

Usage Example
from mypy_boto3_docdb_elastic.type_defs import DeleteClusterSnapshotOutputTypeDef

def get_value() -> DeleteClusterSnapshotOutputTypeDef:
    return {
        "snapshot": ...,
        "ResponseMetadata": ...,
    }
Definition
class DeleteClusterSnapshotOutputTypeDef(TypedDict):
    snapshot: ClusterSnapshotTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ClusterSnapshotTypeDef
  2. See ResponseMetadataTypeDef

GetClusterOutputTypeDef

Usage Example
from mypy_boto3_docdb_elastic.type_defs import GetClusterOutputTypeDef

def get_value() -> GetClusterOutputTypeDef:
    return {
        "cluster": ...,
        "ResponseMetadata": ...,
    }
Definition
class GetClusterOutputTypeDef(TypedDict):
    cluster: ClusterTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ClusterTypeDef
  2. See ResponseMetadataTypeDef

GetClusterSnapshotOutputTypeDef

Usage Example
from mypy_boto3_docdb_elastic.type_defs import GetClusterSnapshotOutputTypeDef

def get_value() -> GetClusterSnapshotOutputTypeDef:
    return {
        "snapshot": ...,
        "ResponseMetadata": ...,
    }
Definition
class GetClusterSnapshotOutputTypeDef(TypedDict):
    snapshot: ClusterSnapshotTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ClusterSnapshotTypeDef
  2. See ResponseMetadataTypeDef

ListClusterSnapshotsOutputTypeDef

Usage Example
from mypy_boto3_docdb_elastic.type_defs import ListClusterSnapshotsOutputTypeDef

def get_value() -> ListClusterSnapshotsOutputTypeDef:
    return {
        "nextToken": ...,
        "snapshots": ...,
        "ResponseMetadata": ...,
    }
Definition
class ListClusterSnapshotsOutputTypeDef(TypedDict):
    nextToken: str,
    snapshots: List[ClusterSnapshotInListTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ClusterSnapshotInListTypeDef
  2. See ResponseMetadataTypeDef

ListClustersOutputTypeDef

Usage Example
from mypy_boto3_docdb_elastic.type_defs import ListClustersOutputTypeDef

def get_value() -> ListClustersOutputTypeDef:
    return {
        "clusters": ...,
        "nextToken": ...,
        "ResponseMetadata": ...,
    }
Definition
class ListClustersOutputTypeDef(TypedDict):
    clusters: List[ClusterInListTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ClusterInListTypeDef
  2. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef

Usage Example
from mypy_boto3_docdb_elastic.type_defs import ListTagsForResourceResponseTypeDef

def get_value() -> ListTagsForResourceResponseTypeDef:
    return {
        "tags": ...,
        "ResponseMetadata": ...,
    }
Definition
class ListTagsForResourceResponseTypeDef(TypedDict):
    tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

RestoreClusterFromSnapshotOutputTypeDef

Usage Example
from mypy_boto3_docdb_elastic.type_defs import RestoreClusterFromSnapshotOutputTypeDef

def get_value() -> RestoreClusterFromSnapshotOutputTypeDef:
    return {
        "cluster": ...,
        "ResponseMetadata": ...,
    }
Definition
class RestoreClusterFromSnapshotOutputTypeDef(TypedDict):
    cluster: ClusterTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ClusterTypeDef
  2. See ResponseMetadataTypeDef

UpdateClusterOutputTypeDef

Usage Example
from mypy_boto3_docdb_elastic.type_defs import UpdateClusterOutputTypeDef

def get_value() -> UpdateClusterOutputTypeDef:
    return {
        "cluster": ...,
        "ResponseMetadata": ...,
    }
Definition
class UpdateClusterOutputTypeDef(TypedDict):
    cluster: ClusterTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ClusterTypeDef
  2. See ResponseMetadataTypeDef

ListClusterSnapshotsInputListClusterSnapshotsPaginateTypeDef

Usage Example
from mypy_boto3_docdb_elastic.type_defs import ListClusterSnapshotsInputListClusterSnapshotsPaginateTypeDef

def get_value() -> ListClusterSnapshotsInputListClusterSnapshotsPaginateTypeDef:
    return {
        "clusterArn": ...,
    }
Definition
class ListClusterSnapshotsInputListClusterSnapshotsPaginateTypeDef(TypedDict):
    clusterArn: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListClustersInputListClustersPaginateTypeDef

Usage Example
from mypy_boto3_docdb_elastic.type_defs import ListClustersInputListClustersPaginateTypeDef

def get_value() -> ListClustersInputListClustersPaginateTypeDef:
    return {
        "PaginationConfig": ...,
    }
Definition
class ListClustersInputListClustersPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef