@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSProtonAsync extends AWSProton
AsyncHandler can be used to receive
notification when an asynchronous operation completes.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSProtonAsync 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
ENDPOINT_PREFIXacceptEnvironmentAccountConnection, cancelEnvironmentDeployment, cancelServiceInstanceDeployment, cancelServicePipelineDeployment, createEnvironment, createEnvironmentAccountConnection, createEnvironmentTemplate, createEnvironmentTemplateVersion, createService, createServiceTemplate, createServiceTemplateVersion, deleteEnvironment, deleteEnvironmentAccountConnection, deleteEnvironmentTemplate, deleteEnvironmentTemplateVersion, deleteService, deleteServiceTemplate, deleteServiceTemplateVersion, getAccountSettings, getCachedResponseMetadata, getEnvironment, getEnvironmentAccountConnection, getEnvironmentTemplate, getEnvironmentTemplateVersion, getService, getServiceInstance, getServiceTemplate, getServiceTemplateVersion, listEnvironmentAccountConnections, listEnvironments, listEnvironmentTemplates, listEnvironmentTemplateVersions, listServiceInstances, listServices, listServiceTemplates, listServiceTemplateVersions, listTagsForResource, rejectEnvironmentAccountConnection, shutdown, tagResource, untagResource, updateAccountSettings, updateEnvironment, updateEnvironmentAccountConnection, updateEnvironmentTemplate, updateEnvironmentTemplateVersion, updateService, updateServiceInstance, updateServicePipeline, updateServiceTemplate, updateServiceTemplateVersion, waitersFuture<AcceptEnvironmentAccountConnectionResult> acceptEnvironmentAccountConnectionAsync(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.
acceptEnvironmentAccountConnectionRequest - Future<AcceptEnvironmentAccountConnectionResult> acceptEnvironmentAccountConnectionAsync(AcceptEnvironmentAccountConnectionRequest acceptEnvironmentAccountConnectionRequest, AsyncHandler<AcceptEnvironmentAccountConnectionRequest,AcceptEnvironmentAccountConnectionResult> asyncHandler)
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.
acceptEnvironmentAccountConnectionRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CancelEnvironmentDeploymentResult> cancelEnvironmentDeploymentAsync(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.
cancelEnvironmentDeploymentRequest - Future<CancelEnvironmentDeploymentResult> cancelEnvironmentDeploymentAsync(CancelEnvironmentDeploymentRequest cancelEnvironmentDeploymentRequest, AsyncHandler<CancelEnvironmentDeploymentRequest,CancelEnvironmentDeploymentResult> asyncHandler)
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.
cancelEnvironmentDeploymentRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CancelServiceInstanceDeploymentResult> cancelServiceInstanceDeploymentAsync(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.
cancelServiceInstanceDeploymentRequest - Future<CancelServiceInstanceDeploymentResult> cancelServiceInstanceDeploymentAsync(CancelServiceInstanceDeploymentRequest cancelServiceInstanceDeploymentRequest, AsyncHandler<CancelServiceInstanceDeploymentRequest,CancelServiceInstanceDeploymentResult> asyncHandler)
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.
cancelServiceInstanceDeploymentRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CancelServicePipelineDeploymentResult> cancelServicePipelineDeploymentAsync(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.
cancelServicePipelineDeploymentRequest - Future<CancelServicePipelineDeploymentResult> cancelServicePipelineDeploymentAsync(CancelServicePipelineDeploymentRequest cancelServicePipelineDeploymentRequest, AsyncHandler<CancelServicePipelineDeploymentRequest,CancelServicePipelineDeploymentResult> asyncHandler)
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.
cancelServicePipelineDeploymentRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateEnvironmentResult> createEnvironmentAsync(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.
createEnvironmentRequest - Future<CreateEnvironmentResult> createEnvironmentAsync(CreateEnvironmentRequest createEnvironmentRequest, AsyncHandler<CreateEnvironmentRequest,CreateEnvironmentResult> asyncHandler)
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.
createEnvironmentRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateEnvironmentAccountConnectionResult> createEnvironmentAccountConnectionAsync(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.
createEnvironmentAccountConnectionRequest - Future<CreateEnvironmentAccountConnectionResult> createEnvironmentAccountConnectionAsync(CreateEnvironmentAccountConnectionRequest createEnvironmentAccountConnectionRequest, AsyncHandler<CreateEnvironmentAccountConnectionRequest,CreateEnvironmentAccountConnectionResult> asyncHandler)
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.
createEnvironmentAccountConnectionRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateEnvironmentTemplateResult> createEnvironmentTemplateAsync(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.
createEnvironmentTemplateRequest - Future<CreateEnvironmentTemplateResult> createEnvironmentTemplateAsync(CreateEnvironmentTemplateRequest createEnvironmentTemplateRequest, AsyncHandler<CreateEnvironmentTemplateRequest,CreateEnvironmentTemplateResult> asyncHandler)
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.
createEnvironmentTemplateRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateEnvironmentTemplateVersionResult> createEnvironmentTemplateVersionAsync(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.
createEnvironmentTemplateVersionRequest - Future<CreateEnvironmentTemplateVersionResult> createEnvironmentTemplateVersionAsync(CreateEnvironmentTemplateVersionRequest createEnvironmentTemplateVersionRequest, AsyncHandler<CreateEnvironmentTemplateVersionRequest,CreateEnvironmentTemplateVersionResult> asyncHandler)
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.
createEnvironmentTemplateVersionRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateServiceResult> createServiceAsync(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.
createServiceRequest - Future<CreateServiceResult> createServiceAsync(CreateServiceRequest createServiceRequest, AsyncHandler<CreateServiceRequest,CreateServiceResult> asyncHandler)
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.
createServiceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateServiceTemplateResult> createServiceTemplateAsync(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.
createServiceTemplateRequest - Future<CreateServiceTemplateResult> createServiceTemplateAsync(CreateServiceTemplateRequest createServiceTemplateRequest, AsyncHandler<CreateServiceTemplateRequest,CreateServiceTemplateResult> asyncHandler)
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.
createServiceTemplateRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateServiceTemplateVersionResult> createServiceTemplateVersionAsync(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.
createServiceTemplateVersionRequest - Future<CreateServiceTemplateVersionResult> createServiceTemplateVersionAsync(CreateServiceTemplateVersionRequest createServiceTemplateVersionRequest, AsyncHandler<CreateServiceTemplateVersionRequest,CreateServiceTemplateVersionResult> asyncHandler)
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.
createServiceTemplateVersionRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteEnvironmentResult> deleteEnvironmentAsync(DeleteEnvironmentRequest deleteEnvironmentRequest)
Delete an environment.
deleteEnvironmentRequest - Future<DeleteEnvironmentResult> deleteEnvironmentAsync(DeleteEnvironmentRequest deleteEnvironmentRequest, AsyncHandler<DeleteEnvironmentRequest,DeleteEnvironmentResult> asyncHandler)
Delete an environment.
deleteEnvironmentRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteEnvironmentAccountConnectionResult> deleteEnvironmentAccountConnectionAsync(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.
deleteEnvironmentAccountConnectionRequest - Future<DeleteEnvironmentAccountConnectionResult> deleteEnvironmentAccountConnectionAsync(DeleteEnvironmentAccountConnectionRequest deleteEnvironmentAccountConnectionRequest, AsyncHandler<DeleteEnvironmentAccountConnectionRequest,DeleteEnvironmentAccountConnectionResult> asyncHandler)
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.
deleteEnvironmentAccountConnectionRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteEnvironmentTemplateResult> deleteEnvironmentTemplateAsync(DeleteEnvironmentTemplateRequest deleteEnvironmentTemplateRequest)
If no other major or minor versions of an environment template exist, delete the environment template.
deleteEnvironmentTemplateRequest - Future<DeleteEnvironmentTemplateResult> deleteEnvironmentTemplateAsync(DeleteEnvironmentTemplateRequest deleteEnvironmentTemplateRequest, AsyncHandler<DeleteEnvironmentTemplateRequest,DeleteEnvironmentTemplateResult> asyncHandler)
If no other major or minor versions of an environment template exist, delete the environment template.
deleteEnvironmentTemplateRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteEnvironmentTemplateVersionResult> deleteEnvironmentTemplateVersionAsync(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.
deleteEnvironmentTemplateVersionRequest - Future<DeleteEnvironmentTemplateVersionResult> deleteEnvironmentTemplateVersionAsync(DeleteEnvironmentTemplateVersionRequest deleteEnvironmentTemplateVersionRequest, AsyncHandler<DeleteEnvironmentTemplateVersionRequest,DeleteEnvironmentTemplateVersionResult> asyncHandler)
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.
deleteEnvironmentTemplateVersionRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteServiceResult> deleteServiceAsync(DeleteServiceRequest deleteServiceRequest)
Delete a service.
deleteServiceRequest - Future<DeleteServiceResult> deleteServiceAsync(DeleteServiceRequest deleteServiceRequest, AsyncHandler<DeleteServiceRequest,DeleteServiceResult> asyncHandler)
Delete a service.
deleteServiceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteServiceTemplateResult> deleteServiceTemplateAsync(DeleteServiceTemplateRequest deleteServiceTemplateRequest)
If no other major or minor versions of the service template exist, delete the service template.
deleteServiceTemplateRequest - Future<DeleteServiceTemplateResult> deleteServiceTemplateAsync(DeleteServiceTemplateRequest deleteServiceTemplateRequest, AsyncHandler<DeleteServiceTemplateRequest,DeleteServiceTemplateResult> asyncHandler)
If no other major or minor versions of the service template exist, delete the service template.
deleteServiceTemplateRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteServiceTemplateVersionResult> deleteServiceTemplateVersionAsync(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.
deleteServiceTemplateVersionRequest - Future<DeleteServiceTemplateVersionResult> deleteServiceTemplateVersionAsync(DeleteServiceTemplateVersionRequest deleteServiceTemplateVersionRequest, AsyncHandler<DeleteServiceTemplateVersionRequest,DeleteServiceTemplateVersionResult> asyncHandler)
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.
deleteServiceTemplateVersionRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetAccountSettingsResult> getAccountSettingsAsync(GetAccountSettingsRequest getAccountSettingsRequest)
Get detail data for the AWS Proton pipeline service role.
getAccountSettingsRequest - Future<GetAccountSettingsResult> getAccountSettingsAsync(GetAccountSettingsRequest getAccountSettingsRequest, AsyncHandler<GetAccountSettingsRequest,GetAccountSettingsResult> asyncHandler)
Get detail data for the AWS Proton pipeline service role.
getAccountSettingsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetEnvironmentResult> getEnvironmentAsync(GetEnvironmentRequest getEnvironmentRequest)
Get detail data for an environment.
getEnvironmentRequest - Future<GetEnvironmentResult> getEnvironmentAsync(GetEnvironmentRequest getEnvironmentRequest, AsyncHandler<GetEnvironmentRequest,GetEnvironmentResult> asyncHandler)
Get detail data for an environment.
getEnvironmentRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetEnvironmentAccountConnectionResult> getEnvironmentAccountConnectionAsync(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.
getEnvironmentAccountConnectionRequest - Future<GetEnvironmentAccountConnectionResult> getEnvironmentAccountConnectionAsync(GetEnvironmentAccountConnectionRequest getEnvironmentAccountConnectionRequest, AsyncHandler<GetEnvironmentAccountConnectionRequest,GetEnvironmentAccountConnectionResult> asyncHandler)
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.
getEnvironmentAccountConnectionRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetEnvironmentTemplateResult> getEnvironmentTemplateAsync(GetEnvironmentTemplateRequest getEnvironmentTemplateRequest)
Get detail data for an environment template.
getEnvironmentTemplateRequest - Future<GetEnvironmentTemplateResult> getEnvironmentTemplateAsync(GetEnvironmentTemplateRequest getEnvironmentTemplateRequest, AsyncHandler<GetEnvironmentTemplateRequest,GetEnvironmentTemplateResult> asyncHandler)
Get detail data for an environment template.
getEnvironmentTemplateRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetEnvironmentTemplateVersionResult> getEnvironmentTemplateVersionAsync(GetEnvironmentTemplateVersionRequest getEnvironmentTemplateVersionRequest)
View detail data for a major or minor version of an environment template.
getEnvironmentTemplateVersionRequest - Future<GetEnvironmentTemplateVersionResult> getEnvironmentTemplateVersionAsync(GetEnvironmentTemplateVersionRequest getEnvironmentTemplateVersionRequest, AsyncHandler<GetEnvironmentTemplateVersionRequest,GetEnvironmentTemplateVersionResult> asyncHandler)
View detail data for a major or minor version of an environment template.
getEnvironmentTemplateVersionRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetServiceResult> getServiceAsync(GetServiceRequest getServiceRequest)
Get detail data for a service.
getServiceRequest - Future<GetServiceResult> getServiceAsync(GetServiceRequest getServiceRequest, AsyncHandler<GetServiceRequest,GetServiceResult> asyncHandler)
Get detail data for a service.
getServiceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetServiceInstanceResult> getServiceInstanceAsync(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.
getServiceInstanceRequest - Future<GetServiceInstanceResult> getServiceInstanceAsync(GetServiceInstanceRequest getServiceInstanceRequest, AsyncHandler<GetServiceInstanceRequest,GetServiceInstanceResult> asyncHandler)
Get detail data for a service instance. A service instance is an instantiation of service template, which is running in a specific environment.
getServiceInstanceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetServiceTemplateResult> getServiceTemplateAsync(GetServiceTemplateRequest getServiceTemplateRequest)
Get detail data for a service template.
getServiceTemplateRequest - Future<GetServiceTemplateResult> getServiceTemplateAsync(GetServiceTemplateRequest getServiceTemplateRequest, AsyncHandler<GetServiceTemplateRequest,GetServiceTemplateResult> asyncHandler)
Get detail data for a service template.
getServiceTemplateRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetServiceTemplateVersionResult> getServiceTemplateVersionAsync(GetServiceTemplateVersionRequest getServiceTemplateVersionRequest)
View detail data for a major or minor version of a service template.
getServiceTemplateVersionRequest - Future<GetServiceTemplateVersionResult> getServiceTemplateVersionAsync(GetServiceTemplateVersionRequest getServiceTemplateVersionRequest, AsyncHandler<GetServiceTemplateVersionRequest,GetServiceTemplateVersionResult> asyncHandler)
View detail data for a major or minor version of a service template.
getServiceTemplateVersionRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListEnvironmentAccountConnectionsResult> listEnvironmentAccountConnectionsAsync(ListEnvironmentAccountConnectionsRequest listEnvironmentAccountConnectionsRequest)
View a list of environment account connections.
For more information, see Environment account connections in the AWS Proton Administrator guide.
listEnvironmentAccountConnectionsRequest - Future<ListEnvironmentAccountConnectionsResult> listEnvironmentAccountConnectionsAsync(ListEnvironmentAccountConnectionsRequest listEnvironmentAccountConnectionsRequest, AsyncHandler<ListEnvironmentAccountConnectionsRequest,ListEnvironmentAccountConnectionsResult> asyncHandler)
View a list of environment account connections.
For more information, see Environment account connections in the AWS Proton Administrator guide.
listEnvironmentAccountConnectionsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListEnvironmentTemplateVersionsResult> listEnvironmentTemplateVersionsAsync(ListEnvironmentTemplateVersionsRequest listEnvironmentTemplateVersionsRequest)
List major or minor versions of an environment template with detail data.
listEnvironmentTemplateVersionsRequest - Future<ListEnvironmentTemplateVersionsResult> listEnvironmentTemplateVersionsAsync(ListEnvironmentTemplateVersionsRequest listEnvironmentTemplateVersionsRequest, AsyncHandler<ListEnvironmentTemplateVersionsRequest,ListEnvironmentTemplateVersionsResult> asyncHandler)
List major or minor versions of an environment template with detail data.
listEnvironmentTemplateVersionsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListEnvironmentTemplatesResult> listEnvironmentTemplatesAsync(ListEnvironmentTemplatesRequest listEnvironmentTemplatesRequest)
List environment templates.
listEnvironmentTemplatesRequest - Future<ListEnvironmentTemplatesResult> listEnvironmentTemplatesAsync(ListEnvironmentTemplatesRequest listEnvironmentTemplatesRequest, AsyncHandler<ListEnvironmentTemplatesRequest,ListEnvironmentTemplatesResult> asyncHandler)
List environment templates.
listEnvironmentTemplatesRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListEnvironmentsResult> listEnvironmentsAsync(ListEnvironmentsRequest listEnvironmentsRequest)
List environments with detail data summaries.
listEnvironmentsRequest - Future<ListEnvironmentsResult> listEnvironmentsAsync(ListEnvironmentsRequest listEnvironmentsRequest, AsyncHandler<ListEnvironmentsRequest,ListEnvironmentsResult> asyncHandler)
List environments with detail data summaries.
listEnvironmentsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListServiceInstancesResult> listServiceInstancesAsync(ListServiceInstancesRequest listServiceInstancesRequest)
List service instances with summaries of detail data.
listServiceInstancesRequest - Future<ListServiceInstancesResult> listServiceInstancesAsync(ListServiceInstancesRequest listServiceInstancesRequest, AsyncHandler<ListServiceInstancesRequest,ListServiceInstancesResult> asyncHandler)
List service instances with summaries of detail data.
listServiceInstancesRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListServiceTemplateVersionsResult> listServiceTemplateVersionsAsync(ListServiceTemplateVersionsRequest listServiceTemplateVersionsRequest)
List major or minor versions of a service template with detail data.
listServiceTemplateVersionsRequest - Future<ListServiceTemplateVersionsResult> listServiceTemplateVersionsAsync(ListServiceTemplateVersionsRequest listServiceTemplateVersionsRequest, AsyncHandler<ListServiceTemplateVersionsRequest,ListServiceTemplateVersionsResult> asyncHandler)
List major or minor versions of a service template with detail data.
listServiceTemplateVersionsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListServiceTemplatesResult> listServiceTemplatesAsync(ListServiceTemplatesRequest listServiceTemplatesRequest)
List service templates with detail data.
listServiceTemplatesRequest - Future<ListServiceTemplatesResult> listServiceTemplatesAsync(ListServiceTemplatesRequest listServiceTemplatesRequest, AsyncHandler<ListServiceTemplatesRequest,ListServiceTemplatesResult> asyncHandler)
List service templates with detail data.
listServiceTemplatesRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListServicesResult> listServicesAsync(ListServicesRequest listServicesRequest)
List services with summaries of detail data.
listServicesRequest - Future<ListServicesResult> listServicesAsync(ListServicesRequest listServicesRequest, AsyncHandler<ListServicesRequest,ListServicesResult> asyncHandler)
List services with summaries of detail data.
listServicesRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListTagsForResourceResult> listTagsForResourceAsync(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.
listTagsForResourceRequest - Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
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.
listTagsForResourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<RejectEnvironmentAccountConnectionResult> rejectEnvironmentAccountConnectionAsync(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.
rejectEnvironmentAccountConnectionRequest - Future<RejectEnvironmentAccountConnectionResult> rejectEnvironmentAccountConnectionAsync(RejectEnvironmentAccountConnectionRequest rejectEnvironmentAccountConnectionRequest, AsyncHandler<RejectEnvironmentAccountConnectionRequest,RejectEnvironmentAccountConnectionResult> asyncHandler)
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.
rejectEnvironmentAccountConnectionRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<TagResourceResult> tagResourceAsync(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.
tagResourceRequest - Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
Tag a resource. For more information, see AWS Proton resources and tagging in the AWS Proton Administrator Guide or AWS Proton User Guide.
tagResourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UntagResourceResult> untagResourceAsync(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.
untagResourceRequest - Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
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.
untagResourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateAccountSettingsResult> updateAccountSettingsAsync(UpdateAccountSettingsRequest updateAccountSettingsRequest)
Update the AWS Proton pipeline service account settings.
updateAccountSettingsRequest - Future<UpdateAccountSettingsResult> updateAccountSettingsAsync(UpdateAccountSettingsRequest updateAccountSettingsRequest, AsyncHandler<UpdateAccountSettingsRequest,UpdateAccountSettingsResult> asyncHandler)
Update the AWS Proton pipeline service account settings.
updateAccountSettingsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateEnvironmentResult> updateEnvironmentAsync(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).
updateEnvironmentRequest - Future<UpdateEnvironmentResult> updateEnvironmentAsync(UpdateEnvironmentRequest updateEnvironmentRequest, AsyncHandler<UpdateEnvironmentRequest,UpdateEnvironmentResult> asyncHandler)
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).
updateEnvironmentRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateEnvironmentAccountConnectionResult> updateEnvironmentAccountConnectionAsync(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.
updateEnvironmentAccountConnectionRequest - Future<UpdateEnvironmentAccountConnectionResult> updateEnvironmentAccountConnectionAsync(UpdateEnvironmentAccountConnectionRequest updateEnvironmentAccountConnectionRequest, AsyncHandler<UpdateEnvironmentAccountConnectionRequest,UpdateEnvironmentAccountConnectionResult> asyncHandler)
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.
updateEnvironmentAccountConnectionRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateEnvironmentTemplateResult> updateEnvironmentTemplateAsync(UpdateEnvironmentTemplateRequest updateEnvironmentTemplateRequest)
Update an environment template.
updateEnvironmentTemplateRequest - Future<UpdateEnvironmentTemplateResult> updateEnvironmentTemplateAsync(UpdateEnvironmentTemplateRequest updateEnvironmentTemplateRequest, AsyncHandler<UpdateEnvironmentTemplateRequest,UpdateEnvironmentTemplateResult> asyncHandler)
Update an environment template.
updateEnvironmentTemplateRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateEnvironmentTemplateVersionResult> updateEnvironmentTemplateVersionAsync(UpdateEnvironmentTemplateVersionRequest updateEnvironmentTemplateVersionRequest)
Update a major or minor version of an environment template.
updateEnvironmentTemplateVersionRequest - Future<UpdateEnvironmentTemplateVersionResult> updateEnvironmentTemplateVersionAsync(UpdateEnvironmentTemplateVersionRequest updateEnvironmentTemplateVersionRequest, AsyncHandler<UpdateEnvironmentTemplateVersionRequest,UpdateEnvironmentTemplateVersionResult> asyncHandler)
Update a major or minor version of an environment template.
updateEnvironmentTemplateVersionRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateServiceResult> updateServiceAsync(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.
updateServiceRequest - Future<UpdateServiceResult> updateServiceAsync(UpdateServiceRequest updateServiceRequest, AsyncHandler<UpdateServiceRequest,UpdateServiceResult> asyncHandler)
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.
updateServiceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateServiceInstanceResult> updateServiceInstanceAsync(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).
updateServiceInstanceRequest - Future<UpdateServiceInstanceResult> updateServiceInstanceAsync(UpdateServiceInstanceRequest updateServiceInstanceRequest, AsyncHandler<UpdateServiceInstanceRequest,UpdateServiceInstanceResult> asyncHandler)
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).
updateServiceInstanceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateServicePipelineResult> updateServicePipelineAsync(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).
updateServicePipelineRequest - Future<UpdateServicePipelineResult> updateServicePipelineAsync(UpdateServicePipelineRequest updateServicePipelineRequest, AsyncHandler<UpdateServicePipelineRequest,UpdateServicePipelineResult> asyncHandler)
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).
updateServicePipelineRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateServiceTemplateResult> updateServiceTemplateAsync(UpdateServiceTemplateRequest updateServiceTemplateRequest)
Update a service template.
updateServiceTemplateRequest - Future<UpdateServiceTemplateResult> updateServiceTemplateAsync(UpdateServiceTemplateRequest updateServiceTemplateRequest, AsyncHandler<UpdateServiceTemplateRequest,UpdateServiceTemplateResult> asyncHandler)
Update a service template.
updateServiceTemplateRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateServiceTemplateVersionResult> updateServiceTemplateVersionAsync(UpdateServiceTemplateVersionRequest updateServiceTemplateVersionRequest)
Update a major or minor version of a service template.
updateServiceTemplateVersionRequest - Future<UpdateServiceTemplateVersionResult> updateServiceTemplateVersionAsync(UpdateServiceTemplateVersionRequest updateServiceTemplateVersionRequest, AsyncHandler<UpdateServiceTemplateVersionRequest,UpdateServiceTemplateVersionResult> asyncHandler)
Update a major or minor version of a service template.
updateServiceTemplateVersionRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.