Copyright | (c) 2013-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Changes information about a Deployment
resource.
- updateDeployment :: Text -> Text -> UpdateDeployment
- data UpdateDeployment
- udPatchOperations :: Lens' UpdateDeployment [PatchOperation]
- udRestAPIId :: Lens' UpdateDeployment Text
- udDeploymentId :: Lens' UpdateDeployment Text
- deployment :: Deployment
- data Deployment
- dApiSummary :: Lens' Deployment (HashMap Text (HashMap Text MethodSnapshot))
- dCreatedDate :: Lens' Deployment (Maybe UTCTime)
- dId :: Lens' Deployment (Maybe Text)
- dDescription :: Lens' Deployment (Maybe Text)
Creating a Request
Creates a value of UpdateDeployment
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
udPatchOperations
- A list of update operations to be applied to the specified resource and in the order specified in this list.udRestAPIId
- The replacement identifier of theRestApi
resource for theDeployment
resource to change information about.udDeploymentId
- The replacement identifier for theDeployment
resource to change information about.
data UpdateDeployment Source #
Requests Amazon API Gateway to change information about a Deployment
resource.
See: updateDeployment
smart constructor.
Request Lenses
udPatchOperations :: Lens' UpdateDeployment [PatchOperation] Source #
A list of update operations to be applied to the specified resource and in the order specified in this list.
udRestAPIId :: Lens' UpdateDeployment Text Source #
The replacement identifier of the RestApi
resource for the Deployment
resource to change information about.
udDeploymentId :: Lens' UpdateDeployment Text Source #
The replacement identifier for the Deployment
resource to change information about.
Destructuring the Response
deployment :: Deployment Source #
Creates a value of Deployment
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dApiSummary
- A summary of theRestApi
at the date and time that the deployment resource was created.dCreatedDate
- The date and time that the deployment resource was created.dId
- The identifier for the deployment resource.dDescription
- The description for the deployment resource.
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.
To create a deployment, call POST
on the Deployments
resource of a RestApi
. To view, update, or delete a deployment, call GET
, PATCH
, or DELETE
on the specified deployment resource (restapis{restapi_id}deployments{deployment_id}
).RestApi
, Deployments
, Stage
, AWS CLI , AWS SDKs
See: deployment
smart constructor.
Response Lenses
dApiSummary :: Lens' Deployment (HashMap Text (HashMap Text MethodSnapshot)) Source #
A summary of the RestApi
at the date and time that the deployment resource was created.
dCreatedDate :: Lens' Deployment (Maybe UTCTime) Source #
The date and time that the deployment resource was created.
dDescription :: Lens' Deployment (Maybe Text) Source #
The description for the deployment resource.