@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") 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, and transitions, as described below.
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.
ListPipelines, which gets a summary of all of the pipelines associated with your account.
ListPipelineExecutions, which gets a summary of the most recent executions for a pipeline.
StartPipelineExecution, which runs the the most recent revision of an artifact through the pipeline.
UpdatePipeline, which updates a pipeline with edits or changes to the structure of the pipeline.
Pipelines include stages. 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. 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 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()
Deprecated.
|
AWSCodePipelineAsyncClient(AWSCredentials awsCredentials)
Deprecated.
|
AWSCodePipelineAsyncClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration,
ExecutorService executorService)
|
AWSCodePipelineAsyncClient(AWSCredentials awsCredentials,
ExecutorService executorService)
|
AWSCodePipelineAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
Deprecated.
|
AWSCodePipelineAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
|
AWSCodePipelineAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
ExecutorService executorService)
|
AWSCodePipelineAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ExecutorService executorService)
|
AWSCodePipelineAsyncClient(ClientConfiguration clientConfiguration)
Deprecated.
|
acknowledgeJob, acknowledgeThirdPartyJob, builder, createCustomActionType, createPipeline, deleteCustomActionType, deletePipeline, deleteWebhook, deregisterWebhookWithThirdParty, disableStageTransition, enableStageTransition, getCachedResponseMetadata, getJobDetails, getPipeline, getPipelineExecution, getPipelineState, getThirdPartyJobDetails, listActionTypes, listPipelineExecutions, listPipelines, listWebhooks, pollForJobs, pollForThirdPartyJobs, putActionRevision, putApprovalResult, putJobFailureResult, putJobSuccessResult, putThirdPartyJobFailureResult, putThirdPartyJobSuccessResult, putWebhook, registerWebhookWithThirdParty, retryStageExecution, startPipelineExecution, updatePipelineaddRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffsetclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitacknowledgeJob, acknowledgeThirdPartyJob, createCustomActionType, createPipeline, deleteCustomActionType, deletePipeline, deleteWebhook, deregisterWebhookWithThirdParty, disableStageTransition, enableStageTransition, getCachedResponseMetadata, getJobDetails, getPipeline, getPipelineExecution, getPipelineState, getThirdPartyJobDetails, listActionTypes, listPipelineExecutions, listPipelines, listWebhooks, pollForJobs, pollForThirdPartyJobs, putActionRevision, putApprovalResult, putJobFailureResult, putJobSuccessResult, putThirdPartyJobFailureResult, putThirdPartyJobSuccessResult, putWebhook, registerWebhookWithThirdParty, retryStageExecution, setEndpoint, setRegion, startPipelineExecution, updatePipeline@Deprecated public AWSCodePipelineAsyncClient()
AWSCodePipelineAsyncClientBuilder.defaultClient()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).
@Deprecated public AWSCodePipelineAsyncClient(ClientConfiguration clientConfiguration)
AwsClientBuilder.withClientConfiguration(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)@Deprecated public AWSCodePipelineAsyncClient(AWSCredentials awsCredentials)
AwsClientBuilder.withCredentials(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).
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.Executors.newFixedThreadPool(int)@Deprecated public AWSCodePipelineAsyncClient(AWSCredentials awsCredentials, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)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.@Deprecated public AWSCodePipelineAsyncClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration) and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)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.@Deprecated public AWSCodePipelineAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
AwsClientBuilder.withCredentials(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)@Deprecated public AWSCodePipelineAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(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)@Deprecated public AWSCodePipelineAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)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.@Deprecated public AWSCodePipelineAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration) and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)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 static AWSCodePipelineAsyncClientBuilder asyncBuilder()
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 AcknowledgeJob 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 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.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 AcknowledgeThirdPartyJob 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 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.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 CreateCustomActionType 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 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.public Future<CreatePipelineResult> createPipelineAsync(CreatePipelineRequest request)
AWSCodePipelineAsyncCreates a pipeline.
createPipelineAsync in interface AWSCodePipelineAsyncrequest - Represents the input of a CreatePipeline action.public Future<CreatePipelineResult> createPipelineAsync(CreatePipelineRequest request, AsyncHandler<CreatePipelineRequest,CreatePipelineResult> asyncHandler)
AWSCodePipelineAsyncCreates a pipeline.
createPipelineAsync in interface AWSCodePipelineAsyncrequest - 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.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.
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.
deleteCustomActionTypeAsync in interface AWSCodePipelineAsyncrequest - Represents the input of a DeleteCustomActionType 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.
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.
deleteCustomActionTypeAsync in interface AWSCodePipelineAsyncrequest - 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.public Future<DeletePipelineResult> deletePipelineAsync(DeletePipelineRequest request)
AWSCodePipelineAsyncDeletes the specified pipeline.
deletePipelineAsync in interface AWSCodePipelineAsyncrequest - Represents the input of a DeletePipeline action.public Future<DeletePipelineResult> deletePipelineAsync(DeletePipelineRequest request, AsyncHandler<DeletePipelineRequest,DeletePipelineResult> asyncHandler)
AWSCodePipelineAsyncDeletes the specified pipeline.
deletePipelineAsync in interface AWSCodePipelineAsyncrequest - 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.public Future<DeleteWebhookResult> deleteWebhookAsync(DeleteWebhookRequest request)
AWSCodePipelineAsyncDeletes a previously created webhook by name. Deleting the webhook stops AWS CodePipeline from starting a pipeline every time an external event occurs. The API will return 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.
deleteWebhookAsync in interface AWSCodePipelineAsyncpublic Future<DeleteWebhookResult> deleteWebhookAsync(DeleteWebhookRequest request, AsyncHandler<DeleteWebhookRequest,DeleteWebhookResult> asyncHandler)
AWSCodePipelineAsyncDeletes a previously created webhook by name. Deleting the webhook stops AWS CodePipeline from starting a pipeline every time an external event occurs. The API will return 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.
deleteWebhookAsync in interface AWSCodePipelineAsyncasyncHandler - 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<DeregisterWebhookWithThirdPartyResult> deregisterWebhookWithThirdPartyAsync(DeregisterWebhookWithThirdPartyRequest request)
AWSCodePipelineAsyncRemoves the connection between the webhook that was created by CodePipeline and the external tool with events to be detected. Currently only supported for webhooks that target an action type of GitHub.
deregisterWebhookWithThirdPartyAsync in interface AWSCodePipelineAsyncpublic Future<DeregisterWebhookWithThirdPartyResult> deregisterWebhookWithThirdPartyAsync(DeregisterWebhookWithThirdPartyRequest request, AsyncHandler<DeregisterWebhookWithThirdPartyRequest,DeregisterWebhookWithThirdPartyResult> asyncHandler)
AWSCodePipelineAsyncRemoves the connection between the webhook that was created by CodePipeline and the external tool with events to be detected. Currently only supported for webhooks that target an action type of GitHub.
deregisterWebhookWithThirdPartyAsync in interface AWSCodePipelineAsyncasyncHandler - 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 DisableStageTransition 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 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.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 EnableStageTransition 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 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.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 GetJobDetails 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 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.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 GetPipeline 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 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.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 GetPipelineExecution 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 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.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 GetPipelineState 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 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.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 GetThirdPartyJobDetails 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 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.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 ListActionTypes 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 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.public Future<ListPipelineExecutionsResult> listPipelineExecutionsAsync(ListPipelineExecutionsRequest request)
AWSCodePipelineAsyncGets a summary of the most recent executions for a pipeline.
listPipelineExecutionsAsync in interface AWSCodePipelineAsyncrequest - Represents the input of a ListPipelineExecutions action.public Future<ListPipelineExecutionsResult> listPipelineExecutionsAsync(ListPipelineExecutionsRequest request, AsyncHandler<ListPipelineExecutionsRequest,ListPipelineExecutionsResult> asyncHandler)
AWSCodePipelineAsyncGets a summary of the most recent executions for a pipeline.
listPipelineExecutionsAsync in interface AWSCodePipelineAsyncrequest - 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.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 ListPipelines 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 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.public Future<ListWebhooksResult> listWebhooksAsync(ListWebhooksRequest request)
AWSCodePipelineAsyncGets a listing of all the webhooks in this region for this account. The output lists all webhooks and includes the webhook URL and ARN, as well the configuration for each webhook.
listWebhooksAsync in interface AWSCodePipelineAsyncpublic Future<ListWebhooksResult> listWebhooksAsync(ListWebhooksRequest request, AsyncHandler<ListWebhooksRequest,ListWebhooksResult> asyncHandler)
AWSCodePipelineAsyncGets a listing of all the webhooks in this region for this account. The output lists all webhooks and includes the webhook URL and ARN, as well the configuration for each webhook.
listWebhooksAsync in interface AWSCodePipelineAsyncasyncHandler - 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. PollForJobs is only valid 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, 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 PollForJobs action.public Future<PollForJobsResult> pollForJobsAsync(PollForJobsRequest request, AsyncHandler<PollForJobsRequest,PollForJobsResult> asyncHandler)
AWSCodePipelineAsyncReturns information about any jobs for AWS CodePipeline to act upon. PollForJobs is only valid 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, 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 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.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 PollForThirdPartyJobs 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 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.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 PutActionRevision 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 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.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 PutApprovalResult 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 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.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 PutJobFailureResult 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 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.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 PutJobSuccessResult 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 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.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 PutThirdPartyJobFailureResult 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 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.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 PutThirdPartyJobSuccessResult 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 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.public Future<PutWebhookResult> putWebhookAsync(PutWebhookRequest request)
AWSCodePipelineAsyncDefines 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.
putWebhookAsync in interface AWSCodePipelineAsyncpublic Future<PutWebhookResult> putWebhookAsync(PutWebhookRequest request, AsyncHandler<PutWebhookRequest,PutWebhookResult> asyncHandler)
AWSCodePipelineAsyncDefines 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.
putWebhookAsync in interface AWSCodePipelineAsyncasyncHandler - 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<RegisterWebhookWithThirdPartyResult> registerWebhookWithThirdPartyAsync(RegisterWebhookWithThirdPartyRequest request)
AWSCodePipelineAsyncConfigures a connection between the webhook that was created and the external tool with events to be detected.
registerWebhookWithThirdPartyAsync in interface AWSCodePipelineAsyncpublic Future<RegisterWebhookWithThirdPartyResult> registerWebhookWithThirdPartyAsync(RegisterWebhookWithThirdPartyRequest request, AsyncHandler<RegisterWebhookWithThirdPartyRequest,RegisterWebhookWithThirdPartyResult> asyncHandler)
AWSCodePipelineAsyncConfigures a connection between the webhook that was created and the external tool with events to be detected.
registerWebhookWithThirdPartyAsync in interface AWSCodePipelineAsyncasyncHandler - 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 RetryStageExecution 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 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.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 StartPipelineExecution 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 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.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 UpdatePipeline 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 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.public void shutdown()
getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to
calling this method.shutdown in interface AWSCodePipelineshutdown in class AmazonWebServiceClientCopyright © 2019. All rights reserved.