View Source aws_proton (aws v0.5.0)
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 administration, see the Proton Administrator Guide.
To learn more about deploying serverless and containerized applications on 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
Link to this section Summary
Functions
In a management account, an environment account connection request is accepted.
Attempts to cancel an environment deployment on an UpdateEnvironment action, if the deployment is IN_PROGRESS.
Attempts to cancel a service instance deployment on an UpdateServiceInstance action, if the deployment is IN_PROGRESS.
Attempts to cancel a service pipeline deployment on an UpdateServicePipeline action, if the deployment is IN_PROGRESS.
Deploy a new environment.
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.
Create a new major or minor version of an environment template.
Create and register a link to a repository that can be used with pull request provisioning or template sync configurations.
Create an Proton service.
Create a service template.
Create a new major or minor version of a service template.
Set up a template for automated template version creation.
In an environment account, delete an environment account connection.
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.
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.
In an environment account, view the detail data for an environment account connection.
Get detail data for a service instance.
View a list of environment account connections.
List tags for a resource.
Notify Proton of status changes to a provisioned resource when you use pull request provisioning.
In a management account, reject an environment account connection from another environment account.
Tag a resource.
Remove a tag from a resource.
Update an environment.
In an environment account, update an environment account connection to use a new IAM role.
Edit a service description or use a spec to add and delete service instances.
Update a service instance.
Update the service pipeline.
templateName and templateType.Link to this section 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.
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
UpdateEnvironmentaction succeeds before the cancellation attempt starts, the resulting deployment state isSUCCEEDEDand 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
UpdateServiceInstanceaction succeeds before the cancellation attempt starts, the resulting deployment state isSUCCEEDEDand 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
UpdateServicePipelineaction succeeds before the cancellation attempt starts, the resulting deployment state isSUCCEEDEDand 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.
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
provisioningparameter and set the value toCUSTOMER_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.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 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.
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.
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.
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.
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 a service instance.
A service instance is an instantiation of service template, which is running in a specific environment.View a list of environment account connections.
For more information, see Environment account connections in the Proton Administrator guide.list_service_instance_provisioned_resources(Client, Input, Options)
View Sourcelist_service_pipeline_provisioned_resources(Client, Input, Options)
View SourceList 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.
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 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.
NONEIn this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.
CURRENT_VERSIONIn 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_VERSIONIn 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_VERSIONIn 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.Edit a service description or use a spec to add and delete service instances.
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.
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.
NONEIn this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.
CURRENT_VERSIONIn 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_VERSIONIn 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_VERSIONIn 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.
NONEIn this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.
CURRENT_VERSIONIn 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_VERSIONIn 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_VERSIONIn 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).
templateName and templateType.