/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::RedshiftData::ListStatements

NAME

Paws::RedshiftData::ListStatements - Arguments for method ListStatements on Paws::RedshiftData

DESCRIPTION

This class represents the parameters used for calling the method ListStatements on the Redshift Data API Service service. Use the attributes of this class as arguments to method ListStatements.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListStatements.

SYNOPSIS

my $redshift-data = Paws->service('RedshiftData');
my $ListStatementsResponse = $redshift -data->ListStatements(
  MaxResults    => 1,                          # OPTIONAL
  NextToken     => 'MyString',                 # OPTIONAL
  RoleLevel     => 1,                          # OPTIONAL
  StatementName => 'MyStatementNameString',    # OPTIONAL
  Status        => 'SUBMITTED',                # OPTIONAL
);

# Results:
my $NextToken  = $ListStatementsResponse->NextToken;
my $Statements = $ListStatementsResponse->Statements;

# Returns a L<Paws::RedshiftData::ListStatementsResponse> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/redshift-data/ListStatements

ATTRIBUTES

MaxResults => Int

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 => Str

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 => Bool

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 => Str

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.

Status => Str

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.

Valid values are: "SUBMITTED", "PICKED", "STARTED", "FINISHED", "ABORTED", "FAILED", "ALL"

SEE ALSO

This class forms part of Paws, documenting arguments for method ListStatements in Paws::RedshiftData

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues