Skip to content

List Statements

redshiftdataapiservice_list_statements R Documentation

List of SQL statements

Description

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.

Usage

redshiftdataapiservice_list_statements(MaxResults, NextToken, RoleLevel,
  StatementName, Status)

Arguments

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.

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.

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.

StatementName

The name of the SQL statement specified as input to batch_execute_statement or execute_statement 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

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.

Value

A list with the following syntax: 

list(
  NextToken = "string",
  Statements = list(
    list(
      CreatedAt = as.POSIXct(
        "2015-01-01"
      ),
      Id = "string",
      IsBatchStatement = TRUE|FALSE,
      QueryParameters = list(
        list(
          name = "string",
          value = "string"
        )
      ),
      QueryString = "string",
      QueryStrings = list(
        "string"
      ),
      SecretArn = "string",
      SessionId = "string",
      StatementName = "string",
      Status = "SUBMITTED"|"PICKED"|"STARTED"|"FINISHED"|"ABORTED"|"FAILED"|"ALL",
      UpdatedAt = as.POSIXct(
        "2015-01-01"
      )
    )
  )
)

Request syntax

svc$list_statements(
  MaxResults = 123,
  NextToken = "string",
  RoleLevel = TRUE|FALSE,
  StatementName = "string",
  Status = "SUBMITTED"|"PICKED"|"STARTED"|"FINISHED"|"ABORTED"|"FAILED"|"ALL"
)