@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSCodePipelineAsync extends AWSCodePipeline
AsyncHandler can be used to receive
notification when an asynchronous operation completes.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSCodePipelineAsync instead.
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.
ENDPOINT_PREFIX| Modifier and Type | Method and Description |
|---|---|
Future<AcknowledgeJobResult> |
acknowledgeJobAsync(AcknowledgeJobRequest acknowledgeJobRequest)
Returns information about a specified job and whether that job has been received by the job worker.
|
Future<AcknowledgeJobResult> |
acknowledgeJobAsync(AcknowledgeJobRequest acknowledgeJobRequest,
AsyncHandler<AcknowledgeJobRequest,AcknowledgeJobResult> asyncHandler)
Returns information about a specified job and whether that job has been received by the job worker.
|
Future<AcknowledgeThirdPartyJobResult> |
acknowledgeThirdPartyJobAsync(AcknowledgeThirdPartyJobRequest acknowledgeThirdPartyJobRequest)
Confirms a job worker has received the specified job.
|
Future<AcknowledgeThirdPartyJobResult> |
acknowledgeThirdPartyJobAsync(AcknowledgeThirdPartyJobRequest acknowledgeThirdPartyJobRequest,
AsyncHandler<AcknowledgeThirdPartyJobRequest,AcknowledgeThirdPartyJobResult> asyncHandler)
Confirms a job worker has received the specified job.
|
Future<CreateCustomActionTypeResult> |
createCustomActionTypeAsync(CreateCustomActionTypeRequest createCustomActionTypeRequest)
Creates a new custom action that can be used in all pipelines associated with the AWS account.
|
Future<CreateCustomActionTypeResult> |
createCustomActionTypeAsync(CreateCustomActionTypeRequest createCustomActionTypeRequest,
AsyncHandler<CreateCustomActionTypeRequest,CreateCustomActionTypeResult> asyncHandler)
Creates a new custom action that can be used in all pipelines associated with the AWS account.
|
Future<CreatePipelineResult> |
createPipelineAsync(CreatePipelineRequest createPipelineRequest)
Creates a pipeline.
|
Future<CreatePipelineResult> |
createPipelineAsync(CreatePipelineRequest createPipelineRequest,
AsyncHandler<CreatePipelineRequest,CreatePipelineResult> asyncHandler)
Creates a pipeline.
|
Future<DeleteCustomActionTypeResult> |
deleteCustomActionTypeAsync(DeleteCustomActionTypeRequest deleteCustomActionTypeRequest)
Marks a custom action as deleted.
|
Future<DeleteCustomActionTypeResult> |
deleteCustomActionTypeAsync(DeleteCustomActionTypeRequest deleteCustomActionTypeRequest,
AsyncHandler<DeleteCustomActionTypeRequest,DeleteCustomActionTypeResult> asyncHandler)
Marks a custom action as deleted.
|
Future<DeletePipelineResult> |
deletePipelineAsync(DeletePipelineRequest deletePipelineRequest)
Deletes the specified pipeline.
|
Future<DeletePipelineResult> |
deletePipelineAsync(DeletePipelineRequest deletePipelineRequest,
AsyncHandler<DeletePipelineRequest,DeletePipelineResult> asyncHandler)
Deletes the specified pipeline.
|
Future<DisableStageTransitionResult> |
disableStageTransitionAsync(DisableStageTransitionRequest disableStageTransitionRequest)
Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline.
|
Future<DisableStageTransitionResult> |
disableStageTransitionAsync(DisableStageTransitionRequest disableStageTransitionRequest,
AsyncHandler<DisableStageTransitionRequest,DisableStageTransitionResult> asyncHandler)
Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline.
|
Future<EnableStageTransitionResult> |
enableStageTransitionAsync(EnableStageTransitionRequest enableStageTransitionRequest)
Enables artifacts in a pipeline to transition to a stage in a pipeline.
|
Future<EnableStageTransitionResult> |
enableStageTransitionAsync(EnableStageTransitionRequest enableStageTransitionRequest,
AsyncHandler<EnableStageTransitionRequest,EnableStageTransitionResult> asyncHandler)
Enables artifacts in a pipeline to transition to a stage in a pipeline.
|
Future<GetJobDetailsResult> |
getJobDetailsAsync(GetJobDetailsRequest getJobDetailsRequest)
Returns information about a job.
|
Future<GetJobDetailsResult> |
getJobDetailsAsync(GetJobDetailsRequest getJobDetailsRequest,
AsyncHandler<GetJobDetailsRequest,GetJobDetailsResult> asyncHandler)
Returns information about a job.
|
Future<GetPipelineResult> |
getPipelineAsync(GetPipelineRequest getPipelineRequest)
Returns the metadata, structure, stages, and actions of a pipeline.
|
Future<GetPipelineResult> |
getPipelineAsync(GetPipelineRequest getPipelineRequest,
AsyncHandler<GetPipelineRequest,GetPipelineResult> asyncHandler)
Returns the metadata, structure, stages, and actions of a pipeline.
|
Future<GetPipelineExecutionResult> |
getPipelineExecutionAsync(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.
|
Future<GetPipelineExecutionResult> |
getPipelineExecutionAsync(GetPipelineExecutionRequest getPipelineExecutionRequest,
AsyncHandler<GetPipelineExecutionRequest,GetPipelineExecutionResult> asyncHandler)
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.
|
Future<GetPipelineStateResult> |
getPipelineStateAsync(GetPipelineStateRequest getPipelineStateRequest)
Returns information about the state of a pipeline, including the stages and actions.
|
Future<GetPipelineStateResult> |
getPipelineStateAsync(GetPipelineStateRequest getPipelineStateRequest,
AsyncHandler<GetPipelineStateRequest,GetPipelineStateResult> asyncHandler)
Returns information about the state of a pipeline, including the stages and actions.
|
Future<GetThirdPartyJobDetailsResult> |
getThirdPartyJobDetailsAsync(GetThirdPartyJobDetailsRequest getThirdPartyJobDetailsRequest)
Requests the details of a job for a third party action.
|
Future<GetThirdPartyJobDetailsResult> |
getThirdPartyJobDetailsAsync(GetThirdPartyJobDetailsRequest getThirdPartyJobDetailsRequest,
AsyncHandler<GetThirdPartyJobDetailsRequest,GetThirdPartyJobDetailsResult> asyncHandler)
Requests the details of a job for a third party action.
|
Future<ListActionTypesResult> |
listActionTypesAsync(ListActionTypesRequest listActionTypesRequest)
Gets a summary of all AWS CodePipeline action types associated with your account.
|
Future<ListActionTypesResult> |
listActionTypesAsync(ListActionTypesRequest listActionTypesRequest,
AsyncHandler<ListActionTypesRequest,ListActionTypesResult> asyncHandler)
Gets a summary of all AWS CodePipeline action types associated with your account.
|
Future<ListPipelineExecutionsResult> |
listPipelineExecutionsAsync(ListPipelineExecutionsRequest listPipelineExecutionsRequest)
Gets a summary of the most recent executions for a pipeline.
|
Future<ListPipelineExecutionsResult> |
listPipelineExecutionsAsync(ListPipelineExecutionsRequest listPipelineExecutionsRequest,
AsyncHandler<ListPipelineExecutionsRequest,ListPipelineExecutionsResult> asyncHandler)
Gets a summary of the most recent executions for a pipeline.
|
Future<ListPipelinesResult> |
listPipelinesAsync(ListPipelinesRequest listPipelinesRequest)
Gets a summary of all of the pipelines associated with your account.
|
Future<ListPipelinesResult> |
listPipelinesAsync(ListPipelinesRequest listPipelinesRequest,
AsyncHandler<ListPipelinesRequest,ListPipelinesResult> asyncHandler)
Gets a summary of all of the pipelines associated with your account.
|
Future<PollForJobsResult> |
pollForJobsAsync(PollForJobsRequest pollForJobsRequest)
Returns information about any jobs for AWS CodePipeline to act upon.
|
Future<PollForJobsResult> |
pollForJobsAsync(PollForJobsRequest pollForJobsRequest,
AsyncHandler<PollForJobsRequest,PollForJobsResult> asyncHandler)
Returns information about any jobs for AWS CodePipeline to act upon.
|
Future<PollForThirdPartyJobsResult> |
pollForThirdPartyJobsAsync(PollForThirdPartyJobsRequest pollForThirdPartyJobsRequest)
Determines whether there are any third party jobs for a job worker to act on.
|
Future<PollForThirdPartyJobsResult> |
pollForThirdPartyJobsAsync(PollForThirdPartyJobsRequest pollForThirdPartyJobsRequest,
AsyncHandler<PollForThirdPartyJobsRequest,PollForThirdPartyJobsResult> asyncHandler)
Determines whether there are any third party jobs for a job worker to act on.
|
Future<PutActionRevisionResult> |
putActionRevisionAsync(PutActionRevisionRequest putActionRevisionRequest)
Provides information to AWS CodePipeline about new revisions to a source.
|
Future<PutActionRevisionResult> |
putActionRevisionAsync(PutActionRevisionRequest putActionRevisionRequest,
AsyncHandler<PutActionRevisionRequest,PutActionRevisionResult> asyncHandler)
Provides information to AWS CodePipeline about new revisions to a source.
|
Future<PutApprovalResultResult> |
putApprovalResultAsync(PutApprovalResultRequest putApprovalResultRequest)
Provides the response to a manual approval request to AWS CodePipeline.
|
Future<PutApprovalResultResult> |
putApprovalResultAsync(PutApprovalResultRequest putApprovalResultRequest,
AsyncHandler<PutApprovalResultRequest,PutApprovalResultResult> asyncHandler)
Provides the response to a manual approval request to AWS CodePipeline.
|
Future<PutJobFailureResultResult> |
putJobFailureResultAsync(PutJobFailureResultRequest putJobFailureResultRequest)
Represents the failure of a job as returned to the pipeline by a job worker.
|
Future<PutJobFailureResultResult> |
putJobFailureResultAsync(PutJobFailureResultRequest putJobFailureResultRequest,
AsyncHandler<PutJobFailureResultRequest,PutJobFailureResultResult> asyncHandler)
Represents the failure of a job as returned to the pipeline by a job worker.
|
Future<PutJobSuccessResultResult> |
putJobSuccessResultAsync(PutJobSuccessResultRequest putJobSuccessResultRequest)
Represents the success of a job as returned to the pipeline by a job worker.
|
Future<PutJobSuccessResultResult> |
putJobSuccessResultAsync(PutJobSuccessResultRequest putJobSuccessResultRequest,
AsyncHandler<PutJobSuccessResultRequest,PutJobSuccessResultResult> asyncHandler)
Represents the success of a job as returned to the pipeline by a job worker.
|
Future<PutThirdPartyJobFailureResultResult> |
putThirdPartyJobFailureResultAsync(PutThirdPartyJobFailureResultRequest putThirdPartyJobFailureResultRequest)
Represents the failure of a third party job as returned to the pipeline by a job worker.
|
Future<PutThirdPartyJobFailureResultResult> |
putThirdPartyJobFailureResultAsync(PutThirdPartyJobFailureResultRequest putThirdPartyJobFailureResultRequest,
AsyncHandler<PutThirdPartyJobFailureResultRequest,PutThirdPartyJobFailureResultResult> asyncHandler)
Represents the failure of a third party job as returned to the pipeline by a job worker.
|
Future<PutThirdPartyJobSuccessResultResult> |
putThirdPartyJobSuccessResultAsync(PutThirdPartyJobSuccessResultRequest putThirdPartyJobSuccessResultRequest)
Represents the success of a third party job as returned to the pipeline by a job worker.
|
Future<PutThirdPartyJobSuccessResultResult> |
putThirdPartyJobSuccessResultAsync(PutThirdPartyJobSuccessResultRequest putThirdPartyJobSuccessResultRequest,
AsyncHandler<PutThirdPartyJobSuccessResultRequest,PutThirdPartyJobSuccessResultResult> asyncHandler)
Represents the success of a third party job as returned to the pipeline by a job worker.
|
Future<RetryStageExecutionResult> |
retryStageExecutionAsync(RetryStageExecutionRequest retryStageExecutionRequest)
Resumes the pipeline execution by retrying the last failed actions in a stage.
|
Future<RetryStageExecutionResult> |
retryStageExecutionAsync(RetryStageExecutionRequest retryStageExecutionRequest,
AsyncHandler<RetryStageExecutionRequest,RetryStageExecutionResult> asyncHandler)
Resumes the pipeline execution by retrying the last failed actions in a stage.
|
Future<StartPipelineExecutionResult> |
startPipelineExecutionAsync(StartPipelineExecutionRequest startPipelineExecutionRequest)
Starts the specified pipeline.
|
Future<StartPipelineExecutionResult> |
startPipelineExecutionAsync(StartPipelineExecutionRequest startPipelineExecutionRequest,
AsyncHandler<StartPipelineExecutionRequest,StartPipelineExecutionResult> asyncHandler)
Starts the specified pipeline.
|
Future<UpdatePipelineResult> |
updatePipelineAsync(UpdatePipelineRequest updatePipelineRequest)
Updates a specified pipeline with edits or changes to its structure.
|
Future<UpdatePipelineResult> |
updatePipelineAsync(UpdatePipelineRequest updatePipelineRequest,
AsyncHandler<UpdatePipelineRequest,UpdatePipelineResult> asyncHandler)
Updates a specified pipeline with edits or changes to its structure.
|
acknowledgeJob, acknowledgeThirdPartyJob, createCustomActionType, createPipeline, deleteCustomActionType, deletePipeline, disableStageTransition, enableStageTransition, getCachedResponseMetadata, getJobDetails, getPipeline, getPipelineExecution, getPipelineState, getThirdPartyJobDetails, listActionTypes, listPipelineExecutions, listPipelines, pollForJobs, pollForThirdPartyJobs, putActionRevision, putApprovalResult, putJobFailureResult, putJobSuccessResult, putThirdPartyJobFailureResult, putThirdPartyJobSuccessResult, retryStageExecution, setEndpoint, setRegion, shutdown, startPipelineExecution, updatePipelineFuture<AcknowledgeJobResult> acknowledgeJobAsync(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.Future<AcknowledgeJobResult> acknowledgeJobAsync(AcknowledgeJobRequest acknowledgeJobRequest, AsyncHandler<AcknowledgeJobRequest,AcknowledgeJobResult> asyncHandler)
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.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<AcknowledgeThirdPartyJobResult> acknowledgeThirdPartyJobAsync(AcknowledgeThirdPartyJobRequest acknowledgeThirdPartyJobRequest)
Confirms a job worker has received the specified job. Only used for partner actions.
acknowledgeThirdPartyJobRequest - Represents the input of an AcknowledgeThirdPartyJob action.Future<AcknowledgeThirdPartyJobResult> acknowledgeThirdPartyJobAsync(AcknowledgeThirdPartyJobRequest acknowledgeThirdPartyJobRequest, AsyncHandler<AcknowledgeThirdPartyJobRequest,AcknowledgeThirdPartyJobResult> asyncHandler)
Confirms a job worker has received the specified job. Only used for partner actions.
acknowledgeThirdPartyJobRequest - Represents the input of an AcknowledgeThirdPartyJob action.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateCustomActionTypeResult> createCustomActionTypeAsync(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.Future<CreateCustomActionTypeResult> createCustomActionTypeAsync(CreateCustomActionTypeRequest createCustomActionTypeRequest, AsyncHandler<CreateCustomActionTypeRequest,CreateCustomActionTypeResult> asyncHandler)
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.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreatePipelineResult> createPipelineAsync(CreatePipelineRequest createPipelineRequest)
Creates a pipeline.
createPipelineRequest - Represents the input of a CreatePipeline action.Future<CreatePipelineResult> createPipelineAsync(CreatePipelineRequest createPipelineRequest, AsyncHandler<CreatePipelineRequest,CreatePipelineResult> asyncHandler)
Creates a pipeline.
createPipelineRequest - Represents the input of a CreatePipeline action.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteCustomActionTypeResult> deleteCustomActionTypeAsync(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.Future<DeleteCustomActionTypeResult> deleteCustomActionTypeAsync(DeleteCustomActionTypeRequest deleteCustomActionTypeRequest, AsyncHandler<DeleteCustomActionTypeRequest,DeleteCustomActionTypeResult> asyncHandler)
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.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeletePipelineResult> deletePipelineAsync(DeletePipelineRequest deletePipelineRequest)
Deletes the specified pipeline.
deletePipelineRequest - Represents the input of a DeletePipeline action.Future<DeletePipelineResult> deletePipelineAsync(DeletePipelineRequest deletePipelineRequest, AsyncHandler<DeletePipelineRequest,DeletePipelineResult> asyncHandler)
Deletes the specified pipeline.
deletePipelineRequest - Represents the input of a DeletePipeline action.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DisableStageTransitionResult> disableStageTransitionAsync(DisableStageTransitionRequest disableStageTransitionRequest)
Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline.
disableStageTransitionRequest - Represents the input of a DisableStageTransition action.Future<DisableStageTransitionResult> disableStageTransitionAsync(DisableStageTransitionRequest disableStageTransitionRequest, AsyncHandler<DisableStageTransitionRequest,DisableStageTransitionResult> asyncHandler)
Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline.
disableStageTransitionRequest - Represents the input of a DisableStageTransition action.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<EnableStageTransitionResult> enableStageTransitionAsync(EnableStageTransitionRequest enableStageTransitionRequest)
Enables artifacts in a pipeline to transition to a stage in a pipeline.
enableStageTransitionRequest - Represents the input of an EnableStageTransition action.Future<EnableStageTransitionResult> enableStageTransitionAsync(EnableStageTransitionRequest enableStageTransitionRequest, AsyncHandler<EnableStageTransitionRequest,EnableStageTransitionResult> asyncHandler)
Enables artifacts in a pipeline to transition to a stage in a pipeline.
enableStageTransitionRequest - Represents the input of an EnableStageTransition action.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetJobDetailsResult> getJobDetailsAsync(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.Future<GetJobDetailsResult> getJobDetailsAsync(GetJobDetailsRequest getJobDetailsRequest, AsyncHandler<GetJobDetailsRequest,GetJobDetailsResult> asyncHandler)
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.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetPipelineResult> getPipelineAsync(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.Future<GetPipelineResult> getPipelineAsync(GetPipelineRequest getPipelineRequest, AsyncHandler<GetPipelineRequest,GetPipelineResult> asyncHandler)
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.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetPipelineExecutionResult> getPipelineExecutionAsync(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.Future<GetPipelineExecutionResult> getPipelineExecutionAsync(GetPipelineExecutionRequest getPipelineExecutionRequest, AsyncHandler<GetPipelineExecutionRequest,GetPipelineExecutionResult> asyncHandler)
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.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetPipelineStateResult> getPipelineStateAsync(GetPipelineStateRequest getPipelineStateRequest)
Returns information about the state of a pipeline, including the stages and actions.
getPipelineStateRequest - Represents the input of a GetPipelineState action.Future<GetPipelineStateResult> getPipelineStateAsync(GetPipelineStateRequest getPipelineStateRequest, AsyncHandler<GetPipelineStateRequest,GetPipelineStateResult> asyncHandler)
Returns information about the state of a pipeline, including the stages and actions.
getPipelineStateRequest - Represents the input of a GetPipelineState action.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetThirdPartyJobDetailsResult> getThirdPartyJobDetailsAsync(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.Future<GetThirdPartyJobDetailsResult> getThirdPartyJobDetailsAsync(GetThirdPartyJobDetailsRequest getThirdPartyJobDetailsRequest, AsyncHandler<GetThirdPartyJobDetailsRequest,GetThirdPartyJobDetailsResult> asyncHandler)
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.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListActionTypesResult> listActionTypesAsync(ListActionTypesRequest listActionTypesRequest)
Gets a summary of all AWS CodePipeline action types associated with your account.
listActionTypesRequest - Represents the input of a ListActionTypes action.Future<ListActionTypesResult> listActionTypesAsync(ListActionTypesRequest listActionTypesRequest, AsyncHandler<ListActionTypesRequest,ListActionTypesResult> asyncHandler)
Gets a summary of all AWS CodePipeline action types associated with your account.
listActionTypesRequest - Represents the input of a ListActionTypes action.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListPipelineExecutionsResult> listPipelineExecutionsAsync(ListPipelineExecutionsRequest listPipelineExecutionsRequest)
Gets a summary of the most recent executions for a pipeline.
listPipelineExecutionsRequest - Represents the input of a ListPipelineExecutions action.Future<ListPipelineExecutionsResult> listPipelineExecutionsAsync(ListPipelineExecutionsRequest listPipelineExecutionsRequest, AsyncHandler<ListPipelineExecutionsRequest,ListPipelineExecutionsResult> asyncHandler)
Gets a summary of the most recent executions for a pipeline.
listPipelineExecutionsRequest - Represents the input of a ListPipelineExecutions action.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListPipelinesResult> listPipelinesAsync(ListPipelinesRequest listPipelinesRequest)
Gets a summary of all of the pipelines associated with your account.
listPipelinesRequest - Represents the input of a ListPipelines action.Future<ListPipelinesResult> listPipelinesAsync(ListPipelinesRequest listPipelinesRequest, AsyncHandler<ListPipelinesRequest,ListPipelinesResult> asyncHandler)
Gets a summary of all of the pipelines associated with your account.
listPipelinesRequest - Represents the input of a ListPipelines action.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<PollForJobsResult> pollForJobsAsync(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.Future<PollForJobsResult> pollForJobsAsync(PollForJobsRequest pollForJobsRequest, AsyncHandler<PollForJobsRequest,PollForJobsResult> asyncHandler)
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.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<PollForThirdPartyJobsResult> pollForThirdPartyJobsAsync(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.Future<PollForThirdPartyJobsResult> pollForThirdPartyJobsAsync(PollForThirdPartyJobsRequest pollForThirdPartyJobsRequest, AsyncHandler<PollForThirdPartyJobsRequest,PollForThirdPartyJobsResult> asyncHandler)
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.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<PutActionRevisionResult> putActionRevisionAsync(PutActionRevisionRequest putActionRevisionRequest)
Provides information to AWS CodePipeline about new revisions to a source.
putActionRevisionRequest - Represents the input of a PutActionRevision action.Future<PutActionRevisionResult> putActionRevisionAsync(PutActionRevisionRequest putActionRevisionRequest, AsyncHandler<PutActionRevisionRequest,PutActionRevisionResult> asyncHandler)
Provides information to AWS CodePipeline about new revisions to a source.
putActionRevisionRequest - Represents the input of a PutActionRevision action.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<PutApprovalResultResult> putApprovalResultAsync(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.Future<PutApprovalResultResult> putApprovalResultAsync(PutApprovalResultRequest putApprovalResultRequest, AsyncHandler<PutApprovalResultRequest,PutApprovalResultResult> asyncHandler)
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.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<PutJobFailureResultResult> putJobFailureResultAsync(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.Future<PutJobFailureResultResult> putJobFailureResultAsync(PutJobFailureResultRequest putJobFailureResultRequest, AsyncHandler<PutJobFailureResultRequest,PutJobFailureResultResult> asyncHandler)
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.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<PutJobSuccessResultResult> putJobSuccessResultAsync(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.Future<PutJobSuccessResultResult> putJobSuccessResultAsync(PutJobSuccessResultRequest putJobSuccessResultRequest, AsyncHandler<PutJobSuccessResultRequest,PutJobSuccessResultResult> asyncHandler)
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.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<PutThirdPartyJobFailureResultResult> putThirdPartyJobFailureResultAsync(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.Future<PutThirdPartyJobFailureResultResult> putThirdPartyJobFailureResultAsync(PutThirdPartyJobFailureResultRequest putThirdPartyJobFailureResultRequest, AsyncHandler<PutThirdPartyJobFailureResultRequest,PutThirdPartyJobFailureResultResult> asyncHandler)
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.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<PutThirdPartyJobSuccessResultResult> putThirdPartyJobSuccessResultAsync(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.Future<PutThirdPartyJobSuccessResultResult> putThirdPartyJobSuccessResultAsync(PutThirdPartyJobSuccessResultRequest putThirdPartyJobSuccessResultRequest, AsyncHandler<PutThirdPartyJobSuccessResultRequest,PutThirdPartyJobSuccessResultResult> asyncHandler)
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.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<RetryStageExecutionResult> retryStageExecutionAsync(RetryStageExecutionRequest retryStageExecutionRequest)
Resumes the pipeline execution by retrying the last failed actions in a stage.
retryStageExecutionRequest - Represents the input of a RetryStageExecution action.Future<RetryStageExecutionResult> retryStageExecutionAsync(RetryStageExecutionRequest retryStageExecutionRequest, AsyncHandler<RetryStageExecutionRequest,RetryStageExecutionResult> asyncHandler)
Resumes the pipeline execution by retrying the last failed actions in a stage.
retryStageExecutionRequest - Represents the input of a RetryStageExecution action.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<StartPipelineExecutionResult> startPipelineExecutionAsync(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.Future<StartPipelineExecutionResult> startPipelineExecutionAsync(StartPipelineExecutionRequest startPipelineExecutionRequest, AsyncHandler<StartPipelineExecutionRequest,StartPipelineExecutionResult> asyncHandler)
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.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdatePipelineResult> updatePipelineAsync(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.Future<UpdatePipelineResult> updatePipelineAsync(UpdatePipelineRequest updatePipelineRequest, AsyncHandler<UpdatePipelineRequest,UpdatePipelineResult> asyncHandler)
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.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.