@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 CodePipeline API Reference. This guide provides descriptions of the actions and data types for CodePipeline. Some functionality for your pipeline can only be configured through the API. For more information, see the CodePipeline User Guide.
You can use the CodePipeline API to work with pipelines, stages, actions, and transitions.
Pipelines are models of automated release processes. Each pipeline is uniquely named, and consists of stages, actions, and transitions.
You can work with pipelines by calling:
CreatePipeline, which creates a uniquely named pipeline.
DeletePipeline, which deletes the specified pipeline.
GetPipeline, which returns information about the pipeline structure and pipeline metadata, including the pipeline Amazon Resource Name (ARN).
GetPipelineExecution, which returns information about a specific execution of a pipeline.
GetPipelineState, which returns information about the current state of the stages and actions of a pipeline.
ListActionExecutions, which returns action-level details for past executions. The details include full stage and action-level details, including individual action duration, status, any errors that occurred during the execution, and input and output artifact location details.
ListPipelines, which gets a summary of all of the pipelines associated with your account.
ListPipelineExecutions, which gets a summary of the most recent executions for a pipeline.
StartPipelineExecution, which runs the most recent revision of an artifact through the pipeline.
StopPipelineExecution, which stops the specified pipeline execution from continuing through the pipeline.
UpdatePipeline, which updates a pipeline with edits or changes to the structure of the pipeline.
Pipelines include stages. Each stage contains one or more actions that must complete before the next stage begins. A stage results in success or failure. If a stage fails, the pipeline stops at that stage and remains stopped until either a new version of an artifact appears in the source location, or a user takes action to rerun the most recent artifact through the pipeline. You can call GetPipelineState, which displays the status of a pipeline, including the status of stages in the pipeline, or GetPipeline, which returns the entire structure of the pipeline, including the stages of that pipeline. For more information about the structure of stages and actions, see CodePipeline Pipeline Structure Reference.
Pipeline stages include actions that are categorized into categories such as source or build actions performed in a stage of a pipeline. For example, you can use a source action to import artifacts into a pipeline from a source such as Amazon S3. Like stages, you do not work with actions directly in most cases, but you do define and interact with actions when working with pipeline operations such as CreatePipeline and GetPipelineState. Valid action categories are:
Source
Build
Test
Deploy
Approval
Invoke
Pipelines also include transitions, which allow the transition of artifacts from one stage to the next in a pipeline after the actions in one stage complete.
You can work with transitions by calling:
DisableStageTransition, which prevents artifacts from transitioning to the next stage in a pipeline.
EnableStageTransition, which enables transition of artifacts between stages in a pipeline.
Using the API to integrate with CodePipeline
For third-party integrators or developers who want to create their own integrations with CodePipeline, the expected sequence varies from the standard API user. To integrate with CodePipeline, developers need to work with the following items:
Jobs, which are instances of an action. For example, a job for a source action might import a revision of an artifact from a source.
You can work with jobs by calling:
AcknowledgeJob, which confirms whether a job worker has received the specified job.
GetJobDetails, which returns the details of a job.
PollForJobs, which determines whether there are any jobs to act on.
PutJobFailureResult, which provides details of a job failure.
PutJobSuccessResult, which provides details of a job success.
Third party jobs, which are instances of an action created by a partner action and integrated into CodePipeline. Partner actions are created by members of the Amazon Web Services Partner Network.
You can work with third party jobs by calling:
AcknowledgeThirdPartyJob, which confirms whether a job worker has received the specified job.
GetThirdPartyJobDetails, which requests the details of a job for a partner action.
PollForThirdPartyJobs, which determines whether there are any jobs to act on.
PutThirdPartyJobFailureResult, which provides details of a job failure.
PutThirdPartyJobSuccessResult, which provides details of a job success.
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 Amazon Web Services 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 Amazon Web Services 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<DeleteWebhookResult> |
deleteWebhookAsync(DeleteWebhookRequest deleteWebhookRequest)
Deletes a previously created webhook by name.
|
Future<DeleteWebhookResult> |
deleteWebhookAsync(DeleteWebhookRequest deleteWebhookRequest,
AsyncHandler<DeleteWebhookRequest,DeleteWebhookResult> asyncHandler)
Deletes a previously created webhook by name.
|
Future<DeregisterWebhookWithThirdPartyResult> |
deregisterWebhookWithThirdPartyAsync(DeregisterWebhookWithThirdPartyRequest deregisterWebhookWithThirdPartyRequest)
Removes the connection between the webhook that was created by CodePipeline and the external tool with events to
be detected.
|
Future<DeregisterWebhookWithThirdPartyResult> |
deregisterWebhookWithThirdPartyAsync(DeregisterWebhookWithThirdPartyRequest deregisterWebhookWithThirdPartyRequest,
AsyncHandler<DeregisterWebhookWithThirdPartyRequest,DeregisterWebhookWithThirdPartyResult> asyncHandler)
Removes the connection between the webhook that was created by CodePipeline and the external tool with events to
be detected.
|
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<GetActionTypeResult> |
getActionTypeAsync(GetActionTypeRequest getActionTypeRequest)
Returns information about an action type created for an external provider, where the action is to be used by
customers of the external provider.
|
Future<GetActionTypeResult> |
getActionTypeAsync(GetActionTypeRequest getActionTypeRequest,
AsyncHandler<GetActionTypeRequest,GetActionTypeResult> asyncHandler)
Returns information about an action type created for an external provider, where the action is to be used by
customers of the external provider.
|
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<ListActionExecutionsResult> |
listActionExecutionsAsync(ListActionExecutionsRequest listActionExecutionsRequest)
Lists the action executions that have occurred in a pipeline.
|
Future<ListActionExecutionsResult> |
listActionExecutionsAsync(ListActionExecutionsRequest listActionExecutionsRequest,
AsyncHandler<ListActionExecutionsRequest,ListActionExecutionsResult> asyncHandler)
Lists the action executions that have occurred in a pipeline.
|
Future<ListActionTypesResult> |
listActionTypesAsync(ListActionTypesRequest listActionTypesRequest)
Gets a summary of all CodePipeline action types associated with your account.
|
Future<ListActionTypesResult> |
listActionTypesAsync(ListActionTypesRequest listActionTypesRequest,
AsyncHandler<ListActionTypesRequest,ListActionTypesResult> asyncHandler)
Gets a summary of all 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<ListRuleExecutionsResult> |
listRuleExecutionsAsync(ListRuleExecutionsRequest listRuleExecutionsRequest)
Lists the rule executions that have occurred in a pipeline configured for conditions with rules.
|
Future<ListRuleExecutionsResult> |
listRuleExecutionsAsync(ListRuleExecutionsRequest listRuleExecutionsRequest,
AsyncHandler<ListRuleExecutionsRequest,ListRuleExecutionsResult> asyncHandler)
Lists the rule executions that have occurred in a pipeline configured for conditions with rules.
|
Future<ListRuleTypesResult> |
listRuleTypesAsync(ListRuleTypesRequest listRuleTypesRequest)
Lists the rules for the condition.
|
Future<ListRuleTypesResult> |
listRuleTypesAsync(ListRuleTypesRequest listRuleTypesRequest,
AsyncHandler<ListRuleTypesRequest,ListRuleTypesResult> asyncHandler)
Lists the rules for the condition.
|
Future<ListTagsForResourceResult> |
listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest)
Gets the set of key-value pairs (metadata) that are used to manage the resource.
|
Future<ListTagsForResourceResult> |
listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest,
AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
Gets the set of key-value pairs (metadata) that are used to manage the resource.
|
Future<ListWebhooksResult> |
listWebhooksAsync(ListWebhooksRequest listWebhooksRequest)
Gets a listing of all the webhooks in this Amazon Web Services Region for this account.
|
Future<ListWebhooksResult> |
listWebhooksAsync(ListWebhooksRequest listWebhooksRequest,
AsyncHandler<ListWebhooksRequest,ListWebhooksResult> asyncHandler)
Gets a listing of all the webhooks in this Amazon Web Services Region for this account.
|
Future<OverrideStageConditionResult> |
overrideStageConditionAsync(OverrideStageConditionRequest overrideStageConditionRequest)
Used to override a stage condition.
|
Future<OverrideStageConditionResult> |
overrideStageConditionAsync(OverrideStageConditionRequest overrideStageConditionRequest,
AsyncHandler<OverrideStageConditionRequest,OverrideStageConditionResult> asyncHandler)
Used to override a stage condition.
|
Future<PollForJobsResult> |
pollForJobsAsync(PollForJobsRequest pollForJobsRequest)
Returns information about any jobs for CodePipeline to act on.
|
Future<PollForJobsResult> |
pollForJobsAsync(PollForJobsRequest pollForJobsRequest,
AsyncHandler<PollForJobsRequest,PollForJobsResult> asyncHandler)
Returns information about any jobs for CodePipeline to act on.
|
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 CodePipeline about new revisions to a source.
|
Future<PutActionRevisionResult> |
putActionRevisionAsync(PutActionRevisionRequest putActionRevisionRequest,
AsyncHandler<PutActionRevisionRequest,PutActionRevisionResult> asyncHandler)
Provides information to CodePipeline about new revisions to a source.
|
Future<PutApprovalResultResult> |
putApprovalResultAsync(PutApprovalResultRequest putApprovalResultRequest)
Provides the response to a manual approval request to CodePipeline.
|
Future<PutApprovalResultResult> |
putApprovalResultAsync(PutApprovalResultRequest putApprovalResultRequest,
AsyncHandler<PutApprovalResultRequest,PutApprovalResultResult> asyncHandler)
Provides the response to a manual approval request to 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<PutWebhookResult> |
putWebhookAsync(PutWebhookRequest putWebhookRequest)
Defines a webhook and returns a unique webhook URL generated by CodePipeline.
|
Future<PutWebhookResult> |
putWebhookAsync(PutWebhookRequest putWebhookRequest,
AsyncHandler<PutWebhookRequest,PutWebhookResult> asyncHandler)
Defines a webhook and returns a unique webhook URL generated by CodePipeline.
|
Future<RegisterWebhookWithThirdPartyResult> |
registerWebhookWithThirdPartyAsync(RegisterWebhookWithThirdPartyRequest registerWebhookWithThirdPartyRequest)
Configures a connection between the webhook that was created and the external tool with events to be detected.
|
Future<RegisterWebhookWithThirdPartyResult> |
registerWebhookWithThirdPartyAsync(RegisterWebhookWithThirdPartyRequest registerWebhookWithThirdPartyRequest,
AsyncHandler<RegisterWebhookWithThirdPartyRequest,RegisterWebhookWithThirdPartyResult> asyncHandler)
Configures a connection between the webhook that was created and the external tool with events to be detected.
|
Future<RetryStageExecutionResult> |
retryStageExecutionAsync(RetryStageExecutionRequest retryStageExecutionRequest)
You can retry a stage that has failed without having to run a pipeline again from the beginning.
|
Future<RetryStageExecutionResult> |
retryStageExecutionAsync(RetryStageExecutionRequest retryStageExecutionRequest,
AsyncHandler<RetryStageExecutionRequest,RetryStageExecutionResult> asyncHandler)
You can retry a stage that has failed without having to run a pipeline again from the beginning.
|
Future<RollbackStageResult> |
rollbackStageAsync(RollbackStageRequest rollbackStageRequest)
Rolls back a stage execution.
|
Future<RollbackStageResult> |
rollbackStageAsync(RollbackStageRequest rollbackStageRequest,
AsyncHandler<RollbackStageRequest,RollbackStageResult> asyncHandler)
Rolls back a stage execution.
|
Future<StartPipelineExecutionResult> |
startPipelineExecutionAsync(StartPipelineExecutionRequest startPipelineExecutionRequest)
Starts the specified pipeline.
|
Future<StartPipelineExecutionResult> |
startPipelineExecutionAsync(StartPipelineExecutionRequest startPipelineExecutionRequest,
AsyncHandler<StartPipelineExecutionRequest,StartPipelineExecutionResult> asyncHandler)
Starts the specified pipeline.
|
Future<StopPipelineExecutionResult> |
stopPipelineExecutionAsync(StopPipelineExecutionRequest stopPipelineExecutionRequest)
Stops the specified pipeline execution.
|
Future<StopPipelineExecutionResult> |
stopPipelineExecutionAsync(StopPipelineExecutionRequest stopPipelineExecutionRequest,
AsyncHandler<StopPipelineExecutionRequest,StopPipelineExecutionResult> asyncHandler)
Stops the specified pipeline execution.
|
Future<TagResourceResult> |
tagResourceAsync(TagResourceRequest tagResourceRequest)
Adds to or modifies the tags of the given resource.
|
Future<TagResourceResult> |
tagResourceAsync(TagResourceRequest tagResourceRequest,
AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
Adds to or modifies the tags of the given resource.
|
Future<UntagResourceResult> |
untagResourceAsync(UntagResourceRequest untagResourceRequest)
Removes tags from an Amazon Web Services resource.
|
Future<UntagResourceResult> |
untagResourceAsync(UntagResourceRequest untagResourceRequest,
AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
Removes tags from an Amazon Web Services resource.
|
Future<UpdateActionTypeResult> |
updateActionTypeAsync(UpdateActionTypeRequest updateActionTypeRequest)
Updates an action type that was created with any supported integration model, where the action type is to be used
by customers of the action type provider.
|
Future<UpdateActionTypeResult> |
updateActionTypeAsync(UpdateActionTypeRequest updateActionTypeRequest,
AsyncHandler<UpdateActionTypeRequest,UpdateActionTypeResult> asyncHandler)
Updates an action type that was created with any supported integration model, where the action type is to be used
by customers of the action type provider.
|
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, deleteWebhook, deregisterWebhookWithThirdParty, disableStageTransition, enableStageTransition, getActionType, getCachedResponseMetadata, getJobDetails, getPipeline, getPipelineExecution, getPipelineState, getThirdPartyJobDetails, listActionExecutions, listActionTypes, listPipelineExecutions, listPipelines, listRuleExecutions, listRuleTypes, listTagsForResource, listWebhooks, overrideStageCondition, pollForJobs, pollForThirdPartyJobs, putActionRevision, putApprovalResult, putJobFailureResult, putJobSuccessResult, putThirdPartyJobFailureResult, putThirdPartyJobSuccessResult, putWebhook, registerWebhookWithThirdParty, retryStageExecution, rollbackStage, setEndpoint, setRegion, shutdown, startPipelineExecution, stopPipelineExecution, tagResource, untagResource, updateActionType, updatePipeline
Future<AcknowledgeJobResult> acknowledgeJobAsync(AcknowledgeJobRequest acknowledgeJobRequest)
Returns information about a specified job and whether that job has been received by the job worker. Used for custom actions only.
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. Used for custom actions only.
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. Used for partner actions only.
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. Used for partner actions only.
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 Amazon Web Services 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 Amazon Web Services 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.
In the pipeline structure, you must include either artifactStore
or artifactStores
in
your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use
artifactStores
.
createPipelineRequest
- Represents the input of a CreatePipeline
action.Future<CreatePipelineResult> createPipelineAsync(CreatePipelineRequest createPipelineRequest, AsyncHandler<CreatePipelineRequest,CreatePipelineResult> asyncHandler)
Creates a pipeline.
In the pipeline structure, you must include either artifactStore
or artifactStores
in
your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use
artifactStores
.
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 fails after the action is marked
for deletion. Used for custom actions only.
To re-create a custom action after it has been deleted you must use a string in the version field that has never been used before. This string can be an incremented version number, for example. To restore a deleted custom action, use a JSON file that is identical to the deleted action, including the original string in the version field.
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 fails after the action is marked
for deletion. Used for custom actions only.
To re-create a custom action after it has been deleted you must use a string in the version field that has never been used before. This string can be an incremented version number, for example. To restore a deleted custom action, use a JSON file that is identical to the deleted action, including the original string in the version field.
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<DeleteWebhookResult> deleteWebhookAsync(DeleteWebhookRequest deleteWebhookRequest)
Deletes a previously created webhook by name. Deleting the webhook stops CodePipeline from starting a pipeline every time an external event occurs. The API returns successfully when trying to delete a webhook that is already deleted. If a deleted webhook is re-created by calling PutWebhook with the same name, it will have a different URL.
deleteWebhookRequest
- Future<DeleteWebhookResult> deleteWebhookAsync(DeleteWebhookRequest deleteWebhookRequest, AsyncHandler<DeleteWebhookRequest,DeleteWebhookResult> asyncHandler)
Deletes a previously created webhook by name. Deleting the webhook stops CodePipeline from starting a pipeline every time an external event occurs. The API returns successfully when trying to delete a webhook that is already deleted. If a deleted webhook is re-created by calling PutWebhook with the same name, it will have a different URL.
deleteWebhookRequest
- 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<DeregisterWebhookWithThirdPartyResult> deregisterWebhookWithThirdPartyAsync(DeregisterWebhookWithThirdPartyRequest deregisterWebhookWithThirdPartyRequest)
Removes the connection between the webhook that was created by CodePipeline and the external tool with events to be detected. Currently supported only for webhooks that target an action type of GitHub.
deregisterWebhookWithThirdPartyRequest
- Future<DeregisterWebhookWithThirdPartyResult> deregisterWebhookWithThirdPartyAsync(DeregisterWebhookWithThirdPartyRequest deregisterWebhookWithThirdPartyRequest, AsyncHandler<DeregisterWebhookWithThirdPartyRequest,DeregisterWebhookWithThirdPartyResult> asyncHandler)
Removes the connection between the webhook that was created by CodePipeline and the external tool with events to be detected. Currently supported only for webhooks that target an action type of GitHub.
deregisterWebhookWithThirdPartyRequest
- 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<GetActionTypeResult> getActionTypeAsync(GetActionTypeRequest getActionTypeRequest)
Returns information about an action type created for an external provider, where the action is to be used by customers of the external provider. The action can be created with any supported integration model.
getActionTypeRequest
- Future<GetActionTypeResult> getActionTypeAsync(GetActionTypeRequest getActionTypeRequest, AsyncHandler<GetActionTypeRequest,GetActionTypeResult> asyncHandler)
Returns information about an action type created for an external provider, where the action is to be used by customers of the external provider. The action can be created with any supported integration model.
getActionTypeRequest
- 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. Used for custom actions only.
When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.
getJobDetailsRequest
- Represents the input of a GetJobDetails
action.Future<GetJobDetailsResult> getJobDetailsAsync(GetJobDetailsRequest getJobDetailsRequest, AsyncHandler<GetJobDetailsRequest,GetJobDetailsResult> asyncHandler)
Returns information about a job. Used for custom actions only.
When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.
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.
Values returned in the revisionId
and revisionUrl
fields indicate the source revision
information, such as the commit ID, for the current state.
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.
Values returned in the revisionId
and revisionUrl
fields indicate the source revision
information, such as the commit ID, for the current state.
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. Used for partner actions only.
When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.
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. Used for partner actions only.
When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.
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<ListActionExecutionsResult> listActionExecutionsAsync(ListActionExecutionsRequest listActionExecutionsRequest)
Lists the action executions that have occurred in a pipeline.
listActionExecutionsRequest
- Future<ListActionExecutionsResult> listActionExecutionsAsync(ListActionExecutionsRequest listActionExecutionsRequest, AsyncHandler<ListActionExecutionsRequest,ListActionExecutionsResult> asyncHandler)
Lists the action executions that have occurred in a pipeline.
listActionExecutionsRequest
- 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 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 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.
When applying the filter for pipeline executions that have succeeded in the stage, the operation returns all executions in the current pipeline version beginning on February 1, 2024.
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.
When applying the filter for pipeline executions that have succeeded in the stage, the operation returns all executions in the current pipeline version beginning on February 1, 2024.
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<ListRuleExecutionsResult> listRuleExecutionsAsync(ListRuleExecutionsRequest listRuleExecutionsRequest)
Lists the rule executions that have occurred in a pipeline configured for conditions with rules.
listRuleExecutionsRequest
- Future<ListRuleExecutionsResult> listRuleExecutionsAsync(ListRuleExecutionsRequest listRuleExecutionsRequest, AsyncHandler<ListRuleExecutionsRequest,ListRuleExecutionsResult> asyncHandler)
Lists the rule executions that have occurred in a pipeline configured for conditions with rules.
listRuleExecutionsRequest
- 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<ListRuleTypesResult> listRuleTypesAsync(ListRuleTypesRequest listRuleTypesRequest)
Lists the rules for the condition.
listRuleTypesRequest
- Future<ListRuleTypesResult> listRuleTypesAsync(ListRuleTypesRequest listRuleTypesRequest, AsyncHandler<ListRuleTypesRequest,ListRuleTypesResult> asyncHandler)
Lists the rules for the condition.
listRuleTypesRequest
- 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<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest)
Gets the set of key-value pairs (metadata) that are used to manage the resource.
listTagsForResourceRequest
- Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
Gets the set of key-value pairs (metadata) that are used to manage the resource.
listTagsForResourceRequest
- 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<ListWebhooksResult> listWebhooksAsync(ListWebhooksRequest listWebhooksRequest)
Gets a listing of all the webhooks in this Amazon Web Services Region for this account. The output lists all webhooks and includes the webhook URL and ARN and the configuration for each webhook.
listWebhooksRequest
- Future<ListWebhooksResult> listWebhooksAsync(ListWebhooksRequest listWebhooksRequest, AsyncHandler<ListWebhooksRequest,ListWebhooksResult> asyncHandler)
Gets a listing of all the webhooks in this Amazon Web Services Region for this account. The output lists all webhooks and includes the webhook URL and ARN and the configuration for each webhook.
listWebhooksRequest
- 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<OverrideStageConditionResult> overrideStageConditionAsync(OverrideStageConditionRequest overrideStageConditionRequest)
Used to override a stage condition.
overrideStageConditionRequest
- Future<OverrideStageConditionResult> overrideStageConditionAsync(OverrideStageConditionRequest overrideStageConditionRequest, AsyncHandler<OverrideStageConditionRequest,OverrideStageConditionResult> asyncHandler)
Used to override a stage condition.
overrideStageConditionRequest
- 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 CodePipeline to act on. PollForJobs
is valid only for action
types with "Custom" in the owner field. If the action type contains AWS
or ThirdParty
in the owner field, the PollForJobs
action returns an error.
When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.
pollForJobsRequest
- Represents the input of a PollForJobs
action.Future<PollForJobsResult> pollForJobsAsync(PollForJobsRequest pollForJobsRequest, AsyncHandler<PollForJobsRequest,PollForJobsResult> asyncHandler)
Returns information about any jobs for CodePipeline to act on. PollForJobs
is valid only for action
types with "Custom" in the owner field. If the action type contains AWS
or ThirdParty
in the owner field, the PollForJobs
action returns an error.
When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.
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. Used for partner actions only.
When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts.
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. Used for partner actions only.
When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts.
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 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 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 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 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. Used for custom actions only.
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. Used for custom actions only.
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. Used for custom actions only.
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. Used for custom actions only.
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. Used for partner actions only.
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. Used for partner actions only.
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. Used for partner actions only.
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. Used for partner actions only.
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<PutWebhookResult> putWebhookAsync(PutWebhookRequest putWebhookRequest)
Defines a webhook and returns a unique webhook URL generated by CodePipeline. This URL can be supplied to third party source hosting providers to call every time there's a code change. When CodePipeline receives a POST request on this URL, the pipeline defined in the webhook is started as long as the POST request satisfied the authentication and filtering requirements supplied when defining the webhook. RegisterWebhookWithThirdParty and DeregisterWebhookWithThirdParty APIs can be used to automatically configure supported third parties to call the generated webhook URL.
putWebhookRequest
- Future<PutWebhookResult> putWebhookAsync(PutWebhookRequest putWebhookRequest, AsyncHandler<PutWebhookRequest,PutWebhookResult> asyncHandler)
Defines a webhook and returns a unique webhook URL generated by CodePipeline. This URL can be supplied to third party source hosting providers to call every time there's a code change. When CodePipeline receives a POST request on this URL, the pipeline defined in the webhook is started as long as the POST request satisfied the authentication and filtering requirements supplied when defining the webhook. RegisterWebhookWithThirdParty and DeregisterWebhookWithThirdParty APIs can be used to automatically configure supported third parties to call the generated webhook URL.
putWebhookRequest
- 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<RegisterWebhookWithThirdPartyResult> registerWebhookWithThirdPartyAsync(RegisterWebhookWithThirdPartyRequest registerWebhookWithThirdPartyRequest)
Configures a connection between the webhook that was created and the external tool with events to be detected.
registerWebhookWithThirdPartyRequest
- Future<RegisterWebhookWithThirdPartyResult> registerWebhookWithThirdPartyAsync(RegisterWebhookWithThirdPartyRequest registerWebhookWithThirdPartyRequest, AsyncHandler<RegisterWebhookWithThirdPartyRequest,RegisterWebhookWithThirdPartyResult> asyncHandler)
Configures a connection between the webhook that was created and the external tool with events to be detected.
registerWebhookWithThirdPartyRequest
- 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)
You can retry a stage that has failed without having to run a pipeline again from the beginning. You do this by either retrying the failed actions in a stage or by retrying all actions in the stage starting from the first action in the stage. When you retry the failed actions in a stage, all actions that are still in progress continue working, and failed actions are triggered again. When you retry a failed stage from the first action in the stage, the stage cannot have any actions in progress. Before a stage can be retried, it must either have all actions failed or some actions failed and some succeeded.
retryStageExecutionRequest
- Represents the input of a RetryStageExecution
action.Future<RetryStageExecutionResult> retryStageExecutionAsync(RetryStageExecutionRequest retryStageExecutionRequest, AsyncHandler<RetryStageExecutionRequest,RetryStageExecutionResult> asyncHandler)
You can retry a stage that has failed without having to run a pipeline again from the beginning. You do this by either retrying the failed actions in a stage or by retrying all actions in the stage starting from the first action in the stage. When you retry the failed actions in a stage, all actions that are still in progress continue working, and failed actions are triggered again. When you retry a failed stage from the first action in the stage, the stage cannot have any actions in progress. Before a stage can be retried, it must either have all actions failed or some actions failed and some succeeded.
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<RollbackStageResult> rollbackStageAsync(RollbackStageRequest rollbackStageRequest)
Rolls back a stage execution.
rollbackStageRequest
- Future<RollbackStageResult> rollbackStageAsync(RollbackStageRequest rollbackStageRequest, AsyncHandler<RollbackStageRequest,RollbackStageResult> asyncHandler)
Rolls back a stage execution.
rollbackStageRequest
- 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<StopPipelineExecutionResult> stopPipelineExecutionAsync(StopPipelineExecutionRequest stopPipelineExecutionRequest)
Stops the specified pipeline execution. You choose to either stop the pipeline execution by completing
in-progress actions without starting subsequent actions, or by abandoning in-progress actions. While completing
or abandoning in-progress actions, the pipeline execution is in a Stopping
state. After all
in-progress actions are completed or abandoned, the pipeline execution is in a Stopped
state.
stopPipelineExecutionRequest
- Future<StopPipelineExecutionResult> stopPipelineExecutionAsync(StopPipelineExecutionRequest stopPipelineExecutionRequest, AsyncHandler<StopPipelineExecutionRequest,StopPipelineExecutionResult> asyncHandler)
Stops the specified pipeline execution. You choose to either stop the pipeline execution by completing
in-progress actions without starting subsequent actions, or by abandoning in-progress actions. While completing
or abandoning in-progress actions, the pipeline execution is in a Stopping
state. After all
in-progress actions are completed or abandoned, the pipeline execution is in a Stopped
state.
stopPipelineExecutionRequest
- 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<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest)
Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.
tagResourceRequest
- Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.
tagResourceRequest
- 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<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest)
Removes tags from an Amazon Web Services resource.
untagResourceRequest
- Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
Removes tags from an Amazon Web Services resource.
untagResourceRequest
- 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<UpdateActionTypeResult> updateActionTypeAsync(UpdateActionTypeRequest updateActionTypeRequest)
Updates an action type that was created with any supported integration model, where the action type is to be used
by customers of the action type provider. Use a JSON file with the action definition and
UpdateActionType
to provide the full structure.
updateActionTypeRequest
- Future<UpdateActionTypeResult> updateActionTypeAsync(UpdateActionTypeRequest updateActionTypeRequest, AsyncHandler<UpdateActionTypeRequest,UpdateActionTypeResult> asyncHandler)
Updates an action type that was created with any supported integration model, where the action type is to be used
by customers of the action type provider. Use a JSON file with the action definition and
UpdateActionType
to provide the full structure.
updateActionTypeRequest
- 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
and 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
and 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.