| 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.APIGateway.UpdateDeployment
Description
Changes information about a Deployment resource.
Synopsis
- data UpdateDeployment = UpdateDeployment' {}
- newUpdateDeployment :: Text -> Text -> UpdateDeployment
- updateDeployment_patchOperations :: Lens' UpdateDeployment (Maybe [PatchOperation])
- updateDeployment_restApiId :: Lens' UpdateDeployment Text
- updateDeployment_deploymentId :: Lens' UpdateDeployment Text
- data Deployment = Deployment' {
- apiSummary :: Maybe (HashMap Text (HashMap Text MethodSnapshot))
- createdDate :: Maybe POSIX
- description :: Maybe Text
- id :: Maybe Text
- newDeployment :: Deployment
- deployment_apiSummary :: Lens' Deployment (Maybe (HashMap Text (HashMap Text MethodSnapshot)))
- deployment_createdDate :: Lens' Deployment (Maybe UTCTime)
- deployment_description :: Lens' Deployment (Maybe Text)
- deployment_id :: Lens' Deployment (Maybe Text)
Creating a Request
data UpdateDeployment Source #
Requests API Gateway to change information about a Deployment resource.
See: newUpdateDeployment smart constructor.
Constructors
| UpdateDeployment' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> UpdateDeployment |
Create a value of UpdateDeployment 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:patchOperations:UpdateDeployment', updateDeployment_patchOperations - For more information about supported patch operations, see
Patch Operations.
UpdateDeployment, updateDeployment_restApiId - The string identifier of the associated RestApi.
UpdateDeployment, updateDeployment_deploymentId - The replacement identifier for the Deployment resource to change
information about.
Request Lenses
updateDeployment_patchOperations :: Lens' UpdateDeployment (Maybe [PatchOperation]) Source #
For more information about supported patch operations, see Patch Operations.
updateDeployment_restApiId :: Lens' UpdateDeployment Text Source #
The string identifier of the associated RestApi.
updateDeployment_deploymentId :: Lens' UpdateDeployment Text Source #
The replacement identifier for the Deployment resource to change information about.
Destructuring the Response
data Deployment Source #
An immutable representation of a RestApi resource that can be called by users using Stages. A deployment must be associated with a Stage for it to be callable over the Internet.
See: newDeployment smart constructor.
Constructors
| Deployment' | |
Fields
| |
Instances
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:apiSummary:Deployment', deployment_apiSummary - A summary of the RestApi at the date and time that the deployment
resource was created.
$sel:createdDate:Deployment', deployment_createdDate - The date and time that the deployment resource was created.
$sel:description:Deployment', deployment_description - The description for the deployment resource.
$sel:id:Deployment', deployment_id - The identifier for the deployment resource.
Response Lenses
deployment_apiSummary :: Lens' Deployment (Maybe (HashMap Text (HashMap Text MethodSnapshot))) Source #
A summary of the RestApi at the date and time that the deployment resource was created.
deployment_createdDate :: Lens' Deployment (Maybe UTCTime) Source #
The date and time that the deployment resource was created.
deployment_description :: Lens' Deployment (Maybe Text) Source #
The description for the deployment resource.
deployment_id :: Lens' Deployment (Maybe Text) Source #
The identifier for the deployment resource.