Typed dictionaries

Index > RDSDataService > Typed dictionaries

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

ArrayValueTypeDef

Usage Example

from mypy_boto3_rds_data.type_defs import ArrayValueTypeDef

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

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)

1. See ArrayValueTypeDef

ResponseMetadataTypeDef

Usage Example

from mypy_boto3_rds_data.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,

BeginTransactionRequestRequestTypeDef

Usage Example

from mypy_boto3_rds_data.type_defs import BeginTransactionRequestRequestTypeDef

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

Definition

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

ColumnMetadataTypeDef

Usage Example

from mypy_boto3_rds_data.type_defs import ColumnMetadataTypeDef

def get_value() -> ColumnMetadataTypeDef:
    return {
        "name": ...,
    }

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

Usage Example

from mypy_boto3_rds_data.type_defs import CommitTransactionRequestRequestTypeDef

def get_value() -> CommitTransactionRequestRequestTypeDef:
    return {
        "resourceArn": ...,
        "secretArn": ...,
        "transactionId": ...,
    }

Definition

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

ExecuteSqlRequestRequestTypeDef

Usage Example

from mypy_boto3_rds_data.type_defs import ExecuteSqlRequestRequestTypeDef

def get_value() -> ExecuteSqlRequestRequestTypeDef:
    return {
        "dbClusterOrInstanceArn": ...,
        "awsSecretStoreArn": ...,
        "sqlStatements": ...,
    }

Definition

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

ResultSetOptionsTypeDef

Usage Example

from mypy_boto3_rds_data.type_defs import ResultSetOptionsTypeDef

def get_value() -> ResultSetOptionsTypeDef:
    return {
        "decimalReturnType": ...,
    }

Definition

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

1. See DecimalReturnTypeType
2. See LongReturnTypeType

FieldTypeDef

Usage Example

from mypy_boto3_rds_data.type_defs import FieldTypeDef

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

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

RecordTypeDef

Usage Example

from mypy_boto3_rds_data.type_defs import RecordTypeDef

def get_value() -> RecordTypeDef:
    return {
        "values": ...,
    }

Definition

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

1. See ValueTypeDef

RollbackTransactionRequestRequestTypeDef

Usage Example

from mypy_boto3_rds_data.type_defs import RollbackTransactionRequestRequestTypeDef

def get_value() -> RollbackTransactionRequestRequestTypeDef:
    return {
        "resourceArn": ...,
        "secretArn": ...,
        "transactionId": ...,
    }

Definition

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

StructValueTypeDef

Usage Example

from mypy_boto3_rds_data.type_defs import StructValueTypeDef

def get_value() -> StructValueTypeDef:
    return {
        "attributes": ...,
    }

Definition

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

1. See ValueTypeDef

ValueTypeDef

Usage Example

from mypy_boto3_rds_data.type_defs import ValueTypeDef

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

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)

1. See ValueTypeDef
2. See StructValueTypeDef

BeginTransactionResponseTypeDef

Usage Example

from mypy_boto3_rds_data.type_defs import BeginTransactionResponseTypeDef

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

Definition

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

1. See ResponseMetadataTypeDef

CommitTransactionResponseTypeDef

Usage Example

from mypy_boto3_rds_data.type_defs import CommitTransactionResponseTypeDef

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

Definition

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

1. See ResponseMetadataTypeDef

RollbackTransactionResponseTypeDef

Usage Example

from mypy_boto3_rds_data.type_defs import RollbackTransactionResponseTypeDef

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

Definition

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

1. See ResponseMetadataTypeDef

ResultSetMetadataTypeDef

Usage Example

from mypy_boto3_rds_data.type_defs import ResultSetMetadataTypeDef

def get_value() -> ResultSetMetadataTypeDef:
    return {
        "columnCount": ...,
    }

Definition

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

1. See ColumnMetadataTypeDef

ExecuteStatementResponseTypeDef

Usage Example

from mypy_boto3_rds_data.type_defs import ExecuteStatementResponseTypeDef

def get_value() -> ExecuteStatementResponseTypeDef:
    return {
        "records": ...,
        "columnMetadata": ...,
        "numberOfRecordsUpdated": ...,
        "generatedFields": ...,
        "formattedRecords": ...,
        "ResponseMetadata": ...,
    }

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

Usage Example

from mypy_boto3_rds_data.type_defs import SqlParameterTypeDef

def get_value() -> SqlParameterTypeDef:
    return {
        "name": ...,
    }

Definition

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

1. See FieldTypeDef
2. See TypeHintType

UpdateResultTypeDef

Usage Example

from mypy_boto3_rds_data.type_defs import UpdateResultTypeDef

def get_value() -> UpdateResultTypeDef:
    return {
        "generatedFields": ...,
    }

Definition

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

1. See FieldTypeDef

ResultFrameTypeDef

Usage Example

from mypy_boto3_rds_data.type_defs import ResultFrameTypeDef

def get_value() -> ResultFrameTypeDef:
    return {
        "resultSetMetadata": ...,
    }

Definition

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

1. See ResultSetMetadataTypeDef
2. See RecordTypeDef

BatchExecuteStatementRequestRequestTypeDef

Usage Example

from mypy_boto3_rds_data.type_defs import BatchExecuteStatementRequestRequestTypeDef

def get_value() -> BatchExecuteStatementRequestRequestTypeDef:
    return {
        "resourceArn": ...,
        "secretArn": ...,
        "sql": ...,
    }

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

Usage Example

from mypy_boto3_rds_data.type_defs import ExecuteStatementRequestRequestTypeDef

def get_value() -> ExecuteStatementRequestRequestTypeDef:
    return {
        "resourceArn": ...,
        "secretArn": ...,
        "sql": ...,
    }

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

Usage Example

from mypy_boto3_rds_data.type_defs import BatchExecuteStatementResponseTypeDef

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

Definition

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

1. See UpdateResultTypeDef
2. See ResponseMetadataTypeDef

SqlStatementResultTypeDef

Usage Example

from mypy_boto3_rds_data.type_defs import SqlStatementResultTypeDef

def get_value() -> SqlStatementResultTypeDef:
    return {
        "resultFrame": ...,
    }

Definition

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

1. See ResultFrameTypeDef

ExecuteSqlResponseTypeDef

Usage Example

from mypy_boto3_rds_data.type_defs import ExecuteSqlResponseTypeDef

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

Definition

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

1. See SqlStatementResultTypeDef
2. See ResponseMetadataTypeDef