| 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.GetDeployments
Description
Gets information about a Deployments collection.
This operation returns paginated results.
Synopsis
- data GetDeployments = GetDeployments' {}
- newGetDeployments :: Text -> GetDeployments
- getDeployments_limit :: Lens' GetDeployments (Maybe Int)
- getDeployments_position :: Lens' GetDeployments (Maybe Text)
- getDeployments_restApiId :: Lens' GetDeployments Text
- data GetDeploymentsResponse = GetDeploymentsResponse' {
- items :: Maybe [Deployment]
- position :: Maybe Text
- httpStatus :: Int
- newGetDeploymentsResponse :: Int -> GetDeploymentsResponse
- getDeploymentsResponse_items :: Lens' GetDeploymentsResponse (Maybe [Deployment])
- getDeploymentsResponse_position :: Lens' GetDeploymentsResponse (Maybe Text)
- getDeploymentsResponse_httpStatus :: Lens' GetDeploymentsResponse Int
Creating a Request
data GetDeployments Source #
Requests API Gateway to get information about a Deployments collection.
See: newGetDeployments smart constructor.
Constructors
| GetDeployments' | |
Instances
Arguments
| :: Text | |
| -> GetDeployments |
Create a value of GetDeployments 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:limit:GetDeployments', getDeployments_limit - The maximum number of returned results per page. The default value is 25
and the maximum value is 500.
$sel:position:GetDeployments', getDeployments_position - The current pagination position in the paged result set.
$sel:restApiId:GetDeployments', getDeployments_restApiId - [Required] The string identifier of the associated RestApi.
Request Lenses
getDeployments_limit :: Lens' GetDeployments (Maybe Int) Source #
The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
getDeployments_position :: Lens' GetDeployments (Maybe Text) Source #
The current pagination position in the paged result set.
getDeployments_restApiId :: Lens' GetDeployments Text Source #
- Required
- The string identifier of the associated RestApi.
Destructuring the Response
data GetDeploymentsResponse Source #
Represents a collection resource that contains zero or more references to your existing deployments, and links that guide you on how to interact with your collection. The collection offers a paginated view of the contained deployments.
To create a new deployment of a RestApi, make a POST request against
this resource. To view, update, or delete an existing deployment, make a
GET, PATCH, or DELETE request, respectively, on a specified
Deployment resource.
Deploying an API, AWS CLI, AWS SDKs
See: newGetDeploymentsResponse smart constructor.
Constructors
| GetDeploymentsResponse' | |
Fields
| |
Instances
newGetDeploymentsResponse Source #
Create a value of GetDeploymentsResponse 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:items:GetDeploymentsResponse', getDeploymentsResponse_items - The current page of elements from this collection.
$sel:position:GetDeployments', getDeploymentsResponse_position - Undocumented member.
$sel:httpStatus:GetDeploymentsResponse', getDeploymentsResponse_httpStatus - The response's http status code.
Response Lenses
getDeploymentsResponse_items :: Lens' GetDeploymentsResponse (Maybe [Deployment]) Source #
The current page of elements from this collection.
getDeploymentsResponse_position :: Lens' GetDeploymentsResponse (Maybe Text) Source #
Undocumented member.
getDeploymentsResponse_httpStatus :: Lens' GetDeploymentsResponse Int Source #
The response's http status code.