Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListComponents

List components with summary data. You can filter the result list by environment, service, or a single service instance.

For more information about components, see AWS Proton components in the AWS Proton User Guide.

Request Syntax


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

environmentName

The name of an environment for result list filtering. AWS Proton returns components associated with the environment or attached to service instances running in it.

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 components 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 component in the array of components, after the list of components 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 component attached to the service instance, if any.

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 components attached to 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


{
   "components": [ 
      { 
         "arn": "string",
         "createdAt": number,
         "deploymentStatus": "string",
         "deploymentStatusMessage": "string",
         "environmentName": "string",
         "lastAttemptedDeploymentId": "string",
         "lastDeploymentAttemptedAt": number,
         "lastDeploymentSucceededAt": number,
         "lastModifiedAt": number,
         "lastSucceededDeploymentId": "string",
         "name": "string",
         "serviceInstanceName": "string",
         "serviceName": "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.

components

An array of components with summary data.

Type: Array of ComponentSummary objects

nextToken

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

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

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