« blib/lib/Paws/Personalize/SolutionSummary.pm
↑ Summary
blib/lib/Paws/Personalize/SolutionVersionSummary.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Personalize::SolutionVersion; | ||
| 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 EventType => (is => 'ro', isa => 'Str', request_name => 'eventType', traits => ['NameInRequest']); | ||
| 7 | has FailureReason => (is => 'ro', isa => 'Str', request_name => 'failureReason', traits => ['NameInRequest']); | ||
| 8 | has LastUpdatedDateTime => (is => 'ro', isa => 'Str', request_name => 'lastUpdatedDateTime', traits => ['NameInRequest']); | ||
| 9 | has PerformAutoML => (is => 'ro', isa => 'Bool', request_name => 'performAutoML', traits => ['NameInRequest']); | ||
| 10 | has PerformHPO => (is => 'ro', isa => 'Bool', request_name => 'performHPO', traits => ['NameInRequest']); | ||
| 11 | has RecipeArn => (is => 'ro', isa => 'Str', request_name => 'recipeArn', traits => ['NameInRequest']); | ||
| 12 | has SolutionArn => (is => 'ro', isa => 'Str', request_name => 'solutionArn', traits => ['NameInRequest']); | ||
| 13 | has SolutionConfig => (is => 'ro', isa => 'Paws::Personalize::SolutionConfig', request_name => 'solutionConfig', traits => ['NameInRequest']); | ||
| 14 | has SolutionVersionArn => (is => 'ro', isa => 'Str', request_name => 'solutionVersionArn', traits => ['NameInRequest']); | ||
| 15 | has Status => (is => 'ro', isa => 'Str', request_name => 'status', traits => ['NameInRequest']); | ||
| 16 | has TrainingHours => (is => 'ro', isa => 'Num', request_name => 'trainingHours', traits => ['NameInRequest']); | ||
| 17 | has TrainingMode => (is => 'ro', isa => 'Str', request_name => 'trainingMode', traits => ['NameInRequest']); | ||
| 18 | has TunedHPOParams => (is => 'ro', isa => 'Paws::Personalize::TunedHPOParams', request_name => 'tunedHPOParams', traits => ['NameInRequest']); | ||
| 19 | |||
| 20 | 1; | ||
| 21 | |||
| 22 | ### main pod documentation begin ### | ||
| 23 | |||
| 24 | =head1 NAME | ||
| 25 | |||
| 26 | Paws::Personalize::SolutionVersion | ||
| 27 | |||
| 28 | =head1 USAGE | ||
| 29 | |||
| 30 | This class represents one of two things: | ||
| 31 | |||
| 32 | =head3 Arguments in a call to a service | ||
| 33 | |||
| 34 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 35 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 36 | |||
| 37 | As an example, if Att1 is expected to be a Paws::Personalize::SolutionVersion object: | ||
| 38 | |||
| 39 | $service_obj->Method(Att1 => { CreationDateTime => $value, ..., TunedHPOParams => $value }); | ||
| 40 | |||
| 41 | =head3 Results returned from an API call | ||
| 42 | |||
| 43 | Use accessors for each attribute. If Att1 is expected to be an Paws::Personalize::SolutionVersion object: | ||
| 44 | |||
| 45 | $result = $service_obj->Method(...); | ||
| 46 | $result->Att1->CreationDateTime | ||
| 47 | |||
| 48 | =head1 DESCRIPTION | ||
| 49 | |||
| 50 | An object that provides information about a specific version of a | ||
| 51 | Solution. | ||
| 52 | |||
| 53 | =head1 ATTRIBUTES | ||
| 54 | |||
| 55 | |||
| 56 | =head2 CreationDateTime => Str | ||
| 57 | |||
| 58 | The date and time (in Unix time) that this version of the solution was | ||
| 59 | created. | ||
| 60 | |||
| 61 | |||
| 62 | =head2 DatasetGroupArn => Str | ||
| 63 | |||
| 64 | The Amazon Resource Name (ARN) of the dataset group providing the | ||
| 65 | training data. | ||
| 66 | |||
| 67 | |||
| 68 | =head2 EventType => Str | ||
| 69 | |||
| 70 | The event type (for example, 'click' or 'like') that is used for | ||
| 71 | training the model. | ||
| 72 | |||
| 73 | |||
| 74 | =head2 FailureReason => Str | ||
| 75 | |||
| 76 | If training a solution version fails, the reason for the failure. | ||
| 77 | |||
| 78 | |||
| 79 | =head2 LastUpdatedDateTime => Str | ||
| 80 | |||
| 81 | The date and time (in Unix time) that the solution was last updated. | ||
| 82 | |||
| 83 | |||
| 84 | =head2 PerformAutoML => Bool | ||
| 85 | |||
| 86 | When true, Amazon Personalize searches for the most optimal recipe | ||
| 87 | according to the solution configuration. When false (the default), | ||
| 88 | Amazon Personalize uses C<recipeArn>. | ||
| 89 | |||
| 90 | |||
| 91 | =head2 PerformHPO => Bool | ||
| 92 | |||
| 93 | Whether to perform hyperparameter optimization (HPO) on the chosen | ||
| 94 | recipe. The default is C<false>. | ||
| 95 | |||
| 96 | |||
| 97 | =head2 RecipeArn => Str | ||
| 98 | |||
| 99 | The ARN of the recipe used in the solution. | ||
| 100 | |||
| 101 | |||
| 102 | =head2 SolutionArn => Str | ||
| 103 | |||
| 104 | The ARN of the solution. | ||
| 105 | |||
| 106 | |||
| 107 | =head2 SolutionConfig => L<Paws::Personalize::SolutionConfig> | ||
| 108 | |||
| 109 | Describes the configuration properties for the solution. | ||
| 110 | |||
| 111 | |||
| 112 | =head2 SolutionVersionArn => Str | ||
| 113 | |||
| 114 | The ARN of the solution version. | ||
| 115 | |||
| 116 | |||
| 117 | =head2 Status => Str | ||
| 118 | |||
| 119 | The status of the solution version. | ||
| 120 | |||
| 121 | A solution version can be in one of the following states: | ||
| 122 | |||
| 123 | =over | ||
| 124 | |||
| 125 | =item * | ||
| 126 | |||
| 127 | CREATE PENDING | ||
| 128 | |||
| 129 | =item * | ||
| 130 | |||
| 131 | CREATE IN_PROGRESS | ||
| 132 | |||
| 133 | =item * | ||
| 134 | |||
| 135 | ACTIVE | ||
| 136 | |||
| 137 | =item * | ||
| 138 | |||
| 139 | CREATE FAILED | ||
| 140 | |||
| 141 | =item * | ||
| 142 | |||
| 143 | CREATE STOPPING | ||
| 144 | |||
| 145 | =item * | ||
| 146 | |||
| 147 | CREATE STOPPED | ||
| 148 | |||
| 149 | =back | ||
| 150 | |||
| 151 | |||
| 152 | |||
| 153 | =head2 TrainingHours => Num | ||
| 154 | |||
| 155 | The time used to train the model. You are billed for the time it takes | ||
| 156 | to train a model. This field is visible only after Amazon Personalize | ||
| 157 | successfully trains a model. | ||
| 158 | |||
| 159 | |||
| 160 | =head2 TrainingMode => Str | ||
| 161 | |||
| 162 | The scope of training to be performed when creating the solution | ||
| 163 | version. The C<FULL> option trains the solution version based on the | ||
| 164 | entirety of the input solution's training data, while the C<UPDATE> | ||
| 165 | option processes only the data that has changed in comparison to the | ||
| 166 | input solution. Choose C<UPDATE> when you want to incrementally update | ||
| 167 | your solution version instead of creating an entirely new one. | ||
| 168 | |||
| 169 | The C<UPDATE> option can only be used when you already have an active | ||
| 170 | solution version created from the input solution using the C<FULL> | ||
| 171 | option and the input solution was trained with the User-Personalization | ||
| 172 | (https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-new-item-USER_PERSONALIZATION.html) | ||
| 173 | recipe or the HRNN-Coldstart | ||
| 174 | (https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-hrnn-coldstart.html) | ||
| 175 | recipe. | ||
| 176 | |||
| 177 | |||
| 178 | =head2 TunedHPOParams => L<Paws::Personalize::TunedHPOParams> | ||
| 179 | |||
| 180 | If hyperparameter optimization was performed, contains the | ||
| 181 | hyperparameter values of the best performing model. | ||
| 182 | |||
| 183 | |||
| 184 | |||
| 185 | =head1 SEE ALSO | ||
| 186 | |||
| 187 | This class forms part of L<Paws>, describing an object used in L<Paws::Personalize> | ||
| 188 | |||
| 189 | =head1 BUGS and CONTRIBUTIONS | ||
| 190 | |||
| 191 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 192 | |||
| 193 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 194 | |||
| 195 | =cut | ||
| 196 |