RedshiftDataAPIService / Client / list_statements

list_statements#

RedshiftDataAPIService.Client.list_statements(**kwargs)#

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

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.list_statements(
    MaxResults=123,
    NextToken='string',
    RoleLevel=True|False,
    StatementName='string',
    Status='SUBMITTED'|'PICKED'|'STARTED'|'FINISHED'|'ABORTED'|'FAILED'|'ALL'
)
Parameters:

  • MaxResults (integer) – 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.

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

  • RoleLevel (boolean) – 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.

  • StatementName (string) – 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.

  • Status (string) –

    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.

Return type:

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',
            ],
            'ResultFormat': 'JSON'|'CSV',
            'SecretArn': 'string',
            'SessionId': '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 information, 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) –

        • ResultFormat (string) –

          The data format of the result of the SQL statement.

        • SecretArn (string) –

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

        • SessionId (string) –

          The session identifier of the query.

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

Exceptions