You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::RedshiftDataAPIService::Types::ListStatementsRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing ListStatementsRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  max_results: 1,
  next_token: "String",
  statement_name: "StatementNameString",
  status: "ABORTED", # accepts ABORTED, ALL, FAILED, FINISHED, PICKED, STARTED, SUBMITTED
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#max_results ⇒ 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.

Returns:

  • (Integer) —

    The maximum number of SQL statements to return in the response.

#next_token ⇒ 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.

Returns:

  • (String) —

    A value that indicates the starting point for the next set of response records in a subsequent request.

#statement_name ⇒ String

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

Returns:

  • (String) —

    The name of the SQL statement specified as input to ExecuteStatement to identify the query.

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

    Possible values:

    • ABORTED
    • ALL
    • FAILED
    • FINISHED
    • PICKED
    • STARTED
    • SUBMITTED

Returns:

  • (String) —

    The status of the SQL statement to list.