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

Class: Aws::Pinpoint::Types::JourneyStateRequest

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

Overview

Note:

When passing JourneyStateRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  state: "DRAFT", # accepts DRAFT, ACTIVE, COMPLETED, CANCELLED, CLOSED
}

Changes the status of a journey.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#state ⇒ String

The status of the journey. Currently, the only supported value is CANCELLED.

If you cancel a journey, Amazon Pinpoint continues to perform activities that are currently in progress, until those activities are complete. Amazon Pinpoint also continues to collect and aggregate analytics data for those activities, until they are complete, and any activities that were complete when you cancelled the journey.

After you cancel a journey, you can\'t add, change, or remove any activities from the journey. In addition, Amazon Pinpoint stops evaluating the journey and doesn\'t perform any activities that haven\'t started.

Possible values:

  • DRAFT
  • ACTIVE
  • COMPLETED
  • CANCELLED
  • CLOSED

Returns:

  • (String) —

    The status of the journey.