Skip to content

Type definitions#

Index > DocDBElastic > Type definitions

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

ApplyPendingMaintenanceActionInputTypeDef#

# ApplyPendingMaintenanceActionInputTypeDef TypedDict usage example

from mypy_boto3_docdb_elastic.type_defs import ApplyPendingMaintenanceActionInputTypeDef


def get_value() -> ApplyPendingMaintenanceActionInputTypeDef:
    return {
        "applyAction": ...,
    }


# ApplyPendingMaintenanceActionInputTypeDef definition

class ApplyPendingMaintenanceActionInputTypeDef(TypedDict):
    applyAction: str,
    optInType: OptInTypeType,  # (1)
    resourceArn: str,
    applyOn: NotRequired[str],
  1. See OptInTypeType

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef TypedDict usage example

from mypy_boto3_docdb_elastic.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],

ClusterInListTypeDef#

# ClusterInListTypeDef TypedDict usage example

from mypy_boto3_docdb_elastic.type_defs import ClusterInListTypeDef


def get_value() -> ClusterInListTypeDef:
    return {
        "clusterArn": ...,
    }


# ClusterInListTypeDef definition

class ClusterInListTypeDef(TypedDict):
    clusterArn: str,
    clusterName: str,
    status: StatusType,  # (1)
  1. See StatusType

ClusterSnapshotInListTypeDef#

# ClusterSnapshotInListTypeDef TypedDict usage example

from mypy_boto3_docdb_elastic.type_defs import ClusterSnapshotInListTypeDef


def get_value() -> ClusterSnapshotInListTypeDef:
    return {
        "clusterArn": ...,
    }


# ClusterSnapshotInListTypeDef definition

class ClusterSnapshotInListTypeDef(TypedDict):
    clusterArn: str,
    snapshotArn: str,
    snapshotCreationTime: str,
    snapshotName: str,
    status: StatusType,  # (1)
  1. See StatusType

ClusterSnapshotTypeDef#

# ClusterSnapshotTypeDef TypedDict usage example

from mypy_boto3_docdb_elastic.type_defs import ClusterSnapshotTypeDef


def get_value() -> ClusterSnapshotTypeDef:
    return {
        "adminUserName": ...,
    }


# ClusterSnapshotTypeDef definition

class ClusterSnapshotTypeDef(TypedDict):
    adminUserName: str,
    clusterArn: str,
    clusterCreationTime: str,
    kmsKeyId: str,
    snapshotArn: str,
    snapshotCreationTime: str,
    snapshotName: str,
    status: StatusType,  # (2)
    subnetIds: List[str],
    vpcSecurityGroupIds: List[str],
    snapshotType: NotRequired[SnapshotTypeType],  # (1)
  1. See SnapshotTypeType
  2. See StatusType

ShardTypeDef#

# ShardTypeDef TypedDict usage example

from mypy_boto3_docdb_elastic.type_defs import ShardTypeDef


def get_value() -> ShardTypeDef:
    return {
        "createTime": ...,
    }


# ShardTypeDef definition

class ShardTypeDef(TypedDict):
    createTime: str,
    shardId: str,
    status: StatusType,  # (1)
  1. See StatusType

CopyClusterSnapshotInputTypeDef#

# CopyClusterSnapshotInputTypeDef TypedDict usage example

from mypy_boto3_docdb_elastic.type_defs import CopyClusterSnapshotInputTypeDef


def get_value() -> CopyClusterSnapshotInputTypeDef:
    return {
        "snapshotArn": ...,
    }


# CopyClusterSnapshotInputTypeDef definition

class CopyClusterSnapshotInputTypeDef(TypedDict):
    snapshotArn: str,
    targetSnapshotName: str,
    copyTags: NotRequired[bool],
    kmsKeyId: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],

CreateClusterInputTypeDef#

# CreateClusterInputTypeDef TypedDict usage example

from mypy_boto3_docdb_elastic.type_defs import CreateClusterInputTypeDef


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


# CreateClusterInputTypeDef definition

class CreateClusterInputTypeDef(TypedDict):
    adminUserName: str,
    adminUserPassword: str,
    authType: AuthType,  # (1)
    clusterName: str,
    shardCapacity: int,
    shardCount: int,
    backupRetentionPeriod: NotRequired[int],
    clientToken: NotRequired[str],
    kmsKeyId: NotRequired[str],
    preferredBackupWindow: NotRequired[str],
    preferredMaintenanceWindow: NotRequired[str],
    shardInstanceCount: NotRequired[int],
    subnetIds: NotRequired[Sequence[str]],
    tags: NotRequired[Mapping[str, str]],
    vpcSecurityGroupIds: NotRequired[Sequence[str]],
  1. See AuthType

CreateClusterSnapshotInputTypeDef#

# CreateClusterSnapshotInputTypeDef TypedDict usage example

from mypy_boto3_docdb_elastic.type_defs import CreateClusterSnapshotInputTypeDef


def get_value() -> CreateClusterSnapshotInputTypeDef:
    return {
        "clusterArn": ...,
    }


# CreateClusterSnapshotInputTypeDef definition

class CreateClusterSnapshotInputTypeDef(TypedDict):
    clusterArn: str,
    snapshotName: str,
    tags: NotRequired[Mapping[str, str]],

DeleteClusterInputTypeDef#

# DeleteClusterInputTypeDef TypedDict usage example

from mypy_boto3_docdb_elastic.type_defs import DeleteClusterInputTypeDef


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


# DeleteClusterInputTypeDef definition

class DeleteClusterInputTypeDef(TypedDict):
    clusterArn: str,

DeleteClusterSnapshotInputTypeDef#

# DeleteClusterSnapshotInputTypeDef TypedDict usage example

from mypy_boto3_docdb_elastic.type_defs import DeleteClusterSnapshotInputTypeDef


def get_value() -> DeleteClusterSnapshotInputTypeDef:
    return {
        "snapshotArn": ...,
    }


# DeleteClusterSnapshotInputTypeDef definition

class DeleteClusterSnapshotInputTypeDef(TypedDict):
    snapshotArn: str,

GetClusterInputTypeDef#

# GetClusterInputTypeDef TypedDict usage example

from mypy_boto3_docdb_elastic.type_defs import GetClusterInputTypeDef


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


# GetClusterInputTypeDef definition

class GetClusterInputTypeDef(TypedDict):
    clusterArn: str,

GetClusterSnapshotInputTypeDef#

# GetClusterSnapshotInputTypeDef TypedDict usage example

from mypy_boto3_docdb_elastic.type_defs import GetClusterSnapshotInputTypeDef


def get_value() -> GetClusterSnapshotInputTypeDef:
    return {
        "snapshotArn": ...,
    }


# GetClusterSnapshotInputTypeDef definition

class GetClusterSnapshotInputTypeDef(TypedDict):
    snapshotArn: str,

GetPendingMaintenanceActionInputTypeDef#

# GetPendingMaintenanceActionInputTypeDef TypedDict usage example

from mypy_boto3_docdb_elastic.type_defs import GetPendingMaintenanceActionInputTypeDef


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


# GetPendingMaintenanceActionInputTypeDef definition

class GetPendingMaintenanceActionInputTypeDef(TypedDict):
    resourceArn: str,

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef TypedDict 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],

ListClusterSnapshotsInputTypeDef#

# ListClusterSnapshotsInputTypeDef TypedDict usage example

from mypy_boto3_docdb_elastic.type_defs import ListClusterSnapshotsInputTypeDef


def get_value() -> ListClusterSnapshotsInputTypeDef:
    return {
        "clusterArn": ...,
    }


# ListClusterSnapshotsInputTypeDef definition

class ListClusterSnapshotsInputTypeDef(TypedDict):
    clusterArn: NotRequired[str],
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
    snapshotType: NotRequired[str],

ListClustersInputTypeDef#

# ListClustersInputTypeDef TypedDict usage example

from mypy_boto3_docdb_elastic.type_defs import ListClustersInputTypeDef


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


# ListClustersInputTypeDef definition

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

ListPendingMaintenanceActionsInputTypeDef#

# ListPendingMaintenanceActionsInputTypeDef TypedDict usage example

from mypy_boto3_docdb_elastic.type_defs import ListPendingMaintenanceActionsInputTypeDef


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


# ListPendingMaintenanceActionsInputTypeDef definition

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

ListTagsForResourceRequestTypeDef#

# ListTagsForResourceRequestTypeDef TypedDict usage example

from mypy_boto3_docdb_elastic.type_defs import ListTagsForResourceRequestTypeDef


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


# ListTagsForResourceRequestTypeDef definition

class ListTagsForResourceRequestTypeDef(TypedDict):
    resourceArn: str,

PendingMaintenanceActionDetailsTypeDef#

# PendingMaintenanceActionDetailsTypeDef TypedDict usage example

from mypy_boto3_docdb_elastic.type_defs import PendingMaintenanceActionDetailsTypeDef


def get_value() -> PendingMaintenanceActionDetailsTypeDef:
    return {
        "action": ...,
    }


# PendingMaintenanceActionDetailsTypeDef definition

class PendingMaintenanceActionDetailsTypeDef(TypedDict):
    action: str,
    autoAppliedAfterDate: NotRequired[str],
    currentApplyDate: NotRequired[str],
    description: NotRequired[str],
    forcedApplyDate: NotRequired[str],
    optInStatus: NotRequired[str],

RestoreClusterFromSnapshotInputTypeDef#

# RestoreClusterFromSnapshotInputTypeDef TypedDict usage example

from mypy_boto3_docdb_elastic.type_defs import RestoreClusterFromSnapshotInputTypeDef


def get_value() -> RestoreClusterFromSnapshotInputTypeDef:
    return {
        "clusterName": ...,
    }


# RestoreClusterFromSnapshotInputTypeDef definition

class RestoreClusterFromSnapshotInputTypeDef(TypedDict):
    clusterName: str,
    snapshotArn: str,
    kmsKeyId: NotRequired[str],
    shardCapacity: NotRequired[int],
    shardInstanceCount: NotRequired[int],
    subnetIds: NotRequired[Sequence[str]],
    tags: NotRequired[Mapping[str, str]],
    vpcSecurityGroupIds: NotRequired[Sequence[str]],

StartClusterInputTypeDef#

# StartClusterInputTypeDef TypedDict usage example

from mypy_boto3_docdb_elastic.type_defs import StartClusterInputTypeDef


def get_value() -> StartClusterInputTypeDef:
    return {
        "clusterArn": ...,
    }


# StartClusterInputTypeDef definition

class StartClusterInputTypeDef(TypedDict):
    clusterArn: str,

StopClusterInputTypeDef#

# StopClusterInputTypeDef TypedDict usage example

from mypy_boto3_docdb_elastic.type_defs import StopClusterInputTypeDef


def get_value() -> StopClusterInputTypeDef:
    return {
        "clusterArn": ...,
    }


# StopClusterInputTypeDef definition

class StopClusterInputTypeDef(TypedDict):
    clusterArn: str,

TagResourceRequestTypeDef#

# TagResourceRequestTypeDef TypedDict usage example

from mypy_boto3_docdb_elastic.type_defs import TagResourceRequestTypeDef


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


# TagResourceRequestTypeDef definition

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

UntagResourceRequestTypeDef#

# UntagResourceRequestTypeDef TypedDict usage example

from mypy_boto3_docdb_elastic.type_defs import UntagResourceRequestTypeDef


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


# UntagResourceRequestTypeDef definition

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

UpdateClusterInputTypeDef#

# UpdateClusterInputTypeDef TypedDict usage example

from mypy_boto3_docdb_elastic.type_defs import UpdateClusterInputTypeDef


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


# UpdateClusterInputTypeDef definition

class UpdateClusterInputTypeDef(TypedDict):
    clusterArn: str,
    adminUserPassword: NotRequired[str],
    authType: NotRequired[AuthType],  # (1)
    backupRetentionPeriod: NotRequired[int],
    clientToken: NotRequired[str],
    preferredBackupWindow: NotRequired[str],
    preferredMaintenanceWindow: NotRequired[str],
    shardCapacity: NotRequired[int],
    shardCount: NotRequired[int],
    shardInstanceCount: NotRequired[int],
    subnetIds: NotRequired[Sequence[str]],
    vpcSecurityGroupIds: NotRequired[Sequence[str]],
  1. See AuthType

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef TypedDict usage example

from mypy_boto3_docdb_elastic.type_defs import ListTagsForResourceResponseTypeDef


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


# ListTagsForResourceResponseTypeDef definition

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

ListClustersOutputTypeDef#

# ListClustersOutputTypeDef TypedDict usage example

from mypy_boto3_docdb_elastic.type_defs import ListClustersOutputTypeDef


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


# ListClustersOutputTypeDef definition

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

ListClusterSnapshotsOutputTypeDef#

# ListClusterSnapshotsOutputTypeDef TypedDict usage example

from mypy_boto3_docdb_elastic.type_defs import ListClusterSnapshotsOutputTypeDef


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


# ListClusterSnapshotsOutputTypeDef definition

class ListClusterSnapshotsOutputTypeDef(TypedDict):
    snapshots: List[ClusterSnapshotInListTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See List[ClusterSnapshotInListTypeDef]
  2. See ResponseMetadataTypeDef

CopyClusterSnapshotOutputTypeDef#

# CopyClusterSnapshotOutputTypeDef TypedDict usage example

from mypy_boto3_docdb_elastic.type_defs import CopyClusterSnapshotOutputTypeDef


def get_value() -> CopyClusterSnapshotOutputTypeDef:
    return {
        "snapshot": ...,
    }


# CopyClusterSnapshotOutputTypeDef definition

class CopyClusterSnapshotOutputTypeDef(TypedDict):
    snapshot: ClusterSnapshotTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ClusterSnapshotTypeDef
  2. See ResponseMetadataTypeDef

CreateClusterSnapshotOutputTypeDef#

# CreateClusterSnapshotOutputTypeDef TypedDict usage example

from mypy_boto3_docdb_elastic.type_defs import CreateClusterSnapshotOutputTypeDef


def get_value() -> CreateClusterSnapshotOutputTypeDef:
    return {
        "snapshot": ...,
    }


# CreateClusterSnapshotOutputTypeDef definition

class CreateClusterSnapshotOutputTypeDef(TypedDict):
    snapshot: ClusterSnapshotTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ClusterSnapshotTypeDef
  2. See ResponseMetadataTypeDef

DeleteClusterSnapshotOutputTypeDef#

# DeleteClusterSnapshotOutputTypeDef TypedDict usage example

from mypy_boto3_docdb_elastic.type_defs import DeleteClusterSnapshotOutputTypeDef


def get_value() -> DeleteClusterSnapshotOutputTypeDef:
    return {
        "snapshot": ...,
    }


# DeleteClusterSnapshotOutputTypeDef definition

class DeleteClusterSnapshotOutputTypeDef(TypedDict):
    snapshot: ClusterSnapshotTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ClusterSnapshotTypeDef
  2. See ResponseMetadataTypeDef

GetClusterSnapshotOutputTypeDef#

# GetClusterSnapshotOutputTypeDef TypedDict usage example

from mypy_boto3_docdb_elastic.type_defs import GetClusterSnapshotOutputTypeDef


def get_value() -> GetClusterSnapshotOutputTypeDef:
    return {
        "snapshot": ...,
    }


# GetClusterSnapshotOutputTypeDef definition

class GetClusterSnapshotOutputTypeDef(TypedDict):
    snapshot: ClusterSnapshotTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ClusterSnapshotTypeDef
  2. See ResponseMetadataTypeDef

ClusterTypeDef#

# ClusterTypeDef TypedDict usage example

from mypy_boto3_docdb_elastic.type_defs import ClusterTypeDef


def get_value() -> ClusterTypeDef:
    return {
        "adminUserName": ...,
    }


# 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,  # (3)
    subnetIds: List[str],
    vpcSecurityGroupIds: List[str],
    backupRetentionPeriod: NotRequired[int],
    preferredBackupWindow: NotRequired[str],
    shardInstanceCount: NotRequired[int],
    shards: NotRequired[List[ShardTypeDef]],  # (2)
  1. See AuthType
  2. See List[ShardTypeDef]
  3. See StatusType

ListClusterSnapshotsInputPaginateTypeDef#

# ListClusterSnapshotsInputPaginateTypeDef TypedDict usage example

from mypy_boto3_docdb_elastic.type_defs import ListClusterSnapshotsInputPaginateTypeDef


def get_value() -> ListClusterSnapshotsInputPaginateTypeDef:
    return {
        "clusterArn": ...,
    }


# ListClusterSnapshotsInputPaginateTypeDef definition

class ListClusterSnapshotsInputPaginateTypeDef(TypedDict):
    clusterArn: NotRequired[str],
    snapshotType: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListClustersInputPaginateTypeDef#

# ListClustersInputPaginateTypeDef TypedDict usage example

from mypy_boto3_docdb_elastic.type_defs import ListClustersInputPaginateTypeDef


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


# ListClustersInputPaginateTypeDef definition

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

ListPendingMaintenanceActionsInputPaginateTypeDef#

# ListPendingMaintenanceActionsInputPaginateTypeDef TypedDict usage example

from mypy_boto3_docdb_elastic.type_defs import ListPendingMaintenanceActionsInputPaginateTypeDef


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


# ListPendingMaintenanceActionsInputPaginateTypeDef definition

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

ResourcePendingMaintenanceActionTypeDef#

# ResourcePendingMaintenanceActionTypeDef TypedDict usage example

from mypy_boto3_docdb_elastic.type_defs import ResourcePendingMaintenanceActionTypeDef


def get_value() -> ResourcePendingMaintenanceActionTypeDef:
    return {
        "pendingMaintenanceActionDetails": ...,
    }


# ResourcePendingMaintenanceActionTypeDef definition

class ResourcePendingMaintenanceActionTypeDef(TypedDict):
    pendingMaintenanceActionDetails: NotRequired[List[PendingMaintenanceActionDetailsTypeDef]],  # (1)
    resourceArn: NotRequired[str],
  1. See List[PendingMaintenanceActionDetailsTypeDef]

CreateClusterOutputTypeDef#

# CreateClusterOutputTypeDef TypedDict usage example

from mypy_boto3_docdb_elastic.type_defs import CreateClusterOutputTypeDef


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


# CreateClusterOutputTypeDef definition

class CreateClusterOutputTypeDef(TypedDict):
    cluster: ClusterTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ClusterTypeDef
  2. See ResponseMetadataTypeDef

DeleteClusterOutputTypeDef#

# DeleteClusterOutputTypeDef TypedDict usage example

from mypy_boto3_docdb_elastic.type_defs import DeleteClusterOutputTypeDef


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


# DeleteClusterOutputTypeDef definition

class DeleteClusterOutputTypeDef(TypedDict):
    cluster: ClusterTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ClusterTypeDef
  2. See ResponseMetadataTypeDef

GetClusterOutputTypeDef#

# GetClusterOutputTypeDef TypedDict usage example

from mypy_boto3_docdb_elastic.type_defs import GetClusterOutputTypeDef


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


# GetClusterOutputTypeDef definition

class GetClusterOutputTypeDef(TypedDict):
    cluster: ClusterTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ClusterTypeDef
  2. See ResponseMetadataTypeDef

RestoreClusterFromSnapshotOutputTypeDef#

# RestoreClusterFromSnapshotOutputTypeDef TypedDict usage example

from mypy_boto3_docdb_elastic.type_defs import RestoreClusterFromSnapshotOutputTypeDef


def get_value() -> RestoreClusterFromSnapshotOutputTypeDef:
    return {
        "cluster": ...,
    }


# RestoreClusterFromSnapshotOutputTypeDef definition

class RestoreClusterFromSnapshotOutputTypeDef(TypedDict):
    cluster: ClusterTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ClusterTypeDef
  2. See ResponseMetadataTypeDef

StartClusterOutputTypeDef#

# StartClusterOutputTypeDef TypedDict usage example

from mypy_boto3_docdb_elastic.type_defs import StartClusterOutputTypeDef


def get_value() -> StartClusterOutputTypeDef:
    return {
        "cluster": ...,
    }


# StartClusterOutputTypeDef definition

class StartClusterOutputTypeDef(TypedDict):
    cluster: ClusterTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ClusterTypeDef
  2. See ResponseMetadataTypeDef

StopClusterOutputTypeDef#

# StopClusterOutputTypeDef TypedDict usage example

from mypy_boto3_docdb_elastic.type_defs import StopClusterOutputTypeDef


def get_value() -> StopClusterOutputTypeDef:
    return {
        "cluster": ...,
    }


# StopClusterOutputTypeDef definition

class StopClusterOutputTypeDef(TypedDict):
    cluster: ClusterTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ClusterTypeDef
  2. See ResponseMetadataTypeDef

UpdateClusterOutputTypeDef#

# UpdateClusterOutputTypeDef TypedDict usage example

from mypy_boto3_docdb_elastic.type_defs import UpdateClusterOutputTypeDef


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


# UpdateClusterOutputTypeDef definition

class UpdateClusterOutputTypeDef(TypedDict):
    cluster: ClusterTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ClusterTypeDef
  2. See ResponseMetadataTypeDef

ApplyPendingMaintenanceActionOutputTypeDef#

# ApplyPendingMaintenanceActionOutputTypeDef TypedDict usage example

from mypy_boto3_docdb_elastic.type_defs import ApplyPendingMaintenanceActionOutputTypeDef


def get_value() -> ApplyPendingMaintenanceActionOutputTypeDef:
    return {
        "resourcePendingMaintenanceAction": ...,
    }


# ApplyPendingMaintenanceActionOutputTypeDef definition

class ApplyPendingMaintenanceActionOutputTypeDef(TypedDict):
    resourcePendingMaintenanceAction: ResourcePendingMaintenanceActionTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ResourcePendingMaintenanceActionTypeDef
  2. See ResponseMetadataTypeDef

GetPendingMaintenanceActionOutputTypeDef#

# GetPendingMaintenanceActionOutputTypeDef TypedDict usage example

from mypy_boto3_docdb_elastic.type_defs import GetPendingMaintenanceActionOutputTypeDef


def get_value() -> GetPendingMaintenanceActionOutputTypeDef:
    return {
        "resourcePendingMaintenanceAction": ...,
    }


# GetPendingMaintenanceActionOutputTypeDef definition

class GetPendingMaintenanceActionOutputTypeDef(TypedDict):
    resourcePendingMaintenanceAction: ResourcePendingMaintenanceActionTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ResourcePendingMaintenanceActionTypeDef
  2. See ResponseMetadataTypeDef

ListPendingMaintenanceActionsOutputTypeDef#

# ListPendingMaintenanceActionsOutputTypeDef TypedDict usage example

from mypy_boto3_docdb_elastic.type_defs import ListPendingMaintenanceActionsOutputTypeDef


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


# ListPendingMaintenanceActionsOutputTypeDef definition

class ListPendingMaintenanceActionsOutputTypeDef(TypedDict):
    resourcePendingMaintenanceActions: List[ResourcePendingMaintenanceActionTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See List[ResourcePendingMaintenanceActionTypeDef]
  2. See ResponseMetadataTypeDef