Interface AWSCodePipelineAsync
-
- All Superinterfaces:
AWSCodePipeline
- All Known Implementing Classes:
AbstractAWSCodePipelineAsync
,AWSCodePipelineAsyncClient
public interface AWSCodePipelineAsync extends AWSCodePipeline
Interface for accessing CodePipeline asynchronously. Each asynchronous method will return a Java Future object representing the asynchronous operation; overloads which accept anAsyncHandler
can be used to receive notification when an asynchronous operation completes.AWS CodePipeline OverviewThis 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 a pipeline structure.
- 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.
- 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 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.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method 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<GetPipelineStateResult>
getPipelineStateAsync(GetPipelineStateRequest getPipelineStateRequest)
Returns information about the state of a pipeline, including the stages, actions, and details about the last run of the pipeline.Future<GetPipelineStateResult>
getPipelineStateAsync(GetPipelineStateRequest getPipelineStateRequest, AsyncHandler<GetPipelineStateRequest,GetPipelineStateResult> asyncHandler)
Returns information about the state of a pipeline, including the stages, actions, and details about the last run of the pipeline.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<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<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<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.-
Methods inherited from interface com.amazonaws.services.codepipeline.AWSCodePipeline
acknowledgeJob, acknowledgeThirdPartyJob, createCustomActionType, createPipeline, deleteCustomActionType, deletePipeline, disableStageTransition, enableStageTransition, getCachedResponseMetadata, getJobDetails, getPipeline, getPipelineState, getThirdPartyJobDetails, listActionTypes, listPipelines, pollForJobs, pollForThirdPartyJobs, putActionRevision, putJobFailureResult, putJobSuccessResult, putThirdPartyJobFailureResult, putThirdPartyJobSuccessResult, setEndpoint, setRegion, shutdown, startPipelineExecution, updatePipeline
-
-
-
-
Method Detail
-
acknowledgeJobAsync
Future<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.
- Parameters:
acknowledgeJobRequest
- Represents the input of an acknowledge job action.- Returns:
- A Java Future containing the result of the AcknowledgeJob operation returned by the service.
-
acknowledgeJobAsync
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.
- Parameters:
acknowledgeJobRequest
- Represents the input of an acknowledge job 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.- Returns:
- A Java Future containing the result of the AcknowledgeJob operation returned by the service.
-
acknowledgeThirdPartyJobAsync
Future<AcknowledgeThirdPartyJobResult> acknowledgeThirdPartyJobAsync(AcknowledgeThirdPartyJobRequest acknowledgeThirdPartyJobRequest)
Confirms a job worker has received the specified job. Only used for partner actions.
- Parameters:
acknowledgeThirdPartyJobRequest
- Represents the input of an acknowledge third party job action.- Returns:
- A Java Future containing the result of the AcknowledgeThirdPartyJob operation returned by the service.
-
acknowledgeThirdPartyJobAsync
Future<AcknowledgeThirdPartyJobResult> acknowledgeThirdPartyJobAsync(AcknowledgeThirdPartyJobRequest acknowledgeThirdPartyJobRequest, AsyncHandler<AcknowledgeThirdPartyJobRequest,AcknowledgeThirdPartyJobResult> asyncHandler)
Confirms a job worker has received the specified job. Only used for partner actions.
- Parameters:
acknowledgeThirdPartyJobRequest
- Represents the input of an acknowledge third party job 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.- Returns:
- A Java Future containing the result of the AcknowledgeThirdPartyJob operation returned by the service.
-
createCustomActionTypeAsync
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.
- Parameters:
createCustomActionTypeRequest
- Represents the input of a create custom action operation.- Returns:
- A Java Future containing the result of the CreateCustomActionType operation returned by the service.
-
createCustomActionTypeAsync
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.
- Parameters:
createCustomActionTypeRequest
- Represents the input of a create custom action 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.- Returns:
- A Java Future containing the result of the CreateCustomActionType operation returned by the service.
-
createPipelineAsync
Future<CreatePipelineResult> createPipelineAsync(CreatePipelineRequest createPipelineRequest)
Creates a pipeline.
- Parameters:
createPipelineRequest
- Represents the input of a create pipeline action.- Returns:
- A Java Future containing the result of the CreatePipeline operation returned by the service.
-
createPipelineAsync
Future<CreatePipelineResult> createPipelineAsync(CreatePipelineRequest createPipelineRequest, AsyncHandler<CreatePipelineRequest,CreatePipelineResult> asyncHandler)
Creates a pipeline.
- Parameters:
createPipelineRequest
- Represents the input of a create pipeline 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.- Returns:
- A Java Future containing the result of the CreatePipeline operation returned by the service.
-
deleteCustomActionTypeAsync
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.
- Parameters:
deleteCustomActionTypeRequest
- Represents the input of a delete custom action operation. The custom action will be marked as deleted.- Returns:
- A Java Future containing the result of the DeleteCustomActionType operation returned by the service.
-
deleteCustomActionTypeAsync
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.
- Parameters:
deleteCustomActionTypeRequest
- Represents the input of a delete custom action 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.- Returns:
- A Java Future containing the result of the DeleteCustomActionType operation returned by the service.
-
deletePipelineAsync
Future<DeletePipelineResult> deletePipelineAsync(DeletePipelineRequest deletePipelineRequest)
Deletes the specified pipeline.
- Parameters:
deletePipelineRequest
- Represents the input of a delete pipeline action.- Returns:
- A Java Future containing the result of the DeletePipeline operation returned by the service.
-
deletePipelineAsync
Future<DeletePipelineResult> deletePipelineAsync(DeletePipelineRequest deletePipelineRequest, AsyncHandler<DeletePipelineRequest,DeletePipelineResult> asyncHandler)
Deletes the specified pipeline.
- Parameters:
deletePipelineRequest
- Represents the input of a delete pipeline 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.- Returns:
- A Java Future containing the result of the DeletePipeline operation returned by the service.
-
disableStageTransitionAsync
Future<DisableStageTransitionResult> disableStageTransitionAsync(DisableStageTransitionRequest disableStageTransitionRequest)
Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline.
- Parameters:
disableStageTransitionRequest
- Represents the input of a disable stage transition input action.- Returns:
- A Java Future containing the result of the DisableStageTransition operation returned by the service.
-
disableStageTransitionAsync
Future<DisableStageTransitionResult> disableStageTransitionAsync(DisableStageTransitionRequest disableStageTransitionRequest, AsyncHandler<DisableStageTransitionRequest,DisableStageTransitionResult> asyncHandler)
Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline.
- Parameters:
disableStageTransitionRequest
- Represents the input of a disable stage transition input 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.- Returns:
- A Java Future containing the result of the DisableStageTransition operation returned by the service.
-
enableStageTransitionAsync
Future<EnableStageTransitionResult> enableStageTransitionAsync(EnableStageTransitionRequest enableStageTransitionRequest)
Enables artifacts in a pipeline to transition to a stage in a pipeline.
- Parameters:
enableStageTransitionRequest
- Represents the input of an enable stage transition action.- Returns:
- A Java Future containing the result of the EnableStageTransition operation returned by the service.
-
enableStageTransitionAsync
Future<EnableStageTransitionResult> enableStageTransitionAsync(EnableStageTransitionRequest enableStageTransitionRequest, AsyncHandler<EnableStageTransitionRequest,EnableStageTransitionResult> asyncHandler)
Enables artifacts in a pipeline to transition to a stage in a pipeline.
- Parameters:
enableStageTransitionRequest
- Represents the input of an enable stage transition 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.- Returns:
- A Java Future containing the result of the EnableStageTransition operation returned by the service.
-
getJobDetailsAsync
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.
- Parameters:
getJobDetailsRequest
- Represents the input of a get job details action.- Returns:
- A Java Future containing the result of the GetJobDetails operation returned by the service.
-
getJobDetailsAsync
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.
- Parameters:
getJobDetailsRequest
- Represents the input of a get job details 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.- Returns:
- A Java Future containing the result of the GetJobDetails operation returned by the service.
-
getPipelineAsync
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.
- Parameters:
getPipelineRequest
- Represents the input of a get pipeline action.- Returns:
- A Java Future containing the result of the GetPipeline operation returned by the service.
-
getPipelineAsync
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.
- Parameters:
getPipelineRequest
- Represents the input of a get pipeline 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.- Returns:
- A Java Future containing the result of the GetPipeline operation returned by the service.
-
getPipelineStateAsync
Future<GetPipelineStateResult> getPipelineStateAsync(GetPipelineStateRequest getPipelineStateRequest)
Returns information about the state of a pipeline, including the stages, actions, and details about the last run of the pipeline.
- Parameters:
getPipelineStateRequest
- Represents the input of a get pipeline state action.- Returns:
- A Java Future containing the result of the GetPipelineState operation returned by the service.
-
getPipelineStateAsync
Future<GetPipelineStateResult> getPipelineStateAsync(GetPipelineStateRequest getPipelineStateRequest, AsyncHandler<GetPipelineStateRequest,GetPipelineStateResult> asyncHandler)
Returns information about the state of a pipeline, including the stages, actions, and details about the last run of the pipeline.
- Parameters:
getPipelineStateRequest
- Represents the input of a get pipeline state 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.- Returns:
- A Java Future containing the result of the GetPipelineState operation returned by the service.
-
getThirdPartyJobDetailsAsync
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.
- Parameters:
getThirdPartyJobDetailsRequest
- Represents the input of a get third party job details action.- Returns:
- A Java Future containing the result of the GetThirdPartyJobDetails operation returned by the service.
-
getThirdPartyJobDetailsAsync
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.
- Parameters:
getThirdPartyJobDetailsRequest
- Represents the input of a get third party job details 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.- Returns:
- A Java Future containing the result of the GetThirdPartyJobDetails operation returned by the service.
-
listActionTypesAsync
Future<ListActionTypesResult> listActionTypesAsync(ListActionTypesRequest listActionTypesRequest)
Gets a summary of all AWS CodePipeline action types associated with your account.
- Parameters:
listActionTypesRequest
- Represents the input of a list action types action.- Returns:
- A Java Future containing the result of the ListActionTypes operation returned by the service.
-
listActionTypesAsync
Future<ListActionTypesResult> listActionTypesAsync(ListActionTypesRequest listActionTypesRequest, AsyncHandler<ListActionTypesRequest,ListActionTypesResult> asyncHandler)
Gets a summary of all AWS CodePipeline action types associated with your account.
- Parameters:
listActionTypesRequest
- Represents the input of a list action types 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.- Returns:
- A Java Future containing the result of the ListActionTypes operation returned by the service.
-
listPipelinesAsync
Future<ListPipelinesResult> listPipelinesAsync(ListPipelinesRequest listPipelinesRequest)
Gets a summary of all of the pipelines associated with your account.
- Parameters:
listPipelinesRequest
- Represents the input of a list pipelines action.- Returns:
- A Java Future containing the result of the ListPipelines operation returned by the service.
-
listPipelinesAsync
Future<ListPipelinesResult> listPipelinesAsync(ListPipelinesRequest listPipelinesRequest, AsyncHandler<ListPipelinesRequest,ListPipelinesResult> asyncHandler)
Gets a summary of all of the pipelines associated with your account.
- Parameters:
listPipelinesRequest
- Represents the input of a list pipelines 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.- Returns:
- A Java Future containing the result of the ListPipelines operation returned by the service.
-
pollForJobsAsync
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.
- Parameters:
pollForJobsRequest
- Represents the input of a poll for jobs action.- Returns:
- A Java Future containing the result of the PollForJobs operation returned by the service.
-
pollForJobsAsync
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.
- Parameters:
pollForJobsRequest
- Represents the input of a poll for jobs 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.- Returns:
- A Java Future containing the result of the PollForJobs operation returned by the service.
-
pollForThirdPartyJobsAsync
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.
- Parameters:
pollForThirdPartyJobsRequest
- Represents the input of a poll for third party jobs action.- Returns:
- A Java Future containing the result of the PollForThirdPartyJobs operation returned by the service.
-
pollForThirdPartyJobsAsync
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.
- Parameters:
pollForThirdPartyJobsRequest
- Represents the input of a poll for third party jobs 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.- Returns:
- A Java Future containing the result of the PollForThirdPartyJobs operation returned by the service.
-
putActionRevisionAsync
Future<PutActionRevisionResult> putActionRevisionAsync(PutActionRevisionRequest putActionRevisionRequest)
Provides information to AWS CodePipeline about new revisions to a source.
- Parameters:
putActionRevisionRequest
- Represents the input of a put action revision action.- Returns:
- A Java Future containing the result of the PutActionRevision operation returned by the service.
-
putActionRevisionAsync
Future<PutActionRevisionResult> putActionRevisionAsync(PutActionRevisionRequest putActionRevisionRequest, AsyncHandler<PutActionRevisionRequest,PutActionRevisionResult> asyncHandler)
Provides information to AWS CodePipeline about new revisions to a source.
- Parameters:
putActionRevisionRequest
- Represents the input of a put action revision 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.- Returns:
- A Java Future containing the result of the PutActionRevision operation returned by the service.
-
putJobFailureResultAsync
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.
- Parameters:
putJobFailureResultRequest
- Represents the input of a put job failure result action.- Returns:
- A Java Future containing the result of the PutJobFailureResult operation returned by the service.
-
putJobFailureResultAsync
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.
- Parameters:
putJobFailureResultRequest
- Represents the input of a put job failure result 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.- Returns:
- A Java Future containing the result of the PutJobFailureResult operation returned by the service.
-
putJobSuccessResultAsync
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.
- Parameters:
putJobSuccessResultRequest
- Represents the input of a put job success result action.- Returns:
- A Java Future containing the result of the PutJobSuccessResult operation returned by the service.
-
putJobSuccessResultAsync
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.
- Parameters:
putJobSuccessResultRequest
- Represents the input of a put job success result 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.- Returns:
- A Java Future containing the result of the PutJobSuccessResult operation returned by the service.
-
putThirdPartyJobFailureResultAsync
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.
- Parameters:
putThirdPartyJobFailureResultRequest
- Represents the input of a third party job failure result action.- Returns:
- A Java Future containing the result of the PutThirdPartyJobFailureResult operation returned by the service.
-
putThirdPartyJobFailureResultAsync
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.
- Parameters:
putThirdPartyJobFailureResultRequest
- Represents the input of a third party job failure result 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.- Returns:
- A Java Future containing the result of the PutThirdPartyJobFailureResult operation returned by the service.
-
putThirdPartyJobSuccessResultAsync
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.
- Parameters:
putThirdPartyJobSuccessResultRequest
- Represents the input of a put third party job success result action.- Returns:
- A Java Future containing the result of the PutThirdPartyJobSuccessResult operation returned by the service.
-
putThirdPartyJobSuccessResultAsync
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.
- Parameters:
putThirdPartyJobSuccessResultRequest
- Represents the input of a put third party job success result 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.- Returns:
- A Java Future containing the result of the PutThirdPartyJobSuccessResult operation returned by the service.
-
startPipelineExecutionAsync
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.
- Parameters:
startPipelineExecutionRequest
- Represents the input of a start pipeline execution action.- Returns:
- A Java Future containing the result of the StartPipelineExecution operation returned by the service.
-
startPipelineExecutionAsync
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.
- Parameters:
startPipelineExecutionRequest
- Represents the input of a start pipeline execution 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.- Returns:
- A Java Future containing the result of the StartPipelineExecution operation returned by the service.
-
updatePipelineAsync
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.
- Parameters:
updatePipelineRequest
- Represents the input of an update pipeline action.- Returns:
- A Java Future containing the result of the UpdatePipeline operation returned by the service.
-
updatePipelineAsync
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.
- Parameters:
updatePipelineRequest
- Represents the input of an update pipeline 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.- Returns:
- A Java Future containing the result of the UpdatePipeline operation returned by the service.
-
-