{-# LANGUAGE DeriveGeneric #-} {-# LANGUAGE DuplicateRecordFields #-} {-# LANGUAGE NamedFieldPuns #-} {-# LANGUAGE OverloadedStrings #-} {-# LANGUAGE RecordWildCards #-} {-# LANGUAGE StrictData #-} {-# LANGUAGE TypeFamilies #-} {-# LANGUAGE NoImplicitPrelude #-} {-# OPTIONS_GHC -fno-warn-unused-binds #-} {-# OPTIONS_GHC -fno-warn-unused-imports #-} {-# OPTIONS_GHC -fno-warn-unused-matches #-} -- Derived from AWS service descriptions, licensed under Apache 2.0. -- | -- Module : Amazonka.ApiGatewayV2.UpdateDeployment -- Copyright : (c) 2013-2023 Brendan Hay -- License : Mozilla Public License, v. 2.0. -- Maintainer : Brendan Hay -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- -- Updates a Deployment. module Amazonka.ApiGatewayV2.UpdateDeployment ( -- * Creating a Request UpdateDeployment (..), newUpdateDeployment, -- * Request Lenses updateDeployment_description, updateDeployment_apiId, updateDeployment_deploymentId, -- * Destructuring the Response UpdateDeploymentResponse (..), newUpdateDeploymentResponse, -- * Response Lenses updateDeploymentResponse_autoDeployed, updateDeploymentResponse_createdDate, updateDeploymentResponse_deploymentId, updateDeploymentResponse_deploymentStatus, updateDeploymentResponse_deploymentStatusMessage, updateDeploymentResponse_description, updateDeploymentResponse_httpStatus, ) where import Amazonka.ApiGatewayV2.Types import qualified Amazonka.Core as Core import qualified Amazonka.Core.Lens.Internal as Lens import qualified Amazonka.Data as Data import qualified Amazonka.Prelude as Prelude import qualified Amazonka.Request as Request import qualified Amazonka.Response as Response -- | Updates a Deployment. -- -- /See:/ 'newUpdateDeployment' smart constructor. data UpdateDeployment = UpdateDeployment' { -- | The description for the deployment resource. description :: Prelude.Maybe Prelude.Text, -- | The API identifier. apiId :: Prelude.Text, -- | The deployment ID. deploymentId :: Prelude.Text } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'UpdateDeployment' with all optional fields omitted. -- -- Use or to modify other optional fields. -- -- The following record fields are available, with the corresponding lenses provided -- for backwards compatibility: -- -- 'description', 'updateDeployment_description' - The description for the deployment resource. -- -- 'apiId', 'updateDeployment_apiId' - The API identifier. -- -- 'deploymentId', 'updateDeployment_deploymentId' - The deployment ID. newUpdateDeployment :: -- | 'apiId' Prelude.Text -> -- | 'deploymentId' Prelude.Text -> UpdateDeployment newUpdateDeployment pApiId_ pDeploymentId_ = UpdateDeployment' { description = Prelude.Nothing, apiId = pApiId_, deploymentId = pDeploymentId_ } -- | The description for the deployment resource. updateDeployment_description :: Lens.Lens' UpdateDeployment (Prelude.Maybe Prelude.Text) updateDeployment_description = Lens.lens (\UpdateDeployment' {description} -> description) (\s@UpdateDeployment' {} a -> s {description = a} :: UpdateDeployment) -- | The API identifier. updateDeployment_apiId :: Lens.Lens' UpdateDeployment Prelude.Text updateDeployment_apiId = Lens.lens (\UpdateDeployment' {apiId} -> apiId) (\s@UpdateDeployment' {} a -> s {apiId = a} :: UpdateDeployment) -- | The deployment ID. updateDeployment_deploymentId :: Lens.Lens' UpdateDeployment Prelude.Text updateDeployment_deploymentId = Lens.lens (\UpdateDeployment' {deploymentId} -> deploymentId) (\s@UpdateDeployment' {} a -> s {deploymentId = a} :: UpdateDeployment) instance Core.AWSRequest UpdateDeployment where type AWSResponse UpdateDeployment = UpdateDeploymentResponse request overrides = Request.patchJSON (overrides defaultService) response = Response.receiveJSON ( \s h x -> UpdateDeploymentResponse' Prelude.<$> (x Data..?> "autoDeployed") Prelude.<*> (x Data..?> "createdDate") Prelude.<*> (x Data..?> "deploymentId") Prelude.<*> (x Data..?> "deploymentStatus") Prelude.<*> (x Data..?> "deploymentStatusMessage") Prelude.<*> (x Data..?> "description") Prelude.<*> (Prelude.pure (Prelude.fromEnum s)) ) instance Prelude.Hashable UpdateDeployment where hashWithSalt _salt UpdateDeployment' {..} = _salt `Prelude.hashWithSalt` description `Prelude.hashWithSalt` apiId `Prelude.hashWithSalt` deploymentId instance Prelude.NFData UpdateDeployment where rnf UpdateDeployment' {..} = Prelude.rnf description `Prelude.seq` Prelude.rnf apiId `Prelude.seq` Prelude.rnf deploymentId instance Data.ToHeaders UpdateDeployment where toHeaders = Prelude.const ( Prelude.mconcat [ "Content-Type" Data.=# ( "application/x-amz-json-1.1" :: Prelude.ByteString ) ] ) instance Data.ToJSON UpdateDeployment where toJSON UpdateDeployment' {..} = Data.object ( Prelude.catMaybes [("description" Data..=) Prelude.<$> description] ) instance Data.ToPath UpdateDeployment where toPath UpdateDeployment' {..} = Prelude.mconcat [ "/v2/apis/", Data.toBS apiId, "/deployments/", Data.toBS deploymentId ] instance Data.ToQuery UpdateDeployment where toQuery = Prelude.const Prelude.mempty -- | /See:/ 'newUpdateDeploymentResponse' smart constructor. data UpdateDeploymentResponse = UpdateDeploymentResponse' { -- | Specifies whether a deployment was automatically released. autoDeployed :: Prelude.Maybe Prelude.Bool, -- | The date and time when the Deployment resource was created. createdDate :: Prelude.Maybe Data.ISO8601, -- | The identifier for the deployment. deploymentId :: Prelude.Maybe Prelude.Text, -- | The status of the deployment: PENDING, FAILED, or SUCCEEDED. deploymentStatus :: Prelude.Maybe DeploymentStatus, -- | May contain additional feedback on the status of an API deployment. deploymentStatusMessage :: Prelude.Maybe Prelude.Text, -- | The description for the deployment. description :: Prelude.Maybe Prelude.Text, -- | The response's http status code. httpStatus :: Prelude.Int } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'UpdateDeploymentResponse' with all optional fields omitted. -- -- Use or to modify other optional fields. -- -- The following record fields are available, with the corresponding lenses provided -- for backwards compatibility: -- -- 'autoDeployed', 'updateDeploymentResponse_autoDeployed' - Specifies whether a deployment was automatically released. -- -- 'createdDate', 'updateDeploymentResponse_createdDate' - The date and time when the Deployment resource was created. -- -- 'deploymentId', 'updateDeploymentResponse_deploymentId' - The identifier for the deployment. -- -- 'deploymentStatus', 'updateDeploymentResponse_deploymentStatus' - The status of the deployment: PENDING, FAILED, or SUCCEEDED. -- -- 'deploymentStatusMessage', 'updateDeploymentResponse_deploymentStatusMessage' - May contain additional feedback on the status of an API deployment. -- -- 'description', 'updateDeploymentResponse_description' - The description for the deployment. -- -- 'httpStatus', 'updateDeploymentResponse_httpStatus' - The response's http status code. newUpdateDeploymentResponse :: -- | 'httpStatus' Prelude.Int -> UpdateDeploymentResponse newUpdateDeploymentResponse pHttpStatus_ = UpdateDeploymentResponse' { autoDeployed = Prelude.Nothing, createdDate = Prelude.Nothing, deploymentId = Prelude.Nothing, deploymentStatus = Prelude.Nothing, deploymentStatusMessage = Prelude.Nothing, description = Prelude.Nothing, httpStatus = pHttpStatus_ } -- | Specifies whether a deployment was automatically released. updateDeploymentResponse_autoDeployed :: Lens.Lens' UpdateDeploymentResponse (Prelude.Maybe Prelude.Bool) updateDeploymentResponse_autoDeployed = Lens.lens (\UpdateDeploymentResponse' {autoDeployed} -> autoDeployed) (\s@UpdateDeploymentResponse' {} a -> s {autoDeployed = a} :: UpdateDeploymentResponse) -- | The date and time when the Deployment resource was created. updateDeploymentResponse_createdDate :: Lens.Lens' UpdateDeploymentResponse (Prelude.Maybe Prelude.UTCTime) updateDeploymentResponse_createdDate = Lens.lens (\UpdateDeploymentResponse' {createdDate} -> createdDate) (\s@UpdateDeploymentResponse' {} a -> s {createdDate = a} :: UpdateDeploymentResponse) Prelude.. Lens.mapping Data._Time -- | The identifier for the deployment. updateDeploymentResponse_deploymentId :: Lens.Lens' UpdateDeploymentResponse (Prelude.Maybe Prelude.Text) updateDeploymentResponse_deploymentId = Lens.lens (\UpdateDeploymentResponse' {deploymentId} -> deploymentId) (\s@UpdateDeploymentResponse' {} a -> s {deploymentId = a} :: UpdateDeploymentResponse) -- | The status of the deployment: PENDING, FAILED, or SUCCEEDED. updateDeploymentResponse_deploymentStatus :: Lens.Lens' UpdateDeploymentResponse (Prelude.Maybe DeploymentStatus) updateDeploymentResponse_deploymentStatus = Lens.lens (\UpdateDeploymentResponse' {deploymentStatus} -> deploymentStatus) (\s@UpdateDeploymentResponse' {} a -> s {deploymentStatus = a} :: UpdateDeploymentResponse) -- | May contain additional feedback on the status of an API deployment. updateDeploymentResponse_deploymentStatusMessage :: Lens.Lens' UpdateDeploymentResponse (Prelude.Maybe Prelude.Text) updateDeploymentResponse_deploymentStatusMessage = Lens.lens (\UpdateDeploymentResponse' {deploymentStatusMessage} -> deploymentStatusMessage) (\s@UpdateDeploymentResponse' {} a -> s {deploymentStatusMessage = a} :: UpdateDeploymentResponse) -- | The description for the deployment. updateDeploymentResponse_description :: Lens.Lens' UpdateDeploymentResponse (Prelude.Maybe Prelude.Text) updateDeploymentResponse_description = Lens.lens (\UpdateDeploymentResponse' {description} -> description) (\s@UpdateDeploymentResponse' {} a -> s {description = a} :: UpdateDeploymentResponse) -- | The response's http status code. updateDeploymentResponse_httpStatus :: Lens.Lens' UpdateDeploymentResponse Prelude.Int updateDeploymentResponse_httpStatus = Lens.lens (\UpdateDeploymentResponse' {httpStatus} -> httpStatus) (\s@UpdateDeploymentResponse' {} a -> s {httpStatus = a} :: UpdateDeploymentResponse) instance Prelude.NFData UpdateDeploymentResponse where rnf UpdateDeploymentResponse' {..} = Prelude.rnf autoDeployed `Prelude.seq` Prelude.rnf createdDate `Prelude.seq` Prelude.rnf deploymentId `Prelude.seq` Prelude.rnf deploymentStatus `Prelude.seq` Prelude.rnf deploymentStatusMessage `Prelude.seq` Prelude.rnf description `Prelude.seq` Prelude.rnf httpStatus