Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListDeployments

List deployments. You can filter the result list by environment, service, or a single service instance.

Request Syntax


{
   "componentName": "string",
   "environmentName": "string",
   "maxResults": number,
   "nextToken": "string",
   "serviceInstanceName": "string",
   "serviceName": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

componentName

The name of a component for result list filtering. AWS Proton returns deployments associated with that component.

Type: String

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

Pattern: ^[0-9A-Za-z]+[0-9A-Za-z_\-]*$

Required: No

environmentName

The name of an environment for result list filtering. AWS Proton returns deployments associated with the environment.

Type: String

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

Pattern: ^[0-9A-Za-z]+[0-9A-Za-z_\-]*$

Required: No

maxResults

The maximum number of deployments to list.

Type: Integer

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

Required: No

nextToken

A token that indicates the location of the next deployment in the array of deployment, after the list of deployment that was previously requested.

Type: String

Pattern: ^[A-Za-z0-9+=/]+$

Required: No

serviceInstanceName

The name of a service instance for result list filtering. AWS Proton returns the deployments associated with the service instance.

Type: String

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

Pattern: ^[0-9A-Za-z]+[0-9A-Za-z_\-]*$

Required: No

serviceName

The name of a service for result list filtering. AWS Proton returns deployments associated with service instances of the service.

Type: String

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

Pattern: ^[0-9A-Za-z]+[0-9A-Za-z_\-]*$

Required: No

Response Syntax


{
   "deployments": [ 
      { 
         "arn": "string",
         "completedAt": number,
         "componentName": "string",
         "createdAt": number,
         "deploymentStatus": "string",
         "environmentName": "string",
         "id": "string",
         "lastAttemptedDeploymentId": "string",
         "lastModifiedAt": number,
         "lastSucceededDeploymentId": "string",
         "serviceInstanceName": "string",
         "serviceName": "string",
         "targetArn": "string",
         "targetResourceCreatedAt": number,
         "targetResourceType": "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

An array of deployment with summary data.

Type: Array of DeploymentSummary objects

nextToken

A token that indicates the location of the next deployment in the array of deployment, after the current requested list of deployment.

Type: String

Pattern: ^[A-Za-z0-9+=/]+$

Errors

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

AccessDeniedException

There isn't sufficient access for performing this action.

HTTP Status Code: 400

InternalServerException

The request failed to register with the service.

HTTP Status Code: 500

ResourceNotFoundException

The requested resource wasn't found.

HTTP Status Code: 400

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400

ValidationException

The input is invalid or an out-of-range value was supplied for the input parameter.

HTTP Status Code: 400