AWS API Changes

2019/05/30 - AWS RDS DataService - 5 new api methods

Changes Update rds-data client to latest version

RollbackTransaction (new)

Link ¶

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

Request Syntax

client.rollback_transaction(
    resourceArn='string',
    secretArn='string',
    transactionId='string'
)

type resourceArn:

string

param resourceArn:

[REQUIRED]

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

type secretArn:

string

param secretArn:

[REQUIRED]

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

type transactionId:

string

param transactionId:

[REQUIRED]

The identifier of the transaction to roll back.

rtype:

dict

returns:

Response Syntax

{
    'transactionStatus': 'string'
}

Response Structure

(dict) --

The response elements represent the output of a request to perform a rollback of a transaction.
- transactionStatus (string) --
  
  The status of the rollback operation.

BatchExecuteStatement (new)

Link ¶

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.

See also: AWS API Documentation

Request Syntax

client.batch_execute_statement(
    database='string',
    parameterSets=[
        [
            {
                'name': 'string',
                'value': {
                    'blobValue': b'bytes',
                    'booleanValue': True|False,
                    'doubleValue': 123.0,
                    'isNull': True|False,
                    'longValue': 123,
                    'stringValue': 'string'
                }
            },
        ],
    ],
    resourceArn='string',
    schema='string',
    secretArn='string',
    sql='string',
    transactionId='string'
)

type database:

string

param database:

The name of the database.

type parameterSets:

list

param parameterSets:

The parameter set for the batch operation.

(list) --
- (dict) --
  
  A parameter used in a SQL statement.
  - name (string) --
    
    The name of the parameter.
  - value (dict) --
    
    The value of the parameter.
    - blobValue (bytes) --
      
      A value of BLOB data type.
    - booleanValue (boolean) --
      
      A value of Boolean data type.
    - doubleValue (float) --
      
      A value of double data type.
    - isNull (boolean) --
      
      A NULL value.
    - longValue (integer) --
      
      A value of long data type.
    - stringValue (string) --
      
      A value of string data type.

type resourceArn:

string

param resourceArn:

[REQUIRED]

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

type schema:

string

param schema:

The name of the database schema.

type secretArn:

string

param secretArn:

[REQUIRED]

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

type sql:

string

param sql:

[REQUIRED]

The SQL statement to run.

type transactionId:

string

param transactionId:

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.

rtype:

dict

returns:

Response Syntax

{
    'updateResults': [
        {
            'generatedFields': [
                {
                    'blobValue': b'bytes',
                    'booleanValue': True|False,
                    'doubleValue': 123.0,
                    'isNull': True|False,
                    'longValue': 123,
                    'stringValue': 'string'
                },
            ]
        },
    ]
}

Response Structure

(dict) --

The response elements represent the output of a SQL statement over an array of data.
- updateResults (list) --
  
  The execution results of each batch entry.
  - (dict) --
    
    The response elements represent the results of an update.
    - generatedFields (list) --
      
      Values for fields generated during the request.
      - (dict) --
        
        Contains a value.
        
        blobValue (bytes) --
        
        A value of BLOB data type.
        
        booleanValue (boolean) --
        
        A value of Boolean data type.
        
        doubleValue (float) --
        
        A value of double data type.
        
        isNull (boolean) --
        
        A NULL value.
        
        longValue (integer) --
        
        A value of long data type.
        
        stringValue (string) --
        
        A value of string data type.

BeginTransaction (new)

Link ¶

Starts a SQL transaction.

See also: AWS API Documentation

Request Syntax

client.begin_transaction(
    database='string',
    resourceArn='string',
    schema='string',
    secretArn='string'
)

type database:

string

param database:

The name of the database.

type resourceArn:

string

param resourceArn:

[REQUIRED]

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

type schema:

string

param schema:

The name of the database schema.

type secretArn:

string

param secretArn:

[REQUIRED]

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

rtype:

dict

returns:

Response Syntax

{
    'transactionId': 'string'
}

Response Structure

(dict) --

The response elements represent the output of a request to start a SQL transaction.
- transactionId (string) --
  
  The transaction ID of the transaction started by the call.

CommitTransaction (new)

Link ¶

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

See also: AWS API Documentation

Request Syntax

client.commit_transaction(
    resourceArn='string',
    secretArn='string',
    transactionId='string'
)

type resourceArn:

string

param resourceArn:

[REQUIRED]

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

type secretArn:

string

param secretArn:

[REQUIRED]

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

type transactionId:

string

param transactionId:

[REQUIRED]

The identifier of the transaction to end and commit.

rtype:

dict

returns:

Response Syntax

{
    'transactionStatus': 'string'
}

Response Structure

(dict) --

The response elements represent the output of a commit transaction request.
- transactionStatus (string) --
  
  The status of the commit operation.

ExecuteStatement (new)

Link ¶

Runs a SQL statement against a database.

The response size limit is 1 MB or 1,000 records. If the call returns more than 1 MB of response data or over 1,000 records, the call is terminated.

See also: AWS API Documentation

Request Syntax

client.execute_statement(
    continueAfterTimeout=True|False,
    database='string',
    includeResultMetadata=True|False,
    parameters=[
        {
            'name': 'string',
            'value': {
                'blobValue': b'bytes',
                'booleanValue': True|False,
                'doubleValue': 123.0,
                'isNull': True|False,
                'longValue': 123,
                'stringValue': 'string'
            }
        },
    ],
    resourceArn='string',
    schema='string',
    secretArn='string',
    sql='string',
    transactionId='string'
)

type continueAfterTimeout:

boolean

param continueAfterTimeout:

A value that indicates whether to continue running the statement after the call times out. By default, the statement stops running when the call times out.

type database:

string

param database:

The name of the database.

type includeResultMetadata:

boolean

param includeResultMetadata:

A value that indicates whether to include metadata in the results.

type parameters:

list

param parameters:

The parameters for the SQL statement.

(dict) --

A parameter used in a SQL statement.
- name (string) --
  
  The name of the parameter.
- value (dict) --
  
  The value of the parameter.
  - blobValue (bytes) --
    
    A value of BLOB data type.
  - booleanValue (boolean) --
    
    A value of Boolean data type.
  - doubleValue (float) --
    
    A value of double data type.
  - isNull (boolean) --
    
    A NULL value.
  - longValue (integer) --
    
    A value of long data type.
  - stringValue (string) --
    
    A value of string data type.

type resourceArn:

string

param resourceArn:

[REQUIRED]

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

type schema:

string

param schema:

The name of the database schema.

type secretArn:

string

param secretArn:

[REQUIRED]

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

type sql:

string

param sql:

[REQUIRED]

The SQL statement to run.

type transactionId:

string

param transactionId:

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.

rtype:

dict

returns:

Response Syntax

{
    'columnMetadata': [
        {
            'arrayBaseColumnType': 123,
            'isAutoIncrement': True|False,
            'isCaseSensitive': True|False,
            'isCurrency': True|False,
            'isSigned': True|False,
            'label': 'string',
            'name': 'string',
            'nullable': 123,
            'precision': 123,
            'scale': 123,
            'schemaName': 'string',
            'tableName': 'string',
            'type': 123,
            'typeName': 'string'
        },
    ],
    'generatedFields': [
        {
            'blobValue': b'bytes',
            'booleanValue': True|False,
            'doubleValue': 123.0,
            'isNull': True|False,
            'longValue': 123,
            'stringValue': 'string'
        },
    ],
    'numberOfRecordsUpdated': 123,
    'records': [
        [
            {
                'blobValue': b'bytes',
                'booleanValue': True|False,
                'doubleValue': 123.0,
                'isNull': True|False,
                'longValue': 123,
                'stringValue': 'string'
            },
        ],
    ]
}

Response Structure

(dict) --

The response elements represent the output of a request to run a SQL statement against a database.
- columnMetadata (list) --
  
  Metadata for the columns included in the results.
  - (dict) --
    
    Contains the metadata for a column.
    - arrayBaseColumnType (integer) --
      
      The type of the column.
    - isAutoIncrement (boolean) --
      
      A value that indicates whether the column increments automatically.
    - isCaseSensitive (boolean) --
      
      A value that indicates whether the column is case-sensitive.
    - isCurrency (boolean) --
      
      A value that indicates whether the column contains currency values.
    - isSigned (boolean) --
      
      A value that indicates whether an integer column is signed.
    - label (string) --
      
      The label for the column.
    - name (string) --
      
      The name of the column.
    - nullable (integer) --
      
      A value that indicates whether the column is nullable.
    - precision (integer) --
      
      The precision value of a decimal number column.
    - scale (integer) --
      
      The scale value of a decimal number column.
    - schemaName (string) --
      
      The name of the schema that owns the table that includes the column.
    - tableName (string) --
      
      The name of the table that includes the column.
    - type (integer) --
      
      The type of the column.
    - typeName (string) --
      
      The database-specific data type of the column.
- generatedFields (list) --
  
  Values for fields generated during the request.
  - (dict) --
    
    Contains a value.
    - blobValue (bytes) --
      
      A value of BLOB data type.
    - booleanValue (boolean) --
      
      A value of Boolean data type.
    - doubleValue (float) --
      
      A value of double data type.
    - isNull (boolean) --
      
      A NULL value.
    - longValue (integer) --
      
      A value of long data type.
    - stringValue (string) --
      
      A value of string data type.
- numberOfRecordsUpdated (integer) --
  
  The number of records updated by the request.
- records (list) --
  
  The records returned by the SQL statement.
  - (list) --
    - (dict) --
      
      Contains a value.
      - blobValue (bytes) --
        
        A value of BLOB data type.
      - booleanValue (boolean) --
        
        A value of Boolean data type.
      - doubleValue (float) --
        
        A value of double data type.
      - isNull (boolean) --
        
        A NULL value.
      - longValue (integer) --
        
        A value of long data type.
      - stringValue (string) --
        
        A value of string data type.