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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-pinpoint/types.rb

Overview

Note:

When making an API call, you may pass JourneyStateRequest data as a hash:

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

Changes the status of a journey.

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.

Returns:

  • (String) 


10248
10249
10250
10251
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 10248

class JourneyStateRequest < Struct.new(
  :state)
  include Aws::Structure
end