@Generated(value="software.amazon.awssdk:codegen") public interface CodePipelineAsyncClient extends SdkClient, SdkAutoCloseable
builder()
method.
Overview
This is the AWS CodePipeline API Reference. This guide provides descriptions of the actions and data types for AWS CodePipeline. Some functionality for your pipeline is only configurable through the API. For additional information, see the AWS CodePipeline User Guide.
You can use the AWS CodePipeline API to work with pipelines, stages, actions, gates, and transitions, as described below.
Pipelines are models of automated release processes. Each pipeline is uniquely named, and consists of actions, gates, and stages.
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.
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 the most recent revision of an artifact through the pipeline.
UpdatePipeline, which updates a pipeline with edits or changes to the structure of the pipeline.
Pipelines include stages, which are logical groupings of gates and actions. Each stage contains one or more actions that must complete before the next stage begins. A stage will result in success or failure. If a stage fails, then the pipeline stops at that stage and will remain stopped until either a new version of an artifact appears in the source location, or a user takes action to re-run 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, also refer to the AWS CodePipeline Pipeline Structure Reference.
Pipeline stages include actions, which are categorized into categories such as source or build actions performed within 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.
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 AWS CodePipeline
For third-party integrators or developers who want to create their own integrations with AWS CodePipeline, the expected sequence varies from the standard API user. In order to integrate with AWS CodePipeline, developers will 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 upon,
PutJobFailureResult, which provides details of a job failure, and
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 AWS CodePipeline. Partner actions are created by members of the AWS 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 upon,
PutThirdPartyJobFailureResult, which provides details of a job failure, and
PutThirdPartyJobSuccessResult, which provides details of a job success.
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_NAME |
Modifier and Type | Method and Description |
---|---|
default CompletableFuture<AcknowledgeJobResponse> |
acknowledgeJob(AcknowledgeJobRequest acknowledgeJobRequest)
Returns information about a specified job and whether that job has been received by the job worker.
|
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.
|
default CompletableFuture<AcknowledgeThirdPartyJobResponse> |
acknowledgeThirdPartyJob(AcknowledgeThirdPartyJobRequest acknowledgeThirdPartyJobRequest)
Confirms a job worker has received the specified job.
|
default CompletableFuture<AcknowledgeThirdPartyJobResponse> |
acknowledgeThirdPartyJob(Consumer<AcknowledgeThirdPartyJobRequest.Builder> acknowledgeThirdPartyJobRequest)
Confirms a job worker has received the specified job.
|
static CodePipelineAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
CodePipelineAsyncClient . |
static CodePipelineAsyncClient |
create()
Create a
CodePipelineAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from
the DefaultCredentialsProvider . |
default CompletableFuture<CreateCustomActionTypeResponse> |
createCustomActionType(Consumer<CreateCustomActionTypeRequest.Builder> createCustomActionTypeRequest)
Creates a new custom action that can be used in all pipelines associated with the AWS account.
|
default CompletableFuture<CreateCustomActionTypeResponse> |
createCustomActionType(CreateCustomActionTypeRequest createCustomActionTypeRequest)
Creates a new custom action that can be used in all pipelines associated with the AWS account.
|
default CompletableFuture<CreatePipelineResponse> |
createPipeline(Consumer<CreatePipelineRequest.Builder> createPipelineRequest)
Creates a pipeline.
|
default CompletableFuture<CreatePipelineResponse> |
createPipeline(CreatePipelineRequest createPipelineRequest)
Creates a pipeline.
|
default CompletableFuture<DeleteCustomActionTypeResponse> |
deleteCustomActionType(Consumer<DeleteCustomActionTypeRequest.Builder> deleteCustomActionTypeRequest)
Marks a custom action as deleted.
|
default CompletableFuture<DeleteCustomActionTypeResponse> |
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<DisableStageTransitionResponse> |
disableStageTransition(Consumer<DisableStageTransitionRequest.Builder> disableStageTransitionRequest)
Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline.
|
default CompletableFuture<DisableStageTransitionResponse> |
disableStageTransition(DisableStageTransitionRequest disableStageTransitionRequest)
Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline.
|
default CompletableFuture<EnableStageTransitionResponse> |
enableStageTransition(Consumer<EnableStageTransitionRequest.Builder> enableStageTransitionRequest)
Enables artifacts in a pipeline to transition to a stage in a pipeline.
|
default CompletableFuture<EnableStageTransitionResponse> |
enableStageTransition(EnableStageTransitionRequest enableStageTransitionRequest)
Enables artifacts in a pipeline to transition to a stage in a pipeline.
|
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.
|
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.
|
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.
|
default CompletableFuture<GetPipelineStateResponse> |
getPipelineState(Consumer<GetPipelineStateRequest.Builder> getPipelineStateRequest)
Returns information about the state of a pipeline, including the stages and actions.
|
default CompletableFuture<GetPipelineStateResponse> |
getPipelineState(GetPipelineStateRequest getPipelineStateRequest)
Returns information about the state of a pipeline, including the stages and actions.
|
default CompletableFuture<GetThirdPartyJobDetailsResponse> |
getThirdPartyJobDetails(Consumer<GetThirdPartyJobDetailsRequest.Builder> getThirdPartyJobDetailsRequest)
Requests the details of a job for a third party action.
|
default CompletableFuture<GetThirdPartyJobDetailsResponse> |
getThirdPartyJobDetails(GetThirdPartyJobDetailsRequest getThirdPartyJobDetailsRequest)
Requests the details of a job for a third party action.
|
default CompletableFuture<ListActionTypesResponse> |
listActionTypes()
Gets a summary of all AWS CodePipeline action types associated with your account.
|
default CompletableFuture<ListActionTypesResponse> |
listActionTypes(Consumer<ListActionTypesRequest.Builder> listActionTypesRequest)
Gets a summary of all AWS CodePipeline action types associated with your account.
|
default CompletableFuture<ListActionTypesResponse> |
listActionTypes(ListActionTypesRequest listActionTypesRequest)
Gets a summary of all AWS CodePipeline action types associated with your account.
|
default CompletableFuture<ListPipelineExecutionsResponse> |
listPipelineExecutions(Consumer<ListPipelineExecutionsRequest.Builder> listPipelineExecutionsRequest)
Gets a summary of the most recent executions for a pipeline.
|
default CompletableFuture<ListPipelineExecutionsResponse> |
listPipelineExecutions(ListPipelineExecutionsRequest listPipelineExecutionsRequest)
Gets a summary of the most recent executions for a pipeline.
|
default CompletableFuture<ListPipelinesResponse> |
listPipelines()
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 CompletableFuture<PollForJobsResponse> |
pollForJobs(Consumer<PollForJobsRequest.Builder> pollForJobsRequest)
Returns information about any jobs for AWS CodePipeline to act upon.
|
default CompletableFuture<PollForJobsResponse> |
pollForJobs(PollForJobsRequest pollForJobsRequest)
Returns information about any jobs for AWS CodePipeline to act upon.
|
default CompletableFuture<PollForThirdPartyJobsResponse> |
pollForThirdPartyJobs(Consumer<PollForThirdPartyJobsRequest.Builder> pollForThirdPartyJobsRequest)
Determines whether there are any third party jobs for a job worker to act on.
|
default CompletableFuture<PollForThirdPartyJobsResponse> |
pollForThirdPartyJobs(PollForThirdPartyJobsRequest pollForThirdPartyJobsRequest)
Determines whether there are any third party jobs for a job worker to act on.
|
default CompletableFuture<PutActionRevisionResponse> |
putActionRevision(Consumer<PutActionRevisionRequest.Builder> putActionRevisionRequest)
Provides information to AWS CodePipeline about new revisions to a source.
|
default CompletableFuture<PutActionRevisionResponse> |
putActionRevision(PutActionRevisionRequest putActionRevisionRequest)
Provides information to AWS CodePipeline about new revisions to a source.
|
default CompletableFuture<PutApprovalResultResponse> |
putApprovalResult(Consumer<PutApprovalResultRequest.Builder> putApprovalResultRequest)
Provides the response to a manual approval request to AWS CodePipeline.
|
default CompletableFuture<PutApprovalResultResponse> |
putApprovalResult(PutApprovalResultRequest putApprovalResultRequest)
Provides the response to a manual approval request to AWS CodePipeline.
|
default CompletableFuture<PutJobFailureResultResponse> |
putJobFailureResult(Consumer<PutJobFailureResultRequest.Builder> putJobFailureResultRequest)
Represents the failure of a job as returned to the pipeline by a job worker.
|
default CompletableFuture<PutJobFailureResultResponse> |
putJobFailureResult(PutJobFailureResultRequest putJobFailureResultRequest)
Represents the failure of a job as returned to the pipeline by a job worker.
|
default CompletableFuture<PutJobSuccessResultResponse> |
putJobSuccessResult(Consumer<PutJobSuccessResultRequest.Builder> putJobSuccessResultRequest)
Represents the success of a job as returned to the pipeline by a job worker.
|
default CompletableFuture<PutJobSuccessResultResponse> |
putJobSuccessResult(PutJobSuccessResultRequest putJobSuccessResultRequest)
Represents the success of a job as returned to the pipeline by a job worker.
|
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.
|
default CompletableFuture<PutThirdPartyJobFailureResultResponse> |
putThirdPartyJobFailureResult(PutThirdPartyJobFailureResultRequest putThirdPartyJobFailureResultRequest)
Represents the failure of a third party job as returned to the pipeline by a job worker.
|
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.
|
default CompletableFuture<PutThirdPartyJobSuccessResultResponse> |
putThirdPartyJobSuccessResult(PutThirdPartyJobSuccessResultRequest putThirdPartyJobSuccessResultRequest)
Represents the success of a third party job as returned to the pipeline by a job worker.
|
default CompletableFuture<RetryStageExecutionResponse> |
retryStageExecution(Consumer<RetryStageExecutionRequest.Builder> retryStageExecutionRequest)
Resumes the pipeline execution by retrying the last failed actions in a stage.
|
default CompletableFuture<RetryStageExecutionResponse> |
retryStageExecution(RetryStageExecutionRequest retryStageExecutionRequest)
Resumes the pipeline execution by retrying the last failed actions in a stage.
|
default CompletableFuture<StartPipelineExecutionResponse> |
startPipelineExecution(Consumer<StartPipelineExecutionRequest.Builder> startPipelineExecutionRequest)
Starts the specified pipeline.
|
default CompletableFuture<StartPipelineExecutionResponse> |
startPipelineExecution(StartPipelineExecutionRequest startPipelineExecutionRequest)
Starts the specified pipeline.
|
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.
|
serviceName
close
static final String SERVICE_NAME
static CodePipelineAsyncClient create()
CodePipelineAsyncClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from
the DefaultCredentialsProvider
.static CodePipelineAsyncClientBuilder builder()
CodePipelineAsyncClient
.default CompletableFuture<AcknowledgeJobResponse> acknowledgeJob(AcknowledgeJobRequest acknowledgeJobRequest)
Returns information about a specified job and whether that job has been received by the job worker. Only used for custom actions.
acknowledgeJobRequest
- Represents the input of an AcknowledgeJob action.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. Only used for custom actions.
AcknowledgeJobRequest.Builder
avoiding the need to
create one manually via AcknowledgeJobRequest.builder()
acknowledgeJobRequest
- a Consumer
that will call methods on AcknowledgeJobInput.Builder
.default CompletableFuture<AcknowledgeThirdPartyJobResponse> acknowledgeThirdPartyJob(AcknowledgeThirdPartyJobRequest acknowledgeThirdPartyJobRequest)
Confirms a job worker has received the specified job. Only used for partner actions.
acknowledgeThirdPartyJobRequest
- Represents the input of an AcknowledgeThirdPartyJob action.default CompletableFuture<AcknowledgeThirdPartyJobResponse> acknowledgeThirdPartyJob(Consumer<AcknowledgeThirdPartyJobRequest.Builder> acknowledgeThirdPartyJobRequest)
Confirms a job worker has received the specified job. Only used for partner actions.
AcknowledgeThirdPartyJobRequest.Builder
avoiding
the need to create one manually via AcknowledgeThirdPartyJobRequest.builder()
acknowledgeThirdPartyJobRequest
- a Consumer
that will call methods on AcknowledgeThirdPartyJobInput.Builder
.default CompletableFuture<CreateCustomActionTypeResponse> createCustomActionType(CreateCustomActionTypeRequest createCustomActionTypeRequest)
Creates a new custom action that can be used in all pipelines associated with the AWS account. Only used for custom actions.
createCustomActionTypeRequest
- Represents the input of a CreateCustomActionType operation.default CompletableFuture<CreateCustomActionTypeResponse> createCustomActionType(Consumer<CreateCustomActionTypeRequest.Builder> createCustomActionTypeRequest)
Creates a new custom action that can be used in all pipelines associated with the AWS account. Only used for custom actions.
CreateCustomActionTypeRequest.Builder
avoiding the
need to create one manually via CreateCustomActionTypeRequest.builder()
createCustomActionTypeRequest
- a Consumer
that will call methods on CreateCustomActionTypeInput.Builder
.default CompletableFuture<CreatePipelineResponse> createPipeline(CreatePipelineRequest createPipelineRequest)
Creates a pipeline.
createPipelineRequest
- Represents the input of a CreatePipeline action.default CompletableFuture<CreatePipelineResponse> createPipeline(Consumer<CreatePipelineRequest.Builder> createPipelineRequest)
Creates a pipeline.
CreatePipelineRequest.Builder
avoiding the need to
create one manually via CreatePipelineRequest.builder()
createPipelineRequest
- a Consumer
that will call methods on CreatePipelineInput.Builder
.default CompletableFuture<DeleteCustomActionTypeResponse> deleteCustomActionType(DeleteCustomActionTypeRequest deleteCustomActionTypeRequest)
Marks a custom action as deleted. PollForJobs for the custom action will fail after the action is marked for deletion. Only used for custom actions.
You cannot recreate a custom action after it has been deleted unless you increase the version number of the action.
deleteCustomActionTypeRequest
- Represents the input of a DeleteCustomActionType operation. The custom action will be marked as deleted.default CompletableFuture<DeleteCustomActionTypeResponse> deleteCustomActionType(Consumer<DeleteCustomActionTypeRequest.Builder> deleteCustomActionTypeRequest)
Marks a custom action as deleted. PollForJobs for the custom action will fail after the action is marked for deletion. Only used for custom actions.
You cannot recreate a custom action after it has been deleted unless you increase the version number of the action.
DeleteCustomActionTypeRequest.Builder
avoiding the
need to create one manually via DeleteCustomActionTypeRequest.builder()
deleteCustomActionTypeRequest
- a Consumer
that will call methods on DeleteCustomActionTypeInput.Builder
.default CompletableFuture<DeletePipelineResponse> deletePipeline(DeletePipelineRequest deletePipelineRequest)
Deletes the specified pipeline.
deletePipelineRequest
- Represents the input of a DeletePipeline action.default CompletableFuture<DeletePipelineResponse> deletePipeline(Consumer<DeletePipelineRequest.Builder> deletePipelineRequest)
Deletes the specified pipeline.
DeletePipelineRequest.Builder
avoiding the need to
create one manually via DeletePipelineRequest.builder()
deletePipelineRequest
- a Consumer
that will call methods on DeletePipelineInput.Builder
.default CompletableFuture<DisableStageTransitionResponse> disableStageTransition(DisableStageTransitionRequest disableStageTransitionRequest)
Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline.
disableStageTransitionRequest
- Represents the input of a DisableStageTransition action.default CompletableFuture<DisableStageTransitionResponse> disableStageTransition(Consumer<DisableStageTransitionRequest.Builder> disableStageTransitionRequest)
Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline.
DisableStageTransitionRequest.Builder
avoiding the
need to create one manually via DisableStageTransitionRequest.builder()
disableStageTransitionRequest
- a Consumer
that will call methods on DisableStageTransitionInput.Builder
.default CompletableFuture<EnableStageTransitionResponse> enableStageTransition(EnableStageTransitionRequest enableStageTransitionRequest)
Enables artifacts in a pipeline to transition to a stage in a pipeline.
enableStageTransitionRequest
- Represents the input of an EnableStageTransition action.default CompletableFuture<EnableStageTransitionResponse> enableStageTransition(Consumer<EnableStageTransitionRequest.Builder> enableStageTransitionRequest)
Enables artifacts in a pipeline to transition to a stage in a pipeline.
EnableStageTransitionRequest.Builder
avoiding the
need to create one manually via EnableStageTransitionRequest.builder()
enableStageTransitionRequest
- a Consumer
that will call methods on EnableStageTransitionInput.Builder
.default CompletableFuture<GetJobDetailsResponse> getJobDetails(GetJobDetailsRequest getJobDetailsRequest)
Returns information about a job. Only used for custom actions.
When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API returns any secret values defined for the action.
getJobDetailsRequest
- Represents the input of a GetJobDetails action.default CompletableFuture<GetJobDetailsResponse> getJobDetails(Consumer<GetJobDetailsRequest.Builder> getJobDetailsRequest)
Returns information about a job. Only used for custom actions.
When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API returns any secret values defined for the action.
GetJobDetailsRequest.Builder
avoiding the need to
create one manually via GetJobDetailsRequest.builder()
getJobDetailsRequest
- a Consumer
that will call methods on GetJobDetailsInput.Builder
.default CompletableFuture<GetPipelineResponse> getPipeline(GetPipelineRequest 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.
getPipelineRequest
- Represents the input of a GetPipeline action.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.
GetPipelineRequest.Builder
avoiding the need to
create one manually via GetPipelineRequest.builder()
getPipelineRequest
- a Consumer
that will call methods on GetPipelineInput.Builder
.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.
getPipelineExecutionRequest
- Represents the input of a GetPipelineExecution action.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.
GetPipelineExecutionRequest.Builder
avoiding the
need to create one manually via GetPipelineExecutionRequest.builder()
getPipelineExecutionRequest
- a Consumer
that will call methods on GetPipelineExecutionInput.Builder
.default CompletableFuture<GetPipelineStateResponse> getPipelineState(GetPipelineStateRequest getPipelineStateRequest)
Returns information about the state of a pipeline, including the stages and actions.
getPipelineStateRequest
- Represents the input of a GetPipelineState action.default CompletableFuture<GetPipelineStateResponse> getPipelineState(Consumer<GetPipelineStateRequest.Builder> getPipelineStateRequest)
Returns information about the state of a pipeline, including the stages and actions.
GetPipelineStateRequest.Builder
avoiding the need
to create one manually via GetPipelineStateRequest.builder()
getPipelineStateRequest
- a Consumer
that will call methods on GetPipelineStateInput.Builder
.default CompletableFuture<GetThirdPartyJobDetailsResponse> getThirdPartyJobDetails(GetThirdPartyJobDetailsRequest getThirdPartyJobDetailsRequest)
Requests the details of a job for a third party action. Only used for partner actions.
When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API returns any secret values defined for the action.
getThirdPartyJobDetailsRequest
- Represents the input of a GetThirdPartyJobDetails action.default CompletableFuture<GetThirdPartyJobDetailsResponse> getThirdPartyJobDetails(Consumer<GetThirdPartyJobDetailsRequest.Builder> getThirdPartyJobDetailsRequest)
Requests the details of a job for a third party action. Only used for partner actions.
When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API returns any secret values defined for the action.
GetThirdPartyJobDetailsRequest.Builder
avoiding
the need to create one manually via GetThirdPartyJobDetailsRequest.builder()
getThirdPartyJobDetailsRequest
- a Consumer
that will call methods on GetThirdPartyJobDetailsInput.Builder
.default CompletableFuture<ListActionTypesResponse> listActionTypes(ListActionTypesRequest listActionTypesRequest)
Gets a summary of all AWS CodePipeline action types associated with your account.
listActionTypesRequest
- Represents the input of a ListActionTypes action.default CompletableFuture<ListActionTypesResponse> listActionTypes()
Gets a summary of all AWS CodePipeline action types associated with your account.
default CompletableFuture<ListActionTypesResponse> listActionTypes(Consumer<ListActionTypesRequest.Builder> listActionTypesRequest)
Gets a summary of all AWS CodePipeline action types associated with your account.
ListActionTypesRequest.Builder
avoiding the need
to create one manually via ListActionTypesRequest.builder()
listActionTypesRequest
- a Consumer
that will call methods on ListActionTypesInput.Builder
.default CompletableFuture<ListPipelineExecutionsResponse> listPipelineExecutions(ListPipelineExecutionsRequest listPipelineExecutionsRequest)
Gets a summary of the most recent executions for a pipeline.
listPipelineExecutionsRequest
- Represents the input of a ListPipelineExecutions action.default CompletableFuture<ListPipelineExecutionsResponse> listPipelineExecutions(Consumer<ListPipelineExecutionsRequest.Builder> listPipelineExecutionsRequest)
Gets a summary of the most recent executions for a pipeline.
ListPipelineExecutionsRequest.Builder
avoiding the
need to create one manually via ListPipelineExecutionsRequest.builder()
listPipelineExecutionsRequest
- a Consumer
that will call methods on ListPipelineExecutionsInput.Builder
.default CompletableFuture<ListPipelinesResponse> listPipelines(ListPipelinesRequest listPipelinesRequest)
Gets a summary of all of the pipelines associated with your account.
listPipelinesRequest
- Represents the input of a ListPipelines action.default CompletableFuture<ListPipelinesResponse> listPipelines()
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.
ListPipelinesRequest.Builder
avoiding the need to
create one manually via ListPipelinesRequest.builder()
listPipelinesRequest
- a Consumer
that will call methods on ListPipelinesInput.Builder
.default CompletableFuture<PollForJobsResponse> pollForJobs(PollForJobsRequest pollForJobsRequest)
Returns information about any jobs for AWS CodePipeline to act upon.
When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API returns any secret values defined for the action.
pollForJobsRequest
- Represents the input of a PollForJobs action.default CompletableFuture<PollForJobsResponse> pollForJobs(Consumer<PollForJobsRequest.Builder> pollForJobsRequest)
Returns information about any jobs for AWS CodePipeline to act upon.
When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API returns any secret values defined for the action.
PollForJobsRequest.Builder
avoiding the need to
create one manually via PollForJobsRequest.builder()
pollForJobsRequest
- a Consumer
that will call methods on PollForJobsInput.Builder
.default CompletableFuture<PollForThirdPartyJobsResponse> pollForThirdPartyJobs(PollForThirdPartyJobsRequest pollForThirdPartyJobsRequest)
Determines whether there are any third party jobs for a job worker to act on. Only used for partner actions.
When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts.
pollForThirdPartyJobsRequest
- Represents the input of a PollForThirdPartyJobs action.default CompletableFuture<PollForThirdPartyJobsResponse> pollForThirdPartyJobs(Consumer<PollForThirdPartyJobsRequest.Builder> pollForThirdPartyJobsRequest)
Determines whether there are any third party jobs for a job worker to act on. Only used for partner actions.
When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts.
PollForThirdPartyJobsRequest.Builder
avoiding the
need to create one manually via PollForThirdPartyJobsRequest.builder()
pollForThirdPartyJobsRequest
- a Consumer
that will call methods on PollForThirdPartyJobsInput.Builder
.default CompletableFuture<PutActionRevisionResponse> putActionRevision(PutActionRevisionRequest putActionRevisionRequest)
Provides information to AWS CodePipeline about new revisions to a source.
putActionRevisionRequest
- Represents the input of a PutActionRevision action.default CompletableFuture<PutActionRevisionResponse> putActionRevision(Consumer<PutActionRevisionRequest.Builder> putActionRevisionRequest)
Provides information to AWS CodePipeline about new revisions to a source.
PutActionRevisionRequest.Builder
avoiding the need
to create one manually via PutActionRevisionRequest.builder()
putActionRevisionRequest
- a Consumer
that will call methods on PutActionRevisionInput.Builder
.default CompletableFuture<PutApprovalResultResponse> putApprovalResult(PutApprovalResultRequest putApprovalResultRequest)
Provides the response to a manual approval request to AWS CodePipeline. Valid responses include Approved and Rejected.
putApprovalResultRequest
- Represents the input of a PutApprovalResult action.default CompletableFuture<PutApprovalResultResponse> putApprovalResult(Consumer<PutApprovalResultRequest.Builder> putApprovalResultRequest)
Provides the response to a manual approval request to AWS CodePipeline. Valid responses include Approved and Rejected.
PutApprovalResultRequest.Builder
avoiding the need
to create one manually via PutApprovalResultRequest.builder()
putApprovalResultRequest
- a Consumer
that will call methods on PutApprovalResultInput.Builder
.default CompletableFuture<PutJobFailureResultResponse> putJobFailureResult(PutJobFailureResultRequest putJobFailureResultRequest)
Represents the failure of a job as returned to the pipeline by a job worker. Only used for custom actions.
putJobFailureResultRequest
- Represents the input of a PutJobFailureResult action.default CompletableFuture<PutJobFailureResultResponse> putJobFailureResult(Consumer<PutJobFailureResultRequest.Builder> putJobFailureResultRequest)
Represents the failure of a job as returned to the pipeline by a job worker. Only used for custom actions.
PutJobFailureResultRequest.Builder
avoiding the
need to create one manually via PutJobFailureResultRequest.builder()
putJobFailureResultRequest
- a Consumer
that will call methods on PutJobFailureResultInput.Builder
.default CompletableFuture<PutJobSuccessResultResponse> putJobSuccessResult(PutJobSuccessResultRequest putJobSuccessResultRequest)
Represents the success of a job as returned to the pipeline by a job worker. Only used for custom actions.
putJobSuccessResultRequest
- Represents the input of a PutJobSuccessResult action.default CompletableFuture<PutJobSuccessResultResponse> putJobSuccessResult(Consumer<PutJobSuccessResultRequest.Builder> putJobSuccessResultRequest)
Represents the success of a job as returned to the pipeline by a job worker. Only used for custom actions.
PutJobSuccessResultRequest.Builder
avoiding the
need to create one manually via PutJobSuccessResultRequest.builder()
putJobSuccessResultRequest
- a Consumer
that will call methods on PutJobSuccessResultInput.Builder
.default CompletableFuture<PutThirdPartyJobFailureResultResponse> putThirdPartyJobFailureResult(PutThirdPartyJobFailureResultRequest putThirdPartyJobFailureResultRequest)
Represents the failure of a third party job as returned to the pipeline by a job worker. Only used for partner actions.
putThirdPartyJobFailureResultRequest
- Represents the input of a PutThirdPartyJobFailureResult action.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. Only used for partner actions.
PutThirdPartyJobFailureResultRequest.Builder
avoiding the need to create one manually via PutThirdPartyJobFailureResultRequest.builder()
putThirdPartyJobFailureResultRequest
- a Consumer
that will call methods on PutThirdPartyJobFailureResultInput.Builder
.default CompletableFuture<PutThirdPartyJobSuccessResultResponse> putThirdPartyJobSuccessResult(PutThirdPartyJobSuccessResultRequest putThirdPartyJobSuccessResultRequest)
Represents the success of a third party job as returned to the pipeline by a job worker. Only used for partner actions.
putThirdPartyJobSuccessResultRequest
- Represents the input of a PutThirdPartyJobSuccessResult action.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. Only used for partner actions.
PutThirdPartyJobSuccessResultRequest.Builder
avoiding the need to create one manually via PutThirdPartyJobSuccessResultRequest.builder()
putThirdPartyJobSuccessResultRequest
- a Consumer
that will call methods on PutThirdPartyJobSuccessResultInput.Builder
.default CompletableFuture<RetryStageExecutionResponse> retryStageExecution(RetryStageExecutionRequest retryStageExecutionRequest)
Resumes the pipeline execution by retrying the last failed actions in a stage.
retryStageExecutionRequest
- Represents the input of a RetryStageExecution action.default CompletableFuture<RetryStageExecutionResponse> retryStageExecution(Consumer<RetryStageExecutionRequest.Builder> retryStageExecutionRequest)
Resumes the pipeline execution by retrying the last failed actions in a stage.
RetryStageExecutionRequest.Builder
avoiding the
need to create one manually via RetryStageExecutionRequest.builder()
retryStageExecutionRequest
- a Consumer
that will call methods on RetryStageExecutionInput.Builder
.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.
startPipelineExecutionRequest
- Represents the input of a StartPipelineExecution action.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.
StartPipelineExecutionRequest.Builder
avoiding the
need to create one manually via StartPipelineExecutionRequest.builder()
startPipelineExecutionRequest
- a Consumer
that will call methods on StartPipelineExecutionInput.Builder
.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 in conjunction with UpdatePipeline to provide the full structure of the pipeline. Updating the pipeline increases the version number of the pipeline by 1.
updatePipelineRequest
- Represents the input of an UpdatePipeline action.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 in conjunction with UpdatePipeline to provide the full structure of the pipeline. Updating the pipeline increases the version number of the pipeline by 1.
UpdatePipelineRequest.Builder
avoiding the need to
create one manually via UpdatePipelineRequest.builder()
updatePipelineRequest
- a Consumer
that will call methods on UpdatePipelineInput.Builder
.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.