Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1484319348.7 KB

Update a component.

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

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 Proton components in the Proton User Guide.

post/#X-Amz-Target=AwsProton20200720.UpdateComponent

Headers

X-Amz-Target'AwsProton20200720.UpdateComponent' required

Request body

clientTokenstring

The client token for the updated component.

deploymentType'NONE' | 'CURRENT_VERSION' required
<p>The deployment type. It defines the mode for updating a component, as follows:</p> <dl> <dt/> <dd> <p> <code>NONE</code> </p> <p>In this mode, a deployment <i>doesn't</i> occur. Only the requested metadata parameters are updated. You can only specify <code>description</code> in this mode.</p> </dd> <dt/> <dd> <p> <code>CURRENT_VERSION</code> </p> <p>In this mode, the component is deployed and updated with the new <code>serviceSpec</code>, <code>templateSource</code>, and/or <code>type</code> that you provide. Only requested parameters are updated.</p> </dd> </dl>
descriptionstring password

An optional customer-provided description of the component.

namestring required

The name of the component to update.

serviceInstanceNamestring

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 <code>serviceInstanceName</code> and <code>serviceName</code> or for neither of them.

serviceNamestring

The name of the service that <code>serviceInstanceName</code> 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 <code>serviceInstanceName</code> and <code>serviceName</code> or for neither of them.

serviceSpecstring password

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.

templateFilestring password
<p>A path to the Infrastructure as Code (IaC) file describing infrastructure that a custom component provisions.</p> <note> <p>Components support a single IaC file, even if you use Terraform as your template language.</p> </note>

Response

Success