RDSDataServiceClient

Index > RDSDataService > RDSDataServiceClient

Auto-generated documentation for RDSDataService type annotations stubs module types-aiobotocore-rds-data.

RDSDataServiceClient

Type annotations and code completion for session.client("rds-data") boto3 documentation

Usage example

from aioboto3.session import Session
from types_aiobotocore_rds_data.client import RDSDataServiceClient

session = Session()
async with session.client("rds-data") as client:
    client: RDSDataServiceClient

Exceptions

aioboto3 client exceptions are generated in runtime. This class provides code completion for session.client("rds-data").exceptions structure.

Usage example

async with session.client("rds-data") as client:
    try:
        do_something(client)
    except (
            client.AccessDeniedException,
        client.BadRequestException,
        client.ClientError,
        client.ForbiddenException,
        client.InternalServerErrorException,
        client.NotFoundException,
        client.ServiceUnavailableError,
        client.StatementTimeoutException,
    ) as e:
        print(e)

Type checking example

from types_aiobotocore_rds_data.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods

batch_execute_statement

Runs a batch SQL statement over an array of data.

Type annotations and code completion for session.client("rds-data").batch_execute_statement method. boto3 documentation

Method definition

await def batch_execute_statement(
    self,
    *,
    resourceArn: str,
    secretArn: str,
    sql: str,
    database: str = ...,
    parameterSets: Sequence[Sequence[SqlParameterTypeDef]] = ...,  # (1)
    schema: str = ...,
    transactionId: str = ...,
) -> BatchExecuteStatementResponseTypeDef:  # (2)
    ...

1. See SqlParameterTypeDef
2. See BatchExecuteStatementResponseTypeDef

Usage example with kwargs

kwargs: BatchExecuteStatementRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "secretArn": ...,
    "sql": ...,
}

parent.batch_execute_statement(**kwargs)

1. See BatchExecuteStatementRequestRequestTypeDef

begin_transaction

Starts a SQL transaction.

Type annotations and code completion for session.client("rds-data").begin_transaction method. boto3 documentation

Method definition

await def begin_transaction(
    self,
    *,
    resourceArn: str,
    secretArn: str,
    database: str = ...,
    schema: str = ...,
) -> BeginTransactionResponseTypeDef:  # (1)
    ...

1. See BeginTransactionResponseTypeDef

Usage example with kwargs

kwargs: BeginTransactionRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "secretArn": ...,
}

parent.begin_transaction(**kwargs)

1. See BeginTransactionRequestRequestTypeDef

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for session.client("rds-data").can_paginate method. boto3 documentation

Method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close

Closes underlying endpoint connections.

Type annotations and code completion for session.client("rds-data").close method. boto3 documentation

Method definition

await def close(
    self,
) -> None:
    ...

commit_transaction

Ends a SQL transaction started with the BeginTransaction operation and commits the changes.

Type annotations and code completion for session.client("rds-data").commit_transaction method. boto3 documentation

Method definition

await def commit_transaction(
    self,
    *,
    resourceArn: str,
    secretArn: str,
    transactionId: str,
) -> CommitTransactionResponseTypeDef:  # (1)
    ...

1. See CommitTransactionResponseTypeDef

Usage example with kwargs

kwargs: CommitTransactionRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "secretArn": ...,
    "transactionId": ...,
}

parent.commit_transaction(**kwargs)

1. See CommitTransactionRequestRequestTypeDef

execute_sql

Runs one or more SQL statements.

Type annotations and code completion for session.client("rds-data").execute_sql method. boto3 documentation

Method definition

await def execute_sql(
    self,
    *,
    awsSecretStoreArn: str,
    dbClusterOrInstanceArn: str,
    sqlStatements: str,
    database: str = ...,
    schema: str = ...,
) -> ExecuteSqlResponseTypeDef:  # (1)
    ...

1. See ExecuteSqlResponseTypeDef

Usage example with kwargs

kwargs: ExecuteSqlRequestRequestTypeDef = {  # (1)
    "awsSecretStoreArn": ...,
    "dbClusterOrInstanceArn": ...,
    "sqlStatements": ...,
}

parent.execute_sql(**kwargs)

1. See ExecuteSqlRequestRequestTypeDef

execute_statement

Runs a SQL statement against a database.

Type annotations and code completion for session.client("rds-data").execute_statement method. boto3 documentation

Method definition

await def execute_statement(
    self,
    *,
    resourceArn: str,
    secretArn: str,
    sql: str,
    continueAfterTimeout: bool = ...,
    database: str = ...,
    formatRecordsAs: RecordsFormatTypeType = ...,  # (1)
    includeResultMetadata: bool = ...,
    parameters: Sequence[SqlParameterTypeDef] = ...,  # (2)
    resultSetOptions: ResultSetOptionsTypeDef = ...,  # (3)
    schema: str = ...,
    transactionId: str = ...,
) -> ExecuteStatementResponseTypeDef:  # (4)
    ...

1. See RecordsFormatTypeType
2. See SqlParameterTypeDef
3. See ResultSetOptionsTypeDef
4. See ExecuteStatementResponseTypeDef

Usage example with kwargs

kwargs: ExecuteStatementRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "secretArn": ...,
    "sql": ...,
}

parent.execute_statement(**kwargs)

1. See ExecuteStatementRequestRequestTypeDef

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for session.client("rds-data").generate_presigned_url method. boto3 documentation

Method definition

await def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

rollback_transaction

Performs a rollback of a transaction.

Type annotations and code completion for session.client("rds-data").rollback_transaction method. boto3 documentation

Method definition

await def rollback_transaction(
    self,
    *,
    resourceArn: str,
    secretArn: str,
    transactionId: str,
) -> RollbackTransactionResponseTypeDef:  # (1)
    ...

1. See RollbackTransactionResponseTypeDef

Usage example with kwargs

kwargs: RollbackTransactionRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "secretArn": ...,
    "transactionId": ...,
}

parent.rollback_transaction(**kwargs)

1. See RollbackTransactionRequestRequestTypeDef

__aenter__

Type annotations and code completion for session.client("rds-data").__aenter__ method. boto3 documentation

Method definition

await def __aenter__(
    self,
) -> RDSDataServiceClient:
    ...

__aexit__

Type annotations and code completion for session.client("rds-data").__aexit__ method. boto3 documentation

Method definition

await def __aexit__(
    self,
    exc_type: Any,
    exc_val: Any,
    exc_tb: Any,
) -> Any:
    ...