Amazonka.Proton.CancelEnvironmentDeployment

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 Proton User 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 SUCCEEDED and the cancellation attempt has no effect.

Creating a Request

data CancelEnvironmentDeployment

See: newCancelEnvironmentDeployment smart constructor.

Constructors

CancelEnvironmentDeployment'

Fields

• environmentName :: Text

  The name of the environment with the deployment to cancel.

Instances

ToJSON CancelEnvironmentDeployment

Defined in Amazonka.Proton.CancelEnvironmentDeployment

Methods

toJSON :: CancelEnvironmentDeployment -> Value

toEncoding :: CancelEnvironmentDeployment -> Encoding

toJSONList :: [CancelEnvironmentDeployment] -> Value

toEncodingList :: [CancelEnvironmentDeployment] -> Encoding

ToHeaders CancelEnvironmentDeployment

Defined in Amazonka.Proton.CancelEnvironmentDeployment

Methods

toHeaders :: CancelEnvironmentDeployment -> [Header]

ToPath CancelEnvironmentDeployment

Defined in Amazonka.Proton.CancelEnvironmentDeployment

Methods

toPath :: CancelEnvironmentDeployment -> ByteString

ToQuery CancelEnvironmentDeployment

Defined in Amazonka.Proton.CancelEnvironmentDeployment

Methods

toQuery :: CancelEnvironmentDeployment -> QueryString

AWSRequest CancelEnvironmentDeployment

Defined in Amazonka.Proton.CancelEnvironmentDeployment

Associated Types

type AWSResponse CancelEnvironmentDeployment

Methods

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

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

Generic CancelEnvironmentDeployment

Defined in Amazonka.Proton.CancelEnvironmentDeployment

Associated Types

type Rep CancelEnvironmentDeployment :: Type -> Type

Methods

from :: CancelEnvironmentDeployment -> Rep CancelEnvironmentDeployment x

to :: Rep CancelEnvironmentDeployment x -> CancelEnvironmentDeployment

Read CancelEnvironmentDeployment

Defined in Amazonka.Proton.CancelEnvironmentDeployment

Methods

readsPrec :: Int -> ReadS CancelEnvironmentDeployment

readList :: ReadS [CancelEnvironmentDeployment]

readPrec :: ReadPrec CancelEnvironmentDeployment

readListPrec :: ReadPrec [CancelEnvironmentDeployment]

Show CancelEnvironmentDeployment

Defined in Amazonka.Proton.CancelEnvironmentDeployment

Methods

showsPrec :: Int -> CancelEnvironmentDeployment -> ShowS

show :: CancelEnvironmentDeployment -> String

showList :: [CancelEnvironmentDeployment] -> ShowS

NFData CancelEnvironmentDeployment

Defined in Amazonka.Proton.CancelEnvironmentDeployment

Methods

rnf :: CancelEnvironmentDeployment -> ()

Eq CancelEnvironmentDeployment

Defined in Amazonka.Proton.CancelEnvironmentDeployment

Methods

(==) :: CancelEnvironmentDeployment -> CancelEnvironmentDeployment -> Bool

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

Hashable CancelEnvironmentDeployment

Defined in Amazonka.Proton.CancelEnvironmentDeployment

Methods

hashWithSalt :: Int -> CancelEnvironmentDeployment -> Int

hash :: CancelEnvironmentDeployment -> Int

type AWSResponse CancelEnvironmentDeployment

Defined in Amazonka.Proton.CancelEnvironmentDeployment

type AWSResponse CancelEnvironmentDeployment = CancelEnvironmentDeploymentResponse

type Rep CancelEnvironmentDeployment

Defined in Amazonka.Proton.CancelEnvironmentDeployment

type Rep CancelEnvironmentDeployment = D1 ('MetaData "CancelEnvironmentDeployment" "Amazonka.Proton.CancelEnvironmentDeployment" "amazonka-proton-2.0-LlJ92rKPVfGGXHsLqGeI74" 'False) (C1 ('MetaCons "CancelEnvironmentDeployment'" 'PrefixI 'True) (S1 ('MetaSel ('Just "environmentName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newCancelEnvironmentDeployment

Arguments

:: Text

CancelEnvironmentDeployment

-> CancelEnvironmentDeployment

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:

CancelEnvironmentDeployment, cancelEnvironmentDeployment_environmentName - The name of the environment with the deployment to cancel.

Request Lenses

cancelEnvironmentDeployment_environmentName :: Lens' CancelEnvironmentDeployment Text

The name of the environment with the deployment to cancel.

Destructuring the Response

data CancelEnvironmentDeploymentResponse

See: newCancelEnvironmentDeploymentResponse smart constructor.

Constructors

CancelEnvironmentDeploymentResponse'

Fields

• httpStatus :: Int

  The response's http status code.

• environment :: Environment

  The environment summary data that's returned by Proton.

Instances

Generic CancelEnvironmentDeploymentResponse

Defined in Amazonka.Proton.CancelEnvironmentDeployment

Associated Types

type Rep CancelEnvironmentDeploymentResponse :: Type -> Type

Methods

from :: CancelEnvironmentDeploymentResponse -> Rep CancelEnvironmentDeploymentResponse x

to :: Rep CancelEnvironmentDeploymentResponse x -> CancelEnvironmentDeploymentResponse

Show CancelEnvironmentDeploymentResponse

Defined in Amazonka.Proton.CancelEnvironmentDeployment

Methods

showsPrec :: Int -> CancelEnvironmentDeploymentResponse -> ShowS

show :: CancelEnvironmentDeploymentResponse -> String

showList :: [CancelEnvironmentDeploymentResponse] -> ShowS

NFData CancelEnvironmentDeploymentResponse

Defined in Amazonka.Proton.CancelEnvironmentDeployment

Methods

rnf :: CancelEnvironmentDeploymentResponse -> ()

Eq CancelEnvironmentDeploymentResponse

Defined in Amazonka.Proton.CancelEnvironmentDeployment

Methods

(==) :: CancelEnvironmentDeploymentResponse -> CancelEnvironmentDeploymentResponse -> Bool

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

type Rep CancelEnvironmentDeploymentResponse

Defined in Amazonka.Proton.CancelEnvironmentDeployment

type Rep CancelEnvironmentDeploymentResponse = D1 ('MetaData "CancelEnvironmentDeploymentResponse" "Amazonka.Proton.CancelEnvironmentDeployment" "amazonka-proton-2.0-LlJ92rKPVfGGXHsLqGeI74" 'False) (C1 ('MetaCons "CancelEnvironmentDeploymentResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "environment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Environment)))

newCancelEnvironmentDeploymentResponse

Arguments

:: Int

$sel:httpStatus:CancelEnvironmentDeploymentResponse'

-> Environment

$sel:environment:CancelEnvironmentDeploymentResponse'

-> 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 Proton.

Response Lenses

cancelEnvironmentDeploymentResponse_httpStatus :: Lens' CancelEnvironmentDeploymentResponse Int

The response's http status code.

cancelEnvironmentDeploymentResponse_environment :: Lens' CancelEnvironmentDeploymentResponse Environment

The environment summary data that's returned by Proton.