AWS SDK for C++AWS SDK for C++ Version 1.11.440 |
Loading...
Searching...
No Matches
AWS SDK for C++AWS SDK for C++ Version 1.11.440 |
#include <ProtonClient.h>
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
Definition at line 106 of file ProtonClient.h.
Definition at line 109 of file ProtonClient.h.
Definition at line 113 of file ProtonClient.h.
Definition at line 114 of file ProtonClient.h.
Aws::Proton::ProtonClientConfiguration(),
nullptr
Initializes client to use DefaultCredentialProviderChain, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
nullptr,
Aws::Proton::ProtonClientConfiguration()
Initializes client to use SimpleAWSCredentialsProvider, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
nullptr,
Aws::Proton::ProtonClientConfiguration()
Initializes client to use specified credentials provider with specified client config. If http client factory is not supplied, the default http client factory will be used
Initializes client to use DefaultCredentialProviderChain, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
Initializes client to use SimpleAWSCredentialsProvider, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
Initializes client to use specified credentials provider with specified client config. If http client factory is not supplied, the default http client factory will be used
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.
nullptr
An Async wrapper for AcceptEnvironmentAccountConnection that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 191 of file ProtonClient.h.
A Callable wrapper for AcceptEnvironmentAccountConnection that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 182 of file ProtonClient.h.
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.
nullptr
An Async wrapper for CancelComponentDeployment that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 220 of file ProtonClient.h.
A Callable wrapper for CancelComponentDeployment that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 211 of file ProtonClient.h.
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.
nullptr
An Async wrapper for CancelEnvironmentDeployment that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 256 of file ProtonClient.h.
A Callable wrapper for CancelEnvironmentDeployment that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 247 of file ProtonClient.h.
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.
nullptr
An Async wrapper for CancelServiceInstanceDeployment that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 292 of file ProtonClient.h.
A Callable wrapper for CancelServiceInstanceDeployment that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 283 of file ProtonClient.h.
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.
nullptr
An Async wrapper for CancelServicePipelineDeployment that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 328 of file ProtonClient.h.
A Callable wrapper for CancelServicePipelineDeployment that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 319 of file ProtonClient.h.
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.
nullptr
An Async wrapper for CreateComponent that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 356 of file ProtonClient.h.
A Callable wrapper for CreateComponent that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 347 of file ProtonClient.h.
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.
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.
nullptr
An Async wrapper for CreateEnvironmentAccountConnection that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 425 of file ProtonClient.h.
A Callable wrapper for CreateEnvironmentAccountConnection that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 416 of file ProtonClient.h.
nullptr
An Async wrapper for CreateEnvironment that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 392 of file ProtonClient.h.
A Callable wrapper for CreateEnvironment that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 383 of file ProtonClient.h.
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.
nullptr
An Async wrapper for CreateEnvironmentTemplate that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 464 of file ProtonClient.h.
A Callable wrapper for CreateEnvironmentTemplate that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 455 of file ProtonClient.h.
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.
nullptr
An Async wrapper for CreateEnvironmentTemplateVersion that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 492 of file ProtonClient.h.
A Callable wrapper for CreateEnvironmentTemplateVersion that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 483 of file ProtonClient.h.
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.
nullptr
An Async wrapper for CreateRepository that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 530 of file ProtonClient.h.
A Callable wrapper for CreateRepository that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 521 of file ProtonClient.h.
nullptr
An Async wrapper for CreateService that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 559 of file ProtonClient.h.
A Callable wrapper for CreateService that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 550 of file ProtonClient.h.
nullptr
An Async wrapper for CreateServiceInstance that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 584 of file ProtonClient.h.
A Callable wrapper for CreateServiceInstance that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 575 of file ProtonClient.h.
nullptr
An Async wrapper for CreateServiceSyncConfig that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 609 of file ProtonClient.h.
A Callable wrapper for CreateServiceSyncConfig that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 600 of file ProtonClient.h.
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.
nullptr
An Async wrapper for CreateServiceTemplate that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 641 of file ProtonClient.h.
A Callable wrapper for CreateServiceTemplate that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 632 of file ProtonClient.h.
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.
nullptr
An Async wrapper for CreateServiceTemplateVersion that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 669 of file ProtonClient.h.
A Callable wrapper for CreateServiceTemplateVersion that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 660 of file ProtonClient.h.
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.
nullptr
An Async wrapper for CreateTemplateSyncConfig that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 703 of file ProtonClient.h.
A Callable wrapper for CreateTemplateSyncConfig that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 694 of file ProtonClient.h.
Delete an Proton component resource.
For more information about components, see Proton components in the Proton User Guide.
nullptr
An Async wrapper for DeleteComponent that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 731 of file ProtonClient.h.
A Callable wrapper for DeleteComponent that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 722 of file ProtonClient.h.
nullptr
An Async wrapper for DeleteDeployment that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 756 of file ProtonClient.h.
A Callable wrapper for DeleteDeployment that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 747 of file ProtonClient.h.
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.
nullptr
An Async wrapper for DeleteEnvironmentAccountConnection that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 815 of file ProtonClient.h.
A Callable wrapper for DeleteEnvironmentAccountConnection that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 806 of file ProtonClient.h.
nullptr
An Async wrapper for DeleteEnvironment that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 781 of file ProtonClient.h.
A Callable wrapper for DeleteEnvironment that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 772 of file ProtonClient.h.
If no other major or minor versions of an environment template exist, delete the environment template.
nullptr
An Async wrapper for DeleteEnvironmentTemplate that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 841 of file ProtonClient.h.
A Callable wrapper for DeleteEnvironmentTemplate that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 832 of file ProtonClient.h.
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.
nullptr
An Async wrapper for DeleteEnvironmentTemplateVersion that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 876 of file ProtonClient.h.
A Callable wrapper for DeleteEnvironmentTemplateVersion that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 867 of file ProtonClient.h.
nullptr
An Async wrapper for DeleteRepository that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 901 of file ProtonClient.h.
A Callable wrapper for DeleteRepository that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 892 of file ProtonClient.h.
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.
nullptr
An Async wrapper for DeleteService that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 931 of file ProtonClient.h.
A Callable wrapper for DeleteService that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 922 of file ProtonClient.h.
nullptr
An Async wrapper for DeleteServiceSyncConfig that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 956 of file ProtonClient.h.
A Callable wrapper for DeleteServiceSyncConfig that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 947 of file ProtonClient.h.
If no other major or minor versions of the service template exist, delete the service template.
nullptr
An Async wrapper for DeleteServiceTemplate that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 982 of file ProtonClient.h.
A Callable wrapper for DeleteServiceTemplate that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 973 of file ProtonClient.h.
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.
nullptr
An Async wrapper for DeleteServiceTemplateVersion that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1016 of file ProtonClient.h.
A Callable wrapper for DeleteServiceTemplateVersion that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1007 of file ProtonClient.h.
nullptr
An Async wrapper for DeleteTemplateSyncConfig that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1041 of file ProtonClient.h.
A Callable wrapper for DeleteTemplateSyncConfig that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1032 of file ProtonClient.h.
{})
const
nullptr,
{}
An Async wrapper for GetAccountSettings that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1067 of file ProtonClient.h.
{})
const
A Callable wrapper for GetAccountSettings that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1058 of file ProtonClient.h.
Get detailed data for a component.
For more information about components, see Proton components in the Proton User Guide.
nullptr
An Async wrapper for GetComponent that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1095 of file ProtonClient.h.
A Callable wrapper for GetComponent that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1086 of file ProtonClient.h.
nullptr
An Async wrapper for GetDeployment that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1120 of file ProtonClient.h.
A Callable wrapper for GetDeployment that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1111 of file ProtonClient.h.
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.
nullptr
An Async wrapper for GetEnvironmentAccountConnection that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1174 of file ProtonClient.h.
A Callable wrapper for GetEnvironmentAccountConnection that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1165 of file ProtonClient.h.
nullptr
An Async wrapper for GetEnvironment that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1145 of file ProtonClient.h.
A Callable wrapper for GetEnvironment that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1136 of file ProtonClient.h.
nullptr
An Async wrapper for GetEnvironmentTemplate that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1199 of file ProtonClient.h.
A Callable wrapper for GetEnvironmentTemplate that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1190 of file ProtonClient.h.
Get detailed data for a major or minor version of an environment template.
nullptr
An Async wrapper for GetEnvironmentTemplateVersion that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1225 of file ProtonClient.h.
A Callable wrapper for GetEnvironmentTemplateVersion that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1216 of file ProtonClient.h.
nullptr
An Async wrapper for GetRepository that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1250 of file ProtonClient.h.
A Callable wrapper for GetRepository that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1241 of file ProtonClient.h.
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.
nullptr
An Async wrapper for GetRepositorySyncStatus that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1283 of file ProtonClient.h.
A Callable wrapper for GetRepositorySyncStatus that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1274 of file ProtonClient.h.
{})
const
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.
nullptr,
{}
An Async wrapper for GetResourcesSummary that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1322 of file ProtonClient.h.
{})
const
A Callable wrapper for GetResourcesSummary that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1313 of file ProtonClient.h.
nullptr
An Async wrapper for GetService that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1347 of file ProtonClient.h.
A Callable wrapper for GetService that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1338 of file ProtonClient.h.
Get detailed data for a service instance. A service instance is an instantiation of service template and it runs in a specific environment.
nullptr
An Async wrapper for GetServiceInstance that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1374 of file ProtonClient.h.
A Callable wrapper for GetServiceInstance that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1365 of file ProtonClient.h.
nullptr
An Async wrapper for GetServiceInstanceSyncStatus that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1399 of file ProtonClient.h.
A Callable wrapper for GetServiceInstanceSyncStatus that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1390 of file ProtonClient.h.
nullptr
An Async wrapper for GetServiceSyncBlockerSummary that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1425 of file ProtonClient.h.
A Callable wrapper for GetServiceSyncBlockerSummary that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1416 of file ProtonClient.h.
nullptr
An Async wrapper for GetServiceSyncConfig that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1451 of file ProtonClient.h.
A Callable wrapper for GetServiceSyncConfig that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1442 of file ProtonClient.h.
nullptr
An Async wrapper for GetServiceTemplate that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1476 of file ProtonClient.h.
A Callable wrapper for GetServiceTemplate that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1467 of file ProtonClient.h.
nullptr
An Async wrapper for GetServiceTemplateVersion that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1502 of file ProtonClient.h.
A Callable wrapper for GetServiceTemplateVersion that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1493 of file ProtonClient.h.
nullptr
An Async wrapper for GetTemplateSyncConfig that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1528 of file ProtonClient.h.
A Callable wrapper for GetTemplateSyncConfig that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1519 of file ProtonClient.h.
nullptr
An Async wrapper for GetTemplateSyncStatus that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1553 of file ProtonClient.h.
A Callable wrapper for GetTemplateSyncStatus that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1544 of file ProtonClient.h.
Get a list of component Infrastructure as Code (IaC) outputs.
For more information about components, see Proton components in the Proton User Guide.
nullptr
An Async wrapper for ListComponentOutputs that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1581 of file ProtonClient.h.
A Callable wrapper for ListComponentOutputs that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1572 of file ProtonClient.h.
List provisioned resources for a component with details.
For more information about components, see Proton components in the Proton User Guide.
nullptr
An Async wrapper for ListComponentProvisionedResources that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1609 of file ProtonClient.h.
A Callable wrapper for ListComponentProvisionedResources that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1600 of file ProtonClient.h.
{})
const
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.
nullptr,
{}
An Async wrapper for ListComponents that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1638 of file ProtonClient.h.
{})
const
A Callable wrapper for ListComponents that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1629 of file ProtonClient.h.
{})
const
List deployments. You can filter the result list by environment, service, or a single service instance.
nullptr,
{}
An Async wrapper for ListDeployments that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1664 of file ProtonClient.h.
{})
const
A Callable wrapper for ListDeployments that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1655 of file ProtonClient.h.
View a list of environment account connections.
For more information, see Environment account connections in the Proton User guide.
nullptr
An Async wrapper for ListEnvironmentAccountConnections that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1693 of file ProtonClient.h.
A Callable wrapper for ListEnvironmentAccountConnections that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1684 of file ProtonClient.h.
nullptr
An Async wrapper for ListEnvironmentOutputs that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1719 of file ProtonClient.h.
A Callable wrapper for ListEnvironmentOutputs that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1710 of file ProtonClient.h.
nullptr
An Async wrapper for ListEnvironmentProvisionedResources that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1745 of file ProtonClient.h.
A Callable wrapper for ListEnvironmentProvisionedResources that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1736 of file ProtonClient.h.
{})
const
nullptr,
{}
An Async wrapper for ListEnvironments that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1821 of file ProtonClient.h.
{})
const
A Callable wrapper for ListEnvironments that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1812 of file ProtonClient.h.
{})
const
nullptr,
{}
An Async wrapper for ListEnvironmentTemplates that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1796 of file ProtonClient.h.
{})
const
A Callable wrapper for ListEnvironmentTemplates that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1787 of file ProtonClient.h.
List major or minor versions of an environment template with detail data.
nullptr
An Async wrapper for ListEnvironmentTemplateVersions that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1771 of file ProtonClient.h.
A Callable wrapper for ListEnvironmentTemplateVersions that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1762 of file ProtonClient.h.
{})
const
nullptr,
{}
An Async wrapper for ListRepositories that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1846 of file ProtonClient.h.
{})
const
A Callable wrapper for ListRepositories that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1837 of file ProtonClient.h.
nullptr
An Async wrapper for ListRepositorySyncDefinitions that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1872 of file ProtonClient.h.
A Callable wrapper for ListRepositorySyncDefinitions that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1863 of file ProtonClient.h.
nullptr
An Async wrapper for ListServiceInstanceOutputs that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1898 of file ProtonClient.h.
A Callable wrapper for ListServiceInstanceOutputs that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1889 of file ProtonClient.h.
nullptr
An Async wrapper for ListServiceInstanceProvisionedResources that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1924 of file ProtonClient.h.
A Callable wrapper for ListServiceInstanceProvisionedResources that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1915 of file ProtonClient.h.
{})
const
List service instances with summary data. This action lists service instances of all services in the Amazon Web Services account.
nullptr,
{}
An Async wrapper for ListServiceInstances that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1951 of file ProtonClient.h.
{})
const
A Callable wrapper for ListServiceInstances that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1942 of file ProtonClient.h.
nullptr
An Async wrapper for ListServicePipelineOutputs that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1977 of file ProtonClient.h.
A Callable wrapper for ListServicePipelineOutputs that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1968 of file ProtonClient.h.
nullptr
An Async wrapper for ListServicePipelineProvisionedResources that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2003 of file ProtonClient.h.
A Callable wrapper for ListServicePipelineProvisionedResources that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1994 of file ProtonClient.h.
{})
const
nullptr,
{}
An Async wrapper for ListServices that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2079 of file ProtonClient.h.
{})
const
A Callable wrapper for ListServices that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2070 of file ProtonClient.h.
{})
const
nullptr,
{}
An Async wrapper for ListServiceTemplates that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2054 of file ProtonClient.h.
{})
const
A Callable wrapper for ListServiceTemplates that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2045 of file ProtonClient.h.
nullptr
An Async wrapper for ListServiceTemplateVersions that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2029 of file ProtonClient.h.
A Callable wrapper for ListServiceTemplateVersions that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2020 of file ProtonClient.h.
List tags for a resource. For more information, see Proton resources and tagging in the Proton User Guide.
nullptr
An Async wrapper for ListTagsForResource that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2107 of file ProtonClient.h.
A Callable wrapper for ListTagsForResource that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2098 of file ProtonClient.h.
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.
nullptr
An Async wrapper for NotifyResourceDeploymentStatusChange that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2135 of file ProtonClient.h.
A Callable wrapper for NotifyResourceDeploymentStatusChange that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2126 of file ProtonClient.h.
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.
nullptr
An Async wrapper for RejectEnvironmentAccountConnection that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2168 of file ProtonClient.h.
A Callable wrapper for RejectEnvironmentAccountConnection that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2159 of file ProtonClient.h.
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.
nullptr
An Async wrapper for TagResource that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2197 of file ProtonClient.h.
A Callable wrapper for TagResource that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2188 of file ProtonClient.h.
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.
nullptr
An Async wrapper for UntagResource that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2226 of file ProtonClient.h.
A Callable wrapper for UntagResource that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2217 of file ProtonClient.h.
{})
const
Update Proton settings that are used for multiple services in the Amazon Web Services account.
nullptr,
{}
An Async wrapper for UpdateAccountSettings that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2252 of file ProtonClient.h.
{})
const
A Callable wrapper for UpdateAccountSettings that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2243 of file ProtonClient.h.
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 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.
nullptr
An Async wrapper for UpdateComponent that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2283 of file ProtonClient.h.
A Callable wrapper for UpdateComponent that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2274 of file ProtonClient.h.
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.
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.
nullptr
An Async wrapper for UpdateEnvironmentAccountConnection that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2377 of file ProtonClient.h.
A Callable wrapper for UpdateEnvironmentAccountConnection that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2368 of file ProtonClient.h.
nullptr
An Async wrapper for UpdateEnvironment that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2348 of file ProtonClient.h.