Typed dictionaries
Auto-generated documentation for RDS type annotations stubs module mypy-boto3-rds.
AccountQuotaTypeDef
Usage Example
from mypy_boto3_rds.type_defs import AccountQuotaTypeDef
def get_value() -> AccountQuotaTypeDef:
return {
"AccountQuotaName": ...,
}
Definition
class AccountQuotaTypeDef(TypedDict):
AccountQuotaName: NotRequired[str],
Used: NotRequired[int],
Max: NotRequired[int],
ResponseMetadataTypeDef
Usage Example
from mypy_boto3_rds.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,
AddRoleToDBClusterMessageRequestTypeDef
Usage Example
from mypy_boto3_rds.type_defs import AddRoleToDBClusterMessageRequestTypeDef
def get_value() -> AddRoleToDBClusterMessageRequestTypeDef:
return {
"DBClusterIdentifier": ...,
"RoleArn": ...,
}
Definition
class AddRoleToDBClusterMessageRequestTypeDef(TypedDict):
DBClusterIdentifier: str,
RoleArn: str,
FeatureName: NotRequired[str],
AddRoleToDBInstanceMessageRequestTypeDef
Usage Example
from mypy_boto3_rds.type_defs import AddRoleToDBInstanceMessageRequestTypeDef
def get_value() -> AddRoleToDBInstanceMessageRequestTypeDef:
return {
"DBInstanceIdentifier": ...,
"RoleArn": ...,
"FeatureName": ...,
}
Definition
class AddRoleToDBInstanceMessageRequestTypeDef(TypedDict):
DBInstanceIdentifier: str,
RoleArn: str,
FeatureName: str,
AddSourceIdentifierToSubscriptionMessageRequestTypeDef
Usage Example
from mypy_boto3_rds.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_rds.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],
TagTypeDef
Usage Example
from mypy_boto3_rds.type_defs import TagTypeDef
def get_value() -> TagTypeDef:
return {
"Key": ...,
}
ApplyPendingMaintenanceActionMessageRequestTypeDef
Usage Example
from mypy_boto3_rds.type_defs import ApplyPendingMaintenanceActionMessageRequestTypeDef
def get_value() -> ApplyPendingMaintenanceActionMessageRequestTypeDef:
return {
"ResourceIdentifier": ...,
"ApplyAction": ...,
"OptInType": ...,
}
Definition
class ApplyPendingMaintenanceActionMessageRequestTypeDef(TypedDict):
ResourceIdentifier: str,
ApplyAction: str,
OptInType: str,
AuthorizeDBSecurityGroupIngressMessageRequestTypeDef
Usage Example
from mypy_boto3_rds.type_defs import AuthorizeDBSecurityGroupIngressMessageRequestTypeDef
def get_value() -> AuthorizeDBSecurityGroupIngressMessageRequestTypeDef:
return {
"DBSecurityGroupName": ...,
}
Definition
class AuthorizeDBSecurityGroupIngressMessageRequestTypeDef(TypedDict):
DBSecurityGroupName: str,
CIDRIP: NotRequired[str],
EC2SecurityGroupName: NotRequired[str],
EC2SecurityGroupId: NotRequired[str],
EC2SecurityGroupOwnerId: NotRequired[str],
AvailabilityZoneTypeDef
Usage Example
from mypy_boto3_rds.type_defs import AvailabilityZoneTypeDef
def get_value() -> AvailabilityZoneTypeDef:
return {
"Name": ...,
}
AvailableProcessorFeatureTypeDef
Usage Example
from mypy_boto3_rds.type_defs import AvailableProcessorFeatureTypeDef
def get_value() -> AvailableProcessorFeatureTypeDef:
return {
"Name": ...,
}
Definition
class AvailableProcessorFeatureTypeDef(TypedDict):
Name: NotRequired[str],
DefaultValue: NotRequired[str],
AllowedValues: NotRequired[str],
BacktrackDBClusterMessageRequestTypeDef
Usage Example
from mypy_boto3_rds.type_defs import BacktrackDBClusterMessageRequestTypeDef
def get_value() -> BacktrackDBClusterMessageRequestTypeDef:
return {
"DBClusterIdentifier": ...,
"BacktrackTo": ...,
}
Definition
class BacktrackDBClusterMessageRequestTypeDef(TypedDict):
DBClusterIdentifier: str,
BacktrackTo: Union[datetime, str],
Force: NotRequired[bool],
UseEarliestTimeOnPointInTimeUnavailable: NotRequired[bool],
BlueGreenDeploymentTaskTypeDef
Usage Example
from mypy_boto3_rds.type_defs import BlueGreenDeploymentTaskTypeDef
def get_value() -> BlueGreenDeploymentTaskTypeDef:
return {
"Name": ...,
}
Definition
class BlueGreenDeploymentTaskTypeDef(TypedDict):
Name: NotRequired[str],
Status: NotRequired[str],
SwitchoverDetailTypeDef
Usage Example
from mypy_boto3_rds.type_defs import SwitchoverDetailTypeDef
def get_value() -> SwitchoverDetailTypeDef:
return {
"SourceMember": ...,
}
Definition
class SwitchoverDetailTypeDef(TypedDict):
SourceMember: NotRequired[str],
TargetMember: NotRequired[str],
Status: NotRequired[str],
CancelExportTaskMessageRequestTypeDef
Usage Example
from mypy_boto3_rds.type_defs import CancelExportTaskMessageRequestTypeDef
def get_value() -> CancelExportTaskMessageRequestTypeDef:
return {
"ExportTaskIdentifier": ...,
}
CertificateDetailsTypeDef
Usage Example
from mypy_boto3_rds.type_defs import CertificateDetailsTypeDef
def get_value() -> CertificateDetailsTypeDef:
return {
"CAIdentifier": ...,
}
Definition
class CertificateDetailsTypeDef(TypedDict):
CAIdentifier: NotRequired[str],
ValidTill: NotRequired[datetime],
CertificateTypeDef
Usage Example
from mypy_boto3_rds.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],
CustomerOverride: NotRequired[bool],
CustomerOverrideValidTill: NotRequired[datetime],
CharacterSetTypeDef
Usage Example
from mypy_boto3_rds.type_defs import CharacterSetTypeDef
def get_value() -> CharacterSetTypeDef:
return {
"CharacterSetName": ...,
}
Definition
class CharacterSetTypeDef(TypedDict):
CharacterSetName: NotRequired[str],
CharacterSetDescription: NotRequired[str],
ClientGenerateDbAuthTokenRequestTypeDef
Usage Example
from mypy_boto3_rds.type_defs import ClientGenerateDbAuthTokenRequestTypeDef
def get_value() -> ClientGenerateDbAuthTokenRequestTypeDef:
return {
"DBHostname": ...,
"Port": ...,
"DBUsername": ...,
}
Definition
class ClientGenerateDbAuthTokenRequestTypeDef(TypedDict):
DBHostname: str,
Port: int,
DBUsername: str,
Region: NotRequired[str],
CloudwatchLogsExportConfigurationTypeDef
Usage Example
from mypy_boto3_rds.type_defs import CloudwatchLogsExportConfigurationTypeDef
def get_value() -> CloudwatchLogsExportConfigurationTypeDef:
return {
"EnableLogTypes": ...,
}
Definition
class CloudwatchLogsExportConfigurationTypeDef(TypedDict):
EnableLogTypes: NotRequired[Sequence[str]],
DisableLogTypes: NotRequired[Sequence[str]],
PendingCloudwatchLogsExportsTypeDef
Usage Example
from mypy_boto3_rds.type_defs import PendingCloudwatchLogsExportsTypeDef
def get_value() -> PendingCloudwatchLogsExportsTypeDef:
return {
"LogTypesToEnable": ...,
}
Definition
class PendingCloudwatchLogsExportsTypeDef(TypedDict):
LogTypesToEnable: NotRequired[List[str]],
LogTypesToDisable: NotRequired[List[str]],
ConnectionPoolConfigurationInfoTypeDef
Usage Example
from mypy_boto3_rds.type_defs import ConnectionPoolConfigurationInfoTypeDef
def get_value() -> ConnectionPoolConfigurationInfoTypeDef:
return {
"MaxConnectionsPercent": ...,
}
Definition
class ConnectionPoolConfigurationInfoTypeDef(TypedDict):
MaxConnectionsPercent: NotRequired[int],
MaxIdleConnectionsPercent: NotRequired[int],
ConnectionBorrowTimeout: NotRequired[int],
SessionPinningFilters: NotRequired[List[str]],
InitQuery: NotRequired[str],
ConnectionPoolConfigurationTypeDef
Usage Example
from mypy_boto3_rds.type_defs import ConnectionPoolConfigurationTypeDef
def get_value() -> ConnectionPoolConfigurationTypeDef:
return {
"MaxConnectionsPercent": ...,
}
Definition
class ConnectionPoolConfigurationTypeDef(TypedDict):
MaxConnectionsPercent: NotRequired[int],
MaxIdleConnectionsPercent: NotRequired[int],
ConnectionBorrowTimeout: NotRequired[int],
SessionPinningFilters: NotRequired[Sequence[str]],
InitQuery: NotRequired[str],
DBClusterParameterGroupTypeDef
Usage Example
from mypy_boto3_rds.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],
DBParameterGroupTypeDef
Usage Example
from mypy_boto3_rds.type_defs import DBParameterGroupTypeDef
def get_value() -> DBParameterGroupTypeDef:
return {
"DBParameterGroupName": ...,
}
Definition
class DBParameterGroupTypeDef(TypedDict):
DBParameterGroupName: NotRequired[str],
DBParameterGroupFamily: NotRequired[str],
Description: NotRequired[str],
DBParameterGroupArn: NotRequired[str],
ScalingConfigurationTypeDef
Usage Example
from mypy_boto3_rds.type_defs import ScalingConfigurationTypeDef
def get_value() -> ScalingConfigurationTypeDef:
return {
"MinCapacity": ...,
}
Definition
class ScalingConfigurationTypeDef(TypedDict):
MinCapacity: NotRequired[int],
MaxCapacity: NotRequired[int],
AutoPause: NotRequired[bool],
SecondsUntilAutoPause: NotRequired[int],
TimeoutAction: NotRequired[str],
SecondsBeforeTimeout: NotRequired[int],
ServerlessV2ScalingConfigurationTypeDef
Usage Example
from mypy_boto3_rds.type_defs import ServerlessV2ScalingConfigurationTypeDef
def get_value() -> ServerlessV2ScalingConfigurationTypeDef:
return {
"MinCapacity": ...,
}
Definition
class ServerlessV2ScalingConfigurationTypeDef(TypedDict):
MinCapacity: NotRequired[float],
MaxCapacity: NotRequired[float],
ProcessorFeatureTypeDef
Usage Example
from mypy_boto3_rds.type_defs import ProcessorFeatureTypeDef
def get_value() -> ProcessorFeatureTypeDef:
return {
"Name": ...,
}
Definition
class ProcessorFeatureTypeDef(TypedDict):
Name: NotRequired[str],
Value: NotRequired[str],
DBProxyEndpointTypeDef
Usage Example
from mypy_boto3_rds.type_defs import DBProxyEndpointTypeDef
def get_value() -> DBProxyEndpointTypeDef:
return {
"DBProxyEndpointName": ...,
}
Definition
class DBProxyEndpointTypeDef(TypedDict):
DBProxyEndpointName: NotRequired[str],
DBProxyEndpointArn: NotRequired[str],
DBProxyName: NotRequired[str],
Status: NotRequired[DBProxyEndpointStatusType], # (1)
VpcId: NotRequired[str],
VpcSecurityGroupIds: NotRequired[List[str]],
VpcSubnetIds: NotRequired[List[str]],
Endpoint: NotRequired[str],
CreatedDate: NotRequired[datetime],
TargetRole: NotRequired[DBProxyEndpointTargetRoleType], # (2)
IsDefault: NotRequired[bool],
UserAuthConfigTypeDef
Usage Example
from mypy_boto3_rds.type_defs import UserAuthConfigTypeDef
def get_value() -> UserAuthConfigTypeDef:
return {
"Description": ...,
}
Definition
class UserAuthConfigTypeDef(TypedDict):
Description: NotRequired[str],
UserName: NotRequired[str],
AuthScheme: NotRequired[AuthSchemeType], # (1)
SecretArn: NotRequired[str],
IAMAuth: NotRequired[IAMAuthModeType], # (2)
ClientPasswordAuthType: NotRequired[ClientPasswordAuthTypeType], # (3)
- See AuthSchemeType
- See IAMAuthModeType
- See ClientPasswordAuthTypeType
CreateGlobalClusterMessageRequestTypeDef
Usage Example
from mypy_boto3_rds.type_defs import CreateGlobalClusterMessageRequestTypeDef
def get_value() -> CreateGlobalClusterMessageRequestTypeDef:
return {
"GlobalClusterIdentifier": ...,
}
Definition
class CreateGlobalClusterMessageRequestTypeDef(TypedDict):
GlobalClusterIdentifier: NotRequired[str],
SourceDBClusterIdentifier: NotRequired[str],
Engine: NotRequired[str],
EngineVersion: NotRequired[str],
DeletionProtection: NotRequired[bool],
DatabaseName: NotRequired[str],
StorageEncrypted: NotRequired[bool],
CustomDBEngineVersionAMITypeDef
Usage Example
from mypy_boto3_rds.type_defs import CustomDBEngineVersionAMITypeDef
def get_value() -> CustomDBEngineVersionAMITypeDef:
return {
"ImageId": ...,
}
Definition
class CustomDBEngineVersionAMITypeDef(TypedDict):
ImageId: NotRequired[str],
Status: NotRequired[str],
DBClusterBacktrackTypeDef
Usage Example
from mypy_boto3_rds.type_defs import DBClusterBacktrackTypeDef
def get_value() -> DBClusterBacktrackTypeDef:
return {
"DBClusterIdentifier": ...,
}
Definition
class DBClusterBacktrackTypeDef(TypedDict):
DBClusterIdentifier: NotRequired[str],
BacktrackIdentifier: NotRequired[str],
BacktrackTo: NotRequired[datetime],
BacktrackedFrom: NotRequired[datetime],
BacktrackRequestCreationTime: NotRequired[datetime],
Status: NotRequired[str],
DBClusterEndpointTypeDef
Usage Example
from mypy_boto3_rds.type_defs import DBClusterEndpointTypeDef
def get_value() -> DBClusterEndpointTypeDef:
return {
"DBClusterEndpointIdentifier": ...,
}
Definition
class DBClusterEndpointTypeDef(TypedDict):
DBClusterEndpointIdentifier: NotRequired[str],
DBClusterIdentifier: NotRequired[str],
DBClusterEndpointResourceIdentifier: NotRequired[str],
Endpoint: NotRequired[str],
Status: NotRequired[str],
EndpointType: NotRequired[str],
CustomEndpointType: NotRequired[str],
StaticMembers: NotRequired[List[str]],
ExcludedMembers: NotRequired[List[str]],
DBClusterEndpointArn: NotRequired[str],
DBClusterMemberTypeDef
Usage Example
from mypy_boto3_rds.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],
DBClusterOptionGroupStatusTypeDef
Usage Example
from mypy_boto3_rds.type_defs import DBClusterOptionGroupStatusTypeDef
def get_value() -> DBClusterOptionGroupStatusTypeDef:
return {
"DBClusterOptionGroupName": ...,
}
Definition
class DBClusterOptionGroupStatusTypeDef(TypedDict):
DBClusterOptionGroupName: NotRequired[str],
Status: NotRequired[str],
ParameterTypeDef
Usage Example
from mypy_boto3_rds.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)
SupportedEngineModes: NotRequired[List[str]],
- See ApplyMethodType
DBClusterRoleTypeDef
Usage Example
from mypy_boto3_rds.type_defs import DBClusterRoleTypeDef
def get_value() -> DBClusterRoleTypeDef:
return {
"RoleArn": ...,
}
Definition
class DBClusterRoleTypeDef(TypedDict):
RoleArn: NotRequired[str],
Status: NotRequired[str],
FeatureName: NotRequired[str],
DBClusterSnapshotAttributeTypeDef
Usage Example
from mypy_boto3_rds.type_defs import DBClusterSnapshotAttributeTypeDef
def get_value() -> DBClusterSnapshotAttributeTypeDef:
return {
"AttributeName": ...,
}
Definition
class DBClusterSnapshotAttributeTypeDef(TypedDict):
AttributeName: NotRequired[str],
AttributeValues: NotRequired[List[str]],
DomainMembershipTypeDef
Usage Example
from mypy_boto3_rds.type_defs import DomainMembershipTypeDef
def get_value() -> DomainMembershipTypeDef:
return {
"Domain": ...,
}
Definition
class DomainMembershipTypeDef(TypedDict):
Domain: NotRequired[str],
Status: NotRequired[str],
FQDN: NotRequired[str],
IAMRoleName: NotRequired[str],
MasterUserSecretTypeDef
Usage Example
from mypy_boto3_rds.type_defs import MasterUserSecretTypeDef
def get_value() -> MasterUserSecretTypeDef:
return {
"SecretArn": ...,
}
Definition
class MasterUserSecretTypeDef(TypedDict):
SecretArn: NotRequired[str],
SecretStatus: NotRequired[str],
KmsKeyId: NotRequired[str],
ScalingConfigurationInfoTypeDef
Usage Example
from mypy_boto3_rds.type_defs import ScalingConfigurationInfoTypeDef
def get_value() -> ScalingConfigurationInfoTypeDef:
return {
"MinCapacity": ...,
}
Definition
class ScalingConfigurationInfoTypeDef(TypedDict):
MinCapacity: NotRequired[int],
MaxCapacity: NotRequired[int],
AutoPause: NotRequired[bool],
SecondsUntilAutoPause: NotRequired[int],
TimeoutAction: NotRequired[str],
SecondsBeforeTimeout: NotRequired[int],
ServerlessV2ScalingConfigurationInfoTypeDef
Usage Example
from mypy_boto3_rds.type_defs import ServerlessV2ScalingConfigurationInfoTypeDef
def get_value() -> ServerlessV2ScalingConfigurationInfoTypeDef:
return {
"MinCapacity": ...,
}
Definition
class ServerlessV2ScalingConfigurationInfoTypeDef(TypedDict):
MinCapacity: NotRequired[float],
MaxCapacity: NotRequired[float],
VpcSecurityGroupMembershipTypeDef
Usage Example
from mypy_boto3_rds.type_defs import VpcSecurityGroupMembershipTypeDef
def get_value() -> VpcSecurityGroupMembershipTypeDef:
return {
"VpcSecurityGroupId": ...,
}
Definition
class VpcSecurityGroupMembershipTypeDef(TypedDict):
VpcSecurityGroupId: NotRequired[str],
Status: NotRequired[str],
TimezoneTypeDef
Usage Example
from mypy_boto3_rds.type_defs import TimezoneTypeDef
def get_value() -> TimezoneTypeDef:
return {
"TimezoneName": ...,
}
UpgradeTargetTypeDef
Usage Example
from mypy_boto3_rds.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],
SupportedEngineModes: NotRequired[List[str]],
SupportsParallelQuery: NotRequired[bool],
SupportsGlobalDatabases: NotRequired[bool],
SupportsBabelfish: NotRequired[bool],
DBInstanceAutomatedBackupsReplicationTypeDef
Usage Example
from mypy_boto3_rds.type_defs import DBInstanceAutomatedBackupsReplicationTypeDef
def get_value() -> DBInstanceAutomatedBackupsReplicationTypeDef:
return {
"DBInstanceAutomatedBackupsArn": ...,
}
Definition
class DBInstanceAutomatedBackupsReplicationTypeDef(TypedDict):
DBInstanceAutomatedBackupsArn: NotRequired[str],
RestoreWindowTypeDef
Usage Example
from mypy_boto3_rds.type_defs import RestoreWindowTypeDef
def get_value() -> RestoreWindowTypeDef:
return {
"EarliestTime": ...,
}
Definition
class RestoreWindowTypeDef(TypedDict):
EarliestTime: NotRequired[datetime],
LatestTime: NotRequired[datetime],
DBInstanceRoleTypeDef
Usage Example
from mypy_boto3_rds.type_defs import DBInstanceRoleTypeDef
def get_value() -> DBInstanceRoleTypeDef:
return {
"RoleArn": ...,
}
Definition
class DBInstanceRoleTypeDef(TypedDict):
RoleArn: NotRequired[str],
FeatureName: NotRequired[str],
Status: NotRequired[str],
DBInstanceStatusInfoTypeDef
Usage Example
from mypy_boto3_rds.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],
DBParameterGroupStatusTypeDef
Usage Example
from mypy_boto3_rds.type_defs import DBParameterGroupStatusTypeDef
def get_value() -> DBParameterGroupStatusTypeDef:
return {
"DBParameterGroupName": ...,
}
Definition
class DBParameterGroupStatusTypeDef(TypedDict):
DBParameterGroupName: NotRequired[str],
ParameterApplyStatus: NotRequired[str],
DBSecurityGroupMembershipTypeDef
Usage Example
from mypy_boto3_rds.type_defs import DBSecurityGroupMembershipTypeDef
def get_value() -> DBSecurityGroupMembershipTypeDef:
return {
"DBSecurityGroupName": ...,
}
Definition
class DBSecurityGroupMembershipTypeDef(TypedDict):
DBSecurityGroupName: NotRequired[str],
Status: NotRequired[str],
EndpointTypeDef
Usage Example
from mypy_boto3_rds.type_defs import EndpointTypeDef
def get_value() -> EndpointTypeDef:
return {
"Address": ...,
}
Definition
class EndpointTypeDef(TypedDict):
Address: NotRequired[str],
Port: NotRequired[int],
HostedZoneId: NotRequired[str],
OptionGroupMembershipTypeDef
Usage Example
from mypy_boto3_rds.type_defs import OptionGroupMembershipTypeDef
def get_value() -> OptionGroupMembershipTypeDef:
return {
"OptionGroupName": ...,
}
Definition
class OptionGroupMembershipTypeDef(TypedDict):
OptionGroupName: NotRequired[str],
Status: NotRequired[str],
TargetHealthTypeDef
Usage Example
from mypy_boto3_rds.type_defs import TargetHealthTypeDef
def get_value() -> TargetHealthTypeDef:
return {
"State": ...,
}
Definition
class TargetHealthTypeDef(TypedDict):
State: NotRequired[TargetStateType], # (1)
Reason: NotRequired[TargetHealthReasonType], # (2)
Description: NotRequired[str],
UserAuthConfigInfoTypeDef
Usage Example
from mypy_boto3_rds.type_defs import UserAuthConfigInfoTypeDef
def get_value() -> UserAuthConfigInfoTypeDef:
return {
"Description": ...,
}
Definition
class UserAuthConfigInfoTypeDef(TypedDict):
Description: NotRequired[str],
UserName: NotRequired[str],
AuthScheme: NotRequired[AuthSchemeType], # (1)
SecretArn: NotRequired[str],
IAMAuth: NotRequired[IAMAuthModeType], # (2)
ClientPasswordAuthType: NotRequired[ClientPasswordAuthTypeType], # (3)
- See AuthSchemeType
- See IAMAuthModeType
- See ClientPasswordAuthTypeType
EC2SecurityGroupTypeDef
Usage Example
from mypy_boto3_rds.type_defs import EC2SecurityGroupTypeDef
def get_value() -> EC2SecurityGroupTypeDef:
return {
"Status": ...,
}
Definition
class EC2SecurityGroupTypeDef(TypedDict):
Status: NotRequired[str],
EC2SecurityGroupName: NotRequired[str],
EC2SecurityGroupId: NotRequired[str],
EC2SecurityGroupOwnerId: NotRequired[str],
IPRangeTypeDef
Usage Example
from mypy_boto3_rds.type_defs import IPRangeTypeDef
def get_value() -> IPRangeTypeDef:
return {
"Status": ...,
}
DBSnapshotAttributeTypeDef
Usage Example
from mypy_boto3_rds.type_defs import DBSnapshotAttributeTypeDef
def get_value() -> DBSnapshotAttributeTypeDef:
return {
"AttributeName": ...,
}
Definition
class DBSnapshotAttributeTypeDef(TypedDict):
AttributeName: NotRequired[str],
AttributeValues: NotRequired[List[str]],
DeleteBlueGreenDeploymentRequestRequestTypeDef
Usage Example
from mypy_boto3_rds.type_defs import DeleteBlueGreenDeploymentRequestRequestTypeDef
def get_value() -> DeleteBlueGreenDeploymentRequestRequestTypeDef:
return {
"BlueGreenDeploymentIdentifier": ...,
}
Definition
class DeleteBlueGreenDeploymentRequestRequestTypeDef(TypedDict):
BlueGreenDeploymentIdentifier: str,
DeleteTarget: NotRequired[bool],
DeleteCustomDBEngineVersionMessageRequestTypeDef
Usage Example
from mypy_boto3_rds.type_defs import DeleteCustomDBEngineVersionMessageRequestTypeDef
def get_value() -> DeleteCustomDBEngineVersionMessageRequestTypeDef:
return {
"Engine": ...,
"EngineVersion": ...,
}
Definition
class DeleteCustomDBEngineVersionMessageRequestTypeDef(TypedDict):
Engine: str,
EngineVersion: str,
DeleteDBClusterEndpointMessageRequestTypeDef
Usage Example
from mypy_boto3_rds.type_defs import DeleteDBClusterEndpointMessageRequestTypeDef
def get_value() -> DeleteDBClusterEndpointMessageRequestTypeDef:
return {
"DBClusterEndpointIdentifier": ...,
}
Definition
class DeleteDBClusterEndpointMessageRequestTypeDef(TypedDict):
DBClusterEndpointIdentifier: str,
DeleteDBClusterMessageRequestTypeDef
Usage Example
from mypy_boto3_rds.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_rds.type_defs import DeleteDBClusterParameterGroupMessageRequestTypeDef
def get_value() -> DeleteDBClusterParameterGroupMessageRequestTypeDef:
return {
"DBClusterParameterGroupName": ...,
}
Definition
class DeleteDBClusterParameterGroupMessageRequestTypeDef(TypedDict):
DBClusterParameterGroupName: str,
DeleteDBClusterSnapshotMessageRequestTypeDef
Usage Example
from mypy_boto3_rds.type_defs import DeleteDBClusterSnapshotMessageRequestTypeDef
def get_value() -> DeleteDBClusterSnapshotMessageRequestTypeDef:
return {
"DBClusterSnapshotIdentifier": ...,
}
Definition
class DeleteDBClusterSnapshotMessageRequestTypeDef(TypedDict):
DBClusterSnapshotIdentifier: str,
DeleteDBInstanceAutomatedBackupMessageRequestTypeDef
Usage Example
from mypy_boto3_rds.type_defs import DeleteDBInstanceAutomatedBackupMessageRequestTypeDef
def get_value() -> DeleteDBInstanceAutomatedBackupMessageRequestTypeDef:
return {
"DbiResourceId": ...,
}
Definition
class DeleteDBInstanceAutomatedBackupMessageRequestTypeDef(TypedDict):
DbiResourceId: NotRequired[str],
DBInstanceAutomatedBackupsArn: NotRequired[str],
DeleteDBInstanceMessageRequestTypeDef
Usage Example
from mypy_boto3_rds.type_defs import DeleteDBInstanceMessageRequestTypeDef
def get_value() -> DeleteDBInstanceMessageRequestTypeDef:
return {
"DBInstanceIdentifier": ...,
}
Definition
class DeleteDBInstanceMessageRequestTypeDef(TypedDict):
DBInstanceIdentifier: str,
SkipFinalSnapshot: NotRequired[bool],
FinalDBSnapshotIdentifier: NotRequired[str],
DeleteAutomatedBackups: NotRequired[bool],
DeleteDBParameterGroupMessageRequestTypeDef
Usage Example
from mypy_boto3_rds.type_defs import DeleteDBParameterGroupMessageRequestTypeDef
def get_value() -> DeleteDBParameterGroupMessageRequestTypeDef:
return {
"DBParameterGroupName": ...,
}
DeleteDBProxyEndpointRequestRequestTypeDef
Usage Example
from mypy_boto3_rds.type_defs import DeleteDBProxyEndpointRequestRequestTypeDef
def get_value() -> DeleteDBProxyEndpointRequestRequestTypeDef:
return {
"DBProxyEndpointName": ...,
}
DeleteDBProxyRequestRequestTypeDef
Usage Example
from mypy_boto3_rds.type_defs import DeleteDBProxyRequestRequestTypeDef
def get_value() -> DeleteDBProxyRequestRequestTypeDef:
return {
"DBProxyName": ...,
}
DeleteDBSecurityGroupMessageRequestTypeDef
Usage Example
from mypy_boto3_rds.type_defs import DeleteDBSecurityGroupMessageRequestTypeDef
def get_value() -> DeleteDBSecurityGroupMessageRequestTypeDef:
return {
"DBSecurityGroupName": ...,
}
DeleteDBSnapshotMessageRequestTypeDef
Usage Example
from mypy_boto3_rds.type_defs import DeleteDBSnapshotMessageRequestTypeDef
def get_value() -> DeleteDBSnapshotMessageRequestTypeDef:
return {
"DBSnapshotIdentifier": ...,
}
DeleteDBSubnetGroupMessageRequestTypeDef
Usage Example
from mypy_boto3_rds.type_defs import DeleteDBSubnetGroupMessageRequestTypeDef
def get_value() -> DeleteDBSubnetGroupMessageRequestTypeDef:
return {
"DBSubnetGroupName": ...,
}
DeleteEventSubscriptionMessageRequestTypeDef
Usage Example
from mypy_boto3_rds.type_defs import DeleteEventSubscriptionMessageRequestTypeDef
def get_value() -> DeleteEventSubscriptionMessageRequestTypeDef:
return {
"SubscriptionName": ...,
}
DeleteGlobalClusterMessageRequestTypeDef
Usage Example
from mypy_boto3_rds.type_defs import DeleteGlobalClusterMessageRequestTypeDef
def get_value() -> DeleteGlobalClusterMessageRequestTypeDef:
return {
"GlobalClusterIdentifier": ...,
}
DeleteOptionGroupMessageRequestTypeDef
Usage Example
from mypy_boto3_rds.type_defs import DeleteOptionGroupMessageRequestTypeDef
def get_value() -> DeleteOptionGroupMessageRequestTypeDef:
return {
"OptionGroupName": ...,
}
DeregisterDBProxyTargetsRequestRequestTypeDef
Usage Example
from mypy_boto3_rds.type_defs import DeregisterDBProxyTargetsRequestRequestTypeDef
def get_value() -> DeregisterDBProxyTargetsRequestRequestTypeDef:
return {
"DBProxyName": ...,
}
Definition
class DeregisterDBProxyTargetsRequestRequestTypeDef(TypedDict):
DBProxyName: str,
TargetGroupName: NotRequired[str],
DBInstanceIdentifiers: NotRequired[Sequence[str]],
DBClusterIdentifiers: NotRequired[Sequence[str]],
FilterTypeDef
Usage Example
from mypy_boto3_rds.type_defs import FilterTypeDef
def get_value() -> FilterTypeDef:
return {
"Name": ...,
"Values": ...,
}