| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Pinpoint::CampaignResponse; | ||
| 3 | use Moose; | ||
| 4 | has AdditionalTreatments => (is => 'ro', isa => 'ArrayRef[Paws::Pinpoint::TreatmentResource]'); | ||
| 5 | has ApplicationId => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has Arn => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has CreationDate => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | has CustomDeliveryConfiguration => (is => 'ro', isa => 'Paws::Pinpoint::CustomDeliveryConfiguration'); | ||
| 9 | has DefaultState => (is => 'ro', isa => 'Paws::Pinpoint::CampaignState'); | ||
| 10 | has Description => (is => 'ro', isa => 'Str'); | ||
| 11 | has HoldoutPercent => (is => 'ro', isa => 'Int'); | ||
| 12 | has Hook => (is => 'ro', isa => 'Paws::Pinpoint::CampaignHook'); | ||
| 13 | has Id => (is => 'ro', isa => 'Str', required => 1); | ||
| 14 | has IsPaused => (is => 'ro', isa => 'Bool'); | ||
| 15 | has LastModifiedDate => (is => 'ro', isa => 'Str', required => 1); | ||
| 16 | has Limits => (is => 'ro', isa => 'Paws::Pinpoint::CampaignLimits'); | ||
| 17 | has MessageConfiguration => (is => 'ro', isa => 'Paws::Pinpoint::MessageConfiguration'); | ||
| 18 | has Name => (is => 'ro', isa => 'Str'); | ||
| 19 | has Schedule => (is => 'ro', isa => 'Paws::Pinpoint::Schedule'); | ||
| 20 | has SegmentId => (is => 'ro', isa => 'Str', required => 1); | ||
| 21 | has SegmentVersion => (is => 'ro', isa => 'Int', required => 1); | ||
| 22 | has State => (is => 'ro', isa => 'Paws::Pinpoint::CampaignState'); | ||
| 23 | has Tags => (is => 'ro', isa => 'Paws::Pinpoint::MapOf__string', request_name => 'tags', traits => ['NameInRequest']); | ||
| 24 | has TemplateConfiguration => (is => 'ro', isa => 'Paws::Pinpoint::TemplateConfiguration'); | ||
| 25 | has TreatmentDescription => (is => 'ro', isa => 'Str'); | ||
| 26 | has TreatmentName => (is => 'ro', isa => 'Str'); | ||
| 27 | has Version => (is => 'ro', isa => 'Int'); | ||
| 28 | |||
| 29 | 1; | ||
| 30 | |||
| 31 | ### main pod documentation begin ### | ||
| 32 | |||
| 33 | =head1 NAME | ||
| 34 | |||
| 35 | Paws::Pinpoint::CampaignResponse | ||
| 36 | |||
| 37 | =head1 USAGE | ||
| 38 | |||
| 39 | This class represents one of two things: | ||
| 40 | |||
| 41 | =head3 Arguments in a call to a service | ||
| 42 | |||
| 43 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 44 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 45 | |||
| 46 | As an example, if Att1 is expected to be a Paws::Pinpoint::CampaignResponse object: | ||
| 47 | |||
| 48 | $service_obj->Method(Att1 => { AdditionalTreatments => $value, ..., Version => $value }); | ||
| 49 | |||
| 50 | =head3 Results returned from an API call | ||
| 51 | |||
| 52 | Use accessors for each attribute. If Att1 is expected to be an Paws::Pinpoint::CampaignResponse object: | ||
| 53 | |||
| 54 | $result = $service_obj->Method(...); | ||
| 55 | $result->Att1->AdditionalTreatments | ||
| 56 | |||
| 57 | =head1 DESCRIPTION | ||
| 58 | |||
| 59 | Provides information about the status, configuration, and other | ||
| 60 | settings for a campaign. | ||
| 61 | |||
| 62 | =head1 ATTRIBUTES | ||
| 63 | |||
| 64 | |||
| 65 | =head2 AdditionalTreatments => ArrayRef[L<Paws::Pinpoint::TreatmentResource>] | ||
| 66 | |||
| 67 | An array of responses, one for each treatment that you defined for the | ||
| 68 | campaign, in addition to the default treatment. | ||
| 69 | |||
| 70 | |||
| 71 | =head2 B<REQUIRED> ApplicationId => Str | ||
| 72 | |||
| 73 | The unique identifier for the application that the campaign applies to. | ||
| 74 | |||
| 75 | |||
| 76 | =head2 B<REQUIRED> Arn => Str | ||
| 77 | |||
| 78 | The Amazon Resource Name (ARN) of the campaign. | ||
| 79 | |||
| 80 | |||
| 81 | =head2 B<REQUIRED> CreationDate => Str | ||
| 82 | |||
| 83 | The date, in ISO 8601 format, when the campaign was created. | ||
| 84 | |||
| 85 | |||
| 86 | =head2 CustomDeliveryConfiguration => L<Paws::Pinpoint::CustomDeliveryConfiguration> | ||
| 87 | |||
| 88 | The delivery configuration settings for sending the campaign through a | ||
| 89 | custom channel. | ||
| 90 | |||
| 91 | |||
| 92 | =head2 DefaultState => L<Paws::Pinpoint::CampaignState> | ||
| 93 | |||
| 94 | The current status of the campaign's default treatment. This value | ||
| 95 | exists only for campaigns that have more than one treatment. | ||
| 96 | |||
| 97 | |||
| 98 | =head2 Description => Str | ||
| 99 | |||
| 100 | The custom description of the campaign. | ||
| 101 | |||
| 102 | |||
| 103 | =head2 HoldoutPercent => Int | ||
| 104 | |||
| 105 | The allocated percentage of users (segment members) who shouldn't | ||
| 106 | receive messages from the campaign. | ||
| 107 | |||
| 108 | |||
| 109 | =head2 Hook => L<Paws::Pinpoint::CampaignHook> | ||
| 110 | |||
| 111 | The settings for the AWS Lambda function to use as a code hook for the | ||
| 112 | campaign. You can use this hook to customize the segment that's used by | ||
| 113 | the campaign. | ||
| 114 | |||
| 115 | |||
| 116 | =head2 B<REQUIRED> Id => Str | ||
| 117 | |||
| 118 | The unique identifier for the campaign. | ||
| 119 | |||
| 120 | |||
| 121 | =head2 IsPaused => Bool | ||
| 122 | |||
| 123 | Specifies whether the campaign is paused. A paused campaign doesn't run | ||
| 124 | unless you resume it by changing this value to false. | ||
| 125 | |||
| 126 | |||
| 127 | =head2 B<REQUIRED> LastModifiedDate => Str | ||
| 128 | |||
| 129 | The date, in ISO 8601 format, when the campaign was last modified. | ||
| 130 | |||
| 131 | |||
| 132 | =head2 Limits => L<Paws::Pinpoint::CampaignLimits> | ||
| 133 | |||
| 134 | The messaging limits for the campaign. | ||
| 135 | |||
| 136 | |||
| 137 | =head2 MessageConfiguration => L<Paws::Pinpoint::MessageConfiguration> | ||
| 138 | |||
| 139 | The message configuration settings for the campaign. | ||
| 140 | |||
| 141 | |||
| 142 | =head2 Name => Str | ||
| 143 | |||
| 144 | The name of the campaign. | ||
| 145 | |||
| 146 | |||
| 147 | =head2 Schedule => L<Paws::Pinpoint::Schedule> | ||
| 148 | |||
| 149 | The schedule settings for the campaign. | ||
| 150 | |||
| 151 | |||
| 152 | =head2 B<REQUIRED> SegmentId => Str | ||
| 153 | |||
| 154 | The unique identifier for the segment that's associated with the | ||
| 155 | campaign. | ||
| 156 | |||
| 157 | |||
| 158 | =head2 B<REQUIRED> SegmentVersion => Int | ||
| 159 | |||
| 160 | The version number of the segment that's associated with the campaign. | ||
| 161 | |||
| 162 | |||
| 163 | =head2 State => L<Paws::Pinpoint::CampaignState> | ||
| 164 | |||
| 165 | The current status of the campaign. | ||
| 166 | |||
| 167 | |||
| 168 | =head2 Tags => L<Paws::Pinpoint::MapOf__string> | ||
| 169 | |||
| 170 | A string-to-string map of key-value pairs that identifies the tags that | ||
| 171 | are associated with the campaign. Each tag consists of a required tag | ||
| 172 | key and an associated tag value. | ||
| 173 | |||
| 174 | |||
| 175 | =head2 TemplateConfiguration => L<Paws::Pinpoint::TemplateConfiguration> | ||
| 176 | |||
| 177 | The message template thatE<rsquo>s used for the campaign. | ||
| 178 | |||
| 179 | |||
| 180 | =head2 TreatmentDescription => Str | ||
| 181 | |||
| 182 | The custom description of the default treatment for the campaign. | ||
| 183 | |||
| 184 | |||
| 185 | =head2 TreatmentName => Str | ||
| 186 | |||
| 187 | The custom name of the default treatment for the campaign, if the | ||
| 188 | campaign has multiple treatments. A I<treatment> is a variation of a | ||
| 189 | campaign that's used for A/B testing. | ||
| 190 | |||
| 191 | |||
| 192 | =head2 Version => Int | ||
| 193 | |||
| 194 | The version number of the campaign. | ||
| 195 | |||
| 196 | |||
| 197 | |||
| 198 | =head1 SEE ALSO | ||
| 199 | |||
| 200 | This class forms part of L<Paws>, describing an object used in L<Paws::Pinpoint> | ||
| 201 | |||
| 202 | =head1 BUGS and CONTRIBUTIONS | ||
| 203 | |||
| 204 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 205 | |||
| 206 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 207 | |||
| 208 | =cut | ||
| 209 |