- Navigation GuideYou are on a Client landing page. Commands (operations) are listed on this page. The Client constructor type is linked at the bottom.
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
Installation
npm install @aws-sdk/client-proton
yarn add @aws-sdk/client-proton
pnpm add @aws-sdk/client-proton
ProtonClient Operations
Command | Summary |
---|
Command | Summary |
---|---|
AcceptEnvironmentAccountConnectionCommand | 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. |
CancelComponentDeploymentCommand | Attempts to cancel a component deployment (for a component that is in the For more information about components, see Proton components in the Proton User Guide. |
CancelEnvironmentDeploymentCommand | Attempts to cancel an environment deployment on an UpdateEnvironment action, if the deployment is The following list includes potential cancellation scenarios.
|
CancelServiceInstanceDeploymentCommand | Attempts to cancel a service instance deployment on an UpdateServiceInstance action, if the deployment is The following list includes potential cancellation scenarios.
|
CancelServicePipelineDeploymentCommand | Attempts to cancel a service pipeline deployment on an UpdateServicePipeline action, if the deployment is The following list includes potential cancellation scenarios.
|
CreateComponentCommand | 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. |
CreateEnvironmentAccountConnectionCommand | 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. |
CreateEnvironmentCommand | 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:
For more information, see Environments and Provisioning methods in the Proton User Guide. |
CreateEnvironmentTemplateCommand | 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:
|
CreateEnvironmentTemplateVersionCommand | 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. |
CreateRepositoryCommand | 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. |
CreateServiceCommand | 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. |
CreateServiceInstanceCommand | Create a service instance. |
CreateServiceSyncConfigCommand | Create the Proton Ops configuration file. |
CreateServiceTemplateCommand | 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. |
CreateServiceTemplateVersionCommand | 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. |
CreateTemplateSyncConfigCommand | 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. |
DeleteComponentCommand | Delete an Proton component resource. For more information about components, see Proton components in the Proton User Guide. |
DeleteDeploymentCommand | Delete the deployment. |
DeleteEnvironmentAccountConnectionCommand | 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. |
DeleteEnvironmentCommand | Delete an environment. |
DeleteEnvironmentTemplateCommand | If no other major or minor versions of an environment template exist, delete the environment template. |
DeleteEnvironmentTemplateVersionCommand | If no other minor versions of an environment template exist, delete a major version of the environment template if it's not the Delete a minor version of an environment template if it isn't the |
DeleteRepositoryCommand | De-register and unlink your repository. |
DeleteServiceCommand | 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 them. For more information about components, see Proton components in the Proton User Guide. |
DeleteServiceSyncConfigCommand | Delete the Proton Ops file. |
DeleteServiceTemplateCommand | If no other major or minor versions of the service template exist, delete the service template. |
DeleteServiceTemplateVersionCommand | If no other minor versions of a service template exist, delete a major version of the service template if it's not the Delete a minor version of a service template if it's not the |
DeleteTemplateSyncConfigCommand | Delete a template sync configuration. |
GetAccountSettingsCommand | Get detail data for Proton account-wide settings. |
GetComponentCommand | Get detailed data for a component. For more information about components, see Proton components in the Proton User Guide. |
GetDeploymentCommand | Get detailed data for a deployment. |
GetEnvironmentAccountConnectionCommand | 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. |
GetEnvironmentCommand | Get detailed data for an environment. |
GetEnvironmentTemplateCommand | Get detailed data for an environment template. |
GetEnvironmentTemplateVersionCommand | Get detailed data for a major or minor version of an environment template. |
GetRepositoryCommand | Get detail data for a linked repository. |
GetRepositorySyncStatusCommand | 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 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. |
GetResourcesSummaryCommand | 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 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. |
GetServiceCommand | Get detailed data for a service. |
GetServiceInstanceCommand | Get detailed data for a service instance. A service instance is an instantiation of service template and it runs in a specific environment. |
GetServiceInstanceSyncStatusCommand | Get the status of the synced service instance. |
GetServiceSyncBlockerSummaryCommand | Get detailed data for the service sync blocker summary. |
GetServiceSyncConfigCommand | Get detailed information for the service sync configuration. |
GetServiceTemplateCommand | Get detailed data for a service template. |
GetServiceTemplateVersionCommand | Get detailed data for a major or minor version of a service template. |
GetTemplateSyncConfigCommand | Get detail data for a template sync configuration. |
GetTemplateSyncStatusCommand | Get the status of a template sync. |
ListComponentOutputsCommand | Get a list of component Infrastructure as Code (IaC) outputs. For more information about components, see Proton components in the Proton User Guide. |
ListComponentProvisionedResourcesCommand | List provisioned resources for a component with details. For more information about components, see Proton components in the Proton User Guide. |
ListComponentsCommand | 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. |
ListDeploymentsCommand | List deployments. You can filter the result list by environment, service, or a single service instance. |
ListEnvironmentAccountConnectionsCommand | View a list of environment account connections. For more information, see Environment account connections in the Proton User guide. |
ListEnvironmentOutputsCommand | List the infrastructure as code outputs for your environment. |
ListEnvironmentProvisionedResourcesCommand | List the provisioned resources for your environment. |
ListEnvironmentTemplateVersionsCommand | List major or minor versions of an environment template with detail data. |
ListEnvironmentTemplatesCommand | List environment templates. |
ListEnvironmentsCommand | List environments with detail data summaries. |
ListRepositoriesCommand | List linked repositories with detail data. |
ListRepositorySyncDefinitionsCommand | List repository sync definitions with detail data. |
ListServiceInstanceOutputsCommand | Get a list service of instance Infrastructure as Code (IaC) outputs. |
ListServiceInstanceProvisionedResourcesCommand | List provisioned resources for a service instance with details. |
ListServiceInstancesCommand | List service instances with summary data. This action lists service instances of all services in the Amazon Web Services account. |
ListServicePipelineOutputsCommand | Get a list of service pipeline Infrastructure as Code (IaC) outputs. |
ListServicePipelineProvisionedResourcesCommand | List provisioned resources for a service and pipeline with details. |
ListServiceTemplateVersionsCommand | List major or minor versions of a service template with detail data. |
ListServiceTemplatesCommand | List service templates with detail data. |
ListServicesCommand | List services with summaries of detail data. |
ListTagsForResourceCommand | List tags for a resource. For more information, see Proton resources and tagging in the Proton User Guide. |
NotifyResourceDeploymentStatusChangeCommand | 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. |
RejectEnvironmentAccountConnectionCommand | 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. |
TagResourceCommand | 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. |
UntagResourceCommand | 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. |
UpdateAccountSettingsCommand | Update Proton settings that are used for multiple services in the Amazon Web Services account. |
UpdateComponentCommand | Update a component. There are a few modes for updating a component. The You can't update a component while its deployment status, or the deployment status of a service instance attached to it, is For more information about components, see Proton components in the Proton User Guide. |
UpdateEnvironmentAccountConnectionCommand | 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. |
UpdateEnvironmentCommand | Update an environment. If the environment is associated with an environment account connection, don't update or include the 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 You can update either the If the environment was configured for Amazon Web Services-managed provisioning, omit the If the environment was configured for self-managed provisioning, specify the For more information, see Environments and Provisioning methods in the Proton User Guide. There are four modes for updating an environment. The
|
UpdateEnvironmentTemplateCommand | Update an environment template. |
UpdateEnvironmentTemplateVersionCommand | Update a major or minor version of an environment template. |
UpdateServiceCommand | 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 Edit the 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. |
UpdateServiceInstanceCommand | Update a service instance. There are a few modes for updating a service instance. The You can't update a service instance while its deployment status, or the deployment status of a component attached to it, is For more information about components, see Proton components in the Proton User Guide. |
UpdateServicePipelineCommand | Update the service pipeline. There are four modes for updating a service pipeline. The
|
UpdateServiceSyncBlockerCommand | Update the service sync blocker by resolving it. |
UpdateServiceSyncConfigCommand | Update the Proton Ops config file. |
UpdateServiceTemplateCommand | Update a service template. |
UpdateServiceTemplateVersionCommand | Update a major or minor version of a service template. |
UpdateTemplateSyncConfigCommand | Update template sync configuration parameters, except for the |
ProtonClient Configuration
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
defaultsMode Optional | DefaultsMode | Provider<DefaultsMode> | The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK. |
disableHostPrefix Optional | boolean | Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation. |
extensions Optional | RuntimeExtension[] | Optional extensions |
logger Optional | Logger | Optional logger for logging debug/info/warn/error. |
maxAttempts Optional | number | Provider<number> | Value for how many times a request will be made at most in case of retry. |
profile Optional | string | Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options. |
region Optional | string | Provider<string> | The AWS region to which this client will send requests |
requestHandler Optional | __HttpHandlerUserInput | The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs. |
retryMode Optional | string | Provider<string> | Specifies which retry algorithm to use. |
useDualstackEndpoint Optional | boolean | Provider<boolean> | Enables IPv6/IPv4 dualstack endpoint. |
useFipsEndpoint Optional | boolean | Provider<boolean> | Enables FIPS compatible endpoints. |
Additional config fields are described in the full configuration type: ProtonClientConfig