ProtonClient
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.
The documentation for each action shows the Query API request parameters and the XML response.
Alternatively, you can use the Amazon Web Services CLI to access an API. For more information, see the Amazon Web Services Command Line Interface User Guide.
The Proton service is a two-pronged automation framework. Administrators create service templates to provide standardized infrastructure and deployment tooling for serverless and container based applications. Developers, in turn, select from the available service templates to automate their application or service deployments.
Because administrators define the infrastructure and tooling that Proton deploys and manages, they need permissions to use all of the listed API operations.
When developers select a specific infrastructure and tooling set, Proton deploys their applications. To monitor their applications that are running on Proton, developers need permissions to the service create, list, update and delete API operations and the service instance list and update API operations.
To learn more about Proton, see the Proton User Guide.
Ensuring Idempotency
When you make a mutating API request, the request typically returns a result before the asynchronous workflows of the operation are complete. Operations might also time out or encounter other server issues before they're complete, even if the request already returned a result. This might make it difficult to determine whether the request succeeded. Moreover, you might need to retry the request multiple times to ensure that the operation completes successfully. However, if the original request and the subsequent retries are successful, the operation occurs multiple times. This means that you might create more resources than you intended.
Idempotency ensures that an API request action completes no more than one time. With an idempotent request, if the original request action completes successfully, any subsequent retries complete successfully without performing any further actions. However, the result might contain updated information, such as the current creation status.
The following lists of APIs are grouped according to methods that ensure idempotency.
Idempotent create APIs with a client token
The API actions in this list support idempotency with the use of a client token. The corresponding Amazon Web Services CLI commands also support idempotency using a client token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. To make an idempotent API request using one of these actions, specify a client token in the request. We recommend that you don't reuse the same client token for other API requests. If you don’t provide a client token for these APIs, a default client token is automatically provided by SDKs.
Given a request action that has succeeded:
If you retry the request using the same client token and the same parameters, the retry succeeds without performing any further actions other than returning the original resource detail data in the response.
If you retry the request using the same client token, but one or more of the parameters are different, the retry throws a ValidationException with an IdempotentParameterMismatch error.
Client tokens expire eight hours after a request is made. If you retry the request with the expired token, a new resource is created.
If the original resource is deleted and you retry the request, a new resource is created.
Idempotent create APIs with a client token:
CreateEnvironmentTemplateVersion
CreateServiceTemplateVersion
CreateEnvironmentAccountConnection
Idempotent create APIs
Given a request action that has succeeded:
If you retry the request with an API from this group, and the original resource hasn't been modified, the retry succeeds without performing any further actions other than returning the original resource detail data in the response.
If the original resource has been modified, the retry throws a ConflictException.
If you retry with different input parameters, the retry throws a ValidationException with an IdempotentParameterMismatch error.
Idempotent create APIs:
CreateEnvironmentTemplate
CreateServiceTemplate
CreateEnvironment
CreateService
Idempotent delete APIs
Given a request action that has succeeded:
When you retry the request with an API from this group and the resource was deleted, its metadata is returned in the response.
If you retry and the resource doesn't exist, the response is empty.
In both cases, the retry succeeds.
Idempotent delete APIs:
DeleteEnvironmentTemplate
DeleteEnvironmentTemplateVersion
DeleteServiceTemplate
DeleteServiceTemplateVersion
DeleteEnvironmentAccountConnection
Asynchronous idempotent delete APIs
Given a request action that has succeeded:
If you retry the request with an API from this group, if the original request delete operation status is DELETE_IN_PROGRESS, the retry returns the resource detail data in the response without performing any further actions.
If the original request delete operation is complete, a retry returns an empty response.
Asynchronous idempotent delete APIs:
DeleteEnvironment
DeleteService
Functions
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.
Inherited functions
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.
Paginate over ListComponentOutputsResponse results.
List provisioned resources for a component with details.
Paginate over ListComponentProvisionedResourcesResponse results.
List components with summary data. You can filter the result list by environment, service, or a single service instance.
Paginate over ListComponentsResponse results.
List deployments. You can filter the result list by environment, service, or a single service instance.
Paginate over ListDeploymentsResponse results.
View a list of environment account connections.
Paginate over ListEnvironmentAccountConnectionsResponse results.
List the infrastructure as code outputs for your environment.
Paginate over ListEnvironmentOutputsResponse results.
List the provisioned resources for your environment.
Paginate over ListEnvironmentProvisionedResourcesResponse results.
List environments with detail data summaries.
Paginate over ListEnvironmentsResponse results.
List environment templates.
Paginate over ListEnvironmentTemplatesResponse results.
List major or minor versions of an environment template with detail data.
Paginate over ListEnvironmentTemplateVersionsResponse results.
List linked repositories with detail data.
Paginate over ListRepositoriesResponse results.
List repository sync definitions with detail data.
Paginate over ListRepositorySyncDefinitionsResponse results.
Get a list service of instance Infrastructure as Code (IaC) outputs.
Paginate over ListServiceInstanceOutputsResponse results.
List provisioned resources for a service instance with details.
Paginate over ListServiceInstanceProvisionedResourcesResponse results.
List service instances with summary data. This action lists service instances of all services in the Amazon Web Services account.
Paginate over ListServiceInstancesResponse results.
Get a list of service pipeline Infrastructure as Code (IaC) outputs.
Paginate over ListServicePipelineOutputsResponse results.
List provisioned resources for a service and pipeline with details.
Paginate over ListServicePipelineProvisionedResourcesResponse results.
List services with summaries of detail data.
Paginate over ListServicesResponse results.
List service templates with detail data.
Paginate over ListServiceTemplatesResponse results.
List major or minor versions of a service template with detail data.
Paginate over ListServiceTemplateVersionsResponse results.
List tags for a resource. For more information, see Proton resources and tagging in the Proton User Guide.
Paginate over ListTagsForResourceResponse results.
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.
Wait until a Component is deleted. Use this after invoking DeleteComponent
Wait until a Component is deployed. Use this after invoking CreateComponent or UpdateComponent
Wait until an Environment is deployed. Use this after invoking CreateEnvironment or UpdateEnvironment
Wait until an EnvironmentTemplateVersion is registered. Use this after invoking CreateEnvironmentTemplateVersion
Wait until an Service has deployed its instances and possibly pipeline. Use this after invoking CreateService
Wait until a Service, its instances, and possibly pipeline have been deleted after DeleteService is invoked
Wait until a ServiceInstance is deployed. Use this after invoking CreateService or UpdateServiceInstance
Wait until an ServicePipeline is deployed. Use this after invoking CreateService or UpdateServicePipeline
Wait until a ServiceTemplateVersion is registered. Use this after invoking CreateServiceTemplateVersion
Wait until a Service, its instances, and possibly pipeline have been deployed after UpdateService is invoked
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.