/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::Forecast::CreateForecast

NAME

Paws::Forecast::CreateForecast - Arguments for method CreateForecast on Paws::Forecast

DESCRIPTION

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

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

SYNOPSIS

my $forecast = Paws->service('Forecast');
my $CreateForecastResponse = $forecast->CreateForecast(
  ForecastName  => 'MyName',
  PredictorArn  => 'MyArn',
  ForecastTypes => [ 'MyForecastType', ... ],    # OPTIONAL
  Tags          => [
    {
      Key   => 'MyTagKey',      # min: 1, max: 128
      Value => 'MyTagValue',    # max: 256

    },
    ...
  ],    # OPTIONAL
);

# Results:
my $ForecastArn = $CreateForecastResponse->ForecastArn;

# Returns a L<Paws::Forecast::CreateForecastResponse> 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/CreateForecast

ATTRIBUTES

REQUIRED ForecastName => Str

A name for the forecast.

ForecastTypes => ArrayRef[Str|Undef]

The quantiles at which probabilistic forecasts are generated. You can currently specify up to 5 quantiles per forecast. Accepted values include 0.01 to 0.99 (increments of .01 only) and mean. The mean forecast is different from the median (0.50) when the distribution is not symmetric (for example, Beta and Negative Binomial). The default value is ["0.1", "0.5", "0.9"].

REQUIRED PredictorArn => Str

The Amazon Resource Name (ARN) of the predictor to use to generate the forecast.

Tags => ArrayRef[Paws::Forecast::Tag]

The optional metadata that you apply to the forecast to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50.

  • For each resource, each tag key must be unique, and each tag key can have only one value.

  • Maximum key length - 128 Unicode characters in UTF-8.

  • Maximum value length - 256 Unicode characters in UTF-8.

  • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

  • Tag keys and values are case sensitive.

  • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.

SEE ALSO

This class forms part of Paws, documenting arguments for method CreateForecast 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