Package-level declarations

This is the Proton Service API Reference. It provides descriptions, syntax and usage examples for each of the actions and data types for the Proton service.

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.

Attempts to cancel a component deployment (for a component that is in the IN_PROGRESS deployment status).

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 User guide.

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 User guide.

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 User guide.

Create an Proton component. A component is an infrastructure extension for a service instance.

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

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.

Create an environment template for Proton. For more information, see Environment Templates in the Proton User 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. Proton uses the link to repeatedly access the repository, to either push to it (self-managed provisioning) or pull from it (template sync). You can share a linked repository across multiple resources (like environments using self-managed provisioning, or synced templates). When you create a repository link, Proton creates a service-linked role for you.

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 User Guide.

Create a service instance.

Create the Proton Ops configuration file.

Create a service template. The administrator creates a service template to define standardized infrastructure and an optional CI/CD 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 Proton templates in the Proton User 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 to create new template versions automatically by tracking a linked repository. A linked repository is a repository that has been registered with Proton. For more information, see CreateRepository.

Delete an Proton component resource.

Delete the deployment.

Delete an environment.

In an environment account, delete an environment account connection.

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.

De-register and unlink your repository.

Delete a service, with its instances and pipeline.

Delete the Proton Ops file.

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 template sync configuration.

Get detail data for Proton account-wide settings.

Get detailed data for a component.

Get detailed data for a deployment.

Get detailed data for an environment.

In an environment account, get the detailed data for an environment account connection.

Get detailed data for an environment template.

Get detailed data for a major or minor version of an environment template.

Get detail data for a linked repository.

Get the sync status of a repository used for Proton template sync. For more information about template sync, see .

Get counts of Proton resources.

Get detailed data for a service.

Get detailed data for a service instance. A service instance is an instantiation of service template and it runs in a specific environment.

Get the status of the synced service instance.

Get detailed data for the service sync blocker summary.

Get detailed information for the service sync configuration.

Get detailed data for a service template.

Get detailed 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.

Get a list of component Infrastructure as Code (IaC) outputs.

List provisioned resources for a component with details.

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

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

View a list of environment account connections.

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 linked repositories with detail data.

List repository sync definitions with detail data.

Get a list service of instance Infrastructure as Code (IaC) outputs.

List provisioned resources for a service instance with details.

List service instances with summary data. This action lists service instances of all services in the Amazon Web Services account.

Get a list of service pipeline Infrastructure as Code (IaC) outputs.

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 User Guide.

Notify Proton of status changes to a provisioned resource when you use self-managed provisioning.

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

Tag a resource. A tag is a key-value pair of metadata that you associate with an Proton resource.

Remove a customer tag from a resource. A tag is a key-value pair of metadata associated with an Proton resource.

Update Proton settings that are used for multiple services in the Amazon Web Services account.

Update a component.

Update an environment.

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

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.

Update a service instance.

Update the service pipeline.

Update the service sync blocker by resolving it.

Update the Proton Ops config file.

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. Repository details (branch, name, and provider) should be of a linked repository. A linked repository is a repository that has been registered with Proton. For more information, see CreateRepository.

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.