« blib/lib/Paws/Forecast/DescribeDatasetImportJobResponse.pm
↑ Summary
blib/lib/Paws/Forecast/DescribeForecast.pm »
| 1 | |||
| 2 | package Paws::Forecast::DescribeDatasetResponse; | ||
| 3 | use Moose; | ||
| 4 | has CreationTime => (is => 'ro', isa => 'Str'); | ||
| 5 | has DataFrequency => (is => 'ro', isa => 'Str'); | ||
| 6 | has DatasetArn => (is => 'ro', isa => 'Str'); | ||
| 7 | has DatasetName => (is => 'ro', isa => 'Str'); | ||
| 8 | has DatasetType => (is => 'ro', isa => 'Str'); | ||
| 9 | has Domain => (is => 'ro', isa => 'Str'); | ||
| 10 | has EncryptionConfig => (is => 'ro', isa => 'Paws::Forecast::EncryptionConfig'); | ||
| 11 | has LastModificationTime => (is => 'ro', isa => 'Str'); | ||
| 12 | has Schema => (is => 'ro', isa => 'Paws::Forecast::Schema'); | ||
| 13 | has Status => (is => 'ro', isa => 'Str'); | ||
| 14 | |||
| 15 | has _request_id => (is => 'ro', isa => 'Str'); | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::Forecast::DescribeDatasetResponse | ||
| 22 | |||
| 23 | =head1 ATTRIBUTES | ||
| 24 | |||
| 25 | |||
| 26 | =head2 CreationTime => Str | ||
| 27 | |||
| 28 | When the dataset was created. | ||
| 29 | |||
| 30 | |||
| 31 | =head2 DataFrequency => Str | ||
| 32 | |||
| 33 | The frequency of data collection. | ||
| 34 | |||
| 35 | Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), | ||
| 36 | 30min (30 minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 | ||
| 37 | minutes), and 1min (1 minute). For example, "M" indicates every month | ||
| 38 | and "30min" indicates every 30 minutes. | ||
| 39 | |||
| 40 | |||
| 41 | =head2 DatasetArn => Str | ||
| 42 | |||
| 43 | The Amazon Resource Name (ARN) of the dataset. | ||
| 44 | |||
| 45 | |||
| 46 | =head2 DatasetName => Str | ||
| 47 | |||
| 48 | The name of the dataset. | ||
| 49 | |||
| 50 | |||
| 51 | =head2 DatasetType => Str | ||
| 52 | |||
| 53 | The dataset type. | ||
| 54 | |||
| 55 | Valid values are: C<"TARGET_TIME_SERIES">, C<"RELATED_TIME_SERIES">, C<"ITEM_METADATA"> | ||
| 56 | =head2 Domain => Str | ||
| 57 | |||
| 58 | The domain associated with the dataset. | ||
| 59 | |||
| 60 | Valid values are: C<"RETAIL">, C<"CUSTOM">, C<"INVENTORY_PLANNING">, C<"EC2_CAPACITY">, C<"WORK_FORCE">, C<"WEB_TRAFFIC">, C<"METRICS"> | ||
| 61 | =head2 EncryptionConfig => L<Paws::Forecast::EncryptionConfig> | ||
| 62 | |||
| 63 | The AWS Key Management Service (KMS) key and the AWS Identity and | ||
| 64 | Access Management (IAM) role that Amazon Forecast can assume to access | ||
| 65 | the key. | ||
| 66 | |||
| 67 | |||
| 68 | =head2 LastModificationTime => Str | ||
| 69 | |||
| 70 | When you create a dataset, C<LastModificationTime> is the same as | ||
| 71 | C<CreationTime>. While data is being imported to the dataset, | ||
| 72 | C<LastModificationTime> is the current time of the C<DescribeDataset> | ||
| 73 | call. After a CreateDatasetImportJob operation has finished, | ||
| 74 | C<LastModificationTime> is when the import job completed or failed. | ||
| 75 | |||
| 76 | |||
| 77 | =head2 Schema => L<Paws::Forecast::Schema> | ||
| 78 | |||
| 79 | An array of C<SchemaAttribute> objects that specify the dataset fields. | ||
| 80 | Each C<SchemaAttribute> specifies the name and data type of a field. | ||
| 81 | |||
| 82 | |||
| 83 | =head2 Status => Str | ||
| 84 | |||
| 85 | The status of the dataset. States include: | ||
| 86 | |||
| 87 | =over | ||
| 88 | |||
| 89 | =item * | ||
| 90 | |||
| 91 | C<ACTIVE> | ||
| 92 | |||
| 93 | =item * | ||
| 94 | |||
| 95 | C<CREATE_PENDING>, C<CREATE_IN_PROGRESS>, C<CREATE_FAILED> | ||
| 96 | |||
| 97 | =item * | ||
| 98 | |||
| 99 | C<DELETE_PENDING>, C<DELETE_IN_PROGRESS>, C<DELETE_FAILED> | ||
| 100 | |||
| 101 | =item * | ||
| 102 | |||
| 103 | C<UPDATE_PENDING>, C<UPDATE_IN_PROGRESS>, C<UPDATE_FAILED> | ||
| 104 | |||
| 105 | =back | ||
| 106 | |||
| 107 | The C<UPDATE> states apply while data is imported to the dataset from a | ||
| 108 | call to the CreateDatasetImportJob operation and reflect the status of | ||
| 109 | the dataset import job. For example, when the import job status is | ||
| 110 | C<CREATE_IN_PROGRESS>, the status of the dataset is | ||
| 111 | C<UPDATE_IN_PROGRESS>. | ||
| 112 | |||
| 113 | The C<Status> of the dataset must be C<ACTIVE> before you can import | ||
| 114 | training data. | ||
| 115 | |||
| 116 | |||
| 117 | =head2 _request_id => Str | ||
| 118 | |||
| 119 | |||
| 120 | =cut | ||
| 121 | |||
| 122 | 1; |