Redshift Data API Service

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 - specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret.

• Temporary credentials - specify the cluster identifier, the database name, and the database user name. Permission to call the redshift:GetClusterCredentials operation is required to use this method.

See also: AWS API Documentation

Request Syntax

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

type ClusterIdentifier

string

param ClusterIdentifier

[REQUIRED]

The cluster identifier. This parameter is required when 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 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.

• (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.

rtype

dict

returns

Response Syntax

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

Response Structure

• (dict) --

  • ClusterIdentifier (string) --

    The cluster identifier.

  • 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.

{'SubStatements': [{'CreatedAt': 'timestamp',
                    'Duration': 'long',
                    'Error': 'string',
                    'HasResultSet': 'boolean',
                    'Id': 'string',
                    'QueryString': 'string',
                    'RedshiftQueryId': 'long',
                    'ResultRows': 'long',
                    'ResultSize': 'long',
                    'Status': 'SUBMITTED | PICKED | STARTED | FINISHED | '
                              'ABORTED | FAILED',
                    'UpdatedAt': 'timestamp'}]}

Describes the details about a specific instance when a query was run by the Amazon Redshift Data API. The information includes when the query started, when it finished, the query status, the number of rows returned, and the SQL statement.

See also: AWS API Documentation

Request Syntax

client.describe_statement(
    Id='string'
)

type Id

string

param Id

[REQUIRED]

The identifier of the SQL statement to describe. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. A suffix indicates the number of the SQL statement. For example, d9b6c0c9-0747-4bf4-b142-e8883122f766:2 has a suffix of :2 that indicates the second SQL statement of a batch query. This identifier is returned by BatchExecuteStatment , ExecuteStatement , and ListStatements .

rtype

dict

returns

Response Syntax

{
    'ClusterIdentifier': 'string',
    'CreatedAt': datetime(2015, 1, 1),
    'Database': 'string',
    'DbUser': 'string',
    'Duration': 123,
    'Error': 'string',
    'HasResultSet': True|False,
    'Id': 'string',
    'QueryParameters': [
        {
            'name': 'string',
            'value': 'string'
        },
    ],
    'QueryString': 'string',
    'RedshiftPid': 123,
    'RedshiftQueryId': 123,
    'ResultRows': 123,
    'ResultSize': 123,
    'SecretArn': 'string',
    'Status': 'SUBMITTED'|'PICKED'|'STARTED'|'FINISHED'|'ABORTED'|'FAILED'|'ALL',
    'SubStatements': [
        {
            'CreatedAt': datetime(2015, 1, 1),
            'Duration': 123,
            'Error': 'string',
            'HasResultSet': True|False,
            'Id': 'string',
            'QueryString': 'string',
            'RedshiftQueryId': 123,
            'ResultRows': 123,
            'ResultSize': 123,
            'Status': 'SUBMITTED'|'PICKED'|'STARTED'|'FINISHED'|'ABORTED'|'FAILED',
            'UpdatedAt': datetime(2015, 1, 1)
        },
    ],
    'UpdatedAt': datetime(2015, 1, 1)
}

Response Structure

• (dict) --

  • ClusterIdentifier (string) --

    The cluster identifier.

  • CreatedAt (datetime) --

    The date and time (UTC) when the SQL statement was submitted to run.

  • Database (string) --

    The name of the database.

  • DbUser (string) --

    The database user name.

  • Duration (integer) --

    The amount of time in nanoseconds that the statement ran.

  • Error (string) --

    The error message from the cluster if the SQL statement encountered an error while running.

  • HasResultSet (boolean) --

    A value that indicates whether the statement has a result set. The result set can be empty.

  • Id (string) --

    The identifier of the SQL statement described. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.

  • QueryParameters (list) --

    The parameters for the SQL statement.

    • (dict) --

      A parameter used in a SQL statement.

      • name (string) --

        The name of the parameter.

      • value (string) --

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

  • QueryString (string) --

    The SQL statement text.

  • RedshiftPid (integer) --

    The process identifier from Amazon Redshift.

  • RedshiftQueryId (integer) --

    The identifier of the query generated by Amazon Redshift. These identifiers are also available in the query column of the STL_QUERY system view.

  • ResultRows (integer) --

    Either the number of rows returned from the SQL statement or the number of rows affected. If result size is greater than zero, the result rows can be the number of rows affected by SQL statements such as INSERT, UPDATE, DELETE, COPY, and others. A -1 indicates the value is null.

  • ResultSize (integer) --

    The size in bytes of the returned results. A -1 indicates the value is null.

  • SecretArn (string) --

    The name or Amazon Resource Name (ARN) of the secret that enables access to the database.

  • Status (string) --

    The status of the SQL statement being described. Status values are defined as follows:

    • ABORTED - The query run was stopped by the user.

    • ALL - A status value that includes all query statuses. This value can be used to filter results.

    • FAILED - The query run failed.

    • FINISHED - The query has finished running.

    • PICKED - The query has been chosen to be run.

    • STARTED - The query run has started.

    • SUBMITTED - The query was submitted, but not yet processed.

  • SubStatements (list) --

    The SQL statements from a multiple statement run.

    • (dict) --

      Information about an SQL statement.

      • CreatedAt (datetime) --

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

      • Duration (integer) --

        The amount of time in nanoseconds that the statement ran.

      • Error (string) --

        The error message from the cluster if the SQL statement encountered an error while running.

      • HasResultSet (boolean) --

        A value that indicates whether the statement has a result set. The result set can be empty.

      • Id (string) --

        The identifier of the SQL statement. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. A suffix indicates the number of the SQL statement. For example, d9b6c0c9-0747-4bf4-b142-e8883122f766:2 has a suffix of :2 that indicates the second SQL statement of a batch query.

      • QueryString (string) --

        The SQL statement text.

      • RedshiftQueryId (integer) --

        The SQL statement identifier. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.

      • ResultRows (integer) --

        Either the number of rows returned from the SQL statement or the number of rows affected. If result size is greater than zero, the result rows can be the number of rows affected by SQL statements such as INSERT, UPDATE, DELETE, COPY, and others. A -1 indicates the value is null.

      • ResultSize (integer) --

        The size in bytes of the returned results. A -1 indicates the value is null.

      • Status (string) --

        The status of the SQL statement. An example is the that the SQL statement finished.

      • UpdatedAt (datetime) --

        The date and time (UTC) that the statement metadata was last updated.

  • UpdatedAt (datetime) --

    The date and time (UTC) that the metadata for the SQL statement was last updated. An example is the time the status last changed.

{'Statements': {'IsBatchStatement': 'boolean', 'QueryStrings': ['string']}}

List of SQL statements. By default, only finished statements are shown. A token is returned to page through the statement list.

See also: AWS API Documentation

Request Syntax

client.list_statements(
    MaxResults=123,
    NextToken='string',
    RoleLevel=True|False,
    StatementName='string',
    Status='SUBMITTED'|'PICKED'|'STARTED'|'FINISHED'|'ABORTED'|'FAILED'|'ALL'
)

type MaxResults

integer

param MaxResults

The maximum number of SQL statements to return in the response. If more SQL statements exist than fit in one response, then NextToken is returned to page through the results.

type NextToken

string

param NextToken

A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.

type RoleLevel

boolean

param RoleLevel

A value that filters which statements to return in the response. If true, all statements run by the caller's IAM role are returned. If false, only statements run by the caller's IAM role in the current IAM session are returned. The default is true.

type StatementName

string

param StatementName

The name of the SQL statement specified as input to BatchExecuteStatement or ExecuteStatement to identify the query. You can list multiple statements by providing a prefix that matches the beginning of the statement name. For example, to list myStatement1, myStatement2, myStatement3, and so on, then provide the a value of myStatement . Data API does a case-sensitive match of SQL statement names to the prefix value you provide.

type Status

string

param Status

The status of the SQL statement to list. Status values are defined as follows:

• ABORTED - The query run was stopped by the user.

• ALL - A status value that includes all query statuses. This value can be used to filter results.

• FAILED - The query run failed.

• FINISHED - The query has finished running.

• PICKED - The query has been chosen to be run.

• STARTED - The query run has started.

• SUBMITTED - The query was submitted, but not yet processed.

rtype

dict

returns

Response Syntax

{
    'NextToken': 'string',
    'Statements': [
        {
            'CreatedAt': datetime(2015, 1, 1),
            'Id': 'string',
            'IsBatchStatement': True|False,
            'QueryParameters': [
                {
                    'name': 'string',
                    'value': 'string'
                },
            ],
            'QueryString': 'string',
            'QueryStrings': [
                'string',
            ],
            'SecretArn': 'string',
            'StatementName': 'string',
            'Status': 'SUBMITTED'|'PICKED'|'STARTED'|'FINISHED'|'ABORTED'|'FAILED'|'ALL',
            'UpdatedAt': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

• (dict) --

  • NextToken (string) --

    A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.

  • Statements (list) --

    The SQL statements.

    • (dict) --

      The SQL statement to run.

      • CreatedAt (datetime) --

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

      • Id (string) --

        The SQL statement identifier. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.

      • IsBatchStatement (boolean) --

        A value that indicates whether the statement is a batch query request.

      • QueryParameters (list) --

        The parameters used in a SQL statement.

        • (dict) --

          A parameter used in a SQL statement.

          • name (string) --

            The name of the parameter.

          • value (string) --

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

      • QueryString (string) --

        The SQL statement.

      • QueryStrings (list) --

        One or more SQL statements. Each query string in the array corresponds to one of the queries in a batch query request.

        • (string) --

      • SecretArn (string) --

        The name or Amazon Resource Name (ARN) of the secret that enables access to the database.

      • StatementName (string) --

        The name of the SQL statement.

      • Status (string) --

        The status of the SQL statement. An example is the that the SQL statement finished.

      • UpdatedAt (datetime) --

        The date and time (UTC) that the statement metadata was last updated.