@ThreadSafe public class AWSCodePipelineAsyncClient extends AWSCodePipelineClient implements AWSCodePipelineAsync
AsyncHandler can be used to receive
notification when an asynchronous operation completes.
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 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.
configFactoryclient, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffsetENDPOINT_PREFIX| Constructor and Description |
|---|
AWSCodePipelineAsyncClient()
Constructs a new asynchronous client to invoke service methods on CodePipeline.
|
AWSCodePipelineAsyncClient(AWSCredentials awsCredentials)
Constructs a new asynchronous client to invoke service methods on CodePipeline using the specified AWS account
credentials.
|
AWSCodePipelineAsyncClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration,
ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on CodePipeline using the specified AWS account
credentials, executor service, and client configuration options.
|
AWSCodePipelineAsyncClient(AWSCredentials awsCredentials,
ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on CodePipeline using the specified AWS account
credentials and executor service.
|
AWSCodePipelineAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
Constructs a new asynchronous client to invoke service methods on CodePipeline using the specified AWS account
credentials provider.
|
AWSCodePipelineAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
Constructs a new asynchronous client to invoke service methods on CodePipeline using the provided AWS account
credentials provider and client configuration options.
|
AWSCodePipelineAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on CodePipeline using the specified AWS account
credentials provider, executor service, and client configuration options.
|
AWSCodePipelineAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on CodePipeline using the specified AWS account
credentials provider and executor service.
|
AWSCodePipelineAsyncClient(ClientConfiguration clientConfiguration)
Constructs a new asynchronous client to invoke service methods on CodePipeline.
|
acknowledgeJob, acknowledgeThirdPartyJob, createCustomActionType, createPipeline, deleteCustomActionType, deletePipeline, disableStageTransition, enableStageTransition, getCachedResponseMetadata, getJobDetails, getPipeline, getPipelineExecution, getPipelineState, getThirdPartyJobDetails, listActionTypes, listPipelines, pollForJobs, pollForThirdPartyJobs, putActionRevision, putApprovalResult, putJobFailureResult, putJobSuccessResult, putThirdPartyJobFailureResult, putThirdPartyJobSuccessResult, retryStageExecution, startPipelineExecution, updatePipelineaddRequestHandler, addRequestHandler, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getEndpointPrefix, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerProvider, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffsetclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitacknowledgeJob, acknowledgeThirdPartyJob, createCustomActionType, createPipeline, deleteCustomActionType, deletePipeline, disableStageTransition, enableStageTransition, getCachedResponseMetadata, getJobDetails, getPipeline, getPipelineExecution, getPipelineState, getThirdPartyJobDetails, listActionTypes, listPipelines, pollForJobs, pollForThirdPartyJobs, putActionRevision, putApprovalResult, putJobFailureResult, putJobSuccessResult, putThirdPartyJobFailureResult, putThirdPartyJobSuccessResult, retryStageExecution, setEndpoint, setRegion, startPipelineExecution, updatePipelinepublic AWSCodePipelineAsyncClient()
Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).
public AWSCodePipelineAsyncClient(ClientConfiguration clientConfiguration)
Asynchronous methods are delegated to a fixed-size thread pool containing a number of threads equal to the
maximum number of concurrent connections configured via ClientConfiguration.getMaxConnections().
clientConfiguration - The client configuration options controlling how this client connects to CodePipeline (ex: proxy settings,
retry counts, etc).DefaultAWSCredentialsProviderChain,
Executors.newFixedThreadPool(int)public AWSCodePipelineAsyncClient(AWSCredentials awsCredentials)
Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.Executors.newFixedThreadPool(int)public AWSCodePipelineAsyncClient(AWSCredentials awsCredentials, ExecutorService executorService)
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.executorService - The executor service by which all asynchronous requests will be executed.public AWSCodePipelineAsyncClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration, ExecutorService executorService)
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).executorService - The executor service by which all asynchronous requests will be executed.public AWSCodePipelineAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.Executors.newFixedThreadPool(int)public AWSCodePipelineAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
Asynchronous methods are delegated to a fixed-size thread pool containing a number of threads equal to the
maximum number of concurrent connections configured via ClientConfiguration.getMaxConnections().
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).DefaultAWSCredentialsProviderChain,
Executors.newFixedThreadPool(int)public AWSCodePipelineAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ExecutorService executorService)
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.executorService - The executor service by which all asynchronous requests will be executed.public AWSCodePipelineAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, ExecutorService executorService)
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).executorService - The executor service by which all asynchronous requests will be executed.public ExecutorService getExecutorService()
public Future<AcknowledgeJobResult> acknowledgeJobAsync(AcknowledgeJobRequest request)
AWSCodePipelineAsyncReturns information about a specified job and whether that job has been received by the job worker. Only used for custom actions.
acknowledgeJobAsync in interface AWSCodePipelineAsyncrequest - Represents the input of an acknowledge job action.public Future<AcknowledgeJobResult> acknowledgeJobAsync(AcknowledgeJobRequest request, AsyncHandler<AcknowledgeJobRequest,AcknowledgeJobResult> asyncHandler)
AWSCodePipelineAsyncReturns information about a specified job and whether that job has been received by the job worker. Only used for custom actions.
acknowledgeJobAsync in interface AWSCodePipelineAsyncrequest - Represents the input of an acknowledge job action.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<AcknowledgeThirdPartyJobResult> acknowledgeThirdPartyJobAsync(AcknowledgeThirdPartyJobRequest request)
AWSCodePipelineAsyncConfirms a job worker has received the specified job. Only used for partner actions.
acknowledgeThirdPartyJobAsync in interface AWSCodePipelineAsyncrequest - Represents the input of an acknowledge third party job action.public Future<AcknowledgeThirdPartyJobResult> acknowledgeThirdPartyJobAsync(AcknowledgeThirdPartyJobRequest request, AsyncHandler<AcknowledgeThirdPartyJobRequest,AcknowledgeThirdPartyJobResult> asyncHandler)
AWSCodePipelineAsyncConfirms a job worker has received the specified job. Only used for partner actions.
acknowledgeThirdPartyJobAsync in interface AWSCodePipelineAsyncrequest - Represents the input of an acknowledge third party job action.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateCustomActionTypeResult> createCustomActionTypeAsync(CreateCustomActionTypeRequest request)
AWSCodePipelineAsyncCreates a new custom action that can be used in all pipelines associated with the AWS account. Only used for custom actions.
createCustomActionTypeAsync in interface AWSCodePipelineAsyncrequest - Represents the input of a create custom action operation.public Future<CreateCustomActionTypeResult> createCustomActionTypeAsync(CreateCustomActionTypeRequest request, AsyncHandler<CreateCustomActionTypeRequest,CreateCustomActionTypeResult> asyncHandler)
AWSCodePipelineAsyncCreates a new custom action that can be used in all pipelines associated with the AWS account. Only used for custom actions.
createCustomActionTypeAsync in interface AWSCodePipelineAsyncrequest - Represents the input of a create custom action operation.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreatePipelineResult> createPipelineAsync(CreatePipelineRequest request)
AWSCodePipelineAsyncCreates a pipeline.
createPipelineAsync in interface AWSCodePipelineAsyncrequest - Represents the input of a create pipeline action.public Future<CreatePipelineResult> createPipelineAsync(CreatePipelineRequest request, AsyncHandler<CreatePipelineRequest,CreatePipelineResult> asyncHandler)
AWSCodePipelineAsyncCreates a pipeline.
createPipelineAsync in interface AWSCodePipelineAsyncrequest - Represents the input of a create pipeline action.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteCustomActionTypeResult> deleteCustomActionTypeAsync(DeleteCustomActionTypeRequest request)
AWSCodePipelineAsyncMarks 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.
deleteCustomActionTypeAsync in interface AWSCodePipelineAsyncrequest - Represents the input of a delete custom action operation. The custom action will be marked as deleted.public Future<DeleteCustomActionTypeResult> deleteCustomActionTypeAsync(DeleteCustomActionTypeRequest request, AsyncHandler<DeleteCustomActionTypeRequest,DeleteCustomActionTypeResult> asyncHandler)
AWSCodePipelineAsyncMarks 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.
deleteCustomActionTypeAsync in interface AWSCodePipelineAsyncrequest - Represents the input of a delete custom action operation. The custom action will be marked as deleted.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeletePipelineResult> deletePipelineAsync(DeletePipelineRequest request)
AWSCodePipelineAsyncDeletes the specified pipeline.
deletePipelineAsync in interface AWSCodePipelineAsyncrequest - Represents the input of a delete pipeline action.public Future<DeletePipelineResult> deletePipelineAsync(DeletePipelineRequest request, AsyncHandler<DeletePipelineRequest,DeletePipelineResult> asyncHandler)
AWSCodePipelineAsyncDeletes the specified pipeline.
deletePipelineAsync in interface AWSCodePipelineAsyncrequest - Represents the input of a delete pipeline action.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DisableStageTransitionResult> disableStageTransitionAsync(DisableStageTransitionRequest request)
AWSCodePipelineAsyncPrevents artifacts in a pipeline from transitioning to the next stage in the pipeline.
disableStageTransitionAsync in interface AWSCodePipelineAsyncrequest - Represents the input of a disable stage transition input action.public Future<DisableStageTransitionResult> disableStageTransitionAsync(DisableStageTransitionRequest request, AsyncHandler<DisableStageTransitionRequest,DisableStageTransitionResult> asyncHandler)
AWSCodePipelineAsyncPrevents artifacts in a pipeline from transitioning to the next stage in the pipeline.
disableStageTransitionAsync in interface AWSCodePipelineAsyncrequest - Represents the input of a disable stage transition input action.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<EnableStageTransitionResult> enableStageTransitionAsync(EnableStageTransitionRequest request)
AWSCodePipelineAsyncEnables artifacts in a pipeline to transition to a stage in a pipeline.
enableStageTransitionAsync in interface AWSCodePipelineAsyncrequest - Represents the input of an enable stage transition action.public Future<EnableStageTransitionResult> enableStageTransitionAsync(EnableStageTransitionRequest request, AsyncHandler<EnableStageTransitionRequest,EnableStageTransitionResult> asyncHandler)
AWSCodePipelineAsyncEnables artifacts in a pipeline to transition to a stage in a pipeline.
enableStageTransitionAsync in interface AWSCodePipelineAsyncrequest - Represents the input of an enable stage transition action.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetJobDetailsResult> getJobDetailsAsync(GetJobDetailsRequest request)
AWSCodePipelineAsyncReturns 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.
getJobDetailsAsync in interface AWSCodePipelineAsyncrequest - Represents the input of a get job details action.public Future<GetJobDetailsResult> getJobDetailsAsync(GetJobDetailsRequest request, AsyncHandler<GetJobDetailsRequest,GetJobDetailsResult> asyncHandler)
AWSCodePipelineAsyncReturns 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.
getJobDetailsAsync in interface AWSCodePipelineAsyncrequest - Represents the input of a get job details action.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetPipelineResult> getPipelineAsync(GetPipelineRequest request)
AWSCodePipelineAsyncReturns 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.
getPipelineAsync in interface AWSCodePipelineAsyncrequest - Represents the input of a get pipeline action.public Future<GetPipelineResult> getPipelineAsync(GetPipelineRequest request, AsyncHandler<GetPipelineRequest,GetPipelineResult> asyncHandler)
AWSCodePipelineAsyncReturns 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.
getPipelineAsync in interface AWSCodePipelineAsyncrequest - Represents the input of a get pipeline action.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetPipelineExecutionResult> getPipelineExecutionAsync(GetPipelineExecutionRequest request)
AWSCodePipelineAsyncReturns information about an execution of a pipeline, including details about artifacts, the pipeline execution ID, and the name, version, and status of the pipeline.
getPipelineExecutionAsync in interface AWSCodePipelineAsyncrequest - Represents the input of a get pipeline execution action.public Future<GetPipelineExecutionResult> getPipelineExecutionAsync(GetPipelineExecutionRequest request, AsyncHandler<GetPipelineExecutionRequest,GetPipelineExecutionResult> asyncHandler)
AWSCodePipelineAsyncReturns information about an execution of a pipeline, including details about artifacts, the pipeline execution ID, and the name, version, and status of the pipeline.
getPipelineExecutionAsync in interface AWSCodePipelineAsyncrequest - Represents the input of a get pipeline execution action.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetPipelineStateResult> getPipelineStateAsync(GetPipelineStateRequest request)
AWSCodePipelineAsyncReturns information about the state of a pipeline, including the stages and actions.
getPipelineStateAsync in interface AWSCodePipelineAsyncrequest - Represents the input of a get pipeline state action.public Future<GetPipelineStateResult> getPipelineStateAsync(GetPipelineStateRequest request, AsyncHandler<GetPipelineStateRequest,GetPipelineStateResult> asyncHandler)
AWSCodePipelineAsyncReturns information about the state of a pipeline, including the stages and actions.
getPipelineStateAsync in interface AWSCodePipelineAsyncrequest - Represents the input of a get pipeline state action.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetThirdPartyJobDetailsResult> getThirdPartyJobDetailsAsync(GetThirdPartyJobDetailsRequest request)
AWSCodePipelineAsyncRequests 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.
getThirdPartyJobDetailsAsync in interface AWSCodePipelineAsyncrequest - Represents the input of a get third party job details action.public Future<GetThirdPartyJobDetailsResult> getThirdPartyJobDetailsAsync(GetThirdPartyJobDetailsRequest request, AsyncHandler<GetThirdPartyJobDetailsRequest,GetThirdPartyJobDetailsResult> asyncHandler)
AWSCodePipelineAsyncRequests 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.
getThirdPartyJobDetailsAsync in interface AWSCodePipelineAsyncrequest - Represents the input of a get third party job details action.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListActionTypesResult> listActionTypesAsync(ListActionTypesRequest request)
AWSCodePipelineAsyncGets a summary of all AWS CodePipeline action types associated with your account.
listActionTypesAsync in interface AWSCodePipelineAsyncrequest - Represents the input of a list action types action.public Future<ListActionTypesResult> listActionTypesAsync(ListActionTypesRequest request, AsyncHandler<ListActionTypesRequest,ListActionTypesResult> asyncHandler)
AWSCodePipelineAsyncGets a summary of all AWS CodePipeline action types associated with your account.
listActionTypesAsync in interface AWSCodePipelineAsyncrequest - Represents the input of a list action types action.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListPipelinesResult> listPipelinesAsync(ListPipelinesRequest request)
AWSCodePipelineAsyncGets a summary of all of the pipelines associated with your account.
listPipelinesAsync in interface AWSCodePipelineAsyncrequest - Represents the input of a list pipelines action.public Future<ListPipelinesResult> listPipelinesAsync(ListPipelinesRequest request, AsyncHandler<ListPipelinesRequest,ListPipelinesResult> asyncHandler)
AWSCodePipelineAsyncGets a summary of all of the pipelines associated with your account.
listPipelinesAsync in interface AWSCodePipelineAsyncrequest - Represents the input of a list pipelines action.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<PollForJobsResult> pollForJobsAsync(PollForJobsRequest request)
AWSCodePipelineAsyncReturns 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.
pollForJobsAsync in interface AWSCodePipelineAsyncrequest - Represents the input of a poll for jobs action.public Future<PollForJobsResult> pollForJobsAsync(PollForJobsRequest request, AsyncHandler<PollForJobsRequest,PollForJobsResult> asyncHandler)
AWSCodePipelineAsyncReturns 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.
pollForJobsAsync in interface AWSCodePipelineAsyncrequest - Represents the input of a poll for jobs action.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<PollForThirdPartyJobsResult> pollForThirdPartyJobsAsync(PollForThirdPartyJobsRequest request)
AWSCodePipelineAsyncDetermines 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.
pollForThirdPartyJobsAsync in interface AWSCodePipelineAsyncrequest - Represents the input of a poll for third party jobs action.public Future<PollForThirdPartyJobsResult> pollForThirdPartyJobsAsync(PollForThirdPartyJobsRequest request, AsyncHandler<PollForThirdPartyJobsRequest,PollForThirdPartyJobsResult> asyncHandler)
AWSCodePipelineAsyncDetermines 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.
pollForThirdPartyJobsAsync in interface AWSCodePipelineAsyncrequest - Represents the input of a poll for third party jobs action.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<PutActionRevisionResult> putActionRevisionAsync(PutActionRevisionRequest request)
AWSCodePipelineAsyncProvides information to AWS CodePipeline about new revisions to a source.
putActionRevisionAsync in interface AWSCodePipelineAsyncrequest - Represents the input of a put action revision action.public Future<PutActionRevisionResult> putActionRevisionAsync(PutActionRevisionRequest request, AsyncHandler<PutActionRevisionRequest,PutActionRevisionResult> asyncHandler)
AWSCodePipelineAsyncProvides information to AWS CodePipeline about new revisions to a source.
putActionRevisionAsync in interface AWSCodePipelineAsyncrequest - Represents the input of a put action revision action.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<PutApprovalResultResult> putApprovalResultAsync(PutApprovalResultRequest request)
AWSCodePipelineAsyncProvides the response to a manual approval request to AWS CodePipeline. Valid responses include Approved and Rejected.
putApprovalResultAsync in interface AWSCodePipelineAsyncrequest - Represents the input of a put approval result action.public Future<PutApprovalResultResult> putApprovalResultAsync(PutApprovalResultRequest request, AsyncHandler<PutApprovalResultRequest,PutApprovalResultResult> asyncHandler)
AWSCodePipelineAsyncProvides the response to a manual approval request to AWS CodePipeline. Valid responses include Approved and Rejected.
putApprovalResultAsync in interface AWSCodePipelineAsyncrequest - Represents the input of a put approval result action.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<PutJobFailureResultResult> putJobFailureResultAsync(PutJobFailureResultRequest request)
AWSCodePipelineAsyncRepresents the failure of a job as returned to the pipeline by a job worker. Only used for custom actions.
putJobFailureResultAsync in interface AWSCodePipelineAsyncrequest - Represents the input of a put job failure result action.public Future<PutJobFailureResultResult> putJobFailureResultAsync(PutJobFailureResultRequest request, AsyncHandler<PutJobFailureResultRequest,PutJobFailureResultResult> asyncHandler)
AWSCodePipelineAsyncRepresents the failure of a job as returned to the pipeline by a job worker. Only used for custom actions.
putJobFailureResultAsync in interface AWSCodePipelineAsyncrequest - Represents the input of a put job failure result action.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<PutJobSuccessResultResult> putJobSuccessResultAsync(PutJobSuccessResultRequest request)
AWSCodePipelineAsyncRepresents the success of a job as returned to the pipeline by a job worker. Only used for custom actions.
putJobSuccessResultAsync in interface AWSCodePipelineAsyncrequest - Represents the input of a put job success result action.public Future<PutJobSuccessResultResult> putJobSuccessResultAsync(PutJobSuccessResultRequest request, AsyncHandler<PutJobSuccessResultRequest,PutJobSuccessResultResult> asyncHandler)
AWSCodePipelineAsyncRepresents the success of a job as returned to the pipeline by a job worker. Only used for custom actions.
putJobSuccessResultAsync in interface AWSCodePipelineAsyncrequest - Represents the input of a put job success result action.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<PutThirdPartyJobFailureResultResult> putThirdPartyJobFailureResultAsync(PutThirdPartyJobFailureResultRequest request)
AWSCodePipelineAsyncRepresents the failure of a third party job as returned to the pipeline by a job worker. Only used for partner actions.
putThirdPartyJobFailureResultAsync in interface AWSCodePipelineAsyncrequest - Represents the input of a third party job failure result action.public Future<PutThirdPartyJobFailureResultResult> putThirdPartyJobFailureResultAsync(PutThirdPartyJobFailureResultRequest request, AsyncHandler<PutThirdPartyJobFailureResultRequest,PutThirdPartyJobFailureResultResult> asyncHandler)
AWSCodePipelineAsyncRepresents the failure of a third party job as returned to the pipeline by a job worker. Only used for partner actions.
putThirdPartyJobFailureResultAsync in interface AWSCodePipelineAsyncrequest - Represents the input of a third party job failure result action.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<PutThirdPartyJobSuccessResultResult> putThirdPartyJobSuccessResultAsync(PutThirdPartyJobSuccessResultRequest request)
AWSCodePipelineAsyncRepresents the success of a third party job as returned to the pipeline by a job worker. Only used for partner actions.
putThirdPartyJobSuccessResultAsync in interface AWSCodePipelineAsyncrequest - Represents the input of a put third party job success result action.public Future<PutThirdPartyJobSuccessResultResult> putThirdPartyJobSuccessResultAsync(PutThirdPartyJobSuccessResultRequest request, AsyncHandler<PutThirdPartyJobSuccessResultRequest,PutThirdPartyJobSuccessResultResult> asyncHandler)
AWSCodePipelineAsyncRepresents the success of a third party job as returned to the pipeline by a job worker. Only used for partner actions.
putThirdPartyJobSuccessResultAsync in interface AWSCodePipelineAsyncrequest - Represents the input of a put third party job success result action.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<RetryStageExecutionResult> retryStageExecutionAsync(RetryStageExecutionRequest request)
AWSCodePipelineAsyncResumes the pipeline execution by retrying the last failed actions in a stage.
retryStageExecutionAsync in interface AWSCodePipelineAsyncrequest - Represents the input of a retry stage execution action.public Future<RetryStageExecutionResult> retryStageExecutionAsync(RetryStageExecutionRequest request, AsyncHandler<RetryStageExecutionRequest,RetryStageExecutionResult> asyncHandler)
AWSCodePipelineAsyncResumes the pipeline execution by retrying the last failed actions in a stage.
retryStageExecutionAsync in interface AWSCodePipelineAsyncrequest - Represents the input of a retry stage execution action.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<StartPipelineExecutionResult> startPipelineExecutionAsync(StartPipelineExecutionRequest request)
AWSCodePipelineAsyncStarts the specified pipeline. Specifically, it begins processing the latest commit to the source location specified as part of the pipeline.
startPipelineExecutionAsync in interface AWSCodePipelineAsyncrequest - Represents the input of a start pipeline execution action.public Future<StartPipelineExecutionResult> startPipelineExecutionAsync(StartPipelineExecutionRequest request, AsyncHandler<StartPipelineExecutionRequest,StartPipelineExecutionResult> asyncHandler)
AWSCodePipelineAsyncStarts the specified pipeline. Specifically, it begins processing the latest commit to the source location specified as part of the pipeline.
startPipelineExecutionAsync in interface AWSCodePipelineAsyncrequest - Represents the input of a start pipeline execution action.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdatePipelineResult> updatePipelineAsync(UpdatePipelineRequest request)
AWSCodePipelineAsyncUpdates 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.
updatePipelineAsync in interface AWSCodePipelineAsyncrequest - Represents the input of an update pipeline action.public Future<UpdatePipelineResult> updatePipelineAsync(UpdatePipelineRequest request, AsyncHandler<UpdatePipelineRequest,UpdatePipelineResult> asyncHandler)
AWSCodePipelineAsyncUpdates 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.
updatePipelineAsync in interface AWSCodePipelineAsyncrequest - Represents the input of an update pipeline action.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public void shutdown()
getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to
calling this method.shutdown in interface AWSCodePipelineshutdown in class AmazonWebServiceClientCopyright © 2016. All rights reserved.