Redshift Data API Service

2022/12/14 - Redshift Data API Service - 2 updated api methods

Changes  This release adds a new --client-token field to ExecuteStatement and BatchExecuteStatement operations. Customers can now run queries with the additional client token parameter to ensures idempotency.

BatchExecuteStatement (updated) Link ¶
Changes (request) 
{'ClientToken': 'string'}

Runs one or more SQL statements, which can be data manipulation language (DML) or data definition language (DDL). Depending on the authorization method, use one of the following combinations of request parameters:

  • Secrets Manager - when connecting to a cluster, specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret. When connecting to a serverless workgroup, specify the Amazon Resource Name (ARN) of the secret and the database name.

  • Temporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name. Also, permission to call the redshift:GetClusterCredentials operation is required. When connecting to a serverless workgroup, specify the workgroup name and database name. Also, permission to call the redshift-serverless:GetCredentials operation is required.

For more information about the Amazon Redshift Data API and CLI usage examples, see Using the Amazon Redshift Data API in the Amazon Redshift Management Guide .

See also: AWS API Documentation

Request Syntax

client.batch_execute_statement(
    ClientToken='string',
    ClusterIdentifier='string',
    Database='string',
    DbUser='string',
    SecretArn='string',
    Sqls=[
        'string',
    ],
    StatementName='string',
    WithEvent=True|False,
    WorkgroupName='string'
)
type ClientToken

string

param ClientToken

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

This field is autopopulated if not provided.

type ClusterIdentifier

string

param ClusterIdentifier

The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.

type Database

string

param Database

[REQUIRED]

The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials.

type DbUser

string

param DbUser

The database user name. This parameter is required when connecting to a cluster and authenticating using temporary credentials.

type SecretArn

string

param SecretArn

The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.

type Sqls

list

param Sqls

[REQUIRED]

One or more SQL statements to run. The SQL statements are run as a single transaction. They run serially in the order of the array. Subsequent SQL statements don't start until the previous statement in the array completes. If any SQL statement fails, then because they are run as one transaction, all work is rolled back.</p>

  • (string) --

type StatementName

string

param StatementName

The name of the SQL statements. You can name the SQL statements when you create them to identify the query.

type WithEvent

boolean

param WithEvent

A value that indicates whether to send an event to the Amazon EventBridge event bus after the SQL statements run.

type WorkgroupName

string

param WorkgroupName

The serverless workgroup name. This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.

rtype

dict

returns

Response Syntax

{
    'ClusterIdentifier': 'string',
    'CreatedAt': datetime(2015, 1, 1),
    'Database': 'string',
    'DbUser': 'string',
    'Id': 'string',
    'SecretArn': 'string',
    'WorkgroupName': 'string'
}

Response Structure

  • (dict) --

    • ClusterIdentifier (string) --

      The cluster identifier. This element is not returned when connecting to a serverless workgroup.

    • CreatedAt (datetime) --

      The date and time (UTC) the statement was created.

    • Database (string) --

      The name of the database.

    • DbUser (string) --

      The database user name.

    • Id (string) --

      The identifier of the SQL statement whose results are to be fetched. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. This identifier is returned by BatchExecuteStatment .

    • SecretArn (string) --

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

    • WorkgroupName (string) --

      The serverless workgroup name. This element is not returned when connecting to a provisioned cluster.

ExecuteStatement (updated) Link ¶
Changes (request) 
{'ClientToken': 'string'}

Runs an SQL statement, which can be data manipulation language (DML) or data definition language (DDL). This statement must be a single SQL statement. Depending on the authorization method, use one of the following combinations of request parameters:

  • Secrets Manager - when connecting to a cluster, specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret. When connecting to a serverless workgroup, specify the Amazon Resource Name (ARN) of the secret and the database name.

  • Temporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name. Also, permission to call the redshift:GetClusterCredentials operation is required. When connecting to a serverless workgroup, specify the workgroup name and database name. Also, permission to call the redshift-serverless:GetCredentials operation is required.

For more information about the Amazon Redshift Data API and CLI usage examples, see Using the Amazon Redshift Data API in the Amazon Redshift Management Guide .

See also: AWS API Documentation

Request Syntax

client.execute_statement(
    ClientToken='string',
    ClusterIdentifier='string',
    Database='string',
    DbUser='string',
    Parameters=[
        {
            'name': 'string',
            'value': 'string'
        },
    ],
    SecretArn='string',
    Sql='string',
    StatementName='string',
    WithEvent=True|False,
    WorkgroupName='string'
)
type ClientToken

string

param ClientToken

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

This field is autopopulated if not provided.

type ClusterIdentifier

string

param ClusterIdentifier

The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.

type Database

string

param Database

[REQUIRED]

The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials.

type DbUser

string

param DbUser

The database user name. This parameter is required when connecting to a cluster and authenticating using temporary credentials.

type Parameters

list

param Parameters

The parameters for the SQL statement.

  • (dict) --

    A parameter used in a SQL statement.

    • name (string) -- [REQUIRED]

      The name of the parameter.

    • value (string) -- [REQUIRED]

      The value of the parameter. Amazon Redshift implicitly converts to the proper data type. For more information, see Data types in the Amazon Redshift Database Developer Guide .

type SecretArn

string

param SecretArn

The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.

type Sql

string

param Sql

[REQUIRED]

The SQL statement text to run.

type StatementName

string

param StatementName

The name of the SQL statement. You can name the SQL statement when you create it to identify the query.

type WithEvent

boolean

param WithEvent

A value that indicates whether to send an event to the Amazon EventBridge event bus after the SQL statement runs.

type WorkgroupName

string

param WorkgroupName

The serverless workgroup name. This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.

rtype

dict

returns

Response Syntax

{
    'ClusterIdentifier': 'string',
    'CreatedAt': datetime(2015, 1, 1),
    'Database': 'string',
    'DbUser': 'string',
    'Id': 'string',
    'SecretArn': 'string',
    'WorkgroupName': 'string'
}

Response Structure

  • (dict) --

    • ClusterIdentifier (string) --

      The cluster identifier. This element is not returned when connecting to a serverless workgroup.

    • CreatedAt (datetime) --

      The date and time (UTC) the statement was created.

    • Database (string) --

      The name of the database.

    • DbUser (string) --

      The database user name.

    • Id (string) --

      The identifier of the SQL statement whose results are to be fetched. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.

    • SecretArn (string) --

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

    • WorkgroupName (string) --

      The serverless workgroup name. This element is not returned when connecting to a provisioned cluster.