« blib/lib/Paws/ForecastQuery/Predictions.pm
↑ Summary
blib/lib/Paws/ForecastQuery/QueryForecastResponse.pm »
| 1 | |||
| 2 | package Paws::ForecastQuery::QueryForecast; | ||
| 3 | use Moose; | ||
| 4 | has EndDate => (is => 'ro', isa => 'Str'); | ||
| 5 | has Filters => (is => 'ro', isa => 'Paws::ForecastQuery::Filters', required => 1); | ||
| 6 | has ForecastArn => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has NextToken => (is => 'ro', isa => 'Str'); | ||
| 8 | has StartDate => (is => 'ro', isa => 'Str'); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'QueryForecast'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ForecastQuery::QueryForecastResponse'); | ||
| 14 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::ForecastQuery::QueryForecast - Arguments for method QueryForecast on L<Paws::ForecastQuery> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method QueryForecast on the | ||
| 26 | L<Amazon Forecast Query Service|Paws::ForecastQuery> service. Use the attributes of this class | ||
| 27 | as arguments to method QueryForecast. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to QueryForecast. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $forecastquery = Paws->service('ForecastQuery'); | ||
| 34 | my $QueryForecastResponse = $forecastquery->QueryForecast( | ||
| 35 | Filters => { | ||
| 36 | 'MyAttributeName' => | ||
| 37 | 'MyAttributeValue', # key: max: 256, value: max: 256 | ||
| 38 | }, | ||
| 39 | ForecastArn => 'MyArn', | ||
| 40 | EndDate => 'MyDateTime', # OPTIONAL | ||
| 41 | NextToken => 'MyNextToken', # OPTIONAL | ||
| 42 | StartDate => 'MyDateTime', # OPTIONAL | ||
| 43 | ); | ||
| 44 | |||
| 45 | # Results: | ||
| 46 | my $Forecast = $QueryForecastResponse->Forecast; | ||
| 47 | |||
| 48 | # Returns a L<Paws::ForecastQuery::QueryForecastResponse> object. | ||
| 49 | |||
| 50 | 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. | ||
| 51 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/forecastquery/QueryForecast> | ||
| 52 | |||
| 53 | =head1 ATTRIBUTES | ||
| 54 | |||
| 55 | |||
| 56 | =head2 EndDate => Str | ||
| 57 | |||
| 58 | The end date for the forecast. Specify the date using this format: | ||
| 59 | yyyy-MM-dd'T'HH:mm:ss (ISO 8601 format). For example, | ||
| 60 | 2015-01-01T20:00:00. | ||
| 61 | |||
| 62 | |||
| 63 | |||
| 64 | =head2 B<REQUIRED> Filters => L<Paws::ForecastQuery::Filters> | ||
| 65 | |||
| 66 | The filtering criteria to apply when retrieving the forecast. For | ||
| 67 | example, to get the forecast for C<client_21> in the electricity usage | ||
| 68 | dataset, specify the following: | ||
| 69 | |||
| 70 | C<{"item_id" : "client_21"}> | ||
| 71 | |||
| 72 | To get the full forecast, use the CreateForecastExportJob | ||
| 73 | (https://docs.aws.amazon.com/en_us/forecast/latest/dg/API_CreateForecastExportJob.html) | ||
| 74 | operation. | ||
| 75 | |||
| 76 | |||
| 77 | |||
| 78 | =head2 B<REQUIRED> ForecastArn => Str | ||
| 79 | |||
| 80 | The Amazon Resource Name (ARN) of the forecast to query. | ||
| 81 | |||
| 82 | |||
| 83 | |||
| 84 | =head2 NextToken => Str | ||
| 85 | |||
| 86 | If the result of the previous request was truncated, the response | ||
| 87 | includes a C<NextToken>. To retrieve the next set of results, use the | ||
| 88 | token in the next request. Tokens expire after 24 hours. | ||
| 89 | |||
| 90 | |||
| 91 | |||
| 92 | =head2 StartDate => Str | ||
| 93 | |||
| 94 | The start date for the forecast. Specify the date using this format: | ||
| 95 | yyyy-MM-dd'T'HH:mm:ss (ISO 8601 format). For example, | ||
| 96 | 2015-01-01T08:00:00. | ||
| 97 | |||
| 98 | |||
| 99 | |||
| 100 | |||
| 101 | =head1 SEE ALSO | ||
| 102 | |||
| 103 | This class forms part of L<Paws>, documenting arguments for method QueryForecast in L<Paws::ForecastQuery> | ||
| 104 | |||
| 105 | =head1 BUGS and CONTRIBUTIONS | ||
| 106 | |||
| 107 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 108 | |||
| 109 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 110 | |||
| 111 | =cut | ||
| 112 |