@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSProtonClient extends AmazonWebServiceClient implements AWSProton
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
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
public static AWSProtonClientBuilder builder()
public AcceptEnvironmentAccountConnectionResult acceptEnvironmentAccountConnection(AcceptEnvironmentAccountConnectionRequest 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.
acceptEnvironmentAccountConnection
in interface AWSProton
acceptEnvironmentAccountConnectionRequest
- ValidationException
- The input is invalid or an out-of-range value was supplied for the input parameter.AccessDeniedException
- There isn't sufficient access for performing this action.ThrottlingException
- The request was denied due to request throttling.ConflictException
- The request couldn't be made due to a conflicting operation or resource.ResourceNotFoundException
- The requested resource wasn't found.InternalServerException
- The request failed to register with the service.public CancelComponentDeploymentResult cancelComponentDeployment(CancelComponentDeploymentRequest 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.
cancelComponentDeployment
in interface AWSProton
cancelComponentDeploymentRequest
- ValidationException
- The input is invalid or an out-of-range value was supplied for the input parameter.AccessDeniedException
- There isn't sufficient access for performing this action.ThrottlingException
- The request was denied due to request throttling.ConflictException
- The request couldn't be made due to a conflicting operation or resource.ResourceNotFoundException
- The requested resource wasn't found.InternalServerException
- The request failed to register with the service.public CancelEnvironmentDeploymentResult cancelEnvironmentDeployment(CancelEnvironmentDeploymentRequest 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.
cancelEnvironmentDeployment
in interface AWSProton
cancelEnvironmentDeploymentRequest
- ValidationException
- The input is invalid or an out-of-range value was supplied for the input parameter.AccessDeniedException
- There isn't sufficient access for performing this action.ThrottlingException
- The request was denied due to request throttling.ConflictException
- The request couldn't be made due to a conflicting operation or resource.ResourceNotFoundException
- The requested resource wasn't found.InternalServerException
- The request failed to register with the service.public CancelServiceInstanceDeploymentResult cancelServiceInstanceDeployment(CancelServiceInstanceDeploymentRequest 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.
cancelServiceInstanceDeployment
in interface AWSProton
cancelServiceInstanceDeploymentRequest
- ValidationException
- The input is invalid or an out-of-range value was supplied for the input parameter.AccessDeniedException
- There isn't sufficient access for performing this action.ThrottlingException
- The request was denied due to request throttling.ConflictException
- The request couldn't be made due to a conflicting operation or resource.ResourceNotFoundException
- The requested resource wasn't found.InternalServerException
- The request failed to register with the service.public CancelServicePipelineDeploymentResult cancelServicePipelineDeployment(CancelServicePipelineDeploymentRequest 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.
cancelServicePipelineDeployment
in interface AWSProton
cancelServicePipelineDeploymentRequest
- ValidationException
- The input is invalid or an out-of-range value was supplied for the input parameter.AccessDeniedException
- There isn't sufficient access for performing this action.ThrottlingException
- The request was denied due to request throttling.ConflictException
- The request couldn't be made due to a conflicting operation or resource.ResourceNotFoundException
- The requested resource wasn't found.InternalServerException
- The request failed to register with the service.public CreateComponentResult createComponent(CreateComponentRequest 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.
createComponent
in interface AWSProton
createComponentRequest
- ServiceQuotaExceededException
- A quota was exceeded. For more information, see Proton Quotas in the
Proton User Guide.ValidationException
- The input is invalid or an out-of-range value was supplied for the input parameter.AccessDeniedException
- There isn't sufficient access for performing this action.ThrottlingException
- The request was denied due to request throttling.ConflictException
- The request couldn't be made due to a conflicting operation or resource.ResourceNotFoundException
- The requested resource wasn't found.InternalServerException
- The request failed to register with the service.public CreateEnvironmentResult createEnvironment(CreateEnvironmentRequest 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.
createEnvironment
in interface AWSProton
createEnvironmentRequest
- ServiceQuotaExceededException
- A quota was exceeded. For more information, see Proton Quotas in the
Proton User Guide.ValidationException
- The input is invalid or an out-of-range value was supplied for the input parameter.AccessDeniedException
- There isn't sufficient access for performing this action.ThrottlingException
- The request was denied due to request throttling.ConflictException
- The request couldn't be made due to a conflicting operation or resource.ResourceNotFoundException
- The requested resource wasn't found.InternalServerException
- The request failed to register with the service.public CreateEnvironmentAccountConnectionResult createEnvironmentAccountConnection(CreateEnvironmentAccountConnectionRequest 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.
createEnvironmentAccountConnection
in interface AWSProton
createEnvironmentAccountConnectionRequest
- ServiceQuotaExceededException
- A quota was exceeded. For more information, see Proton Quotas in the
Proton User Guide.ValidationException
- The input is invalid or an out-of-range value was supplied for the input parameter.AccessDeniedException
- There isn't sufficient access for performing this action.ThrottlingException
- The request was denied due to request throttling.ConflictException
- The request couldn't be made due to a conflicting operation or resource.InternalServerException
- The request failed to register with the service.public CreateEnvironmentTemplateResult createEnvironmentTemplate(CreateEnvironmentTemplateRequest 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.
createEnvironmentTemplate
in interface AWSProton
createEnvironmentTemplateRequest
- ServiceQuotaExceededException
- A quota was exceeded. For more information, see Proton Quotas in the
Proton User Guide.ValidationException
- The input is invalid or an out-of-range value was supplied for the input parameter.AccessDeniedException
- There isn't sufficient access for performing this action.ThrottlingException
- The request was denied due to request throttling.ConflictException
- The request couldn't be made due to a conflicting operation or resource.InternalServerException
- The request failed to register with the service.public CreateEnvironmentTemplateVersionResult createEnvironmentTemplateVersion(CreateEnvironmentTemplateVersionRequest 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.
createEnvironmentTemplateVersion
in interface AWSProton
createEnvironmentTemplateVersionRequest
- ServiceQuotaExceededException
- A quota was exceeded. For more information, see Proton Quotas in the
Proton User Guide.ValidationException
- The input is invalid or an out-of-range value was supplied for the input parameter.AccessDeniedException
- There isn't sufficient access for performing this action.ThrottlingException
- The request was denied due to request throttling.ConflictException
- The request couldn't be made due to a conflicting operation or resource.ResourceNotFoundException
- The requested resource wasn't found.InternalServerException
- The request failed to register with the service.public CreateRepositoryResult createRepository(CreateRepositoryRequest 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.
createRepository
in interface AWSProton
createRepositoryRequest
- ServiceQuotaExceededException
- A quota was exceeded. For more information, see Proton Quotas in the
Proton User Guide.ValidationException
- The input is invalid or an out-of-range value was supplied for the input parameter.AccessDeniedException
- There isn't sufficient access for performing this action.ThrottlingException
- The request was denied due to request throttling.ConflictException
- The request couldn't be made due to a conflicting operation or resource.InternalServerException
- The request failed to register with the service.public CreateServiceResult createService(CreateServiceRequest 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.
createService
in interface AWSProton
createServiceRequest
- ServiceQuotaExceededException
- A quota was exceeded. For more information, see Proton Quotas in the
Proton User Guide.ValidationException
- The input is invalid or an out-of-range value was supplied for the input parameter.AccessDeniedException
- There isn't sufficient access for performing this action.ThrottlingException
- The request was denied due to request throttling.ConflictException
- The request couldn't be made due to a conflicting operation or resource.ResourceNotFoundException
- The requested resource wasn't found.InternalServerException
- The request failed to register with the service.public CreateServiceInstanceResult createServiceInstance(CreateServiceInstanceRequest request)
Create a service instance.
createServiceInstance
in interface AWSProton
createServiceInstanceRequest
- ValidationException
- The input is invalid or an out-of-range value was supplied for the input parameter.AccessDeniedException
- There isn't sufficient access for performing this action.ThrottlingException
- The request was denied due to request throttling.ConflictException
- The request couldn't be made due to a conflicting operation or resource.ResourceNotFoundException
- The requested resource wasn't found.InternalServerException
- The request failed to register with the service.public CreateServiceSyncConfigResult createServiceSyncConfig(CreateServiceSyncConfigRequest request)
Create the Proton Ops configuration file.
createServiceSyncConfig
in interface AWSProton
createServiceSyncConfigRequest
- ServiceQuotaExceededException
- A quota was exceeded. For more information, see Proton Quotas in the
Proton User Guide.ValidationException
- The input is invalid or an out-of-range value was supplied for the input parameter.AccessDeniedException
- There isn't sufficient access for performing this action.ThrottlingException
- The request was denied due to request throttling.ConflictException
- The request couldn't be made due to a conflicting operation or resource.InternalServerException
- The request failed to register with the service.public CreateServiceTemplateResult createServiceTemplate(CreateServiceTemplateRequest 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.
createServiceTemplate
in interface AWSProton
createServiceTemplateRequest
- ServiceQuotaExceededException
- A quota was exceeded. For more information, see Proton Quotas in the
Proton User Guide.ValidationException
- The input is invalid or an out-of-range value was supplied for the input parameter.AccessDeniedException
- There isn't sufficient access for performing this action.ThrottlingException
- The request was denied due to request throttling.ConflictException
- The request couldn't be made due to a conflicting operation or resource.InternalServerException
- The request failed to register with the service.public CreateServiceTemplateVersionResult createServiceTemplateVersion(CreateServiceTemplateVersionRequest 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.
createServiceTemplateVersion
in interface AWSProton
createServiceTemplateVersionRequest
- ServiceQuotaExceededException
- A quota was exceeded. For more information, see Proton Quotas in the
Proton User Guide.ValidationException
- The input is invalid or an out-of-range value was supplied for the input parameter.AccessDeniedException
- There isn't sufficient access for performing this action.ThrottlingException
- The request was denied due to request throttling.ConflictException
- The request couldn't be made due to a conflicting operation or resource.ResourceNotFoundException
- The requested resource wasn't found.InternalServerException
- The request failed to register with the service.public CreateTemplateSyncConfigResult createTemplateSyncConfig(CreateTemplateSyncConfigRequest 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.
createTemplateSyncConfig
in interface AWSProton
createTemplateSyncConfigRequest
- ServiceQuotaExceededException
- A quota was exceeded. For more information, see Proton Quotas in the
Proton User Guide.ValidationException
- The input is invalid or an out-of-range value was supplied for the input parameter.AccessDeniedException
- There isn't sufficient access for performing this action.ThrottlingException
- The request was denied due to request throttling.ConflictException
- The request couldn't be made due to a conflicting operation or resource.InternalServerException
- The request failed to register with the service.public DeleteComponentResult deleteComponent(DeleteComponentRequest request)
Delete an Proton component resource.
For more information about components, see Proton components in the Proton User Guide.
deleteComponent
in interface AWSProton
deleteComponentRequest
- ValidationException
- The input is invalid or an out-of-range value was supplied for the input parameter.AccessDeniedException
- There isn't sufficient access for performing this action.ThrottlingException
- The request was denied due to request throttling.ConflictException
- The request couldn't be made due to a conflicting operation or resource.ResourceNotFoundException
- The requested resource wasn't found.InternalServerException
- The request failed to register with the service.public DeleteDeploymentResult deleteDeployment(DeleteDeploymentRequest request)
Delete the deployment.
deleteDeployment
in interface AWSProton
deleteDeploymentRequest
- ValidationException
- The input is invalid or an out-of-range value was supplied for the input parameter.AccessDeniedException
- There isn't sufficient access for performing this action.ThrottlingException
- The request was denied due to request throttling.ResourceNotFoundException
- The requested resource wasn't found.InternalServerException
- The request failed to register with the service.public DeleteEnvironmentResult deleteEnvironment(DeleteEnvironmentRequest request)
Delete an environment.
deleteEnvironment
in interface AWSProton
deleteEnvironmentRequest
- ValidationException
- The input is invalid or an out-of-range value was supplied for the input parameter.AccessDeniedException
- There isn't sufficient access for performing this action.ThrottlingException
- The request was denied due to request throttling.ConflictException
- The request couldn't be made due to a conflicting operation or resource.ResourceNotFoundException
- The requested resource wasn't found.InternalServerException
- The request failed to register with the service.public DeleteEnvironmentAccountConnectionResult deleteEnvironmentAccountConnection(DeleteEnvironmentAccountConnectionRequest 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.
deleteEnvironmentAccountConnection
in interface AWSProton
deleteEnvironmentAccountConnectionRequest
- ValidationException
- The input is invalid or an out-of-range value was supplied for the input parameter.AccessDeniedException
- There isn't sufficient access for performing this action.ThrottlingException
- The request was denied due to request throttling.ConflictException
- The request couldn't be made due to a conflicting operation or resource.ResourceNotFoundException
- The requested resource wasn't found.InternalServerException
- The request failed to register with the service.public DeleteEnvironmentTemplateResult deleteEnvironmentTemplate(DeleteEnvironmentTemplateRequest request)
If no other major or minor versions of an environment template exist, delete the environment template.
deleteEnvironmentTemplate
in interface AWSProton
deleteEnvironmentTemplateRequest
- ValidationException
- The input is invalid or an out-of-range value was supplied for the input parameter.AccessDeniedException
- There isn't sufficient access for performing this action.ThrottlingException
- The request was denied due to request throttling.ConflictException
- The request couldn't be made due to a conflicting operation or resource.ResourceNotFoundException
- The requested resource wasn't found.InternalServerException
- The request failed to register with the service.public DeleteEnvironmentTemplateVersionResult deleteEnvironmentTemplateVersion(DeleteEnvironmentTemplateVersionRequest 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.
deleteEnvironmentTemplateVersion
in interface AWSProton
deleteEnvironmentTemplateVersionRequest
- ValidationException
- The input is invalid or an out-of-range value was supplied for the input parameter.AccessDeniedException
- There isn't sufficient access for performing this action.ThrottlingException
- The request was denied due to request throttling.ConflictException
- The request couldn't be made due to a conflicting operation or resource.ResourceNotFoundException
- The requested resource wasn't found.InternalServerException
- The request failed to register with the service.public DeleteRepositoryResult deleteRepository(DeleteRepositoryRequest request)
De-register and unlink your repository.
deleteRepository
in interface AWSProton
deleteRepositoryRequest
- ValidationException
- The input is invalid or an out-of-range value was supplied for the input parameter.AccessDeniedException
- There isn't sufficient access for performing this action.ThrottlingException
- The request was denied due to request throttling.ConflictException
- The request couldn't be made due to a conflicting operation or resource.ResourceNotFoundException
- The requested resource wasn't found.InternalServerException
- The request failed to register with the service.public DeleteServiceResult deleteService(DeleteServiceRequest request)
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.
deleteService
in interface AWSProton
deleteServiceRequest
- ValidationException
- The input is invalid or an out-of-range value was supplied for the input parameter.AccessDeniedException
- There isn't sufficient access for performing this action.ThrottlingException
- The request was denied due to request throttling.ConflictException
- The request couldn't be made due to a conflicting operation or resource.ResourceNotFoundException
- The requested resource wasn't found.InternalServerException
- The request failed to register with the service.public DeleteServiceSyncConfigResult deleteServiceSyncConfig(DeleteServiceSyncConfigRequest request)
Delete the Proton Ops file.
deleteServiceSyncConfig
in interface AWSProton
deleteServiceSyncConfigRequest
- ValidationException
- The input is invalid or an out-of-range value was supplied for the input parameter.AccessDeniedException
- There isn't sufficient access for performing this action.ThrottlingException
- The request was denied due to request throttling.ConflictException
- The request couldn't be made due to a conflicting operation or resource.ResourceNotFoundException
- The requested resource wasn't found.InternalServerException
- The request failed to register with the service.public DeleteServiceTemplateResult deleteServiceTemplate(DeleteServiceTemplateRequest request)
If no other major or minor versions of the service template exist, delete the service template.
deleteServiceTemplate
in interface AWSProton
deleteServiceTemplateRequest
- ValidationException
- The input is invalid or an out-of-range value was supplied for the input parameter.AccessDeniedException
- There isn't sufficient access for performing this action.ThrottlingException
- The request was denied due to request throttling.ConflictException
- The request couldn't be made due to a conflicting operation or resource.ResourceNotFoundException
- The requested resource wasn't found.InternalServerException
- The request failed to register with the service.public DeleteServiceTemplateVersionResult deleteServiceTemplateVersion(DeleteServiceTemplateVersionRequest 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.
deleteServiceTemplateVersion
in interface AWSProton
deleteServiceTemplateVersionRequest
- ValidationException
- The input is invalid or an out-of-range value was supplied for the input parameter.AccessDeniedException
- There isn't sufficient access for performing this action.ThrottlingException
- The request was denied due to request throttling.ConflictException
- The request couldn't be made due to a conflicting operation or resource.ResourceNotFoundException
- The requested resource wasn't found.InternalServerException
- The request failed to register with the service.public DeleteTemplateSyncConfigResult deleteTemplateSyncConfig(DeleteTemplateSyncConfigRequest request)
Delete a template sync configuration.
deleteTemplateSyncConfig
in interface AWSProton
deleteTemplateSyncConfigRequest
- ValidationException
- The input is invalid or an out-of-range value was supplied for the input parameter.AccessDeniedException
- There isn't sufficient access for performing this action.ThrottlingException
- The request was denied due to request throttling.ConflictException
- The request couldn't be made due to a conflicting operation or resource.ResourceNotFoundException
- The requested resource wasn't found.InternalServerException
- The request failed to register with the service.public GetAccountSettingsResult getAccountSettings(GetAccountSettingsRequest request)
Get detail data for Proton account-wide settings.
getAccountSettings
in interface AWSProton
getAccountSettingsRequest
- ValidationException
- The input is invalid or an out-of-range value was supplied for the input parameter.AccessDeniedException
- There isn't sufficient access for performing this action.ThrottlingException
- The request was denied due to request throttling.ResourceNotFoundException
- The requested resource wasn't found.InternalServerException
- The request failed to register with the service.public GetComponentResult getComponent(GetComponentRequest request)
Get detailed data for a component.
For more information about components, see Proton components in the Proton User Guide.
getComponent
in interface AWSProton
getComponentRequest
- ValidationException
- The input is invalid or an out-of-range value was supplied for the input parameter.AccessDeniedException
- There isn't sufficient access for performing this action.ThrottlingException
- The request was denied due to request throttling.ResourceNotFoundException
- The requested resource wasn't found.InternalServerException
- The request failed to register with the service.public GetDeploymentResult getDeployment(GetDeploymentRequest request)
Get detailed data for a deployment.
getDeployment
in interface AWSProton
getDeploymentRequest
- ValidationException
- The input is invalid or an out-of-range value was supplied for the input parameter.AccessDeniedException
- There isn't sufficient access for performing this action.ThrottlingException
- The request was denied due to request throttling.ResourceNotFoundException
- The requested resource wasn't found.InternalServerException
- The request failed to register with the service.public GetEnvironmentResult getEnvironment(GetEnvironmentRequest request)
Get detailed data for an environment.
getEnvironment
in interface AWSProton
getEnvironmentRequest
- ValidationException
- The input is invalid or an out-of-range value was supplied for the input parameter.AccessDeniedException
- There isn't sufficient access for performing this action.ThrottlingException
- The request was denied due to request throttling.ResourceNotFoundException
- The requested resource wasn't found.InternalServerException
- The request failed to register with the service.public GetEnvironmentAccountConnectionResult getEnvironmentAccountConnection(GetEnvironmentAccountConnectionRequest 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.
getEnvironmentAccountConnection
in interface AWSProton
getEnvironmentAccountConnectionRequest
- ValidationException
- The input is invalid or an out-of-range value was supplied for the input parameter.AccessDeniedException
- There isn't sufficient access for performing this action.ThrottlingException
- The request was denied due to request throttling.ResourceNotFoundException
- The requested resource wasn't found.InternalServerException
- The request failed to register with the service.public GetEnvironmentTemplateResult getEnvironmentTemplate(GetEnvironmentTemplateRequest request)
Get detailed data for an environment template.
getEnvironmentTemplate
in interface AWSProton
getEnvironmentTemplateRequest
- ValidationException
- The input is invalid or an out-of-range value was supplied for the input parameter.AccessDeniedException
- There isn't sufficient access for performing this action.ThrottlingException
- The request was denied due to request throttling.ResourceNotFoundException
- The requested resource wasn't found.InternalServerException
- The request failed to register with the service.public GetEnvironmentTemplateVersionResult getEnvironmentTemplateVersion(GetEnvironmentTemplateVersionRequest request)
Get detailed data for a major or minor version of an environment template.
getEnvironmentTemplateVersion
in interface AWSProton
getEnvironmentTemplateVersionRequest
- ValidationException
- The input is invalid or an out-of-range value was supplied for the input parameter.AccessDeniedException
- There isn't sufficient access for performing this action.ThrottlingException
- The request was denied due to request throttling.ResourceNotFoundException
- The requested resource wasn't found.InternalServerException
- The request failed to register with the service.public GetRepositoryResult getRepository(GetRepositoryRequest request)
Get detail data for a linked repository.
getRepository
in interface AWSProton
getRepositoryRequest
- ValidationException
- The input is invalid or an out-of-range value was supplied for the input parameter.AccessDeniedException
- There isn't sufficient access for performing this action.ThrottlingException
- The request was denied due to request throttling.ResourceNotFoundException
- The requested resource wasn't found.InternalServerException
- The request failed to register with the service.public GetRepositorySyncStatusResult getRepositorySyncStatus(GetRepositorySyncStatusRequest request)
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.
getRepositorySyncStatus
in interface AWSProton
getRepositorySyncStatusRequest
- ValidationException
- The input is invalid or an out-of-range value was supplied for the input parameter.AccessDeniedException
- There isn't sufficient access for performing this action.ThrottlingException
- The request was denied due to request throttling.ResourceNotFoundException
- The requested resource wasn't found.InternalServerException
- The request failed to register with the service.public GetResourcesSummaryResult getResourcesSummary(GetResourcesSummaryRequest 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.
getResourcesSummary
in interface AWSProton
getResourcesSummaryRequest
- ValidationException
- The input is invalid or an out-of-range value was supplied for the input parameter.AccessDeniedException
- There isn't sufficient access for performing this action.ThrottlingException
- The request was denied due to request throttling.InternalServerException
- The request failed to register with the service.public GetServiceResult getService(GetServiceRequest request)
Get detailed data for a service.
getService
in interface AWSProton
getServiceRequest
- ValidationException
- The input is invalid or an out-of-range value was supplied for the input parameter.AccessDeniedException
- There isn't sufficient access for performing this action.ThrottlingException
- The request was denied due to request throttling.ResourceNotFoundException
- The requested resource wasn't found.InternalServerException
- The request failed to register with the service.public GetServiceInstanceResult getServiceInstance(GetServiceInstanceRequest request)
Get detailed data for a service instance. A service instance is an instantiation of service template and it runs in a specific environment.
getServiceInstance
in interface AWSProton
getServiceInstanceRequest
- ValidationException
- The input is invalid or an out-of-range value was supplied for the input parameter.AccessDeniedException
- There isn't sufficient access for performing this action.ThrottlingException
- The request was denied due to request throttling.ResourceNotFoundException
- The requested resource wasn't found.InternalServerException
- The request failed to register with the service.public GetServiceInstanceSyncStatusResult getServiceInstanceSyncStatus(GetServiceInstanceSyncStatusRequest request)
Get the status of the synced service instance.
getServiceInstanceSyncStatus
in interface AWSProton
getServiceInstanceSyncStatusRequest
- ValidationException
- The input is invalid or an out-of-range value was supplied for the input parameter.AccessDeniedException
- There isn't sufficient access for performing this action.ThrottlingException
- The request was denied due to request throttling.ResourceNotFoundException
- The requested resource wasn't found.InternalServerException
- The request failed to register with the service.public GetServiceSyncBlockerSummaryResult getServiceSyncBlockerSummary(GetServiceSyncBlockerSummaryRequest request)
Get detailed data for the service sync blocker summary.
getServiceSyncBlockerSummary
in interface AWSProton
getServiceSyncBlockerSummaryRequest
- ValidationException
- The input is invalid or an out-of-range value was supplied for the input parameter.AccessDeniedException
- There isn't sufficient access for performing this action.ThrottlingException
- The request was denied due to request throttling.ResourceNotFoundException
- The requested resource wasn't found.InternalServerException
- The request failed to register with the service.public GetServiceSyncConfigResult getServiceSyncConfig(GetServiceSyncConfigRequest request)
Get detailed information for the service sync configuration.
getServiceSyncConfig
in interface AWSProton
getServiceSyncConfigRequest
- ValidationException
- The input is invalid or an out-of-range value was supplied for the input parameter.AccessDeniedException
- There isn't sufficient access for performing this action.ThrottlingException
- The request was denied due to request throttling.ResourceNotFoundException
- The requested resource wasn't found.InternalServerException
- The request failed to register with the service.public GetServiceTemplateResult getServiceTemplate(GetServiceTemplateRequest request)
Get detailed data for a service template.
getServiceTemplate
in interface AWSProton
getServiceTemplateRequest
- ValidationException
- The input is invalid or an out-of-range value was supplied for the input parameter.AccessDeniedException
- There isn't sufficient access for performing this action.ThrottlingException
- The request was denied due to request throttling.ResourceNotFoundException
- The requested resource wasn't found.InternalServerException
- The request failed to register with the service.public GetServiceTemplateVersionResult getServiceTemplateVersion(GetServiceTemplateVersionRequest request)
Get detailed data for a major or minor version of a service template.
getServiceTemplateVersion
in interface AWSProton
getServiceTemplateVersionRequest
- ValidationException
- The input is invalid or an out-of-range value was supplied for the input parameter.AccessDeniedException
- There isn't sufficient access for performing this action.ThrottlingException
- The request was denied due to request throttling.ResourceNotFoundException
- The requested resource wasn't found.InternalServerException
- The request failed to register with the service.public GetTemplateSyncConfigResult getTemplateSyncConfig(GetTemplateSyncConfigRequest request)
Get detail data for a template sync configuration.
getTemplateSyncConfig
in interface AWSProton
getTemplateSyncConfigRequest
- ValidationException
- The input is invalid or an out-of-range value was supplied for the input parameter.AccessDeniedException
- There isn't sufficient access for performing this action.ThrottlingException
- The request was denied due to request throttling.ResourceNotFoundException
- The requested resource wasn't found.InternalServerException
- The request failed to register with the service.public GetTemplateSyncStatusResult getTemplateSyncStatus(GetTemplateSyncStatusRequest request)
Get the status of a template sync.
getTemplateSyncStatus
in interface AWSProton
getTemplateSyncStatusRequest
- ValidationException
- The input is invalid or an out-of-range value was supplied for the input parameter.AccessDeniedException
- There isn't sufficient access for performing this action.ThrottlingException
- The request was denied due to request throttling.ResourceNotFoundException
- The requested resource wasn't found.InternalServerException
- The request failed to register with the service.public ListComponentOutputsResult listComponentOutputs(ListComponentOutputsRequest request)
Get a list of component Infrastructure as Code (IaC) outputs.
For more information about components, see Proton components in the Proton User Guide.
listComponentOutputs
in interface AWSProton
listComponentOutputsRequest
- ValidationException
- The input is invalid or an out-of-range value was supplied for the input parameter.AccessDeniedException
- There isn't sufficient access for performing this action.ThrottlingException
- The request was denied due to request throttling.ResourceNotFoundException
- The requested resource wasn't found.InternalServerException
- The request failed to register with the service.public ListComponentProvisionedResourcesResult listComponentProvisionedResources(ListComponentProvisionedResourcesRequest request)
List provisioned resources for a component with details.
For more information about components, see Proton components in the Proton User Guide.
listComponentProvisionedResources
in interface AWSProton
listComponentProvisionedResourcesRequest
- ValidationException
- The input is invalid or an out-of-range value was supplied for the input parameter.AccessDeniedException
- There isn't sufficient access for performing this action.ThrottlingException
- The request was denied due to request throttling.ResourceNotFoundException
- The requested resource wasn't found.InternalServerException
- The request failed to register with the service.public ListComponentsResult listComponents(ListComponentsRequest 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.
listComponents
in interface AWSProton
listComponentsRequest
- ValidationException
- The input is invalid or an out-of-range value was supplied for the input parameter.AccessDeniedException
- There isn't sufficient access for performing this action.ThrottlingException
- The request was denied due to request throttling.InternalServerException
- The request failed to register with the service.public ListDeploymentsResult listDeployments(ListDeploymentsRequest request)
List deployments. You can filter the result list by environment, service, or a single service instance.
listDeployments
in interface AWSProton
listDeploymentsRequest
- ValidationException
- The input is invalid or an out-of-range value was supplied for the input parameter.AccessDeniedException
- There isn't sufficient access for performing this action.ThrottlingException
- The request was denied due to request throttling.ResourceNotFoundException
- The requested resource wasn't found.InternalServerException
- The request failed to register with the service.public ListEnvironmentAccountConnectionsResult listEnvironmentAccountConnections(ListEnvironmentAccountConnectionsRequest request)
View a list of environment account connections.
For more information, see Environment account connections in the Proton User guide.
listEnvironmentAccountConnections
in interface AWSProton
listEnvironmentAccountConnectionsRequest
- ValidationException
- The input is invalid or an out-of-range value was supplied for the input parameter.AccessDeniedException
- There isn't sufficient access for performing this action.ThrottlingException
- The request was denied due to request throttling.InternalServerException
- The request failed to register with the service.public ListEnvironmentOutputsResult listEnvironmentOutputs(ListEnvironmentOutputsRequest request)
List the infrastructure as code outputs for your environment.
listEnvironmentOutputs
in interface AWSProton
listEnvironmentOutputsRequest
- ValidationException
- The input is invalid or an out-of-range value was supplied for the input parameter.AccessDeniedException
- There isn't sufficient access for performing this action.ThrottlingException
- The request was denied due to request throttling.ResourceNotFoundException
- The requested resource wasn't found.InternalServerException
- The request failed to register with the service.public ListEnvironmentProvisionedResourcesResult listEnvironmentProvisionedResources(ListEnvironmentProvisionedResourcesRequest request)
List the provisioned resources for your environment.
listEnvironmentProvisionedResources
in interface AWSProton
listEnvironmentProvisionedResourcesRequest
- ValidationException
- The input is invalid or an out-of-range value was supplied for the input parameter.AccessDeniedException
- There isn't sufficient access for performing this action.ThrottlingException
- The request was denied due to request throttling.ResourceNotFoundException
- The requested resource wasn't found.InternalServerException
- The request failed to register with the service.public ListEnvironmentTemplateVersionsResult listEnvironmentTemplateVersions(ListEnvironmentTemplateVersionsRequest request)
List major or minor versions of an environment template with detail data.
listEnvironmentTemplateVersions
in interface AWSProton
listEnvironmentTemplateVersionsRequest
- ValidationException
- The input is invalid or an out-of-range value was supplied for the input parameter.AccessDeniedException
- There isn't sufficient access for performing this action.ThrottlingException
- The request was denied due to request throttling.ResourceNotFoundException
- The requested resource wasn't found.InternalServerException
- The request failed to register with the service.public ListEnvironmentTemplatesResult listEnvironmentTemplates(ListEnvironmentTemplatesRequest request)
List environment templates.
listEnvironmentTemplates
in interface AWSProton
listEnvironmentTemplatesRequest
- ValidationException
- The input is invalid or an out-of-range value was supplied for the input parameter.AccessDeniedException
- There isn't sufficient access for performing this action.ThrottlingException
- The request was denied due to request throttling.InternalServerException
- The request failed to register with the service.public ListEnvironmentsResult listEnvironments(ListEnvironmentsRequest request)
List environments with detail data summaries.
listEnvironments
in interface AWSProton
listEnvironmentsRequest
- ValidationException
- The input is invalid or an out-of-range value was supplied for the input parameter.AccessDeniedException
- There isn't sufficient access for performing this action.ThrottlingException
- The request was denied due to request throttling.ResourceNotFoundException
- The requested resource wasn't found.InternalServerException
- The request failed to register with the service.public ListRepositoriesResult listRepositories(ListRepositoriesRequest request)
List linked repositories with detail data.
listRepositories
in interface AWSProton
listRepositoriesRequest
- ValidationException
- The input is invalid or an out-of-range value was supplied for the input parameter.AccessDeniedException
- There isn't sufficient access for performing this action.ThrottlingException
- The request was denied due to request throttling.ResourceNotFoundException
- The requested resource wasn't found.InternalServerException
- The request failed to register with the service.public ListRepositorySyncDefinitionsResult listRepositorySyncDefinitions(ListRepositorySyncDefinitionsRequest request)
List repository sync definitions with detail data.
listRepositorySyncDefinitions
in interface AWSProton
listRepositorySyncDefinitionsRequest
- ValidationException
- The input is invalid or an out-of-range value was supplied for the input parameter.AccessDeniedException
- There isn't sufficient access for performing this action.ThrottlingException
- The request was denied due to request throttling.InternalServerException
- The request failed to register with the service.public ListServiceInstanceOutputsResult listServiceInstanceOutputs(ListServiceInstanceOutputsRequest request)
Get a list service of instance Infrastructure as Code (IaC) outputs.
listServiceInstanceOutputs
in interface AWSProton
listServiceInstanceOutputsRequest
- ValidationException
- The input is invalid or an out-of-range value was supplied for the input parameter.AccessDeniedException
- There isn't sufficient access for performing this action.ThrottlingException
- The request was denied due to request throttling.ResourceNotFoundException
- The requested resource wasn't found.InternalServerException
- The request failed to register with the service.public ListServiceInstanceProvisionedResourcesResult listServiceInstanceProvisionedResources(ListServiceInstanceProvisionedResourcesRequest request)
List provisioned resources for a service instance with details.
listServiceInstanceProvisionedResources
in interface AWSProton
listServiceInstanceProvisionedResourcesRequest
- ValidationException
- The input is invalid or an out-of-range value was supplied for the input parameter.AccessDeniedException
- There isn't sufficient access for performing this action.ThrottlingException
- The request was denied due to request throttling.ResourceNotFoundException
- The requested resource wasn't found.InternalServerException
- The request failed to register with the service.public ListServiceInstancesResult listServiceInstances(ListServiceInstancesRequest request)
List service instances with summary data. This action lists service instances of all services in the Amazon Web Services account.
listServiceInstances
in interface AWSProton
listServiceInstancesRequest
- ValidationException
- The input is invalid or an out-of-range value was supplied for the input parameter.AccessDeniedException
- There isn't sufficient access for performing this action.ThrottlingException
- The request was denied due to request throttling.ResourceNotFoundException
- The requested resource wasn't found.InternalServerException
- The request failed to register with the service.public ListServicePipelineOutputsResult listServicePipelineOutputs(ListServicePipelineOutputsRequest request)
Get a list of service pipeline Infrastructure as Code (IaC) outputs.
listServicePipelineOutputs
in interface AWSProton
listServicePipelineOutputsRequest
- ValidationException
- The input is invalid or an out-of-range value was supplied for the input parameter.AccessDeniedException
- There isn't sufficient access for performing this action.ThrottlingException
- The request was denied due to request throttling.ResourceNotFoundException
- The requested resource wasn't found.InternalServerException
- The request failed to register with the service.public ListServicePipelineProvisionedResourcesResult listServicePipelineProvisionedResources(ListServicePipelineProvisionedResourcesRequest request)
List provisioned resources for a service and pipeline with details.
listServicePipelineProvisionedResources
in interface AWSProton
listServicePipelineProvisionedResourcesRequest
- ValidationException
- The input is invalid or an out-of-range value was supplied for the input parameter.AccessDeniedException
- There isn't sufficient access for performing this action.ThrottlingException
- The request was denied due to request throttling.ResourceNotFoundException
- The requested resource wasn't found.InternalServerException
- The request failed to register with the service.public ListServiceTemplateVersionsResult listServiceTemplateVersions(ListServiceTemplateVersionsRequest request)
List major or minor versions of a service template with detail data.
listServiceTemplateVersions
in interface AWSProton
listServiceTemplateVersionsRequest
- ValidationException
- The input is invalid or an out-of-range value was supplied for the input parameter.AccessDeniedException
- There isn't sufficient access for performing this action.ThrottlingException
- The request was denied due to request throttling.ResourceNotFoundException
- The requested resource wasn't found.InternalServerException
- The request failed to register with the service.public ListServiceTemplatesResult listServiceTemplates(ListServiceTemplatesRequest request)
List service templates with detail data.
listServiceTemplates
in interface AWSProton
listServiceTemplatesRequest
- ValidationException
- The input is invalid or an out-of-range value was supplied for the input parameter.AccessDeniedException
- There isn't sufficient access for performing this action.ThrottlingException
- The request was denied due to request throttling.InternalServerException
- The request failed to register with the service.public ListServicesResult listServices(ListServicesRequest request)
List services with summaries of detail data.
listServices
in interface AWSProton
listServicesRequest
- ValidationException
- The input is invalid or an out-of-range value was supplied for the input parameter.AccessDeniedException
- There isn't sufficient access for performing this action.ThrottlingException
- The request was denied due to request throttling.InternalServerException
- The request failed to register with the service.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
List tags for a resource. For more information, see Proton resources and tagging in the Proton User Guide.
listTagsForResource
in interface AWSProton
listTagsForResourceRequest
- ValidationException
- The input is invalid or an out-of-range value was supplied for the input parameter.AccessDeniedException
- There isn't sufficient access for performing this action.ThrottlingException
- The request was denied due to request throttling.ResourceNotFoundException
- The requested resource wasn't found.InternalServerException
- The request failed to register with the service.public NotifyResourceDeploymentStatusChangeResult notifyResourceDeploymentStatusChange(NotifyResourceDeploymentStatusChangeRequest 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.
notifyResourceDeploymentStatusChange
in interface AWSProton
notifyResourceDeploymentStatusChangeRequest
- ServiceQuotaExceededException
- A quota was exceeded. For more information, see Proton Quotas in the
Proton User Guide.ValidationException
- The input is invalid or an out-of-range value was supplied for the input parameter.AccessDeniedException
- There isn't sufficient access for performing this action.ThrottlingException
- The request was denied due to request throttling.ConflictException
- The request couldn't be made due to a conflicting operation or resource.ResourceNotFoundException
- The requested resource wasn't found.InternalServerException
- The request failed to register with the service.public RejectEnvironmentAccountConnectionResult rejectEnvironmentAccountConnection(RejectEnvironmentAccountConnectionRequest 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.
rejectEnvironmentAccountConnection
in interface AWSProton
rejectEnvironmentAccountConnectionRequest
- ValidationException
- The input is invalid or an out-of-range value was supplied for the input parameter.AccessDeniedException
- There isn't sufficient access for performing this action.ThrottlingException
- The request was denied due to request throttling.ConflictException
- The request couldn't be made due to a conflicting operation or resource.ResourceNotFoundException
- The requested resource wasn't found.InternalServerException
- The request failed to register with the service.public TagResourceResult tagResource(TagResourceRequest 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.
tagResource
in interface AWSProton
tagResourceRequest
- ValidationException
- The input is invalid or an out-of-range value was supplied for the input parameter.AccessDeniedException
- There isn't sufficient access for performing this action.ThrottlingException
- The request was denied due to request throttling.ConflictException
- The request couldn't be made due to a conflicting operation or resource.ResourceNotFoundException
- The requested resource wasn't found.InternalServerException
- The request failed to register with the service.public UntagResourceResult untagResource(UntagResourceRequest 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.
untagResource
in interface AWSProton
untagResourceRequest
- ValidationException
- The input is invalid or an out-of-range value was supplied for the input parameter.AccessDeniedException
- There isn't sufficient access for performing this action.ThrottlingException
- The request was denied due to request throttling.ConflictException
- The request couldn't be made due to a conflicting operation or resource.ResourceNotFoundException
- The requested resource wasn't found.InternalServerException
- The request failed to register with the service.public UpdateAccountSettingsResult updateAccountSettings(UpdateAccountSettingsRequest request)
Update Proton settings that are used for multiple services in the Amazon Web Services account.
updateAccountSettings
in interface AWSProton
updateAccountSettingsRequest
- ValidationException
- The input is invalid or an out-of-range value was supplied for the input parameter.AccessDeniedException
- There isn't sufficient access for performing this action.ThrottlingException
- The request was denied due to request throttling.ConflictException
- The request couldn't be made due to a conflicting operation or resource.InternalServerException
- The request failed to register with the service.public UpdateComponentResult updateComponent(UpdateComponentRequest request)
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.
updateComponent
in interface AWSProton
updateComponentRequest
- ServiceQuotaExceededException
- A quota was exceeded. For more information, see Proton Quotas in the
Proton User Guide.ValidationException
- The input is invalid or an out-of-range value was supplied for the input parameter.AccessDeniedException
- There isn't sufficient access for performing this action.ThrottlingException
- The request was denied due to request throttling.ConflictException
- The request couldn't be made due to a conflicting operation or resource.ResourceNotFoundException
- The requested resource wasn't found.InternalServerException
- The request failed to register with the service.public UpdateEnvironmentResult updateEnvironment(UpdateEnvironmentRequest 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.
updateEnvironment
in interface AWSProton
updateEnvironmentRequest
- ValidationException
- The input is invalid or an out-of-range value was supplied for the input parameter.AccessDeniedException
- There isn't sufficient access for performing this action.ThrottlingException
- The request was denied due to request throttling.ConflictException
- The request couldn't be made due to a conflicting operation or resource.ResourceNotFoundException
- The requested resource wasn't found.InternalServerException
- The request failed to register with the service.public UpdateEnvironmentAccountConnectionResult updateEnvironmentAccountConnection(UpdateEnvironmentAccountConnectionRequest 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.
updateEnvironmentAccountConnection
in interface AWSProton
updateEnvironmentAccountConnectionRequest
- ValidationException
- The input is invalid or an out-of-range value was supplied for the input parameter.AccessDeniedException
- There isn't sufficient access for performing this action.ThrottlingException
- The request was denied due to request throttling.ConflictException
- The request couldn't be made due to a conflicting operation or resource.ResourceNotFoundException
- The requested resource wasn't found.InternalServerException
- The request failed to register with the service.public UpdateEnvironmentTemplateResult updateEnvironmentTemplate(UpdateEnvironmentTemplateRequest request)
Update an environment template.
updateEnvironmentTemplate
in interface AWSProton
updateEnvironmentTemplateRequest
- ValidationException
- The input is invalid or an out-of-range value was supplied for the input parameter.AccessDeniedException
- There isn't sufficient access for performing this action.ThrottlingException
- The request was denied due to request throttling.ConflictException
- The request couldn't be made due to a conflicting operation or resource.ResourceNotFoundException
- The requested resource wasn't found.InternalServerException
- The request failed to register with the service.public UpdateEnvironmentTemplateVersionResult updateEnvironmentTemplateVersion(UpdateEnvironmentTemplateVersionRequest request)
Update a major or minor version of an environment template.
updateEnvironmentTemplateVersion
in interface AWSProton
updateEnvironmentTemplateVersionRequest
- ValidationException
- The input is invalid or an out-of-range value was supplied for the input parameter.AccessDeniedException
- There isn't sufficient access for performing this action.ThrottlingException
- The request was denied due to request throttling.ConflictException
- The request couldn't be made due to a conflicting operation or resource.ResourceNotFoundException
- The requested resource wasn't found.InternalServerException
- The request failed to register with the service.public UpdateServiceResult updateService(UpdateServiceRequest request)
Edit a service description or use a spec to add and delete service instances.
Existing service instances and the service pipeline can't be edited using this API. They can only be deleted.
Use the description
parameter to modify the description.
Edit the spec
parameter to add or delete instances.
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.
updateService
in interface AWSProton
updateServiceRequest
- ServiceQuotaExceededException
- A quota was exceeded. For more information, see Proton Quotas in the
Proton User Guide.ValidationException
- The input is invalid or an out-of-range value was supplied for the input parameter.AccessDeniedException
- There isn't sufficient access for performing this action.ThrottlingException
- The request was denied due to request throttling.ConflictException
- The request couldn't be made due to a conflicting operation or resource.ResourceNotFoundException
- The requested resource wasn't found.InternalServerException
- The request failed to register with the service.public UpdateServiceInstanceResult updateServiceInstance(UpdateServiceInstanceRequest request)
Update a service instance.
There are a few modes for updating a service instance. The deploymentType
field defines the mode.
You can't update a service 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.
updateServiceInstance
in interface AWSProton
updateServiceInstanceRequest
- ValidationException
- The input is invalid or an out-of-range value was supplied for the input parameter.AccessDeniedException
- There isn't sufficient access for performing this action.ThrottlingException
- The request was denied due to request throttling.ConflictException
- The request couldn't be made due to a conflicting operation or resource.ResourceNotFoundException
- The requested resource wasn't found.InternalServerException
- The request failed to register with the service.public UpdateServicePipelineResult updateServicePipeline(UpdateServicePipelineRequest 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.
updateServicePipeline
in interface AWSProton
updateServicePipelineRequest
- ValidationException
- The input is invalid or an out-of-range value was supplied for the input parameter.AccessDeniedException
- There isn't sufficient access for performing this action.ThrottlingException
- The request was denied due to request throttling.ConflictException
- The request couldn't be made due to a conflicting operation or resource.ResourceNotFoundException
- The requested resource wasn't found.InternalServerException
- The request failed to register with the service.public UpdateServiceSyncBlockerResult updateServiceSyncBlocker(UpdateServiceSyncBlockerRequest request)
Update the service sync blocker by resolving it.
updateServiceSyncBlocker
in interface AWSProton
updateServiceSyncBlockerRequest
- ValidationException
- The input is invalid or an out-of-range value was supplied for the input parameter.AccessDeniedException
- There isn't sufficient access for performing this action.ThrottlingException
- The request was denied due to request throttling.ConflictException
- The request couldn't be made due to a conflicting operation or resource.ResourceNotFoundException
- The requested resource wasn't found.InternalServerException
- The request failed to register with the service.public UpdateServiceSyncConfigResult updateServiceSyncConfig(UpdateServiceSyncConfigRequest request)
Update the Proton Ops config file.
updateServiceSyncConfig
in interface AWSProton
updateServiceSyncConfigRequest
- ValidationException
- The input is invalid or an out-of-range value was supplied for the input parameter.AccessDeniedException
- There isn't sufficient access for performing this action.ThrottlingException
- The request was denied due to request throttling.ConflictException
- The request couldn't be made due to a conflicting operation or resource.ResourceNotFoundException
- The requested resource wasn't found.InternalServerException
- The request failed to register with the service.public UpdateServiceTemplateResult updateServiceTemplate(UpdateServiceTemplateRequest request)
Update a service template.
updateServiceTemplate
in interface AWSProton
updateServiceTemplateRequest
- ValidationException
- The input is invalid or an out-of-range value was supplied for the input parameter.AccessDeniedException
- There isn't sufficient access for performing this action.ThrottlingException
- The request was denied due to request throttling.ConflictException
- The request couldn't be made due to a conflicting operation or resource.ResourceNotFoundException
- The requested resource wasn't found.InternalServerException
- The request failed to register with the service.public UpdateServiceTemplateVersionResult updateServiceTemplateVersion(UpdateServiceTemplateVersionRequest request)
Update a major or minor version of a service template.
updateServiceTemplateVersion
in interface AWSProton
updateServiceTemplateVersionRequest
- ValidationException
- The input is invalid or an out-of-range value was supplied for the input parameter.AccessDeniedException
- There isn't sufficient access for performing this action.ThrottlingException
- The request was denied due to request throttling.ConflictException
- The request couldn't be made due to a conflicting operation or resource.ResourceNotFoundException
- The requested resource wasn't found.InternalServerException
- The request failed to register with the service.public UpdateTemplateSyncConfigResult updateTemplateSyncConfig(UpdateTemplateSyncConfigRequest 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.
updateTemplateSyncConfig
in interface AWSProton
updateTemplateSyncConfigRequest
- ValidationException
- The input is invalid or an out-of-range value was supplied for the input parameter.AccessDeniedException
- There isn't sufficient access for performing this action.ThrottlingException
- The request was denied due to request throttling.ConflictException
- The request couldn't be made due to a conflicting operation or resource.ResourceNotFoundException
- The requested resource wasn't found.InternalServerException
- The request failed to register with the service.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
getCachedResponseMetadata
in interface AWSProton
request
- The originally executed requestpublic AWSProtonWaiters waiters()
public void shutdown()
AmazonWebServiceClient
shutdown
in interface AWSProton
shutdown
in class AmazonWebServiceClient