@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSProtonAsyncClient extends AWSProtonClient implements AWSProtonAsync
AsyncHandler
can be used to receive
notification when an asynchronous operation completes.
This is the AWS Proton Service API Reference. It provides descriptions, syntax and usage examples for each of the actions and data types for the AWS Proton service.
The documentation for each action shows the Query API request parameters and the XML response.
Alternatively, you can use the AWS CLI to access an API. For more information, see the AWS Command Line Interface User Guide.
The AWS Proton service is a two-pronged automation framework. Administrators create service templates to provide standardized infrastructure and deployment tooling for serverless and container based applications. Developers, in turn, select from the available service templates to automate their application or service deployments.
Because administrators define the infrastructure and tooling that AWS Proton deploys and manages, they need permissions to use all of the listed API operations.
When developers select a specific infrastructure and tooling set, AWS Proton deploys their applications. To monitor their applications that are running on AWS Proton, developers need permissions to the service create, list, update and delete API operations and the service instance list and update API operations.
To learn more about AWS Proton administration, see the AWS Proton Administrator Guide.
To learn more about deploying serverless and containerized applications on AWS Proton, see the AWS Proton User Guide.
Ensuring Idempotency
When you make a mutating API request, the request typically returns a result before the asynchronous workflows of the operation are complete. Operations might also time out or encounter other server issues before they're complete, even if the request already returned a result. This might make it difficult to determine whether the request succeeded. Moreover, you might need to retry the request multiple times to ensure that the operation completes successfully. However, if the original request and the subsequent retries are successful, the operation occurs multiple times. This means that you might create more resources than you intended.
Idempotency ensures that an API request action completes no more than one time. With an idempotent request, if the original request action completes successfully, any subsequent retries complete successfully without performing any further actions. However, the result might contain updated information, such as the current creation status.
The following lists of APIs are grouped according to methods that ensure idempotency.
Idempotent create APIs with a client token
The API actions in this list support idempotency with the use of a client token. The corresponding AWS CLI commands also support idempotency using a client token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. To make an idempotent API request using one of these actions, specify a client token in the request. We recommend that you don't reuse the same client token for other API requests. If you don’t provide a client token for these APIs, a default client token is automatically provided by SDKs.
Given a request action that has succeeded:
If you retry the request using the same client token and the same parameters, the retry succeeds without performing any further actions other than returning the original resource detail data in the response.
If you retry the request using the same client token, but one or more of the parameters are different, the retry
throws a ValidationException
with an IdempotentParameterMismatch
error.
Client tokens expire eight hours after a request is made. If you retry the request with the expired token, a new resource is created.
If the original resource is deleted and you retry the request, a new resource is created.
Idempotent create APIs with a client token:
CreateEnvironmentTemplateVersion
CreateServiceTemplateVersion
CreateEnvironmentAccountConnection
Idempotent create APIs
Given a request action that has succeeded:
If you retry the request with an API from this group, and the original resource hasn't been modified, the retry succeeds without performing any further actions other than returning the original resource detail data in the response.
If the original resource has been modified, the retry throws a ConflictException
.
If you retry with different input parameters, the retry throws a ValidationException
with an
IdempotentParameterMismatch
error.
Idempotent create APIs:
CreateEnvironmentTemplate
CreateServiceTemplate
CreateEnvironment
CreateService
Idempotent delete APIs
Given a request action that has succeeded:
When you retry the request with an API from this group and the resource was deleted, its metadata is returned in the response.
If you retry and the resource doesn't exist, the response is empty.
In both cases, the retry succeeds.
Idempotent delete APIs:
DeleteEnvironmentTemplate
DeleteEnvironmentTemplateVersion
DeleteServiceTemplate
DeleteServiceTemplateVersion
DeleteEnvironmentAccountConnection
Asynchronous idempotent delete APIs
Given a request action that has succeeded:
If you retry the request with an API from this group, if the original request delete operation status is
DELETE_IN_PROGRESS
, the retry returns the resource detail data in the response without performing any
further actions.
If the original request delete operation is complete, a retry returns an empty response.
Asynchronous idempotent delete APIs:
DeleteEnvironment
DeleteService
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
acceptEnvironmentAccountConnection, builder, 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, tagResource, untagResource, updateAccountSettings, updateEnvironment, updateEnvironmentAccountConnection, updateEnvironmentTemplate, updateEnvironmentTemplateVersion, updateService, updateServiceInstance, updateServicePipeline, updateServiceTemplate, updateServiceTemplateVersion, waiters
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
acceptEnvironmentAccountConnection, 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, tagResource, untagResource, updateAccountSettings, updateEnvironment, updateEnvironmentAccountConnection, updateEnvironmentTemplate, updateEnvironmentTemplateVersion, updateService, updateServiceInstance, updateServicePipeline, updateServiceTemplate, updateServiceTemplateVersion, waiters
public static AWSProtonAsyncClientBuilder asyncBuilder()
public ExecutorService getExecutorService()
public Future<AcceptEnvironmentAccountConnectionResult> acceptEnvironmentAccountConnectionAsync(AcceptEnvironmentAccountConnectionRequest request)
AWSProtonAsync
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.
acceptEnvironmentAccountConnectionAsync
in interface AWSProtonAsync
public Future<AcceptEnvironmentAccountConnectionResult> acceptEnvironmentAccountConnectionAsync(AcceptEnvironmentAccountConnectionRequest request, AsyncHandler<AcceptEnvironmentAccountConnectionRequest,AcceptEnvironmentAccountConnectionResult> asyncHandler)
AWSProtonAsync
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.
acceptEnvironmentAccountConnectionAsync
in interface AWSProtonAsync
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.public Future<CancelEnvironmentDeploymentResult> cancelEnvironmentDeploymentAsync(CancelEnvironmentDeploymentRequest request)
AWSProtonAsync
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.
cancelEnvironmentDeploymentAsync
in interface AWSProtonAsync
public Future<CancelEnvironmentDeploymentResult> cancelEnvironmentDeploymentAsync(CancelEnvironmentDeploymentRequest request, AsyncHandler<CancelEnvironmentDeploymentRequest,CancelEnvironmentDeploymentResult> asyncHandler)
AWSProtonAsync
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.
cancelEnvironmentDeploymentAsync
in interface AWSProtonAsync
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.public Future<CancelServiceInstanceDeploymentResult> cancelServiceInstanceDeploymentAsync(CancelServiceInstanceDeploymentRequest request)
AWSProtonAsync
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.
cancelServiceInstanceDeploymentAsync
in interface AWSProtonAsync
public Future<CancelServiceInstanceDeploymentResult> cancelServiceInstanceDeploymentAsync(CancelServiceInstanceDeploymentRequest request, AsyncHandler<CancelServiceInstanceDeploymentRequest,CancelServiceInstanceDeploymentResult> asyncHandler)
AWSProtonAsync
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.
cancelServiceInstanceDeploymentAsync
in interface AWSProtonAsync
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.public Future<CancelServicePipelineDeploymentResult> cancelServicePipelineDeploymentAsync(CancelServicePipelineDeploymentRequest request)
AWSProtonAsync
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.
cancelServicePipelineDeploymentAsync
in interface AWSProtonAsync
public Future<CancelServicePipelineDeploymentResult> cancelServicePipelineDeploymentAsync(CancelServicePipelineDeploymentRequest request, AsyncHandler<CancelServicePipelineDeploymentRequest,CancelServicePipelineDeploymentResult> asyncHandler)
AWSProtonAsync
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.
cancelServicePipelineDeploymentAsync
in interface AWSProtonAsync
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.public Future<CreateEnvironmentResult> createEnvironmentAsync(CreateEnvironmentRequest request)
AWSProtonAsync
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.
createEnvironmentAsync
in interface AWSProtonAsync
public Future<CreateEnvironmentResult> createEnvironmentAsync(CreateEnvironmentRequest request, AsyncHandler<CreateEnvironmentRequest,CreateEnvironmentResult> asyncHandler)
AWSProtonAsync
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.
createEnvironmentAsync
in interface AWSProtonAsync
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.public Future<CreateEnvironmentAccountConnectionResult> createEnvironmentAccountConnectionAsync(CreateEnvironmentAccountConnectionRequest request)
AWSProtonAsync
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.
createEnvironmentAccountConnectionAsync
in interface AWSProtonAsync
public Future<CreateEnvironmentAccountConnectionResult> createEnvironmentAccountConnectionAsync(CreateEnvironmentAccountConnectionRequest request, AsyncHandler<CreateEnvironmentAccountConnectionRequest,CreateEnvironmentAccountConnectionResult> asyncHandler)
AWSProtonAsync
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.
createEnvironmentAccountConnectionAsync
in interface AWSProtonAsync
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.public Future<CreateEnvironmentTemplateResult> createEnvironmentTemplateAsync(CreateEnvironmentTemplateRequest request)
AWSProtonAsync
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.
createEnvironmentTemplateAsync
in interface AWSProtonAsync
public Future<CreateEnvironmentTemplateResult> createEnvironmentTemplateAsync(CreateEnvironmentTemplateRequest request, AsyncHandler<CreateEnvironmentTemplateRequest,CreateEnvironmentTemplateResult> asyncHandler)
AWSProtonAsync
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.
createEnvironmentTemplateAsync
in interface AWSProtonAsync
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.public Future<CreateEnvironmentTemplateVersionResult> createEnvironmentTemplateVersionAsync(CreateEnvironmentTemplateVersionRequest request)
AWSProtonAsync
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.
createEnvironmentTemplateVersionAsync
in interface AWSProtonAsync
public Future<CreateEnvironmentTemplateVersionResult> createEnvironmentTemplateVersionAsync(CreateEnvironmentTemplateVersionRequest request, AsyncHandler<CreateEnvironmentTemplateVersionRequest,CreateEnvironmentTemplateVersionResult> asyncHandler)
AWSProtonAsync
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.
createEnvironmentTemplateVersionAsync
in interface AWSProtonAsync
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.public Future<CreateServiceResult> createServiceAsync(CreateServiceRequest request)
AWSProtonAsync
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.
createServiceAsync
in interface AWSProtonAsync
public Future<CreateServiceResult> createServiceAsync(CreateServiceRequest request, AsyncHandler<CreateServiceRequest,CreateServiceResult> asyncHandler)
AWSProtonAsync
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.
createServiceAsync
in interface AWSProtonAsync
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.public Future<CreateServiceTemplateResult> createServiceTemplateAsync(CreateServiceTemplateRequest request)
AWSProtonAsync
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.
createServiceTemplateAsync
in interface AWSProtonAsync
public Future<CreateServiceTemplateResult> createServiceTemplateAsync(CreateServiceTemplateRequest request, AsyncHandler<CreateServiceTemplateRequest,CreateServiceTemplateResult> asyncHandler)
AWSProtonAsync
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.
createServiceTemplateAsync
in interface AWSProtonAsync
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.public Future<CreateServiceTemplateVersionResult> createServiceTemplateVersionAsync(CreateServiceTemplateVersionRequest request)
AWSProtonAsync
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.
createServiceTemplateVersionAsync
in interface AWSProtonAsync
public Future<CreateServiceTemplateVersionResult> createServiceTemplateVersionAsync(CreateServiceTemplateVersionRequest request, AsyncHandler<CreateServiceTemplateVersionRequest,CreateServiceTemplateVersionResult> asyncHandler)
AWSProtonAsync
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.
createServiceTemplateVersionAsync
in interface AWSProtonAsync
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.public Future<DeleteEnvironmentResult> deleteEnvironmentAsync(DeleteEnvironmentRequest request)
AWSProtonAsync
Delete an environment.
deleteEnvironmentAsync
in interface AWSProtonAsync
public Future<DeleteEnvironmentResult> deleteEnvironmentAsync(DeleteEnvironmentRequest request, AsyncHandler<DeleteEnvironmentRequest,DeleteEnvironmentResult> asyncHandler)
AWSProtonAsync
Delete an environment.
deleteEnvironmentAsync
in interface AWSProtonAsync
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.public Future<DeleteEnvironmentAccountConnectionResult> deleteEnvironmentAccountConnectionAsync(DeleteEnvironmentAccountConnectionRequest request)
AWSProtonAsync
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.
deleteEnvironmentAccountConnectionAsync
in interface AWSProtonAsync
public Future<DeleteEnvironmentAccountConnectionResult> deleteEnvironmentAccountConnectionAsync(DeleteEnvironmentAccountConnectionRequest request, AsyncHandler<DeleteEnvironmentAccountConnectionRequest,DeleteEnvironmentAccountConnectionResult> asyncHandler)
AWSProtonAsync
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.
deleteEnvironmentAccountConnectionAsync
in interface AWSProtonAsync
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.public Future<DeleteEnvironmentTemplateResult> deleteEnvironmentTemplateAsync(DeleteEnvironmentTemplateRequest request)
AWSProtonAsync
If no other major or minor versions of an environment template exist, delete the environment template.
deleteEnvironmentTemplateAsync
in interface AWSProtonAsync
public Future<DeleteEnvironmentTemplateResult> deleteEnvironmentTemplateAsync(DeleteEnvironmentTemplateRequest request, AsyncHandler<DeleteEnvironmentTemplateRequest,DeleteEnvironmentTemplateResult> asyncHandler)
AWSProtonAsync
If no other major or minor versions of an environment template exist, delete the environment template.
deleteEnvironmentTemplateAsync
in interface AWSProtonAsync
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.public Future<DeleteEnvironmentTemplateVersionResult> deleteEnvironmentTemplateVersionAsync(DeleteEnvironmentTemplateVersionRequest request)
AWSProtonAsync
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.
deleteEnvironmentTemplateVersionAsync
in interface AWSProtonAsync
public Future<DeleteEnvironmentTemplateVersionResult> deleteEnvironmentTemplateVersionAsync(DeleteEnvironmentTemplateVersionRequest request, AsyncHandler<DeleteEnvironmentTemplateVersionRequest,DeleteEnvironmentTemplateVersionResult> asyncHandler)
AWSProtonAsync
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.
deleteEnvironmentTemplateVersionAsync
in interface AWSProtonAsync
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.public Future<DeleteServiceResult> deleteServiceAsync(DeleteServiceRequest request)
AWSProtonAsync
Delete a service.
deleteServiceAsync
in interface AWSProtonAsync
public Future<DeleteServiceResult> deleteServiceAsync(DeleteServiceRequest request, AsyncHandler<DeleteServiceRequest,DeleteServiceResult> asyncHandler)
AWSProtonAsync
Delete a service.
deleteServiceAsync
in interface AWSProtonAsync
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.public Future<DeleteServiceTemplateResult> deleteServiceTemplateAsync(DeleteServiceTemplateRequest request)
AWSProtonAsync
If no other major or minor versions of the service template exist, delete the service template.
deleteServiceTemplateAsync
in interface AWSProtonAsync
public Future<DeleteServiceTemplateResult> deleteServiceTemplateAsync(DeleteServiceTemplateRequest request, AsyncHandler<DeleteServiceTemplateRequest,DeleteServiceTemplateResult> asyncHandler)
AWSProtonAsync
If no other major or minor versions of the service template exist, delete the service template.
deleteServiceTemplateAsync
in interface AWSProtonAsync
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.public Future<DeleteServiceTemplateVersionResult> deleteServiceTemplateVersionAsync(DeleteServiceTemplateVersionRequest request)
AWSProtonAsync
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.
deleteServiceTemplateVersionAsync
in interface AWSProtonAsync
public Future<DeleteServiceTemplateVersionResult> deleteServiceTemplateVersionAsync(DeleteServiceTemplateVersionRequest request, AsyncHandler<DeleteServiceTemplateVersionRequest,DeleteServiceTemplateVersionResult> asyncHandler)
AWSProtonAsync
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.
deleteServiceTemplateVersionAsync
in interface AWSProtonAsync
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.public Future<GetAccountSettingsResult> getAccountSettingsAsync(GetAccountSettingsRequest request)
AWSProtonAsync
Get detail data for the AWS Proton pipeline service role.
getAccountSettingsAsync
in interface AWSProtonAsync
public Future<GetAccountSettingsResult> getAccountSettingsAsync(GetAccountSettingsRequest request, AsyncHandler<GetAccountSettingsRequest,GetAccountSettingsResult> asyncHandler)
AWSProtonAsync
Get detail data for the AWS Proton pipeline service role.
getAccountSettingsAsync
in interface AWSProtonAsync
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.public Future<GetEnvironmentResult> getEnvironmentAsync(GetEnvironmentRequest request)
AWSProtonAsync
Get detail data for an environment.
getEnvironmentAsync
in interface AWSProtonAsync
public Future<GetEnvironmentResult> getEnvironmentAsync(GetEnvironmentRequest request, AsyncHandler<GetEnvironmentRequest,GetEnvironmentResult> asyncHandler)
AWSProtonAsync
Get detail data for an environment.
getEnvironmentAsync
in interface AWSProtonAsync
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.public Future<GetEnvironmentAccountConnectionResult> getEnvironmentAccountConnectionAsync(GetEnvironmentAccountConnectionRequest request)
AWSProtonAsync
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.
getEnvironmentAccountConnectionAsync
in interface AWSProtonAsync
public Future<GetEnvironmentAccountConnectionResult> getEnvironmentAccountConnectionAsync(GetEnvironmentAccountConnectionRequest request, AsyncHandler<GetEnvironmentAccountConnectionRequest,GetEnvironmentAccountConnectionResult> asyncHandler)
AWSProtonAsync
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.
getEnvironmentAccountConnectionAsync
in interface AWSProtonAsync
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.public Future<GetEnvironmentTemplateResult> getEnvironmentTemplateAsync(GetEnvironmentTemplateRequest request)
AWSProtonAsync
Get detail data for an environment template.
getEnvironmentTemplateAsync
in interface AWSProtonAsync
public Future<GetEnvironmentTemplateResult> getEnvironmentTemplateAsync(GetEnvironmentTemplateRequest request, AsyncHandler<GetEnvironmentTemplateRequest,GetEnvironmentTemplateResult> asyncHandler)
AWSProtonAsync
Get detail data for an environment template.
getEnvironmentTemplateAsync
in interface AWSProtonAsync
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.public Future<GetEnvironmentTemplateVersionResult> getEnvironmentTemplateVersionAsync(GetEnvironmentTemplateVersionRequest request)
AWSProtonAsync
View detail data for a major or minor version of an environment template.
getEnvironmentTemplateVersionAsync
in interface AWSProtonAsync
public Future<GetEnvironmentTemplateVersionResult> getEnvironmentTemplateVersionAsync(GetEnvironmentTemplateVersionRequest request, AsyncHandler<GetEnvironmentTemplateVersionRequest,GetEnvironmentTemplateVersionResult> asyncHandler)
AWSProtonAsync
View detail data for a major or minor version of an environment template.
getEnvironmentTemplateVersionAsync
in interface AWSProtonAsync
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.public Future<GetServiceResult> getServiceAsync(GetServiceRequest request)
AWSProtonAsync
Get detail data for a service.
getServiceAsync
in interface AWSProtonAsync
public Future<GetServiceResult> getServiceAsync(GetServiceRequest request, AsyncHandler<GetServiceRequest,GetServiceResult> asyncHandler)
AWSProtonAsync
Get detail data for a service.
getServiceAsync
in interface AWSProtonAsync
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.public Future<GetServiceInstanceResult> getServiceInstanceAsync(GetServiceInstanceRequest request)
AWSProtonAsync
Get detail data for a service instance. A service instance is an instantiation of service template, which is running in a specific environment.
getServiceInstanceAsync
in interface AWSProtonAsync
public Future<GetServiceInstanceResult> getServiceInstanceAsync(GetServiceInstanceRequest request, AsyncHandler<GetServiceInstanceRequest,GetServiceInstanceResult> asyncHandler)
AWSProtonAsync
Get detail data for a service instance. A service instance is an instantiation of service template, which is running in a specific environment.
getServiceInstanceAsync
in interface AWSProtonAsync
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.public Future<GetServiceTemplateResult> getServiceTemplateAsync(GetServiceTemplateRequest request)
AWSProtonAsync
Get detail data for a service template.
getServiceTemplateAsync
in interface AWSProtonAsync
public Future<GetServiceTemplateResult> getServiceTemplateAsync(GetServiceTemplateRequest request, AsyncHandler<GetServiceTemplateRequest,GetServiceTemplateResult> asyncHandler)
AWSProtonAsync
Get detail data for a service template.
getServiceTemplateAsync
in interface AWSProtonAsync
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.public Future<GetServiceTemplateVersionResult> getServiceTemplateVersionAsync(GetServiceTemplateVersionRequest request)
AWSProtonAsync
View detail data for a major or minor version of a service template.
getServiceTemplateVersionAsync
in interface AWSProtonAsync
public Future<GetServiceTemplateVersionResult> getServiceTemplateVersionAsync(GetServiceTemplateVersionRequest request, AsyncHandler<GetServiceTemplateVersionRequest,GetServiceTemplateVersionResult> asyncHandler)
AWSProtonAsync
View detail data for a major or minor version of a service template.
getServiceTemplateVersionAsync
in interface AWSProtonAsync
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.public Future<ListEnvironmentAccountConnectionsResult> listEnvironmentAccountConnectionsAsync(ListEnvironmentAccountConnectionsRequest request)
AWSProtonAsync
View a list of environment account connections.
For more information, see Environment account connections in the AWS Proton Administrator guide.
listEnvironmentAccountConnectionsAsync
in interface AWSProtonAsync
public Future<ListEnvironmentAccountConnectionsResult> listEnvironmentAccountConnectionsAsync(ListEnvironmentAccountConnectionsRequest request, AsyncHandler<ListEnvironmentAccountConnectionsRequest,ListEnvironmentAccountConnectionsResult> asyncHandler)
AWSProtonAsync
View a list of environment account connections.
For more information, see Environment account connections in the AWS Proton Administrator guide.
listEnvironmentAccountConnectionsAsync
in interface AWSProtonAsync
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.public Future<ListEnvironmentTemplateVersionsResult> listEnvironmentTemplateVersionsAsync(ListEnvironmentTemplateVersionsRequest request)
AWSProtonAsync
List major or minor versions of an environment template with detail data.
listEnvironmentTemplateVersionsAsync
in interface AWSProtonAsync
public Future<ListEnvironmentTemplateVersionsResult> listEnvironmentTemplateVersionsAsync(ListEnvironmentTemplateVersionsRequest request, AsyncHandler<ListEnvironmentTemplateVersionsRequest,ListEnvironmentTemplateVersionsResult> asyncHandler)
AWSProtonAsync
List major or minor versions of an environment template with detail data.
listEnvironmentTemplateVersionsAsync
in interface AWSProtonAsync
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.public Future<ListEnvironmentTemplatesResult> listEnvironmentTemplatesAsync(ListEnvironmentTemplatesRequest request)
AWSProtonAsync
List environment templates.
listEnvironmentTemplatesAsync
in interface AWSProtonAsync
public Future<ListEnvironmentTemplatesResult> listEnvironmentTemplatesAsync(ListEnvironmentTemplatesRequest request, AsyncHandler<ListEnvironmentTemplatesRequest,ListEnvironmentTemplatesResult> asyncHandler)
AWSProtonAsync
List environment templates.
listEnvironmentTemplatesAsync
in interface AWSProtonAsync
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.public Future<ListEnvironmentsResult> listEnvironmentsAsync(ListEnvironmentsRequest request)
AWSProtonAsync
List environments with detail data summaries.
listEnvironmentsAsync
in interface AWSProtonAsync
public Future<ListEnvironmentsResult> listEnvironmentsAsync(ListEnvironmentsRequest request, AsyncHandler<ListEnvironmentsRequest,ListEnvironmentsResult> asyncHandler)
AWSProtonAsync
List environments with detail data summaries.
listEnvironmentsAsync
in interface AWSProtonAsync
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.public Future<ListServiceInstancesResult> listServiceInstancesAsync(ListServiceInstancesRequest request)
AWSProtonAsync
List service instances with summaries of detail data.
listServiceInstancesAsync
in interface AWSProtonAsync
public Future<ListServiceInstancesResult> listServiceInstancesAsync(ListServiceInstancesRequest request, AsyncHandler<ListServiceInstancesRequest,ListServiceInstancesResult> asyncHandler)
AWSProtonAsync
List service instances with summaries of detail data.
listServiceInstancesAsync
in interface AWSProtonAsync
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.public Future<ListServiceTemplateVersionsResult> listServiceTemplateVersionsAsync(ListServiceTemplateVersionsRequest request)
AWSProtonAsync
List major or minor versions of a service template with detail data.
listServiceTemplateVersionsAsync
in interface AWSProtonAsync
public Future<ListServiceTemplateVersionsResult> listServiceTemplateVersionsAsync(ListServiceTemplateVersionsRequest request, AsyncHandler<ListServiceTemplateVersionsRequest,ListServiceTemplateVersionsResult> asyncHandler)
AWSProtonAsync
List major or minor versions of a service template with detail data.
listServiceTemplateVersionsAsync
in interface AWSProtonAsync
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.public Future<ListServiceTemplatesResult> listServiceTemplatesAsync(ListServiceTemplatesRequest request)
AWSProtonAsync
List service templates with detail data.
listServiceTemplatesAsync
in interface AWSProtonAsync
public Future<ListServiceTemplatesResult> listServiceTemplatesAsync(ListServiceTemplatesRequest request, AsyncHandler<ListServiceTemplatesRequest,ListServiceTemplatesResult> asyncHandler)
AWSProtonAsync
List service templates with detail data.
listServiceTemplatesAsync
in interface AWSProtonAsync
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.public Future<ListServicesResult> listServicesAsync(ListServicesRequest request)
AWSProtonAsync
List services with summaries of detail data.
listServicesAsync
in interface AWSProtonAsync
public Future<ListServicesResult> listServicesAsync(ListServicesRequest request, AsyncHandler<ListServicesRequest,ListServicesResult> asyncHandler)
AWSProtonAsync
List services with summaries of detail data.
listServicesAsync
in interface AWSProtonAsync
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.public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request)
AWSProtonAsync
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.
listTagsForResourceAsync
in interface AWSProtonAsync
public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
AWSProtonAsync
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.
listTagsForResourceAsync
in interface AWSProtonAsync
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.public Future<RejectEnvironmentAccountConnectionResult> rejectEnvironmentAccountConnectionAsync(RejectEnvironmentAccountConnectionRequest request)
AWSProtonAsync
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.
rejectEnvironmentAccountConnectionAsync
in interface AWSProtonAsync
public Future<RejectEnvironmentAccountConnectionResult> rejectEnvironmentAccountConnectionAsync(RejectEnvironmentAccountConnectionRequest request, AsyncHandler<RejectEnvironmentAccountConnectionRequest,RejectEnvironmentAccountConnectionResult> asyncHandler)
AWSProtonAsync
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.
rejectEnvironmentAccountConnectionAsync
in interface AWSProtonAsync
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.public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request)
AWSProtonAsync
Tag a resource. For more information, see AWS Proton resources and tagging in the AWS Proton Administrator Guide or AWS Proton User Guide.
tagResourceAsync
in interface AWSProtonAsync
public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
AWSProtonAsync
Tag a resource. For more information, see AWS Proton resources and tagging in the AWS Proton Administrator Guide or AWS Proton User Guide.
tagResourceAsync
in interface AWSProtonAsync
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.public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request)
AWSProtonAsync
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.
untagResourceAsync
in interface AWSProtonAsync
public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
AWSProtonAsync
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.
untagResourceAsync
in interface AWSProtonAsync
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.public Future<UpdateAccountSettingsResult> updateAccountSettingsAsync(UpdateAccountSettingsRequest request)
AWSProtonAsync
Update the AWS Proton pipeline service account settings.
updateAccountSettingsAsync
in interface AWSProtonAsync
public Future<UpdateAccountSettingsResult> updateAccountSettingsAsync(UpdateAccountSettingsRequest request, AsyncHandler<UpdateAccountSettingsRequest,UpdateAccountSettingsResult> asyncHandler)
AWSProtonAsync
Update the AWS Proton pipeline service account settings.
updateAccountSettingsAsync
in interface AWSProtonAsync
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.public Future<UpdateEnvironmentResult> updateEnvironmentAsync(UpdateEnvironmentRequest request)
AWSProtonAsync
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).
updateEnvironmentAsync
in interface AWSProtonAsync
public Future<UpdateEnvironmentResult> updateEnvironmentAsync(UpdateEnvironmentRequest request, AsyncHandler<UpdateEnvironmentRequest,UpdateEnvironmentResult> asyncHandler)
AWSProtonAsync
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).
updateEnvironmentAsync
in interface AWSProtonAsync
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.public Future<UpdateEnvironmentAccountConnectionResult> updateEnvironmentAccountConnectionAsync(UpdateEnvironmentAccountConnectionRequest request)
AWSProtonAsync
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.
updateEnvironmentAccountConnectionAsync
in interface AWSProtonAsync
public Future<UpdateEnvironmentAccountConnectionResult> updateEnvironmentAccountConnectionAsync(UpdateEnvironmentAccountConnectionRequest request, AsyncHandler<UpdateEnvironmentAccountConnectionRequest,UpdateEnvironmentAccountConnectionResult> asyncHandler)
AWSProtonAsync
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.
updateEnvironmentAccountConnectionAsync
in interface AWSProtonAsync
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.public Future<UpdateEnvironmentTemplateResult> updateEnvironmentTemplateAsync(UpdateEnvironmentTemplateRequest request)
AWSProtonAsync
Update an environment template.
updateEnvironmentTemplateAsync
in interface AWSProtonAsync
public Future<UpdateEnvironmentTemplateResult> updateEnvironmentTemplateAsync(UpdateEnvironmentTemplateRequest request, AsyncHandler<UpdateEnvironmentTemplateRequest,UpdateEnvironmentTemplateResult> asyncHandler)
AWSProtonAsync
Update an environment template.
updateEnvironmentTemplateAsync
in interface AWSProtonAsync
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.public Future<UpdateEnvironmentTemplateVersionResult> updateEnvironmentTemplateVersionAsync(UpdateEnvironmentTemplateVersionRequest request)
AWSProtonAsync
Update a major or minor version of an environment template.
updateEnvironmentTemplateVersionAsync
in interface AWSProtonAsync
public Future<UpdateEnvironmentTemplateVersionResult> updateEnvironmentTemplateVersionAsync(UpdateEnvironmentTemplateVersionRequest request, AsyncHandler<UpdateEnvironmentTemplateVersionRequest,UpdateEnvironmentTemplateVersionResult> asyncHandler)
AWSProtonAsync
Update a major or minor version of an environment template.
updateEnvironmentTemplateVersionAsync
in interface AWSProtonAsync
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.public Future<UpdateServiceResult> updateServiceAsync(UpdateServiceRequest request)
AWSProtonAsync
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.
updateServiceAsync
in interface AWSProtonAsync
public Future<UpdateServiceResult> updateServiceAsync(UpdateServiceRequest request, AsyncHandler<UpdateServiceRequest,UpdateServiceResult> asyncHandler)
AWSProtonAsync
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.
updateServiceAsync
in interface AWSProtonAsync
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.public Future<UpdateServiceInstanceResult> updateServiceInstanceAsync(UpdateServiceInstanceRequest request)
AWSProtonAsync
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).
updateServiceInstanceAsync
in interface AWSProtonAsync
public Future<UpdateServiceInstanceResult> updateServiceInstanceAsync(UpdateServiceInstanceRequest request, AsyncHandler<UpdateServiceInstanceRequest,UpdateServiceInstanceResult> asyncHandler)
AWSProtonAsync
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).
updateServiceInstanceAsync
in interface AWSProtonAsync
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.public Future<UpdateServicePipelineResult> updateServicePipelineAsync(UpdateServicePipelineRequest request)
AWSProtonAsync
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).
updateServicePipelineAsync
in interface AWSProtonAsync
public Future<UpdateServicePipelineResult> updateServicePipelineAsync(UpdateServicePipelineRequest request, AsyncHandler<UpdateServicePipelineRequest,UpdateServicePipelineResult> asyncHandler)
AWSProtonAsync
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).
updateServicePipelineAsync
in interface AWSProtonAsync
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.public Future<UpdateServiceTemplateResult> updateServiceTemplateAsync(UpdateServiceTemplateRequest request)
AWSProtonAsync
Update a service template.
updateServiceTemplateAsync
in interface AWSProtonAsync
public Future<UpdateServiceTemplateResult> updateServiceTemplateAsync(UpdateServiceTemplateRequest request, AsyncHandler<UpdateServiceTemplateRequest,UpdateServiceTemplateResult> asyncHandler)
AWSProtonAsync
Update a service template.
updateServiceTemplateAsync
in interface AWSProtonAsync
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.public Future<UpdateServiceTemplateVersionResult> updateServiceTemplateVersionAsync(UpdateServiceTemplateVersionRequest request)
AWSProtonAsync
Update a major or minor version of a service template.
updateServiceTemplateVersionAsync
in interface AWSProtonAsync
public Future<UpdateServiceTemplateVersionResult> updateServiceTemplateVersionAsync(UpdateServiceTemplateVersionRequest request, AsyncHandler<UpdateServiceTemplateVersionRequest,UpdateServiceTemplateVersionResult> asyncHandler)
AWSProtonAsync
Update a major or minor version of a service template.
updateServiceTemplateVersionAsync
in interface AWSProtonAsync
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.public void shutdown()
getExecutorService().shutdown()
followed by getExecutorService().awaitTermination()
prior to
calling this method.shutdown
in interface AWSProton
shutdown
in class AWSProtonClient