The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.

NAME

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

DESCRIPTION

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

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

SYNOPSIS

    my $forecast = Paws->service('Forecast');
    my $CreateDatasetResponse = $forecast->CreateDataset(
      DatasetName => 'MyName',
      DatasetType => 'TARGET_TIME_SERIES',
      Domain      => 'RETAIL',
      Schema      => {
        Attributes => [
          {
            AttributeName => 'MyName',    # min: 1, max: 63
            AttributeType =>
              'string',    # values: string, integer, float, timestamp; OPTIONAL
          },
          ...
        ],                 # OPTIONAL
      },
      DataFrequency    => 'MyFrequency',    # OPTIONAL
      EncryptionConfig => {
        KMSKeyArn => 'MyKMSKeyArn',         # max: 256
        RoleArn   => 'MyArn',               # max: 256

      },    # OPTIONAL
    );

    # Results:
    my $DatasetArn = $CreateDatasetResponse->DatasetArn;

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

ATTRIBUTES

DataFrequency => Str

The frequency of data collection. This parameter is required for RELATED_TIME_SERIES datasets.

Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, "D" indicates every day and "15min" indicates every 15 minutes.

REQUIRED DatasetName => Str

A name for the dataset.

REQUIRED DatasetType => Str

The dataset type. Valid values depend on the chosen Domain.

Valid values are: "TARGET_TIME_SERIES", "RELATED_TIME_SERIES", "ITEM_METADATA"

REQUIRED Domain => Str

The domain associated with the dataset. When you add a dataset to a dataset group, this value and the value specified for the Domain parameter of the CreateDatasetGroup operation must match.

The Domain and DatasetType that you choose determine the fields that must be present in the training data that you import to the dataset. For example, if you choose the RETAIL domain and TARGET_TIME_SERIES as the DatasetType, Amazon Forecast requires item_id, timestamp, and demand fields to be present in your data. For more information, see howitworks-datasets-groups.

Valid values are: "RETAIL", "CUSTOM", "INVENTORY_PLANNING", "EC2_CAPACITY", "WORK_FORCE", "WEB_TRAFFIC", "METRICS"

EncryptionConfig => Paws::Forecast::EncryptionConfig

An AWS Key Management Service (KMS) key and the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.

REQUIRED Schema => Paws::Forecast::Schema

The schema for the dataset. The schema attributes and their order must match the fields in your data. The dataset Domain and DatasetType that you choose determine the minimum required fields in your training data. For information about the required fields for a specific dataset domain and type, see howitworks-domains-ds-types.

SEE ALSO

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