Typed dictionaries#
Auto-generated documentation for DocDB type annotations stubs module mypy-boto3-docdb.
AddSourceIdentifierToSubscriptionMessageRequestTypeDef#
# AddSourceIdentifierToSubscriptionMessageRequestTypeDef usage example
from mypy_boto3_docdb.type_defs import AddSourceIdentifierToSubscriptionMessageRequestTypeDef
def get_value() -> AddSourceIdentifierToSubscriptionMessageRequestTypeDef:
return {
"SubscriptionName": ...,
"SourceIdentifier": ...,
}
# AddSourceIdentifierToSubscriptionMessageRequestTypeDef definition
class AddSourceIdentifierToSubscriptionMessageRequestTypeDef(TypedDict):
SubscriptionName: str,
SourceIdentifier: str,
EventSubscriptionTypeDef#
# EventSubscriptionTypeDef usage example
from mypy_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],
TagTypeDef#
# TagTypeDef usage example
from mypy_boto3_docdb.type_defs import TagTypeDef
def get_value() -> TagTypeDef:
return {
"Key": ...,
}
# TagTypeDef definition
class TagTypeDef(TypedDict):
Key: NotRequired[str],
Value: NotRequired[str],
ApplyPendingMaintenanceActionMessageRequestTypeDef#
# ApplyPendingMaintenanceActionMessageRequestTypeDef usage example
from mypy_boto3_docdb.type_defs import ApplyPendingMaintenanceActionMessageRequestTypeDef
def get_value() -> ApplyPendingMaintenanceActionMessageRequestTypeDef:
return {
"ResourceIdentifier": ...,
"ApplyAction": ...,
"OptInType": ...,
}
# ApplyPendingMaintenanceActionMessageRequestTypeDef definition
class ApplyPendingMaintenanceActionMessageRequestTypeDef(TypedDict):
ResourceIdentifier: str,
ApplyAction: str,
OptInType: str,
AvailabilityZoneTypeDef#
# AvailabilityZoneTypeDef usage example
from mypy_boto3_docdb.type_defs import AvailabilityZoneTypeDef
def get_value() -> AvailabilityZoneTypeDef:
return {
"Name": ...,
}
# AvailabilityZoneTypeDef definition
class AvailabilityZoneTypeDef(TypedDict):
Name: NotRequired[str],
CertificateTypeDef#
# CertificateTypeDef usage example
from mypy_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 usage example
from mypy_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]],
DBClusterParameterGroupTypeDef#
# DBClusterParameterGroupTypeDef usage example
from mypy_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 usage example
from mypy_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],
CreateGlobalClusterMessageRequestTypeDef#
# CreateGlobalClusterMessageRequestTypeDef usage example
from mypy_boto3_docdb.type_defs import CreateGlobalClusterMessageRequestTypeDef
def get_value() -> CreateGlobalClusterMessageRequestTypeDef:
return {
"GlobalClusterIdentifier": ...,
}
# CreateGlobalClusterMessageRequestTypeDef 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#
# DBClusterMemberTypeDef usage example
from mypy_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 usage example
from mypy_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)
- See ApplyMethodType
DBClusterParameterGroupNameMessageTypeDef#
# DBClusterParameterGroupNameMessageTypeDef usage example
from mypy_boto3_docdb.type_defs import DBClusterParameterGroupNameMessageTypeDef
def get_value() -> DBClusterParameterGroupNameMessageTypeDef:
return {
"DBClusterParameterGroupName": ...,
"ResponseMetadata": ...,
}
# DBClusterParameterGroupNameMessageTypeDef definition
class DBClusterParameterGroupNameMessageTypeDef(TypedDict):
DBClusterParameterGroupName: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DBClusterRoleTypeDef#
# DBClusterRoleTypeDef usage example
from mypy_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 usage example
from mypy_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 usage example
from mypy_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 usage example
from mypy_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 usage example
from mypy_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 usage example
from mypy_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],
DeleteDBClusterMessageRequestTypeDef#
# DeleteDBClusterMessageRequestTypeDef usage example
from mypy_boto3_docdb.type_defs import DeleteDBClusterMessageRequestTypeDef
def get_value() -> DeleteDBClusterMessageRequestTypeDef:
return {
"DBClusterIdentifier": ...,
}
# DeleteDBClusterMessageRequestTypeDef definition
class DeleteDBClusterMessageRequestTypeDef(TypedDict):
DBClusterIdentifier: str,
SkipFinalSnapshot: NotRequired[bool],
FinalDBSnapshotIdentifier: NotRequired[str],
DeleteDBClusterParameterGroupMessageRequestTypeDef#
# DeleteDBClusterParameterGroupMessageRequestTypeDef usage example
from mypy_boto3_docdb.type_defs import DeleteDBClusterParameterGroupMessageRequestTypeDef
def get_value() -> DeleteDBClusterParameterGroupMessageRequestTypeDef:
return {
"DBClusterParameterGroupName": ...,
}
# DeleteDBClusterParameterGroupMessageRequestTypeDef definition
class DeleteDBClusterParameterGroupMessageRequestTypeDef(TypedDict):
DBClusterParameterGroupName: str,
DeleteDBClusterSnapshotMessageRequestTypeDef#
# DeleteDBClusterSnapshotMessageRequestTypeDef usage example
from mypy_boto3_docdb.type_defs import DeleteDBClusterSnapshotMessageRequestTypeDef
def get_value() -> DeleteDBClusterSnapshotMessageRequestTypeDef:
return {
"DBClusterSnapshotIdentifier": ...,
}
# DeleteDBClusterSnapshotMessageRequestTypeDef definition
class DeleteDBClusterSnapshotMessageRequestTypeDef(TypedDict):
DBClusterSnapshotIdentifier: str,
DeleteDBInstanceMessageRequestTypeDef#
# DeleteDBInstanceMessageRequestTypeDef usage example
from mypy_boto3_docdb.type_defs import DeleteDBInstanceMessageRequestTypeDef
def get_value() -> DeleteDBInstanceMessageRequestTypeDef:
return {
"DBInstanceIdentifier": ...,
}
# DeleteDBInstanceMessageRequestTypeDef definition
class DeleteDBInstanceMessageRequestTypeDef(TypedDict):
DBInstanceIdentifier: str,
DeleteDBSubnetGroupMessageRequestTypeDef#
# DeleteDBSubnetGroupMessageRequestTypeDef usage example
from mypy_boto3_docdb.type_defs import DeleteDBSubnetGroupMessageRequestTypeDef
def get_value() -> DeleteDBSubnetGroupMessageRequestTypeDef:
return {
"DBSubnetGroupName": ...,
}
# DeleteDBSubnetGroupMessageRequestTypeDef definition
class DeleteDBSubnetGroupMessageRequestTypeDef(TypedDict):
DBSubnetGroupName: str,
DeleteEventSubscriptionMessageRequestTypeDef#
# DeleteEventSubscriptionMessageRequestTypeDef usage example
from mypy_boto3_docdb.type_defs import DeleteEventSubscriptionMessageRequestTypeDef
def get_value() -> DeleteEventSubscriptionMessageRequestTypeDef:
return {
"SubscriptionName": ...,
}
# DeleteEventSubscriptionMessageRequestTypeDef definition
class DeleteEventSubscriptionMessageRequestTypeDef(TypedDict):
SubscriptionName: str,
DeleteGlobalClusterMessageRequestTypeDef#
# DeleteGlobalClusterMessageRequestTypeDef usage example
from mypy_boto3_docdb.type_defs import DeleteGlobalClusterMessageRequestTypeDef
def get_value() -> DeleteGlobalClusterMessageRequestTypeDef:
return {
"GlobalClusterIdentifier": ...,
}
# DeleteGlobalClusterMessageRequestTypeDef definition
class DeleteGlobalClusterMessageRequestTypeDef(TypedDict):
GlobalClusterIdentifier: str,
FilterTypeDef#
# FilterTypeDef usage example
from mypy_boto3_docdb.type_defs import FilterTypeDef
def get_value() -> FilterTypeDef:
return {
"Name": ...,
"Values": ...,
}
# FilterTypeDef definition
class FilterTypeDef(TypedDict):
Name: str,
Values: Sequence[str],
DescribeDBClusterSnapshotAttributesMessageRequestTypeDef#
# DescribeDBClusterSnapshotAttributesMessageRequestTypeDef usage example
from mypy_boto3_docdb.type_defs import DescribeDBClusterSnapshotAttributesMessageRequestTypeDef
def get_value() -> DescribeDBClusterSnapshotAttributesMessageRequestTypeDef:
return {
"DBClusterSnapshotIdentifier": ...,
}
# DescribeDBClusterSnapshotAttributesMessageRequestTypeDef definition
class DescribeDBClusterSnapshotAttributesMessageRequestTypeDef(TypedDict):
DBClusterSnapshotIdentifier: str,
WaiterConfigTypeDef#
# WaiterConfigTypeDef usage example
from mypy_boto3_docdb.type_defs import WaiterConfigTypeDef
def get_value() -> WaiterConfigTypeDef:
return {
"Delay": ...,
}
# WaiterConfigTypeDef definition
class WaiterConfigTypeDef(TypedDict):
Delay: NotRequired[int],
MaxAttempts: NotRequired[int],
EmptyResponseMetadataTypeDef#
# EmptyResponseMetadataTypeDef usage example
from mypy_boto3_docdb.type_defs import EmptyResponseMetadataTypeDef
def get_value() -> EmptyResponseMetadataTypeDef:
return {
"ResponseMetadata": ...,
}
# EmptyResponseMetadataTypeDef definition
class EmptyResponseMetadataTypeDef(TypedDict):
ResponseMetadata: ResponseMetadataTypeDef, # (1)
EventCategoriesMapTypeDef#
# EventCategoriesMapTypeDef usage example
from mypy_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 usage example
from mypy_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],
- See SourceTypeType
FailoverDBClusterMessageRequestTypeDef#
# FailoverDBClusterMessageRequestTypeDef usage example
from mypy_boto3_docdb.type_defs import FailoverDBClusterMessageRequestTypeDef
def get_value() -> FailoverDBClusterMessageRequestTypeDef:
return {
"DBClusterIdentifier": ...,
}
# FailoverDBClusterMessageRequestTypeDef definition
class FailoverDBClusterMessageRequestTypeDef(TypedDict):
DBClusterIdentifier: NotRequired[str],
TargetDBInstanceIdentifier: NotRequired[str],
GlobalClusterMemberTypeDef#
# GlobalClusterMemberTypeDef usage example
from mypy_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],
ModifyDBClusterSnapshotAttributeMessageRequestTypeDef#
# ModifyDBClusterSnapshotAttributeMessageRequestTypeDef usage example
from mypy_boto3_docdb.type_defs import ModifyDBClusterSnapshotAttributeMessageRequestTypeDef
def get_value() -> ModifyDBClusterSnapshotAttributeMessageRequestTypeDef:
return {
"DBClusterSnapshotIdentifier": ...,
"AttributeName": ...,
}
# ModifyDBClusterSnapshotAttributeMessageRequestTypeDef definition
class ModifyDBClusterSnapshotAttributeMessageRequestTypeDef(TypedDict):
DBClusterSnapshotIdentifier: str,
AttributeName: str,
ValuesToAdd: NotRequired[Sequence[str]],
ValuesToRemove: NotRequired[Sequence[str]],
ModifyDBInstanceMessageRequestTypeDef#
# ModifyDBInstanceMessageRequestTypeDef usage example
from mypy_boto3_docdb.type_defs import ModifyDBInstanceMessageRequestTypeDef
def get_value() -> ModifyDBInstanceMessageRequestTypeDef:
return {
"DBInstanceIdentifier": ...,
}
# ModifyDBInstanceMessageRequestTypeDef 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#
# ModifyDBSubnetGroupMessageRequestTypeDef usage example
from mypy_boto3_docdb.type_defs import ModifyDBSubnetGroupMessageRequestTypeDef
def get_value() -> ModifyDBSubnetGroupMessageRequestTypeDef:
return {
"DBSubnetGroupName": ...,
"SubnetIds": ...,
}
# ModifyDBSubnetGroupMessageRequestTypeDef definition
class ModifyDBSubnetGroupMessageRequestTypeDef(TypedDict):
DBSubnetGroupName: str,
SubnetIds: Sequence[str],
DBSubnetGroupDescription: NotRequired[str],
ModifyEventSubscriptionMessageRequestTypeDef#
# ModifyEventSubscriptionMessageRequestTypeDef usage example
from mypy_boto3_docdb.type_defs import ModifyEventSubscriptionMessageRequestTypeDef
def get_value() -> ModifyEventSubscriptionMessageRequestTypeDef:
return {
"SubscriptionName": ...,
}
# ModifyEventSubscriptionMessageRequestTypeDef definition
class ModifyEventSubscriptionMessageRequestTypeDef(TypedDict):
SubscriptionName: str,
SnsTopicArn: NotRequired[str],
SourceType: NotRequired[str],
EventCategories: NotRequired[Sequence[str]],
Enabled: NotRequired[bool],
ModifyGlobalClusterMessageRequestTypeDef#
# ModifyGlobalClusterMessageRequestTypeDef usage example
from mypy_boto3_docdb.type_defs import ModifyGlobalClusterMessageRequestTypeDef
def get_value() -> ModifyGlobalClusterMessageRequestTypeDef:
return {
"GlobalClusterIdentifier": ...,
}
# ModifyGlobalClusterMessageRequestTypeDef definition
class ModifyGlobalClusterMessageRequestTypeDef(TypedDict):
GlobalClusterIdentifier: str,
NewGlobalClusterIdentifier: NotRequired[str],
DeletionProtection: NotRequired[bool],
PaginatorConfigTypeDef#
# PaginatorConfigTypeDef usage example
from mypy_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],
PendingCloudwatchLogsExportsTypeDef#
# PendingCloudwatchLogsExportsTypeDef usage example
from mypy_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 usage example
from mypy_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],
RebootDBInstanceMessageRequestTypeDef#
# RebootDBInstanceMessageRequestTypeDef usage example
from mypy_boto3_docdb.type_defs import RebootDBInstanceMessageRequestTypeDef
def get_value() -> RebootDBInstanceMessageRequestTypeDef:
return {
"DBInstanceIdentifier": ...,
}
# RebootDBInstanceMessageRequestTypeDef definition
class RebootDBInstanceMessageRequestTypeDef(TypedDict):
DBInstanceIdentifier: str,
ForceFailover: NotRequired[bool],
RemoveFromGlobalClusterMessageRequestTypeDef#
# RemoveFromGlobalClusterMessageRequestTypeDef usage example
from mypy_boto3_docdb.type_defs import RemoveFromGlobalClusterMessageRequestTypeDef
def get_value() -> RemoveFromGlobalClusterMessageRequestTypeDef:
return {
"GlobalClusterIdentifier": ...,
"DbClusterIdentifier": ...,
}
# RemoveFromGlobalClusterMessageRequestTypeDef definition
class RemoveFromGlobalClusterMessageRequestTypeDef(TypedDict):
GlobalClusterIdentifier: str,
DbClusterIdentifier: str,
RemoveSourceIdentifierFromSubscriptionMessageRequestTypeDef#
# RemoveSourceIdentifierFromSubscriptionMessageRequestTypeDef usage example
from mypy_boto3_docdb.type_defs import RemoveSourceIdentifierFromSubscriptionMessageRequestTypeDef
def get_value() -> RemoveSourceIdentifierFromSubscriptionMessageRequestTypeDef:
return {
"SubscriptionName": ...,
"SourceIdentifier": ...,
}
# RemoveSourceIdentifierFromSubscriptionMessageRequestTypeDef definition
class RemoveSourceIdentifierFromSubscriptionMessageRequestTypeDef(TypedDict):
SubscriptionName: str,
SourceIdentifier: str,
RemoveTagsFromResourceMessageRequestTypeDef#
# RemoveTagsFromResourceMessageRequestTypeDef usage example
from mypy_boto3_docdb.type_defs import RemoveTagsFromResourceMessageRequestTypeDef
def get_value() -> RemoveTagsFromResourceMessageRequestTypeDef:
return {
"ResourceName": ...,
"TagKeys": ...,
}
# RemoveTagsFromResourceMessageRequestTypeDef definition
class RemoveTagsFromResourceMessageRequestTypeDef(TypedDict):
ResourceName: str,
TagKeys: Sequence[str],
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef usage example
from mypy_boto3_docdb.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
"HostId": ...,
"HTTPStatusCode": ...,
"HTTPHeaders": ...,
"RetryAttempts": ...,
}
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
StartDBClusterMessageRequestTypeDef#
# StartDBClusterMessageRequestTypeDef usage example
from mypy_boto3_docdb.type_defs import StartDBClusterMessageRequestTypeDef
def get_value() -> StartDBClusterMessageRequestTypeDef:
return {
"DBClusterIdentifier": ...,
}
# StartDBClusterMessageRequestTypeDef definition
class StartDBClusterMessageRequestTypeDef(TypedDict):
DBClusterIdentifier: str,
StopDBClusterMessageRequestTypeDef#
# StopDBClusterMessageRequestTypeDef usage example
from mypy_boto3_docdb.type_defs import StopDBClusterMessageRequestTypeDef
def get_value() -> StopDBClusterMessageRequestTypeDef:
return {
"DBClusterIdentifier": ...,
}
# StopDBClusterMessageRequestTypeDef definition
class StopDBClusterMessageRequestTypeDef(TypedDict):
DBClusterIdentifier: str,
AddSourceIdentifierToSubscriptionResultTypeDef#
# AddSourceIdentifierToSubscriptionResultTypeDef usage example
from mypy_boto3_docdb.type_defs import AddSourceIdentifierToSubscriptionResultTypeDef
def get_value() -> AddSourceIdentifierToSubscriptionResultTypeDef:
return {
"EventSubscription": ...,
"ResponseMetadata": ...,
}
# AddSourceIdentifierToSubscriptionResultTypeDef definition
class AddSourceIdentifierToSubscriptionResultTypeDef(TypedDict):
EventSubscription: EventSubscriptionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateEventSubscriptionResultTypeDef#
# CreateEventSubscriptionResultTypeDef usage example
from mypy_boto3_docdb.type_defs import CreateEventSubscriptionResultTypeDef
def get_value() -> CreateEventSubscriptionResultTypeDef:
return {
"EventSubscription": ...,
"ResponseMetadata": ...,
}
# CreateEventSubscriptionResultTypeDef definition
class CreateEventSubscriptionResultTypeDef(TypedDict):
EventSubscription: EventSubscriptionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DeleteEventSubscriptionResultTypeDef#
# DeleteEventSubscriptionResultTypeDef usage example
from mypy_boto3_docdb.type_defs import DeleteEventSubscriptionResultTypeDef
def get_value() -> DeleteEventSubscriptionResultTypeDef:
return {
"EventSubscription": ...,
"ResponseMetadata": ...,
}
# DeleteEventSubscriptionResultTypeDef definition
class DeleteEventSubscriptionResultTypeDef(TypedDict):
EventSubscription: EventSubscriptionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
EventSubscriptionsMessageTypeDef#
# EventSubscriptionsMessageTypeDef usage example
from mypy_boto3_docdb.type_defs import EventSubscriptionsMessageTypeDef
def get_value() -> EventSubscriptionsMessageTypeDef:
return {
"Marker": ...,
"EventSubscriptionsList": ...,
"ResponseMetadata": ...,
}
# EventSubscriptionsMessageTypeDef definition
class EventSubscriptionsMessageTypeDef(TypedDict):
Marker: str,
EventSubscriptionsList: List[EventSubscriptionTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ModifyEventSubscriptionResultTypeDef#
# ModifyEventSubscriptionResultTypeDef usage example
from mypy_boto3_docdb.type_defs import ModifyEventSubscriptionResultTypeDef
def get_value() -> ModifyEventSubscriptionResultTypeDef:
return {
"EventSubscription": ...,
"ResponseMetadata": ...,
}
# ModifyEventSubscriptionResultTypeDef definition
class ModifyEventSubscriptionResultTypeDef(TypedDict):
EventSubscription: EventSubscriptionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
RemoveSourceIdentifierFromSubscriptionResultTypeDef#
# RemoveSourceIdentifierFromSubscriptionResultTypeDef usage example
from mypy_boto3_docdb.type_defs import RemoveSourceIdentifierFromSubscriptionResultTypeDef
def get_value() -> RemoveSourceIdentifierFromSubscriptionResultTypeDef:
return {
"EventSubscription": ...,
"ResponseMetadata": ...,
}
# RemoveSourceIdentifierFromSubscriptionResultTypeDef definition
class RemoveSourceIdentifierFromSubscriptionResultTypeDef(TypedDict):
EventSubscription: EventSubscriptionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
AddTagsToResourceMessageRequestTypeDef#
# AddTagsToResourceMessageRequestTypeDef usage example
from mypy_boto3_docdb.type_defs import AddTagsToResourceMessageRequestTypeDef
def get_value() -> AddTagsToResourceMessageRequestTypeDef:
return {
"ResourceName": ...,
"Tags": ...,
}
# AddTagsToResourceMessageRequestTypeDef definition
class AddTagsToResourceMessageRequestTypeDef(TypedDict):
ResourceName: str,
Tags: Sequence[TagTypeDef], # (1)
- See TagTypeDef
CopyDBClusterParameterGroupMessageRequestTypeDef#
# CopyDBClusterParameterGroupMessageRequestTypeDef usage example
from mypy_boto3_docdb.type_defs import CopyDBClusterParameterGroupMessageRequestTypeDef
def get_value() -> CopyDBClusterParameterGroupMessageRequestTypeDef:
return {
"SourceDBClusterParameterGroupIdentifier": ...,
"TargetDBClusterParameterGroupIdentifier": ...,
"TargetDBClusterParameterGroupDescription": ...,
}
# CopyDBClusterParameterGroupMessageRequestTypeDef definition
class CopyDBClusterParameterGroupMessageRequestTypeDef(TypedDict):
SourceDBClusterParameterGroupIdentifier: str,
TargetDBClusterParameterGroupIdentifier: str,
TargetDBClusterParameterGroupDescription: str,
Tags: NotRequired[Sequence[TagTypeDef]], # (1)
- See TagTypeDef
CopyDBClusterSnapshotMessageRequestTypeDef#
# CopyDBClusterSnapshotMessageRequestTypeDef usage example
from mypy_boto3_docdb.type_defs import CopyDBClusterSnapshotMessageRequestTypeDef
def get_value() -> CopyDBClusterSnapshotMessageRequestTypeDef:
return {
"SourceDBClusterSnapshotIdentifier": ...,
"TargetDBClusterSnapshotIdentifier": ...,
}
# CopyDBClusterSnapshotMessageRequestTypeDef 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],
- See TagTypeDef
CreateDBClusterMessageRequestTypeDef#
# CreateDBClusterMessageRequestTypeDef usage example
from mypy_boto3_docdb.type_defs import CreateDBClusterMessageRequestTypeDef
def get_value() -> CreateDBClusterMessageRequestTypeDef:
return {
"DBClusterIdentifier": ...,
"Engine": ...,
}
# CreateDBClusterMessageRequestTypeDef 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],
- See TagTypeDef
CreateDBClusterParameterGroupMessageRequestTypeDef#
# CreateDBClusterParameterGroupMessageRequestTypeDef usage example
from mypy_boto3_docdb.type_defs import CreateDBClusterParameterGroupMessageRequestTypeDef
def get_value() -> CreateDBClusterParameterGroupMessageRequestTypeDef:
return {
"DBClusterParameterGroupName": ...,
"DBParameterGroupFamily": ...,
"Description": ...,
}
# CreateDBClusterParameterGroupMessageRequestTypeDef definition
class CreateDBClusterParameterGroupMessageRequestTypeDef(TypedDict):
DBClusterParameterGroupName: str,
DBParameterGroupFamily: str,
Description: str,
Tags: NotRequired[Sequence[TagTypeDef]], # (1)
- See TagTypeDef
CreateDBClusterSnapshotMessageRequestTypeDef#
# CreateDBClusterSnapshotMessageRequestTypeDef usage example
from mypy_boto3_docdb.type_defs import CreateDBClusterSnapshotMessageRequestTypeDef
def get_value() -> CreateDBClusterSnapshotMessageRequestTypeDef:
return {
"DBClusterSnapshotIdentifier": ...,
"DBClusterIdentifier": ...,
}
# CreateDBClusterSnapshotMessageRequestTypeDef definition
class CreateDBClusterSnapshotMessageRequestTypeDef(TypedDict):
DBClusterSnapshotIdentifier: str,
DBClusterIdentifier: str,
Tags: NotRequired[Sequence[TagTypeDef]], # (1)
- See TagTypeDef
CreateDBInstanceMessageRequestTypeDef#
# CreateDBInstanceMessageRequestTypeDef usage example
from mypy_boto3_docdb.type_defs import CreateDBInstanceMessageRequestTypeDef
def get_value() -> CreateDBInstanceMessageRequestTypeDef:
return {
"DBInstanceIdentifier": ...,
"DBInstanceClass": ...,
"Engine": ...,
"DBClusterIdentifier": ...,
}
# CreateDBInstanceMessageRequestTypeDef 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],
- See TagTypeDef
CreateDBSubnetGroupMessageRequestTypeDef#
# CreateDBSubnetGroupMessageRequestTypeDef usage example
from mypy_boto3_docdb.type_defs import CreateDBSubnetGroupMessageRequestTypeDef
def get_value() -> CreateDBSubnetGroupMessageRequestTypeDef:
return {
"DBSubnetGroupName": ...,
"DBSubnetGroupDescription": ...,
"SubnetIds": ...,
}
# CreateDBSubnetGroupMessageRequestTypeDef definition
class CreateDBSubnetGroupMessageRequestTypeDef(TypedDict):
DBSubnetGroupName: str,
DBSubnetGroupDescription: str,
SubnetIds: Sequence[str],
Tags: NotRequired[Sequence[TagTypeDef]], # (1)
- See TagTypeDef
CreateEventSubscriptionMessageRequestTypeDef#
# CreateEventSubscriptionMessageRequestTypeDef usage example
from mypy_boto3_docdb.type_defs import CreateEventSubscriptionMessageRequestTypeDef
def get_value() -> CreateEventSubscriptionMessageRequestTypeDef:
return {
"SubscriptionName": ...,
"SnsTopicArn": ...,
}
# CreateEventSubscriptionMessageRequestTypeDef 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)
- See TagTypeDef
RestoreDBClusterFromSnapshotMessageRequestTypeDef#
# RestoreDBClusterFromSnapshotMessageRequestTypeDef usage example
from mypy_boto3_docdb.type_defs import RestoreDBClusterFromSnapshotMessageRequestTypeDef
def get_value() -> RestoreDBClusterFromSnapshotMessageRequestTypeDef:
return {
"DBClusterIdentifier": ...,
"SnapshotIdentifier": ...,
"Engine": ...,
}
# RestoreDBClusterFromSnapshotMessageRequestTypeDef 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],
DBClusterParameterGroupName: NotRequired[str],
- See TagTypeDef
RestoreDBClusterToPointInTimeMessageRequestTypeDef#
# RestoreDBClusterToPointInTimeMessageRequestTypeDef usage example
from mypy_boto3_docdb.type_defs import RestoreDBClusterToPointInTimeMessageRequestTypeDef
def get_value() -> RestoreDBClusterToPointInTimeMessageRequestTypeDef:
return {
"DBClusterIdentifier": ...,
"SourceDBClusterIdentifier": ...,
}
# RestoreDBClusterToPointInTimeMessageRequestTypeDef 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],
- See TagTypeDef
TagListMessageTypeDef#
# TagListMessageTypeDef usage example
from mypy_boto3_docdb.type_defs import TagListMessageTypeDef
def get_value() -> TagListMessageTypeDef:
return {
"TagList": ...,
"ResponseMetadata": ...,
}
# TagListMessageTypeDef definition
class TagListMessageTypeDef(TypedDict):
TagList: List[TagTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See TagTypeDef
- See ResponseMetadataTypeDef
OrderableDBInstanceOptionTypeDef#
# OrderableDBInstanceOptionTypeDef usage example
from mypy_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],
SubnetTypeDef#
# SubnetTypeDef usage example
from mypy_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],
CertificateMessageTypeDef#
# CertificateMessageTypeDef usage example
from mypy_boto3_docdb.type_defs import CertificateMessageTypeDef
def get_value() -> CertificateMessageTypeDef:
return {
"Certificates": ...,
"Marker": ...,
"ResponseMetadata": ...,
}
# CertificateMessageTypeDef definition
class CertificateMessageTypeDef(TypedDict):
Certificates: List[CertificateTypeDef], # (1)
Marker: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ModifyDBClusterMessageRequestTypeDef#
# ModifyDBClusterMessageRequestTypeDef usage example
from mypy_boto3_docdb.type_defs import ModifyDBClusterMessageRequestTypeDef
def get_value() -> ModifyDBClusterMessageRequestTypeDef:
return {
"DBClusterIdentifier": ...,
}
# ModifyDBClusterMessageRequestTypeDef 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],
CopyDBClusterParameterGroupResultTypeDef#
# CopyDBClusterParameterGroupResultTypeDef usage example
from mypy_boto3_docdb.type_defs import CopyDBClusterParameterGroupResultTypeDef
def get_value() -> CopyDBClusterParameterGroupResultTypeDef:
return {
"DBClusterParameterGroup": ...,
"ResponseMetadata": ...,
}
# CopyDBClusterParameterGroupResultTypeDef definition
class CopyDBClusterParameterGroupResultTypeDef(TypedDict):
DBClusterParameterGroup: DBClusterParameterGroupTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateDBClusterParameterGroupResultTypeDef#
# CreateDBClusterParameterGroupResultTypeDef usage example
from mypy_boto3_docdb.type_defs import CreateDBClusterParameterGroupResultTypeDef
def get_value() -> CreateDBClusterParameterGroupResultTypeDef:
return {
"DBClusterParameterGroup": ...,
"ResponseMetadata": ...,
}
# CreateDBClusterParameterGroupResultTypeDef definition
class CreateDBClusterParameterGroupResultTypeDef(TypedDict):
DBClusterParameterGroup: DBClusterParameterGroupTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DBClusterParameterGroupsMessageTypeDef#
# DBClusterParameterGroupsMessageTypeDef usage example
from mypy_boto3_docdb.type_defs import DBClusterParameterGroupsMessageTypeDef
def get_value() -> DBClusterParameterGroupsMessageTypeDef:
return {
"Marker": ...,
"DBClusterParameterGroups": ...,
"ResponseMetadata": ...,
}
# DBClusterParameterGroupsMessageTypeDef definition
class DBClusterParameterGroupsMessageTypeDef(TypedDict):
Marker: str,
DBClusterParameterGroups: List[DBClusterParameterGroupTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CopyDBClusterSnapshotResultTypeDef#
# CopyDBClusterSnapshotResultTypeDef usage example
from mypy_boto3_docdb.type_defs import CopyDBClusterSnapshotResultTypeDef
def get_value() -> CopyDBClusterSnapshotResultTypeDef:
return {
"DBClusterSnapshot": ...,
"ResponseMetadata": ...,
}
# CopyDBClusterSnapshotResultTypeDef definition
class CopyDBClusterSnapshotResultTypeDef(TypedDict):
DBClusterSnapshot: DBClusterSnapshotTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateDBClusterSnapshotResultTypeDef#
# CreateDBClusterSnapshotResultTypeDef usage example
from mypy_boto3_docdb.type_defs import CreateDBClusterSnapshotResultTypeDef
def get_value() -> CreateDBClusterSnapshotResultTypeDef:
return {
"DBClusterSnapshot": ...,
"ResponseMetadata": ...,
}
# CreateDBClusterSnapshotResultTypeDef definition
class CreateDBClusterSnapshotResultTypeDef(TypedDict):
DBClusterSnapshot: DBClusterSnapshotTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DBClusterSnapshotMessageTypeDef#
# DBClusterSnapshotMessageTypeDef usage example
from mypy_boto3_docdb.type_defs import DBClusterSnapshotMessageTypeDef
def get_value() -> DBClusterSnapshotMessageTypeDef:
return {
"Marker": ...,
"DBClusterSnapshots": ...,
"ResponseMetadata": ...,
}
# DBClusterSnapshotMessageTypeDef definition
class DBClusterSnapshotMessageTypeDef(TypedDict):
Marker: str,
DBClusterSnapshots: List[DBClusterSnapshotTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DeleteDBClusterSnapshotResultTypeDef#
# DeleteDBClusterSnapshotResultTypeDef usage example
from mypy_boto3_docdb.type_defs import DeleteDBClusterSnapshotResultTypeDef
def get_value() -> DeleteDBClusterSnapshotResultTypeDef:
return {
"DBClusterSnapshot": ...,
"ResponseMetadata": ...,
}
# DeleteDBClusterSnapshotResultTypeDef definition
class DeleteDBClusterSnapshotResultTypeDef(TypedDict):
DBClusterSnapshot: DBClusterSnapshotTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DBClusterParameterGroupDetailsTypeDef#
# DBClusterParameterGroupDetailsTypeDef usage example
from mypy_boto3_docdb.type_defs import DBClusterParameterGroupDetailsTypeDef
def get_value() -> DBClusterParameterGroupDetailsTypeDef:
return {
"Parameters": ...,
"Marker": ...,
"ResponseMetadata": ...,
}
# DBClusterParameterGroupDetailsTypeDef definition
class DBClusterParameterGroupDetailsTypeDef(TypedDict):
Parameters: List[ParameterTypeDef], # (1)
Marker: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
EngineDefaultsTypeDef#
# EngineDefaultsTypeDef usage example
from mypy_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)
- See ParameterTypeDef
ModifyDBClusterParameterGroupMessageRequestTypeDef#
# ModifyDBClusterParameterGroupMessageRequestTypeDef usage example
from mypy_boto3_docdb.type_defs import ModifyDBClusterParameterGroupMessageRequestTypeDef
def get_value() -> ModifyDBClusterParameterGroupMessageRequestTypeDef:
return {
"DBClusterParameterGroupName": ...,
"Parameters": ...,
}
# ModifyDBClusterParameterGroupMessageRequestTypeDef definition
class ModifyDBClusterParameterGroupMessageRequestTypeDef(TypedDict):
DBClusterParameterGroupName: str,
Parameters: Sequence[ParameterTypeDef], # (1)
- See ParameterTypeDef
ResetDBClusterParameterGroupMessageRequestTypeDef#
# ResetDBClusterParameterGroupMessageRequestTypeDef usage example
from mypy_boto3_docdb.type_defs import ResetDBClusterParameterGroupMessageRequestTypeDef
def get_value() -> ResetDBClusterParameterGroupMessageRequestTypeDef:
return {
"DBClusterParameterGroupName": ...,
}
# ResetDBClusterParameterGroupMessageRequestTypeDef definition
class ResetDBClusterParameterGroupMessageRequestTypeDef(TypedDict):
DBClusterParameterGroupName: str,
ResetAllParameters: NotRequired[bool],
Parameters: NotRequired[Sequence[ParameterTypeDef]], # (1)
- See ParameterTypeDef
DBClusterSnapshotAttributesResultTypeDef#
# DBClusterSnapshotAttributesResultTypeDef usage example
from mypy_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)
DBClusterTypeDef#
# DBClusterTypeDef usage example
from mypy_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],
DBEngineVersionTypeDef#
# DBEngineVersionTypeDef usage example
from mypy_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],
DescribeCertificatesMessageDescribeCertificatesPaginateTypeDef#
# DescribeCertificatesMessageDescribeCertificatesPaginateTypeDef usage example
from mypy_boto3_docdb.type_defs import DescribeCertificatesMessageDescribeCertificatesPaginateTypeDef
def get_value() -> DescribeCertificatesMessageDescribeCertificatesPaginateTypeDef:
return {
"CertificateIdentifier": ...,
}
# DescribeCertificatesMessageDescribeCertificatesPaginateTypeDef definition
class DescribeCertificatesMessageDescribeCertificatesPaginateTypeDef(TypedDict):
CertificateIdentifier: NotRequired[str],
Filters: NotRequired[Sequence[FilterTypeDef]], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
- See FilterTypeDef
- See PaginatorConfigTypeDef
DescribeCertificatesMessageRequestTypeDef#
# DescribeCertificatesMessageRequestTypeDef usage example
from mypy_boto3_docdb.type_defs import DescribeCertificatesMessageRequestTypeDef
def get_value() -> DescribeCertificatesMessageRequestTypeDef:
return {
"CertificateIdentifier": ...,
}
# DescribeCertificatesMessageRequestTypeDef definition
class DescribeCertificatesMessageRequestTypeDef(TypedDict):
CertificateIdentifier: NotRequired[str],
Filters: NotRequired[Sequence[FilterTypeDef]], # (1)
MaxRecords: NotRequired[int],
Marker: NotRequired[str],
- See FilterTypeDef
DescribeDBClusterParameterGroupsMessageDescribeDBClusterParameterGroupsPaginateTypeDef#
# DescribeDBClusterParameterGroupsMessageDescribeDBClusterParameterGroupsPaginateTypeDef usage example
from mypy_boto3_docdb.type_defs import DescribeDBClusterParameterGroupsMessageDescribeDBClusterParameterGroupsPaginateTypeDef
def get_value() -> DescribeDBClusterParameterGroupsMessageDescribeDBClusterParameterGroupsPaginateTypeDef:
return {
"DBClusterParameterGroupName": ...,
}
# DescribeDBClusterParameterGroupsMessageDescribeDBClusterParameterGroupsPaginateTypeDef definition
class DescribeDBClusterParameterGroupsMessageDescribeDBClusterParameterGroupsPaginateTypeDef(TypedDict):
DBClusterParameterGroupName: NotRequired[str],
Filters: NotRequired[Sequence[FilterTypeDef]], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
- See FilterTypeDef
- See PaginatorConfigTypeDef
DescribeDBClusterParameterGroupsMessageRequestTypeDef#
# DescribeDBClusterParameterGroupsMessageRequestTypeDef usage example
from mypy_boto3_docdb.type_defs import DescribeDBClusterParameterGroupsMessageRequestTypeDef
def get_value() -> DescribeDBClusterParameterGroupsMessageRequestTypeDef:
return {
"DBClusterParameterGroupName": ...,
}
# DescribeDBClusterParameterGroupsMessageRequestTypeDef definition
class DescribeDBClusterParameterGroupsMessageRequestTypeDef(TypedDict):
DBClusterParameterGroupName: NotRequired[str],
Filters: NotRequired[Sequence[FilterTypeDef]], # (1)
MaxRecords: NotRequired[int],
Marker: NotRequired[str],
- See FilterTypeDef
DescribeDBClusterParametersMessageDescribeDBClusterParametersPaginateTypeDef#
# DescribeDBClusterParametersMessageDescribeDBClusterParametersPaginateTypeDef usage example
from mypy_boto3_docdb.type_defs import DescribeDBClusterParametersMessageDescribeDBClusterParametersPaginateTypeDef
def get_value() -> DescribeDBClusterParametersMessageDescribeDBClusterParametersPaginateTypeDef:
return {
"DBClusterParameterGroupName": ...,
}
# DescribeDBClusterParametersMessageDescribeDBClusterParametersPaginateTypeDef definition
class DescribeDBClusterParametersMessageDescribeDBClusterParametersPaginateTypeDef(TypedDict):
DBClusterParameterGroupName: str,
Source: NotRequired[str],
Filters: NotRequired[Sequence[FilterTypeDef]], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
- See FilterTypeDef
- See PaginatorConfigTypeDef
DescribeDBClusterParametersMessageRequestTypeDef#
# DescribeDBClusterParametersMessageRequestTypeDef usage example
from mypy_boto3_docdb.type_defs import DescribeDBClusterParametersMessageRequestTypeDef
def get_value() -> DescribeDBClusterParametersMessageRequestTypeDef:
return {
"DBClusterParameterGroupName": ...,
}
# DescribeDBClusterParametersMessageRequestTypeDef definition
class DescribeDBClusterParametersMessageRequestTypeDef(TypedDict):
DBClusterParameterGroupName: str,
Source: NotRequired[str],
Filters: NotRequired[Sequence[FilterTypeDef]], # (1)
MaxRecords: NotRequired[int],
Marker: NotRequired[str],
- See FilterTypeDef
DescribeDBClusterSnapshotsMessageDescribeDBClusterSnapshotsPaginateTypeDef#
# DescribeDBClusterSnapshotsMessageDescribeDBClusterSnapshotsPaginateTypeDef usage example
from mypy_boto3_docdb.type_defs import DescribeDBClusterSnapshotsMessageDescribeDBClusterSnapshotsPaginateTypeDef
def get_value() -> DescribeDBClusterSnapshotsMessageDescribeDBClusterSnapshotsPaginateTypeDef:
return {
"DBClusterIdentifier": ...,
}
# DescribeDBClusterSnapshotsMessageDescribeDBClusterSnapshotsPaginateTypeDef 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)
- See FilterTypeDef
- See PaginatorConfigTypeDef
DescribeDBClusterSnapshotsMessageRequestTypeDef#
# DescribeDBClusterSnapshotsMessageRequestTypeDef usage example
from mypy_boto3_docdb.type_defs import DescribeDBClusterSnapshotsMessageRequestTypeDef
def get_value() -> DescribeDBClusterSnapshotsMessageRequestTypeDef:
return {
"DBClusterIdentifier": ...,
}
# DescribeDBClusterSnapshotsMessageRequestTypeDef 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],
- See FilterTypeDef
DescribeDBClustersMessageDescribeDBClustersPaginateTypeDef#
# DescribeDBClustersMessageDescribeDBClustersPaginateTypeDef usage example
from mypy_boto3_docdb.type_defs import DescribeDBClustersMessageDescribeDBClustersPaginateTypeDef
def get_value() -> DescribeDBClustersMessageDescribeDBClustersPaginateTypeDef:
return {
"DBClusterIdentifier": ...,
}
# DescribeDBClustersMessageDescribeDBClustersPaginateTypeDef definition
class DescribeDBClustersMessageDescribeDBClustersPaginateTypeDef(TypedDict):
DBClusterIdentifier: NotRequired[str],
Filters: NotRequired[Sequence[FilterTypeDef]], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
- See FilterTypeDef
- See PaginatorConfigTypeDef
DescribeDBClustersMessageRequestTypeDef#
# DescribeDBClustersMessageRequestTypeDef usage example
from mypy_boto3_docdb.type_defs import DescribeDBClustersMessageRequestTypeDef
def get_value() -> DescribeDBClustersMessageRequestTypeDef:
return {
"DBClusterIdentifier": ...,
}
# DescribeDBClustersMessageRequestTypeDef definition
class DescribeDBClustersMessageRequestTypeDef(TypedDict):
DBClusterIdentifier: NotRequired[str],
Filters: NotRequired[Sequence[FilterTypeDef]], # (1)
MaxRecords: NotRequired[int],
Marker: NotRequired[str],
- See FilterTypeDef
DescribeDBEngineVersionsMessageDescribeDBEngineVersionsPaginateTypeDef#
# DescribeDBEngineVersionsMessageDescribeDBEngineVersionsPaginateTypeDef usage example
from mypy_boto3_docdb.type_defs import DescribeDBEngineVersionsMessageDescribeDBEngineVersionsPaginateTypeDef
def get_value() -> DescribeDBEngineVersionsMessageDescribeDBEngineVersionsPaginateTypeDef:
return {
"Engine": ...,
}
# DescribeDBEngineVersionsMessageDescribeDBEngineVersionsPaginateTypeDef definition
class DescribeDBEngineVersionsMessageDescribeDBEngineVersionsPaginateTypeDef(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)
- See FilterTypeDef
- See PaginatorConfigTypeDef
DescribeDBEngineVersionsMessageRequestTypeDef#
# DescribeDBEngineVersionsMessageRequestTypeDef usage example
from mypy_boto3_docdb.type_defs import DescribeDBEngineVersionsMessageRequestTypeDef
def get_value() -> DescribeDBEngineVersionsMessageRequestTypeDef:
return {
"Engine": ...,
}
# DescribeDBEngineVersionsMessageRequestTypeDef 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],
- See FilterTypeDef
DescribeDBInstancesMessageDescribeDBInstancesPaginateTypeDef#
# DescribeDBInstancesMessageDescribeDBInstancesPaginateTypeDef usage example
from mypy_boto3_docdb.type_defs import DescribeDBInstancesMessageDescribeDBInstancesPaginateTypeDef
def get_value() -> DescribeDBInstancesMessageDescribeDBInstancesPaginateTypeDef:
return {
"DBInstanceIdentifier": ...,
}
# DescribeDBInstancesMessageDescribeDBInstancesPaginateTypeDef definition
class DescribeDBInstancesMessageDescribeDBInstancesPaginateTypeDef(TypedDict):
DBInstanceIdentifier: NotRequired[str],
Filters: NotRequired[Sequence[FilterTypeDef]], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
- See FilterTypeDef
- See PaginatorConfigTypeDef
DescribeDBInstancesMessageRequestTypeDef#
# DescribeDBInstancesMessageRequestTypeDef usage example
from mypy_boto3_docdb.type_defs import DescribeDBInstancesMessageRequestTypeDef
def get_value() -> DescribeDBInstancesMessageRequestTypeDef:
return {
"DBInstanceIdentifier": ...,
}
# DescribeDBInstancesMessageRequestTypeDef definition
class DescribeDBInstancesMessageRequestTypeDef(TypedDict):
DBInstanceIdentifier: NotRequired[str],
Filters: NotRequired[Sequence[FilterTypeDef]], # (1)
MaxRecords: NotRequired[int],
Marker: NotRequired[str],
- See FilterTypeDef
DescribeDBSubnetGroupsMessageDescribeDBSubnetGroupsPaginateTypeDef#
# DescribeDBSubnetGroupsMessageDescribeDBSubnetGroupsPaginateTypeDef usage example
from mypy_boto3_docdb.type_defs import DescribeDBSubnetGroupsMessageDescribeDBSubnetGroupsPaginateTypeDef
def get_value() -> DescribeDBSubnetGroupsMessageDescribeDBSubnetGroupsPaginateTypeDef:
return {
"DBSubnetGroupName": ...,
}
# DescribeDBSubnetGroupsMessageDescribeDBSubnetGroupsPaginateTypeDef definition
class DescribeDBSubnetGroupsMessageDescribeDBSubnetGroupsPaginateTypeDef(TypedDict):
DBSubnetGroupName: NotRequired[str],
Filters: NotRequired[Sequence[FilterTypeDef]], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
- See FilterTypeDef
- See PaginatorConfigTypeDef
DescribeDBSubnetGroupsMessageRequestTypeDef#
# DescribeDBSubnetGroupsMessageRequestTypeDef usage example
from mypy_boto3_docdb.type_defs import DescribeDBSubnetGroupsMessageRequestTypeDef
def get_value() -> DescribeDBSubnetGroupsMessageRequestTypeDef:
return {
"DBSubnetGroupName": ...,
}
# DescribeDBSubnetGroupsMessageRequestTypeDef definition
class DescribeDBSubnetGroupsMessageRequestTypeDef(TypedDict):
DBSubnetGroupName: NotRequired[str],
Filters: NotRequired[Sequence[FilterTypeDef]], # (1)
MaxRecords: NotRequired[int],
Marker: NotRequired[str],
- See FilterTypeDef
DescribeEngineDefaultClusterParametersMessageRequestTypeDef#
# DescribeEngineDefaultClusterParametersMessageRequestTypeDef usage example
from mypy_boto3_docdb.type_defs import DescribeEngineDefaultClusterParametersMessageRequestTypeDef
def get_value() -> DescribeEngineDefaultClusterParametersMessageRequestTypeDef:
return {
"DBParameterGroupFamily": ...,
}
# DescribeEngineDefaultClusterParametersMessageRequestTypeDef definition
class DescribeEngineDefaultClusterParametersMessageRequestTypeDef(TypedDict):
DBParameterGroupFamily: str,
Filters: NotRequired[Sequence[FilterTypeDef]], # (1)
MaxRecords: NotRequired[int],
Marker: NotRequired[str],
- See FilterTypeDef
DescribeEventCategoriesMessageRequestTypeDef#
# DescribeEventCategoriesMessageRequestTypeDef usage example
from mypy_boto3_docdb.type_defs import DescribeEventCategoriesMessageRequestTypeDef
def get_value() -> DescribeEventCategoriesMessageRequestTypeDef:
return {
"SourceType": ...,
}
# DescribeEventCategoriesMessageRequestTypeDef definition
class DescribeEventCategoriesMessageRequestTypeDef(TypedDict):
SourceType: NotRequired[str],
Filters: NotRequired[Sequence[FilterTypeDef]], # (1)
- See FilterTypeDef
DescribeEventSubscriptionsMessageDescribeEventSubscriptionsPaginateTypeDef#
# DescribeEventSubscriptionsMessageDescribeEventSubscriptionsPaginateTypeDef usage example
from mypy_boto3_docdb.type_defs import DescribeEventSubscriptionsMessageDescribeEventSubscriptionsPaginateTypeDef
def get_value() -> DescribeEventSubscriptionsMessageDescribeEventSubscriptionsPaginateTypeDef:
return {
"SubscriptionName": ...,
}
# DescribeEventSubscriptionsMessageDescribeEventSubscriptionsPaginateTypeDef definition
class DescribeEventSubscriptionsMessageDescribeEventSubscriptionsPaginateTypeDef(TypedDict):
SubscriptionName: NotRequired[str],
Filters: NotRequired[Sequence[FilterTypeDef]], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
- See FilterTypeDef
- See PaginatorConfigTypeDef
DescribeEventSubscriptionsMessageRequestTypeDef#
# DescribeEventSubscriptionsMessageRequestTypeDef usage example
from mypy_boto3_docdb.type_defs import DescribeEventSubscriptionsMessageRequestTypeDef
def get_value() -> DescribeEventSubscriptionsMessageRequestTypeDef:
return {
"SubscriptionName": ...,
}
# DescribeEventSubscriptionsMessageRequestTypeDef definition
class DescribeEventSubscriptionsMessageRequestTypeDef(TypedDict):
SubscriptionName: NotRequired[str],
Filters: NotRequired[Sequence[FilterTypeDef]], # (1)
MaxRecords: NotRequired[int],
Marker: NotRequired[str],
- See FilterTypeDef
DescribeEventsMessageDescribeEventsPaginateTypeDef#
# DescribeEventsMessageDescribeEventsPaginateTypeDef usage example
from mypy_boto3_docdb.type_defs import DescribeEventsMessageDescribeEventsPaginateTypeDef
def get_value() -> DescribeEventsMessageDescribeEventsPaginateTypeDef:
return {
"SourceIdentifier": ...,
}
# DescribeEventsMessageDescribeEventsPaginateTypeDef definition
class DescribeEventsMessageDescribeEventsPaginateTypeDef(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)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (3)
- See SourceTypeType
- See FilterTypeDef
- See PaginatorConfigTypeDef
DescribeEventsMessageRequestTypeDef#
# DescribeEventsMessageRequestTypeDef usage example
from mypy_boto3_docdb.type_defs import DescribeEventsMessageRequestTypeDef
def get_value() -> DescribeEventsMessageRequestTypeDef:
return {
"SourceIdentifier": ...,
}
# DescribeEventsMessageRequestTypeDef 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],
- See SourceTypeType
- See FilterTypeDef
DescribeGlobalClustersMessageDescribeGlobalClustersPaginateTypeDef#
# DescribeGlobalClustersMessageDescribeGlobalClustersPaginateTypeDef usage example
from mypy_boto3_docdb.type_defs import DescribeGlobalClustersMessageDescribeGlobalClustersPaginateTypeDef
def get_value() -> DescribeGlobalClustersMessageDescribeGlobalClustersPaginateTypeDef:
return {
"GlobalClusterIdentifier": ...,
}
# DescribeGlobalClustersMessageDescribeGlobalClustersPaginateTypeDef definition
class DescribeGlobalClustersMessageDescribeGlobalClustersPaginateTypeDef(TypedDict):
GlobalClusterIdentifier: NotRequired[str],
Filters: NotRequired[Sequence[FilterTypeDef]], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
- See FilterTypeDef
- See PaginatorConfigTypeDef
DescribeGlobalClustersMessageRequestTypeDef#
# DescribeGlobalClustersMessageRequestTypeDef usage example
from mypy_boto3_docdb.type_defs import DescribeGlobalClustersMessageRequestTypeDef
def get_value() -> DescribeGlobalClustersMessageRequestTypeDef:
return {
"GlobalClusterIdentifier": ...,
}
# DescribeGlobalClustersMessageRequestTypeDef definition
class DescribeGlobalClustersMessageRequestTypeDef(TypedDict):
GlobalClusterIdentifier: NotRequired[str],
Filters: NotRequired[Sequence[FilterTypeDef]], # (1)
MaxRecords: NotRequired[int],
Marker: NotRequired[str],
- See FilterTypeDef
DescribeOrderableDBInstanceOptionsMessageDescribeOrderableDBInstanceOptionsPaginateTypeDef#
# DescribeOrderableDBInstanceOptionsMessageDescribeOrderableDBInstanceOptionsPaginateTypeDef usage example
from mypy_boto3_docdb.type_defs import DescribeOrderableDBInstanceOptionsMessageDescribeOrderableDBInstanceOptionsPaginateTypeDef
def get_value() -> DescribeOrderableDBInstanceOptionsMessageDescribeOrderableDBInstanceOptionsPaginateTypeDef:
return {
"Engine": ...,
}
# DescribeOrderableDBInstanceOptionsMessageDescribeOrderableDBInstanceOptionsPaginateTypeDef definition
class DescribeOrderableDBInstanceOptionsMessageDescribeOrderableDBInstanceOptionsPaginateTypeDef(TypedDict):
Engine: str,
EngineVersion: NotRequired[str],
DBInstanceClass: NotRequired[str],
LicenseModel: NotRequired[str],
Vpc: NotRequired[bool],
Filters: NotRequired[Sequence[FilterTypeDef]], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
- See FilterTypeDef
- See PaginatorConfigTypeDef
DescribeOrderableDBInstanceOptionsMessageRequestTypeDef#
# DescribeOrderableDBInstanceOptionsMessageRequestTypeDef usage example
from mypy_boto3_docdb.type_defs import DescribeOrderableDBInstanceOptionsMessageRequestTypeDef
def get_value() -> DescribeOrderableDBInstanceOptionsMessageRequestTypeDef:
return {
"Engine": ...,
}
# DescribeOrderableDBInstanceOptionsMessageRequestTypeDef 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],
- See FilterTypeDef
DescribePendingMaintenanceActionsMessageDescribePendingMaintenanceActionsPaginateTypeDef#
# DescribePendingMaintenanceActionsMessageDescribePendingMaintenanceActionsPaginateTypeDef usage example
from mypy_boto3_docdb.type_defs import DescribePendingMaintenanceActionsMessageDescribePendingMaintenanceActionsPaginateTypeDef
def get_value() -> DescribePendingMaintenanceActionsMessageDescribePendingMaintenanceActionsPaginateTypeDef:
return {
"ResourceIdentifier": ...,
}
# DescribePendingMaintenanceActionsMessageDescribePendingMaintenanceActionsPaginateTypeDef definition
class DescribePendingMaintenanceActionsMessageDescribePendingMaintenanceActionsPaginateTypeDef(TypedDict):
ResourceIdentifier: NotRequired[str],
Filters: NotRequired[Sequence[FilterTypeDef]], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
- See FilterTypeDef
- See PaginatorConfigTypeDef
DescribePendingMaintenanceActionsMessageRequestTypeDef#
# DescribePendingMaintenanceActionsMessageRequestTypeDef usage example
from mypy_boto3_docdb.type_defs import DescribePendingMaintenanceActionsMessageRequestTypeDef
def get_value() -> DescribePendingMaintenanceActionsMessageRequestTypeDef:
return {
"ResourceIdentifier": ...,
}
# DescribePendingMaintenanceActionsMessageRequestTypeDef definition
class DescribePendingMaintenanceActionsMessageRequestTypeDef(TypedDict):
ResourceIdentifier: NotRequired[str],
Filters: NotRequired[Sequence[FilterTypeDef]], # (1)
Marker: NotRequired[str],
MaxRecords: NotRequired[int],
- See FilterTypeDef
ListTagsForResourceMessageRequestTypeDef#
# ListTagsForResourceMessageRequestTypeDef usage example
from mypy_boto3_docdb.type_defs import ListTagsForResourceMessageRequestTypeDef
def get_value() -> ListTagsForResourceMessageRequestTypeDef:
return {
"ResourceName": ...,
}
# ListTagsForResourceMessageRequestTypeDef definition
class ListTagsForResourceMessageRequestTypeDef(TypedDict):
ResourceName: str,
Filters: NotRequired[Sequence[FilterTypeDef]], # (1)
- See FilterTypeDef
DescribeDBInstancesMessageDBInstanceAvailableWaitTypeDef#
# DescribeDBInstancesMessageDBInstanceAvailableWaitTypeDef usage example
from mypy_boto3_docdb.type_defs import DescribeDBInstancesMessageDBInstanceAvailableWaitTypeDef
def get_value() -> DescribeDBInstancesMessageDBInstanceAvailableWaitTypeDef:
return {
"DBInstanceIdentifier": ...,
}
# DescribeDBInstancesMessageDBInstanceAvailableWaitTypeDef definition
class DescribeDBInstancesMessageDBInstanceAvailableWaitTypeDef(TypedDict):
DBInstanceIdentifier: NotRequired[str],
Filters: NotRequired[Sequence[FilterTypeDef]], # (1)
MaxRecords: NotRequired[int],
Marker: NotRequired[str],
WaiterConfig: NotRequired[WaiterConfigTypeDef], # (2)
- See FilterTypeDef
- See WaiterConfigTypeDef
DescribeDBInstancesMessageDBInstanceDeletedWaitTypeDef#
# DescribeDBInstancesMessageDBInstanceDeletedWaitTypeDef usage example
from mypy_boto3_docdb.type_defs import DescribeDBInstancesMessageDBInstanceDeletedWaitTypeDef
def get_value() -> DescribeDBInstancesMessageDBInstanceDeletedWaitTypeDef:
return {
"DBInstanceIdentifier": ...,
}
# DescribeDBInstancesMessageDBInstanceDeletedWaitTypeDef definition
class DescribeDBInstancesMessageDBInstanceDeletedWaitTypeDef(TypedDict):
DBInstanceIdentifier: NotRequired[str],
Filters: NotRequired[Sequence[FilterTypeDef]], # (1)
MaxRecords: NotRequired[int],
Marker: NotRequired[str],
WaiterConfig: NotRequired[WaiterConfigTypeDef], # (2)
- See FilterTypeDef
- See WaiterConfigTypeDef
EventCategoriesMessageTypeDef#
# EventCategoriesMessageTypeDef usage example
from mypy_boto3_docdb.type_defs import EventCategoriesMessageTypeDef
def get_value() -> EventCategoriesMessageTypeDef:
return {
"EventCategoriesMapList": ...,
"ResponseMetadata": ...,
}
# EventCategoriesMessageTypeDef definition
class EventCategoriesMessageTypeDef(TypedDict):
EventCategoriesMapList: List[EventCategoriesMapTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
EventsMessageTypeDef#
# EventsMessageTypeDef usage example
from mypy_boto3_docdb.type_defs import EventsMessageTypeDef
def get_value() -> EventsMessageTypeDef:
return {
"Marker": ...,
"Events": ...,
"ResponseMetadata": ...,
}
# EventsMessageTypeDef definition
class EventsMessageTypeDef(TypedDict):
Marker: str,
Events: List[EventTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See EventTypeDef
- See ResponseMetadataTypeDef
GlobalClusterTypeDef#
# GlobalClusterTypeDef usage example
from mypy_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)
PendingModifiedValuesTypeDef#
# PendingModifiedValuesTypeDef usage example
from mypy_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)
ResourcePendingMaintenanceActionsTypeDef#
# ResourcePendingMaintenanceActionsTypeDef usage example
from mypy_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)
OrderableDBInstanceOptionsMessageTypeDef#
# OrderableDBInstanceOptionsMessageTypeDef usage example
from mypy_boto3_docdb.type_defs import OrderableDBInstanceOptionsMessageTypeDef
def get_value() -> OrderableDBInstanceOptionsMessageTypeDef:
return {
"OrderableDBInstanceOptions": ...,
"Marker": ...,
"ResponseMetadata": ...,
}
# OrderableDBInstanceOptionsMessageTypeDef definition
class OrderableDBInstanceOptionsMessageTypeDef(TypedDict):
OrderableDBInstanceOptions: List[OrderableDBInstanceOptionTypeDef], # (1)
Marker: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DBSubnetGroupTypeDef#
# DBSubnetGroupTypeDef usage example
from mypy_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],
- See SubnetTypeDef
DescribeEngineDefaultClusterParametersResultTypeDef#
# DescribeEngineDefaultClusterParametersResultTypeDef usage example
from mypy_boto3_docdb.type_defs import DescribeEngineDefaultClusterParametersResultTypeDef
def get_value() -> DescribeEngineDefaultClusterParametersResultTypeDef:
return {
"EngineDefaults": ...,
"ResponseMetadata": ...,
}
# DescribeEngineDefaultClusterParametersResultTypeDef definition
class DescribeEngineDefaultClusterParametersResultTypeDef(TypedDict):
EngineDefaults: EngineDefaultsTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeDBClusterSnapshotAttributesResultTypeDef#
# DescribeDBClusterSnapshotAttributesResultTypeDef usage example
from mypy_boto3_docdb.type_defs import DescribeDBClusterSnapshotAttributesResultTypeDef
def get_value() -> DescribeDBClusterSnapshotAttributesResultTypeDef:
return {
"DBClusterSnapshotAttributesResult": ...,
"ResponseMetadata": ...,
}
# DescribeDBClusterSnapshotAttributesResultTypeDef definition
class DescribeDBClusterSnapshotAttributesResultTypeDef(TypedDict):
DBClusterSnapshotAttributesResult: DBClusterSnapshotAttributesResultTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ModifyDBClusterSnapshotAttributeResultTypeDef#
# ModifyDBClusterSnapshotAttributeResultTypeDef usage example
from mypy_boto3_docdb.type_defs import ModifyDBClusterSnapshotAttributeResultTypeDef
def get_value() -> ModifyDBClusterSnapshotAttributeResultTypeDef:
return {
"DBClusterSnapshotAttributesResult": ...,
"ResponseMetadata": ...,
}
# ModifyDBClusterSnapshotAttributeResultTypeDef definition
class ModifyDBClusterSnapshotAttributeResultTypeDef(TypedDict):
DBClusterSnapshotAttributesResult: DBClusterSnapshotAttributesResultTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateDBClusterResultTypeDef#
# CreateDBClusterResultTypeDef usage example
from mypy_boto3_docdb.type_defs import CreateDBClusterResultTypeDef
def get_value() -> CreateDBClusterResultTypeDef:
return {
"DBCluster": ...,
"ResponseMetadata": ...,
}
# CreateDBClusterResultTypeDef definition
class CreateDBClusterResultTypeDef(TypedDict):
DBCluster: DBClusterTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DBClusterMessageTypeDef#
# DBClusterMessageTypeDef usage example
from mypy_boto3_docdb.type_defs import DBClusterMessageTypeDef
def get_value() -> DBClusterMessageTypeDef:
return {
"Marker": ...,
"DBClusters": ...,
"ResponseMetadata": ...,
}
# DBClusterMessageTypeDef definition
class DBClusterMessageTypeDef(TypedDict):
Marker: str,
DBClusters: List[DBClusterTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DeleteDBClusterResultTypeDef#
# DeleteDBClusterResultTypeDef usage example
from mypy_boto3_docdb.type_defs import DeleteDBClusterResultTypeDef
def get_value() -> DeleteDBClusterResultTypeDef:
return {
"DBCluster": ...,
"ResponseMetadata": ...,
}
# DeleteDBClusterResultTypeDef definition
class DeleteDBClusterResultTypeDef(TypedDict):
DBCluster: DBClusterTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
FailoverDBClusterResultTypeDef#
# FailoverDBClusterResultTypeDef usage example
from mypy_boto3_docdb.type_defs import FailoverDBClusterResultTypeDef
def get_value() -> FailoverDBClusterResultTypeDef:
return {
"DBCluster": ...,
"ResponseMetadata": ...,
}
# FailoverDBClusterResultTypeDef definition
class FailoverDBClusterResultTypeDef(TypedDict):
DBCluster: DBClusterTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ModifyDBClusterResultTypeDef#
# ModifyDBClusterResultTypeDef usage example
from mypy_boto3_docdb.type_defs import ModifyDBClusterResultTypeDef
def get_value() -> ModifyDBClusterResultTypeDef:
return {
"DBCluster": ...,
"ResponseMetadata": ...,
}
# ModifyDBClusterResultTypeDef definition
class ModifyDBClusterResultTypeDef(TypedDict):
DBCluster: DBClusterTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
RestoreDBClusterFromSnapshotResultTypeDef#
# RestoreDBClusterFromSnapshotResultTypeDef usage example
from mypy_boto3_docdb.type_defs import RestoreDBClusterFromSnapshotResultTypeDef
def get_value() -> RestoreDBClusterFromSnapshotResultTypeDef:
return {
"DBCluster": ...,
"ResponseMetadata": ...,
}
# RestoreDBClusterFromSnapshotResultTypeDef definition
class RestoreDBClusterFromSnapshotResultTypeDef(TypedDict):
DBCluster: DBClusterTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
RestoreDBClusterToPointInTimeResultTypeDef#
# RestoreDBClusterToPointInTimeResultTypeDef usage example
from mypy_boto3_docdb.type_defs import RestoreDBClusterToPointInTimeResultTypeDef
def get_value() -> RestoreDBClusterToPointInTimeResultTypeDef:
return {
"DBCluster": ...,
"ResponseMetadata": ...,
}
# RestoreDBClusterToPointInTimeResultTypeDef definition
class RestoreDBClusterToPointInTimeResultTypeDef(TypedDict):
DBCluster: DBClusterTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
StartDBClusterResultTypeDef#
# StartDBClusterResultTypeDef usage example
from mypy_boto3_docdb.type_defs import StartDBClusterResultTypeDef
def get_value() -> StartDBClusterResultTypeDef:
return {
"DBCluster": ...,
"ResponseMetadata": ...,
}
# StartDBClusterResultTypeDef definition
class StartDBClusterResultTypeDef(TypedDict):
DBCluster: DBClusterTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
StopDBClusterResultTypeDef#
# StopDBClusterResultTypeDef usage example
from mypy_boto3_docdb.type_defs import StopDBClusterResultTypeDef
def get_value() -> StopDBClusterResultTypeDef:
return {
"DBCluster": ...,
"ResponseMetadata": ...,
}
# StopDBClusterResultTypeDef definition
class StopDBClusterResultTypeDef(TypedDict):
DBCluster: DBClusterTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DBEngineVersionMessageTypeDef#
# DBEngineVersionMessageTypeDef usage example
from mypy_boto3_docdb.type_defs import DBEngineVersionMessageTypeDef
def get_value() -> DBEngineVersionMessageTypeDef:
return {
"Marker": ...,
"DBEngineVersions": ...,
"ResponseMetadata": ...,
}
# DBEngineVersionMessageTypeDef definition
class DBEngineVersionMessageTypeDef(TypedDict):
Marker: str,
DBEngineVersions: List[DBEngineVersionTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateGlobalClusterResultTypeDef#
# CreateGlobalClusterResultTypeDef usage example
from mypy_boto3_docdb.type_defs import CreateGlobalClusterResultTypeDef
def get_value() -> CreateGlobalClusterResultTypeDef:
return {
"GlobalCluster": ...,
"ResponseMetadata": ...,
}
# CreateGlobalClusterResultTypeDef definition
class CreateGlobalClusterResultTypeDef(TypedDict):
GlobalCluster: GlobalClusterTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DeleteGlobalClusterResultTypeDef#
# DeleteGlobalClusterResultTypeDef usage example
from mypy_boto3_docdb.type_defs import DeleteGlobalClusterResultTypeDef
def get_value() -> DeleteGlobalClusterResultTypeDef:
return {
"GlobalCluster": ...,
"ResponseMetadata": ...,
}
# DeleteGlobalClusterResultTypeDef definition
class DeleteGlobalClusterResultTypeDef(TypedDict):
GlobalCluster: GlobalClusterTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GlobalClustersMessageTypeDef#
# GlobalClustersMessageTypeDef usage example
from mypy_boto3_docdb.type_defs import GlobalClustersMessageTypeDef
def get_value() -> GlobalClustersMessageTypeDef:
return {
"Marker": ...,
"GlobalClusters": ...,
"ResponseMetadata": ...,
}
# GlobalClustersMessageTypeDef definition
class GlobalClustersMessageTypeDef(TypedDict):
Marker: str,
GlobalClusters: List[GlobalClusterTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ModifyGlobalClusterResultTypeDef#
# ModifyGlobalClusterResultTypeDef usage example
from mypy_boto3_docdb.type_defs import ModifyGlobalClusterResultTypeDef
def get_value() -> ModifyGlobalClusterResultTypeDef:
return {
"GlobalCluster": ...,
"ResponseMetadata": ...,
}
# ModifyGlobalClusterResultTypeDef definition
class ModifyGlobalClusterResultTypeDef(TypedDict):
GlobalCluster: GlobalClusterTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
RemoveFromGlobalClusterResultTypeDef#
# RemoveFromGlobalClusterResultTypeDef usage example
from mypy_boto3_docdb.type_defs import RemoveFromGlobalClusterResultTypeDef
def get_value() -> RemoveFromGlobalClusterResultTypeDef:
return {
"GlobalCluster": ...,
"ResponseMetadata": ...,
}
# RemoveFromGlobalClusterResultTypeDef definition
class RemoveFromGlobalClusterResultTypeDef(TypedDict):
GlobalCluster: GlobalClusterTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ApplyPendingMaintenanceActionResultTypeDef#
# ApplyPendingMaintenanceActionResultTypeDef usage example
from mypy_boto3_docdb.type_defs import ApplyPendingMaintenanceActionResultTypeDef
def get_value() -> ApplyPendingMaintenanceActionResultTypeDef:
return {
"ResourcePendingMaintenanceActions": ...,
"ResponseMetadata": ...,
}
# ApplyPendingMaintenanceActionResultTypeDef definition
class ApplyPendingMaintenanceActionResultTypeDef(TypedDict):
ResourcePendingMaintenanceActions: ResourcePendingMaintenanceActionsTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
PendingMaintenanceActionsMessageTypeDef#
# PendingMaintenanceActionsMessageTypeDef usage example
from mypy_boto3_docdb.type_defs import PendingMaintenanceActionsMessageTypeDef
def get_value() -> PendingMaintenanceActionsMessageTypeDef:
return {
"PendingMaintenanceActions": ...,
"Marker": ...,
"ResponseMetadata": ...,
}
# PendingMaintenanceActionsMessageTypeDef definition
class PendingMaintenanceActionsMessageTypeDef(TypedDict):
PendingMaintenanceActions: List[ResourcePendingMaintenanceActionsTypeDef], # (1)
Marker: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateDBSubnetGroupResultTypeDef#
# CreateDBSubnetGroupResultTypeDef usage example
from mypy_boto3_docdb.type_defs import CreateDBSubnetGroupResultTypeDef
def get_value() -> CreateDBSubnetGroupResultTypeDef:
return {
"DBSubnetGroup": ...,
"ResponseMetadata": ...,
}
# CreateDBSubnetGroupResultTypeDef definition
class CreateDBSubnetGroupResultTypeDef(TypedDict):
DBSubnetGroup: DBSubnetGroupTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DBInstanceTypeDef#
# DBInstanceTypeDef usage example
from mypy_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]],
- See EndpointTypeDef
- See VpcSecurityGroupMembershipTypeDef
- See DBSubnetGroupTypeDef
- See PendingModifiedValuesTypeDef
- See DBInstanceStatusInfoTypeDef
DBSubnetGroupMessageTypeDef#
# DBSubnetGroupMessageTypeDef usage example
from mypy_boto3_docdb.type_defs import DBSubnetGroupMessageTypeDef
def get_value() -> DBSubnetGroupMessageTypeDef:
return {
"Marker": ...,
"DBSubnetGroups": ...,
"ResponseMetadata": ...,
}
# DBSubnetGroupMessageTypeDef definition
class DBSubnetGroupMessageTypeDef(TypedDict):
Marker: str,
DBSubnetGroups: List[DBSubnetGroupTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ModifyDBSubnetGroupResultTypeDef#
# ModifyDBSubnetGroupResultTypeDef usage example
from mypy_boto3_docdb.type_defs import ModifyDBSubnetGroupResultTypeDef
def get_value() -> ModifyDBSubnetGroupResultTypeDef:
return {
"DBSubnetGroup": ...,
"ResponseMetadata": ...,
}
# ModifyDBSubnetGroupResultTypeDef definition
class ModifyDBSubnetGroupResultTypeDef(TypedDict):
DBSubnetGroup: DBSubnetGroupTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateDBInstanceResultTypeDef#
# CreateDBInstanceResultTypeDef usage example
from mypy_boto3_docdb.type_defs import CreateDBInstanceResultTypeDef
def get_value() -> CreateDBInstanceResultTypeDef:
return {
"DBInstance": ...,
"ResponseMetadata": ...,
}
# CreateDBInstanceResultTypeDef definition
class CreateDBInstanceResultTypeDef(TypedDict):
DBInstance: DBInstanceTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DBInstanceMessageTypeDef#
# DBInstanceMessageTypeDef usage example
from mypy_boto3_docdb.type_defs import DBInstanceMessageTypeDef
def get_value() -> DBInstanceMessageTypeDef:
return {
"Marker": ...,
"DBInstances": ...,
"ResponseMetadata": ...,
}
# DBInstanceMessageTypeDef definition
class DBInstanceMessageTypeDef(TypedDict):
Marker: str,
DBInstances: List[DBInstanceTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DeleteDBInstanceResultTypeDef#
# DeleteDBInstanceResultTypeDef usage example
from mypy_boto3_docdb.type_defs import DeleteDBInstanceResultTypeDef
def get_value() -> DeleteDBInstanceResultTypeDef:
return {
"DBInstance": ...,
"ResponseMetadata": ...,
}
# DeleteDBInstanceResultTypeDef definition
class DeleteDBInstanceResultTypeDef(TypedDict):
DBInstance: DBInstanceTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ModifyDBInstanceResultTypeDef#
# ModifyDBInstanceResultTypeDef usage example
from mypy_boto3_docdb.type_defs import ModifyDBInstanceResultTypeDef
def get_value() -> ModifyDBInstanceResultTypeDef:
return {
"DBInstance": ...,
"ResponseMetadata": ...,
}
# ModifyDBInstanceResultTypeDef definition
class ModifyDBInstanceResultTypeDef(TypedDict):
DBInstance: DBInstanceTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
RebootDBInstanceResultTypeDef#
# RebootDBInstanceResultTypeDef usage example
from mypy_boto3_docdb.type_defs import RebootDBInstanceResultTypeDef
def get_value() -> RebootDBInstanceResultTypeDef:
return {
"DBInstance": ...,
"ResponseMetadata": ...,
}
# RebootDBInstanceResultTypeDef definition
class RebootDBInstanceResultTypeDef(TypedDict):
DBInstance: DBInstanceTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)