NAME
Paws::Forecast::ListForecasts - Arguments for method ListForecasts on Paws::Forecast
DESCRIPTION
This class represents the parameters used for calling the method ListForecasts on the Amazon Forecast Service service. Use the attributes of this class as arguments to method ListForecasts.
You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListForecasts.
SYNOPSIS
my $forecast = Paws->service('Forecast');
my $ListForecastsResponse = $forecast->ListForecasts(
Filters => [
{
Condition => 'IS', # values: IS, IS_NOT
Key => 'MyString', # max: 256
Value => 'MyArn', # max: 256
},
...
], # OPTIONAL
MaxResults => 1, # OPTIONAL
NextToken => 'MyNextToken', # OPTIONAL
);
# Results:
my $Forecasts = $ListForecastsResponse->Forecasts;
my $NextToken = $ListForecastsResponse->NextToken;
# Returns a L<Paws::Forecast::ListForecastsResponse> 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/forecast/ListForecasts
ATTRIBUTES
Filters => ArrayRef[Paws::Forecast::Filter]
An array of filters. For each filter, you provide a condition and a match statement. The condition is either IS
or IS_NOT
, which specifies whether to include or exclude the forecasts that match the statement from the list, respectively. The match statement consists of a key and a value.
Filter properties
Condition
- The condition to apply. Valid values areIS
andIS_NOT
. To include the forecasts that match the statement, specifyIS
. To exclude matching forecasts, specifyIS_NOT
.Key
- The name of the parameter to filter on. Valid values areDatasetGroupArn
,PredictorArn
, andStatus
.Value
- The value to match.
For example, to list all forecasts whose status is not ACTIVE, you would specify:
"Filters": [ { "Condition": "IS_NOT", "Key": "Status", "Value": "ACTIVE" } ]
MaxResults => Int
The number of items to return in the response.
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.
SEE ALSO
This class forms part of Paws, documenting arguments for method ListForecasts in Paws::Forecast
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