Interface CreateCampaignRequest.Builder

  • Method Details

    • catalog

      The catalog (AWS or Sandbox).

      Parameters:
      catalog - The catalog (AWS or Sandbox).
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • catalog

      The catalog (AWS or Sandbox).

      Parameters:
      catalog - The catalog (AWS or Sandbox).
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • name

      The display name.

      Parameters:
      name - The display name.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • campaignTemplateId

      CreateCampaignRequest.Builder campaignTemplateId(String campaignTemplateId)

      The campaign template this campaign draws its assets from.

      Binds the campaign to a single source template: every asset must come from this template's asset templates, and one from another template is refused at `BatchCreateCampaignAsset`. Immutable once set. Every campaign has one: a campaign's language and its assets' blueprints both come from its template.

      Templates are AWS-authored and read-only — they are discovered through `SearchCampaignTemplates` and `GetCampaignTemplate`, and there is no create, update or delete operation for one.

      The template's id only: a campaign template has no ARN (DG-084). The member keeps the `Id` name, which is the convention for referencing another resource from a body.

      Parameters:
      campaignTemplateId - The campaign template this campaign draws its assets from.

      Binds the campaign to a single source template: every asset must come from this template's asset templates, and one from another template is refused at `BatchCreateCampaignAsset`. Immutable once set. Every campaign has one: a campaign's language and its assets' blueprints both come from its template.

      Templates are AWS-authored and read-only — they are discovered through `SearchCampaignTemplates` and `GetCampaignTemplate`, and there is no create, update or delete operation for one.

      The template's id only: a campaign template has no ARN (DG-084). The member keeps the `

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • senderEmail

      CreateCampaignRequest.Builder senderEmail(String senderEmail)

      The address every email of this campaign is sent from.

      Printable ASCII only, with no spaces or line breaks, or field code `PATTERN_MISMATCH`. Then three rules, all checked when the sender is set. Its domain must exactly match, ignoring case, the domain of the partner's alliance lead email in AWS Partner Central (a subdomain does not), or field code `SENDER_DOMAIN_NOT_ALLIANCE_LEAD`. Then, for a sender at example.com, DNS must hold the CNAME `dkim._domainkey.example.com` → `dkim._domainkey.md02.com` (field code `SENDER_DOMAIN_DKIM_MISSING`) and a DMARC record, one TXT `_dmarc.example.com` starting `v=DMARC1` with a `p` of `none`, `quarantine` or `reject` (field code `SENDER_DOMAIN_DMARC_MISSING`). Both DNS codes are reported together when both records are missing.

      A partner who can't satisfy them can't set a sender, so can't run email campaigns. A shared mail provider's domain, such as gmail.com, can't carry the records. Optional here: a campaign with no sender can be created and edited, but its email assets cannot be activated until one is set.

      Parameters:
      senderEmail - The address every email of this campaign is sent from.

      Printable ASCII only, with no spaces or line breaks, or field code `PATTERN_MISMATCH`. Then three rules, all checked when the sender is set. Its domain must exactly match, ignoring case, the domain of the partner's alliance lead email in AWS Partner Central (a subdomain does not), or field code `SENDER_DOMAIN_NOT_ALLIANCE_LEAD`. Then, for a sender at example.com, DNS must hold the CNAME `dkim._domainkey.example.com` → `dkim._domainkey.md02.com` (field code `SENDER_DOMAIN_DKIM_MISSING`) and a DMARC record, one TXT `_dmarc.example.com` starting `v=DMARC1` with a `p` of `none`, `quarantine` or `reject` (field code `SENDER_DOMAIN_DMARC_MISSING`). Both DNS codes are reported together when both records are missing.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • privacyPolicyUrl

      CreateCampaignRequest.Builder privacyPolicyUrl(String privacyPolicyUrl)

      The URL of the partner's privacy policy, linked from every email and landing page footer. Optional here: a campaign whose emails or landing pages show it cannot activate them until one is set.

      Parameters:
      privacyPolicyUrl - The URL of the partner's privacy policy, linked from every email and landing page footer. Optional here: a campaign whose emails or landing pages show it cannot activate them until one is set.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • partnerAddress

      CreateCampaignRequest.Builder partnerAddress(String partnerAddress)

      The partner's physical postal address, shown in every email footer and as a landing page's contact line. Optional here: an email that shows it cannot activate until one is set. A landing page that shows it publishes it empty when it is unset, and a document's footer then prints the partner's name alone.

      Parameters:
      partnerAddress - The partner's physical postal address, shown in every email footer and as a landing page's contact line. Optional here: an email that shows it cannot activate until one is set. A landing page that shows it publishes it empty when it is unset, and a document's footer then prints the partner's name alone.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • partnerBadge

      CreateCampaignRequest.Builder partnerBadge(FileRef partnerBadge)

      The partner's badge — a tier or designation badge from AWS Partner Badge Manager — shown in every badge slot of the campaign's emails, landing pages and documents. Optional: until one is set, every badge slot shows the Standalone AWS Partner badge.

      A PNG or JPEG of at most 2 MB, staged like an asset image and checked the same way: it must have passed the staging scan (`SCAN_REJECTED`, or `SCAN_IN_PROGRESS` while it is pending), and its bytes must be the format its name says (`IMAGE_FORMAT_NOT_SUPPORTED`). Any shape is accepted: a badge is drawn whole, never cropped. Content moderation judges it when an asset that shows it is activated.

      Parameters:
      partnerBadge - The partner's badge — a tier or designation badge from AWS Partner Badge Manager — shown in every badge slot of the campaign's emails, landing pages and documents. Optional: until one is set, every badge slot shows the Standalone AWS Partner badge.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • partnerBadge

      default CreateCampaignRequest.Builder partnerBadge(Consumer<FileRef.Builder> partnerBadge)

      The partner's badge — a tier or designation badge from AWS Partner Badge Manager — shown in every badge slot of the campaign's emails, landing pages and documents. Optional: until one is set, every badge slot shows the Standalone AWS Partner badge.

      A PNG or JPEG of at most 2 MB, staged like an asset image and checked the same way: it must have passed the staging scan (`SCAN_REJECTED`, or `SCAN_IN_PROGRESS` while it is pending), and its bytes must be the format its name says (`IMAGE_FORMAT_NOT_SUPPORTED`). Any shape is accepted: a badge is drawn whole, never cropped. Content moderation judges it when an asset that shows it is activated. This is a convenience method that creates an instance of the FileRef.Builder avoiding the need to create one manually via FileRef.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to partnerBadge(FileRef).

      Parameters:
      partnerBadge - a consumer that will call methods on FileRef.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • emailTarget

      CreateCampaignRequest.Builder emailTarget(FileRef emailTarget)

      The campaign's send audience — a CSV of recipient email addresses.

      The campaign's *target*: who the campaign is sent to, as distinct from a `CampaignAsset`, which is the content that is sent. It sits on the campaign and not on the activation call because a partner assembles it in the same wizard flow that sets the name and the dates — and because attaching it here means it is validated, staged and resolved to a count before anything is activated, rather than at the last click.

      Required format: a header row naming the email column `Email`, `E-mail`, `Email Address` or `E-mail Address` — compared without case, spaces or punctuation. Other columns are permitted and ignored, and with two email columns the first is used. A file without such a header is refused with field code `EMAIL_COLUMN_MISSING`: the address column is never guessed. The rows reach the delivery platform's importer as the partner wrote them — a partner's audience is never rewritten.

      At most 5 MB, checked against the object's size before anything is copied, and at most 10,000 distinct addresses, refused with `RECIPIENT_LIST_TOO_LARGE`. A file with no valid address at all is refused with `RECIPIENT_LIST_EMPTY`; otherwise rows without a usable address are not a refusal: they are skipped and counted, and `GetCampaign` reports the counts. Optional here, because a campaign is a container and holds no state to be incomplete in — but an email asset cannot be activated without it, so the requirement moved to the point of activation.

      Editable at any time, and an edit reaches the delivery platform only when an asset is activated after it. Each email activation loads the audience into a contact list of its own, so an address taken off the file is not sent to by the next activation.

      The bytes are write-only. No response returns a URL or an `S3Uri` for this file; `GetCampaign` returns the scan verdict, when the list was attached and how its rows resolved, and nothing more.

      Parameters:
      emailTarget - The campaign's send audience — a CSV of recipient email addresses.

      The campaign's *target*: who the campaign is sent to, as distinct from a `CampaignAsset`, which is the content that is sent. It sits on the campaign and not on the activation call because a partner assembles it in the same wizard flow that sets the name and the dates — and because attaching it here means it is validated, staged and resolved to a count before anything is activated, rather than at the last click.

      Required format: a header row naming the email column `Email`, `E-mail`, `Email Address` or `E-mail Address` — compared without case, spaces or punctuation. Other columns are permitted and ignored, and with two email columns the first is used. A file without such a header is refused with field code `EMAIL_COLUMN_MISSING`: the address column is never guessed. The rows reach the delivery platform's importer as the partner wrote them — a partner's audience is never rewritten.

      At most 5 MB, checked against the object's size before anything is copied, and at most 10,000 distinct addresses, refused with `RECIPIENT_LIST_TOO_LARGE`. A file with no valid address at all is refused with `RECIPIENT_LIST_EMPTY`; otherwise rows without a usable address are not a refusal: they are skipped and counted, and `GetCampaign` reports the counts. Optional here, because a campaign is a container and holds no state to be incomplete in — but an email asset cannot be activated without it, so the requirement moved to the point of activation.

      Editable at any time, and an edit reaches the delivery platform only when an asset is activated after it. Each email activation loads the audience into a contact list of its own, so an address taken off the file is not sent to by the next activation.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • emailTarget

      default CreateCampaignRequest.Builder emailTarget(Consumer<FileRef.Builder> emailTarget)

      The campaign's send audience — a CSV of recipient email addresses.

      The campaign's *target*: who the campaign is sent to, as distinct from a `CampaignAsset`, which is the content that is sent. It sits on the campaign and not on the activation call because a partner assembles it in the same wizard flow that sets the name and the dates — and because attaching it here means it is validated, staged and resolved to a count before anything is activated, rather than at the last click.

      Required format: a header row naming the email column `Email`, `E-mail`, `Email Address` or `E-mail Address` — compared without case, spaces or punctuation. Other columns are permitted and ignored, and with two email columns the first is used. A file without such a header is refused with field code `EMAIL_COLUMN_MISSING`: the address column is never guessed. The rows reach the delivery platform's importer as the partner wrote them — a partner's audience is never rewritten.

      At most 5 MB, checked against the object's size before anything is copied, and at most 10,000 distinct addresses, refused with `RECIPIENT_LIST_TOO_LARGE`. A file with no valid address at all is refused with `RECIPIENT_LIST_EMPTY`; otherwise rows without a usable address are not a refusal: they are skipped and counted, and `GetCampaign` reports the counts. Optional here, because a campaign is a container and holds no state to be incomplete in — but an email asset cannot be activated without it, so the requirement moved to the point of activation.

      Editable at any time, and an edit reaches the delivery platform only when an asset is activated after it. Each email activation loads the audience into a contact list of its own, so an address taken off the file is not sent to by the next activation.

      The bytes are write-only. No response returns a URL or an `S3Uri` for this file; `GetCampaign` returns the scan verdict, when the list was attached and how its rows resolved, and nothing more. This is a convenience method that creates an instance of the FileRef.Builder avoiding the need to create one manually via FileRef.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to emailTarget(FileRef).

      Parameters:
      emailTarget - a consumer that will call methods on FileRef.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • emailTargetEngagementGroupIds

      CreateCampaignRequest.Builder emailTargetEngagementGroupIds(Collection<String> emailTargetEngagementGroupIds)

      Engagement groups whose contacts the campaign's emails will also go to: the Ids ListEngagementGroups returns (AWS Partner Central Selling). 1–10, each named once.

      Each group is named once: a repeated id is refused with field code `INVALID_VALUE`. Not checked against your groups when saved. StartCampaignAssetActivationTask resolves them to recipients. On a stage that can't resolve groups yet, Start refuses an email while groups are set (`ENGAGEMENT_GROUPS_UNAVAILABLE`), rather than send to `EmailTarget` alone.

      Parameters:
      emailTargetEngagementGroupIds - Engagement groups whose contacts the campaign's emails will also go to: the Ids ListEngagementGroups returns (AWS Partner Central Selling). 1–10, each named once.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • emailTargetEngagementGroupIds

      CreateCampaignRequest.Builder emailTargetEngagementGroupIds(String... emailTargetEngagementGroupIds)

      Engagement groups whose contacts the campaign's emails will also go to: the Ids ListEngagementGroups returns (AWS Partner Central Selling). 1–10, each named once.

      Each group is named once: a repeated id is refused with field code `INVALID_VALUE`. Not checked against your groups when saved. StartCampaignAssetActivationTask resolves them to recipients. On a stage that can't resolve groups yet, Start refuses an email while groups are set (`ENGAGEMENT_GROUPS_UNAVAILABLE`), rather than send to `EmailTarget` alone.

      Parameters:
      emailTargetEngagementGroupIds - Engagement groups whose contacts the campaign's emails will also go to: the Ids ListEngagementGroups returns (AWS Partner Central Selling). 1–10, each named once.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • targetAudience

      CreateCampaignRequest.Builder targetAudience(TargetAudience targetAudience)

      Advisory targeting metadata. Refined later, and not validated here.

      Parameters:
      targetAudience - Advisory targeting metadata. Refined later, and not validated here.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • targetAudience

      default CreateCampaignRequest.Builder targetAudience(Consumer<TargetAudience.Builder> targetAudience)

      Advisory targeting metadata. Refined later, and not validated here.

      This is a convenience method that creates an instance of the TargetAudience.Builder avoiding the need to create one manually via TargetAudience.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to targetAudience(TargetAudience).

      Parameters:
      targetAudience - a consumer that will call methods on TargetAudience.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • estimatedBudget

      CreateCampaignRequest.Builder estimatedBudget(MonetaryValue estimatedBudget)

      What the partner expects the campaign to cost.

      Parameters:
      estimatedBudget - What the partner expects the campaign to cost.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • estimatedBudget

      default CreateCampaignRequest.Builder estimatedBudget(Consumer<MonetaryValue.Builder> estimatedBudget)

      What the partner expects the campaign to cost.

      This is a convenience method that creates an instance of the MonetaryValue.Builder avoiding the need to create one manually via MonetaryValue.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to estimatedBudget(MonetaryValue).

      Parameters:
      estimatedBudget - a consumer that will call methods on MonetaryValue.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • totalBudget

      CreateCampaignRequest.Builder totalBudget(MonetaryValue totalBudget)

      The campaign's total budget.

      Parameters:
      totalBudget - The campaign's total budget.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • totalBudget

      default CreateCampaignRequest.Builder totalBudget(Consumer<MonetaryValue.Builder> totalBudget)

      The campaign's total budget.

      This is a convenience method that creates an instance of the MonetaryValue.Builder avoiding the need to create one manually via MonetaryValue.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to totalBudget(MonetaryValue).

      Parameters:
      totalBudget - a consumer that will call methods on MonetaryValue.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • startOn

      The first day of the campaign's run window. Not after EndOn (ValidationException, INVALID_VALUE).

      Parameters:
      startOn - The first day of the campaign's run window. Not after EndOn ( ValidationException, INVALID_VALUE).
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • endOn

      The last day of the campaign's run window, inclusive and in UTC. Not in the past: the campaign completes at the UTC midnight after it (see CampaignState). A scheduled send must fall on or before it.

      Optional here, but required before any asset activates: until it is set, GetCampaign's ActivationIssues reports END_ON_MISSING and StartCampaignAssetActivationTask refuses (CAMPAIGN_INCOMPLETE). Set it with UpdateCampaign.

      Parameters:
      endOn - The last day of the campaign's run window, inclusive and in UTC. Not in the past: the campaign completes at the UTC midnight after it (see CampaignState). A scheduled send must fall on or before it.

      Optional here, but required before any asset activates: until it is set, GetCampaign's ActivationIssues reports END_ON_MISSING and StartCampaignAssetActivationTask refuses (CAMPAIGN_INCOMPLETE). Set it with UpdateCampaign.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • clientToken

      CreateCampaignRequest.Builder clientToken(String clientToken)

      Idempotency token. Same token within 24h returns existing resource.

      Parameters:
      clientToken - Idempotency token. Same token within 24h returns existing resource.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • tags

      Tags to apply at creation.

      Tag-on-create rather than create-then-tag is a Tagris requirement, not a convenience: it is what lets a tag-based access control policy govern the creation itself. A campaign created untagged and tagged a moment later is briefly outside any such policy.

      A key beginning `aws:` (any case) is reserved for AWS-applied system tags and is refused with `ValidationException`, as is a key repeated in the list; nothing is created. The tags are recorded before the campaign is written, so a create that cannot record them fails and creates nothing. A retry with the same `ClientToken` returns the campaign the first attempt created and does not re-apply tags — use `TagResource` to change them afterwards. `ListTagsForResource` returns them.

      Parameters:
      tags - Tags to apply at creation.

      Tag-on-create rather than create-then-tag is a Tagris requirement, not a convenience: it is what lets a tag-based access control policy govern the creation itself. A campaign created untagged and tagged a moment later is briefly outside any such policy.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • tags

      Tags to apply at creation.

      Tag-on-create rather than create-then-tag is a Tagris requirement, not a convenience: it is what lets a tag-based access control policy govern the creation itself. A campaign created untagged and tagged a moment later is briefly outside any such policy.

      A key beginning `aws:` (any case) is reserved for AWS-applied system tags and is refused with `ValidationException`, as is a key repeated in the list; nothing is created. The tags are recorded before the campaign is written, so a create that cannot record them fails and creates nothing. A retry with the same `ClientToken` returns the campaign the first attempt created and does not re-apply tags — use `TagResource` to change them afterwards. `ListTagsForResource` returns them.

      Parameters:
      tags - Tags to apply at creation.

      Tag-on-create rather than create-then-tag is a Tagris requirement, not a convenience: it is what lets a tag-based access control policy govern the creation itself. A campaign created untagged and tagged a moment later is briefly outside any such policy.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • tags

      Tags to apply at creation.

      Tag-on-create rather than create-then-tag is a Tagris requirement, not a convenience: it is what lets a tag-based access control policy govern the creation itself. A campaign created untagged and tagged a moment later is briefly outside any such policy.

      A key beginning `aws:` (any case) is reserved for AWS-applied system tags and is refused with `ValidationException`, as is a key repeated in the list; nothing is created. The tags are recorded before the campaign is written, so a create that cannot record them fails and creates nothing. A retry with the same `ClientToken` returns the campaign the first attempt created and does not re-apply tags — use `TagResource` to change them afterwards. `ListTagsForResource` returns them. This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

      Parameters:
      tags - a consumer that will call methods on Tag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • overrideConfiguration

      CreateCampaignRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.
    • overrideConfiguration

      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.