Deployments

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.

Links

Relation	Description	Method	Templated
self	A relation that refers to the current resource.	GET	No
deployment:by-id	Gets a Deployment resource with the specified identifier. This link relation offers the following templated variable(s): deployment_id: Required. [Required] The identifier of the Deployment resource to get information about. embed: Optional. 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`.	GET	Yes
deployment:create	Creates a Deployment for the application programming interface (API).	POST	No
next	The next page of elements from this collection. Not valid for the last element of the collection.	GET	No
first	The first page of elements from this collection.	GET	No
item	The current page of elements from this collection.	GET	No

Properties

The Deployments resource does not have any properties.

Remarks

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.

Amazon API Gateway REST API Reference

Deployments

Links

Properties

Remarks

See Also