Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.CodeDeploy.StopDeployment

Contents

Description

Attempts to stop an ongoing deployment.

Creating a Request

data StopDeployment Source #

Represents the input of a StopDeployment operation.

See: newStopDeployment smart constructor.

Constructors

StopDeployment'
Fields autoRollbackEnabled :: Maybe Bool Indicates, when a deployment is stopped, whether instances that have been updated should be rolled back to the previous version of the application revision. deploymentId :: Text The unique ID of a deployment.

Instances

Instances details

ToJSON StopDeployment Source #
Instance details Defined in Amazonka.CodeDeploy.StopDeployment Methods toJSON :: StopDeployment -> Value # toEncoding :: StopDeployment -> Encoding # toJSONList :: [StopDeployment] -> Value # toEncodingList :: [StopDeployment] -> Encoding #
ToHeaders StopDeployment Source #
Instance details Defined in Amazonka.CodeDeploy.StopDeployment Methods toHeaders :: StopDeployment -> [Header] #
ToPath StopDeployment Source #
Instance details Defined in Amazonka.CodeDeploy.StopDeployment Methods toPath :: StopDeployment -> ByteString #
ToQuery StopDeployment Source #
Instance details Defined in Amazonka.CodeDeploy.StopDeployment Methods toQuery :: StopDeployment -> QueryString #
AWSRequest StopDeployment Source #
Instance details Defined in Amazonka.CodeDeploy.StopDeployment Associated Types type AWSResponse StopDeployment # Methods request :: (Service -> Service) -> StopDeployment -> Request StopDeployment # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy StopDeployment -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StopDeployment))) #
Generic StopDeployment Source #
Instance details Defined in Amazonka.CodeDeploy.StopDeployment Associated Types type Rep StopDeployment :: Type -> Type # Methods from :: StopDeployment -> Rep StopDeployment x # to :: Rep StopDeployment x -> StopDeployment #
Read StopDeployment Source #
Instance details Defined in Amazonka.CodeDeploy.StopDeployment Methods readsPrec :: Int -> ReadS StopDeployment # readList :: ReadS [StopDeployment] # readPrec :: ReadPrec StopDeployment # readListPrec :: ReadPrec [StopDeployment] #
Show StopDeployment Source #
Instance details Defined in Amazonka.CodeDeploy.StopDeployment Methods showsPrec :: Int -> StopDeployment -> ShowS # show :: StopDeployment -> String # showList :: [StopDeployment] -> ShowS #
NFData StopDeployment Source #
Instance details Defined in Amazonka.CodeDeploy.StopDeployment Methods rnf :: StopDeployment -> () #
Eq StopDeployment Source #
Instance details Defined in Amazonka.CodeDeploy.StopDeployment Methods (==) :: StopDeployment -> StopDeployment -> Bool # (/=) :: StopDeployment -> StopDeployment -> Bool #
Hashable StopDeployment Source #
Instance details Defined in Amazonka.CodeDeploy.StopDeployment Methods hashWithSalt :: Int -> StopDeployment -> Int # hash :: StopDeployment -> Int #
type AWSResponse StopDeployment Source #
Instance details Defined in Amazonka.CodeDeploy.StopDeployment type AWSResponse StopDeployment = StopDeploymentResponse
type Rep StopDeployment Source #
Instance details Defined in Amazonka.CodeDeploy.StopDeployment type Rep StopDeployment = D1 ('MetaData "StopDeployment" "Amazonka.CodeDeploy.StopDeployment" "amazonka-codedeploy-2.0-4OehMEUeOr9G9ZXD2VmvAo" 'False) (C1 ('MetaCons "StopDeployment'" 'PrefixI 'True) (S1 ('MetaSel ('Just "autoRollbackEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "deploymentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newStopDeployment Source #

Arguments

:: Text	`StopDeployment`
-> StopDeployment

Create a value of StopDeployment 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:autoRollbackEnabled:StopDeployment', stopDeployment_autoRollbackEnabled - Indicates, when a deployment is stopped, whether instances that have been updated should be rolled back to the previous version of the application revision.

StopDeployment, stopDeployment_deploymentId - The unique ID of a deployment.

Request Lenses

stopDeployment_autoRollbackEnabled :: Lens' StopDeployment (Maybe Bool) Source #

Indicates, when a deployment is stopped, whether instances that have been updated should be rolled back to the previous version of the application revision.

stopDeployment_deploymentId :: Lens' StopDeployment Text Source #

The unique ID of a deployment.

Destructuring the Response

data StopDeploymentResponse Source #

Represents the output of a StopDeployment operation.

See: newStopDeploymentResponse smart constructor.

Constructors

StopDeploymentResponse'
Fields status :: Maybe StopStatus The status of the stop deployment operation: Pending: The stop operation is pending. Succeeded: The stop operation was successful. statusMessage :: Maybe Text An accompanying status message. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic StopDeploymentResponse Source #
Instance details Defined in Amazonka.CodeDeploy.StopDeployment Associated Types type Rep StopDeploymentResponse :: Type -> Type # Methods from :: StopDeploymentResponse -> Rep StopDeploymentResponse x # to :: Rep StopDeploymentResponse x -> StopDeploymentResponse #
Read StopDeploymentResponse Source #
Instance details Defined in Amazonka.CodeDeploy.StopDeployment Methods readsPrec :: Int -> ReadS StopDeploymentResponse # readList :: ReadS [StopDeploymentResponse] # readPrec :: ReadPrec StopDeploymentResponse # readListPrec :: ReadPrec [StopDeploymentResponse] #
Show StopDeploymentResponse Source #
Instance details Defined in Amazonka.CodeDeploy.StopDeployment Methods showsPrec :: Int -> StopDeploymentResponse -> ShowS # show :: StopDeploymentResponse -> String # showList :: [StopDeploymentResponse] -> ShowS #
NFData StopDeploymentResponse Source #
Instance details Defined in Amazonka.CodeDeploy.StopDeployment Methods rnf :: StopDeploymentResponse -> () #
Eq StopDeploymentResponse Source #
Instance details Defined in Amazonka.CodeDeploy.StopDeployment Methods (==) :: StopDeploymentResponse -> StopDeploymentResponse -> Bool # (/=) :: StopDeploymentResponse -> StopDeploymentResponse -> Bool #
type Rep StopDeploymentResponse Source #
Instance details Defined in Amazonka.CodeDeploy.StopDeployment type Rep StopDeploymentResponse = D1 ('MetaData "StopDeploymentResponse" "Amazonka.CodeDeploy.StopDeployment" "amazonka-codedeploy-2.0-4OehMEUeOr9G9ZXD2VmvAo" 'False) (C1 ('MetaCons "StopDeploymentResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StopStatus)) :: (S1 ('MetaSel ('Just "statusMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))