Amazonka.AppConfig.StopDeployment

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.

Creating a Request

data StopDeployment

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

ToHeaders StopDeployment

Defined in Amazonka.AppConfig.StopDeployment

Methods

toHeaders :: StopDeployment -> [Header]

ToPath StopDeployment

Defined in Amazonka.AppConfig.StopDeployment

Methods

toPath :: StopDeployment -> ByteString

ToQuery StopDeployment

Defined in Amazonka.AppConfig.StopDeployment

Methods

toQuery :: StopDeployment -> QueryString

AWSRequest StopDeployment

Defined in Amazonka.AppConfig.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

Defined in Amazonka.AppConfig.StopDeployment

Associated Types

type Rep StopDeployment :: Type -> Type

Methods

from :: StopDeployment -> Rep StopDeployment x

to :: Rep StopDeployment x -> StopDeployment

Read StopDeployment

Defined in Amazonka.AppConfig.StopDeployment

Methods

readsPrec :: Int -> ReadS StopDeployment

readList :: ReadS [StopDeployment]

readPrec :: ReadPrec StopDeployment

readListPrec :: ReadPrec [StopDeployment]

Show StopDeployment

Defined in Amazonka.AppConfig.StopDeployment

Methods

showsPrec :: Int -> StopDeployment -> ShowS

show :: StopDeployment -> String

showList :: [StopDeployment] -> ShowS

NFData StopDeployment

Defined in Amazonka.AppConfig.StopDeployment

Methods

rnf :: StopDeployment -> ()

Eq StopDeployment

Defined in Amazonka.AppConfig.StopDeployment

Methods

(==) :: StopDeployment -> StopDeployment -> Bool

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

Hashable StopDeployment

Defined in Amazonka.AppConfig.StopDeployment

Methods

hashWithSalt :: Int -> StopDeployment -> Int

hash :: StopDeployment -> Int

type AWSResponse StopDeployment

Defined in Amazonka.AppConfig.StopDeployment

type AWSResponse StopDeployment = Deployment

type Rep StopDeployment

Defined in Amazonka.AppConfig.StopDeployment

type Rep StopDeployment = D1 ('MetaData "StopDeployment" "Amazonka.AppConfig.StopDeployment" "amazonka-appconfig-2.0-KxEFpSAUlWtLf1lFyPWujo" '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))))

newStopDeployment

Arguments

:: Text

StopDeployment

-> Text

StopDeployment

-> Int

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:

StopDeployment, stopDeployment_applicationId - The application ID.

StopDeployment, stopDeployment_environmentId - The environment ID.

StopDeployment, stopDeployment_deploymentNumber - The sequence number of the deployment.

Request Lenses

stopDeployment_applicationId :: Lens' StopDeployment Text

The application ID.

stopDeployment_environmentId :: Lens' StopDeployment Text

The environment ID.

stopDeployment_deploymentNumber :: Lens' StopDeployment Int

The sequence number of the deployment.

Destructuring the Response

data Deployment

See: newDeployment smart constructor.

Constructors

Deployment'

Fields

• applicationId :: Maybe Text

  The ID of the application that was deployed.

• appliedExtensions :: Maybe [AppliedExtension]

  A list of extensions that were processed as part of the deployment. The extensions that were previously associated to the configuration profile, environment, or the application when StartDeployment was called.

• completedAt :: Maybe ISO8601

  The time the deployment completed.

• configurationLocationUri :: Maybe Text

  Information about the source location of the configuration.

• configurationName :: Maybe Text

  The name of the configuration.

• configurationProfileId :: Maybe Text

  The ID of the configuration profile that was deployed.

• configurationVersion :: Maybe Text

  The configuration version that was deployed.

• deploymentDurationInMinutes :: Maybe Natural

  Total amount of time the deployment lasted.

• deploymentNumber :: Maybe Int

  The sequence number of the deployment.

• deploymentStrategyId :: Maybe Text

  The ID of the deployment strategy that was deployed.

• description :: Maybe Text

  The description of the deployment.

• environmentId :: Maybe Text

  The ID of the environment that was deployed.

• eventLog :: Maybe [DeploymentEvent]

  A list containing all events related to a deployment. The most recent events are displayed first.

• finalBakeTimeInMinutes :: Maybe Natural

  The amount of time that AppConfig monitored for alarms before considering the deployment to be complete and no longer eligible for automatic rollback.

• growthFactor :: Maybe Double

  The percentage of targets to receive a deployed configuration during each interval.

• growthType :: Maybe GrowthType

  The algorithm used to define how percentage grew over time.

• percentageComplete :: Maybe Double

  The percentage of targets for which the deployment is available.

• startedAt :: Maybe ISO8601

  The time the deployment started.

• state :: Maybe DeploymentState

  The state of the deployment.

Instances

FromJSON Deployment

Defined in Amazonka.AppConfig.Types.Deployment

Methods

parseJSON :: Value -> Parser Deployment

parseJSONList :: Value -> Parser [Deployment]

Generic Deployment

Defined in Amazonka.AppConfig.Types.Deployment

Associated Types

type Rep Deployment :: Type -> Type

Methods

from :: Deployment -> Rep Deployment x

to :: Rep Deployment x -> Deployment

Read Deployment

Defined in Amazonka.AppConfig.Types.Deployment

Methods

readsPrec :: Int -> ReadS Deployment

readList :: ReadS [Deployment]

readPrec :: ReadPrec Deployment

readListPrec :: ReadPrec [Deployment]

Show Deployment

Defined in Amazonka.AppConfig.Types.Deployment

Methods

showsPrec :: Int -> Deployment -> ShowS

show :: Deployment -> String

showList :: [Deployment] -> ShowS

NFData Deployment

Defined in Amazonka.AppConfig.Types.Deployment

Methods

rnf :: Deployment -> ()

Eq Deployment

Defined in Amazonka.AppConfig.Types.Deployment

Methods

(==) :: Deployment -> Deployment -> Bool

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

Hashable Deployment

Defined in Amazonka.AppConfig.Types.Deployment

Methods

hashWithSalt :: Int -> Deployment -> Int

hash :: Deployment -> Int

type Rep Deployment

Defined in Amazonka.AppConfig.Types.Deployment

type Rep Deployment = D1 ('MetaData "Deployment" "Amazonka.AppConfig.Types.Deployment" "amazonka-appconfig-2.0-KxEFpSAUlWtLf1lFyPWujo" 'False) (C1 ('MetaCons "Deployment'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "applicationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "appliedExtensions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AppliedExtension]))) :*: (S1 ('MetaSel ('Just "completedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :*: S1 ('MetaSel ('Just "configurationLocationUri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "configurationName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "configurationProfileId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "configurationVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "deploymentDurationInMinutes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "deploymentNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))))) :*: (((S1 ('MetaSel ('Just "deploymentStrategyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "environmentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "eventLog") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DeploymentEvent])) :*: S1 ('MetaSel ('Just "finalBakeTimeInMinutes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))) :*: ((S1 ('MetaSel ('Just "growthFactor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "growthType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe GrowthType))) :*: (S1 ('MetaSel ('Just "percentageComplete") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: (S1 ('MetaSel ('Just "startedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :*: S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DeploymentState))))))))

newDeployment :: Deployment

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:applicationId:Deployment', deployment_applicationId - The ID of the application that was deployed.

$sel:appliedExtensions:Deployment', deployment_appliedExtensions - A list of extensions that were processed as part of the deployment. The extensions that were previously associated to the configuration profile, environment, or the application when StartDeployment was called.

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

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

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

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

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

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

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

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

Deployment, deployment_description - The description of the deployment.

$sel:environmentId:Deployment', deployment_environmentId - The ID of the environment 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:finalBakeTimeInMinutes:Deployment', deployment_finalBakeTimeInMinutes - The amount of time that AppConfig monitored for alarms before considering the deployment to be complete and no longer eligible for automatic rollback.

$sel:growthFactor:Deployment', deployment_growthFactor - The percentage of targets to receive a deployed configuration during each interval.

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

$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:state:Deployment', deployment_state - The state of the deployment.

Response Lenses

deployment_applicationId :: Lens' Deployment (Maybe Text)

The ID of the application that was deployed.

deployment_appliedExtensions :: Lens' Deployment (Maybe [AppliedExtension])

A list of extensions that were processed as part of the deployment. The extensions that were previously associated to the configuration profile, environment, or the application when StartDeployment was called.

deployment_completedAt :: Lens' Deployment (Maybe UTCTime)

The time the deployment completed.

deployment_configurationLocationUri :: Lens' Deployment (Maybe Text)

Information about the source location of the configuration.

deployment_configurationName :: Lens' Deployment (Maybe Text)

The name of the configuration.

deployment_configurationProfileId :: Lens' Deployment (Maybe Text)

The ID of the configuration profile that was deployed.

deployment_configurationVersion :: Lens' Deployment (Maybe Text)

The configuration version that was deployed.

deployment_deploymentDurationInMinutes :: Lens' Deployment (Maybe Natural)

Total amount of time the deployment lasted.

deployment_deploymentNumber :: Lens' Deployment (Maybe Int)

The sequence number of the deployment.

deployment_deploymentStrategyId :: Lens' Deployment (Maybe Text)

The ID of the deployment strategy that was deployed.

deployment_description :: Lens' Deployment (Maybe Text)

The description of the deployment.

deployment_environmentId :: Lens' Deployment (Maybe Text)

The ID of the environment that was deployed.

deployment_eventLog :: Lens' Deployment (Maybe [DeploymentEvent])

A list containing all events related to a deployment. The most recent events are displayed first.

deployment_finalBakeTimeInMinutes :: Lens' Deployment (Maybe Natural)

The amount of time that AppConfig monitored for alarms before considering the deployment to be complete and no longer eligible for automatic rollback.

deployment_growthFactor :: Lens' Deployment (Maybe Double)

The percentage of targets to receive a deployed configuration during each interval.

deployment_growthType :: Lens' Deployment (Maybe GrowthType)

The algorithm used to define how percentage grew over time.

deployment_percentageComplete :: Lens' Deployment (Maybe Double)

The percentage of targets for which the deployment is available.

deployment_startedAt :: Lens' Deployment (Maybe UTCTime)

The time the deployment started.

deployment_state :: Lens' Deployment (Maybe DeploymentState)

The state of the deployment.