Skip to content

BatchExecuteStatementRequest

Source code in docs_src/capo_rds_data/types/batch_execute_statement_request.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
class BatchExecuteStatementRequest(TypedDict, closed=True):
    resource_arn: "capo_rds_data.types.arn.Arn"
    """<p>The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.</p>"""
    secret_arn: "capo_rds_data.types.arn.Arn"
    """<p>The ARN of the secret that enables access to the DB cluster. Enter the database user name and password for the credentials in the secret.</p> <p>For information about creating the secret, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/create_database_secret.html">Create a database secret</a>.</p>"""
    sql: "capo_rds_data.types.sql_statement.SqlStatement"
    """<p>The SQL statement to run. Don't include a semicolon (;) at the end of the SQL statement.</p>"""
    database: NotRequired["capo_rds_data.types.db_name.DbName"]
    """<p>The name of the database.</p>"""
    schema: NotRequired["capo_rds_data.types.db_name.DbName"]
    """<p>The name of the database schema.</p> <note> <p>Currently, the <code>schema</code> parameter isn't supported.</p> </note>"""
    parameter_sets: NotRequired[
        "capo_rds_data.types.sql_parameter_sets.SqlParameterSets"
    ]
    """<p>The parameter set for the batch operation.</p> <p>The SQL statement is executed as many times as the number of parameter sets provided. To execute a SQL statement with no parameters, use one of the following options:</p> <ul> <li> <p>Specify one or more empty parameter sets.</p> </li> <li> <p>Use the <code>ExecuteStatement</code> operation instead of the <code>BatchExecuteStatement</code> operation.</p> </li> </ul> <note> <p>Array parameters are not supported.</p> </note>"""
    transaction_id: NotRequired["capo_rds_data.types.id.Id"]
    """<p>The identifier of a transaction that was started by using the <code>BeginTransaction</code> operation. Specify the transaction ID of the transaction that you want to include the SQL statement in.</p> <p>If the SQL statement is not part of a transaction, don't set this parameter.</p>"""

database instance-attribute 

database: NotRequired[DbName]

The name of the database.

parameter_sets instance-attribute 

parameter_sets: NotRequired[SqlParameterSets]

The parameter set for the batch operation.

The SQL statement is executed as many times as the number of parameter sets provided. To execute a SQL statement with no parameters, use one of the following options:

  • Specify one or more empty parameter sets.

  • Use the ExecuteStatement operation instead of the BatchExecuteStatement operation.

Array parameters are not supported.

resource_arn instance-attribute 

resource_arn: Arn

The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.

schema instance-attribute 

schema: NotRequired[DbName]

The name of the database schema.

Currently, the schema parameter isn't supported.

secret_arn instance-attribute 

secret_arn: Arn

The ARN of the secret that enables access to the DB cluster. Enter the database user name and password for the credentials in the secret.

For information about creating the secret, see Create a database secret.

sql instance-attribute 

sql: SqlStatement

The SQL statement to run. Don't include a semicolon (;) at the end of the SQL statement.

transaction_id instance-attribute 

transaction_id: NotRequired[Id]

The identifier of a transaction that was started by using the BeginTransaction operation. Specify the transaction ID of the transaction that you want to include the SQL statement in.

If the SQL statement is not part of a transaction, don't set this parameter.