« blib/lib/Paws/Forecast/DescribeDatasetImportJob.pm
↑ Summary
blib/lib/Paws/Forecast/DescribeDatasetResponse.pm »
| 1 | |||
| 2 | package Paws::Forecast::DescribeDatasetImportJobResponse; | ||
| 3 | use Moose; | ||
| 4 | has CreationTime => (is => 'ro', isa => 'Str'); | ||
| 5 | has DatasetArn => (is => 'ro', isa => 'Str'); | ||
| 6 | has DatasetImportJobArn => (is => 'ro', isa => 'Str'); | ||
| 7 | has DatasetImportJobName => (is => 'ro', isa => 'Str'); | ||
| 8 | has DataSize => (is => 'ro', isa => 'Num'); | ||
| 9 | has DataSource => (is => 'ro', isa => 'Paws::Forecast::DataSource'); | ||
| 10 | has EstimatedTimeRemainingInMinutes => (is => 'ro', isa => 'Int'); | ||
| 11 | has FieldStatistics => (is => 'ro', isa => 'Paws::Forecast::FieldStatistics'); | ||
| 12 | has GeolocationFormat => (is => 'ro', isa => 'Str'); | ||
| 13 | has LastModificationTime => (is => 'ro', isa => 'Str'); | ||
| 14 | has Message => (is => 'ro', isa => 'Str'); | ||
| 15 | has Status => (is => 'ro', isa => 'Str'); | ||
| 16 | has TimestampFormat => (is => 'ro', isa => 'Str'); | ||
| 17 | has TimeZone => (is => 'ro', isa => 'Str'); | ||
| 18 | has UseGeolocationForTimeZone => (is => 'ro', isa => 'Bool'); | ||
| 19 | |||
| 20 | has _request_id => (is => 'ro', isa => 'Str'); | ||
| 21 | |||
| 22 | ### main pod documentation begin ### | ||
| 23 | |||
| 24 | =head1 NAME | ||
| 25 | |||
| 26 | Paws::Forecast::DescribeDatasetImportJobResponse | ||
| 27 | |||
| 28 | =head1 ATTRIBUTES | ||
| 29 | |||
| 30 | |||
| 31 | =head2 CreationTime => Str | ||
| 32 | |||
| 33 | When the dataset import job was created. | ||
| 34 | |||
| 35 | |||
| 36 | =head2 DatasetArn => Str | ||
| 37 | |||
| 38 | The Amazon Resource Name (ARN) of the dataset that the training data | ||
| 39 | was imported to. | ||
| 40 | |||
| 41 | |||
| 42 | =head2 DatasetImportJobArn => Str | ||
| 43 | |||
| 44 | The ARN of the dataset import job. | ||
| 45 | |||
| 46 | |||
| 47 | =head2 DatasetImportJobName => Str | ||
| 48 | |||
| 49 | The name of the dataset import job. | ||
| 50 | |||
| 51 | |||
| 52 | =head2 DataSize => Num | ||
| 53 | |||
| 54 | The size of the dataset in gigabytes (GB) after the import job has | ||
| 55 | finished. | ||
| 56 | |||
| 57 | |||
| 58 | =head2 DataSource => L<Paws::Forecast::DataSource> | ||
| 59 | |||
| 60 | The location of the training data to import and an AWS Identity and | ||
| 61 | Access Management (IAM) role that Amazon Forecast can assume to access | ||
| 62 | the data. | ||
| 63 | |||
| 64 | If encryption is used, C<DataSource> includes an AWS Key Management | ||
| 65 | Service (KMS) key. | ||
| 66 | |||
| 67 | |||
| 68 | =head2 EstimatedTimeRemainingInMinutes => Int | ||
| 69 | |||
| 70 | The estimated time remaining in minutes for the dataset import job to | ||
| 71 | complete. | ||
| 72 | |||
| 73 | |||
| 74 | =head2 FieldStatistics => L<Paws::Forecast::FieldStatistics> | ||
| 75 | |||
| 76 | Statistical information about each field in the input data. | ||
| 77 | |||
| 78 | |||
| 79 | =head2 GeolocationFormat => Str | ||
| 80 | |||
| 81 | The format of the geolocation attribute. Valid Values:C<"LAT_LONG"> and | ||
| 82 | C<"CC_POSTALCODE">. | ||
| 83 | |||
| 84 | |||
| 85 | =head2 LastModificationTime => Str | ||
| 86 | |||
| 87 | The last time the resource was modified. The timestamp depends on the | ||
| 88 | status of the job: | ||
| 89 | |||
| 90 | =over | ||
| 91 | |||
| 92 | =item * | ||
| 93 | |||
| 94 | C<CREATE_PENDING> - The C<CreationTime>. | ||
| 95 | |||
| 96 | =item * | ||
| 97 | |||
| 98 | C<CREATE_IN_PROGRESS> - The current timestamp. | ||
| 99 | |||
| 100 | =item * | ||
| 101 | |||
| 102 | C<CREATE_STOPPING> - The current timestamp. | ||
| 103 | |||
| 104 | =item * | ||
| 105 | |||
| 106 | C<CREATE_STOPPED> - When the job stopped. | ||
| 107 | |||
| 108 | =item * | ||
| 109 | |||
| 110 | C<ACTIVE> or C<CREATE_FAILED> - When the job finished or failed. | ||
| 111 | |||
| 112 | =back | ||
| 113 | |||
| 114 | |||
| 115 | |||
| 116 | =head2 Message => Str | ||
| 117 | |||
| 118 | If an error occurred, an informational message about the error. | ||
| 119 | |||
| 120 | |||
| 121 | =head2 Status => Str | ||
| 122 | |||
| 123 | The status of the dataset import job. States include: | ||
| 124 | |||
| 125 | =over | ||
| 126 | |||
| 127 | =item * | ||
| 128 | |||
| 129 | C<ACTIVE> | ||
| 130 | |||
| 131 | =item * | ||
| 132 | |||
| 133 | C<CREATE_PENDING>, C<CREATE_IN_PROGRESS>, C<CREATE_FAILED> | ||
| 134 | |||
| 135 | =item * | ||
| 136 | |||
| 137 | C<DELETE_PENDING>, C<DELETE_IN_PROGRESS>, C<DELETE_FAILED> | ||
| 138 | |||
| 139 | =item * | ||
| 140 | |||
| 141 | C<CREATE_STOPPING>, C<CREATE_STOPPED> | ||
| 142 | |||
| 143 | =back | ||
| 144 | |||
| 145 | |||
| 146 | |||
| 147 | =head2 TimestampFormat => Str | ||
| 148 | |||
| 149 | The format of timestamps in the dataset. The format that you specify | ||
| 150 | depends on the C<DataFrequency> specified when the dataset was created. | ||
| 151 | The following formats are supported | ||
| 152 | |||
| 153 | =over | ||
| 154 | |||
| 155 | =item * | ||
| 156 | |||
| 157 | "yyyy-MM-dd" | ||
| 158 | |||
| 159 | For the following data frequencies: Y, M, W, and D | ||
| 160 | |||
| 161 | =item * | ||
| 162 | |||
| 163 | "yyyy-MM-dd HH:mm:ss" | ||
| 164 | |||
| 165 | For the following data frequencies: H, 30min, 15min, and 1min; and | ||
| 166 | optionally, for: Y, M, W, and D | ||
| 167 | |||
| 168 | =back | ||
| 169 | |||
| 170 | |||
| 171 | |||
| 172 | =head2 TimeZone => Str | ||
| 173 | |||
| 174 | The single time zone applied to every item in the dataset | ||
| 175 | |||
| 176 | |||
| 177 | =head2 UseGeolocationForTimeZone => Bool | ||
| 178 | |||
| 179 | Whether C<TimeZone> is automatically derived from the geolocation | ||
| 180 | attribute. | ||
| 181 | |||
| 182 | |||
| 183 | =head2 _request_id => Str | ||
| 184 | |||
| 185 | |||
| 186 | =cut | ||
| 187 | |||
| 188 | 1; |