« blib/lib/Paws/TimestreamQuery/Endpoint.pm
↑ Summary
blib/lib/Paws/TimestreamQuery/QueryResponse.pm »
| 1 | |||
| 2 | package Paws::TimestreamQuery::Query; | ||
| 3 | use Moose; | ||
| 4 | has ClientToken => (is => 'ro', isa => 'Str'); | ||
| 5 | has MaxRows => (is => 'ro', isa => 'Int'); | ||
| 6 | has NextToken => (is => 'ro', isa => 'Str'); | ||
| 7 | has QueryString => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'Query'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::TimestreamQuery::QueryResponse'); | ||
| 13 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::TimestreamQuery::Query - Arguments for method Query on L<Paws::TimestreamQuery> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method Query on the | ||
| 25 | L<Amazon Timestream Query|Paws::TimestreamQuery> service. Use the attributes of this class | ||
| 26 | as arguments to method Query. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to Query. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $query.timestream = Paws->service('TimestreamQuery'); | ||
| 33 | my $QueryResponse = $query . timestream->Query( | ||
| 34 | QueryString => 'MyQueryString', | ||
| 35 | ClientToken => 'MyClientRequestToken', # OPTIONAL | ||
| 36 | MaxRows => 1, # OPTIONAL | ||
| 37 | NextToken => 'MyString', # OPTIONAL | ||
| 38 | ); | ||
| 39 | |||
| 40 | # Results: | ||
| 41 | my $ColumnInfo = $QueryResponse->ColumnInfo; | ||
| 42 | my $NextToken = $QueryResponse->NextToken; | ||
| 43 | my $QueryId = $QueryResponse->QueryId; | ||
| 44 | my $QueryStatus = $QueryResponse->QueryStatus; | ||
| 45 | my $Rows = $QueryResponse->Rows; | ||
| 46 | |||
| 47 | # Returns a L<Paws::TimestreamQuery::QueryResponse> object. | ||
| 48 | |||
| 49 | 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. | ||
| 50 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/query.timestream/Query> | ||
| 51 | |||
| 52 | =head1 ATTRIBUTES | ||
| 53 | |||
| 54 | |||
| 55 | =head2 ClientToken => Str | ||
| 56 | |||
| 57 | Unique, case-sensitive string of up to 64 ASCII characters that you | ||
| 58 | specify when you make a Query request. Providing a C<ClientToken> makes | ||
| 59 | the call to C<Query> idempotent, meaning that multiple identical calls | ||
| 60 | have the same effect as one single call. | ||
| 61 | |||
| 62 | Your query request will fail in the following cases: | ||
| 63 | |||
| 64 | =over | ||
| 65 | |||
| 66 | =item * | ||
| 67 | |||
| 68 | If you submit a request with the same client token outside the 5-minute | ||
| 69 | idepotency window. | ||
| 70 | |||
| 71 | =item * | ||
| 72 | |||
| 73 | If you submit a request with the same client token but a change in | ||
| 74 | other parameters within the 5-minute idempotency window. | ||
| 75 | |||
| 76 | =back | ||
| 77 | |||
| 78 | After 4 hours, any request with the same client token is treated as a | ||
| 79 | new request. | ||
| 80 | |||
| 81 | |||
| 82 | |||
| 83 | =head2 MaxRows => Int | ||
| 84 | |||
| 85 | The total number of rows to return in the output. If the total number | ||
| 86 | of rows available is more than the value specified, a NextToken is | ||
| 87 | provided in the command's output. To resume pagination, provide the | ||
| 88 | NextToken value in the starting-token argument of a subsequent command. | ||
| 89 | |||
| 90 | |||
| 91 | |||
| 92 | =head2 NextToken => Str | ||
| 93 | |||
| 94 | A pagination token passed to get a set of results. | ||
| 95 | |||
| 96 | |||
| 97 | |||
| 98 | =head2 B<REQUIRED> QueryString => Str | ||
| 99 | |||
| 100 | The query to be executed by Timestream. | ||
| 101 | |||
| 102 | |||
| 103 | |||
| 104 | |||
| 105 | =head1 SEE ALSO | ||
| 106 | |||
| 107 | This class forms part of L<Paws>, documenting arguments for method Query in L<Paws::TimestreamQuery> | ||
| 108 | |||
| 109 | =head1 BUGS and CONTRIBUTIONS | ||
| 110 | |||
| 111 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 112 | |||
| 113 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 114 | |||
| 115 | =cut | ||
| 116 |