UpdateDeployment - Amazon API Gateway


Changes information about a Deployment resource.

Request Syntax

PATCH /restapis/restapi_id/deployments/deployment_id HTTP/1.1 Content-type: application/json { "patchOperations": [ { "from": "string", "op": "string", "path": "string", "value": "string" } ] }

URI Request Parameters

The request uses the following URI parameters.


The replacement identifier for the Deployment resource to change information about.

Required: Yes


The string identifier of the associated RestApi.

Required: Yes

Request Body

The request accepts the following data in JSON format.


For more information about supported patch operations, see Patch Operations.

Type: Array of PatchOperation objects

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "apiSummary": { "string" : { "string" : { "apiKeyRequired": boolean, "authorizationType": "string" } } }, "createdDate": number, "description": "string", "id": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.


A summary of the RestApi at the date and time that the deployment resource was created.

Type: String to string to MethodSnapshot object map map


The date and time that the deployment resource was created.

Type: Timestamp


The description for the deployment resource.

Type: String


The identifier for the deployment resource.

Type: String


For information about the errors that are common to all actions, see Common Errors.


The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

HTTP Status Code: 400


The requested resource is not found. Make sure that the request URI is correct.

HTTP Status Code: 404


The requested service is not available. For details see the accompanying error message. Retry after the specified time period.

HTTP Status Code: 503


The request has reached its throttling limit. Retry after the specified time period.

HTTP Status Code: 429


The request is denied because the caller has insufficient permissions.

HTTP Status Code: 401


Update a deployment description

This example illustrates one usage of UpdateDeployment.

Sample Request

PATCH /restapis/fugvjdxtri/deployments/dzacq7 HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160603T192159Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160603/us-east-1/apigateway/aws4_request, SignedHeaders=content-length;content-type;host;x-amz-date, Signature={sig4_hash} { "patchOperations" : [ { "op" : "replace", "path" : "/description", "value" : "Updated first deployment" } ] }

Sample Response

{ "_links": { "curies": { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-deployment-{rel}.html", "name": "deployment", "templated": true }, "self": { "href": "/restapis/fugvjdxtri/deployments/dzacq7" }, "deployment:delete": { "href": "/restapis/fugvjdxtri/deployments/dzacq7" }, "deployment:stages": { "href": "/restapis/fugvjdxtri/stages?deployment_id=dzacq7" }, "deployment:update": { "href": "/restapis/fugvjdxtri/deployments/dzacq7" } }, "createdDate": "2016-06-03T17:56:06Z", "description": "Updated first deployment", "id": "dzacq7" }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: