You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Pinpoint::Types::CampaignState

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Provides information about the status of a campaign.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#campaign_status ⇒ String

The current status of the campaign, or the current status of a treatment that belongs to an A/B test campaign.

If a campaign uses A/B testing, the campaign has a status of COMPLETED only if all campaign treatments have a status of COMPLETED. If you delete the segment that\'s associated with a campaign, the campaign fails and has a status of DELETED.

Possible values:

  • SCHEDULED
  • EXECUTING
  • PENDING_NEXT_RUN
  • COMPLETED
  • PAUSED
  • DELETED
  • INVALID

Returns:

  • (String) —

    The current status of the campaign, or the current status of a treatment that belongs to an A/B test campaign.