Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . rds-data ]

begin-transaction

Description

Starts a SQL transaction.

`` important pA transaction can run for a maximum of 24 hours. A transaction is terminated and rolled back automatically after 24 hours./p pA transaction times out if no calls use its transaction ID in three minutes. If a transaction times out before it's committed, it's rolled back automatically./p pDDL statements inside a transaction cause an implicit commit. We recommend that you run each DDL statement in a separate codeExecuteStatement/codecall with codecontinueAfterTimeout/codeenabled./p /important``

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  begin-transaction
[--database <value>]
--resource-arn <value>
[--schema <value>]
--secret-arn <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--database (string)

The name of the database.

--resource-arn (string)

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

--schema (string)

The name of the database schema.

--secret-arn (string)

The name or ARN of the secret that enables access to the DB cluster.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Examples

To start a SQL transaction

The following begin-transaction example starts a SQL transaction.

aws rds-data begin-transaction \
    --resource-arn "arn:aws:rds:us-west-2:123456789012:cluster:mydbcluster" \
    --database "mydb" \
    --secret-arn "arn:aws:secretsmanager:us-west-2:123456789012:secret:mysecret"

Output:

{
    "transactionId": "ABC1234567890xyz"
}

For more information, see Using the Data API for Aurora Serverless in the Amazon RDS User Guide.

Output

transactionId -> (string)

The transaction ID of the transaction started by the call.