RedshiftDataAPIService / Client / describe_statement

describe_statement

RedshiftDataAPIService.Client.describe_statement(**kwargs)

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.

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

response = client.describe_statement(
    Id='string'
)
Parameters:

Id (string) –

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

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • Id (string) –

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

    • SecretArn (string) –

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

    • DbUser (string) –

      The database user name.

    • Database (string) –

      The name of the database.

    • ClusterIdentifier (string) –

      The cluster identifier.

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

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

    • CreatedAt (datetime) –

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

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

    • RedshiftPid (integer) –

      The process identifier from Amazon Redshift.

    • HasResultSet (boolean) –

      A value that indicates whether the statement has a result set. The result set can be empty. The value is true for an empty result set. The value is true if any substatement returns a result set.

    • QueryString (string) –

      The SQL statement text.

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

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

    • 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 information, see Data types in the Amazon Redshift Database Developer Guide.

    • SubStatements (list) –

      The SQL statements from a multiple statement run.

      • (dict) –

        Information about an SQL statement.

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

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

        • Status (string) –

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

        • CreatedAt (datetime) –

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

        • UpdatedAt (datetime) –

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

        • QueryString (string) –

          The SQL statement text.

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

        • RedshiftQueryId (integer) –

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

        • HasResultSet (boolean) –

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

    • WorkgroupName (string) –

      The serverless workgroup name or Amazon Resource Name (ARN).

    • ResultFormat (string) –

      The data format of the result of the SQL statement.

    • SessionId (string) –

      The session identifier of the query.

Exceptions