Skip to content

Type definitions#

Index > DocDB > Type definitions

Auto-generated documentation for DocDB type annotations stubs module types-boto3-docdb.

TimestampTypeDef#

# TimestampTypeDef Union usage example

from types_boto3_docdb.type_defs import TimestampTypeDef


def get_value() -> TimestampTypeDef:
    return ...


# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

AddSourceIdentifierToSubscriptionMessageTypeDef#

# AddSourceIdentifierToSubscriptionMessageTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import AddSourceIdentifierToSubscriptionMessageTypeDef


def get_value() -> AddSourceIdentifierToSubscriptionMessageTypeDef:
    return {
        "SubscriptionName": ...,
    }


# AddSourceIdentifierToSubscriptionMessageTypeDef definition

class AddSourceIdentifierToSubscriptionMessageTypeDef(TypedDict):
    SubscriptionName: str,
    SourceIdentifier: str,

EventSubscriptionTypeDef#

# EventSubscriptionTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import EventSubscriptionTypeDef


def get_value() -> EventSubscriptionTypeDef:
    return {
        "CustomerAwsId": ...,
    }


# EventSubscriptionTypeDef definition

class EventSubscriptionTypeDef(TypedDict):
    CustomerAwsId: NotRequired[str],
    CustSubscriptionId: NotRequired[str],
    SnsTopicArn: NotRequired[str],
    Status: NotRequired[str],
    SubscriptionCreationTime: NotRequired[str],
    SourceType: NotRequired[str],
    SourceIdsList: NotRequired[List[str]],
    EventCategoriesList: NotRequired[List[str]],
    Enabled: NotRequired[bool],
    EventSubscriptionArn: NotRequired[str],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef TypedDict usage example

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

TagTypeDef#

# TagTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import TagTypeDef


def get_value() -> TagTypeDef:
    return {
        "Key": ...,
    }


# TagTypeDef definition

class TagTypeDef(TypedDict):
    Key: NotRequired[str],
    Value: NotRequired[str],

ApplyPendingMaintenanceActionMessageTypeDef#

# ApplyPendingMaintenanceActionMessageTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import ApplyPendingMaintenanceActionMessageTypeDef


def get_value() -> ApplyPendingMaintenanceActionMessageTypeDef:
    return {
        "ResourceIdentifier": ...,
    }


# ApplyPendingMaintenanceActionMessageTypeDef definition

class ApplyPendingMaintenanceActionMessageTypeDef(TypedDict):
    ResourceIdentifier: str,
    ApplyAction: str,
    OptInType: str,

AvailabilityZoneTypeDef#

# AvailabilityZoneTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import AvailabilityZoneTypeDef


def get_value() -> AvailabilityZoneTypeDef:
    return {
        "Name": ...,
    }


# AvailabilityZoneTypeDef definition

class AvailabilityZoneTypeDef(TypedDict):
    Name: NotRequired[str],

CertificateDetailsTypeDef#

# CertificateDetailsTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import CertificateDetailsTypeDef


def get_value() -> CertificateDetailsTypeDef:
    return {
        "CAIdentifier": ...,
    }


# CertificateDetailsTypeDef definition

class CertificateDetailsTypeDef(TypedDict):
    CAIdentifier: NotRequired[str],
    ValidTill: NotRequired[datetime],

CertificateTypeDef#

# CertificateTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import CertificateTypeDef


def get_value() -> CertificateTypeDef:
    return {
        "CertificateIdentifier": ...,
    }


# CertificateTypeDef definition

class CertificateTypeDef(TypedDict):
    CertificateIdentifier: NotRequired[str],
    CertificateType: NotRequired[str],
    Thumbprint: NotRequired[str],
    ValidFrom: NotRequired[datetime],
    ValidTill: NotRequired[datetime],
    CertificateArn: NotRequired[str],

CloudwatchLogsExportConfigurationTypeDef#

# CloudwatchLogsExportConfigurationTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import CloudwatchLogsExportConfigurationTypeDef


def get_value() -> CloudwatchLogsExportConfigurationTypeDef:
    return {
        "EnableLogTypes": ...,
    }


# CloudwatchLogsExportConfigurationTypeDef definition

class CloudwatchLogsExportConfigurationTypeDef(TypedDict):
    EnableLogTypes: NotRequired[Sequence[str]],
    DisableLogTypes: NotRequired[Sequence[str]],

ClusterMasterUserSecretTypeDef#

# ClusterMasterUserSecretTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import ClusterMasterUserSecretTypeDef


def get_value() -> ClusterMasterUserSecretTypeDef:
    return {
        "SecretArn": ...,
    }


# ClusterMasterUserSecretTypeDef definition

class ClusterMasterUserSecretTypeDef(TypedDict):
    SecretArn: NotRequired[str],
    SecretStatus: NotRequired[str],
    KmsKeyId: NotRequired[str],

DBClusterParameterGroupTypeDef#

# DBClusterParameterGroupTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import DBClusterParameterGroupTypeDef


def get_value() -> DBClusterParameterGroupTypeDef:
    return {
        "DBClusterParameterGroupName": ...,
    }


# DBClusterParameterGroupTypeDef definition

class DBClusterParameterGroupTypeDef(TypedDict):
    DBClusterParameterGroupName: NotRequired[str],
    DBParameterGroupFamily: NotRequired[str],
    Description: NotRequired[str],
    DBClusterParameterGroupArn: NotRequired[str],

DBClusterSnapshotTypeDef#

# DBClusterSnapshotTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import DBClusterSnapshotTypeDef


def get_value() -> DBClusterSnapshotTypeDef:
    return {
        "AvailabilityZones": ...,
    }


# DBClusterSnapshotTypeDef definition

class DBClusterSnapshotTypeDef(TypedDict):
    AvailabilityZones: NotRequired[List[str]],
    DBClusterSnapshotIdentifier: NotRequired[str],
    DBClusterIdentifier: NotRequired[str],
    SnapshotCreateTime: NotRequired[datetime],
    Engine: NotRequired[str],
    Status: NotRequired[str],
    Port: NotRequired[int],
    VpcId: NotRequired[str],
    ClusterCreateTime: NotRequired[datetime],
    MasterUsername: NotRequired[str],
    EngineVersion: NotRequired[str],
    SnapshotType: NotRequired[str],
    PercentProgress: NotRequired[int],
    StorageEncrypted: NotRequired[bool],
    KmsKeyId: NotRequired[str],
    DBClusterSnapshotArn: NotRequired[str],
    SourceDBClusterSnapshotArn: NotRequired[str],
    StorageType: NotRequired[str],

CreateGlobalClusterMessageTypeDef#

# CreateGlobalClusterMessageTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import CreateGlobalClusterMessageTypeDef


def get_value() -> CreateGlobalClusterMessageTypeDef:
    return {
        "GlobalClusterIdentifier": ...,
    }


# CreateGlobalClusterMessageTypeDef definition

class CreateGlobalClusterMessageTypeDef(TypedDict):
    GlobalClusterIdentifier: str,
    SourceDBClusterIdentifier: NotRequired[str],
    Engine: NotRequired[str],
    EngineVersion: NotRequired[str],
    DeletionProtection: NotRequired[bool],
    DatabaseName: NotRequired[str],
    StorageEncrypted: NotRequired[bool],

DBClusterMemberTypeDef#

# DBClusterMemberTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import DBClusterMemberTypeDef


def get_value() -> DBClusterMemberTypeDef:
    return {
        "DBInstanceIdentifier": ...,
    }


# DBClusterMemberTypeDef definition

class DBClusterMemberTypeDef(TypedDict):
    DBInstanceIdentifier: NotRequired[str],
    IsClusterWriter: NotRequired[bool],
    DBClusterParameterGroupStatus: NotRequired[str],
    PromotionTier: NotRequired[int],

ParameterTypeDef#

# ParameterTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import ParameterTypeDef


def get_value() -> ParameterTypeDef:
    return {
        "ParameterName": ...,
    }


# ParameterTypeDef definition

class ParameterTypeDef(TypedDict):
    ParameterName: NotRequired[str],
    ParameterValue: NotRequired[str],
    Description: NotRequired[str],
    Source: NotRequired[str],
    ApplyType: NotRequired[str],
    DataType: NotRequired[str],
    AllowedValues: NotRequired[str],
    IsModifiable: NotRequired[bool],
    MinimumEngineVersion: NotRequired[str],
    ApplyMethod: NotRequired[ApplyMethodType],  # (1)
  1. See ApplyMethodType

DBClusterRoleTypeDef#

# DBClusterRoleTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import DBClusterRoleTypeDef


def get_value() -> DBClusterRoleTypeDef:
    return {
        "RoleArn": ...,
    }


# DBClusterRoleTypeDef definition

class DBClusterRoleTypeDef(TypedDict):
    RoleArn: NotRequired[str],
    Status: NotRequired[str],

DBClusterSnapshotAttributeTypeDef#

# DBClusterSnapshotAttributeTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import DBClusterSnapshotAttributeTypeDef


def get_value() -> DBClusterSnapshotAttributeTypeDef:
    return {
        "AttributeName": ...,
    }


# DBClusterSnapshotAttributeTypeDef definition

class DBClusterSnapshotAttributeTypeDef(TypedDict):
    AttributeName: NotRequired[str],
    AttributeValues: NotRequired[List[str]],

VpcSecurityGroupMembershipTypeDef#

# VpcSecurityGroupMembershipTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import VpcSecurityGroupMembershipTypeDef


def get_value() -> VpcSecurityGroupMembershipTypeDef:
    return {
        "VpcSecurityGroupId": ...,
    }


# VpcSecurityGroupMembershipTypeDef definition

class VpcSecurityGroupMembershipTypeDef(TypedDict):
    VpcSecurityGroupId: NotRequired[str],
    Status: NotRequired[str],

UpgradeTargetTypeDef#

# UpgradeTargetTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import UpgradeTargetTypeDef


def get_value() -> UpgradeTargetTypeDef:
    return {
        "Engine": ...,
    }


# UpgradeTargetTypeDef definition

class UpgradeTargetTypeDef(TypedDict):
    Engine: NotRequired[str],
    EngineVersion: NotRequired[str],
    Description: NotRequired[str],
    AutoUpgrade: NotRequired[bool],
    IsMajorVersionUpgrade: NotRequired[bool],

DBInstanceStatusInfoTypeDef#

# DBInstanceStatusInfoTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import DBInstanceStatusInfoTypeDef


def get_value() -> DBInstanceStatusInfoTypeDef:
    return {
        "StatusType": ...,
    }


# DBInstanceStatusInfoTypeDef definition

class DBInstanceStatusInfoTypeDef(TypedDict):
    StatusType: NotRequired[str],
    Normal: NotRequired[bool],
    Status: NotRequired[str],
    Message: NotRequired[str],

EndpointTypeDef#

# EndpointTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import EndpointTypeDef


def get_value() -> EndpointTypeDef:
    return {
        "Address": ...,
    }


# EndpointTypeDef definition

class EndpointTypeDef(TypedDict):
    Address: NotRequired[str],
    Port: NotRequired[int],
    HostedZoneId: NotRequired[str],

DeleteDBClusterMessageTypeDef#

# DeleteDBClusterMessageTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import DeleteDBClusterMessageTypeDef


def get_value() -> DeleteDBClusterMessageTypeDef:
    return {
        "DBClusterIdentifier": ...,
    }


# DeleteDBClusterMessageTypeDef definition

class DeleteDBClusterMessageTypeDef(TypedDict):
    DBClusterIdentifier: str,
    SkipFinalSnapshot: NotRequired[bool],
    FinalDBSnapshotIdentifier: NotRequired[str],

DeleteDBClusterParameterGroupMessageTypeDef#

# DeleteDBClusterParameterGroupMessageTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import DeleteDBClusterParameterGroupMessageTypeDef


def get_value() -> DeleteDBClusterParameterGroupMessageTypeDef:
    return {
        "DBClusterParameterGroupName": ...,
    }


# DeleteDBClusterParameterGroupMessageTypeDef definition

class DeleteDBClusterParameterGroupMessageTypeDef(TypedDict):
    DBClusterParameterGroupName: str,

DeleteDBClusterSnapshotMessageTypeDef#

# DeleteDBClusterSnapshotMessageTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import DeleteDBClusterSnapshotMessageTypeDef


def get_value() -> DeleteDBClusterSnapshotMessageTypeDef:
    return {
        "DBClusterSnapshotIdentifier": ...,
    }


# DeleteDBClusterSnapshotMessageTypeDef definition

class DeleteDBClusterSnapshotMessageTypeDef(TypedDict):
    DBClusterSnapshotIdentifier: str,

DeleteDBInstanceMessageTypeDef#

# DeleteDBInstanceMessageTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import DeleteDBInstanceMessageTypeDef


def get_value() -> DeleteDBInstanceMessageTypeDef:
    return {
        "DBInstanceIdentifier": ...,
    }


# DeleteDBInstanceMessageTypeDef definition

class DeleteDBInstanceMessageTypeDef(TypedDict):
    DBInstanceIdentifier: str,

DeleteDBSubnetGroupMessageTypeDef#

# DeleteDBSubnetGroupMessageTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import DeleteDBSubnetGroupMessageTypeDef


def get_value() -> DeleteDBSubnetGroupMessageTypeDef:
    return {
        "DBSubnetGroupName": ...,
    }


# DeleteDBSubnetGroupMessageTypeDef definition

class DeleteDBSubnetGroupMessageTypeDef(TypedDict):
    DBSubnetGroupName: str,

DeleteEventSubscriptionMessageTypeDef#

# DeleteEventSubscriptionMessageTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import DeleteEventSubscriptionMessageTypeDef


def get_value() -> DeleteEventSubscriptionMessageTypeDef:
    return {
        "SubscriptionName": ...,
    }


# DeleteEventSubscriptionMessageTypeDef definition

class DeleteEventSubscriptionMessageTypeDef(TypedDict):
    SubscriptionName: str,

DeleteGlobalClusterMessageTypeDef#

# DeleteGlobalClusterMessageTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import DeleteGlobalClusterMessageTypeDef


def get_value() -> DeleteGlobalClusterMessageTypeDef:
    return {
        "GlobalClusterIdentifier": ...,
    }


# DeleteGlobalClusterMessageTypeDef definition

class DeleteGlobalClusterMessageTypeDef(TypedDict):
    GlobalClusterIdentifier: str,

FilterTypeDef#

# FilterTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import FilterTypeDef


def get_value() -> FilterTypeDef:
    return {
        "Name": ...,
    }


# FilterTypeDef definition

class FilterTypeDef(TypedDict):
    Name: str,
    Values: Sequence[str],

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import PaginatorConfigTypeDef


def get_value() -> PaginatorConfigTypeDef:
    return {
        "MaxItems": ...,
    }


# PaginatorConfigTypeDef definition

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

DescribeDBClusterSnapshotAttributesMessageTypeDef#

# DescribeDBClusterSnapshotAttributesMessageTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import DescribeDBClusterSnapshotAttributesMessageTypeDef


def get_value() -> DescribeDBClusterSnapshotAttributesMessageTypeDef:
    return {
        "DBClusterSnapshotIdentifier": ...,
    }


# DescribeDBClusterSnapshotAttributesMessageTypeDef definition

class DescribeDBClusterSnapshotAttributesMessageTypeDef(TypedDict):
    DBClusterSnapshotIdentifier: str,

WaiterConfigTypeDef#

# WaiterConfigTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import WaiterConfigTypeDef


def get_value() -> WaiterConfigTypeDef:
    return {
        "Delay": ...,
    }


# WaiterConfigTypeDef definition

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

EventCategoriesMapTypeDef#

# EventCategoriesMapTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import EventCategoriesMapTypeDef


def get_value() -> EventCategoriesMapTypeDef:
    return {
        "SourceType": ...,
    }


# EventCategoriesMapTypeDef definition

class EventCategoriesMapTypeDef(TypedDict):
    SourceType: NotRequired[str],
    EventCategories: NotRequired[List[str]],

EventTypeDef#

# EventTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import EventTypeDef


def get_value() -> EventTypeDef:
    return {
        "SourceIdentifier": ...,
    }


# EventTypeDef definition

class EventTypeDef(TypedDict):
    SourceIdentifier: NotRequired[str],
    SourceType: NotRequired[SourceTypeType],  # (1)
    Message: NotRequired[str],
    EventCategories: NotRequired[List[str]],
    Date: NotRequired[datetime],
    SourceArn: NotRequired[str],
  1. See SourceTypeType

FailoverDBClusterMessageTypeDef#

# FailoverDBClusterMessageTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import FailoverDBClusterMessageTypeDef


def get_value() -> FailoverDBClusterMessageTypeDef:
    return {
        "DBClusterIdentifier": ...,
    }


# FailoverDBClusterMessageTypeDef definition

class FailoverDBClusterMessageTypeDef(TypedDict):
    DBClusterIdentifier: NotRequired[str],
    TargetDBInstanceIdentifier: NotRequired[str],

FailoverGlobalClusterMessageTypeDef#

# FailoverGlobalClusterMessageTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import FailoverGlobalClusterMessageTypeDef


def get_value() -> FailoverGlobalClusterMessageTypeDef:
    return {
        "GlobalClusterIdentifier": ...,
    }


# FailoverGlobalClusterMessageTypeDef definition

class FailoverGlobalClusterMessageTypeDef(TypedDict):
    GlobalClusterIdentifier: str,
    TargetDbClusterIdentifier: str,
    AllowDataLoss: NotRequired[bool],
    Switchover: NotRequired[bool],

GlobalClusterMemberTypeDef#

# GlobalClusterMemberTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import GlobalClusterMemberTypeDef


def get_value() -> GlobalClusterMemberTypeDef:
    return {
        "DBClusterArn": ...,
    }


# GlobalClusterMemberTypeDef definition

class GlobalClusterMemberTypeDef(TypedDict):
    DBClusterArn: NotRequired[str],
    Readers: NotRequired[List[str]],
    IsWriter: NotRequired[bool],

ModifyDBClusterSnapshotAttributeMessageTypeDef#

# ModifyDBClusterSnapshotAttributeMessageTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import ModifyDBClusterSnapshotAttributeMessageTypeDef


def get_value() -> ModifyDBClusterSnapshotAttributeMessageTypeDef:
    return {
        "DBClusterSnapshotIdentifier": ...,
    }


# ModifyDBClusterSnapshotAttributeMessageTypeDef definition

class ModifyDBClusterSnapshotAttributeMessageTypeDef(TypedDict):
    DBClusterSnapshotIdentifier: str,
    AttributeName: str,
    ValuesToAdd: NotRequired[Sequence[str]],
    ValuesToRemove: NotRequired[Sequence[str]],

ModifyDBInstanceMessageTypeDef#

# ModifyDBInstanceMessageTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import ModifyDBInstanceMessageTypeDef


def get_value() -> ModifyDBInstanceMessageTypeDef:
    return {
        "DBInstanceIdentifier": ...,
    }


# ModifyDBInstanceMessageTypeDef definition

class ModifyDBInstanceMessageTypeDef(TypedDict):
    DBInstanceIdentifier: str,
    DBInstanceClass: NotRequired[str],
    ApplyImmediately: NotRequired[bool],
    PreferredMaintenanceWindow: NotRequired[str],
    AutoMinorVersionUpgrade: NotRequired[bool],
    NewDBInstanceIdentifier: NotRequired[str],
    CACertificateIdentifier: NotRequired[str],
    CopyTagsToSnapshot: NotRequired[bool],
    PromotionTier: NotRequired[int],
    EnablePerformanceInsights: NotRequired[bool],
    PerformanceInsightsKMSKeyId: NotRequired[str],
    CertificateRotationRestart: NotRequired[bool],

ModifyDBSubnetGroupMessageTypeDef#

# ModifyDBSubnetGroupMessageTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import ModifyDBSubnetGroupMessageTypeDef


def get_value() -> ModifyDBSubnetGroupMessageTypeDef:
    return {
        "DBSubnetGroupName": ...,
    }


# ModifyDBSubnetGroupMessageTypeDef definition

class ModifyDBSubnetGroupMessageTypeDef(TypedDict):
    DBSubnetGroupName: str,
    SubnetIds: Sequence[str],
    DBSubnetGroupDescription: NotRequired[str],

ModifyEventSubscriptionMessageTypeDef#

# ModifyEventSubscriptionMessageTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import ModifyEventSubscriptionMessageTypeDef


def get_value() -> ModifyEventSubscriptionMessageTypeDef:
    return {
        "SubscriptionName": ...,
    }


# ModifyEventSubscriptionMessageTypeDef definition

class ModifyEventSubscriptionMessageTypeDef(TypedDict):
    SubscriptionName: str,
    SnsTopicArn: NotRequired[str],
    SourceType: NotRequired[str],
    EventCategories: NotRequired[Sequence[str]],
    Enabled: NotRequired[bool],

ModifyGlobalClusterMessageTypeDef#

# ModifyGlobalClusterMessageTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import ModifyGlobalClusterMessageTypeDef


def get_value() -> ModifyGlobalClusterMessageTypeDef:
    return {
        "GlobalClusterIdentifier": ...,
    }


# ModifyGlobalClusterMessageTypeDef definition

class ModifyGlobalClusterMessageTypeDef(TypedDict):
    GlobalClusterIdentifier: str,
    NewGlobalClusterIdentifier: NotRequired[str],
    DeletionProtection: NotRequired[bool],

PendingCloudwatchLogsExportsTypeDef#

# PendingCloudwatchLogsExportsTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import PendingCloudwatchLogsExportsTypeDef


def get_value() -> PendingCloudwatchLogsExportsTypeDef:
    return {
        "LogTypesToEnable": ...,
    }


# PendingCloudwatchLogsExportsTypeDef definition

class PendingCloudwatchLogsExportsTypeDef(TypedDict):
    LogTypesToEnable: NotRequired[List[str]],
    LogTypesToDisable: NotRequired[List[str]],

PendingMaintenanceActionTypeDef#

# PendingMaintenanceActionTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import PendingMaintenanceActionTypeDef


def get_value() -> PendingMaintenanceActionTypeDef:
    return {
        "Action": ...,
    }


# PendingMaintenanceActionTypeDef definition

class PendingMaintenanceActionTypeDef(TypedDict):
    Action: NotRequired[str],
    AutoAppliedAfterDate: NotRequired[datetime],
    ForcedApplyDate: NotRequired[datetime],
    OptInStatus: NotRequired[str],
    CurrentApplyDate: NotRequired[datetime],
    Description: NotRequired[str],

RebootDBInstanceMessageTypeDef#

# RebootDBInstanceMessageTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import RebootDBInstanceMessageTypeDef


def get_value() -> RebootDBInstanceMessageTypeDef:
    return {
        "DBInstanceIdentifier": ...,
    }


# RebootDBInstanceMessageTypeDef definition

class RebootDBInstanceMessageTypeDef(TypedDict):
    DBInstanceIdentifier: str,
    ForceFailover: NotRequired[bool],

RemoveFromGlobalClusterMessageTypeDef#

# RemoveFromGlobalClusterMessageTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import RemoveFromGlobalClusterMessageTypeDef


def get_value() -> RemoveFromGlobalClusterMessageTypeDef:
    return {
        "GlobalClusterIdentifier": ...,
    }


# RemoveFromGlobalClusterMessageTypeDef definition

class RemoveFromGlobalClusterMessageTypeDef(TypedDict):
    GlobalClusterIdentifier: str,
    DbClusterIdentifier: str,

RemoveSourceIdentifierFromSubscriptionMessageTypeDef#

# RemoveSourceIdentifierFromSubscriptionMessageTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import RemoveSourceIdentifierFromSubscriptionMessageTypeDef


def get_value() -> RemoveSourceIdentifierFromSubscriptionMessageTypeDef:
    return {
        "SubscriptionName": ...,
    }


# RemoveSourceIdentifierFromSubscriptionMessageTypeDef definition

class RemoveSourceIdentifierFromSubscriptionMessageTypeDef(TypedDict):
    SubscriptionName: str,
    SourceIdentifier: str,

RemoveTagsFromResourceMessageTypeDef#

# RemoveTagsFromResourceMessageTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import RemoveTagsFromResourceMessageTypeDef


def get_value() -> RemoveTagsFromResourceMessageTypeDef:
    return {
        "ResourceName": ...,
    }


# RemoveTagsFromResourceMessageTypeDef definition

class RemoveTagsFromResourceMessageTypeDef(TypedDict):
    ResourceName: str,
    TagKeys: Sequence[str],

StartDBClusterMessageTypeDef#

# StartDBClusterMessageTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import StartDBClusterMessageTypeDef


def get_value() -> StartDBClusterMessageTypeDef:
    return {
        "DBClusterIdentifier": ...,
    }


# StartDBClusterMessageTypeDef definition

class StartDBClusterMessageTypeDef(TypedDict):
    DBClusterIdentifier: str,

StopDBClusterMessageTypeDef#

# StopDBClusterMessageTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import StopDBClusterMessageTypeDef


def get_value() -> StopDBClusterMessageTypeDef:
    return {
        "DBClusterIdentifier": ...,
    }


# StopDBClusterMessageTypeDef definition

class StopDBClusterMessageTypeDef(TypedDict):
    DBClusterIdentifier: str,

SwitchoverGlobalClusterMessageTypeDef#

# SwitchoverGlobalClusterMessageTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import SwitchoverGlobalClusterMessageTypeDef


def get_value() -> SwitchoverGlobalClusterMessageTypeDef:
    return {
        "GlobalClusterIdentifier": ...,
    }


# SwitchoverGlobalClusterMessageTypeDef definition

class SwitchoverGlobalClusterMessageTypeDef(TypedDict):
    GlobalClusterIdentifier: str,
    TargetDbClusterIdentifier: str,

AddSourceIdentifierToSubscriptionResultTypeDef#

# AddSourceIdentifierToSubscriptionResultTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import AddSourceIdentifierToSubscriptionResultTypeDef


def get_value() -> AddSourceIdentifierToSubscriptionResultTypeDef:
    return {
        "EventSubscription": ...,
    }


# AddSourceIdentifierToSubscriptionResultTypeDef definition

class AddSourceIdentifierToSubscriptionResultTypeDef(TypedDict):
    EventSubscription: EventSubscriptionTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See EventSubscriptionTypeDef
  2. See ResponseMetadataTypeDef

CreateEventSubscriptionResultTypeDef#

# CreateEventSubscriptionResultTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import CreateEventSubscriptionResultTypeDef


def get_value() -> CreateEventSubscriptionResultTypeDef:
    return {
        "EventSubscription": ...,
    }


# CreateEventSubscriptionResultTypeDef definition

class CreateEventSubscriptionResultTypeDef(TypedDict):
    EventSubscription: EventSubscriptionTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See EventSubscriptionTypeDef
  2. See ResponseMetadataTypeDef

DBClusterParameterGroupNameMessageTypeDef#

# DBClusterParameterGroupNameMessageTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import DBClusterParameterGroupNameMessageTypeDef


def get_value() -> DBClusterParameterGroupNameMessageTypeDef:
    return {
        "DBClusterParameterGroupName": ...,
    }


# DBClusterParameterGroupNameMessageTypeDef definition

class DBClusterParameterGroupNameMessageTypeDef(TypedDict):
    DBClusterParameterGroupName: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteEventSubscriptionResultTypeDef#

# DeleteEventSubscriptionResultTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import DeleteEventSubscriptionResultTypeDef


def get_value() -> DeleteEventSubscriptionResultTypeDef:
    return {
        "EventSubscription": ...,
    }


# DeleteEventSubscriptionResultTypeDef definition

class DeleteEventSubscriptionResultTypeDef(TypedDict):
    EventSubscription: EventSubscriptionTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See EventSubscriptionTypeDef
  2. See ResponseMetadataTypeDef

EmptyResponseMetadataTypeDef#

# EmptyResponseMetadataTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import EmptyResponseMetadataTypeDef


def get_value() -> EmptyResponseMetadataTypeDef:
    return {
        "ResponseMetadata": ...,
    }


# EmptyResponseMetadataTypeDef definition

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

EventSubscriptionsMessageTypeDef#

# EventSubscriptionsMessageTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import EventSubscriptionsMessageTypeDef


def get_value() -> EventSubscriptionsMessageTypeDef:
    return {
        "Marker": ...,
    }


# EventSubscriptionsMessageTypeDef definition

class EventSubscriptionsMessageTypeDef(TypedDict):
    Marker: str,
    EventSubscriptionsList: List[EventSubscriptionTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See EventSubscriptionTypeDef
  2. See ResponseMetadataTypeDef

ModifyEventSubscriptionResultTypeDef#

# ModifyEventSubscriptionResultTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import ModifyEventSubscriptionResultTypeDef


def get_value() -> ModifyEventSubscriptionResultTypeDef:
    return {
        "EventSubscription": ...,
    }


# ModifyEventSubscriptionResultTypeDef definition

class ModifyEventSubscriptionResultTypeDef(TypedDict):
    EventSubscription: EventSubscriptionTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See EventSubscriptionTypeDef
  2. See ResponseMetadataTypeDef

RemoveSourceIdentifierFromSubscriptionResultTypeDef#

# RemoveSourceIdentifierFromSubscriptionResultTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import RemoveSourceIdentifierFromSubscriptionResultTypeDef


def get_value() -> RemoveSourceIdentifierFromSubscriptionResultTypeDef:
    return {
        "EventSubscription": ...,
    }


# RemoveSourceIdentifierFromSubscriptionResultTypeDef definition

class RemoveSourceIdentifierFromSubscriptionResultTypeDef(TypedDict):
    EventSubscription: EventSubscriptionTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See EventSubscriptionTypeDef
  2. See ResponseMetadataTypeDef

AddTagsToResourceMessageTypeDef#

# AddTagsToResourceMessageTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import AddTagsToResourceMessageTypeDef


def get_value() -> AddTagsToResourceMessageTypeDef:
    return {
        "ResourceName": ...,
    }


# AddTagsToResourceMessageTypeDef definition

class AddTagsToResourceMessageTypeDef(TypedDict):
    ResourceName: str,
    Tags: Sequence[TagTypeDef],  # (1)
  1. See TagTypeDef

CopyDBClusterParameterGroupMessageTypeDef#

# CopyDBClusterParameterGroupMessageTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import CopyDBClusterParameterGroupMessageTypeDef


def get_value() -> CopyDBClusterParameterGroupMessageTypeDef:
    return {
        "SourceDBClusterParameterGroupIdentifier": ...,
    }


# CopyDBClusterParameterGroupMessageTypeDef definition

class CopyDBClusterParameterGroupMessageTypeDef(TypedDict):
    SourceDBClusterParameterGroupIdentifier: str,
    TargetDBClusterParameterGroupIdentifier: str,
    TargetDBClusterParameterGroupDescription: str,
    Tags: NotRequired[Sequence[TagTypeDef]],  # (1)
  1. See TagTypeDef

CopyDBClusterSnapshotMessageTypeDef#

# CopyDBClusterSnapshotMessageTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import CopyDBClusterSnapshotMessageTypeDef


def get_value() -> CopyDBClusterSnapshotMessageTypeDef:
    return {
        "SourceDBClusterSnapshotIdentifier": ...,
    }


# CopyDBClusterSnapshotMessageTypeDef definition

class CopyDBClusterSnapshotMessageTypeDef(TypedDict):
    SourceDBClusterSnapshotIdentifier: str,
    TargetDBClusterSnapshotIdentifier: str,
    KmsKeyId: NotRequired[str],
    PreSignedUrl: NotRequired[str],
    CopyTags: NotRequired[bool],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (1)
    SourceRegion: NotRequired[str],
  1. See TagTypeDef

CreateDBClusterMessageTypeDef#

# CreateDBClusterMessageTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import CreateDBClusterMessageTypeDef


def get_value() -> CreateDBClusterMessageTypeDef:
    return {
        "DBClusterIdentifier": ...,
    }


# CreateDBClusterMessageTypeDef definition

class CreateDBClusterMessageTypeDef(TypedDict):
    DBClusterIdentifier: str,
    Engine: str,
    AvailabilityZones: NotRequired[Sequence[str]],
    BackupRetentionPeriod: NotRequired[int],
    DBClusterParameterGroupName: NotRequired[str],
    VpcSecurityGroupIds: NotRequired[Sequence[str]],
    DBSubnetGroupName: NotRequired[str],
    EngineVersion: NotRequired[str],
    Port: NotRequired[int],
    MasterUsername: NotRequired[str],
    MasterUserPassword: NotRequired[str],
    PreferredBackupWindow: NotRequired[str],
    PreferredMaintenanceWindow: NotRequired[str],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (1)
    StorageEncrypted: NotRequired[bool],
    KmsKeyId: NotRequired[str],
    PreSignedUrl: NotRequired[str],
    EnableCloudwatchLogsExports: NotRequired[Sequence[str]],
    DeletionProtection: NotRequired[bool],
    GlobalClusterIdentifier: NotRequired[str],
    StorageType: NotRequired[str],
    ManageMasterUserPassword: NotRequired[bool],
    MasterUserSecretKmsKeyId: NotRequired[str],
    SourceRegion: NotRequired[str],
  1. See TagTypeDef

CreateDBClusterParameterGroupMessageTypeDef#

# CreateDBClusterParameterGroupMessageTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import CreateDBClusterParameterGroupMessageTypeDef


def get_value() -> CreateDBClusterParameterGroupMessageTypeDef:
    return {
        "DBClusterParameterGroupName": ...,
    }


# CreateDBClusterParameterGroupMessageTypeDef definition

class CreateDBClusterParameterGroupMessageTypeDef(TypedDict):
    DBClusterParameterGroupName: str,
    DBParameterGroupFamily: str,
    Description: str,
    Tags: NotRequired[Sequence[TagTypeDef]],  # (1)
  1. See TagTypeDef

CreateDBClusterSnapshotMessageTypeDef#

# CreateDBClusterSnapshotMessageTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import CreateDBClusterSnapshotMessageTypeDef


def get_value() -> CreateDBClusterSnapshotMessageTypeDef:
    return {
        "DBClusterSnapshotIdentifier": ...,
    }


# CreateDBClusterSnapshotMessageTypeDef definition

class CreateDBClusterSnapshotMessageTypeDef(TypedDict):
    DBClusterSnapshotIdentifier: str,
    DBClusterIdentifier: str,
    Tags: NotRequired[Sequence[TagTypeDef]],  # (1)
  1. See TagTypeDef

CreateDBInstanceMessageTypeDef#

# CreateDBInstanceMessageTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import CreateDBInstanceMessageTypeDef


def get_value() -> CreateDBInstanceMessageTypeDef:
    return {
        "DBInstanceIdentifier": ...,
    }


# CreateDBInstanceMessageTypeDef definition

class CreateDBInstanceMessageTypeDef(TypedDict):
    DBInstanceIdentifier: str,
    DBInstanceClass: str,
    Engine: str,
    DBClusterIdentifier: str,
    AvailabilityZone: NotRequired[str],
    PreferredMaintenanceWindow: NotRequired[str],
    AutoMinorVersionUpgrade: NotRequired[bool],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (1)
    CopyTagsToSnapshot: NotRequired[bool],
    PromotionTier: NotRequired[int],
    EnablePerformanceInsights: NotRequired[bool],
    PerformanceInsightsKMSKeyId: NotRequired[str],
    CACertificateIdentifier: NotRequired[str],
  1. See TagTypeDef

CreateDBSubnetGroupMessageTypeDef#

# CreateDBSubnetGroupMessageTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import CreateDBSubnetGroupMessageTypeDef


def get_value() -> CreateDBSubnetGroupMessageTypeDef:
    return {
        "DBSubnetGroupName": ...,
    }


# CreateDBSubnetGroupMessageTypeDef definition

class CreateDBSubnetGroupMessageTypeDef(TypedDict):
    DBSubnetGroupName: str,
    DBSubnetGroupDescription: str,
    SubnetIds: Sequence[str],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (1)
  1. See TagTypeDef

CreateEventSubscriptionMessageTypeDef#

# CreateEventSubscriptionMessageTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import CreateEventSubscriptionMessageTypeDef


def get_value() -> CreateEventSubscriptionMessageTypeDef:
    return {
        "SubscriptionName": ...,
    }


# CreateEventSubscriptionMessageTypeDef definition

class CreateEventSubscriptionMessageTypeDef(TypedDict):
    SubscriptionName: str,
    SnsTopicArn: str,
    SourceType: NotRequired[str],
    EventCategories: NotRequired[Sequence[str]],
    SourceIds: NotRequired[Sequence[str]],
    Enabled: NotRequired[bool],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (1)
  1. See TagTypeDef

RestoreDBClusterFromSnapshotMessageTypeDef#

# RestoreDBClusterFromSnapshotMessageTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import RestoreDBClusterFromSnapshotMessageTypeDef


def get_value() -> RestoreDBClusterFromSnapshotMessageTypeDef:
    return {
        "DBClusterIdentifier": ...,
    }


# RestoreDBClusterFromSnapshotMessageTypeDef definition

class RestoreDBClusterFromSnapshotMessageTypeDef(TypedDict):
    DBClusterIdentifier: str,
    SnapshotIdentifier: str,
    Engine: str,
    AvailabilityZones: NotRequired[Sequence[str]],
    EngineVersion: NotRequired[str],
    Port: NotRequired[int],
    DBSubnetGroupName: NotRequired[str],
    VpcSecurityGroupIds: NotRequired[Sequence[str]],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (1)
    KmsKeyId: NotRequired[str],
    EnableCloudwatchLogsExports: NotRequired[Sequence[str]],
    DeletionProtection: NotRequired[bool],
    DBClusterParameterGroupName: NotRequired[str],
    StorageType: NotRequired[str],
  1. See TagTypeDef

TagListMessageTypeDef#

# TagListMessageTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import TagListMessageTypeDef


def get_value() -> TagListMessageTypeDef:
    return {
        "TagList": ...,
    }


# TagListMessageTypeDef definition

class TagListMessageTypeDef(TypedDict):
    TagList: List[TagTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TagTypeDef
  2. See ResponseMetadataTypeDef

OrderableDBInstanceOptionTypeDef#

# OrderableDBInstanceOptionTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import OrderableDBInstanceOptionTypeDef


def get_value() -> OrderableDBInstanceOptionTypeDef:
    return {
        "Engine": ...,
    }


# OrderableDBInstanceOptionTypeDef definition

class OrderableDBInstanceOptionTypeDef(TypedDict):
    Engine: NotRequired[str],
    EngineVersion: NotRequired[str],
    DBInstanceClass: NotRequired[str],
    LicenseModel: NotRequired[str],
    AvailabilityZones: NotRequired[List[AvailabilityZoneTypeDef]],  # (1)
    Vpc: NotRequired[bool],
    StorageType: NotRequired[str],
  1. See AvailabilityZoneTypeDef

SubnetTypeDef#

# SubnetTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import SubnetTypeDef


def get_value() -> SubnetTypeDef:
    return {
        "SubnetIdentifier": ...,
    }


# SubnetTypeDef definition

class SubnetTypeDef(TypedDict):
    SubnetIdentifier: NotRequired[str],
    SubnetAvailabilityZone: NotRequired[AvailabilityZoneTypeDef],  # (1)
    SubnetStatus: NotRequired[str],
  1. See AvailabilityZoneTypeDef

CertificateMessageTypeDef#

# CertificateMessageTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import CertificateMessageTypeDef


def get_value() -> CertificateMessageTypeDef:
    return {
        "Certificates": ...,
    }


# CertificateMessageTypeDef definition

class CertificateMessageTypeDef(TypedDict):
    Certificates: List[CertificateTypeDef],  # (1)
    Marker: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CertificateTypeDef
  2. See ResponseMetadataTypeDef

ModifyDBClusterMessageTypeDef#

# ModifyDBClusterMessageTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import ModifyDBClusterMessageTypeDef


def get_value() -> ModifyDBClusterMessageTypeDef:
    return {
        "DBClusterIdentifier": ...,
    }


# ModifyDBClusterMessageTypeDef definition

class ModifyDBClusterMessageTypeDef(TypedDict):
    DBClusterIdentifier: str,
    NewDBClusterIdentifier: NotRequired[str],
    ApplyImmediately: NotRequired[bool],
    BackupRetentionPeriod: NotRequired[int],
    DBClusterParameterGroupName: NotRequired[str],
    VpcSecurityGroupIds: NotRequired[Sequence[str]],
    Port: NotRequired[int],
    MasterUserPassword: NotRequired[str],
    PreferredBackupWindow: NotRequired[str],
    PreferredMaintenanceWindow: NotRequired[str],
    CloudwatchLogsExportConfiguration: NotRequired[CloudwatchLogsExportConfigurationTypeDef],  # (1)
    EngineVersion: NotRequired[str],
    AllowMajorVersionUpgrade: NotRequired[bool],
    DeletionProtection: NotRequired[bool],
    StorageType: NotRequired[str],
    ManageMasterUserPassword: NotRequired[bool],
    MasterUserSecretKmsKeyId: NotRequired[str],
    RotateMasterUserPassword: NotRequired[bool],
  1. See CloudwatchLogsExportConfigurationTypeDef

CopyDBClusterParameterGroupResultTypeDef#

# CopyDBClusterParameterGroupResultTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import CopyDBClusterParameterGroupResultTypeDef


def get_value() -> CopyDBClusterParameterGroupResultTypeDef:
    return {
        "DBClusterParameterGroup": ...,
    }


# CopyDBClusterParameterGroupResultTypeDef definition

class CopyDBClusterParameterGroupResultTypeDef(TypedDict):
    DBClusterParameterGroup: DBClusterParameterGroupTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DBClusterParameterGroupTypeDef
  2. See ResponseMetadataTypeDef

CreateDBClusterParameterGroupResultTypeDef#

# CreateDBClusterParameterGroupResultTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import CreateDBClusterParameterGroupResultTypeDef


def get_value() -> CreateDBClusterParameterGroupResultTypeDef:
    return {
        "DBClusterParameterGroup": ...,
    }


# CreateDBClusterParameterGroupResultTypeDef definition

class CreateDBClusterParameterGroupResultTypeDef(TypedDict):
    DBClusterParameterGroup: DBClusterParameterGroupTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DBClusterParameterGroupTypeDef
  2. See ResponseMetadataTypeDef

DBClusterParameterGroupsMessageTypeDef#

# DBClusterParameterGroupsMessageTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import DBClusterParameterGroupsMessageTypeDef


def get_value() -> DBClusterParameterGroupsMessageTypeDef:
    return {
        "Marker": ...,
    }


# DBClusterParameterGroupsMessageTypeDef definition

class DBClusterParameterGroupsMessageTypeDef(TypedDict):
    Marker: str,
    DBClusterParameterGroups: List[DBClusterParameterGroupTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DBClusterParameterGroupTypeDef
  2. See ResponseMetadataTypeDef

CopyDBClusterSnapshotResultTypeDef#

# CopyDBClusterSnapshotResultTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import CopyDBClusterSnapshotResultTypeDef


def get_value() -> CopyDBClusterSnapshotResultTypeDef:
    return {
        "DBClusterSnapshot": ...,
    }


# CopyDBClusterSnapshotResultTypeDef definition

class CopyDBClusterSnapshotResultTypeDef(TypedDict):
    DBClusterSnapshot: DBClusterSnapshotTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DBClusterSnapshotTypeDef
  2. See ResponseMetadataTypeDef

CreateDBClusterSnapshotResultTypeDef#

# CreateDBClusterSnapshotResultTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import CreateDBClusterSnapshotResultTypeDef


def get_value() -> CreateDBClusterSnapshotResultTypeDef:
    return {
        "DBClusterSnapshot": ...,
    }


# CreateDBClusterSnapshotResultTypeDef definition

class CreateDBClusterSnapshotResultTypeDef(TypedDict):
    DBClusterSnapshot: DBClusterSnapshotTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DBClusterSnapshotTypeDef
  2. See ResponseMetadataTypeDef

DBClusterSnapshotMessageTypeDef#

# DBClusterSnapshotMessageTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import DBClusterSnapshotMessageTypeDef


def get_value() -> DBClusterSnapshotMessageTypeDef:
    return {
        "Marker": ...,
    }


# DBClusterSnapshotMessageTypeDef definition

class DBClusterSnapshotMessageTypeDef(TypedDict):
    Marker: str,
    DBClusterSnapshots: List[DBClusterSnapshotTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DBClusterSnapshotTypeDef
  2. See ResponseMetadataTypeDef

DeleteDBClusterSnapshotResultTypeDef#

# DeleteDBClusterSnapshotResultTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import DeleteDBClusterSnapshotResultTypeDef


def get_value() -> DeleteDBClusterSnapshotResultTypeDef:
    return {
        "DBClusterSnapshot": ...,
    }


# DeleteDBClusterSnapshotResultTypeDef definition

class DeleteDBClusterSnapshotResultTypeDef(TypedDict):
    DBClusterSnapshot: DBClusterSnapshotTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DBClusterSnapshotTypeDef
  2. See ResponseMetadataTypeDef

DBClusterParameterGroupDetailsTypeDef#

# DBClusterParameterGroupDetailsTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import DBClusterParameterGroupDetailsTypeDef


def get_value() -> DBClusterParameterGroupDetailsTypeDef:
    return {
        "Parameters": ...,
    }


# DBClusterParameterGroupDetailsTypeDef definition

class DBClusterParameterGroupDetailsTypeDef(TypedDict):
    Parameters: List[ParameterTypeDef],  # (1)
    Marker: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ParameterTypeDef
  2. See ResponseMetadataTypeDef

EngineDefaultsTypeDef#

# EngineDefaultsTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import EngineDefaultsTypeDef


def get_value() -> EngineDefaultsTypeDef:
    return {
        "DBParameterGroupFamily": ...,
    }


# EngineDefaultsTypeDef definition

class EngineDefaultsTypeDef(TypedDict):
    DBParameterGroupFamily: NotRequired[str],
    Marker: NotRequired[str],
    Parameters: NotRequired[List[ParameterTypeDef]],  # (1)
  1. See ParameterTypeDef

ModifyDBClusterParameterGroupMessageTypeDef#

# ModifyDBClusterParameterGroupMessageTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import ModifyDBClusterParameterGroupMessageTypeDef


def get_value() -> ModifyDBClusterParameterGroupMessageTypeDef:
    return {
        "DBClusterParameterGroupName": ...,
    }


# ModifyDBClusterParameterGroupMessageTypeDef definition

class ModifyDBClusterParameterGroupMessageTypeDef(TypedDict):
    DBClusterParameterGroupName: str,
    Parameters: Sequence[ParameterTypeDef],  # (1)
  1. See ParameterTypeDef

ResetDBClusterParameterGroupMessageTypeDef#

# ResetDBClusterParameterGroupMessageTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import ResetDBClusterParameterGroupMessageTypeDef


def get_value() -> ResetDBClusterParameterGroupMessageTypeDef:
    return {
        "DBClusterParameterGroupName": ...,
    }


# ResetDBClusterParameterGroupMessageTypeDef definition

class ResetDBClusterParameterGroupMessageTypeDef(TypedDict):
    DBClusterParameterGroupName: str,
    ResetAllParameters: NotRequired[bool],
    Parameters: NotRequired[Sequence[ParameterTypeDef]],  # (1)
  1. See ParameterTypeDef

DBClusterSnapshotAttributesResultTypeDef#

# DBClusterSnapshotAttributesResultTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import DBClusterSnapshotAttributesResultTypeDef


def get_value() -> DBClusterSnapshotAttributesResultTypeDef:
    return {
        "DBClusterSnapshotIdentifier": ...,
    }


# DBClusterSnapshotAttributesResultTypeDef definition

class DBClusterSnapshotAttributesResultTypeDef(TypedDict):
    DBClusterSnapshotIdentifier: NotRequired[str],
    DBClusterSnapshotAttributes: NotRequired[List[DBClusterSnapshotAttributeTypeDef]],  # (1)
  1. See DBClusterSnapshotAttributeTypeDef

DBClusterTypeDef#

# DBClusterTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import DBClusterTypeDef


def get_value() -> DBClusterTypeDef:
    return {
        "AvailabilityZones": ...,
    }


# DBClusterTypeDef definition

class DBClusterTypeDef(TypedDict):
    AvailabilityZones: NotRequired[List[str]],
    BackupRetentionPeriod: NotRequired[int],
    DBClusterIdentifier: NotRequired[str],
    DBClusterParameterGroup: NotRequired[str],
    DBSubnetGroup: NotRequired[str],
    Status: NotRequired[str],
    PercentProgress: NotRequired[str],
    EarliestRestorableTime: NotRequired[datetime],
    Endpoint: NotRequired[str],
    ReaderEndpoint: NotRequired[str],
    MultiAZ: NotRequired[bool],
    Engine: NotRequired[str],
    EngineVersion: NotRequired[str],
    LatestRestorableTime: NotRequired[datetime],
    Port: NotRequired[int],
    MasterUsername: NotRequired[str],
    PreferredBackupWindow: NotRequired[str],
    PreferredMaintenanceWindow: NotRequired[str],
    ReplicationSourceIdentifier: NotRequired[str],
    ReadReplicaIdentifiers: NotRequired[List[str]],
    DBClusterMembers: NotRequired[List[DBClusterMemberTypeDef]],  # (1)
    VpcSecurityGroups: NotRequired[List[VpcSecurityGroupMembershipTypeDef]],  # (2)
    HostedZoneId: NotRequired[str],
    StorageEncrypted: NotRequired[bool],
    KmsKeyId: NotRequired[str],
    DbClusterResourceId: NotRequired[str],
    DBClusterArn: NotRequired[str],
    AssociatedRoles: NotRequired[List[DBClusterRoleTypeDef]],  # (3)
    CloneGroupId: NotRequired[str],
    ClusterCreateTime: NotRequired[datetime],
    EnabledCloudwatchLogsExports: NotRequired[List[str]],
    DeletionProtection: NotRequired[bool],
    StorageType: NotRequired[str],
    MasterUserSecret: NotRequired[ClusterMasterUserSecretTypeDef],  # (4)
  1. See DBClusterMemberTypeDef
  2. See VpcSecurityGroupMembershipTypeDef
  3. See DBClusterRoleTypeDef
  4. See ClusterMasterUserSecretTypeDef

DBEngineVersionTypeDef#

# DBEngineVersionTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import DBEngineVersionTypeDef


def get_value() -> DBEngineVersionTypeDef:
    return {
        "Engine": ...,
    }


# DBEngineVersionTypeDef definition

class DBEngineVersionTypeDef(TypedDict):
    Engine: NotRequired[str],
    EngineVersion: NotRequired[str],
    DBParameterGroupFamily: NotRequired[str],
    DBEngineDescription: NotRequired[str],
    DBEngineVersionDescription: NotRequired[str],
    ValidUpgradeTarget: NotRequired[List[UpgradeTargetTypeDef]],  # (1)
    ExportableLogTypes: NotRequired[List[str]],
    SupportsLogExportsToCloudwatchLogs: NotRequired[bool],
    SupportedCACertificateIdentifiers: NotRequired[List[str]],
    SupportsCertificateRotationWithoutRestart: NotRequired[bool],
  1. See UpgradeTargetTypeDef

DescribeCertificatesMessageTypeDef#

# DescribeCertificatesMessageTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import DescribeCertificatesMessageTypeDef


def get_value() -> DescribeCertificatesMessageTypeDef:
    return {
        "CertificateIdentifier": ...,
    }


# DescribeCertificatesMessageTypeDef definition

class DescribeCertificatesMessageTypeDef(TypedDict):
    CertificateIdentifier: NotRequired[str],
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
    MaxRecords: NotRequired[int],
    Marker: NotRequired[str],
  1. See FilterTypeDef

DescribeDBClusterParameterGroupsMessageTypeDef#

# DescribeDBClusterParameterGroupsMessageTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import DescribeDBClusterParameterGroupsMessageTypeDef


def get_value() -> DescribeDBClusterParameterGroupsMessageTypeDef:
    return {
        "DBClusterParameterGroupName": ...,
    }


# DescribeDBClusterParameterGroupsMessageTypeDef definition

class DescribeDBClusterParameterGroupsMessageTypeDef(TypedDict):
    DBClusterParameterGroupName: NotRequired[str],
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
    MaxRecords: NotRequired[int],
    Marker: NotRequired[str],
  1. See FilterTypeDef

DescribeDBClusterParametersMessageTypeDef#

# DescribeDBClusterParametersMessageTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import DescribeDBClusterParametersMessageTypeDef


def get_value() -> DescribeDBClusterParametersMessageTypeDef:
    return {
        "DBClusterParameterGroupName": ...,
    }


# DescribeDBClusterParametersMessageTypeDef definition

class DescribeDBClusterParametersMessageTypeDef(TypedDict):
    DBClusterParameterGroupName: str,
    Source: NotRequired[str],
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
    MaxRecords: NotRequired[int],
    Marker: NotRequired[str],
  1. See FilterTypeDef

DescribeDBClusterSnapshotsMessageTypeDef#

# DescribeDBClusterSnapshotsMessageTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import DescribeDBClusterSnapshotsMessageTypeDef


def get_value() -> DescribeDBClusterSnapshotsMessageTypeDef:
    return {
        "DBClusterIdentifier": ...,
    }


# DescribeDBClusterSnapshotsMessageTypeDef definition

class DescribeDBClusterSnapshotsMessageTypeDef(TypedDict):
    DBClusterIdentifier: NotRequired[str],
    DBClusterSnapshotIdentifier: NotRequired[str],
    SnapshotType: NotRequired[str],
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
    MaxRecords: NotRequired[int],
    Marker: NotRequired[str],
    IncludeShared: NotRequired[bool],
    IncludePublic: NotRequired[bool],
  1. See FilterTypeDef

DescribeDBClustersMessageTypeDef#

# DescribeDBClustersMessageTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import DescribeDBClustersMessageTypeDef


def get_value() -> DescribeDBClustersMessageTypeDef:
    return {
        "DBClusterIdentifier": ...,
    }


# DescribeDBClustersMessageTypeDef definition

class DescribeDBClustersMessageTypeDef(TypedDict):
    DBClusterIdentifier: NotRequired[str],
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
    MaxRecords: NotRequired[int],
    Marker: NotRequired[str],
  1. See FilterTypeDef

DescribeDBEngineVersionsMessageTypeDef#

# DescribeDBEngineVersionsMessageTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import DescribeDBEngineVersionsMessageTypeDef


def get_value() -> DescribeDBEngineVersionsMessageTypeDef:
    return {
        "Engine": ...,
    }


# DescribeDBEngineVersionsMessageTypeDef definition

class DescribeDBEngineVersionsMessageTypeDef(TypedDict):
    Engine: NotRequired[str],
    EngineVersion: NotRequired[str],
    DBParameterGroupFamily: NotRequired[str],
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
    MaxRecords: NotRequired[int],
    Marker: NotRequired[str],
    DefaultOnly: NotRequired[bool],
    ListSupportedCharacterSets: NotRequired[bool],
    ListSupportedTimezones: NotRequired[bool],
  1. See FilterTypeDef

DescribeDBInstancesMessageTypeDef#

# DescribeDBInstancesMessageTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import DescribeDBInstancesMessageTypeDef


def get_value() -> DescribeDBInstancesMessageTypeDef:
    return {
        "DBInstanceIdentifier": ...,
    }


# DescribeDBInstancesMessageTypeDef definition

class DescribeDBInstancesMessageTypeDef(TypedDict):
    DBInstanceIdentifier: NotRequired[str],
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
    MaxRecords: NotRequired[int],
    Marker: NotRequired[str],
  1. See FilterTypeDef

DescribeDBSubnetGroupsMessageTypeDef#

# DescribeDBSubnetGroupsMessageTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import DescribeDBSubnetGroupsMessageTypeDef


def get_value() -> DescribeDBSubnetGroupsMessageTypeDef:
    return {
        "DBSubnetGroupName": ...,
    }


# DescribeDBSubnetGroupsMessageTypeDef definition

class DescribeDBSubnetGroupsMessageTypeDef(TypedDict):
    DBSubnetGroupName: NotRequired[str],
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
    MaxRecords: NotRequired[int],
    Marker: NotRequired[str],
  1. See FilterTypeDef

DescribeEngineDefaultClusterParametersMessageTypeDef#

# DescribeEngineDefaultClusterParametersMessageTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import DescribeEngineDefaultClusterParametersMessageTypeDef


def get_value() -> DescribeEngineDefaultClusterParametersMessageTypeDef:
    return {
        "DBParameterGroupFamily": ...,
    }


# DescribeEngineDefaultClusterParametersMessageTypeDef definition

class DescribeEngineDefaultClusterParametersMessageTypeDef(TypedDict):
    DBParameterGroupFamily: str,
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
    MaxRecords: NotRequired[int],
    Marker: NotRequired[str],
  1. See FilterTypeDef

DescribeEventCategoriesMessageTypeDef#

# DescribeEventCategoriesMessageTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import DescribeEventCategoriesMessageTypeDef


def get_value() -> DescribeEventCategoriesMessageTypeDef:
    return {
        "SourceType": ...,
    }


# DescribeEventCategoriesMessageTypeDef definition

class DescribeEventCategoriesMessageTypeDef(TypedDict):
    SourceType: NotRequired[str],
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
  1. See FilterTypeDef

DescribeEventSubscriptionsMessageTypeDef#

# DescribeEventSubscriptionsMessageTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import DescribeEventSubscriptionsMessageTypeDef


def get_value() -> DescribeEventSubscriptionsMessageTypeDef:
    return {
        "SubscriptionName": ...,
    }


# DescribeEventSubscriptionsMessageTypeDef definition

class DescribeEventSubscriptionsMessageTypeDef(TypedDict):
    SubscriptionName: NotRequired[str],
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
    MaxRecords: NotRequired[int],
    Marker: NotRequired[str],
  1. See FilterTypeDef

DescribeGlobalClustersMessageTypeDef#

# DescribeGlobalClustersMessageTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import DescribeGlobalClustersMessageTypeDef


def get_value() -> DescribeGlobalClustersMessageTypeDef:
    return {
        "GlobalClusterIdentifier": ...,
    }


# DescribeGlobalClustersMessageTypeDef definition

class DescribeGlobalClustersMessageTypeDef(TypedDict):
    GlobalClusterIdentifier: NotRequired[str],
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
    MaxRecords: NotRequired[int],
    Marker: NotRequired[str],
  1. See FilterTypeDef

DescribeOrderableDBInstanceOptionsMessageTypeDef#

# DescribeOrderableDBInstanceOptionsMessageTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import DescribeOrderableDBInstanceOptionsMessageTypeDef


def get_value() -> DescribeOrderableDBInstanceOptionsMessageTypeDef:
    return {
        "Engine": ...,
    }


# DescribeOrderableDBInstanceOptionsMessageTypeDef definition

class DescribeOrderableDBInstanceOptionsMessageTypeDef(TypedDict):
    Engine: str,
    EngineVersion: NotRequired[str],
    DBInstanceClass: NotRequired[str],
    LicenseModel: NotRequired[str],
    Vpc: NotRequired[bool],
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
    MaxRecords: NotRequired[int],
    Marker: NotRequired[str],
  1. See FilterTypeDef

DescribePendingMaintenanceActionsMessageTypeDef#

# DescribePendingMaintenanceActionsMessageTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import DescribePendingMaintenanceActionsMessageTypeDef


def get_value() -> DescribePendingMaintenanceActionsMessageTypeDef:
    return {
        "ResourceIdentifier": ...,
    }


# DescribePendingMaintenanceActionsMessageTypeDef definition

class DescribePendingMaintenanceActionsMessageTypeDef(TypedDict):
    ResourceIdentifier: NotRequired[str],
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
    Marker: NotRequired[str],
    MaxRecords: NotRequired[int],
  1. See FilterTypeDef

ListTagsForResourceMessageTypeDef#

# ListTagsForResourceMessageTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import ListTagsForResourceMessageTypeDef


def get_value() -> ListTagsForResourceMessageTypeDef:
    return {
        "ResourceName": ...,
    }


# ListTagsForResourceMessageTypeDef definition

class ListTagsForResourceMessageTypeDef(TypedDict):
    ResourceName: str,
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
  1. See FilterTypeDef

DescribeCertificatesMessagePaginateTypeDef#

# DescribeCertificatesMessagePaginateTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import DescribeCertificatesMessagePaginateTypeDef


def get_value() -> DescribeCertificatesMessagePaginateTypeDef:
    return {
        "CertificateIdentifier": ...,
    }


# DescribeCertificatesMessagePaginateTypeDef definition

class DescribeCertificatesMessagePaginateTypeDef(TypedDict):
    CertificateIdentifier: NotRequired[str],
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See FilterTypeDef
  2. See PaginatorConfigTypeDef

DescribeDBClusterParameterGroupsMessagePaginateTypeDef#

# DescribeDBClusterParameterGroupsMessagePaginateTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import DescribeDBClusterParameterGroupsMessagePaginateTypeDef


def get_value() -> DescribeDBClusterParameterGroupsMessagePaginateTypeDef:
    return {
        "DBClusterParameterGroupName": ...,
    }


# DescribeDBClusterParameterGroupsMessagePaginateTypeDef definition

class DescribeDBClusterParameterGroupsMessagePaginateTypeDef(TypedDict):
    DBClusterParameterGroupName: NotRequired[str],
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See FilterTypeDef
  2. See PaginatorConfigTypeDef

DescribeDBClusterParametersMessagePaginateTypeDef#

# DescribeDBClusterParametersMessagePaginateTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import DescribeDBClusterParametersMessagePaginateTypeDef


def get_value() -> DescribeDBClusterParametersMessagePaginateTypeDef:
    return {
        "DBClusterParameterGroupName": ...,
    }


# DescribeDBClusterParametersMessagePaginateTypeDef definition

class DescribeDBClusterParametersMessagePaginateTypeDef(TypedDict):
    DBClusterParameterGroupName: str,
    Source: NotRequired[str],
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See FilterTypeDef
  2. See PaginatorConfigTypeDef

DescribeDBClusterSnapshotsMessagePaginateTypeDef#

# DescribeDBClusterSnapshotsMessagePaginateTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import DescribeDBClusterSnapshotsMessagePaginateTypeDef


def get_value() -> DescribeDBClusterSnapshotsMessagePaginateTypeDef:
    return {
        "DBClusterIdentifier": ...,
    }


# DescribeDBClusterSnapshotsMessagePaginateTypeDef definition

class DescribeDBClusterSnapshotsMessagePaginateTypeDef(TypedDict):
    DBClusterIdentifier: NotRequired[str],
    DBClusterSnapshotIdentifier: NotRequired[str],
    SnapshotType: NotRequired[str],
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
    IncludeShared: NotRequired[bool],
    IncludePublic: NotRequired[bool],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See FilterTypeDef
  2. See PaginatorConfigTypeDef

DescribeDBClustersMessagePaginateTypeDef#

# DescribeDBClustersMessagePaginateTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import DescribeDBClustersMessagePaginateTypeDef


def get_value() -> DescribeDBClustersMessagePaginateTypeDef:
    return {
        "DBClusterIdentifier": ...,
    }


# DescribeDBClustersMessagePaginateTypeDef definition

class DescribeDBClustersMessagePaginateTypeDef(TypedDict):
    DBClusterIdentifier: NotRequired[str],
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See FilterTypeDef
  2. See PaginatorConfigTypeDef

DescribeDBEngineVersionsMessagePaginateTypeDef#

# DescribeDBEngineVersionsMessagePaginateTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import DescribeDBEngineVersionsMessagePaginateTypeDef


def get_value() -> DescribeDBEngineVersionsMessagePaginateTypeDef:
    return {
        "Engine": ...,
    }


# DescribeDBEngineVersionsMessagePaginateTypeDef definition

class DescribeDBEngineVersionsMessagePaginateTypeDef(TypedDict):
    Engine: NotRequired[str],
    EngineVersion: NotRequired[str],
    DBParameterGroupFamily: NotRequired[str],
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
    DefaultOnly: NotRequired[bool],
    ListSupportedCharacterSets: NotRequired[bool],
    ListSupportedTimezones: NotRequired[bool],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See FilterTypeDef
  2. See PaginatorConfigTypeDef

DescribeDBInstancesMessagePaginateTypeDef#

# DescribeDBInstancesMessagePaginateTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import DescribeDBInstancesMessagePaginateTypeDef


def get_value() -> DescribeDBInstancesMessagePaginateTypeDef:
    return {
        "DBInstanceIdentifier": ...,
    }


# DescribeDBInstancesMessagePaginateTypeDef definition

class DescribeDBInstancesMessagePaginateTypeDef(TypedDict):
    DBInstanceIdentifier: NotRequired[str],
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See FilterTypeDef
  2. See PaginatorConfigTypeDef

DescribeDBSubnetGroupsMessagePaginateTypeDef#

# DescribeDBSubnetGroupsMessagePaginateTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import DescribeDBSubnetGroupsMessagePaginateTypeDef


def get_value() -> DescribeDBSubnetGroupsMessagePaginateTypeDef:
    return {
        "DBSubnetGroupName": ...,
    }


# DescribeDBSubnetGroupsMessagePaginateTypeDef definition

class DescribeDBSubnetGroupsMessagePaginateTypeDef(TypedDict):
    DBSubnetGroupName: NotRequired[str],
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See FilterTypeDef
  2. See PaginatorConfigTypeDef

DescribeEventSubscriptionsMessagePaginateTypeDef#

# DescribeEventSubscriptionsMessagePaginateTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import DescribeEventSubscriptionsMessagePaginateTypeDef


def get_value() -> DescribeEventSubscriptionsMessagePaginateTypeDef:
    return {
        "SubscriptionName": ...,
    }


# DescribeEventSubscriptionsMessagePaginateTypeDef definition

class DescribeEventSubscriptionsMessagePaginateTypeDef(TypedDict):
    SubscriptionName: NotRequired[str],
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See FilterTypeDef
  2. See PaginatorConfigTypeDef

DescribeGlobalClustersMessagePaginateTypeDef#

# DescribeGlobalClustersMessagePaginateTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import DescribeGlobalClustersMessagePaginateTypeDef


def get_value() -> DescribeGlobalClustersMessagePaginateTypeDef:
    return {
        "GlobalClusterIdentifier": ...,
    }


# DescribeGlobalClustersMessagePaginateTypeDef definition

class DescribeGlobalClustersMessagePaginateTypeDef(TypedDict):
    GlobalClusterIdentifier: NotRequired[str],
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See FilterTypeDef
  2. See PaginatorConfigTypeDef

DescribeOrderableDBInstanceOptionsMessagePaginateTypeDef#

# DescribeOrderableDBInstanceOptionsMessagePaginateTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import DescribeOrderableDBInstanceOptionsMessagePaginateTypeDef


def get_value() -> DescribeOrderableDBInstanceOptionsMessagePaginateTypeDef:
    return {
        "Engine": ...,
    }


# DescribeOrderableDBInstanceOptionsMessagePaginateTypeDef definition

class DescribeOrderableDBInstanceOptionsMessagePaginateTypeDef(TypedDict):
    Engine: str,
    EngineVersion: NotRequired[str],
    DBInstanceClass: NotRequired[str],
    LicenseModel: NotRequired[str],
    Vpc: NotRequired[bool],
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See FilterTypeDef
  2. See PaginatorConfigTypeDef

DescribePendingMaintenanceActionsMessagePaginateTypeDef#

# DescribePendingMaintenanceActionsMessagePaginateTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import DescribePendingMaintenanceActionsMessagePaginateTypeDef


def get_value() -> DescribePendingMaintenanceActionsMessagePaginateTypeDef:
    return {
        "ResourceIdentifier": ...,
    }


# DescribePendingMaintenanceActionsMessagePaginateTypeDef definition

class DescribePendingMaintenanceActionsMessagePaginateTypeDef(TypedDict):
    ResourceIdentifier: NotRequired[str],
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See FilterTypeDef
  2. See PaginatorConfigTypeDef

DescribeDBInstancesMessageWaitExtraTypeDef#

# DescribeDBInstancesMessageWaitExtraTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import DescribeDBInstancesMessageWaitExtraTypeDef


def get_value() -> DescribeDBInstancesMessageWaitExtraTypeDef:
    return {
        "DBInstanceIdentifier": ...,
    }


# DescribeDBInstancesMessageWaitExtraTypeDef definition

class DescribeDBInstancesMessageWaitExtraTypeDef(TypedDict):
    DBInstanceIdentifier: NotRequired[str],
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
    MaxRecords: NotRequired[int],
    Marker: NotRequired[str],
    WaiterConfig: NotRequired[WaiterConfigTypeDef],  # (2)
  1. See FilterTypeDef
  2. See WaiterConfigTypeDef

DescribeDBInstancesMessageWaitTypeDef#

# DescribeDBInstancesMessageWaitTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import DescribeDBInstancesMessageWaitTypeDef


def get_value() -> DescribeDBInstancesMessageWaitTypeDef:
    return {
        "DBInstanceIdentifier": ...,
    }


# DescribeDBInstancesMessageWaitTypeDef definition

class DescribeDBInstancesMessageWaitTypeDef(TypedDict):
    DBInstanceIdentifier: NotRequired[str],
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
    MaxRecords: NotRequired[int],
    Marker: NotRequired[str],
    WaiterConfig: NotRequired[WaiterConfigTypeDef],  # (2)
  1. See FilterTypeDef
  2. See WaiterConfigTypeDef

DescribeEventsMessagePaginateTypeDef#

# DescribeEventsMessagePaginateTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import DescribeEventsMessagePaginateTypeDef


def get_value() -> DescribeEventsMessagePaginateTypeDef:
    return {
        "SourceIdentifier": ...,
    }


# DescribeEventsMessagePaginateTypeDef definition

class DescribeEventsMessagePaginateTypeDef(TypedDict):
    SourceIdentifier: NotRequired[str],
    SourceType: NotRequired[SourceTypeType],  # (1)
    StartTime: NotRequired[TimestampTypeDef],
    EndTime: NotRequired[TimestampTypeDef],
    Duration: NotRequired[int],
    EventCategories: NotRequired[Sequence[str]],
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (2)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (3)
  1. See SourceTypeType
  2. See FilterTypeDef
  3. See PaginatorConfigTypeDef

DescribeEventsMessageTypeDef#

# DescribeEventsMessageTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import DescribeEventsMessageTypeDef


def get_value() -> DescribeEventsMessageTypeDef:
    return {
        "SourceIdentifier": ...,
    }


# DescribeEventsMessageTypeDef definition

class DescribeEventsMessageTypeDef(TypedDict):
    SourceIdentifier: NotRequired[str],
    SourceType: NotRequired[SourceTypeType],  # (1)
    StartTime: NotRequired[TimestampTypeDef],
    EndTime: NotRequired[TimestampTypeDef],
    Duration: NotRequired[int],
    EventCategories: NotRequired[Sequence[str]],
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (2)
    MaxRecords: NotRequired[int],
    Marker: NotRequired[str],
  1. See SourceTypeType
  2. See FilterTypeDef

RestoreDBClusterToPointInTimeMessageTypeDef#

# RestoreDBClusterToPointInTimeMessageTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import RestoreDBClusterToPointInTimeMessageTypeDef


def get_value() -> RestoreDBClusterToPointInTimeMessageTypeDef:
    return {
        "DBClusterIdentifier": ...,
    }


# RestoreDBClusterToPointInTimeMessageTypeDef definition

class RestoreDBClusterToPointInTimeMessageTypeDef(TypedDict):
    DBClusterIdentifier: str,
    SourceDBClusterIdentifier: str,
    RestoreType: NotRequired[str],
    RestoreToTime: NotRequired[TimestampTypeDef],
    UseLatestRestorableTime: NotRequired[bool],
    Port: NotRequired[int],
    DBSubnetGroupName: NotRequired[str],
    VpcSecurityGroupIds: NotRequired[Sequence[str]],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (1)
    KmsKeyId: NotRequired[str],
    EnableCloudwatchLogsExports: NotRequired[Sequence[str]],
    DeletionProtection: NotRequired[bool],
    StorageType: NotRequired[str],
  1. See TagTypeDef

EventCategoriesMessageTypeDef#

# EventCategoriesMessageTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import EventCategoriesMessageTypeDef


def get_value() -> EventCategoriesMessageTypeDef:
    return {
        "EventCategoriesMapList": ...,
    }


# EventCategoriesMessageTypeDef definition

class EventCategoriesMessageTypeDef(TypedDict):
    EventCategoriesMapList: List[EventCategoriesMapTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See EventCategoriesMapTypeDef
  2. See ResponseMetadataTypeDef

EventsMessageTypeDef#

# EventsMessageTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import EventsMessageTypeDef


def get_value() -> EventsMessageTypeDef:
    return {
        "Marker": ...,
    }


# EventsMessageTypeDef definition

class EventsMessageTypeDef(TypedDict):
    Marker: str,
    Events: List[EventTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See EventTypeDef
  2. See ResponseMetadataTypeDef

GlobalClusterTypeDef#

# GlobalClusterTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import GlobalClusterTypeDef


def get_value() -> GlobalClusterTypeDef:
    return {
        "GlobalClusterIdentifier": ...,
    }


# GlobalClusterTypeDef definition

class GlobalClusterTypeDef(TypedDict):
    GlobalClusterIdentifier: NotRequired[str],
    GlobalClusterResourceId: NotRequired[str],
    GlobalClusterArn: NotRequired[str],
    Status: NotRequired[str],
    Engine: NotRequired[str],
    EngineVersion: NotRequired[str],
    DatabaseName: NotRequired[str],
    StorageEncrypted: NotRequired[bool],
    DeletionProtection: NotRequired[bool],
    GlobalClusterMembers: NotRequired[List[GlobalClusterMemberTypeDef]],  # (1)
  1. See GlobalClusterMemberTypeDef

PendingModifiedValuesTypeDef#

# PendingModifiedValuesTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import PendingModifiedValuesTypeDef


def get_value() -> PendingModifiedValuesTypeDef:
    return {
        "DBInstanceClass": ...,
    }


# PendingModifiedValuesTypeDef definition

class PendingModifiedValuesTypeDef(TypedDict):
    DBInstanceClass: NotRequired[str],
    AllocatedStorage: NotRequired[int],
    MasterUserPassword: NotRequired[str],
    Port: NotRequired[int],
    BackupRetentionPeriod: NotRequired[int],
    MultiAZ: NotRequired[bool],
    EngineVersion: NotRequired[str],
    LicenseModel: NotRequired[str],
    Iops: NotRequired[int],
    DBInstanceIdentifier: NotRequired[str],
    StorageType: NotRequired[str],
    CACertificateIdentifier: NotRequired[str],
    DBSubnetGroupName: NotRequired[str],
    PendingCloudwatchLogsExports: NotRequired[PendingCloudwatchLogsExportsTypeDef],  # (1)
  1. See PendingCloudwatchLogsExportsTypeDef

ResourcePendingMaintenanceActionsTypeDef#

# ResourcePendingMaintenanceActionsTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import ResourcePendingMaintenanceActionsTypeDef


def get_value() -> ResourcePendingMaintenanceActionsTypeDef:
    return {
        "ResourceIdentifier": ...,
    }


# ResourcePendingMaintenanceActionsTypeDef definition

class ResourcePendingMaintenanceActionsTypeDef(TypedDict):
    ResourceIdentifier: NotRequired[str],
    PendingMaintenanceActionDetails: NotRequired[List[PendingMaintenanceActionTypeDef]],  # (1)
  1. See PendingMaintenanceActionTypeDef

OrderableDBInstanceOptionsMessageTypeDef#

# OrderableDBInstanceOptionsMessageTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import OrderableDBInstanceOptionsMessageTypeDef


def get_value() -> OrderableDBInstanceOptionsMessageTypeDef:
    return {
        "OrderableDBInstanceOptions": ...,
    }


# OrderableDBInstanceOptionsMessageTypeDef definition

class OrderableDBInstanceOptionsMessageTypeDef(TypedDict):
    OrderableDBInstanceOptions: List[OrderableDBInstanceOptionTypeDef],  # (1)
    Marker: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See OrderableDBInstanceOptionTypeDef
  2. See ResponseMetadataTypeDef

DBSubnetGroupTypeDef#

# DBSubnetGroupTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import DBSubnetGroupTypeDef


def get_value() -> DBSubnetGroupTypeDef:
    return {
        "DBSubnetGroupName": ...,
    }


# DBSubnetGroupTypeDef definition

class DBSubnetGroupTypeDef(TypedDict):
    DBSubnetGroupName: NotRequired[str],
    DBSubnetGroupDescription: NotRequired[str],
    VpcId: NotRequired[str],
    SubnetGroupStatus: NotRequired[str],
    Subnets: NotRequired[List[SubnetTypeDef]],  # (1)
    DBSubnetGroupArn: NotRequired[str],
  1. See SubnetTypeDef

DescribeEngineDefaultClusterParametersResultTypeDef#

# DescribeEngineDefaultClusterParametersResultTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import DescribeEngineDefaultClusterParametersResultTypeDef


def get_value() -> DescribeEngineDefaultClusterParametersResultTypeDef:
    return {
        "EngineDefaults": ...,
    }


# DescribeEngineDefaultClusterParametersResultTypeDef definition

class DescribeEngineDefaultClusterParametersResultTypeDef(TypedDict):
    EngineDefaults: EngineDefaultsTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See EngineDefaultsTypeDef
  2. See ResponseMetadataTypeDef

DescribeDBClusterSnapshotAttributesResultTypeDef#

# DescribeDBClusterSnapshotAttributesResultTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import DescribeDBClusterSnapshotAttributesResultTypeDef


def get_value() -> DescribeDBClusterSnapshotAttributesResultTypeDef:
    return {
        "DBClusterSnapshotAttributesResult": ...,
    }


# DescribeDBClusterSnapshotAttributesResultTypeDef definition

class DescribeDBClusterSnapshotAttributesResultTypeDef(TypedDict):
    DBClusterSnapshotAttributesResult: DBClusterSnapshotAttributesResultTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DBClusterSnapshotAttributesResultTypeDef
  2. See ResponseMetadataTypeDef

ModifyDBClusterSnapshotAttributeResultTypeDef#

# ModifyDBClusterSnapshotAttributeResultTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import ModifyDBClusterSnapshotAttributeResultTypeDef


def get_value() -> ModifyDBClusterSnapshotAttributeResultTypeDef:
    return {
        "DBClusterSnapshotAttributesResult": ...,
    }


# ModifyDBClusterSnapshotAttributeResultTypeDef definition

class ModifyDBClusterSnapshotAttributeResultTypeDef(TypedDict):
    DBClusterSnapshotAttributesResult: DBClusterSnapshotAttributesResultTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DBClusterSnapshotAttributesResultTypeDef
  2. See ResponseMetadataTypeDef

CreateDBClusterResultTypeDef#

# CreateDBClusterResultTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import CreateDBClusterResultTypeDef


def get_value() -> CreateDBClusterResultTypeDef:
    return {
        "DBCluster": ...,
    }


# CreateDBClusterResultTypeDef definition

class CreateDBClusterResultTypeDef(TypedDict):
    DBCluster: DBClusterTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DBClusterTypeDef
  2. See ResponseMetadataTypeDef

DBClusterMessageTypeDef#

# DBClusterMessageTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import DBClusterMessageTypeDef


def get_value() -> DBClusterMessageTypeDef:
    return {
        "Marker": ...,
    }


# DBClusterMessageTypeDef definition

class DBClusterMessageTypeDef(TypedDict):
    Marker: str,
    DBClusters: List[DBClusterTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DBClusterTypeDef
  2. See ResponseMetadataTypeDef

DeleteDBClusterResultTypeDef#

# DeleteDBClusterResultTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import DeleteDBClusterResultTypeDef


def get_value() -> DeleteDBClusterResultTypeDef:
    return {
        "DBCluster": ...,
    }


# DeleteDBClusterResultTypeDef definition

class DeleteDBClusterResultTypeDef(TypedDict):
    DBCluster: DBClusterTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DBClusterTypeDef
  2. See ResponseMetadataTypeDef

FailoverDBClusterResultTypeDef#

# FailoverDBClusterResultTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import FailoverDBClusterResultTypeDef


def get_value() -> FailoverDBClusterResultTypeDef:
    return {
        "DBCluster": ...,
    }


# FailoverDBClusterResultTypeDef definition

class FailoverDBClusterResultTypeDef(TypedDict):
    DBCluster: DBClusterTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DBClusterTypeDef
  2. See ResponseMetadataTypeDef

ModifyDBClusterResultTypeDef#

# ModifyDBClusterResultTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import ModifyDBClusterResultTypeDef


def get_value() -> ModifyDBClusterResultTypeDef:
    return {
        "DBCluster": ...,
    }


# ModifyDBClusterResultTypeDef definition

class ModifyDBClusterResultTypeDef(TypedDict):
    DBCluster: DBClusterTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DBClusterTypeDef
  2. See ResponseMetadataTypeDef

RestoreDBClusterFromSnapshotResultTypeDef#

# RestoreDBClusterFromSnapshotResultTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import RestoreDBClusterFromSnapshotResultTypeDef


def get_value() -> RestoreDBClusterFromSnapshotResultTypeDef:
    return {
        "DBCluster": ...,
    }


# RestoreDBClusterFromSnapshotResultTypeDef definition

class RestoreDBClusterFromSnapshotResultTypeDef(TypedDict):
    DBCluster: DBClusterTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DBClusterTypeDef
  2. See ResponseMetadataTypeDef

RestoreDBClusterToPointInTimeResultTypeDef#

# RestoreDBClusterToPointInTimeResultTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import RestoreDBClusterToPointInTimeResultTypeDef


def get_value() -> RestoreDBClusterToPointInTimeResultTypeDef:
    return {
        "DBCluster": ...,
    }


# RestoreDBClusterToPointInTimeResultTypeDef definition

class RestoreDBClusterToPointInTimeResultTypeDef(TypedDict):
    DBCluster: DBClusterTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DBClusterTypeDef
  2. See ResponseMetadataTypeDef

StartDBClusterResultTypeDef#

# StartDBClusterResultTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import StartDBClusterResultTypeDef


def get_value() -> StartDBClusterResultTypeDef:
    return {
        "DBCluster": ...,
    }


# StartDBClusterResultTypeDef definition

class StartDBClusterResultTypeDef(TypedDict):
    DBCluster: DBClusterTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DBClusterTypeDef
  2. See ResponseMetadataTypeDef

StopDBClusterResultTypeDef#

# StopDBClusterResultTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import StopDBClusterResultTypeDef


def get_value() -> StopDBClusterResultTypeDef:
    return {
        "DBCluster": ...,
    }


# StopDBClusterResultTypeDef definition

class StopDBClusterResultTypeDef(TypedDict):
    DBCluster: DBClusterTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DBClusterTypeDef
  2. See ResponseMetadataTypeDef

DBEngineVersionMessageTypeDef#

# DBEngineVersionMessageTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import DBEngineVersionMessageTypeDef


def get_value() -> DBEngineVersionMessageTypeDef:
    return {
        "Marker": ...,
    }


# DBEngineVersionMessageTypeDef definition

class DBEngineVersionMessageTypeDef(TypedDict):
    Marker: str,
    DBEngineVersions: List[DBEngineVersionTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DBEngineVersionTypeDef
  2. See ResponseMetadataTypeDef

CreateGlobalClusterResultTypeDef#

# CreateGlobalClusterResultTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import CreateGlobalClusterResultTypeDef


def get_value() -> CreateGlobalClusterResultTypeDef:
    return {
        "GlobalCluster": ...,
    }


# CreateGlobalClusterResultTypeDef definition

class CreateGlobalClusterResultTypeDef(TypedDict):
    GlobalCluster: GlobalClusterTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See GlobalClusterTypeDef
  2. See ResponseMetadataTypeDef

DeleteGlobalClusterResultTypeDef#

# DeleteGlobalClusterResultTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import DeleteGlobalClusterResultTypeDef


def get_value() -> DeleteGlobalClusterResultTypeDef:
    return {
        "GlobalCluster": ...,
    }


# DeleteGlobalClusterResultTypeDef definition

class DeleteGlobalClusterResultTypeDef(TypedDict):
    GlobalCluster: GlobalClusterTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See GlobalClusterTypeDef
  2. See ResponseMetadataTypeDef

FailoverGlobalClusterResultTypeDef#

# FailoverGlobalClusterResultTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import FailoverGlobalClusterResultTypeDef


def get_value() -> FailoverGlobalClusterResultTypeDef:
    return {
        "GlobalCluster": ...,
    }


# FailoverGlobalClusterResultTypeDef definition

class FailoverGlobalClusterResultTypeDef(TypedDict):
    GlobalCluster: GlobalClusterTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See GlobalClusterTypeDef
  2. See ResponseMetadataTypeDef

GlobalClustersMessageTypeDef#

# GlobalClustersMessageTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import GlobalClustersMessageTypeDef


def get_value() -> GlobalClustersMessageTypeDef:
    return {
        "Marker": ...,
    }


# GlobalClustersMessageTypeDef definition

class GlobalClustersMessageTypeDef(TypedDict):
    Marker: str,
    GlobalClusters: List[GlobalClusterTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See GlobalClusterTypeDef
  2. See ResponseMetadataTypeDef

ModifyGlobalClusterResultTypeDef#

# ModifyGlobalClusterResultTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import ModifyGlobalClusterResultTypeDef


def get_value() -> ModifyGlobalClusterResultTypeDef:
    return {
        "GlobalCluster": ...,
    }


# ModifyGlobalClusterResultTypeDef definition

class ModifyGlobalClusterResultTypeDef(TypedDict):
    GlobalCluster: GlobalClusterTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See GlobalClusterTypeDef
  2. See ResponseMetadataTypeDef

RemoveFromGlobalClusterResultTypeDef#

# RemoveFromGlobalClusterResultTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import RemoveFromGlobalClusterResultTypeDef


def get_value() -> RemoveFromGlobalClusterResultTypeDef:
    return {
        "GlobalCluster": ...,
    }


# RemoveFromGlobalClusterResultTypeDef definition

class RemoveFromGlobalClusterResultTypeDef(TypedDict):
    GlobalCluster: GlobalClusterTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See GlobalClusterTypeDef
  2. See ResponseMetadataTypeDef

SwitchoverGlobalClusterResultTypeDef#

# SwitchoverGlobalClusterResultTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import SwitchoverGlobalClusterResultTypeDef


def get_value() -> SwitchoverGlobalClusterResultTypeDef:
    return {
        "GlobalCluster": ...,
    }


# SwitchoverGlobalClusterResultTypeDef definition

class SwitchoverGlobalClusterResultTypeDef(TypedDict):
    GlobalCluster: GlobalClusterTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See GlobalClusterTypeDef
  2. See ResponseMetadataTypeDef

ApplyPendingMaintenanceActionResultTypeDef#

# ApplyPendingMaintenanceActionResultTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import ApplyPendingMaintenanceActionResultTypeDef


def get_value() -> ApplyPendingMaintenanceActionResultTypeDef:
    return {
        "ResourcePendingMaintenanceActions": ...,
    }


# ApplyPendingMaintenanceActionResultTypeDef definition

class ApplyPendingMaintenanceActionResultTypeDef(TypedDict):
    ResourcePendingMaintenanceActions: ResourcePendingMaintenanceActionsTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ResourcePendingMaintenanceActionsTypeDef
  2. See ResponseMetadataTypeDef

PendingMaintenanceActionsMessageTypeDef#

# PendingMaintenanceActionsMessageTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import PendingMaintenanceActionsMessageTypeDef


def get_value() -> PendingMaintenanceActionsMessageTypeDef:
    return {
        "PendingMaintenanceActions": ...,
    }


# PendingMaintenanceActionsMessageTypeDef definition

class PendingMaintenanceActionsMessageTypeDef(TypedDict):
    PendingMaintenanceActions: List[ResourcePendingMaintenanceActionsTypeDef],  # (1)
    Marker: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ResourcePendingMaintenanceActionsTypeDef
  2. See ResponseMetadataTypeDef

CreateDBSubnetGroupResultTypeDef#

# CreateDBSubnetGroupResultTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import CreateDBSubnetGroupResultTypeDef


def get_value() -> CreateDBSubnetGroupResultTypeDef:
    return {
        "DBSubnetGroup": ...,
    }


# CreateDBSubnetGroupResultTypeDef definition

class CreateDBSubnetGroupResultTypeDef(TypedDict):
    DBSubnetGroup: DBSubnetGroupTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DBSubnetGroupTypeDef
  2. See ResponseMetadataTypeDef

DBInstanceTypeDef#

# DBInstanceTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import DBInstanceTypeDef


def get_value() -> DBInstanceTypeDef:
    return {
        "DBInstanceIdentifier": ...,
    }


# DBInstanceTypeDef definition

class DBInstanceTypeDef(TypedDict):
    DBInstanceIdentifier: NotRequired[str],
    DBInstanceClass: NotRequired[str],
    Engine: NotRequired[str],
    DBInstanceStatus: NotRequired[str],
    Endpoint: NotRequired[EndpointTypeDef],  # (1)
    InstanceCreateTime: NotRequired[datetime],
    PreferredBackupWindow: NotRequired[str],
    BackupRetentionPeriod: NotRequired[int],
    VpcSecurityGroups: NotRequired[List[VpcSecurityGroupMembershipTypeDef]],  # (2)
    AvailabilityZone: NotRequired[str],
    DBSubnetGroup: NotRequired[DBSubnetGroupTypeDef],  # (3)
    PreferredMaintenanceWindow: NotRequired[str],
    PendingModifiedValues: NotRequired[PendingModifiedValuesTypeDef],  # (4)
    LatestRestorableTime: NotRequired[datetime],
    EngineVersion: NotRequired[str],
    AutoMinorVersionUpgrade: NotRequired[bool],
    PubliclyAccessible: NotRequired[bool],
    StatusInfos: NotRequired[List[DBInstanceStatusInfoTypeDef]],  # (5)
    DBClusterIdentifier: NotRequired[str],
    StorageEncrypted: NotRequired[bool],
    KmsKeyId: NotRequired[str],
    DbiResourceId: NotRequired[str],
    CACertificateIdentifier: NotRequired[str],
    CopyTagsToSnapshot: NotRequired[bool],
    PromotionTier: NotRequired[int],
    DBInstanceArn: NotRequired[str],
    EnabledCloudwatchLogsExports: NotRequired[List[str]],
    CertificateDetails: NotRequired[CertificateDetailsTypeDef],  # (6)
    PerformanceInsightsEnabled: NotRequired[bool],
    PerformanceInsightsKMSKeyId: NotRequired[str],
  1. See EndpointTypeDef
  2. See VpcSecurityGroupMembershipTypeDef
  3. See DBSubnetGroupTypeDef
  4. See PendingModifiedValuesTypeDef
  5. See DBInstanceStatusInfoTypeDef
  6. See CertificateDetailsTypeDef

DBSubnetGroupMessageTypeDef#

# DBSubnetGroupMessageTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import DBSubnetGroupMessageTypeDef


def get_value() -> DBSubnetGroupMessageTypeDef:
    return {
        "Marker": ...,
    }


# DBSubnetGroupMessageTypeDef definition

class DBSubnetGroupMessageTypeDef(TypedDict):
    Marker: str,
    DBSubnetGroups: List[DBSubnetGroupTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DBSubnetGroupTypeDef
  2. See ResponseMetadataTypeDef

ModifyDBSubnetGroupResultTypeDef#

# ModifyDBSubnetGroupResultTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import ModifyDBSubnetGroupResultTypeDef


def get_value() -> ModifyDBSubnetGroupResultTypeDef:
    return {
        "DBSubnetGroup": ...,
    }


# ModifyDBSubnetGroupResultTypeDef definition

class ModifyDBSubnetGroupResultTypeDef(TypedDict):
    DBSubnetGroup: DBSubnetGroupTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DBSubnetGroupTypeDef
  2. See ResponseMetadataTypeDef

CreateDBInstanceResultTypeDef#

# CreateDBInstanceResultTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import CreateDBInstanceResultTypeDef


def get_value() -> CreateDBInstanceResultTypeDef:
    return {
        "DBInstance": ...,
    }


# CreateDBInstanceResultTypeDef definition

class CreateDBInstanceResultTypeDef(TypedDict):
    DBInstance: DBInstanceTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DBInstanceTypeDef
  2. See ResponseMetadataTypeDef

DBInstanceMessageTypeDef#

# DBInstanceMessageTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import DBInstanceMessageTypeDef


def get_value() -> DBInstanceMessageTypeDef:
    return {
        "Marker": ...,
    }


# DBInstanceMessageTypeDef definition

class DBInstanceMessageTypeDef(TypedDict):
    Marker: str,
    DBInstances: List[DBInstanceTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DBInstanceTypeDef
  2. See ResponseMetadataTypeDef

DeleteDBInstanceResultTypeDef#

# DeleteDBInstanceResultTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import DeleteDBInstanceResultTypeDef


def get_value() -> DeleteDBInstanceResultTypeDef:
    return {
        "DBInstance": ...,
    }


# DeleteDBInstanceResultTypeDef definition

class DeleteDBInstanceResultTypeDef(TypedDict):
    DBInstance: DBInstanceTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DBInstanceTypeDef
  2. See ResponseMetadataTypeDef

ModifyDBInstanceResultTypeDef#

# ModifyDBInstanceResultTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import ModifyDBInstanceResultTypeDef


def get_value() -> ModifyDBInstanceResultTypeDef:
    return {
        "DBInstance": ...,
    }


# ModifyDBInstanceResultTypeDef definition

class ModifyDBInstanceResultTypeDef(TypedDict):
    DBInstance: DBInstanceTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DBInstanceTypeDef
  2. See ResponseMetadataTypeDef

RebootDBInstanceResultTypeDef#

# RebootDBInstanceResultTypeDef TypedDict usage example

from types_boto3_docdb.type_defs import RebootDBInstanceResultTypeDef


def get_value() -> RebootDBInstanceResultTypeDef:
    return {
        "DBInstance": ...,
    }


# RebootDBInstanceResultTypeDef definition

class RebootDBInstanceResultTypeDef(TypedDict):
    DBInstance: DBInstanceTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DBInstanceTypeDef
  2. See ResponseMetadataTypeDef