AWSProton (AWS SDK for Java

All Known Subinterfaces:

AWSProtonAsync

All Known Implementing Classes:

AbstractAWSProton, AbstractAWSProtonAsync, AWSProtonAsyncClient, AWSProtonClient
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSProton
```
Interface for accessing AWS Proton.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSProton instead.

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
Modifier and Type Field and Description

static String ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.

Fields
Modifier and Type	Field and Description
`static String`	`ENDPOINT_PREFIX` The region metadata service name for computing region endpoints.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`AcceptEnvironmentAccountConnectionResult`	`acceptEnvironmentAccountConnection(AcceptEnvironmentAccountConnectionRequest acceptEnvironmentAccountConnectionRequest)` In a management account, an environment account connection request is accepted.
`CancelEnvironmentDeploymentResult`	`cancelEnvironmentDeployment(CancelEnvironmentDeploymentRequest cancelEnvironmentDeploymentRequest)` Attempts to cancel an environment deployment on an UpdateEnvironment action, if the deployment is `IN_PROGRESS`.
`CancelServiceInstanceDeploymentResult`	`cancelServiceInstanceDeployment(CancelServiceInstanceDeploymentRequest cancelServiceInstanceDeploymentRequest)` Attempts to cancel a service instance deployment on an UpdateServiceInstance action, if the deployment is `IN_PROGRESS`.
`CancelServicePipelineDeploymentResult`	`cancelServicePipelineDeployment(CancelServicePipelineDeploymentRequest cancelServicePipelineDeploymentRequest)` Attempts to cancel a service pipeline deployment on an UpdateServicePipeline action, if the deployment is `IN_PROGRESS`.
`CreateEnvironmentResult`	`createEnvironment(CreateEnvironmentRequest createEnvironmentRequest)` Deploy a new environment.
`CreateEnvironmentAccountConnectionResult`	`createEnvironmentAccountConnection(CreateEnvironmentAccountConnectionRequest createEnvironmentAccountConnectionRequest)` 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 createEnvironmentTemplateRequest)` Create an environment template for AWS Proton.
`CreateEnvironmentTemplateVersionResult`	`createEnvironmentTemplateVersion(CreateEnvironmentTemplateVersionRequest createEnvironmentTemplateVersionRequest)` Create a new major or minor version of an environment template.
`CreateServiceResult`	`createService(CreateServiceRequest createServiceRequest)` Create an AWS Proton service.
`CreateServiceTemplateResult`	`createServiceTemplate(CreateServiceTemplateRequest createServiceTemplateRequest)` Create a service template.
`CreateServiceTemplateVersionResult`	`createServiceTemplateVersion(CreateServiceTemplateVersionRequest createServiceTemplateVersionRequest)` Create a new major or minor version of a service template.
`DeleteEnvironmentResult`	`deleteEnvironment(DeleteEnvironmentRequest deleteEnvironmentRequest)` Delete an environment.
`DeleteEnvironmentAccountConnectionResult`	`deleteEnvironmentAccountConnection(DeleteEnvironmentAccountConnectionRequest deleteEnvironmentAccountConnectionRequest)` In an environment account, delete an environment account connection.
`DeleteEnvironmentTemplateResult`	`deleteEnvironmentTemplate(DeleteEnvironmentTemplateRequest deleteEnvironmentTemplateRequest)` If no other major or minor versions of an environment template exist, delete the environment template.
`DeleteEnvironmentTemplateVersionResult`	`deleteEnvironmentTemplateVersion(DeleteEnvironmentTemplateVersionRequest deleteEnvironmentTemplateVersionRequest)` 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 deleteServiceRequest)` Delete a service.
`DeleteServiceTemplateResult`	`deleteServiceTemplate(DeleteServiceTemplateRequest deleteServiceTemplateRequest)` If no other major or minor versions of the service template exist, delete the service template.
`DeleteServiceTemplateVersionResult`	`deleteServiceTemplateVersion(DeleteServiceTemplateVersionRequest deleteServiceTemplateVersionRequest)` 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 getAccountSettingsRequest)` 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 getEnvironmentRequest)` Get detail data for an environment.
`GetEnvironmentAccountConnectionResult`	`getEnvironmentAccountConnection(GetEnvironmentAccountConnectionRequest getEnvironmentAccountConnectionRequest)` In an environment account, view the detail data for an environment account connection.
`GetEnvironmentTemplateResult`	`getEnvironmentTemplate(GetEnvironmentTemplateRequest getEnvironmentTemplateRequest)` Get detail data for an environment template.
`GetEnvironmentTemplateVersionResult`	`getEnvironmentTemplateVersion(GetEnvironmentTemplateVersionRequest getEnvironmentTemplateVersionRequest)` View detail data for a major or minor version of an environment template.
`GetServiceResult`	`getService(GetServiceRequest getServiceRequest)` Get detail data for a service.
`GetServiceInstanceResult`	`getServiceInstance(GetServiceInstanceRequest getServiceInstanceRequest)` Get detail data for a service instance.
`GetServiceTemplateResult`	`getServiceTemplate(GetServiceTemplateRequest getServiceTemplateRequest)` Get detail data for a service template.
`GetServiceTemplateVersionResult`	`getServiceTemplateVersion(GetServiceTemplateVersionRequest getServiceTemplateVersionRequest)` View detail data for a major or minor version of a service template.
`ListEnvironmentAccountConnectionsResult`	`listEnvironmentAccountConnections(ListEnvironmentAccountConnectionsRequest listEnvironmentAccountConnectionsRequest)` View a list of environment account connections.
`ListEnvironmentsResult`	`listEnvironments(ListEnvironmentsRequest listEnvironmentsRequest)` List environments with detail data summaries.
`ListEnvironmentTemplatesResult`	`listEnvironmentTemplates(ListEnvironmentTemplatesRequest listEnvironmentTemplatesRequest)` List environment templates.
`ListEnvironmentTemplateVersionsResult`	`listEnvironmentTemplateVersions(ListEnvironmentTemplateVersionsRequest listEnvironmentTemplateVersionsRequest)` List major or minor versions of an environment template with detail data.
`ListServiceInstancesResult`	`listServiceInstances(ListServiceInstancesRequest listServiceInstancesRequest)` List service instances with summaries of detail data.
`ListServicesResult`	`listServices(ListServicesRequest listServicesRequest)` List services with summaries of detail data.
`ListServiceTemplatesResult`	`listServiceTemplates(ListServiceTemplatesRequest listServiceTemplatesRequest)` List service templates with detail data.
`ListServiceTemplateVersionsResult`	`listServiceTemplateVersions(ListServiceTemplateVersionsRequest listServiceTemplateVersionsRequest)` List major or minor versions of a service template with detail data.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)` List tags for a resource.
`RejectEnvironmentAccountConnectionResult`	`rejectEnvironmentAccountConnection(RejectEnvironmentAccountConnectionRequest rejectEnvironmentAccountConnectionRequest)` 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 tagResourceRequest)` Tag a resource.
`UntagResourceResult`	`untagResource(UntagResourceRequest untagResourceRequest)` Remove a tag from a resource.
`UpdateAccountSettingsResult`	`updateAccountSettings(UpdateAccountSettingsRequest updateAccountSettingsRequest)` Update the AWS Proton pipeline service account settings.
`UpdateEnvironmentResult`	`updateEnvironment(UpdateEnvironmentRequest updateEnvironmentRequest)` Update an environment.
`UpdateEnvironmentAccountConnectionResult`	`updateEnvironmentAccountConnection(UpdateEnvironmentAccountConnectionRequest updateEnvironmentAccountConnectionRequest)` In an environment account, update an environment account connection to use a new IAM role.
`UpdateEnvironmentTemplateResult`	`updateEnvironmentTemplate(UpdateEnvironmentTemplateRequest updateEnvironmentTemplateRequest)` Update an environment template.
`UpdateEnvironmentTemplateVersionResult`	`updateEnvironmentTemplateVersion(UpdateEnvironmentTemplateVersionRequest updateEnvironmentTemplateVersionRequest)` Update a major or minor version of an environment template.
`UpdateServiceResult`	`updateService(UpdateServiceRequest updateServiceRequest)` Edit a service description or use a spec to add and delete service instances.
`UpdateServiceInstanceResult`	`updateServiceInstance(UpdateServiceInstanceRequest updateServiceInstanceRequest)` Update a service instance.
`UpdateServicePipelineResult`	`updateServicePipeline(UpdateServicePipelineRequest updateServicePipelineRequest)` Update the service pipeline.
`UpdateServiceTemplateResult`	`updateServiceTemplate(UpdateServiceTemplateRequest updateServiceTemplateRequest)` Update a service template.
`UpdateServiceTemplateVersionResult`	`updateServiceTemplateVersion(UpdateServiceTemplateVersionRequest updateServiceTemplateVersionRequest)` Update a major or minor version of a service template.
`AWSProtonWaiters`	`waiters()`

- Field Detail
  - ENDPOINT_PREFIX
```
static final String ENDPOINT_PREFIX
```
    The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.
    
    See Also:
    
    RegionUtils.getRegionsForService(String), Constant Field Values
- Method Detail
  - acceptEnvironmentAccountConnection
```
AcceptEnvironmentAccountConnectionResult acceptEnvironmentAccountConnection(AcceptEnvironmentAccountConnectionRequest acceptEnvironmentAccountConnectionRequest)
```
    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.
    
    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
```
CancelEnvironmentDeploymentResult cancelEnvironmentDeployment(CancelEnvironmentDeploymentRequest cancelEnvironmentDeploymentRequest)
```
    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.
    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
```
CancelServiceInstanceDeploymentResult cancelServiceInstanceDeployment(CancelServiceInstanceDeploymentRequest cancelServiceInstanceDeploymentRequest)
```
    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.
    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
```
CancelServicePipelineDeploymentResult cancelServicePipelineDeployment(CancelServicePipelineDeploymentRequest cancelServicePipelineDeploymentRequest)
```
    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.
    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
```
CreateEnvironmentResult createEnvironment(CreateEnvironmentRequest createEnvironmentRequest)
```
    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.
    
    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
```
CreateEnvironmentAccountConnectionResult createEnvironmentAccountConnection(CreateEnvironmentAccountConnectionRequest createEnvironmentAccountConnectionRequest)
```
    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.
    
    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
```
CreateEnvironmentTemplateResult createEnvironmentTemplate(CreateEnvironmentTemplateRequest createEnvironmentTemplateRequest)
```
    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.
    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
```
CreateEnvironmentTemplateVersionResult createEnvironmentTemplateVersion(CreateEnvironmentTemplateVersionRequest createEnvironmentTemplateVersionRequest)
```
    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.
    
    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
```
CreateServiceResult createService(CreateServiceRequest createServiceRequest)
```
    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.
    
    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
```
CreateServiceTemplateResult createServiceTemplate(CreateServiceTemplateRequest createServiceTemplateRequest)
```
    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.
    
    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
```
CreateServiceTemplateVersionResult createServiceTemplateVersion(CreateServiceTemplateVersionRequest createServiceTemplateVersionRequest)
```
    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.
    
    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
```
DeleteEnvironmentResult deleteEnvironment(DeleteEnvironmentRequest deleteEnvironmentRequest)
```
    Delete an environment.
    
    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
```
DeleteEnvironmentAccountConnectionResult deleteEnvironmentAccountConnection(DeleteEnvironmentAccountConnectionRequest deleteEnvironmentAccountConnectionRequest)
```
    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.
    
    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
```
DeleteEnvironmentTemplateResult deleteEnvironmentTemplate(DeleteEnvironmentTemplateRequest deleteEnvironmentTemplateRequest)
```
    If no other major or minor versions of an environment template exist, delete the environment template.
    
    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
```
DeleteEnvironmentTemplateVersionResult deleteEnvironmentTemplateVersion(DeleteEnvironmentTemplateVersionRequest deleteEnvironmentTemplateVersionRequest)
```
    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.
    
    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
```
DeleteServiceResult deleteService(DeleteServiceRequest deleteServiceRequest)
```
    Delete a service.
    
    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
```
DeleteServiceTemplateResult deleteServiceTemplate(DeleteServiceTemplateRequest deleteServiceTemplateRequest)
```
    If no other major or minor versions of the service template exist, delete the service template.
    
    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
```
DeleteServiceTemplateVersionResult deleteServiceTemplateVersion(DeleteServiceTemplateVersionRequest deleteServiceTemplateVersionRequest)
```
    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.
    
    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
```
GetAccountSettingsResult getAccountSettings(GetAccountSettingsRequest getAccountSettingsRequest)
```
    Get detail data for the AWS Proton pipeline service role.
    
    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
```
GetEnvironmentResult getEnvironment(GetEnvironmentRequest getEnvironmentRequest)
```
    Get detail data for an environment.
    
    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
```
GetEnvironmentAccountConnectionResult getEnvironmentAccountConnection(GetEnvironmentAccountConnectionRequest getEnvironmentAccountConnectionRequest)
```
    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.
    
    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
```
GetEnvironmentTemplateResult getEnvironmentTemplate(GetEnvironmentTemplateRequest getEnvironmentTemplateRequest)
```
    Get detail data for an environment template.
    
    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
```
GetEnvironmentTemplateVersionResult getEnvironmentTemplateVersion(GetEnvironmentTemplateVersionRequest getEnvironmentTemplateVersionRequest)
```
    View detail data for a major or minor version of an environment template.
    
    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
```
GetServiceResult getService(GetServiceRequest getServiceRequest)
```
    Get detail data for a service.
    
    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
```
GetServiceInstanceResult getServiceInstance(GetServiceInstanceRequest getServiceInstanceRequest)
```
    Get detail data for a service instance. A service instance is an instantiation of service template, which is running in a specific environment.
    
    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
```
GetServiceTemplateResult getServiceTemplate(GetServiceTemplateRequest getServiceTemplateRequest)
```
    Get detail data for a service template.
    
    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
```
GetServiceTemplateVersionResult getServiceTemplateVersion(GetServiceTemplateVersionRequest getServiceTemplateVersionRequest)
```
    View detail data for a major or minor version of a service template.
    
    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
```
ListEnvironmentAccountConnectionsResult listEnvironmentAccountConnections(ListEnvironmentAccountConnectionsRequest listEnvironmentAccountConnectionsRequest)
```
    View a list of environment account connections.
    
    For more information, see Environment account connections in the AWS Proton Administrator guide.
    
    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
```
ListEnvironmentTemplateVersionsResult listEnvironmentTemplateVersions(ListEnvironmentTemplateVersionsRequest listEnvironmentTemplateVersionsRequest)
```
    List major or minor versions of an environment template with detail data.
    
    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
```
ListEnvironmentTemplatesResult listEnvironmentTemplates(ListEnvironmentTemplatesRequest listEnvironmentTemplatesRequest)
```
    List environment templates.
    
    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
```
ListEnvironmentsResult listEnvironments(ListEnvironmentsRequest listEnvironmentsRequest)
```
    List environments with detail data summaries.
    
    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
```
ListServiceInstancesResult listServiceInstances(ListServiceInstancesRequest listServiceInstancesRequest)
```
    List service instances with summaries of detail data.
    
    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
```
ListServiceTemplateVersionsResult listServiceTemplateVersions(ListServiceTemplateVersionsRequest listServiceTemplateVersionsRequest)
```
    List major or minor versions of a service template with detail data.
    
    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
```
ListServiceTemplatesResult listServiceTemplates(ListServiceTemplatesRequest listServiceTemplatesRequest)
```
    List service templates with detail data.
    
    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
```
ListServicesResult listServices(ListServicesRequest listServicesRequest)
```
    List services with summaries of detail data.
    
    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
```
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
```
    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.
    
    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
```
RejectEnvironmentAccountConnectionResult rejectEnvironmentAccountConnection(RejectEnvironmentAccountConnectionRequest rejectEnvironmentAccountConnectionRequest)
```
    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.
    
    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
```
TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
```
    Tag a resource. For more information, see AWS Proton resources and tagging in the AWS Proton Administrator Guide or AWS Proton User Guide.
    
    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
```
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
```
    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.
    
    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
```
UpdateAccountSettingsResult updateAccountSettings(UpdateAccountSettingsRequest updateAccountSettingsRequest)
```
    Update the AWS Proton pipeline service account settings.
    
    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
```
UpdateEnvironmentResult updateEnvironment(UpdateEnvironmentRequest updateEnvironmentRequest)
```
    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).
    
    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
```
UpdateEnvironmentAccountConnectionResult updateEnvironmentAccountConnection(UpdateEnvironmentAccountConnectionRequest updateEnvironmentAccountConnectionRequest)
```
    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.
    
    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
```
UpdateEnvironmentTemplateResult updateEnvironmentTemplate(UpdateEnvironmentTemplateRequest updateEnvironmentTemplateRequest)
```
    Update an environment template.
    
    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
```
UpdateEnvironmentTemplateVersionResult updateEnvironmentTemplateVersion(UpdateEnvironmentTemplateVersionRequest updateEnvironmentTemplateVersionRequest)
```
    Update a major or minor version of an environment template.
    
    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
```
UpdateServiceResult updateService(UpdateServiceRequest updateServiceRequest)
```
    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.
    
    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
```
UpdateServiceInstanceResult updateServiceInstance(UpdateServiceInstanceRequest updateServiceInstanceRequest)
```
    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).
    
    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
```
UpdateServicePipelineResult updateServicePipeline(UpdateServicePipelineRequest updateServicePipelineRequest)
```
    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).
    
    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
```
UpdateServiceTemplateResult updateServiceTemplate(UpdateServiceTemplateRequest updateServiceTemplateRequest)
```
    Update a service template.
    
    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
```
UpdateServiceTemplateVersionResult updateServiceTemplateVersion(UpdateServiceTemplateVersionRequest updateServiceTemplateVersionRequest)
```
    Update a major or minor version of a service template.
    
    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
  - shutdown
```
void shutdown()
```
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
  - getCachedResponseMetadata
```
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 a request.
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.
  - waiters
```
AWSProtonWaiters waiters()
```

Did this page help you?

Interface AWSProton

Field Summary

Method Summary

Field Detail

ENDPOINT_PREFIX

Method Detail

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

shutdown

getCachedResponseMetadata

waiters