Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListStatements

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 AWS CLI usage examples, see Using the Amazon Redshift Data API in the Amazon Redshift Management Guide.

Request Syntax


{
   "MaxResults": number,
   "NextToken": "string",
   "RoleLevel": boolean,
   "StatementName": "string",
   "Status": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Note

In the following list, the required parameters are described first.

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: Integer

Valid Range: Minimum value of 0. Maximum value of 100.

Required: No

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: String

Required: No

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: Boolean

Required: No

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: String

Length Constraints: Minimum length of 0. Maximum length of 500.

Required: No

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.

Type: String

Required: No

Response Syntax


{
   "NextToken": "string",
   "Statements": [ 
      { 
         "CreatedAt": number,
         "Id": "string",
         "IsBatchStatement": boolean,
         "QueryParameters": [ 
            { 
               "name": "string",
               "value": "string"
            }
         ],
         "QueryString": "string",
         "QueryStrings": [ "string" ],
         "ResultFormat": "string",
         "SecretArn": "string",
         "SessionId": "string",
         "StatementName": "string",
         "Status": "string",
         "UpdatedAt": number
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Statements

The SQL statements.

Type: Array of StatementData objects

NextToken

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerException

The Amazon Redshift Data API operation failed due to invalid input.

HTTP Status Code: 500

ValidationException

The Amazon Redshift Data API operation failed due to invalid input.

HTTP Status Code: 400