com.amazonaws.services.proton.AWSProton Maven / Gradle / Ivy
/*
* Copyright 2016-2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.proton;
import javax.annotation.Generated;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.proton.model.*;
/**
* Interface for accessing AWS Proton.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.proton.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 Administration 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
*
*
*
*
*
* <p> <b>Idempotent delete APIs</b> </p> <p>Given a request action that has succeeded:</p> <p>When you retry the request with an API from this group and the resource was deleted, its metadata is returned in the response.</p> <p>If you retry and the resource doesn't exist, the response is empty.</p> <p>In both cases, the retry succeeds.</p> <p>Idempotent delete APIs:</p> <ul> <li> <p>DeleteEnvironmentTemplate</p> </li> <li> <p>DeleteEnvironmentTemplateVersion</p> </li> <li> <p>DeleteServiceTemplate</p> </li> <li> <p>DeleteServiceTemplateVersion</p> </li> <li> <p>DeleteEnvironmentAccountConnection</p> </li> </ul> <p> <b>Asynchronous idempotent delete APIs</b> </p> <p>Given a request action that has succeeded:</p> <p>If you retry the request with an API from this group, if the original request delete operation status is <code>DELETE_IN_PROGRESS</code>, the retry returns the resource detail data in the response without performing any further actions.</p> <p>If the original request delete operation is complete, a retry returns an empty response.</p> <p>Asynchronous idempotent delete APIs:</p> <ul> <li> <p>DeleteEnvironment</p> </li> <li> <p>DeleteService</p> </li> </ul>
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AWSProton {
/**
* 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 RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "proton";
/**
*
* 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 Administration guide.
*
*
* @param acceptEnvironmentAccountConnectionRequest
* @return 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.
* @throws AccessDeniedException
* There isn't sufficient access for performing this action.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws ConflictException
* The request couldn't be made due to a conflicting operation or resource.
* @throws ResourceNotFoundException
* The requested resource wasn't found.
* @throws InternalServerException
* The request failed to register with the service.
* @sample AWSProton.AcceptEnvironmentAccountConnection
* @see AWS API Documentation
*/
AcceptEnvironmentAccountConnectionResult acceptEnvironmentAccountConnection(
AcceptEnvironmentAccountConnectionRequest acceptEnvironmentAccountConnectionRequest);
/**
*
* 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 Administration 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.
*
*
*
*
* @param cancelEnvironmentDeploymentRequest
* @return 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.
* @throws AccessDeniedException
* There isn't sufficient access for performing this action.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws ConflictException
* The request couldn't be made due to a conflicting operation or resource.
* @throws ResourceNotFoundException
* The requested resource wasn't found.
* @throws InternalServerException
* The request failed to register with the service.
* @sample AWSProton.CancelEnvironmentDeployment
* @see AWS API Documentation
*/
CancelEnvironmentDeploymentResult cancelEnvironmentDeployment(CancelEnvironmentDeploymentRequest cancelEnvironmentDeploymentRequest);
/**
*
* 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 Administration
* 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.
*
*
*
*
* @param cancelServiceInstanceDeploymentRequest
* @return 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.
* @throws AccessDeniedException
* There isn't sufficient access for performing this action.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws ConflictException
* The request couldn't be made due to a conflicting operation or resource.
* @throws ResourceNotFoundException
* The requested resource wasn't found.
* @throws InternalServerException
* The request failed to register with the service.
* @sample AWSProton.CancelServiceInstanceDeployment
* @see AWS API Documentation
*/
CancelServiceInstanceDeploymentResult cancelServiceInstanceDeployment(CancelServiceInstanceDeploymentRequest cancelServiceInstanceDeploymentRequest);
/**
*
* 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 Administration
* 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.
*
*
*
*
* @param cancelServicePipelineDeploymentRequest
* @return 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.
* @throws AccessDeniedException
* There isn't sufficient access for performing this action.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws ConflictException
* The request couldn't be made due to a conflicting operation or resource.
* @throws ResourceNotFoundException
* The requested resource wasn't found.
* @throws InternalServerException
* The request failed to register with the service.
* @sample AWSProton.CancelServicePipelineDeployment
* @see AWS API Documentation
*/
CancelServicePipelineDeploymentResult cancelServicePipelineDeployment(CancelServicePipelineDeploymentRequest cancelServicePipelineDeploymentRequest);
/**
*
* 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 Administration Guide.
*
*
* @param createEnvironmentRequest
* @return 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 Administration Guide.
* @throws ValidationException
* The input is invalid or an out-of-range value was supplied for the input parameter.
* @throws AccessDeniedException
* There isn't sufficient access for performing this action.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws ConflictException
* The request couldn't be made due to a conflicting operation or resource.
* @throws ResourceNotFoundException
* The requested resource wasn't found.
* @throws InternalServerException
* The request failed to register with the service.
* @sample AWSProton.CreateEnvironment
* @see AWS API
* Documentation
*/
CreateEnvironmentResult createEnvironment(CreateEnvironmentRequest createEnvironmentRequest);
/**
*
* Create an environment account connection in an environment account so that environment infrastructure resources
* can be provisioned in the environment account from the 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 Administration guide.
*
*
* @param createEnvironmentAccountConnectionRequest
* @return 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 Administration Guide.
* @throws ValidationException
* The input is invalid or an out-of-range value was supplied for the input parameter.
* @throws AccessDeniedException
* There isn't sufficient access for performing this action.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws ConflictException
* The request couldn't be made due to a conflicting operation or resource.
* @throws InternalServerException
* The request failed to register with the service.
* @sample AWSProton.CreateEnvironmentAccountConnection
* @see AWS API Documentation
*/
CreateEnvironmentAccountConnectionResult createEnvironmentAccountConnection(
CreateEnvironmentAccountConnectionRequest createEnvironmentAccountConnectionRequest);
/**
*
* Create an environment template for AWS Proton. For more information, see Environment Templates in
* the AWS Proton Administration 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 Administration Guide.
*
*
*
*
* @param createEnvironmentTemplateRequest
* @return 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 Administration Guide.
* @throws ValidationException
* The input is invalid or an out-of-range value was supplied for the input parameter.
* @throws AccessDeniedException
* There isn't sufficient access for performing this action.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws ConflictException
* The request couldn't be made due to a conflicting operation or resource.
* @throws InternalServerException
* The request failed to register with the service.
* @sample AWSProton.CreateEnvironmentTemplate
* @see AWS API Documentation
*/
CreateEnvironmentTemplateResult createEnvironmentTemplate(CreateEnvironmentTemplateRequest createEnvironmentTemplateRequest);
/**
*
* 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.
*
*
* @param createEnvironmentTemplateVersionRequest
* @return 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 Administration Guide.
* @throws ValidationException
* The input is invalid or an out-of-range value was supplied for the input parameter.
* @throws AccessDeniedException
* There isn't sufficient access for performing this action.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws ConflictException
* The request couldn't be made due to a conflicting operation or resource.
* @throws ResourceNotFoundException
* The requested resource wasn't found.
* @throws InternalServerException
* The request failed to register with the service.
* @sample AWSProton.CreateEnvironmentTemplateVersion
* @see AWS API Documentation
*/
CreateEnvironmentTemplateVersionResult createEnvironmentTemplateVersion(CreateEnvironmentTemplateVersionRequest createEnvironmentTemplateVersionRequest);
/**
*
* 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
* Administration Guide and Services in the AWS Proton User
* Guide.
*
*
* @param createServiceRequest
* @return 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 Administration Guide.
* @throws ValidationException
* The input is invalid or an out-of-range value was supplied for the input parameter.
* @throws AccessDeniedException
* There isn't sufficient access for performing this action.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws ConflictException
* The request couldn't be made due to a conflicting operation or resource.
* @throws ResourceNotFoundException
* The requested resource wasn't found.
* @throws InternalServerException
* The request failed to register with the service.
* @sample AWSProton.CreateService
* @see AWS API
* Documentation
*/
CreateServiceResult createService(CreateServiceRequest createServiceRequest);
/**
*
* 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 Administration Guide.
*
*
* @param createServiceTemplateRequest
* @return 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 Administration Guide.
* @throws ValidationException
* The input is invalid or an out-of-range value was supplied for the input parameter.
* @throws AccessDeniedException
* There isn't sufficient access for performing this action.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws ConflictException
* The request couldn't be made due to a conflicting operation or resource.
* @throws InternalServerException
* The request failed to register with the service.
* @sample AWSProton.CreateServiceTemplate
* @see AWS
* API Documentation
*/
CreateServiceTemplateResult createServiceTemplate(CreateServiceTemplateRequest createServiceTemplateRequest);
/**
*
* 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.
*
*
* @param createServiceTemplateVersionRequest
* @return 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 Administration Guide.
* @throws ValidationException
* The input is invalid or an out-of-range value was supplied for the input parameter.
* @throws AccessDeniedException
* There isn't sufficient access for performing this action.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws ConflictException
* The request couldn't be made due to a conflicting operation or resource.
* @throws ResourceNotFoundException
* The requested resource wasn't found.
* @throws InternalServerException
* The request failed to register with the service.
* @sample AWSProton.CreateServiceTemplateVersion
* @see AWS API Documentation
*/
CreateServiceTemplateVersionResult createServiceTemplateVersion(CreateServiceTemplateVersionRequest createServiceTemplateVersionRequest);
/**
*
* Delete an environment.
*
*
* @param deleteEnvironmentRequest
* @return 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.
* @throws AccessDeniedException
* There isn't sufficient access for performing this action.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws ConflictException
* The request couldn't be made due to a conflicting operation or resource.
* @throws ResourceNotFoundException
* The requested resource wasn't found.
* @throws InternalServerException
* The request failed to register with the service.
* @sample AWSProton.DeleteEnvironment
* @see AWS API
* Documentation
*/
DeleteEnvironmentResult deleteEnvironment(DeleteEnvironmentRequest deleteEnvironmentRequest);
/**
*
* 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 Administration guide.
*
*
* @param deleteEnvironmentAccountConnectionRequest
* @return 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.
* @throws AccessDeniedException
* There isn't sufficient access for performing this action.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws ConflictException
* The request couldn't be made due to a conflicting operation or resource.
* @throws ResourceNotFoundException
* The requested resource wasn't found.
* @throws InternalServerException
* The request failed to register with the service.
* @sample AWSProton.DeleteEnvironmentAccountConnection
* @see AWS API Documentation
*/
DeleteEnvironmentAccountConnectionResult deleteEnvironmentAccountConnection(
DeleteEnvironmentAccountConnectionRequest deleteEnvironmentAccountConnectionRequest);
/**
*
* If no other major or minor versions of an environment template exist, delete the environment template.
*
*
* @param deleteEnvironmentTemplateRequest
* @return 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.
* @throws AccessDeniedException
* There isn't sufficient access for performing this action.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws ConflictException
* The request couldn't be made due to a conflicting operation or resource.
* @throws ResourceNotFoundException
* The requested resource wasn't found.
* @throws InternalServerException
* The request failed to register with the service.
* @sample AWSProton.DeleteEnvironmentTemplate
* @see AWS API Documentation
*/
DeleteEnvironmentTemplateResult deleteEnvironmentTemplate(DeleteEnvironmentTemplateRequest deleteEnvironmentTemplateRequest);
/**
*
* 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.
*
*
* @param deleteEnvironmentTemplateVersionRequest
* @return 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.
* @throws AccessDeniedException
* There isn't sufficient access for performing this action.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws ConflictException
* The request couldn't be made due to a conflicting operation or resource.
* @throws ResourceNotFoundException
* The requested resource wasn't found.
* @throws InternalServerException
* The request failed to register with the service.
* @sample AWSProton.DeleteEnvironmentTemplateVersion
* @see AWS API Documentation
*/
DeleteEnvironmentTemplateVersionResult deleteEnvironmentTemplateVersion(DeleteEnvironmentTemplateVersionRequest deleteEnvironmentTemplateVersionRequest);
/**
*
* Delete a service.
*
*
* @param deleteServiceRequest
* @return 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.
* @throws AccessDeniedException
* There isn't sufficient access for performing this action.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws ConflictException
* The request couldn't be made due to a conflicting operation or resource.
* @throws ResourceNotFoundException
* The requested resource wasn't found.
* @throws InternalServerException
* The request failed to register with the service.
* @sample AWSProton.DeleteService
* @see AWS API
* Documentation
*/
DeleteServiceResult deleteService(DeleteServiceRequest deleteServiceRequest);
/**
*
* If no other major or minor versions of the service template exist, delete the service template.
*
*
* @param deleteServiceTemplateRequest
* @return 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.
* @throws AccessDeniedException
* There isn't sufficient access for performing this action.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws ConflictException
* The request couldn't be made due to a conflicting operation or resource.
* @throws ResourceNotFoundException
* The requested resource wasn't found.
* @throws InternalServerException
* The request failed to register with the service.
* @sample AWSProton.DeleteServiceTemplate
* @see AWS
* API Documentation
*/
DeleteServiceTemplateResult deleteServiceTemplate(DeleteServiceTemplateRequest deleteServiceTemplateRequest);
/**
*
* 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.
*
*
* @param deleteServiceTemplateVersionRequest
* @return 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.
* @throws AccessDeniedException
* There isn't sufficient access for performing this action.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws ConflictException
* The request couldn't be made due to a conflicting operation or resource.
* @throws ResourceNotFoundException
* The requested resource wasn't found.
* @throws InternalServerException
* The request failed to register with the service.
* @sample AWSProton.DeleteServiceTemplateVersion
* @see AWS API Documentation
*/
DeleteServiceTemplateVersionResult deleteServiceTemplateVersion(DeleteServiceTemplateVersionRequest deleteServiceTemplateVersionRequest);
/**
*
* Get detail data for the AWS Proton pipeline service role.
*
*
* @param getAccountSettingsRequest
* @return 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.
* @throws AccessDeniedException
* There isn't sufficient access for performing this action.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws ResourceNotFoundException
* The requested resource wasn't found.
* @throws InternalServerException
* The request failed to register with the service.
* @sample AWSProton.GetAccountSettings
* @see AWS API
* Documentation
*/
GetAccountSettingsResult getAccountSettings(GetAccountSettingsRequest getAccountSettingsRequest);
/**
*
* Get detail data for an environment.
*
*
* @param getEnvironmentRequest
* @return 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.
* @throws AccessDeniedException
* There isn't sufficient access for performing this action.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws ResourceNotFoundException
* The requested resource wasn't found.
* @throws InternalServerException
* The request failed to register with the service.
* @sample AWSProton.GetEnvironment
* @see AWS API
* Documentation
*/
GetEnvironmentResult getEnvironment(GetEnvironmentRequest getEnvironmentRequest);
/**
*
* In an environment account, view the detail data for an environment account connection.
*
*
* For more information, see Environment account
* connections in the AWS Proton Administration guide.
*
*
* @param getEnvironmentAccountConnectionRequest
* @return 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.
* @throws AccessDeniedException
* There isn't sufficient access for performing this action.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws ResourceNotFoundException
* The requested resource wasn't found.
* @throws InternalServerException
* The request failed to register with the service.
* @sample AWSProton.GetEnvironmentAccountConnection
* @see AWS API Documentation
*/
GetEnvironmentAccountConnectionResult getEnvironmentAccountConnection(GetEnvironmentAccountConnectionRequest getEnvironmentAccountConnectionRequest);
/**
*
* Get detail data for an environment template.
*
*
* @param getEnvironmentTemplateRequest
* @return 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.
* @throws AccessDeniedException
* There isn't sufficient access for performing this action.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws ResourceNotFoundException
* The requested resource wasn't found.
* @throws InternalServerException
* The request failed to register with the service.
* @sample AWSProton.GetEnvironmentTemplate
* @see AWS
* API Documentation
*/
GetEnvironmentTemplateResult getEnvironmentTemplate(GetEnvironmentTemplateRequest getEnvironmentTemplateRequest);
/**
*
* View detail data for a major or minor version of an environment template.
*
*
* @param getEnvironmentTemplateVersionRequest
* @return 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.
* @throws AccessDeniedException
* There isn't sufficient access for performing this action.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws ResourceNotFoundException
* The requested resource wasn't found.
* @throws InternalServerException
* The request failed to register with the service.
* @sample AWSProton.GetEnvironmentTemplateVersion
* @see AWS API Documentation
*/
GetEnvironmentTemplateVersionResult getEnvironmentTemplateVersion(GetEnvironmentTemplateVersionRequest getEnvironmentTemplateVersionRequest);
/**
*
* Get detail data for a service.
*
*
* @param getServiceRequest
* @return 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.
* @throws AccessDeniedException
* There isn't sufficient access for performing this action.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws ResourceNotFoundException
* The requested resource wasn't found.
* @throws InternalServerException
* The request failed to register with the service.
* @sample AWSProton.GetService
* @see AWS API
* Documentation
*/
GetServiceResult getService(GetServiceRequest getServiceRequest);
/**
*
* Get detail data for a service instance. A service instance is an instantiation of service template, which is
* running in a specific environment.
*
*
* @param getServiceInstanceRequest
* @return 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.
* @throws AccessDeniedException
* There isn't sufficient access for performing this action.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws ResourceNotFoundException
* The requested resource wasn't found.
* @throws InternalServerException
* The request failed to register with the service.
* @sample AWSProton.GetServiceInstance
* @see AWS API
* Documentation
*/
GetServiceInstanceResult getServiceInstance(GetServiceInstanceRequest getServiceInstanceRequest);
/**
*
* Get detail data for a service template.
*
*
* @param getServiceTemplateRequest
* @return 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.
* @throws AccessDeniedException
* There isn't sufficient access for performing this action.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws ResourceNotFoundException
* The requested resource wasn't found.
* @throws InternalServerException
* The request failed to register with the service.
* @sample AWSProton.GetServiceTemplate
* @see AWS API
* Documentation
*/
GetServiceTemplateResult getServiceTemplate(GetServiceTemplateRequest getServiceTemplateRequest);
/**
*
* View detail data for a major or minor version of a service template.
*
*
* @param getServiceTemplateVersionRequest
* @return 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.
* @throws AccessDeniedException
* There isn't sufficient access for performing this action.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws ResourceNotFoundException
* The requested resource wasn't found.
* @throws InternalServerException
* The request failed to register with the service.
* @sample AWSProton.GetServiceTemplateVersion
* @see AWS API Documentation
*/
GetServiceTemplateVersionResult getServiceTemplateVersion(GetServiceTemplateVersionRequest getServiceTemplateVersionRequest);
/**
*
* View a list of environment account connections.
*
*
* For more information, see Environment account
* connections in the AWS Proton Administration guide.
*
*
* @param listEnvironmentAccountConnectionsRequest
* @return 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.
* @throws AccessDeniedException
* There isn't sufficient access for performing this action.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws InternalServerException
* The request failed to register with the service.
* @sample AWSProton.ListEnvironmentAccountConnections
* @see AWS API Documentation
*/
ListEnvironmentAccountConnectionsResult listEnvironmentAccountConnections(ListEnvironmentAccountConnectionsRequest listEnvironmentAccountConnectionsRequest);
/**
*
* List major or minor versions of an environment template with detail data.
*
*
* @param listEnvironmentTemplateVersionsRequest
* @return 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.
* @throws AccessDeniedException
* There isn't sufficient access for performing this action.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws ResourceNotFoundException
* The requested resource wasn't found.
* @throws InternalServerException
* The request failed to register with the service.
* @sample AWSProton.ListEnvironmentTemplateVersions
* @see AWS API Documentation
*/
ListEnvironmentTemplateVersionsResult listEnvironmentTemplateVersions(ListEnvironmentTemplateVersionsRequest listEnvironmentTemplateVersionsRequest);
/**
*
* List environment templates.
*
*
* @param listEnvironmentTemplatesRequest
* @return 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.
* @throws AccessDeniedException
* There isn't sufficient access for performing this action.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws InternalServerException
* The request failed to register with the service.
* @sample AWSProton.ListEnvironmentTemplates
* @see AWS API Documentation
*/
ListEnvironmentTemplatesResult listEnvironmentTemplates(ListEnvironmentTemplatesRequest listEnvironmentTemplatesRequest);
/**
*
* List environments with detail data summaries.
*
*
* @param listEnvironmentsRequest
* @return 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.
* @throws AccessDeniedException
* There isn't sufficient access for performing this action.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws ResourceNotFoundException
* The requested resource wasn't found.
* @throws InternalServerException
* The request failed to register with the service.
* @sample AWSProton.ListEnvironments
* @see AWS API
* Documentation
*/
ListEnvironmentsResult listEnvironments(ListEnvironmentsRequest listEnvironmentsRequest);
/**
*
* List service instances with summaries of detail data.
*
*
* @param listServiceInstancesRequest
* @return 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.
* @throws AccessDeniedException
* There isn't sufficient access for performing this action.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws ResourceNotFoundException
* The requested resource wasn't found.
* @throws InternalServerException
* The request failed to register with the service.
* @sample AWSProton.ListServiceInstances
* @see AWS
* API Documentation
*/
ListServiceInstancesResult listServiceInstances(ListServiceInstancesRequest listServiceInstancesRequest);
/**
*
* List major or minor versions of a service template with detail data.
*
*
* @param listServiceTemplateVersionsRequest
* @return 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.
* @throws AccessDeniedException
* There isn't sufficient access for performing this action.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws ResourceNotFoundException
* The requested resource wasn't found.
* @throws InternalServerException
* The request failed to register with the service.
* @sample AWSProton.ListServiceTemplateVersions
* @see AWS API Documentation
*/
ListServiceTemplateVersionsResult listServiceTemplateVersions(ListServiceTemplateVersionsRequest listServiceTemplateVersionsRequest);
/**
*
* List service templates with detail data.
*
*
* @param listServiceTemplatesRequest
* @return 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.
* @throws AccessDeniedException
* There isn't sufficient access for performing this action.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws InternalServerException
* The request failed to register with the service.
* @sample AWSProton.ListServiceTemplates
* @see AWS
* API Documentation
*/
ListServiceTemplatesResult listServiceTemplates(ListServiceTemplatesRequest listServiceTemplatesRequest);
/**
*
* List services with summaries of detail data.
*
*
* @param listServicesRequest
* @return 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.
* @throws AccessDeniedException
* There isn't sufficient access for performing this action.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws InternalServerException
* The request failed to register with the service.
* @sample AWSProton.ListServices
* @see AWS API
* Documentation
*/
ListServicesResult listServices(ListServicesRequest listServicesRequest);
/**
*
* List tags for a resource. For more information, see AWS Proton resources and tagging in the AWS Proton Administration Guide or
* AWS Proton User Guide.
*
*
* @param listTagsForResourceRequest
* @return 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.
* @throws AccessDeniedException
* There isn't sufficient access for performing this action.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws ResourceNotFoundException
* The requested resource wasn't found.
* @throws InternalServerException
* The request failed to register with the service.
* @sample AWSProton.ListTagsForResource
* @see AWS API
* Documentation
*/
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest);
/**
*
* 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 Administration guide.
*
*
* @param rejectEnvironmentAccountConnectionRequest
* @return 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.
* @throws AccessDeniedException
* There isn't sufficient access for performing this action.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws ConflictException
* The request couldn't be made due to a conflicting operation or resource.
* @throws ResourceNotFoundException
* The requested resource wasn't found.
* @throws InternalServerException
* The request failed to register with the service.
* @sample AWSProton.RejectEnvironmentAccountConnection
* @see AWS API Documentation
*/
RejectEnvironmentAccountConnectionResult rejectEnvironmentAccountConnection(
RejectEnvironmentAccountConnectionRequest rejectEnvironmentAccountConnectionRequest);
/**
*
* Tag a resource. For more information, see AWS Proton resources and tagging in the AWS Proton Administration Guide or
* AWS Proton User Guide.
*
*
* @param tagResourceRequest
* @return 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.
* @throws AccessDeniedException
* There isn't sufficient access for performing this action.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws ConflictException
* The request couldn't be made due to a conflicting operation or resource.
* @throws ResourceNotFoundException
* The requested resource wasn't found.
* @throws InternalServerException
* The request failed to register with the service.
* @sample AWSProton.TagResource
* @see AWS API
* Documentation
*/
TagResourceResult tagResource(TagResourceRequest tagResourceRequest);
/**
*
* Remove a tag from a resource. For more information, see AWS Proton resources and tagging in the AWS Proton Administration Guide or
* AWS Proton User Guide.
*
*
* @param untagResourceRequest
* @return 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.
* @throws AccessDeniedException
* There isn't sufficient access for performing this action.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws ConflictException
* The request couldn't be made due to a conflicting operation or resource.
* @throws ResourceNotFoundException
* The requested resource wasn't found.
* @throws InternalServerException
* The request failed to register with the service.
* @sample AWSProton.UntagResource
* @see AWS API
* Documentation
*/
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest);
/**
*
* Update the AWS Proton pipeline service account settings.
*
*
* @param updateAccountSettingsRequest
* @return 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.
* @throws AccessDeniedException
* There isn't sufficient access for performing this action.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws ConflictException
* The request couldn't be made due to a conflicting operation or resource.
* @throws InternalServerException
* The request failed to register with the service.
* @sample AWSProton.UpdateAccountSettings
* @see AWS
* API Documentation
*/
UpdateAccountSettingsResult updateAccountSettings(UpdateAccountSettingsRequest updateAccountSettingsRequest);
/**
*
* 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 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).
*
*
*
*
* @param updateEnvironmentRequest
* @return 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.
* @throws AccessDeniedException
* There isn't sufficient access for performing this action.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws ConflictException
* The request couldn't be made due to a conflicting operation or resource.
* @throws ResourceNotFoundException
* The requested resource wasn't found.
* @throws InternalServerException
* The request failed to register with the service.
* @sample AWSProton.UpdateEnvironment
* @see AWS API
* Documentation
*/
UpdateEnvironmentResult updateEnvironment(UpdateEnvironmentRequest updateEnvironmentRequest);
/**
*
* 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 Administration guide.
*
*
* @param updateEnvironmentAccountConnectionRequest
* @return 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.
* @throws AccessDeniedException
* There isn't sufficient access for performing this action.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws ConflictException
* The request couldn't be made due to a conflicting operation or resource.
* @throws ResourceNotFoundException
* The requested resource wasn't found.
* @throws InternalServerException
* The request failed to register with the service.
* @sample AWSProton.UpdateEnvironmentAccountConnection
* @see AWS API Documentation
*/
UpdateEnvironmentAccountConnectionResult updateEnvironmentAccountConnection(
UpdateEnvironmentAccountConnectionRequest updateEnvironmentAccountConnectionRequest);
/**
*
* Update an environment template.
*
*
* @param updateEnvironmentTemplateRequest
* @return 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.
* @throws AccessDeniedException
* There isn't sufficient access for performing this action.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws ConflictException
* The request couldn't be made due to a conflicting operation or resource.
* @throws ResourceNotFoundException
* The requested resource wasn't found.
* @throws InternalServerException
* The request failed to register with the service.
* @sample AWSProton.UpdateEnvironmentTemplate
* @see AWS API Documentation
*/
UpdateEnvironmentTemplateResult updateEnvironmentTemplate(UpdateEnvironmentTemplateRequest updateEnvironmentTemplateRequest);
/**
*
* Update a major or minor version of an environment template.
*
*
* @param updateEnvironmentTemplateVersionRequest
* @return 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.
* @throws AccessDeniedException
* There isn't sufficient access for performing this action.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws ConflictException
* The request couldn't be made due to a conflicting operation or resource.
* @throws ResourceNotFoundException
* The requested resource wasn't found.
* @throws InternalServerException
* The request failed to register with the service.
* @sample AWSProton.UpdateEnvironmentTemplateVersion
* @see AWS API Documentation
*/
UpdateEnvironmentTemplateVersionResult updateEnvironmentTemplateVersion(UpdateEnvironmentTemplateVersionRequest updateEnvironmentTemplateVersionRequest);
/**
*
* 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.
*
*
* @param updateServiceRequest
* @return 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 Administration Guide.
* @throws ValidationException
* The input is invalid or an out-of-range value was supplied for the input parameter.
* @throws AccessDeniedException
* There isn't sufficient access for performing this action.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws ConflictException
* The request couldn't be made due to a conflicting operation or resource.
* @throws ResourceNotFoundException
* The requested resource wasn't found.
* @throws InternalServerException
* The request failed to register with the service.
* @sample AWSProton.UpdateService
* @see AWS API
* Documentation
*/
UpdateServiceResult updateService(UpdateServiceRequest updateServiceRequest);
/**
*
* 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).
*
*
*
*
* @param updateServiceInstanceRequest
* @return 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.
* @throws AccessDeniedException
* There isn't sufficient access for performing this action.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws ConflictException
* The request couldn't be made due to a conflicting operation or resource.
* @throws ResourceNotFoundException
* The requested resource wasn't found.
* @throws InternalServerException
* The request failed to register with the service.
* @sample AWSProton.UpdateServiceInstance
* @see AWS
* API Documentation
*/
UpdateServiceInstanceResult updateServiceInstance(UpdateServiceInstanceRequest updateServiceInstanceRequest);
/**
*
* 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).
*
*
*
*
* @param updateServicePipelineRequest
* @return 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.
* @throws AccessDeniedException
* There isn't sufficient access for performing this action.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws ConflictException
* The request couldn't be made due to a conflicting operation or resource.
* @throws ResourceNotFoundException
* The requested resource wasn't found.
* @throws InternalServerException
* The request failed to register with the service.
* @sample AWSProton.UpdateServicePipeline
* @see AWS
* API Documentation
*/
UpdateServicePipelineResult updateServicePipeline(UpdateServicePipelineRequest updateServicePipelineRequest);
/**
*
* Update a service template.
*
*
* @param updateServiceTemplateRequest
* @return 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.
* @throws AccessDeniedException
* There isn't sufficient access for performing this action.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws ConflictException
* The request couldn't be made due to a conflicting operation or resource.
* @throws ResourceNotFoundException
* The requested resource wasn't found.
* @throws InternalServerException
* The request failed to register with the service.
* @sample AWSProton.UpdateServiceTemplate
* @see AWS
* API Documentation
*/
UpdateServiceTemplateResult updateServiceTemplate(UpdateServiceTemplateRequest updateServiceTemplateRequest);
/**
*
* Update a major or minor version of a service template.
*
*
* @param updateServiceTemplateVersionRequest
* @return 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.
* @throws AccessDeniedException
* There isn't sufficient access for performing this action.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws ConflictException
* The request couldn't be made due to a conflicting operation or resource.
* @throws ResourceNotFoundException
* The requested resource wasn't found.
* @throws InternalServerException
* The request failed to register with the service.
* @sample AWSProton.UpdateServiceTemplateVersion
* @see AWS API Documentation
*/
UpdateServiceTemplateVersionResult updateServiceTemplateVersion(UpdateServiceTemplateVersionRequest updateServiceTemplateVersionRequest);
/**
* 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.
*/
void shutdown();
/**
* 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.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none is available.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}