« blib/lib/Paws/Pinpoint/CreateApplicationRequest.pm
↑ Summary
blib/lib/Paws/Pinpoint/CreateCampaignResponse.pm »
| 1 | |||
| 2 | package Paws::Pinpoint::CreateCampaign; | ||
| 3 | use Moose; | ||
| 4 | has ApplicationId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'application-id', required => 1); | ||
| 5 | has WriteCampaignRequest => (is => 'ro', isa => 'Paws::Pinpoint::WriteCampaignRequest', required => 1); | ||
| 6 | |||
| 7 | use MooseX::ClassAttribute; | ||
| 8 | class_has _stream_param => (is => 'ro', default => 'WriteCampaignRequest'); | ||
| 9 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateCampaign'); | ||
| 10 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/v1/apps/{application-id}/campaigns'); | ||
| 11 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Pinpoint::CreateCampaignResponse'); | ||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::Pinpoint::CreateCampaign - Arguments for method CreateCampaign on L<Paws::Pinpoint> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method CreateCampaign on the | ||
| 24 | L<Amazon Pinpoint|Paws::Pinpoint> service. Use the attributes of this class | ||
| 25 | as arguments to method CreateCampaign. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateCampaign. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $pinpoint = Paws->service('Pinpoint'); | ||
| 32 | my $CreateCampaignResponse = $pinpoint->CreateCampaign( | ||
| 33 | ApplicationId => 'My__string', | ||
| 34 | WriteCampaignRequest => { | ||
| 35 | AdditionalTreatments => [ | ||
| 36 | { | ||
| 37 | SizePercent => 1, | ||
| 38 | CustomDeliveryConfiguration => { | ||
| 39 | DeliveryUri => 'My__string', | ||
| 40 | EndpointTypes => [ | ||
| 41 | 'PUSH', | ||
| 42 | ... # values: PUSH, GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM | ||
| 43 | ], # OPTIONAL | ||
| 44 | }, # OPTIONAL | ||
| 45 | MessageConfiguration => { | ||
| 46 | ADMMessage => { | ||
| 47 | Action => | ||
| 48 | 'OPEN_APP', # values: OPEN_APP, DEEP_LINK, URL; OPTIONAL | ||
| 49 | Body => 'My__string', | ||
| 50 | ImageIconUrl => 'My__string', | ||
| 51 | ImageSmallIconUrl => 'My__string', | ||
| 52 | ImageUrl => 'My__string', | ||
| 53 | JsonBody => 'My__string', | ||
| 54 | MediaUrl => 'My__string', | ||
| 55 | RawContent => 'My__string', | ||
| 56 | SilentPush => 1, # OPTIONAL | ||
| 57 | TimeToLive => 1, | ||
| 58 | Title => 'My__string', | ||
| 59 | Url => 'My__string', | ||
| 60 | }, # OPTIONAL | ||
| 61 | APNSMessage => { | ||
| 62 | Action => | ||
| 63 | 'OPEN_APP', # values: OPEN_APP, DEEP_LINK, URL; OPTIONAL | ||
| 64 | Body => 'My__string', | ||
| 65 | ImageIconUrl => 'My__string', | ||
| 66 | ImageSmallIconUrl => 'My__string', | ||
| 67 | ImageUrl => 'My__string', | ||
| 68 | JsonBody => 'My__string', | ||
| 69 | MediaUrl => 'My__string', | ||
| 70 | RawContent => 'My__string', | ||
| 71 | SilentPush => 1, # OPTIONAL | ||
| 72 | TimeToLive => 1, | ||
| 73 | Title => 'My__string', | ||
| 74 | Url => 'My__string', | ||
| 75 | }, # OPTIONAL | ||
| 76 | BaiduMessage => { | ||
| 77 | Action => | ||
| 78 | 'OPEN_APP', # values: OPEN_APP, DEEP_LINK, URL; OPTIONAL | ||
| 79 | Body => 'My__string', | ||
| 80 | ImageIconUrl => 'My__string', | ||
| 81 | ImageSmallIconUrl => 'My__string', | ||
| 82 | ImageUrl => 'My__string', | ||
| 83 | JsonBody => 'My__string', | ||
| 84 | MediaUrl => 'My__string', | ||
| 85 | RawContent => 'My__string', | ||
| 86 | SilentPush => 1, # OPTIONAL | ||
| 87 | TimeToLive => 1, | ||
| 88 | Title => 'My__string', | ||
| 89 | Url => 'My__string', | ||
| 90 | }, # OPTIONAL | ||
| 91 | CustomMessage => { Data => 'My__string', }, # OPTIONAL | ||
| 92 | DefaultMessage => { | ||
| 93 | Action => | ||
| 94 | 'OPEN_APP', # values: OPEN_APP, DEEP_LINK, URL; OPTIONAL | ||
| 95 | Body => 'My__string', | ||
| 96 | ImageIconUrl => 'My__string', | ||
| 97 | ImageSmallIconUrl => 'My__string', | ||
| 98 | ImageUrl => 'My__string', | ||
| 99 | JsonBody => 'My__string', | ||
| 100 | MediaUrl => 'My__string', | ||
| 101 | RawContent => 'My__string', | ||
| 102 | SilentPush => 1, # OPTIONAL | ||
| 103 | TimeToLive => 1, | ||
| 104 | Title => 'My__string', | ||
| 105 | Url => 'My__string', | ||
| 106 | }, # OPTIONAL | ||
| 107 | EmailMessage => { | ||
| 108 | Body => 'My__string', | ||
| 109 | FromAddress => 'My__string', | ||
| 110 | HtmlBody => 'My__string', | ||
| 111 | Title => 'My__string', | ||
| 112 | }, # OPTIONAL | ||
| 113 | GCMMessage => { | ||
| 114 | Action => | ||
| 115 | 'OPEN_APP', # values: OPEN_APP, DEEP_LINK, URL; OPTIONAL | ||
| 116 | Body => 'My__string', | ||
| 117 | ImageIconUrl => 'My__string', | ||
| 118 | ImageSmallIconUrl => 'My__string', | ||
| 119 | ImageUrl => 'My__string', | ||
| 120 | JsonBody => 'My__string', | ||
| 121 | MediaUrl => 'My__string', | ||
| 122 | RawContent => 'My__string', | ||
| 123 | SilentPush => 1, # OPTIONAL | ||
| 124 | TimeToLive => 1, | ||
| 125 | Title => 'My__string', | ||
| 126 | Url => 'My__string', | ||
| 127 | }, # OPTIONAL | ||
| 128 | SMSMessage => { | ||
| 129 | Body => 'My__string', | ||
| 130 | EntityId => 'My__string', | ||
| 131 | MessageType => 'TRANSACTIONAL' | ||
| 132 | , # values: TRANSACTIONAL, PROMOTIONAL; OPTIONAL | ||
| 133 | OriginationNumber => 'My__string', | ||
| 134 | SenderId => 'My__string', | ||
| 135 | TemplateId => 'My__string', | ||
| 136 | }, # OPTIONAL | ||
| 137 | }, # OPTIONAL | ||
| 138 | Schedule => { | ||
| 139 | StartTime => 'My__string', | ||
| 140 | EndTime => 'My__string', | ||
| 141 | EventFilter => { | ||
| 142 | Dimensions => { | ||
| 143 | Attributes => { | ||
| 144 | 'My__string' => { | ||
| 145 | Values => [ 'My__string', ... ], | ||
| 146 | AttributeType => 'INCLUSIVE' | ||
| 147 | , # values: INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, ON, BETWEEN; OPTIONAL | ||
| 148 | }, | ||
| 149 | }, # OPTIONAL | ||
| 150 | EventType => { | ||
| 151 | Values => [ 'My__string', ... ], | ||
| 152 | DimensionType => | ||
| 153 | 'INCLUSIVE', # values: INCLUSIVE, EXCLUSIVE; OPTIONAL | ||
| 154 | }, # OPTIONAL | ||
| 155 | Metrics => { | ||
| 156 | 'My__string' => { | ||
| 157 | ComparisonOperator => 'My__string', | ||
| 158 | Value => 1, | ||
| 159 | |||
| 160 | }, | ||
| 161 | }, # OPTIONAL | ||
| 162 | }, | ||
| 163 | FilterType => 'SYSTEM', # values: SYSTEM, ENDPOINT | ||
| 164 | |||
| 165 | }, # OPTIONAL | ||
| 166 | Frequency => 'ONCE' | ||
| 167 | , # values: ONCE, HOURLY, DAILY, WEEKLY, MONTHLY, EVENT; OPTIONAL | ||
| 168 | IsLocalTime => 1, # OPTIONAL | ||
| 169 | QuietTime => { | ||
| 170 | End => 'My__string', | ||
| 171 | Start => 'My__string', | ||
| 172 | }, # OPTIONAL | ||
| 173 | Timezone => 'My__string', | ||
| 174 | }, # OPTIONAL | ||
| 175 | TemplateConfiguration => { | ||
| 176 | EmailTemplate => { | ||
| 177 | Name => 'My__string', | ||
| 178 | Version => 'My__string', | ||
| 179 | }, # OPTIONAL | ||
| 180 | PushTemplate => { | ||
| 181 | Name => 'My__string', | ||
| 182 | Version => 'My__string', | ||
| 183 | }, # OPTIONAL | ||
| 184 | SMSTemplate => { | ||
| 185 | Name => 'My__string', | ||
| 186 | Version => 'My__string', | ||
| 187 | }, # OPTIONAL | ||
| 188 | VoiceTemplate => { | ||
| 189 | Name => 'My__string', | ||
| 190 | Version => 'My__string', | ||
| 191 | }, # OPTIONAL | ||
| 192 | }, # OPTIONAL | ||
| 193 | TreatmentDescription => 'My__string', | ||
| 194 | TreatmentName => 'My__string', | ||
| 195 | }, | ||
| 196 | ... | ||
| 197 | ], # OPTIONAL | ||
| 198 | CustomDeliveryConfiguration => { | ||
| 199 | DeliveryUri => 'My__string', | ||
| 200 | EndpointTypes => [ | ||
| 201 | 'PUSH', | ||
| 202 | ... # values: PUSH, GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM | ||
| 203 | ], # OPTIONAL | ||
| 204 | }, # OPTIONAL | ||
| 205 | Description => 'My__string', | ||
| 206 | HoldoutPercent => 1, | ||
| 207 | Hook => { | ||
| 208 | LambdaFunctionName => 'My__string', | ||
| 209 | Mode => 'DELIVERY', # values: DELIVERY, FILTER; OPTIONAL | ||
| 210 | WebUrl => 'My__string', | ||
| 211 | }, # OPTIONAL | ||
| 212 | IsPaused => 1, # OPTIONAL | ||
| 213 | Limits => { | ||
| 214 | Daily => 1, | ||
| 215 | MaximumDuration => 1, | ||
| 216 | MessagesPerSecond => 1, | ||
| 217 | Total => 1, | ||
| 218 | }, # OPTIONAL | ||
| 219 | MessageConfiguration => { | ||
| 220 | ADMMessage => { | ||
| 221 | Action => 'OPEN_APP', # values: OPEN_APP, DEEP_LINK, URL; OPTIONAL | ||
| 222 | Body => 'My__string', | ||
| 223 | ImageIconUrl => 'My__string', | ||
| 224 | ImageSmallIconUrl => 'My__string', | ||
| 225 | ImageUrl => 'My__string', | ||
| 226 | JsonBody => 'My__string', | ||
| 227 | MediaUrl => 'My__string', | ||
| 228 | RawContent => 'My__string', | ||
| 229 | SilentPush => 1, # OPTIONAL | ||
| 230 | TimeToLive => 1, | ||
| 231 | Title => 'My__string', | ||
| 232 | Url => 'My__string', | ||
| 233 | }, # OPTIONAL | ||
| 234 | APNSMessage => { | ||
| 235 | Action => 'OPEN_APP', # values: OPEN_APP, DEEP_LINK, URL; OPTIONAL | ||
| 236 | Body => 'My__string', | ||
| 237 | ImageIconUrl => 'My__string', | ||
| 238 | ImageSmallIconUrl => 'My__string', | ||
| 239 | ImageUrl => 'My__string', | ||
| 240 | JsonBody => 'My__string', | ||
| 241 | MediaUrl => 'My__string', | ||
| 242 | RawContent => 'My__string', | ||
| 243 | SilentPush => 1, # OPTIONAL | ||
| 244 | TimeToLive => 1, | ||
| 245 | Title => 'My__string', | ||
| 246 | Url => 'My__string', | ||
| 247 | }, # OPTIONAL | ||
| 248 | BaiduMessage => { | ||
| 249 | Action => 'OPEN_APP', # values: OPEN_APP, DEEP_LINK, URL; OPTIONAL | ||
| 250 | Body => 'My__string', | ||
| 251 | ImageIconUrl => 'My__string', | ||
| 252 | ImageSmallIconUrl => 'My__string', | ||
| 253 | ImageUrl => 'My__string', | ||
| 254 | JsonBody => 'My__string', | ||
| 255 | MediaUrl => 'My__string', | ||
| 256 | RawContent => 'My__string', | ||
| 257 | SilentPush => 1, # OPTIONAL | ||
| 258 | TimeToLive => 1, | ||
| 259 | Title => 'My__string', | ||
| 260 | Url => 'My__string', | ||
| 261 | }, # OPTIONAL | ||
| 262 | CustomMessage => { Data => 'My__string', }, # OPTIONAL | ||
| 263 | DefaultMessage => { | ||
| 264 | Action => 'OPEN_APP', # values: OPEN_APP, DEEP_LINK, URL; OPTIONAL | ||
| 265 | Body => 'My__string', | ||
| 266 | ImageIconUrl => 'My__string', | ||
| 267 | ImageSmallIconUrl => 'My__string', | ||
| 268 | ImageUrl => 'My__string', | ||
| 269 | JsonBody => 'My__string', | ||
| 270 | MediaUrl => 'My__string', | ||
| 271 | RawContent => 'My__string', | ||
| 272 | SilentPush => 1, # OPTIONAL | ||
| 273 | TimeToLive => 1, | ||
| 274 | Title => 'My__string', | ||
| 275 | Url => 'My__string', | ||
| 276 | }, # OPTIONAL | ||
| 277 | EmailMessage => { | ||
| 278 | Body => 'My__string', | ||
| 279 | FromAddress => 'My__string', | ||
| 280 | HtmlBody => 'My__string', | ||
| 281 | Title => 'My__string', | ||
| 282 | }, # OPTIONAL | ||
| 283 | GCMMessage => { | ||
| 284 | Action => 'OPEN_APP', # values: OPEN_APP, DEEP_LINK, URL; OPTIONAL | ||
| 285 | Body => 'My__string', | ||
| 286 | ImageIconUrl => 'My__string', | ||
| 287 | ImageSmallIconUrl => 'My__string', | ||
| 288 | ImageUrl => 'My__string', | ||
| 289 | JsonBody => 'My__string', | ||
| 290 | MediaUrl => 'My__string', | ||
| 291 | RawContent => 'My__string', | ||
| 292 | SilentPush => 1, # OPTIONAL | ||
| 293 | TimeToLive => 1, | ||
| 294 | Title => 'My__string', | ||
| 295 | Url => 'My__string', | ||
| 296 | }, # OPTIONAL | ||
| 297 | SMSMessage => { | ||
| 298 | Body => 'My__string', | ||
| 299 | EntityId => 'My__string', | ||
| 300 | MessageType => | ||
| 301 | 'TRANSACTIONAL', # values: TRANSACTIONAL, PROMOTIONAL; OPTIONAL | ||
| 302 | OriginationNumber => 'My__string', | ||
| 303 | SenderId => 'My__string', | ||
| 304 | TemplateId => 'My__string', | ||
| 305 | }, # OPTIONAL | ||
| 306 | }, # OPTIONAL | ||
| 307 | Name => 'My__string', | ||
| 308 | Schedule => { | ||
| 309 | StartTime => 'My__string', | ||
| 310 | EndTime => 'My__string', | ||
| 311 | EventFilter => { | ||
| 312 | Dimensions => { | ||
| 313 | Attributes => { | ||
| 314 | 'My__string' => { | ||
| 315 | Values => [ 'My__string', ... ], | ||
| 316 | AttributeType => 'INCLUSIVE' | ||
| 317 | , # values: INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, ON, BETWEEN; OPTIONAL | ||
| 318 | }, | ||
| 319 | }, # OPTIONAL | ||
| 320 | EventType => { | ||
| 321 | Values => [ 'My__string', ... ], | ||
| 322 | DimensionType => | ||
| 323 | 'INCLUSIVE', # values: INCLUSIVE, EXCLUSIVE; OPTIONAL | ||
| 324 | }, # OPTIONAL | ||
| 325 | Metrics => { | ||
| 326 | 'My__string' => { | ||
| 327 | ComparisonOperator => 'My__string', | ||
| 328 | Value => 1, | ||
| 329 | |||
| 330 | }, | ||
| 331 | }, # OPTIONAL | ||
| 332 | }, | ||
| 333 | FilterType => 'SYSTEM', # values: SYSTEM, ENDPOINT | ||
| 334 | |||
| 335 | }, # OPTIONAL | ||
| 336 | Frequency => 'ONCE' | ||
| 337 | , # values: ONCE, HOURLY, DAILY, WEEKLY, MONTHLY, EVENT; OPTIONAL | ||
| 338 | IsLocalTime => 1, # OPTIONAL | ||
| 339 | QuietTime => { | ||
| 340 | End => 'My__string', | ||
| 341 | Start => 'My__string', | ||
| 342 | }, # OPTIONAL | ||
| 343 | Timezone => 'My__string', | ||
| 344 | }, # OPTIONAL | ||
| 345 | SegmentId => 'My__string', | ||
| 346 | SegmentVersion => 1, | ||
| 347 | Tags => { 'My__string' => 'My__string', }, # OPTIONAL | ||
| 348 | TemplateConfiguration => { | ||
| 349 | EmailTemplate => { | ||
| 350 | Name => 'My__string', | ||
| 351 | Version => 'My__string', | ||
| 352 | }, # OPTIONAL | ||
| 353 | PushTemplate => { | ||
| 354 | Name => 'My__string', | ||
| 355 | Version => 'My__string', | ||
| 356 | }, # OPTIONAL | ||
| 357 | SMSTemplate => { | ||
| 358 | Name => 'My__string', | ||
| 359 | Version => 'My__string', | ||
| 360 | }, # OPTIONAL | ||
| 361 | VoiceTemplate => { | ||
| 362 | Name => 'My__string', | ||
| 363 | Version => 'My__string', | ||
| 364 | }, # OPTIONAL | ||
| 365 | }, # OPTIONAL | ||
| 366 | TreatmentDescription => 'My__string', | ||
| 367 | TreatmentName => 'My__string', | ||
| 368 | }, | ||
| 369 | |||
| 370 | ); | ||
| 371 | |||
| 372 | # Results: | ||
| 373 | my $CampaignResponse = $CreateCampaignResponse->CampaignResponse; | ||
| 374 | |||
| 375 | # Returns a L<Paws::Pinpoint::CreateCampaignResponse> object. | ||
| 376 | |||
| 377 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 378 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/pinpoint/CreateCampaign> | ||
| 379 | |||
| 380 | =head1 ATTRIBUTES | ||
| 381 | |||
| 382 | |||
| 383 | =head2 B<REQUIRED> ApplicationId => Str | ||
| 384 | |||
| 385 | The unique identifier for the application. This identifier is displayed | ||
| 386 | as the B<Project ID> on the Amazon Pinpoint console. | ||
| 387 | |||
| 388 | |||
| 389 | |||
| 390 | =head2 B<REQUIRED> WriteCampaignRequest => L<Paws::Pinpoint::WriteCampaignRequest> | ||
| 391 | |||
| 392 | |||
| 393 | |||
| 394 | |||
| 395 | |||
| 396 | |||
| 397 | =head1 SEE ALSO | ||
| 398 | |||
| 399 | This class forms part of L<Paws>, documenting arguments for method CreateCampaign in L<Paws::Pinpoint> | ||
| 400 | |||
| 401 | =head1 BUGS and CONTRIBUTIONS | ||
| 402 | |||
| 403 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 404 | |||
| 405 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 406 | |||
| 407 | =cut | ||
| 408 |