« blib/lib/Paws/RedshiftData/ListSchemasResponse.pm
↑ Summary
blib/lib/Paws/RedshiftData/ListStatementsResponse.pm »
| 1 | |||
| 2 | package Paws::RedshiftData::ListStatements; | ||
| 3 | use Moose; | ||
| 4 | has MaxResults => (is => 'ro', isa => 'Int'); | ||
| 5 | has NextToken => (is => 'ro', isa => 'Str'); | ||
| 6 | has RoleLevel => (is => 'ro', isa => 'Bool'); | ||
| 7 | has StatementName => (is => 'ro', isa => 'Str'); | ||
| 8 | has Status => (is => 'ro', isa => 'Str'); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListStatements'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RedshiftData::ListStatementsResponse'); | ||
| 14 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::RedshiftData::ListStatements - Arguments for method ListStatements on L<Paws::RedshiftData> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method ListStatements on the | ||
| 26 | L<Redshift Data API Service|Paws::RedshiftData> service. Use the attributes of this class | ||
| 27 | as arguments to method ListStatements. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListStatements. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $redshift-data = Paws->service('RedshiftData'); | ||
| 34 | my $ListStatementsResponse = $redshift -data->ListStatements( | ||
| 35 | MaxResults => 1, # OPTIONAL | ||
| 36 | NextToken => 'MyString', # OPTIONAL | ||
| 37 | RoleLevel => 1, # OPTIONAL | ||
| 38 | StatementName => 'MyStatementNameString', # OPTIONAL | ||
| 39 | Status => 'SUBMITTED', # OPTIONAL | ||
| 40 | ); | ||
| 41 | |||
| 42 | # Results: | ||
| 43 | my $NextToken = $ListStatementsResponse->NextToken; | ||
| 44 | my $Statements = $ListStatementsResponse->Statements; | ||
| 45 | |||
| 46 | # Returns a L<Paws::RedshiftData::ListStatementsResponse> object. | ||
| 47 | |||
| 48 | 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. | ||
| 49 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/redshift-data/ListStatements> | ||
| 50 | |||
| 51 | =head1 ATTRIBUTES | ||
| 52 | |||
| 53 | |||
| 54 | =head2 MaxResults => Int | ||
| 55 | |||
| 56 | The maximum number of SQL statements to return in the response. If more | ||
| 57 | SQL statements exist than fit in one response, then C<NextToken> is | ||
| 58 | returned to page through the results. | ||
| 59 | |||
| 60 | |||
| 61 | |||
| 62 | =head2 NextToken => Str | ||
| 63 | |||
| 64 | A value that indicates the starting point for the next set of response | ||
| 65 | records in a subsequent request. If a value is returned in a response, | ||
| 66 | you can retrieve the next set of records by providing this returned | ||
| 67 | NextToken value in the next NextToken parameter and retrying the | ||
| 68 | command. If the NextToken field is empty, all response records have | ||
| 69 | been retrieved for the request. | ||
| 70 | |||
| 71 | |||
| 72 | |||
| 73 | =head2 RoleLevel => Bool | ||
| 74 | |||
| 75 | A value that filters which statements to return in the response. If | ||
| 76 | true, all statements run by the caller's IAM role are returned. If | ||
| 77 | false, only statements run by the caller's IAM role in the current IAM | ||
| 78 | session are returned. The default is true. | ||
| 79 | |||
| 80 | |||
| 81 | |||
| 82 | =head2 StatementName => Str | ||
| 83 | |||
| 84 | The name of the SQL statement specified as input to C<ExecuteStatement> | ||
| 85 | to identify the query. You can list multiple statements by providing a | ||
| 86 | prefix that matches the beginning of the statement name. For example, | ||
| 87 | to list myStatement1, myStatement2, myStatement3, and so on, then | ||
| 88 | provide the a value of C<myStatement>. Data API does a case-sensitive | ||
| 89 | match of SQL statement names to the prefix value you provide. | ||
| 90 | |||
| 91 | |||
| 92 | |||
| 93 | =head2 Status => Str | ||
| 94 | |||
| 95 | The status of the SQL statement to list. Status values are defined as | ||
| 96 | follows: | ||
| 97 | |||
| 98 | =over | ||
| 99 | |||
| 100 | =item * | ||
| 101 | |||
| 102 | ABORTED - The query run was stopped by the user. | ||
| 103 | |||
| 104 | =item * | ||
| 105 | |||
| 106 | ALL - A status value that includes all query statuses. This value can | ||
| 107 | be used to filter results. | ||
| 108 | |||
| 109 | =item * | ||
| 110 | |||
| 111 | FAILED - The query run failed. | ||
| 112 | |||
| 113 | =item * | ||
| 114 | |||
| 115 | FINISHED - The query has finished running. | ||
| 116 | |||
| 117 | =item * | ||
| 118 | |||
| 119 | PICKED - The query has been chosen to be run. | ||
| 120 | |||
| 121 | =item * | ||
| 122 | |||
| 123 | STARTED - The query run has started. | ||
| 124 | |||
| 125 | =item * | ||
| 126 | |||
| 127 | SUBMITTED - The query was submitted, but not yet processed. | ||
| 128 | |||
| 129 | =back | ||
| 130 | |||
| 131 | |||
| 132 | Valid values are: C<"SUBMITTED">, C<"PICKED">, C<"STARTED">, C<"FINISHED">, C<"ABORTED">, C<"FAILED">, C<"ALL"> | ||
| 133 | |||
| 134 | |||
| 135 | =head1 SEE ALSO | ||
| 136 | |||
| 137 | This class forms part of L<Paws>, documenting arguments for method ListStatements in L<Paws::RedshiftData> | ||
| 138 | |||
| 139 | =head1 BUGS and CONTRIBUTIONS | ||
| 140 | |||
| 141 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 142 | |||
| 143 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 144 | |||
| 145 | =cut | ||
| 146 |