« blib/lib/Paws/Pinpoint/WriteApplicationSettingsRequest.pm
↑ Summary
blib/lib/Paws/Pinpoint/WriteEventStream.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Pinpoint::WriteCampaignRequest; | ||
| 3 | use Moose; | ||
| 4 | has AdditionalTreatments => (is => 'ro', isa => 'ArrayRef[Paws::Pinpoint::WriteTreatmentResource]'); | ||
| 5 | has CustomDeliveryConfiguration => (is => 'ro', isa => 'Paws::Pinpoint::CustomDeliveryConfiguration'); | ||
| 6 | has Description => (is => 'ro', isa => 'Str'); | ||
| 7 | has HoldoutPercent => (is => 'ro', isa => 'Int'); | ||
| 8 | has Hook => (is => 'ro', isa => 'Paws::Pinpoint::CampaignHook'); | ||
| 9 | has IsPaused => (is => 'ro', isa => 'Bool'); | ||
| 10 | has Limits => (is => 'ro', isa => 'Paws::Pinpoint::CampaignLimits'); | ||
| 11 | has MessageConfiguration => (is => 'ro', isa => 'Paws::Pinpoint::MessageConfiguration'); | ||
| 12 | has Name => (is => 'ro', isa => 'Str'); | ||
| 13 | has Schedule => (is => 'ro', isa => 'Paws::Pinpoint::Schedule'); | ||
| 14 | has SegmentId => (is => 'ro', isa => 'Str'); | ||
| 15 | has SegmentVersion => (is => 'ro', isa => 'Int'); | ||
| 16 | has Tags => (is => 'ro', isa => 'Paws::Pinpoint::MapOf__string', request_name => 'tags', traits => ['NameInRequest']); | ||
| 17 | has TemplateConfiguration => (is => 'ro', isa => 'Paws::Pinpoint::TemplateConfiguration'); | ||
| 18 | has TreatmentDescription => (is => 'ro', isa => 'Str'); | ||
| 19 | has TreatmentName => (is => 'ro', isa => 'Str'); | ||
| 20 | |||
| 21 | 1; | ||
| 22 | |||
| 23 | ### main pod documentation begin ### | ||
| 24 | |||
| 25 | =head1 NAME | ||
| 26 | |||
| 27 | Paws::Pinpoint::WriteCampaignRequest | ||
| 28 | |||
| 29 | =head1 USAGE | ||
| 30 | |||
| 31 | This class represents one of two things: | ||
| 32 | |||
| 33 | =head3 Arguments in a call to a service | ||
| 34 | |||
| 35 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 36 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 37 | |||
| 38 | As an example, if Att1 is expected to be a Paws::Pinpoint::WriteCampaignRequest object: | ||
| 39 | |||
| 40 | $service_obj->Method(Att1 => { AdditionalTreatments => $value, ..., TreatmentName => $value }); | ||
| 41 | |||
| 42 | =head3 Results returned from an API call | ||
| 43 | |||
| 44 | Use accessors for each attribute. If Att1 is expected to be an Paws::Pinpoint::WriteCampaignRequest object: | ||
| 45 | |||
| 46 | $result = $service_obj->Method(...); | ||
| 47 | $result->Att1->AdditionalTreatments | ||
| 48 | |||
| 49 | =head1 DESCRIPTION | ||
| 50 | |||
| 51 | Specifies the configuration and other settings for a campaign. | ||
| 52 | |||
| 53 | =head1 ATTRIBUTES | ||
| 54 | |||
| 55 | |||
| 56 | =head2 AdditionalTreatments => ArrayRef[L<Paws::Pinpoint::WriteTreatmentResource>] | ||
| 57 | |||
| 58 | An array of requests that defines additional treatments for the | ||
| 59 | campaign, in addition to the default treatment for the campaign. | ||
| 60 | |||
| 61 | |||
| 62 | =head2 CustomDeliveryConfiguration => L<Paws::Pinpoint::CustomDeliveryConfiguration> | ||
| 63 | |||
| 64 | The delivery configuration settings for sending the campaign through a | ||
| 65 | custom channel. This object is required if the MessageConfiguration | ||
| 66 | object for the campaign specifies a CustomMessage object. | ||
| 67 | |||
| 68 | |||
| 69 | =head2 Description => Str | ||
| 70 | |||
| 71 | A custom description of the campaign. | ||
| 72 | |||
| 73 | |||
| 74 | =head2 HoldoutPercent => Int | ||
| 75 | |||
| 76 | The allocated percentage of users (segment members) who shouldn't | ||
| 77 | receive messages from the campaign. | ||
| 78 | |||
| 79 | |||
| 80 | =head2 Hook => L<Paws::Pinpoint::CampaignHook> | ||
| 81 | |||
| 82 | The settings for the AWS Lambda function to invoke as a code hook for | ||
| 83 | the campaign. You can use this hook to customize the segment that's | ||
| 84 | used by the campaign. | ||
| 85 | |||
| 86 | |||
| 87 | =head2 IsPaused => Bool | ||
| 88 | |||
| 89 | Specifies whether to pause the campaign. A paused campaign doesn't run | ||
| 90 | unless you resume it by changing this value to false. | ||
| 91 | |||
| 92 | |||
| 93 | =head2 Limits => L<Paws::Pinpoint::CampaignLimits> | ||
| 94 | |||
| 95 | The messaging limits for the campaign. | ||
| 96 | |||
| 97 | |||
| 98 | =head2 MessageConfiguration => L<Paws::Pinpoint::MessageConfiguration> | ||
| 99 | |||
| 100 | The message configuration settings for the campaign. | ||
| 101 | |||
| 102 | |||
| 103 | =head2 Name => Str | ||
| 104 | |||
| 105 | A custom name for the campaign. | ||
| 106 | |||
| 107 | |||
| 108 | =head2 Schedule => L<Paws::Pinpoint::Schedule> | ||
| 109 | |||
| 110 | The schedule settings for the campaign. | ||
| 111 | |||
| 112 | |||
| 113 | =head2 SegmentId => Str | ||
| 114 | |||
| 115 | The unique identifier for the segment to associate with the campaign. | ||
| 116 | |||
| 117 | |||
| 118 | =head2 SegmentVersion => Int | ||
| 119 | |||
| 120 | The version of the segment to associate with the campaign. | ||
| 121 | |||
| 122 | |||
| 123 | =head2 Tags => L<Paws::Pinpoint::MapOf__string> | ||
| 124 | |||
| 125 | A string-to-string map of key-value pairs that defines the tags to | ||
| 126 | associate with the campaign. Each tag consists of a required tag key | ||
| 127 | and an associated tag value. | ||
| 128 | |||
| 129 | |||
| 130 | =head2 TemplateConfiguration => L<Paws::Pinpoint::TemplateConfiguration> | ||
| 131 | |||
| 132 | The message template to use for the campaign. | ||
| 133 | |||
| 134 | |||
| 135 | =head2 TreatmentDescription => Str | ||
| 136 | |||
| 137 | A custom description of the default treatment for the campaign. | ||
| 138 | |||
| 139 | |||
| 140 | =head2 TreatmentName => Str | ||
| 141 | |||
| 142 | A custom name of the default treatment for the campaign, if the | ||
| 143 | campaign has multiple treatments. A I<treatment> is a variation of a | ||
| 144 | campaign that's used for A/B testing. | ||
| 145 | |||
| 146 | |||
| 147 | |||
| 148 | =head1 SEE ALSO | ||
| 149 | |||
| 150 | This class forms part of L<Paws>, describing an object used in L<Paws::Pinpoint> | ||
| 151 | |||
| 152 | =head1 BUGS and CONTRIBUTIONS | ||
| 153 | |||
| 154 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 155 | |||
| 156 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 157 | |||
| 158 | =cut | ||
| 159 |