Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

UpdateComponent

Update a component.

There are a few modes for updating a component. The deploymentType field defines the mode.

Note

You can't update a component while its deployment status, or the deployment status of a service instance attached to it, is IN_PROGRESS.

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

Request Syntax


{
   "clientToken": "string",
   "deploymentType": "string",
   "description": "string",
   "name": "string",
   "serviceInstanceName": "string",
   "serviceName": "string",
   "serviceSpec": "string",
   "templateFile": "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.

clientToken

The client token for the updated component.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 64.

Pattern: ^[!-~]*$

Required: No

deploymentType

The deployment type. It defines the mode for updating a component, as follows:

NONE

In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated. You can only specify description in this mode.

CURRENT_VERSION

In this mode, the component is deployed and updated with the new serviceSpec, templateSource, and/or type that you provide. Only requested parameters are updated.

Type: String

Valid Values: NONE | CURRENT_VERSION

Required: Yes

description

An optional customer-provided description of the component.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 500.

Required: No

name

The name of the component to update.

Type: String

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

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

Required: Yes

serviceInstanceName

The name of the service instance that you want to attach this component to. Don't specify to keep the component's current service instance attachment. Specify an empty string to detach the component from the service instance it's attached to. Specify non-empty values for both serviceInstanceName and serviceName or for neither of them.

Type: String

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

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

Required: No

serviceName

The name of the service that serviceInstanceName is associated with. Don't specify to keep the component's current service instance attachment. Specify an empty string to detach the component from the service instance it's attached to. Specify non-empty values for both serviceInstanceName and serviceName or for neither of them.

Type: String

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

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

Required: No

serviceSpec

The service spec that you want the component to use to access service inputs. Set this only when the component is attached to a service instance.

Type: String

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

Required: No

templateFile

A path to the Infrastructure as Code (IaC) file describing infrastructure that a custom component provisions.

Note

Components support a single IaC file, even if you use Terraform as your template language.

Type: String

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

Required: No

Response Syntax


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

component

The detailed data of the updated component.

Type: Component object

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

ConflictException

The request couldn't be made due to a conflicting operation or resource.

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

ServiceQuotaExceededException

A quota was exceeded. For more information, see AWS Proton Quotas in the AWS Proton User Guide.

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