| Copyright | (c) 2013-2021 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 |
Amazonka.APIGateway.GetDeployment
Description
Gets information about a Deployment resource.
Synopsis
- data GetDeployment = GetDeployment' {}
- newGetDeployment :: Text -> Text -> GetDeployment
- getDeployment_embed :: Lens' GetDeployment (Maybe [Text])
- getDeployment_restApiId :: Lens' GetDeployment Text
- getDeployment_deploymentId :: Lens' GetDeployment Text
- data Deployment = Deployment' {
- apiSummary :: Maybe (HashMap Text (HashMap Text MethodSnapshot))
- createdDate :: Maybe POSIX
- id :: Maybe Text
- description :: Maybe Text
- newDeployment :: Deployment
- deployment_apiSummary :: Lens' Deployment (Maybe (HashMap Text (HashMap Text MethodSnapshot)))
- deployment_createdDate :: Lens' Deployment (Maybe UTCTime)
- deployment_id :: Lens' Deployment (Maybe Text)
- deployment_description :: Lens' Deployment (Maybe Text)
Creating a Request
data GetDeployment Source #
Requests API Gateway to get information about a Deployment resource.
See: newGetDeployment smart constructor.
Constructors
| GetDeployment' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> GetDeployment |
Create a value of GetDeployment 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:embed:GetDeployment', getDeployment_embed - 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.
$sel:restApiId:GetDeployment', getDeployment_restApiId - [Required] The string identifier of the associated RestApi.
$sel:deploymentId:GetDeployment', getDeployment_deploymentId - [Required] The identifier of the Deployment resource to get information
about.
Request Lenses
getDeployment_embed :: Lens' GetDeployment (Maybe [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.
getDeployment_restApiId :: Lens' GetDeployment Text Source #
- Required
- The string identifier of the associated RestApi.
getDeployment_deploymentId :: Lens' GetDeployment Text Source #
- Required
- The identifier of the Deployment resource to get 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.
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: 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:id:Deployment', deployment_id - The identifier for the deployment resource.
$sel:description:Deployment', deployment_description - The description 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_id :: Lens' Deployment (Maybe Text) Source #
The identifier for the deployment resource.
deployment_description :: Lens' Deployment (Maybe Text) Source #
The description for the deployment resource.