| 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.Proton.CancelEnvironmentDeployment
Description
Attempts to cancel an environment deployment on an UpdateEnvironment
action, if the deployment is IN_PROGRESS. For more information, see
Update an environment
in the AWS Proton Administrator guide.
The following list includes potential cancellation scenarios.
- If the cancellation attempt succeeds, the resulting deployment state
is
CANCELLED. - If the cancellation attempt fails, the resulting deployment state is
FAILED. - If the current UpdateEnvironment action succeeds before the
cancellation attempt starts, the resulting deployment state is
SUCCEEDEDand the cancellation attempt has no effect.
Synopsis
- data CancelEnvironmentDeployment = CancelEnvironmentDeployment' {}
- newCancelEnvironmentDeployment :: Text -> CancelEnvironmentDeployment
- cancelEnvironmentDeployment_environmentName :: Lens' CancelEnvironmentDeployment Text
- data CancelEnvironmentDeploymentResponse = CancelEnvironmentDeploymentResponse' {}
- newCancelEnvironmentDeploymentResponse :: Int -> Environment -> CancelEnvironmentDeploymentResponse
- cancelEnvironmentDeploymentResponse_httpStatus :: Lens' CancelEnvironmentDeploymentResponse Int
- cancelEnvironmentDeploymentResponse_environment :: Lens' CancelEnvironmentDeploymentResponse Environment
Creating a Request
data CancelEnvironmentDeployment Source #
See: newCancelEnvironmentDeployment smart constructor.
Constructors
| CancelEnvironmentDeployment' | |
Fields
| |
Instances
newCancelEnvironmentDeployment Source #
Create a value of CancelEnvironmentDeployment 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:environmentName:CancelEnvironmentDeployment', cancelEnvironmentDeployment_environmentName - The name of the environment with the deployment to cancel.
Request Lenses
cancelEnvironmentDeployment_environmentName :: Lens' CancelEnvironmentDeployment Text Source #
The name of the environment with the deployment to cancel.
Destructuring the Response
data CancelEnvironmentDeploymentResponse Source #
See: newCancelEnvironmentDeploymentResponse smart constructor.
Constructors
| CancelEnvironmentDeploymentResponse' | |
Fields
| |
Instances
newCancelEnvironmentDeploymentResponse Source #
Arguments
| :: Int | |
| -> Environment | |
| -> CancelEnvironmentDeploymentResponse |
Create a value of CancelEnvironmentDeploymentResponse 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:CancelEnvironmentDeploymentResponse', cancelEnvironmentDeploymentResponse_httpStatus - The response's http status code.
$sel:environment:CancelEnvironmentDeploymentResponse', cancelEnvironmentDeploymentResponse_environment - The environment summary data that's returned by AWS Proton.
Response Lenses
cancelEnvironmentDeploymentResponse_httpStatus :: Lens' CancelEnvironmentDeploymentResponse Int Source #
The response's http status code.
cancelEnvironmentDeploymentResponse_environment :: Lens' CancelEnvironmentDeploymentResponse Environment Source #
The environment summary data that's returned by AWS Proton.