Typed dictionaries#
Index > RDSDataService > Typed dictionaries
Auto-generated documentation for RDSDataService type annotations stubs module mypy-boto3-rds-data.
ArrayValueTypeDef#
# ArrayValueTypeDef usage example
from mypy_boto3_rds_data.type_defs import ArrayValueTypeDef
def get_value() -> ArrayValueTypeDef:
return {
"booleanValues": ...,
}
# ArrayValueTypeDef definition
class ArrayValueTypeDef(TypedDict):
booleanValues: NotRequired[Sequence[bool]],
longValues: NotRequired[Sequence[int]],
doubleValues: NotRequired[Sequence[float]],
stringValues: NotRequired[Sequence[str]],
arrayValues: NotRequired[Sequence[ArrayValueTypeDef]], # (1)
BeginTransactionRequestRequestTypeDef#
# BeginTransactionRequestRequestTypeDef usage example
from mypy_boto3_rds_data.type_defs import BeginTransactionRequestRequestTypeDef
def get_value() -> BeginTransactionRequestRequestTypeDef:
return {
"resourceArn": ...,
"secretArn": ...,
}
# BeginTransactionRequestRequestTypeDef definition
class BeginTransactionRequestRequestTypeDef(TypedDict):
resourceArn: str,
secretArn: str,
database: NotRequired[str],
schema: NotRequired[str],
BeginTransactionResponseTypeDef#
# BeginTransactionResponseTypeDef usage example
from mypy_boto3_rds_data.type_defs import BeginTransactionResponseTypeDef
def get_value() -> BeginTransactionResponseTypeDef:
return {
"transactionId": ...,
"ResponseMetadata": ...,
}
# BeginTransactionResponseTypeDef definition
class BeginTransactionResponseTypeDef(TypedDict):
transactionId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ColumnMetadataTypeDef#
# ColumnMetadataTypeDef usage example
from mypy_boto3_rds_data.type_defs import ColumnMetadataTypeDef
def get_value() -> ColumnMetadataTypeDef:
return {
"name": ...,
}
# ColumnMetadataTypeDef definition
class ColumnMetadataTypeDef(TypedDict):
name: NotRequired[str],
type: NotRequired[int],
typeName: NotRequired[str],
label: NotRequired[str],
schemaName: NotRequired[str],
tableName: NotRequired[str],
isAutoIncrement: NotRequired[bool],
isSigned: NotRequired[bool],
isCurrency: NotRequired[bool],
isCaseSensitive: NotRequired[bool],
nullable: NotRequired[int],
precision: NotRequired[int],
scale: NotRequired[int],
arrayBaseColumnType: NotRequired[int],
CommitTransactionRequestRequestTypeDef#
# CommitTransactionRequestRequestTypeDef usage example
from mypy_boto3_rds_data.type_defs import CommitTransactionRequestRequestTypeDef
def get_value() -> CommitTransactionRequestRequestTypeDef:
return {
"resourceArn": ...,
"secretArn": ...,
"transactionId": ...,
}
# CommitTransactionRequestRequestTypeDef definition
class CommitTransactionRequestRequestTypeDef(TypedDict):
resourceArn: str,
secretArn: str,
transactionId: str,
CommitTransactionResponseTypeDef#
# CommitTransactionResponseTypeDef usage example
from mypy_boto3_rds_data.type_defs import CommitTransactionResponseTypeDef
def get_value() -> CommitTransactionResponseTypeDef:
return {
"transactionStatus": ...,
"ResponseMetadata": ...,
}
# CommitTransactionResponseTypeDef definition
class CommitTransactionResponseTypeDef(TypedDict):
transactionStatus: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ExecuteSqlRequestRequestTypeDef#
# ExecuteSqlRequestRequestTypeDef usage example
from mypy_boto3_rds_data.type_defs import ExecuteSqlRequestRequestTypeDef
def get_value() -> ExecuteSqlRequestRequestTypeDef:
return {
"dbClusterOrInstanceArn": ...,
"awsSecretStoreArn": ...,
"sqlStatements": ...,
}
# ExecuteSqlRequestRequestTypeDef definition
class ExecuteSqlRequestRequestTypeDef(TypedDict):
dbClusterOrInstanceArn: str,
awsSecretStoreArn: str,
sqlStatements: str,
database: NotRequired[str],
schema: NotRequired[str],
ResultSetOptionsTypeDef#
# ResultSetOptionsTypeDef usage example
from mypy_boto3_rds_data.type_defs import ResultSetOptionsTypeDef
def get_value() -> ResultSetOptionsTypeDef:
return {
"decimalReturnType": ...,
}
# ResultSetOptionsTypeDef definition
class ResultSetOptionsTypeDef(TypedDict):
decimalReturnType: NotRequired[DecimalReturnTypeType], # (1)
longReturnType: NotRequired[LongReturnTypeType], # (2)
FieldTypeDef#
# FieldTypeDef usage example
from mypy_boto3_rds_data.type_defs import FieldTypeDef
def get_value() -> FieldTypeDef:
return {
"isNull": ...,
}
# FieldTypeDef definition
class FieldTypeDef(TypedDict):
isNull: NotRequired[bool],
booleanValue: NotRequired[bool],
longValue: NotRequired[int],
doubleValue: NotRequired[float],
stringValue: NotRequired[str],
blobValue: NotRequired[Union[str, bytes, IO[Any], StreamingBody]],
arrayValue: NotRequired[ArrayValueTypeDef], # (1)
RecordTypeDef#
# RecordTypeDef usage example
from mypy_boto3_rds_data.type_defs import RecordTypeDef
def get_value() -> RecordTypeDef:
return {
"values": ...,
}
# RecordTypeDef definition
class RecordTypeDef(TypedDict):
values: NotRequired[List[ValueTypeDef]], # (1)
- See ValueTypeDef
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef usage example
from mypy_boto3_rds_data.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,
RollbackTransactionRequestRequestTypeDef#
# RollbackTransactionRequestRequestTypeDef usage example
from mypy_boto3_rds_data.type_defs import RollbackTransactionRequestRequestTypeDef
def get_value() -> RollbackTransactionRequestRequestTypeDef:
return {
"resourceArn": ...,
"secretArn": ...,
"transactionId": ...,
}
# RollbackTransactionRequestRequestTypeDef definition
class RollbackTransactionRequestRequestTypeDef(TypedDict):
resourceArn: str,
secretArn: str,
transactionId: str,
RollbackTransactionResponseTypeDef#
# RollbackTransactionResponseTypeDef usage example
from mypy_boto3_rds_data.type_defs import RollbackTransactionResponseTypeDef
def get_value() -> RollbackTransactionResponseTypeDef:
return {
"transactionStatus": ...,
"ResponseMetadata": ...,
}
# RollbackTransactionResponseTypeDef definition
class RollbackTransactionResponseTypeDef(TypedDict):
transactionStatus: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
StructValueTypeDef#
# StructValueTypeDef usage example
from mypy_boto3_rds_data.type_defs import StructValueTypeDef
def get_value() -> StructValueTypeDef:
return {
"attributes": ...,
}
# StructValueTypeDef definition
class StructValueTypeDef(TypedDict):
attributes: NotRequired[List[ValueTypeDef]], # (1)
- See ValueTypeDef
ValueTypeDef#
# ValueTypeDef usage example
from mypy_boto3_rds_data.type_defs import ValueTypeDef
def get_value() -> ValueTypeDef:
return {
"isNull": ...,
}
# ValueTypeDef definition
class ValueTypeDef(TypedDict):
isNull: NotRequired[bool],
bitValue: NotRequired[bool],
bigIntValue: NotRequired[int],
intValue: NotRequired[int],
doubleValue: NotRequired[float],
realValue: NotRequired[float],
stringValue: NotRequired[str],
blobValue: NotRequired[bytes],
arrayValues: NotRequired[List[ValueTypeDef]], # (1)
structValue: NotRequired[StructValueTypeDef], # (2)
- See ValueTypeDef
- See StructValueTypeDef
ResultSetMetadataTypeDef#
# ResultSetMetadataTypeDef usage example
from mypy_boto3_rds_data.type_defs import ResultSetMetadataTypeDef
def get_value() -> ResultSetMetadataTypeDef:
return {
"columnCount": ...,
}
# ResultSetMetadataTypeDef definition
class ResultSetMetadataTypeDef(TypedDict):
columnCount: NotRequired[int],
columnMetadata: NotRequired[List[ColumnMetadataTypeDef]], # (1)
ExecuteStatementResponseTypeDef#
# ExecuteStatementResponseTypeDef usage example
from mypy_boto3_rds_data.type_defs import ExecuteStatementResponseTypeDef
def get_value() -> ExecuteStatementResponseTypeDef:
return {
"records": ...,
"columnMetadata": ...,
"numberOfRecordsUpdated": ...,
"generatedFields": ...,
"formattedRecords": ...,
"ResponseMetadata": ...,
}
# ExecuteStatementResponseTypeDef definition
class ExecuteStatementResponseTypeDef(TypedDict):
records: List[List[FieldTypeDef]], # (1)
columnMetadata: List[ColumnMetadataTypeDef], # (2)
numberOfRecordsUpdated: int,
generatedFields: List[FieldTypeDef], # (3)
formattedRecords: str,
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See FieldTypeDef
- See ColumnMetadataTypeDef
- See FieldTypeDef
- See ResponseMetadataTypeDef
SqlParameterTypeDef#
# SqlParameterTypeDef usage example
from mypy_boto3_rds_data.type_defs import SqlParameterTypeDef
def get_value() -> SqlParameterTypeDef:
return {
"name": ...,
}
# SqlParameterTypeDef definition
class SqlParameterTypeDef(TypedDict):
name: NotRequired[str],
value: NotRequired[FieldTypeDef], # (1)
typeHint: NotRequired[TypeHintType], # (2)
- See FieldTypeDef
- See TypeHintType
UpdateResultTypeDef#
# UpdateResultTypeDef usage example
from mypy_boto3_rds_data.type_defs import UpdateResultTypeDef
def get_value() -> UpdateResultTypeDef:
return {
"generatedFields": ...,
}
# UpdateResultTypeDef definition
class UpdateResultTypeDef(TypedDict):
generatedFields: NotRequired[List[FieldTypeDef]], # (1)
- See FieldTypeDef
ResultFrameTypeDef#
# ResultFrameTypeDef usage example
from mypy_boto3_rds_data.type_defs import ResultFrameTypeDef
def get_value() -> ResultFrameTypeDef:
return {
"resultSetMetadata": ...,
}
# ResultFrameTypeDef definition
class ResultFrameTypeDef(TypedDict):
resultSetMetadata: NotRequired[ResultSetMetadataTypeDef], # (1)
records: NotRequired[List[RecordTypeDef]], # (2)
BatchExecuteStatementRequestRequestTypeDef#
# BatchExecuteStatementRequestRequestTypeDef usage example
from mypy_boto3_rds_data.type_defs import BatchExecuteStatementRequestRequestTypeDef
def get_value() -> BatchExecuteStatementRequestRequestTypeDef:
return {
"resourceArn": ...,
"secretArn": ...,
"sql": ...,
}
# BatchExecuteStatementRequestRequestTypeDef definition
class BatchExecuteStatementRequestRequestTypeDef(TypedDict):
resourceArn: str,
secretArn: str,
sql: str,
database: NotRequired[str],
schema: NotRequired[str],
parameterSets: NotRequired[Sequence[Sequence[SqlParameterTypeDef]]], # (1)
transactionId: NotRequired[str],
ExecuteStatementRequestRequestTypeDef#
# ExecuteStatementRequestRequestTypeDef usage example
from mypy_boto3_rds_data.type_defs import ExecuteStatementRequestRequestTypeDef
def get_value() -> ExecuteStatementRequestRequestTypeDef:
return {
"resourceArn": ...,
"secretArn": ...,
"sql": ...,
}
# ExecuteStatementRequestRequestTypeDef definition
class ExecuteStatementRequestRequestTypeDef(TypedDict):
resourceArn: str,
secretArn: str,
sql: str,
database: NotRequired[str],
schema: NotRequired[str],
parameters: NotRequired[Sequence[SqlParameterTypeDef]], # (1)
transactionId: NotRequired[str],
includeResultMetadata: NotRequired[bool],
continueAfterTimeout: NotRequired[bool],
resultSetOptions: NotRequired[ResultSetOptionsTypeDef], # (2)
formatRecordsAs: NotRequired[RecordsFormatTypeType], # (3)
BatchExecuteStatementResponseTypeDef#
# BatchExecuteStatementResponseTypeDef usage example
from mypy_boto3_rds_data.type_defs import BatchExecuteStatementResponseTypeDef
def get_value() -> BatchExecuteStatementResponseTypeDef:
return {
"updateResults": ...,
"ResponseMetadata": ...,
}
# BatchExecuteStatementResponseTypeDef definition
class BatchExecuteStatementResponseTypeDef(TypedDict):
updateResults: List[UpdateResultTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
SqlStatementResultTypeDef#
# SqlStatementResultTypeDef usage example
from mypy_boto3_rds_data.type_defs import SqlStatementResultTypeDef
def get_value() -> SqlStatementResultTypeDef:
return {
"resultFrame": ...,
}
# SqlStatementResultTypeDef definition
class SqlStatementResultTypeDef(TypedDict):
resultFrame: NotRequired[ResultFrameTypeDef], # (1)
numberOfRecordsUpdated: NotRequired[int],
ExecuteSqlResponseTypeDef#
# ExecuteSqlResponseTypeDef usage example
from mypy_boto3_rds_data.type_defs import ExecuteSqlResponseTypeDef
def get_value() -> ExecuteSqlResponseTypeDef:
return {
"sqlStatementResults": ...,
"ResponseMetadata": ...,
}
# ExecuteSqlResponseTypeDef definition
class ExecuteSqlResponseTypeDef(TypedDict):
sqlStatementResults: List[SqlStatementResultTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)