Proton

In a management account, an environment account connection request is accepted. When the environment account connection request is accepted, Proton can use the associated IAM role to provision environment infrastructure resources in the associated environment account.

For more information, see Environment account connections in the Proton Administrator guide.

Attempts to cancel an environment deployment on an "UpdateEnvironment" action, if the deployment is IN_PROGRESS. For more information, see Update an environment in the Proton Administrator guide.

The following list includes potential cancellation scenarios.

• If the cancellation attempt succeeds, the resulting deployment state is CANCELLED.
• If the cancellation attempt fails, the resulting deployment state is FAILED.
• If the current "UpdateEnvironment" action succeeds before the cancellation attempt starts, the resulting deployment state is SUCCEEDED and the cancellation attempt has no effect.

Attempts to cancel a service instance deployment on an "UpdateServiceInstance" action, if the deployment is IN_PROGRESS. For more information, see Update a service instance in the Proton Administrator guide or the Proton User guide.

The following list includes potential cancellation scenarios.

• If the cancellation attempt succeeds, the resulting deployment state is CANCELLED.
• If the cancellation attempt fails, the resulting deployment state is FAILED.
• If the current "UpdateServiceInstance" action succeeds before the cancellation attempt starts, the resulting deployment state is SUCCEEDED and the cancellation attempt has no effect.

Attempts to cancel a service pipeline deployment on an "UpdateServicePipeline" action, if the deployment is IN_PROGRESS. For more information, see Update a service pipeline in the Proton Administrator guide or the Proton User guide.

The following list includes potential cancellation scenarios.

• If the cancellation attempt succeeds, the resulting deployment state is CANCELLED.
• If the cancellation attempt fails, the resulting deployment state is FAILED.
• If the current "UpdateServicePipeline" action succeeds before the cancellation attempt starts, the resulting deployment state is SUCCEEDED and the cancellation attempt has no effect.

Deploy a new environment. An Proton environment is created from an environment template that defines infrastructure and resources that can be shared across services.

You can provision environments using the following methods:

• Standard provisioning: Proton makes direct calls to provision your resources.
• Pull request provisioning: Proton makes pull requests on your repository to provide compiled infrastructure as code (IaC) files that your IaC engine uses to provision resources.

For more information, see the Environments in the Proton Administrator Guide.

Create an environment account connection in an environment account so that environment infrastructure resources can be provisioned in the environment account from a management account.

An environment account connection is a secure bi-directional connection between a management account and an environment account that maintains authorization and permissions. For more information, see Environment account connections in the Proton Administrator guide.

Create an environment template for Proton. For more information, see Environment Templates in the Proton Administrator Guide.

You can create an environment template in one of the two following ways:

• Register and publish a standard environment template that instructs Proton to deploy and manage environment infrastructure.
• Register and publish a customer managed environment template that connects Proton to your existing provisioned infrastructure that you manage. Proton doesn't manage your existing provisioned infrastructure. To create an environment template for customer provisioned and managed infrastructure, include the provisioning parameter and set the value to CUSTOMER_MANAGED. For more information, see Register and publish an environment template in the Proton Administrator Guide.

Create a new major or minor version of an environment template. A major version of an environment template is a version that isn't backwards compatible. A minor version of an environment template is a version that's backwards compatible within its major version.

Create and register a link to a repository that can be used with pull request provisioning or template sync configurations. For more information, see Template bundles and Template sync configurations in the Proton Administrator Guide.

Create an Proton service. An Proton service is an instantiation of a service template and often includes several service instances and pipeline. For more information, see Services in the Proton Administrator Guide and Services in the Proton User Guide.

Create a service template. The administrator creates a service template to define standardized infrastructure and an optional CICD service pipeline. Developers, in turn, select the service template from Proton. If the selected service template includes a service pipeline definition, they provide a link to their source code repository. Proton then deploys and manages the infrastructure defined by the selected service template. For more information, see Service Templates in the Proton Administrator Guide.

Create a new major or minor version of a service template. A major version of a service template is a version that isn't backward compatible. A minor version of a service template is a version that's backward compatible within its major version.

Set up a template for automated template version creation. When a commit is pushed to your registered repository, Proton checks for changes to your repository template bundles. If it detects a template bundle change, a new minor or major version of its template is created, if the version doesn’t already exist. For more information, see Template sync configurations in the Proton Administrator Guide.

Delete an environment.

In an environment account, delete an environment account connection.

After you delete an environment account connection that’s in use by an Proton environment, Proton can’t manage the environment infrastructure resources until a new environment account connection is accepted for the environment account and associated environment. You're responsible for cleaning up provisioned resources that remain without an environment connection.

For more information, see Environment account connections in the Proton Administrator guide.

If no other major or minor versions of an environment template exist, delete the environment template.

If no other minor versions of an environment template exist, delete a major version of the environment template if it's not the Recommended version. Delete the Recommended version of the environment template if no other major versions or minor versions of the environment template exist. A major version of an environment template is a version that's not backward compatible.

Delete a minor version of an environment template if it isn't the Recommended version. Delete a Recommended minor version of the environment template if no other minor versions of the environment template exist. A minor version of an environment template is a version that's backward compatible.

De-register and unlink your repository.

Delete a service.

If no other major or minor versions of the service template exist, delete the service template.

If no other minor versions of a service template exist, delete a major version of the service template if it's not the Recommended version. Delete the Recommended version of the service template if no other major versions or minor versions of the service template exist. A major version of a service template is a version that isn't backwards compatible.

Delete a minor version of a service template if it's not the Recommended version. Delete a Recommended minor version of the service template if no other minor versions of the service template exist. A minor version of a service template is a version that's backwards compatible.

Delete a template sync configuration.

Get detail data for the Proton pipeline service role.

Get detail data for an environment.

In an environment account, view the detail data for an environment account connection.

For more information, see Environment account connections in the Proton Administrator guide.

Get detail data for an environment template.

View detail data for a major or minor version of an environment template.

Get detail data for a repository.

Get the repository sync status.

Get detail data for a service.

Get detail data for a service instance. A service instance is an instantiation of service template, which is running in a specific environment.

Get detail data for a service template.

View detail data for a major or minor version of a service template.

Get detail data for a template sync configuration.

Get the status of a template sync.

View a list of environment account connections.

For more information, see Environment account connections in the Proton Administrator guide.

List the infrastructure as code outputs for your environment.

List the provisioned resources for your environment.

List environments with detail data summaries.

List environment templates.

List major or minor versions of an environment template with detail data.

List repositories with detail data.

List repository sync definitions with detail data.

View a list service instance infrastructure as code outputs with detail data.

List provisioned resources for a service instance with details.

List service instances with summaries of detail data.

View a list service pipeline infrastructure as code outputs with detail.

List provisioned resources for a service and pipeline with details.

List services with summaries of detail data.

List service templates with detail data.

List major or minor versions of a service template with detail data.

List tags for a resource. For more information, see Proton resources and tagging in the Proton Administrator Guide or Proton User Guide.

Notify Proton of status changes to a provisioned resource when you use pull request provisioning. For more information, see Template bundles.

! IMPORTANT: ! Provisioning by pull request is currently in feature preview and is only usable with Terraform based Proton Templates. ! To learn more about Amazon Web Services Feature Preview terms, see section 2 on Beta and Previews.

In a management account, reject an environment account connection from another environment account.

After you reject an environment account connection request, you won’t be able to accept or use the rejected environment account connection.

You can’t reject an environment account connection that is connected to an environment.

For more information, see Environment account connections in the Proton Administrator guide.

Tag a resource. For more information, see Proton resources and tagging in the Proton Administrator Guide or Proton User Guide.

Remove a tag from a resource. For more information, see Proton resources and tagging in the Proton Administrator Guide or Proton User Guide.

Update the Proton service pipeline role or repository settings.

Update an environment.

If the environment is associated with an environment account connection, don't update or include the protonServiceRoleArn and provisioningRepository parameter to update or connect to an environment account connection.

You can only update to a new environment account connection if it was created in the same environment account that the current environment account connection was created in and is associated with the current environment.

If the environment isn't associated with an environment account connection, don't update or include the environmentAccountConnectionId parameter to update or connect to an environment account connection.

You can update either the environmentAccountConnectionId or protonServiceRoleArn parameter and value. You can’t update both.

If the environment was provisioned with pull request provisioning, include the provisioningRepository parameter and omit the protonServiceRoleArn and environmentAccountConnectionId parameters.

If the environment wasn't provisioned with pull request provisioning, omit the provisioningRepository parameter.

There are four modes for updating an environment as described in the following. The deploymentType field defines the mode.

NONE

In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.

: CURRENT_VERSION In this mode, the environment is deployed and updated with the new spec that you provide. Only requested parameters are updated. Don’t include minor or major version parameters when you use this deployment-type.

MINOR_VERSION

In this mode, the environment is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can also specify a different minor version of the current major version in use.

: MAJOR_VERSION In this mode, the environment is deployed and updated with the published, recommended (latest) major and minor version of the current template, by default. You can also specify a different major version that's higher than the major version in use and a minor version (optional).

In an environment account, update an environment account connection to use a new IAM role.

For more information, see Environment account connections in the Proton Administrator guide.

Update an environment template.

Update a major or minor version of an environment template.

Edit a service description or use a spec to add and delete service instances.

Note: Existing service instances and the service pipeline can't be edited using this API. They can only be deleted.

Use the description parameter to modify the description.

Edit the spec parameter to add or delete instances.

Update a service instance.

There are four modes for updating a service instance as described in the following. The deploymentType field defines the mode.

NONE

In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.

: CURRENT_VERSION In this mode, the service instance is deployed and updated with the new spec that you provide. Only requested parameters are updated. Don’t include minor or major version parameters when you use this deployment-type.

MINOR_VERSION

In this mode, the service instance is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can also specify a different minor version of the current major version in use.

: MAJOR_VERSION In this mode, the service instance is deployed and updated with the published, recommended (latest) major and minor version of the current template, by default. You can also specify a different major version that is higher than the major version in use and a minor version (optional).

Update the service pipeline.

There are four modes for updating a service pipeline as described in the following. The deploymentType field defines the mode.

NONE

In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.

: CURRENT_VERSION In this mode, the service pipeline is deployed and updated with the new spec that you provide. Only requested parameters are updated. Don’t include minor or major version parameters when you use this deployment-type.

MINOR_VERSION

In this mode, the service pipeline is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can also specify a different minor version of the current major version in use.

: MAJOR_VERSION In this mode, the service pipeline is deployed and updated with the published, recommended (latest) major and minor version of the current template by default. You can also specify a different major version that is higher than the major version in use and a minor version (optional).

Update a service template.

Update a major or minor version of a service template.

Update template sync configuration parameters, except for the templateName and templateType.

Wait until an Environment is deployed. Use this after invoking CreateEnvironment or UpdateEnvironment Checks state up to 999 times, 5 seconds apart (about 84 minutes max wait time).

Wait until an EnvironmentTemplateVersion is registered. Use this after invoking CreateEnvironmentTemplateVersion Checks state up to 150 times, 2 seconds apart (about 5 minutes max wait time).

Wait until an Service has deployed its instances and possibly pipeline. Use this after invoking CreateService Checks state up to 999 times, 5 seconds apart (about 84 minutes max wait time).

Wait until a Service, its instances, and possibly pipeline have been deleted after DeleteService is invoked Checks state up to 999 times, 5 seconds apart (about 84 minutes max wait time).

Wait until a ServiceInstance is deployed. Use this after invoking CreateService or UpdateServiceInstance Checks state up to 999 times, 5 seconds apart (about 84 minutes max wait time).

Wait until an ServicePipeline is deployed. Use this after invoking CreateService or UpdateServicePipeline Checks state up to 360 times, 10 seconds apart (about 60 minutes max wait time).

Wait until a ServiceTemplateVersion is registered. Use this after invoking CreateServiceTemplateVersion Checks state up to 150 times, 2 seconds apart (about 5 minutes max wait time).

Wait until a Service, its instances, and possibly pipeline have been deployed after UpdateService is invoked Checks state up to 999 times, 5 seconds apart (about 84 minutes max wait time).