Interface CodePipelineAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient
supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in
some cases such as credentials retrieval and endpoint discovery as part of the async API call.
Overview
This is the CodePipeline API Reference. This guide provides descriptions of the actions and data types for CodePipeline. Some functionality for your pipeline can only be configured through the API. For more information, see the CodePipeline User Guide.
You can use the CodePipeline API to work with pipelines, stages, actions, and transitions.
Pipelines are models of automated release processes. Each pipeline is uniquely named, and consists of stages, actions, and transitions.
You can work with pipelines by calling:
-
CreatePipeline, which creates a uniquely named pipeline.
-
DeletePipeline, which deletes the specified pipeline.
-
GetPipeline, which returns information about the pipeline structure and pipeline metadata, including the pipeline Amazon Resource Name (ARN).
-
GetPipelineExecution, which returns information about a specific execution of a pipeline.
-
GetPipelineState, which returns information about the current state of the stages and actions of a pipeline.
-
ListActionExecutions, which returns action-level details for past executions. The details include full stage and action-level details, including individual action duration, status, any errors that occurred during the execution, and input and output artifact location details.
-
ListPipelines, which gets a summary of all of the pipelines associated with your account.
-
ListPipelineExecutions, which gets a summary of the most recent executions for a pipeline.
-
StartPipelineExecution, which runs the most recent revision of an artifact through the pipeline.
-
StopPipelineExecution, which stops the specified pipeline execution from continuing through the pipeline.
-
UpdatePipeline, which updates a pipeline with edits or changes to the structure of the pipeline.
Pipelines include stages. Each stage contains one or more actions that must complete before the next stage begins. A stage results in success or failure. If a stage fails, the pipeline stops at that stage and remains stopped until either a new version of an artifact appears in the source location, or a user takes action to rerun the most recent artifact through the pipeline. You can call GetPipelineState, which displays the status of a pipeline, including the status of stages in the pipeline, or GetPipeline, which returns the entire structure of the pipeline, including the stages of that pipeline. For more information about the structure of stages and actions, see CodePipeline Pipeline Structure Reference.
Pipeline stages include actions that are categorized into categories such as source or build actions performed in a stage of a pipeline. For example, you can use a source action to import artifacts into a pipeline from a source such as Amazon S3. Like stages, you do not work with actions directly in most cases, but you do define and interact with actions when working with pipeline operations such as CreatePipeline and GetPipelineState. Valid action categories are:
-
Source
-
Build
-
Test
-
Deploy
-
Approval
-
Invoke
Pipelines also include transitions, which allow the transition of artifacts from one stage to the next in a pipeline after the actions in one stage complete.
You can work with transitions by calling:
-
DisableStageTransition, which prevents artifacts from transitioning to the next stage in a pipeline.
-
EnableStageTransition, which enables transition of artifacts between stages in a pipeline.
Using the API to integrate with CodePipeline
For third-party integrators or developers who want to create their own integrations with CodePipeline, the expected sequence varies from the standard API user. To integrate with CodePipeline, developers need to work with the following items:
Jobs, which are instances of an action. For example, a job for a source action might import a revision of an artifact from a source.
You can work with jobs by calling:
-
AcknowledgeJob, which confirms whether a job worker has received the specified job.
-
GetJobDetails, which returns the details of a job.
-
PollForJobs, which determines whether there are any jobs to act on.
-
PutJobFailureResult, which provides details of a job failure.
-
PutJobSuccessResult, which provides details of a job success.
Third party jobs, which are instances of an action created by a partner action and integrated into CodePipeline. Partner actions are created by members of the Amazon Web Services Partner Network.
You can work with third party jobs by calling:
-
AcknowledgeThirdPartyJob, which confirms whether a job worker has received the specified job.
-
GetThirdPartyJobDetails, which requests the details of a job for a partner action.
-
PollForThirdPartyJobs, which determines whether there are any jobs to act on.
-
PutThirdPartyJobFailureResult, which provides details of a job failure.
-
PutThirdPartyJobSuccessResult, which provides details of a job success.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptiondefault CompletableFuture
<AcknowledgeJobResponse> acknowledgeJob
(Consumer<AcknowledgeJobRequest.Builder> acknowledgeJobRequest) Returns information about a specified job and whether that job has been received by the job worker.default CompletableFuture
<AcknowledgeJobResponse> acknowledgeJob
(AcknowledgeJobRequest acknowledgeJobRequest) Returns information about a specified job and whether that job has been received by the job worker.acknowledgeThirdPartyJob
(Consumer<AcknowledgeThirdPartyJobRequest.Builder> acknowledgeThirdPartyJobRequest) Confirms a job worker has received the specified job.acknowledgeThirdPartyJob
(AcknowledgeThirdPartyJobRequest acknowledgeThirdPartyJobRequest) Confirms a job worker has received the specified job.builder()
Create a builder that can be used to configure and create aCodePipelineAsyncClient
.static CodePipelineAsyncClient
create()
Create aCodePipelineAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.createCustomActionType
(Consumer<CreateCustomActionTypeRequest.Builder> createCustomActionTypeRequest) Creates a new custom action that can be used in all pipelines associated with the Amazon Web Services account.createCustomActionType
(CreateCustomActionTypeRequest createCustomActionTypeRequest) Creates a new custom action that can be used in all pipelines associated with the Amazon Web Services account.default CompletableFuture
<CreatePipelineResponse> createPipeline
(Consumer<CreatePipelineRequest.Builder> createPipelineRequest) Creates a pipeline.default CompletableFuture
<CreatePipelineResponse> createPipeline
(CreatePipelineRequest createPipelineRequest) Creates a pipeline.deleteCustomActionType
(Consumer<DeleteCustomActionTypeRequest.Builder> deleteCustomActionTypeRequest) Marks a custom action as deleted.deleteCustomActionType
(DeleteCustomActionTypeRequest deleteCustomActionTypeRequest) Marks a custom action as deleted.default CompletableFuture
<DeletePipelineResponse> deletePipeline
(Consumer<DeletePipelineRequest.Builder> deletePipelineRequest) Deletes the specified pipeline.default CompletableFuture
<DeletePipelineResponse> deletePipeline
(DeletePipelineRequest deletePipelineRequest) Deletes the specified pipeline.default CompletableFuture
<DeleteWebhookResponse> deleteWebhook
(Consumer<DeleteWebhookRequest.Builder> deleteWebhookRequest) Deletes a previously created webhook by name.default CompletableFuture
<DeleteWebhookResponse> deleteWebhook
(DeleteWebhookRequest deleteWebhookRequest) Deletes a previously created webhook by name.deregisterWebhookWithThirdParty
(Consumer<DeregisterWebhookWithThirdPartyRequest.Builder> deregisterWebhookWithThirdPartyRequest) Removes the connection between the webhook that was created by CodePipeline and the external tool with events to be detected.deregisterWebhookWithThirdParty
(DeregisterWebhookWithThirdPartyRequest deregisterWebhookWithThirdPartyRequest) Removes the connection between the webhook that was created by CodePipeline and the external tool with events to be detected.disableStageTransition
(Consumer<DisableStageTransitionRequest.Builder> disableStageTransitionRequest) Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline.disableStageTransition
(DisableStageTransitionRequest disableStageTransitionRequest) Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline.enableStageTransition
(Consumer<EnableStageTransitionRequest.Builder> enableStageTransitionRequest) Enables artifacts in a pipeline to transition to a stage in a pipeline.enableStageTransition
(EnableStageTransitionRequest enableStageTransitionRequest) Enables artifacts in a pipeline to transition to a stage in a pipeline.default CompletableFuture
<GetActionTypeResponse> getActionType
(Consumer<GetActionTypeRequest.Builder> getActionTypeRequest) Returns information about an action type created for an external provider, where the action is to be used by customers of the external provider.default CompletableFuture
<GetActionTypeResponse> getActionType
(GetActionTypeRequest getActionTypeRequest) Returns information about an action type created for an external provider, where the action is to be used by customers of the external provider.default CompletableFuture
<GetJobDetailsResponse> getJobDetails
(Consumer<GetJobDetailsRequest.Builder> getJobDetailsRequest) Returns information about a job.default CompletableFuture
<GetJobDetailsResponse> getJobDetails
(GetJobDetailsRequest getJobDetailsRequest) Returns information about a job.default CompletableFuture
<GetPipelineResponse> getPipeline
(Consumer<GetPipelineRequest.Builder> getPipelineRequest) Returns the metadata, structure, stages, and actions of a pipeline.default CompletableFuture
<GetPipelineResponse> getPipeline
(GetPipelineRequest getPipelineRequest) Returns the metadata, structure, stages, and actions of a pipeline.getPipelineExecution
(Consumer<GetPipelineExecutionRequest.Builder> getPipelineExecutionRequest) Returns information about an execution of a pipeline, including details about artifacts, the pipeline execution ID, and the name, version, and status of the pipeline.getPipelineExecution
(GetPipelineExecutionRequest getPipelineExecutionRequest) Returns information about an execution of a pipeline, including details about artifacts, the pipeline execution ID, and the name, version, and status of the pipeline.getPipelineState
(Consumer<GetPipelineStateRequest.Builder> getPipelineStateRequest) Returns information about the state of a pipeline, including the stages and actions.getPipelineState
(GetPipelineStateRequest getPipelineStateRequest) Returns information about the state of a pipeline, including the stages and actions.getThirdPartyJobDetails
(Consumer<GetThirdPartyJobDetailsRequest.Builder> getThirdPartyJobDetailsRequest) Requests the details of a job for a third party action.getThirdPartyJobDetails
(GetThirdPartyJobDetailsRequest getThirdPartyJobDetailsRequest) Requests the details of a job for a third party action.listActionExecutions
(Consumer<ListActionExecutionsRequest.Builder> listActionExecutionsRequest) Lists the action executions that have occurred in a pipeline.listActionExecutions
(ListActionExecutionsRequest listActionExecutionsRequest) Lists the action executions that have occurred in a pipeline.default ListActionExecutionsPublisher
listActionExecutionsPaginator
(Consumer<ListActionExecutionsRequest.Builder> listActionExecutionsRequest) This is a variant oflistActionExecutions(software.amazon.awssdk.services.codepipeline.model.ListActionExecutionsRequest)
operation.default ListActionExecutionsPublisher
listActionExecutionsPaginator
(ListActionExecutionsRequest listActionExecutionsRequest) This is a variant oflistActionExecutions(software.amazon.awssdk.services.codepipeline.model.ListActionExecutionsRequest)
operation.default CompletableFuture
<ListActionTypesResponse> Gets a summary of all CodePipeline action types associated with your account.default CompletableFuture
<ListActionTypesResponse> listActionTypes
(Consumer<ListActionTypesRequest.Builder> listActionTypesRequest) Gets a summary of all CodePipeline action types associated with your account.default CompletableFuture
<ListActionTypesResponse> listActionTypes
(ListActionTypesRequest listActionTypesRequest) Gets a summary of all CodePipeline action types associated with your account.default ListActionTypesPublisher
This is a variant oflistActionTypes(software.amazon.awssdk.services.codepipeline.model.ListActionTypesRequest)
operation.default ListActionTypesPublisher
listActionTypesPaginator
(Consumer<ListActionTypesRequest.Builder> listActionTypesRequest) This is a variant oflistActionTypes(software.amazon.awssdk.services.codepipeline.model.ListActionTypesRequest)
operation.default ListActionTypesPublisher
listActionTypesPaginator
(ListActionTypesRequest listActionTypesRequest) This is a variant oflistActionTypes(software.amazon.awssdk.services.codepipeline.model.ListActionTypesRequest)
operation.listPipelineExecutions
(Consumer<ListPipelineExecutionsRequest.Builder> listPipelineExecutionsRequest) Gets a summary of the most recent executions for a pipeline.listPipelineExecutions
(ListPipelineExecutionsRequest listPipelineExecutionsRequest) Gets a summary of the most recent executions for a pipeline.default ListPipelineExecutionsPublisher
listPipelineExecutionsPaginator
(Consumer<ListPipelineExecutionsRequest.Builder> listPipelineExecutionsRequest) This is a variant oflistPipelineExecutions(software.amazon.awssdk.services.codepipeline.model.ListPipelineExecutionsRequest)
operation.default ListPipelineExecutionsPublisher
listPipelineExecutionsPaginator
(ListPipelineExecutionsRequest listPipelineExecutionsRequest) This is a variant oflistPipelineExecutions(software.amazon.awssdk.services.codepipeline.model.ListPipelineExecutionsRequest)
operation.default CompletableFuture
<ListPipelinesResponse> Gets a summary of all of the pipelines associated with your account.default CompletableFuture
<ListPipelinesResponse> listPipelines
(Consumer<ListPipelinesRequest.Builder> listPipelinesRequest) Gets a summary of all of the pipelines associated with your account.default CompletableFuture
<ListPipelinesResponse> listPipelines
(ListPipelinesRequest listPipelinesRequest) Gets a summary of all of the pipelines associated with your account.default ListPipelinesPublisher
This is a variant oflistPipelines(software.amazon.awssdk.services.codepipeline.model.ListPipelinesRequest)
operation.default ListPipelinesPublisher
listPipelinesPaginator
(Consumer<ListPipelinesRequest.Builder> listPipelinesRequest) This is a variant oflistPipelines(software.amazon.awssdk.services.codepipeline.model.ListPipelinesRequest)
operation.default ListPipelinesPublisher
listPipelinesPaginator
(ListPipelinesRequest listPipelinesRequest) This is a variant oflistPipelines(software.amazon.awssdk.services.codepipeline.model.ListPipelinesRequest)
operation.listRuleExecutions
(Consumer<ListRuleExecutionsRequest.Builder> listRuleExecutionsRequest) Lists the rule executions that have occurred in a pipeline configured for conditions with rules.listRuleExecutions
(ListRuleExecutionsRequest listRuleExecutionsRequest) Lists the rule executions that have occurred in a pipeline configured for conditions with rules.default ListRuleExecutionsPublisher
listRuleExecutionsPaginator
(Consumer<ListRuleExecutionsRequest.Builder> listRuleExecutionsRequest) This is a variant oflistRuleExecutions(software.amazon.awssdk.services.codepipeline.model.ListRuleExecutionsRequest)
operation.default ListRuleExecutionsPublisher
listRuleExecutionsPaginator
(ListRuleExecutionsRequest listRuleExecutionsRequest) This is a variant oflistRuleExecutions(software.amazon.awssdk.services.codepipeline.model.ListRuleExecutionsRequest)
operation.default CompletableFuture
<ListRuleTypesResponse> listRuleTypes
(Consumer<ListRuleTypesRequest.Builder> listRuleTypesRequest) Lists the rules for the condition.default CompletableFuture
<ListRuleTypesResponse> listRuleTypes
(ListRuleTypesRequest listRuleTypesRequest) Lists the rules for the condition.listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Gets the set of key-value pairs (metadata) that are used to manage the resource.listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Gets the set of key-value pairs (metadata) that are used to manage the resource.default ListTagsForResourcePublisher
listTagsForResourcePaginator
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) This is a variant oflistTagsForResource(software.amazon.awssdk.services.codepipeline.model.ListTagsForResourceRequest)
operation.default ListTagsForResourcePublisher
listTagsForResourcePaginator
(ListTagsForResourceRequest listTagsForResourceRequest) This is a variant oflistTagsForResource(software.amazon.awssdk.services.codepipeline.model.ListTagsForResourceRequest)
operation.default CompletableFuture
<ListWebhooksResponse> Gets a listing of all the webhooks in this Amazon Web Services Region for this account.default CompletableFuture
<ListWebhooksResponse> listWebhooks
(Consumer<ListWebhooksRequest.Builder> listWebhooksRequest) Gets a listing of all the webhooks in this Amazon Web Services Region for this account.default CompletableFuture
<ListWebhooksResponse> listWebhooks
(ListWebhooksRequest listWebhooksRequest) Gets a listing of all the webhooks in this Amazon Web Services Region for this account.default ListWebhooksPublisher
This is a variant oflistWebhooks(software.amazon.awssdk.services.codepipeline.model.ListWebhooksRequest)
operation.default ListWebhooksPublisher
listWebhooksPaginator
(Consumer<ListWebhooksRequest.Builder> listWebhooksRequest) This is a variant oflistWebhooks(software.amazon.awssdk.services.codepipeline.model.ListWebhooksRequest)
operation.default ListWebhooksPublisher
listWebhooksPaginator
(ListWebhooksRequest listWebhooksRequest) This is a variant oflistWebhooks(software.amazon.awssdk.services.codepipeline.model.ListWebhooksRequest)
operation.overrideStageCondition
(Consumer<OverrideStageConditionRequest.Builder> overrideStageConditionRequest) Used to override a stage condition.overrideStageCondition
(OverrideStageConditionRequest overrideStageConditionRequest) Used to override a stage condition.default CompletableFuture
<PollForJobsResponse> pollForJobs
(Consumer<PollForJobsRequest.Builder> pollForJobsRequest) Returns information about any jobs for CodePipeline to act on.default CompletableFuture
<PollForJobsResponse> pollForJobs
(PollForJobsRequest pollForJobsRequest) Returns information about any jobs for CodePipeline to act on.pollForThirdPartyJobs
(Consumer<PollForThirdPartyJobsRequest.Builder> pollForThirdPartyJobsRequest) Determines whether there are any third party jobs for a job worker to act on.pollForThirdPartyJobs
(PollForThirdPartyJobsRequest pollForThirdPartyJobsRequest) Determines whether there are any third party jobs for a job worker to act on.putActionRevision
(Consumer<PutActionRevisionRequest.Builder> putActionRevisionRequest) Provides information to CodePipeline about new revisions to a source.putActionRevision
(PutActionRevisionRequest putActionRevisionRequest) Provides information to CodePipeline about new revisions to a source.putApprovalResult
(Consumer<PutApprovalResultRequest.Builder> putApprovalResultRequest) Provides the response to a manual approval request to CodePipeline.putApprovalResult
(PutApprovalResultRequest putApprovalResultRequest) Provides the response to a manual approval request to CodePipeline.putJobFailureResult
(Consumer<PutJobFailureResultRequest.Builder> putJobFailureResultRequest) Represents the failure of a job as returned to the pipeline by a job worker.putJobFailureResult
(PutJobFailureResultRequest putJobFailureResultRequest) Represents the failure of a job as returned to the pipeline by a job worker.putJobSuccessResult
(Consumer<PutJobSuccessResultRequest.Builder> putJobSuccessResultRequest) Represents the success of a job as returned to the pipeline by a job worker.putJobSuccessResult
(PutJobSuccessResultRequest putJobSuccessResultRequest) Represents the success of a job as returned to the pipeline by a job worker.putThirdPartyJobFailureResult
(Consumer<PutThirdPartyJobFailureResultRequest.Builder> putThirdPartyJobFailureResultRequest) Represents the failure of a third party job as returned to the pipeline by a job worker.putThirdPartyJobFailureResult
(PutThirdPartyJobFailureResultRequest putThirdPartyJobFailureResultRequest) Represents the failure of a third party job as returned to the pipeline by a job worker.putThirdPartyJobSuccessResult
(Consumer<PutThirdPartyJobSuccessResultRequest.Builder> putThirdPartyJobSuccessResultRequest) Represents the success of a third party job as returned to the pipeline by a job worker.putThirdPartyJobSuccessResult
(PutThirdPartyJobSuccessResultRequest putThirdPartyJobSuccessResultRequest) Represents the success of a third party job as returned to the pipeline by a job worker.default CompletableFuture
<PutWebhookResponse> putWebhook
(Consumer<PutWebhookRequest.Builder> putWebhookRequest) Defines a webhook and returns a unique webhook URL generated by CodePipeline.default CompletableFuture
<PutWebhookResponse> putWebhook
(PutWebhookRequest putWebhookRequest) Defines a webhook and returns a unique webhook URL generated by CodePipeline.registerWebhookWithThirdParty
(Consumer<RegisterWebhookWithThirdPartyRequest.Builder> registerWebhookWithThirdPartyRequest) Configures a connection between the webhook that was created and the external tool with events to be detected.registerWebhookWithThirdParty
(RegisterWebhookWithThirdPartyRequest registerWebhookWithThirdPartyRequest) Configures a connection between the webhook that was created and the external tool with events to be detected.retryStageExecution
(Consumer<RetryStageExecutionRequest.Builder> retryStageExecutionRequest) You can retry a stage that has failed without having to run a pipeline again from the beginning.retryStageExecution
(RetryStageExecutionRequest retryStageExecutionRequest) You can retry a stage that has failed without having to run a pipeline again from the beginning.default CompletableFuture
<RollbackStageResponse> rollbackStage
(Consumer<RollbackStageRequest.Builder> rollbackStageRequest) Rolls back a stage execution.default CompletableFuture
<RollbackStageResponse> rollbackStage
(RollbackStageRequest rollbackStageRequest) Rolls back a stage execution.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstartPipelineExecution
(Consumer<StartPipelineExecutionRequest.Builder> startPipelineExecutionRequest) Starts the specified pipeline.startPipelineExecution
(StartPipelineExecutionRequest startPipelineExecutionRequest) Starts the specified pipeline.stopPipelineExecution
(Consumer<StopPipelineExecutionRequest.Builder> stopPipelineExecutionRequest) Stops the specified pipeline execution.stopPipelineExecution
(StopPipelineExecutionRequest stopPipelineExecutionRequest) Stops the specified pipeline execution.default CompletableFuture
<TagResourceResponse> tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds to or modifies the tags of the given resource.default CompletableFuture
<TagResourceResponse> tagResource
(TagResourceRequest tagResourceRequest) Adds to or modifies the tags of the given resource.default CompletableFuture
<UntagResourceResponse> untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes tags from an Amazon Web Services resource.default CompletableFuture
<UntagResourceResponse> untagResource
(UntagResourceRequest untagResourceRequest) Removes tags from an Amazon Web Services resource.updateActionType
(Consumer<UpdateActionTypeRequest.Builder> updateActionTypeRequest) Updates an action type that was created with any supported integration model, where the action type is to be used by customers of the action type provider.updateActionType
(UpdateActionTypeRequest updateActionTypeRequest) Updates an action type that was created with any supported integration model, where the action type is to be used by customers of the action type provider.default CompletableFuture
<UpdatePipelineResponse> updatePipeline
(Consumer<UpdatePipelineRequest.Builder> updatePipelineRequest) Updates a specified pipeline with edits or changes to its structure.default CompletableFuture
<UpdatePipelineResponse> updatePipeline
(UpdatePipelineRequest updatePipelineRequest) Updates a specified pipeline with edits or changes to its structure.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
acknowledgeJob
default CompletableFuture<AcknowledgeJobResponse> acknowledgeJob(AcknowledgeJobRequest acknowledgeJobRequest) Returns information about a specified job and whether that job has been received by the job worker. Used for custom actions only.
- Parameters:
acknowledgeJobRequest
- Represents the input of an AcknowledgeJob action.- Returns:
- A Java Future containing the result of the AcknowledgeJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- InvalidNonceException The nonce was specified in an invalid format.
- JobNotFoundException The job was specified in an invalid format or cannot be 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
acknowledgeJob
default CompletableFuture<AcknowledgeJobResponse> acknowledgeJob(Consumer<AcknowledgeJobRequest.Builder> acknowledgeJobRequest) Returns information about a specified job and whether that job has been received by the job worker. Used for custom actions only.
This is a convenience which creates an instance of the
AcknowledgeJobRequest.Builder
avoiding the need to create one manually viaAcknowledgeJobRequest.builder()
- Parameters:
acknowledgeJobRequest
- AConsumer
that will call methods onAcknowledgeJobRequest.Builder
to create a request. Represents the input of an AcknowledgeJob action.- Returns:
- A Java Future containing the result of the AcknowledgeJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- InvalidNonceException The nonce was specified in an invalid format.
- JobNotFoundException The job was specified in an invalid format or cannot be 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
acknowledgeThirdPartyJob
default CompletableFuture<AcknowledgeThirdPartyJobResponse> acknowledgeThirdPartyJob(AcknowledgeThirdPartyJobRequest acknowledgeThirdPartyJobRequest) Confirms a job worker has received the specified job. Used for partner actions only.
- Parameters:
acknowledgeThirdPartyJobRequest
- Represents the input of an AcknowledgeThirdPartyJob action.- Returns:
- A Java Future containing the result of the AcknowledgeThirdPartyJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- InvalidNonceException The nonce was specified in an invalid format.
- JobNotFoundException The job was specified in an invalid format or cannot be found.
- InvalidClientTokenException The client 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
acknowledgeThirdPartyJob
default CompletableFuture<AcknowledgeThirdPartyJobResponse> acknowledgeThirdPartyJob(Consumer<AcknowledgeThirdPartyJobRequest.Builder> acknowledgeThirdPartyJobRequest) Confirms a job worker has received the specified job. Used for partner actions only.
This is a convenience which creates an instance of the
AcknowledgeThirdPartyJobRequest.Builder
avoiding the need to create one manually viaAcknowledgeThirdPartyJobRequest.builder()
- Parameters:
acknowledgeThirdPartyJobRequest
- AConsumer
that will call methods onAcknowledgeThirdPartyJobRequest.Builder
to create a request. Represents the input of an AcknowledgeThirdPartyJob action.- Returns:
- A Java Future containing the result of the AcknowledgeThirdPartyJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- InvalidNonceException The nonce was specified in an invalid format.
- JobNotFoundException The job was specified in an invalid format or cannot be found.
- InvalidClientTokenException The client 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createCustomActionType
default CompletableFuture<CreateCustomActionTypeResponse> createCustomActionType(CreateCustomActionTypeRequest createCustomActionTypeRequest) Creates a new custom action that can be used in all pipelines associated with the Amazon Web Services account. Only used for custom actions.
- Parameters:
createCustomActionTypeRequest
- Represents the input of a CreateCustomActionType operation.- Returns:
- A Java Future containing the result of the CreateCustomActionType operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- LimitExceededException The number of pipelines associated with the Amazon Web Services account has exceeded the limit allowed for the account.
- TooManyTagsException The tags limit for a resource has been exceeded.
- InvalidTagsException The specified resource tags are invalid.
- ConcurrentModificationException Unable to modify the tag due to a simultaneous update request.
- 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createCustomActionType
default CompletableFuture<CreateCustomActionTypeResponse> createCustomActionType(Consumer<CreateCustomActionTypeRequest.Builder> createCustomActionTypeRequest) Creates a new custom action that can be used in all pipelines associated with the Amazon Web Services account. Only used for custom actions.
This is a convenience which creates an instance of the
CreateCustomActionTypeRequest.Builder
avoiding the need to create one manually viaCreateCustomActionTypeRequest.builder()
- Parameters:
createCustomActionTypeRequest
- AConsumer
that will call methods onCreateCustomActionTypeRequest.Builder
to create a request. Represents the input of a CreateCustomActionType operation.- Returns:
- A Java Future containing the result of the CreateCustomActionType operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- LimitExceededException The number of pipelines associated with the Amazon Web Services account has exceeded the limit allowed for the account.
- TooManyTagsException The tags limit for a resource has been exceeded.
- InvalidTagsException The specified resource tags are invalid.
- ConcurrentModificationException Unable to modify the tag due to a simultaneous update request.
- 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createPipeline
default CompletableFuture<CreatePipelineResponse> createPipeline(CreatePipelineRequest createPipelineRequest) Creates a pipeline.
In the pipeline structure, you must include either
artifactStore
orartifactStores
in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must useartifactStores
.- Parameters:
createPipelineRequest
- Represents the input of aCreatePipeline
action.- Returns:
- A Java Future containing the result of the CreatePipeline operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- PipelineNameInUseException The specified pipeline name is already in use.
- InvalidStageDeclarationException The stage declaration was specified in an invalid format.
- InvalidActionDeclarationException The action declaration was specified in an invalid format.
- InvalidBlockerDeclarationException Reserved for future use.
- InvalidStructureException The structure was specified in an invalid format.
- LimitExceededException The number of pipelines associated with the Amazon Web Services account has exceeded the limit allowed for the account.
- TooManyTagsException The tags limit for a resource has been exceeded.
- InvalidTagsException The specified resource tags are invalid.
- ConcurrentModificationException Unable to modify the tag due to a simultaneous update request.
- 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createPipeline
default CompletableFuture<CreatePipelineResponse> createPipeline(Consumer<CreatePipelineRequest.Builder> createPipelineRequest) Creates a pipeline.
In the pipeline structure, you must include either
artifactStore
orartifactStores
in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must useartifactStores
.
This is a convenience which creates an instance of the
CreatePipelineRequest.Builder
avoiding the need to create one manually viaCreatePipelineRequest.builder()
- Parameters:
createPipelineRequest
- AConsumer
that will call methods onCreatePipelineRequest.Builder
to create a request. Represents the input of aCreatePipeline
action.- Returns:
- A Java Future containing the result of the CreatePipeline operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- PipelineNameInUseException The specified pipeline name is already in use.
- InvalidStageDeclarationException The stage declaration was specified in an invalid format.
- InvalidActionDeclarationException The action declaration was specified in an invalid format.
- InvalidBlockerDeclarationException Reserved for future use.
- InvalidStructureException The structure was specified in an invalid format.
- LimitExceededException The number of pipelines associated with the Amazon Web Services account has exceeded the limit allowed for the account.
- TooManyTagsException The tags limit for a resource has been exceeded.
- InvalidTagsException The specified resource tags are invalid.
- ConcurrentModificationException Unable to modify the tag due to a simultaneous update request.
- 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteCustomActionType
default CompletableFuture<DeleteCustomActionTypeResponse> deleteCustomActionType(DeleteCustomActionTypeRequest deleteCustomActionTypeRequest) Marks a custom action as deleted.
PollForJobs
for the custom action fails after the action is marked for deletion. Used for custom actions only.To re-create a custom action after it has been deleted you must use a string in the version field that has never been used before. This string can be an incremented version number, for example. To restore a deleted custom action, use a JSON file that is identical to the deleted action, including the original string in the version field.
- Parameters:
deleteCustomActionTypeRequest
- Represents the input of aDeleteCustomActionType
operation. The custom action will be marked as deleted.- Returns:
- A Java Future containing the result of the DeleteCustomActionType operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- ConcurrentModificationException Unable to modify the tag due to a simultaneous update request.
- 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteCustomActionType
default CompletableFuture<DeleteCustomActionTypeResponse> deleteCustomActionType(Consumer<DeleteCustomActionTypeRequest.Builder> deleteCustomActionTypeRequest) Marks a custom action as deleted.
PollForJobs
for the custom action fails after the action is marked for deletion. Used for custom actions only.To re-create a custom action after it has been deleted you must use a string in the version field that has never been used before. This string can be an incremented version number, for example. To restore a deleted custom action, use a JSON file that is identical to the deleted action, including the original string in the version field.
This is a convenience which creates an instance of the
DeleteCustomActionTypeRequest.Builder
avoiding the need to create one manually viaDeleteCustomActionTypeRequest.builder()
- Parameters:
deleteCustomActionTypeRequest
- AConsumer
that will call methods onDeleteCustomActionTypeRequest.Builder
to create a request. Represents the input of aDeleteCustomActionType
operation. The custom action will be marked as deleted.- Returns:
- A Java Future containing the result of the DeleteCustomActionType operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- ConcurrentModificationException Unable to modify the tag due to a simultaneous update request.
- 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deletePipeline
default CompletableFuture<DeletePipelineResponse> deletePipeline(DeletePipelineRequest deletePipelineRequest) Deletes the specified pipeline.
- Parameters:
deletePipelineRequest
- Represents the input of aDeletePipeline
action.- Returns:
- A Java Future containing the result of the DeletePipeline operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- ConcurrentModificationException Unable to modify the tag due to a simultaneous update request.
- 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deletePipeline
default CompletableFuture<DeletePipelineResponse> deletePipeline(Consumer<DeletePipelineRequest.Builder> deletePipelineRequest) Deletes the specified pipeline.
This is a convenience which creates an instance of the
DeletePipelineRequest.Builder
avoiding the need to create one manually viaDeletePipelineRequest.builder()
- Parameters:
deletePipelineRequest
- AConsumer
that will call methods onDeletePipelineRequest.Builder
to create a request. Represents the input of aDeletePipeline
action.- Returns:
- A Java Future containing the result of the DeletePipeline operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- ConcurrentModificationException Unable to modify the tag due to a simultaneous update request.
- 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteWebhook
default CompletableFuture<DeleteWebhookResponse> deleteWebhook(DeleteWebhookRequest deleteWebhookRequest) Deletes a previously created webhook by name. Deleting the webhook stops CodePipeline from starting a pipeline every time an external event occurs. The API returns successfully when trying to delete a webhook that is already deleted. If a deleted webhook is re-created by calling PutWebhook with the same name, it will have a different URL.
- Parameters:
deleteWebhookRequest
-- Returns:
- A Java Future containing the result of the DeleteWebhook operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- ConcurrentModificationException Unable to modify the tag due to a simultaneous update request.
- 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteWebhook
default CompletableFuture<DeleteWebhookResponse> deleteWebhook(Consumer<DeleteWebhookRequest.Builder> deleteWebhookRequest) Deletes a previously created webhook by name. Deleting the webhook stops CodePipeline from starting a pipeline every time an external event occurs. The API returns successfully when trying to delete a webhook that is already deleted. If a deleted webhook is re-created by calling PutWebhook with the same name, it will have a different URL.
This is a convenience which creates an instance of the
DeleteWebhookRequest.Builder
avoiding the need to create one manually viaDeleteWebhookRequest.builder()
- Parameters:
deleteWebhookRequest
- AConsumer
that will call methods onDeleteWebhookRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteWebhook operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- ConcurrentModificationException Unable to modify the tag due to a simultaneous update request.
- 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deregisterWebhookWithThirdParty
default CompletableFuture<DeregisterWebhookWithThirdPartyResponse> deregisterWebhookWithThirdParty(DeregisterWebhookWithThirdPartyRequest deregisterWebhookWithThirdPartyRequest) Removes the connection between the webhook that was created by CodePipeline and the external tool with events to be detected. Currently supported only for webhooks that target an action type of GitHub.
- Parameters:
deregisterWebhookWithThirdPartyRequest
-- Returns:
- A Java Future containing the result of the DeregisterWebhookWithThirdParty operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- WebhookNotFoundException The specified webhook was entered in an invalid format or cannot be 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deregisterWebhookWithThirdParty
default CompletableFuture<DeregisterWebhookWithThirdPartyResponse> deregisterWebhookWithThirdParty(Consumer<DeregisterWebhookWithThirdPartyRequest.Builder> deregisterWebhookWithThirdPartyRequest) Removes the connection between the webhook that was created by CodePipeline and the external tool with events to be detected. Currently supported only for webhooks that target an action type of GitHub.
This is a convenience which creates an instance of the
DeregisterWebhookWithThirdPartyRequest.Builder
avoiding the need to create one manually viaDeregisterWebhookWithThirdPartyRequest.builder()
- Parameters:
deregisterWebhookWithThirdPartyRequest
- AConsumer
that will call methods onDeregisterWebhookWithThirdPartyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeregisterWebhookWithThirdParty operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- WebhookNotFoundException The specified webhook was entered in an invalid format or cannot be 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
disableStageTransition
default CompletableFuture<DisableStageTransitionResponse> disableStageTransition(DisableStageTransitionRequest disableStageTransitionRequest) Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline.
- Parameters:
disableStageTransitionRequest
- Represents the input of aDisableStageTransition
action.- Returns:
- A Java Future containing the result of the DisableStageTransition operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- PipelineNotFoundException The pipeline was specified in an invalid format or cannot be found.
- StageNotFoundException The stage was specified in an invalid format or cannot be 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
disableStageTransition
default CompletableFuture<DisableStageTransitionResponse> disableStageTransition(Consumer<DisableStageTransitionRequest.Builder> disableStageTransitionRequest) Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline.
This is a convenience which creates an instance of the
DisableStageTransitionRequest.Builder
avoiding the need to create one manually viaDisableStageTransitionRequest.builder()
- Parameters:
disableStageTransitionRequest
- AConsumer
that will call methods onDisableStageTransitionRequest.Builder
to create a request. Represents the input of aDisableStageTransition
action.- Returns:
- A Java Future containing the result of the DisableStageTransition operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- PipelineNotFoundException The pipeline was specified in an invalid format or cannot be found.
- StageNotFoundException The stage was specified in an invalid format or cannot be 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
enableStageTransition
default CompletableFuture<EnableStageTransitionResponse> enableStageTransition(EnableStageTransitionRequest enableStageTransitionRequest) Enables artifacts in a pipeline to transition to a stage in a pipeline.
- Parameters:
enableStageTransitionRequest
- Represents the input of anEnableStageTransition
action.- Returns:
- A Java Future containing the result of the EnableStageTransition operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- PipelineNotFoundException The pipeline was specified in an invalid format or cannot be found.
- StageNotFoundException The stage was specified in an invalid format or cannot be 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
enableStageTransition
default CompletableFuture<EnableStageTransitionResponse> enableStageTransition(Consumer<EnableStageTransitionRequest.Builder> enableStageTransitionRequest) Enables artifacts in a pipeline to transition to a stage in a pipeline.
This is a convenience which creates an instance of the
EnableStageTransitionRequest.Builder
avoiding the need to create one manually viaEnableStageTransitionRequest.builder()
- Parameters:
enableStageTransitionRequest
- AConsumer
that will call methods onEnableStageTransitionRequest.Builder
to create a request. Represents the input of anEnableStageTransition
action.- Returns:
- A Java Future containing the result of the EnableStageTransition operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- PipelineNotFoundException The pipeline was specified in an invalid format or cannot be found.
- StageNotFoundException The stage was specified in an invalid format or cannot be 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getActionType
default CompletableFuture<GetActionTypeResponse> getActionType(GetActionTypeRequest getActionTypeRequest) Returns information about an action type created for an external provider, where the action is to be used by customers of the external provider. The action can be created with any supported integration model.
- Parameters:
getActionTypeRequest
-- Returns:
- A Java Future containing the result of the GetActionType operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ActionTypeNotFoundException The specified action type cannot be found.
- ValidationException The validation 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getActionType
default CompletableFuture<GetActionTypeResponse> getActionType(Consumer<GetActionTypeRequest.Builder> getActionTypeRequest) Returns information about an action type created for an external provider, where the action is to be used by customers of the external provider. The action can be created with any supported integration model.
This is a convenience which creates an instance of the
GetActionTypeRequest.Builder
avoiding the need to create one manually viaGetActionTypeRequest.builder()
- Parameters:
getActionTypeRequest
- AConsumer
that will call methods onGetActionTypeRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetActionType operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ActionTypeNotFoundException The specified action type cannot be found.
- ValidationException The validation 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getJobDetails
default CompletableFuture<GetJobDetailsResponse> getJobDetails(GetJobDetailsRequest getJobDetailsRequest) Returns information about a job. Used for custom actions only.
When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.
- Parameters:
getJobDetailsRequest
- Represents the input of aGetJobDetails
action.- Returns:
- A Java Future containing the result of the GetJobDetails operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- JobNotFoundException The job was specified in an invalid format or cannot be 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getJobDetails
default CompletableFuture<GetJobDetailsResponse> getJobDetails(Consumer<GetJobDetailsRequest.Builder> getJobDetailsRequest) Returns information about a job. Used for custom actions only.
When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.
This is a convenience which creates an instance of the
GetJobDetailsRequest.Builder
avoiding the need to create one manually viaGetJobDetailsRequest.builder()
- Parameters:
getJobDetailsRequest
- AConsumer
that will call methods onGetJobDetailsRequest.Builder
to create a request. Represents the input of aGetJobDetails
action.- Returns:
- A Java Future containing the result of the GetJobDetails operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- JobNotFoundException The job was specified in an invalid format or cannot be 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getPipeline
Returns the metadata, structure, stages, and actions of a pipeline. Can be used to return the entire structure of a pipeline in JSON format, which can then be modified and used to update the pipeline structure with UpdatePipeline.
- Parameters:
getPipelineRequest
- Represents the input of aGetPipeline
action.- Returns:
- A Java Future containing the result of the GetPipeline operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- PipelineNotFoundException The pipeline was specified in an invalid format or cannot be found.
- PipelineVersionNotFoundException The pipeline version was specified in an invalid format or cannot be 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getPipeline
default CompletableFuture<GetPipelineResponse> getPipeline(Consumer<GetPipelineRequest.Builder> getPipelineRequest) Returns the metadata, structure, stages, and actions of a pipeline. Can be used to return the entire structure of a pipeline in JSON format, which can then be modified and used to update the pipeline structure with UpdatePipeline.
This is a convenience which creates an instance of the
GetPipelineRequest.Builder
avoiding the need to create one manually viaGetPipelineRequest.builder()
- Parameters:
getPipelineRequest
- AConsumer
that will call methods onGetPipelineRequest.Builder
to create a request. Represents the input of aGetPipeline
action.- Returns:
- A Java Future containing the result of the GetPipeline operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- PipelineNotFoundException The pipeline was specified in an invalid format or cannot be found.
- PipelineVersionNotFoundException The pipeline version was specified in an invalid format or cannot be 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getPipelineExecution
default CompletableFuture<GetPipelineExecutionResponse> getPipelineExecution(GetPipelineExecutionRequest getPipelineExecutionRequest) Returns information about an execution of a pipeline, including details about artifacts, the pipeline execution ID, and the name, version, and status of the pipeline.
- Parameters:
getPipelineExecutionRequest
- Represents the input of aGetPipelineExecution
action.- Returns:
- A Java Future containing the result of the GetPipelineExecution operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- PipelineNotFoundException The pipeline was specified in an invalid format or cannot be found.
- PipelineExecutionNotFoundException The pipeline execution was specified in an invalid format or cannot be found, or an execution ID does not belong to the specified pipeline.
- 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getPipelineExecution
default CompletableFuture<GetPipelineExecutionResponse> getPipelineExecution(Consumer<GetPipelineExecutionRequest.Builder> getPipelineExecutionRequest) Returns information about an execution of a pipeline, including details about artifacts, the pipeline execution ID, and the name, version, and status of the pipeline.
This is a convenience which creates an instance of the
GetPipelineExecutionRequest.Builder
avoiding the need to create one manually viaGetPipelineExecutionRequest.builder()
- Parameters:
getPipelineExecutionRequest
- AConsumer
that will call methods onGetPipelineExecutionRequest.Builder
to create a request. Represents the input of aGetPipelineExecution
action.- Returns:
- A Java Future containing the result of the GetPipelineExecution operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- PipelineNotFoundException The pipeline was specified in an invalid format or cannot be found.
- PipelineExecutionNotFoundException The pipeline execution was specified in an invalid format or cannot be found, or an execution ID does not belong to the specified pipeline.
- 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getPipelineState
default CompletableFuture<GetPipelineStateResponse> getPipelineState(GetPipelineStateRequest getPipelineStateRequest) Returns information about the state of a pipeline, including the stages and actions.
Values returned in the
revisionId
andrevisionUrl
fields indicate the source revision information, such as the commit ID, for the current state.- Parameters:
getPipelineStateRequest
- Represents the input of aGetPipelineState
action.- Returns:
- A Java Future containing the result of the GetPipelineState operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- PipelineNotFoundException The pipeline was specified in an invalid format or cannot be 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getPipelineState
default CompletableFuture<GetPipelineStateResponse> getPipelineState(Consumer<GetPipelineStateRequest.Builder> getPipelineStateRequest) Returns information about the state of a pipeline, including the stages and actions.
Values returned in the
revisionId
andrevisionUrl
fields indicate the source revision information, such as the commit ID, for the current state.
This is a convenience which creates an instance of the
GetPipelineStateRequest.Builder
avoiding the need to create one manually viaGetPipelineStateRequest.builder()
- Parameters:
getPipelineStateRequest
- AConsumer
that will call methods onGetPipelineStateRequest.Builder
to create a request. Represents the input of aGetPipelineState
action.- Returns:
- A Java Future containing the result of the GetPipelineState operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- PipelineNotFoundException The pipeline was specified in an invalid format or cannot be 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getThirdPartyJobDetails
default CompletableFuture<GetThirdPartyJobDetailsResponse> getThirdPartyJobDetails(GetThirdPartyJobDetailsRequest getThirdPartyJobDetailsRequest) Requests the details of a job for a third party action. Used for partner actions only.
When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.
- Parameters:
getThirdPartyJobDetailsRequest
- Represents the input of aGetThirdPartyJobDetails
action.- Returns:
- A Java Future containing the result of the GetThirdPartyJobDetails operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- JobNotFoundException The job was specified in an invalid format or cannot be found.
- ValidationException The validation was specified in an invalid format.
- InvalidClientTokenException The client token was specified in an invalid format
- InvalidJobException The job was specified in an invalid format or cannot be 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getThirdPartyJobDetails
default CompletableFuture<GetThirdPartyJobDetailsResponse> getThirdPartyJobDetails(Consumer<GetThirdPartyJobDetailsRequest.Builder> getThirdPartyJobDetailsRequest) Requests the details of a job for a third party action. Used for partner actions only.
When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.
This is a convenience which creates an instance of the
GetThirdPartyJobDetailsRequest.Builder
avoiding the need to create one manually viaGetThirdPartyJobDetailsRequest.builder()
- Parameters:
getThirdPartyJobDetailsRequest
- AConsumer
that will call methods onGetThirdPartyJobDetailsRequest.Builder
to create a request. Represents the input of aGetThirdPartyJobDetails
action.- Returns:
- A Java Future containing the result of the GetThirdPartyJobDetails operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- JobNotFoundException The job was specified in an invalid format or cannot be found.
- ValidationException The validation was specified in an invalid format.
- InvalidClientTokenException The client token was specified in an invalid format
- InvalidJobException The job was specified in an invalid format or cannot be 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listActionExecutions
default CompletableFuture<ListActionExecutionsResponse> listActionExecutions(ListActionExecutionsRequest listActionExecutionsRequest) Lists the action executions that have occurred in a pipeline.
- Parameters:
listActionExecutionsRequest
-- Returns:
- A Java Future containing the result of the ListActionExecutions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- PipelineNotFoundException The pipeline was specified in an invalid format or cannot be found.
- InvalidNextTokenException The next token was specified in an invalid format. Make sure that the next token you provide is the token returned by a previous call.
- PipelineExecutionNotFoundException The pipeline execution was specified in an invalid format or cannot be found, or an execution ID does not belong to the specified pipeline.
- 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listActionExecutions
default CompletableFuture<ListActionExecutionsResponse> listActionExecutions(Consumer<ListActionExecutionsRequest.Builder> listActionExecutionsRequest) Lists the action executions that have occurred in a pipeline.
This is a convenience which creates an instance of the
ListActionExecutionsRequest.Builder
avoiding the need to create one manually viaListActionExecutionsRequest.builder()
- Parameters:
listActionExecutionsRequest
- AConsumer
that will call methods onListActionExecutionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListActionExecutions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- PipelineNotFoundException The pipeline was specified in an invalid format or cannot be found.
- InvalidNextTokenException The next token was specified in an invalid format. Make sure that the next token you provide is the token returned by a previous call.
- PipelineExecutionNotFoundException The pipeline execution was specified in an invalid format or cannot be found, or an execution ID does not belong to the specified pipeline.
- 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listActionExecutionsPaginator
default ListActionExecutionsPublisher listActionExecutionsPaginator(ListActionExecutionsRequest listActionExecutionsRequest) This is a variant of
listActionExecutions(software.amazon.awssdk.services.codepipeline.model.ListActionExecutionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.codepipeline.paginators.ListActionExecutionsPublisher publisher = client.listActionExecutionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.codepipeline.paginators.ListActionExecutionsPublisher publisher = client.listActionExecutionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codepipeline.model.ListActionExecutionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.codepipeline.model.ListActionExecutionsResponse response) { //... }; });
Please notice that the configuration of maxResults 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
listActionExecutions(software.amazon.awssdk.services.codepipeline.model.ListActionExecutionsRequest)
operation.- Parameters:
listActionExecutionsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- PipelineNotFoundException The pipeline was specified in an invalid format or cannot be found.
- InvalidNextTokenException The next token was specified in an invalid format. Make sure that the next token you provide is the token returned by a previous call.
- PipelineExecutionNotFoundException The pipeline execution was specified in an invalid format or cannot be found, or an execution ID does not belong to the specified pipeline.
- 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listActionExecutionsPaginator
default ListActionExecutionsPublisher listActionExecutionsPaginator(Consumer<ListActionExecutionsRequest.Builder> listActionExecutionsRequest) This is a variant of
listActionExecutions(software.amazon.awssdk.services.codepipeline.model.ListActionExecutionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.codepipeline.paginators.ListActionExecutionsPublisher publisher = client.listActionExecutionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.codepipeline.paginators.ListActionExecutionsPublisher publisher = client.listActionExecutionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codepipeline.model.ListActionExecutionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.codepipeline.model.ListActionExecutionsResponse response) { //... }; });
Please notice that the configuration of maxResults 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
listActionExecutions(software.amazon.awssdk.services.codepipeline.model.ListActionExecutionsRequest)
operation.
This is a convenience which creates an instance of the
ListActionExecutionsRequest.Builder
avoiding the need to create one manually viaListActionExecutionsRequest.builder()
- Parameters:
listActionExecutionsRequest
- AConsumer
that will call methods onListActionExecutionsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- PipelineNotFoundException The pipeline was specified in an invalid format or cannot be found.
- InvalidNextTokenException The next token was specified in an invalid format. Make sure that the next token you provide is the token returned by a previous call.
- PipelineExecutionNotFoundException The pipeline execution was specified in an invalid format or cannot be found, or an execution ID does not belong to the specified pipeline.
- 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listActionTypes
default CompletableFuture<ListActionTypesResponse> listActionTypes(ListActionTypesRequest listActionTypesRequest) Gets a summary of all CodePipeline action types associated with your account.
- Parameters:
listActionTypesRequest
- Represents the input of aListActionTypes
action.- Returns:
- A Java Future containing the result of the ListActionTypes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- InvalidNextTokenException The next token was specified in an invalid format. Make sure that the next token you provide is the token returned by a previous call.
- 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listActionTypes
default CompletableFuture<ListActionTypesResponse> listActionTypes(Consumer<ListActionTypesRequest.Builder> listActionTypesRequest) Gets a summary of all CodePipeline action types associated with your account.
This is a convenience which creates an instance of the
ListActionTypesRequest.Builder
avoiding the need to create one manually viaListActionTypesRequest.builder()
- Parameters:
listActionTypesRequest
- AConsumer
that will call methods onListActionTypesRequest.Builder
to create a request. Represents the input of aListActionTypes
action.- Returns:
- A Java Future containing the result of the ListActionTypes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- InvalidNextTokenException The next token was specified in an invalid format. Make sure that the next token you provide is the token returned by a previous call.
- 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listActionTypes
Gets a summary of all CodePipeline action types associated with your account.
- Returns:
- A Java Future containing the result of the ListActionTypes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- InvalidNextTokenException The next token was specified in an invalid format. Make sure that the next token you provide is the token returned by a previous call.
- 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listActionTypesPaginator
This is a variant of
listActionTypes(software.amazon.awssdk.services.codepipeline.model.ListActionTypesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.codepipeline.paginators.ListActionTypesPublisher publisher = client.listActionTypesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.codepipeline.paginators.ListActionTypesPublisher publisher = client.listActionTypesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codepipeline.model.ListActionTypesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.codepipeline.model.ListActionTypesResponse response) { //... }; });
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listActionTypes(software.amazon.awssdk.services.codepipeline.model.ListActionTypesRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- InvalidNextTokenException The next token was specified in an invalid format. Make sure that the next token you provide is the token returned by a previous call.
- 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listActionTypesPaginator
default ListActionTypesPublisher listActionTypesPaginator(ListActionTypesRequest listActionTypesRequest) This is a variant of
listActionTypes(software.amazon.awssdk.services.codepipeline.model.ListActionTypesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.codepipeline.paginators.ListActionTypesPublisher publisher = client.listActionTypesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.codepipeline.paginators.ListActionTypesPublisher publisher = client.listActionTypesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codepipeline.model.ListActionTypesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.codepipeline.model.ListActionTypesResponse response) { //... }; });
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listActionTypes(software.amazon.awssdk.services.codepipeline.model.ListActionTypesRequest)
operation.- Parameters:
listActionTypesRequest
- Represents the input of aListActionTypes
action.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- InvalidNextTokenException The next token was specified in an invalid format. Make sure that the next token you provide is the token returned by a previous call.
- 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listActionTypesPaginator
default ListActionTypesPublisher listActionTypesPaginator(Consumer<ListActionTypesRequest.Builder> listActionTypesRequest) This is a variant of
listActionTypes(software.amazon.awssdk.services.codepipeline.model.ListActionTypesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.codepipeline.paginators.ListActionTypesPublisher publisher = client.listActionTypesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.codepipeline.paginators.ListActionTypesPublisher publisher = client.listActionTypesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codepipeline.model.ListActionTypesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.codepipeline.model.ListActionTypesResponse response) { //... }; });
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listActionTypes(software.amazon.awssdk.services.codepipeline.model.ListActionTypesRequest)
operation.
This is a convenience which creates an instance of the
ListActionTypesRequest.Builder
avoiding the need to create one manually viaListActionTypesRequest.builder()
- Parameters:
listActionTypesRequest
- AConsumer
that will call methods onListActionTypesRequest.Builder
to create a request. Represents the input of aListActionTypes
action.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- InvalidNextTokenException The next token was specified in an invalid format. Make sure that the next token you provide is the token returned by a previous call.
- 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPipelineExecutions
default CompletableFuture<ListPipelineExecutionsResponse> listPipelineExecutions(ListPipelineExecutionsRequest listPipelineExecutionsRequest) Gets a summary of the most recent executions for a pipeline.
When applying the filter for pipeline executions that have succeeded in the stage, the operation returns all executions in the current pipeline version beginning on February 1, 2024.
- Parameters:
listPipelineExecutionsRequest
- Represents the input of aListPipelineExecutions
action.- Returns:
- A Java Future containing the result of the ListPipelineExecutions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- PipelineNotFoundException The pipeline was specified in an invalid format or cannot be found.
- InvalidNextTokenException The next token was specified in an invalid format. Make sure that the next token you provide is the token returned by a previous call.
- 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPipelineExecutions
default CompletableFuture<ListPipelineExecutionsResponse> listPipelineExecutions(Consumer<ListPipelineExecutionsRequest.Builder> listPipelineExecutionsRequest) Gets a summary of the most recent executions for a pipeline.
When applying the filter for pipeline executions that have succeeded in the stage, the operation returns all executions in the current pipeline version beginning on February 1, 2024.
This is a convenience which creates an instance of the
ListPipelineExecutionsRequest.Builder
avoiding the need to create one manually viaListPipelineExecutionsRequest.builder()
- Parameters:
listPipelineExecutionsRequest
- AConsumer
that will call methods onListPipelineExecutionsRequest.Builder
to create a request. Represents the input of aListPipelineExecutions
action.- Returns:
- A Java Future containing the result of the ListPipelineExecutions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- PipelineNotFoundException The pipeline was specified in an invalid format or cannot be found.
- InvalidNextTokenException The next token was specified in an invalid format. Make sure that the next token you provide is the token returned by a previous call.
- 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPipelineExecutionsPaginator
default ListPipelineExecutionsPublisher listPipelineExecutionsPaginator(ListPipelineExecutionsRequest listPipelineExecutionsRequest) This is a variant of
listPipelineExecutions(software.amazon.awssdk.services.codepipeline.model.ListPipelineExecutionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.codepipeline.paginators.ListPipelineExecutionsPublisher publisher = client.listPipelineExecutionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.codepipeline.paginators.ListPipelineExecutionsPublisher publisher = client.listPipelineExecutionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codepipeline.model.ListPipelineExecutionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.codepipeline.model.ListPipelineExecutionsResponse response) { //... }; });
Please notice that the configuration of maxResults 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
listPipelineExecutions(software.amazon.awssdk.services.codepipeline.model.ListPipelineExecutionsRequest)
operation.- Parameters:
listPipelineExecutionsRequest
- Represents the input of aListPipelineExecutions
action.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- PipelineNotFoundException The pipeline was specified in an invalid format or cannot be found.
- InvalidNextTokenException The next token was specified in an invalid format. Make sure that the next token you provide is the token returned by a previous call.
- 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPipelineExecutionsPaginator
default ListPipelineExecutionsPublisher listPipelineExecutionsPaginator(Consumer<ListPipelineExecutionsRequest.Builder> listPipelineExecutionsRequest) This is a variant of
listPipelineExecutions(software.amazon.awssdk.services.codepipeline.model.ListPipelineExecutionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.codepipeline.paginators.ListPipelineExecutionsPublisher publisher = client.listPipelineExecutionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.codepipeline.paginators.ListPipelineExecutionsPublisher publisher = client.listPipelineExecutionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codepipeline.model.ListPipelineExecutionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.codepipeline.model.ListPipelineExecutionsResponse response) { //... }; });
Please notice that the configuration of maxResults 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
listPipelineExecutions(software.amazon.awssdk.services.codepipeline.model.ListPipelineExecutionsRequest)
operation.
This is a convenience which creates an instance of the
ListPipelineExecutionsRequest.Builder
avoiding the need to create one manually viaListPipelineExecutionsRequest.builder()
- Parameters:
listPipelineExecutionsRequest
- AConsumer
that will call methods onListPipelineExecutionsRequest.Builder
to create a request. Represents the input of aListPipelineExecutions
action.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- PipelineNotFoundException The pipeline was specified in an invalid format or cannot be found.
- InvalidNextTokenException The next token was specified in an invalid format. Make sure that the next token you provide is the token returned by a previous call.
- 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPipelines
default CompletableFuture<ListPipelinesResponse> listPipelines(ListPipelinesRequest listPipelinesRequest) Gets a summary of all of the pipelines associated with your account.
- Parameters:
listPipelinesRequest
- Represents the input of aListPipelines
action.- Returns:
- A Java Future containing the result of the ListPipelines operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- InvalidNextTokenException The next token was specified in an invalid format. Make sure that the next token you provide is the token returned by a previous call.
- 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPipelines
default CompletableFuture<ListPipelinesResponse> listPipelines(Consumer<ListPipelinesRequest.Builder> listPipelinesRequest) Gets a summary of all of the pipelines associated with your account.
This is a convenience which creates an instance of the
ListPipelinesRequest.Builder
avoiding the need to create one manually viaListPipelinesRequest.builder()
- Parameters:
listPipelinesRequest
- AConsumer
that will call methods onListPipelinesRequest.Builder
to create a request. Represents the input of aListPipelines
action.- Returns:
- A Java Future containing the result of the ListPipelines operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- InvalidNextTokenException The next token was specified in an invalid format. Make sure that the next token you provide is the token returned by a previous call.
- 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPipelines
Gets a summary of all of the pipelines associated with your account.
- Returns:
- A Java Future containing the result of the ListPipelines operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- InvalidNextTokenException The next token was specified in an invalid format. Make sure that the next token you provide is the token returned by a previous call.
- 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPipelinesPaginator
This is a variant of
listPipelines(software.amazon.awssdk.services.codepipeline.model.ListPipelinesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.codepipeline.paginators.ListPipelinesPublisher publisher = client.listPipelinesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.codepipeline.paginators.ListPipelinesPublisher publisher = client.listPipelinesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codepipeline.model.ListPipelinesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.codepipeline.model.ListPipelinesResponse response) { //... }; });
Please notice that the configuration of maxResults 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
listPipelines(software.amazon.awssdk.services.codepipeline.model.ListPipelinesRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- InvalidNextTokenException The next token was specified in an invalid format. Make sure that the next token you provide is the token returned by a previous call.
- 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPipelinesPaginator
This is a variant of
listPipelines(software.amazon.awssdk.services.codepipeline.model.ListPipelinesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.codepipeline.paginators.ListPipelinesPublisher publisher = client.listPipelinesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.codepipeline.paginators.ListPipelinesPublisher publisher = client.listPipelinesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codepipeline.model.ListPipelinesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.codepipeline.model.ListPipelinesResponse response) { //... }; });
Please notice that the configuration of maxResults 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
listPipelines(software.amazon.awssdk.services.codepipeline.model.ListPipelinesRequest)
operation.- Parameters:
listPipelinesRequest
- Represents the input of aListPipelines
action.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- InvalidNextTokenException The next token was specified in an invalid format. Make sure that the next token you provide is the token returned by a previous call.
- 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPipelinesPaginator
default ListPipelinesPublisher listPipelinesPaginator(Consumer<ListPipelinesRequest.Builder> listPipelinesRequest) This is a variant of
listPipelines(software.amazon.awssdk.services.codepipeline.model.ListPipelinesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.codepipeline.paginators.ListPipelinesPublisher publisher = client.listPipelinesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.codepipeline.paginators.ListPipelinesPublisher publisher = client.listPipelinesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codepipeline.model.ListPipelinesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.codepipeline.model.ListPipelinesResponse response) { //... }; });
Please notice that the configuration of maxResults 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
listPipelines(software.amazon.awssdk.services.codepipeline.model.ListPipelinesRequest)
operation.
This is a convenience which creates an instance of the
ListPipelinesRequest.Builder
avoiding the need to create one manually viaListPipelinesRequest.builder()
- Parameters:
listPipelinesRequest
- AConsumer
that will call methods onListPipelinesRequest.Builder
to create a request. Represents the input of aListPipelines
action.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- InvalidNextTokenException The next token was specified in an invalid format. Make sure that the next token you provide is the token returned by a previous call.
- 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRuleExecutions
default CompletableFuture<ListRuleExecutionsResponse> listRuleExecutions(ListRuleExecutionsRequest listRuleExecutionsRequest) Lists the rule executions that have occurred in a pipeline configured for conditions with rules.
- Parameters:
listRuleExecutionsRequest
-- Returns:
- A Java Future containing the result of the ListRuleExecutions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- PipelineNotFoundException The pipeline was specified in an invalid format or cannot be found.
- InvalidNextTokenException The next token was specified in an invalid format. Make sure that the next token you provide is the token returned by a previous call.
- PipelineExecutionNotFoundException The pipeline execution was specified in an invalid format or cannot be found, or an execution ID does not belong to the specified pipeline.
- 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRuleExecutions
default CompletableFuture<ListRuleExecutionsResponse> listRuleExecutions(Consumer<ListRuleExecutionsRequest.Builder> listRuleExecutionsRequest) Lists the rule executions that have occurred in a pipeline configured for conditions with rules.
This is a convenience which creates an instance of the
ListRuleExecutionsRequest.Builder
avoiding the need to create one manually viaListRuleExecutionsRequest.builder()
- Parameters:
listRuleExecutionsRequest
- AConsumer
that will call methods onListRuleExecutionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListRuleExecutions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- PipelineNotFoundException The pipeline was specified in an invalid format or cannot be found.
- InvalidNextTokenException The next token was specified in an invalid format. Make sure that the next token you provide is the token returned by a previous call.
- PipelineExecutionNotFoundException The pipeline execution was specified in an invalid format or cannot be found, or an execution ID does not belong to the specified pipeline.
- 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRuleExecutionsPaginator
default ListRuleExecutionsPublisher listRuleExecutionsPaginator(ListRuleExecutionsRequest listRuleExecutionsRequest) This is a variant of
listRuleExecutions(software.amazon.awssdk.services.codepipeline.model.ListRuleExecutionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.codepipeline.paginators.ListRuleExecutionsPublisher publisher = client.listRuleExecutionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.codepipeline.paginators.ListRuleExecutionsPublisher publisher = client.listRuleExecutionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codepipeline.model.ListRuleExecutionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.codepipeline.model.ListRuleExecutionsResponse response) { //... }; });
Please notice that the configuration of maxResults 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
listRuleExecutions(software.amazon.awssdk.services.codepipeline.model.ListRuleExecutionsRequest)
operation.- Parameters:
listRuleExecutionsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- PipelineNotFoundException The pipeline was specified in an invalid format or cannot be found.
- InvalidNextTokenException The next token was specified in an invalid format. Make sure that the next token you provide is the token returned by a previous call.
- PipelineExecutionNotFoundException The pipeline execution was specified in an invalid format or cannot be found, or an execution ID does not belong to the specified pipeline.
- 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRuleExecutionsPaginator
default ListRuleExecutionsPublisher listRuleExecutionsPaginator(Consumer<ListRuleExecutionsRequest.Builder> listRuleExecutionsRequest) This is a variant of
listRuleExecutions(software.amazon.awssdk.services.codepipeline.model.ListRuleExecutionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.codepipeline.paginators.ListRuleExecutionsPublisher publisher = client.listRuleExecutionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.codepipeline.paginators.ListRuleExecutionsPublisher publisher = client.listRuleExecutionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codepipeline.model.ListRuleExecutionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.codepipeline.model.ListRuleExecutionsResponse response) { //... }; });
Please notice that the configuration of maxResults 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
listRuleExecutions(software.amazon.awssdk.services.codepipeline.model.ListRuleExecutionsRequest)
operation.
This is a convenience which creates an instance of the
ListRuleExecutionsRequest.Builder
avoiding the need to create one manually viaListRuleExecutionsRequest.builder()
- Parameters:
listRuleExecutionsRequest
- AConsumer
that will call methods onListRuleExecutionsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- PipelineNotFoundException The pipeline was specified in an invalid format or cannot be found.
- InvalidNextTokenException The next token was specified in an invalid format. Make sure that the next token you provide is the token returned by a previous call.
- PipelineExecutionNotFoundException The pipeline execution was specified in an invalid format or cannot be found, or an execution ID does not belong to the specified pipeline.
- 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRuleTypes
default CompletableFuture<ListRuleTypesResponse> listRuleTypes(ListRuleTypesRequest listRuleTypesRequest) Lists the rules for the condition.
- Parameters:
listRuleTypesRequest
-- Returns:
- A Java Future containing the result of the ListRuleTypes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- InvalidNextTokenException The next token was specified in an invalid format. Make sure that the next token you provide is the token returned by a previous call.
- 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRuleTypes
default CompletableFuture<ListRuleTypesResponse> listRuleTypes(Consumer<ListRuleTypesRequest.Builder> listRuleTypesRequest) Lists the rules for the condition.
This is a convenience which creates an instance of the
ListRuleTypesRequest.Builder
avoiding the need to create one manually viaListRuleTypesRequest.builder()
- Parameters:
listRuleTypesRequest
- AConsumer
that will call methods onListRuleTypesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListRuleTypes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- InvalidNextTokenException The next token was specified in an invalid format. Make sure that the next token you provide is the token returned by a previous call.
- 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Gets the set of key-value pairs (metadata) that are used to manage the resource.
- Parameters:
listTagsForResourceRequest
-- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- ResourceNotFoundException The resource was specified in an invalid format.
- InvalidNextTokenException The next token was specified in an invalid format. Make sure that the next token you provide is the token returned by a previous call.
- InvalidArnException The specified resource ARN 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Gets the set of key-value pairs (metadata) that are used to manage the resource.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- ResourceNotFoundException The resource was specified in an invalid format.
- InvalidNextTokenException The next token was specified in an invalid format. Make sure that the next token you provide is the token returned by a previous call.
- InvalidArnException The specified resource ARN 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResourcePaginator
default ListTagsForResourcePublisher listTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest) This is a variant of
listTagsForResource(software.amazon.awssdk.services.codepipeline.model.ListTagsForResourceRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.codepipeline.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.codepipeline.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codepipeline.model.ListTagsForResourceResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.codepipeline.model.ListTagsForResourceResponse response) { //... }; });
Please notice that the configuration of maxResults 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
listTagsForResource(software.amazon.awssdk.services.codepipeline.model.ListTagsForResourceRequest)
operation.- Parameters:
listTagsForResourceRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- ResourceNotFoundException The resource was specified in an invalid format.
- InvalidNextTokenException The next token was specified in an invalid format. Make sure that the next token you provide is the token returned by a previous call.
- InvalidArnException The specified resource ARN 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResourcePaginator
default ListTagsForResourcePublisher listTagsForResourcePaginator(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) This is a variant of
listTagsForResource(software.amazon.awssdk.services.codepipeline.model.ListTagsForResourceRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.codepipeline.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.codepipeline.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codepipeline.model.ListTagsForResourceResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.codepipeline.model.ListTagsForResourceResponse response) { //... }; });
Please notice that the configuration of maxResults 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
listTagsForResource(software.amazon.awssdk.services.codepipeline.model.ListTagsForResourceRequest)
operation.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- ResourceNotFoundException The resource was specified in an invalid format.
- InvalidNextTokenException The next token was specified in an invalid format. Make sure that the next token you provide is the token returned by a previous call.
- InvalidArnException The specified resource ARN 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listWebhooks
default CompletableFuture<ListWebhooksResponse> listWebhooks(ListWebhooksRequest listWebhooksRequest) Gets a listing of all the webhooks in this Amazon Web Services Region for this account. The output lists all webhooks and includes the webhook URL and ARN and the configuration for each webhook.
- Parameters:
listWebhooksRequest
-- Returns:
- A Java Future containing the result of the ListWebhooks operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- InvalidNextTokenException The next token was specified in an invalid format. Make sure that the next token you provide is the token returned by a previous call.
- 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listWebhooks
default CompletableFuture<ListWebhooksResponse> listWebhooks(Consumer<ListWebhooksRequest.Builder> listWebhooksRequest) Gets a listing of all the webhooks in this Amazon Web Services Region for this account. The output lists all webhooks and includes the webhook URL and ARN and the configuration for each webhook.
This is a convenience which creates an instance of the
ListWebhooksRequest.Builder
avoiding the need to create one manually viaListWebhooksRequest.builder()
- Parameters:
listWebhooksRequest
- AConsumer
that will call methods onListWebhooksRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListWebhooks operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- InvalidNextTokenException The next token was specified in an invalid format. Make sure that the next token you provide is the token returned by a previous call.
- 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listWebhooks
Gets a listing of all the webhooks in this Amazon Web Services Region for this account. The output lists all webhooks and includes the webhook URL and ARN and the configuration for each webhook.
- Returns:
- A Java Future containing the result of the ListWebhooks operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- InvalidNextTokenException The next token was specified in an invalid format. Make sure that the next token you provide is the token returned by a previous call.
- 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listWebhooksPaginator
This is a variant of
listWebhooks(software.amazon.awssdk.services.codepipeline.model.ListWebhooksRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.codepipeline.paginators.ListWebhooksPublisher publisher = client.listWebhooksPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.codepipeline.paginators.ListWebhooksPublisher publisher = client.listWebhooksPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codepipeline.model.ListWebhooksResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.codepipeline.model.ListWebhooksResponse response) { //... }; });
Please notice that the configuration of MaxResults 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
listWebhooks(software.amazon.awssdk.services.codepipeline.model.ListWebhooksRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- InvalidNextTokenException The next token was specified in an invalid format. Make sure that the next token you provide is the token returned by a previous call.
- 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listWebhooksPaginator
This is a variant of
listWebhooks(software.amazon.awssdk.services.codepipeline.model.ListWebhooksRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.codepipeline.paginators.ListWebhooksPublisher publisher = client.listWebhooksPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.codepipeline.paginators.ListWebhooksPublisher publisher = client.listWebhooksPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codepipeline.model.ListWebhooksResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.codepipeline.model.ListWebhooksResponse response) { //... }; });
Please notice that the configuration of MaxResults 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
listWebhooks(software.amazon.awssdk.services.codepipeline.model.ListWebhooksRequest)
operation.- Parameters:
listWebhooksRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- InvalidNextTokenException The next token was specified in an invalid format. Make sure that the next token you provide is the token returned by a previous call.
- 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listWebhooksPaginator
default ListWebhooksPublisher listWebhooksPaginator(Consumer<ListWebhooksRequest.Builder> listWebhooksRequest) This is a variant of
listWebhooks(software.amazon.awssdk.services.codepipeline.model.ListWebhooksRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.codepipeline.paginators.ListWebhooksPublisher publisher = client.listWebhooksPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.codepipeline.paginators.ListWebhooksPublisher publisher = client.listWebhooksPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codepipeline.model.ListWebhooksResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.codepipeline.model.ListWebhooksResponse response) { //... }; });
Please notice that the configuration of MaxResults 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
listWebhooks(software.amazon.awssdk.services.codepipeline.model.ListWebhooksRequest)
operation.
This is a convenience which creates an instance of the
ListWebhooksRequest.Builder
avoiding the need to create one manually viaListWebhooksRequest.builder()
- Parameters:
listWebhooksRequest
- AConsumer
that will call methods onListWebhooksRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- InvalidNextTokenException The next token was specified in an invalid format. Make sure that the next token you provide is the token returned by a previous call.
- 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
overrideStageCondition
default CompletableFuture<OverrideStageConditionResponse> overrideStageCondition(OverrideStageConditionRequest overrideStageConditionRequest) Used to override a stage condition.
- Parameters:
overrideStageConditionRequest
-- Returns:
- A Java Future containing the result of the OverrideStageCondition operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- ConflictException Your request cannot be handled because the pipeline is busy handling ongoing activities. Try again later.
- PipelineNotFoundException The pipeline was specified in an invalid format or cannot be found.
- StageNotFoundException The stage was specified in an invalid format or cannot be found.
- ConditionNotOverridableException Unable to override because the condition does not allow overrides.
- NotLatestPipelineExecutionException The stage has failed in a later run of the pipeline and the
pipelineExecutionId
associated with the request is out of date. - ConcurrentPipelineExecutionsLimitExceededException The pipeline has reached the limit for concurrent pipeline executions.
- 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
overrideStageCondition
default CompletableFuture<OverrideStageConditionResponse> overrideStageCondition(Consumer<OverrideStageConditionRequest.Builder> overrideStageConditionRequest) Used to override a stage condition.
This is a convenience which creates an instance of the
OverrideStageConditionRequest.Builder
avoiding the need to create one manually viaOverrideStageConditionRequest.builder()
- Parameters:
overrideStageConditionRequest
- AConsumer
that will call methods onOverrideStageConditionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the OverrideStageCondition operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- ConflictException Your request cannot be handled because the pipeline is busy handling ongoing activities. Try again later.
- PipelineNotFoundException The pipeline was specified in an invalid format or cannot be found.
- StageNotFoundException The stage was specified in an invalid format or cannot be found.
- ConditionNotOverridableException Unable to override because the condition does not allow overrides.
- NotLatestPipelineExecutionException The stage has failed in a later run of the pipeline and the
pipelineExecutionId
associated with the request is out of date. - ConcurrentPipelineExecutionsLimitExceededException The pipeline has reached the limit for concurrent pipeline executions.
- 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
pollForJobs
Returns information about any jobs for CodePipeline to act on.
PollForJobs
is valid only for action types with "Custom" in the owner field. If the action type containsAWS
orThirdParty
in the owner field, thePollForJobs
action returns an error.When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.
- Parameters:
pollForJobsRequest
- Represents the input of aPollForJobs
action.- Returns:
- A Java Future containing the result of the PollForJobs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- ActionTypeNotFoundException The specified action type cannot be 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
pollForJobs
default CompletableFuture<PollForJobsResponse> pollForJobs(Consumer<PollForJobsRequest.Builder> pollForJobsRequest) Returns information about any jobs for CodePipeline to act on.
PollForJobs
is valid only for action types with "Custom" in the owner field. If the action type containsAWS
orThirdParty
in the owner field, thePollForJobs
action returns an error.When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.
This is a convenience which creates an instance of the
PollForJobsRequest.Builder
avoiding the need to create one manually viaPollForJobsRequest.builder()
- Parameters:
pollForJobsRequest
- AConsumer
that will call methods onPollForJobsRequest.Builder
to create a request. Represents the input of aPollForJobs
action.- Returns:
- A Java Future containing the result of the PollForJobs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- ActionTypeNotFoundException The specified action type cannot be 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
pollForThirdPartyJobs
default CompletableFuture<PollForThirdPartyJobsResponse> pollForThirdPartyJobs(PollForThirdPartyJobsRequest pollForThirdPartyJobsRequest) Determines whether there are any third party jobs for a job worker to act on. Used for partner actions only.
When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts.
- Parameters:
pollForThirdPartyJobsRequest
- Represents the input of aPollForThirdPartyJobs
action.- Returns:
- A Java Future containing the result of the PollForThirdPartyJobs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ActionTypeNotFoundException The specified action type cannot be found.
- ValidationException The validation 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
pollForThirdPartyJobs
default CompletableFuture<PollForThirdPartyJobsResponse> pollForThirdPartyJobs(Consumer<PollForThirdPartyJobsRequest.Builder> pollForThirdPartyJobsRequest) Determines whether there are any third party jobs for a job worker to act on. Used for partner actions only.
When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts.
This is a convenience which creates an instance of the
PollForThirdPartyJobsRequest.Builder
avoiding the need to create one manually viaPollForThirdPartyJobsRequest.builder()
- Parameters:
pollForThirdPartyJobsRequest
- AConsumer
that will call methods onPollForThirdPartyJobsRequest.Builder
to create a request. Represents the input of aPollForThirdPartyJobs
action.- Returns:
- A Java Future containing the result of the PollForThirdPartyJobs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ActionTypeNotFoundException The specified action type cannot be found.
- ValidationException The validation 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putActionRevision
default CompletableFuture<PutActionRevisionResponse> putActionRevision(PutActionRevisionRequest putActionRevisionRequest) Provides information to CodePipeline about new revisions to a source.
- Parameters:
putActionRevisionRequest
- Represents the input of aPutActionRevision
action.- Returns:
- A Java Future containing the result of the PutActionRevision operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- PipelineNotFoundException The pipeline was specified in an invalid format or cannot be found.
- StageNotFoundException The stage was specified in an invalid format or cannot be found.
- ActionNotFoundException The specified action cannot be found.
- ValidationException The validation was specified in an invalid format.
- ConcurrentPipelineExecutionsLimitExceededException The pipeline has reached the limit for concurrent pipeline executions.
- 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putActionRevision
default CompletableFuture<PutActionRevisionResponse> putActionRevision(Consumer<PutActionRevisionRequest.Builder> putActionRevisionRequest) Provides information to CodePipeline about new revisions to a source.
This is a convenience which creates an instance of the
PutActionRevisionRequest.Builder
avoiding the need to create one manually viaPutActionRevisionRequest.builder()
- Parameters:
putActionRevisionRequest
- AConsumer
that will call methods onPutActionRevisionRequest.Builder
to create a request. Represents the input of aPutActionRevision
action.- Returns:
- A Java Future containing the result of the PutActionRevision operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- PipelineNotFoundException The pipeline was specified in an invalid format or cannot be found.
- StageNotFoundException The stage was specified in an invalid format or cannot be found.
- ActionNotFoundException The specified action cannot be found.
- ValidationException The validation was specified in an invalid format.
- ConcurrentPipelineExecutionsLimitExceededException The pipeline has reached the limit for concurrent pipeline executions.
- 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putApprovalResult
default CompletableFuture<PutApprovalResultResponse> putApprovalResult(PutApprovalResultRequest putApprovalResultRequest) Provides the response to a manual approval request to CodePipeline. Valid responses include Approved and Rejected.
- Parameters:
putApprovalResultRequest
- Represents the input of aPutApprovalResult
action.- Returns:
- A Java Future containing the result of the PutApprovalResult operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidApprovalTokenException The approval request already received a response or has expired.
- ApprovalAlreadyCompletedException The approval action has already been approved or rejected.
- PipelineNotFoundException The pipeline was specified in an invalid format or cannot be found.
- StageNotFoundException The stage was specified in an invalid format or cannot be found.
- ActionNotFoundException The specified action cannot be found.
- ValidationException The validation 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putApprovalResult
default CompletableFuture<PutApprovalResultResponse> putApprovalResult(Consumer<PutApprovalResultRequest.Builder> putApprovalResultRequest) Provides the response to a manual approval request to CodePipeline. Valid responses include Approved and Rejected.
This is a convenience which creates an instance of the
PutApprovalResultRequest.Builder
avoiding the need to create one manually viaPutApprovalResultRequest.builder()
- Parameters:
putApprovalResultRequest
- AConsumer
that will call methods onPutApprovalResultRequest.Builder
to create a request. Represents the input of aPutApprovalResult
action.- Returns:
- A Java Future containing the result of the PutApprovalResult operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidApprovalTokenException The approval request already received a response or has expired.
- ApprovalAlreadyCompletedException The approval action has already been approved or rejected.
- PipelineNotFoundException The pipeline was specified in an invalid format or cannot be found.
- StageNotFoundException The stage was specified in an invalid format or cannot be found.
- ActionNotFoundException The specified action cannot be found.
- ValidationException The validation 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putJobFailureResult
default CompletableFuture<PutJobFailureResultResponse> putJobFailureResult(PutJobFailureResultRequest putJobFailureResultRequest) Represents the failure of a job as returned to the pipeline by a job worker. Used for custom actions only.
- Parameters:
putJobFailureResultRequest
- Represents the input of aPutJobFailureResult
action.- Returns:
- A Java Future containing the result of the PutJobFailureResult operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- JobNotFoundException The job was specified in an invalid format or cannot be found.
- InvalidJobStateException The job state 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putJobFailureResult
default CompletableFuture<PutJobFailureResultResponse> putJobFailureResult(Consumer<PutJobFailureResultRequest.Builder> putJobFailureResultRequest) Represents the failure of a job as returned to the pipeline by a job worker. Used for custom actions only.
This is a convenience which creates an instance of the
PutJobFailureResultRequest.Builder
avoiding the need to create one manually viaPutJobFailureResultRequest.builder()
- Parameters:
putJobFailureResultRequest
- AConsumer
that will call methods onPutJobFailureResultRequest.Builder
to create a request. Represents the input of aPutJobFailureResult
action.- Returns:
- A Java Future containing the result of the PutJobFailureResult operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- JobNotFoundException The job was specified in an invalid format or cannot be found.
- InvalidJobStateException The job state 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putJobSuccessResult
default CompletableFuture<PutJobSuccessResultResponse> putJobSuccessResult(PutJobSuccessResultRequest putJobSuccessResultRequest) Represents the success of a job as returned to the pipeline by a job worker. Used for custom actions only.
- Parameters:
putJobSuccessResultRequest
- Represents the input of aPutJobSuccessResult
action.- Returns:
- A Java Future containing the result of the PutJobSuccessResult operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- JobNotFoundException The job was specified in an invalid format or cannot be found.
- InvalidJobStateException The job state was specified in an invalid format.
- OutputVariablesSizeExceededException Exceeded the total size limit for all variables in the pipeline.
- 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putJobSuccessResult
default CompletableFuture<PutJobSuccessResultResponse> putJobSuccessResult(Consumer<PutJobSuccessResultRequest.Builder> putJobSuccessResultRequest) Represents the success of a job as returned to the pipeline by a job worker. Used for custom actions only.
This is a convenience which creates an instance of the
PutJobSuccessResultRequest.Builder
avoiding the need to create one manually viaPutJobSuccessResultRequest.builder()
- Parameters:
putJobSuccessResultRequest
- AConsumer
that will call methods onPutJobSuccessResultRequest.Builder
to create a request. Represents the input of aPutJobSuccessResult
action.- Returns:
- A Java Future containing the result of the PutJobSuccessResult operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- JobNotFoundException The job was specified in an invalid format or cannot be found.
- InvalidJobStateException The job state was specified in an invalid format.
- OutputVariablesSizeExceededException Exceeded the total size limit for all variables in the pipeline.
- 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putThirdPartyJobFailureResult
default CompletableFuture<PutThirdPartyJobFailureResultResponse> putThirdPartyJobFailureResult(PutThirdPartyJobFailureResultRequest putThirdPartyJobFailureResultRequest) Represents the failure of a third party job as returned to the pipeline by a job worker. Used for partner actions only.
- Parameters:
putThirdPartyJobFailureResultRequest
- Represents the input of aPutThirdPartyJobFailureResult
action.- Returns:
- A Java Future containing the result of the PutThirdPartyJobFailureResult operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- JobNotFoundException The job was specified in an invalid format or cannot be found.
- InvalidJobStateException The job state was specified in an invalid format.
- InvalidClientTokenException The client 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putThirdPartyJobFailureResult
default CompletableFuture<PutThirdPartyJobFailureResultResponse> putThirdPartyJobFailureResult(Consumer<PutThirdPartyJobFailureResultRequest.Builder> putThirdPartyJobFailureResultRequest) Represents the failure of a third party job as returned to the pipeline by a job worker. Used for partner actions only.
This is a convenience which creates an instance of the
PutThirdPartyJobFailureResultRequest.Builder
avoiding the need to create one manually viaPutThirdPartyJobFailureResultRequest.builder()
- Parameters:
putThirdPartyJobFailureResultRequest
- AConsumer
that will call methods onPutThirdPartyJobFailureResultRequest.Builder
to create a request. Represents the input of aPutThirdPartyJobFailureResult
action.- Returns:
- A Java Future containing the result of the PutThirdPartyJobFailureResult operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- JobNotFoundException The job was specified in an invalid format or cannot be found.
- InvalidJobStateException The job state was specified in an invalid format.
- InvalidClientTokenException The client 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putThirdPartyJobSuccessResult
default CompletableFuture<PutThirdPartyJobSuccessResultResponse> putThirdPartyJobSuccessResult(PutThirdPartyJobSuccessResultRequest putThirdPartyJobSuccessResultRequest) Represents the success of a third party job as returned to the pipeline by a job worker. Used for partner actions only.
- Parameters:
putThirdPartyJobSuccessResultRequest
- Represents the input of aPutThirdPartyJobSuccessResult
action.- Returns:
- A Java Future containing the result of the PutThirdPartyJobSuccessResult operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- JobNotFoundException The job was specified in an invalid format or cannot be found.
- InvalidJobStateException The job state was specified in an invalid format.
- InvalidClientTokenException The client 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putThirdPartyJobSuccessResult
default CompletableFuture<PutThirdPartyJobSuccessResultResponse> putThirdPartyJobSuccessResult(Consumer<PutThirdPartyJobSuccessResultRequest.Builder> putThirdPartyJobSuccessResultRequest) Represents the success of a third party job as returned to the pipeline by a job worker. Used for partner actions only.
This is a convenience which creates an instance of the
PutThirdPartyJobSuccessResultRequest.Builder
avoiding the need to create one manually viaPutThirdPartyJobSuccessResultRequest.builder()
- Parameters:
putThirdPartyJobSuccessResultRequest
- AConsumer
that will call methods onPutThirdPartyJobSuccessResultRequest.Builder
to create a request. Represents the input of aPutThirdPartyJobSuccessResult
action.- Returns:
- A Java Future containing the result of the PutThirdPartyJobSuccessResult operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- JobNotFoundException The job was specified in an invalid format or cannot be found.
- InvalidJobStateException The job state was specified in an invalid format.
- InvalidClientTokenException The client 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putWebhook
Defines a webhook and returns a unique webhook URL generated by CodePipeline. This URL can be supplied to third party source hosting providers to call every time there's a code change. When CodePipeline receives a POST request on this URL, the pipeline defined in the webhook is started as long as the POST request satisfied the authentication and filtering requirements supplied when defining the webhook. RegisterWebhookWithThirdParty and DeregisterWebhookWithThirdParty APIs can be used to automatically configure supported third parties to call the generated webhook URL.
- Parameters:
putWebhookRequest
-- Returns:
- A Java Future containing the result of the PutWebhook operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- LimitExceededException The number of pipelines associated with the Amazon Web Services account has exceeded the limit allowed for the account.
- InvalidWebhookFilterPatternException The specified event filter rule is in an invalid format.
- InvalidWebhookAuthenticationParametersException The specified authentication type is in an invalid format.
- PipelineNotFoundException The pipeline was specified in an invalid format or cannot be found.
- TooManyTagsException The tags limit for a resource has been exceeded.
- InvalidTagsException The specified resource tags are invalid.
- ConcurrentModificationException Unable to modify the tag due to a simultaneous update request.
- 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putWebhook
default CompletableFuture<PutWebhookResponse> putWebhook(Consumer<PutWebhookRequest.Builder> putWebhookRequest) Defines a webhook and returns a unique webhook URL generated by CodePipeline. This URL can be supplied to third party source hosting providers to call every time there's a code change. When CodePipeline receives a POST request on this URL, the pipeline defined in the webhook is started as long as the POST request satisfied the authentication and filtering requirements supplied when defining the webhook. RegisterWebhookWithThirdParty and DeregisterWebhookWithThirdParty APIs can be used to automatically configure supported third parties to call the generated webhook URL.
This is a convenience which creates an instance of the
PutWebhookRequest.Builder
avoiding the need to create one manually viaPutWebhookRequest.builder()
- Parameters:
putWebhookRequest
- AConsumer
that will call methods onPutWebhookRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutWebhook operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- LimitExceededException The number of pipelines associated with the Amazon Web Services account has exceeded the limit allowed for the account.
- InvalidWebhookFilterPatternException The specified event filter rule is in an invalid format.
- InvalidWebhookAuthenticationParametersException The specified authentication type is in an invalid format.
- PipelineNotFoundException The pipeline was specified in an invalid format or cannot be found.
- TooManyTagsException The tags limit for a resource has been exceeded.
- InvalidTagsException The specified resource tags are invalid.
- ConcurrentModificationException Unable to modify the tag due to a simultaneous update request.
- 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
registerWebhookWithThirdParty
default CompletableFuture<RegisterWebhookWithThirdPartyResponse> registerWebhookWithThirdParty(RegisterWebhookWithThirdPartyRequest registerWebhookWithThirdPartyRequest) Configures a connection between the webhook that was created and the external tool with events to be detected.
- Parameters:
registerWebhookWithThirdPartyRequest
-- Returns:
- A Java Future containing the result of the RegisterWebhookWithThirdParty operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- WebhookNotFoundException The specified webhook was entered in an invalid format or cannot be 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
registerWebhookWithThirdParty
default CompletableFuture<RegisterWebhookWithThirdPartyResponse> registerWebhookWithThirdParty(Consumer<RegisterWebhookWithThirdPartyRequest.Builder> registerWebhookWithThirdPartyRequest) Configures a connection between the webhook that was created and the external tool with events to be detected.
This is a convenience which creates an instance of the
RegisterWebhookWithThirdPartyRequest.Builder
avoiding the need to create one manually viaRegisterWebhookWithThirdPartyRequest.builder()
- Parameters:
registerWebhookWithThirdPartyRequest
- AConsumer
that will call methods onRegisterWebhookWithThirdPartyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the RegisterWebhookWithThirdParty operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- WebhookNotFoundException The specified webhook was entered in an invalid format or cannot be 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
retryStageExecution
default CompletableFuture<RetryStageExecutionResponse> retryStageExecution(RetryStageExecutionRequest retryStageExecutionRequest) You can retry a stage that has failed without having to run a pipeline again from the beginning. You do this by either retrying the failed actions in a stage or by retrying all actions in the stage starting from the first action in the stage. When you retry the failed actions in a stage, all actions that are still in progress continue working, and failed actions are triggered again. When you retry a failed stage from the first action in the stage, the stage cannot have any actions in progress. Before a stage can be retried, it must either have all actions failed or some actions failed and some succeeded.
- Parameters:
retryStageExecutionRequest
- Represents the input of aRetryStageExecution
action.- Returns:
- A Java Future containing the result of the RetryStageExecution operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- ConflictException Your request cannot be handled because the pipeline is busy handling ongoing activities. Try again later.
- PipelineNotFoundException The pipeline was specified in an invalid format or cannot be found.
- StageNotFoundException The stage was specified in an invalid format or cannot be found.
- StageNotRetryableException Unable to retry. The pipeline structure or stage state might have changed while actions awaited retry, or the stage contains no failed actions.
- NotLatestPipelineExecutionException The stage has failed in a later run of the pipeline and the
pipelineExecutionId
associated with the request is out of date. - ConcurrentPipelineExecutionsLimitExceededException The pipeline has reached the limit for concurrent pipeline executions.
- 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
retryStageExecution
default CompletableFuture<RetryStageExecutionResponse> retryStageExecution(Consumer<RetryStageExecutionRequest.Builder> retryStageExecutionRequest) You can retry a stage that has failed without having to run a pipeline again from the beginning. You do this by either retrying the failed actions in a stage or by retrying all actions in the stage starting from the first action in the stage. When you retry the failed actions in a stage, all actions that are still in progress continue working, and failed actions are triggered again. When you retry a failed stage from the first action in the stage, the stage cannot have any actions in progress. Before a stage can be retried, it must either have all actions failed or some actions failed and some succeeded.
This is a convenience which creates an instance of the
RetryStageExecutionRequest.Builder
avoiding the need to create one manually viaRetryStageExecutionRequest.builder()
- Parameters:
retryStageExecutionRequest
- AConsumer
that will call methods onRetryStageExecutionRequest.Builder
to create a request. Represents the input of aRetryStageExecution
action.- Returns:
- A Java Future containing the result of the RetryStageExecution operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- ConflictException Your request cannot be handled because the pipeline is busy handling ongoing activities. Try again later.
- PipelineNotFoundException The pipeline was specified in an invalid format or cannot be found.
- StageNotFoundException The stage was specified in an invalid format or cannot be found.
- StageNotRetryableException Unable to retry. The pipeline structure or stage state might have changed while actions awaited retry, or the stage contains no failed actions.
- NotLatestPipelineExecutionException The stage has failed in a later run of the pipeline and the
pipelineExecutionId
associated with the request is out of date. - ConcurrentPipelineExecutionsLimitExceededException The pipeline has reached the limit for concurrent pipeline executions.
- 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
rollbackStage
default CompletableFuture<RollbackStageResponse> rollbackStage(RollbackStageRequest rollbackStageRequest) Rolls back a stage execution.
- Parameters:
rollbackStageRequest
-- Returns:
- A Java Future containing the result of the RollbackStage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- ConflictException Your request cannot be handled because the pipeline is busy handling ongoing activities. Try again later.
- PipelineNotFoundException The pipeline was specified in an invalid format or cannot be found.
- PipelineExecutionNotFoundException The pipeline execution was specified in an invalid format or cannot be found, or an execution ID does not belong to the specified pipeline.
- PipelineExecutionOutdatedException The specified pipeline execution is outdated and cannot be used as a target pipeline execution for rollback.
- StageNotFoundException The stage was specified in an invalid format or cannot be found.
- UnableToRollbackStageException Unable to roll back the stage. The cause might be if the pipeline version has changed since the target pipeline execution was deployed, the stage is currently running, or an incorrect target pipeline execution ID was provided.
- 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
rollbackStage
default CompletableFuture<RollbackStageResponse> rollbackStage(Consumer<RollbackStageRequest.Builder> rollbackStageRequest) Rolls back a stage execution.
This is a convenience which creates an instance of the
RollbackStageRequest.Builder
avoiding the need to create one manually viaRollbackStageRequest.builder()
- Parameters:
rollbackStageRequest
- AConsumer
that will call methods onRollbackStageRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the RollbackStage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- ConflictException Your request cannot be handled because the pipeline is busy handling ongoing activities. Try again later.
- PipelineNotFoundException The pipeline was specified in an invalid format or cannot be found.
- PipelineExecutionNotFoundException The pipeline execution was specified in an invalid format or cannot be found, or an execution ID does not belong to the specified pipeline.
- PipelineExecutionOutdatedException The specified pipeline execution is outdated and cannot be used as a target pipeline execution for rollback.
- StageNotFoundException The stage was specified in an invalid format or cannot be found.
- UnableToRollbackStageException Unable to roll back the stage. The cause might be if the pipeline version has changed since the target pipeline execution was deployed, the stage is currently running, or an incorrect target pipeline execution ID was provided.
- 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startPipelineExecution
default CompletableFuture<StartPipelineExecutionResponse> startPipelineExecution(StartPipelineExecutionRequest startPipelineExecutionRequest) Starts the specified pipeline. Specifically, it begins processing the latest commit to the source location specified as part of the pipeline.
- Parameters:
startPipelineExecutionRequest
- Represents the input of aStartPipelineExecution
action.- Returns:
- A Java Future containing the result of the StartPipelineExecution operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- ConflictException Your request cannot be handled because the pipeline is busy handling ongoing activities. Try again later.
- PipelineNotFoundException The pipeline was specified in an invalid format or cannot be found.
- ConcurrentPipelineExecutionsLimitExceededException The pipeline has reached the limit for concurrent pipeline executions.
- 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startPipelineExecution
default CompletableFuture<StartPipelineExecutionResponse> startPipelineExecution(Consumer<StartPipelineExecutionRequest.Builder> startPipelineExecutionRequest) Starts the specified pipeline. Specifically, it begins processing the latest commit to the source location specified as part of the pipeline.
This is a convenience which creates an instance of the
StartPipelineExecutionRequest.Builder
avoiding the need to create one manually viaStartPipelineExecutionRequest.builder()
- Parameters:
startPipelineExecutionRequest
- AConsumer
that will call methods onStartPipelineExecutionRequest.Builder
to create a request. Represents the input of aStartPipelineExecution
action.- Returns:
- A Java Future containing the result of the StartPipelineExecution operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- ConflictException Your request cannot be handled because the pipeline is busy handling ongoing activities. Try again later.
- PipelineNotFoundException The pipeline was specified in an invalid format or cannot be found.
- ConcurrentPipelineExecutionsLimitExceededException The pipeline has reached the limit for concurrent pipeline executions.
- 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopPipelineExecution
default CompletableFuture<StopPipelineExecutionResponse> stopPipelineExecution(StopPipelineExecutionRequest stopPipelineExecutionRequest) Stops the specified pipeline execution. You choose to either stop the pipeline execution by completing in-progress actions without starting subsequent actions, or by abandoning in-progress actions. While completing or abandoning in-progress actions, the pipeline execution is in a
Stopping
state. After all in-progress actions are completed or abandoned, the pipeline execution is in aStopped
state.- Parameters:
stopPipelineExecutionRequest
-- Returns:
- A Java Future containing the result of the StopPipelineExecution operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- ConflictException Your request cannot be handled because the pipeline is busy handling ongoing activities. Try again later.
- PipelineNotFoundException The pipeline was specified in an invalid format or cannot be found.
- PipelineExecutionNotStoppableException Unable to stop the pipeline execution. The execution might
already be in a
Stopped
state, or it might no longer be in progress. - DuplicatedStopRequestException The pipeline execution is already in a
Stopping
state. If you already chose to stop and wait, you cannot make that request again. You can choose to stop and abandon now, but be aware that this option can lead to failed tasks or out of sequence tasks. If you already chose to stop and abandon, you cannot make that request again. - 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopPipelineExecution
default CompletableFuture<StopPipelineExecutionResponse> stopPipelineExecution(Consumer<StopPipelineExecutionRequest.Builder> stopPipelineExecutionRequest) Stops the specified pipeline execution. You choose to either stop the pipeline execution by completing in-progress actions without starting subsequent actions, or by abandoning in-progress actions. While completing or abandoning in-progress actions, the pipeline execution is in a
Stopping
state. After all in-progress actions are completed or abandoned, the pipeline execution is in aStopped
state.
This is a convenience which creates an instance of the
StopPipelineExecutionRequest.Builder
avoiding the need to create one manually viaStopPipelineExecutionRequest.builder()
- Parameters:
stopPipelineExecutionRequest
- AConsumer
that will call methods onStopPipelineExecutionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StopPipelineExecution operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- ConflictException Your request cannot be handled because the pipeline is busy handling ongoing activities. Try again later.
- PipelineNotFoundException The pipeline was specified in an invalid format or cannot be found.
- PipelineExecutionNotStoppableException Unable to stop the pipeline execution. The execution might
already be in a
Stopped
state, or it might no longer be in progress. - DuplicatedStopRequestException The pipeline execution is already in a
Stopping
state. If you already chose to stop and wait, you cannot make that request again. You can choose to stop and abandon now, but be aware that this option can lead to failed tasks or out of sequence tasks. If you already chose to stop and abandon, you cannot make that request again. - 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.
- Parameters:
tagResourceRequest
-- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- ResourceNotFoundException The resource was specified in an invalid format.
- InvalidArnException The specified resource ARN is invalid.
- TooManyTagsException The tags limit for a resource has been exceeded.
- InvalidTagsException The specified resource tags are invalid.
- ConcurrentModificationException Unable to modify the tag due to a simultaneous update request.
- 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- ResourceNotFoundException The resource was specified in an invalid format.
- InvalidArnException The specified resource ARN is invalid.
- TooManyTagsException The tags limit for a resource has been exceeded.
- InvalidTagsException The specified resource tags are invalid.
- ConcurrentModificationException Unable to modify the tag due to a simultaneous update request.
- 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Removes tags from an Amazon Web Services resource.
- Parameters:
untagResourceRequest
-- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- ResourceNotFoundException The resource was specified in an invalid format.
- InvalidArnException The specified resource ARN is invalid.
- InvalidTagsException The specified resource tags are invalid.
- ConcurrentModificationException Unable to modify the tag due to a simultaneous update request.
- 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes tags from an Amazon Web Services resource.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- ResourceNotFoundException The resource was specified in an invalid format.
- InvalidArnException The specified resource ARN is invalid.
- InvalidTagsException The specified resource tags are invalid.
- ConcurrentModificationException Unable to modify the tag due to a simultaneous update request.
- 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateActionType
default CompletableFuture<UpdateActionTypeResponse> updateActionType(UpdateActionTypeRequest updateActionTypeRequest) Updates an action type that was created with any supported integration model, where the action type is to be used by customers of the action type provider. Use a JSON file with the action definition and
UpdateActionType
to provide the full structure.- Parameters:
updateActionTypeRequest
-- Returns:
- A Java Future containing the result of the UpdateActionType operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- RequestFailedException The request failed because of an unknown error, exception, or failure.
- ValidationException The validation was specified in an invalid format.
- ActionTypeNotFoundException The specified action type cannot be 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateActionType
default CompletableFuture<UpdateActionTypeResponse> updateActionType(Consumer<UpdateActionTypeRequest.Builder> updateActionTypeRequest) Updates an action type that was created with any supported integration model, where the action type is to be used by customers of the action type provider. Use a JSON file with the action definition and
UpdateActionType
to provide the full structure.
This is a convenience which creates an instance of the
UpdateActionTypeRequest.Builder
avoiding the need to create one manually viaUpdateActionTypeRequest.builder()
- Parameters:
updateActionTypeRequest
- AConsumer
that will call methods onUpdateActionTypeRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateActionType operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- RequestFailedException The request failed because of an unknown error, exception, or failure.
- ValidationException The validation was specified in an invalid format.
- ActionTypeNotFoundException The specified action type cannot be 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updatePipeline
default CompletableFuture<UpdatePipelineResponse> updatePipeline(UpdatePipelineRequest updatePipelineRequest) Updates a specified pipeline with edits or changes to its structure. Use a JSON file with the pipeline structure and
UpdatePipeline
to provide the full structure of the pipeline. Updating the pipeline increases the version number of the pipeline by 1.- Parameters:
updatePipelineRequest
- Represents the input of anUpdatePipeline
action.- Returns:
- A Java Future containing the result of the UpdatePipeline operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- InvalidStageDeclarationException The stage declaration was specified in an invalid format.
- InvalidActionDeclarationException The action declaration was specified in an invalid format.
- InvalidBlockerDeclarationException Reserved for future use.
- InvalidStructureException The structure was specified in an invalid format.
- LimitExceededException The number of pipelines associated with the Amazon Web Services account has exceeded the limit allowed for the 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updatePipeline
default CompletableFuture<UpdatePipelineResponse> updatePipeline(Consumer<UpdatePipelineRequest.Builder> updatePipelineRequest) Updates a specified pipeline with edits or changes to its structure. Use a JSON file with the pipeline structure and
UpdatePipeline
to provide the full structure of the pipeline. Updating the pipeline increases the version number of the pipeline by 1.
This is a convenience which creates an instance of the
UpdatePipelineRequest.Builder
avoiding the need to create one manually viaUpdatePipelineRequest.builder()
- Parameters:
updatePipelineRequest
- AConsumer
that will call methods onUpdatePipelineRequest.Builder
to create a request. Represents the input of anUpdatePipeline
action.- Returns:
- A Java Future containing the result of the UpdatePipeline operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The validation was specified in an invalid format.
- InvalidStageDeclarationException The stage declaration was specified in an invalid format.
- InvalidActionDeclarationException The action declaration was specified in an invalid format.
- InvalidBlockerDeclarationException Reserved for future use.
- InvalidStructureException The structure was specified in an invalid format.
- LimitExceededException The number of pipelines associated with the Amazon Web Services account has exceeded the limit allowed for the 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.
- CodePipelineException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aCodePipelineAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aCodePipelineAsyncClient
.
-