Amazon API Gateway
API Reference

Deployment

Represents an API deployment.

URI

/v2/apis/apiId/deployments/deploymentId

HTTP Methods

GET

Operation ID: GetDeployment

Gets a Deployment.

Path Parameters

Name Type Required Description
apiId String True

The API identifier.

deploymentId String True

The deployment ID.

Responses

Status Code Response Model Description
200 Deployment

Success

404 NotFoundException

The resource specified in the request was not found.

429 LimitExceededException

The client is sending more than the allowed number of requests per unit of time.

DELETE

Operation ID: DeleteDeployment

Deletes a Deployment.

Path Parameters

Name Type Required Description
apiId String True

The API identifier.

deploymentId String True

The deployment ID.

Responses

Status Code Response Model Description
204 None

The request has succeeded, and there is no additional content to send in the response payload body.

404 NotFoundException

The resource specified in the request was not found.

429 LimitExceededException

The client is sending more than the allowed number of requests per unit of time.

PATCH

Operation ID: UpdateDeployment

Updates a Deployment.

Path Parameters

Name Type Required Description
apiId String True

The API identifier.

deploymentId String True

The deployment ID.

Responses

Status Code Response Model Description
200 Deployment

Success

400 BadRequestException

One of the parameters in the request is invalid.

404 NotFoundException

The resource specified in the request was not found.

409 ConflictException

The resource already exists.

429 LimitExceededException

The client is sending more than the allowed number of requests per unit of time.

Schemas

Request Bodies

Example PATCH

{ "description": "string" }

Response Bodies

Example Deployment

{ "deploymentId": "string", "description": "string", "createdDate": "string", "deploymentStatus": enum, "deploymentStatusMessage": "string" }

Example BadRequestException

{ "message": "string" }

Example NotFoundException

{ "message": "string", "resourceType": "string" }

Example ConflictException

{ "message": "string" }

Example LimitExceededException

{ "message": "string", "limitType": "string" }

Properties

BadRequestException

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

Property Type Required Description
message

string

False

Describes the error encountered.

ConflictException

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.

Property Type Required Description
message

string

False

Describes the error encountered.

Deployment

An immutable representation of an API that can be called by users. A Deployment must be associated with a Stage for it to be callable over the internet.

Property Type Required Description
deploymentId

string

False

The identifier for the deployment.

description

string

False

The description for the deployment.

createdDate

string

Format: date-time

False

The date and time when the Deployment resource was created.

deploymentStatus

DeploymentStatus

False

The status of the deployment: PENDING, FAILED, or SUCCEEDED.

deploymentStatusMessage

string

False

May contain additional feedback on the status of an API deployment.

DeploymentStatus

Represents a deployment status.

  • PENDING

  • FAILED

  • DEPLOYED

LimitExceededException

A limit has been exceeded. See the accompanying error message for details.

Property Type Required Description
message

string

False

Describes the error encountered.

limitType

string

False

The limit type.

NotFoundException

The resource specified in the request was not found. See the message field for more information.

Property Type Required Description
message

string

False

Describes the error encountered.

resourceType

string

False

The resource type.

UpdateDeploymentInput

Represents the input parameters for an UpdateDeployment request.

Property Type Required Description
description

string

False

The description for the deployment resource.

See Also

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

GetDeployment

DeleteDeployment

UpdateDeployment