Interface CodeDeployClient
-
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface CodeDeployClient extends AwsClient
Service client for accessing CodeDeploy. This can be created using the staticbuilder()method.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
Fields Modifier and Type Field Description static StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
All Methods Static Methods Instance Methods Default Methods Modifier and Type Method Description default AddTagsToOnPremisesInstancesResponseaddTagsToOnPremisesInstances(Consumer<AddTagsToOnPremisesInstancesRequest.Builder> addTagsToOnPremisesInstancesRequest)Adds tags to on-premises instances.default AddTagsToOnPremisesInstancesResponseaddTagsToOnPremisesInstances(AddTagsToOnPremisesInstancesRequest addTagsToOnPremisesInstancesRequest)Adds tags to on-premises instances.default BatchGetApplicationRevisionsResponsebatchGetApplicationRevisions(Consumer<BatchGetApplicationRevisionsRequest.Builder> batchGetApplicationRevisionsRequest)Gets information about one or more application revisions.default BatchGetApplicationRevisionsResponsebatchGetApplicationRevisions(BatchGetApplicationRevisionsRequest batchGetApplicationRevisionsRequest)Gets information about one or more application revisions.default BatchGetApplicationsResponsebatchGetApplications(Consumer<BatchGetApplicationsRequest.Builder> batchGetApplicationsRequest)Gets information about one or more applications.default BatchGetApplicationsResponsebatchGetApplications(BatchGetApplicationsRequest batchGetApplicationsRequest)Gets information about one or more applications.default BatchGetDeploymentGroupsResponsebatchGetDeploymentGroups(Consumer<BatchGetDeploymentGroupsRequest.Builder> batchGetDeploymentGroupsRequest)Gets information about one or more deployment groups.default BatchGetDeploymentGroupsResponsebatchGetDeploymentGroups(BatchGetDeploymentGroupsRequest batchGetDeploymentGroupsRequest)Gets information about one or more deployment groups.default BatchGetDeploymentsResponsebatchGetDeployments(Consumer<BatchGetDeploymentsRequest.Builder> batchGetDeploymentsRequest)Gets information about one or more deployments.default BatchGetDeploymentsResponsebatchGetDeployments(BatchGetDeploymentsRequest batchGetDeploymentsRequest)Gets information about one or more deployments.default BatchGetDeploymentTargetsResponsebatchGetDeploymentTargets(Consumer<BatchGetDeploymentTargetsRequest.Builder> batchGetDeploymentTargetsRequest)Returns an array of one or more targets associated with a deployment.default BatchGetDeploymentTargetsResponsebatchGetDeploymentTargets(BatchGetDeploymentTargetsRequest batchGetDeploymentTargetsRequest)Returns an array of one or more targets associated with a deployment.default BatchGetOnPremisesInstancesResponsebatchGetOnPremisesInstances(Consumer<BatchGetOnPremisesInstancesRequest.Builder> batchGetOnPremisesInstancesRequest)Gets information about one or more on-premises instances.default BatchGetOnPremisesInstancesResponsebatchGetOnPremisesInstances(BatchGetOnPremisesInstancesRequest batchGetOnPremisesInstancesRequest)Gets information about one or more on-premises instances.static CodeDeployClientBuilderbuilder()Create a builder that can be used to configure and create aCodeDeployClient.default ContinueDeploymentResponsecontinueDeployment(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.default ContinueDeploymentResponsecontinueDeployment(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 CodeDeployClientcreate()Create aCodeDeployClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.default CreateApplicationResponsecreateApplication(Consumer<CreateApplicationRequest.Builder> createApplicationRequest)Creates an application.default CreateApplicationResponsecreateApplication(CreateApplicationRequest createApplicationRequest)Creates an application.default CreateDeploymentResponsecreateDeployment(Consumer<CreateDeploymentRequest.Builder> createDeploymentRequest)Deploys an application revision through the specified deployment group.default CreateDeploymentResponsecreateDeployment(CreateDeploymentRequest createDeploymentRequest)Deploys an application revision through the specified deployment group.default CreateDeploymentConfigResponsecreateDeploymentConfig(Consumer<CreateDeploymentConfigRequest.Builder> createDeploymentConfigRequest)Creates a deployment configuration.default CreateDeploymentConfigResponsecreateDeploymentConfig(CreateDeploymentConfigRequest createDeploymentConfigRequest)Creates a deployment configuration.default CreateDeploymentGroupResponsecreateDeploymentGroup(Consumer<CreateDeploymentGroupRequest.Builder> createDeploymentGroupRequest)Creates a deployment group to which application revisions are deployed.default CreateDeploymentGroupResponsecreateDeploymentGroup(CreateDeploymentGroupRequest createDeploymentGroupRequest)Creates a deployment group to which application revisions are deployed.default DeleteApplicationResponsedeleteApplication(Consumer<DeleteApplicationRequest.Builder> deleteApplicationRequest)Deletes an application.default DeleteApplicationResponsedeleteApplication(DeleteApplicationRequest deleteApplicationRequest)Deletes an application.default DeleteDeploymentConfigResponsedeleteDeploymentConfig(Consumer<DeleteDeploymentConfigRequest.Builder> deleteDeploymentConfigRequest)Deletes a deployment configuration.default DeleteDeploymentConfigResponsedeleteDeploymentConfig(DeleteDeploymentConfigRequest deleteDeploymentConfigRequest)Deletes a deployment configuration.default DeleteDeploymentGroupResponsedeleteDeploymentGroup(Consumer<DeleteDeploymentGroupRequest.Builder> deleteDeploymentGroupRequest)Deletes a deployment group.default DeleteDeploymentGroupResponsedeleteDeploymentGroup(DeleteDeploymentGroupRequest deleteDeploymentGroupRequest)Deletes a deployment group.default DeleteGitHubAccountTokenResponsedeleteGitHubAccountToken(Consumer<DeleteGitHubAccountTokenRequest.Builder> deleteGitHubAccountTokenRequest)Deletes a GitHub account connection.default DeleteGitHubAccountTokenResponsedeleteGitHubAccountToken(DeleteGitHubAccountTokenRequest deleteGitHubAccountTokenRequest)Deletes a GitHub account connection.default DeleteResourcesByExternalIdResponsedeleteResourcesByExternalId(Consumer<DeleteResourcesByExternalIdRequest.Builder> deleteResourcesByExternalIdRequest)Deletes resources linked to an external ID.default DeleteResourcesByExternalIdResponsedeleteResourcesByExternalId(DeleteResourcesByExternalIdRequest deleteResourcesByExternalIdRequest)Deletes resources linked to an external ID.default DeregisterOnPremisesInstanceResponsederegisterOnPremisesInstance(Consumer<DeregisterOnPremisesInstanceRequest.Builder> deregisterOnPremisesInstanceRequest)Deregisters an on-premises instance.default DeregisterOnPremisesInstanceResponsederegisterOnPremisesInstance(DeregisterOnPremisesInstanceRequest deregisterOnPremisesInstanceRequest)Deregisters an on-premises instance.default GetApplicationResponsegetApplication(Consumer<GetApplicationRequest.Builder> getApplicationRequest)Gets information about an application.default GetApplicationResponsegetApplication(GetApplicationRequest getApplicationRequest)Gets information about an application.default GetApplicationRevisionResponsegetApplicationRevision(Consumer<GetApplicationRevisionRequest.Builder> getApplicationRevisionRequest)Gets information about an application revision.default GetApplicationRevisionResponsegetApplicationRevision(GetApplicationRevisionRequest getApplicationRevisionRequest)Gets information about an application revision.default GetDeploymentResponsegetDeployment(Consumer<GetDeploymentRequest.Builder> getDeploymentRequest)Gets information about a deployment.default GetDeploymentResponsegetDeployment(GetDeploymentRequest getDeploymentRequest)Gets information about a deployment.default GetDeploymentConfigResponsegetDeploymentConfig(Consumer<GetDeploymentConfigRequest.Builder> getDeploymentConfigRequest)Gets information about a deployment configuration.default GetDeploymentConfigResponsegetDeploymentConfig(GetDeploymentConfigRequest getDeploymentConfigRequest)Gets information about a deployment configuration.default GetDeploymentGroupResponsegetDeploymentGroup(Consumer<GetDeploymentGroupRequest.Builder> getDeploymentGroupRequest)Gets information about a deployment group.default GetDeploymentGroupResponsegetDeploymentGroup(GetDeploymentGroupRequest getDeploymentGroupRequest)Gets information about a deployment group.default GetDeploymentTargetResponsegetDeploymentTarget(Consumer<GetDeploymentTargetRequest.Builder> getDeploymentTargetRequest)Returns information about a deployment target.default GetDeploymentTargetResponsegetDeploymentTarget(GetDeploymentTargetRequest getDeploymentTargetRequest)Returns information about a deployment target.default GetOnPremisesInstanceResponsegetOnPremisesInstance(Consumer<GetOnPremisesInstanceRequest.Builder> getOnPremisesInstanceRequest)Gets information about an on-premises instance.default GetOnPremisesInstanceResponsegetOnPremisesInstance(GetOnPremisesInstanceRequest getOnPremisesInstanceRequest)Gets information about an on-premises instance.default ListApplicationRevisionsResponselistApplicationRevisions(Consumer<ListApplicationRevisionsRequest.Builder> listApplicationRevisionsRequest)Lists information about revisions for an application.default ListApplicationRevisionsResponselistApplicationRevisions(ListApplicationRevisionsRequest listApplicationRevisionsRequest)Lists information about revisions for an application.default ListApplicationRevisionsIterablelistApplicationRevisionsPaginator(Consumer<ListApplicationRevisionsRequest.Builder> listApplicationRevisionsRequest)This is a variant oflistApplicationRevisions(software.amazon.awssdk.services.codedeploy.model.ListApplicationRevisionsRequest)operation.default ListApplicationRevisionsIterablelistApplicationRevisionsPaginator(ListApplicationRevisionsRequest listApplicationRevisionsRequest)This is a variant oflistApplicationRevisions(software.amazon.awssdk.services.codedeploy.model.ListApplicationRevisionsRequest)operation.default ListApplicationsResponselistApplications()Lists the applications registered with the user or Amazon Web Services account.default ListApplicationsResponselistApplications(Consumer<ListApplicationsRequest.Builder> listApplicationsRequest)Lists the applications registered with the user or Amazon Web Services account.default ListApplicationsResponselistApplications(ListApplicationsRequest listApplicationsRequest)Lists the applications registered with the user or Amazon Web Services account.default ListApplicationsIterablelistApplicationsPaginator()This is a variant oflistApplications(software.amazon.awssdk.services.codedeploy.model.ListApplicationsRequest)operation.default ListApplicationsIterablelistApplicationsPaginator(Consumer<ListApplicationsRequest.Builder> listApplicationsRequest)This is a variant oflistApplications(software.amazon.awssdk.services.codedeploy.model.ListApplicationsRequest)operation.default ListApplicationsIterablelistApplicationsPaginator(ListApplicationsRequest listApplicationsRequest)This is a variant oflistApplications(software.amazon.awssdk.services.codedeploy.model.ListApplicationsRequest)operation.default ListDeploymentConfigsResponselistDeploymentConfigs()Lists the deployment configurations with the user or Amazon Web Services account.default ListDeploymentConfigsResponselistDeploymentConfigs(Consumer<ListDeploymentConfigsRequest.Builder> listDeploymentConfigsRequest)Lists the deployment configurations with the user or Amazon Web Services account.default ListDeploymentConfigsResponselistDeploymentConfigs(ListDeploymentConfigsRequest listDeploymentConfigsRequest)Lists the deployment configurations with the user or Amazon Web Services account.default ListDeploymentConfigsIterablelistDeploymentConfigsPaginator()This is a variant oflistDeploymentConfigs(software.amazon.awssdk.services.codedeploy.model.ListDeploymentConfigsRequest)operation.default ListDeploymentConfigsIterablelistDeploymentConfigsPaginator(Consumer<ListDeploymentConfigsRequest.Builder> listDeploymentConfigsRequest)This is a variant oflistDeploymentConfigs(software.amazon.awssdk.services.codedeploy.model.ListDeploymentConfigsRequest)operation.default ListDeploymentConfigsIterablelistDeploymentConfigsPaginator(ListDeploymentConfigsRequest listDeploymentConfigsRequest)This is a variant oflistDeploymentConfigs(software.amazon.awssdk.services.codedeploy.model.ListDeploymentConfigsRequest)operation.default ListDeploymentGroupsResponselistDeploymentGroups(Consumer<ListDeploymentGroupsRequest.Builder> listDeploymentGroupsRequest)Lists the deployment groups for an application registered with the Amazon Web Services user or Amazon Web Services account.default ListDeploymentGroupsResponselistDeploymentGroups(ListDeploymentGroupsRequest listDeploymentGroupsRequest)Lists the deployment groups for an application registered with the Amazon Web Services user or Amazon Web Services account.default ListDeploymentGroupsIterablelistDeploymentGroupsPaginator(Consumer<ListDeploymentGroupsRequest.Builder> listDeploymentGroupsRequest)This is a variant oflistDeploymentGroups(software.amazon.awssdk.services.codedeploy.model.ListDeploymentGroupsRequest)operation.default ListDeploymentGroupsIterablelistDeploymentGroupsPaginator(ListDeploymentGroupsRequest listDeploymentGroupsRequest)This is a variant oflistDeploymentGroups(software.amazon.awssdk.services.codedeploy.model.ListDeploymentGroupsRequest)operation.default ListDeploymentsResponselistDeployments()Lists the deployments in a deployment group for an application registered with the user or Amazon Web Services account.default ListDeploymentsResponselistDeployments(Consumer<ListDeploymentsRequest.Builder> listDeploymentsRequest)Lists the deployments in a deployment group for an application registered with the user or Amazon Web Services account.default ListDeploymentsResponselistDeployments(ListDeploymentsRequest listDeploymentsRequest)Lists the deployments in a deployment group for an application registered with the user or Amazon Web Services account.default ListDeploymentsIterablelistDeploymentsPaginator()This is a variant oflistDeployments(software.amazon.awssdk.services.codedeploy.model.ListDeploymentsRequest)operation.default ListDeploymentsIterablelistDeploymentsPaginator(Consumer<ListDeploymentsRequest.Builder> listDeploymentsRequest)This is a variant oflistDeployments(software.amazon.awssdk.services.codedeploy.model.ListDeploymentsRequest)operation.default ListDeploymentsIterablelistDeploymentsPaginator(ListDeploymentsRequest listDeploymentsRequest)This is a variant oflistDeployments(software.amazon.awssdk.services.codedeploy.model.ListDeploymentsRequest)operation.default ListDeploymentTargetsResponselistDeploymentTargets(Consumer<ListDeploymentTargetsRequest.Builder> listDeploymentTargetsRequest)Returns an array of target IDs that are associated a deployment.default ListDeploymentTargetsResponselistDeploymentTargets(ListDeploymentTargetsRequest listDeploymentTargetsRequest)Returns an array of target IDs that are associated a deployment.default ListGitHubAccountTokenNamesResponselistGitHubAccountTokenNames()Lists the names of stored connections to GitHub accounts.default ListGitHubAccountTokenNamesResponselistGitHubAccountTokenNames(Consumer<ListGitHubAccountTokenNamesRequest.Builder> listGitHubAccountTokenNamesRequest)Lists the names of stored connections to GitHub accounts.default ListGitHubAccountTokenNamesResponselistGitHubAccountTokenNames(ListGitHubAccountTokenNamesRequest listGitHubAccountTokenNamesRequest)Lists the names of stored connections to GitHub accounts.default ListOnPremisesInstancesResponselistOnPremisesInstances()Gets a list of names for one or more on-premises instances.default ListOnPremisesInstancesResponselistOnPremisesInstances(Consumer<ListOnPremisesInstancesRequest.Builder> listOnPremisesInstancesRequest)Gets a list of names for one or more on-premises instances.default ListOnPremisesInstancesResponselistOnPremisesInstances(ListOnPremisesInstancesRequest listOnPremisesInstancesRequest)Gets a list of names for one or more on-premises instances.default ListTagsForResourceResponselistTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)Returns a list of tags for the resource identified by a specified Amazon Resource Name (ARN).default ListTagsForResourceResponselistTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)Returns a list of tags for the resource identified by a specified Amazon Resource Name (ARN).default PutLifecycleEventHookExecutionStatusResponseputLifecycleEventHookExecutionStatus(Consumer<PutLifecycleEventHookExecutionStatusRequest.Builder> putLifecycleEventHookExecutionStatusRequest)Sets the result of a Lambda validation function.default PutLifecycleEventHookExecutionStatusResponseputLifecycleEventHookExecutionStatus(PutLifecycleEventHookExecutionStatusRequest putLifecycleEventHookExecutionStatusRequest)Sets the result of a Lambda validation function.default RegisterApplicationRevisionResponseregisterApplicationRevision(Consumer<RegisterApplicationRevisionRequest.Builder> registerApplicationRevisionRequest)Registers with CodeDeploy a revision for the specified application.default RegisterApplicationRevisionResponseregisterApplicationRevision(RegisterApplicationRevisionRequest registerApplicationRevisionRequest)Registers with CodeDeploy a revision for the specified application.default RegisterOnPremisesInstanceResponseregisterOnPremisesInstance(Consumer<RegisterOnPremisesInstanceRequest.Builder> registerOnPremisesInstanceRequest)Registers an on-premises instance.default RegisterOnPremisesInstanceResponseregisterOnPremisesInstance(RegisterOnPremisesInstanceRequest registerOnPremisesInstanceRequest)Registers an on-premises instance.default RemoveTagsFromOnPremisesInstancesResponseremoveTagsFromOnPremisesInstances(Consumer<RemoveTagsFromOnPremisesInstancesRequest.Builder> removeTagsFromOnPremisesInstancesRequest)Removes one or more tags from one or more on-premises instances.default RemoveTagsFromOnPremisesInstancesResponseremoveTagsFromOnPremisesInstances(RemoveTagsFromOnPremisesInstancesRequest removeTagsFromOnPremisesInstancesRequest)Removes one or more tags from one or more on-premises instances.default CodeDeployServiceClientConfigurationserviceClientConfiguration()static ServiceMetadataserviceMetadata()default StopDeploymentResponsestopDeployment(Consumer<StopDeploymentRequest.Builder> stopDeploymentRequest)Attempts to stop an ongoing deployment.default StopDeploymentResponsestopDeployment(StopDeploymentRequest stopDeploymentRequest)Attempts to stop an ongoing deployment.default TagResourceResponsetagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)Associates the list of tags in the inputTagsparameter with the resource identified by theResourceArninput parameter.default TagResourceResponsetagResource(TagResourceRequest tagResourceRequest)Associates the list of tags in the inputTagsparameter with the resource identified by theResourceArninput parameter.default UntagResourceResponseuntagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)Disassociates a resource from a list of tags.default UntagResourceResponseuntagResource(UntagResourceRequest untagResourceRequest)Disassociates a resource from a list of tags.default UpdateApplicationResponseupdateApplication(Consumer<UpdateApplicationRequest.Builder> updateApplicationRequest)Changes the name of an application.default UpdateApplicationResponseupdateApplication(UpdateApplicationRequest updateApplicationRequest)Changes the name of an application.default UpdateDeploymentGroupResponseupdateDeploymentGroup(Consumer<UpdateDeploymentGroupRequest.Builder> updateDeploymentGroupRequest)Changes information about a deployment group.default UpdateDeploymentGroupResponseupdateDeploymentGroup(UpdateDeploymentGroupRequest updateDeploymentGroupRequest)Changes information about a deployment group.default CodeDeployWaiterwaiter()Create an instance ofCodeDeployWaiterusing this client.-
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
-
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
-
-
-
Field Detail
-
SERVICE_NAME
static final String SERVICE_NAME
- See Also:
- Constant Field Values
-
SERVICE_METADATA_ID
static final String SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
addTagsToOnPremisesInstances
default AddTagsToOnPremisesInstancesResponse addTagsToOnPremisesInstances(AddTagsToOnPremisesInstancesRequest addTagsToOnPremisesInstancesRequest) throws InstanceNameRequiredException, InvalidInstanceNameException, TagRequiredException, InvalidTagException, TagLimitExceededException, InstanceLimitExceededException, InstanceNotRegisteredException, AwsServiceException, SdkClientException, CodeDeployException
Adds tags to on-premises instances.
- Parameters:
addTagsToOnPremisesInstancesRequest- Represents the input of, and adds tags to, an on-premises instance operation.- Returns:
- Result of the AddTagsToOnPremisesInstances operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
addTagsToOnPremisesInstances
default AddTagsToOnPremisesInstancesResponse addTagsToOnPremisesInstances(Consumer<AddTagsToOnPremisesInstancesRequest.Builder> addTagsToOnPremisesInstancesRequest) throws InstanceNameRequiredException, InvalidInstanceNameException, TagRequiredException, InvalidTagException, TagLimitExceededException, InstanceLimitExceededException, InstanceNotRegisteredException, AwsServiceException, SdkClientException, CodeDeployException
Adds tags to on-premises instances.
This is a convenience which creates an instance of the
AddTagsToOnPremisesInstancesRequest.Builderavoiding the need to create one manually viaAddTagsToOnPremisesInstancesRequest.builder()- Parameters:
addTagsToOnPremisesInstancesRequest- AConsumerthat will call methods onAddTagsToOnPremisesInstancesRequest.Builderto create a request. Represents the input of, and adds tags to, an on-premises instance operation.- Returns:
- Result of the AddTagsToOnPremisesInstances operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
batchGetApplicationRevisions
default BatchGetApplicationRevisionsResponse batchGetApplicationRevisions(BatchGetApplicationRevisionsRequest batchGetApplicationRevisionsRequest) throws ApplicationDoesNotExistException, ApplicationNameRequiredException, InvalidApplicationNameException, RevisionRequiredException, InvalidRevisionException, BatchLimitExceededException, AwsServiceException, SdkClientException, CodeDeployException
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 aBatchGetApplicationRevisionsoperation.- Returns:
- Result of the BatchGetApplicationRevisions operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
batchGetApplicationRevisions
default BatchGetApplicationRevisionsResponse batchGetApplicationRevisions(Consumer<BatchGetApplicationRevisionsRequest.Builder> batchGetApplicationRevisionsRequest) throws ApplicationDoesNotExistException, ApplicationNameRequiredException, InvalidApplicationNameException, RevisionRequiredException, InvalidRevisionException, BatchLimitExceededException, AwsServiceException, SdkClientException, CodeDeployException
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.Builderavoiding the need to create one manually viaBatchGetApplicationRevisionsRequest.builder()- Parameters:
batchGetApplicationRevisionsRequest- AConsumerthat will call methods onBatchGetApplicationRevisionsRequest.Builderto create a request. Represents the input of aBatchGetApplicationRevisionsoperation.- Returns:
- Result of the BatchGetApplicationRevisions operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
batchGetApplications
default BatchGetApplicationsResponse batchGetApplications(BatchGetApplicationsRequest batchGetApplicationsRequest) throws ApplicationNameRequiredException, InvalidApplicationNameException, ApplicationDoesNotExistException, BatchLimitExceededException, AwsServiceException, SdkClientException, CodeDeployException
Gets information about one or more applications. The maximum number of applications that can be returned is 100.
- Parameters:
batchGetApplicationsRequest- Represents the input of aBatchGetApplicationsoperation.- Returns:
- Result of the BatchGetApplications operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
batchGetApplications
default BatchGetApplicationsResponse batchGetApplications(Consumer<BatchGetApplicationsRequest.Builder> batchGetApplicationsRequest) throws ApplicationNameRequiredException, InvalidApplicationNameException, ApplicationDoesNotExistException, BatchLimitExceededException, AwsServiceException, SdkClientException, CodeDeployException
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.Builderavoiding the need to create one manually viaBatchGetApplicationsRequest.builder()- Parameters:
batchGetApplicationsRequest- AConsumerthat will call methods onBatchGetApplicationsRequest.Builderto create a request. Represents the input of aBatchGetApplicationsoperation.- Returns:
- Result of the BatchGetApplications operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
batchGetDeploymentGroups
default BatchGetDeploymentGroupsResponse batchGetDeploymentGroups(BatchGetDeploymentGroupsRequest batchGetDeploymentGroupsRequest) throws ApplicationNameRequiredException, InvalidApplicationNameException, ApplicationDoesNotExistException, DeploymentGroupNameRequiredException, InvalidDeploymentGroupNameException, BatchLimitExceededException, DeploymentConfigDoesNotExistException, AwsServiceException, SdkClientException, CodeDeployException
Gets information about one or more deployment groups.
- Parameters:
batchGetDeploymentGroupsRequest- Represents the input of aBatchGetDeploymentGroupsoperation.- Returns:
- Result of the BatchGetDeploymentGroups operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
batchGetDeploymentGroups
default BatchGetDeploymentGroupsResponse batchGetDeploymentGroups(Consumer<BatchGetDeploymentGroupsRequest.Builder> batchGetDeploymentGroupsRequest) throws ApplicationNameRequiredException, InvalidApplicationNameException, ApplicationDoesNotExistException, DeploymentGroupNameRequiredException, InvalidDeploymentGroupNameException, BatchLimitExceededException, DeploymentConfigDoesNotExistException, AwsServiceException, SdkClientException, CodeDeployException
Gets information about one or more deployment groups.
This is a convenience which creates an instance of the
BatchGetDeploymentGroupsRequest.Builderavoiding the need to create one manually viaBatchGetDeploymentGroupsRequest.builder()- Parameters:
batchGetDeploymentGroupsRequest- AConsumerthat will call methods onBatchGetDeploymentGroupsRequest.Builderto create a request. Represents the input of aBatchGetDeploymentGroupsoperation.- Returns:
- Result of the BatchGetDeploymentGroups operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
batchGetDeploymentTargets
default BatchGetDeploymentTargetsResponse batchGetDeploymentTargets(BatchGetDeploymentTargetsRequest batchGetDeploymentTargetsRequest) throws InvalidDeploymentIdException, DeploymentIdRequiredException, DeploymentDoesNotExistException, DeploymentNotStartedException, DeploymentTargetIdRequiredException, InvalidDeploymentTargetIdException, DeploymentTargetDoesNotExistException, DeploymentTargetListSizeExceededException, AwsServiceException, SdkClientException, CodeDeployException
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:
- Result of the BatchGetDeploymentTargets operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
-
batchGetDeploymentTargets
default BatchGetDeploymentTargetsResponse batchGetDeploymentTargets(Consumer<BatchGetDeploymentTargetsRequest.Builder> batchGetDeploymentTargetsRequest) throws InvalidDeploymentIdException, DeploymentIdRequiredException, DeploymentDoesNotExistException, DeploymentNotStartedException, DeploymentTargetIdRequiredException, InvalidDeploymentTargetIdException, DeploymentTargetDoesNotExistException, DeploymentTargetListSizeExceededException, AwsServiceException, SdkClientException, CodeDeployException
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.Builderavoiding the need to create one manually viaBatchGetDeploymentTargetsRequest.builder()- Parameters:
batchGetDeploymentTargetsRequest- AConsumerthat will call methods onBatchGetDeploymentTargetsRequest.Builderto create a request.- Returns:
- Result of the BatchGetDeploymentTargets operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
-
batchGetDeployments
default BatchGetDeploymentsResponse batchGetDeployments(BatchGetDeploymentsRequest batchGetDeploymentsRequest) throws DeploymentIdRequiredException, InvalidDeploymentIdException, BatchLimitExceededException, AwsServiceException, SdkClientException, CodeDeployException
Gets information about one or more deployments. The maximum number of deployments that can be returned is 25.
- Parameters:
batchGetDeploymentsRequest- Represents the input of aBatchGetDeploymentsoperation.- Returns:
- Result of the BatchGetDeployments operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
batchGetDeployments
default BatchGetDeploymentsResponse batchGetDeployments(Consumer<BatchGetDeploymentsRequest.Builder> batchGetDeploymentsRequest) throws DeploymentIdRequiredException, InvalidDeploymentIdException, BatchLimitExceededException, AwsServiceException, SdkClientException, CodeDeployException
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.Builderavoiding the need to create one manually viaBatchGetDeploymentsRequest.builder()- Parameters:
batchGetDeploymentsRequest- AConsumerthat will call methods onBatchGetDeploymentsRequest.Builderto create a request. Represents the input of aBatchGetDeploymentsoperation.- Returns:
- Result of the BatchGetDeployments operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
batchGetOnPremisesInstances
default BatchGetOnPremisesInstancesResponse batchGetOnPremisesInstances(BatchGetOnPremisesInstancesRequest batchGetOnPremisesInstancesRequest) throws InstanceNameRequiredException, InvalidInstanceNameException, BatchLimitExceededException, AwsServiceException, SdkClientException, CodeDeployException
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 aBatchGetOnPremisesInstancesoperation.- Returns:
- Result of the BatchGetOnPremisesInstances operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
batchGetOnPremisesInstances
default BatchGetOnPremisesInstancesResponse batchGetOnPremisesInstances(Consumer<BatchGetOnPremisesInstancesRequest.Builder> batchGetOnPremisesInstancesRequest) throws InstanceNameRequiredException, InvalidInstanceNameException, BatchLimitExceededException, AwsServiceException, SdkClientException, CodeDeployException
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.Builderavoiding the need to create one manually viaBatchGetOnPremisesInstancesRequest.builder()- Parameters:
batchGetOnPremisesInstancesRequest- AConsumerthat will call methods onBatchGetOnPremisesInstancesRequest.Builderto create a request. Represents the input of aBatchGetOnPremisesInstancesoperation.- Returns:
- Result of the BatchGetOnPremisesInstances operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
continueDeployment
default ContinueDeploymentResponse continueDeployment(ContinueDeploymentRequest continueDeploymentRequest) throws DeploymentIdRequiredException, DeploymentDoesNotExistException, DeploymentAlreadyCompletedException, InvalidDeploymentIdException, DeploymentIsNotInReadyStateException, UnsupportedActionForDeploymentTypeException, InvalidDeploymentWaitTypeException, InvalidDeploymentStatusException, AwsServiceException, SdkClientException, CodeDeployException
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:
- Result of the ContinueDeployment operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
continueDeployment
default ContinueDeploymentResponse continueDeployment(Consumer<ContinueDeploymentRequest.Builder> continueDeploymentRequest) throws DeploymentIdRequiredException, DeploymentDoesNotExistException, DeploymentAlreadyCompletedException, InvalidDeploymentIdException, DeploymentIsNotInReadyStateException, UnsupportedActionForDeploymentTypeException, InvalidDeploymentWaitTypeException, InvalidDeploymentStatusException, AwsServiceException, SdkClientException, CodeDeployException
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.Builderavoiding the need to create one manually viaContinueDeploymentRequest.builder()- Parameters:
continueDeploymentRequest- AConsumerthat will call methods onContinueDeploymentRequest.Builderto create a request.- Returns:
- Result of the ContinueDeployment operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createApplication
default CreateApplicationResponse createApplication(CreateApplicationRequest createApplicationRequest) throws ApplicationNameRequiredException, InvalidApplicationNameException, ApplicationAlreadyExistsException, ApplicationLimitExceededException, InvalidComputePlatformException, InvalidTagsToAddException, AwsServiceException, SdkClientException, CodeDeployException
Creates an application.
- Parameters:
createApplicationRequest- Represents the input of aCreateApplicationoperation.- Returns:
- Result of the CreateApplication operation returned by the service.
- Throws:
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 beLambda,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.AwsServiceException- See Also:
- AWS API Documentation
-
createApplication
default CreateApplicationResponse createApplication(Consumer<CreateApplicationRequest.Builder> createApplicationRequest) throws ApplicationNameRequiredException, InvalidApplicationNameException, ApplicationAlreadyExistsException, ApplicationLimitExceededException, InvalidComputePlatformException, InvalidTagsToAddException, AwsServiceException, SdkClientException, CodeDeployException
Creates an application.
This is a convenience which creates an instance of the
CreateApplicationRequest.Builderavoiding the need to create one manually viaCreateApplicationRequest.builder()- Parameters:
createApplicationRequest- AConsumerthat will call methods onCreateApplicationRequest.Builderto create a request. Represents the input of aCreateApplicationoperation.- Returns:
- Result of the CreateApplication operation returned by the service.
- Throws:
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 beLambda,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.AwsServiceException- See Also:
- AWS API Documentation
-
createDeployment
default CreateDeploymentResponse createDeployment(CreateDeploymentRequest createDeploymentRequest) throws ApplicationNameRequiredException, InvalidApplicationNameException, ApplicationDoesNotExistException, DeploymentGroupNameRequiredException, InvalidDeploymentGroupNameException, DeploymentGroupDoesNotExistException, RevisionRequiredException, RevisionDoesNotExistException, InvalidRevisionException, InvalidDeploymentConfigNameException, DeploymentConfigDoesNotExistException, DescriptionTooLongException, DeploymentLimitExceededException, InvalidTargetInstancesException, InvalidAlarmConfigException, AlarmsLimitExceededException, InvalidAutoRollbackConfigException, InvalidLoadBalancerInfoException, InvalidFileExistsBehaviorException, InvalidRoleException, InvalidAutoScalingGroupException, ThrottlingException, InvalidUpdateOutdatedInstancesOnlyValueException, InvalidIgnoreApplicationStopFailuresValueException, InvalidGitHubAccountTokenException, InvalidTrafficRoutingConfigurationException, AwsServiceException, SdkClientException, CodeDeployException
Deploys an application revision through the specified deployment group.
- Parameters:
createDeploymentRequest- Represents the input of aCreateDeploymentoperation.- Returns:
- Result of the CreateDeployment operation returned by the service.
- Throws:
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,falseis expected. For EC2/On-premises deployments,trueorfalseis expected.InvalidIgnoreApplicationStopFailuresValueException- The IgnoreApplicationStopFailures value is invalid. For Lambda deployments,falseis expected. For EC2/On-premises deployments,trueorfalseis 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.AwsServiceException- See Also:
- AWS API Documentation
-
createDeployment
default CreateDeploymentResponse createDeployment(Consumer<CreateDeploymentRequest.Builder> createDeploymentRequest) throws ApplicationNameRequiredException, InvalidApplicationNameException, ApplicationDoesNotExistException, DeploymentGroupNameRequiredException, InvalidDeploymentGroupNameException, DeploymentGroupDoesNotExistException, RevisionRequiredException, RevisionDoesNotExistException, InvalidRevisionException, InvalidDeploymentConfigNameException, DeploymentConfigDoesNotExistException, DescriptionTooLongException, DeploymentLimitExceededException, InvalidTargetInstancesException, InvalidAlarmConfigException, AlarmsLimitExceededException, InvalidAutoRollbackConfigException, InvalidLoadBalancerInfoException, InvalidFileExistsBehaviorException, InvalidRoleException, InvalidAutoScalingGroupException, ThrottlingException, InvalidUpdateOutdatedInstancesOnlyValueException, InvalidIgnoreApplicationStopFailuresValueException, InvalidGitHubAccountTokenException, InvalidTrafficRoutingConfigurationException, AwsServiceException, SdkClientException, CodeDeployException
Deploys an application revision through the specified deployment group.
This is a convenience which creates an instance of the
CreateDeploymentRequest.Builderavoiding the need to create one manually viaCreateDeploymentRequest.builder()- Parameters:
createDeploymentRequest- AConsumerthat will call methods onCreateDeploymentRequest.Builderto create a request. Represents the input of aCreateDeploymentoperation.- Returns:
- Result of the CreateDeployment operation returned by the service.
- Throws:
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,falseis expected. For EC2/On-premises deployments,trueorfalseis expected.InvalidIgnoreApplicationStopFailuresValueException- The IgnoreApplicationStopFailures value is invalid. For Lambda deployments,falseis expected. For EC2/On-premises deployments,trueorfalseis 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.AwsServiceException- See Also:
- AWS API Documentation
-
createDeploymentConfig
default CreateDeploymentConfigResponse createDeploymentConfig(CreateDeploymentConfigRequest createDeploymentConfigRequest) throws InvalidDeploymentConfigNameException, DeploymentConfigNameRequiredException, DeploymentConfigAlreadyExistsException, InvalidMinimumHealthyHostValueException, DeploymentConfigLimitExceededException, InvalidComputePlatformException, InvalidTrafficRoutingConfigurationException, InvalidZonalDeploymentConfigurationException, AwsServiceException, SdkClientException, CodeDeployException
Creates a deployment configuration.
- Parameters:
createDeploymentConfigRequest- Represents the input of aCreateDeploymentConfigoperation.- Returns:
- Result of the CreateDeploymentConfig operation returned by the service.
- Throws:
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 beLambda,Server, orECS.InvalidTrafficRoutingConfigurationException- The configuration that specifies how traffic is routed during a deployment is invalid.InvalidZonalDeploymentConfigurationException- TheZonalConfigobject 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.AwsServiceException- See Also:
- AWS API Documentation
-
createDeploymentConfig
default CreateDeploymentConfigResponse createDeploymentConfig(Consumer<CreateDeploymentConfigRequest.Builder> createDeploymentConfigRequest) throws InvalidDeploymentConfigNameException, DeploymentConfigNameRequiredException, DeploymentConfigAlreadyExistsException, InvalidMinimumHealthyHostValueException, DeploymentConfigLimitExceededException, InvalidComputePlatformException, InvalidTrafficRoutingConfigurationException, InvalidZonalDeploymentConfigurationException, AwsServiceException, SdkClientException, CodeDeployException
Creates a deployment configuration.
This is a convenience which creates an instance of the
CreateDeploymentConfigRequest.Builderavoiding the need to create one manually viaCreateDeploymentConfigRequest.builder()- Parameters:
createDeploymentConfigRequest- AConsumerthat will call methods onCreateDeploymentConfigRequest.Builderto create a request. Represents the input of aCreateDeploymentConfigoperation.- Returns:
- Result of the CreateDeploymentConfig operation returned by the service.
- Throws:
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 beLambda,Server, orECS.InvalidTrafficRoutingConfigurationException- The configuration that specifies how traffic is routed during a deployment is invalid.InvalidZonalDeploymentConfigurationException- TheZonalConfigobject 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.AwsServiceException- See Also:
- AWS API Documentation
-
createDeploymentGroup
default CreateDeploymentGroupResponse createDeploymentGroup(CreateDeploymentGroupRequest createDeploymentGroupRequest) throws ApplicationNameRequiredException, InvalidApplicationNameException, ApplicationDoesNotExistException, DeploymentGroupNameRequiredException, InvalidDeploymentGroupNameException, DeploymentGroupAlreadyExistsException, InvalidEc2TagException, InvalidTagException, InvalidAutoScalingGroupException, InvalidDeploymentConfigNameException, DeploymentConfigDoesNotExistException, RoleRequiredException, InvalidRoleException, DeploymentGroupLimitExceededException, LifecycleHookLimitExceededException, InvalidTriggerConfigException, TriggerTargetsLimitExceededException, InvalidAlarmConfigException, AlarmsLimitExceededException, InvalidAutoRollbackConfigException, InvalidLoadBalancerInfoException, InvalidDeploymentStyleException, InvalidBlueGreenDeploymentConfigurationException, InvalidEc2TagCombinationException, InvalidOnPremisesTagCombinationException, TagSetListLimitExceededException, InvalidInputException, ThrottlingException, InvalidEcsServiceException, InvalidTargetGroupPairException, EcsServiceMappingLimitExceededException, InvalidTagsToAddException, InvalidTrafficRoutingConfigurationException, AwsServiceException, SdkClientException, CodeDeployException
Creates a deployment group to which application revisions are deployed.
- Parameters:
createDeploymentGroupRequest- Represents the input of aCreateDeploymentGroupoperation.- Returns:
- Result of the CreateDeploymentGroup operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createDeploymentGroup
default CreateDeploymentGroupResponse createDeploymentGroup(Consumer<CreateDeploymentGroupRequest.Builder> createDeploymentGroupRequest) throws ApplicationNameRequiredException, InvalidApplicationNameException, ApplicationDoesNotExistException, DeploymentGroupNameRequiredException, InvalidDeploymentGroupNameException, DeploymentGroupAlreadyExistsException, InvalidEc2TagException, InvalidTagException, InvalidAutoScalingGroupException, InvalidDeploymentConfigNameException, DeploymentConfigDoesNotExistException, RoleRequiredException, InvalidRoleException, DeploymentGroupLimitExceededException, LifecycleHookLimitExceededException, InvalidTriggerConfigException, TriggerTargetsLimitExceededException, InvalidAlarmConfigException, AlarmsLimitExceededException, InvalidAutoRollbackConfigException, InvalidLoadBalancerInfoException, InvalidDeploymentStyleException, InvalidBlueGreenDeploymentConfigurationException, InvalidEc2TagCombinationException, InvalidOnPremisesTagCombinationException, TagSetListLimitExceededException, InvalidInputException, ThrottlingException, InvalidEcsServiceException, InvalidTargetGroupPairException, EcsServiceMappingLimitExceededException, InvalidTagsToAddException, InvalidTrafficRoutingConfigurationException, AwsServiceException, SdkClientException, CodeDeployException
Creates a deployment group to which application revisions are deployed.
This is a convenience which creates an instance of the
CreateDeploymentGroupRequest.Builderavoiding the need to create one manually viaCreateDeploymentGroupRequest.builder()- Parameters:
createDeploymentGroupRequest- AConsumerthat will call methods onCreateDeploymentGroupRequest.Builderto create a request. Represents the input of aCreateDeploymentGroupoperation.- Returns:
- Result of the CreateDeploymentGroup operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteApplication
default DeleteApplicationResponse deleteApplication(DeleteApplicationRequest deleteApplicationRequest) throws ApplicationNameRequiredException, InvalidApplicationNameException, InvalidRoleException, AwsServiceException, SdkClientException, CodeDeployException
Deletes an application.
- Parameters:
deleteApplicationRequest- Represents the input of aDeleteApplicationoperation.- Returns:
- Result of the DeleteApplication operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteApplication
default DeleteApplicationResponse deleteApplication(Consumer<DeleteApplicationRequest.Builder> deleteApplicationRequest) throws ApplicationNameRequiredException, InvalidApplicationNameException, InvalidRoleException, AwsServiceException, SdkClientException, CodeDeployException
Deletes an application.
This is a convenience which creates an instance of the
DeleteApplicationRequest.Builderavoiding the need to create one manually viaDeleteApplicationRequest.builder()- Parameters:
deleteApplicationRequest- AConsumerthat will call methods onDeleteApplicationRequest.Builderto create a request. Represents the input of aDeleteApplicationoperation.- Returns:
- Result of the DeleteApplication operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteDeploymentConfig
default DeleteDeploymentConfigResponse deleteDeploymentConfig(DeleteDeploymentConfigRequest deleteDeploymentConfigRequest) throws InvalidDeploymentConfigNameException, DeploymentConfigNameRequiredException, DeploymentConfigInUseException, InvalidOperationException, AwsServiceException, SdkClientException, CodeDeployException
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 aDeleteDeploymentConfigoperation.- Returns:
- Result of the DeleteDeploymentConfig operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteDeploymentConfig
default DeleteDeploymentConfigResponse deleteDeploymentConfig(Consumer<DeleteDeploymentConfigRequest.Builder> deleteDeploymentConfigRequest) throws InvalidDeploymentConfigNameException, DeploymentConfigNameRequiredException, DeploymentConfigInUseException, InvalidOperationException, AwsServiceException, SdkClientException, CodeDeployException
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.Builderavoiding the need to create one manually viaDeleteDeploymentConfigRequest.builder()- Parameters:
deleteDeploymentConfigRequest- AConsumerthat will call methods onDeleteDeploymentConfigRequest.Builderto create a request. Represents the input of aDeleteDeploymentConfigoperation.- Returns:
- Result of the DeleteDeploymentConfig operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteDeploymentGroup
default DeleteDeploymentGroupResponse deleteDeploymentGroup(DeleteDeploymentGroupRequest deleteDeploymentGroupRequest) throws ApplicationNameRequiredException, InvalidApplicationNameException, DeploymentGroupNameRequiredException, InvalidDeploymentGroupNameException, InvalidRoleException, AwsServiceException, SdkClientException, CodeDeployException
Deletes a deployment group.
- Parameters:
deleteDeploymentGroupRequest- Represents the input of aDeleteDeploymentGroupoperation.- Returns:
- Result of the DeleteDeploymentGroup operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteDeploymentGroup
default DeleteDeploymentGroupResponse deleteDeploymentGroup(Consumer<DeleteDeploymentGroupRequest.Builder> deleteDeploymentGroupRequest) throws ApplicationNameRequiredException, InvalidApplicationNameException, DeploymentGroupNameRequiredException, InvalidDeploymentGroupNameException, InvalidRoleException, AwsServiceException, SdkClientException, CodeDeployException
Deletes a deployment group.
This is a convenience which creates an instance of the
DeleteDeploymentGroupRequest.Builderavoiding the need to create one manually viaDeleteDeploymentGroupRequest.builder()- Parameters:
deleteDeploymentGroupRequest- AConsumerthat will call methods onDeleteDeploymentGroupRequest.Builderto create a request. Represents the input of aDeleteDeploymentGroupoperation.- Returns:
- Result of the DeleteDeploymentGroup operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteGitHubAccountToken
default DeleteGitHubAccountTokenResponse deleteGitHubAccountToken(DeleteGitHubAccountTokenRequest deleteGitHubAccountTokenRequest) throws GitHubAccountTokenNameRequiredException, GitHubAccountTokenDoesNotExistException, InvalidGitHubAccountTokenNameException, ResourceValidationException, OperationNotSupportedException, AwsServiceException, SdkClientException, CodeDeployException
Deletes a GitHub account connection.
- Parameters:
deleteGitHubAccountTokenRequest- Represents the input of aDeleteGitHubAccountoperation.- Returns:
- Result of the DeleteGitHubAccountToken operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteGitHubAccountToken
default DeleteGitHubAccountTokenResponse deleteGitHubAccountToken(Consumer<DeleteGitHubAccountTokenRequest.Builder> deleteGitHubAccountTokenRequest) throws GitHubAccountTokenNameRequiredException, GitHubAccountTokenDoesNotExistException, InvalidGitHubAccountTokenNameException, ResourceValidationException, OperationNotSupportedException, AwsServiceException, SdkClientException, CodeDeployException
Deletes a GitHub account connection.
This is a convenience which creates an instance of the
DeleteGitHubAccountTokenRequest.Builderavoiding the need to create one manually viaDeleteGitHubAccountTokenRequest.builder()- Parameters:
deleteGitHubAccountTokenRequest- AConsumerthat will call methods onDeleteGitHubAccountTokenRequest.Builderto create a request. Represents the input of aDeleteGitHubAccountoperation.- Returns:
- Result of the DeleteGitHubAccountToken operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteResourcesByExternalId
default DeleteResourcesByExternalIdResponse deleteResourcesByExternalId(DeleteResourcesByExternalIdRequest deleteResourcesByExternalIdRequest) throws AwsServiceException, SdkClientException, CodeDeployException
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:
- Result of the DeleteResourcesByExternalId operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteResourcesByExternalId
default DeleteResourcesByExternalIdResponse deleteResourcesByExternalId(Consumer<DeleteResourcesByExternalIdRequest.Builder> deleteResourcesByExternalIdRequest) throws AwsServiceException, SdkClientException, CodeDeployException
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.Builderavoiding the need to create one manually viaDeleteResourcesByExternalIdRequest.builder()- Parameters:
deleteResourcesByExternalIdRequest- AConsumerthat will call methods onDeleteResourcesByExternalIdRequest.Builderto create a request.- Returns:
- Result of the DeleteResourcesByExternalId operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deregisterOnPremisesInstance
default DeregisterOnPremisesInstanceResponse deregisterOnPremisesInstance(DeregisterOnPremisesInstanceRequest deregisterOnPremisesInstanceRequest) throws InstanceNameRequiredException, InvalidInstanceNameException, AwsServiceException, SdkClientException, CodeDeployException
Deregisters an on-premises instance.
- Parameters:
deregisterOnPremisesInstanceRequest- Represents the input of aDeregisterOnPremisesInstanceoperation.- Returns:
- Result of the DeregisterOnPremisesInstance operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deregisterOnPremisesInstance
default DeregisterOnPremisesInstanceResponse deregisterOnPremisesInstance(Consumer<DeregisterOnPremisesInstanceRequest.Builder> deregisterOnPremisesInstanceRequest) throws InstanceNameRequiredException, InvalidInstanceNameException, AwsServiceException, SdkClientException, CodeDeployException
Deregisters an on-premises instance.
This is a convenience which creates an instance of the
DeregisterOnPremisesInstanceRequest.Builderavoiding the need to create one manually viaDeregisterOnPremisesInstanceRequest.builder()- Parameters:
deregisterOnPremisesInstanceRequest- AConsumerthat will call methods onDeregisterOnPremisesInstanceRequest.Builderto create a request. Represents the input of aDeregisterOnPremisesInstanceoperation.- Returns:
- Result of the DeregisterOnPremisesInstance operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getApplication
default GetApplicationResponse getApplication(GetApplicationRequest getApplicationRequest) throws ApplicationNameRequiredException, InvalidApplicationNameException, ApplicationDoesNotExistException, AwsServiceException, SdkClientException, CodeDeployException
Gets information about an application.
- Parameters:
getApplicationRequest- Represents the input of aGetApplicationoperation.- Returns:
- Result of the GetApplication operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getApplication
default GetApplicationResponse getApplication(Consumer<GetApplicationRequest.Builder> getApplicationRequest) throws ApplicationNameRequiredException, InvalidApplicationNameException, ApplicationDoesNotExistException, AwsServiceException, SdkClientException, CodeDeployException
Gets information about an application.
This is a convenience which creates an instance of the
GetApplicationRequest.Builderavoiding the need to create one manually viaGetApplicationRequest.builder()- Parameters:
getApplicationRequest- AConsumerthat will call methods onGetApplicationRequest.Builderto create a request. Represents the input of aGetApplicationoperation.- Returns:
- Result of the GetApplication operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getApplicationRevision
default GetApplicationRevisionResponse getApplicationRevision(GetApplicationRevisionRequest getApplicationRevisionRequest) throws ApplicationDoesNotExistException, ApplicationNameRequiredException, InvalidApplicationNameException, RevisionDoesNotExistException, RevisionRequiredException, InvalidRevisionException, AwsServiceException, SdkClientException, CodeDeployException
Gets information about an application revision.
- Parameters:
getApplicationRevisionRequest- Represents the input of aGetApplicationRevisionoperation.- Returns:
- Result of the GetApplicationRevision operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getApplicationRevision
default GetApplicationRevisionResponse getApplicationRevision(Consumer<GetApplicationRevisionRequest.Builder> getApplicationRevisionRequest) throws ApplicationDoesNotExistException, ApplicationNameRequiredException, InvalidApplicationNameException, RevisionDoesNotExistException, RevisionRequiredException, InvalidRevisionException, AwsServiceException, SdkClientException, CodeDeployException
Gets information about an application revision.
This is a convenience which creates an instance of the
GetApplicationRevisionRequest.Builderavoiding the need to create one manually viaGetApplicationRevisionRequest.builder()- Parameters:
getApplicationRevisionRequest- AConsumerthat will call methods onGetApplicationRevisionRequest.Builderto create a request. Represents the input of aGetApplicationRevisionoperation.- Returns:
- Result of the GetApplicationRevision operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getDeployment
default GetDeploymentResponse getDeployment(GetDeploymentRequest getDeploymentRequest) throws DeploymentIdRequiredException, InvalidDeploymentIdException, DeploymentDoesNotExistException, AwsServiceException, SdkClientException, CodeDeployException
Gets information about a deployment.
The
contentproperty of theappSpecContentobject in the returned revision is always null. UseGetApplicationRevisionand thesha256property of the returnedappSpecContentobject to get the content of the deployment’s AppSpec file.- Parameters:
getDeploymentRequest- Represents the input of aGetDeploymentoperation.- Returns:
- Result of the GetDeployment operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getDeployment
default GetDeploymentResponse getDeployment(Consumer<GetDeploymentRequest.Builder> getDeploymentRequest) throws DeploymentIdRequiredException, InvalidDeploymentIdException, DeploymentDoesNotExistException, AwsServiceException, SdkClientException, CodeDeployException
Gets information about a deployment.
The
contentproperty of theappSpecContentobject in the returned revision is always null. UseGetApplicationRevisionand thesha256property of the returnedappSpecContentobject to get the content of the deployment’s AppSpec file.
This is a convenience which creates an instance of the
GetDeploymentRequest.Builderavoiding the need to create one manually viaGetDeploymentRequest.builder()- Parameters:
getDeploymentRequest- AConsumerthat will call methods onGetDeploymentRequest.Builderto create a request. Represents the input of aGetDeploymentoperation.- Returns:
- Result of the GetDeployment operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getDeploymentConfig
default GetDeploymentConfigResponse getDeploymentConfig(GetDeploymentConfigRequest getDeploymentConfigRequest) throws InvalidDeploymentConfigNameException, DeploymentConfigNameRequiredException, DeploymentConfigDoesNotExistException, InvalidComputePlatformException, AwsServiceException, SdkClientException, CodeDeployException
Gets information about a deployment configuration.
- Parameters:
getDeploymentConfigRequest- Represents the input of aGetDeploymentConfigoperation.- Returns:
- Result of the GetDeploymentConfig operation returned by the service.
- Throws:
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 beLambda,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.AwsServiceException- See Also:
- AWS API Documentation
-
getDeploymentConfig
default GetDeploymentConfigResponse getDeploymentConfig(Consumer<GetDeploymentConfigRequest.Builder> getDeploymentConfigRequest) throws InvalidDeploymentConfigNameException, DeploymentConfigNameRequiredException, DeploymentConfigDoesNotExistException, InvalidComputePlatformException, AwsServiceException, SdkClientException, CodeDeployException
Gets information about a deployment configuration.
This is a convenience which creates an instance of the
GetDeploymentConfigRequest.Builderavoiding the need to create one manually viaGetDeploymentConfigRequest.builder()- Parameters:
getDeploymentConfigRequest- AConsumerthat will call methods onGetDeploymentConfigRequest.Builderto create a request. Represents the input of aGetDeploymentConfigoperation.- Returns:
- Result of the GetDeploymentConfig operation returned by the service.
- Throws:
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 beLambda,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.AwsServiceException- See Also:
- AWS API Documentation
-
getDeploymentGroup
default GetDeploymentGroupResponse getDeploymentGroup(GetDeploymentGroupRequest getDeploymentGroupRequest) throws ApplicationNameRequiredException, InvalidApplicationNameException, ApplicationDoesNotExistException, DeploymentGroupNameRequiredException, InvalidDeploymentGroupNameException, DeploymentGroupDoesNotExistException, DeploymentConfigDoesNotExistException, AwsServiceException, SdkClientException, CodeDeployException
Gets information about a deployment group.
- Parameters:
getDeploymentGroupRequest- Represents the input of aGetDeploymentGroupoperation.- Returns:
- Result of the GetDeploymentGroup operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getDeploymentGroup
default GetDeploymentGroupResponse getDeploymentGroup(Consumer<GetDeploymentGroupRequest.Builder> getDeploymentGroupRequest) throws ApplicationNameRequiredException, InvalidApplicationNameException, ApplicationDoesNotExistException, DeploymentGroupNameRequiredException, InvalidDeploymentGroupNameException, DeploymentGroupDoesNotExistException, DeploymentConfigDoesNotExistException, AwsServiceException, SdkClientException, CodeDeployException
Gets information about a deployment group.
This is a convenience which creates an instance of the
GetDeploymentGroupRequest.Builderavoiding the need to create one manually viaGetDeploymentGroupRequest.builder()- Parameters:
getDeploymentGroupRequest- AConsumerthat will call methods onGetDeploymentGroupRequest.Builderto create a request. Represents the input of aGetDeploymentGroupoperation.- Returns:
- Result of the GetDeploymentGroup operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getDeploymentTarget
default GetDeploymentTargetResponse getDeploymentTarget(GetDeploymentTargetRequest getDeploymentTargetRequest) throws InvalidDeploymentIdException, DeploymentIdRequiredException, DeploymentDoesNotExistException, DeploymentNotStartedException, DeploymentTargetIdRequiredException, InvalidDeploymentTargetIdException, DeploymentTargetDoesNotExistException, InvalidInstanceNameException, AwsServiceException, SdkClientException, CodeDeployException
Returns information about a deployment target.
- Parameters:
getDeploymentTargetRequest-- Returns:
- Result of the GetDeploymentTarget operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getDeploymentTarget
default GetDeploymentTargetResponse getDeploymentTarget(Consumer<GetDeploymentTargetRequest.Builder> getDeploymentTargetRequest) throws InvalidDeploymentIdException, DeploymentIdRequiredException, DeploymentDoesNotExistException, DeploymentNotStartedException, DeploymentTargetIdRequiredException, InvalidDeploymentTargetIdException, DeploymentTargetDoesNotExistException, InvalidInstanceNameException, AwsServiceException, SdkClientException, CodeDeployException
Returns information about a deployment target.
This is a convenience which creates an instance of the
GetDeploymentTargetRequest.Builderavoiding the need to create one manually viaGetDeploymentTargetRequest.builder()- Parameters:
getDeploymentTargetRequest- AConsumerthat will call methods onGetDeploymentTargetRequest.Builderto create a request.- Returns:
- Result of the GetDeploymentTarget operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getOnPremisesInstance
default GetOnPremisesInstanceResponse getOnPremisesInstance(GetOnPremisesInstanceRequest getOnPremisesInstanceRequest) throws InstanceNameRequiredException, InstanceNotRegisteredException, InvalidInstanceNameException, AwsServiceException, SdkClientException, CodeDeployException
Gets information about an on-premises instance.
- Parameters:
getOnPremisesInstanceRequest- Represents the input of aGetOnPremisesInstanceoperation.- Returns:
- Result of the GetOnPremisesInstance operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getOnPremisesInstance
default GetOnPremisesInstanceResponse getOnPremisesInstance(Consumer<GetOnPremisesInstanceRequest.Builder> getOnPremisesInstanceRequest) throws InstanceNameRequiredException, InstanceNotRegisteredException, InvalidInstanceNameException, AwsServiceException, SdkClientException, CodeDeployException
Gets information about an on-premises instance.
This is a convenience which creates an instance of the
GetOnPremisesInstanceRequest.Builderavoiding the need to create one manually viaGetOnPremisesInstanceRequest.builder()- Parameters:
getOnPremisesInstanceRequest- AConsumerthat will call methods onGetOnPremisesInstanceRequest.Builderto create a request. Represents the input of aGetOnPremisesInstanceoperation.- Returns:
- Result of the GetOnPremisesInstance operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listApplicationRevisions
default ListApplicationRevisionsResponse listApplicationRevisions(ListApplicationRevisionsRequest listApplicationRevisionsRequest) throws ApplicationDoesNotExistException, ApplicationNameRequiredException, InvalidApplicationNameException, InvalidSortByException, InvalidSortOrderException, InvalidBucketNameFilterException, InvalidKeyPrefixFilterException, BucketNameFilterRequiredException, InvalidDeployedStateFilterException, InvalidNextTokenException, AwsServiceException, SdkClientException, CodeDeployException
Lists information about revisions for an application.
- Parameters:
listApplicationRevisionsRequest- Represents the input of aListApplicationRevisionsoperation.- Returns:
- Result of the ListApplicationRevisions operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listApplicationRevisions
default ListApplicationRevisionsResponse listApplicationRevisions(Consumer<ListApplicationRevisionsRequest.Builder> listApplicationRevisionsRequest) throws ApplicationDoesNotExistException, ApplicationNameRequiredException, InvalidApplicationNameException, InvalidSortByException, InvalidSortOrderException, InvalidBucketNameFilterException, InvalidKeyPrefixFilterException, BucketNameFilterRequiredException, InvalidDeployedStateFilterException, InvalidNextTokenException, AwsServiceException, SdkClientException, CodeDeployException
Lists information about revisions for an application.
This is a convenience which creates an instance of the
ListApplicationRevisionsRequest.Builderavoiding the need to create one manually viaListApplicationRevisionsRequest.builder()- Parameters:
listApplicationRevisionsRequest- AConsumerthat will call methods onListApplicationRevisionsRequest.Builderto create a request. Represents the input of aListApplicationRevisionsoperation.- Returns:
- Result of the ListApplicationRevisions operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listApplicationRevisionsPaginator
default ListApplicationRevisionsIterable listApplicationRevisionsPaginator(ListApplicationRevisionsRequest listApplicationRevisionsRequest) throws ApplicationDoesNotExistException, ApplicationNameRequiredException, InvalidApplicationNameException, InvalidSortByException, InvalidSortOrderException, InvalidBucketNameFilterException, InvalidKeyPrefixFilterException, BucketNameFilterRequiredException, InvalidDeployedStateFilterException, InvalidNextTokenException, AwsServiceException, SdkClientException, CodeDeployException
This is a variant of
listApplicationRevisions(software.amazon.awssdk.services.codedeploy.model.ListApplicationRevisionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.codedeploy.paginators.ListApplicationRevisionsIterable responses = client.listApplicationRevisionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.codedeploy.paginators.ListApplicationRevisionsIterable responses = client .listApplicationRevisionsPaginator(request); for (software.amazon.awssdk.services.codedeploy.model.ListApplicationRevisionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.codedeploy.paginators.ListApplicationRevisionsIterable responses = client.listApplicationRevisionsPaginator(request); responses.iterator().forEachRemaining(....);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 aListApplicationRevisionsoperation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listApplicationRevisionsPaginator
default ListApplicationRevisionsIterable listApplicationRevisionsPaginator(Consumer<ListApplicationRevisionsRequest.Builder> listApplicationRevisionsRequest) throws ApplicationDoesNotExistException, ApplicationNameRequiredException, InvalidApplicationNameException, InvalidSortByException, InvalidSortOrderException, InvalidBucketNameFilterException, InvalidKeyPrefixFilterException, BucketNameFilterRequiredException, InvalidDeployedStateFilterException, InvalidNextTokenException, AwsServiceException, SdkClientException, CodeDeployException
This is a variant of
listApplicationRevisions(software.amazon.awssdk.services.codedeploy.model.ListApplicationRevisionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.codedeploy.paginators.ListApplicationRevisionsIterable responses = client.listApplicationRevisionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.codedeploy.paginators.ListApplicationRevisionsIterable responses = client .listApplicationRevisionsPaginator(request); for (software.amazon.awssdk.services.codedeploy.model.ListApplicationRevisionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.codedeploy.paginators.ListApplicationRevisionsIterable responses = client.listApplicationRevisionsPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListApplicationRevisionsRequest.builder()- Parameters:
listApplicationRevisionsRequest- AConsumerthat will call methods onListApplicationRevisionsRequest.Builderto create a request. Represents the input of aListApplicationRevisionsoperation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listApplications
default ListApplicationsResponse listApplications(ListApplicationsRequest listApplicationsRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, CodeDeployException
Lists the applications registered with the user or Amazon Web Services account.
- Parameters:
listApplicationsRequest- Represents the input of aListApplicationsoperation.- Returns:
- Result of the ListApplications operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listApplications
default ListApplicationsResponse listApplications(Consumer<ListApplicationsRequest.Builder> listApplicationsRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, CodeDeployException
Lists the applications registered with the user or Amazon Web Services account.
This is a convenience which creates an instance of the
ListApplicationsRequest.Builderavoiding the need to create one manually viaListApplicationsRequest.builder()- Parameters:
listApplicationsRequest- AConsumerthat will call methods onListApplicationsRequest.Builderto create a request. Represents the input of aListApplicationsoperation.- Returns:
- Result of the ListApplications operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listApplications
default ListApplicationsResponse listApplications() throws InvalidNextTokenException, AwsServiceException, SdkClientException, CodeDeployException
Lists the applications registered with the user or Amazon Web Services account.
- Returns:
- Result of the ListApplications operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
listApplications(ListApplicationsRequest), AWS API Documentation
-
listApplicationsPaginator
default ListApplicationsIterable listApplicationsPaginator() throws InvalidNextTokenException, AwsServiceException, SdkClientException, CodeDeployException
This is a variant of
listApplications(software.amazon.awssdk.services.codedeploy.model.ListApplicationsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.codedeploy.paginators.ListApplicationsIterable responses = client.listApplicationsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.codedeploy.paginators.ListApplicationsIterable responses = client .listApplicationsPaginator(request); for (software.amazon.awssdk.services.codedeploy.model.ListApplicationsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.codedeploy.paginators.ListApplicationsIterable responses = client.listApplicationsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
listApplicationsPaginator(ListApplicationsRequest), AWS API Documentation
-
listApplicationsPaginator
default ListApplicationsIterable listApplicationsPaginator(ListApplicationsRequest listApplicationsRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, CodeDeployException
This is a variant of
listApplications(software.amazon.awssdk.services.codedeploy.model.ListApplicationsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.codedeploy.paginators.ListApplicationsIterable responses = client.listApplicationsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.codedeploy.paginators.ListApplicationsIterable responses = client .listApplicationsPaginator(request); for (software.amazon.awssdk.services.codedeploy.model.ListApplicationsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.codedeploy.paginators.ListApplicationsIterable responses = client.listApplicationsPaginator(request); responses.iterator().forEachRemaining(....);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 aListApplicationsoperation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listApplicationsPaginator
default ListApplicationsIterable listApplicationsPaginator(Consumer<ListApplicationsRequest.Builder> listApplicationsRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, CodeDeployException
This is a variant of
listApplications(software.amazon.awssdk.services.codedeploy.model.ListApplicationsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.codedeploy.paginators.ListApplicationsIterable responses = client.listApplicationsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.codedeploy.paginators.ListApplicationsIterable responses = client .listApplicationsPaginator(request); for (software.amazon.awssdk.services.codedeploy.model.ListApplicationsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.codedeploy.paginators.ListApplicationsIterable responses = client.listApplicationsPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListApplicationsRequest.builder()- Parameters:
listApplicationsRequest- AConsumerthat will call methods onListApplicationsRequest.Builderto create a request. Represents the input of aListApplicationsoperation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listDeploymentConfigs
default ListDeploymentConfigsResponse listDeploymentConfigs(ListDeploymentConfigsRequest listDeploymentConfigsRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, CodeDeployException
Lists the deployment configurations with the user or Amazon Web Services account.
- Parameters:
listDeploymentConfigsRequest- Represents the input of aListDeploymentConfigsoperation.- Returns:
- Result of the ListDeploymentConfigs operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listDeploymentConfigs
default ListDeploymentConfigsResponse listDeploymentConfigs(Consumer<ListDeploymentConfigsRequest.Builder> listDeploymentConfigsRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, CodeDeployException
Lists the deployment configurations with the user or Amazon Web Services account.
This is a convenience which creates an instance of the
ListDeploymentConfigsRequest.Builderavoiding the need to create one manually viaListDeploymentConfigsRequest.builder()- Parameters:
listDeploymentConfigsRequest- AConsumerthat will call methods onListDeploymentConfigsRequest.Builderto create a request. Represents the input of aListDeploymentConfigsoperation.- Returns:
- Result of the ListDeploymentConfigs operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listDeploymentConfigs
default ListDeploymentConfigsResponse listDeploymentConfigs() throws InvalidNextTokenException, AwsServiceException, SdkClientException, CodeDeployException
Lists the deployment configurations with the user or Amazon Web Services account.
- Returns:
- Result of the ListDeploymentConfigs operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
listDeploymentConfigs(ListDeploymentConfigsRequest), AWS API Documentation
-
listDeploymentConfigsPaginator
default ListDeploymentConfigsIterable listDeploymentConfigsPaginator() throws InvalidNextTokenException, AwsServiceException, SdkClientException, CodeDeployException
This is a variant of
listDeploymentConfigs(software.amazon.awssdk.services.codedeploy.model.ListDeploymentConfigsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.codedeploy.paginators.ListDeploymentConfigsIterable responses = client.listDeploymentConfigsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.codedeploy.paginators.ListDeploymentConfigsIterable responses = client .listDeploymentConfigsPaginator(request); for (software.amazon.awssdk.services.codedeploy.model.ListDeploymentConfigsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.codedeploy.paginators.ListDeploymentConfigsIterable responses = client.listDeploymentConfigsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
listDeploymentConfigsPaginator(ListDeploymentConfigsRequest), AWS API Documentation
-
listDeploymentConfigsPaginator
default ListDeploymentConfigsIterable listDeploymentConfigsPaginator(ListDeploymentConfigsRequest listDeploymentConfigsRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, CodeDeployException
This is a variant of
listDeploymentConfigs(software.amazon.awssdk.services.codedeploy.model.ListDeploymentConfigsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.codedeploy.paginators.ListDeploymentConfigsIterable responses = client.listDeploymentConfigsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.codedeploy.paginators.ListDeploymentConfigsIterable responses = client .listDeploymentConfigsPaginator(request); for (software.amazon.awssdk.services.codedeploy.model.ListDeploymentConfigsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.codedeploy.paginators.ListDeploymentConfigsIterable responses = client.listDeploymentConfigsPaginator(request); responses.iterator().forEachRemaining(....);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 aListDeploymentConfigsoperation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listDeploymentConfigsPaginator
default ListDeploymentConfigsIterable listDeploymentConfigsPaginator(Consumer<ListDeploymentConfigsRequest.Builder> listDeploymentConfigsRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, CodeDeployException
This is a variant of
listDeploymentConfigs(software.amazon.awssdk.services.codedeploy.model.ListDeploymentConfigsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.codedeploy.paginators.ListDeploymentConfigsIterable responses = client.listDeploymentConfigsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.codedeploy.paginators.ListDeploymentConfigsIterable responses = client .listDeploymentConfigsPaginator(request); for (software.amazon.awssdk.services.codedeploy.model.ListDeploymentConfigsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.codedeploy.paginators.ListDeploymentConfigsIterable responses = client.listDeploymentConfigsPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListDeploymentConfigsRequest.builder()- Parameters:
listDeploymentConfigsRequest- AConsumerthat will call methods onListDeploymentConfigsRequest.Builderto create a request. Represents the input of aListDeploymentConfigsoperation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listDeploymentGroups
default ListDeploymentGroupsResponse listDeploymentGroups(ListDeploymentGroupsRequest listDeploymentGroupsRequest) throws ApplicationNameRequiredException, InvalidApplicationNameException, ApplicationDoesNotExistException, InvalidNextTokenException, AwsServiceException, SdkClientException, CodeDeployException
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 aListDeploymentGroupsoperation.- Returns:
- Result of the ListDeploymentGroups operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listDeploymentGroups
default ListDeploymentGroupsResponse listDeploymentGroups(Consumer<ListDeploymentGroupsRequest.Builder> listDeploymentGroupsRequest) throws ApplicationNameRequiredException, InvalidApplicationNameException, ApplicationDoesNotExistException, InvalidNextTokenException, AwsServiceException, SdkClientException, CodeDeployException
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.Builderavoiding the need to create one manually viaListDeploymentGroupsRequest.builder()- Parameters:
listDeploymentGroupsRequest- AConsumerthat will call methods onListDeploymentGroupsRequest.Builderto create a request. Represents the input of aListDeploymentGroupsoperation.- Returns:
- Result of the ListDeploymentGroups operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listDeploymentGroupsPaginator
default ListDeploymentGroupsIterable listDeploymentGroupsPaginator(ListDeploymentGroupsRequest listDeploymentGroupsRequest) throws ApplicationNameRequiredException, InvalidApplicationNameException, ApplicationDoesNotExistException, InvalidNextTokenException, AwsServiceException, SdkClientException, CodeDeployException
This is a variant of
listDeploymentGroups(software.amazon.awssdk.services.codedeploy.model.ListDeploymentGroupsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.codedeploy.paginators.ListDeploymentGroupsIterable responses = client.listDeploymentGroupsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.codedeploy.paginators.ListDeploymentGroupsIterable responses = client .listDeploymentGroupsPaginator(request); for (software.amazon.awssdk.services.codedeploy.model.ListDeploymentGroupsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.codedeploy.paginators.ListDeploymentGroupsIterable responses = client.listDeploymentGroupsPaginator(request); responses.iterator().forEachRemaining(....);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 aListDeploymentGroupsoperation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listDeploymentGroupsPaginator
default ListDeploymentGroupsIterable listDeploymentGroupsPaginator(Consumer<ListDeploymentGroupsRequest.Builder> listDeploymentGroupsRequest) throws ApplicationNameRequiredException, InvalidApplicationNameException, ApplicationDoesNotExistException, InvalidNextTokenException, AwsServiceException, SdkClientException, CodeDeployException
This is a variant of
listDeploymentGroups(software.amazon.awssdk.services.codedeploy.model.ListDeploymentGroupsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.codedeploy.paginators.ListDeploymentGroupsIterable responses = client.listDeploymentGroupsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.codedeploy.paginators.ListDeploymentGroupsIterable responses = client .listDeploymentGroupsPaginator(request); for (software.amazon.awssdk.services.codedeploy.model.ListDeploymentGroupsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.codedeploy.paginators.ListDeploymentGroupsIterable responses = client.listDeploymentGroupsPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListDeploymentGroupsRequest.builder()- Parameters:
listDeploymentGroupsRequest- AConsumerthat will call methods onListDeploymentGroupsRequest.Builderto create a request. Represents the input of aListDeploymentGroupsoperation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listDeploymentTargets
default ListDeploymentTargetsResponse listDeploymentTargets(ListDeploymentTargetsRequest listDeploymentTargetsRequest) throws DeploymentIdRequiredException, DeploymentDoesNotExistException, DeploymentNotStartedException, InvalidNextTokenException, InvalidDeploymentIdException, InvalidInstanceStatusException, InvalidInstanceTypeException, InvalidDeploymentInstanceTypeException, InvalidTargetFilterNameException, AwsServiceException, SdkClientException, CodeDeployException
Returns an array of target IDs that are associated a deployment.
- Parameters:
listDeploymentTargetsRequest-- Returns:
- Result of the ListDeploymentTargets operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listDeploymentTargets
default ListDeploymentTargetsResponse listDeploymentTargets(Consumer<ListDeploymentTargetsRequest.Builder> listDeploymentTargetsRequest) throws DeploymentIdRequiredException, DeploymentDoesNotExistException, DeploymentNotStartedException, InvalidNextTokenException, InvalidDeploymentIdException, InvalidInstanceStatusException, InvalidInstanceTypeException, InvalidDeploymentInstanceTypeException, InvalidTargetFilterNameException, AwsServiceException, SdkClientException, CodeDeployException
Returns an array of target IDs that are associated a deployment.
This is a convenience which creates an instance of the
ListDeploymentTargetsRequest.Builderavoiding the need to create one manually viaListDeploymentTargetsRequest.builder()- Parameters:
listDeploymentTargetsRequest- AConsumerthat will call methods onListDeploymentTargetsRequest.Builderto create a request.- Returns:
- Result of the ListDeploymentTargets operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listDeployments
default ListDeploymentsResponse listDeployments(ListDeploymentsRequest listDeploymentsRequest) throws ApplicationNameRequiredException, InvalidApplicationNameException, ApplicationDoesNotExistException, InvalidDeploymentGroupNameException, DeploymentGroupDoesNotExistException, DeploymentGroupNameRequiredException, InvalidTimeRangeException, InvalidDeploymentStatusException, InvalidNextTokenException, InvalidExternalIdException, InvalidInputException, AwsServiceException, SdkClientException, CodeDeployException
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 aListDeploymentsoperation.- Returns:
- Result of the ListDeployments operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listDeployments
default ListDeploymentsResponse listDeployments(Consumer<ListDeploymentsRequest.Builder> listDeploymentsRequest) throws ApplicationNameRequiredException, InvalidApplicationNameException, ApplicationDoesNotExistException, InvalidDeploymentGroupNameException, DeploymentGroupDoesNotExistException, DeploymentGroupNameRequiredException, InvalidTimeRangeException, InvalidDeploymentStatusException, InvalidNextTokenException, InvalidExternalIdException, InvalidInputException, AwsServiceException, SdkClientException, CodeDeployException
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.Builderavoiding the need to create one manually viaListDeploymentsRequest.builder()- Parameters:
listDeploymentsRequest- AConsumerthat will call methods onListDeploymentsRequest.Builderto create a request. Represents the input of aListDeploymentsoperation.- Returns:
- Result of the ListDeployments operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listDeployments
default ListDeploymentsResponse listDeployments() throws ApplicationNameRequiredException, InvalidApplicationNameException, ApplicationDoesNotExistException, InvalidDeploymentGroupNameException, DeploymentGroupDoesNotExistException, DeploymentGroupNameRequiredException, InvalidTimeRangeException, InvalidDeploymentStatusException, InvalidNextTokenException, InvalidExternalIdException, InvalidInputException, AwsServiceException, SdkClientException, CodeDeployException
Lists the deployments in a deployment group for an application registered with the user or Amazon Web Services account.
- Returns:
- Result of the ListDeployments operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
listDeployments(ListDeploymentsRequest), AWS API Documentation
-
listDeploymentsPaginator
default ListDeploymentsIterable listDeploymentsPaginator() throws ApplicationNameRequiredException, InvalidApplicationNameException, ApplicationDoesNotExistException, InvalidDeploymentGroupNameException, DeploymentGroupDoesNotExistException, DeploymentGroupNameRequiredException, InvalidTimeRangeException, InvalidDeploymentStatusException, InvalidNextTokenException, InvalidExternalIdException, InvalidInputException, AwsServiceException, SdkClientException, CodeDeployException
This is a variant of
listDeployments(software.amazon.awssdk.services.codedeploy.model.ListDeploymentsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.codedeploy.paginators.ListDeploymentsIterable responses = client.listDeploymentsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.codedeploy.paginators.ListDeploymentsIterable responses = client .listDeploymentsPaginator(request); for (software.amazon.awssdk.services.codedeploy.model.ListDeploymentsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.codedeploy.paginators.ListDeploymentsIterable responses = client.listDeploymentsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
listDeploymentsPaginator(ListDeploymentsRequest), AWS API Documentation
-
listDeploymentsPaginator
default ListDeploymentsIterable listDeploymentsPaginator(ListDeploymentsRequest listDeploymentsRequest) throws ApplicationNameRequiredException, InvalidApplicationNameException, ApplicationDoesNotExistException, InvalidDeploymentGroupNameException, DeploymentGroupDoesNotExistException, DeploymentGroupNameRequiredException, InvalidTimeRangeException, InvalidDeploymentStatusException, InvalidNextTokenException, InvalidExternalIdException, InvalidInputException, AwsServiceException, SdkClientException, CodeDeployException
This is a variant of
listDeployments(software.amazon.awssdk.services.codedeploy.model.ListDeploymentsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.codedeploy.paginators.ListDeploymentsIterable responses = client.listDeploymentsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.codedeploy.paginators.ListDeploymentsIterable responses = client .listDeploymentsPaginator(request); for (software.amazon.awssdk.services.codedeploy.model.ListDeploymentsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.codedeploy.paginators.ListDeploymentsIterable responses = client.listDeploymentsPaginator(request); responses.iterator().forEachRemaining(....);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 aListDeploymentsoperation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listDeploymentsPaginator
default ListDeploymentsIterable listDeploymentsPaginator(Consumer<ListDeploymentsRequest.Builder> listDeploymentsRequest) throws ApplicationNameRequiredException, InvalidApplicationNameException, ApplicationDoesNotExistException, InvalidDeploymentGroupNameException, DeploymentGroupDoesNotExistException, DeploymentGroupNameRequiredException, InvalidTimeRangeException, InvalidDeploymentStatusException, InvalidNextTokenException, InvalidExternalIdException, InvalidInputException, AwsServiceException, SdkClientException, CodeDeployException
This is a variant of
listDeployments(software.amazon.awssdk.services.codedeploy.model.ListDeploymentsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.codedeploy.paginators.ListDeploymentsIterable responses = client.listDeploymentsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.codedeploy.paginators.ListDeploymentsIterable responses = client .listDeploymentsPaginator(request); for (software.amazon.awssdk.services.codedeploy.model.ListDeploymentsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.codedeploy.paginators.ListDeploymentsIterable responses = client.listDeploymentsPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListDeploymentsRequest.builder()- Parameters:
listDeploymentsRequest- AConsumerthat will call methods onListDeploymentsRequest.Builderto create a request. Represents the input of aListDeploymentsoperation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listGitHubAccountTokenNames
default ListGitHubAccountTokenNamesResponse listGitHubAccountTokenNames(ListGitHubAccountTokenNamesRequest listGitHubAccountTokenNamesRequest) throws InvalidNextTokenException, ResourceValidationException, OperationNotSupportedException, AwsServiceException, SdkClientException, CodeDeployException
Lists the names of stored connections to GitHub accounts.
- Parameters:
listGitHubAccountTokenNamesRequest- Represents the input of aListGitHubAccountTokenNamesoperation.- Returns:
- Result of the ListGitHubAccountTokenNames operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listGitHubAccountTokenNames
default ListGitHubAccountTokenNamesResponse listGitHubAccountTokenNames(Consumer<ListGitHubAccountTokenNamesRequest.Builder> listGitHubAccountTokenNamesRequest) throws InvalidNextTokenException, ResourceValidationException, OperationNotSupportedException, AwsServiceException, SdkClientException, CodeDeployException
Lists the names of stored connections to GitHub accounts.
This is a convenience which creates an instance of the
ListGitHubAccountTokenNamesRequest.Builderavoiding the need to create one manually viaListGitHubAccountTokenNamesRequest.builder()- Parameters:
listGitHubAccountTokenNamesRequest- AConsumerthat will call methods onListGitHubAccountTokenNamesRequest.Builderto create a request. Represents the input of aListGitHubAccountTokenNamesoperation.- Returns:
- Result of the ListGitHubAccountTokenNames operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listGitHubAccountTokenNames
default ListGitHubAccountTokenNamesResponse listGitHubAccountTokenNames() throws InvalidNextTokenException, ResourceValidationException, OperationNotSupportedException, AwsServiceException, SdkClientException, CodeDeployException
Lists the names of stored connections to GitHub accounts.
- Returns:
- Result of the ListGitHubAccountTokenNames operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
listGitHubAccountTokenNames(ListGitHubAccountTokenNamesRequest), AWS API Documentation
-
listOnPremisesInstances
default ListOnPremisesInstancesResponse listOnPremisesInstances(ListOnPremisesInstancesRequest listOnPremisesInstancesRequest) throws InvalidRegistrationStatusException, InvalidTagFilterException, InvalidNextTokenException, AwsServiceException, SdkClientException, CodeDeployException
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 aListOnPremisesInstancesoperation.- Returns:
- Result of the ListOnPremisesInstances operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listOnPremisesInstances
default ListOnPremisesInstancesResponse listOnPremisesInstances(Consumer<ListOnPremisesInstancesRequest.Builder> listOnPremisesInstancesRequest) throws InvalidRegistrationStatusException, InvalidTagFilterException, InvalidNextTokenException, AwsServiceException, SdkClientException, CodeDeployException
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.Builderavoiding the need to create one manually viaListOnPremisesInstancesRequest.builder()- Parameters:
listOnPremisesInstancesRequest- AConsumerthat will call methods onListOnPremisesInstancesRequest.Builderto create a request. Represents the input of aListOnPremisesInstancesoperation.- Returns:
- Result of the ListOnPremisesInstances operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listOnPremisesInstances
default ListOnPremisesInstancesResponse listOnPremisesInstances() throws InvalidRegistrationStatusException, InvalidTagFilterException, InvalidNextTokenException, AwsServiceException, SdkClientException, CodeDeployException
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:
- Result of the ListOnPremisesInstances operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
listOnPremisesInstances(ListOnPremisesInstancesRequest), AWS API Documentation
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws ArnNotSupportedException, InvalidArnException, ResourceArnRequiredException, AwsServiceException, SdkClientException, CodeDeployException
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:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws ArnNotSupportedException, InvalidArnException, ResourceArnRequiredException, AwsServiceException, SdkClientException, CodeDeployException
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.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
putLifecycleEventHookExecutionStatus
default PutLifecycleEventHookExecutionStatusResponse putLifecycleEventHookExecutionStatus(PutLifecycleEventHookExecutionStatusRequest putLifecycleEventHookExecutionStatusRequest) throws InvalidLifecycleEventHookExecutionStatusException, InvalidLifecycleEventHookExecutionIdException, LifecycleEventAlreadyCompletedException, DeploymentIdRequiredException, DeploymentDoesNotExistException, InvalidDeploymentIdException, UnsupportedActionForDeploymentTypeException, AwsServiceException, SdkClientException, CodeDeployException
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
BeforeAllowTrafficandAfterAllowTraffic. For Amazon ECS deployments, the available lifecycle hooks areBeforeInstall,AfterInstall,AfterAllowTestTraffic,BeforeAllowTraffic, andAfterAllowTraffic. Lambda validation functions returnSucceededorFailed. For more information, see AppSpec 'hooks' Section for an Lambda Deployment and AppSpec 'hooks' Section for an Amazon ECS Deployment.- Parameters:
putLifecycleEventHookExecutionStatusRequest-- Returns:
- Result of the PutLifecycleEventHookExecutionStatus operation returned by the service.
- Throws:
InvalidLifecycleEventHookExecutionStatusException- The result of a Lambda validation function that verifies a lifecycle event is invalid. It should returnSucceededorFailed.InvalidLifecycleEventHookExecutionIdException- A lifecycle event hook is invalid. Review thehookssection in your AppSpec file to ensure the lifecycle events andhooksfunctions 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.AwsServiceException- See Also:
- AWS API Documentation
-
putLifecycleEventHookExecutionStatus
default PutLifecycleEventHookExecutionStatusResponse putLifecycleEventHookExecutionStatus(Consumer<PutLifecycleEventHookExecutionStatusRequest.Builder> putLifecycleEventHookExecutionStatusRequest) throws InvalidLifecycleEventHookExecutionStatusException, InvalidLifecycleEventHookExecutionIdException, LifecycleEventAlreadyCompletedException, DeploymentIdRequiredException, DeploymentDoesNotExistException, InvalidDeploymentIdException, UnsupportedActionForDeploymentTypeException, AwsServiceException, SdkClientException, CodeDeployException
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
BeforeAllowTrafficandAfterAllowTraffic. For Amazon ECS deployments, the available lifecycle hooks areBeforeInstall,AfterInstall,AfterAllowTestTraffic,BeforeAllowTraffic, andAfterAllowTraffic. Lambda validation functions returnSucceededorFailed. 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.Builderavoiding the need to create one manually viaPutLifecycleEventHookExecutionStatusRequest.builder()- Parameters:
putLifecycleEventHookExecutionStatusRequest- AConsumerthat will call methods onPutLifecycleEventHookExecutionStatusRequest.Builderto create a request.- Returns:
- Result of the PutLifecycleEventHookExecutionStatus operation returned by the service.
- Throws:
InvalidLifecycleEventHookExecutionStatusException- The result of a Lambda validation function that verifies a lifecycle event is invalid. It should returnSucceededorFailed.InvalidLifecycleEventHookExecutionIdException- A lifecycle event hook is invalid. Review thehookssection in your AppSpec file to ensure the lifecycle events andhooksfunctions 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.AwsServiceException- See Also:
- AWS API Documentation
-
registerApplicationRevision
default RegisterApplicationRevisionResponse registerApplicationRevision(RegisterApplicationRevisionRequest registerApplicationRevisionRequest) throws ApplicationDoesNotExistException, ApplicationNameRequiredException, InvalidApplicationNameException, DescriptionTooLongException, RevisionRequiredException, InvalidRevisionException, AwsServiceException, SdkClientException, CodeDeployException
Registers with CodeDeploy a revision for the specified application.
- Parameters:
registerApplicationRevisionRequest- Represents the input of a RegisterApplicationRevision operation.- Returns:
- Result of the RegisterApplicationRevision operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
registerApplicationRevision
default RegisterApplicationRevisionResponse registerApplicationRevision(Consumer<RegisterApplicationRevisionRequest.Builder> registerApplicationRevisionRequest) throws ApplicationDoesNotExistException, ApplicationNameRequiredException, InvalidApplicationNameException, DescriptionTooLongException, RevisionRequiredException, InvalidRevisionException, AwsServiceException, SdkClientException, CodeDeployException
Registers with CodeDeploy a revision for the specified application.
This is a convenience which creates an instance of the
RegisterApplicationRevisionRequest.Builderavoiding the need to create one manually viaRegisterApplicationRevisionRequest.builder()- Parameters:
registerApplicationRevisionRequest- AConsumerthat will call methods onRegisterApplicationRevisionRequest.Builderto create a request. Represents the input of a RegisterApplicationRevision operation.- Returns:
- Result of the RegisterApplicationRevision operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
registerOnPremisesInstance
default RegisterOnPremisesInstanceResponse registerOnPremisesInstance(RegisterOnPremisesInstanceRequest registerOnPremisesInstanceRequest) throws InstanceNameAlreadyRegisteredException, IamArnRequiredException, IamSessionArnAlreadyRegisteredException, IamUserArnAlreadyRegisteredException, InstanceNameRequiredException, IamUserArnRequiredException, InvalidInstanceNameException, InvalidIamSessionArnException, InvalidIamUserArnException, MultipleIamArnsProvidedException, AwsServiceException, SdkClientException, CodeDeployException
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:
- Result of the RegisterOnPremisesInstance operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
registerOnPremisesInstance
default RegisterOnPremisesInstanceResponse registerOnPremisesInstance(Consumer<RegisterOnPremisesInstanceRequest.Builder> registerOnPremisesInstanceRequest) throws InstanceNameAlreadyRegisteredException, IamArnRequiredException, IamSessionArnAlreadyRegisteredException, IamUserArnAlreadyRegisteredException, InstanceNameRequiredException, IamUserArnRequiredException, InvalidInstanceNameException, InvalidIamSessionArnException, InvalidIamUserArnException, MultipleIamArnsProvidedException, AwsServiceException, SdkClientException, CodeDeployException
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.Builderavoiding the need to create one manually viaRegisterOnPremisesInstanceRequest.builder()- Parameters:
registerOnPremisesInstanceRequest- AConsumerthat will call methods onRegisterOnPremisesInstanceRequest.Builderto create a request. Represents the input of the register on-premises instance operation.- Returns:
- Result of the RegisterOnPremisesInstance operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
removeTagsFromOnPremisesInstances
default RemoveTagsFromOnPremisesInstancesResponse removeTagsFromOnPremisesInstances(RemoveTagsFromOnPremisesInstancesRequest removeTagsFromOnPremisesInstancesRequest) throws InstanceNameRequiredException, InvalidInstanceNameException, TagRequiredException, InvalidTagException, TagLimitExceededException, InstanceLimitExceededException, InstanceNotRegisteredException, AwsServiceException, SdkClientException, CodeDeployException
Removes one or more tags from one or more on-premises instances.
- Parameters:
removeTagsFromOnPremisesInstancesRequest- Represents the input of aRemoveTagsFromOnPremisesInstancesoperation.- Returns:
- Result of the RemoveTagsFromOnPremisesInstances operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
removeTagsFromOnPremisesInstances
default RemoveTagsFromOnPremisesInstancesResponse removeTagsFromOnPremisesInstances(Consumer<RemoveTagsFromOnPremisesInstancesRequest.Builder> removeTagsFromOnPremisesInstancesRequest) throws InstanceNameRequiredException, InvalidInstanceNameException, TagRequiredException, InvalidTagException, TagLimitExceededException, InstanceLimitExceededException, InstanceNotRegisteredException, AwsServiceException, SdkClientException, CodeDeployException
Removes one or more tags from one or more on-premises instances.
This is a convenience which creates an instance of the
RemoveTagsFromOnPremisesInstancesRequest.Builderavoiding the need to create one manually viaRemoveTagsFromOnPremisesInstancesRequest.builder()- Parameters:
removeTagsFromOnPremisesInstancesRequest- AConsumerthat will call methods onRemoveTagsFromOnPremisesInstancesRequest.Builderto create a request. Represents the input of aRemoveTagsFromOnPremisesInstancesoperation.- Returns:
- Result of the RemoveTagsFromOnPremisesInstances operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
stopDeployment
default StopDeploymentResponse stopDeployment(StopDeploymentRequest stopDeploymentRequest) throws DeploymentIdRequiredException, DeploymentDoesNotExistException, DeploymentGroupDoesNotExistException, DeploymentAlreadyCompletedException, InvalidDeploymentIdException, UnsupportedActionForDeploymentTypeException, AwsServiceException, SdkClientException, CodeDeployException
Attempts to stop an ongoing deployment.
- Parameters:
stopDeploymentRequest- Represents the input of aStopDeploymentoperation.- Returns:
- Result of the StopDeployment operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
stopDeployment
default StopDeploymentResponse stopDeployment(Consumer<StopDeploymentRequest.Builder> stopDeploymentRequest) throws DeploymentIdRequiredException, DeploymentDoesNotExistException, DeploymentGroupDoesNotExistException, DeploymentAlreadyCompletedException, InvalidDeploymentIdException, UnsupportedActionForDeploymentTypeException, AwsServiceException, SdkClientException, CodeDeployException
Attempts to stop an ongoing deployment.
This is a convenience which creates an instance of the
StopDeploymentRequest.Builderavoiding the need to create one manually viaStopDeploymentRequest.builder()- Parameters:
stopDeploymentRequest- AConsumerthat will call methods onStopDeploymentRequest.Builderto create a request. Represents the input of aStopDeploymentoperation.- Returns:
- Result of the StopDeployment operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws ResourceArnRequiredException, ApplicationDoesNotExistException, DeploymentGroupDoesNotExistException, DeploymentConfigDoesNotExistException, TagRequiredException, InvalidTagsToAddException, ArnNotSupportedException, InvalidArnException, AwsServiceException, SdkClientException, CodeDeployException
Associates the list of tags in the input
Tagsparameter with the resource identified by theResourceArninput parameter.- Parameters:
tagResourceRequest-- Returns:
- Result of the TagResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws ResourceArnRequiredException, ApplicationDoesNotExistException, DeploymentGroupDoesNotExistException, DeploymentConfigDoesNotExistException, TagRequiredException, InvalidTagsToAddException, ArnNotSupportedException, InvalidArnException, AwsServiceException, SdkClientException, CodeDeployException
Associates the list of tags in the input
Tagsparameter with the resource identified by theResourceArninput parameter.
This is a convenience which creates an instance of the
TagResourceRequest.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto create a request.- Returns:
- Result of the TagResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ResourceArnRequiredException, ApplicationDoesNotExistException, DeploymentGroupDoesNotExistException, DeploymentConfigDoesNotExistException, TagRequiredException, InvalidTagsToAddException, ArnNotSupportedException, InvalidArnException, AwsServiceException, SdkClientException, CodeDeployException
Disassociates a resource from a list of tags. The resource is identified by the
ResourceArninput parameter. The tags are identified by the list of keys in theTagKeysinput parameter.- Parameters:
untagResourceRequest-- Returns:
- Result of the UntagResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws ResourceArnRequiredException, ApplicationDoesNotExistException, DeploymentGroupDoesNotExistException, DeploymentConfigDoesNotExistException, TagRequiredException, InvalidTagsToAddException, ArnNotSupportedException, InvalidArnException, AwsServiceException, SdkClientException, CodeDeployException
Disassociates a resource from a list of tags. The resource is identified by the
ResourceArninput parameter. The tags are identified by the list of keys in theTagKeysinput parameter.
This is a convenience which creates an instance of the
UntagResourceRequest.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateApplication
default UpdateApplicationResponse updateApplication(UpdateApplicationRequest updateApplicationRequest) throws ApplicationNameRequiredException, InvalidApplicationNameException, ApplicationAlreadyExistsException, ApplicationDoesNotExistException, AwsServiceException, SdkClientException, CodeDeployException
Changes the name of an application.
- Parameters:
updateApplicationRequest- Represents the input of anUpdateApplicationoperation.- Returns:
- Result of the UpdateApplication operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateApplication
default UpdateApplicationResponse updateApplication(Consumer<UpdateApplicationRequest.Builder> updateApplicationRequest) throws ApplicationNameRequiredException, InvalidApplicationNameException, ApplicationAlreadyExistsException, ApplicationDoesNotExistException, AwsServiceException, SdkClientException, CodeDeployException
Changes the name of an application.
This is a convenience which creates an instance of the
UpdateApplicationRequest.Builderavoiding the need to create one manually viaUpdateApplicationRequest.builder()- Parameters:
updateApplicationRequest- AConsumerthat will call methods onUpdateApplicationRequest.Builderto create a request. Represents the input of anUpdateApplicationoperation.- Returns:
- Result of the UpdateApplication operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateDeploymentGroup
default UpdateDeploymentGroupResponse updateDeploymentGroup(UpdateDeploymentGroupRequest updateDeploymentGroupRequest) throws ApplicationNameRequiredException, InvalidApplicationNameException, ApplicationDoesNotExistException, InvalidDeploymentGroupNameException, DeploymentGroupAlreadyExistsException, DeploymentGroupNameRequiredException, DeploymentGroupDoesNotExistException, InvalidEc2TagException, InvalidTagException, InvalidAutoScalingGroupException, InvalidDeploymentConfigNameException, DeploymentConfigDoesNotExistException, InvalidRoleException, LifecycleHookLimitExceededException, InvalidTriggerConfigException, TriggerTargetsLimitExceededException, InvalidAlarmConfigException, AlarmsLimitExceededException, InvalidAutoRollbackConfigException, InvalidLoadBalancerInfoException, InvalidDeploymentStyleException, InvalidBlueGreenDeploymentConfigurationException, InvalidEc2TagCombinationException, InvalidOnPremisesTagCombinationException, TagSetListLimitExceededException, InvalidInputException, ThrottlingException, InvalidEcsServiceException, InvalidTargetGroupPairException, EcsServiceMappingLimitExceededException, InvalidTrafficRoutingConfigurationException, AwsServiceException, SdkClientException, CodeDeployException
Changes information about a deployment group.
- Parameters:
updateDeploymentGroupRequest- Represents the input of anUpdateDeploymentGroupoperation.- Returns:
- Result of the UpdateDeploymentGroup operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateDeploymentGroup
default UpdateDeploymentGroupResponse updateDeploymentGroup(Consumer<UpdateDeploymentGroupRequest.Builder> updateDeploymentGroupRequest) throws ApplicationNameRequiredException, InvalidApplicationNameException, ApplicationDoesNotExistException, InvalidDeploymentGroupNameException, DeploymentGroupAlreadyExistsException, DeploymentGroupNameRequiredException, DeploymentGroupDoesNotExistException, InvalidEc2TagException, InvalidTagException, InvalidAutoScalingGroupException, InvalidDeploymentConfigNameException, DeploymentConfigDoesNotExistException, InvalidRoleException, LifecycleHookLimitExceededException, InvalidTriggerConfigException, TriggerTargetsLimitExceededException, InvalidAlarmConfigException, AlarmsLimitExceededException, InvalidAutoRollbackConfigException, InvalidLoadBalancerInfoException, InvalidDeploymentStyleException, InvalidBlueGreenDeploymentConfigurationException, InvalidEc2TagCombinationException, InvalidOnPremisesTagCombinationException, TagSetListLimitExceededException, InvalidInputException, ThrottlingException, InvalidEcsServiceException, InvalidTargetGroupPairException, EcsServiceMappingLimitExceededException, InvalidTrafficRoutingConfigurationException, AwsServiceException, SdkClientException, CodeDeployException
Changes information about a deployment group.
This is a convenience which creates an instance of the
UpdateDeploymentGroupRequest.Builderavoiding the need to create one manually viaUpdateDeploymentGroupRequest.builder()- Parameters:
updateDeploymentGroupRequest- AConsumerthat will call methods onUpdateDeploymentGroupRequest.Builderto create a request. Represents the input of anUpdateDeploymentGroupoperation.- Returns:
- Result of the UpdateDeploymentGroup operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
waiter
default CodeDeployWaiter waiter()
Create an instance ofCodeDeployWaiterusing 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
CodeDeployWaiter
-
create
static CodeDeployClient create()
Create aCodeDeployClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static CodeDeployClientBuilder builder()
Create a builder that can be used to configure and create aCodeDeployClient.
-
serviceMetadata
static ServiceMetadata serviceMetadata()
-
serviceClientConfiguration
default CodeDeployServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
-