Copyright | (c) 2013-2017 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 |
Language | Haskell2010 |
Gets information about a Deployment
resource.
- getDeployment :: Text -> Text -> GetDeployment
- data GetDeployment
- gEmbed :: Lens' GetDeployment [Text]
- gRestAPIId :: Lens' GetDeployment Text
- gDeploymentId :: Lens' GetDeployment 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 GetDeployment
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gEmbed
- A query parameter to retrieve the specified embedded resources of the returnedDeployment
resource in the response. In a REST API call, thisembed
parameter value is a list of comma-separated strings, as inGET restapis{restapi_id}deployments{deployment_id}?embed=var1,var2
. The SDK and other platform-dependent libraries might use a different format for the list. Currently, this request supports only retrieval of the embedded API summary this way. Hence, the parameter value must be a single-valued list containing only the"apisummary"
string. For example,GET restapis{restapi_id}deployments{deployment_id}?embed=apisummary
.gRestAPIId
- The string identifier of the associatedRestApi
.gDeploymentId
- The identifier of theDeployment
resource to get information about.
data GetDeployment Source #
Requests Amazon API Gateway to get information about a Deployment
resource.
See: getDeployment
smart constructor.
Request Lenses
gEmbed :: Lens' GetDeployment [Text] Source #
A query parameter to retrieve the specified embedded resources of the returned Deployment
resource in the response. In a REST API call, this embed
parameter value is a list of comma-separated strings, as in GET restapis{restapi_id}deployments{deployment_id}?embed=var1,var2
. The SDK and other platform-dependent libraries might use a different format for the list. Currently, this request supports only retrieval of the embedded API summary this way. Hence, the parameter value must be a single-valued list containing only the "apisummary"
string. For example, GET restapis{restapi_id}deployments{deployment_id}?embed=apisummary
.
gRestAPIId :: Lens' GetDeployment Text Source #
The string identifier of the associated RestApi
.
gDeploymentId :: Lens' GetDeployment Text Source #
The identifier of the Deployment
resource to get 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.