ListStatements
List of SQL statements. By default, only finished statements are shown. A token is returned to page through the statement list.
When you use identity-enhanced role sessions to list statements, you must provide either the
cluster-identifier or workgroup-name parameter. This ensures that the IdC user
can only access the Amazon Redshift IdC applications they are assigned. For more information, see
Trusted identity propagation overview.
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
{
"ClusterIdentifier": "string",
"Database": "string",
"MaxResults": number,
"NextToken": "string",
"RoleLevel": boolean,
"StatementName": "string",
"Status": "string",
"WorkgroupName": "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.
- ClusterIdentifier
-
The cluster identifier. Only statements that ran on this cluster are returned. When providing
ClusterIdentifier, thenWorkgroupNamecan't be specified.Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Required: No
- Database
-
The name of the database when listing statements run against a
ClusterIdentifierorWorkgroupName.Type: String
Required: No
- MaxResults
-
The maximum number of SQL statements to return in the response. If more SQL statements exist than fit in one response, then
NextTokenis 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
BatchExecuteStatementorExecuteStatementto 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 ofmyStatement. 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
Valid Values:
SUBMITTED | PICKED | STARTED | FINISHED | ABORTED | FAILED | ALLRequired: No
-
- WorkgroupName
-
The serverless workgroup name or Amazon Resource Name (ARN). Only statements that ran on this workgroup are returned. When providing
WorkgroupName, thenClusterIdentifiercan't be specified.Type: String
Length Constraints: Minimum length of 3. Maximum length of 128.
Pattern:
^(([a-z0-9-]+)|(arn:(aws(-[a-z]+)*):redshift-serverless:[a-z]{2}(-gov|(-iso[a-z]?))?-[a-z]+-\d{1}:\d{12}:workgroup/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}))$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
-
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
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
