AWSProtonClient (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceClient
- - com.amazonaws.services.proton.AWSProtonClient

All Implemented Interfaces:

AWSProton

Direct Known Subclasses:

AWSProtonAsyncClient
```
@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSProtonClient
extends AmazonWebServiceClient
implements AWSProton
```
Client for accessing AWS Proton. All service calls made using this client are blocking, and will not return until the service call completes.

This is the AWS Proton Service API Reference. It provides descriptions, syntax and usage examples for each of the actions and data types for the AWS Proton service.

The documentation for each action shows the Query API request parameters and the XML response.

Alternatively, you can use the AWS CLI to access an API. For more information, see the AWS Command Line Interface User Guide.

The AWS 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 AWS Proton deploys and manages, they need permissions to use all of the listed API operations.

When developers select a specific infrastructure and tooling set, AWS Proton deploys their applications. To monitor their applications that are running on AWS 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 AWS Proton administration, see the AWS Proton Administrator Guide.

To learn more about deploying serverless and containerized applications on AWS Proton, see the AWS 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 AWS 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

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceClient
  LOGGING_AWS_REQUEST_METRIC
- Fields inherited from interface com.amazonaws.services.proton.AWSProton
  ENDPOINT_PREFIX

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AcceptEnvironmentAccountConnectionResult`	`acceptEnvironmentAccountConnection(AcceptEnvironmentAccountConnectionRequest request)` In a management account, an environment account connection request is accepted.
`static AWSProtonClientBuilder`	`builder()`
`CancelEnvironmentDeploymentResult`	`cancelEnvironmentDeployment(CancelEnvironmentDeploymentRequest request)` Attempts to cancel an environment deployment on an UpdateEnvironment action, if the deployment is `IN_PROGRESS`.
`CancelServiceInstanceDeploymentResult`	`cancelServiceInstanceDeployment(CancelServiceInstanceDeploymentRequest request)` Attempts to cancel a service instance deployment on an UpdateServiceInstance action, if the deployment is `IN_PROGRESS`.
`CancelServicePipelineDeploymentResult`	`cancelServicePipelineDeployment(CancelServicePipelineDeploymentRequest request)` Attempts to cancel a service pipeline deployment on an UpdateServicePipeline action, if the deployment is `IN_PROGRESS`.
`CreateEnvironmentResult`	`createEnvironment(CreateEnvironmentRequest request)` Deploy a new environment.
`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.
`CreateEnvironmentTemplateResult`	`createEnvironmentTemplate(CreateEnvironmentTemplateRequest request)` Create an environment template for AWS Proton.
`CreateEnvironmentTemplateVersionResult`	`createEnvironmentTemplateVersion(CreateEnvironmentTemplateVersionRequest request)` Create a new major or minor version of an environment template.
`CreateServiceResult`	`createService(CreateServiceRequest request)` Create an AWS Proton service.
`CreateServiceTemplateResult`	`createServiceTemplate(CreateServiceTemplateRequest request)` Create a service template.
`CreateServiceTemplateVersionResult`	`createServiceTemplateVersion(CreateServiceTemplateVersionRequest request)` Create a new major or minor version of a service template.
`DeleteEnvironmentResult`	`deleteEnvironment(DeleteEnvironmentRequest request)` Delete an environment.
`DeleteEnvironmentAccountConnectionResult`	`deleteEnvironmentAccountConnection(DeleteEnvironmentAccountConnectionRequest request)` In an environment account, delete an environment account connection.
`DeleteEnvironmentTemplateResult`	`deleteEnvironmentTemplate(DeleteEnvironmentTemplateRequest request)` If no other major or minor versions of an environment template exist, delete the environment template.
`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.
`DeleteServiceResult`	`deleteService(DeleteServiceRequest request)` Delete a service.
`DeleteServiceTemplateResult`	`deleteServiceTemplate(DeleteServiceTemplateRequest request)` If no other major or minor versions of the service template exist, delete the service template.
`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.
`GetAccountSettingsResult`	`getAccountSettings(GetAccountSettingsRequest request)` Get detail data for the AWS Proton pipeline service role.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
`GetEnvironmentResult`	`getEnvironment(GetEnvironmentRequest request)` Get detail data for an environment.
`GetEnvironmentAccountConnectionResult`	`getEnvironmentAccountConnection(GetEnvironmentAccountConnectionRequest request)` In an environment account, view the detail data for an environment account connection.
`GetEnvironmentTemplateResult`	`getEnvironmentTemplate(GetEnvironmentTemplateRequest request)` Get detail data for an environment template.
`GetEnvironmentTemplateVersionResult`	`getEnvironmentTemplateVersion(GetEnvironmentTemplateVersionRequest request)` View detail data for a major or minor version of an environment template.
`GetServiceResult`	`getService(GetServiceRequest request)` Get detail data for a service.
`GetServiceInstanceResult`	`getServiceInstance(GetServiceInstanceRequest request)` Get detail data for a service instance.
`GetServiceTemplateResult`	`getServiceTemplate(GetServiceTemplateRequest request)` Get detail data for a service template.
`GetServiceTemplateVersionResult`	`getServiceTemplateVersion(GetServiceTemplateVersionRequest request)` View detail data for a major or minor version of a service template.
`ListEnvironmentAccountConnectionsResult`	`listEnvironmentAccountConnections(ListEnvironmentAccountConnectionsRequest request)` View a list of environment account connections.
`ListEnvironmentsResult`	`listEnvironments(ListEnvironmentsRequest request)` List environments with detail data summaries.
`ListEnvironmentTemplatesResult`	`listEnvironmentTemplates(ListEnvironmentTemplatesRequest request)` List environment templates.
`ListEnvironmentTemplateVersionsResult`	`listEnvironmentTemplateVersions(ListEnvironmentTemplateVersionsRequest request)` List major or minor versions of an environment template with detail data.
`ListServiceInstancesResult`	`listServiceInstances(ListServiceInstancesRequest request)` List service instances with summaries of detail data.
`ListServicesResult`	`listServices(ListServicesRequest request)` List services with summaries of detail data.
`ListServiceTemplatesResult`	`listServiceTemplates(ListServiceTemplatesRequest request)` List service templates with detail data.
`ListServiceTemplateVersionsResult`	`listServiceTemplateVersions(ListServiceTemplateVersionsRequest request)` List major or minor versions of a service template with detail data.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest request)` List tags for a resource.
`RejectEnvironmentAccountConnectionResult`	`rejectEnvironmentAccountConnection(RejectEnvironmentAccountConnectionRequest request)` In a management account, reject an environment account connection from another environment account.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`TagResourceResult`	`tagResource(TagResourceRequest request)` Tag a resource.
`UntagResourceResult`	`untagResource(UntagResourceRequest request)` Remove a tag from a resource.
`UpdateAccountSettingsResult`	`updateAccountSettings(UpdateAccountSettingsRequest request)` Update the AWS Proton pipeline service account settings.
`UpdateEnvironmentResult`	`updateEnvironment(UpdateEnvironmentRequest request)` Update an environment.
`UpdateEnvironmentAccountConnectionResult`	`updateEnvironmentAccountConnection(UpdateEnvironmentAccountConnectionRequest request)` In an environment account, update an environment account connection to use a new IAM role.
`UpdateEnvironmentTemplateResult`	`updateEnvironmentTemplate(UpdateEnvironmentTemplateRequest request)` Update an environment template.
`UpdateEnvironmentTemplateVersionResult`	`updateEnvironmentTemplateVersion(UpdateEnvironmentTemplateVersionRequest request)` Update a major or minor version of an environment template.
`UpdateServiceResult`	`updateService(UpdateServiceRequest request)` Edit a service description or use a spec to add and delete service instances.
`UpdateServiceInstanceResult`	`updateServiceInstance(UpdateServiceInstanceRequest request)` Update a service instance.
`UpdateServicePipelineResult`	`updateServicePipeline(UpdateServicePipelineRequest request)` Update the service pipeline.
`UpdateServiceTemplateResult`	`updateServiceTemplate(UpdateServiceTemplateRequest request)` Update a service template.
`UpdateServiceTemplateVersionResult`	`updateServiceTemplateVersion(UpdateServiceTemplateVersionRequest request)` Update a major or minor version of a service template.
`AWSProtonWaiters`	`waiters()`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - builder
```
public static AWSProtonClientBuilder builder()
```
  - acceptEnvironmentAccountConnection
```
public AcceptEnvironmentAccountConnectionResult acceptEnvironmentAccountConnection(AcceptEnvironmentAccountConnectionRequest request)
```
    In a management account, an environment account connection request is accepted. When the environment account connection request is accepted, AWS 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 AWS Proton Administrator guide.
    
    Specified by:
    
    acceptEnvironmentAccountConnection in interface AWSProton
    
    Parameters:
    
    acceptEnvironmentAccountConnectionRequest -
    
    Returns:
    
    Result of the AcceptEnvironmentAccountConnection operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - cancelEnvironmentDeployment
```
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 AWS Proton Administrator 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.
    Specified by:
    
    cancelEnvironmentDeployment in interface AWSProton
    
    Parameters:
    
    cancelEnvironmentDeploymentRequest -
    
    Returns:
    
    Result of the CancelEnvironmentDeployment operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - cancelServiceInstanceDeployment
```
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 AWS Proton Administrator guide or the AWS 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.
    Specified by:
    
    cancelServiceInstanceDeployment in interface AWSProton
    
    Parameters:
    
    cancelServiceInstanceDeploymentRequest -
    
    Returns:
    
    Result of the CancelServiceInstanceDeployment operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - cancelServicePipelineDeployment
```
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 AWS Proton Administrator guide or the AWS 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.
    Specified by:
    
    cancelServicePipelineDeployment in interface AWSProton
    
    Parameters:
    
    cancelServicePipelineDeploymentRequest -
    
    Returns:
    
    Result of the CancelServicePipelineDeployment operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - createEnvironment
```
public CreateEnvironmentResult createEnvironment(CreateEnvironmentRequest request)
```
    Deploy a new environment. An AWS Proton environment is created from an environment template that defines infrastructure and resources that can be shared across services. For more information, see the Environments in the AWS Proton Administrator Guide.
    
    Specified by:
    
    createEnvironment in interface AWSProton
    
    Parameters:
    
    createEnvironmentRequest -
    
    Returns:
    
    Result of the CreateEnvironment operation returned by the service.
    
    Throws:
    
    ServiceQuotaExceededException - A quota was exceeded. For more information, see AWS Proton Quotas in the AWS Proton Administrator 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.
    
    See Also:
    
    AWS API Documentation
  - createEnvironmentAccountConnection
```
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 AWS Proton Administrator guide.
    
    Specified by:
    
    createEnvironmentAccountConnection in interface AWSProton
    
    Parameters:
    
    createEnvironmentAccountConnectionRequest -
    
    Returns:
    
    Result of the CreateEnvironmentAccountConnection operation returned by the service.
    
    Throws:
    
    ServiceQuotaExceededException - A quota was exceeded. For more information, see AWS Proton Quotas in the AWS Proton Administrator 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.
    
    See Also:
    
    AWS API Documentation
  - createEnvironmentTemplate
```
public CreateEnvironmentTemplateResult createEnvironmentTemplate(CreateEnvironmentTemplateRequest request)
```
    Create an environment template for AWS Proton. For more information, see Environment Templates in the AWS Proton Administrator Guide.
    
    You can create an environment template in one of the two following ways:
    - Register and publish a standard environment template that instructs AWS Proton to deploy and manage environment infrastructure.
    - Register and publish a customer managed environment template that connects AWS Proton to your existing provisioned infrastructure that you manage. AWS 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 AWS Proton Administrator Guide.
    Specified by:
    
    createEnvironmentTemplate in interface AWSProton
    
    Parameters:
    
    createEnvironmentTemplateRequest -
    
    Returns:
    
    Result of the CreateEnvironmentTemplate operation returned by the service.
    
    Throws:
    
    ServiceQuotaExceededException - A quota was exceeded. For more information, see AWS Proton Quotas in the AWS Proton Administrator 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.
    
    See Also:
    
    AWS API Documentation
  - createEnvironmentTemplateVersion
```
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.
    
    Specified by:
    
    createEnvironmentTemplateVersion in interface AWSProton
    
    Parameters:
    
    createEnvironmentTemplateVersionRequest -
    
    Returns:
    
    Result of the CreateEnvironmentTemplateVersion operation returned by the service.
    
    Throws:
    
    ServiceQuotaExceededException - A quota was exceeded. For more information, see AWS Proton Quotas in the AWS Proton Administrator 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.
    
    See Also:
    
    AWS API Documentation
  - createService
```
public CreateServiceResult createService(CreateServiceRequest request)
```
    Create an AWS Proton service. An AWS Proton service is an instantiation of a service template and often includes several service instances and pipeline. For more information, see Services in the AWS Proton Administrator Guide and Services in the AWS Proton User Guide.
    
    Specified by:
    
    createService in interface AWSProton
    
    Parameters:
    
    createServiceRequest -
    
    Returns:
    
    Result of the CreateService operation returned by the service.
    
    Throws:
    
    ServiceQuotaExceededException - A quota was exceeded. For more information, see AWS Proton Quotas in the AWS Proton Administrator 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.
    
    See Also:
    
    AWS API Documentation
  - createServiceTemplate
```
public CreateServiceTemplateResult createServiceTemplate(CreateServiceTemplateRequest request)
```
    Create a service template. The administrator creates a service template to define standardized infrastructure and an optional CICD service pipeline. Developers, in turn, select the service template from AWS Proton. If the selected service template includes a service pipeline definition, they provide a link to their source code repository. AWS Proton then deploys and manages the infrastructure defined by the selected service template. For more information, see Service Templates in the AWS Proton Administrator Guide.
    
    Specified by:
    
    createServiceTemplate in interface AWSProton
    
    Parameters:
    
    createServiceTemplateRequest -
    
    Returns:
    
    Result of the CreateServiceTemplate operation returned by the service.
    
    Throws:
    
    ServiceQuotaExceededException - A quota was exceeded. For more information, see AWS Proton Quotas in the AWS Proton Administrator 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.
    
    See Also:
    
    AWS API Documentation
  - createServiceTemplateVersion
```
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 backwards compatible. A minor version of a service template is a version that's backwards compatible within its major version.
    
    Specified by:
    
    createServiceTemplateVersion in interface AWSProton
    
    Parameters:
    
    createServiceTemplateVersionRequest -
    
    Returns:
    
    Result of the CreateServiceTemplateVersion operation returned by the service.
    
    Throws:
    
    ServiceQuotaExceededException - A quota was exceeded. For more information, see AWS Proton Quotas in the AWS Proton Administrator 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.
    
    See Also:
    
    AWS API Documentation
  - deleteEnvironment
```
public DeleteEnvironmentResult deleteEnvironment(DeleteEnvironmentRequest request)
```
    Delete an environment.
    
    Specified by:
    
    deleteEnvironment in interface AWSProton
    
    Parameters:
    
    deleteEnvironmentRequest -
    
    Returns:
    
    Result of the DeleteEnvironment operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - deleteEnvironmentAccountConnection
```
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 AWS Proton environment, AWS 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 AWS Proton Administrator guide.
    
    Specified by:
    
    deleteEnvironmentAccountConnection in interface AWSProton
    
    Parameters:
    
    deleteEnvironmentAccountConnectionRequest -
    
    Returns:
    
    Result of the DeleteEnvironmentAccountConnection operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - deleteEnvironmentTemplate
```
public DeleteEnvironmentTemplateResult deleteEnvironmentTemplate(DeleteEnvironmentTemplateRequest request)
```
    If no other major or minor versions of an environment template exist, delete the environment template.
    
    Specified by:
    
    deleteEnvironmentTemplate in interface AWSProton
    
    Parameters:
    
    deleteEnvironmentTemplateRequest -
    
    Returns:
    
    Result of the DeleteEnvironmentTemplate operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - deleteEnvironmentTemplateVersion
```
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 backwards 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 backwards compatible.
    
    Specified by:
    
    deleteEnvironmentTemplateVersion in interface AWSProton
    
    Parameters:
    
    deleteEnvironmentTemplateVersionRequest -
    
    Returns:
    
    Result of the DeleteEnvironmentTemplateVersion operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - deleteService
```
public DeleteServiceResult deleteService(DeleteServiceRequest request)
```
    Delete a service.
    
    Specified by:
    
    deleteService in interface AWSProton
    
    Parameters:
    
    deleteServiceRequest -
    
    Returns:
    
    Result of the DeleteService operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - deleteServiceTemplate
```
public DeleteServiceTemplateResult deleteServiceTemplate(DeleteServiceTemplateRequest request)
```
    If no other major or minor versions of the service template exist, delete the service template.
    
    Specified by:
    
    deleteServiceTemplate in interface AWSProton
    
    Parameters:
    
    deleteServiceTemplateRequest -
    
    Returns:
    
    Result of the DeleteServiceTemplate operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - deleteServiceTemplateVersion
```
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.
    
    Specified by:
    
    deleteServiceTemplateVersion in interface AWSProton
    
    Parameters:
    
    deleteServiceTemplateVersionRequest -
    
    Returns:
    
    Result of the DeleteServiceTemplateVersion operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - getAccountSettings
```
public GetAccountSettingsResult getAccountSettings(GetAccountSettingsRequest request)
```
    Get detail data for the AWS Proton pipeline service role.
    
    Specified by:
    
    getAccountSettings in interface AWSProton
    
    Parameters:
    
    getAccountSettingsRequest -
    
    Returns:
    
    Result of the GetAccountSettings operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - getEnvironment
```
public GetEnvironmentResult getEnvironment(GetEnvironmentRequest request)
```
    Get detail data for an environment.
    
    Specified by:
    
    getEnvironment in interface AWSProton
    
    Parameters:
    
    getEnvironmentRequest -
    
    Returns:
    
    Result of the GetEnvironment operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - getEnvironmentAccountConnection
```
public GetEnvironmentAccountConnectionResult getEnvironmentAccountConnection(GetEnvironmentAccountConnectionRequest request)
```
    In an environment account, view the detail data for an environment account connection.
    
    For more information, see Environment account connections in the AWS Proton Administrator guide.
    
    Specified by:
    
    getEnvironmentAccountConnection in interface AWSProton
    
    Parameters:
    
    getEnvironmentAccountConnectionRequest -
    
    Returns:
    
    Result of the GetEnvironmentAccountConnection operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - getEnvironmentTemplate
```
public GetEnvironmentTemplateResult getEnvironmentTemplate(GetEnvironmentTemplateRequest request)
```
    Get detail data for an environment template.
    
    Specified by:
    
    getEnvironmentTemplate in interface AWSProton
    
    Parameters:
    
    getEnvironmentTemplateRequest -
    
    Returns:
    
    Result of the GetEnvironmentTemplate operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - getEnvironmentTemplateVersion
```
public GetEnvironmentTemplateVersionResult getEnvironmentTemplateVersion(GetEnvironmentTemplateVersionRequest request)
```
    View detail data for a major or minor version of an environment template.
    
    Specified by:
    
    getEnvironmentTemplateVersion in interface AWSProton
    
    Parameters:
    
    getEnvironmentTemplateVersionRequest -
    
    Returns:
    
    Result of the GetEnvironmentTemplateVersion operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - getService
```
public GetServiceResult getService(GetServiceRequest request)
```
    Get detail data for a service.
    
    Specified by:
    
    getService in interface AWSProton
    
    Parameters:
    
    getServiceRequest -
    
    Returns:
    
    Result of the GetService operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - getServiceInstance
```
public GetServiceInstanceResult getServiceInstance(GetServiceInstanceRequest request)
```
    Get detail data for a service instance. A service instance is an instantiation of service template, which is running in a specific environment.
    
    Specified by:
    
    getServiceInstance in interface AWSProton
    
    Parameters:
    
    getServiceInstanceRequest -
    
    Returns:
    
    Result of the GetServiceInstance operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - getServiceTemplate
```
public GetServiceTemplateResult getServiceTemplate(GetServiceTemplateRequest request)
```
    Get detail data for a service template.
    
    Specified by:
    
    getServiceTemplate in interface AWSProton
    
    Parameters:
    
    getServiceTemplateRequest -
    
    Returns:
    
    Result of the GetServiceTemplate operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - getServiceTemplateVersion
```
public GetServiceTemplateVersionResult getServiceTemplateVersion(GetServiceTemplateVersionRequest request)
```
    View detail data for a major or minor version of a service template.
    
    Specified by:
    
    getServiceTemplateVersion in interface AWSProton
    
    Parameters:
    
    getServiceTemplateVersionRequest -
    
    Returns:
    
    Result of the GetServiceTemplateVersion operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listEnvironmentAccountConnections
```
public ListEnvironmentAccountConnectionsResult listEnvironmentAccountConnections(ListEnvironmentAccountConnectionsRequest request)
```
    View a list of environment account connections.
    
    For more information, see Environment account connections in the AWS Proton Administrator guide.
    
    Specified by:
    
    listEnvironmentAccountConnections in interface AWSProton
    
    Parameters:
    
    listEnvironmentAccountConnectionsRequest -
    
    Returns:
    
    Result of the ListEnvironmentAccountConnections operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listEnvironmentTemplateVersions
```
public ListEnvironmentTemplateVersionsResult listEnvironmentTemplateVersions(ListEnvironmentTemplateVersionsRequest request)
```
    List major or minor versions of an environment template with detail data.
    
    Specified by:
    
    listEnvironmentTemplateVersions in interface AWSProton
    
    Parameters:
    
    listEnvironmentTemplateVersionsRequest -
    
    Returns:
    
    Result of the ListEnvironmentTemplateVersions operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listEnvironmentTemplates
```
public ListEnvironmentTemplatesResult listEnvironmentTemplates(ListEnvironmentTemplatesRequest request)
```
    List environment templates.
    
    Specified by:
    
    listEnvironmentTemplates in interface AWSProton
    
    Parameters:
    
    listEnvironmentTemplatesRequest -
    
    Returns:
    
    Result of the ListEnvironmentTemplates operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listEnvironments
```
public ListEnvironmentsResult listEnvironments(ListEnvironmentsRequest request)
```
    List environments with detail data summaries.
    
    Specified by:
    
    listEnvironments in interface AWSProton
    
    Parameters:
    
    listEnvironmentsRequest -
    
    Returns:
    
    Result of the ListEnvironments operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listServiceInstances
```
public ListServiceInstancesResult listServiceInstances(ListServiceInstancesRequest request)
```
    List service instances with summaries of detail data.
    
    Specified by:
    
    listServiceInstances in interface AWSProton
    
    Parameters:
    
    listServiceInstancesRequest -
    
    Returns:
    
    Result of the ListServiceInstances operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listServiceTemplateVersions
```
public ListServiceTemplateVersionsResult listServiceTemplateVersions(ListServiceTemplateVersionsRequest request)
```
    List major or minor versions of a service template with detail data.
    
    Specified by:
    
    listServiceTemplateVersions in interface AWSProton
    
    Parameters:
    
    listServiceTemplateVersionsRequest -
    
    Returns:
    
    Result of the ListServiceTemplateVersions operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listServiceTemplates
```
public ListServiceTemplatesResult listServiceTemplates(ListServiceTemplatesRequest request)
```
    List service templates with detail data.
    
    Specified by:
    
    listServiceTemplates in interface AWSProton
    
    Parameters:
    
    listServiceTemplatesRequest -
    
    Returns:
    
    Result of the ListServiceTemplates operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listServices
```
public ListServicesResult listServices(ListServicesRequest request)
```
    List services with summaries of detail data.
    
    Specified by:
    
    listServices in interface AWSProton
    
    Parameters:
    
    listServicesRequest -
    
    Returns:
    
    Result of the ListServices operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    List tags for a resource. For more information, see AWS Proton resources and tagging in the AWS Proton Administrator Guide or AWS Proton User Guide.
    
    Specified by:
    
    listTagsForResource in interface AWSProton
    
    Parameters:
    
    listTagsForResourceRequest -
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - rejectEnvironmentAccountConnection
```
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 won’t be able to accept or use the rejected environment account connection.
    
    You can’t reject an environment account connection that is connected to an environment.
    
    For more information, see Environment account connections in the AWS Proton Administrator guide.
    
    Specified by:
    
    rejectEnvironmentAccountConnection in interface AWSProton
    
    Parameters:
    
    rejectEnvironmentAccountConnectionRequest -
    
    Returns:
    
    Result of the RejectEnvironmentAccountConnection operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    Tag a resource. For more information, see AWS Proton resources and tagging in the AWS Proton Administrator Guide or AWS Proton User Guide.
    
    Specified by:
    
    tagResource in interface AWSProton
    
    Parameters:
    
    tagResourceRequest -
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Remove a tag from a resource. For more information, see AWS Proton resources and tagging in the AWS Proton Administrator Guide or AWS Proton User Guide.
    
    Specified by:
    
    untagResource in interface AWSProton
    
    Parameters:
    
    untagResourceRequest -
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - updateAccountSettings
```
public UpdateAccountSettingsResult updateAccountSettings(UpdateAccountSettingsRequest request)
```
    Update the AWS Proton pipeline service account settings.
    
    Specified by:
    
    updateAccountSettings in interface AWSProton
    
    Parameters:
    
    updateAccountSettingsRequest -
    
    Returns:
    
    Result of the UpdateAccountSettings operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - updateEnvironment
```
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 parameter to update or connect to an environment account connection.
    
    You can only update to a new environment account connection if it was created in the same environment account that the current environment account connection was created in and is associated with the current environment.
    
    If the environment isn't associated with an environment account connection, don't update or include the environmentAccountConnectionId parameter to update or connect to an environment account connection.
    
    You can update either the environmentAccountConnectionId or protonServiceRoleArn parameter and value. You can’t update both.
    
    There are four modes for updating an environment as described in the following. 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 (optional).
    
    Specified by:
    
    updateEnvironment in interface AWSProton
    
    Parameters:
    
    updateEnvironmentRequest -
    
    Returns:
    
    Result of the UpdateEnvironment operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - updateEnvironmentAccountConnection
```
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 AWS Proton Administrator guide.
    
    Specified by:
    
    updateEnvironmentAccountConnection in interface AWSProton
    
    Parameters:
    
    updateEnvironmentAccountConnectionRequest -
    
    Returns:
    
    Result of the UpdateEnvironmentAccountConnection operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - updateEnvironmentTemplate
```
public UpdateEnvironmentTemplateResult updateEnvironmentTemplate(UpdateEnvironmentTemplateRequest request)
```
    Update an environment template.
    
    Specified by:
    
    updateEnvironmentTemplate in interface AWSProton
    
    Parameters:
    
    updateEnvironmentTemplateRequest -
    
    Returns:
    
    Result of the UpdateEnvironmentTemplate operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - updateEnvironmentTemplateVersion
```
public UpdateEnvironmentTemplateVersionResult updateEnvironmentTemplateVersion(UpdateEnvironmentTemplateVersionRequest request)
```
    Update a major or minor version of an environment template.
    
    Specified by:
    
    updateEnvironmentTemplateVersion in interface AWSProton
    
    Parameters:
    
    updateEnvironmentTemplateVersionRequest -
    
    Returns:
    
    Result of the UpdateEnvironmentTemplateVersion operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - updateService
```
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.
    
    Specified by:
    
    updateService in interface AWSProton
    
    Parameters:
    
    updateServiceRequest -
    
    Returns:
    
    Result of the UpdateService operation returned by the service.
    
    Throws:
    
    ServiceQuotaExceededException - A quota was exceeded. For more information, see AWS Proton Quotas in the AWS Proton Administrator 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.
    
    See Also:
    
    AWS API Documentation
  - updateServiceInstance
```
public UpdateServiceInstanceResult updateServiceInstance(UpdateServiceInstanceRequest request)
```
    Update a service instance.
    
    There are four modes for updating a service instance as described in the following. 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 instance 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 service instance 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 service instance 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 is higher than the major version in use and a minor version (optional).
    
    Specified by:
    
    updateServiceInstance in interface AWSProton
    
    Parameters:
    
    updateServiceInstanceRequest -
    
    Returns:
    
    Result of the UpdateServiceInstance operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - updateServicePipeline
```
public UpdateServicePipelineResult updateServicePipeline(UpdateServicePipelineRequest request)
```
    Update the service pipeline.
    
    There are four modes for updating a service pipeline as described in the following. 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 minor or major 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 also 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 also specify a different major version that is higher than the major version in use and a minor version (optional).
    
    Specified by:
    
    updateServicePipeline in interface AWSProton
    
    Parameters:
    
    updateServicePipelineRequest -
    
    Returns:
    
    Result of the UpdateServicePipeline operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - updateServiceTemplate
```
public UpdateServiceTemplateResult updateServiceTemplate(UpdateServiceTemplateRequest request)
```
    Update a service template.
    
    Specified by:
    
    updateServiceTemplate in interface AWSProton
    
    Parameters:
    
    updateServiceTemplateRequest -
    
    Returns:
    
    Result of the UpdateServiceTemplate operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - updateServiceTemplateVersion
```
public UpdateServiceTemplateVersionResult updateServiceTemplateVersion(UpdateServiceTemplateVersionRequest request)
```
    Update a major or minor version of a service template.
    
    Specified by:
    
    updateServiceTemplateVersion in interface AWSProton
    
    Parameters:
    
    updateServiceTemplateVersionRequest -
    
    Returns:
    
    Result of the UpdateServiceTemplateVersion operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    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.
    
    Specified by:
    
    getCachedResponseMetadata in interface AWSProton
    
    Parameters:
    
    request - The originally executed request
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.
  - waiters
```
public AWSProtonWaiters waiters()
```
    Specified by:
    
    waiters in interface AWSProton
  - shutdown
```
public void shutdown()
```
    Description copied from class: AmazonWebServiceClient
    
    Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AWSProton
    
    Overrides:
    
    shutdown in class AmazonWebServiceClient

Did this page help you?

Class AWSProtonClient

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

Fields inherited from interface com.amazonaws.services.proton.AWSProton

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceClient

Methods inherited from class java.lang.Object

Method Detail

builder

acceptEnvironmentAccountConnection

cancelEnvironmentDeployment

cancelServiceInstanceDeployment

cancelServicePipelineDeployment

createEnvironment

createEnvironmentAccountConnection

createEnvironmentTemplate

createEnvironmentTemplateVersion

createService

createServiceTemplate

createServiceTemplateVersion

deleteEnvironment

deleteEnvironmentAccountConnection

deleteEnvironmentTemplate

deleteEnvironmentTemplateVersion

deleteService

deleteServiceTemplate

deleteServiceTemplateVersion

getAccountSettings

getEnvironment

getEnvironmentAccountConnection

getEnvironmentTemplate

getEnvironmentTemplateVersion

getService

getServiceInstance

getServiceTemplate

getServiceTemplateVersion

listEnvironmentAccountConnections

listEnvironmentTemplateVersions

listEnvironmentTemplates

listEnvironments

listServiceInstances

listServiceTemplateVersions

listServiceTemplates

listServices

listTagsForResource

rejectEnvironmentAccountConnection

tagResource

untagResource

updateAccountSettings

updateEnvironment

updateEnvironmentAccountConnection

updateEnvironmentTemplate

updateEnvironmentTemplateVersion

updateService

updateServiceInstance

updateServicePipeline

updateServiceTemplate

updateServiceTemplateVersion

getCachedResponseMetadata

waiters

shutdown