Skip to content

Type definitions#

Index > RDSDataService > Type definitions

Auto-generated documentation for RDSDataService type annotations stubs module mypy-boto3-rds-data.

BlobTypeDef#

# BlobTypeDef definition

BlobTypeDef = Union[
    str,
    bytes,
    IO[Any],
    StreamingBody,
]

ArrayValueTypeDef#

# ArrayValueTypeDef definition

class ArrayValueTypeDef(TypedDict):
    booleanValues: NotRequired[Sequence[bool]],
    longValues: NotRequired[Sequence[int]],
    doubleValues: NotRequired[Sequence[float]],
    stringValues: NotRequired[Sequence[str]],
    arrayValues: NotRequired[Sequence[Dict[str, Any]]],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

BeginTransactionRequestRequestTypeDef#

# BeginTransactionRequestRequestTypeDef definition

class BeginTransactionRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    secretArn: str,
    database: NotRequired[str],
    schema: NotRequired[str],

ColumnMetadataTypeDef#

# 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 definition

class CommitTransactionRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    secretArn: str,
    transactionId: str,

ExecuteSqlRequestRequestTypeDef#

# ExecuteSqlRequestRequestTypeDef definition

class ExecuteSqlRequestRequestTypeDef(TypedDict):
    dbClusterOrInstanceArn: str,
    awsSecretStoreArn: str,
    sqlStatements: str,
    database: NotRequired[str],
    schema: NotRequired[str],

ResultSetOptionsTypeDef#

# ResultSetOptionsTypeDef definition

class ResultSetOptionsTypeDef(TypedDict):
    decimalReturnType: NotRequired[DecimalReturnTypeType],  # (1)
    longReturnType: NotRequired[LongReturnTypeType],  # (2)
  1. See DecimalReturnTypeType
  2. See LongReturnTypeType

RecordTypeDef#

# RecordTypeDef definition

class RecordTypeDef(TypedDict):
    values: NotRequired[List[ValueTypeDef]],  # (1)
  1. See ValueTypeDef

RollbackTransactionRequestRequestTypeDef#

# RollbackTransactionRequestRequestTypeDef definition

class RollbackTransactionRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    secretArn: str,
    transactionId: str,

StructValueTypeDef#

# StructValueTypeDef definition

class StructValueTypeDef(TypedDict):
    attributes: NotRequired[List[ValueTypeDef]],  # (1)
  1. See ValueTypeDef

ValueTypeDef#

# 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[Dict[str, Any]]],
    structValue: NotRequired[Dict[str, Any]],

BeginTransactionResponseTypeDef#

# BeginTransactionResponseTypeDef definition

class BeginTransactionResponseTypeDef(TypedDict):
    transactionId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CommitTransactionResponseTypeDef#

# CommitTransactionResponseTypeDef definition

class CommitTransactionResponseTypeDef(TypedDict):
    transactionStatus: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

RollbackTransactionResponseTypeDef#

# RollbackTransactionResponseTypeDef definition

class RollbackTransactionResponseTypeDef(TypedDict):
    transactionStatus: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

FieldTypeDef#

# 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)
  1. See ArrayValueTypeDef

ResultSetMetadataTypeDef#

# ResultSetMetadataTypeDef definition

class ResultSetMetadataTypeDef(TypedDict):
    columnCount: NotRequired[int],
    columnMetadata: NotRequired[List[ColumnMetadataTypeDef]],  # (1)
  1. See ColumnMetadataTypeDef

ExecuteStatementResponseTypeDef#

# 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)
  1. See FieldTypeDef
  2. See ColumnMetadataTypeDef
  3. See FieldTypeDef
  4. See ResponseMetadataTypeDef

SqlParameterTypeDef#

# SqlParameterTypeDef definition

class SqlParameterTypeDef(TypedDict):
    name: NotRequired[str],
    value: NotRequired[FieldTypeDef],  # (1)
    typeHint: NotRequired[TypeHintType],  # (2)
  1. See FieldTypeDef
  2. See TypeHintType

UpdateResultTypeDef#

# UpdateResultTypeDef definition

class UpdateResultTypeDef(TypedDict):
    generatedFields: NotRequired[List[FieldTypeDef]],  # (1)
  1. See FieldTypeDef

ResultFrameTypeDef#

# ResultFrameTypeDef definition

class ResultFrameTypeDef(TypedDict):
    resultSetMetadata: NotRequired[ResultSetMetadataTypeDef],  # (1)
    records: NotRequired[List[RecordTypeDef]],  # (2)
  1. See ResultSetMetadataTypeDef
  2. See RecordTypeDef

BatchExecuteStatementRequestRequestTypeDef#

# 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],
  1. See SqlParameterTypeDef

ExecuteStatementRequestRequestTypeDef#

# 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)
  1. See SqlParameterTypeDef
  2. See ResultSetOptionsTypeDef
  3. See RecordsFormatTypeType

BatchExecuteStatementResponseTypeDef#

# BatchExecuteStatementResponseTypeDef definition

class BatchExecuteStatementResponseTypeDef(TypedDict):
    updateResults: List[UpdateResultTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See UpdateResultTypeDef
  2. See ResponseMetadataTypeDef

SqlStatementResultTypeDef#

# SqlStatementResultTypeDef definition

class SqlStatementResultTypeDef(TypedDict):
    resultFrame: NotRequired[ResultFrameTypeDef],  # (1)
    numberOfRecordsUpdated: NotRequired[int],
  1. See ResultFrameTypeDef

ExecuteSqlResponseTypeDef#

# ExecuteSqlResponseTypeDef definition

class ExecuteSqlResponseTypeDef(TypedDict):
    sqlStatementResults: List[SqlStatementResultTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SqlStatementResultTypeDef
  2. See ResponseMetadataTypeDef