URI HTTP methods Schemas Properties See also

Deployments

Represents the collection of deployments for an API.

URI

/v2/apis/apiId/deployments

HTTP methods

GET

Operation ID: GetDeployments

Gets the Deployments for an API.

Path parameters
Name	Type	Required	Description
`apiId`	String	True	The API identifier.

Query parameters
Name	Type	Required	Description
`nextToken`	String	False	The next page of elements from this collection. Not valid for the last element of the collection.
`maxResults`	String	False	The maximum number of elements to be returned for this resource.

Responses
Status code	Response model	Description
`200`	`Deployments`	Success
`400`	`BadRequestException`	One of the parameters in the request is invalid.
`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.

POST

Operation ID: CreateDeployment

Creates a Deployment for an API.

Path parameters
Name	Type	Required	Description
`apiId`	String	True	The API identifier.

Responses
Status code	Response model	Description
`201`	`Deployment`	The request has succeeded and has resulted in the creation of a resource.
`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


{
  "description": "string",
  "stageName": "string"
}

Response bodies


{
  "items": [
    {
      "deploymentId": "string",
      "description": "string",
      "createdDate": "string",
      "deploymentStatus": enum,
      "deploymentStatusMessage": "string",
      "autoDeployed": boolean
    }
  ],
  "nextToken": "string"
}


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


{
  "message": "string"
}


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


{
  "message": "string"
}


{
  "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.

CreateDeploymentInput

Represents the input parameters for a CreateDeployment request.

Property	Type	Required	Description
`description`	string	False	The description for the deployment resource.
`stageName`	string	False	The name of an existing stage to associate with the deployment.

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
`autoDeployed`	boolean	False	Specifies whether a deployment was automatically released.
`createdDate`	string Format: date-time	False	The date and time when the `Deployment` resource was created.
`deploymentId`	string	False	The identifier for the deployment.
`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.
`description`	string	False	The description for the deployment.

DeploymentStatus

Represents a deployment status.

PENDING
FAILED
DEPLOYED

Deployments

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.

Property	Type	Required	Description
`items`	Array of type Deployment	False	The elements from this collection.
`nextToken`	string	False	The next page of elements from this collection. Not valid for the last element of the collection.

LimitExceededException

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

Property	Type	Required	Description
`limitType`	string	False	The limit type.
`message`	string	False	Describes the error encountered.

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.