| 1 | package Paws::ForecastQuery; | ||
| 2 | use Moose; | ||
| 3 | sub service { 'forecastquery' } | ||
| 4 | sub signing_name { 'forecast' } | ||
| 5 | sub version { '2018-06-26' } | ||
| 6 | sub target_prefix { 'AmazonForecastRuntime' } | ||
| 7 | sub json_version { "1.1" } | ||
| 8 | has max_attempts => (is => 'ro', isa => 'Int', default => 5); | ||
| 9 | has retry => (is => 'ro', isa => 'HashRef', default => sub { | ||
| 10 | { base => 'rand', type => 'exponential', growth_factor => 2 } | ||
| 11 | }); | ||
| 12 | has retriables => (is => 'ro', isa => 'ArrayRef', default => sub { [ | ||
| 13 | ] }); | ||
| 14 | |||
| 15 | with 'Paws::API::Caller', 'Paws::API::EndpointResolver', 'Paws::Net::V4Signature', 'Paws::Net::JsonCaller'; | ||
| 16 | |||
| 17 | |||
| 18 | sub QueryForecast { | ||
| 19 | my $self = shift; | ||
| 20 | my $call_object = $self->new_with_coercions('Paws::ForecastQuery::QueryForecast', @_); | ||
| 21 | return $self->caller->do_call($self, $call_object); | ||
| 22 | } | ||
| 23 | |||
| 24 | |||
| 25 | |||
| 26 | sub operations { qw/QueryForecast / } | ||
| 27 | |||
| 28 | 1; | ||
| 29 | |||
| 30 | ### main pod documentation begin ### | ||
| 31 | |||
| 32 | =head1 NAME | ||
| 33 | |||
| 34 | Paws::ForecastQuery - Perl Interface to AWS Amazon Forecast Query Service | ||
| 35 | |||
| 36 | =head1 SYNOPSIS | ||
| 37 | |||
| 38 | use Paws; | ||
| 39 | |||
| 40 | my $obj = Paws->service('ForecastQuery'); | ||
| 41 | my $res = $obj->Method( | ||
| 42 | Arg1 => $val1, | ||
| 43 | Arg2 => [ 'V1', 'V2' ], | ||
| 44 | # if Arg3 is an object, the HashRef will be used as arguments to the constructor | ||
| 45 | # of the arguments type | ||
| 46 | Arg3 => { Att1 => 'Val1' }, | ||
| 47 | # if Arg4 is an array of objects, the HashRefs will be passed as arguments to | ||
| 48 | # the constructor of the arguments type | ||
| 49 | Arg4 => [ { Att1 => 'Val1' }, { Att1 => 'Val2' } ], | ||
| 50 | ); | ||
| 51 | |||
| 52 | =head1 DESCRIPTION | ||
| 53 | |||
| 54 | Provides APIs for creating and managing Amazon Forecast resources. | ||
| 55 | |||
| 56 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/forecastquery-2018-06-26> | ||
| 57 | |||
| 58 | |||
| 59 | =head1 METHODS | ||
| 60 | |||
| 61 | =head2 QueryForecast | ||
| 62 | |||
| 63 | =over | ||
| 64 | |||
| 65 | =item Filters => L<Paws::ForecastQuery::Filters> | ||
| 66 | |||
| 67 | =item ForecastArn => Str | ||
| 68 | |||
| 69 | =item [EndDate => Str] | ||
| 70 | |||
| 71 | =item [NextToken => Str] | ||
| 72 | |||
| 73 | =item [StartDate => Str] | ||
| 74 | |||
| 75 | |||
| 76 | =back | ||
| 77 | |||
| 78 | Each argument is described in detail in: L<Paws::ForecastQuery::QueryForecast> | ||
| 79 | |||
| 80 | Returns: a L<Paws::ForecastQuery::QueryForecastResponse> instance | ||
| 81 | |||
| 82 | Retrieves a forecast for a single item, filtered by the supplied | ||
| 83 | criteria. | ||
| 84 | |||
| 85 | The criteria is a key-value pair. The key is either C<item_id> (or the | ||
| 86 | equivalent non-timestamp, non-target field) from the | ||
| 87 | C<TARGET_TIME_SERIES> dataset, or one of the forecast dimensions | ||
| 88 | specified as part of the C<FeaturizationConfig> object. | ||
| 89 | |||
| 90 | By default, C<QueryForecast> returns the complete date range for the | ||
| 91 | filtered forecast. You can request a specific date range. | ||
| 92 | |||
| 93 | To get the full forecast, use the CreateForecastExportJob | ||
| 94 | (https://docs.aws.amazon.com/en_us/forecast/latest/dg/API_CreateForecastExportJob.html) | ||
| 95 | operation. | ||
| 96 | |||
| 97 | The forecasts generated by Amazon Forecast are in the same timezone as | ||
| 98 | the dataset that was used to create the predictor. | ||
| 99 | |||
| 100 | |||
| 101 | |||
| 102 | |||
| 103 | =head1 PAGINATORS | ||
| 104 | |||
| 105 | Paginator methods are helpers that repetively call methods that return partial results | ||
| 106 | |||
| 107 | |||
| 108 | |||
| 109 | |||
| 110 | =head1 SEE ALSO | ||
| 111 | |||
| 112 | This service class forms part of L<Paws> | ||
| 113 | |||
| 114 | =head1 BUGS and CONTRIBUTIONS | ||
| 115 | |||
| 116 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 117 | |||
| 118 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 119 | |||
| 120 | =cut | ||
| 121 |