« blib/lib/Paws/Forecast/CreateDataset.pm
↑ Summary
blib/lib/Paws/Forecast/CreateDatasetGroupResponse.pm »
| 1 | |||
| 2 | package Paws::Forecast::CreateDatasetGroup; | ||
| 3 | use Moose; | ||
| 4 | has DatasetArns => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 5 | has DatasetGroupName => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has Domain => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::Forecast::Tag]'); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateDatasetGroup'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Forecast::CreateDatasetGroupResponse'); | ||
| 13 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::Forecast::CreateDatasetGroup - Arguments for method CreateDatasetGroup on L<Paws::Forecast> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method CreateDatasetGroup on the | ||
| 25 | L<Amazon Forecast Service|Paws::Forecast> service. Use the attributes of this class | ||
| 26 | as arguments to method CreateDatasetGroup. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateDatasetGroup. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $forecast = Paws->service('Forecast'); | ||
| 33 | my $CreateDatasetGroupResponse = $forecast->CreateDatasetGroup( | ||
| 34 | DatasetGroupName => 'MyName', | ||
| 35 | Domain => 'RETAIL', | ||
| 36 | DatasetArns => [ | ||
| 37 | 'MyArn', ... # max: 256 | ||
| 38 | ], # OPTIONAL | ||
| 39 | Tags => [ | ||
| 40 | { | ||
| 41 | Key => 'MyTagKey', # min: 1, max: 128 | ||
| 42 | Value => 'MyTagValue', # max: 256 | ||
| 43 | |||
| 44 | }, | ||
| 45 | ... | ||
| 46 | ], # OPTIONAL | ||
| 47 | ); | ||
| 48 | |||
| 49 | # Results: | ||
| 50 | my $DatasetGroupArn = $CreateDatasetGroupResponse->DatasetGroupArn; | ||
| 51 | |||
| 52 | # Returns a L<Paws::Forecast::CreateDatasetGroupResponse> object. | ||
| 53 | |||
| 54 | 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. | ||
| 55 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/forecast/CreateDatasetGroup> | ||
| 56 | |||
| 57 | =head1 ATTRIBUTES | ||
| 58 | |||
| 59 | |||
| 60 | =head2 DatasetArns => ArrayRef[Str|Undef] | ||
| 61 | |||
| 62 | An array of Amazon Resource Names (ARNs) of the datasets that you want | ||
| 63 | to include in the dataset group. | ||
| 64 | |||
| 65 | |||
| 66 | |||
| 67 | =head2 B<REQUIRED> DatasetGroupName => Str | ||
| 68 | |||
| 69 | A name for the dataset group. | ||
| 70 | |||
| 71 | |||
| 72 | |||
| 73 | =head2 B<REQUIRED> Domain => Str | ||
| 74 | |||
| 75 | The domain associated with the dataset group. When you add a dataset to | ||
| 76 | a dataset group, this value and the value specified for the C<Domain> | ||
| 77 | parameter of the CreateDataset operation must match. | ||
| 78 | |||
| 79 | The C<Domain> and C<DatasetType> that you choose determine the fields | ||
| 80 | that must be present in training data that you import to a dataset. For | ||
| 81 | example, if you choose the C<RETAIL> domain and C<TARGET_TIME_SERIES> | ||
| 82 | as the C<DatasetType>, Amazon Forecast requires that C<item_id>, | ||
| 83 | C<timestamp>, and C<demand> fields are present in your data. For more | ||
| 84 | information, see howitworks-datasets-groups. | ||
| 85 | |||
| 86 | Valid values are: C<"RETAIL">, C<"CUSTOM">, C<"INVENTORY_PLANNING">, C<"EC2_CAPACITY">, C<"WORK_FORCE">, C<"WEB_TRAFFIC">, C<"METRICS"> | ||
| 87 | |||
| 88 | =head2 Tags => ArrayRef[L<Paws::Forecast::Tag>] | ||
| 89 | |||
| 90 | The optional metadata that you apply to the dataset group to help you | ||
| 91 | categorize and organize them. Each tag consists of a key and an | ||
| 92 | optional value, both of which you define. | ||
| 93 | |||
| 94 | The following basic restrictions apply to tags: | ||
| 95 | |||
| 96 | =over | ||
| 97 | |||
| 98 | =item * | ||
| 99 | |||
| 100 | Maximum number of tags per resource - 50. | ||
| 101 | |||
| 102 | =item * | ||
| 103 | |||
| 104 | For each resource, each tag key must be unique, and each tag key can | ||
| 105 | have only one value. | ||
| 106 | |||
| 107 | =item * | ||
| 108 | |||
| 109 | Maximum key length - 128 Unicode characters in UTF-8. | ||
| 110 | |||
| 111 | =item * | ||
| 112 | |||
| 113 | Maximum value length - 256 Unicode characters in UTF-8. | ||
| 114 | |||
| 115 | =item * | ||
| 116 | |||
| 117 | If your tagging schema is used across multiple services and resources, | ||
| 118 | remember that other services may have restrictions on allowed | ||
| 119 | characters. Generally allowed characters are: letters, numbers, and | ||
| 120 | spaces representable in UTF-8, and the following characters: + - = . _ | ||
| 121 | : / @. | ||
| 122 | |||
| 123 | =item * | ||
| 124 | |||
| 125 | Tag keys and values are case sensitive. | ||
| 126 | |||
| 127 | =item * | ||
| 128 | |||
| 129 | Do not use C<aws:>, C<AWS:>, or any upper or lowercase combination of | ||
| 130 | such as a prefix for keys as it is reserved for AWS use. You cannot | ||
| 131 | edit or delete tag keys with this prefix. Values can have this prefix. | ||
| 132 | If a tag value has C<aws> as its prefix but the key does not, then | ||
| 133 | Forecast considers it to be a user tag and will count against the limit | ||
| 134 | of 50 tags. Tags with only the key prefix of C<aws> do not count | ||
| 135 | against your tags per resource limit. | ||
| 136 | |||
| 137 | =back | ||
| 138 | |||
| 139 | |||
| 140 | |||
| 141 | |||
| 142 | |||
| 143 | =head1 SEE ALSO | ||
| 144 | |||
| 145 | This class forms part of L<Paws>, documenting arguments for method CreateDatasetGroup in L<Paws::Forecast> | ||
| 146 | |||
| 147 | =head1 BUGS and CONTRIBUTIONS | ||
| 148 | |||
| 149 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 150 | |||
| 151 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 152 | |||
| 153 | =cut | ||
| 154 |