| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.Pinpoint.UpdateJourneyState
Description
Cancels (stops) an active journey.
Synopsis
- data UpdateJourneyState = UpdateJourneyState' {}
- newUpdateJourneyState :: Text -> Text -> JourneyStateRequest -> UpdateJourneyState
- updateJourneyState_journeyId :: Lens' UpdateJourneyState Text
- updateJourneyState_applicationId :: Lens' UpdateJourneyState Text
- updateJourneyState_journeyStateRequest :: Lens' UpdateJourneyState JourneyStateRequest
- data UpdateJourneyStateResponse = UpdateJourneyStateResponse' {}
- newUpdateJourneyStateResponse :: Int -> JourneyResponse -> UpdateJourneyStateResponse
- updateJourneyStateResponse_httpStatus :: Lens' UpdateJourneyStateResponse Int
- updateJourneyStateResponse_journeyResponse :: Lens' UpdateJourneyStateResponse JourneyResponse
Creating a Request
data UpdateJourneyState Source #
See: newUpdateJourneyState smart constructor.
Constructors
| UpdateJourneyState' | |
Fields
| |
Instances
newUpdateJourneyState Source #
Arguments
| :: Text | |
| -> Text | |
| -> JourneyStateRequest | |
| -> 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:
$sel:journeyId:UpdateJourneyState', updateJourneyState_journeyId - The unique identifier for the journey.
$sel:applicationId: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 Source #
The unique identifier for the journey.
updateJourneyState_applicationId :: Lens' UpdateJourneyState Text Source #
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
updateJourneyState_journeyStateRequest :: Lens' UpdateJourneyState JourneyStateRequest Source #
Undocumented member.
Destructuring the Response
data UpdateJourneyStateResponse Source #
See: newUpdateJourneyStateResponse smart constructor.
Constructors
| UpdateJourneyStateResponse' | |
Fields
| |
Instances
newUpdateJourneyStateResponse Source #
Arguments
| :: Int | |
| -> JourneyResponse | |
| -> 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 Source #
The response's http status code.
updateJourneyStateResponse_journeyResponse :: Lens' UpdateJourneyStateResponse JourneyResponse Source #
Undocumented member.