aws-sdk-partnercentralmarketing 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,3777 @@
1
+ # frozen_string_literal: true
2
+
3
+ # WARNING ABOUT GENERATED CODE
4
+ #
5
+ # This file is generated. See the contributing guide for more information:
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
+ #
8
+ # WARNING ABOUT GENERATED CODE
9
+
10
+ module Aws::PartnerCentralMarketing
11
+ module Types
12
+
13
+ # You do not have sufficient access to perform this action.
14
+ #
15
+ # An IAM denial carries no `Reason`. A refusal for the caller's Partner
16
+ # Central state carries one, so a client tells the two apart by its
17
+ # presence.
18
+ #
19
+ # @!attribute [rw] message
20
+ # Error message.
21
+ # @return [String]
22
+ #
23
+ # @!attribute [rw] reason
24
+ # Why the caller was refused, when the refusal is about the caller's
25
+ # Partner Central state rather than IAM.
26
+ # @return [String]
27
+ #
28
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/AccessDeniedException AWS API Documentation
29
+ #
30
+ class AccessDeniedException < Struct.new(
31
+ :message,
32
+ :reason)
33
+ SENSITIVE = []
34
+ include Aws::Structure
35
+ end
36
+
37
+ # One thing that must be fixed before activation.
38
+ #
39
+ # @!attribute [rw] code
40
+ # What is wrong. Branch on this, not on `Message`.
41
+ # @return [String]
42
+ #
43
+ # @!attribute [rw] field_id
44
+ # The asset field to fix. Present for asset-level issues, except
45
+ # `SEND_MODE_MISSING` and a `CONTENT_REJECTED` that refused the
46
+ # asset's text as a whole rather than one field.
47
+ # @return [String]
48
+ #
49
+ # @!attribute [rw] campaign_setting
50
+ # The `UpdateCampaign` member to set. Present for campaign-level
51
+ # issues.
52
+ # @return [String]
53
+ #
54
+ # @!attribute [rw] partner_profile_field
55
+ # The partner-profile value to set or shorten, in AWS Partner Central,
56
+ # or the derived value whose input it is. Present on
57
+ # `PARTNER_PROFILE_FIELD_MISSING` and
58
+ # `PARTNER_PROFILE_FIELD_DOES_NOT_FIT`.
59
+ # @return [String]
60
+ #
61
+ # @!attribute [rw] affected_asset_ids
62
+ # The assets this campaign-level issue blocks.
63
+ # @return [Array<String>]
64
+ #
65
+ # @!attribute [rw] message
66
+ # A description for display. Don't parse it.
67
+ # @return [String]
68
+ #
69
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/ActivationIssue AWS API Documentation
70
+ #
71
+ class ActivationIssue < Struct.new(
72
+ :code,
73
+ :field_id,
74
+ :campaign_setting,
75
+ :partner_profile_field,
76
+ :affected_asset_ids,
77
+ :message)
78
+ SENSITIVE = []
79
+ include Aws::Structure
80
+ end
81
+
82
+ # An `AssetLink` field's constraints.
83
+ #
84
+ # @!attribute [rw] category
85
+ # The category of asset the field may name. The value must be an asset
86
+ # of this category on the same campaign; list the candidates with
87
+ # `ListCampaignAssets`.
88
+ # @return [String]
89
+ #
90
+ # @!attribute [rw] label_field_id
91
+ # The text field on the same asset whose copy names the linked asset,
92
+ # such as the "Solution Brief" in "Your Solution Brief is ready to
93
+ # download!". When the partner picks an asset, fill this field with
94
+ # the picked asset's `LinkLabel`, in a preview and in the same save,
95
+ # unless the partner has edited it. The field stays editable. The
96
+ # service does the same when a save changes the link without setting
97
+ # this field and the partner has never written it.
98
+ # @return [String]
99
+ #
100
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/AssetLinkFieldType AWS API Documentation
101
+ #
102
+ class AssetLinkFieldType < Struct.new(
103
+ :category,
104
+ :label_field_id)
105
+ SENSITIVE = []
106
+ include Aws::Structure
107
+ end
108
+
109
+ # One blueprint to instantiate.
110
+ #
111
+ # Carries nothing but the blueprint's identity, and that is the point
112
+ # rather than a saving: category, name, FileFormat and platform are all
113
+ # derived from the named blueprint, so no caller has a member with which
114
+ # to contradict the pinned schema (asset design section 3.1).
115
+ #
116
+ # There is deliberately no per-entry ClientToken. AWS Batch Operations
117
+ # requires a *request identifier* per entry -- "a request identifier CAN
118
+ # either be a resource identifier or a client idempotency token" -- and
119
+ # SourceAssetTemplateIdentifier is a resource identifier, unique across
120
+ # entries and echoed in this entry's error. Idempotency is structural
121
+ # rather than token-based: an asset id is derived from (CampaignId,
122
+ # SourceAssetTemplateId), so a replayed entry resolves to the same asset
123
+ # (I-16).
124
+ #
125
+ # @!attribute [rw] source_asset_template_identifier
126
+ # The asset template to instantiate, as returned by
127
+ # GetCampaignTemplate in CampaignTemplate.AssetTemplates\[\].id.
128
+ #
129
+ # Must belong to the campaign's own campaign template. An asset's
130
+ # editable field schema is copied from this blueprint at creation and
131
+ # pinned, so an asset without one could be neither validated on update
132
+ # nor made live.
133
+ #
134
+ # Also this entry's request identifier: it MUST be unique across the
135
+ # request's entries, since a campaign holds at most one asset per
136
+ # blueprint (I-15) and two entries naming the same blueprint could not
137
+ # both succeed.
138
+ # @return [String]
139
+ #
140
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/BatchCreateCampaignAssetEntry AWS API Documentation
141
+ #
142
+ class BatchCreateCampaignAssetEntry < Struct.new(
143
+ :source_asset_template_identifier)
144
+ SENSITIVE = []
145
+ include Aws::Structure
146
+ end
147
+
148
+ # Why one entry could not be instantiated.
149
+ #
150
+ # @!attribute [rw] source_asset_template_id
151
+ # The failing entry's request identifier, so a caller can match this
152
+ # error to the entry it sent.
153
+ # @return [String]
154
+ #
155
+ # @!attribute [rw] code
156
+ # Error code -- ResourceNotFoundException when the blueprint is not on
157
+ # the campaign's bound template, InternalServerException otherwise.
158
+ # Throttling never appears here: DG throttles per operation, so a
159
+ # throttle fails the whole batch.
160
+ # @return [String]
161
+ #
162
+ # @!attribute [rw] message
163
+ # Human-readable cause.
164
+ # @return [String]
165
+ #
166
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/BatchCreateCampaignAssetError AWS API Documentation
167
+ #
168
+ class BatchCreateCampaignAssetError < Struct.new(
169
+ :source_asset_template_id,
170
+ :code,
171
+ :message)
172
+ SENSITIVE = []
173
+ include Aws::Structure
174
+ end
175
+
176
+ # Input for BatchCreateCampaignAsset operation.
177
+ #
178
+ # DG-038: replaces CreateCampaignAssetRequest. Selecting assets is a set
179
+ # decision -- a partner picks which of the bound campaign template's
180
+ # blueprints this campaign will carry -- so the operation takes a list
181
+ # of entries and there is no singular create. "Add the blueprint I
182
+ # skipped" is a batch of one.
183
+ #
184
+ # @!attribute [rw] catalog
185
+ # The catalog (AWS or Sandbox).
186
+ # @return [String]
187
+ #
188
+ # @!attribute [rw] campaign_identifier
189
+ # The campaign identifier.
190
+ # @return [String]
191
+ #
192
+ # @!attribute [rw] entries
193
+ # The blueprints to instantiate, one entry each.
194
+ # @return [Array<Types::BatchCreateCampaignAssetEntry>]
195
+ #
196
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/BatchCreateCampaignAssetRequest AWS API Documentation
197
+ #
198
+ class BatchCreateCampaignAssetRequest < Struct.new(
199
+ :catalog,
200
+ :campaign_identifier,
201
+ :entries)
202
+ SENSITIVE = []
203
+ include Aws::Structure
204
+ end
205
+
206
+ # Output for BatchCreateCampaignAsset.
207
+ #
208
+ # Per-entry, per AWS Batch Operations. `Errors` is required and is empty
209
+ # rather than absent on a fully successful call; `Successful` is the
210
+ # success list the standard makes optional, and DG returns it because a
211
+ # client otherwise cannot learn the ids that were created.
212
+ #
213
+ # Status is 200 whenever entries were processed individually --
214
+ # including when every entry failed, since the batch itself succeeded
215
+ # and the entries did not. A 4xx means the batch could not be attempted
216
+ # as a whole and nothing was written.
217
+ #
218
+ # A partial batch is a real state and the recovery is to re-send the
219
+ # same entry list: an entry is idempotent by identity (I-15/I-16), so
220
+ # what landed no-ops and what did not gets created. An already-existing
221
+ # asset is therefore a `Successful` row, not an error -- were it an
222
+ # error, a client looping until `Errors` is empty would never terminate.
223
+ #
224
+ # @!attribute [rw] errors
225
+ # One entry per blueprint that could not be instantiated. Empty, never
226
+ # absent, when all entries succeeded.
227
+ # @return [Array<Types::BatchCreateCampaignAssetError>]
228
+ #
229
+ # @!attribute [rw] successful
230
+ # One entry per asset that exists as a result of this call, whether
231
+ # created here or already present.
232
+ # @return [Array<Types::BatchCreateCampaignAssetResult>]
233
+ #
234
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/BatchCreateCampaignAssetResponse AWS API Documentation
235
+ #
236
+ class BatchCreateCampaignAssetResponse < Struct.new(
237
+ :errors,
238
+ :successful)
239
+ SENSITIVE = []
240
+ include Aws::Structure
241
+ end
242
+
243
+ # One asset that exists as a result of this call.
244
+ #
245
+ # @!attribute [rw] source_asset_template_id
246
+ # The entry's request identifier.
247
+ # @return [String]
248
+ #
249
+ # @!attribute [rw] id
250
+ # The asset's identifier, derived from (CampaignId,
251
+ # SourceAssetTemplateId) rather than minted, so the same entry always
252
+ # resolves to the same id.
253
+ # @return [String]
254
+ #
255
+ # @!attribute [rw] layout
256
+ # For a multi-layout blueprint, the asset's layout options, so a
257
+ # client can render the first layout picker without reading each asset
258
+ # back. Nothing is selected at creation. Absent for a single-layout
259
+ # blueprint.
260
+ # @return [Types::CampaignAssetLayout]
261
+ #
262
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/BatchCreateCampaignAssetResult AWS API Documentation
263
+ #
264
+ class BatchCreateCampaignAssetResult < Struct.new(
265
+ :source_asset_template_id,
266
+ :id,
267
+ :layout)
268
+ SENSITIVE = []
269
+ include Aws::Structure
270
+ end
271
+
272
+ # A marketing campaign resource.
273
+ #
274
+ # @!attribute [rw] campaign_id
275
+ # The campaign identifier.
276
+ # @return [String]
277
+ #
278
+ # @!attribute [rw] arn
279
+ # The campaign ARN.
280
+ # @return [String]
281
+ #
282
+ # @!attribute [rw] name
283
+ # The display name.
284
+ # @return [String]
285
+ #
286
+ # @!attribute [rw] state
287
+ # The campaign's state, derived on every read from `EndOn` and its
288
+ # assets. See `CampaignState`.
289
+ # @return [String]
290
+ #
291
+ # @!attribute [rw] campaign_template_id
292
+ # The campaign template this campaign draws its assets from. Set at
293
+ # create, immutable.
294
+ # @return [String]
295
+ #
296
+ # @!attribute [rw] language
297
+ # The language the campaign's assets are written and typeset in: its
298
+ # template's `LanguageCode`, set at create. To work in another
299
+ # language, create the campaign from that language's template.
300
+ # @return [String]
301
+ #
302
+ # @!attribute [rw] partner_profile
303
+ # The partner's branding — display name, website and logo — from
304
+ # their AWS Partner Central profile, rendered onto every asset of this
305
+ # campaign. Read-only here: the partner edits it in Partner Central,
306
+ # and the next activation or export uses the change. Absent only when
307
+ # the partner has no profile.
308
+ # @return [Types::PartnerProfileBranding]
309
+ #
310
+ # @!attribute [rw] sender_email
311
+ # The address the campaign's emails are sent from. Absent until one
312
+ # is set.
313
+ # @return [String]
314
+ #
315
+ # @!attribute [rw] privacy_policy_url
316
+ # The URL of the partner's privacy policy. Absent until one is set.
317
+ # @return [String]
318
+ #
319
+ # @!attribute [rw] partner_address
320
+ # The partner's postal address. Absent until one is set.
321
+ # @return [String]
322
+ #
323
+ # @!attribute [rw] partner_badge
324
+ # The partner's badge. Absent until one is set, and every badge slot
325
+ # shows the Standalone AWS Partner badge while the partner's primary
326
+ # AWS Partner path is at stage Validated or Differentiated. Below
327
+ # that, no badge is shown.
328
+ # @return [Types::PartnerBadgeDetail]
329
+ #
330
+ # @!attribute [rw] email_target
331
+ # The attached recipient list — metadata only. There is no read path
332
+ # for the addresses.
333
+ # @return [Types::EmailTargetDetail]
334
+ #
335
+ # @!attribute [rw] email_target_engagement_group_ids
336
+ # The engagement groups set by `CreateCampaign` / `UpdateCampaign`.
337
+ # Absent until set. Resolved to recipients at Start, where the stage
338
+ # can.
339
+ # @return [Array<String>]
340
+ #
341
+ # @!attribute [rw] social_connections
342
+ # The account the campaign's social posts publish from, per platform,
343
+ # as set by `UpdateCampaign`. Absent until one is set.
344
+ #
345
+ # Needed only for a platform where you hold two or more connections.
346
+ # With none set, a post uses your one connection on its platform, and
347
+ # fails `SOCIAL\_CONNECTION\_NOT\_CHOSEN` when you hold several. A
348
+ # choice that no longer names a connection on its platform fails
349
+ # `SOCIAL\_CONNECTION\_MISSING`. Join with `ListSocialConnections`
350
+ # for each connection's status.
351
+ # @return [Hash<String,Array<String>>]
352
+ #
353
+ # @!attribute [rw] estimated_budget
354
+ # What the partner expects the campaign to cost.
355
+ # @return [Types::MonetaryValue]
356
+ #
357
+ # @!attribute [rw] total_budget
358
+ # The campaign's total budget.
359
+ # @return [Types::MonetaryValue]
360
+ #
361
+ # @!attribute [rw] target_audience
362
+ # Target audience configuration.
363
+ # @return [Types::TargetAudience]
364
+ #
365
+ # @!attribute [rw] start_on
366
+ # The first day of the campaign's run window.
367
+ # @return [String]
368
+ #
369
+ # @!attribute [rw] end_on
370
+ # The last day of the campaign's run window.
371
+ # @return [String]
372
+ #
373
+ # @!attribute [rw] created_at
374
+ # Creation timestamp.
375
+ # @return [Time]
376
+ #
377
+ # @!attribute [rw] updated_at
378
+ # Last update timestamp.
379
+ # @return [Time]
380
+ #
381
+ # @!attribute [rw] activation_issues
382
+ # Campaign settings that must be set before the assets listed in each
383
+ # issue can be activated. Empty when nothing is missing.
384
+ #
385
+ # Each issue names the setting in `CampaignSetting` — set it with
386
+ # `UpdateCampaign` — or the profile value in `PartnerProfileField` —
387
+ # set it in Partner Central — and the assets it blocks in
388
+ # `AffectedAssetIds`. `StartCampaignAssetActivationTask` refuses with
389
+ # `ValidationException` (`CAMPAIGN_INCOMPLETE`) while a requested
390
+ # asset is affected.
391
+ # @return [Array<Types::ActivationIssue>]
392
+ #
393
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/Campaign AWS API Documentation
394
+ #
395
+ class Campaign < Struct.new(
396
+ :campaign_id,
397
+ :arn,
398
+ :name,
399
+ :state,
400
+ :campaign_template_id,
401
+ :language,
402
+ :partner_profile,
403
+ :sender_email,
404
+ :privacy_policy_url,
405
+ :partner_address,
406
+ :partner_badge,
407
+ :email_target,
408
+ :email_target_engagement_group_ids,
409
+ :social_connections,
410
+ :estimated_budget,
411
+ :total_budget,
412
+ :target_audience,
413
+ :start_on,
414
+ :end_on,
415
+ :created_at,
416
+ :updated_at,
417
+ :activation_issues)
418
+ SENSITIVE = [:sender_email, :partner_address]
419
+ include Aws::Structure
420
+ end
421
+
422
+ # A marketing asset resource within a campaign.
423
+ #
424
+ # @!attribute [rw] id
425
+ # The asset identifier.
426
+ # @return [String]
427
+ #
428
+ # @!attribute [rw] campaign_id
429
+ # The campaign identifier.
430
+ # @return [String]
431
+ #
432
+ # @!attribute [rw] category
433
+ # The asset category.
434
+ # @return [String]
435
+ #
436
+ # @!attribute [rw] name
437
+ # The display name.
438
+ # @return [String]
439
+ #
440
+ # @!attribute [rw] link_label
441
+ # DOCUMENT only: the words a page uses for this document, such as
442
+ # "eBook". Fill an `AssetLink` field's `LabelFieldId` with it when
443
+ # the partner picks this asset.
444
+ # @return [String]
445
+ #
446
+ # @!attribute [rw] state
447
+ # Whether the asset is live.
448
+ #
449
+ # Reports current truth only, and nothing else on this shape overrides
450
+ # it. During an *initial* publication it stays INACTIVE until the
451
+ # delivery platform holds the object; during a *re*-publication it
452
+ # stays ACTIVE, because the previously published content is still
453
+ # serving.
454
+ #
455
+ # A stopped asset and one never started both read INACTIVE;
456
+ # `LastActivationStatus` tells them apart, because a stop does not
457
+ # change how the last activation went — stopped is INACTIVE with that
458
+ # member `SUCCEEDED`, never started is INACTIVE with it absent.
459
+ #
460
+ # An update never moves this member.
461
+ # @return [String]
462
+ #
463
+ # @!attribute [rw] last_activation_status
464
+ # How the most recent hand-over to the delivery platform ended.
465
+ #
466
+ # The hand-over, not the delivery: if DG got the artifact scheduled at
467
+ # the platform this is SUCCEEDED, and whether the platform then
468
+ # delivered is `DeliveryStatus`. Per category the hand-over point is —
469
+ # email: the mailing armed; social: the create, which *is* the
470
+ # schedule; landing page: create plus publish-personalisation;
471
+ # document: bytes written.
472
+ #
473
+ # Read with `State` this is what separates a stopped asset (INACTIVE
474
+ # with SUCCEEDED here) from one never activated (INACTIVE with this
475
+ # member absent) — a stop does not change how the last *activation*
476
+ # went.
477
+ #
478
+ # There is no public UNKNOWN. A hand-over whose outcome DG cannot yet
479
+ # determine reports IN\_PROGRESS, because a partner's action is
480
+ # identical either way and there is nothing to do with "unknown".
481
+ # Reporting it as FAILED would be the harmful collapse: that reads as
482
+ # safe to retry, and a retry on an at-most-once create publishes a
483
+ # second live object.
484
+ #
485
+ # Omitted before the first activation attempt.
486
+ # @return [String]
487
+ #
488
+ # @!attribute [rw] delivery_status
489
+ # What the platform did with the artifact after accepting it.
490
+ #
491
+ # EMAIL and SOCIAL\_POST only — absent on every other category, which
492
+ # has no delivery event. See the DeliveryStatus docs.
493
+ # @return [String]
494
+ #
495
+ # @!attribute [rw] delivery_status_reason
496
+ # Why delivery failed. Present only when DeliveryStatus is FAILED. For
497
+ # an email the platform rejected: SENDER\_EMAIL\_INVALID,
498
+ # RECIPIENT\_LIST\_EMPTY, MAILING\_CREDITS\_EXHAUSTED or
499
+ # RECIPIENT\_LIMIT\_EXCEEDED. Otherwise DELIVERY\_FAILED. A Facebook
500
+ # post refused because its connection has no Page is FAILED with
501
+ # SOCIAL\_CONNECTION\_PAGE\_REQUIRED, and withdrawn: reconnect
502
+ # Facebook with a Page selected. A social post the platform stopped
503
+ # retrying, because it could not publish within 12 hours of its
504
+ # scheduled time, is FAILED with DELIVERY\_FAILED. Any other social
505
+ # post that could not be published stays PENDING while it is
506
+ # investigated, and is reported FAILED with DELIVERY\_FAILED once it
507
+ # is confirmed it will not go out. Deactivate and activate the asset
508
+ # again to retry.
509
+ # @return [String]
510
+ #
511
+ # @!attribute [rw] source_asset_template_id
512
+ # The asset template this asset was created from: the
513
+ # `SourceAssetTemplateIdentifier` its `BatchCreateCampaignAsset` entry
514
+ # named, one of `GetCampaignTemplate`'s
515
+ # `CampaignTemplate.AssetTemplates[].Id`. Set at create and never
516
+ # writable. Absent on an asset created before DG recorded it, which
517
+ # can't be activated either. A campaign holds at most one asset per
518
+ # asset template, so this is how a client matches a campaign's assets
519
+ # to its template's asset templates, for example to create the same
520
+ # assets in another campaign. Names don't identify one: two asset
521
+ # templates can share a name.
522
+ # @return [String]
523
+ #
524
+ # @!attribute [rw] social_platform
525
+ # SOCIAL\_POST only: the platform the post goes to, set from its
526
+ # template and never writable. The same value
527
+ # `CampaignAssetSummary.SocialPlatform` reports. Absent for every
528
+ # other category.
529
+ # @return [String]
530
+ #
531
+ # @!attribute [rw] file_format
532
+ # Concrete file format of the finished artifact. For `DOWNLOAD_ONLY`
533
+ # this is the format of the object export copies through verbatim.
534
+ # @return [String]
535
+ #
536
+ # @!attribute [rw] send_mode
537
+ # When this asset sends, as chosen with UpdateCampaignAsset. `EMAIL`
538
+ # and `SOCIAL_POST` only — the two categories whose delivery platform
539
+ # holds a schedule of its own. Absent until chosen, and then the asset
540
+ # reports `SEND_MODE_MISSING`.
541
+ # @return [String]
542
+ #
543
+ # @!attribute [rw] scheduled_send_at
544
+ # The send time, present only when `SendMode` is `SCHEDULED`. It
545
+ # reaches the delivery platform at the asset's next activation.
546
+ #
547
+ # Was `scheduleDate: UtcDate`; retyped with the write member of the
548
+ # same name.
549
+ # @return [Time]
550
+ #
551
+ # @!attribute [rw] field_values
552
+ # The asset's pinned template fields — the field schema copied from
553
+ # the blueprint at instantiation, each paired with the partner's
554
+ # current value. Present on every asset instantiated from a blueprint
555
+ # that offers editable fields, whatever its category (design section
556
+ # 3.1); absent on one whose blueprint offers none.
557
+ # @return [Array<Types::CampaignAssetFieldValue>]
558
+ #
559
+ # @!attribute [rw] layout_previews
560
+ # The asset's AWS-authored layout, as stable public CDN URLs composed
561
+ # from the fileKeys copied off the blueprint at instantiation.
562
+ # Together with FieldValues this makes the asset self-describing: a
563
+ # client renders the edit form and shows the real layout while
564
+ # editing, with no template lookup.
565
+ #
566
+ # The stored form is a bare object key and the URL is composed on
567
+ # read. The key is revision-addressed and prior revisions are
568
+ # retained, so the key IS the pin — nothing is copied into the asset
569
+ # bucket, and there is no version parameter to carry (DG-038).
570
+ #
571
+ # One entry for every category except LANDING\_PAGE, which has two and
572
+ # distinguishes them with PageType.
573
+ #
574
+ # On a multi-layout asset, the SELECTED option's pages only (its
575
+ # first option when none is stored); each option's own previews are
576
+ # on layout.options.
577
+ # @return [Array<Types::LayoutPreview>]
578
+ #
579
+ # @!attribute [rw] layout
580
+ # A multi-layout asset's layout choice (DG-044): the selection once
581
+ # made, and every option the asset was created with. Absent for a
582
+ # single-layout asset.
583
+ #
584
+ # FieldValues is always the union of every option's fields, selected
585
+ # or not, so a client can switch layouts without a round trip: each
586
+ # option lists its own FieldIds. The selection drives layout.selected
587
+ # and the top-level LayoutPreviews only.
588
+ # @return [Types::CampaignAssetLayout]
589
+ #
590
+ # @!attribute [rw] activation_issues
591
+ # What must be fixed on this asset before it can be activated. Empty
592
+ # when the asset is ready.
593
+ #
594
+ # Issues don't block saving: an asset can be saved incomplete and
595
+ # fixed over several updates. `StartCampaignAssetActivationTask`
596
+ # refuses an asset that still has issues: an issue blocks activation
597
+ # when only an edit to the asset can change the outcome. Most issues
598
+ # name the field to fix in `FieldId`. Fix it with
599
+ # `UpdateCampaignAsset`, then read this list again.
600
+ #
601
+ # Besides the issues computed from the asset's content, the list
602
+ # carries what the last activation found: `CONTENT_REJECTED` and
603
+ # `PARTNER_IMAGE_REJECTED` when moderation refused a field. Editing
604
+ # that field removes its issue. A `CONTENT_REJECTED` without a
605
+ # `FieldId` means the text was refused as a whole; editing any text
606
+ # field removes it.
607
+ #
608
+ # Problems with the campaign's own settings, such as a missing
609
+ # recipient list, and with the partner's profile, such as a missing
610
+ # logo, are reported on `Campaign.ActivationIssues`, not here.
611
+ # @return [Array<Types::ActivationIssue>]
612
+ #
613
+ # @!attribute [rw] public_url
614
+ # The live public address this asset's activation produced.
615
+ #
616
+ # A landing page's page URL, read back from the delivery platform at
617
+ # activation and preserved across every convergence; a document's
618
+ # public CDN URL, composed on read from the key the publish wrote.
619
+ # Absent until the asset activates, and absent for EMAIL and
620
+ # SOCIAL\_POST, which produce no partner-addressable URL of their own.
621
+ #
622
+ # For a landing page this is the entire deliverable — without it a
623
+ # partner has no way to learn where their live page is. A WIDGET
624
+ # landing page reports none: it is embedded rather than standalone, so
625
+ # absence there is expected rather than a fault.
626
+ # @return [String]
627
+ #
628
+ # @!attribute [rw] created_at
629
+ # Creation timestamp.
630
+ # @return [Time]
631
+ #
632
+ # @!attribute [rw] updated_at
633
+ # Last update timestamp.
634
+ # @return [Time]
635
+ #
636
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/CampaignAsset AWS API Documentation
637
+ #
638
+ class CampaignAsset < Struct.new(
639
+ :id,
640
+ :campaign_id,
641
+ :category,
642
+ :name,
643
+ :link_label,
644
+ :state,
645
+ :last_activation_status,
646
+ :delivery_status,
647
+ :delivery_status_reason,
648
+ :source_asset_template_id,
649
+ :social_platform,
650
+ :file_format,
651
+ :send_mode,
652
+ :scheduled_send_at,
653
+ :field_values,
654
+ :layout_previews,
655
+ :layout,
656
+ :activation_issues,
657
+ :public_url,
658
+ :created_at,
659
+ :updated_at)
660
+ SENSITIVE = []
661
+ include Aws::Structure
662
+ end
663
+
664
+ # How one asset named in a task is going.
665
+ #
666
+ # @!attribute [rw] campaign_asset_id
667
+ # The asset this outcome belongs to.
668
+ # @return [String]
669
+ #
670
+ # @!attribute [rw] status
671
+ # This asset's contribution to the task's status.
672
+ # @return [String]
673
+ #
674
+ # @!attribute [rw] reason
675
+ # Why the activation did not succeed. Present when status is FAILED.
676
+ # @return [String]
677
+ #
678
+ # @!attribute [rw] message
679
+ # A description of `Reason` for display. Don't parse it. For a
680
+ # mailing-credit shortfall it states the credits needed and remaining.
681
+ # @return [String]
682
+ #
683
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/CampaignAssetActivationOutcome AWS API Documentation
684
+ #
685
+ class CampaignAssetActivationOutcome < Struct.new(
686
+ :campaign_asset_id,
687
+ :status,
688
+ :reason,
689
+ :message)
690
+ SENSITIVE = []
691
+ include Aws::Structure
692
+ end
693
+
694
+ # Why a campaign asset export task failed. Present only when the task's
695
+ # status is FAILED.
696
+ #
697
+ # Dedicated to the export flow — deliberately not the service-wide
698
+ # FailureReason/FailureCode, so export codes are not advertised in the
699
+ # SDKs of unrelated operations. Treat an unrecognised code as an
700
+ # unspecified failure and fall back to message.
701
+ #
702
+ # @!attribute [rw] code
703
+ # Machine-readable failure cause.
704
+ # @return [String]
705
+ #
706
+ # @!attribute [rw] message
707
+ # Human-readable explanation.
708
+ # @return [String]
709
+ #
710
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/CampaignAssetExportFailureReason AWS API Documentation
711
+ #
712
+ class CampaignAssetExportFailureReason < Struct.new(
713
+ :code,
714
+ :message)
715
+ SENSITIVE = []
716
+ include Aws::Structure
717
+ end
718
+
719
+ # One template field on an asset: the schema snapshot taken at
720
+ # instantiation plus the current value. The value is absent while the
721
+ # field is unfilled.
722
+ #
723
+ # Schema and value are one shape rather than two lists because a client
724
+ # rendering an edit form needs both together, and because the pin
725
+ # (design section 3.1) is what an update validates against — separating
726
+ # them would let values outlive the schema they were checked against.
727
+ #
728
+ # Addressed by the **DG** FieldId throughout. The delivery platform's
729
+ # own field-definition ids stay on the template record and are joined in
730
+ # at activation, so a vendor identifier never reaches an asset row or a
731
+ # response (DG-025 containment).
732
+ #
733
+ # @!attribute [rw] field
734
+ # The field schema (snapshot from the template).
735
+ # @return [Types::CampaignAssetTemplateField]
736
+ #
737
+ # @!attribute [rw] value
738
+ # The field's current value; the variant matches the field's type.
739
+ # @return [Types::TemplateFieldValue]
740
+ #
741
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/CampaignAssetFieldValue AWS API Documentation
742
+ #
743
+ class CampaignAssetFieldValue < Struct.new(
744
+ :field,
745
+ :value)
746
+ SENSITIVE = []
747
+ include Aws::Structure
748
+ end
749
+
750
+ # An image stored on one of your assets, named by the field that holds
751
+ # it.
752
+ #
753
+ # @!attribute [rw] campaign_identifier
754
+ # The source campaign's id or ARN.
755
+ # @return [String]
756
+ #
757
+ # @!attribute [rw] campaign_asset_identifier
758
+ # The source asset's id.
759
+ # @return [String]
760
+ #
761
+ # @!attribute [rw] field_id
762
+ # The source image field.
763
+ # @return [String]
764
+ #
765
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/CampaignAssetImageSource AWS API Documentation
766
+ #
767
+ class CampaignAssetImageSource < Struct.new(
768
+ :campaign_identifier,
769
+ :campaign_asset_identifier,
770
+ :field_id)
771
+ SENSITIVE = []
772
+ include Aws::Structure
773
+ end
774
+
775
+ # A multi-layout asset's layout choice: the selection, when made, and
776
+ # its options.
777
+ #
778
+ # @!attribute [rw] selected
779
+ # The selected option's value. An asset is created with its first
780
+ # option selected; an asset created before that rule, with none
781
+ # stored, reports and activates its first option.
782
+ # @return [String]
783
+ #
784
+ # @!attribute [rw] options
785
+ # Every option the asset was created with, in authored order.
786
+ # @return [Array<Types::CampaignAssetLayoutOption>]
787
+ #
788
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/CampaignAssetLayout AWS API Documentation
789
+ #
790
+ class CampaignAssetLayout < Struct.new(
791
+ :selected,
792
+ :options)
793
+ SENSITIVE = []
794
+ include Aws::Structure
795
+ end
796
+
797
+ # One layout a multi-layout asset offers.
798
+ #
799
+ # @!attribute [rw] value
800
+ # The value that selects this option.
801
+ # @return [String]
802
+ #
803
+ # @!attribute [rw] label
804
+ # Display label.
805
+ # @return [String]
806
+ #
807
+ # @!attribute [rw] field_ids
808
+ # The fields this option uses: the FieldValues that stay in scope when
809
+ # it is selected. Lets a client show an option's form before
810
+ # selecting it.
811
+ # @return [Array<String>]
812
+ #
813
+ # @!attribute [rw] layout_previews
814
+ # This option's pages, in page order.
815
+ # @return [Array<Types::LayoutPreview>]
816
+ #
817
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/CampaignAssetLayoutOption AWS API Documentation
818
+ #
819
+ class CampaignAssetLayoutOption < Struct.new(
820
+ :value,
821
+ :label,
822
+ :field_ids,
823
+ :layout_previews)
824
+ SENSITIVE = []
825
+ include Aws::Structure
826
+ end
827
+
828
+ # Summary representation of an asset for list operations.
829
+ #
830
+ # @!attribute [rw] id
831
+ # The asset identifier.
832
+ # @return [String]
833
+ #
834
+ # @!attribute [rw] category
835
+ # The asset category.
836
+ # @return [String]
837
+ #
838
+ # @!attribute [rw] name
839
+ # The display name.
840
+ # @return [String]
841
+ #
842
+ # @!attribute [rw] link_label
843
+ # DOCUMENT only: the words a page uses for this document, such as
844
+ # "eBook". A client listing the candidates for an `AssetLink` field
845
+ # reads it here, so a preview can update on pick without a fetch.
846
+ # @return [String]
847
+ #
848
+ # @!attribute [rw] state
849
+ # Where the asset sits in its lifecycle.
850
+ # @return [String]
851
+ #
852
+ # @!attribute [rw] last_activation_status
853
+ # How the last hand-over to the delivery platform ended. Absent before
854
+ # the first activation.
855
+ # @return [String]
856
+ #
857
+ # @!attribute [rw] delivery_status
858
+ # Whether the platform has delivered the asset.
859
+ # @return [String]
860
+ #
861
+ # @!attribute [rw] delivery_status_reason
862
+ # Why delivery failed. Present only when DeliveryStatus is FAILED. For
863
+ # an email the platform rejected: SENDER\_EMAIL\_INVALID,
864
+ # RECIPIENT\_LIST\_EMPTY, MAILING\_CREDITS\_EXHAUSTED or
865
+ # RECIPIENT\_LIMIT\_EXCEEDED. Otherwise DELIVERY\_FAILED. A Facebook
866
+ # post refused because its connection has no Page is FAILED with
867
+ # SOCIAL\_CONNECTION\_PAGE\_REQUIRED, and withdrawn: reconnect
868
+ # Facebook with a Page selected. A social post the platform stopped
869
+ # retrying, because it could not publish within 12 hours of its
870
+ # scheduled time, is FAILED with DELIVERY\_FAILED. Any other social
871
+ # post that could not be published stays PENDING while it is
872
+ # investigated, and is reported FAILED with DELIVERY\_FAILED once it
873
+ # is confirmed it will not go out. Deactivate and activate the asset
874
+ # again to retry.
875
+ # @return [String]
876
+ #
877
+ # @!attribute [rw] source_asset_template_id
878
+ # The asset template this asset was created from. The same value
879
+ # `CampaignAsset.SourceAssetTemplateId` reports, and absent when it
880
+ # is.
881
+ # @return [String]
882
+ #
883
+ # @!attribute [rw] social_platform
884
+ # SOCIAL\_POST only: the platform the post goes to. Join it with
885
+ # ListSocialConnections' status for that platform to show a post that
886
+ # cannot activate (a connection missing, EXPIRED or PAGE\_REQUIRED)
887
+ # before Start is pressed.
888
+ # @return [String]
889
+ #
890
+ # @!attribute [rw] started_at
891
+ # When the asset first went live, set once. Absent if it never has.
892
+ # @return [Time]
893
+ #
894
+ # @!attribute [rw] file_format
895
+ # Concrete file format of the finished artifact.
896
+ # @return [String]
897
+ #
898
+ # @!attribute [rw] send_mode
899
+ # When this asset sends, as chosen with UpdateCampaignAsset. `EMAIL`
900
+ # and `SOCIAL_POST` only — the two categories whose delivery platform
901
+ # holds a schedule of its own. Absent until chosen, and then the asset
902
+ # reports `SEND_MODE_MISSING`.
903
+ # @return [String]
904
+ #
905
+ # @!attribute [rw] scheduled_send_at
906
+ # The send time, present only when `SendMode` is `SCHEDULED`. It
907
+ # reaches the delivery platform at the asset's next activation.
908
+ #
909
+ # Was `scheduleDate: UtcDate`; retyped with the write member of the
910
+ # same name.
911
+ # @return [Time]
912
+ #
913
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/CampaignAssetSummary AWS API Documentation
914
+ #
915
+ class CampaignAssetSummary < Struct.new(
916
+ :id,
917
+ :category,
918
+ :name,
919
+ :link_label,
920
+ :state,
921
+ :last_activation_status,
922
+ :delivery_status,
923
+ :delivery_status_reason,
924
+ :source_asset_template_id,
925
+ :social_platform,
926
+ :started_at,
927
+ :file_format,
928
+ :send_mode,
929
+ :scheduled_send_at)
930
+ SENSITIVE = []
931
+ include Aws::Structure
932
+ end
933
+
934
+ # One asset blueprint inside a campaign template. The id is
935
+ # template-local — an asset template is not a standalone resource and
936
+ # has no ARN.
937
+ #
938
+ # @!attribute [rw] id
939
+ # The template-local asset template identifier.
940
+ # @return [String]
941
+ #
942
+ # @!attribute [rw] type
943
+ # The kind of asset this blueprint instantiates as.
944
+ # @return [String]
945
+ #
946
+ # @!attribute [rw] label
947
+ # Display label; becomes the instantiated asset's name.
948
+ # @return [String]
949
+ #
950
+ # @!attribute [rw] display_order
951
+ # Ordering for preview and instantiation.
952
+ # @return [Integer]
953
+ #
954
+ # @!attribute [rw] fields
955
+ # The editable-field schema, copied and pinned onto each campaign
956
+ # asset at create. Fields the service fills itself are not listed.
957
+ # @return [Array<Types::CampaignAssetTemplateField>]
958
+ #
959
+ # @!attribute [rw] layout_previews
960
+ # Previews of the AWS-authored layout skeleton.
961
+ # @return [Array<Types::LayoutPreview>]
962
+ #
963
+ # @!attribute [rw] prerequisite_asset_template_ids
964
+ # The asset templates this one embeds output from, such as an email's
965
+ # landing page. Each must be in the same `BatchCreateCampaignAsset`
966
+ # request or already an asset on the campaign, else the create is
967
+ # refused `PREREQUISITE_ASSET_MISSING`; include them when the partner
968
+ # picks this one. Absent when there are none. A link the partner
969
+ # chooses, such as a landing page's download button, is not listed
970
+ # here: it is an `AssetLink` field and needs nothing at create.
971
+ # @return [Array<String>]
972
+ #
973
+ # @!attribute [rw] social_platform
974
+ # SOCIAL\_POST only: the platform an asset made from this blueprint
975
+ # posts to, which the asset reports as `SocialPlatform`. Fixed by the
976
+ # template, so a client can show which social connection the post
977
+ # needs before it is created. Absent for every other type.
978
+ # @return [String]
979
+ #
980
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/CampaignAssetTemplate AWS API Documentation
981
+ #
982
+ class CampaignAssetTemplate < Struct.new(
983
+ :id,
984
+ :type,
985
+ :label,
986
+ :display_order,
987
+ :fields,
988
+ :layout_previews,
989
+ :prerequisite_asset_template_ids,
990
+ :social_platform)
991
+ SENSITIVE = []
992
+ include Aws::Structure
993
+ end
994
+
995
+ # One slot in an asset template's layout: addressing key, placement,
996
+ # and the field kind carrying its own constraints, placeholder or
997
+ # default.
998
+ #
999
+ # @!attribute [rw] field_id
1000
+ # The field identifier; matches a \{\{fieldId}} slot in the layout.
1001
+ # @return [String]
1002
+ #
1003
+ # @!attribute [rw] label
1004
+ # Human-readable name for the field, for display. Authored in the
1005
+ # template policy, never derived from the field id or the source
1006
+ # layout's field name: the id is a slug (`Page_2_Title`) and is not
1007
+ # meant to be shown to a partner. Absent on fields imported before
1008
+ # labels existed.
1009
+ # @return [String]
1010
+ #
1011
+ # @!attribute [rw] description
1012
+ # What belongs in this field, in English: its role in the asset and
1013
+ # what good content for it is (for example "Headline that names the
1014
+ # customer and leads with a source-backed statistic"). AWS-authored
1015
+ # with the template; never written by a partner. Absent when the
1016
+ # template carries none, never empty. Pinned onto the asset with the
1017
+ # field, so a corrected description reaches assets created after the
1018
+ # correction.
1019
+ # @return [String]
1020
+ #
1021
+ # @!attribute [rw] section
1022
+ # Layout section the field belongs to.
1023
+ # @return [String]
1024
+ #
1025
+ # @!attribute [rw] page
1026
+ # One-based page number, for paginated layouts (print documents).
1027
+ # @return [Integer]
1028
+ #
1029
+ # @!attribute [rw] required
1030
+ # Whether the field must be filled before the asset can be activated.
1031
+ # Derived from DG policy — never inherited from an upstream authoring
1032
+ # system.
1033
+ #
1034
+ # Required for activation, not for saving: `UpdateCampaignAsset`
1035
+ # accepts partial content and may clear a required field. An unfilled
1036
+ # required field appears in the asset's `ActivationIssues` as
1037
+ # `REQUIRED_FIELD_MISSING`, and activation refuses the asset with the
1038
+ # same code.
1039
+ #
1040
+ # A text field is filled only by a non-blank value, and a rich-text
1041
+ # field only by a value with non-blank text; a `Placeholder` never
1042
+ # fills one. An image field is filled by the partner's image or by
1043
+ # the template's `DefaultValue`. A field the campaign fills
1044
+ # (`CampaignSetting`) or the partner's profile fills
1045
+ # (`PartnerProfileField`) is never unfilled on the asset.
1046
+ # @return [Boolean]
1047
+ #
1048
+ # @!attribute [rw] type
1049
+ # The field kind, with that kind's constraints, placeholder or
1050
+ # default.
1051
+ # @return [Types::FieldType]
1052
+ #
1053
+ # @!attribute [rw] campaign_setting
1054
+ # The campaign setting this field shows, when it shows one: the
1055
+ # partner sets it once on the campaign and every asset displays it.
1056
+ # Present only on such fields.
1057
+ #
1058
+ # A client shows the field as "Set on the campaign", linking to the
1059
+ # campaign, rather than as an input. `UpdateCampaignAsset` refuses a
1060
+ # value for it with `FIELD_SET_ON_CAMPAIGN`, and on an asset the field
1061
+ # carries no value: read it from the named member of `GetCampaign`'s
1062
+ # `Campaign`.
1063
+ # @return [String]
1064
+ #
1065
+ # @!attribute [rw] partner_profile_field
1066
+ # The partner-profile value this field shows, when it shows one: the
1067
+ # partner's AWS Partner Central profile supplies it, and every asset
1068
+ # of every campaign displays it. Present only on such fields.
1069
+ #
1070
+ # A client shows the field as "From your Partner Central profile"
1071
+ # rather than as an input. `UpdateCampaignAsset` refuses a value for
1072
+ # it with `FIELD_FROM_PARTNER_PROFILE`. On a read the field carries
1073
+ # the partner's resolved value — the logo as its URL, the name and
1074
+ # website as text — so a slot renders from this list alone;
1075
+ # `GetCampaign`'s `Campaign$PartnerProfile` carries the same three
1076
+ # values.
1077
+ # @return [String]
1078
+ #
1079
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/CampaignAssetTemplateField AWS API Documentation
1080
+ #
1081
+ class CampaignAssetTemplateField < Struct.new(
1082
+ :field_id,
1083
+ :label,
1084
+ :description,
1085
+ :section,
1086
+ :page,
1087
+ :required,
1088
+ :type,
1089
+ :campaign_setting,
1090
+ :partner_profile_field)
1091
+ SENSITIVE = []
1092
+ include Aws::Structure
1093
+ end
1094
+
1095
+ # How to order `ListCampaigns`. Ties break by campaign id, ascending.
1096
+ #
1097
+ # @!attribute [rw] sort_by
1098
+ # The attribute to sort by.
1099
+ # @return [String]
1100
+ #
1101
+ # @!attribute [rw] sort_order
1102
+ # The direction.
1103
+ # @return [String]
1104
+ #
1105
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/CampaignSort AWS API Documentation
1106
+ #
1107
+ class CampaignSort < Struct.new(
1108
+ :sort_by,
1109
+ :sort_order)
1110
+ SENSITIVE = []
1111
+ include Aws::Structure
1112
+ end
1113
+
1114
+ # Summary representation of a campaign for list operations.
1115
+ #
1116
+ # @!attribute [rw] campaign_id
1117
+ # The campaign identifier.
1118
+ # @return [String]
1119
+ #
1120
+ # @!attribute [rw] arn
1121
+ # The campaign ARN. Present on the summary so a caller can tag a
1122
+ # campaign straight from a list result without a GetCampaign per row —
1123
+ # the same reason the audit timestamps are here.
1124
+ # @return [String]
1125
+ #
1126
+ # @!attribute [rw] name
1127
+ # The display name.
1128
+ # @return [String]
1129
+ #
1130
+ # @!attribute [rw] state
1131
+ # The campaign's state, derived on every read from `EndOn` and its
1132
+ # assets. See `CampaignState`.
1133
+ # @return [String]
1134
+ #
1135
+ # @!attribute [rw] language
1136
+ # The language the campaign's assets are written and typeset in. See
1137
+ # `Campaign$Language`.
1138
+ # @return [String]
1139
+ #
1140
+ # @!attribute [rw] start_on
1141
+ # The first day of the campaign's run window.
1142
+ # @return [String]
1143
+ #
1144
+ # @!attribute [rw] end_on
1145
+ # The last day of the campaign's run window.
1146
+ # @return [String]
1147
+ #
1148
+ # @!attribute [rw] created_at
1149
+ # Creation timestamp. Present on the summary so a caller can order a
1150
+ # list by recency without reading each campaign in full.
1151
+ # @return [Time]
1152
+ #
1153
+ # @!attribute [rw] updated_at
1154
+ # Last update timestamp. Present on the summary for the same reason as
1155
+ # CreatedAt.
1156
+ # @return [Time]
1157
+ #
1158
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/CampaignSummary AWS API Documentation
1159
+ #
1160
+ class CampaignSummary < Struct.new(
1161
+ :campaign_id,
1162
+ :arn,
1163
+ :name,
1164
+ :state,
1165
+ :language,
1166
+ :start_on,
1167
+ :end_on,
1168
+ :created_at,
1169
+ :updated_at)
1170
+ SENSITIVE = []
1171
+ include Aws::Structure
1172
+ end
1173
+
1174
+ # A platform-managed campaign template — an AWS-authored kit of asset
1175
+ # blueprints a partner creates a campaign from.
1176
+ #
1177
+ # @!attribute [rw] id
1178
+ # The campaign template identifier.
1179
+ # @return [String]
1180
+ #
1181
+ # @!attribute [rw] name
1182
+ # The display name.
1183
+ # @return [String]
1184
+ #
1185
+ # @!attribute [rw] industry
1186
+ # Target industry for filtering or categorization.
1187
+ # @return [String]
1188
+ #
1189
+ # @!attribute [rw] use_case
1190
+ # Campaign use case for filtering or categorization.
1191
+ # @return [String]
1192
+ #
1193
+ # @!attribute [rw] description
1194
+ # A short overview of the campaign, as plain text in the template's
1195
+ # language: no HTML and no character entities. Absent when the
1196
+ # template has none; never an empty string.
1197
+ # @return [String]
1198
+ #
1199
+ # @!attribute [rw] language_code
1200
+ # Language the template is authored in, which a campaign created from
1201
+ # it takes. A template has one language; the same content in another
1202
+ # language is another template.
1203
+ # @return [String]
1204
+ #
1205
+ # @!attribute [rw] collection
1206
+ # The browsing context the template is listed in. Every template has
1207
+ # exactly one.
1208
+ # @return [String]
1209
+ #
1210
+ # @!attribute [rw] aws_services
1211
+ # AWS services the template promotes.
1212
+ # @return [Array<String>]
1213
+ #
1214
+ # @!attribute [rw] customer_segments
1215
+ # The customer segments the template is written for. Absent when the
1216
+ # template names none, in which case it matches every
1217
+ # `CustomerSegments` search filter.
1218
+ # @return [Array<String>]
1219
+ #
1220
+ # @!attribute [rw] themes
1221
+ # The template's marketing themes. Absent when the template names
1222
+ # none, in which case it matches every `Themes` search filter.
1223
+ # @return [Array<String>]
1224
+ #
1225
+ # @!attribute [rw] setup_duration
1226
+ # Estimated setup time.
1227
+ # @return [String]
1228
+ #
1229
+ # @!attribute [rw] thumbnail_url
1230
+ # Thumbnail URL.
1231
+ # @return [String]
1232
+ #
1233
+ # @!attribute [rw] effective_date_begin
1234
+ # The instant the template becomes available to partners. Until then
1235
+ # the template does not exist to a partner: SearchCampaignTemplates
1236
+ # omits it and GetCampaignTemplate returns ResourceNotFoundException.
1237
+ # @return [Time]
1238
+ #
1239
+ # @!attribute [rw] asset_templates
1240
+ # The ordered asset blueprints. One call serves both template browsing
1241
+ # and server-side copy-at-create.
1242
+ # @return [Array<Types::CampaignAssetTemplate>]
1243
+ #
1244
+ # @!attribute [rw] reference_materials
1245
+ # The template's reference materials: guides, briefs, copy blocks and
1246
+ # other files a partner downloads and uses in their own channels. Kept
1247
+ # apart from `AssetTemplates` because none of them can become a
1248
+ # campaign asset — they have no editable field and nothing to activate
1249
+ # — and listing them beside the blueprints invited a
1250
+ # `BatchCreateCampaignAsset` that could only fail.
1251
+ #
1252
+ # Absent when the template has none.
1253
+ # @return [Array<Types::ReferenceMaterial>]
1254
+ #
1255
+ # @!attribute [rw] created_at
1256
+ # Creation timestamp.
1257
+ # @return [Time]
1258
+ #
1259
+ # @!attribute [rw] updated_at
1260
+ # Last update timestamp.
1261
+ # @return [Time]
1262
+ #
1263
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/CampaignTemplate AWS API Documentation
1264
+ #
1265
+ class CampaignTemplate < Struct.new(
1266
+ :id,
1267
+ :name,
1268
+ :industry,
1269
+ :use_case,
1270
+ :description,
1271
+ :language_code,
1272
+ :collection,
1273
+ :aws_services,
1274
+ :customer_segments,
1275
+ :themes,
1276
+ :setup_duration,
1277
+ :thumbnail_url,
1278
+ :effective_date_begin,
1279
+ :asset_templates,
1280
+ :reference_materials,
1281
+ :created_at,
1282
+ :updated_at)
1283
+ SENSITIVE = []
1284
+ include Aws::Structure
1285
+ end
1286
+
1287
+ # Summary representation of a campaign template, returned by search.
1288
+ #
1289
+ # @!attribute [rw] id
1290
+ # The campaign template identifier.
1291
+ # @return [String]
1292
+ #
1293
+ # @!attribute [rw] name
1294
+ # The display name.
1295
+ # @return [String]
1296
+ #
1297
+ # @!attribute [rw] industry
1298
+ # Target industry for filtering or categorization.
1299
+ # @return [String]
1300
+ #
1301
+ # @!attribute [rw] use_case
1302
+ # Campaign use case for filtering or categorization.
1303
+ # @return [String]
1304
+ #
1305
+ # @!attribute [rw] description
1306
+ # The campaign overview. See `CampaignTemplate$Description`.
1307
+ # @return [String]
1308
+ #
1309
+ # @!attribute [rw] language_code
1310
+ # Language the template is authored in. See
1311
+ # `CampaignTemplate$LanguageCode`.
1312
+ # @return [String]
1313
+ #
1314
+ # @!attribute [rw] collection
1315
+ # The browsing context the template is listed in. See
1316
+ # `CampaignTemplate$Collection`.
1317
+ # @return [String]
1318
+ #
1319
+ # @!attribute [rw] aws_services
1320
+ # AWS services the template promotes.
1321
+ # @return [Array<String>]
1322
+ #
1323
+ # @!attribute [rw] customer_segments
1324
+ # The customer segments the template is written for. See
1325
+ # `CampaignTemplate$CustomerSegments`.
1326
+ # @return [Array<String>]
1327
+ #
1328
+ # @!attribute [rw] themes
1329
+ # The template's marketing themes. See `CampaignTemplate$Themes`.
1330
+ # @return [Array<String>]
1331
+ #
1332
+ # @!attribute [rw] thumbnail_url
1333
+ # Thumbnail URL.
1334
+ # @return [String]
1335
+ #
1336
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/CampaignTemplateSummary AWS API Documentation
1337
+ #
1338
+ class CampaignTemplateSummary < Struct.new(
1339
+ :id,
1340
+ :name,
1341
+ :industry,
1342
+ :use_case,
1343
+ :description,
1344
+ :language_code,
1345
+ :collection,
1346
+ :aws_services,
1347
+ :customer_segments,
1348
+ :themes,
1349
+ :thumbnail_url)
1350
+ SENSITIVE = []
1351
+ include Aws::Structure
1352
+ end
1353
+
1354
+ # The request conflicts with the current state of the resource.
1355
+ #
1356
+ # @!attribute [rw] message
1357
+ # Error message.
1358
+ # @return [String]
1359
+ #
1360
+ # @!attribute [rw] resource_id
1361
+ # The affected resource identifier. For a uniqueness conflict this is
1362
+ # the identifier of the *existing* resource, so the caller can act on
1363
+ # it without a separate lookup.
1364
+ # @return [String]
1365
+ #
1366
+ # @!attribute [rw] resource_type
1367
+ # The affected resource type.
1368
+ # @return [String]
1369
+ #
1370
+ # @!attribute [rw] reason
1371
+ # Machine-readable cause, for clients that branch on it.
1372
+ #
1373
+ # An open set of `SCREAMING_SNAKE_CASE` tokens, deliberately typed as
1374
+ # a string rather than an enum. `ConflictException` is shared by every
1375
+ # resource in this service, so an enum here would accumulate values
1376
+ # that are meaningful for one resource and inapplicable to the rest —
1377
+ # the cohesiveness problem the Backward Compatibility standard
1378
+ # describes under "Sharing enums" — and each new value would force an
1379
+ # SDK regeneration on callers who can never encounter it. Clients MUST
1380
+ # treat an unrecognised value as an unspecified conflict and fall back
1381
+ # to `Message`.
1382
+ #
1383
+ # Values in use today:
1384
+ #
1385
+ # From the campaign asset activation path. Every one of these is
1386
+ # decided before the operation returns, so a caller that receives one
1387
+ # knows nothing was started.
1388
+ #
1389
+ # These two are thrown by `DeactivateCampaignAsset`, which refuses one
1390
+ # asset outright. `StartCampaignAssetActivationTask` reports the same
1391
+ # two causes **per asset** as a FAILED task entry instead of throwing,
1392
+ # because one bad identifier must not refuse the twenty-four good ones
1393
+ # beside it — so the spellings are deliberately identical to
1394
+ # `CampaignAssetStateReason`'s, letting a client match one string
1395
+ # whichever way the refusal arrived. The two types evolve
1396
+ # independently on purpose: this is an open string shared by every
1397
+ # resource, that is a closed enum owned by one operation.
1398
+ #
1399
+ # * `ASSET_START_IN_PROGRESS` — the asset is already being started, or
1400
+ # another caller changed it during this request. Retryable once the
1401
+ # outcome is visible.
1402
+ # * `PREREQUISITE_ASSET_NOT_ACTIVE` — this asset embeds output from
1403
+ # another asset that is not live. `ResourceId` carries that asset's
1404
+ # identifier.
1405
+ #
1406
+ # From the prerequisite edges between a campaign's assets — an email
1407
+ # that embeds its landing page's URL. Both refuse the whole request
1408
+ # and write nothing.
1409
+ #
1410
+ # * `PREREQUISITE_ASSET_MISSING` — from `BatchCreateCampaignAsset`: an
1411
+ # entry's blueprint embeds another blueprint's output, and that
1412
+ # blueprint is neither named in the same request nor already an
1413
+ # asset on the campaign. Retry with it in the request. `ResourceId`
1414
+ # carries the missing blueprint's identifier.
1415
+ # * `ASSET_HAS_DEPENDENTS` — from `DeleteCampaignAsset`: another asset
1416
+ # on the campaign embeds this asset's output, so deleting it would
1417
+ # leave that asset unactivatable. Delete the dependents first. The
1418
+ # message names them.
1419
+ #
1420
+ # `CAMPAIGN_COMPLETED` — the campaign is complete (the UTC date is
1421
+ # after its `EndOn`), so it and its assets are read-only. Refuses
1422
+ # `UpdateCampaign`, `BatchCreateCampaignAsset`, `UpdateCampaignAsset`,
1423
+ # `DeleteCampaignAsset` and `StartCampaignAssetActivationTask`; never
1424
+ # `DeactivateCampaignAsset`. **Not retryable, and not fixable** —
1425
+ # `EndOn` cannot be moved once it has passed, so nothing the caller
1426
+ # does will make the write succeed. `ResourceId` carries the campaign
1427
+ # identifier.
1428
+ #
1429
+ # ⚠️ This is the one conflict reason whose condition **never clears**,
1430
+ # which sits awkwardly with `ConflictException` promising a state that
1431
+ # may change. It is a conflict rather than a validation failure
1432
+ # because the request is well formed and would have succeeded a moment
1433
+ # earlier — the resource's state is what refuses it, which is what
1434
+ # this exception is for. Contrast `ASSET_NOT_STARTABLE`, which moved
1435
+ # to `ValidationException` precisely because it is a property of the
1436
+ # asset's *type* rather than of its state.
1437
+ #
1438
+ # ⚠️ **`COMPLETED` also exists as a `CampaignAssetExportTaskStatus`
1439
+ # value, on a different axis.** That one means an export archive
1440
+ # finished assembling. The two are unrelated and must not be unified.
1441
+ #
1442
+ # `CAMPAIGN_HAS_ACTIVE_ASSETS` — from `DeleteCampaign`: at least one
1443
+ # of the campaign's assets is live, and deleting the campaign would
1444
+ # orphan what the delivery platform still serves or sends. Deactivate
1445
+ # those assets with `DeactivateCampaignAsset`, then retry. The message
1446
+ # names them. `ResourceId` carries the campaign identifier.
1447
+ #
1448
+ # `CAMPAIGN_ACTIVATION_IN_PROGRESS` — from
1449
+ # `StartCampaignAssetActivationTask` and `DeleteCampaign`, refusing
1450
+ # the whole request: one activation task runs on a campaign at a time.
1451
+ # `ResourceId` carries the **holding task's id**, so a caller can
1452
+ # poll `GetCampaignAssetActivationTask` rather than guess. Retryable
1453
+ # once that task reaches a terminal status.
1454
+ #
1455
+ # `SERVICE_LINKED_ROLE_DELETION_IN_PROGRESS` — from
1456
+ # `StartCampaignAssetActivationTask`, refusing the whole request: this
1457
+ # service's service-linked role is being deleted, so no asset may go
1458
+ # live. Not a lease conflict: `ResourceId` is unset and there is no
1459
+ # task to poll. Retryable after a short wait; if the role was deleted,
1460
+ # the next activation recreates it.
1461
+ #
1462
+ # `LAYOUT_LOCKED_AFTER_ACTIVATION` — from `UpdateCampaignAsset`,
1463
+ # refusing a `Layout` change on a multi-layout asset that has
1464
+ # activated successfully at least once (DG-044). The published object
1465
+ # is that layout's, so switching would leave the asset describing a
1466
+ # layout that is not the one live. **Not fixable**: the asset keeps
1467
+ # its layout for life. A failed activation does not lock it.
1468
+ # Re-sending the layout already selected is not a change and is
1469
+ # accepted. `ResourceId` carries the asset identifier.
1470
+ #
1471
+ # `ASSET_START_IN_PROGRESS` — also from `UpdateCampaignAsset`,
1472
+ # refusing any edit to an asset the campaign's running activation
1473
+ # task has accepted and not yet finished: the run publishes the
1474
+ # content it read, so an edit accepted mid-run would either be
1475
+ # published unvalidated or never published. Nothing is written.
1476
+ # Retryable once the asset's outcome on the task
1477
+ # (`GetCampaignAssetActivationTask`) is terminal; the asset's
1478
+ # siblings may still be running. `ResourceId` carries the asset
1479
+ # identifier.
1480
+ #
1481
+ # `ASSET_ALREADY_ACTIVE` — from `UpdateCampaignAsset`, refusing any
1482
+ # change to a live email or social post, content or schedule.
1483
+ # Deactivate it first; the next activation sends everything current.
1484
+ # Landing pages and documents are edited live and converge by
1485
+ # re-activation. `ResourceId` carries the asset identifier.
1486
+ #
1487
+ # `ASSET_NOT_DEACTIVATABLE` — from `DeactivateCampaignAsset`, for an
1488
+ # asset that can't be stopped: a document, banner or landing page
1489
+ # until the campaign has completed, when it becomes removable. Until
1490
+ # then, update it and activate it again. `ResourceId` carries the
1491
+ # asset identifier.
1492
+ #
1493
+ # `ASSET_HAS_LOCKED_SENDS` — from `DeactivateCampaignAsset`, within an
1494
+ # hour of the asset's send (a social post's publish), when it can no
1495
+ # longer be withdrawn. `ASSET_ALREADY_DELIVERED` — the same, once that
1496
+ # time has passed: a sent email or a published post cannot be
1497
+ # recalled. Neither is retryable.
1498
+ #
1499
+ # Three values were removed with the campaign lifecycle and the
1500
+ # singular activate, and none should be re-added here:
1501
+ #
1502
+ # * `CAMPAIGN_NOT_STARTED` — a campaign has no state to be started out
1503
+ # of.
1504
+ # * `ASSET_NOT_STARTABLE` — moved to `ValidationException`, with no
1505
+ # reason. The value's own documentation said it was "not retryable
1506
+ # and not fixable: it is a property of the asset's type", and
1507
+ # `ConflictException` promises a state that may change. The gate
1508
+ # itself stays — deleting it lets a download-only asset into a task
1509
+ # with no dispatch arm, which would succeed and do nothing.
1510
+ # * `ASSET_START_UNCONFIRMED` — described a state that no longer
1511
+ # occurs. DG cannot be more idempotent than a platform whose social
1512
+ # create has no idempotency key, so an ambiguous hand-over is now an
1513
+ # ordinary failure carrying `INTERNAL_ERROR`. Holding the asset in a
1514
+ # distinct state bought a guarantee that was never real, and had no
1515
+ # exit.
1516
+ # @return [String]
1517
+ #
1518
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/ConflictException AWS API Documentation
1519
+ #
1520
+ class ConflictException < Struct.new(
1521
+ :message,
1522
+ :resource_id,
1523
+ :resource_type,
1524
+ :reason)
1525
+ SENSITIVE = []
1526
+ include Aws::Structure
1527
+ end
1528
+
1529
+ # Input for CreateCampaign operation.
1530
+ #
1531
+ # @!attribute [rw] catalog
1532
+ # The catalog (AWS or Sandbox).
1533
+ # @return [String]
1534
+ #
1535
+ # @!attribute [rw] name
1536
+ # The display name.
1537
+ # @return [String]
1538
+ #
1539
+ # @!attribute [rw] campaign_template_id
1540
+ # The campaign template this campaign draws its assets from.
1541
+ #
1542
+ # Binds the campaign to a single source template: every asset must
1543
+ # come from this template's asset templates, and one from another
1544
+ # template is refused at `BatchCreateCampaignAsset`. Immutable once
1545
+ # set. Every campaign has one: a campaign's language and its assets'
1546
+ # blueprints both come from its template. Templates are AWS-authored
1547
+ # and read-only — they are discovered
1548
+ # through `SearchCampaignTemplates` and `GetCampaignTemplate`, and
1549
+ # there is no create, update or delete operation for one. The
1550
+ # template's id only: a campaign template has no ARN (DG-084).
1551
+ # The member keeps the `<Resource>Id` name, which is the convention
1552
+ # for referencing another resource from a body. </Resource>
1553
+ # @return [String]
1554
+ #
1555
+ # @!attribute [rw] sender_email
1556
+ # The address every email of this campaign is sent from.
1557
+ #
1558
+ # Printable ASCII only, with no spaces or line breaks, or field code
1559
+ # `PATTERN\_MISMATCH`. Then three rules, all checked when the sender
1560
+ # is set. Its domain must exactly match, ignoring case, the domain of
1561
+ # the partner's alliance lead email in AWS Partner Central (a
1562
+ # subdomain does not), or field code
1563
+ # `SENDER\_DOMAIN\_NOT\_ALLIANCE\_LEAD`. Then, for a sender at
1564
+ # example.com, DNS must hold the CNAME
1565
+ # `dkim.\_domainkey.example.com` → `dkim.\_domainkey.md02.com`
1566
+ # (field code `SENDER\_DOMAIN\_DKIM\_MISSING`) and a DMARC record,
1567
+ # one TXT `\_dmarc.example.com` starting `v=DMARC1` with a `p`
1568
+ # of `none`, `quarantine` or `reject` (field code
1569
+ # `SENDER\_DOMAIN\_DMARC\_MISSING`). Both DNS codes are reported
1570
+ # together when both records are missing. A partner who can't satisfy
1571
+ # them can't set a sender, so can't run
1572
+ # email campaigns. A shared mail provider's domain, such as
1573
+ # gmail.com, can't carry the records. Optional here: a campaign with
1574
+ # no sender can be created and edited, but its email assets cannot be
1575
+ # activated until one is set.
1576
+ # @return [String]
1577
+ #
1578
+ # @!attribute [rw] privacy_policy_url
1579
+ # The URL of the partner's privacy policy, linked from every email
1580
+ # and landing page footer. Optional here: a campaign whose emails or
1581
+ # landing pages show it cannot activate them until one is set.
1582
+ # @return [String]
1583
+ #
1584
+ # @!attribute [rw] partner_address
1585
+ # The partner's physical postal address, shown in every email footer
1586
+ # and as a landing page's contact line. Optional here: an email that
1587
+ # shows it cannot activate until one is set. A landing page that shows
1588
+ # it publishes it empty when it is unset, and a document's footer
1589
+ # then prints the partner's name alone.
1590
+ # @return [String]
1591
+ #
1592
+ # @!attribute [rw] partner_badge
1593
+ # The partner's badge — a tier or designation badge from AWS Partner
1594
+ # Badge Manager — shown in every badge slot of the campaign's emails,
1595
+ # landing pages and documents. Optional: until one is set, every badge
1596
+ # slot shows the Standalone AWS Partner badge.
1597
+ #
1598
+ # A PNG or JPEG of at most 2 MB, staged like an asset image and
1599
+ # checked the same way: it must have passed the staging scan
1600
+ # (`SCAN\_REJECTED`, or `SCAN\_IN\_PROGRESS` while it is pending),
1601
+ # and its bytes must be the format its name says
1602
+ # (`IMAGE\_FORMAT\_NOT\_SUPPORTED`). Any shape is accepted: a badge
1603
+ # is drawn whole, never cropped. Content moderation judges it when an
1604
+ # asset that shows it is activated.
1605
+ # @return [Types::FileRef]
1606
+ #
1607
+ # @!attribute [rw] email_target
1608
+ # The campaign's send audience — a CSV of recipient email addresses.
1609
+ #
1610
+ # The campaign's *target*: who the campaign is sent to, as distinct
1611
+ # from a `CampaignAsset`, which is the content that is sent. It sits
1612
+ # on the campaign and not on the activation call because a partner
1613
+ # assembles it in the same wizard flow that sets the name and the
1614
+ # dates — and because attaching it here means it is validated, staged
1615
+ # and resolved to a count before anything is activated, rather than at
1616
+ # the last click. Required format: a header row naming the email
1617
+ # column `Email`,
1618
+ # `E-mail`, `Email Address` or `E-mail Address` — compared
1619
+ # without case, spaces or punctuation. Other columns are permitted and
1620
+ # ignored, and with two email columns the first is used. A file
1621
+ # without such a header is refused with field code
1622
+ # `EMAIL\_COLUMN\_MISSING`: the address column is never guessed. The
1623
+ # rows reach the delivery platform's importer as the partner wrote
1624
+ # them — a partner's audience is never rewritten. At most 5 MB,
1625
+ # checked against the object's size before anything is
1626
+ # copied, and at most 10,000 distinct addresses, refused with
1627
+ # `RECIPIENT\_LIST\_TOO\_LARGE`. A file with no valid address at all
1628
+ # is refused with `RECIPIENT\_LIST\_EMPTY`; otherwise rows without a
1629
+ # usable address are not a refusal: they are skipped and counted, and
1630
+ # `GetCampaign` reports the counts. Optional here, because a
1631
+ # campaign is a container and holds no state to be incomplete in — but
1632
+ # an email asset cannot be activated without it, so the requirement
1633
+ # moved to the point of activation. Editable at any time, and an edit
1634
+ # reaches the delivery platform only
1635
+ # when an asset is activated after it. Each email activation loads the
1636
+ # audience into a contact list of its own, so an address taken off the
1637
+ # file is not sent to by the next activation. The bytes are
1638
+ # write-only. No response returns a URL or an `S3Uri`
1639
+ # for this file; `GetCampaign` returns the scan verdict, when the
1640
+ # list was attached and how its rows resolved, and nothing more.
1641
+ # @return [Types::FileRef]
1642
+ #
1643
+ # @!attribute [rw] email_target_engagement_group_ids
1644
+ # Engagement groups whose contacts the campaign's emails will also go
1645
+ # to: the `Id`s `ListEngagementGroups` returns (AWS Partner Central
1646
+ # Selling). 1–10, each named once.
1647
+ #
1648
+ # Each group is named once: a repeated id is refused with field code
1649
+ # `INVALID\_VALUE`. Not checked against your groups when saved.
1650
+ # StartCampaignAssetActivationTask resolves them to recipients. On a
1651
+ # stage that can't resolve groups yet, Start refuses an email while
1652
+ # groups are set (`ENGAGEMENT\_GROUPS\_UNAVAILABLE`), rather than
1653
+ # send to `EmailTarget` alone.
1654
+ # @return [Array<String>]
1655
+ #
1656
+ # @!attribute [rw] target_audience
1657
+ # Advisory targeting metadata. Refined later, and not validated here.
1658
+ # @return [Types::TargetAudience]
1659
+ #
1660
+ # @!attribute [rw] estimated_budget
1661
+ # What the partner expects the campaign to cost.
1662
+ # @return [Types::MonetaryValue]
1663
+ #
1664
+ # @!attribute [rw] total_budget
1665
+ # The campaign's total budget.
1666
+ # @return [Types::MonetaryValue]
1667
+ #
1668
+ # @!attribute [rw] start_on
1669
+ # The first day of the campaign's run window. Not after `EndOn`
1670
+ # (`ValidationException`, `INVALID_VALUE`).
1671
+ # @return [String]
1672
+ #
1673
+ # @!attribute [rw] end_on
1674
+ # The last day of the campaign's run window, inclusive and in UTC.
1675
+ # Not in the past: the campaign completes at the UTC midnight after it
1676
+ # (see `CampaignState`). A scheduled send must fall on or before it.
1677
+ #
1678
+ # Optional here, but required before any asset activates: until it is
1679
+ # set, GetCampaign's `ActivationIssues` reports `END_ON_MISSING` and
1680
+ # StartCampaignAssetActivationTask refuses (`CAMPAIGN_INCOMPLETE`).
1681
+ # Set it with UpdateCampaign.
1682
+ # @return [String]
1683
+ #
1684
+ # @!attribute [rw] client_token
1685
+ # Idempotency token. Same token within 24h returns existing resource.
1686
+ #
1687
+ # **A suitable default value is auto-generated.** You should normally
1688
+ # not need to pass this option.
1689
+ # @return [String]
1690
+ #
1691
+ # @!attribute [rw] tags
1692
+ # Tags to apply at creation.
1693
+ #
1694
+ # Tag-on-create rather than create-then-tag is a Tagris requirement,
1695
+ # not a convenience: it is what lets a tag-based access control policy
1696
+ # govern the creation itself. A campaign created untagged and tagged a
1697
+ # moment later is briefly outside any such policy.
1698
+ #
1699
+ # A key beginning `aws:` (any case) is reserved for AWS-applied
1700
+ # system tags and is refused with `ValidationException`, as is a key
1701
+ # repeated in the list; nothing is created. The tags are recorded
1702
+ # before the campaign is written, so a create that cannot record them
1703
+ # fails and creates nothing. A retry with the same `ClientToken`
1704
+ # returns the campaign the first attempt created and does not re-apply
1705
+ # tags — use `TagResource` to change them afterwards.
1706
+ # `ListTagsForResource` returns them.
1707
+ # @return [Array<Types::Tag>]
1708
+ #
1709
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/CreateCampaignRequest AWS API Documentation
1710
+ #
1711
+ class CreateCampaignRequest < Struct.new(
1712
+ :catalog,
1713
+ :name,
1714
+ :campaign_template_id,
1715
+ :sender_email,
1716
+ :privacy_policy_url,
1717
+ :partner_address,
1718
+ :partner_badge,
1719
+ :email_target,
1720
+ :email_target_engagement_group_ids,
1721
+ :target_audience,
1722
+ :estimated_budget,
1723
+ :total_budget,
1724
+ :start_on,
1725
+ :end_on,
1726
+ :client_token,
1727
+ :tags)
1728
+ SENSITIVE = [:sender_email, :partner_address]
1729
+ include Aws::Structure
1730
+ end
1731
+
1732
+ # Output for CreateCampaign.
1733
+ #
1734
+ # @!attribute [rw] id
1735
+ # The new campaign's identifier.
1736
+ # @return [String]
1737
+ #
1738
+ # @!attribute [rw] arn
1739
+ # The new campaign's ARN.
1740
+ # @return [String]
1741
+ #
1742
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/CreateCampaignResponse AWS API Documentation
1743
+ #
1744
+ class CreateCampaignResponse < Struct.new(
1745
+ :id,
1746
+ :arn)
1747
+ SENSITIVE = []
1748
+ include Aws::Structure
1749
+ end
1750
+
1751
+ # Input for CreateSocialConnectionAuthorizationUrl.
1752
+ #
1753
+ # Names a platform, not a connection: the same call serves a first
1754
+ # connect, connecting another account, and re-authorizing an expired
1755
+ # one. Which of those it was is decided by the account the partner
1756
+ # consents with, and shows up in ListSocialConnections afterwards.
1757
+ # Writes nothing in this service.
1758
+ #
1759
+ # @!attribute [rw] catalog
1760
+ # Catalog the connection belongs to.
1761
+ # @return [String]
1762
+ #
1763
+ # @!attribute [rw] platform
1764
+ # Social platform to authorize.
1765
+ # @return [String]
1766
+ #
1767
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/CreateSocialConnectionAuthorizationUrlRequest AWS API Documentation
1768
+ #
1769
+ class CreateSocialConnectionAuthorizationUrlRequest < Struct.new(
1770
+ :catalog,
1771
+ :platform)
1772
+ SENSITIVE = []
1773
+ include Aws::Structure
1774
+ end
1775
+
1776
+ # Output for CreateSocialConnectionAuthorizationUrl.
1777
+ #
1778
+ # @!attribute [rw] platform
1779
+ # Social platform the URL authorizes.
1780
+ # @return [String]
1781
+ #
1782
+ # @!attribute [rw] authorization_url
1783
+ # Fresh single-use URL the partner visits to grant authorization.
1784
+ # @return [String]
1785
+ #
1786
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/CreateSocialConnectionAuthorizationUrlResponse AWS API Documentation
1787
+ #
1788
+ class CreateSocialConnectionAuthorizationUrlResponse < Struct.new(
1789
+ :platform,
1790
+ :authorization_url)
1791
+ SENSITIVE = [:authorization_url]
1792
+ include Aws::Structure
1793
+ end
1794
+
1795
+ # Input for DeactivateCampaignAsset.
1796
+ #
1797
+ # @!attribute [rw] catalog
1798
+ # The catalog (AWS or Sandbox).
1799
+ # @return [String]
1800
+ #
1801
+ # @!attribute [rw] campaign_identifier
1802
+ # The campaign identifier.
1803
+ # @return [String]
1804
+ #
1805
+ # @!attribute [rw] campaign_asset_identifier
1806
+ # The asset identifier.
1807
+ # @return [String]
1808
+ #
1809
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/DeactivateCampaignAssetRequest AWS API Documentation
1810
+ #
1811
+ class DeactivateCampaignAssetRequest < Struct.new(
1812
+ :catalog,
1813
+ :campaign_identifier,
1814
+ :campaign_asset_identifier)
1815
+ SENSITIVE = []
1816
+ include Aws::Structure
1817
+ end
1818
+
1819
+ # Output for DeactivateCampaignAsset.
1820
+ #
1821
+ # Synchronous, so the outcome of the stop is this response — there is no
1822
+ # `lastDeactivationStatus`, and its absence is not an oversight.
1823
+ # Activation is asynchronous and its outcome arrives long after the
1824
+ # response, which is why that one has to be persisted where a partner
1825
+ # can read it later.
1826
+ #
1827
+ # @!attribute [rw] id
1828
+ # The asset identifier.
1829
+ # @return [String]
1830
+ #
1831
+ # @!attribute [rw] state
1832
+ # The asset's lifecycle position — INACTIVE once the stop is
1833
+ # confirmed.
1834
+ # @return [String]
1835
+ #
1836
+ # @!attribute [rw] last_activation_status
1837
+ # How the most recent *activation* attempt ended, which a stop does
1838
+ # not change. Read with state, it is what separates a stopped asset
1839
+ # (INACTIVE + SUCCEEDED) from one never activated (INACTIVE, this
1840
+ # member absent). Omitted until a first activation has been attempted.
1841
+ # @return [String]
1842
+ #
1843
+ # @!attribute [rw] state_reason
1844
+ # Why the asset sits where it does. Present when LastActivationStatus
1845
+ # is FAILED, or on a deliberate INACTIVE.
1846
+ # @return [String]
1847
+ #
1848
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/DeactivateCampaignAssetResponse AWS API Documentation
1849
+ #
1850
+ class DeactivateCampaignAssetResponse < Struct.new(
1851
+ :id,
1852
+ :state,
1853
+ :last_activation_status,
1854
+ :state_reason)
1855
+ SENSITIVE = []
1856
+ include Aws::Structure
1857
+ end
1858
+
1859
+ # Input for DeleteCampaignAsset operation.
1860
+ #
1861
+ # @!attribute [rw] catalog
1862
+ # The catalog (AWS or Sandbox).
1863
+ # @return [String]
1864
+ #
1865
+ # @!attribute [rw] campaign_identifier
1866
+ # The campaign identifier.
1867
+ # @return [String]
1868
+ #
1869
+ # @!attribute [rw] campaign_asset_identifier
1870
+ # The asset identifier.
1871
+ # @return [String]
1872
+ #
1873
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/DeleteCampaignAssetRequest AWS API Documentation
1874
+ #
1875
+ class DeleteCampaignAssetRequest < Struct.new(
1876
+ :catalog,
1877
+ :campaign_identifier,
1878
+ :campaign_asset_identifier)
1879
+ SENSITIVE = []
1880
+ include Aws::Structure
1881
+ end
1882
+
1883
+ # Input for DeleteCampaign.
1884
+ #
1885
+ # @!attribute [rw] catalog
1886
+ # The catalog (AWS or Sandbox).
1887
+ # @return [String]
1888
+ #
1889
+ # @!attribute [rw] campaign_identifier
1890
+ # The campaign to delete.
1891
+ # @return [String]
1892
+ #
1893
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/DeleteCampaignRequest AWS API Documentation
1894
+ #
1895
+ class DeleteCampaignRequest < Struct.new(
1896
+ :catalog,
1897
+ :campaign_identifier)
1898
+ SENSITIVE = []
1899
+ include Aws::Structure
1900
+ end
1901
+
1902
+ # Input for DeleteSocialConnection.
1903
+ #
1904
+ # @!attribute [rw] catalog
1905
+ # Catalog the connection belongs to.
1906
+ # @return [String]
1907
+ #
1908
+ # @!attribute [rw] identifier
1909
+ # Identifier or ARN of the social connection to delete.
1910
+ # @return [String]
1911
+ #
1912
+ # @!attribute [rw] client_token
1913
+ # Idempotency token.
1914
+ #
1915
+ # **A suitable default value is auto-generated.** You should normally
1916
+ # not need to pass this option.
1917
+ # @return [String]
1918
+ #
1919
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/DeleteSocialConnectionRequest AWS API Documentation
1920
+ #
1921
+ class DeleteSocialConnectionRequest < Struct.new(
1922
+ :catalog,
1923
+ :identifier,
1924
+ :client_token)
1925
+ SENSITIVE = []
1926
+ include Aws::Structure
1927
+ end
1928
+
1929
+ # The campaign's attached recipient list, as read — metadata only.
1930
+ #
1931
+ # No URL and no `S3Uri`, presigned or otherwise. The file is a list of
1932
+ # email addresses belonging to people who are not the partner, so there
1933
+ # is no read path for the bytes at all; what a caller needs is whether
1934
+ # the list was accepted and how many recipients it resolved to. The
1935
+ # three counts describe the file as it was read when attached. They
1936
+ # are absent for a list attached before the service began reading lists
1937
+ # at upload.
1938
+ #
1939
+ # @!attribute [rw] scan_status
1940
+ # The scan verdict for the attached list.
1941
+ # @return [String]
1942
+ #
1943
+ # @!attribute [rw] attached_at
1944
+ # When the list was attached.
1945
+ # @return [Time]
1946
+ #
1947
+ # @!attribute [rw] valid_count
1948
+ # Distinct usable addresses — the recipients an email activation sends
1949
+ # to.
1950
+ # @return [Integer]
1951
+ #
1952
+ # @!attribute [rw] rejected_count
1953
+ # Rows skipped because their email cell is not a usable address.
1954
+ # @return [Integer]
1955
+ #
1956
+ # @!attribute [rw] duplicate_count
1957
+ # Rows repeating an address already counted. Not an error: each
1958
+ # address is sent to once.
1959
+ # @return [Integer]
1960
+ #
1961
+ # @!attribute [rw] file_name
1962
+ # The display name of the uploaded file, as the partner named it, with
1963
+ # no path: for example `Q4 leads.csv`. Absent for a list attached
1964
+ # before the service kept the name. There is no link to the file: the
1965
+ # list is never downloadable from the campaign.
1966
+ # @return [String]
1967
+ #
1968
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/EmailTargetDetail AWS API Documentation
1969
+ #
1970
+ class EmailTargetDetail < Struct.new(
1971
+ :scan_status,
1972
+ :attached_at,
1973
+ :valid_count,
1974
+ :rejected_count,
1975
+ :duplicate_count,
1976
+ :file_name)
1977
+ SENSITIVE = []
1978
+ include Aws::Structure
1979
+ end
1980
+
1981
+ # The kind of a template field, carrying that kind's constraints,
1982
+ # placeholder or default. One discriminator instead of a separate kind
1983
+ # enum, constraints blob and preset value, so kind and constraints
1984
+ # cannot disagree. Read-only — templates are AWS-authored; the service
1985
+ # validates each partner value against it.
1986
+ #
1987
+ # A URL the partner types is not a distinct kind: it is text with a URL
1988
+ # pattern, and its link role is carried by the layout placeholder. The
1989
+ # same holds for a colour, which is text with a hex-colour pattern. A
1990
+ # link to another of the campaign's assets, whose URL DG writes at
1991
+ # activation, is `AssetLink`.
1992
+ #
1993
+ # @note FieldType is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of FieldType corresponding to the set member.
1994
+ #
1995
+ # @!attribute [rw] text
1996
+ # A plain-text field.
1997
+ # @return [Types::TextFieldType]
1998
+ #
1999
+ # @!attribute [rw] rich_text
2000
+ # A field whose value is a constrained HTML fragment.
2001
+ # @return [Types::RichTextFieldType]
2002
+ #
2003
+ # @!attribute [rw] image
2004
+ # An image field.
2005
+ # @return [Types::ImageFieldType]
2006
+ #
2007
+ # @!attribute [rw] asset_link
2008
+ # A link to another asset on the same campaign. The partner chooses
2009
+ # which asset, by `LinkedAssetId`; at activation DG writes that
2010
+ # asset's public URL into the field. A landing page's download
2011
+ # button is one, naming a `DOCUMENT`.
2012
+ # @return [Types::AssetLinkFieldType]
2013
+ #
2014
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/FieldType AWS API Documentation
2015
+ #
2016
+ class FieldType < Struct.new(
2017
+ :text,
2018
+ :rich_text,
2019
+ :image,
2020
+ :asset_link,
2021
+ :unknown)
2022
+ SENSITIVE = []
2023
+ include Aws::Structure
2024
+ include Aws::Structure::Union
2025
+
2026
+ class Text < FieldType; end
2027
+ class RichText < FieldType; end
2028
+ class Image < FieldType; end
2029
+ class AssetLink < FieldType; end
2030
+ class Unknown < FieldType; end
2031
+ end
2032
+
2033
+ # A value-only update to one email template field. The write counterpart
2034
+ # of CampaignAssetFieldValue: it carries just the addressing key and the
2035
+ # new value, never the service-owned schema.
2036
+ #
2037
+ # @!attribute [rw] field_id
2038
+ # The field to update; must match a FieldId in the asset's stored
2039
+ # schema.
2040
+ # @return [String]
2041
+ #
2042
+ # @!attribute [rw] value
2043
+ # The new value. Omit to clear the field.
2044
+ # @return [Types::TemplateFieldValue]
2045
+ #
2046
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/FieldValueInput AWS API Documentation
2047
+ #
2048
+ class FieldValueInput < Struct.new(
2049
+ :field_id,
2050
+ :value)
2051
+ SENSITIVE = []
2052
+ include Aws::Structure
2053
+ end
2054
+
2055
+ # A reference to a partner-supplied file in the Partner Central file
2056
+ # staging bucket.
2057
+ #
2058
+ # The URI must be `s3://\{stagingBucket}/\{callerAccountId}/…`, where
2059
+ # the account id segment equals the caller's session-derived account —
2060
+ # never an account named in the request body. A mismatch is refused
2061
+ # `FILE\_REFERENCE\_NOT\_OWNED`; any other bucket,
2062
+ # `FILE\_REFERENCE\_INVALID`. `VersionId` is required: the staging
2063
+ # bucket is versioned, and the
2064
+ # service takes exactly the version the upload returned, so a later
2065
+ # upload to the same key cannot change what was referenced. The service
2066
+ # copies that version into storage it controls and pins the copy for
2067
+ # scanning and processing.
2068
+ #
2069
+ # @!attribute [rw] s3_uri
2070
+ # The `s3://` location of the file.
2071
+ # @return [String]
2072
+ #
2073
+ # @!attribute [rw] version_id
2074
+ # The version of the object to take: the `VersionId` the staging
2075
+ # upload returned.
2076
+ # @return [String]
2077
+ #
2078
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/FileRef AWS API Documentation
2079
+ #
2080
+ class FileRef < Struct.new(
2081
+ :s3_uri,
2082
+ :version_id)
2083
+ SENSITIVE = []
2084
+ include Aws::Structure
2085
+ end
2086
+
2087
+ # Input for GetCampaignAssetActivationTask.
2088
+ #
2089
+ # @!attribute [rw] catalog
2090
+ # The catalog (AWS or Sandbox).
2091
+ # @return [String]
2092
+ #
2093
+ # @!attribute [rw] campaign_identifier
2094
+ # The campaign whose current task to read. This addresses the task,
2095
+ # and also authorizes the call.
2096
+ # @return [String]
2097
+ #
2098
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/GetCampaignAssetActivationTaskRequest AWS API Documentation
2099
+ #
2100
+ class GetCampaignAssetActivationTaskRequest < Struct.new(
2101
+ :catalog,
2102
+ :campaign_identifier)
2103
+ SENSITIVE = []
2104
+ include Aws::Structure
2105
+ end
2106
+
2107
+ # Output for GetCampaignAssetActivationTask: the campaign's most recent
2108
+ # task.
2109
+ #
2110
+ # @!attribute [rw] campaign_id
2111
+ # The campaign's id. Canonical: because `CampaignIdentifier` accepts
2112
+ # an id or an ARN, echoing this tells a caller who passed an ARN what
2113
+ # the id is. The task's own id is `TaskId`.
2114
+ # @return [String]
2115
+ #
2116
+ # @!attribute [rw] task_id
2117
+ # Opaque correlation value for the task. Echoed so a caller can tell
2118
+ # the task it started from a later one that superseded it. Never an
2119
+ # input: the campaign is what addresses a task, because a campaign has
2120
+ # at most one.
2121
+ # @return [String]
2122
+ #
2123
+ # @!attribute [rw] task_status
2124
+ # The task's status over every asset it names, refused ones included:
2125
+ # one refused and one succeeded is PARTIAL\_FAILURE.
2126
+ # @return [String]
2127
+ #
2128
+ # @!attribute [rw] started_at
2129
+ # When the task was created.
2130
+ # @return [Time]
2131
+ #
2132
+ # @!attribute [rw] ended_at
2133
+ # When the task reached a terminal status. Absent while IN\_PROGRESS.
2134
+ # @return [Time]
2135
+ #
2136
+ # @!attribute [rw] assets
2137
+ # One entry per asset the request named, in the order named. An asset
2138
+ # refused up front is FAILED from the first response, with its reason.
2139
+ # @return [Array<Types::CampaignAssetActivationOutcome>]
2140
+ #
2141
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/GetCampaignAssetActivationTaskResponse AWS API Documentation
2142
+ #
2143
+ class GetCampaignAssetActivationTaskResponse < Struct.new(
2144
+ :campaign_id,
2145
+ :task_id,
2146
+ :task_status,
2147
+ :started_at,
2148
+ :ended_at,
2149
+ :assets)
2150
+ SENSITIVE = []
2151
+ include Aws::Structure
2152
+ end
2153
+
2154
+ # Input for GetCampaignAssetExportTask.
2155
+ #
2156
+ # Takes the catalog, the owning campaign, and the export task
2157
+ # identifier. The campaign identifier is required so the operation can
2158
+ # be authorized on the task's owning campaign/\{CampaignId}: the task
2159
+ # is addressable by its id within the caller's partition, but the
2160
+ # campaign is not derivable from the task id alone at authorization
2161
+ # time.
2162
+ #
2163
+ # @!attribute [rw] catalog
2164
+ # The catalog (AWS or Sandbox).
2165
+ # @return [String]
2166
+ #
2167
+ # @!attribute [rw] campaign_identifier
2168
+ # The campaign that owns the export task. Accepts the campaign id or
2169
+ # ARN. Required so the read is authorized on campaign/\{CampaignId};
2170
+ # the task must belong to this campaign or the request resolves to
2171
+ # not-found.
2172
+ # @return [String]
2173
+ #
2174
+ # @!attribute [rw] campaign_asset_export_task_identifier
2175
+ # The export task to retrieve: the `Id` StartCampaignAssetExportTask
2176
+ # returned (`etsk-…`).
2177
+ #
2178
+ # An id only. An export task has no ARN: none is returned, recorded or
2179
+ # authorized on (the read authorizes on its campaign), so there is no
2180
+ # ARN to accept (DG-063 D-35).
2181
+ # @return [String]
2182
+ #
2183
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/GetCampaignAssetExportTaskRequest AWS API Documentation
2184
+ #
2185
+ class GetCampaignAssetExportTaskRequest < Struct.new(
2186
+ :catalog,
2187
+ :campaign_identifier,
2188
+ :campaign_asset_export_task_identifier)
2189
+ SENSITIVE = []
2190
+ include Aws::Structure
2191
+ end
2192
+
2193
+ # Output for GetCampaignAssetExportTask.
2194
+ #
2195
+ # @!attribute [rw] id
2196
+ # The export task identifier.
2197
+ # @return [String]
2198
+ #
2199
+ # @!attribute [rw] status
2200
+ # The task's state.
2201
+ # @return [String]
2202
+ #
2203
+ # @!attribute [rw] created_at
2204
+ # When the task was created.
2205
+ # @return [Time]
2206
+ #
2207
+ # @!attribute [rw] download_url
2208
+ # Presigned GET URL for the ZIP archive. Present only when status is
2209
+ # COMPLETED. Freshly minted on each call and short-lived (&lt;=15
2210
+ # minutes).
2211
+ # @return [String]
2212
+ #
2213
+ # @!attribute [rw] expires_at
2214
+ # When DownloadUrl expires. Present only when status is COMPLETED.
2215
+ # @return [Time]
2216
+ #
2217
+ # @!attribute [rw] failure_reason
2218
+ # Why the task failed. Present only when status is FAILED.
2219
+ # @return [Types::CampaignAssetExportFailureReason]
2220
+ #
2221
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/GetCampaignAssetExportTaskResponse AWS API Documentation
2222
+ #
2223
+ class GetCampaignAssetExportTaskResponse < Struct.new(
2224
+ :id,
2225
+ :status,
2226
+ :created_at,
2227
+ :download_url,
2228
+ :expires_at,
2229
+ :failure_reason)
2230
+ SENSITIVE = []
2231
+ include Aws::Structure
2232
+ end
2233
+
2234
+ # Input for GetCampaignAsset operation.
2235
+ #
2236
+ # @!attribute [rw] catalog
2237
+ # The catalog (AWS or Sandbox).
2238
+ # @return [String]
2239
+ #
2240
+ # @!attribute [rw] campaign_identifier
2241
+ # The campaign identifier.
2242
+ # @return [String]
2243
+ #
2244
+ # @!attribute [rw] campaign_asset_identifier
2245
+ # The asset identifier.
2246
+ # @return [String]
2247
+ #
2248
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/GetCampaignAssetRequest AWS API Documentation
2249
+ #
2250
+ class GetCampaignAssetRequest < Struct.new(
2251
+ :catalog,
2252
+ :campaign_identifier,
2253
+ :campaign_asset_identifier)
2254
+ SENSITIVE = []
2255
+ include Aws::Structure
2256
+ end
2257
+
2258
+ # Output for GetCampaignAsset.
2259
+ #
2260
+ # @!attribute [rw] asset
2261
+ # The asset resource.
2262
+ # @return [Types::CampaignAsset]
2263
+ #
2264
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/GetCampaignAssetResponse AWS API Documentation
2265
+ #
2266
+ class GetCampaignAssetResponse < Struct.new(
2267
+ :asset)
2268
+ SENSITIVE = []
2269
+ include Aws::Structure
2270
+ end
2271
+
2272
+ # Input for GetCampaign operation.
2273
+ #
2274
+ # @!attribute [rw] catalog
2275
+ # The catalog (AWS or Sandbox).
2276
+ # @return [String]
2277
+ #
2278
+ # @!attribute [rw] campaign_identifier
2279
+ # The campaign identifier.
2280
+ # @return [String]
2281
+ #
2282
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/GetCampaignRequest AWS API Documentation
2283
+ #
2284
+ class GetCampaignRequest < Struct.new(
2285
+ :catalog,
2286
+ :campaign_identifier)
2287
+ SENSITIVE = []
2288
+ include Aws::Structure
2289
+ end
2290
+
2291
+ # Output for GetCampaign.
2292
+ #
2293
+ # @!attribute [rw] campaign
2294
+ # The campaign.
2295
+ # @return [Types::Campaign]
2296
+ #
2297
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/GetCampaignResponse AWS API Documentation
2298
+ #
2299
+ class GetCampaignResponse < Struct.new(
2300
+ :campaign)
2301
+ SENSITIVE = []
2302
+ include Aws::Structure
2303
+ end
2304
+
2305
+ # Input for GetCampaignTemplate.
2306
+ #
2307
+ # @!attribute [rw] catalog
2308
+ # The catalog (AWS or Sandbox).
2309
+ # @return [String]
2310
+ #
2311
+ # @!attribute [rw] identifier
2312
+ # The campaign template's id. A campaign template has no ARN
2313
+ # (DG-084).
2314
+ # @return [String]
2315
+ #
2316
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/GetCampaignTemplateRequest AWS API Documentation
2317
+ #
2318
+ class GetCampaignTemplateRequest < Struct.new(
2319
+ :catalog,
2320
+ :identifier)
2321
+ SENSITIVE = []
2322
+ include Aws::Structure
2323
+ end
2324
+
2325
+ # Output for GetCampaignTemplate.
2326
+ #
2327
+ # @!attribute [rw] campaign_template
2328
+ # The campaign template, including its asset templates.
2329
+ # @return [Types::CampaignTemplate]
2330
+ #
2331
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/GetCampaignTemplateResponse AWS API Documentation
2332
+ #
2333
+ class GetCampaignTemplateResponse < Struct.new(
2334
+ :campaign_template)
2335
+ SENSITIVE = []
2336
+ include Aws::Structure
2337
+ end
2338
+
2339
+ # An image field's constraints and default.
2340
+ #
2341
+ # @!attribute [rw] max_size_bytes
2342
+ # Maximum accepted file size in bytes.
2343
+ # @return [Integer]
2344
+ #
2345
+ # @!attribute [rw] allowed_formats
2346
+ # Accepted image formats.
2347
+ # @return [Array<String>]
2348
+ #
2349
+ # @!attribute [rw] default_value
2350
+ # The AWS-authored image the asset uses until the partner sets one:
2351
+ # shown in previews and published in an empty slot of an email,
2352
+ # landing page, banner ad or social post. It fills a required image
2353
+ # field. A document leaves an empty image slot blank.
2354
+ # @return [Types::LayoutPreview]
2355
+ #
2356
+ # @!attribute [rw] recommended_width_pixels
2357
+ # The image size, in pixels, that fills this slot and prints sharply,
2358
+ # for example 1920 x 301 for a full-width header. Shown to the partner
2359
+ # as "Recommended: W x H px".
2360
+ #
2361
+ # Present, together with `RecommendedHeightPixels`, on document (PDF)
2362
+ # image slots only, where the slot is a fixed rectangle. Such a slot
2363
+ # is always filled: the image is scaled to cover it, centred, and
2364
+ # clipped to it, the same as CSS `object-fit: cover`. An image whose
2365
+ # shape is too far from W:H is refused with
2366
+ # `IMAGE_ASPECT_RATIO_MISMATCH`; one narrower than W is accepted. A
2367
+ # slot showing the partner's logo or badge, and a slot without the
2368
+ # two members (every slot from before sizes existed), fits the image
2369
+ # inside instead (`object-fit: contain`): a logo or a badge is never
2370
+ # cropped. Email and landing-page image slots are laid out by HTML and
2371
+ # carry neither.
2372
+ # @return [Integer]
2373
+ #
2374
+ # @!attribute [rw] recommended_height_pixels
2375
+ # The image height, in pixels, that fills this slot. Present exactly
2376
+ # when `RecommendedWidthPixels` is.
2377
+ # @return [Integer]
2378
+ #
2379
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/ImageFieldType AWS API Documentation
2380
+ #
2381
+ class ImageFieldType < Struct.new(
2382
+ :max_size_bytes,
2383
+ :allowed_formats,
2384
+ :default_value,
2385
+ :recommended_width_pixels,
2386
+ :recommended_height_pixels)
2387
+ SENSITIVE = []
2388
+ include Aws::Structure
2389
+ end
2390
+
2391
+ # An unexpected error occurred during the processing of the request.
2392
+ #
2393
+ # @!attribute [rw] message
2394
+ # Error message.
2395
+ # @return [String]
2396
+ #
2397
+ # @!attribute [rw] retry_after_seconds
2398
+ # Seconds before retry.
2399
+ # @return [Integer]
2400
+ #
2401
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/InternalServerException AWS API Documentation
2402
+ #
2403
+ class InternalServerException < Struct.new(
2404
+ :message,
2405
+ :retry_after_seconds)
2406
+ SENSITIVE = []
2407
+ include Aws::Structure
2408
+ end
2409
+
2410
+ # A rendering of an AWS-authored layout skeleton or placeholder image.
2411
+ #
2412
+ # The url is a stable, cache-friendly CloudFront URL rather than a
2413
+ # presigned GET, because the bytes are AWS marketing content that is
2414
+ # already public. The key's random segment is the object's only
2415
+ # protection, so the URL is a bearer credential for the object and is
2416
+ # withheld entirely while a template is not yet effective — see
2417
+ # CampaignTemplate.EffectiveDateBegin.
2418
+ #
2419
+ # @!attribute [rw] format
2420
+ # The format of the referenced object.
2421
+ # @return [String]
2422
+ #
2423
+ # @!attribute [rw] url
2424
+ # A stable URL serving the object. Not presigned, so it does not
2425
+ # expire.
2426
+ # @return [String]
2427
+ #
2428
+ # @!attribute [rw] page_type
2429
+ # Which page of a multi-page layout this is. Present only for
2430
+ # LANDING\_PAGE, which genuinely has two layout objects — the page
2431
+ # carrying the form, and the confirmation page shown after submit —
2432
+ # and absent for every other category, which has one.
2433
+ #
2434
+ # A confirmation page is a second LAYOUT, never a second asset:
2435
+ # modelling it as its own asset would give it a lifecycle, an
2436
+ # activation and a state it does not have.
2437
+ # @return [String]
2438
+ #
2439
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/LayoutPreview AWS API Documentation
2440
+ #
2441
+ class LayoutPreview < Struct.new(
2442
+ :format,
2443
+ :url,
2444
+ :page_type)
2445
+ SENSITIVE = []
2446
+ include Aws::Structure
2447
+ end
2448
+
2449
+ # Input for ListCampaignAssets operation.
2450
+ #
2451
+ # @!attribute [rw] catalog
2452
+ # The catalog (AWS or Sandbox).
2453
+ # @return [String]
2454
+ #
2455
+ # @!attribute [rw] campaign_identifier
2456
+ # The campaign identifier.
2457
+ # @return [String]
2458
+ #
2459
+ # @!attribute [rw] max_results
2460
+ # Maximum results per page.
2461
+ # @return [Integer]
2462
+ #
2463
+ # @!attribute [rw] next_token
2464
+ # Pagination token.
2465
+ # @return [String]
2466
+ #
2467
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/ListCampaignAssetsRequest AWS API Documentation
2468
+ #
2469
+ class ListCampaignAssetsRequest < Struct.new(
2470
+ :catalog,
2471
+ :campaign_identifier,
2472
+ :max_results,
2473
+ :next_token)
2474
+ SENSITIVE = []
2475
+ include Aws::Structure
2476
+ end
2477
+
2478
+ # Output for ListCampaignAssets operation.
2479
+ #
2480
+ # @!attribute [rw] items
2481
+ # The list of results.
2482
+ # @return [Array<Types::CampaignAssetSummary>]
2483
+ #
2484
+ # @!attribute [rw] next_token
2485
+ # Pagination token.
2486
+ # @return [String]
2487
+ #
2488
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/ListCampaignAssetsResponse AWS API Documentation
2489
+ #
2490
+ class ListCampaignAssetsResponse < Struct.new(
2491
+ :items,
2492
+ :next_token)
2493
+ SENSITIVE = []
2494
+ include Aws::Structure
2495
+ end
2496
+
2497
+ # Input for ListCampaigns operation.
2498
+ #
2499
+ # Filters combine with AND. Results are eventually consistent: a
2500
+ # campaign created, renamed or activated a moment ago can take up to a
2501
+ # second to appear with its current values. `GetCampaign` is strongly
2502
+ # consistent.
2503
+ #
2504
+ # @!attribute [rw] catalog
2505
+ # The catalog (AWS or Sandbox).
2506
+ # @return [String]
2507
+ #
2508
+ # @!attribute [rw] campaign_identifiers
2509
+ # Only these campaigns, each named by its id or its campaign ARN. A
2510
+ # campaign that does not exist, was deleted, or whose ARN names
2511
+ # another account or catalog is left out rather than refused.
2512
+ # @return [Array<String>]
2513
+ #
2514
+ # @!attribute [rw] name
2515
+ # Only campaigns whose name contains this, compared
2516
+ # case-insensitively.
2517
+ # @return [String]
2518
+ #
2519
+ # @!attribute [rw] states
2520
+ # Only campaigns in one of these states.
2521
+ # @return [Array<String>]
2522
+ #
2523
+ # @!attribute [rw] sort
2524
+ # The order of the results. Default: `CREATED_AT`, `DESCENDING`.
2525
+ # @return [Types::CampaignSort]
2526
+ #
2527
+ # @!attribute [rw] max_results
2528
+ # Maximum results per page.
2529
+ # @return [Integer]
2530
+ #
2531
+ # @!attribute [rw] next_token
2532
+ # Pagination token. Bound to the filters and sort it was issued for: a
2533
+ # request that changes `CampaignIdentifiers`, `Name`, `States` or
2534
+ # `Sort` between pages is refused with `ValidationException`.
2535
+ # `MaxResults` may change.
2536
+ # @return [String]
2537
+ #
2538
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/ListCampaignsRequest AWS API Documentation
2539
+ #
2540
+ class ListCampaignsRequest < Struct.new(
2541
+ :catalog,
2542
+ :campaign_identifiers,
2543
+ :name,
2544
+ :states,
2545
+ :sort,
2546
+ :max_results,
2547
+ :next_token)
2548
+ SENSITIVE = []
2549
+ include Aws::Structure
2550
+ end
2551
+
2552
+ # Output for ListCampaigns operation.
2553
+ #
2554
+ # @!attribute [rw] items
2555
+ # The list of results.
2556
+ # @return [Array<Types::CampaignSummary>]
2557
+ #
2558
+ # @!attribute [rw] next_token
2559
+ # Pagination token.
2560
+ # @return [String]
2561
+ #
2562
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/ListCampaignsResponse AWS API Documentation
2563
+ #
2564
+ class ListCampaignsResponse < Struct.new(
2565
+ :items,
2566
+ :next_token)
2567
+ SENSITIVE = []
2568
+ include Aws::Structure
2569
+ end
2570
+
2571
+ # Input for ListSocialConnections.
2572
+ #
2573
+ # @!attribute [rw] catalog
2574
+ # Catalog to list connections from.
2575
+ # @return [String]
2576
+ #
2577
+ # @!attribute [rw] platform
2578
+ # Restrict results to a single social platform.
2579
+ # @return [String]
2580
+ #
2581
+ # @!attribute [rw] max_results
2582
+ # Maximum number of results to return per page.
2583
+ # @return [Integer]
2584
+ #
2585
+ # @!attribute [rw] next_token
2586
+ # Pagination token from a previous response.
2587
+ # @return [String]
2588
+ #
2589
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/ListSocialConnectionsRequest AWS API Documentation
2590
+ #
2591
+ class ListSocialConnectionsRequest < Struct.new(
2592
+ :catalog,
2593
+ :platform,
2594
+ :max_results,
2595
+ :next_token)
2596
+ SENSITIVE = []
2597
+ include Aws::Structure
2598
+ end
2599
+
2600
+ # Output for ListSocialConnections.
2601
+ #
2602
+ # @!attribute [rw] items
2603
+ # The social connections for this partner and catalog.
2604
+ # @return [Array<Types::SocialConnectionSummary>]
2605
+ #
2606
+ # @!attribute [rw] next_token
2607
+ # Pagination token for the next page, absent on the last page.
2608
+ # @return [String]
2609
+ #
2610
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/ListSocialConnectionsResponse AWS API Documentation
2611
+ #
2612
+ class ListSocialConnectionsResponse < Struct.new(
2613
+ :items,
2614
+ :next_token)
2615
+ SENSITIVE = []
2616
+ include Aws::Structure
2617
+ end
2618
+
2619
+ # Input for ListTagsForResource.
2620
+ #
2621
+ # @!attribute [rw] resource_arn
2622
+ # The ARN of the resource whose tags should be returned.
2623
+ # @return [String]
2624
+ #
2625
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/ListTagsForResourceRequest AWS API Documentation
2626
+ #
2627
+ class ListTagsForResourceRequest < Struct.new(
2628
+ :resource_arn)
2629
+ SENSITIVE = []
2630
+ include Aws::Structure
2631
+ end
2632
+
2633
+ # Output for ListTagsForResource.
2634
+ #
2635
+ # @!attribute [rw] resource_arn
2636
+ # The ARN of the resource the tags belong to.
2637
+ # @return [String]
2638
+ #
2639
+ # @!attribute [rw] tags
2640
+ # The tags currently applied. Absent rather than empty when the
2641
+ # resource carries no tags.
2642
+ # @return [Array<Types::Tag>]
2643
+ #
2644
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/ListTagsForResourceResponse AWS API Documentation
2645
+ #
2646
+ class ListTagsForResourceResponse < Struct.new(
2647
+ :resource_arn,
2648
+ :tags)
2649
+ SENSITIVE = []
2650
+ include Aws::Structure
2651
+ end
2652
+
2653
+ # An amount of money in a named currency.
2654
+ #
2655
+ # The amount is a decimal string, not a float: a budget is exact, and
2656
+ # binary floating point cannot represent every two-decimal value.
2657
+ # Mirrors the Partner Central Selling API's
2658
+ # `ExpectedCustomerSpend.Amount`.
2659
+ #
2660
+ # @!attribute [rw] amount
2661
+ # The amount, as a decimal string with at most two decimal places.
2662
+ # @return [String]
2663
+ #
2664
+ # @!attribute [rw] currency_code
2665
+ # The ISO 4217 currency the amount is denominated in.
2666
+ # @return [String]
2667
+ #
2668
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/MonetaryValue AWS API Documentation
2669
+ #
2670
+ class MonetaryValue < Struct.new(
2671
+ :amount,
2672
+ :currency_code)
2673
+ SENSITIVE = []
2674
+ include Aws::Structure
2675
+ end
2676
+
2677
+ # The campaign's partner badge, as read.
2678
+ #
2679
+ # @!attribute [rw] url
2680
+ # A presigned GET of the badge, which expires one hour after the read:
2681
+ # fetch it again with `GetCampaign` when it returns 403.
2682
+ # @return [String]
2683
+ #
2684
+ # @!attribute [rw] attached_at
2685
+ # When the badge was set.
2686
+ # @return [Time]
2687
+ #
2688
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/PartnerBadgeDetail AWS API Documentation
2689
+ #
2690
+ class PartnerBadgeDetail < Struct.new(
2691
+ :url,
2692
+ :attached_at)
2693
+ SENSITIVE = []
2694
+ include Aws::Structure
2695
+ end
2696
+
2697
+ # A partner's branding, read from their AWS Partner Central profile.
2698
+ #
2699
+ # The profile is the only source: a campaign carries no branding of its
2700
+ # own, so every campaign of a partner shows the same identity, vetted by
2701
+ # Partner Central. Edit it in Partner Central.
2702
+ #
2703
+ # @!attribute [rw] display_name
2704
+ # The profile's display name.
2705
+ # @return [String]
2706
+ #
2707
+ # @!attribute [rw] website_url
2708
+ # The profile's website.
2709
+ # @return [String]
2710
+ #
2711
+ # @!attribute [rw] logo_url
2712
+ # The profile's logo URL, as AWS Partner Central serves it — the
2713
+ # image every asset of the campaign shows. Absent when the profile
2714
+ # names none.
2715
+ #
2716
+ # Partner Central Marketing keeps no copy: the same URL is written
2717
+ # into a published landing page and email, and fetched when a document
2718
+ # is composed, so what a client renders from it is what is sent. Only
2719
+ # a document fetches the image: one it cannot fetch and draw fails
2720
+ # that asset with `INTERNAL\_ERROR`, which a retry can clear. A
2721
+ # landing page or email links the URL as given, so a logo that does
2722
+ # not load shows as a broken image.
2723
+ # @return [String]
2724
+ #
2725
+ # @!attribute [rw] refreshed_at
2726
+ # When this branding was last read from Partner Central. Earlier than
2727
+ # the request when Partner Central could not be reached and Partner
2728
+ # Central Marketing answered from its last copy.
2729
+ # @return [Time]
2730
+ #
2731
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/PartnerProfileBranding AWS API Documentation
2732
+ #
2733
+ class PartnerProfileBranding < Struct.new(
2734
+ :display_name,
2735
+ :website_url,
2736
+ :logo_url,
2737
+ :refreshed_at)
2738
+ SENSITIVE = []
2739
+ include Aws::Structure
2740
+ end
2741
+
2742
+ # A reference material that comes with a campaign template: a file the
2743
+ # partner downloads as-is.
2744
+ #
2745
+ # Not a blueprint: it carries no fields, cannot be instantiated, and is
2746
+ # not activated.
2747
+ #
2748
+ # Not the `ReferenceMaterial` resource deleted on 2026-09-22 (its six
2749
+ # operations, ARN and record are gone). That was partner-uploaded and
2750
+ # addressable; this is AWS-authored template content with no identity of
2751
+ # its own.
2752
+ #
2753
+ # @!attribute [rw] name
2754
+ # The display name.
2755
+ # @return [String]
2756
+ #
2757
+ # @!attribute [rw] url
2758
+ # A stable public CDN URL for the file. AWS-authored content, so it is
2759
+ # not presigned and carries no expiry — the same treatment as
2760
+ # `LayoutPreview.url`, and withheld on the same condition: absent
2761
+ # while the template's `EffectiveDateBegin` is in the future.
2762
+ # @return [String]
2763
+ #
2764
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/ReferenceMaterial AWS API Documentation
2765
+ #
2766
+ class ReferenceMaterial < Struct.new(
2767
+ :name,
2768
+ :url)
2769
+ SENSITIVE = []
2770
+ include Aws::Structure
2771
+ end
2772
+
2773
+ # The specified resource does not exist.
2774
+ #
2775
+ # @!attribute [rw] message
2776
+ # Error message.
2777
+ # @return [String]
2778
+ #
2779
+ # @!attribute [rw] resource_id
2780
+ # The affected resource identifier.
2781
+ # @return [String]
2782
+ #
2783
+ # @!attribute [rw] resource_type
2784
+ # The affected resource type.
2785
+ # @return [String]
2786
+ #
2787
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/ResourceNotFoundException AWS API Documentation
2788
+ #
2789
+ class ResourceNotFoundException < Struct.new(
2790
+ :message,
2791
+ :resource_id,
2792
+ :resource_type)
2793
+ SENSITIVE = []
2794
+ include Aws::Structure
2795
+ end
2796
+
2797
+ # A rich-text field's constraints and placeholder. Distinct from text
2798
+ # because the value is a markup fragment whose permitted tags are part
2799
+ # of the contract: a client needs the tag list to configure its editor,
2800
+ # and the service needs it to sanitize.
2801
+ #
2802
+ # @!attribute [rw] max_length
2803
+ # Maximum accepted length of the markup fragment.
2804
+ # @return [Integer]
2805
+ #
2806
+ # @!attribute [rw] allowed_tags
2807
+ # The HTML tags permitted in the value. Anything else is stripped.
2808
+ # @return [Array<String>]
2809
+ #
2810
+ # @!attribute [rw] placeholder
2811
+ # Example markup shown where the field is empty in a preview of the
2812
+ # asset, restricted to AllowedTags. Never the asset's value: it is
2813
+ # not set on the asset at create, does not fill a required field, and
2814
+ # is never published.
2815
+ # @return [String]
2816
+ #
2817
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/RichTextFieldType AWS API Documentation
2818
+ #
2819
+ class RichTextFieldType < Struct.new(
2820
+ :max_length,
2821
+ :allowed_tags,
2822
+ :placeholder)
2823
+ SENSITIVE = [:placeholder]
2824
+ include Aws::Structure
2825
+ end
2826
+
2827
+ # Input for SearchCampaignTemplates.
2828
+ #
2829
+ # @!attribute [rw] catalog
2830
+ # The catalog (AWS or Sandbox). AWS and Sandbox templates may differ.
2831
+ # @return [String]
2832
+ #
2833
+ # @!attribute [rw] search_text
2834
+ # Free-text query matched against the template's name and
2835
+ # description. Any word may match, and the last word matches as a
2836
+ # prefix when it has 3 or more characters, so `nov` finds Amazon Nova.
2837
+ # A template whose name holds the query as a phrase ranks first, then
2838
+ # whole-word matches, then prefix-only ones. Omit to browse the whole
2839
+ # catalog. Text analysis is derived from each template's own
2840
+ # LanguageCode, never from the language filter.
2841
+ # @return [String]
2842
+ #
2843
+ # @!attribute [rw] industry
2844
+ # Restrict to templates in these industries. Values within this member
2845
+ # are OR-ed; distinct facet members are AND-ed. Exact, case-sensitive
2846
+ # match.
2847
+ # @return [Array<String>]
2848
+ #
2849
+ # @!attribute [rw] use_case
2850
+ # Restrict to templates with these campaign use cases. Values within
2851
+ # this member are OR-ed; distinct facet members are AND-ed. Exact,
2852
+ # case-sensitive match.
2853
+ # @return [Array<String>]
2854
+ #
2855
+ # @!attribute [rw] language
2856
+ # Restrict to templates in these language(s), matched by each
2857
+ # template's `LanguageCode`. Values within this member are OR-ed;
2858
+ # distinct facet members are AND-ed. Narrows results; it does not
2859
+ # reinterpret SearchText.
2860
+ # @return [Array<String>]
2861
+ #
2862
+ # @!attribute [rw] aws_services
2863
+ # Restrict to templates promoting these AWS services. Values within
2864
+ # this member are OR-ed; distinct facet members are AND-ed. Exact,
2865
+ # case-sensitive match.
2866
+ # @return [Array<String>]
2867
+ #
2868
+ # @!attribute [rw] customer_segments
2869
+ # Restrict to templates for these customer segments. Values within
2870
+ # this member are OR-ed; distinct facet members are AND-ed. A template
2871
+ # that names no customer segment matches every value.
2872
+ # @return [Array<String>]
2873
+ #
2874
+ # @!attribute [rw] themes
2875
+ # Restrict to templates with these themes. Values within this member
2876
+ # are OR-ed; distinct facet members are AND-ed. A template that names
2877
+ # no theme matches every value.
2878
+ # @return [Array<String>]
2879
+ #
2880
+ # @!attribute [rw] collection
2881
+ # Restrict to templates in these collections. Values within this
2882
+ # member are OR-ed; distinct facet members are AND-ed. Omit for no
2883
+ # restriction; there is no default.
2884
+ # @return [Array<String>]
2885
+ #
2886
+ # @!attribute [rw] max_results
2887
+ # Maximum results per page.
2888
+ # @return [Integer]
2889
+ #
2890
+ # @!attribute [rw] next_token
2891
+ # Pagination token.
2892
+ # @return [String]
2893
+ #
2894
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/SearchCampaignTemplatesRequest AWS API Documentation
2895
+ #
2896
+ class SearchCampaignTemplatesRequest < Struct.new(
2897
+ :catalog,
2898
+ :search_text,
2899
+ :industry,
2900
+ :use_case,
2901
+ :language,
2902
+ :aws_services,
2903
+ :customer_segments,
2904
+ :themes,
2905
+ :collection,
2906
+ :max_results,
2907
+ :next_token)
2908
+ SENSITIVE = []
2909
+ include Aws::Structure
2910
+ end
2911
+
2912
+ # Output for SearchCampaignTemplates.
2913
+ #
2914
+ # @!attribute [rw] total_results
2915
+ # Total count over the whole matching set, not just this page — for
2916
+ # "over N results" display.
2917
+ # @return [Integer]
2918
+ #
2919
+ # @!attribute [rw] campaign_templates
2920
+ # This page of template summaries.
2921
+ # @return [Array<Types::CampaignTemplateSummary>]
2922
+ #
2923
+ # @!attribute [rw] next_token
2924
+ # Pagination token.
2925
+ # @return [String]
2926
+ #
2927
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/SearchCampaignTemplatesResponse AWS API Documentation
2928
+ #
2929
+ class SearchCampaignTemplatesResponse < Struct.new(
2930
+ :total_results,
2931
+ :campaign_templates,
2932
+ :next_token)
2933
+ SENSITIVE = []
2934
+ include Aws::Structure
2935
+ end
2936
+
2937
+ # The request exceeds a service quota.
2938
+ #
2939
+ # @!attribute [rw] message
2940
+ # Error message.
2941
+ # @return [String]
2942
+ #
2943
+ # @!attribute [rw] resource_type
2944
+ # The affected resource type.
2945
+ # @return [String]
2946
+ #
2947
+ # @!attribute [rw] quota_code
2948
+ # The exceeded quota code.
2949
+ # @return [String]
2950
+ #
2951
+ # @!attribute [rw] service_code
2952
+ # The service code.
2953
+ # @return [String]
2954
+ #
2955
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/ServiceQuotaExceededException AWS API Documentation
2956
+ #
2957
+ class ServiceQuotaExceededException < Struct.new(
2958
+ :message,
2959
+ :resource_type,
2960
+ :quota_code,
2961
+ :service_code)
2962
+ SENSITIVE = []
2963
+ include Aws::Structure
2964
+ end
2965
+
2966
+ # Summary of a social connection returned by ListSocialConnections.
2967
+ #
2968
+ # Carries no ARN (owner ruling 2026-10-05): a connection is addressed by
2969
+ # its `Id`. Social connections are not taggable, and every social
2970
+ # operation authorizes on its action rather than on a resource ARN.
2971
+ #
2972
+ # @!attribute [rw] id
2973
+ # Identifier of the social connection.
2974
+ # @return [String]
2975
+ #
2976
+ # @!attribute [rw] platform
2977
+ # Social platform this connection authorizes.
2978
+ # @return [String]
2979
+ #
2980
+ # @!attribute [rw] status
2981
+ # Authorization state.
2982
+ # @return [String]
2983
+ #
2984
+ # @!attribute [rw] page_name
2985
+ # The Facebook Page this connection publishes to. Absent where no Page
2986
+ # applies.
2987
+ # @return [String]
2988
+ #
2989
+ # @!attribute [rw] account_name
2990
+ # Display name of the account behind this connection. Absent when the
2991
+ # execution backend reports none.
2992
+ # @return [String]
2993
+ #
2994
+ # @!attribute [rw] connected_at
2995
+ # When the account was last authorized. Advances on every
2996
+ # re-authorization.
2997
+ # @return [Time]
2998
+ #
2999
+ # @!attribute [rw] expires_at
3000
+ # When the authorization lapses. Absent where the platform reports no
3001
+ # expiry (X never does). A connection past this time reads EXPIRED
3002
+ # only once the backend notices, so treat this as a warning date, not
3003
+ # a status.
3004
+ # @return [Time]
3005
+ #
3006
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/SocialConnectionSummary AWS API Documentation
3007
+ #
3008
+ class SocialConnectionSummary < Struct.new(
3009
+ :id,
3010
+ :platform,
3011
+ :status,
3012
+ :page_name,
3013
+ :account_name,
3014
+ :connected_at,
3015
+ :expires_at)
3016
+ SENSITIVE = [:account_name]
3017
+ include Aws::Structure
3018
+ end
3019
+
3020
+ # Input for StartCampaignAssetActivationTask.
3021
+ #
3022
+ # @!attribute [rw] catalog
3023
+ # The catalog (AWS or Sandbox).
3024
+ # @return [String]
3025
+ #
3026
+ # @!attribute [rw] campaign_identifier
3027
+ # The campaign identifier, which also authorizes the call.
3028
+ # @return [String]
3029
+ #
3030
+ # @!attribute [rw] campaign_asset_identifiers
3031
+ # The assets to activate, in any order — the service derives the
3032
+ # dependency order and ignores the order given here.
3033
+ # @return [Array<String>]
3034
+ #
3035
+ # @!attribute [rw] client_token
3036
+ # Idempotency token. Two requests carrying the same token are one
3037
+ # request, and the second returns the first one's task rather than
3038
+ # starting a second.
3039
+ #
3040
+ # The deduplication window is the **life of the task record**, not a
3041
+ # fixed number of hours: replaying a token after the task has expired
3042
+ # starts a new task. Stated because a caller would otherwise assume
3043
+ # the usual few-hour guarantee.
3044
+ #
3045
+ # **A suitable default value is auto-generated.** You should normally
3046
+ # not need to pass this option.
3047
+ # @return [String]
3048
+ #
3049
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/StartCampaignAssetActivationTaskRequest AWS API Documentation
3050
+ #
3051
+ class StartCampaignAssetActivationTaskRequest < Struct.new(
3052
+ :catalog,
3053
+ :campaign_identifier,
3054
+ :campaign_asset_identifiers,
3055
+ :client_token)
3056
+ SENSITIVE = []
3057
+ include Aws::Structure
3058
+ end
3059
+
3060
+ # Output for StartCampaignAssetActivationTask: the task just created.
3061
+ #
3062
+ # @!attribute [rw] campaign_id
3063
+ # The campaign's id. Canonical: because `CampaignIdentifier` accepts
3064
+ # an id or an ARN, echoing this tells a caller who passed an ARN what
3065
+ # the id is. The task's own id is `TaskId`.
3066
+ # @return [String]
3067
+ #
3068
+ # @!attribute [rw] task_id
3069
+ # Opaque correlation value for the task. Echoed so a caller can tell
3070
+ # the task it started from a later one that superseded it. Never an
3071
+ # input: the campaign is what addresses a task, because a campaign has
3072
+ # at most one.
3073
+ # @return [String]
3074
+ #
3075
+ # @!attribute [rw] task_status
3076
+ # The task's status over every asset it names, refused ones included:
3077
+ # one refused and one succeeded is PARTIAL\_FAILURE.
3078
+ # @return [String]
3079
+ #
3080
+ # @!attribute [rw] started_at
3081
+ # When the task was created.
3082
+ # @return [Time]
3083
+ #
3084
+ # @!attribute [rw] ended_at
3085
+ # When the task reached a terminal status. Absent while IN\_PROGRESS.
3086
+ # @return [Time]
3087
+ #
3088
+ # @!attribute [rw] assets
3089
+ # One entry per asset the request named, in the order named. An asset
3090
+ # refused up front is FAILED from the first response, with its reason.
3091
+ # @return [Array<Types::CampaignAssetActivationOutcome>]
3092
+ #
3093
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/StartCampaignAssetActivationTaskResponse AWS API Documentation
3094
+ #
3095
+ class StartCampaignAssetActivationTaskResponse < Struct.new(
3096
+ :campaign_id,
3097
+ :task_id,
3098
+ :task_status,
3099
+ :started_at,
3100
+ :ended_at,
3101
+ :assets)
3102
+ SENSITIVE = []
3103
+ include Aws::Structure
3104
+ end
3105
+
3106
+ # Input for StartCampaignAssetExportTask.
3107
+ #
3108
+ # @!attribute [rw] catalog
3109
+ # The catalog (AWS or Sandbox).
3110
+ # @return [String]
3111
+ #
3112
+ # @!attribute [rw] campaign_identifier
3113
+ # The campaign whose assets are exported. Accepts the campaign id or
3114
+ # ARN.
3115
+ # @return [String]
3116
+ #
3117
+ # @!attribute [rw] client_token
3118
+ # Idempotency token. Two requests carrying the same token within the
3119
+ # dedup window are one request and return the same task id.
3120
+ #
3121
+ # **A suitable default value is auto-generated.** You should normally
3122
+ # not need to pass this option.
3123
+ # @return [String]
3124
+ #
3125
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/StartCampaignAssetExportTaskRequest AWS API Documentation
3126
+ #
3127
+ class StartCampaignAssetExportTaskRequest < Struct.new(
3128
+ :catalog,
3129
+ :campaign_identifier,
3130
+ :client_token)
3131
+ SENSITIVE = []
3132
+ include Aws::Structure
3133
+ end
3134
+
3135
+ # Output for StartCampaignAssetExportTask.
3136
+ #
3137
+ # Returns the newly created task id and its status, which is always
3138
+ # IN\_PROGRESS on this synchronous return. Poll
3139
+ # GetCampaignAssetExportTask for the outcome.
3140
+ #
3141
+ # @!attribute [rw] id
3142
+ # The export task identifier.
3143
+ # @return [String]
3144
+ #
3145
+ # @!attribute [rw] status
3146
+ # The task's state, always IN\_PROGRESS at creation.
3147
+ # @return [String]
3148
+ #
3149
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/StartCampaignAssetExportTaskResponse AWS API Documentation
3150
+ #
3151
+ class StartCampaignAssetExportTaskResponse < Struct.new(
3152
+ :id,
3153
+ :status)
3154
+ SENSITIVE = []
3155
+ include Aws::Structure
3156
+ end
3157
+
3158
+ # A key-value pair applied to a resource.
3159
+ #
3160
+ # @!attribute [rw] key
3161
+ # The tag key.
3162
+ # @return [String]
3163
+ #
3164
+ # @!attribute [rw] value
3165
+ # The tag value.
3166
+ # @return [String]
3167
+ #
3168
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/Tag AWS API Documentation
3169
+ #
3170
+ class Tag < Struct.new(
3171
+ :key,
3172
+ :value)
3173
+ SENSITIVE = []
3174
+ include Aws::Structure
3175
+ end
3176
+
3177
+ # Input for TagResource.
3178
+ #
3179
+ # @!attribute [rw] resource_arn
3180
+ # The ARN of the resource to tag.
3181
+ # @return [String]
3182
+ #
3183
+ # @!attribute [rw] tags
3184
+ # The tags to add or replace.
3185
+ # @return [Array<Types::Tag>]
3186
+ #
3187
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/TagResourceRequest AWS API Documentation
3188
+ #
3189
+ class TagResourceRequest < Struct.new(
3190
+ :resource_arn,
3191
+ :tags)
3192
+ SENSITIVE = []
3193
+ include Aws::Structure
3194
+ end
3195
+
3196
+ # Output for TagResource.
3197
+ #
3198
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/TagResourceResponse AWS API Documentation
3199
+ #
3200
+ class TagResourceResponse < Aws::EmptyStructure; end
3201
+
3202
+ # Advisory targeting metadata for a campaign.
3203
+ #
3204
+ # Describes who the campaign is *about*, and never drives a send —
3205
+ # that is `EmailTarget`. Nothing here is validated at create, because
3206
+ # a partner refines it across the wizard.
3207
+ #
3208
+ # @!attribute [rw] industries
3209
+ # Target industries.
3210
+ # @return [Array<String>]
3211
+ #
3212
+ # @!attribute [rw] company_sizes
3213
+ # Target company sizes.
3214
+ # @return [Array<String>]
3215
+ #
3216
+ # @!attribute [rw] countries
3217
+ # Target countries, as ISO 3166-1 alpha-2 codes.
3218
+ # @return [Array<String>]
3219
+ #
3220
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/TargetAudience AWS API Documentation
3221
+ #
3222
+ class TargetAudience < Struct.new(
3223
+ :industries,
3224
+ :company_sizes,
3225
+ :countries)
3226
+ SENSITIVE = []
3227
+ include Aws::Structure
3228
+ end
3229
+
3230
+ # The value of a template field. Exactly one variant is set, matching
3231
+ # the field's type: text and RichText fields use text, image fields use
3232
+ # ImageReference (or, on a write, CampaignAssetImage), AssetLink fields
3233
+ # use LinkedAssetId.
3234
+ #
3235
+ # @note TemplateFieldValue is a union - when making an API calls you must set exactly one of the members.
3236
+ #
3237
+ # @note TemplateFieldValue is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of TemplateFieldValue corresponding to the set member.
3238
+ #
3239
+ # @!attribute [rw] text
3240
+ # Text value — for both text and RichText fields. A RichText value is
3241
+ # a markup fragment restricted to the field's AllowedTags.
3242
+ # @return [String]
3243
+ #
3244
+ # @!attribute [rw] image_reference
3245
+ # Image reference (image fields).
3246
+ #
3247
+ # On a write, one of exactly two forms:
3248
+ #
3249
+ # * the `s3://` URI of a file you staged in the Partner Central file
3250
+ # staging bucket. It is scanned, then copied into this asset.
3251
+ # * the URL Build with AI returned for a suggested image, unchanged.
3252
+ # It is copied into this asset and not scanned. Any other URL is
3253
+ # refused with `FILE_REFERENCE_INVALID`, including one a read
3254
+ # returned: to keep the current image, omit the field; to put it on
3255
+ # another asset, use `CampaignAssetImage`.
3256
+ #
3257
+ # On a read, a URL the caller can fetch: an image in the asset's own
3258
+ # storage comes back as a presigned GET that expires one hour after
3259
+ # the read, so fetch it again with `GetCampaignAsset` when it returns
3260
+ # 403; an image already on DG's public CDN comes back as that stable
3261
+ # URL. A stored reference outside this asset's storage, or not a
3262
+ # raster image, is never signed, and the value is omitted. The signed
3263
+ # URL serves the image as its image type, whatever the upload
3264
+ # declared.
3265
+ # @return [String]
3266
+ #
3267
+ # @!attribute [rw] linked_asset_id
3268
+ # The asset an `AssetLink` field names: the id of an asset on the same
3269
+ # campaign, of the field's category. It is a prerequisite of this
3270
+ # asset while linked, so it activates first, this asset cannot start
3271
+ # until it is live, and it cannot be deleted.
3272
+ # @return [String]
3273
+ #
3274
+ # @!attribute [rw] campaign_asset_image
3275
+ # Write only. Copies an image stored on another of your assets into
3276
+ # this image field. The image is checked against this field's
3277
+ # constraints and not scanned again. Also requires
3278
+ # `partnercentral:GetCampaignAsset` on the source campaign. Reads
3279
+ # return the copy as `ImageReference`.
3280
+ # @return [Types::CampaignAssetImageSource]
3281
+ #
3282
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/TemplateFieldValue AWS API Documentation
3283
+ #
3284
+ class TemplateFieldValue < Struct.new(
3285
+ :text,
3286
+ :image_reference,
3287
+ :linked_asset_id,
3288
+ :campaign_asset_image,
3289
+ :unknown)
3290
+ SENSITIVE = [:text]
3291
+ include Aws::Structure
3292
+ include Aws::Structure::Union
3293
+
3294
+ class Text < TemplateFieldValue; end
3295
+ class ImageReference < TemplateFieldValue; end
3296
+ class LinkedAssetId < TemplateFieldValue; end
3297
+ class CampaignAssetImage < TemplateFieldValue; end
3298
+ class Unknown < TemplateFieldValue; end
3299
+ end
3300
+
3301
+ # A plain-text field's constraints and placeholder.
3302
+ #
3303
+ # @!attribute [rw] min_length
3304
+ # Minimum accepted length.
3305
+ # @return [Integer]
3306
+ #
3307
+ # @!attribute [rw] max_length
3308
+ # Maximum accepted length.
3309
+ # @return [Integer]
3310
+ #
3311
+ # @!attribute [rw] pattern
3312
+ # Regular expression the value must match — used for URL, email, phone
3313
+ # and hex-colour fields.
3314
+ # @return [String]
3315
+ #
3316
+ # @!attribute [rw] placeholder
3317
+ # Example text shown where the field is empty in a preview of the
3318
+ # asset. Never the asset's value: it is not set on the asset at
3319
+ # create, does not fill a required field, and is never published.
3320
+ # @return [String]
3321
+ #
3322
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/TextFieldType AWS API Documentation
3323
+ #
3324
+ class TextFieldType < Struct.new(
3325
+ :min_length,
3326
+ :max_length,
3327
+ :pattern,
3328
+ :placeholder)
3329
+ SENSITIVE = [:placeholder]
3330
+ include Aws::Structure
3331
+ end
3332
+
3333
+ # The request was denied due to request throttling.
3334
+ #
3335
+ # @!attribute [rw] message
3336
+ # Error message.
3337
+ # @return [String]
3338
+ #
3339
+ # @!attribute [rw] retry_after_seconds
3340
+ # Seconds before retry.
3341
+ # @return [Integer]
3342
+ #
3343
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/ThrottlingException AWS API Documentation
3344
+ #
3345
+ class ThrottlingException < Struct.new(
3346
+ :message,
3347
+ :retry_after_seconds)
3348
+ SENSITIVE = []
3349
+ include Aws::Structure
3350
+ end
3351
+
3352
+ # Input for UntagResource.
3353
+ #
3354
+ # @!attribute [rw] resource_arn
3355
+ # The ARN of the resource to remove tags from.
3356
+ # @return [String]
3357
+ #
3358
+ # @!attribute [rw] tag_keys
3359
+ # The tag keys to remove. Associated values are removed with them.
3360
+ # @return [Array<String>]
3361
+ #
3362
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/UntagResourceRequest AWS API Documentation
3363
+ #
3364
+ class UntagResourceRequest < Struct.new(
3365
+ :resource_arn,
3366
+ :tag_keys)
3367
+ SENSITIVE = []
3368
+ include Aws::Structure
3369
+ end
3370
+
3371
+ # Output for UntagResource.
3372
+ #
3373
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/UntagResourceResponse AWS API Documentation
3374
+ #
3375
+ class UntagResourceResponse < Aws::EmptyStructure; end
3376
+
3377
+ # Input for UpdateCampaignAsset operation.
3378
+ #
3379
+ # @!attribute [rw] catalog
3380
+ # The catalog (AWS or Sandbox).
3381
+ # @return [String]
3382
+ #
3383
+ # @!attribute [rw] campaign_identifier
3384
+ # The campaign identifier.
3385
+ # @return [String]
3386
+ #
3387
+ # @!attribute [rw] campaign_asset_identifier
3388
+ # The asset identifier.
3389
+ # @return [String]
3390
+ #
3391
+ # @!attribute [rw] field_values
3392
+ # Value-only updates to the asset's pinned template fields, keyed by
3393
+ # FieldId. The field schema (labels, descriptions, constraints,
3394
+ # placeholders, image defaults) is service-owned and pinned at
3395
+ # instantiation, so clients send only the values they are changing.
3396
+ # Fields omitted keep their stored values; send the entry with `Value`
3397
+ # omitted to clear one.
3398
+ #
3399
+ # Named `FieldValues` to match the member it edits on `CampaignAsset`,
3400
+ # which is the same concept read back. It was `templateFieldUpdates`;
3401
+ # the two names for one concept were the defect, not the length.
3402
+ # @return [Array<Types::FieldValueInput>]
3403
+ #
3404
+ # @!attribute [rw] layout
3405
+ # Selects a multi-layout asset's layout: one of the values in
3406
+ # `CampaignAsset.layout.options`.
3407
+ #
3408
+ # PATCH: omitted leaves the selection unchanged, and there is no way
3409
+ # to clear it. A value that is not one of the asset's options — or
3410
+ # any value on a single-layout asset — is a plain
3411
+ # `ValidationException`, and nothing in the call is applied. Every
3412
+ # pinned field stays writable whichever layout is selected.
3413
+ # @return [String]
3414
+ #
3415
+ # @!attribute [rw] send_mode
3416
+ # When a **sendable** asset (`EMAIL`, `SOCIAL_POST`) sends: on
3417
+ # activation, or at `ScheduledSendAt`.
3418
+ #
3419
+ # A mode beside a value rather than a union, on purpose:
3420
+ # `ScheduledSendAt` stays a plain `Timestamp`, and the precedent is
3421
+ # EventBridge Scheduler's `FlexibleTimeWindow { Mode,
3422
+ # MaximumWindowInMinutes }`. The pair is checked as one, and a request
3423
+ # where they disagree is refused with `ValidationException`
3424
+ # (`INVALID_VALUE`, naming the member) and applies nothing:
3425
+ #
3426
+ # * `SCHEDULED` requires `ScheduledSendAt`; a reschedule resends
3427
+ # `SCHEDULED` with the new time;
3428
+ # * `ON_ACTIVATION` forbids `ScheduledSendAt`, and drops any time
3429
+ # already stored;
3430
+ # * `ScheduledSendAt` without `SendMode` is refused.
3431
+ #
3432
+ # PATCH: omitted leaves both unchanged. Until a mode is chosen the
3433
+ # asset reports `SEND_MODE_MISSING` and does not activate: no default,
3434
+ # because an unchosen send mails the real audience. Rejected with
3435
+ # `ValidationException` (`NOT_SUPPORTED_FOR_CATEGORY`) for a category
3436
+ # that has no send (`LANDING_PAGE`, `DOCUMENT`, `BANNER_AD`). Like
3437
+ # every other edit, it reaches the delivery platform at the asset's
3438
+ # next activation, and a live email or social post refuses it
3439
+ # (`ASSET_ALREADY_ACTIVE`): deactivate first.
3440
+ # @return [String]
3441
+ #
3442
+ # @!attribute [rw] scheduled_send_at
3443
+ # The send time, with `SendMode: SCHEDULED` and only then. See
3444
+ # `SendMode`.
3445
+ #
3446
+ # Must be at least an hour out (`SEND_WINDOW_TOO_SOON`), unless it is
3447
+ # the time already stored: resending the stored mode and time changes
3448
+ # nothing and is accepted, so a form that always resubmits does not
3449
+ # trip the window.
3450
+ #
3451
+ # Must also fall on or before the campaign's `EndOn` (by the end of
3452
+ # that UTC day): refused with `ValidationException` (`INVALID_VALUE`)
3453
+ # otherwise, so nothing is scheduled to send after the campaign
3454
+ # completes.
3455
+ #
3456
+ # Was `scheduleDate`, a `YYYY-MM-DD` string. Retyped because a date
3457
+ # alone cannot express a send *time*, which is the whole point of a
3458
+ # schedule — and because the resource already spelled the same concept
3459
+ # `ScheduledSendAt` on the activation responses. Two spellings of one
3460
+ # concept on one resource was the defect.
3461
+ # @return [Time]
3462
+ #
3463
+ # @!attribute [rw] client_token
3464
+ # Idempotency token. Retry-safety only — this is **not** a concurrency
3465
+ # token, and sequential edits to one field are last-writer-wins.
3466
+ #
3467
+ # **A suitable default value is auto-generated.** You should normally
3468
+ # not need to pass this option.
3469
+ # @return [String]
3470
+ #
3471
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/UpdateCampaignAssetRequest AWS API Documentation
3472
+ #
3473
+ class UpdateCampaignAssetRequest < Struct.new(
3474
+ :catalog,
3475
+ :campaign_identifier,
3476
+ :campaign_asset_identifier,
3477
+ :field_values,
3478
+ :layout,
3479
+ :send_mode,
3480
+ :scheduled_send_at,
3481
+ :client_token)
3482
+ SENSITIVE = []
3483
+ include Aws::Structure
3484
+ end
3485
+
3486
+ # Output for UpdateCampaignAsset.
3487
+ #
3488
+ # A minimal acknowledgment, not an echo. Read GetCampaignAsset for the
3489
+ # applied values (`FieldValues`).
3490
+ #
3491
+ # @!attribute [rw] id
3492
+ # The asset identifier.
3493
+ # @return [String]
3494
+ #
3495
+ # @!attribute [rw] state
3496
+ # The asset's state, **unchanged**.
3497
+ #
3498
+ # An update never moves it, so a live asset stays ACTIVE while its
3499
+ # edited values take effect for the next activation. There is no
3500
+ # edit-outcome member: a 200 means every submitted value applied, and
3501
+ # every failure is a refusal on the call itself (DG-040 Decision 11).
3502
+ # @return [String]
3503
+ #
3504
+ # @!attribute [rw] activation_issues
3505
+ # What must be fixed on this asset before it can be activated. Empty
3506
+ # when the asset is ready.
3507
+ #
3508
+ # Issues don't block saving: an asset can be saved incomplete and
3509
+ # fixed over several updates. `StartCampaignAssetActivationTask`
3510
+ # refuses an asset that still has issues: an issue blocks activation
3511
+ # when only an edit to the asset can change the outcome. Most issues
3512
+ # name the field to fix in `FieldId`. Fix it with
3513
+ # `UpdateCampaignAsset`, then read this list again.
3514
+ #
3515
+ # Besides the issues computed from the asset's content, the list
3516
+ # carries what the last activation found: `CONTENT_REJECTED` and
3517
+ # `PARTNER_IMAGE_REJECTED` when moderation refused a field. Editing
3518
+ # that field removes its issue. A `CONTENT_REJECTED` without a
3519
+ # `FieldId` means the text was refused as a whole; editing any text
3520
+ # field removes it.
3521
+ #
3522
+ # Problems with the campaign's own settings, such as a missing
3523
+ # recipient list, and with the partner's profile, such as a missing
3524
+ # logo, are reported on `Campaign.ActivationIssues`, not here.
3525
+ # @return [Array<Types::ActivationIssue>]
3526
+ #
3527
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/UpdateCampaignAssetResponse AWS API Documentation
3528
+ #
3529
+ class UpdateCampaignAssetResponse < Struct.new(
3530
+ :id,
3531
+ :state,
3532
+ :activation_issues)
3533
+ SENSITIVE = []
3534
+ include Aws::Structure
3535
+ end
3536
+
3537
+ # Input for UpdateCampaign operation.
3538
+ #
3539
+ # @!attribute [rw] catalog
3540
+ # The catalog (AWS or Sandbox).
3541
+ # @return [String]
3542
+ #
3543
+ # @!attribute [rw] campaign_identifier
3544
+ # The campaign identifier.
3545
+ # @return [String]
3546
+ #
3547
+ # @!attribute [rw] name
3548
+ # The display name.
3549
+ # @return [String]
3550
+ #
3551
+ # @!attribute [rw] sender_email
3552
+ # Sets or replaces the address the campaign's emails are sent from.
3553
+ # Checked by the same three rules as on `CreateCampaign`, with the
3554
+ # same codes, but only when it differs, ignoring case, from the stored
3555
+ # sender: re-sending the stored one is not checked, and
3556
+ # `StartCampaignAssetActivationTask` re-checks it before an email
3557
+ # activates.
3558
+ #
3559
+ # Replaces, never clears: like every member of this operation, an
3560
+ # omitted value leaves the sender as it was, and there is no way to
3561
+ # remove one once set.
3562
+ # @return [String]
3563
+ #
3564
+ # @!attribute [rw] privacy_policy_url
3565
+ # Sets or replaces the URL of the partner's privacy policy. Replaces,
3566
+ # never clears.
3567
+ # @return [String]
3568
+ #
3569
+ # @!attribute [rw] partner_address
3570
+ # Sets or replaces the partner's postal address. Replaces, never
3571
+ # clears.
3572
+ # @return [String]
3573
+ #
3574
+ # @!attribute [rw] partner_badge
3575
+ # Sets or replaces the partner's badge, checked exactly as on
3576
+ # `CreateCampaign`. Replaces, never clears: upload the Standalone AWS
3577
+ # Partner badge to show it again. The badge an asset already published
3578
+ # keeps showing on it until that asset is activated again.
3579
+ # @return [Types::FileRef]
3580
+ #
3581
+ # @!attribute [rw] email_target
3582
+ # Replaces the campaign's attached recipient list.
3583
+ #
3584
+ # The referenced object is copied and pinned again on every call that
3585
+ # supplies it, so the pinned copy always reflects the *last*
3586
+ # `UpdateCampaign` that named one. Editing the source object in your
3587
+ # own bucket without calling this operation again has no effect.
3588
+ # Replaces, never detaches: a partner can swap the list but cannot
3589
+ # remove it.
3590
+ # @return [Types::FileRef]
3591
+ #
3592
+ # @!attribute [rw] email_target_engagement_group_ids
3593
+ # Engagement groups whose contacts the campaign's emails will also go
3594
+ # to (see `CreateCampaign`). Replaces the stored list; never clears
3595
+ # it.
3596
+ #
3597
+ # As on `CreateCampaign`: each group once (`INVALID\_VALUE`
3598
+ # otherwise), not checked against your groups when saved, and resolved
3599
+ # at Start where the stage can (`ENGAGEMENT\_GROUPS\_UNAVAILABLE`
3600
+ # where it can't).
3601
+ # @return [Array<String>]
3602
+ #
3603
+ # @!attribute [rw] social_connections
3604
+ # Sets the account the campaign's social posts publish from, per
3605
+ # platform. Each platform named replaces that platform's choice; a
3606
+ # platform not named keeps its own. Replaces, never clears.
3607
+ #
3608
+ # Not checked against your connections here: a connection can be
3609
+ # deleted at any time, so the activation checks the choice. See
3610
+ # `Campaign$SocialConnections`.
3611
+ # @return [Hash<String,Array<String>>]
3612
+ #
3613
+ # @!attribute [rw] estimated_budget
3614
+ # What the partner expects the campaign to cost.
3615
+ # @return [Types::MonetaryValue]
3616
+ #
3617
+ # @!attribute [rw] total_budget
3618
+ # The campaign's total budget.
3619
+ # @return [Types::MonetaryValue]
3620
+ #
3621
+ # @!attribute [rw] target_audience
3622
+ # Target audience configuration.
3623
+ # @return [Types::TargetAudience]
3624
+ #
3625
+ # @!attribute [rw] client_token
3626
+ # Idempotency token. Accepted and not stored: this is a change-only
3627
+ # partial update with last-writer-wins, so re-applying the same call
3628
+ # produces the same result and the same response. There is nothing a
3629
+ # replay cache would protect.
3630
+ #
3631
+ # **A suitable default value is auto-generated.** You should normally
3632
+ # not need to pass this option.
3633
+ # @return [String]
3634
+ #
3635
+ # @!attribute [rw] start_on
3636
+ # The first day of the campaign's run window. Not after `EndOn`
3637
+ # (`ValidationException`, `INVALID_VALUE`).
3638
+ # @return [String]
3639
+ #
3640
+ # @!attribute [rw] end_on
3641
+ # The last day of the campaign's run window, inclusive and in UTC.
3642
+ #
3643
+ # Editable only while the campaign is open, like everything else here:
3644
+ # once the stored `EndOn` has passed the campaign is completed and
3645
+ # this update is refused (`CAMPAIGN_COMPLETED`). Refused with
3646
+ # `ValidationException` (`INVALID_VALUE`) when it is in the past, or
3647
+ # earlier than the day of a scheduled send on one of the campaign's
3648
+ # assets: move or cancel that send first. Setting it to today ends the
3649
+ # campaign at the next UTC midnight.
3650
+ # @return [String]
3651
+ #
3652
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/UpdateCampaignRequest AWS API Documentation
3653
+ #
3654
+ class UpdateCampaignRequest < Struct.new(
3655
+ :catalog,
3656
+ :campaign_identifier,
3657
+ :name,
3658
+ :sender_email,
3659
+ :privacy_policy_url,
3660
+ :partner_address,
3661
+ :partner_badge,
3662
+ :email_target,
3663
+ :email_target_engagement_group_ids,
3664
+ :social_connections,
3665
+ :estimated_budget,
3666
+ :total_budget,
3667
+ :target_audience,
3668
+ :client_token,
3669
+ :start_on,
3670
+ :end_on)
3671
+ SENSITIVE = [:sender_email, :partner_address]
3672
+ include Aws::Structure
3673
+ end
3674
+
3675
+ # Output for UpdateCampaign.
3676
+ #
3677
+ # @!attribute [rw] id
3678
+ # The campaign identifier.
3679
+ # @return [String]
3680
+ #
3681
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/UpdateCampaignResponse AWS API Documentation
3682
+ #
3683
+ class UpdateCampaignResponse < Struct.new(
3684
+ :id)
3685
+ SENSITIVE = []
3686
+ include Aws::Structure
3687
+ end
3688
+
3689
+ # The input fails to satisfy the constraints specified by the service.
3690
+ #
3691
+ # A caller branches on `Reason`, and where the rejection is attributable
3692
+ # to particular fields it reads `FieldList` rather than parsing
3693
+ # `Message`, which is prose and may change.
3694
+ #
3695
+ # @!attribute [rw] message
3696
+ # Error message.
3697
+ # @return [String]
3698
+ #
3699
+ # @!attribute [rw] reason
3700
+ # The single coarse reason the request was rejected, for a caller that
3701
+ # does not care which field.
3702
+ # @return [String]
3703
+ #
3704
+ # @!attribute [rw] field_list
3705
+ # Every field that failed, not just the first.
3706
+ #
3707
+ # ⚠️ **Every field, deliberately.** The convention comment carried
3708
+ # by most internal models — *"if more than one field caused the
3709
+ # error, pick one and elaborate in the message"* — is the reading
3710
+ # this service does NOT take: a partner editing a form would then
3711
+ # discover their errors one request at a time. The whole request is
3712
+ # validated and the full set reported, so one round of fixes is one
3713
+ # call. **Each entry names a member of the request just sent**, and
3714
+ # only
3715
+ # that: the value to change and send again. A template field value is
3716
+ # `Name` `FieldValues` with the template field in `FieldId`, one
3717
+ # entry per failing field. **When it is present.** Only when the
3718
+ # refusal points at something
3719
+ # the partner fixes in a form, and then every such refusal carries it:
3720
+ # - `UpdateCampaignAsset`: `FieldValues` (including a file the
3721
+ # content scan declined, which is why a partner handles image failures
3722
+ # and text failures the same way, through this list), `Layout`,
3723
+ # `SendMode` and `ScheduledSendAt`; - `CreateCampaign` and
3724
+ # `UpdateCampaign`: campaign settings and files; -
3725
+ # `GetCampaignTemplate`: `Identifier`. Every other
3726
+ # `ValidationException` carries `Message` only — tags,
3727
+ # ARNs, social connections, exports, and `CAMPAIGN\_INCOMPLETE`,
3728
+ # whose missing settings are not members of the request it refuses.
3729
+ # @return [Array<Types::ValidationExceptionField>]
3730
+ #
3731
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/ValidationException AWS API Documentation
3732
+ #
3733
+ class ValidationException < Struct.new(
3734
+ :message,
3735
+ :reason,
3736
+ :field_list)
3737
+ SENSITIVE = []
3738
+ include Aws::Structure
3739
+ end
3740
+
3741
+ # A field that failed validation.
3742
+ #
3743
+ # @!attribute [rw] name
3744
+ # The member of the request that failed, as the request names it:
3745
+ # `FieldValues` for a template field value, `Layout`, `EmailTarget`,
3746
+ # `Identifier`, and so on. It is never a template field id: a template
3747
+ # field is always `FieldValues`, with the field in `FieldId`.
3748
+ # @return [String]
3749
+ #
3750
+ # @!attribute [rw] field_id
3751
+ # The template field that failed, when `Name` is `FieldValues`; absent
3752
+ # otherwise.
3753
+ # @return [String]
3754
+ #
3755
+ # @!attribute [rw] message
3756
+ # Why this field failed, in prose a partner can be shown directly.
3757
+ # @return [String]
3758
+ #
3759
+ # @!attribute [rw] code
3760
+ # Why this field failed, as a value a client branches on. Read this
3761
+ # rather than `Message`.
3762
+ # @return [String]
3763
+ #
3764
+ # @see http://docs.aws.amazon.com/goto/WebAPI/partnercentral-marketing-2026-05-31/ValidationExceptionField AWS API Documentation
3765
+ #
3766
+ class ValidationExceptionField < Struct.new(
3767
+ :name,
3768
+ :field_id,
3769
+ :message,
3770
+ :code)
3771
+ SENSITIVE = []
3772
+ include Aws::Structure
3773
+ end
3774
+
3775
+ end
3776
+ end
3777
+