Skip to content

Typed dictionaries

Index > DocDB > Typed dictionaries

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

AddSourceIdentifierToSubscriptionMessageRequestTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import AddSourceIdentifierToSubscriptionMessageRequestTypeDef

def get_value() -> AddSourceIdentifierToSubscriptionMessageRequestTypeDef:
    return {
        "SubscriptionName": ...,
        "SourceIdentifier": ...,
    }
Definition
class AddSourceIdentifierToSubscriptionMessageRequestTypeDef(TypedDict):
    SubscriptionName: str,
    SourceIdentifier: str,

EventSubscriptionTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import EventSubscriptionTypeDef

def get_value() -> EventSubscriptionTypeDef:
    return {
        "CustomerAwsId": ...,
    }
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

Usage Example
from mypy_boto3_docdb.type_defs import ResponseMetadataTypeDef

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

TagTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import TagTypeDef

def get_value() -> TagTypeDef:
    return {
        "Key": ...,
    }
Definition
class TagTypeDef(TypedDict):
    Key: NotRequired[str],
    Value: NotRequired[str],

ApplyPendingMaintenanceActionMessageRequestTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import ApplyPendingMaintenanceActionMessageRequestTypeDef

def get_value() -> ApplyPendingMaintenanceActionMessageRequestTypeDef:
    return {
        "ResourceIdentifier": ...,
        "ApplyAction": ...,
        "OptInType": ...,
    }
Definition
class ApplyPendingMaintenanceActionMessageRequestTypeDef(TypedDict):
    ResourceIdentifier: str,
    ApplyAction: str,
    OptInType: str,

AvailabilityZoneTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import AvailabilityZoneTypeDef

def get_value() -> AvailabilityZoneTypeDef:
    return {
        "Name": ...,
    }
Definition
class AvailabilityZoneTypeDef(TypedDict):
    Name: NotRequired[str],

CertificateTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import CertificateTypeDef

def get_value() -> CertificateTypeDef:
    return {
        "CertificateIdentifier": ...,
    }
Definition
class CertificateTypeDef(TypedDict):
    CertificateIdentifier: NotRequired[str],
    CertificateType: NotRequired[str],
    Thumbprint: NotRequired[str],
    ValidFrom: NotRequired[datetime],
    ValidTill: NotRequired[datetime],
    CertificateArn: NotRequired[str],

CloudwatchLogsExportConfigurationTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import CloudwatchLogsExportConfigurationTypeDef

def get_value() -> CloudwatchLogsExportConfigurationTypeDef:
    return {
        "EnableLogTypes": ...,
    }
Definition
class CloudwatchLogsExportConfigurationTypeDef(TypedDict):
    EnableLogTypes: NotRequired[Sequence[str]],
    DisableLogTypes: NotRequired[Sequence[str]],

DBClusterParameterGroupTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import DBClusterParameterGroupTypeDef

def get_value() -> DBClusterParameterGroupTypeDef:
    return {
        "DBClusterParameterGroupName": ...,
    }
Definition
class DBClusterParameterGroupTypeDef(TypedDict):
    DBClusterParameterGroupName: NotRequired[str],
    DBParameterGroupFamily: NotRequired[str],
    Description: NotRequired[str],
    DBClusterParameterGroupArn: NotRequired[str],

DBClusterSnapshotTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import DBClusterSnapshotTypeDef

def get_value() -> DBClusterSnapshotTypeDef:
    return {
        "AvailabilityZones": ...,
    }
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],

CreateGlobalClusterMessageRequestTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import CreateGlobalClusterMessageRequestTypeDef

def get_value() -> CreateGlobalClusterMessageRequestTypeDef:
    return {
        "GlobalClusterIdentifier": ...,
    }
Definition
class CreateGlobalClusterMessageRequestTypeDef(TypedDict):
    GlobalClusterIdentifier: str,
    SourceDBClusterIdentifier: NotRequired[str],
    Engine: NotRequired[str],
    EngineVersion: NotRequired[str],
    DeletionProtection: NotRequired[bool],
    DatabaseName: NotRequired[str],
    StorageEncrypted: NotRequired[bool],

DBClusterMemberTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import DBClusterMemberTypeDef

def get_value() -> DBClusterMemberTypeDef:
    return {
        "DBInstanceIdentifier": ...,
    }
Definition
class DBClusterMemberTypeDef(TypedDict):
    DBInstanceIdentifier: NotRequired[str],
    IsClusterWriter: NotRequired[bool],
    DBClusterParameterGroupStatus: NotRequired[str],
    PromotionTier: NotRequired[int],

ParameterTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import ParameterTypeDef

def get_value() -> ParameterTypeDef:
    return {
        "ParameterName": ...,
    }
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

Usage Example
from mypy_boto3_docdb.type_defs import DBClusterRoleTypeDef

def get_value() -> DBClusterRoleTypeDef:
    return {
        "RoleArn": ...,
    }
Definition
class DBClusterRoleTypeDef(TypedDict):
    RoleArn: NotRequired[str],
    Status: NotRequired[str],

DBClusterSnapshotAttributeTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import DBClusterSnapshotAttributeTypeDef

def get_value() -> DBClusterSnapshotAttributeTypeDef:
    return {
        "AttributeName": ...,
    }
Definition
class DBClusterSnapshotAttributeTypeDef(TypedDict):
    AttributeName: NotRequired[str],
    AttributeValues: NotRequired[List[str]],

VpcSecurityGroupMembershipTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import VpcSecurityGroupMembershipTypeDef

def get_value() -> VpcSecurityGroupMembershipTypeDef:
    return {
        "VpcSecurityGroupId": ...,
    }
Definition
class VpcSecurityGroupMembershipTypeDef(TypedDict):
    VpcSecurityGroupId: NotRequired[str],
    Status: NotRequired[str],

UpgradeTargetTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import UpgradeTargetTypeDef

def get_value() -> UpgradeTargetTypeDef:
    return {
        "Engine": ...,
    }
Definition
class UpgradeTargetTypeDef(TypedDict):
    Engine: NotRequired[str],
    EngineVersion: NotRequired[str],
    Description: NotRequired[str],
    AutoUpgrade: NotRequired[bool],
    IsMajorVersionUpgrade: NotRequired[bool],

DBInstanceStatusInfoTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import DBInstanceStatusInfoTypeDef

def get_value() -> DBInstanceStatusInfoTypeDef:
    return {
        "StatusType": ...,
    }
Definition
class DBInstanceStatusInfoTypeDef(TypedDict):
    StatusType: NotRequired[str],
    Normal: NotRequired[bool],
    Status: NotRequired[str],
    Message: NotRequired[str],

EndpointTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import EndpointTypeDef

def get_value() -> EndpointTypeDef:
    return {
        "Address": ...,
    }
Definition
class EndpointTypeDef(TypedDict):
    Address: NotRequired[str],
    Port: NotRequired[int],
    HostedZoneId: NotRequired[str],

DeleteDBClusterMessageRequestTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import DeleteDBClusterMessageRequestTypeDef

def get_value() -> DeleteDBClusterMessageRequestTypeDef:
    return {
        "DBClusterIdentifier": ...,
    }
Definition
class DeleteDBClusterMessageRequestTypeDef(TypedDict):
    DBClusterIdentifier: str,
    SkipFinalSnapshot: NotRequired[bool],
    FinalDBSnapshotIdentifier: NotRequired[str],

DeleteDBClusterParameterGroupMessageRequestTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import DeleteDBClusterParameterGroupMessageRequestTypeDef

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

DeleteDBClusterSnapshotMessageRequestTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import DeleteDBClusterSnapshotMessageRequestTypeDef

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

DeleteDBInstanceMessageRequestTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import DeleteDBInstanceMessageRequestTypeDef

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

DeleteDBSubnetGroupMessageRequestTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import DeleteDBSubnetGroupMessageRequestTypeDef

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

DeleteEventSubscriptionMessageRequestTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import DeleteEventSubscriptionMessageRequestTypeDef

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

DeleteGlobalClusterMessageRequestTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import DeleteGlobalClusterMessageRequestTypeDef

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

FilterTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import FilterTypeDef

def get_value() -> FilterTypeDef:
    return {
        "Name": ...,
        "Values": ...,
    }
Definition
class FilterTypeDef(TypedDict):
    Name: str,
    Values: Sequence[str],

PaginatorConfigTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import PaginatorConfigTypeDef

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

DescribeDBClusterSnapshotAttributesMessageRequestTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import DescribeDBClusterSnapshotAttributesMessageRequestTypeDef

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

WaiterConfigTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import WaiterConfigTypeDef

def get_value() -> WaiterConfigTypeDef:
    return {
        "Delay": ...,
    }
Definition
class WaiterConfigTypeDef(TypedDict):
    Delay: NotRequired[int],
    MaxAttempts: NotRequired[int],

EventCategoriesMapTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import EventCategoriesMapTypeDef

def get_value() -> EventCategoriesMapTypeDef:
    return {
        "SourceType": ...,
    }
Definition
class EventCategoriesMapTypeDef(TypedDict):
    SourceType: NotRequired[str],
    EventCategories: NotRequired[List[str]],

EventTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import EventTypeDef

def get_value() -> EventTypeDef:
    return {
        "SourceIdentifier": ...,
    }
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

FailoverDBClusterMessageRequestTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import FailoverDBClusterMessageRequestTypeDef

def get_value() -> FailoverDBClusterMessageRequestTypeDef:
    return {
        "DBClusterIdentifier": ...,
    }
Definition
class FailoverDBClusterMessageRequestTypeDef(TypedDict):
    DBClusterIdentifier: NotRequired[str],
    TargetDBInstanceIdentifier: NotRequired[str],

GlobalClusterMemberTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import GlobalClusterMemberTypeDef

def get_value() -> GlobalClusterMemberTypeDef:
    return {
        "DBClusterArn": ...,
    }
Definition
class GlobalClusterMemberTypeDef(TypedDict):
    DBClusterArn: NotRequired[str],
    Readers: NotRequired[List[str]],
    IsWriter: NotRequired[bool],

ModifyDBClusterSnapshotAttributeMessageRequestTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import ModifyDBClusterSnapshotAttributeMessageRequestTypeDef

def get_value() -> ModifyDBClusterSnapshotAttributeMessageRequestTypeDef:
    return {
        "DBClusterSnapshotIdentifier": ...,
        "AttributeName": ...,
    }
Definition
class ModifyDBClusterSnapshotAttributeMessageRequestTypeDef(TypedDict):
    DBClusterSnapshotIdentifier: str,
    AttributeName: str,
    ValuesToAdd: NotRequired[Sequence[str]],
    ValuesToRemove: NotRequired[Sequence[str]],

ModifyDBInstanceMessageRequestTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import ModifyDBInstanceMessageRequestTypeDef

def get_value() -> ModifyDBInstanceMessageRequestTypeDef:
    return {
        "DBInstanceIdentifier": ...,
    }
Definition
class ModifyDBInstanceMessageRequestTypeDef(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],

ModifyDBSubnetGroupMessageRequestTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import ModifyDBSubnetGroupMessageRequestTypeDef

def get_value() -> ModifyDBSubnetGroupMessageRequestTypeDef:
    return {
        "DBSubnetGroupName": ...,
        "SubnetIds": ...,
    }
Definition
class ModifyDBSubnetGroupMessageRequestTypeDef(TypedDict):
    DBSubnetGroupName: str,
    SubnetIds: Sequence[str],
    DBSubnetGroupDescription: NotRequired[str],

ModifyEventSubscriptionMessageRequestTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import ModifyEventSubscriptionMessageRequestTypeDef

def get_value() -> ModifyEventSubscriptionMessageRequestTypeDef:
    return {
        "SubscriptionName": ...,
    }
Definition
class ModifyEventSubscriptionMessageRequestTypeDef(TypedDict):
    SubscriptionName: str,
    SnsTopicArn: NotRequired[str],
    SourceType: NotRequired[str],
    EventCategories: NotRequired[Sequence[str]],
    Enabled: NotRequired[bool],

ModifyGlobalClusterMessageRequestTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import ModifyGlobalClusterMessageRequestTypeDef

def get_value() -> ModifyGlobalClusterMessageRequestTypeDef:
    return {
        "GlobalClusterIdentifier": ...,
    }
Definition
class ModifyGlobalClusterMessageRequestTypeDef(TypedDict):
    GlobalClusterIdentifier: str,
    NewGlobalClusterIdentifier: NotRequired[str],
    DeletionProtection: NotRequired[bool],

PendingCloudwatchLogsExportsTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import PendingCloudwatchLogsExportsTypeDef

def get_value() -> PendingCloudwatchLogsExportsTypeDef:
    return {
        "LogTypesToEnable": ...,
    }
Definition
class PendingCloudwatchLogsExportsTypeDef(TypedDict):
    LogTypesToEnable: NotRequired[List[str]],
    LogTypesToDisable: NotRequired[List[str]],

PendingMaintenanceActionTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import PendingMaintenanceActionTypeDef

def get_value() -> PendingMaintenanceActionTypeDef:
    return {
        "Action": ...,
    }
Definition
class PendingMaintenanceActionTypeDef(TypedDict):
    Action: NotRequired[str],
    AutoAppliedAfterDate: NotRequired[datetime],
    ForcedApplyDate: NotRequired[datetime],
    OptInStatus: NotRequired[str],
    CurrentApplyDate: NotRequired[datetime],
    Description: NotRequired[str],

RebootDBInstanceMessageRequestTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import RebootDBInstanceMessageRequestTypeDef

def get_value() -> RebootDBInstanceMessageRequestTypeDef:
    return {
        "DBInstanceIdentifier": ...,
    }
Definition
class RebootDBInstanceMessageRequestTypeDef(TypedDict):
    DBInstanceIdentifier: str,
    ForceFailover: NotRequired[bool],

RemoveFromGlobalClusterMessageRequestTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import RemoveFromGlobalClusterMessageRequestTypeDef

def get_value() -> RemoveFromGlobalClusterMessageRequestTypeDef:
    return {
        "GlobalClusterIdentifier": ...,
        "DbClusterIdentifier": ...,
    }
Definition
class RemoveFromGlobalClusterMessageRequestTypeDef(TypedDict):
    GlobalClusterIdentifier: str,
    DbClusterIdentifier: str,

RemoveSourceIdentifierFromSubscriptionMessageRequestTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import RemoveSourceIdentifierFromSubscriptionMessageRequestTypeDef

def get_value() -> RemoveSourceIdentifierFromSubscriptionMessageRequestTypeDef:
    return {
        "SubscriptionName": ...,
        "SourceIdentifier": ...,
    }
Definition
class RemoveSourceIdentifierFromSubscriptionMessageRequestTypeDef(TypedDict):
    SubscriptionName: str,
    SourceIdentifier: str,

RemoveTagsFromResourceMessageRequestTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import RemoveTagsFromResourceMessageRequestTypeDef

def get_value() -> RemoveTagsFromResourceMessageRequestTypeDef:
    return {
        "ResourceName": ...,
        "TagKeys": ...,
    }
Definition
class RemoveTagsFromResourceMessageRequestTypeDef(TypedDict):
    ResourceName: str,
    TagKeys: Sequence[str],

StartDBClusterMessageRequestTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import StartDBClusterMessageRequestTypeDef

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

StopDBClusterMessageRequestTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import StopDBClusterMessageRequestTypeDef

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

AddSourceIdentifierToSubscriptionResultTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import AddSourceIdentifierToSubscriptionResultTypeDef

def get_value() -> AddSourceIdentifierToSubscriptionResultTypeDef:
    return {
        "EventSubscription": ...,
        "ResponseMetadata": ...,
    }
Definition
class AddSourceIdentifierToSubscriptionResultTypeDef(TypedDict):
    EventSubscription: EventSubscriptionTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See EventSubscriptionTypeDef
  2. See ResponseMetadataTypeDef

CreateEventSubscriptionResultTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import CreateEventSubscriptionResultTypeDef

def get_value() -> CreateEventSubscriptionResultTypeDef:
    return {
        "EventSubscription": ...,
        "ResponseMetadata": ...,
    }
Definition
class CreateEventSubscriptionResultTypeDef(TypedDict):
    EventSubscription: EventSubscriptionTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See EventSubscriptionTypeDef
  2. See ResponseMetadataTypeDef

DBClusterParameterGroupNameMessageTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import DBClusterParameterGroupNameMessageTypeDef

def get_value() -> DBClusterParameterGroupNameMessageTypeDef:
    return {
        "DBClusterParameterGroupName": ...,
        "ResponseMetadata": ...,
    }
Definition
class DBClusterParameterGroupNameMessageTypeDef(TypedDict):
    DBClusterParameterGroupName: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteEventSubscriptionResultTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import DeleteEventSubscriptionResultTypeDef

def get_value() -> DeleteEventSubscriptionResultTypeDef:
    return {
        "EventSubscription": ...,
        "ResponseMetadata": ...,
    }
Definition
class DeleteEventSubscriptionResultTypeDef(TypedDict):
    EventSubscription: EventSubscriptionTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See EventSubscriptionTypeDef
  2. See ResponseMetadataTypeDef

EmptyResponseMetadataTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import EmptyResponseMetadataTypeDef

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

EventSubscriptionsMessageTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import EventSubscriptionsMessageTypeDef

def get_value() -> EventSubscriptionsMessageTypeDef:
    return {
        "Marker": ...,
        "EventSubscriptionsList": ...,
        "ResponseMetadata": ...,
    }
Definition
class EventSubscriptionsMessageTypeDef(TypedDict):
    Marker: str,
    EventSubscriptionsList: List[EventSubscriptionTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See EventSubscriptionTypeDef
  2. See ResponseMetadataTypeDef

ModifyEventSubscriptionResultTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import ModifyEventSubscriptionResultTypeDef

def get_value() -> ModifyEventSubscriptionResultTypeDef:
    return {
        "EventSubscription": ...,
        "ResponseMetadata": ...,
    }
Definition
class ModifyEventSubscriptionResultTypeDef(TypedDict):
    EventSubscription: EventSubscriptionTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See EventSubscriptionTypeDef
  2. See ResponseMetadataTypeDef

RemoveSourceIdentifierFromSubscriptionResultTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import RemoveSourceIdentifierFromSubscriptionResultTypeDef

def get_value() -> RemoveSourceIdentifierFromSubscriptionResultTypeDef:
    return {
        "EventSubscription": ...,
        "ResponseMetadata": ...,
    }
Definition
class RemoveSourceIdentifierFromSubscriptionResultTypeDef(TypedDict):
    EventSubscription: EventSubscriptionTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See EventSubscriptionTypeDef
  2. See ResponseMetadataTypeDef

AddTagsToResourceMessageRequestTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import AddTagsToResourceMessageRequestTypeDef

def get_value() -> AddTagsToResourceMessageRequestTypeDef:
    return {
        "ResourceName": ...,
        "Tags": ...,
    }
Definition
class AddTagsToResourceMessageRequestTypeDef(TypedDict):
    ResourceName: str,
    Tags: Sequence[TagTypeDef],  # (1)
  1. See TagTypeDef

CopyDBClusterParameterGroupMessageRequestTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import CopyDBClusterParameterGroupMessageRequestTypeDef

def get_value() -> CopyDBClusterParameterGroupMessageRequestTypeDef:
    return {
        "SourceDBClusterParameterGroupIdentifier": ...,
        "TargetDBClusterParameterGroupIdentifier": ...,
        "TargetDBClusterParameterGroupDescription": ...,
    }
Definition
class CopyDBClusterParameterGroupMessageRequestTypeDef(TypedDict):
    SourceDBClusterParameterGroupIdentifier: str,
    TargetDBClusterParameterGroupIdentifier: str,
    TargetDBClusterParameterGroupDescription: str,
    Tags: NotRequired[Sequence[TagTypeDef]],  # (1)
  1. See TagTypeDef

CopyDBClusterSnapshotMessageRequestTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import CopyDBClusterSnapshotMessageRequestTypeDef

def get_value() -> CopyDBClusterSnapshotMessageRequestTypeDef:
    return {
        "SourceDBClusterSnapshotIdentifier": ...,
        "TargetDBClusterSnapshotIdentifier": ...,
    }
Definition
class CopyDBClusterSnapshotMessageRequestTypeDef(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

CreateDBClusterMessageRequestTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import CreateDBClusterMessageRequestTypeDef

def get_value() -> CreateDBClusterMessageRequestTypeDef:
    return {
        "DBClusterIdentifier": ...,
        "Engine": ...,
    }
Definition
class CreateDBClusterMessageRequestTypeDef(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],
    SourceRegion: NotRequired[str],
  1. See TagTypeDef

CreateDBClusterParameterGroupMessageRequestTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import CreateDBClusterParameterGroupMessageRequestTypeDef

def get_value() -> CreateDBClusterParameterGroupMessageRequestTypeDef:
    return {
        "DBClusterParameterGroupName": ...,
        "DBParameterGroupFamily": ...,
        "Description": ...,
    }
Definition
class CreateDBClusterParameterGroupMessageRequestTypeDef(TypedDict):
    DBClusterParameterGroupName: str,
    DBParameterGroupFamily: str,
    Description: str,
    Tags: NotRequired[Sequence[TagTypeDef]],  # (1)
  1. See TagTypeDef

CreateDBClusterSnapshotMessageRequestTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import CreateDBClusterSnapshotMessageRequestTypeDef

def get_value() -> CreateDBClusterSnapshotMessageRequestTypeDef:
    return {
        "DBClusterSnapshotIdentifier": ...,
        "DBClusterIdentifier": ...,
    }
Definition
class CreateDBClusterSnapshotMessageRequestTypeDef(TypedDict):
    DBClusterSnapshotIdentifier: str,
    DBClusterIdentifier: str,
    Tags: NotRequired[Sequence[TagTypeDef]],  # (1)
  1. See TagTypeDef

CreateDBInstanceMessageRequestTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import CreateDBInstanceMessageRequestTypeDef

def get_value() -> CreateDBInstanceMessageRequestTypeDef:
    return {
        "DBInstanceIdentifier": ...,
        "DBInstanceClass": ...,
        "Engine": ...,
        "DBClusterIdentifier": ...,
    }
Definition
class CreateDBInstanceMessageRequestTypeDef(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],
  1. See TagTypeDef

CreateDBSubnetGroupMessageRequestTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import CreateDBSubnetGroupMessageRequestTypeDef

def get_value() -> CreateDBSubnetGroupMessageRequestTypeDef:
    return {
        "DBSubnetGroupName": ...,
        "DBSubnetGroupDescription": ...,
        "SubnetIds": ...,
    }
Definition
class CreateDBSubnetGroupMessageRequestTypeDef(TypedDict):
    DBSubnetGroupName: str,
    DBSubnetGroupDescription: str,
    SubnetIds: Sequence[str],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (1)
  1. See TagTypeDef

CreateEventSubscriptionMessageRequestTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import CreateEventSubscriptionMessageRequestTypeDef

def get_value() -> CreateEventSubscriptionMessageRequestTypeDef:
    return {
        "SubscriptionName": ...,
        "SnsTopicArn": ...,
    }
Definition
class CreateEventSubscriptionMessageRequestTypeDef(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

RestoreDBClusterFromSnapshotMessageRequestTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import RestoreDBClusterFromSnapshotMessageRequestTypeDef

def get_value() -> RestoreDBClusterFromSnapshotMessageRequestTypeDef:
    return {
        "DBClusterIdentifier": ...,
        "SnapshotIdentifier": ...,
        "Engine": ...,
    }
Definition
class RestoreDBClusterFromSnapshotMessageRequestTypeDef(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],
  1. See TagTypeDef

RestoreDBClusterToPointInTimeMessageRequestTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import RestoreDBClusterToPointInTimeMessageRequestTypeDef

def get_value() -> RestoreDBClusterToPointInTimeMessageRequestTypeDef:
    return {
        "DBClusterIdentifier": ...,
        "SourceDBClusterIdentifier": ...,
    }
Definition
class RestoreDBClusterToPointInTimeMessageRequestTypeDef(TypedDict):
    DBClusterIdentifier: str,
    SourceDBClusterIdentifier: str,
    RestoreType: NotRequired[str],
    RestoreToTime: NotRequired[Union[datetime, str]],
    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],
  1. See TagTypeDef

TagListMessageTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import TagListMessageTypeDef

def get_value() -> TagListMessageTypeDef:
    return {
        "TagList": ...,
        "ResponseMetadata": ...,
    }
Definition
class TagListMessageTypeDef(TypedDict):
    TagList: List[TagTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TagTypeDef
  2. See ResponseMetadataTypeDef

OrderableDBInstanceOptionTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import OrderableDBInstanceOptionTypeDef

def get_value() -> OrderableDBInstanceOptionTypeDef:
    return {
        "Engine": ...,
    }
Definition
class OrderableDBInstanceOptionTypeDef(TypedDict):
    Engine: NotRequired[str],
    EngineVersion: NotRequired[str],
    DBInstanceClass: NotRequired[str],
    LicenseModel: NotRequired[str],
    AvailabilityZones: NotRequired[List[AvailabilityZoneTypeDef]],  # (1)
    Vpc: NotRequired[bool],
  1. See AvailabilityZoneTypeDef

SubnetTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import SubnetTypeDef

def get_value() -> SubnetTypeDef:
    return {
        "SubnetIdentifier": ...,
    }
Definition
class SubnetTypeDef(TypedDict):
    SubnetIdentifier: NotRequired[str],
    SubnetAvailabilityZone: NotRequired[AvailabilityZoneTypeDef],  # (1)
    SubnetStatus: NotRequired[str],
  1. See AvailabilityZoneTypeDef

CertificateMessageTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import CertificateMessageTypeDef

def get_value() -> CertificateMessageTypeDef:
    return {
        "Certificates": ...,
        "Marker": ...,
        "ResponseMetadata": ...,
    }
Definition
class CertificateMessageTypeDef(TypedDict):
    Certificates: List[CertificateTypeDef],  # (1)
    Marker: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CertificateTypeDef
  2. See ResponseMetadataTypeDef

ModifyDBClusterMessageRequestTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import ModifyDBClusterMessageRequestTypeDef

def get_value() -> ModifyDBClusterMessageRequestTypeDef:
    return {
        "DBClusterIdentifier": ...,
    }
Definition
class ModifyDBClusterMessageRequestTypeDef(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],
    DeletionProtection: NotRequired[bool],
  1. See CloudwatchLogsExportConfigurationTypeDef

CopyDBClusterParameterGroupResultTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import CopyDBClusterParameterGroupResultTypeDef

def get_value() -> CopyDBClusterParameterGroupResultTypeDef:
    return {
        "DBClusterParameterGroup": ...,
        "ResponseMetadata": ...,
    }
Definition
class CopyDBClusterParameterGroupResultTypeDef(TypedDict):
    DBClusterParameterGroup: DBClusterParameterGroupTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DBClusterParameterGroupTypeDef
  2. See ResponseMetadataTypeDef

CreateDBClusterParameterGroupResultTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import CreateDBClusterParameterGroupResultTypeDef

def get_value() -> CreateDBClusterParameterGroupResultTypeDef:
    return {
        "DBClusterParameterGroup": ...,
        "ResponseMetadata": ...,
    }
Definition
class CreateDBClusterParameterGroupResultTypeDef(TypedDict):
    DBClusterParameterGroup: DBClusterParameterGroupTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DBClusterParameterGroupTypeDef
  2. See ResponseMetadataTypeDef

DBClusterParameterGroupsMessageTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import DBClusterParameterGroupsMessageTypeDef

def get_value() -> DBClusterParameterGroupsMessageTypeDef:
    return {
        "Marker": ...,
        "DBClusterParameterGroups": ...,
        "ResponseMetadata": ...,
    }
Definition
class DBClusterParameterGroupsMessageTypeDef(TypedDict):
    Marker: str,
    DBClusterParameterGroups: List[DBClusterParameterGroupTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DBClusterParameterGroupTypeDef
  2. See ResponseMetadataTypeDef

CopyDBClusterSnapshotResultTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import CopyDBClusterSnapshotResultTypeDef

def get_value() -> CopyDBClusterSnapshotResultTypeDef:
    return {
        "DBClusterSnapshot": ...,
        "ResponseMetadata": ...,
    }
Definition
class CopyDBClusterSnapshotResultTypeDef(TypedDict):
    DBClusterSnapshot: DBClusterSnapshotTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DBClusterSnapshotTypeDef
  2. See ResponseMetadataTypeDef

CreateDBClusterSnapshotResultTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import CreateDBClusterSnapshotResultTypeDef

def get_value() -> CreateDBClusterSnapshotResultTypeDef:
    return {
        "DBClusterSnapshot": ...,
        "ResponseMetadata": ...,
    }
Definition
class CreateDBClusterSnapshotResultTypeDef(TypedDict):
    DBClusterSnapshot: DBClusterSnapshotTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DBClusterSnapshotTypeDef
  2. See ResponseMetadataTypeDef

DBClusterSnapshotMessageTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import DBClusterSnapshotMessageTypeDef

def get_value() -> DBClusterSnapshotMessageTypeDef:
    return {
        "Marker": ...,
        "DBClusterSnapshots": ...,
        "ResponseMetadata": ...,
    }
Definition
class DBClusterSnapshotMessageTypeDef(TypedDict):
    Marker: str,
    DBClusterSnapshots: List[DBClusterSnapshotTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DBClusterSnapshotTypeDef
  2. See ResponseMetadataTypeDef

DeleteDBClusterSnapshotResultTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import DeleteDBClusterSnapshotResultTypeDef

def get_value() -> DeleteDBClusterSnapshotResultTypeDef:
    return {
        "DBClusterSnapshot": ...,
        "ResponseMetadata": ...,
    }
Definition
class DeleteDBClusterSnapshotResultTypeDef(TypedDict):
    DBClusterSnapshot: DBClusterSnapshotTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DBClusterSnapshotTypeDef
  2. See ResponseMetadataTypeDef

DBClusterParameterGroupDetailsTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import DBClusterParameterGroupDetailsTypeDef

def get_value() -> DBClusterParameterGroupDetailsTypeDef:
    return {
        "Parameters": ...,
        "Marker": ...,
        "ResponseMetadata": ...,
    }
Definition
class DBClusterParameterGroupDetailsTypeDef(TypedDict):
    Parameters: List[ParameterTypeDef],  # (1)
    Marker: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ParameterTypeDef
  2. See ResponseMetadataTypeDef

EngineDefaultsTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import EngineDefaultsTypeDef

def get_value() -> EngineDefaultsTypeDef:
    return {
        "DBParameterGroupFamily": ...,
    }
Definition
class EngineDefaultsTypeDef(TypedDict):
    DBParameterGroupFamily: NotRequired[str],
    Marker: NotRequired[str],
    Parameters: NotRequired[List[ParameterTypeDef]],  # (1)
  1. See ParameterTypeDef

ModifyDBClusterParameterGroupMessageRequestTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import ModifyDBClusterParameterGroupMessageRequestTypeDef

def get_value() -> ModifyDBClusterParameterGroupMessageRequestTypeDef:
    return {
        "DBClusterParameterGroupName": ...,
        "Parameters": ...,
    }
Definition
class ModifyDBClusterParameterGroupMessageRequestTypeDef(TypedDict):
    DBClusterParameterGroupName: str,
    Parameters: Sequence[ParameterTypeDef],  # (1)
  1. See ParameterTypeDef

ResetDBClusterParameterGroupMessageRequestTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import ResetDBClusterParameterGroupMessageRequestTypeDef

def get_value() -> ResetDBClusterParameterGroupMessageRequestTypeDef:
    return {
        "DBClusterParameterGroupName": ...,
    }
Definition
class ResetDBClusterParameterGroupMessageRequestTypeDef(TypedDict):
    DBClusterParameterGroupName: str,
    ResetAllParameters: NotRequired[bool],
    Parameters: NotRequired[Sequence[ParameterTypeDef]],  # (1)
  1. See ParameterTypeDef

DBClusterSnapshotAttributesResultTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import DBClusterSnapshotAttributesResultTypeDef

def get_value() -> DBClusterSnapshotAttributesResultTypeDef:
    return {
        "DBClusterSnapshotIdentifier": ...,
    }
Definition
class DBClusterSnapshotAttributesResultTypeDef(TypedDict):
    DBClusterSnapshotIdentifier: NotRequired[str],
    DBClusterSnapshotAttributes: NotRequired[List[DBClusterSnapshotAttributeTypeDef]],  # (1)
  1. See DBClusterSnapshotAttributeTypeDef

DBClusterTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import DBClusterTypeDef

def get_value() -> DBClusterTypeDef:
    return {
        "AvailabilityZones": ...,
    }
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],
  1. See DBClusterMemberTypeDef
  2. See VpcSecurityGroupMembershipTypeDef
  3. See DBClusterRoleTypeDef

DBEngineVersionTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import DBEngineVersionTypeDef

def get_value() -> DBEngineVersionTypeDef:
    return {
        "Engine": ...,
    }
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],
  1. See UpgradeTargetTypeDef

DescribeCertificatesMessageRequestTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import DescribeCertificatesMessageRequestTypeDef

def get_value() -> DescribeCertificatesMessageRequestTypeDef:
    return {
        "CertificateIdentifier": ...,
    }
Definition
class DescribeCertificatesMessageRequestTypeDef(TypedDict):
    CertificateIdentifier: NotRequired[str],
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
    MaxRecords: NotRequired[int],
    Marker: NotRequired[str],
  1. See FilterTypeDef

DescribeDBClusterParameterGroupsMessageRequestTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import DescribeDBClusterParameterGroupsMessageRequestTypeDef

def get_value() -> DescribeDBClusterParameterGroupsMessageRequestTypeDef:
    return {
        "DBClusterParameterGroupName": ...,
    }
Definition
class DescribeDBClusterParameterGroupsMessageRequestTypeDef(TypedDict):
    DBClusterParameterGroupName: NotRequired[str],
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
    MaxRecords: NotRequired[int],
    Marker: NotRequired[str],
  1. See FilterTypeDef

DescribeDBClusterParametersMessageRequestTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import DescribeDBClusterParametersMessageRequestTypeDef

def get_value() -> DescribeDBClusterParametersMessageRequestTypeDef:
    return {
        "DBClusterParameterGroupName": ...,
    }
Definition
class DescribeDBClusterParametersMessageRequestTypeDef(TypedDict):
    DBClusterParameterGroupName: str,
    Source: NotRequired[str],
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
    MaxRecords: NotRequired[int],
    Marker: NotRequired[str],
  1. See FilterTypeDef

DescribeDBClusterSnapshotsMessageRequestTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import DescribeDBClusterSnapshotsMessageRequestTypeDef

def get_value() -> DescribeDBClusterSnapshotsMessageRequestTypeDef:
    return {
        "DBClusterIdentifier": ...,
    }
Definition
class DescribeDBClusterSnapshotsMessageRequestTypeDef(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

DescribeDBClustersMessageRequestTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import DescribeDBClustersMessageRequestTypeDef

def get_value() -> DescribeDBClustersMessageRequestTypeDef:
    return {
        "DBClusterIdentifier": ...,
    }
Definition
class DescribeDBClustersMessageRequestTypeDef(TypedDict):
    DBClusterIdentifier: NotRequired[str],
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
    MaxRecords: NotRequired[int],
    Marker: NotRequired[str],
  1. See FilterTypeDef

DescribeDBEngineVersionsMessageRequestTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import DescribeDBEngineVersionsMessageRequestTypeDef

def get_value() -> DescribeDBEngineVersionsMessageRequestTypeDef:
    return {
        "Engine": ...,
    }
Definition
class DescribeDBEngineVersionsMessageRequestTypeDef(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

DescribeDBInstancesMessageRequestTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import DescribeDBInstancesMessageRequestTypeDef

def get_value() -> DescribeDBInstancesMessageRequestTypeDef:
    return {
        "DBInstanceIdentifier": ...,
    }
Definition
class DescribeDBInstancesMessageRequestTypeDef(TypedDict):
    DBInstanceIdentifier: NotRequired[str],
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
    MaxRecords: NotRequired[int],
    Marker: NotRequired[str],
  1. See FilterTypeDef

DescribeDBSubnetGroupsMessageRequestTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import DescribeDBSubnetGroupsMessageRequestTypeDef

def get_value() -> DescribeDBSubnetGroupsMessageRequestTypeDef:
    return {
        "DBSubnetGroupName": ...,
    }
Definition
class DescribeDBSubnetGroupsMessageRequestTypeDef(TypedDict):
    DBSubnetGroupName: NotRequired[str],
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
    MaxRecords: NotRequired[int],
    Marker: NotRequired[str],
  1. See FilterTypeDef

DescribeEngineDefaultClusterParametersMessageRequestTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import DescribeEngineDefaultClusterParametersMessageRequestTypeDef

def get_value() -> DescribeEngineDefaultClusterParametersMessageRequestTypeDef:
    return {
        "DBParameterGroupFamily": ...,
    }
Definition
class DescribeEngineDefaultClusterParametersMessageRequestTypeDef(TypedDict):
    DBParameterGroupFamily: str,
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
    MaxRecords: NotRequired[int],
    Marker: NotRequired[str],
  1. See FilterTypeDef

DescribeEventCategoriesMessageRequestTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import DescribeEventCategoriesMessageRequestTypeDef

def get_value() -> DescribeEventCategoriesMessageRequestTypeDef:
    return {
        "SourceType": ...,
    }
Definition
class DescribeEventCategoriesMessageRequestTypeDef(TypedDict):
    SourceType: NotRequired[str],
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
  1. See FilterTypeDef

DescribeEventSubscriptionsMessageRequestTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import DescribeEventSubscriptionsMessageRequestTypeDef

def get_value() -> DescribeEventSubscriptionsMessageRequestTypeDef:
    return {
        "SubscriptionName": ...,
    }
Definition
class DescribeEventSubscriptionsMessageRequestTypeDef(TypedDict):
    SubscriptionName: NotRequired[str],
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
    MaxRecords: NotRequired[int],
    Marker: NotRequired[str],
  1. See FilterTypeDef

DescribeEventsMessageRequestTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import DescribeEventsMessageRequestTypeDef

def get_value() -> DescribeEventsMessageRequestTypeDef:
    return {
        "SourceIdentifier": ...,
    }
Definition
class DescribeEventsMessageRequestTypeDef(TypedDict):
    SourceIdentifier: NotRequired[str],
    SourceType: NotRequired[SourceTypeType],  # (1)
    StartTime: NotRequired[Union[datetime, str]],
    EndTime: NotRequired[Union[datetime, str]],
    Duration: NotRequired[int],
    EventCategories: NotRequired[Sequence[str]],
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (2)
    MaxRecords: NotRequired[int],
    Marker: NotRequired[str],
  1. See SourceTypeType
  2. See FilterTypeDef

DescribeGlobalClustersMessageRequestTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import DescribeGlobalClustersMessageRequestTypeDef

def get_value() -> DescribeGlobalClustersMessageRequestTypeDef:
    return {
        "GlobalClusterIdentifier": ...,
    }
Definition
class DescribeGlobalClustersMessageRequestTypeDef(TypedDict):
    GlobalClusterIdentifier: NotRequired[str],
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
    MaxRecords: NotRequired[int],
    Marker: NotRequired[str],
  1. See FilterTypeDef

DescribeOrderableDBInstanceOptionsMessageRequestTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import DescribeOrderableDBInstanceOptionsMessageRequestTypeDef

def get_value() -> DescribeOrderableDBInstanceOptionsMessageRequestTypeDef:
    return {
        "Engine": ...,
    }
Definition
class DescribeOrderableDBInstanceOptionsMessageRequestTypeDef(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

DescribePendingMaintenanceActionsMessageRequestTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import DescribePendingMaintenanceActionsMessageRequestTypeDef

def get_value() -> DescribePendingMaintenanceActionsMessageRequestTypeDef:
    return {
        "ResourceIdentifier": ...,
    }
Definition
class DescribePendingMaintenanceActionsMessageRequestTypeDef(TypedDict):
    ResourceIdentifier: NotRequired[str],
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
    Marker: NotRequired[str],
    MaxRecords: NotRequired[int],
  1. See FilterTypeDef

ListTagsForResourceMessageRequestTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import ListTagsForResourceMessageRequestTypeDef

def get_value() -> ListTagsForResourceMessageRequestTypeDef:
    return {
        "ResourceName": ...,
    }
Definition
class ListTagsForResourceMessageRequestTypeDef(TypedDict):
    ResourceName: str,
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
  1. See FilterTypeDef

DescribeCertificatesMessageDescribeCertificatesPaginateTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import DescribeCertificatesMessageDescribeCertificatesPaginateTypeDef

def get_value() -> DescribeCertificatesMessageDescribeCertificatesPaginateTypeDef:
    return {
        "CertificateIdentifier": ...,
    }
Definition
class DescribeCertificatesMessageDescribeCertificatesPaginateTypeDef(TypedDict):
    CertificateIdentifier: NotRequired[str],
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See FilterTypeDef
  2. See PaginatorConfigTypeDef

DescribeDBClusterParameterGroupsMessageDescribeDBClusterParameterGroupsPaginateTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import DescribeDBClusterParameterGroupsMessageDescribeDBClusterParameterGroupsPaginateTypeDef

def get_value() -> DescribeDBClusterParameterGroupsMessageDescribeDBClusterParameterGroupsPaginateTypeDef:
    return {
        "DBClusterParameterGroupName": ...,
    }
Definition
class DescribeDBClusterParameterGroupsMessageDescribeDBClusterParameterGroupsPaginateTypeDef(TypedDict):
    DBClusterParameterGroupName: NotRequired[str],
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See FilterTypeDef
  2. See PaginatorConfigTypeDef

DescribeDBClusterParametersMessageDescribeDBClusterParametersPaginateTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import DescribeDBClusterParametersMessageDescribeDBClusterParametersPaginateTypeDef

def get_value() -> DescribeDBClusterParametersMessageDescribeDBClusterParametersPaginateTypeDef:
    return {
        "DBClusterParameterGroupName": ...,
    }
Definition
class DescribeDBClusterParametersMessageDescribeDBClusterParametersPaginateTypeDef(TypedDict):
    DBClusterParameterGroupName: str,
    Source: NotRequired[str],
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See FilterTypeDef
  2. See PaginatorConfigTypeDef

DescribeDBClusterSnapshotsMessageDescribeDBClusterSnapshotsPaginateTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import DescribeDBClusterSnapshotsMessageDescribeDBClusterSnapshotsPaginateTypeDef

def get_value() -> DescribeDBClusterSnapshotsMessageDescribeDBClusterSnapshotsPaginateTypeDef:
    return {
        "DBClusterIdentifier": ...,
    }
Definition
class DescribeDBClusterSnapshotsMessageDescribeDBClusterSnapshotsPaginateTypeDef(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

DescribeDBClustersMessageDescribeDBClustersPaginateTypeDef

Usage Example
from mypy_boto3_docdb.type_defs import DescribeDBClustersMessageDescribeDBClustersPaginateTypeDef

def get_value() -> DescribeDBClustersMessageDescribeDBClustersPaginateTypeDef:
    return {
        "DBClusterIdentifier": ...,
    }
Definition
class DescribeDBClustersMessageDescribeDBClustersPaginateTypeDef(TypedDict):
    DBClusterIdentifier: NotRequired[str],
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)