« blib/lib/Paws/Personalize/DatasetExportJobSummary.pm
↑ Summary
blib/lib/Paws/Personalize/DatasetGroupSummary.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Personalize::DatasetGroup; | ||
| 3 | use Moose; | ||
| 4 | has CreationDateTime => (is => 'ro', isa => 'Str', request_name => 'creationDateTime', traits => ['NameInRequest']); | ||
| 5 | has DatasetGroupArn => (is => 'ro', isa => 'Str', request_name => 'datasetGroupArn', traits => ['NameInRequest']); | ||
| 6 | has FailureReason => (is => 'ro', isa => 'Str', request_name => 'failureReason', traits => ['NameInRequest']); | ||
| 7 | has KmsKeyArn => (is => 'ro', isa => 'Str', request_name => 'kmsKeyArn', traits => ['NameInRequest']); | ||
| 8 | has LastUpdatedDateTime => (is => 'ro', isa => 'Str', request_name => 'lastUpdatedDateTime', traits => ['NameInRequest']); | ||
| 9 | has Name => (is => 'ro', isa => 'Str', request_name => 'name', traits => ['NameInRequest']); | ||
| 10 | has RoleArn => (is => 'ro', isa => 'Str', request_name => 'roleArn', traits => ['NameInRequest']); | ||
| 11 | has Status => (is => 'ro', isa => 'Str', request_name => 'status', traits => ['NameInRequest']); | ||
| 12 | |||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::Personalize::DatasetGroup | ||
| 20 | |||
| 21 | =head1 USAGE | ||
| 22 | |||
| 23 | This class represents one of two things: | ||
| 24 | |||
| 25 | =head3 Arguments in a call to a service | ||
| 26 | |||
| 27 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 28 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 29 | |||
| 30 | As an example, if Att1 is expected to be a Paws::Personalize::DatasetGroup object: | ||
| 31 | |||
| 32 | $service_obj->Method(Att1 => { CreationDateTime => $value, ..., Status => $value }); | ||
| 33 | |||
| 34 | =head3 Results returned from an API call | ||
| 35 | |||
| 36 | Use accessors for each attribute. If Att1 is expected to be an Paws::Personalize::DatasetGroup object: | ||
| 37 | |||
| 38 | $result = $service_obj->Method(...); | ||
| 39 | $result->Att1->CreationDateTime | ||
| 40 | |||
| 41 | =head1 DESCRIPTION | ||
| 42 | |||
| 43 | A dataset group is a collection of related datasets (Interactions, | ||
| 44 | User, and Item). You create a dataset group by calling | ||
| 45 | CreateDatasetGroup. You then create a dataset and add it to a dataset | ||
| 46 | group by calling CreateDataset. The dataset group is used to create and | ||
| 47 | train a solution by calling CreateSolution. A dataset group can contain | ||
| 48 | only one of each type of dataset. | ||
| 49 | |||
| 50 | You can specify an AWS Key Management Service (KMS) key to encrypt the | ||
| 51 | datasets in the group. | ||
| 52 | |||
| 53 | =head1 ATTRIBUTES | ||
| 54 | |||
| 55 | |||
| 56 | =head2 CreationDateTime => Str | ||
| 57 | |||
| 58 | The creation date and time (in Unix time) of the dataset group. | ||
| 59 | |||
| 60 | |||
| 61 | =head2 DatasetGroupArn => Str | ||
| 62 | |||
| 63 | The Amazon Resource Name (ARN) of the dataset group. | ||
| 64 | |||
| 65 | |||
| 66 | =head2 FailureReason => Str | ||
| 67 | |||
| 68 | If creating a dataset group fails, provides the reason why. | ||
| 69 | |||
| 70 | |||
| 71 | =head2 KmsKeyArn => Str | ||
| 72 | |||
| 73 | The Amazon Resource Name (ARN) of the KMS key used to encrypt the | ||
| 74 | datasets. | ||
| 75 | |||
| 76 | |||
| 77 | =head2 LastUpdatedDateTime => Str | ||
| 78 | |||
| 79 | The last update date and time (in Unix time) of the dataset group. | ||
| 80 | |||
| 81 | |||
| 82 | =head2 Name => Str | ||
| 83 | |||
| 84 | The name of the dataset group. | ||
| 85 | |||
| 86 | |||
| 87 | =head2 RoleArn => Str | ||
| 88 | |||
| 89 | The ARN of the IAM role that has permissions to create the dataset | ||
| 90 | group. | ||
| 91 | |||
| 92 | |||
| 93 | =head2 Status => Str | ||
| 94 | |||
| 95 | The current status of the dataset group. | ||
| 96 | |||
| 97 | A dataset group can be in one of the following states: | ||
| 98 | |||
| 99 | =over | ||
| 100 | |||
| 101 | =item * | ||
| 102 | |||
| 103 | CREATE PENDING E<gt> CREATE IN_PROGRESS E<gt> ACTIVE -or- CREATE FAILED | ||
| 104 | |||
| 105 | =item * | ||
| 106 | |||
| 107 | DELETE PENDING | ||
| 108 | |||
| 109 | =back | ||
| 110 | |||
| 111 | |||
| 112 | |||
| 113 | |||
| 114 | =head1 SEE ALSO | ||
| 115 | |||
| 116 | This class forms part of L<Paws>, describing an object used in L<Paws::Personalize> | ||
| 117 | |||
| 118 | =head1 BUGS and CONTRIBUTIONS | ||
| 119 | |||
| 120 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 121 | |||
| 122 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 123 | |||
| 124 | =cut | ||
| 125 |