Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListDeployments

Lists the deployments that have been created.

Request Syntax


POST /listDeployments HTTP/1.1
Content-type: application/json

{
   "filters": [ 
      { 
         "name": "string",
         "values": [ "string" ]
      }
   ],
   "maxResults": number,
   "nextToken": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

filters

Filters to scope the results. The following filters are supported:

WORKLOAD_NAME - The name used in deployments.
DEPLOYMENT_STATUS - COMPLETED | CREATING | DELETE_IN_PROGRESS | DELETE_INITIATING | DELETE_FAILED | DELETED | FAILED | IN_PROGRESS | VALIDATING

Type: Array of DeploymentFilter objects

Array Members: Minimum number of 1 item.

Required: No

maxResults

The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

nextToken

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "deployments": [ 
      { 
         "createdAt": number,
         "id": "string",
         "name": "string",
         "patternName": "string",
         "status": "string",
         "workloadName": "string"
      }
   ],
   "nextToken": "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.

deployments

Lists the deployments.

Type: Array of DeploymentDataSummary objects

nextToken

The token to include in another request to get the next page of items. This value is null when there are no more items to return.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Errors

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

InternalServerException

An internal error has occurred. Retry your request, but if the problem persists, contact us with details by posting a question on re:Post.

HTTP Status Code: 500

ValidationException

The input fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400