Interface CodeDeployAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient
supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in
some cases such as credentials retrieval and endpoint discovery as part of the async API call.
CodeDeploy is a deployment service that automates application deployments to Amazon EC2 instances, on-premises instances running in your own facility, serverless Lambda functions, or applications in an Amazon ECS service.
You can deploy a nearly unlimited variety of application content, such as an updated Lambda function, updated applications in an Amazon ECS service, code, web and configuration files, executables, packages, scripts, multimedia files, and so on. CodeDeploy can deploy application content stored in Amazon S3 buckets, GitHub repositories, or Bitbucket repositories. You do not need to make changes to your existing code before you can use CodeDeploy.
CodeDeploy makes it easier for you to rapidly release new features, helps you avoid downtime during application deployment, and handles the complexity of updating your applications, without many of the risks associated with error-prone manual deployments.
CodeDeploy Components
Use the information in this guide to help you work with the following CodeDeploy components:
-
Application: A name that uniquely identifies the application you want to deploy. CodeDeploy uses this name, which functions as a container, to ensure the correct combination of revision, deployment configuration, and deployment group are referenced during a deployment.
-
Deployment group: A set of individual instances, CodeDeploy Lambda deployment configuration settings, or an Amazon ECS service and network details. A Lambda deployment group specifies how to route traffic to a new version of a Lambda function. An Amazon ECS deployment group specifies the service created in Amazon ECS to deploy, a load balancer, and a listener to reroute production traffic to an updated containerized application. An Amazon EC2/On-premises deployment group contains individually tagged instances, Amazon EC2 instances in Amazon EC2 Auto Scaling groups, or both. All deployment groups can specify optional trigger, alarm, and rollback settings.
-
Deployment configuration: A set of deployment rules and deployment success and failure conditions used by CodeDeploy during a deployment.
-
Deployment: The process and the components used when updating a Lambda function, a containerized application in an Amazon ECS service, or of installing content on one or more instances.
-
Application revisions: For an Lambda deployment, this is an AppSpec file that specifies the Lambda function to be updated and one or more functions to validate deployment lifecycle events. For an Amazon ECS deployment, this is an AppSpec file that specifies the Amazon ECS task definition, container, and port where production traffic is rerouted. For an EC2/On-premises deployment, this is an archive file that contains source content—source code, webpages, executable files, and deployment scripts—along with an AppSpec file. Revisions are stored in Amazon S3 buckets or GitHub repositories. For Amazon S3, a revision is uniquely identified by its Amazon S3 object key and its ETag, version, or both. For GitHub, a revision is uniquely identified by its commit ID.
This guide also contains information to help you get details about the instances in your deployments, to make on-premises instances available for CodeDeploy deployments, to get details about a Lambda function deployment, and to get details about Amazon ECS service deployments.
CodeDeploy Information Resources
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionaddTagsToOnPremisesInstances
(Consumer<AddTagsToOnPremisesInstancesRequest.Builder> addTagsToOnPremisesInstancesRequest) Adds tags to on-premises instances.addTagsToOnPremisesInstances
(AddTagsToOnPremisesInstancesRequest addTagsToOnPremisesInstancesRequest) Adds tags to on-premises instances.batchGetApplicationRevisions
(Consumer<BatchGetApplicationRevisionsRequest.Builder> batchGetApplicationRevisionsRequest) Gets information about one or more application revisions.batchGetApplicationRevisions
(BatchGetApplicationRevisionsRequest batchGetApplicationRevisionsRequest) Gets information about one or more application revisions.batchGetApplications
(Consumer<BatchGetApplicationsRequest.Builder> batchGetApplicationsRequest) Gets information about one or more applications.batchGetApplications
(BatchGetApplicationsRequest batchGetApplicationsRequest) Gets information about one or more applications.batchGetDeploymentGroups
(Consumer<BatchGetDeploymentGroupsRequest.Builder> batchGetDeploymentGroupsRequest) Gets information about one or more deployment groups.batchGetDeploymentGroups
(BatchGetDeploymentGroupsRequest batchGetDeploymentGroupsRequest) Gets information about one or more deployment groups.batchGetDeployments
(Consumer<BatchGetDeploymentsRequest.Builder> batchGetDeploymentsRequest) Gets information about one or more deployments.batchGetDeployments
(BatchGetDeploymentsRequest batchGetDeploymentsRequest) Gets information about one or more deployments.batchGetDeploymentTargets
(Consumer<BatchGetDeploymentTargetsRequest.Builder> batchGetDeploymentTargetsRequest) Returns an array of one or more targets associated with a deployment.batchGetDeploymentTargets
(BatchGetDeploymentTargetsRequest batchGetDeploymentTargetsRequest) Returns an array of one or more targets associated with a deployment.batchGetOnPremisesInstances
(Consumer<BatchGetOnPremisesInstancesRequest.Builder> batchGetOnPremisesInstancesRequest) Gets information about one or more on-premises instances.batchGetOnPremisesInstances
(BatchGetOnPremisesInstancesRequest batchGetOnPremisesInstancesRequest) Gets information about one or more on-premises instances.static CodeDeployAsyncClientBuilder
builder()
Create a builder that can be used to configure and create aCodeDeployAsyncClient
.continueDeployment
(Consumer<ContinueDeploymentRequest.Builder> continueDeploymentRequest) For a blue/green deployment, starts the process of rerouting traffic from instances in the original environment to instances in the replacement environment without waiting for a specified wait time to elapse.continueDeployment
(ContinueDeploymentRequest continueDeploymentRequest) For a blue/green deployment, starts the process of rerouting traffic from instances in the original environment to instances in the replacement environment without waiting for a specified wait time to elapse.static CodeDeployAsyncClient
create()
Create aCodeDeployAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.createApplication
(Consumer<CreateApplicationRequest.Builder> createApplicationRequest) Creates an application.createApplication
(CreateApplicationRequest createApplicationRequest) Creates an application.createDeployment
(Consumer<CreateDeploymentRequest.Builder> createDeploymentRequest) Deploys an application revision through the specified deployment group.createDeployment
(CreateDeploymentRequest createDeploymentRequest) Deploys an application revision through the specified deployment group.createDeploymentConfig
(Consumer<CreateDeploymentConfigRequest.Builder> createDeploymentConfigRequest) Creates a deployment configuration.createDeploymentConfig
(CreateDeploymentConfigRequest createDeploymentConfigRequest) Creates a deployment configuration.createDeploymentGroup
(Consumer<CreateDeploymentGroupRequest.Builder> createDeploymentGroupRequest) Creates a deployment group to which application revisions are deployed.createDeploymentGroup
(CreateDeploymentGroupRequest createDeploymentGroupRequest) Creates a deployment group to which application revisions are deployed.deleteApplication
(Consumer<DeleteApplicationRequest.Builder> deleteApplicationRequest) Deletes an application.deleteApplication
(DeleteApplicationRequest deleteApplicationRequest) Deletes an application.deleteDeploymentConfig
(Consumer<DeleteDeploymentConfigRequest.Builder> deleteDeploymentConfigRequest) Deletes a deployment configuration.deleteDeploymentConfig
(DeleteDeploymentConfigRequest deleteDeploymentConfigRequest) Deletes a deployment configuration.deleteDeploymentGroup
(Consumer<DeleteDeploymentGroupRequest.Builder> deleteDeploymentGroupRequest) Deletes a deployment group.deleteDeploymentGroup
(DeleteDeploymentGroupRequest deleteDeploymentGroupRequest) Deletes a deployment group.deleteGitHubAccountToken
(Consumer<DeleteGitHubAccountTokenRequest.Builder> deleteGitHubAccountTokenRequest) Deletes a GitHub account connection.deleteGitHubAccountToken
(DeleteGitHubAccountTokenRequest deleteGitHubAccountTokenRequest) Deletes a GitHub account connection.deleteResourcesByExternalId
(Consumer<DeleteResourcesByExternalIdRequest.Builder> deleteResourcesByExternalIdRequest) Deletes resources linked to an external ID.deleteResourcesByExternalId
(DeleteResourcesByExternalIdRequest deleteResourcesByExternalIdRequest) Deletes resources linked to an external ID.deregisterOnPremisesInstance
(Consumer<DeregisterOnPremisesInstanceRequest.Builder> deregisterOnPremisesInstanceRequest) Deregisters an on-premises instance.deregisterOnPremisesInstance
(DeregisterOnPremisesInstanceRequest deregisterOnPremisesInstanceRequest) Deregisters an on-premises instance.default CompletableFuture
<GetApplicationResponse> getApplication
(Consumer<GetApplicationRequest.Builder> getApplicationRequest) Gets information about an application.default CompletableFuture
<GetApplicationResponse> getApplication
(GetApplicationRequest getApplicationRequest) Gets information about an application.getApplicationRevision
(Consumer<GetApplicationRevisionRequest.Builder> getApplicationRevisionRequest) Gets information about an application revision.getApplicationRevision
(GetApplicationRevisionRequest getApplicationRevisionRequest) Gets information about an application revision.default CompletableFuture
<GetDeploymentResponse> getDeployment
(Consumer<GetDeploymentRequest.Builder> getDeploymentRequest) Gets information about a deployment.default CompletableFuture
<GetDeploymentResponse> getDeployment
(GetDeploymentRequest getDeploymentRequest) Gets information about a deployment.getDeploymentConfig
(Consumer<GetDeploymentConfigRequest.Builder> getDeploymentConfigRequest) Gets information about a deployment configuration.getDeploymentConfig
(GetDeploymentConfigRequest getDeploymentConfigRequest) Gets information about a deployment configuration.getDeploymentGroup
(Consumer<GetDeploymentGroupRequest.Builder> getDeploymentGroupRequest) Gets information about a deployment group.getDeploymentGroup
(GetDeploymentGroupRequest getDeploymentGroupRequest) Gets information about a deployment group.getDeploymentTarget
(Consumer<GetDeploymentTargetRequest.Builder> getDeploymentTargetRequest) Returns information about a deployment target.getDeploymentTarget
(GetDeploymentTargetRequest getDeploymentTargetRequest) Returns information about a deployment target.getOnPremisesInstance
(Consumer<GetOnPremisesInstanceRequest.Builder> getOnPremisesInstanceRequest) Gets information about an on-premises instance.getOnPremisesInstance
(GetOnPremisesInstanceRequest getOnPremisesInstanceRequest) Gets information about an on-premises instance.listApplicationRevisions
(Consumer<ListApplicationRevisionsRequest.Builder> listApplicationRevisionsRequest) Lists information about revisions for an application.listApplicationRevisions
(ListApplicationRevisionsRequest listApplicationRevisionsRequest) Lists information about revisions for an application.listApplicationRevisionsPaginator
(Consumer<ListApplicationRevisionsRequest.Builder> listApplicationRevisionsRequest) This is a variant oflistApplicationRevisions(software.amazon.awssdk.services.codedeploy.model.ListApplicationRevisionsRequest)
operation.listApplicationRevisionsPaginator
(ListApplicationRevisionsRequest listApplicationRevisionsRequest) This is a variant oflistApplicationRevisions(software.amazon.awssdk.services.codedeploy.model.ListApplicationRevisionsRequest)
operation.Lists the applications registered with the user or Amazon Web Services account.listApplications
(Consumer<ListApplicationsRequest.Builder> listApplicationsRequest) Lists the applications registered with the user or Amazon Web Services account.listApplications
(ListApplicationsRequest listApplicationsRequest) Lists the applications registered with the user or Amazon Web Services account.default ListApplicationsPublisher
This is a variant oflistApplications(software.amazon.awssdk.services.codedeploy.model.ListApplicationsRequest)
operation.default ListApplicationsPublisher
listApplicationsPaginator
(Consumer<ListApplicationsRequest.Builder> listApplicationsRequest) This is a variant oflistApplications(software.amazon.awssdk.services.codedeploy.model.ListApplicationsRequest)
operation.default ListApplicationsPublisher
listApplicationsPaginator
(ListApplicationsRequest listApplicationsRequest) This is a variant oflistApplications(software.amazon.awssdk.services.codedeploy.model.ListApplicationsRequest)
operation.Lists the deployment configurations with the user or Amazon Web Services account.listDeploymentConfigs
(Consumer<ListDeploymentConfigsRequest.Builder> listDeploymentConfigsRequest) Lists the deployment configurations with the user or Amazon Web Services account.listDeploymentConfigs
(ListDeploymentConfigsRequest listDeploymentConfigsRequest) Lists the deployment configurations with the user or Amazon Web Services account.default ListDeploymentConfigsPublisher
This is a variant oflistDeploymentConfigs(software.amazon.awssdk.services.codedeploy.model.ListDeploymentConfigsRequest)
operation.default ListDeploymentConfigsPublisher
listDeploymentConfigsPaginator
(Consumer<ListDeploymentConfigsRequest.Builder> listDeploymentConfigsRequest) This is a variant oflistDeploymentConfigs(software.amazon.awssdk.services.codedeploy.model.ListDeploymentConfigsRequest)
operation.default ListDeploymentConfigsPublisher
listDeploymentConfigsPaginator
(ListDeploymentConfigsRequest listDeploymentConfigsRequest) This is a variant oflistDeploymentConfigs(software.amazon.awssdk.services.codedeploy.model.ListDeploymentConfigsRequest)
operation.listDeploymentGroups
(Consumer<ListDeploymentGroupsRequest.Builder> listDeploymentGroupsRequest) Lists the deployment groups for an application registered with the Amazon Web Services user or Amazon Web Services account.listDeploymentGroups
(ListDeploymentGroupsRequest listDeploymentGroupsRequest) Lists the deployment groups for an application registered with the Amazon Web Services user or Amazon Web Services account.default ListDeploymentGroupsPublisher
listDeploymentGroupsPaginator
(Consumer<ListDeploymentGroupsRequest.Builder> listDeploymentGroupsRequest) This is a variant oflistDeploymentGroups(software.amazon.awssdk.services.codedeploy.model.ListDeploymentGroupsRequest)
operation.default ListDeploymentGroupsPublisher
listDeploymentGroupsPaginator
(ListDeploymentGroupsRequest listDeploymentGroupsRequest) This is a variant oflistDeploymentGroups(software.amazon.awssdk.services.codedeploy.model.ListDeploymentGroupsRequest)
operation.default CompletableFuture
<ListDeploymentsResponse> Lists the deployments in a deployment group for an application registered with the user or Amazon Web Services account.default CompletableFuture
<ListDeploymentsResponse> listDeployments
(Consumer<ListDeploymentsRequest.Builder> listDeploymentsRequest) Lists the deployments in a deployment group for an application registered with the user or Amazon Web Services account.default CompletableFuture
<ListDeploymentsResponse> listDeployments
(ListDeploymentsRequest listDeploymentsRequest) Lists the deployments in a deployment group for an application registered with the user or Amazon Web Services account.default ListDeploymentsPublisher
This is a variant oflistDeployments(software.amazon.awssdk.services.codedeploy.model.ListDeploymentsRequest)
operation.default ListDeploymentsPublisher
listDeploymentsPaginator
(Consumer<ListDeploymentsRequest.Builder> listDeploymentsRequest) This is a variant oflistDeployments(software.amazon.awssdk.services.codedeploy.model.ListDeploymentsRequest)
operation.default ListDeploymentsPublisher
listDeploymentsPaginator
(ListDeploymentsRequest listDeploymentsRequest) This is a variant oflistDeployments(software.amazon.awssdk.services.codedeploy.model.ListDeploymentsRequest)
operation.listDeploymentTargets
(Consumer<ListDeploymentTargetsRequest.Builder> listDeploymentTargetsRequest) Returns an array of target IDs that are associated a deployment.listDeploymentTargets
(ListDeploymentTargetsRequest listDeploymentTargetsRequest) Returns an array of target IDs that are associated a deployment.Lists the names of stored connections to GitHub accounts.listGitHubAccountTokenNames
(Consumer<ListGitHubAccountTokenNamesRequest.Builder> listGitHubAccountTokenNamesRequest) Lists the names of stored connections to GitHub accounts.listGitHubAccountTokenNames
(ListGitHubAccountTokenNamesRequest listGitHubAccountTokenNamesRequest) Lists the names of stored connections to GitHub accounts.Gets a list of names for one or more on-premises instances.listOnPremisesInstances
(Consumer<ListOnPremisesInstancesRequest.Builder> listOnPremisesInstancesRequest) Gets a list of names for one or more on-premises instances.listOnPremisesInstances
(ListOnPremisesInstancesRequest listOnPremisesInstancesRequest) Gets a list of names for one or more on-premises instances.listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Returns a list of tags for the resource identified by a specified Amazon Resource Name (ARN).listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Returns a list of tags for the resource identified by a specified Amazon Resource Name (ARN).putLifecycleEventHookExecutionStatus
(Consumer<PutLifecycleEventHookExecutionStatusRequest.Builder> putLifecycleEventHookExecutionStatusRequest) Sets the result of a Lambda validation function.putLifecycleEventHookExecutionStatus
(PutLifecycleEventHookExecutionStatusRequest putLifecycleEventHookExecutionStatusRequest) Sets the result of a Lambda validation function.registerApplicationRevision
(Consumer<RegisterApplicationRevisionRequest.Builder> registerApplicationRevisionRequest) Registers with CodeDeploy a revision for the specified application.registerApplicationRevision
(RegisterApplicationRevisionRequest registerApplicationRevisionRequest) Registers with CodeDeploy a revision for the specified application.registerOnPremisesInstance
(Consumer<RegisterOnPremisesInstanceRequest.Builder> registerOnPremisesInstanceRequest) Registers an on-premises instance.registerOnPremisesInstance
(RegisterOnPremisesInstanceRequest registerOnPremisesInstanceRequest) Registers an on-premises instance.removeTagsFromOnPremisesInstances
(Consumer<RemoveTagsFromOnPremisesInstancesRequest.Builder> removeTagsFromOnPremisesInstancesRequest) Removes one or more tags from one or more on-premises instances.removeTagsFromOnPremisesInstances
(RemoveTagsFromOnPremisesInstancesRequest removeTagsFromOnPremisesInstancesRequest) Removes one or more tags from one or more on-premises instances.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationdefault CompletableFuture
<StopDeploymentResponse> stopDeployment
(Consumer<StopDeploymentRequest.Builder> stopDeploymentRequest) Attempts to stop an ongoing deployment.default CompletableFuture
<StopDeploymentResponse> stopDeployment
(StopDeploymentRequest stopDeploymentRequest) Attempts to stop an ongoing deployment.default CompletableFuture
<TagResourceResponse> tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Associates the list of tags in the inputTags
parameter with the resource identified by theResourceArn
input parameter.default CompletableFuture
<TagResourceResponse> tagResource
(TagResourceRequest tagResourceRequest) Associates the list of tags in the inputTags
parameter with the resource identified by theResourceArn
input parameter.default CompletableFuture
<UntagResourceResponse> untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Disassociates a resource from a list of tags.default CompletableFuture
<UntagResourceResponse> untagResource
(UntagResourceRequest untagResourceRequest) Disassociates a resource from a list of tags.updateApplication
(Consumer<UpdateApplicationRequest.Builder> updateApplicationRequest) Changes the name of an application.updateApplication
(UpdateApplicationRequest updateApplicationRequest) Changes the name of an application.updateDeploymentGroup
(Consumer<UpdateDeploymentGroupRequest.Builder> updateDeploymentGroupRequest) Changes information about a deployment group.updateDeploymentGroup
(UpdateDeploymentGroupRequest updateDeploymentGroupRequest) Changes information about a deployment group.default CodeDeployAsyncWaiter
waiter()
Create an instance ofCodeDeployAsyncWaiter
using this client.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
addTagsToOnPremisesInstances
default CompletableFuture<AddTagsToOnPremisesInstancesResponse> addTagsToOnPremisesInstances(AddTagsToOnPremisesInstancesRequest addTagsToOnPremisesInstancesRequest) Adds tags to on-premises instances.
- Parameters:
addTagsToOnPremisesInstancesRequest
- Represents the input of, and adds tags to, an on-premises instance operation.- Returns:
- A Java Future containing the result of the AddTagsToOnPremisesInstances operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InstanceNameRequiredException An on-premises instance name was not specified.
- InvalidInstanceNameException The on-premises instance name was specified in an invalid format.
- TagRequiredException A tag was not specified.
- InvalidTagException The tag was specified in an invalid format.
- TagLimitExceededException The maximum allowed number of tags was exceeded.
- InstanceLimitExceededException The maximum number of allowed on-premises instances in a single call was exceeded.
- InstanceNotRegisteredException The specified on-premises instance is not registered.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
addTagsToOnPremisesInstances
default CompletableFuture<AddTagsToOnPremisesInstancesResponse> addTagsToOnPremisesInstances(Consumer<AddTagsToOnPremisesInstancesRequest.Builder> addTagsToOnPremisesInstancesRequest) Adds tags to on-premises instances.
This is a convenience which creates an instance of the
AddTagsToOnPremisesInstancesRequest.Builder
avoiding the need to create one manually viaAddTagsToOnPremisesInstancesRequest.builder()
- Parameters:
addTagsToOnPremisesInstancesRequest
- AConsumer
that will call methods onAddTagsToOnPremisesInstancesRequest.Builder
to create a request. Represents the input of, and adds tags to, an on-premises instance operation.- Returns:
- A Java Future containing the result of the AddTagsToOnPremisesInstances operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InstanceNameRequiredException An on-premises instance name was not specified.
- InvalidInstanceNameException The on-premises instance name was specified in an invalid format.
- TagRequiredException A tag was not specified.
- InvalidTagException The tag was specified in an invalid format.
- TagLimitExceededException The maximum allowed number of tags was exceeded.
- InstanceLimitExceededException The maximum number of allowed on-premises instances in a single call was exceeded.
- InstanceNotRegisteredException The specified on-premises instance is not registered.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchGetApplicationRevisions
default CompletableFuture<BatchGetApplicationRevisionsResponse> batchGetApplicationRevisions(BatchGetApplicationRevisionsRequest batchGetApplicationRevisionsRequest) Gets information about one or more application revisions. The maximum number of application revisions that can be returned is 25.
- Parameters:
batchGetApplicationRevisionsRequest
- Represents the input of aBatchGetApplicationRevisions
operation.- Returns:
- A Java Future containing the result of the BatchGetApplicationRevisions operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ApplicationDoesNotExistException The application does not exist with the user or Amazon Web Services account.
- ApplicationNameRequiredException The minimum number of required application names was not specified.
- InvalidApplicationNameException The application name was specified in an invalid format.
- RevisionRequiredException The revision ID was not specified.
- InvalidRevisionException The revision was specified in an invalid format.
- BatchLimitExceededException The maximum number of names or IDs allowed for this request (100) was exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchGetApplicationRevisions
default CompletableFuture<BatchGetApplicationRevisionsResponse> batchGetApplicationRevisions(Consumer<BatchGetApplicationRevisionsRequest.Builder> batchGetApplicationRevisionsRequest) Gets information about one or more application revisions. The maximum number of application revisions that can be returned is 25.
This is a convenience which creates an instance of the
BatchGetApplicationRevisionsRequest.Builder
avoiding the need to create one manually viaBatchGetApplicationRevisionsRequest.builder()
- Parameters:
batchGetApplicationRevisionsRequest
- AConsumer
that will call methods onBatchGetApplicationRevisionsRequest.Builder
to create a request. Represents the input of aBatchGetApplicationRevisions
operation.- Returns:
- A Java Future containing the result of the BatchGetApplicationRevisions operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ApplicationDoesNotExistException The application does not exist with the user or Amazon Web Services account.
- ApplicationNameRequiredException The minimum number of required application names was not specified.
- InvalidApplicationNameException The application name was specified in an invalid format.
- RevisionRequiredException The revision ID was not specified.
- InvalidRevisionException The revision was specified in an invalid format.
- BatchLimitExceededException The maximum number of names or IDs allowed for this request (100) was exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchGetApplications
default CompletableFuture<BatchGetApplicationsResponse> batchGetApplications(BatchGetApplicationsRequest batchGetApplicationsRequest) Gets information about one or more applications. The maximum number of applications that can be returned is 100.
- Parameters:
batchGetApplicationsRequest
- Represents the input of aBatchGetApplications
operation.- Returns:
- A Java Future containing the result of the BatchGetApplications operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ApplicationNameRequiredException The minimum number of required application names was not specified.
- InvalidApplicationNameException The application name was specified in an invalid format.
- ApplicationDoesNotExistException The application does not exist with the user or Amazon Web Services account.
- BatchLimitExceededException The maximum number of names or IDs allowed for this request (100) was exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchGetApplications
default CompletableFuture<BatchGetApplicationsResponse> batchGetApplications(Consumer<BatchGetApplicationsRequest.Builder> batchGetApplicationsRequest) Gets information about one or more applications. The maximum number of applications that can be returned is 100.
This is a convenience which creates an instance of the
BatchGetApplicationsRequest.Builder
avoiding the need to create one manually viaBatchGetApplicationsRequest.builder()
- Parameters:
batchGetApplicationsRequest
- AConsumer
that will call methods onBatchGetApplicationsRequest.Builder
to create a request. Represents the input of aBatchGetApplications
operation.- Returns:
- A Java Future containing the result of the BatchGetApplications operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ApplicationNameRequiredException The minimum number of required application names was not specified.
- InvalidApplicationNameException The application name was specified in an invalid format.
- ApplicationDoesNotExistException The application does not exist with the user or Amazon Web Services account.
- BatchLimitExceededException The maximum number of names or IDs allowed for this request (100) was exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchGetDeploymentGroups
default CompletableFuture<BatchGetDeploymentGroupsResponse> batchGetDeploymentGroups(BatchGetDeploymentGroupsRequest batchGetDeploymentGroupsRequest) Gets information about one or more deployment groups.
- Parameters:
batchGetDeploymentGroupsRequest
- Represents the input of aBatchGetDeploymentGroups
operation.- Returns:
- A Java Future containing the result of the BatchGetDeploymentGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ApplicationNameRequiredException The minimum number of required application names was not specified.
- InvalidApplicationNameException The application name was specified in an invalid format.
- ApplicationDoesNotExistException The application does not exist with the user or Amazon Web Services account.
- DeploymentGroupNameRequiredException The deployment group name was not specified.
- InvalidDeploymentGroupNameException The deployment group name was specified in an invalid format.
- BatchLimitExceededException The maximum number of names or IDs allowed for this request (100) was exceeded.
- DeploymentConfigDoesNotExistException The deployment configuration does not exist with the user or Amazon Web Services account.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchGetDeploymentGroups
default CompletableFuture<BatchGetDeploymentGroupsResponse> batchGetDeploymentGroups(Consumer<BatchGetDeploymentGroupsRequest.Builder> batchGetDeploymentGroupsRequest) Gets information about one or more deployment groups.
This is a convenience which creates an instance of the
BatchGetDeploymentGroupsRequest.Builder
avoiding the need to create one manually viaBatchGetDeploymentGroupsRequest.builder()
- Parameters:
batchGetDeploymentGroupsRequest
- AConsumer
that will call methods onBatchGetDeploymentGroupsRequest.Builder
to create a request. Represents the input of aBatchGetDeploymentGroups
operation.- Returns:
- A Java Future containing the result of the BatchGetDeploymentGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ApplicationNameRequiredException The minimum number of required application names was not specified.
- InvalidApplicationNameException The application name was specified in an invalid format.
- ApplicationDoesNotExistException The application does not exist with the user or Amazon Web Services account.
- DeploymentGroupNameRequiredException The deployment group name was not specified.
- InvalidDeploymentGroupNameException The deployment group name was specified in an invalid format.
- BatchLimitExceededException The maximum number of names or IDs allowed for this request (100) was exceeded.
- DeploymentConfigDoesNotExistException The deployment configuration does not exist with the user or Amazon Web Services account.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchGetDeploymentTargets
default CompletableFuture<BatchGetDeploymentTargetsResponse> batchGetDeploymentTargets(BatchGetDeploymentTargetsRequest batchGetDeploymentTargetsRequest) Returns an array of one or more targets associated with a deployment. This method works with all compute types and should be used instead of the deprecated
BatchGetDeploymentInstances
. The maximum number of targets that can be returned is 25.The type of targets returned depends on the deployment's compute platform or deployment method:
-
EC2/On-premises: Information about Amazon EC2 instance targets.
-
Lambda: Information about Lambda functions targets.
-
Amazon ECS: Information about Amazon ECS service targets.
-
CloudFormation: Information about targets of blue/green deployments initiated by a CloudFormation stack update.
- Parameters:
batchGetDeploymentTargetsRequest
-- Returns:
- A Java Future containing the result of the BatchGetDeploymentTargets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidDeploymentIdException At least one of the deployment IDs was specified in an invalid format.
- DeploymentIdRequiredException At least one deployment ID must be specified.
- DeploymentDoesNotExistException The deployment with the user or Amazon Web Services account does not exist.
- DeploymentNotStartedException The specified deployment has not started.
- DeploymentTargetIdRequiredException A deployment target ID was not provided.
- InvalidDeploymentTargetIdException The target ID provided was not valid.
- DeploymentTargetDoesNotExistException The provided target ID does not belong to the attempted deployment.
- DeploymentTargetListSizeExceededException The maximum number of targets that can be associated with an Amazon ECS or Lambda deployment was exceeded. The target list of both types of deployments must have exactly one item. This exception does not apply to EC2/On-premises deployments.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
batchGetDeploymentTargets
default CompletableFuture<BatchGetDeploymentTargetsResponse> batchGetDeploymentTargets(Consumer<BatchGetDeploymentTargetsRequest.Builder> batchGetDeploymentTargetsRequest) Returns an array of one or more targets associated with a deployment. This method works with all compute types and should be used instead of the deprecated
BatchGetDeploymentInstances
. The maximum number of targets that can be returned is 25.The type of targets returned depends on the deployment's compute platform or deployment method:
-
EC2/On-premises: Information about Amazon EC2 instance targets.
-
Lambda: Information about Lambda functions targets.
-
Amazon ECS: Information about Amazon ECS service targets.
-
CloudFormation: Information about targets of blue/green deployments initiated by a CloudFormation stack update.
This is a convenience which creates an instance of the
BatchGetDeploymentTargetsRequest.Builder
avoiding the need to create one manually viaBatchGetDeploymentTargetsRequest.builder()
- Parameters:
batchGetDeploymentTargetsRequest
- AConsumer
that will call methods onBatchGetDeploymentTargetsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the BatchGetDeploymentTargets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidDeploymentIdException At least one of the deployment IDs was specified in an invalid format.
- DeploymentIdRequiredException At least one deployment ID must be specified.
- DeploymentDoesNotExistException The deployment with the user or Amazon Web Services account does not exist.
- DeploymentNotStartedException The specified deployment has not started.
- DeploymentTargetIdRequiredException A deployment target ID was not provided.
- InvalidDeploymentTargetIdException The target ID provided was not valid.
- DeploymentTargetDoesNotExistException The provided target ID does not belong to the attempted deployment.
- DeploymentTargetListSizeExceededException The maximum number of targets that can be associated with an Amazon ECS or Lambda deployment was exceeded. The target list of both types of deployments must have exactly one item. This exception does not apply to EC2/On-premises deployments.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
batchGetDeployments
default CompletableFuture<BatchGetDeploymentsResponse> batchGetDeployments(BatchGetDeploymentsRequest batchGetDeploymentsRequest) Gets information about one or more deployments. The maximum number of deployments that can be returned is 25.
- Parameters:
batchGetDeploymentsRequest
- Represents the input of aBatchGetDeployments
operation.- Returns:
- A Java Future containing the result of the BatchGetDeployments operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DeploymentIdRequiredException At least one deployment ID must be specified.
- InvalidDeploymentIdException At least one of the deployment IDs was specified in an invalid format.
- BatchLimitExceededException The maximum number of names or IDs allowed for this request (100) was exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchGetDeployments
default CompletableFuture<BatchGetDeploymentsResponse> batchGetDeployments(Consumer<BatchGetDeploymentsRequest.Builder> batchGetDeploymentsRequest) Gets information about one or more deployments. The maximum number of deployments that can be returned is 25.
This is a convenience which creates an instance of the
BatchGetDeploymentsRequest.Builder
avoiding the need to create one manually viaBatchGetDeploymentsRequest.builder()
- Parameters:
batchGetDeploymentsRequest
- AConsumer
that will call methods onBatchGetDeploymentsRequest.Builder
to create a request. Represents the input of aBatchGetDeployments
operation.- Returns:
- A Java Future containing the result of the BatchGetDeployments operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DeploymentIdRequiredException At least one deployment ID must be specified.
- InvalidDeploymentIdException At least one of the deployment IDs was specified in an invalid format.
- BatchLimitExceededException The maximum number of names or IDs allowed for this request (100) was exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchGetOnPremisesInstances
default CompletableFuture<BatchGetOnPremisesInstancesResponse> batchGetOnPremisesInstances(BatchGetOnPremisesInstancesRequest batchGetOnPremisesInstancesRequest) Gets information about one or more on-premises instances. The maximum number of on-premises instances that can be returned is 25.
- Parameters:
batchGetOnPremisesInstancesRequest
- Represents the input of aBatchGetOnPremisesInstances
operation.- Returns:
- A Java Future containing the result of the BatchGetOnPremisesInstances operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InstanceNameRequiredException An on-premises instance name was not specified.
- InvalidInstanceNameException The on-premises instance name was specified in an invalid format.
- BatchLimitExceededException The maximum number of names or IDs allowed for this request (100) was exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchGetOnPremisesInstances
default CompletableFuture<BatchGetOnPremisesInstancesResponse> batchGetOnPremisesInstances(Consumer<BatchGetOnPremisesInstancesRequest.Builder> batchGetOnPremisesInstancesRequest) Gets information about one or more on-premises instances. The maximum number of on-premises instances that can be returned is 25.
This is a convenience which creates an instance of the
BatchGetOnPremisesInstancesRequest.Builder
avoiding the need to create one manually viaBatchGetOnPremisesInstancesRequest.builder()
- Parameters:
batchGetOnPremisesInstancesRequest
- AConsumer
that will call methods onBatchGetOnPremisesInstancesRequest.Builder
to create a request. Represents the input of aBatchGetOnPremisesInstances
operation.- Returns:
- A Java Future containing the result of the BatchGetOnPremisesInstances operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InstanceNameRequiredException An on-premises instance name was not specified.
- InvalidInstanceNameException The on-premises instance name was specified in an invalid format.
- BatchLimitExceededException The maximum number of names or IDs allowed for this request (100) was exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
continueDeployment
default CompletableFuture<ContinueDeploymentResponse> continueDeployment(ContinueDeploymentRequest continueDeploymentRequest) For a blue/green deployment, starts the process of rerouting traffic from instances in the original environment to instances in the replacement environment without waiting for a specified wait time to elapse. (Traffic rerouting, which is achieved by registering instances in the replacement environment with the load balancer, can start as soon as all instances have a status of Ready.)
- Parameters:
continueDeploymentRequest
-- Returns:
- A Java Future containing the result of the ContinueDeployment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DeploymentIdRequiredException At least one deployment ID must be specified.
- DeploymentDoesNotExistException The deployment with the user or Amazon Web Services account does not exist.
- DeploymentAlreadyCompletedException The deployment is already complete.
- InvalidDeploymentIdException At least one of the deployment IDs was specified in an invalid format.
- DeploymentIsNotInReadyStateException The deployment does not have a status of Ready and can't continue yet.
- UnsupportedActionForDeploymentTypeException A call was submitted that is not supported for the specified deployment type.
- InvalidDeploymentWaitTypeException The wait type is invalid.
- InvalidDeploymentStatusException The specified deployment status doesn't exist or cannot be determined.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
continueDeployment
default CompletableFuture<ContinueDeploymentResponse> continueDeployment(Consumer<ContinueDeploymentRequest.Builder> continueDeploymentRequest) For a blue/green deployment, starts the process of rerouting traffic from instances in the original environment to instances in the replacement environment without waiting for a specified wait time to elapse. (Traffic rerouting, which is achieved by registering instances in the replacement environment with the load balancer, can start as soon as all instances have a status of Ready.)
This is a convenience which creates an instance of the
ContinueDeploymentRequest.Builder
avoiding the need to create one manually viaContinueDeploymentRequest.builder()
- Parameters:
continueDeploymentRequest
- AConsumer
that will call methods onContinueDeploymentRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ContinueDeployment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DeploymentIdRequiredException At least one deployment ID must be specified.
- DeploymentDoesNotExistException The deployment with the user or Amazon Web Services account does not exist.
- DeploymentAlreadyCompletedException The deployment is already complete.
- InvalidDeploymentIdException At least one of the deployment IDs was specified in an invalid format.
- DeploymentIsNotInReadyStateException The deployment does not have a status of Ready and can't continue yet.
- UnsupportedActionForDeploymentTypeException A call was submitted that is not supported for the specified deployment type.
- InvalidDeploymentWaitTypeException The wait type is invalid.
- InvalidDeploymentStatusException The specified deployment status doesn't exist or cannot be determined.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createApplication
default CompletableFuture<CreateApplicationResponse> createApplication(CreateApplicationRequest createApplicationRequest) Creates an application.
- Parameters:
createApplicationRequest
- Represents the input of aCreateApplication
operation.- Returns:
- A Java Future containing the result of the CreateApplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ApplicationNameRequiredException The minimum number of required application names was not specified.
- InvalidApplicationNameException The application name was specified in an invalid format.
- ApplicationAlreadyExistsException An application with the specified name with the user or Amazon Web Services account already exists.
- ApplicationLimitExceededException More applications were attempted to be created than are allowed.
- InvalidComputePlatformException The computePlatform is invalid. The computePlatform should be
Lambda
,Server
, orECS
. - InvalidTagsToAddException The specified tags are not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createApplication
default CompletableFuture<CreateApplicationResponse> createApplication(Consumer<CreateApplicationRequest.Builder> createApplicationRequest) Creates an application.
This is a convenience which creates an instance of the
CreateApplicationRequest.Builder
avoiding the need to create one manually viaCreateApplicationRequest.builder()
- Parameters:
createApplicationRequest
- AConsumer
that will call methods onCreateApplicationRequest.Builder
to create a request. Represents the input of aCreateApplication
operation.- Returns:
- A Java Future containing the result of the CreateApplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ApplicationNameRequiredException The minimum number of required application names was not specified.
- InvalidApplicationNameException The application name was specified in an invalid format.
- ApplicationAlreadyExistsException An application with the specified name with the user or Amazon Web Services account already exists.
- ApplicationLimitExceededException More applications were attempted to be created than are allowed.
- InvalidComputePlatformException The computePlatform is invalid. The computePlatform should be
Lambda
,Server
, orECS
. - InvalidTagsToAddException The specified tags are not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createDeployment
default CompletableFuture<CreateDeploymentResponse> createDeployment(CreateDeploymentRequest createDeploymentRequest) Deploys an application revision through the specified deployment group.
- Parameters:
createDeploymentRequest
- Represents the input of aCreateDeployment
operation.- Returns:
- A Java Future containing the result of the CreateDeployment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ApplicationNameRequiredException The minimum number of required application names was not specified.
- InvalidApplicationNameException The application name was specified in an invalid format.
- ApplicationDoesNotExistException The application does not exist with the user or Amazon Web Services account.
- DeploymentGroupNameRequiredException The deployment group name was not specified.
- InvalidDeploymentGroupNameException The deployment group name was specified in an invalid format.
- DeploymentGroupDoesNotExistException The named deployment group with the user or Amazon Web Services account does not exist.
- RevisionRequiredException The revision ID was not specified.
- RevisionDoesNotExistException The named revision does not exist with the user or Amazon Web Services account.
- InvalidRevisionException The revision was specified in an invalid format.
- InvalidDeploymentConfigNameException The deployment configuration name was specified in an invalid format.
- DeploymentConfigDoesNotExistException The deployment configuration does not exist with the user or Amazon Web Services account.
- DescriptionTooLongException The description is too long.
- DeploymentLimitExceededException The number of allowed deployments was exceeded.
- InvalidTargetInstancesException The target instance configuration is invalid. Possible causes
include:
-
Configuration data for target instances was entered for an in-place deployment.
-
The limit of 10 tags for a tag type was exceeded.
-
The combined length of the tag names exceeded the limit.
-
A specified tag is not currently applied to any instances.
-
- InvalidAlarmConfigException The format of the alarm configuration is invalid. Possible causes
include:
-
The alarm list is null.
-
The alarm object is null.
-
The alarm name is empty or null or exceeds the limit of 255 characters.
-
Two alarms with the same name have been specified.
-
The alarm configuration is enabled, but the alarm list is empty.
-
- AlarmsLimitExceededException The maximum number of alarms for a deployment group (10) was exceeded.
- InvalidAutoRollbackConfigException The automatic rollback configuration was specified in an invalid format. For example, automatic rollback is enabled, but an invalid triggering event type or no event types were listed.
- InvalidLoadBalancerInfoException An invalid load balancer name, or no load balancer name, was specified.
- InvalidFileExistsBehaviorException An invalid fileExistsBehavior option was specified to determine how CodeDeploy handles files or directories that already exist in a deployment target location, but weren't part of the previous successful deployment. Valid values include "DISALLOW," "OVERWRITE," and "RETAIN."
- InvalidRoleException The service role ARN was specified in an invalid format. Or, if an Auto Scaling group was specified, the specified service role does not grant the appropriate permissions to Amazon EC2 Auto Scaling.
- InvalidAutoScalingGroupException The Auto Scaling group was specified in an invalid format or does not exist.
- ThrottlingException An API function was called too frequently.
- InvalidUpdateOutdatedInstancesOnlyValueException The UpdateOutdatedInstancesOnly value is invalid.
For Lambda deployments,
false
is expected. For EC2/On-premises deployments,true
orfalse
is expected. - InvalidIgnoreApplicationStopFailuresValueException The IgnoreApplicationStopFailures value is
invalid. For Lambda deployments,
false
is expected. For EC2/On-premises deployments,true
orfalse
is expected. - InvalidGitHubAccountTokenException The GitHub token is not valid.
- InvalidTrafficRoutingConfigurationException The configuration that specifies how traffic is routed during a deployment is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createDeployment
default CompletableFuture<CreateDeploymentResponse> createDeployment(Consumer<CreateDeploymentRequest.Builder> createDeploymentRequest) Deploys an application revision through the specified deployment group.
This is a convenience which creates an instance of the
CreateDeploymentRequest.Builder
avoiding the need to create one manually viaCreateDeploymentRequest.builder()
- Parameters:
createDeploymentRequest
- AConsumer
that will call methods onCreateDeploymentRequest.Builder
to create a request. Represents the input of aCreateDeployment
operation.- Returns:
- A Java Future containing the result of the CreateDeployment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ApplicationNameRequiredException The minimum number of required application names was not specified.
- InvalidApplicationNameException The application name was specified in an invalid format.
- ApplicationDoesNotExistException The application does not exist with the user or Amazon Web Services account.
- DeploymentGroupNameRequiredException The deployment group name was not specified.
- InvalidDeploymentGroupNameException The deployment group name was specified in an invalid format.
- DeploymentGroupDoesNotExistException The named deployment group with the user or Amazon Web Services account does not exist.
- RevisionRequiredException The revision ID was not specified.
- RevisionDoesNotExistException The named revision does not exist with the user or Amazon Web Services account.
- InvalidRevisionException The revision was specified in an invalid format.
- InvalidDeploymentConfigNameException The deployment configuration name was specified in an invalid format.
- DeploymentConfigDoesNotExistException The deployment configuration does not exist with the user or Amazon Web Services account.
- DescriptionTooLongException The description is too long.
- DeploymentLimitExceededException The number of allowed deployments was exceeded.
- InvalidTargetInstancesException The target instance configuration is invalid. Possible causes
include:
-
Configuration data for target instances was entered for an in-place deployment.
-
The limit of 10 tags for a tag type was exceeded.
-
The combined length of the tag names exceeded the limit.
-
A specified tag is not currently applied to any instances.
-
- InvalidAlarmConfigException The format of the alarm configuration is invalid. Possible causes
include:
-
The alarm list is null.
-
The alarm object is null.
-
The alarm name is empty or null or exceeds the limit of 255 characters.
-
Two alarms with the same name have been specified.
-
The alarm configuration is enabled, but the alarm list is empty.
-
- AlarmsLimitExceededException The maximum number of alarms for a deployment group (10) was exceeded.
- InvalidAutoRollbackConfigException The automatic rollback configuration was specified in an invalid format. For example, automatic rollback is enabled, but an invalid triggering event type or no event types were listed.
- InvalidLoadBalancerInfoException An invalid load balancer name, or no load balancer name, was specified.
- InvalidFileExistsBehaviorException An invalid fileExistsBehavior option was specified to determine how CodeDeploy handles files or directories that already exist in a deployment target location, but weren't part of the previous successful deployment. Valid values include "DISALLOW," "OVERWRITE," and "RETAIN."
- InvalidRoleException The service role ARN was specified in an invalid format. Or, if an Auto Scaling group was specified, the specified service role does not grant the appropriate permissions to Amazon EC2 Auto Scaling.
- InvalidAutoScalingGroupException The Auto Scaling group was specified in an invalid format or does not exist.
- ThrottlingException An API function was called too frequently.
- InvalidUpdateOutdatedInstancesOnlyValueException The UpdateOutdatedInstancesOnly value is invalid.
For Lambda deployments,
false
is expected. For EC2/On-premises deployments,true
orfalse
is expected. - InvalidIgnoreApplicationStopFailuresValueException The IgnoreApplicationStopFailures value is
invalid. For Lambda deployments,
false
is expected. For EC2/On-premises deployments,true
orfalse
is expected. - InvalidGitHubAccountTokenException The GitHub token is not valid.
- InvalidTrafficRoutingConfigurationException The configuration that specifies how traffic is routed during a deployment is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createDeploymentConfig
default CompletableFuture<CreateDeploymentConfigResponse> createDeploymentConfig(CreateDeploymentConfigRequest createDeploymentConfigRequest) Creates a deployment configuration.
- Parameters:
createDeploymentConfigRequest
- Represents the input of aCreateDeploymentConfig
operation.- Returns:
- A Java Future containing the result of the CreateDeploymentConfig operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidDeploymentConfigNameException The deployment configuration name was specified in an invalid format.
- DeploymentConfigNameRequiredException The deployment configuration name was not specified.
- DeploymentConfigAlreadyExistsException A deployment configuration with the specified name with the user or Amazon Web Services account already exists.
- InvalidMinimumHealthyHostValueException The minimum healthy instance value was specified in an invalid format.
- DeploymentConfigLimitExceededException The deployment configurations limit was exceeded.
- InvalidComputePlatformException The computePlatform is invalid. The computePlatform should be
Lambda
,Server
, orECS
. - InvalidTrafficRoutingConfigurationException The configuration that specifies how traffic is routed during a deployment is invalid.
- InvalidZonalDeploymentConfigurationException The
ZonalConfig
object is not valid. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createDeploymentConfig
default CompletableFuture<CreateDeploymentConfigResponse> createDeploymentConfig(Consumer<CreateDeploymentConfigRequest.Builder> createDeploymentConfigRequest) Creates a deployment configuration.
This is a convenience which creates an instance of the
CreateDeploymentConfigRequest.Builder
avoiding the need to create one manually viaCreateDeploymentConfigRequest.builder()
- Parameters:
createDeploymentConfigRequest
- AConsumer
that will call methods onCreateDeploymentConfigRequest.Builder
to create a request. Represents the input of aCreateDeploymentConfig
operation.- Returns:
- A Java Future containing the result of the CreateDeploymentConfig operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidDeploymentConfigNameException The deployment configuration name was specified in an invalid format.
- DeploymentConfigNameRequiredException The deployment configuration name was not specified.
- DeploymentConfigAlreadyExistsException A deployment configuration with the specified name with the user or Amazon Web Services account already exists.
- InvalidMinimumHealthyHostValueException The minimum healthy instance value was specified in an invalid format.
- DeploymentConfigLimitExceededException The deployment configurations limit was exceeded.
- InvalidComputePlatformException The computePlatform is invalid. The computePlatform should be
Lambda
,Server
, orECS
. - InvalidTrafficRoutingConfigurationException The configuration that specifies how traffic is routed during a deployment is invalid.
- InvalidZonalDeploymentConfigurationException The
ZonalConfig
object is not valid. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createDeploymentGroup
default CompletableFuture<CreateDeploymentGroupResponse> createDeploymentGroup(CreateDeploymentGroupRequest createDeploymentGroupRequest) Creates a deployment group to which application revisions are deployed.
- Parameters:
createDeploymentGroupRequest
- Represents the input of aCreateDeploymentGroup
operation.- Returns:
- A Java Future containing the result of the CreateDeploymentGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ApplicationNameRequiredException The minimum number of required application names was not specified.
- InvalidApplicationNameException The application name was specified in an invalid format.
- ApplicationDoesNotExistException The application does not exist with the user or Amazon Web Services account.
- DeploymentGroupNameRequiredException The deployment group name was not specified.
- InvalidDeploymentGroupNameException The deployment group name was specified in an invalid format.
- DeploymentGroupAlreadyExistsException A deployment group with the specified name with the user or Amazon Web Services account already exists.
- InvalidEc2TagException The tag was specified in an invalid format.
- InvalidTagException The tag was specified in an invalid format.
- InvalidAutoScalingGroupException The Auto Scaling group was specified in an invalid format or does not exist.
- InvalidDeploymentConfigNameException The deployment configuration name was specified in an invalid format.
- DeploymentConfigDoesNotExistException The deployment configuration does not exist with the user or Amazon Web Services account.
- RoleRequiredException The role ID was not specified.
- InvalidRoleException The service role ARN was specified in an invalid format. Or, if an Auto Scaling group was specified, the specified service role does not grant the appropriate permissions to Amazon EC2 Auto Scaling.
- DeploymentGroupLimitExceededException The deployment groups limit was exceeded.
- LifecycleHookLimitExceededException The limit for lifecycle hooks was exceeded.
- InvalidTriggerConfigException The trigger was specified in an invalid format.
- TriggerTargetsLimitExceededException The maximum allowed number of triggers was exceeded.
- InvalidAlarmConfigException The format of the alarm configuration is invalid. Possible causes
include:
-
The alarm list is null.
-
The alarm object is null.
-
The alarm name is empty or null or exceeds the limit of 255 characters.
-
Two alarms with the same name have been specified.
-
The alarm configuration is enabled, but the alarm list is empty.
-
- AlarmsLimitExceededException The maximum number of alarms for a deployment group (10) was exceeded.
- InvalidAutoRollbackConfigException The automatic rollback configuration was specified in an invalid format. For example, automatic rollback is enabled, but an invalid triggering event type or no event types were listed.
- InvalidLoadBalancerInfoException An invalid load balancer name, or no load balancer name, was specified.
- InvalidDeploymentStyleException An invalid deployment style was specified. Valid deployment types include "IN_PLACE" and "BLUE_GREEN." Valid deployment options include "WITH_TRAFFIC_CONTROL" and "WITHOUT_TRAFFIC_CONTROL."
- InvalidBlueGreenDeploymentConfigurationException The configuration for the blue/green deployment group was provided in an invalid format. For information about deployment configuration format, see CreateDeploymentConfig.
- InvalidEc2TagCombinationException A call was submitted that specified both Ec2TagFilters and Ec2TagSet, but only one of these data types can be used in a single call.
- InvalidOnPremisesTagCombinationException A call was submitted that specified both OnPremisesTagFilters and OnPremisesTagSet, but only one of these data types can be used in a single call.
- TagSetListLimitExceededException The number of tag groups included in the tag set list exceeded the maximum allowed limit of 3.
- InvalidInputException The input was specified in an invalid format.
- ThrottlingException An API function was called too frequently.
- InvalidEcsServiceException The Amazon ECS service identifier is not valid.
- InvalidTargetGroupPairException A target group pair associated with this deployment is not valid.
- EcsServiceMappingLimitExceededException The Amazon ECS service is associated with more than one deployment groups. An Amazon ECS service can be associated with only one deployment group.
- InvalidTagsToAddException The specified tags are not valid.
- InvalidTrafficRoutingConfigurationException The configuration that specifies how traffic is routed during a deployment is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createDeploymentGroup
default CompletableFuture<CreateDeploymentGroupResponse> createDeploymentGroup(Consumer<CreateDeploymentGroupRequest.Builder> createDeploymentGroupRequest) Creates a deployment group to which application revisions are deployed.
This is a convenience which creates an instance of the
CreateDeploymentGroupRequest.Builder
avoiding the need to create one manually viaCreateDeploymentGroupRequest.builder()
- Parameters:
createDeploymentGroupRequest
- AConsumer
that will call methods onCreateDeploymentGroupRequest.Builder
to create a request. Represents the input of aCreateDeploymentGroup
operation.- Returns:
- A Java Future containing the result of the CreateDeploymentGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ApplicationNameRequiredException The minimum number of required application names was not specified.
- InvalidApplicationNameException The application name was specified in an invalid format.
- ApplicationDoesNotExistException The application does not exist with the user or Amazon Web Services account.
- DeploymentGroupNameRequiredException The deployment group name was not specified.
- InvalidDeploymentGroupNameException The deployment group name was specified in an invalid format.
- DeploymentGroupAlreadyExistsException A deployment group with the specified name with the user or Amazon Web Services account already exists.
- InvalidEc2TagException The tag was specified in an invalid format.
- InvalidTagException The tag was specified in an invalid format.
- InvalidAutoScalingGroupException The Auto Scaling group was specified in an invalid format or does not exist.
- InvalidDeploymentConfigNameException The deployment configuration name was specified in an invalid format.
- DeploymentConfigDoesNotExistException The deployment configuration does not exist with the user or Amazon Web Services account.
- RoleRequiredException The role ID was not specified.
- InvalidRoleException The service role ARN was specified in an invalid format. Or, if an Auto Scaling group was specified, the specified service role does not grant the appropriate permissions to Amazon EC2 Auto Scaling.
- DeploymentGroupLimitExceededException The deployment groups limit was exceeded.
- LifecycleHookLimitExceededException The limit for lifecycle hooks was exceeded.
- InvalidTriggerConfigException The trigger was specified in an invalid format.
- TriggerTargetsLimitExceededException The maximum allowed number of triggers was exceeded.
- InvalidAlarmConfigException The format of the alarm configuration is invalid. Possible causes
include:
-
The alarm list is null.
-
The alarm object is null.
-
The alarm name is empty or null or exceeds the limit of 255 characters.
-
Two alarms with the same name have been specified.
-
The alarm configuration is enabled, but the alarm list is empty.
-
- AlarmsLimitExceededException The maximum number of alarms for a deployment group (10) was exceeded.
- InvalidAutoRollbackConfigException The automatic rollback configuration was specified in an invalid format. For example, automatic rollback is enabled, but an invalid triggering event type or no event types were listed.
- InvalidLoadBalancerInfoException An invalid load balancer name, or no load balancer name, was specified.
- InvalidDeploymentStyleException An invalid deployment style was specified. Valid deployment types include "IN_PLACE" and "BLUE_GREEN." Valid deployment options include "WITH_TRAFFIC_CONTROL" and "WITHOUT_TRAFFIC_CONTROL."
- InvalidBlueGreenDeploymentConfigurationException The configuration for the blue/green deployment group was provided in an invalid format. For information about deployment configuration format, see CreateDeploymentConfig.
- InvalidEc2TagCombinationException A call was submitted that specified both Ec2TagFilters and Ec2TagSet, but only one of these data types can be used in a single call.
- InvalidOnPremisesTagCombinationException A call was submitted that specified both OnPremisesTagFilters and OnPremisesTagSet, but only one of these data types can be used in a single call.
- TagSetListLimitExceededException The number of tag groups included in the tag set list exceeded the maximum allowed limit of 3.
- InvalidInputException The input was specified in an invalid format.
- ThrottlingException An API function was called too frequently.
- InvalidEcsServiceException The Amazon ECS service identifier is not valid.
- InvalidTargetGroupPairException A target group pair associated with this deployment is not valid.
- EcsServiceMappingLimitExceededException The Amazon ECS service is associated with more than one deployment groups. An Amazon ECS service can be associated with only one deployment group.
- InvalidTagsToAddException The specified tags are not valid.
- InvalidTrafficRoutingConfigurationException The configuration that specifies how traffic is routed during a deployment is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteApplication
default CompletableFuture<DeleteApplicationResponse> deleteApplication(DeleteApplicationRequest deleteApplicationRequest) Deletes an application.
- Parameters:
deleteApplicationRequest
- Represents the input of aDeleteApplication
operation.- Returns:
- A Java Future containing the result of the DeleteApplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ApplicationNameRequiredException The minimum number of required application names was not specified.
- InvalidApplicationNameException The application name was specified in an invalid format.
- InvalidRoleException The service role ARN was specified in an invalid format. Or, if an Auto Scaling group was specified, the specified service role does not grant the appropriate permissions to Amazon EC2 Auto Scaling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteApplication
default CompletableFuture<DeleteApplicationResponse> deleteApplication(Consumer<DeleteApplicationRequest.Builder> deleteApplicationRequest) Deletes an application.
This is a convenience which creates an instance of the
DeleteApplicationRequest.Builder
avoiding the need to create one manually viaDeleteApplicationRequest.builder()
- Parameters:
deleteApplicationRequest
- AConsumer
that will call methods onDeleteApplicationRequest.Builder
to create a request. Represents the input of aDeleteApplication
operation.- Returns:
- A Java Future containing the result of the DeleteApplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ApplicationNameRequiredException The minimum number of required application names was not specified.
- InvalidApplicationNameException The application name was specified in an invalid format.
- InvalidRoleException The service role ARN was specified in an invalid format. Or, if an Auto Scaling group was specified, the specified service role does not grant the appropriate permissions to Amazon EC2 Auto Scaling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDeploymentConfig
default CompletableFuture<DeleteDeploymentConfigResponse> deleteDeploymentConfig(DeleteDeploymentConfigRequest deleteDeploymentConfigRequest) Deletes a deployment configuration.
A deployment configuration cannot be deleted if it is currently in use. Predefined configurations cannot be deleted.
- Parameters:
deleteDeploymentConfigRequest
- Represents the input of aDeleteDeploymentConfig
operation.- Returns:
- A Java Future containing the result of the DeleteDeploymentConfig operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidDeploymentConfigNameException The deployment configuration name was specified in an invalid format.
- DeploymentConfigNameRequiredException The deployment configuration name was not specified.
- DeploymentConfigInUseException The deployment configuration is still in use.
- InvalidOperationException An invalid operation was detected.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDeploymentConfig
default CompletableFuture<DeleteDeploymentConfigResponse> deleteDeploymentConfig(Consumer<DeleteDeploymentConfigRequest.Builder> deleteDeploymentConfigRequest) Deletes a deployment configuration.
A deployment configuration cannot be deleted if it is currently in use. Predefined configurations cannot be deleted.
This is a convenience which creates an instance of the
DeleteDeploymentConfigRequest.Builder
avoiding the need to create one manually viaDeleteDeploymentConfigRequest.builder()
- Parameters:
deleteDeploymentConfigRequest
- AConsumer
that will call methods onDeleteDeploymentConfigRequest.Builder
to create a request. Represents the input of aDeleteDeploymentConfig
operation.- Returns:
- A Java Future containing the result of the DeleteDeploymentConfig operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidDeploymentConfigNameException The deployment configuration name was specified in an invalid format.
- DeploymentConfigNameRequiredException The deployment configuration name was not specified.
- DeploymentConfigInUseException The deployment configuration is still in use.
- InvalidOperationException An invalid operation was detected.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDeploymentGroup
default CompletableFuture<DeleteDeploymentGroupResponse> deleteDeploymentGroup(DeleteDeploymentGroupRequest deleteDeploymentGroupRequest) Deletes a deployment group.
- Parameters:
deleteDeploymentGroupRequest
- Represents the input of aDeleteDeploymentGroup
operation.- Returns:
- A Java Future containing the result of the DeleteDeploymentGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ApplicationNameRequiredException The minimum number of required application names was not specified.
- InvalidApplicationNameException The application name was specified in an invalid format.
- DeploymentGroupNameRequiredException The deployment group name was not specified.
- InvalidDeploymentGroupNameException The deployment group name was specified in an invalid format.
- InvalidRoleException The service role ARN was specified in an invalid format. Or, if an Auto Scaling group was specified, the specified service role does not grant the appropriate permissions to Amazon EC2 Auto Scaling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDeploymentGroup
default CompletableFuture<DeleteDeploymentGroupResponse> deleteDeploymentGroup(Consumer<DeleteDeploymentGroupRequest.Builder> deleteDeploymentGroupRequest) Deletes a deployment group.
This is a convenience which creates an instance of the
DeleteDeploymentGroupRequest.Builder
avoiding the need to create one manually viaDeleteDeploymentGroupRequest.builder()
- Parameters:
deleteDeploymentGroupRequest
- AConsumer
that will call methods onDeleteDeploymentGroupRequest.Builder
to create a request. Represents the input of aDeleteDeploymentGroup
operation.- Returns:
- A Java Future containing the result of the DeleteDeploymentGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ApplicationNameRequiredException The minimum number of required application names was not specified.
- InvalidApplicationNameException The application name was specified in an invalid format.
- DeploymentGroupNameRequiredException The deployment group name was not specified.
- InvalidDeploymentGroupNameException The deployment group name was specified in an invalid format.
- InvalidRoleException The service role ARN was specified in an invalid format. Or, if an Auto Scaling group was specified, the specified service role does not grant the appropriate permissions to Amazon EC2 Auto Scaling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteGitHubAccountToken
default CompletableFuture<DeleteGitHubAccountTokenResponse> deleteGitHubAccountToken(DeleteGitHubAccountTokenRequest deleteGitHubAccountTokenRequest) Deletes a GitHub account connection.
- Parameters:
deleteGitHubAccountTokenRequest
- Represents the input of aDeleteGitHubAccount
operation.- Returns:
- A Java Future containing the result of the DeleteGitHubAccountToken operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- GitHubAccountTokenNameRequiredException The call is missing a required GitHub account connection name.
- GitHubAccountTokenDoesNotExistException No GitHub account connection exists with the named specified in the call.
- InvalidGitHubAccountTokenNameException The format of the specified GitHub account connection name is invalid.
- ResourceValidationException The specified resource could not be validated.
- OperationNotSupportedException The API used does not support the deployment.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteGitHubAccountToken
default CompletableFuture<DeleteGitHubAccountTokenResponse> deleteGitHubAccountToken(Consumer<DeleteGitHubAccountTokenRequest.Builder> deleteGitHubAccountTokenRequest) Deletes a GitHub account connection.
This is a convenience which creates an instance of the
DeleteGitHubAccountTokenRequest.Builder
avoiding the need to create one manually viaDeleteGitHubAccountTokenRequest.builder()
- Parameters:
deleteGitHubAccountTokenRequest
- AConsumer
that will call methods onDeleteGitHubAccountTokenRequest.Builder
to create a request. Represents the input of aDeleteGitHubAccount
operation.- Returns:
- A Java Future containing the result of the DeleteGitHubAccountToken operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- GitHubAccountTokenNameRequiredException The call is missing a required GitHub account connection name.
- GitHubAccountTokenDoesNotExistException No GitHub account connection exists with the named specified in the call.
- InvalidGitHubAccountTokenNameException The format of the specified GitHub account connection name is invalid.
- ResourceValidationException The specified resource could not be validated.
- OperationNotSupportedException The API used does not support the deployment.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteResourcesByExternalId
default CompletableFuture<DeleteResourcesByExternalIdResponse> deleteResourcesByExternalId(DeleteResourcesByExternalIdRequest deleteResourcesByExternalIdRequest) Deletes resources linked to an external ID. This action only applies if you have configured blue/green deployments through CloudFormation.
It is not necessary to call this action directly. CloudFormation calls it on your behalf when it needs to delete stack resources. This action is offered publicly in case you need to delete resources to comply with General Data Protection Regulation (GDPR) requirements.
- Parameters:
deleteResourcesByExternalIdRequest
-- Returns:
- A Java Future containing the result of the DeleteResourcesByExternalId operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteResourcesByExternalId
default CompletableFuture<DeleteResourcesByExternalIdResponse> deleteResourcesByExternalId(Consumer<DeleteResourcesByExternalIdRequest.Builder> deleteResourcesByExternalIdRequest) Deletes resources linked to an external ID. This action only applies if you have configured blue/green deployments through CloudFormation.
It is not necessary to call this action directly. CloudFormation calls it on your behalf when it needs to delete stack resources. This action is offered publicly in case you need to delete resources to comply with General Data Protection Regulation (GDPR) requirements.
This is a convenience which creates an instance of the
DeleteResourcesByExternalIdRequest.Builder
avoiding the need to create one manually viaDeleteResourcesByExternalIdRequest.builder()
- Parameters:
deleteResourcesByExternalIdRequest
- AConsumer
that will call methods onDeleteResourcesByExternalIdRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteResourcesByExternalId operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deregisterOnPremisesInstance
default CompletableFuture<DeregisterOnPremisesInstanceResponse> deregisterOnPremisesInstance(DeregisterOnPremisesInstanceRequest deregisterOnPremisesInstanceRequest) Deregisters an on-premises instance.
- Parameters:
deregisterOnPremisesInstanceRequest
- Represents the input of aDeregisterOnPremisesInstance
operation.- Returns:
- A Java Future containing the result of the DeregisterOnPremisesInstance operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InstanceNameRequiredException An on-premises instance name was not specified.
- InvalidInstanceNameException The on-premises instance name was specified in an invalid format.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deregisterOnPremisesInstance
default CompletableFuture<DeregisterOnPremisesInstanceResponse> deregisterOnPremisesInstance(Consumer<DeregisterOnPremisesInstanceRequest.Builder> deregisterOnPremisesInstanceRequest) Deregisters an on-premises instance.
This is a convenience which creates an instance of the
DeregisterOnPremisesInstanceRequest.Builder
avoiding the need to create one manually viaDeregisterOnPremisesInstanceRequest.builder()
- Parameters:
deregisterOnPremisesInstanceRequest
- AConsumer
that will call methods onDeregisterOnPremisesInstanceRequest.Builder
to create a request. Represents the input of aDeregisterOnPremisesInstance
operation.- Returns:
- A Java Future containing the result of the DeregisterOnPremisesInstance operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InstanceNameRequiredException An on-premises instance name was not specified.
- InvalidInstanceNameException The on-premises instance name was specified in an invalid format.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getApplication
default CompletableFuture<GetApplicationResponse> getApplication(GetApplicationRequest getApplicationRequest) Gets information about an application.
- Parameters:
getApplicationRequest
- Represents the input of aGetApplication
operation.- Returns:
- A Java Future containing the result of the GetApplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ApplicationNameRequiredException The minimum number of required application names was not specified.
- InvalidApplicationNameException The application name was specified in an invalid format.
- ApplicationDoesNotExistException The application does not exist with the user or Amazon Web Services account.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getApplication
default CompletableFuture<GetApplicationResponse> getApplication(Consumer<GetApplicationRequest.Builder> getApplicationRequest) Gets information about an application.
This is a convenience which creates an instance of the
GetApplicationRequest.Builder
avoiding the need to create one manually viaGetApplicationRequest.builder()
- Parameters:
getApplicationRequest
- AConsumer
that will call methods onGetApplicationRequest.Builder
to create a request. Represents the input of aGetApplication
operation.- Returns:
- A Java Future containing the result of the GetApplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ApplicationNameRequiredException The minimum number of required application names was not specified.
- InvalidApplicationNameException The application name was specified in an invalid format.
- ApplicationDoesNotExistException The application does not exist with the user or Amazon Web Services account.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getApplicationRevision
default CompletableFuture<GetApplicationRevisionResponse> getApplicationRevision(GetApplicationRevisionRequest getApplicationRevisionRequest) Gets information about an application revision.
- Parameters:
getApplicationRevisionRequest
- Represents the input of aGetApplicationRevision
operation.- Returns:
- A Java Future containing the result of the GetApplicationRevision operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ApplicationDoesNotExistException The application does not exist with the user or Amazon Web Services account.
- ApplicationNameRequiredException The minimum number of required application names was not specified.
- InvalidApplicationNameException The application name was specified in an invalid format.
- RevisionDoesNotExistException The named revision does not exist with the user or Amazon Web Services account.
- RevisionRequiredException The revision ID was not specified.
- InvalidRevisionException The revision was specified in an invalid format.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getApplicationRevision
default CompletableFuture<GetApplicationRevisionResponse> getApplicationRevision(Consumer<GetApplicationRevisionRequest.Builder> getApplicationRevisionRequest) Gets information about an application revision.
This is a convenience which creates an instance of the
GetApplicationRevisionRequest.Builder
avoiding the need to create one manually viaGetApplicationRevisionRequest.builder()
- Parameters:
getApplicationRevisionRequest
- AConsumer
that will call methods onGetApplicationRevisionRequest.Builder
to create a request. Represents the input of aGetApplicationRevision
operation.- Returns:
- A Java Future containing the result of the GetApplicationRevision operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ApplicationDoesNotExistException The application does not exist with the user or Amazon Web Services account.
- ApplicationNameRequiredException The minimum number of required application names was not specified.
- InvalidApplicationNameException The application name was specified in an invalid format.
- RevisionDoesNotExistException The named revision does not exist with the user or Amazon Web Services account.
- RevisionRequiredException The revision ID was not specified.
- InvalidRevisionException The revision was specified in an invalid format.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDeployment
default CompletableFuture<GetDeploymentResponse> getDeployment(GetDeploymentRequest getDeploymentRequest) Gets information about a deployment.
The
content
property of theappSpecContent
object in the returned revision is always null. UseGetApplicationRevision
and thesha256
property of the returnedappSpecContent
object to get the content of the deployment’s AppSpec file.- Parameters:
getDeploymentRequest
- Represents the input of aGetDeployment
operation.- Returns:
- A Java Future containing the result of the GetDeployment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DeploymentIdRequiredException At least one deployment ID must be specified.
- InvalidDeploymentIdException At least one of the deployment IDs was specified in an invalid format.
- DeploymentDoesNotExistException The deployment with the user or Amazon Web Services account does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDeployment
default CompletableFuture<GetDeploymentResponse> getDeployment(Consumer<GetDeploymentRequest.Builder> getDeploymentRequest) Gets information about a deployment.
The
content
property of theappSpecContent
object in the returned revision is always null. UseGetApplicationRevision
and thesha256
property of the returnedappSpecContent
object to get the content of the deployment’s AppSpec file.
This is a convenience which creates an instance of the
GetDeploymentRequest.Builder
avoiding the need to create one manually viaGetDeploymentRequest.builder()
- Parameters:
getDeploymentRequest
- AConsumer
that will call methods onGetDeploymentRequest.Builder
to create a request. Represents the input of aGetDeployment
operation.- Returns:
- A Java Future containing the result of the GetDeployment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DeploymentIdRequiredException At least one deployment ID must be specified.
- InvalidDeploymentIdException At least one of the deployment IDs was specified in an invalid format.
- DeploymentDoesNotExistException The deployment with the user or Amazon Web Services account does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDeploymentConfig
default CompletableFuture<GetDeploymentConfigResponse> getDeploymentConfig(GetDeploymentConfigRequest getDeploymentConfigRequest) Gets information about a deployment configuration.
- Parameters:
getDeploymentConfigRequest
- Represents the input of aGetDeploymentConfig
operation.- Returns:
- A Java Future containing the result of the GetDeploymentConfig operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidDeploymentConfigNameException The deployment configuration name was specified in an invalid format.
- DeploymentConfigNameRequiredException The deployment configuration name was not specified.
- DeploymentConfigDoesNotExistException The deployment configuration does not exist with the user or Amazon Web Services account.
- InvalidComputePlatformException The computePlatform is invalid. The computePlatform should be
Lambda
,Server
, orECS
. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDeploymentConfig
default CompletableFuture<GetDeploymentConfigResponse> getDeploymentConfig(Consumer<GetDeploymentConfigRequest.Builder> getDeploymentConfigRequest) Gets information about a deployment configuration.
This is a convenience which creates an instance of the
GetDeploymentConfigRequest.Builder
avoiding the need to create one manually viaGetDeploymentConfigRequest.builder()
- Parameters:
getDeploymentConfigRequest
- AConsumer
that will call methods onGetDeploymentConfigRequest.Builder
to create a request. Represents the input of aGetDeploymentConfig
operation.- Returns:
- A Java Future containing the result of the GetDeploymentConfig operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidDeploymentConfigNameException The deployment configuration name was specified in an invalid format.
- DeploymentConfigNameRequiredException The deployment configuration name was not specified.
- DeploymentConfigDoesNotExistException The deployment configuration does not exist with the user or Amazon Web Services account.
- InvalidComputePlatformException The computePlatform is invalid. The computePlatform should be
Lambda
,Server
, orECS
. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDeploymentGroup
default CompletableFuture<GetDeploymentGroupResponse> getDeploymentGroup(GetDeploymentGroupRequest getDeploymentGroupRequest) Gets information about a deployment group.
- Parameters:
getDeploymentGroupRequest
- Represents the input of aGetDeploymentGroup
operation.- Returns:
- A Java Future containing the result of the GetDeploymentGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ApplicationNameRequiredException The minimum number of required application names was not specified.
- InvalidApplicationNameException The application name was specified in an invalid format.
- ApplicationDoesNotExistException The application does not exist with the user or Amazon Web Services account.
- DeploymentGroupNameRequiredException The deployment group name was not specified.
- InvalidDeploymentGroupNameException The deployment group name was specified in an invalid format.
- DeploymentGroupDoesNotExistException The named deployment group with the user or Amazon Web Services account does not exist.
- DeploymentConfigDoesNotExistException The deployment configuration does not exist with the user or Amazon Web Services account.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDeploymentGroup
default CompletableFuture<GetDeploymentGroupResponse> getDeploymentGroup(Consumer<GetDeploymentGroupRequest.Builder> getDeploymentGroupRequest) Gets information about a deployment group.
This is a convenience which creates an instance of the
GetDeploymentGroupRequest.Builder
avoiding the need to create one manually viaGetDeploymentGroupRequest.builder()
- Parameters:
getDeploymentGroupRequest
- AConsumer
that will call methods onGetDeploymentGroupRequest.Builder
to create a request. Represents the input of aGetDeploymentGroup
operation.- Returns:
- A Java Future containing the result of the GetDeploymentGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ApplicationNameRequiredException The minimum number of required application names was not specified.
- InvalidApplicationNameException The application name was specified in an invalid format.
- ApplicationDoesNotExistException The application does not exist with the user or Amazon Web Services account.
- DeploymentGroupNameRequiredException The deployment group name was not specified.
- InvalidDeploymentGroupNameException The deployment group name was specified in an invalid format.
- DeploymentGroupDoesNotExistException The named deployment group with the user or Amazon Web Services account does not exist.
- DeploymentConfigDoesNotExistException The deployment configuration does not exist with the user or Amazon Web Services account.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDeploymentTarget
default CompletableFuture<GetDeploymentTargetResponse> getDeploymentTarget(GetDeploymentTargetRequest getDeploymentTargetRequest) Returns information about a deployment target.
- Parameters:
getDeploymentTargetRequest
-- Returns:
- A Java Future containing the result of the GetDeploymentTarget operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidDeploymentIdException At least one of the deployment IDs was specified in an invalid format.
- DeploymentIdRequiredException At least one deployment ID must be specified.
- DeploymentDoesNotExistException The deployment with the user or Amazon Web Services account does not exist.
- DeploymentNotStartedException The specified deployment has not started.
- DeploymentTargetIdRequiredException A deployment target ID was not provided.
- InvalidDeploymentTargetIdException The target ID provided was not valid.
- DeploymentTargetDoesNotExistException The provided target ID does not belong to the attempted deployment.
- InvalidInstanceNameException The on-premises instance name was specified in an invalid format.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDeploymentTarget
default CompletableFuture<GetDeploymentTargetResponse> getDeploymentTarget(Consumer<GetDeploymentTargetRequest.Builder> getDeploymentTargetRequest) Returns information about a deployment target.
This is a convenience which creates an instance of the
GetDeploymentTargetRequest.Builder
avoiding the need to create one manually viaGetDeploymentTargetRequest.builder()
- Parameters:
getDeploymentTargetRequest
- AConsumer
that will call methods onGetDeploymentTargetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetDeploymentTarget operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidDeploymentIdException At least one of the deployment IDs was specified in an invalid format.
- DeploymentIdRequiredException At least one deployment ID must be specified.
- DeploymentDoesNotExistException The deployment with the user or Amazon Web Services account does not exist.
- DeploymentNotStartedException The specified deployment has not started.
- DeploymentTargetIdRequiredException A deployment target ID was not provided.
- InvalidDeploymentTargetIdException The target ID provided was not valid.
- DeploymentTargetDoesNotExistException The provided target ID does not belong to the attempted deployment.
- InvalidInstanceNameException The on-premises instance name was specified in an invalid format.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getOnPremisesInstance
default CompletableFuture<GetOnPremisesInstanceResponse> getOnPremisesInstance(GetOnPremisesInstanceRequest getOnPremisesInstanceRequest) Gets information about an on-premises instance.
- Parameters:
getOnPremisesInstanceRequest
- Represents the input of aGetOnPremisesInstance
operation.- Returns:
- A Java Future containing the result of the GetOnPremisesInstance operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InstanceNameRequiredException An on-premises instance name was not specified.
- InstanceNotRegisteredException The specified on-premises instance is not registered.
- InvalidInstanceNameException The on-premises instance name was specified in an invalid format.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getOnPremisesInstance
default CompletableFuture<GetOnPremisesInstanceResponse> getOnPremisesInstance(Consumer<GetOnPremisesInstanceRequest.Builder> getOnPremisesInstanceRequest) Gets information about an on-premises instance.
This is a convenience which creates an instance of the
GetOnPremisesInstanceRequest.Builder
avoiding the need to create one manually viaGetOnPremisesInstanceRequest.builder()
- Parameters:
getOnPremisesInstanceRequest
- AConsumer
that will call methods onGetOnPremisesInstanceRequest.Builder
to create a request. Represents the input of aGetOnPremisesInstance
operation.- Returns:
- A Java Future containing the result of the GetOnPremisesInstance operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InstanceNameRequiredException An on-premises instance name was not specified.
- InstanceNotRegisteredException The specified on-premises instance is not registered.
- InvalidInstanceNameException The on-premises instance name was specified in an invalid format.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listApplicationRevisions
default CompletableFuture<ListApplicationRevisionsResponse> listApplicationRevisions(ListApplicationRevisionsRequest listApplicationRevisionsRequest) Lists information about revisions for an application.
- Parameters:
listApplicationRevisionsRequest
- Represents the input of aListApplicationRevisions
operation.- Returns:
- A Java Future containing the result of the ListApplicationRevisions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ApplicationDoesNotExistException The application does not exist with the user or Amazon Web Services account.
- ApplicationNameRequiredException The minimum number of required application names was not specified.
- InvalidApplicationNameException The application name was specified in an invalid format.
- InvalidSortByException The column name to sort by is either not present or was specified in an invalid format.
- InvalidSortOrderException The sort order was specified in an invalid format.
- InvalidBucketNameFilterException The bucket name either doesn't exist or was specified in an invalid format.
- InvalidKeyPrefixFilterException The specified key prefix filter was specified in an invalid format.
- BucketNameFilterRequiredException A bucket name is required, but was not provided.
- InvalidDeployedStateFilterException The deployed state filter was specified in an invalid format.
- InvalidNextTokenException The next token was specified in an invalid format.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listApplicationRevisions
default CompletableFuture<ListApplicationRevisionsResponse> listApplicationRevisions(Consumer<ListApplicationRevisionsRequest.Builder> listApplicationRevisionsRequest) Lists information about revisions for an application.
This is a convenience which creates an instance of the
ListApplicationRevisionsRequest.Builder
avoiding the need to create one manually viaListApplicationRevisionsRequest.builder()
- Parameters:
listApplicationRevisionsRequest
- AConsumer
that will call methods onListApplicationRevisionsRequest.Builder
to create a request. Represents the input of aListApplicationRevisions
operation.- Returns:
- A Java Future containing the result of the ListApplicationRevisions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ApplicationDoesNotExistException The application does not exist with the user or Amazon Web Services account.
- ApplicationNameRequiredException The minimum number of required application names was not specified.
- InvalidApplicationNameException The application name was specified in an invalid format.
- InvalidSortByException The column name to sort by is either not present or was specified in an invalid format.
- InvalidSortOrderException The sort order was specified in an invalid format.
- InvalidBucketNameFilterException The bucket name either doesn't exist or was specified in an invalid format.
- InvalidKeyPrefixFilterException The specified key prefix filter was specified in an invalid format.
- BucketNameFilterRequiredException A bucket name is required, but was not provided.
- InvalidDeployedStateFilterException The deployed state filter was specified in an invalid format.
- InvalidNextTokenException The next token was specified in an invalid format.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listApplicationRevisionsPaginator
default ListApplicationRevisionsPublisher listApplicationRevisionsPaginator(ListApplicationRevisionsRequest listApplicationRevisionsRequest) This is a variant of
listApplicationRevisions(software.amazon.awssdk.services.codedeploy.model.ListApplicationRevisionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.codedeploy.paginators.ListApplicationRevisionsPublisher publisher = client.listApplicationRevisionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.codedeploy.paginators.ListApplicationRevisionsPublisher publisher = client.listApplicationRevisionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codedeploy.model.ListApplicationRevisionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.codedeploy.model.ListApplicationRevisionsResponse response) { //... }; });
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listApplicationRevisions(software.amazon.awssdk.services.codedeploy.model.ListApplicationRevisionsRequest)
operation.- Parameters:
listApplicationRevisionsRequest
- Represents the input of aListApplicationRevisions
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ApplicationDoesNotExistException The application does not exist with the user or Amazon Web Services account.
- ApplicationNameRequiredException The minimum number of required application names was not specified.
- InvalidApplicationNameException The application name was specified in an invalid format.
- InvalidSortByException The column name to sort by is either not present or was specified in an invalid format.
- InvalidSortOrderException The sort order was specified in an invalid format.
- InvalidBucketNameFilterException The bucket name either doesn't exist or was specified in an invalid format.
- InvalidKeyPrefixFilterException The specified key prefix filter was specified in an invalid format.
- BucketNameFilterRequiredException A bucket name is required, but was not provided.
- InvalidDeployedStateFilterException The deployed state filter was specified in an invalid format.
- InvalidNextTokenException The next token was specified in an invalid format.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listApplicationRevisionsPaginator
default ListApplicationRevisionsPublisher listApplicationRevisionsPaginator(Consumer<ListApplicationRevisionsRequest.Builder> listApplicationRevisionsRequest) This is a variant of
listApplicationRevisions(software.amazon.awssdk.services.codedeploy.model.ListApplicationRevisionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.codedeploy.paginators.ListApplicationRevisionsPublisher publisher = client.listApplicationRevisionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.codedeploy.paginators.ListApplicationRevisionsPublisher publisher = client.listApplicationRevisionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codedeploy.model.ListApplicationRevisionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.codedeploy.model.ListApplicationRevisionsResponse response) { //... }; });
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listApplicationRevisions(software.amazon.awssdk.services.codedeploy.model.ListApplicationRevisionsRequest)
operation.
This is a convenience which creates an instance of the
ListApplicationRevisionsRequest.Builder
avoiding the need to create one manually viaListApplicationRevisionsRequest.builder()
- Parameters:
listApplicationRevisionsRequest
- AConsumer
that will call methods onListApplicationRevisionsRequest.Builder
to create a request. Represents the input of aListApplicationRevisions
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ApplicationDoesNotExistException The application does not exist with the user or Amazon Web Services account.
- ApplicationNameRequiredException The minimum number of required application names was not specified.
- InvalidApplicationNameException The application name was specified in an invalid format.
- InvalidSortByException The column name to sort by is either not present or was specified in an invalid format.
- InvalidSortOrderException The sort order was specified in an invalid format.
- InvalidBucketNameFilterException The bucket name either doesn't exist or was specified in an invalid format.
- InvalidKeyPrefixFilterException The specified key prefix filter was specified in an invalid format.
- BucketNameFilterRequiredException A bucket name is required, but was not provided.
- InvalidDeployedStateFilterException The deployed state filter was specified in an invalid format.
- InvalidNextTokenException The next token was specified in an invalid format.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listApplications
default CompletableFuture<ListApplicationsResponse> listApplications(ListApplicationsRequest listApplicationsRequest) Lists the applications registered with the user or Amazon Web Services account.
- Parameters:
listApplicationsRequest
- Represents the input of aListApplications
operation.- Returns:
- A Java Future containing the result of the ListApplications operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidNextTokenException The next token was specified in an invalid format.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listApplications
default CompletableFuture<ListApplicationsResponse> listApplications(Consumer<ListApplicationsRequest.Builder> listApplicationsRequest) Lists the applications registered with the user or Amazon Web Services account.
This is a convenience which creates an instance of the
ListApplicationsRequest.Builder
avoiding the need to create one manually viaListApplicationsRequest.builder()
- Parameters:
listApplicationsRequest
- AConsumer
that will call methods onListApplicationsRequest.Builder
to create a request. Represents the input of aListApplications
operation.- Returns:
- A Java Future containing the result of the ListApplications operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidNextTokenException The next token was specified in an invalid format.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listApplications
Lists the applications registered with the user or Amazon Web Services account.
- Returns:
- A Java Future containing the result of the ListApplications operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidNextTokenException The next token was specified in an invalid format.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listApplicationsPaginator
This is a variant of
listApplications(software.amazon.awssdk.services.codedeploy.model.ListApplicationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.codedeploy.paginators.ListApplicationsPublisher publisher = client.listApplicationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.codedeploy.paginators.ListApplicationsPublisher publisher = client.listApplicationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codedeploy.model.ListApplicationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.codedeploy.model.ListApplicationsResponse response) { //... }; });
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listApplications(software.amazon.awssdk.services.codedeploy.model.ListApplicationsRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidNextTokenException The next token was specified in an invalid format.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listApplicationsPaginator
default ListApplicationsPublisher listApplicationsPaginator(ListApplicationsRequest listApplicationsRequest) This is a variant of
listApplications(software.amazon.awssdk.services.codedeploy.model.ListApplicationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.codedeploy.paginators.ListApplicationsPublisher publisher = client.listApplicationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.codedeploy.paginators.ListApplicationsPublisher publisher = client.listApplicationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codedeploy.model.ListApplicationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.codedeploy.model.ListApplicationsResponse response) { //... }; });
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listApplications(software.amazon.awssdk.services.codedeploy.model.ListApplicationsRequest)
operation.- Parameters:
listApplicationsRequest
- Represents the input of aListApplications
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidNextTokenException The next token was specified in an invalid format.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listApplicationsPaginator
default ListApplicationsPublisher listApplicationsPaginator(Consumer<ListApplicationsRequest.Builder> listApplicationsRequest) This is a variant of
listApplications(software.amazon.awssdk.services.codedeploy.model.ListApplicationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.codedeploy.paginators.ListApplicationsPublisher publisher = client.listApplicationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.codedeploy.paginators.ListApplicationsPublisher publisher = client.listApplicationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codedeploy.model.ListApplicationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.codedeploy.model.ListApplicationsResponse response) { //... }; });
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listApplications(software.amazon.awssdk.services.codedeploy.model.ListApplicationsRequest)
operation.
This is a convenience which creates an instance of the
ListApplicationsRequest.Builder
avoiding the need to create one manually viaListApplicationsRequest.builder()
- Parameters:
listApplicationsRequest
- AConsumer
that will call methods onListApplicationsRequest.Builder
to create a request. Represents the input of aListApplications
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidNextTokenException The next token was specified in an invalid format.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDeploymentConfigs
default CompletableFuture<ListDeploymentConfigsResponse> listDeploymentConfigs(ListDeploymentConfigsRequest listDeploymentConfigsRequest) Lists the deployment configurations with the user or Amazon Web Services account.
- Parameters:
listDeploymentConfigsRequest
- Represents the input of aListDeploymentConfigs
operation.- Returns:
- A Java Future containing the result of the ListDeploymentConfigs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidNextTokenException The next token was specified in an invalid format.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDeploymentConfigs
default CompletableFuture<ListDeploymentConfigsResponse> listDeploymentConfigs(Consumer<ListDeploymentConfigsRequest.Builder> listDeploymentConfigsRequest) Lists the deployment configurations with the user or Amazon Web Services account.
This is a convenience which creates an instance of the
ListDeploymentConfigsRequest.Builder
avoiding the need to create one manually viaListDeploymentConfigsRequest.builder()
- Parameters:
listDeploymentConfigsRequest
- AConsumer
that will call methods onListDeploymentConfigsRequest.Builder
to create a request. Represents the input of aListDeploymentConfigs
operation.- Returns:
- A Java Future containing the result of the ListDeploymentConfigs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidNextTokenException The next token was specified in an invalid format.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDeploymentConfigs
Lists the deployment configurations with the user or Amazon Web Services account.
- Returns:
- A Java Future containing the result of the ListDeploymentConfigs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidNextTokenException The next token was specified in an invalid format.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDeploymentConfigsPaginator
This is a variant of
listDeploymentConfigs(software.amazon.awssdk.services.codedeploy.model.ListDeploymentConfigsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.codedeploy.paginators.ListDeploymentConfigsPublisher publisher = client.listDeploymentConfigsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.codedeploy.paginators.ListDeploymentConfigsPublisher publisher = client.listDeploymentConfigsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codedeploy.model.ListDeploymentConfigsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.codedeploy.model.ListDeploymentConfigsResponse response) { //... }; });
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDeploymentConfigs(software.amazon.awssdk.services.codedeploy.model.ListDeploymentConfigsRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidNextTokenException The next token was specified in an invalid format.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDeploymentConfigsPaginator
default ListDeploymentConfigsPublisher listDeploymentConfigsPaginator(ListDeploymentConfigsRequest listDeploymentConfigsRequest) This is a variant of
listDeploymentConfigs(software.amazon.awssdk.services.codedeploy.model.ListDeploymentConfigsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.codedeploy.paginators.ListDeploymentConfigsPublisher publisher = client.listDeploymentConfigsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.codedeploy.paginators.ListDeploymentConfigsPublisher publisher = client.listDeploymentConfigsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codedeploy.model.ListDeploymentConfigsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.codedeploy.model.ListDeploymentConfigsResponse response) { //... }; });
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDeploymentConfigs(software.amazon.awssdk.services.codedeploy.model.ListDeploymentConfigsRequest)
operation.- Parameters:
listDeploymentConfigsRequest
- Represents the input of aListDeploymentConfigs
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidNextTokenException The next token was specified in an invalid format.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDeploymentConfigsPaginator
default ListDeploymentConfigsPublisher listDeploymentConfigsPaginator(Consumer<ListDeploymentConfigsRequest.Builder> listDeploymentConfigsRequest) This is a variant of
listDeploymentConfigs(software.amazon.awssdk.services.codedeploy.model.ListDeploymentConfigsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.codedeploy.paginators.ListDeploymentConfigsPublisher publisher = client.listDeploymentConfigsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.codedeploy.paginators.ListDeploymentConfigsPublisher publisher = client.listDeploymentConfigsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codedeploy.model.ListDeploymentConfigsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.codedeploy.model.ListDeploymentConfigsResponse response) { //... }; });
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDeploymentConfigs(software.amazon.awssdk.services.codedeploy.model.ListDeploymentConfigsRequest)
operation.
This is a convenience which creates an instance of the
ListDeploymentConfigsRequest.Builder
avoiding the need to create one manually viaListDeploymentConfigsRequest.builder()
- Parameters:
listDeploymentConfigsRequest
- AConsumer
that will call methods onListDeploymentConfigsRequest.Builder
to create a request. Represents the input of aListDeploymentConfigs
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidNextTokenException The next token was specified in an invalid format.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDeploymentGroups
default CompletableFuture<ListDeploymentGroupsResponse> listDeploymentGroups(ListDeploymentGroupsRequest listDeploymentGroupsRequest) Lists the deployment groups for an application registered with the Amazon Web Services user or Amazon Web Services account.
- Parameters:
listDeploymentGroupsRequest
- Represents the input of aListDeploymentGroups
operation.- Returns:
- A Java Future containing the result of the ListDeploymentGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ApplicationNameRequiredException The minimum number of required application names was not specified.
- InvalidApplicationNameException The application name was specified in an invalid format.
- ApplicationDoesNotExistException The application does not exist with the user or Amazon Web Services account.
- InvalidNextTokenException The next token was specified in an invalid format.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDeploymentGroups
default CompletableFuture<ListDeploymentGroupsResponse> listDeploymentGroups(Consumer<ListDeploymentGroupsRequest.Builder> listDeploymentGroupsRequest) Lists the deployment groups for an application registered with the Amazon Web Services user or Amazon Web Services account.
This is a convenience which creates an instance of the
ListDeploymentGroupsRequest.Builder
avoiding the need to create one manually viaListDeploymentGroupsRequest.builder()
- Parameters:
listDeploymentGroupsRequest
- AConsumer
that will call methods onListDeploymentGroupsRequest.Builder
to create a request. Represents the input of aListDeploymentGroups
operation.- Returns:
- A Java Future containing the result of the ListDeploymentGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ApplicationNameRequiredException The minimum number of required application names was not specified.
- InvalidApplicationNameException The application name was specified in an invalid format.
- ApplicationDoesNotExistException The application does not exist with the user or Amazon Web Services account.
- InvalidNextTokenException The next token was specified in an invalid format.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDeploymentGroupsPaginator
default ListDeploymentGroupsPublisher listDeploymentGroupsPaginator(ListDeploymentGroupsRequest listDeploymentGroupsRequest) This is a variant of
listDeploymentGroups(software.amazon.awssdk.services.codedeploy.model.ListDeploymentGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.codedeploy.paginators.ListDeploymentGroupsPublisher publisher = client.listDeploymentGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.codedeploy.paginators.ListDeploymentGroupsPublisher publisher = client.listDeploymentGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codedeploy.model.ListDeploymentGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.codedeploy.model.ListDeploymentGroupsResponse response) { //... }; });
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDeploymentGroups(software.amazon.awssdk.services.codedeploy.model.ListDeploymentGroupsRequest)
operation.- Parameters:
listDeploymentGroupsRequest
- Represents the input of aListDeploymentGroups
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ApplicationNameRequiredException The minimum number of required application names was not specified.
- InvalidApplicationNameException The application name was specified in an invalid format.
- ApplicationDoesNotExistException The application does not exist with the user or Amazon Web Services account.
- InvalidNextTokenException The next token was specified in an invalid format.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDeploymentGroupsPaginator
default ListDeploymentGroupsPublisher listDeploymentGroupsPaginator(Consumer<ListDeploymentGroupsRequest.Builder> listDeploymentGroupsRequest) This is a variant of
listDeploymentGroups(software.amazon.awssdk.services.codedeploy.model.ListDeploymentGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.codedeploy.paginators.ListDeploymentGroupsPublisher publisher = client.listDeploymentGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.codedeploy.paginators.ListDeploymentGroupsPublisher publisher = client.listDeploymentGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codedeploy.model.ListDeploymentGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.codedeploy.model.ListDeploymentGroupsResponse response) { //... }; });
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDeploymentGroups(software.amazon.awssdk.services.codedeploy.model.ListDeploymentGroupsRequest)
operation.
This is a convenience which creates an instance of the
ListDeploymentGroupsRequest.Builder
avoiding the need to create one manually viaListDeploymentGroupsRequest.builder()
- Parameters:
listDeploymentGroupsRequest
- AConsumer
that will call methods onListDeploymentGroupsRequest.Builder
to create a request. Represents the input of aListDeploymentGroups
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ApplicationNameRequiredException The minimum number of required application names was not specified.
- InvalidApplicationNameException The application name was specified in an invalid format.
- ApplicationDoesNotExistException The application does not exist with the user or Amazon Web Services account.
- InvalidNextTokenException The next token was specified in an invalid format.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDeploymentTargets
default CompletableFuture<ListDeploymentTargetsResponse> listDeploymentTargets(ListDeploymentTargetsRequest listDeploymentTargetsRequest) Returns an array of target IDs that are associated a deployment.
- Parameters:
listDeploymentTargetsRequest
-- Returns:
- A Java Future containing the result of the ListDeploymentTargets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DeploymentIdRequiredException At least one deployment ID must be specified.
- DeploymentDoesNotExistException The deployment with the user or Amazon Web Services account does not exist.
- DeploymentNotStartedException The specified deployment has not started.
- InvalidNextTokenException The next token was specified in an invalid format.
- InvalidDeploymentIdException At least one of the deployment IDs was specified in an invalid format.
- InvalidInstanceStatusException The specified instance status does not exist.
- InvalidInstanceTypeException An invalid instance type was specified for instances in a blue/green deployment. Valid values include "Blue" for an original environment and "Green" for a replacement environment.
- InvalidDeploymentInstanceTypeException An instance type was specified for an in-place deployment. Instance types are supported for blue/green deployments only.
- InvalidTargetFilterNameException The target filter name is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDeploymentTargets
default CompletableFuture<ListDeploymentTargetsResponse> listDeploymentTargets(Consumer<ListDeploymentTargetsRequest.Builder> listDeploymentTargetsRequest) Returns an array of target IDs that are associated a deployment.
This is a convenience which creates an instance of the
ListDeploymentTargetsRequest.Builder
avoiding the need to create one manually viaListDeploymentTargetsRequest.builder()
- Parameters:
listDeploymentTargetsRequest
- AConsumer
that will call methods onListDeploymentTargetsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListDeploymentTargets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DeploymentIdRequiredException At least one deployment ID must be specified.
- DeploymentDoesNotExistException The deployment with the user or Amazon Web Services account does not exist.
- DeploymentNotStartedException The specified deployment has not started.
- InvalidNextTokenException The next token was specified in an invalid format.
- InvalidDeploymentIdException At least one of the deployment IDs was specified in an invalid format.
- InvalidInstanceStatusException The specified instance status does not exist.
- InvalidInstanceTypeException An invalid instance type was specified for instances in a blue/green deployment. Valid values include "Blue" for an original environment and "Green" for a replacement environment.
- InvalidDeploymentInstanceTypeException An instance type was specified for an in-place deployment. Instance types are supported for blue/green deployments only.
- InvalidTargetFilterNameException The target filter name is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDeployments
default CompletableFuture<ListDeploymentsResponse> listDeployments(ListDeploymentsRequest listDeploymentsRequest) Lists the deployments in a deployment group for an application registered with the user or Amazon Web Services account.
- Parameters:
listDeploymentsRequest
- Represents the input of aListDeployments
operation.- Returns:
- A Java Future containing the result of the ListDeployments operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ApplicationNameRequiredException The minimum number of required application names was not specified.
- InvalidApplicationNameException The application name was specified in an invalid format.
- ApplicationDoesNotExistException The application does not exist with the user or Amazon Web Services account.
- InvalidDeploymentGroupNameException The deployment group name was specified in an invalid format.
- DeploymentGroupDoesNotExistException The named deployment group with the user or Amazon Web Services account does not exist.
- DeploymentGroupNameRequiredException The deployment group name was not specified.
- InvalidTimeRangeException The specified time range was specified in an invalid format.
- InvalidDeploymentStatusException The specified deployment status doesn't exist or cannot be determined.
- InvalidNextTokenException The next token was specified in an invalid format.
- InvalidExternalIdException The external ID was specified in an invalid format.
- InvalidInputException The input was specified in an invalid format.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDeployments
default CompletableFuture<ListDeploymentsResponse> listDeployments(Consumer<ListDeploymentsRequest.Builder> listDeploymentsRequest) Lists the deployments in a deployment group for an application registered with the user or Amazon Web Services account.
This is a convenience which creates an instance of the
ListDeploymentsRequest.Builder
avoiding the need to create one manually viaListDeploymentsRequest.builder()
- Parameters:
listDeploymentsRequest
- AConsumer
that will call methods onListDeploymentsRequest.Builder
to create a request. Represents the input of aListDeployments
operation.- Returns:
- A Java Future containing the result of the ListDeployments operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ApplicationNameRequiredException The minimum number of required application names was not specified.
- InvalidApplicationNameException The application name was specified in an invalid format.
- ApplicationDoesNotExistException The application does not exist with the user or Amazon Web Services account.
- InvalidDeploymentGroupNameException The deployment group name was specified in an invalid format.
- DeploymentGroupDoesNotExistException The named deployment group with the user or Amazon Web Services account does not exist.
- DeploymentGroupNameRequiredException The deployment group name was not specified.
- InvalidTimeRangeException The specified time range was specified in an invalid format.
- InvalidDeploymentStatusException The specified deployment status doesn't exist or cannot be determined.
- InvalidNextTokenException The next token was specified in an invalid format.
- InvalidExternalIdException The external ID was specified in an invalid format.
- InvalidInputException The input was specified in an invalid format.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDeployments
Lists the deployments in a deployment group for an application registered with the user or Amazon Web Services account.
- Returns:
- A Java Future containing the result of the ListDeployments operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ApplicationNameRequiredException The minimum number of required application names was not specified.
- InvalidApplicationNameException The application name was specified in an invalid format.
- ApplicationDoesNotExistException The application does not exist with the user or Amazon Web Services account.
- InvalidDeploymentGroupNameException The deployment group name was specified in an invalid format.
- DeploymentGroupDoesNotExistException The named deployment group with the user or Amazon Web Services account does not exist.
- DeploymentGroupNameRequiredException The deployment group name was not specified.
- InvalidTimeRangeException The specified time range was specified in an invalid format.
- InvalidDeploymentStatusException The specified deployment status doesn't exist or cannot be determined.
- InvalidNextTokenException The next token was specified in an invalid format.
- InvalidExternalIdException The external ID was specified in an invalid format.
- InvalidInputException The input was specified in an invalid format.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDeploymentsPaginator
This is a variant of
listDeployments(software.amazon.awssdk.services.codedeploy.model.ListDeploymentsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.codedeploy.paginators.ListDeploymentsPublisher publisher = client.listDeploymentsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.codedeploy.paginators.ListDeploymentsPublisher publisher = client.listDeploymentsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codedeploy.model.ListDeploymentsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.codedeploy.model.ListDeploymentsResponse response) { //... }; });
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDeployments(software.amazon.awssdk.services.codedeploy.model.ListDeploymentsRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ApplicationNameRequiredException The minimum number of required application names was not specified.
- InvalidApplicationNameException The application name was specified in an invalid format.
- ApplicationDoesNotExistException The application does not exist with the user or Amazon Web Services account.
- InvalidDeploymentGroupNameException The deployment group name was specified in an invalid format.
- DeploymentGroupDoesNotExistException The named deployment group with the user or Amazon Web Services account does not exist.
- DeploymentGroupNameRequiredException The deployment group name was not specified.
- InvalidTimeRangeException The specified time range was specified in an invalid format.
- InvalidDeploymentStatusException The specified deployment status doesn't exist or cannot be determined.
- InvalidNextTokenException The next token was specified in an invalid format.
- InvalidExternalIdException The external ID was specified in an invalid format.
- InvalidInputException The input was specified in an invalid format.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDeploymentsPaginator
default ListDeploymentsPublisher listDeploymentsPaginator(ListDeploymentsRequest listDeploymentsRequest) This is a variant of
listDeployments(software.amazon.awssdk.services.codedeploy.model.ListDeploymentsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.codedeploy.paginators.ListDeploymentsPublisher publisher = client.listDeploymentsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.codedeploy.paginators.ListDeploymentsPublisher publisher = client.listDeploymentsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codedeploy.model.ListDeploymentsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.codedeploy.model.ListDeploymentsResponse response) { //... }; });
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDeployments(software.amazon.awssdk.services.codedeploy.model.ListDeploymentsRequest)
operation.- Parameters:
listDeploymentsRequest
- Represents the input of aListDeployments
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ApplicationNameRequiredException The minimum number of required application names was not specified.
- InvalidApplicationNameException The application name was specified in an invalid format.
- ApplicationDoesNotExistException The application does not exist with the user or Amazon Web Services account.
- InvalidDeploymentGroupNameException The deployment group name was specified in an invalid format.
- DeploymentGroupDoesNotExistException The named deployment group with the user or Amazon Web Services account does not exist.
- DeploymentGroupNameRequiredException The deployment group name was not specified.
- InvalidTimeRangeException The specified time range was specified in an invalid format.
- InvalidDeploymentStatusException The specified deployment status doesn't exist or cannot be determined.
- InvalidNextTokenException The next token was specified in an invalid format.
- InvalidExternalIdException The external ID was specified in an invalid format.
- InvalidInputException The input was specified in an invalid format.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDeploymentsPaginator
default ListDeploymentsPublisher listDeploymentsPaginator(Consumer<ListDeploymentsRequest.Builder> listDeploymentsRequest) This is a variant of
listDeployments(software.amazon.awssdk.services.codedeploy.model.ListDeploymentsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.codedeploy.paginators.ListDeploymentsPublisher publisher = client.listDeploymentsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.codedeploy.paginators.ListDeploymentsPublisher publisher = client.listDeploymentsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codedeploy.model.ListDeploymentsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.codedeploy.model.ListDeploymentsResponse response) { //... }; });
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDeployments(software.amazon.awssdk.services.codedeploy.model.ListDeploymentsRequest)
operation.
This is a convenience which creates an instance of the
ListDeploymentsRequest.Builder
avoiding the need to create one manually viaListDeploymentsRequest.builder()
- Parameters:
listDeploymentsRequest
- AConsumer
that will call methods onListDeploymentsRequest.Builder
to create a request. Represents the input of aListDeployments
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ApplicationNameRequiredException The minimum number of required application names was not specified.
- InvalidApplicationNameException The application name was specified in an invalid format.
- ApplicationDoesNotExistException The application does not exist with the user or Amazon Web Services account.
- InvalidDeploymentGroupNameException The deployment group name was specified in an invalid format.
- DeploymentGroupDoesNotExistException The named deployment group with the user or Amazon Web Services account does not exist.
- DeploymentGroupNameRequiredException The deployment group name was not specified.
- InvalidTimeRangeException The specified time range was specified in an invalid format.
- InvalidDeploymentStatusException The specified deployment status doesn't exist or cannot be determined.
- InvalidNextTokenException The next token was specified in an invalid format.
- InvalidExternalIdException The external ID was specified in an invalid format.
- InvalidInputException The input was specified in an invalid format.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listGitHubAccountTokenNames
default CompletableFuture<ListGitHubAccountTokenNamesResponse> listGitHubAccountTokenNames(ListGitHubAccountTokenNamesRequest listGitHubAccountTokenNamesRequest) Lists the names of stored connections to GitHub accounts.
- Parameters:
listGitHubAccountTokenNamesRequest
- Represents the input of aListGitHubAccountTokenNames
operation.- Returns:
- A Java Future containing the result of the ListGitHubAccountTokenNames operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidNextTokenException The next token was specified in an invalid format.
- ResourceValidationException The specified resource could not be validated.
- OperationNotSupportedException The API used does not support the deployment.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listGitHubAccountTokenNames
default CompletableFuture<ListGitHubAccountTokenNamesResponse> listGitHubAccountTokenNames(Consumer<ListGitHubAccountTokenNamesRequest.Builder> listGitHubAccountTokenNamesRequest) Lists the names of stored connections to GitHub accounts.
This is a convenience which creates an instance of the
ListGitHubAccountTokenNamesRequest.Builder
avoiding the need to create one manually viaListGitHubAccountTokenNamesRequest.builder()
- Parameters:
listGitHubAccountTokenNamesRequest
- AConsumer
that will call methods onListGitHubAccountTokenNamesRequest.Builder
to create a request. Represents the input of aListGitHubAccountTokenNames
operation.- Returns:
- A Java Future containing the result of the ListGitHubAccountTokenNames operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidNextTokenException The next token was specified in an invalid format.
- ResourceValidationException The specified resource could not be validated.
- OperationNotSupportedException The API used does not support the deployment.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listGitHubAccountTokenNames
Lists the names of stored connections to GitHub accounts.
- Returns:
- A Java Future containing the result of the ListGitHubAccountTokenNames operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidNextTokenException The next token was specified in an invalid format.
- ResourceValidationException The specified resource could not be validated.
- OperationNotSupportedException The API used does not support the deployment.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listOnPremisesInstances
default CompletableFuture<ListOnPremisesInstancesResponse> listOnPremisesInstances(ListOnPremisesInstancesRequest listOnPremisesInstancesRequest) Gets a list of names for one or more on-premises instances.
Unless otherwise specified, both registered and deregistered on-premises instance names are listed. To list only registered or deregistered on-premises instance names, use the registration status parameter.
- Parameters:
listOnPremisesInstancesRequest
- Represents the input of aListOnPremisesInstances
operation.- Returns:
- A Java Future containing the result of the ListOnPremisesInstances operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRegistrationStatusException The registration status was specified in an invalid format.
- InvalidTagFilterException The tag filter was specified in an invalid format.
- InvalidNextTokenException The next token was specified in an invalid format.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listOnPremisesInstances
default CompletableFuture<ListOnPremisesInstancesResponse> listOnPremisesInstances(Consumer<ListOnPremisesInstancesRequest.Builder> listOnPremisesInstancesRequest) Gets a list of names for one or more on-premises instances.
Unless otherwise specified, both registered and deregistered on-premises instance names are listed. To list only registered or deregistered on-premises instance names, use the registration status parameter.
This is a convenience which creates an instance of the
ListOnPremisesInstancesRequest.Builder
avoiding the need to create one manually viaListOnPremisesInstancesRequest.builder()
- Parameters:
listOnPremisesInstancesRequest
- AConsumer
that will call methods onListOnPremisesInstancesRequest.Builder
to create a request. Represents the input of aListOnPremisesInstances
operation.- Returns:
- A Java Future containing the result of the ListOnPremisesInstances operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRegistrationStatusException The registration status was specified in an invalid format.
- InvalidTagFilterException The tag filter was specified in an invalid format.
- InvalidNextTokenException The next token was specified in an invalid format.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listOnPremisesInstances
Gets a list of names for one or more on-premises instances.
Unless otherwise specified, both registered and deregistered on-premises instance names are listed. To list only registered or deregistered on-premises instance names, use the registration status parameter.
- Returns:
- A Java Future containing the result of the ListOnPremisesInstances operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRegistrationStatusException The registration status was specified in an invalid format.
- InvalidTagFilterException The tag filter was specified in an invalid format.
- InvalidNextTokenException The next token was specified in an invalid format.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Returns a list of tags for the resource identified by a specified Amazon Resource Name (ARN). Tags are used to organize and categorize your CodeDeploy resources.
- Parameters:
listTagsForResourceRequest
-- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ArnNotSupportedException The specified ARN is not supported. For example, it might be an ARN for a resource that is not expected.
- InvalidArnException The specified ARN is not in a valid format.
- ResourceArnRequiredException The ARN of a resource is required, but was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Returns a list of tags for the resource identified by a specified Amazon Resource Name (ARN). Tags are used to organize and categorize your CodeDeploy resources.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ArnNotSupportedException The specified ARN is not supported. For example, it might be an ARN for a resource that is not expected.
- InvalidArnException The specified ARN is not in a valid format.
- ResourceArnRequiredException The ARN of a resource is required, but was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putLifecycleEventHookExecutionStatus
default CompletableFuture<PutLifecycleEventHookExecutionStatusResponse> putLifecycleEventHookExecutionStatus(PutLifecycleEventHookExecutionStatusRequest putLifecycleEventHookExecutionStatusRequest) Sets the result of a Lambda validation function. The function validates lifecycle hooks during a deployment that uses the Lambda or Amazon ECS compute platform. For Lambda deployments, the available lifecycle hooks are
BeforeAllowTraffic
andAfterAllowTraffic
. For Amazon ECS deployments, the available lifecycle hooks areBeforeInstall
,AfterInstall
,AfterAllowTestTraffic
,BeforeAllowTraffic
, andAfterAllowTraffic
. Lambda validation functions returnSucceeded
orFailed
. For more information, see AppSpec 'hooks' Section for an Lambda Deployment and AppSpec 'hooks' Section for an Amazon ECS Deployment.- Parameters:
putLifecycleEventHookExecutionStatusRequest
-- Returns:
- A Java Future containing the result of the PutLifecycleEventHookExecutionStatus operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidLifecycleEventHookExecutionStatusException The result of a Lambda validation function that
verifies a lifecycle event is invalid. It should return
Succeeded
orFailed
. - InvalidLifecycleEventHookExecutionIdException A lifecycle event hook is invalid. Review the
hooks
section in your AppSpec file to ensure the lifecycle events andhooks
functions are valid. - LifecycleEventAlreadyCompletedException An attempt to return the status of an already completed lifecycle event occurred.
- DeploymentIdRequiredException At least one deployment ID must be specified.
- DeploymentDoesNotExistException The deployment with the user or Amazon Web Services account does not exist.
- InvalidDeploymentIdException At least one of the deployment IDs was specified in an invalid format.
- UnsupportedActionForDeploymentTypeException A call was submitted that is not supported for the specified deployment type.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- InvalidLifecycleEventHookExecutionStatusException The result of a Lambda validation function that
verifies a lifecycle event is invalid. It should return
- See Also:
-
putLifecycleEventHookExecutionStatus
default CompletableFuture<PutLifecycleEventHookExecutionStatusResponse> putLifecycleEventHookExecutionStatus(Consumer<PutLifecycleEventHookExecutionStatusRequest.Builder> putLifecycleEventHookExecutionStatusRequest) Sets the result of a Lambda validation function. The function validates lifecycle hooks during a deployment that uses the Lambda or Amazon ECS compute platform. For Lambda deployments, the available lifecycle hooks are
BeforeAllowTraffic
andAfterAllowTraffic
. For Amazon ECS deployments, the available lifecycle hooks areBeforeInstall
,AfterInstall
,AfterAllowTestTraffic
,BeforeAllowTraffic
, andAfterAllowTraffic
. Lambda validation functions returnSucceeded
orFailed
. For more information, see AppSpec 'hooks' Section for an Lambda Deployment and AppSpec 'hooks' Section for an Amazon ECS Deployment.
This is a convenience which creates an instance of the
PutLifecycleEventHookExecutionStatusRequest.Builder
avoiding the need to create one manually viaPutLifecycleEventHookExecutionStatusRequest.builder()
- Parameters:
putLifecycleEventHookExecutionStatusRequest
- AConsumer
that will call methods onPutLifecycleEventHookExecutionStatusRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutLifecycleEventHookExecutionStatus operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidLifecycleEventHookExecutionStatusException The result of a Lambda validation function that
verifies a lifecycle event is invalid. It should return
Succeeded
orFailed
. - InvalidLifecycleEventHookExecutionIdException A lifecycle event hook is invalid. Review the
hooks
section in your AppSpec file to ensure the lifecycle events andhooks
functions are valid. - LifecycleEventAlreadyCompletedException An attempt to return the status of an already completed lifecycle event occurred.
- DeploymentIdRequiredException At least one deployment ID must be specified.
- DeploymentDoesNotExistException The deployment with the user or Amazon Web Services account does not exist.
- InvalidDeploymentIdException At least one of the deployment IDs was specified in an invalid format.
- UnsupportedActionForDeploymentTypeException A call was submitted that is not supported for the specified deployment type.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- InvalidLifecycleEventHookExecutionStatusException The result of a Lambda validation function that
verifies a lifecycle event is invalid. It should return
- See Also:
-
registerApplicationRevision
default CompletableFuture<RegisterApplicationRevisionResponse> registerApplicationRevision(RegisterApplicationRevisionRequest registerApplicationRevisionRequest) Registers with CodeDeploy a revision for the specified application.
- Parameters:
registerApplicationRevisionRequest
- Represents the input of a RegisterApplicationRevision operation.- Returns:
- A Java Future containing the result of the RegisterApplicationRevision operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ApplicationDoesNotExistException The application does not exist with the user or Amazon Web Services account.
- ApplicationNameRequiredException The minimum number of required application names was not specified.
- InvalidApplicationNameException The application name was specified in an invalid format.
- DescriptionTooLongException The description is too long.
- RevisionRequiredException The revision ID was not specified.
- InvalidRevisionException The revision was specified in an invalid format.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
registerApplicationRevision
default CompletableFuture<RegisterApplicationRevisionResponse> registerApplicationRevision(Consumer<RegisterApplicationRevisionRequest.Builder> registerApplicationRevisionRequest) Registers with CodeDeploy a revision for the specified application.
This is a convenience which creates an instance of the
RegisterApplicationRevisionRequest.Builder
avoiding the need to create one manually viaRegisterApplicationRevisionRequest.builder()
- Parameters:
registerApplicationRevisionRequest
- AConsumer
that will call methods onRegisterApplicationRevisionRequest.Builder
to create a request. Represents the input of a RegisterApplicationRevision operation.- Returns:
- A Java Future containing the result of the RegisterApplicationRevision operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ApplicationDoesNotExistException The application does not exist with the user or Amazon Web Services account.
- ApplicationNameRequiredException The minimum number of required application names was not specified.
- InvalidApplicationNameException The application name was specified in an invalid format.
- DescriptionTooLongException The description is too long.
- RevisionRequiredException The revision ID was not specified.
- InvalidRevisionException The revision was specified in an invalid format.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
registerOnPremisesInstance
default CompletableFuture<RegisterOnPremisesInstanceResponse> registerOnPremisesInstance(RegisterOnPremisesInstanceRequest registerOnPremisesInstanceRequest) Registers an on-premises instance.
Only one IAM ARN (an IAM session ARN or IAM user ARN) is supported in the request. You cannot use both.
- Parameters:
registerOnPremisesInstanceRequest
- Represents the input of the register on-premises instance operation.- Returns:
- A Java Future containing the result of the RegisterOnPremisesInstance operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InstanceNameAlreadyRegisteredException The specified on-premises instance name is already registered.
- IamArnRequiredException No IAM ARN was included in the request. You must use an IAM session ARN or user ARN in the request.
- IamSessionArnAlreadyRegisteredException The request included an IAM session ARN that has already been used to register a different instance.
- IamUserArnAlreadyRegisteredException The specified user ARN is already registered with an on-premises instance.
- InstanceNameRequiredException An on-premises instance name was not specified.
- IamUserArnRequiredException An user ARN was not specified.
- InvalidInstanceNameException The on-premises instance name was specified in an invalid format.
- InvalidIamSessionArnException The IAM session ARN was specified in an invalid format.
- InvalidIamUserArnException The user ARN was specified in an invalid format.
- MultipleIamArnsProvidedException Both an user ARN and an IAM session ARN were included in the request. Use only one ARN type.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
registerOnPremisesInstance
default CompletableFuture<RegisterOnPremisesInstanceResponse> registerOnPremisesInstance(Consumer<RegisterOnPremisesInstanceRequest.Builder> registerOnPremisesInstanceRequest) Registers an on-premises instance.
Only one IAM ARN (an IAM session ARN or IAM user ARN) is supported in the request. You cannot use both.
This is a convenience which creates an instance of the
RegisterOnPremisesInstanceRequest.Builder
avoiding the need to create one manually viaRegisterOnPremisesInstanceRequest.builder()
- Parameters:
registerOnPremisesInstanceRequest
- AConsumer
that will call methods onRegisterOnPremisesInstanceRequest.Builder
to create a request. Represents the input of the register on-premises instance operation.- Returns:
- A Java Future containing the result of the RegisterOnPremisesInstance operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InstanceNameAlreadyRegisteredException The specified on-premises instance name is already registered.
- IamArnRequiredException No IAM ARN was included in the request. You must use an IAM session ARN or user ARN in the request.
- IamSessionArnAlreadyRegisteredException The request included an IAM session ARN that has already been used to register a different instance.
- IamUserArnAlreadyRegisteredException The specified user ARN is already registered with an on-premises instance.
- InstanceNameRequiredException An on-premises instance name was not specified.
- IamUserArnRequiredException An user ARN was not specified.
- InvalidInstanceNameException The on-premises instance name was specified in an invalid format.
- InvalidIamSessionArnException The IAM session ARN was specified in an invalid format.
- InvalidIamUserArnException The user ARN was specified in an invalid format.
- MultipleIamArnsProvidedException Both an user ARN and an IAM session ARN were included in the request. Use only one ARN type.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
removeTagsFromOnPremisesInstances
default CompletableFuture<RemoveTagsFromOnPremisesInstancesResponse> removeTagsFromOnPremisesInstances(RemoveTagsFromOnPremisesInstancesRequest removeTagsFromOnPremisesInstancesRequest) Removes one or more tags from one or more on-premises instances.
- Parameters:
removeTagsFromOnPremisesInstancesRequest
- Represents the input of aRemoveTagsFromOnPremisesInstances
operation.- Returns:
- A Java Future containing the result of the RemoveTagsFromOnPremisesInstances operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InstanceNameRequiredException An on-premises instance name was not specified.
- InvalidInstanceNameException The on-premises instance name was specified in an invalid format.
- TagRequiredException A tag was not specified.
- InvalidTagException The tag was specified in an invalid format.
- TagLimitExceededException The maximum allowed number of tags was exceeded.
- InstanceLimitExceededException The maximum number of allowed on-premises instances in a single call was exceeded.
- InstanceNotRegisteredException The specified on-premises instance is not registered.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
removeTagsFromOnPremisesInstances
default CompletableFuture<RemoveTagsFromOnPremisesInstancesResponse> removeTagsFromOnPremisesInstances(Consumer<RemoveTagsFromOnPremisesInstancesRequest.Builder> removeTagsFromOnPremisesInstancesRequest) Removes one or more tags from one or more on-premises instances.
This is a convenience which creates an instance of the
RemoveTagsFromOnPremisesInstancesRequest.Builder
avoiding the need to create one manually viaRemoveTagsFromOnPremisesInstancesRequest.builder()
- Parameters:
removeTagsFromOnPremisesInstancesRequest
- AConsumer
that will call methods onRemoveTagsFromOnPremisesInstancesRequest.Builder
to create a request. Represents the input of aRemoveTagsFromOnPremisesInstances
operation.- Returns:
- A Java Future containing the result of the RemoveTagsFromOnPremisesInstances operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InstanceNameRequiredException An on-premises instance name was not specified.
- InvalidInstanceNameException The on-premises instance name was specified in an invalid format.
- TagRequiredException A tag was not specified.
- InvalidTagException The tag was specified in an invalid format.
- TagLimitExceededException The maximum allowed number of tags was exceeded.
- InstanceLimitExceededException The maximum number of allowed on-premises instances in a single call was exceeded.
- InstanceNotRegisteredException The specified on-premises instance is not registered.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopDeployment
default CompletableFuture<StopDeploymentResponse> stopDeployment(StopDeploymentRequest stopDeploymentRequest) Attempts to stop an ongoing deployment.
- Parameters:
stopDeploymentRequest
- Represents the input of aStopDeployment
operation.- Returns:
- A Java Future containing the result of the StopDeployment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DeploymentIdRequiredException At least one deployment ID must be specified.
- DeploymentDoesNotExistException The deployment with the user or Amazon Web Services account does not exist.
- DeploymentGroupDoesNotExistException The named deployment group with the user or Amazon Web Services account does not exist.
- DeploymentAlreadyCompletedException The deployment is already complete.
- InvalidDeploymentIdException At least one of the deployment IDs was specified in an invalid format.
- UnsupportedActionForDeploymentTypeException A call was submitted that is not supported for the specified deployment type.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopDeployment
default CompletableFuture<StopDeploymentResponse> stopDeployment(Consumer<StopDeploymentRequest.Builder> stopDeploymentRequest) Attempts to stop an ongoing deployment.
This is a convenience which creates an instance of the
StopDeploymentRequest.Builder
avoiding the need to create one manually viaStopDeploymentRequest.builder()
- Parameters:
stopDeploymentRequest
- AConsumer
that will call methods onStopDeploymentRequest.Builder
to create a request. Represents the input of aStopDeployment
operation.- Returns:
- A Java Future containing the result of the StopDeployment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- DeploymentIdRequiredException At least one deployment ID must be specified.
- DeploymentDoesNotExistException The deployment with the user or Amazon Web Services account does not exist.
- DeploymentGroupDoesNotExistException The named deployment group with the user or Amazon Web Services account does not exist.
- DeploymentAlreadyCompletedException The deployment is already complete.
- InvalidDeploymentIdException At least one of the deployment IDs was specified in an invalid format.
- UnsupportedActionForDeploymentTypeException A call was submitted that is not supported for the specified deployment type.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
Associates the list of tags in the input
Tags
parameter with the resource identified by theResourceArn
input parameter.- Parameters:
tagResourceRequest
-- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceArnRequiredException The ARN of a resource is required, but was not found.
- ApplicationDoesNotExistException The application does not exist with the user or Amazon Web Services account.
- DeploymentGroupDoesNotExistException The named deployment group with the user or Amazon Web Services account does not exist.
- DeploymentConfigDoesNotExistException The deployment configuration does not exist with the user or Amazon Web Services account.
- TagRequiredException A tag was not specified.
- InvalidTagsToAddException The specified tags are not valid.
- ArnNotSupportedException The specified ARN is not supported. For example, it might be an ARN for a resource that is not expected.
- InvalidArnException The specified ARN is not in a valid format.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Associates the list of tags in the input
Tags
parameter with the resource identified by theResourceArn
input parameter.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceArnRequiredException The ARN of a resource is required, but was not found.
- ApplicationDoesNotExistException The application does not exist with the user or Amazon Web Services account.
- DeploymentGroupDoesNotExistException The named deployment group with the user or Amazon Web Services account does not exist.
- DeploymentConfigDoesNotExistException The deployment configuration does not exist with the user or Amazon Web Services account.
- TagRequiredException A tag was not specified.
- InvalidTagsToAddException The specified tags are not valid.
- ArnNotSupportedException The specified ARN is not supported. For example, it might be an ARN for a resource that is not expected.
- InvalidArnException The specified ARN is not in a valid format.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Disassociates a resource from a list of tags. The resource is identified by the
ResourceArn
input parameter. The tags are identified by the list of keys in theTagKeys
input parameter.- Parameters:
untagResourceRequest
-- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceArnRequiredException The ARN of a resource is required, but was not found.
- ApplicationDoesNotExistException The application does not exist with the user or Amazon Web Services account.
- DeploymentGroupDoesNotExistException The named deployment group with the user or Amazon Web Services account does not exist.
- DeploymentConfigDoesNotExistException The deployment configuration does not exist with the user or Amazon Web Services account.
- TagRequiredException A tag was not specified.
- InvalidTagsToAddException The specified tags are not valid.
- ArnNotSupportedException The specified ARN is not supported. For example, it might be an ARN for a resource that is not expected.
- InvalidArnException The specified ARN is not in a valid format.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Disassociates a resource from a list of tags. The resource is identified by the
ResourceArn
input parameter. The tags are identified by the list of keys in theTagKeys
input parameter.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceArnRequiredException The ARN of a resource is required, but was not found.
- ApplicationDoesNotExistException The application does not exist with the user or Amazon Web Services account.
- DeploymentGroupDoesNotExistException The named deployment group with the user or Amazon Web Services account does not exist.
- DeploymentConfigDoesNotExistException The deployment configuration does not exist with the user or Amazon Web Services account.
- TagRequiredException A tag was not specified.
- InvalidTagsToAddException The specified tags are not valid.
- ArnNotSupportedException The specified ARN is not supported. For example, it might be an ARN for a resource that is not expected.
- InvalidArnException The specified ARN is not in a valid format.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateApplication
default CompletableFuture<UpdateApplicationResponse> updateApplication(UpdateApplicationRequest updateApplicationRequest) Changes the name of an application.
- Parameters:
updateApplicationRequest
- Represents the input of anUpdateApplication
operation.- Returns:
- A Java Future containing the result of the UpdateApplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ApplicationNameRequiredException The minimum number of required application names was not specified.
- InvalidApplicationNameException The application name was specified in an invalid format.
- ApplicationAlreadyExistsException An application with the specified name with the user or Amazon Web Services account already exists.
- ApplicationDoesNotExistException The application does not exist with the user or Amazon Web Services account.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateApplication
default CompletableFuture<UpdateApplicationResponse> updateApplication(Consumer<UpdateApplicationRequest.Builder> updateApplicationRequest) Changes the name of an application.
This is a convenience which creates an instance of the
UpdateApplicationRequest.Builder
avoiding the need to create one manually viaUpdateApplicationRequest.builder()
- Parameters:
updateApplicationRequest
- AConsumer
that will call methods onUpdateApplicationRequest.Builder
to create a request. Represents the input of anUpdateApplication
operation.- Returns:
- A Java Future containing the result of the UpdateApplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ApplicationNameRequiredException The minimum number of required application names was not specified.
- InvalidApplicationNameException The application name was specified in an invalid format.
- ApplicationAlreadyExistsException An application with the specified name with the user or Amazon Web Services account already exists.
- ApplicationDoesNotExistException The application does not exist with the user or Amazon Web Services account.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateDeploymentGroup
default CompletableFuture<UpdateDeploymentGroupResponse> updateDeploymentGroup(UpdateDeploymentGroupRequest updateDeploymentGroupRequest) Changes information about a deployment group.
- Parameters:
updateDeploymentGroupRequest
- Represents the input of anUpdateDeploymentGroup
operation.- Returns:
- A Java Future containing the result of the UpdateDeploymentGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ApplicationNameRequiredException The minimum number of required application names was not specified.
- InvalidApplicationNameException The application name was specified in an invalid format.
- ApplicationDoesNotExistException The application does not exist with the user or Amazon Web Services account.
- InvalidDeploymentGroupNameException The deployment group name was specified in an invalid format.
- DeploymentGroupAlreadyExistsException A deployment group with the specified name with the user or Amazon Web Services account already exists.
- DeploymentGroupNameRequiredException The deployment group name was not specified.
- DeploymentGroupDoesNotExistException The named deployment group with the user or Amazon Web Services account does not exist.
- InvalidEc2TagException The tag was specified in an invalid format.
- InvalidTagException The tag was specified in an invalid format.
- InvalidAutoScalingGroupException The Auto Scaling group was specified in an invalid format or does not exist.
- InvalidDeploymentConfigNameException The deployment configuration name was specified in an invalid format.
- DeploymentConfigDoesNotExistException The deployment configuration does not exist with the user or Amazon Web Services account.
- InvalidRoleException The service role ARN was specified in an invalid format. Or, if an Auto Scaling group was specified, the specified service role does not grant the appropriate permissions to Amazon EC2 Auto Scaling.
- LifecycleHookLimitExceededException The limit for lifecycle hooks was exceeded.
- InvalidTriggerConfigException The trigger was specified in an invalid format.
- TriggerTargetsLimitExceededException The maximum allowed number of triggers was exceeded.
- InvalidAlarmConfigException The format of the alarm configuration is invalid. Possible causes
include:
-
The alarm list is null.
-
The alarm object is null.
-
The alarm name is empty or null or exceeds the limit of 255 characters.
-
Two alarms with the same name have been specified.
-
The alarm configuration is enabled, but the alarm list is empty.
-
- AlarmsLimitExceededException The maximum number of alarms for a deployment group (10) was exceeded.
- InvalidAutoRollbackConfigException The automatic rollback configuration was specified in an invalid format. For example, automatic rollback is enabled, but an invalid triggering event type or no event types were listed.
- InvalidLoadBalancerInfoException An invalid load balancer name, or no load balancer name, was specified.
- InvalidDeploymentStyleException An invalid deployment style was specified. Valid deployment types include "IN_PLACE" and "BLUE_GREEN." Valid deployment options include "WITH_TRAFFIC_CONTROL" and "WITHOUT_TRAFFIC_CONTROL."
- InvalidBlueGreenDeploymentConfigurationException The configuration for the blue/green deployment group was provided in an invalid format. For information about deployment configuration format, see CreateDeploymentConfig.
- InvalidEc2TagCombinationException A call was submitted that specified both Ec2TagFilters and Ec2TagSet, but only one of these data types can be used in a single call.
- InvalidOnPremisesTagCombinationException A call was submitted that specified both OnPremisesTagFilters and OnPremisesTagSet, but only one of these data types can be used in a single call.
- TagSetListLimitExceededException The number of tag groups included in the tag set list exceeded the maximum allowed limit of 3.
- InvalidInputException The input was specified in an invalid format.
- ThrottlingException An API function was called too frequently.
- InvalidEcsServiceException The Amazon ECS service identifier is not valid.
- InvalidTargetGroupPairException A target group pair associated with this deployment is not valid.
- EcsServiceMappingLimitExceededException The Amazon ECS service is associated with more than one deployment groups. An Amazon ECS service can be associated with only one deployment group.
- InvalidTrafficRoutingConfigurationException The configuration that specifies how traffic is routed during a deployment is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateDeploymentGroup
default CompletableFuture<UpdateDeploymentGroupResponse> updateDeploymentGroup(Consumer<UpdateDeploymentGroupRequest.Builder> updateDeploymentGroupRequest) Changes information about a deployment group.
This is a convenience which creates an instance of the
UpdateDeploymentGroupRequest.Builder
avoiding the need to create one manually viaUpdateDeploymentGroupRequest.builder()
- Parameters:
updateDeploymentGroupRequest
- AConsumer
that will call methods onUpdateDeploymentGroupRequest.Builder
to create a request. Represents the input of anUpdateDeploymentGroup
operation.- Returns:
- A Java Future containing the result of the UpdateDeploymentGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ApplicationNameRequiredException The minimum number of required application names was not specified.
- InvalidApplicationNameException The application name was specified in an invalid format.
- ApplicationDoesNotExistException The application does not exist with the user or Amazon Web Services account.
- InvalidDeploymentGroupNameException The deployment group name was specified in an invalid format.
- DeploymentGroupAlreadyExistsException A deployment group with the specified name with the user or Amazon Web Services account already exists.
- DeploymentGroupNameRequiredException The deployment group name was not specified.
- DeploymentGroupDoesNotExistException The named deployment group with the user or Amazon Web Services account does not exist.
- InvalidEc2TagException The tag was specified in an invalid format.
- InvalidTagException The tag was specified in an invalid format.
- InvalidAutoScalingGroupException The Auto Scaling group was specified in an invalid format or does not exist.
- InvalidDeploymentConfigNameException The deployment configuration name was specified in an invalid format.
- DeploymentConfigDoesNotExistException The deployment configuration does not exist with the user or Amazon Web Services account.
- InvalidRoleException The service role ARN was specified in an invalid format. Or, if an Auto Scaling group was specified, the specified service role does not grant the appropriate permissions to Amazon EC2 Auto Scaling.
- LifecycleHookLimitExceededException The limit for lifecycle hooks was exceeded.
- InvalidTriggerConfigException The trigger was specified in an invalid format.
- TriggerTargetsLimitExceededException The maximum allowed number of triggers was exceeded.
- InvalidAlarmConfigException The format of the alarm configuration is invalid. Possible causes
include:
-
The alarm list is null.
-
The alarm object is null.
-
The alarm name is empty or null or exceeds the limit of 255 characters.
-
Two alarms with the same name have been specified.
-
The alarm configuration is enabled, but the alarm list is empty.
-
- AlarmsLimitExceededException The maximum number of alarms for a deployment group (10) was exceeded.
- InvalidAutoRollbackConfigException The automatic rollback configuration was specified in an invalid format. For example, automatic rollback is enabled, but an invalid triggering event type or no event types were listed.
- InvalidLoadBalancerInfoException An invalid load balancer name, or no load balancer name, was specified.
- InvalidDeploymentStyleException An invalid deployment style was specified. Valid deployment types include "IN_PLACE" and "BLUE_GREEN." Valid deployment options include "WITH_TRAFFIC_CONTROL" and "WITHOUT_TRAFFIC_CONTROL."
- InvalidBlueGreenDeploymentConfigurationException The configuration for the blue/green deployment group was provided in an invalid format. For information about deployment configuration format, see CreateDeploymentConfig.
- InvalidEc2TagCombinationException A call was submitted that specified both Ec2TagFilters and Ec2TagSet, but only one of these data types can be used in a single call.
- InvalidOnPremisesTagCombinationException A call was submitted that specified both OnPremisesTagFilters and OnPremisesTagSet, but only one of these data types can be used in a single call.
- TagSetListLimitExceededException The number of tag groups included in the tag set list exceeded the maximum allowed limit of 3.
- InvalidInputException The input was specified in an invalid format.
- ThrottlingException An API function was called too frequently.
- InvalidEcsServiceException The Amazon ECS service identifier is not valid.
- InvalidTargetGroupPairException A target group pair associated with this deployment is not valid.
- EcsServiceMappingLimitExceededException The Amazon ECS service is associated with more than one deployment groups. An Amazon ECS service can be associated with only one deployment group.
- InvalidTrafficRoutingConfigurationException The configuration that specifies how traffic is routed during a deployment is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeDeployException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
waiter
Create an instance ofCodeDeployAsyncWaiter
using this client.Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.
- Returns:
- an instance of
CodeDeployAsyncWaiter
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aCodeDeployAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aCodeDeployAsyncClient
.
-