Enum CampaignState

java.lang.Object
java.lang.Enum<CampaignState>
software.amazon.awssdk.services.partnercentralmarketing.model.CampaignState
All Implemented Interfaces:
Serializable, Comparable<CampaignState>

@Generated("software.amazon.awssdk:codegen") public enum CampaignState extends Enum<CampaignState>

A campaign's state, derived on every read from its EndOn and its assets:

  1. COMPLETED once the UTC date is after EndOn (so a campaign ending today completes at the next UTC midnight). A campaign with no EndOn never completes, and cannot activate until it has one;
  2. otherwise ACTIVE when any of its assets is ACTIVE;
  3. otherwise DRAFT, including a campaign with no assets.

A summary of the assets, not a lifecycle: nothing transitions it, it is never stored, and it gates no operation by itself: the refusal on a completed campaign (CAMPAIGN_COMPLETED) reads the same EndOn. Otherwise whether an asset can be edited, activated or deleted depends on that asset. So a scheduled email counts as ACTIVE once armed, before it sends; a campaign stays DRAFT during its first activation; deactivating its only active email or social post returns it to DRAFT; and a COMPLETED campaign can still have live landing pages.

  • Enum Constant Details

  • Method Details

    • values

      public static CampaignState[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared
    • valueOf

      public static CampaignState valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null
    • toString

      public String toString()
      Overrides:
      toString in class Enum<CampaignState>
    • fromValue

      public static CampaignState fromValue(String value)
      Use this in place of valueOf to convert the raw string returned by the service into the enum value.
      Parameters:
      value - real value
      Returns:
      CampaignState corresponding to the value
    • knownValues

      public static Set<CampaignState> knownValues()
      Use this in place of values() to return a Set of all values known to the SDK. This will return all known enum values except UNKNOWN_TO_SDK_VERSION.
      Returns:
      a Set of known CampaignStates