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

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, geolocation; OPTIONAL
      },
      ...
    ],    # min: 1, max: 100; OPTIONAL
  },
  DataFrequency    => 'MyFrequency',    # OPTIONAL
  EncryptionConfig => {
    KMSKeyArn => 'MyKMSKeyArn',         # max: 256
    RoleArn   => 'MyArn',               # max: 256

  },    # OPTIONAL
  Tags => [
    {
      Key   => 'MyTagKey',      # min: 1, max: 128
      Value => 'MyTagValue',    # 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.

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

The optional metadata that you apply to the dataset 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 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