Amazonka.Pinpoint.UpdateJourneyState

Cancels (stops) an active journey.

Creating a Request

data UpdateJourneyState

See: newUpdateJourneyState smart constructor.

Constructors

UpdateJourneyState'

Fields

• journeyId :: Text

  The unique identifier for the journey.

• applicationId :: Text

  The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

• journeyStateRequest :: JourneyStateRequest

Instances

ToJSON UpdateJourneyState

Defined in Amazonka.Pinpoint.UpdateJourneyState

Methods

toJSON :: UpdateJourneyState -> Value

toEncoding :: UpdateJourneyState -> Encoding

toJSONList :: [UpdateJourneyState] -> Value

toEncodingList :: [UpdateJourneyState] -> Encoding

ToHeaders UpdateJourneyState

Defined in Amazonka.Pinpoint.UpdateJourneyState

Methods

toHeaders :: UpdateJourneyState -> [Header]

ToPath UpdateJourneyState

Defined in Amazonka.Pinpoint.UpdateJourneyState

Methods

toPath :: UpdateJourneyState -> ByteString

ToQuery UpdateJourneyState

Defined in Amazonka.Pinpoint.UpdateJourneyState

Methods

toQuery :: UpdateJourneyState -> QueryString

AWSRequest UpdateJourneyState

Defined in Amazonka.Pinpoint.UpdateJourneyState

Associated Types

type AWSResponse UpdateJourneyState

Methods

request :: (Service -> Service) -> UpdateJourneyState -> Request UpdateJourneyState

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateJourneyState -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateJourneyState)))

Generic UpdateJourneyState

Defined in Amazonka.Pinpoint.UpdateJourneyState

Associated Types

type Rep UpdateJourneyState :: Type -> Type

Methods

from :: UpdateJourneyState -> Rep UpdateJourneyState x

to :: Rep UpdateJourneyState x -> UpdateJourneyState

Read UpdateJourneyState

Defined in Amazonka.Pinpoint.UpdateJourneyState

Methods

readsPrec :: Int -> ReadS UpdateJourneyState

readList :: ReadS [UpdateJourneyState]

readPrec :: ReadPrec UpdateJourneyState

readListPrec :: ReadPrec [UpdateJourneyState]

Show UpdateJourneyState

Defined in Amazonka.Pinpoint.UpdateJourneyState

Methods

showsPrec :: Int -> UpdateJourneyState -> ShowS

show :: UpdateJourneyState -> String

showList :: [UpdateJourneyState] -> ShowS

NFData UpdateJourneyState

Defined in Amazonka.Pinpoint.UpdateJourneyState

Methods

rnf :: UpdateJourneyState -> ()

Eq UpdateJourneyState

Defined in Amazonka.Pinpoint.UpdateJourneyState

Methods

(==) :: UpdateJourneyState -> UpdateJourneyState -> Bool

(/=) :: UpdateJourneyState -> UpdateJourneyState -> Bool

Hashable UpdateJourneyState

Defined in Amazonka.Pinpoint.UpdateJourneyState

Methods

hashWithSalt :: Int -> UpdateJourneyState -> Int

hash :: UpdateJourneyState -> Int

type AWSResponse UpdateJourneyState

Defined in Amazonka.Pinpoint.UpdateJourneyState

type AWSResponse UpdateJourneyState = UpdateJourneyStateResponse

type Rep UpdateJourneyState

Defined in Amazonka.Pinpoint.UpdateJourneyState

type Rep UpdateJourneyState = D1 ('MetaData "UpdateJourneyState" "Amazonka.Pinpoint.UpdateJourneyState" "amazonka-pinpoint-2.0-GBFs9S7wa7bFiDe66NqAzt" 'False) (C1 ('MetaCons "UpdateJourneyState'" 'PrefixI 'True) (S1 ('MetaSel ('Just "journeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "applicationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "journeyStateRequest") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 JourneyStateRequest))))

newUpdateJourneyState

Arguments

:: Text

UpdateJourneyState

-> Text

UpdateJourneyState

-> JourneyStateRequest

$sel:journeyStateRequest:UpdateJourneyState'

-> UpdateJourneyState

Create a value of UpdateJourneyState with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

UpdateJourneyState, updateJourneyState_journeyId - The unique identifier for the journey.

UpdateJourneyState, updateJourneyState_applicationId - The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

$sel:journeyStateRequest:UpdateJourneyState', updateJourneyState_journeyStateRequest - Undocumented member.

Request Lenses

updateJourneyState_journeyId :: Lens' UpdateJourneyState Text

The unique identifier for the journey.

updateJourneyState_applicationId :: Lens' UpdateJourneyState Text

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

updateJourneyState_journeyStateRequest :: Lens' UpdateJourneyState JourneyStateRequest

Undocumented member.

Destructuring the Response

data UpdateJourneyStateResponse

See: newUpdateJourneyStateResponse smart constructor.

Constructors

UpdateJourneyStateResponse'

Fields

• httpStatus :: Int

  The response's http status code.

• journeyResponse :: JourneyResponse

Instances

Generic UpdateJourneyStateResponse

Defined in Amazonka.Pinpoint.UpdateJourneyState

Associated Types

type Rep UpdateJourneyStateResponse :: Type -> Type

Methods

from :: UpdateJourneyStateResponse -> Rep UpdateJourneyStateResponse x

to :: Rep UpdateJourneyStateResponse x -> UpdateJourneyStateResponse

Read UpdateJourneyStateResponse

Defined in Amazonka.Pinpoint.UpdateJourneyState

Methods

readsPrec :: Int -> ReadS UpdateJourneyStateResponse

readList :: ReadS [UpdateJourneyStateResponse]

readPrec :: ReadPrec UpdateJourneyStateResponse

readListPrec :: ReadPrec [UpdateJourneyStateResponse]

Show UpdateJourneyStateResponse

Defined in Amazonka.Pinpoint.UpdateJourneyState

Methods

showsPrec :: Int -> UpdateJourneyStateResponse -> ShowS

show :: UpdateJourneyStateResponse -> String

showList :: [UpdateJourneyStateResponse] -> ShowS

NFData UpdateJourneyStateResponse

Defined in Amazonka.Pinpoint.UpdateJourneyState

Methods

rnf :: UpdateJourneyStateResponse -> ()

Eq UpdateJourneyStateResponse

Defined in Amazonka.Pinpoint.UpdateJourneyState

Methods

(==) :: UpdateJourneyStateResponse -> UpdateJourneyStateResponse -> Bool

(/=) :: UpdateJourneyStateResponse -> UpdateJourneyStateResponse -> Bool

type Rep UpdateJourneyStateResponse

Defined in Amazonka.Pinpoint.UpdateJourneyState

type Rep UpdateJourneyStateResponse = D1 ('MetaData "UpdateJourneyStateResponse" "Amazonka.Pinpoint.UpdateJourneyState" "amazonka-pinpoint-2.0-GBFs9S7wa7bFiDe66NqAzt" 'False) (C1 ('MetaCons "UpdateJourneyStateResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "journeyResponse") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 JourneyResponse)))

newUpdateJourneyStateResponse

Arguments

:: Int

$sel:httpStatus:UpdateJourneyStateResponse'

-> JourneyResponse

$sel:journeyResponse:UpdateJourneyStateResponse'

-> UpdateJourneyStateResponse

Create a value of UpdateJourneyStateResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:UpdateJourneyStateResponse', updateJourneyStateResponse_httpStatus - The response's http status code.

$sel:journeyResponse:UpdateJourneyStateResponse', updateJourneyStateResponse_journeyResponse - Undocumented member.

Response Lenses

updateJourneyStateResponse_httpStatus :: Lens' UpdateJourneyStateResponse Int

The response's http status code.

updateJourneyStateResponse_journeyResponse :: Lens' UpdateJourneyStateResponse JourneyResponse

Undocumented member.