NAME

Paws::ForecastQuery::QueryForecast - Arguments for method QueryForecast on Paws::ForecastQuery

DESCRIPTION

This class represents the parameters used for calling the method QueryForecast on the Amazon Forecast Query Service service. Use the attributes of this class as arguments to method QueryForecast.

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

SYNOPSIS

my $forecastquery = Paws->service('ForecastQuery');
my $QueryForecastResponse = $forecastquery->QueryForecast(
  Filters => {
    'MyAttributeName' =>
      'MyAttributeValue',    # key: max: 256, value: max: 256
  },
  ForecastArn => 'MyArn',
  EndDate     => 'MyDateTime',     # OPTIONAL
  NextToken   => 'MyNextToken',    # OPTIONAL
  StartDate   => 'MyDateTime',     # OPTIONAL
);

# Results:
my $Forecast = $QueryForecastResponse->Forecast;

# Returns a L<Paws::ForecastQuery::QueryForecastResponse> 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/forecastquery/QueryForecast

ATTRIBUTES

EndDate => Str

The end date for the forecast. Specify the date using this format: yyyy-MM-dd'T'HH:mm:ss (ISO 8601 format). For example, 2015-01-01T20:00:00.

REQUIRED Filters => Paws::ForecastQuery::Filters

The filtering criteria to apply when retrieving the forecast. For example, to get the forecast for client_21 in the electricity usage dataset, specify the following:

{"item_id" : "client_21"}

To get the full forecast, use the CreateForecastExportJob (https://docs.aws.amazon.com/en_us/forecast/latest/dg/API_CreateForecastExportJob.html) operation.

REQUIRED ForecastArn => Str

The Amazon Resource Name (ARN) of the forecast to query.

NextToken => Str

If the result of the previous request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.

StartDate => Str

The start date for the forecast. Specify the date using this format: yyyy-MM-dd'T'HH:mm:ss (ISO 8601 format). For example, 2015-01-01T08:00:00.

SEE ALSO

This class forms part of Paws, documenting arguments for method QueryForecast in Paws::ForecastQuery

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