Skip to content

Type definitions#

Index > RDSDataService > Type definitions

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

BlobTypeDef#

# BlobTypeDef Union usage example

from mypy_boto3_rds_data.type_defs import BlobTypeDef


def get_value() -> BlobTypeDef:
    return ...


# BlobTypeDef definition

BlobTypeDef = Union[
    str,
    bytes,
    IO[Any],
    botocore.response.StreamingBody,
]

ArrayValueUnionTypeDef#

# ArrayValueUnionTypeDef Union usage example

from mypy_boto3_rds_data.type_defs import ArrayValueUnionTypeDef


def get_value() -> ArrayValueUnionTypeDef:
    return ...


# ArrayValueUnionTypeDef definition

ArrayValueUnionTypeDef = Union[
    ArrayValueTypeDef,  # (1)
    ArrayValueOutputTypeDef,  # (2)
]
  1. See ArrayValueTypeDef
  2. See ArrayValueOutputTypeDef

FieldUnionTypeDef#

# FieldUnionTypeDef Union usage example

from mypy_boto3_rds_data.type_defs import FieldUnionTypeDef


def get_value() -> FieldUnionTypeDef:
    return ...


# FieldUnionTypeDef definition

FieldUnionTypeDef = Union[
    FieldTypeDef,  # (1)
    FieldOutputTypeDef,  # (2)
]
  1. See FieldTypeDef
  2. See FieldOutputTypeDef

ArrayValueOutputTypeDef#

# ArrayValueOutputTypeDef TypedDict usage example

from mypy_boto3_rds_data.type_defs import ArrayValueOutputTypeDef


def get_value() -> ArrayValueOutputTypeDef:
    return {
        "booleanValues": ...,
    }


# ArrayValueOutputTypeDef definition

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

ArrayValueTypeDef#

# ArrayValueTypeDef TypedDict 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[Mapping[str, Any]]],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef TypedDict usage example

from mypy_boto3_rds_data.type_defs import ResponseMetadataTypeDef


def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
    }


# ResponseMetadataTypeDef definition

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

BeginTransactionRequestTypeDef#

# BeginTransactionRequestTypeDef TypedDict usage example

from mypy_boto3_rds_data.type_defs import BeginTransactionRequestTypeDef


def get_value() -> BeginTransactionRequestTypeDef:
    return {
        "resourceArn": ...,
    }


# BeginTransactionRequestTypeDef definition

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

ColumnMetadataTypeDef#

# ColumnMetadataTypeDef TypedDict 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],

CommitTransactionRequestTypeDef#

# CommitTransactionRequestTypeDef TypedDict usage example

from mypy_boto3_rds_data.type_defs import CommitTransactionRequestTypeDef


def get_value() -> CommitTransactionRequestTypeDef:
    return {
        "resourceArn": ...,
    }


# CommitTransactionRequestTypeDef definition

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

ExecuteSqlRequestTypeDef#

# ExecuteSqlRequestTypeDef TypedDict usage example

from mypy_boto3_rds_data.type_defs import ExecuteSqlRequestTypeDef


def get_value() -> ExecuteSqlRequestTypeDef:
    return {
        "dbClusterOrInstanceArn": ...,
    }


# ExecuteSqlRequestTypeDef definition

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

ResultSetOptionsTypeDef#

# ResultSetOptionsTypeDef TypedDict 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)
  1. See DecimalReturnTypeType
  2. See LongReturnTypeType

RollbackTransactionRequestTypeDef#

# RollbackTransactionRequestTypeDef TypedDict usage example

from mypy_boto3_rds_data.type_defs import RollbackTransactionRequestTypeDef


def get_value() -> RollbackTransactionRequestTypeDef:
    return {
        "resourceArn": ...,
    }


# RollbackTransactionRequestTypeDef definition

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

StructValueTypeDef#

# StructValueTypeDef TypedDict 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[Dict[str, Any]]],

FieldOutputTypeDef#

# FieldOutputTypeDef TypedDict usage example

from mypy_boto3_rds_data.type_defs import FieldOutputTypeDef


def get_value() -> FieldOutputTypeDef:
    return {
        "isNull": ...,
    }


# FieldOutputTypeDef definition

class FieldOutputTypeDef(TypedDict):
    isNull: NotRequired[bool],
    booleanValue: NotRequired[bool],
    longValue: NotRequired[int],
    doubleValue: NotRequired[float],
    stringValue: NotRequired[str],
    blobValue: NotRequired[bytes],
    arrayValue: NotRequired[ArrayValueOutputTypeDef],  # (1)
  1. See ArrayValueOutputTypeDef

BeginTransactionResponseTypeDef#

# BeginTransactionResponseTypeDef TypedDict usage example

from mypy_boto3_rds_data.type_defs import BeginTransactionResponseTypeDef


def get_value() -> BeginTransactionResponseTypeDef:
    return {
        "transactionId": ...,
    }


# BeginTransactionResponseTypeDef definition

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

CommitTransactionResponseTypeDef#

# CommitTransactionResponseTypeDef TypedDict usage example

from mypy_boto3_rds_data.type_defs import CommitTransactionResponseTypeDef


def get_value() -> CommitTransactionResponseTypeDef:
    return {
        "transactionStatus": ...,
    }


# CommitTransactionResponseTypeDef definition

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

RollbackTransactionResponseTypeDef#

# RollbackTransactionResponseTypeDef TypedDict usage example

from mypy_boto3_rds_data.type_defs import RollbackTransactionResponseTypeDef


def get_value() -> RollbackTransactionResponseTypeDef:
    return {
        "transactionStatus": ...,
    }


# RollbackTransactionResponseTypeDef definition

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

ResultSetMetadataTypeDef#

# ResultSetMetadataTypeDef TypedDict 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)
  1. See List[ColumnMetadataTypeDef]

ValueTypeDef#

# ValueTypeDef TypedDict 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[Dict[str, Any]]],
    structValue: NotRequired[StructValueTypeDef],  # (1)
  1. See StructValueTypeDef

ExecuteStatementResponseTypeDef#

# ExecuteStatementResponseTypeDef TypedDict usage example

from mypy_boto3_rds_data.type_defs import ExecuteStatementResponseTypeDef


def get_value() -> ExecuteStatementResponseTypeDef:
    return {
        "records": ...,
    }


# ExecuteStatementResponseTypeDef definition

class ExecuteStatementResponseTypeDef(TypedDict):
    records: List[List[FieldOutputTypeDef]],  # (1)
    columnMetadata: List[ColumnMetadataTypeDef],  # (2)
    numberOfRecordsUpdated: int,
    generatedFields: List[FieldOutputTypeDef],  # (3)
    formattedRecords: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See List[List[FieldOutputTypeDef]]
  2. See List[ColumnMetadataTypeDef]
  3. See List[FieldOutputTypeDef]
  4. See ResponseMetadataTypeDef

UpdateResultTypeDef#

# UpdateResultTypeDef TypedDict 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[FieldOutputTypeDef]],  # (1)
  1. See List[FieldOutputTypeDef]

FieldTypeDef#

# FieldTypeDef TypedDict 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[BlobTypeDef],
    arrayValue: NotRequired[ArrayValueUnionTypeDef],  # (1)
  1. See ArrayValueUnionTypeDef

RecordTypeDef#

# RecordTypeDef TypedDict 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)
  1. See List[ValueTypeDef]

BatchExecuteStatementResponseTypeDef#

# BatchExecuteStatementResponseTypeDef TypedDict usage example

from mypy_boto3_rds_data.type_defs import BatchExecuteStatementResponseTypeDef


def get_value() -> BatchExecuteStatementResponseTypeDef:
    return {
        "updateResults": ...,
    }


# BatchExecuteStatementResponseTypeDef definition

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

ResultFrameTypeDef#

# ResultFrameTypeDef TypedDict 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)
  1. See ResultSetMetadataTypeDef
  2. See List[RecordTypeDef]

SqlParameterTypeDef#

# SqlParameterTypeDef TypedDict 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[FieldUnionTypeDef],  # (1)
    typeHint: NotRequired[TypeHintType],  # (2)
  1. See FieldUnionTypeDef
  2. See TypeHintType

SqlStatementResultTypeDef#

# SqlStatementResultTypeDef TypedDict 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],
  1. See ResultFrameTypeDef

BatchExecuteStatementRequestTypeDef#

# BatchExecuteStatementRequestTypeDef TypedDict usage example

from mypy_boto3_rds_data.type_defs import BatchExecuteStatementRequestTypeDef


def get_value() -> BatchExecuteStatementRequestTypeDef:
    return {
        "resourceArn": ...,
    }


# BatchExecuteStatementRequestTypeDef definition

class BatchExecuteStatementRequestTypeDef(TypedDict):
    resourceArn: str,
    secretArn: str,
    sql: str,
    database: NotRequired[str],
    schema: NotRequired[str],
    parameterSets: NotRequired[Sequence[Sequence[SqlParameterTypeDef]]],  # (1)
    transactionId: NotRequired[str],
  1. See Sequence[Sequence[SqlParameterTypeDef]]

ExecuteStatementRequestTypeDef#

# ExecuteStatementRequestTypeDef TypedDict usage example

from mypy_boto3_rds_data.type_defs import ExecuteStatementRequestTypeDef


def get_value() -> ExecuteStatementRequestTypeDef:
    return {
        "resourceArn": ...,
    }


# ExecuteStatementRequestTypeDef definition

class ExecuteStatementRequestTypeDef(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 Sequence[SqlParameterTypeDef]
  2. See ResultSetOptionsTypeDef
  3. See RecordsFormatTypeType

ExecuteSqlResponseTypeDef#

# ExecuteSqlResponseTypeDef TypedDict usage example

from mypy_boto3_rds_data.type_defs import ExecuteSqlResponseTypeDef


def get_value() -> ExecuteSqlResponseTypeDef:
    return {
        "sqlStatementResults": ...,
    }


# ExecuteSqlResponseTypeDef definition

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