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.AppConfig.StopDeployment

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Stops a deployment. This API action works only on deployments that have a status of DEPLOYING. This action moves the deployment to a status of ROLLED_BACK.

Synopsis

data StopDeployment = StopDeployment' {
- applicationId :: Text
- environmentId :: Text
- deploymentNumber :: Int
}
newStopDeployment :: Text -> Text -> Int -> StopDeployment
stopDeployment_applicationId :: Lens' StopDeployment Text
stopDeployment_environmentId :: Lens' StopDeployment Text
stopDeployment_deploymentNumber :: Lens' StopDeployment Int
data Deployment = Deployment' {
- growthFactor :: Maybe Double
- configurationName :: Maybe Text
- state :: Maybe DeploymentState
- deploymentStrategyId :: Maybe Text
- deploymentNumber :: Maybe Int
- configurationVersion :: Maybe Text
- eventLog :: Maybe [DeploymentEvent]
- percentageComplete :: Maybe Double
- startedAt :: Maybe POSIX
- applicationId :: Maybe Text
- deploymentDurationInMinutes :: Maybe Natural
- environmentId :: Maybe Text
- completedAt :: Maybe POSIX
- configurationLocationUri :: Maybe Text
- finalBakeTimeInMinutes :: Maybe Natural
- description :: Maybe Text
- configurationProfileId :: Maybe Text
- growthType :: Maybe GrowthType
}
newDeployment :: Deployment
deployment_growthFactor :: Lens' Deployment (Maybe Double)
deployment_configurationName :: Lens' Deployment (Maybe Text)
deployment_state :: Lens' Deployment (Maybe DeploymentState)
deployment_deploymentStrategyId :: Lens' Deployment (Maybe Text)
deployment_deploymentNumber :: Lens' Deployment (Maybe Int)
deployment_configurationVersion :: Lens' Deployment (Maybe Text)
deployment_eventLog :: Lens' Deployment (Maybe [DeploymentEvent])
deployment_percentageComplete :: Lens' Deployment (Maybe Double)
deployment_startedAt :: Lens' Deployment (Maybe UTCTime)
deployment_applicationId :: Lens' Deployment (Maybe Text)
deployment_deploymentDurationInMinutes :: Lens' Deployment (Maybe Natural)
deployment_environmentId :: Lens' Deployment (Maybe Text)
deployment_completedAt :: Lens' Deployment (Maybe UTCTime)
deployment_configurationLocationUri :: Lens' Deployment (Maybe Text)
deployment_finalBakeTimeInMinutes :: Lens' Deployment (Maybe Natural)
deployment_description :: Lens' Deployment (Maybe Text)
deployment_configurationProfileId :: Lens' Deployment (Maybe Text)
deployment_growthType :: Lens' Deployment (Maybe GrowthType)

Creating a Request

data StopDeployment Source #

See: newStopDeployment smart constructor.

Constructors

StopDeployment'
Fields applicationId :: Text The application ID. environmentId :: Text The environment ID. deploymentNumber :: Int The sequence number of the deployment.

Instances

Instances details

Eq StopDeployment Source #
Instance details Defined in Amazonka.AppConfig.StopDeployment Methods (==) :: StopDeployment -> StopDeployment -> Bool # (/=) :: StopDeployment -> StopDeployment -> Bool #
Read StopDeployment Source #
Instance details Defined in Amazonka.AppConfig.StopDeployment Methods readsPrec :: Int -> ReadS StopDeployment # readList :: ReadS [StopDeployment] # readPrec :: ReadPrec StopDeployment # readListPrec :: ReadPrec [StopDeployment] #
Show StopDeployment Source #
Instance details Defined in Amazonka.AppConfig.StopDeployment Methods showsPrec :: Int -> StopDeployment -> ShowS # show :: StopDeployment -> String # showList :: [StopDeployment] -> ShowS #
Generic StopDeployment Source #
Instance details Defined in Amazonka.AppConfig.StopDeployment Associated Types type Rep StopDeployment :: Type -> Type # Methods from :: StopDeployment -> Rep StopDeployment x # to :: Rep StopDeployment x -> StopDeployment #
NFData StopDeployment Source #
Instance details Defined in Amazonka.AppConfig.StopDeployment Methods rnf :: StopDeployment -> () #
Hashable StopDeployment Source #
Instance details Defined in Amazonka.AppConfig.StopDeployment Methods hashWithSalt :: Int -> StopDeployment -> Int # hash :: StopDeployment -> Int #
AWSRequest StopDeployment Source #
Instance details Defined in Amazonka.AppConfig.StopDeployment Associated Types type AWSResponse StopDeployment # Methods request :: StopDeployment -> Request StopDeployment # response :: MonadResource m => Logger -> Service -> Proxy StopDeployment -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StopDeployment))) #
ToHeaders StopDeployment Source #
Instance details Defined in Amazonka.AppConfig.StopDeployment Methods toHeaders :: StopDeployment -> [Header] #
ToPath StopDeployment Source #
Instance details Defined in Amazonka.AppConfig.StopDeployment Methods toPath :: StopDeployment -> ByteString #
ToQuery StopDeployment Source #
Instance details Defined in Amazonka.AppConfig.StopDeployment Methods toQuery :: StopDeployment -> QueryString #
type Rep StopDeployment Source #
Instance details Defined in Amazonka.AppConfig.StopDeployment type Rep StopDeployment = D1 ('MetaData "StopDeployment" "Amazonka.AppConfig.StopDeployment" "libZSservicesZSamazonka-appconfigZSamazonka-appconfig" 'False) (C1 ('MetaCons "StopDeployment'" 'PrefixI 'True) (S1 ('MetaSel ('Just "applicationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "environmentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "deploymentNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))
type AWSResponse StopDeployment Source #
Instance details Defined in Amazonka.AppConfig.StopDeployment type AWSResponse StopDeployment = Deployment

newStopDeployment Source #

Arguments

:: Text	`$sel:applicationId:StopDeployment'`
-> Text	`$sel:environmentId:StopDeployment'`
-> Int	`$sel:deploymentNumber: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:applicationId:StopDeployment', stopDeployment_applicationId - The application ID.

$sel:environmentId:StopDeployment', stopDeployment_environmentId - The environment ID.

$sel:deploymentNumber:StopDeployment', stopDeployment_deploymentNumber - The sequence number of the deployment.

Request Lenses

stopDeployment_applicationId :: Lens' StopDeployment Text Source #

The application ID.

stopDeployment_environmentId :: Lens' StopDeployment Text Source #

The environment ID.

stopDeployment_deploymentNumber :: Lens' StopDeployment Int Source #

The sequence number of the deployment.

Destructuring the Response

data Deployment Source #

See: newDeployment smart constructor.

Constructors

Deployment'

Fields

growthFactor :: Maybe Double
The percentage of targets to receive a deployed configuration during each interval.
configurationName :: Maybe Text
The name of the configuration.
state :: Maybe DeploymentState
The state of the deployment.
deploymentStrategyId :: Maybe Text
The ID of the deployment strategy that was deployed.
deploymentNumber :: Maybe Int
The sequence number of the deployment.
configurationVersion :: Maybe Text
The configuration version that was deployed.
eventLog :: Maybe [DeploymentEvent]
A list containing all events related to a deployment. The most recent events are displayed first.
percentageComplete :: Maybe Double
The percentage of targets for which the deployment is available.
startedAt :: Maybe POSIX
The time the deployment started.
applicationId :: Maybe Text
The ID of the application that was deployed.
deploymentDurationInMinutes :: Maybe Natural
Total amount of time the deployment lasted.
environmentId :: Maybe Text
The ID of the environment that was deployed.
completedAt :: Maybe POSIX
The time the deployment completed.
configurationLocationUri :: Maybe Text
Information about the source location of the configuration.
finalBakeTimeInMinutes :: Maybe Natural
The amount of time AppConfig monitored for alarms before considering the deployment to be complete and no longer eligible for automatic roll back.
description :: Maybe Text
The description of the deployment.
configurationProfileId :: Maybe Text
The ID of the configuration profile that was deployed.
growthType :: Maybe GrowthType
The algorithm used to define how percentage grew over time.

Instances

Instances details

Eq Deployment Source #
Instance details Defined in Amazonka.AppConfig.Types.Deployment Methods (==) :: Deployment -> Deployment -> Bool # (/=) :: Deployment -> Deployment -> Bool #
Read Deployment Source #
Instance details Defined in Amazonka.AppConfig.Types.Deployment Methods readsPrec :: Int -> ReadS Deployment # readList :: ReadS [Deployment] # readPrec :: ReadPrec Deployment # readListPrec :: ReadPrec [Deployment] #
Show Deployment Source #
Instance details Defined in Amazonka.AppConfig.Types.Deployment Methods showsPrec :: Int -> Deployment -> ShowS # show :: Deployment -> String # showList :: [Deployment] -> ShowS #
Generic Deployment Source #
Instance details Defined in Amazonka.AppConfig.Types.Deployment Associated Types type Rep Deployment :: Type -> Type # Methods from :: Deployment -> Rep Deployment x # to :: Rep Deployment x -> Deployment #
NFData Deployment Source #
Instance details Defined in Amazonka.AppConfig.Types.Deployment Methods rnf :: Deployment -> () #
Hashable Deployment Source #
Instance details Defined in Amazonka.AppConfig.Types.Deployment Methods hashWithSalt :: Int -> Deployment -> Int # hash :: Deployment -> Int #
FromJSON Deployment Source #
Instance details Defined in Amazonka.AppConfig.Types.Deployment Methods parseJSON :: Value -> Parser Deployment # parseJSONList :: Value -> Parser [Deployment] #
type Rep Deployment Source #
Instance details Defined in Amazonka.AppConfig.Types.Deployment type Rep Deployment = D1 ('MetaData "Deployment" "Amazonka.AppConfig.Types.Deployment" "libZSservicesZSamazonka-appconfigZSamazonka-appconfig" 'False) (C1 ('MetaCons "Deployment'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "growthFactor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :: S1 ('MetaSel ('Just "configurationName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DeploymentState)) :: S1 ('MetaSel ('Just "deploymentStrategyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "deploymentNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "configurationVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "eventLog") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DeploymentEvent])) :: (S1 ('MetaSel ('Just "percentageComplete") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :: S1 ('MetaSel ('Just "startedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))))) :: (((S1 ('MetaSel ('Just "applicationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "deploymentDurationInMinutes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "environmentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "completedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :: ((S1 ('MetaSel ('Just "configurationLocationUri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "finalBakeTimeInMinutes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "configurationProfileId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "growthType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe GrowthType))))))))

newDeployment :: Deployment Source #

Create a value of Deployment 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:growthFactor:Deployment', deployment_growthFactor - The percentage of targets to receive a deployed configuration during each interval.

$sel:configurationName:Deployment', deployment_configurationName - The name of the configuration.

$sel:state:Deployment', deployment_state - The state of the deployment.

$sel:deploymentStrategyId:Deployment', deployment_deploymentStrategyId - The ID of the deployment strategy that was deployed.

$sel:deploymentNumber:Deployment', deployment_deploymentNumber - The sequence number of the deployment.

$sel:configurationVersion:Deployment', deployment_configurationVersion - The configuration version that was deployed.

$sel:eventLog:Deployment', deployment_eventLog - A list containing all events related to a deployment. The most recent events are displayed first.

$sel:percentageComplete:Deployment', deployment_percentageComplete - The percentage of targets for which the deployment is available.

$sel:startedAt:Deployment', deployment_startedAt - The time the deployment started.

$sel:applicationId:Deployment', deployment_applicationId - The ID of the application that was deployed.

$sel:deploymentDurationInMinutes:Deployment', deployment_deploymentDurationInMinutes - Total amount of time the deployment lasted.

$sel:environmentId:Deployment', deployment_environmentId - The ID of the environment that was deployed.

$sel:completedAt:Deployment', deployment_completedAt - The time the deployment completed.

$sel:configurationLocationUri:Deployment', deployment_configurationLocationUri - Information about the source location of the configuration.

$sel:finalBakeTimeInMinutes:Deployment', deployment_finalBakeTimeInMinutes - The amount of time AppConfig monitored for alarms before considering the deployment to be complete and no longer eligible for automatic roll back.

$sel:description:Deployment', deployment_description - The description of the deployment.

$sel:configurationProfileId:Deployment', deployment_configurationProfileId - The ID of the configuration profile that was deployed.

$sel:growthType:Deployment', deployment_growthType - The algorithm used to define how percentage grew over time.