AWS Proton
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.…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
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…
Endpoints 87
Environment account connection
- POSTAccept environment account connection
/#X-Amz-Target=AwsProton20200720.AcceptEnvironmentAccountConnectionDeprecated. In a management account, an environment account connection request is accepted. When the environment account connection request is accepted,… - POSTCreate environment account connection
/#X-Amz-Target=AwsProton20200720.CreateEnvironmentAccountConnectionDeprecated. Create an environment account connection in an environment account so that environment infrastructure resources can be provisioned in the… - POSTDelete environment account connection
/#X-Amz-Target=AwsProton20200720.DeleteEnvironmentAccountConnectionDeprecated. In an environment account, delete an environment account connection. After you delete an environment account connection that’s in use by an Proton… - POSTGet environment account connection
/#X-Amz-Target=AwsProton20200720.GetEnvironmentAccountConnectionDeprecated. In an environment account, get the detailed data for an environment account connection. For more information, see Environment account connections… - POSTList environment account connections
/#X-Amz-Target=AwsProton20200720.ListEnvironmentAccountConnectionsDeprecated. View a list of environment account connections. For more information, see Environment account connections in the Proton User guide . - POSTReject environment account connection
/#X-Amz-Target=AwsProton20200720.RejectEnvironmentAccountConnectionDeprecated. In a management account, reject an environment account connection from another environment account. After you reject an environment account… - POSTUpdate environment account connection
/#X-Amz-Target=AwsProton20200720.UpdateEnvironmentAccountConnectionDeprecated. In an environment account, update an environment account connection to use a new IAM role. For more information, see Environment account…
Component
- POSTCreate component
/#X-Amz-Target=AwsProton20200720.CreateComponentDeprecated. Create an Proton component. A component is an infrastructure extension for a service instance. For more information about components, see Proton… - POSTDelete component
/#X-Amz-Target=AwsProton20200720.DeleteComponentDeprecated. Delete an Proton component resource. For more information about components, see Proton components in the Proton User Guide . - POSTGet component
/#X-Amz-Target=AwsProton20200720.GetComponentDeprecated. Get detailed data for a component. For more information about components, see Proton components in the Proton User Guide . - POSTList components
/#X-Amz-Target=AwsProton20200720.ListComponentsDeprecated. List components with summary data. You can filter the result list by environment, service, or a single service instance. For more information… - POSTUpdate component
/#X-Amz-Target=AwsProton20200720.UpdateComponentDeprecated. 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…
Environment
- POSTCreate environment
/#X-Amz-Target=AwsProton20200720.CreateEnvironmentDeprecated. Deploy a new environment. An Proton environment is created from an environment template that defines infrastructure and resources that can be… - POSTDelete environment
/#X-Amz-Target=AwsProton20200720.DeleteEnvironmentDeprecated. Delete an environment. - POSTGet environment
/#X-Amz-Target=AwsProton20200720.GetEnvironmentDeprecated. Get detailed data for an environment. - POSTList environments
/#X-Amz-Target=AwsProton20200720.ListEnvironmentsDeprecated. List environments with detail data summaries. - POSTUpdate environment
/#X-Amz-Target=AwsProton20200720.UpdateEnvironmentDeprecated. Update an environment. If the environment is associated with an environment account connection, don't update or include the protonServiceRoleArn…
Environment template
- POSTCreate environment template
/#X-Amz-Target=AwsProton20200720.CreateEnvironmentTemplateDeprecated. Create an environment template for Proton. For more information, see Environment Templates in the Proton User Guide . You can create an… - POSTDelete environment template
/#X-Amz-Target=AwsProton20200720.DeleteEnvironmentTemplateDeprecated. If no other major or minor versions of an environment template exist, delete the environment template. - POSTGet environment template
/#X-Amz-Target=AwsProton20200720.GetEnvironmentTemplateDeprecated. Get detailed data for an environment template. - POSTList environment templates
/#X-Amz-Target=AwsProton20200720.ListEnvironmentTemplatesDeprecated. List environment templates. - POSTUpdate environment template
/#X-Amz-Target=AwsProton20200720.UpdateEnvironmentTemplateDeprecated. Update an environment template.
Environment template version
- POSTCreate environment template version
/#X-Amz-Target=AwsProton20200720.CreateEnvironmentTemplateVersionDeprecated. 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… - POSTDelete environment template version
/#X-Amz-Target=AwsProton20200720.DeleteEnvironmentTemplateVersionDeprecated. If no other minor versions of an environment template exist, delete a major version of the environment template if it's not the Recommended… - POSTGet environment template version
/#X-Amz-Target=AwsProton20200720.GetEnvironmentTemplateVersionDeprecated. Get detailed data for a major or minor version of an environment template. - POSTList environment template versions
/#X-Amz-Target=AwsProton20200720.ListEnvironmentTemplateVersionsDeprecated. List major or minor versions of an environment template with detail data. - POSTUpdate environment template version
/#X-Amz-Target=AwsProton20200720.UpdateEnvironmentTemplateVersionDeprecated. Update a major or minor version of an environment template.
Repository
- POSTCreate repository
/#X-Amz-Target=AwsProton20200720.CreateRepositoryDeprecated. Create and register a link to a repository. Proton uses the link to repeatedly access the repository, to either push to it (self-managed… - POSTDelete repository
/#X-Amz-Target=AwsProton20200720.DeleteRepositoryDeprecated. De-register and unlink your repository. - POSTGet repository
/#X-Amz-Target=AwsProton20200720.GetRepositoryDeprecated. Get detail data for a linked repository. - POSTList repositories
/#X-Amz-Target=AwsProton20200720.ListRepositoriesDeprecated. List linked repositories with detail data.
Service
- POSTCreate service
/#X-Amz-Target=AwsProton20200720.CreateServiceDeprecated. Create an Proton service. An Proton service is an instantiation of a service template and often includes several service instances and pipeline.… - POSTDelete service
/#X-Amz-Target=AwsProton20200720.DeleteServiceDeprecated. Delete a service, with its instances and pipeline. You can't delete a service if it has any service instances that have components attached to… - POSTGet service
/#X-Amz-Target=AwsProton20200720.GetServiceDeprecated. Get detailed data for a service. - POSTList services
/#X-Amz-Target=AwsProton20200720.ListServicesDeprecated. List services with summaries of detail data. - POSTUpdate service
/#X-Amz-Target=AwsProton20200720.UpdateServiceDeprecated. 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…
Service instance
- POSTCreate service instance
/#X-Amz-Target=AwsProton20200720.CreateServiceInstanceDeprecated. Create a service instance. - POSTGet service instance
/#X-Amz-Target=AwsProton20200720.GetServiceInstanceDeprecated. Get detailed data for a service instance. A service instance is an instantiation of service template and it runs in a specific environment. - POSTList service instances
/#X-Amz-Target=AwsProton20200720.ListServiceInstancesDeprecated. List service instances with summary data. This action lists service instances of all services in the Amazon Web Services account. - POSTUpdate service instance
/#X-Amz-Target=AwsProton20200720.UpdateServiceInstanceDeprecated. Update a service instance. There are a few modes for updating a service instance. The deploymentType field defines the mode. You can't update a…
Service sync config
- POSTCreate service sync config
/#X-Amz-Target=AwsProton20200720.CreateServiceSyncConfigDeprecated. Create the Proton Ops configuration file. - POSTDelete service sync config
/#X-Amz-Target=AwsProton20200720.DeleteServiceSyncConfigDeprecated. Delete the Proton Ops file. - POSTGet service sync config
/#X-Amz-Target=AwsProton20200720.GetServiceSyncConfigDeprecated. Get detailed information for the service sync configuration. - POSTUpdate service sync config
/#X-Amz-Target=AwsProton20200720.UpdateServiceSyncConfigDeprecated. Update the Proton Ops config file.
Service template
- POSTCreate service template
/#X-Amz-Target=AwsProton20200720.CreateServiceTemplateDeprecated. Create a service template. The administrator creates a service template to define standardized infrastructure and an optional CI/CD service… - POSTDelete service template
/#X-Amz-Target=AwsProton20200720.DeleteServiceTemplateDeprecated. If no other major or minor versions of the service template exist, delete the service template. - POSTGet service template
/#X-Amz-Target=AwsProton20200720.GetServiceTemplateDeprecated. Get detailed data for a service template. - POSTList service templates
/#X-Amz-Target=AwsProton20200720.ListServiceTemplatesDeprecated. List service templates with detail data. - POSTUpdate service template
/#X-Amz-Target=AwsProton20200720.UpdateServiceTemplateDeprecated. Update a service template.
Service template version
- POSTCreate service template version
/#X-Amz-Target=AwsProton20200720.CreateServiceTemplateVersionDeprecated. 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… - POSTDelete service template version
/#X-Amz-Target=AwsProton20200720.DeleteServiceTemplateVersionDeprecated. 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… - POSTGet service template version
/#X-Amz-Target=AwsProton20200720.GetServiceTemplateVersionDeprecated. Get detailed data for a major or minor version of a service template. - POSTList service template versions
/#X-Amz-Target=AwsProton20200720.ListServiceTemplateVersionsDeprecated. List major or minor versions of a service template with detail data. - POSTUpdate service template version
/#X-Amz-Target=AwsProton20200720.UpdateServiceTemplateVersionDeprecated. Update a major or minor version of a service template.
Template sync config
- POSTCreate template sync config
/#X-Amz-Target=AwsProton20200720.CreateTemplateSyncConfigDeprecated. Set up a template to create new template versions automatically by tracking a linked repository. A linked repository is a repository that has been… - POSTDelete template sync config
/#X-Amz-Target=AwsProton20200720.DeleteTemplateSyncConfigDeprecated. Delete a template sync configuration. - POSTGet template sync config
/#X-Amz-Target=AwsProton20200720.GetTemplateSyncConfigDeprecated. Get detail data for a template sync configuration. - POSTUpdate template sync config
/#X-Amz-Target=AwsProton20200720.UpdateTemplateSyncConfigDeprecated. Update template sync configuration parameters, except for the templateName and templateType . Repository details (branch, name, and provider)…
Deployment
- POSTDelete deployment
/#X-Amz-Target=AwsProton20200720.DeleteDeploymentDeprecated. Delete the deployment. - POSTGet deployment
/#X-Amz-Target=AwsProton20200720.GetDeploymentDeprecated. Get detailed data for a deployment. - POSTList deployments
/#X-Amz-Target=AwsProton20200720.ListDeploymentsDeprecated. List deployments. You can filter the result list by environment, service, or a single service instance.
Account settings
- POSTGet account settings
/#X-Amz-Target=AwsProton20200720.GetAccountSettingsDeprecated. Get detail data for Proton account-wide settings. - POSTUpdate account settings
/#X-Amz-Target=AwsProton20200720.UpdateAccountSettingsDeprecated. Update Proton settings that are used for multiple services in the Amazon Web Services account.
Service sync blocker
- POSTGet service sync blocker summary
/#X-Amz-Target=AwsProton20200720.GetServiceSyncBlockerSummaryDeprecated. Get detailed data for the service sync blocker summary. - POSTUpdate service sync blocker
/#X-Amz-Target=AwsProton20200720.UpdateServiceSyncBlockerDeprecated. Update the service sync blocker by resolving it.
Component output
- POSTList component outputs
/#X-Amz-Target=AwsProton20200720.ListComponentOutputsDeprecated. Get a list of component Infrastructure as Code (IaC) outputs. For more information about components, see Proton components in the Proton User…
Component provisioned
- POSTList component provisioned resources
/#X-Amz-Target=AwsProton20200720.ListComponentProvisionedResourcesDeprecated. List provisioned resources for a component with details. For more information about components, see Proton components in the Proton User Guide .
Environment output
- POSTList environment outputs
/#X-Amz-Target=AwsProton20200720.ListEnvironmentOutputsDeprecated. List the infrastructure as code outputs for your environment.
Environment provisioned
- POSTList environment provisioned resources
/#X-Amz-Target=AwsProton20200720.ListEnvironmentProvisionedResourcesDeprecated. List the provisioned resources for your environment.
Service instance output
- POSTList service instance outputs
/#X-Amz-Target=AwsProton20200720.ListServiceInstanceOutputsDeprecated. Get a list service of instance Infrastructure as Code (IaC) outputs.
Service instance provisioned
- POSTList service instance provisioned resources
/#X-Amz-Target=AwsProton20200720.ListServiceInstanceProvisionedResourcesDeprecated. List provisioned resources for a service instance with details.
Service pipeline output
- POSTList service pipeline outputs
/#X-Amz-Target=AwsProton20200720.ListServicePipelineOutputsDeprecated. Get a list of service pipeline Infrastructure as Code (IaC) outputs.
Service pipeline provisioned
- POSTList service pipeline provisioned resources
/#X-Amz-Target=AwsProton20200720.ListServicePipelineProvisionedResourcesDeprecated. List provisioned resources for a service and pipeline with details.
Service pipeline
- POSTUpdate service pipeline
/#X-Amz-Target=AwsProton20200720.UpdateServicePipelineDeprecated. Update the service pipeline. There are four modes for updating a service pipeline. The deploymentType field defines the mode. NONE In this mode, a…
- POSTCancel component deployment
/#X-Amz-Target=AwsProton20200720.CancelComponentDeploymentDeprecated. Attempts to cancel a component deployment (for a component that is in the IN_PROGRESS deployment status). For more information about components,… - POSTCancel environment deployment
/#X-Amz-Target=AwsProton20200720.CancelEnvironmentDeploymentDeprecated. Attempts to cancel an environment deployment on an UpdateEnvironment action, if the deployment is IN_PROGRESS . For more information, see Update… - POSTCancel service instance deployment
/#X-Amz-Target=AwsProton20200720.CancelServiceInstanceDeploymentDeprecated. Attempts to cancel a service instance deployment on an UpdateServiceInstance action, if the deployment is IN_PROGRESS . For more information, see… - POSTCancel service pipeline deployment
/#X-Amz-Target=AwsProton20200720.CancelServicePipelineDeploymentDeprecated. Attempts to cancel a service pipeline deployment on an UpdateServicePipeline action, if the deployment is IN_PROGRESS . For more information, see… - POSTGet repository sync status
/#X-Amz-Target=AwsProton20200720.GetRepositorySyncStatusDeprecated. Get the sync status of a repository used for Proton template sync. For more information about template sync, see . A repository sync status isn't… - POSTGet resources summary
/#X-Amz-Target=AwsProton20200720.GetResourcesSummaryDeprecated. Get counts of Proton resources. For infrastructure-provisioning resources (environments, services, service instances, pipelines), the action… - POSTGet service instance sync status
/#X-Amz-Target=AwsProton20200720.GetServiceInstanceSyncStatusDeprecated. Get the status of the synced service instance. - POSTGet template sync status
/#X-Amz-Target=AwsProton20200720.GetTemplateSyncStatusDeprecated. Get the status of a template sync. - POSTList repository sync definitions
/#X-Amz-Target=AwsProton20200720.ListRepositorySyncDefinitionsDeprecated. List repository sync definitions with detail data. - POSTList tags for resource
/#X-Amz-Target=AwsProton20200720.ListTagsForResourceDeprecated. List tags for a resource. For more information, see Proton resources and tagging in the Proton User Guide . - POSTNotify resource deployment status change
/#X-Amz-Target=AwsProton20200720.NotifyResourceDeploymentStatusChangeDeprecated. Notify Proton of status changes to a provisioned resource when you use self-managed provisioning. For more information, see Self-managed… - POSTTag resource
/#X-Amz-Target=AwsProton20200720.TagResourceDeprecated. Tag a resource. A tag is a key-value pair of metadata that you associate with an Proton resource. For more information, see Proton resources and… - POSTUntag resource
/#X-Amz-Target=AwsProton20200720.UntagResourceDeprecated. Remove a customer tag from a resource. A tag is a key-value pair of metadata associated with an Proton resource. For more information, see Proton…
API details
- Base URL
https://proton.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 87 operations on 87 pathsPOST 87
87 marked deprecated - Main resources
- Environment account connection 7Component 5Environment 5Environment template 5Environment template version 5Service 5Service template 5Service template version 5Repository 4Service instance 4
- Description format
- AWS Smithy model, API version
2020-07-20 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the AWS Proton in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the AWS Proton collection, without the publisher's secrets.
- Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Accept environment account connection” (POST /#X-Amz-Target=AwsProton20200720.AcceptEnvironmentAccountConnection), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the AWS Proton?
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.… It is listed under Developer tools and has 87 endpoints.
Who publishes the AWS Proton?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the AWS Proton?
Requests go to https://proton.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the AWS Proton?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the AWS Proton have?
87 operations on 87 paths (87 POST). The largest groups are Environment account connection, Component, Environment, Environment template.
Is forking the AWS Proton free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.