com.amazonaws.services.codepipeline.AWSCodePipelineAsync Maven / Gradle / Ivy
Show all versions of aws-java-sdk-codepipeline Show documentation
/*
* Copyright 2011-2016 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.codepipeline;
import com.amazonaws.services.codepipeline.model.*;
/**
* Interface for accessing CodePipeline asynchronously. Each asynchronous method will return a Java Future object
* representing the asynchronous operation; overloads which accept an {@code AsyncHandler} can be used to receive
* notification when an asynchronous operation completes.
*
* AWS CodePipeline
*
* Overview
*
*
* This is the AWS CodePipeline API Reference. This guide provides descriptions of the actions and data types for AWS
* CodePipeline. Some functionality for your pipeline is only configurable through the API. For additional information,
* see the AWS CodePipeline User
* Guide.
*
*
* You can use the AWS CodePipeline API to work with pipelines, stages, actions, gates, and transitions, as described
* below.
*
*
* Pipelines are models of automated release processes. Each pipeline is uniquely named, and consists of actions,
* gates, and stages.
*
*
* You can work with pipelines by calling:
*
*
* -
*
* CreatePipeline, which creates a uniquely-named pipeline.
*
*
* -
*
* DeletePipeline, which deletes the specified pipeline.
*
*
* -
*
* GetPipeline, which returns information about a pipeline structure.
*
*
* -
*
* GetPipelineExecution, which returns information about a specific execution of a pipeline.
*
*
* -
*
* GetPipelineState, which returns information about the current state of the stages and actions of a pipeline.
*
*
* -
*
* ListPipelines, which gets a summary of all of the pipelines associated with your account.
*
*
* -
*
* 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.
*
*
*
*/
public interface AWSCodePipelineAsync extends AWSCodePipeline {
/**
*
* Returns information about a specified job and whether that job has been received by the job worker. Only used for
* custom actions.
*
*
* @param acknowledgeJobRequest
* Represents the input of an acknowledge job action.
* @return A Java Future containing the result of the AcknowledgeJob operation returned by the service.
* @sample AWSCodePipelineAsync.AcknowledgeJob
*/
java.util.concurrent.Future 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.
*
*
* @param acknowledgeJobRequest
* Represents the input of an acknowledge job action.
* @param 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.
* @return A Java Future containing the result of the AcknowledgeJob operation returned by the service.
* @sample AWSCodePipelineAsyncHandler.AcknowledgeJob
*/
java.util.concurrent.Future acknowledgeJobAsync(AcknowledgeJobRequest acknowledgeJobRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Confirms a job worker has received the specified job. Only used for partner actions.
*
*
* @param acknowledgeThirdPartyJobRequest
* Represents the input of an acknowledge third party job action.
* @return A Java Future containing the result of the AcknowledgeThirdPartyJob operation returned by the service.
* @sample AWSCodePipelineAsync.AcknowledgeThirdPartyJob
*/
java.util.concurrent.Future acknowledgeThirdPartyJobAsync(AcknowledgeThirdPartyJobRequest acknowledgeThirdPartyJobRequest);
/**
*
* Confirms a job worker has received the specified job. Only used for partner actions.
*
*
* @param acknowledgeThirdPartyJobRequest
* Represents the input of an acknowledge third party job action.
* @param 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.
* @return A Java Future containing the result of the AcknowledgeThirdPartyJob operation returned by the service.
* @sample AWSCodePipelineAsyncHandler.AcknowledgeThirdPartyJob
*/
java.util.concurrent.Future acknowledgeThirdPartyJobAsync(AcknowledgeThirdPartyJobRequest acknowledgeThirdPartyJobRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Creates a new custom action that can be used in all pipelines associated with the AWS account. Only used for
* custom actions.
*
*
* @param createCustomActionTypeRequest
* Represents the input of a create custom action operation.
* @return A Java Future containing the result of the CreateCustomActionType operation returned by the service.
* @sample AWSCodePipelineAsync.CreateCustomActionType
*/
java.util.concurrent.Future 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.
*
*
* @param createCustomActionTypeRequest
* Represents the input of a create custom action operation.
* @param 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.
* @return A Java Future containing the result of the CreateCustomActionType operation returned by the service.
* @sample AWSCodePipelineAsyncHandler.CreateCustomActionType
*/
java.util.concurrent.Future createCustomActionTypeAsync(CreateCustomActionTypeRequest createCustomActionTypeRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Creates a pipeline.
*
*
* @param createPipelineRequest
* Represents the input of a create pipeline action.
* @return A Java Future containing the result of the CreatePipeline operation returned by the service.
* @sample AWSCodePipelineAsync.CreatePipeline
*/
java.util.concurrent.Future createPipelineAsync(CreatePipelineRequest createPipelineRequest);
/**
*
* Creates a pipeline.
*
*
* @param createPipelineRequest
* Represents the input of a create pipeline action.
* @param 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.
* @return A Java Future containing the result of the CreatePipeline operation returned by the service.
* @sample AWSCodePipelineAsyncHandler.CreatePipeline
*/
java.util.concurrent.Future createPipelineAsync(CreatePipelineRequest createPipelineRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
*
* @param deleteCustomActionTypeRequest
* Represents the input of a delete custom action operation. The custom action will be marked as deleted.
* @return A Java Future containing the result of the DeleteCustomActionType operation returned by the service.
* @sample AWSCodePipelineAsync.DeleteCustomActionType
*/
java.util.concurrent.Future 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.
*
*
*
* @param deleteCustomActionTypeRequest
* Represents the input of a delete custom action operation. The custom action will be marked as deleted.
* @param 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.
* @return A Java Future containing the result of the DeleteCustomActionType operation returned by the service.
* @sample AWSCodePipelineAsyncHandler.DeleteCustomActionType
*/
java.util.concurrent.Future deleteCustomActionTypeAsync(DeleteCustomActionTypeRequest deleteCustomActionTypeRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Deletes the specified pipeline.
*
*
* @param deletePipelineRequest
* Represents the input of a delete pipeline action.
* @return A Java Future containing the result of the DeletePipeline operation returned by the service.
* @sample AWSCodePipelineAsync.DeletePipeline
*/
java.util.concurrent.Future deletePipelineAsync(DeletePipelineRequest deletePipelineRequest);
/**
*
* Deletes the specified pipeline.
*
*
* @param deletePipelineRequest
* Represents the input of a delete pipeline action.
* @param 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.
* @return A Java Future containing the result of the DeletePipeline operation returned by the service.
* @sample AWSCodePipelineAsyncHandler.DeletePipeline
*/
java.util.concurrent.Future deletePipelineAsync(DeletePipelineRequest deletePipelineRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline.
*
*
* @param disableStageTransitionRequest
* Represents the input of a disable stage transition input action.
* @return A Java Future containing the result of the DisableStageTransition operation returned by the service.
* @sample AWSCodePipelineAsync.DisableStageTransition
*/
java.util.concurrent.Future disableStageTransitionAsync(DisableStageTransitionRequest disableStageTransitionRequest);
/**
*
* Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline.
*
*
* @param disableStageTransitionRequest
* Represents the input of a disable stage transition input action.
* @param 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.
* @return A Java Future containing the result of the DisableStageTransition operation returned by the service.
* @sample AWSCodePipelineAsyncHandler.DisableStageTransition
*/
java.util.concurrent.Future disableStageTransitionAsync(DisableStageTransitionRequest disableStageTransitionRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Enables artifacts in a pipeline to transition to a stage in a pipeline.
*
*
* @param enableStageTransitionRequest
* Represents the input of an enable stage transition action.
* @return A Java Future containing the result of the EnableStageTransition operation returned by the service.
* @sample AWSCodePipelineAsync.EnableStageTransition
*/
java.util.concurrent.Future enableStageTransitionAsync(EnableStageTransitionRequest enableStageTransitionRequest);
/**
*
* Enables artifacts in a pipeline to transition to a stage in a pipeline.
*
*
* @param enableStageTransitionRequest
* Represents the input of an enable stage transition action.
* @param 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.
* @return A Java Future containing the result of the EnableStageTransition operation returned by the service.
* @sample AWSCodePipelineAsyncHandler.EnableStageTransition
*/
java.util.concurrent.Future enableStageTransitionAsync(EnableStageTransitionRequest enableStageTransitionRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
*
* @param getJobDetailsRequest
* Represents the input of a get job details action.
* @return A Java Future containing the result of the GetJobDetails operation returned by the service.
* @sample AWSCodePipelineAsync.GetJobDetails
*/
java.util.concurrent.Future 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.
*
*
*
* @param getJobDetailsRequest
* Represents the input of a get job details action.
* @param 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.
* @return A Java Future containing the result of the GetJobDetails operation returned by the service.
* @sample AWSCodePipelineAsyncHandler.GetJobDetails
*/
java.util.concurrent.Future getJobDetailsAsync(GetJobDetailsRequest getJobDetailsRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param getPipelineRequest
* Represents the input of a get pipeline action.
* @return A Java Future containing the result of the GetPipeline operation returned by the service.
* @sample AWSCodePipelineAsync.GetPipeline
*/
java.util.concurrent.Future 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.
*
*
* @param getPipelineRequest
* Represents the input of a get pipeline action.
* @param 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.
* @return A Java Future containing the result of the GetPipeline operation returned by the service.
* @sample AWSCodePipelineAsyncHandler.GetPipeline
*/
java.util.concurrent.Future getPipelineAsync(GetPipelineRequest getPipelineRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param getPipelineExecutionRequest
* Represents the input of a get pipeline execution action.
* @return A Java Future containing the result of the GetPipelineExecution operation returned by the service.
* @sample AWSCodePipelineAsync.GetPipelineExecution
*/
java.util.concurrent.Future 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.
*
*
* @param getPipelineExecutionRequest
* Represents the input of a get pipeline execution action.
* @param 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.
* @return A Java Future containing the result of the GetPipelineExecution operation returned by the service.
* @sample AWSCodePipelineAsyncHandler.GetPipelineExecution
*/
java.util.concurrent.Future getPipelineExecutionAsync(GetPipelineExecutionRequest getPipelineExecutionRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Returns information about the state of a pipeline, including the stages and actions.
*
*
* @param getPipelineStateRequest
* Represents the input of a get pipeline state action.
* @return A Java Future containing the result of the GetPipelineState operation returned by the service.
* @sample AWSCodePipelineAsync.GetPipelineState
*/
java.util.concurrent.Future getPipelineStateAsync(GetPipelineStateRequest getPipelineStateRequest);
/**
*
* Returns information about the state of a pipeline, including the stages and actions.
*
*
* @param getPipelineStateRequest
* Represents the input of a get pipeline state action.
* @param 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.
* @return A Java Future containing the result of the GetPipelineState operation returned by the service.
* @sample AWSCodePipelineAsyncHandler.GetPipelineState
*/
java.util.concurrent.Future getPipelineStateAsync(GetPipelineStateRequest getPipelineStateRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
*
* @param getThirdPartyJobDetailsRequest
* Represents the input of a get third party job details action.
* @return A Java Future containing the result of the GetThirdPartyJobDetails operation returned by the service.
* @sample AWSCodePipelineAsync.GetThirdPartyJobDetails
*/
java.util.concurrent.Future 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.
*
*
*
* @param getThirdPartyJobDetailsRequest
* Represents the input of a get third party job details action.
* @param 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.
* @return A Java Future containing the result of the GetThirdPartyJobDetails operation returned by the service.
* @sample AWSCodePipelineAsyncHandler.GetThirdPartyJobDetails
*/
java.util.concurrent.Future getThirdPartyJobDetailsAsync(GetThirdPartyJobDetailsRequest getThirdPartyJobDetailsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Gets a summary of all AWS CodePipeline action types associated with your account.
*
*
* @param listActionTypesRequest
* Represents the input of a list action types action.
* @return A Java Future containing the result of the ListActionTypes operation returned by the service.
* @sample AWSCodePipelineAsync.ListActionTypes
*/
java.util.concurrent.Future listActionTypesAsync(ListActionTypesRequest listActionTypesRequest);
/**
*
* Gets a summary of all AWS CodePipeline action types associated with your account.
*
*
* @param listActionTypesRequest
* Represents the input of a list action types action.
* @param 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.
* @return A Java Future containing the result of the ListActionTypes operation returned by the service.
* @sample AWSCodePipelineAsyncHandler.ListActionTypes
*/
java.util.concurrent.Future listActionTypesAsync(ListActionTypesRequest listActionTypesRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Gets a summary of all of the pipelines associated with your account.
*
*
* @param listPipelinesRequest
* Represents the input of a list pipelines action.
* @return A Java Future containing the result of the ListPipelines operation returned by the service.
* @sample AWSCodePipelineAsync.ListPipelines
*/
java.util.concurrent.Future listPipelinesAsync(ListPipelinesRequest listPipelinesRequest);
/**
*
* Gets a summary of all of the pipelines associated with your account.
*
*
* @param listPipelinesRequest
* Represents the input of a list pipelines action.
* @param 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.
* @return A Java Future containing the result of the ListPipelines operation returned by the service.
* @sample AWSCodePipelineAsyncHandler.ListPipelines
*/
java.util.concurrent.Future listPipelinesAsync(ListPipelinesRequest listPipelinesRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
*
* @param pollForJobsRequest
* Represents the input of a poll for jobs action.
* @return A Java Future containing the result of the PollForJobs operation returned by the service.
* @sample AWSCodePipelineAsync.PollForJobs
*/
java.util.concurrent.Future 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.
*
*
*
* @param pollForJobsRequest
* Represents the input of a poll for jobs action.
* @param 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.
* @return A Java Future containing the result of the PollForJobs operation returned by the service.
* @sample AWSCodePipelineAsyncHandler.PollForJobs
*/
java.util.concurrent.Future pollForJobsAsync(PollForJobsRequest pollForJobsRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
*
* @param pollForThirdPartyJobsRequest
* Represents the input of a poll for third party jobs action.
* @return A Java Future containing the result of the PollForThirdPartyJobs operation returned by the service.
* @sample AWSCodePipelineAsync.PollForThirdPartyJobs
*/
java.util.concurrent.Future 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.
*
*
*
* @param pollForThirdPartyJobsRequest
* Represents the input of a poll for third party jobs action.
* @param 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.
* @return A Java Future containing the result of the PollForThirdPartyJobs operation returned by the service.
* @sample AWSCodePipelineAsyncHandler.PollForThirdPartyJobs
*/
java.util.concurrent.Future pollForThirdPartyJobsAsync(PollForThirdPartyJobsRequest pollForThirdPartyJobsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Provides information to AWS CodePipeline about new revisions to a source.
*
*
* @param putActionRevisionRequest
* Represents the input of a put action revision action.
* @return A Java Future containing the result of the PutActionRevision operation returned by the service.
* @sample AWSCodePipelineAsync.PutActionRevision
*/
java.util.concurrent.Future putActionRevisionAsync(PutActionRevisionRequest putActionRevisionRequest);
/**
*
* Provides information to AWS CodePipeline about new revisions to a source.
*
*
* @param putActionRevisionRequest
* Represents the input of a put action revision action.
* @param 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.
* @return A Java Future containing the result of the PutActionRevision operation returned by the service.
* @sample AWSCodePipelineAsyncHandler.PutActionRevision
*/
java.util.concurrent.Future putActionRevisionAsync(PutActionRevisionRequest putActionRevisionRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Provides the response to a manual approval request to AWS CodePipeline. Valid responses include Approved and
* Rejected.
*
*
* @param putApprovalResultRequest
* Represents the input of a put approval result action.
* @return A Java Future containing the result of the PutApprovalResult operation returned by the service.
* @sample AWSCodePipelineAsync.PutApprovalResult
*/
java.util.concurrent.Future putApprovalResultAsync(PutApprovalResultRequest putApprovalResultRequest);
/**
*
* Provides the response to a manual approval request to AWS CodePipeline. Valid responses include Approved and
* Rejected.
*
*
* @param putApprovalResultRequest
* Represents the input of a put approval result action.
* @param 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.
* @return A Java Future containing the result of the PutApprovalResult operation returned by the service.
* @sample AWSCodePipelineAsyncHandler.PutApprovalResult
*/
java.util.concurrent.Future putApprovalResultAsync(PutApprovalResultRequest putApprovalResultRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Represents the failure of a job as returned to the pipeline by a job worker. Only used for custom actions.
*
*
* @param putJobFailureResultRequest
* Represents the input of a put job failure result action.
* @return A Java Future containing the result of the PutJobFailureResult operation returned by the service.
* @sample AWSCodePipelineAsync.PutJobFailureResult
*/
java.util.concurrent.Future putJobFailureResultAsync(PutJobFailureResultRequest putJobFailureResultRequest);
/**
*
* Represents the failure of a job as returned to the pipeline by a job worker. Only used for custom actions.
*
*
* @param putJobFailureResultRequest
* Represents the input of a put job failure result action.
* @param 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.
* @return A Java Future containing the result of the PutJobFailureResult operation returned by the service.
* @sample AWSCodePipelineAsyncHandler.PutJobFailureResult
*/
java.util.concurrent.Future putJobFailureResultAsync(PutJobFailureResultRequest putJobFailureResultRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Represents the success of a job as returned to the pipeline by a job worker. Only used for custom actions.
*
*
* @param putJobSuccessResultRequest
* Represents the input of a put job success result action.
* @return A Java Future containing the result of the PutJobSuccessResult operation returned by the service.
* @sample AWSCodePipelineAsync.PutJobSuccessResult
*/
java.util.concurrent.Future putJobSuccessResultAsync(PutJobSuccessResultRequest putJobSuccessResultRequest);
/**
*
* Represents the success of a job as returned to the pipeline by a job worker. Only used for custom actions.
*
*
* @param putJobSuccessResultRequest
* Represents the input of a put job success result action.
* @param 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.
* @return A Java Future containing the result of the PutJobSuccessResult operation returned by the service.
* @sample AWSCodePipelineAsyncHandler.PutJobSuccessResult
*/
java.util.concurrent.Future putJobSuccessResultAsync(PutJobSuccessResultRequest putJobSuccessResultRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Represents the failure of a third party job as returned to the pipeline by a job worker. Only used for partner
* actions.
*
*
* @param putThirdPartyJobFailureResultRequest
* Represents the input of a third party job failure result action.
* @return A Java Future containing the result of the PutThirdPartyJobFailureResult operation returned by the
* service.
* @sample AWSCodePipelineAsync.PutThirdPartyJobFailureResult
*/
java.util.concurrent.Future 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.
*
*
* @param putThirdPartyJobFailureResultRequest
* Represents the input of a third party job failure result action.
* @param 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.
* @return A Java Future containing the result of the PutThirdPartyJobFailureResult operation returned by the
* service.
* @sample AWSCodePipelineAsyncHandler.PutThirdPartyJobFailureResult
*/
java.util.concurrent.Future putThirdPartyJobFailureResultAsync(
PutThirdPartyJobFailureResultRequest putThirdPartyJobFailureResultRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Represents the success of a third party job as returned to the pipeline by a job worker. Only used for partner
* actions.
*
*
* @param putThirdPartyJobSuccessResultRequest
* Represents the input of a put third party job success result action.
* @return A Java Future containing the result of the PutThirdPartyJobSuccessResult operation returned by the
* service.
* @sample AWSCodePipelineAsync.PutThirdPartyJobSuccessResult
*/
java.util.concurrent.Future 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.
*
*
* @param putThirdPartyJobSuccessResultRequest
* Represents the input of a put third party job success result action.
* @param 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.
* @return A Java Future containing the result of the PutThirdPartyJobSuccessResult operation returned by the
* service.
* @sample AWSCodePipelineAsyncHandler.PutThirdPartyJobSuccessResult
*/
java.util.concurrent.Future putThirdPartyJobSuccessResultAsync(
PutThirdPartyJobSuccessResultRequest putThirdPartyJobSuccessResultRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Resumes the pipeline execution by retrying the last failed actions in a stage.
*
*
* @param retryStageExecutionRequest
* Represents the input of a retry stage execution action.
* @return A Java Future containing the result of the RetryStageExecution operation returned by the service.
* @sample AWSCodePipelineAsync.RetryStageExecution
*/
java.util.concurrent.Future retryStageExecutionAsync(RetryStageExecutionRequest retryStageExecutionRequest);
/**
*
* Resumes the pipeline execution by retrying the last failed actions in a stage.
*
*
* @param retryStageExecutionRequest
* Represents the input of a retry stage execution action.
* @param 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.
* @return A Java Future containing the result of the RetryStageExecution operation returned by the service.
* @sample AWSCodePipelineAsyncHandler.RetryStageExecution
*/
java.util.concurrent.Future retryStageExecutionAsync(RetryStageExecutionRequest retryStageExecutionRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Starts the specified pipeline. Specifically, it begins processing the latest commit to the source location
* specified as part of the pipeline.
*
*
* @param startPipelineExecutionRequest
* Represents the input of a start pipeline execution action.
* @return A Java Future containing the result of the StartPipelineExecution operation returned by the service.
* @sample AWSCodePipelineAsync.StartPipelineExecution
*/
java.util.concurrent.Future startPipelineExecutionAsync(StartPipelineExecutionRequest startPipelineExecutionRequest);
/**
*
* Starts the specified pipeline. Specifically, it begins processing the latest commit to the source location
* specified as part of the pipeline.
*
*
* @param startPipelineExecutionRequest
* Represents the input of a start pipeline execution action.
* @param 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.
* @return A Java Future containing the result of the StartPipelineExecution operation returned by the service.
* @sample AWSCodePipelineAsyncHandler.StartPipelineExecution
*/
java.util.concurrent.Future startPipelineExecutionAsync(StartPipelineExecutionRequest startPipelineExecutionRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param updatePipelineRequest
* Represents the input of an update pipeline action.
* @return A Java Future containing the result of the UpdatePipeline operation returned by the service.
* @sample AWSCodePipelineAsync.UpdatePipeline
*/
java.util.concurrent.Future 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.
*
*
* @param updatePipelineRequest
* Represents the input of an update pipeline action.
* @param 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.
* @return A Java Future containing the result of the UpdatePipeline operation returned by the service.
* @sample AWSCodePipelineAsyncHandler.UpdatePipeline
*/
java.util.concurrent.Future updatePipelineAsync(UpdatePipelineRequest updatePipelineRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
}