BatchExecuteStatement

$result = $client->batchExecuteStatement([/* ... */]);
$promise = $client->batchExecuteStatementAsync([/* ... */]);

Runs a batch SQL statement over an array of data.

You can run bulk update and insert operations for multiple records using a DML statement with different parameter sets. Bulk operations can provide a significant performance improvement over individual insert and update operations.

Parameter Syntax

$result = $client->batchExecuteStatement([
    'database' => '<string>',
    'parameterSets' => [
        [
            [
                'name' => '<string>',
                'typeHint' => 'JSON|UUID|TIMESTAMP|DATE|TIME|DECIMAL',
                'value' => [
                    'arrayValue' => [
                        'arrayValues' => [
                            [...], // RECURSIVE
                            // ...
                        ],
                        'booleanValues' => [true || false, ...],
                        'doubleValues' => [<float>, ...],
                        'longValues' => [<integer>, ...],
                        'stringValues' => ['<string>', ...],
                    ],
                    'blobValue' => <string || resource || Psr\Http\Message\StreamInterface>,
                    'booleanValue' => true || false,
                    'doubleValue' => <float>,
                    'isNull' => true || false,
                    'longValue' => <integer>,
                    'stringValue' => '<string>',
                ],
            ],
            // ...
        ],
        // ...
    ],
    'resourceArn' => '<string>', // REQUIRED
    'schema' => '<string>',
    'secretArn' => '<string>', // REQUIRED
    'sql' => '<string>', // REQUIRED
    'transactionId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'updateResults' => [
        [
            'generatedFields' => [
                [
                    'arrayValue' => [
                        'arrayValues' => [
                            [...], // RECURSIVE
                            // ...
                        ],
                        'booleanValues' => [true || false, ...],
                        'doubleValues' => [<float>, ...],
                        'longValues' => [<integer>, ...],
                        'stringValues' => ['<string>', ...],
                    ],
                    'blobValue' => <string || resource || Psr\Http\Message\StreamInterface>,
                    'booleanValue' => true || false,
                    'doubleValue' => <float>,
                    'isNull' => true || false,
                    'longValue' => <integer>,
                    'stringValue' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
]

Result Details

Errors

SecretsErrorException:

There was a problem with the Secrets Manager secret used with the request, caused by one of the following conditions:

• RDS Data API timed out retrieving the secret.

• The secret provided wasn't found.

• The secret couldn't be decrypted.

HttpEndpointNotEnabledException:

The HTTP endpoint for using RDS Data API isn't enabled for the DB cluster.

DatabaseErrorException:

There was an error in processing the SQL statement.

DatabaseResumingException:

A request was canceled because the Aurora Serverless v2 DB instance was in a paused state. The Data API request automatically causes the DB instance to begin resuming. Wait a few seconds and try again.

DatabaseUnavailableException:

The writer instance in the DB cluster isn't available.

TransactionNotFoundException:

The transaction ID wasn't found.

InvalidSecretException:

The Secrets Manager secret used with the request isn't valid.

ServiceUnavailableError:

The service specified by the resourceArn parameter isn't available.

ForbiddenException:

There are insufficient privileges to make the call.

DatabaseNotFoundException:

The DB cluster doesn't have a DB instance.

AccessDeniedException:

You don't have sufficient access to perform this action.

BadRequestException:

There is an error in the call or in a SQL statement. (This error only appears in calls from Aurora Serverless v1 databases.)

StatementTimeoutException:

The execution of the SQL statement timed out.

InternalServerErrorException:

An internal error occurred.

BeginTransaction

$result = $client->beginTransaction([/* ... */]);
$promise = $client->beginTransactionAsync([/* ... */]);

Starts a SQL transaction.

Parameter Syntax

$result = $client->beginTransaction([
    'database' => '<string>',
    'resourceArn' => '<string>', // REQUIRED
    'schema' => '<string>',
    'secretArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'transactionId' => '<string>',
]

Result Details

Errors

SecretsErrorException:

There was a problem with the Secrets Manager secret used with the request, caused by one of the following conditions:

• RDS Data API timed out retrieving the secret.

• The secret provided wasn't found.

• The secret couldn't be decrypted.

HttpEndpointNotEnabledException:

The HTTP endpoint for using RDS Data API isn't enabled for the DB cluster.

DatabaseErrorException:

There was an error in processing the SQL statement.

DatabaseResumingException:

A request was canceled because the Aurora Serverless v2 DB instance was in a paused state. The Data API request automatically causes the DB instance to begin resuming. Wait a few seconds and try again.

DatabaseUnavailableException:

The writer instance in the DB cluster isn't available.

TransactionNotFoundException:

The transaction ID wasn't found.

InvalidSecretException:

The Secrets Manager secret used with the request isn't valid.

ServiceUnavailableError:

The service specified by the resourceArn parameter isn't available.

ForbiddenException:

There are insufficient privileges to make the call.

DatabaseNotFoundException:

The DB cluster doesn't have a DB instance.

AccessDeniedException:

You don't have sufficient access to perform this action.

BadRequestException:

There is an error in the call or in a SQL statement. (This error only appears in calls from Aurora Serverless v1 databases.)

StatementTimeoutException:

The execution of the SQL statement timed out.

InternalServerErrorException:

An internal error occurred.

CommitTransaction

$result = $client->commitTransaction([/* ... */]);
$promise = $client->commitTransactionAsync([/* ... */]);

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

Parameter Syntax

$result = $client->commitTransaction([
    'resourceArn' => '<string>', // REQUIRED
    'secretArn' => '<string>', // REQUIRED
    'transactionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'transactionStatus' => '<string>',
]

Result Details

Errors

SecretsErrorException:

There was a problem with the Secrets Manager secret used with the request, caused by one of the following conditions:

• RDS Data API timed out retrieving the secret.

• The secret provided wasn't found.

• The secret couldn't be decrypted.

HttpEndpointNotEnabledException:

The HTTP endpoint for using RDS Data API isn't enabled for the DB cluster.

DatabaseErrorException:

There was an error in processing the SQL statement.

DatabaseUnavailableException:

The writer instance in the DB cluster isn't available.

TransactionNotFoundException:

The transaction ID wasn't found.

InvalidSecretException:

The Secrets Manager secret used with the request isn't valid.

ServiceUnavailableError:

The service specified by the resourceArn parameter isn't available.

ForbiddenException:

There are insufficient privileges to make the call.

DatabaseNotFoundException:

The DB cluster doesn't have a DB instance.

AccessDeniedException:

You don't have sufficient access to perform this action.

BadRequestException:

There is an error in the call or in a SQL statement. (This error only appears in calls from Aurora Serverless v1 databases.)

StatementTimeoutException:

The execution of the SQL statement timed out.

InternalServerErrorException:

An internal error occurred.

NotFoundException:

The resourceArn, secretArn, or transactionId value can't be found.

ExecuteSql

$result = $client->executeSql([/* ... */]);
$promise = $client->executeSqlAsync([/* ... */]);

Runs one or more SQL statements.

Parameter Syntax

$result = $client->executeSql([
    'awsSecretStoreArn' => '<string>', // REQUIRED
    'database' => '<string>',
    'dbClusterOrInstanceArn' => '<string>', // REQUIRED
    'schema' => '<string>',
    'sqlStatements' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'sqlStatementResults' => [
        [
            'numberOfRecordsUpdated' => <integer>,
            'resultFrame' => [
                'records' => [
                    [
                        'values' => [
                            [
                                'arrayValues' => [
                                    [...], // RECURSIVE
                                    // ...
                                ],
                                'bigIntValue' => <integer>,
                                'bitValue' => true || false,
                                'blobValue' => <string || resource || Psr\Http\Message\StreamInterface>,
                                'doubleValue' => <float>,
                                'intValue' => <integer>,
                                'isNull' => true || false,
                                'realValue' => <float>,
                                'stringValue' => '<string>',
                                'structValue' => [
                                    'attributes' => [
                                        [...], // RECURSIVE
                                        // ...
                                    ],
                                ],
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
                'resultSetMetadata' => [
                    'columnCount' => <integer>,
                    'columnMetadata' => [
                        [
                            'arrayBaseColumnType' => <integer>,
                            'isAutoIncrement' => true || false,
                            'isCaseSensitive' => true || false,
                            'isCurrency' => true || false,
                            'isSigned' => true || false,
                            'label' => '<string>',
                            'name' => '<string>',
                            'nullable' => <integer>,
                            'precision' => <integer>,
                            'scale' => <integer>,
                            'schemaName' => '<string>',
                            'tableName' => '<string>',
                            'type' => <integer>,
                            'typeName' => '<string>',
                        ],
                        // ...
                    ],
                ],
            ],
        ],
        // ...
    ],
]

Result Details

Errors

AccessDeniedException:

You don't have sufficient access to perform this action.

BadRequestException:

There is an error in the call or in a SQL statement. (This error only appears in calls from Aurora Serverless v1 databases.)

InternalServerErrorException:

An internal error occurred.

ForbiddenException:

There are insufficient privileges to make the call.

ServiceUnavailableError:

The service specified by the resourceArn parameter isn't available.

ExecuteStatement

$result = $client->executeStatement([/* ... */]);
$promise = $client->executeStatementAsync([/* ... */]);

Runs a SQL statement against a database.

Parameter Syntax

$result = $client->executeStatement([
    'continueAfterTimeout' => true || false,
    'database' => '<string>',
    'formatRecordsAs' => 'NONE|JSON',
    'includeResultMetadata' => true || false,
    'parameters' => [
        [
            'name' => '<string>',
            'typeHint' => 'JSON|UUID|TIMESTAMP|DATE|TIME|DECIMAL',
            'value' => [
                'arrayValue' => [
                    'arrayValues' => [
                        [...], // RECURSIVE
                        // ...
                    ],
                    'booleanValues' => [true || false, ...],
                    'doubleValues' => [<float>, ...],
                    'longValues' => [<integer>, ...],
                    'stringValues' => ['<string>', ...],
                ],
                'blobValue' => <string || resource || Psr\Http\Message\StreamInterface>,
                'booleanValue' => true || false,
                'doubleValue' => <float>,
                'isNull' => true || false,
                'longValue' => <integer>,
                'stringValue' => '<string>',
            ],
        ],
        // ...
    ],
    'resourceArn' => '<string>', // REQUIRED
    'resultSetOptions' => [
        'decimalReturnType' => 'STRING|DOUBLE_OR_LONG',
        'longReturnType' => 'STRING|LONG',
    ],
    'schema' => '<string>',
    'secretArn' => '<string>', // REQUIRED
    'sql' => '<string>', // REQUIRED
    'transactionId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'columnMetadata' => [
        [
            'arrayBaseColumnType' => <integer>,
            'isAutoIncrement' => true || false,
            'isCaseSensitive' => true || false,
            'isCurrency' => true || false,
            'isSigned' => true || false,
            'label' => '<string>',
            'name' => '<string>',
            'nullable' => <integer>,
            'precision' => <integer>,
            'scale' => <integer>,
            'schemaName' => '<string>',
            'tableName' => '<string>',
            'type' => <integer>,
            'typeName' => '<string>',
        ],
        // ...
    ],
    'formattedRecords' => '<string>',
    'generatedFields' => [
        [
            'arrayValue' => [
                'arrayValues' => [
                    [...], // RECURSIVE
                    // ...
                ],
                'booleanValues' => [true || false, ...],
                'doubleValues' => [<float>, ...],
                'longValues' => [<integer>, ...],
                'stringValues' => ['<string>', ...],
            ],
            'blobValue' => <string || resource || Psr\Http\Message\StreamInterface>,
            'booleanValue' => true || false,
            'doubleValue' => <float>,
            'isNull' => true || false,
            'longValue' => <integer>,
            'stringValue' => '<string>',
        ],
        // ...
    ],
    'numberOfRecordsUpdated' => <integer>,
    'records' => [
        [
            [
                'arrayValue' => [
                    'arrayValues' => [
                        [...], // RECURSIVE
                        // ...
                    ],
                    'booleanValues' => [true || false, ...],
                    'doubleValues' => [<float>, ...],
                    'longValues' => [<integer>, ...],
                    'stringValues' => ['<string>', ...],
                ],
                'blobValue' => <string || resource || Psr\Http\Message\StreamInterface>,
                'booleanValue' => true || false,
                'doubleValue' => <float>,
                'isNull' => true || false,
                'longValue' => <integer>,
                'stringValue' => '<string>',
            ],
            // ...
        ],
        // ...
    ],
]

Result Details

Errors

SecretsErrorException:

There was a problem with the Secrets Manager secret used with the request, caused by one of the following conditions:

• RDS Data API timed out retrieving the secret.

• The secret provided wasn't found.

• The secret couldn't be decrypted.

HttpEndpointNotEnabledException:

The HTTP endpoint for using RDS Data API isn't enabled for the DB cluster.

DatabaseErrorException:

There was an error in processing the SQL statement.

DatabaseResumingException:

A request was canceled because the Aurora Serverless v2 DB instance was in a paused state. The Data API request automatically causes the DB instance to begin resuming. Wait a few seconds and try again.

DatabaseUnavailableException:

The writer instance in the DB cluster isn't available.

TransactionNotFoundException:

The transaction ID wasn't found.

InvalidSecretException:

The Secrets Manager secret used with the request isn't valid.

ServiceUnavailableError:

The service specified by the resourceArn parameter isn't available.

ForbiddenException:

There are insufficient privileges to make the call.

DatabaseNotFoundException:

The DB cluster doesn't have a DB instance.

AccessDeniedException:

You don't have sufficient access to perform this action.

BadRequestException:

There is an error in the call or in a SQL statement. (This error only appears in calls from Aurora Serverless v1 databases.)

StatementTimeoutException:

The execution of the SQL statement timed out.

InternalServerErrorException:

An internal error occurred.

UnsupportedResultException:

There was a problem with the result because of one of the following conditions:

• It contained an unsupported data type.

• It contained a multidimensional array.

• The size was too large.

RollbackTransaction

$result = $client->rollbackTransaction([/* ... */]);
$promise = $client->rollbackTransactionAsync([/* ... */]);

Performs a rollback of a transaction. Rolling back a transaction cancels its changes.

Parameter Syntax

$result = $client->rollbackTransaction([
    'resourceArn' => '<string>', // REQUIRED
    'secretArn' => '<string>', // REQUIRED
    'transactionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'transactionStatus' => '<string>',
]

Result Details

Errors

SecretsErrorException:

There was a problem with the Secrets Manager secret used with the request, caused by one of the following conditions:

• RDS Data API timed out retrieving the secret.

• The secret provided wasn't found.

• The secret couldn't be decrypted.

HttpEndpointNotEnabledException:

The HTTP endpoint for using RDS Data API isn't enabled for the DB cluster.

DatabaseErrorException:

There was an error in processing the SQL statement.

DatabaseUnavailableException:

The writer instance in the DB cluster isn't available.

TransactionNotFoundException:

The transaction ID wasn't found.

InvalidSecretException:

The Secrets Manager secret used with the request isn't valid.

ServiceUnavailableError:

The service specified by the resourceArn parameter isn't available.

ForbiddenException:

There are insufficient privileges to make the call.

DatabaseNotFoundException:

The DB cluster doesn't have a DB instance.

AccessDeniedException:

You don't have sufficient access to perform this action.

BadRequestException:

There is an error in the call or in a SQL statement. (This error only appears in calls from Aurora Serverless v1 databases.)

StatementTimeoutException:

The execution of the SQL statement timed out.

InternalServerErrorException:

An internal error occurred.

NotFoundException:

The resourceArn, secretArn, or transactionId value can't be found.