AWS.Proton — AWS SDK for JavaScript (original) (raw)

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

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

Sending a Request Using Proton

var proton = new AWS.Proton();
proton.acceptEnvironmentAccountConnection(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the Proton object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var proton = new AWS.Proton({apiVersion: '2020-07-20'});

You can also set the API version globally in AWS.config.apiVersions using the proton service identifier:

AWS.config.apiVersions = {
  proton: '2020-07-20',
  // other service API versions
};

var proton = new AWS.Proton();

This service supports a list of resource states that can be polled using the waitFor() method. The resource states are:

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

acceptEnvironmentAccountConnection(params = {}, callback) ⇒ AWS.Request

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

cancelComponentDeployment(params = {}, callback) ⇒ AWS.Request

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

For more information about components, see Proton components in the Proton User Guide.

cancelEnvironmentDeployment(params = {}, callback) ⇒ AWS.Request

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.

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.

cancelServiceInstanceDeployment(params = {}, callback) ⇒ AWS.Request

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.

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.

cancelServicePipelineDeployment(params = {}, callback) ⇒ AWS.Request

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.

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.

createComponent(params = {}, callback) ⇒ AWS.Request

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

For more information about components, see Proton components in the Proton User Guide.

createEnvironment(params = {}, callback) ⇒ AWS.Request

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:

• Amazon Web Services-managed provisioning: Proton makes direct calls to provision your resources.
• Self-managed 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 Environments and Provisioning methods in the Proton User Guide.

createEnvironmentAccountConnection(params = {}, callback) ⇒ AWS.Request

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

createEnvironmentTemplate(params = {}, callback) ⇒ AWS.Request

Create an environment template for Proton. For more information, see Environment Templates in the Proton User 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 User Guide.

createEnvironmentTemplateVersion(params = {}, callback) ⇒ AWS.Request

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.

createRepository(params = {}, callback) ⇒ AWS.Request

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.

For more information, see Self-managed provisioning, Template bundles, and Template sync configurations in the Proton User Guide.

createService(params = {}, callback) ⇒ AWS.Request

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.

createServiceInstance(params = {}, callback) ⇒ AWS.Request

Create a service instance.

createServiceSyncConfig(params = {}, callback) ⇒ AWS.Request

Create the Proton Ops configuration file.

createServiceTemplate(params = {}, callback) ⇒ AWS.Request

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.

createServiceTemplateVersion(params = {}, callback) ⇒ AWS.Request

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.

createTemplateSyncConfig(params = {}, callback) ⇒ AWS.Request

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.

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

deleteComponent(params = {}, callback) ⇒ AWS.Request

Delete an Proton component resource.

For more information about components, see Proton components in the Proton User Guide.

deleteDeployment(params = {}, callback) ⇒ AWS.Request

deleteEnvironment(params = {}, callback) ⇒ AWS.Request

deleteEnvironmentAccountConnection(params = {}, callback) ⇒ AWS.Request

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

deleteEnvironmentTemplate(params = {}, callback) ⇒ AWS.Request

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

deleteEnvironmentTemplateVersion(params = {}, callback) ⇒ AWS.Request

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.

deleteRepository(params = {}, callback) ⇒ AWS.Request

De-register and unlink your repository.

deleteService(params = {}, callback) ⇒ AWS.Request

Delete a service, with its instances and pipeline.

Note: You can't delete a service if it has any service instances that have components attached to them. For more information about components, see Proton components in the Proton User Guide.

deleteServiceSyncConfig(params = {}, callback) ⇒ AWS.Request

Delete the Proton Ops file.

deleteServiceTemplate(params = {}, callback) ⇒ AWS.Request

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

deleteServiceTemplateVersion(params = {}, callback) ⇒ AWS.Request

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.

deleteTemplateSyncConfig(params = {}, callback) ⇒ AWS.Request

Delete a template sync configuration.

getAccountSettings(params = {}, callback) ⇒ AWS.Request

Get detail data for Proton account-wide settings.

getComponent(params = {}, callback) ⇒ AWS.Request

Get detailed data for a component.

For more information about components, see Proton components in the Proton User Guide.

getDeployment(params = {}, callback) ⇒ AWS.Request

Get detailed data for a deployment.

getEnvironment(params = {}, callback) ⇒ AWS.Request

Get detailed data for an environment.

getEnvironmentAccountConnection(params = {}, callback) ⇒ AWS.Request

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

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

getEnvironmentTemplate(params = {}, callback) ⇒ AWS.Request

Get detailed data for an environment template.

getEnvironmentTemplateVersion(params = {}, callback) ⇒ AWS.Request

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

getRepository(params = {}, callback) ⇒ AWS.Request

Get detail data for a linked repository.

getRepositorySyncStatus(params = {}, callback) ⇒ AWS.Request

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

Note: A repository sync status isn't tied to the Proton Repository resource (or any other Proton resource). Therefore, tags on an Proton Repository resource have no effect on this action. Specifically, you can't use these tags to control access to this action using Attribute-based access control (ABAC). For more information about ABAC, see ABAC in the Proton User Guide.

getResourcesSummary(params = {}, callback) ⇒ AWS.Request

Get counts of Proton resources.

For infrastructure-provisioning resources (environments, services, service instances, pipelines), the action returns staleness counts. A resource is stale when it's behind the recommended version of the Proton template that it uses and it needs an update to become current.

The action returns staleness counts (counts of resources that are up-to-date, behind a template major version, or behind a template minor version), the total number of resources, and the number of resources that are in a failed state, grouped by resource type. Components, environments, and service templates return less information - see the components, environments, and serviceTemplates field descriptions.

For context, the action also returns the total number of each type of Proton template in the Amazon Web Services account.

For more information, see Proton dashboard in the Proton User Guide.

getService(params = {}, callback) ⇒ AWS.Request

Get detailed data for a service.

getServiceInstance(params = {}, callback) ⇒ AWS.Request

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

getServiceInstanceSyncStatus(params = {}, callback) ⇒ AWS.Request

Get the status of the synced service instance.

getServiceSyncBlockerSummary(params = {}, callback) ⇒ AWS.Request

Get detailed data for the service sync blocker summary.

getServiceSyncConfig(params = {}, callback) ⇒ AWS.Request

Get detailed information for the service sync configuration.

getServiceTemplate(params = {}, callback) ⇒ AWS.Request

Get detailed data for a service template.

getServiceTemplateVersion(params = {}, callback) ⇒ AWS.Request

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

getTemplateSyncConfig(params = {}, callback) ⇒ AWS.Request

Get detail data for a template sync configuration.

getTemplateSyncStatus(params = {}, callback) ⇒ AWS.Request

Get the status of a template sync.

listComponentOutputs(params = {}, callback) ⇒ AWS.Request

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

For more information about components, see Proton components in the Proton User Guide.

listComponentProvisionedResources(params = {}, callback) ⇒ AWS.Request

List provisioned resources for a component with details.

For more information about components, see Proton components in the Proton User Guide.

listComponents(params = {}, callback) ⇒ AWS.Request

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

For more information about components, see Proton components in the Proton User Guide.

listDeployments(params = {}, callback) ⇒ AWS.Request

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

listEnvironmentAccountConnections(params = {}, callback) ⇒ AWS.Request

listEnvironmentOutputs(params = {}, callback) ⇒ AWS.Request

List the infrastructure as code outputs for your environment.

listEnvironmentProvisionedResources(params = {}, callback) ⇒ AWS.Request

List the provisioned resources for your environment.

listEnvironments(params = {}, callback) ⇒ AWS.Request

List environments with detail data summaries.

listEnvironmentTemplates(params = {}, callback) ⇒ AWS.Request

List environment templates.

listEnvironmentTemplateVersions(params = {}, callback) ⇒ AWS.Request

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

listRepositories(params = {}, callback) ⇒ AWS.Request

List linked repositories with detail data.

listRepositorySyncDefinitions(params = {}, callback) ⇒ AWS.Request

List repository sync definitions with detail data.

listServiceInstanceOutputs(params = {}, callback) ⇒ AWS.Request

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

listServiceInstanceProvisionedResources(params = {}, callback) ⇒ AWS.Request

List provisioned resources for a service instance with details.

listServiceInstances(params = {}, callback) ⇒ AWS.Request

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

listServicePipelineOutputs(params = {}, callback) ⇒ AWS.Request

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

listServicePipelineProvisionedResources(params = {}, callback) ⇒ AWS.Request

List provisioned resources for a service and pipeline with details.

listServices(params = {}, callback) ⇒ AWS.Request

List services with summaries of detail data.

listServiceTemplates(params = {}, callback) ⇒ AWS.Request

List service templates with detail data.

listServiceTemplateVersions(params = {}, callback) ⇒ AWS.Request

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

listTagsForResource(params = {}, callback) ⇒ AWS.Request

notifyResourceDeploymentStatusChange(params = {}, callback) ⇒ AWS.Request

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

For more information, see Self-managed provisioning in the Proton User Guide.

rejectEnvironmentAccountConnection(params = {}, callback) ⇒ AWS.Request

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

After you reject an environment account connection request, you can't accept or use the rejected environment account connection.

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

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

tagResource(params = {}, callback) ⇒ AWS.Request

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 tagging in the Proton User Guide.

untagResource(params = {}, callback) ⇒ AWS.Request

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 resources and tagging in the Proton User Guide.

updateAccountSettings(params = {}, callback) ⇒ AWS.Request

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

updateComponent(params = {}, callback) ⇒ AWS.Request

Update a component.

There are a few modes for updating a component. The deploymentType field defines the mode.

Note: You can't update a component while its deployment status, or the deployment status of a service instance attached to it, is IN_PROGRESS.

For more information about components, see Proton components in the Proton User Guide.

updateEnvironment(params = {}, callback) ⇒ AWS.Request

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 that connection was created in the same environment account that the current environment account connection was created in. The account connection must also be associated with the current environment.

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

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

If the environment was configured for Amazon Web Services-managed provisioning, omit the provisioningRepository parameter.

If the environment was configured for self-managed provisioning, specify the provisioningRepository parameter and omit the protonServiceRoleArn and environmentAccountConnectionId parameters.

For more information, see Environments and Provisioning methods in the Proton User Guide.

There are four modes for updating an environment. 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.

updateEnvironmentAccountConnection(params = {}, callback) ⇒ AWS.Request

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

updateEnvironmentTemplate(params = {}, callback) ⇒ AWS.Request

Update an environment template.

updateEnvironmentTemplateVersion(params = {}, callback) ⇒ AWS.Request

Update a major or minor version of an environment template.

updateService(params = {}, callback) ⇒ AWS.Request

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.

Note: You can't delete a service instance (remove it from the spec) if it has an attached component. For more information about components, see Proton components in the Proton User Guide.

updateServiceInstance(params = {}, callback) ⇒ AWS.Request

Update a service instance.

There are a few modes for updating a service instance. The deploymentType field defines the mode.

Note: You can't update a service instance while its deployment status, or the deployment status of a component attached to it, is IN_PROGRESS. For more information about components, see Proton components in the Proton User Guide.

updateServicePipeline(params = {}, callback) ⇒ AWS.Request

Update the service pipeline.

There are four modes for updating a service pipeline. 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 major or minor 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 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 specify a different major version that's higher than the major version in use and a minor version.

updateServiceSyncBlocker(params = {}, callback) ⇒ AWS.Request

Update the service sync blocker by resolving it.

updateServiceSyncConfig(params = {}, callback) ⇒ AWS.Request

Update the Proton Ops config file.

updateServiceTemplate(params = {}, callback) ⇒ AWS.Request

Update a service template.

updateServiceTemplateVersion(params = {}, callback) ⇒ AWS.Request

Update a major or minor version of a service template.

updateTemplateSyncConfig(params = {}, callback) ⇒ AWS.Request

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.

waitFor(state, params = {}, callback) ⇒ AWS.Request

Waits for a given Proton resource. The final callback or'complete' event will be fired only when the resource is either in its final state or the waiter has timed out and stopped polling for the final state.