« blib/lib/Paws/Personalize/CampaignSummary.pm
↑ Summary
blib/lib/Paws/Personalize/CategoricalHyperParameterRange.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Personalize::CampaignUpdateSummary; | ||
| 3 | use Moose; | ||
| 4 | has CampaignConfig => (is => 'ro', isa => 'Paws::Personalize::CampaignConfig', request_name => 'campaignConfig', traits => ['NameInRequest']); | ||
| 5 | has CreationDateTime => (is => 'ro', isa => 'Str', request_name => 'creationDateTime', traits => ['NameInRequest']); | ||
| 6 | has FailureReason => (is => 'ro', isa => 'Str', request_name => 'failureReason', traits => ['NameInRequest']); | ||
| 7 | has LastUpdatedDateTime => (is => 'ro', isa => 'Str', request_name => 'lastUpdatedDateTime', traits => ['NameInRequest']); | ||
| 8 | has MinProvisionedTPS => (is => 'ro', isa => 'Int', request_name => 'minProvisionedTPS', traits => ['NameInRequest']); | ||
| 9 | has SolutionVersionArn => (is => 'ro', isa => 'Str', request_name => 'solutionVersionArn', traits => ['NameInRequest']); | ||
| 10 | has Status => (is => 'ro', isa => 'Str', request_name => 'status', traits => ['NameInRequest']); | ||
| 11 | |||
| 12 | 1; | ||
| 13 | |||
| 14 | ### main pod documentation begin ### | ||
| 15 | |||
| 16 | =head1 NAME | ||
| 17 | |||
| 18 | Paws::Personalize::CampaignUpdateSummary | ||
| 19 | |||
| 20 | =head1 USAGE | ||
| 21 | |||
| 22 | This class represents one of two things: | ||
| 23 | |||
| 24 | =head3 Arguments in a call to a service | ||
| 25 | |||
| 26 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 27 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 28 | |||
| 29 | As an example, if Att1 is expected to be a Paws::Personalize::CampaignUpdateSummary object: | ||
| 30 | |||
| 31 | $service_obj->Method(Att1 => { CampaignConfig => $value, ..., Status => $value }); | ||
| 32 | |||
| 33 | =head3 Results returned from an API call | ||
| 34 | |||
| 35 | Use accessors for each attribute. If Att1 is expected to be an Paws::Personalize::CampaignUpdateSummary object: | ||
| 36 | |||
| 37 | $result = $service_obj->Method(...); | ||
| 38 | $result->Att1->CampaignConfig | ||
| 39 | |||
| 40 | =head1 DESCRIPTION | ||
| 41 | |||
| 42 | Provides a summary of the properties of a campaign update. For a | ||
| 43 | complete listing, call the DescribeCampaign API. | ||
| 44 | |||
| 45 | =head1 ATTRIBUTES | ||
| 46 | |||
| 47 | |||
| 48 | =head2 CampaignConfig => L<Paws::Personalize::CampaignConfig> | ||
| 49 | |||
| 50 | |||
| 51 | |||
| 52 | |||
| 53 | =head2 CreationDateTime => Str | ||
| 54 | |||
| 55 | The date and time (in Unix time) that the campaign update was created. | ||
| 56 | |||
| 57 | |||
| 58 | =head2 FailureReason => Str | ||
| 59 | |||
| 60 | If a campaign update fails, the reason behind the failure. | ||
| 61 | |||
| 62 | |||
| 63 | =head2 LastUpdatedDateTime => Str | ||
| 64 | |||
| 65 | The date and time (in Unix time) that the campaign update was last | ||
| 66 | updated. | ||
| 67 | |||
| 68 | |||
| 69 | =head2 MinProvisionedTPS => Int | ||
| 70 | |||
| 71 | Specifies the requested minimum provisioned transactions | ||
| 72 | (recommendations) per second that Amazon Personalize will support. | ||
| 73 | |||
| 74 | |||
| 75 | =head2 SolutionVersionArn => Str | ||
| 76 | |||
| 77 | The Amazon Resource Name (ARN) of the deployed solution version. | ||
| 78 | |||
| 79 | |||
| 80 | =head2 Status => Str | ||
| 81 | |||
| 82 | The status of the campaign update. | ||
| 83 | |||
| 84 | A campaign update can be in one of the following states: | ||
| 85 | |||
| 86 | =over | ||
| 87 | |||
| 88 | =item * | ||
| 89 | |||
| 90 | CREATE PENDING E<gt> CREATE IN_PROGRESS E<gt> ACTIVE -or- CREATE FAILED | ||
| 91 | |||
| 92 | =item * | ||
| 93 | |||
| 94 | DELETE PENDING E<gt> DELETE IN_PROGRESS | ||
| 95 | |||
| 96 | =back | ||
| 97 | |||
| 98 | |||
| 99 | |||
| 100 | |||
| 101 | =head1 SEE ALSO | ||
| 102 | |||
| 103 | This class forms part of L<Paws>, describing an object used in L<Paws::Personalize> | ||
| 104 | |||
| 105 | =head1 BUGS and CONTRIBUTIONS | ||
| 106 | |||
| 107 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 108 | |||
| 109 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 110 | |||
| 111 | =cut | ||
| 112 |