@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 CodePipeline API Reference. This guide provides descriptions of the actions and data types for CodePipeline. Some functionality for your pipeline can only be configured through the API. For more information, see the CodePipeline User Guide.
You can use the CodePipeline API to work with pipelines, stages, actions, and transitions.
Pipelines are models of automated release processes. Each pipeline is uniquely named, and consists of stages, actions, and transitions.
You can work with pipelines by calling:
CreatePipeline, which creates a uniquely named pipeline.
DeletePipeline, which deletes the specified pipeline.
GetPipeline, which returns information about the pipeline structure and pipeline metadata, including the pipeline Amazon Resource Name (ARN).
GetPipelineExecution, which returns information about a specific execution of a pipeline.
GetPipelineState, which returns information about the current state of the stages and actions of a pipeline.
ListActionExecutions, which returns action-level details for past executions. The details include full stage and action-level details, including individual action duration, status, any errors that occurred during the execution, and input and output artifact location details.
ListPipelines, which gets a summary of all of the pipelines associated with your account.
ListPipelineExecutions, which gets a summary of the most recent executions for a pipeline.
StartPipelineExecution, which runs the most recent revision of an artifact through the pipeline.
StopPipelineExecution, which stops the specified pipeline execution from continuing through the pipeline.
UpdatePipeline, which updates a pipeline with edits or changes to the structure of the pipeline.
Pipelines include stages. Each stage contains one or more actions that must complete before the next stage begins. A stage results in success or failure. If a stage fails, the pipeline stops at that stage and remains stopped until either a new version of an artifact appears in the source location, or a user takes action to rerun the most recent artifact through the pipeline. You can call GetPipelineState, which displays the status of a pipeline, including the status of stages in the pipeline, or GetPipeline, which returns the entire structure of the pipeline, including the stages of that pipeline. For more information about the structure of stages and actions, see CodePipeline Pipeline Structure Reference.
Pipeline stages include actions that are categorized into categories such as source or build actions performed in a stage of a pipeline. For example, you can use a source action to import artifacts into a pipeline from a source such as Amazon S3. Like stages, you do not work with actions directly in most cases, but you do define and interact with actions when working with pipeline operations such as CreatePipeline and GetPipelineState. Valid action categories are:
Source
Build
Test
Deploy
Approval
Invoke
Pipelines also include transitions, which allow the transition of artifacts from one stage to the next in a pipeline after the actions in one stage complete.
You can work with transitions by calling:
DisableStageTransition, which prevents artifacts from transitioning to the next stage in a pipeline.
EnableStageTransition, which enables transition of artifacts between stages in a pipeline.
Using the API to integrate with CodePipeline
For third-party integrators or developers who want to create their own integrations with CodePipeline, the expected sequence varies from the standard API user. To integrate with CodePipeline, developers need to work with the following items:
Jobs, which are instances of an action. For example, a job for a source action might import a revision of an artifact from a source.
You can work with jobs by calling:
AcknowledgeJob, which confirms whether a job worker has received the specified job.
GetJobDetails, which returns the details of a job.
PollForJobs, which determines whether there are any jobs to act on.
PutJobFailureResult, which provides details of a job failure.
PutJobSuccessResult, which provides details of a job success.
Third party jobs, which are instances of an action created by a partner action and integrated into CodePipeline. Partner actions are created by members of the Amazon Web Services Partner Network.
You can work with third party jobs by calling:
AcknowledgeThirdPartyJob, which confirms whether a job worker has received the specified job.
GetThirdPartyJobDetails, which requests the details of a job for a partner action.
PollForThirdPartyJobs, which determines whether there are any jobs to act on.
PutThirdPartyJobFailureResult, which provides details of a job failure.
PutThirdPartyJobSuccessResult, which provides details of a job success.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_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, getActionType, getCachedResponseMetadata, getJobDetails, getPipeline, getPipelineExecution, getPipelineState, getThirdPartyJobDetails, listActionExecutions, listActionTypes, listPipelineExecutions, listPipelines, listRuleExecutions, listRuleTypes, listTagsForResource, listWebhooks, overrideStageCondition, pollForJobs, pollForThirdPartyJobs, putActionRevision, putApprovalResult, putJobFailureResult, putJobSuccessResult, putThirdPartyJobFailureResult, putThirdPartyJobSuccessResult, putWebhook, registerWebhookWithThirdParty, retryStageExecution, rollbackStage, startPipelineExecution, stopPipelineExecution, tagResource, untagResource, updateActionType, updatePipeline
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
acknowledgeJob, acknowledgeThirdPartyJob, createCustomActionType, createPipeline, deleteCustomActionType, deletePipeline, deleteWebhook, deregisterWebhookWithThirdParty, disableStageTransition, enableStageTransition, getActionType, getCachedResponseMetadata, getJobDetails, getPipeline, getPipelineExecution, getPipelineState, getThirdPartyJobDetails, listActionExecutions, listActionTypes, listPipelineExecutions, listPipelines, listRuleExecutions, listRuleTypes, listTagsForResource, listWebhooks, overrideStageCondition, pollForJobs, pollForThirdPartyJobs, putActionRevision, putApprovalResult, putJobFailureResult, putJobSuccessResult, putThirdPartyJobFailureResult, putThirdPartyJobSuccessResult, putWebhook, registerWebhookWithThirdParty, retryStageExecution, rollbackStage, setEndpoint, setRegion, startPipelineExecution, stopPipelineExecution, tagResource, untagResource, updateActionType, 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)
AWSCodePipelineAsync
Returns information about a specified job and whether that job has been received by the job worker. Used for custom actions only.
acknowledgeJobAsync
in interface AWSCodePipelineAsync
request
- Represents the input of an AcknowledgeJob action.public Future<AcknowledgeJobResult> acknowledgeJobAsync(AcknowledgeJobRequest request, AsyncHandler<AcknowledgeJobRequest,AcknowledgeJobResult> asyncHandler)
AWSCodePipelineAsync
Returns information about a specified job and whether that job has been received by the job worker. Used for custom actions only.
acknowledgeJobAsync
in interface AWSCodePipelineAsync
request
- 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)
AWSCodePipelineAsync
Confirms a job worker has received the specified job. Used for partner actions only.
acknowledgeThirdPartyJobAsync
in interface AWSCodePipelineAsync
request
- Represents the input of an AcknowledgeThirdPartyJob action.public Future<AcknowledgeThirdPartyJobResult> acknowledgeThirdPartyJobAsync(AcknowledgeThirdPartyJobRequest request, AsyncHandler<AcknowledgeThirdPartyJobRequest,AcknowledgeThirdPartyJobResult> asyncHandler)
AWSCodePipelineAsync
Confirms a job worker has received the specified job. Used for partner actions only.
acknowledgeThirdPartyJobAsync
in interface AWSCodePipelineAsync
request
- 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)
AWSCodePipelineAsync
Creates a new custom action that can be used in all pipelines associated with the Amazon Web Services account. Only used for custom actions.
createCustomActionTypeAsync
in interface AWSCodePipelineAsync
request
- Represents the input of a CreateCustomActionType operation.public Future<CreateCustomActionTypeResult> createCustomActionTypeAsync(CreateCustomActionTypeRequest request, AsyncHandler<CreateCustomActionTypeRequest,CreateCustomActionTypeResult> asyncHandler)
AWSCodePipelineAsync
Creates a new custom action that can be used in all pipelines associated with the Amazon Web Services account. Only used for custom actions.
createCustomActionTypeAsync
in interface AWSCodePipelineAsync
request
- 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)
AWSCodePipelineAsync
Creates a pipeline.
In the pipeline structure, you must include either artifactStore
or artifactStores
in
your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use
artifactStores
.
createPipelineAsync
in interface AWSCodePipelineAsync
request
- Represents the input of a CreatePipeline
action.public Future<CreatePipelineResult> createPipelineAsync(CreatePipelineRequest request, AsyncHandler<CreatePipelineRequest,CreatePipelineResult> asyncHandler)
AWSCodePipelineAsync
Creates a pipeline.
In the pipeline structure, you must include either artifactStore
or artifactStores
in
your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use
artifactStores
.
createPipelineAsync
in interface AWSCodePipelineAsync
request
- 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)
AWSCodePipelineAsync
Marks a custom action as deleted. PollForJobs
for the custom action fails after the action is marked
for deletion. Used for custom actions only.
To re-create a custom action after it has been deleted you must use a string in the version field that has never been used before. This string can be an incremented version number, for example. To restore a deleted custom action, use a JSON file that is identical to the deleted action, including the original string in the version field.
deleteCustomActionTypeAsync
in interface AWSCodePipelineAsync
request
- 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)
AWSCodePipelineAsync
Marks a custom action as deleted. PollForJobs
for the custom action fails after the action is marked
for deletion. Used for custom actions only.
To re-create a custom action after it has been deleted you must use a string in the version field that has never been used before. This string can be an incremented version number, for example. To restore a deleted custom action, use a JSON file that is identical to the deleted action, including the original string in the version field.
deleteCustomActionTypeAsync
in interface AWSCodePipelineAsync
request
- 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)
AWSCodePipelineAsync
Deletes the specified pipeline.
deletePipelineAsync
in interface AWSCodePipelineAsync
request
- Represents the input of a DeletePipeline
action.public Future<DeletePipelineResult> deletePipelineAsync(DeletePipelineRequest request, AsyncHandler<DeletePipelineRequest,DeletePipelineResult> asyncHandler)
AWSCodePipelineAsync
Deletes the specified pipeline.
deletePipelineAsync
in interface AWSCodePipelineAsync
request
- 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)
AWSCodePipelineAsync
Deletes a previously created webhook by name. Deleting the webhook stops CodePipeline from starting a pipeline every time an external event occurs. The API returns successfully when trying to delete a webhook that is already deleted. If a deleted webhook is re-created by calling PutWebhook with the same name, it will have a different URL.
deleteWebhookAsync
in interface AWSCodePipelineAsync
public Future<DeleteWebhookResult> deleteWebhookAsync(DeleteWebhookRequest request, AsyncHandler<DeleteWebhookRequest,DeleteWebhookResult> asyncHandler)
AWSCodePipelineAsync
Deletes a previously created webhook by name. Deleting the webhook stops CodePipeline from starting a pipeline every time an external event occurs. The API returns successfully when trying to delete a webhook that is already deleted. If a deleted webhook is re-created by calling PutWebhook with the same name, it will have a different URL.
deleteWebhookAsync
in interface AWSCodePipelineAsync
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<DeregisterWebhookWithThirdPartyResult> deregisterWebhookWithThirdPartyAsync(DeregisterWebhookWithThirdPartyRequest request)
AWSCodePipelineAsync
Removes the connection between the webhook that was created by CodePipeline and the external tool with events to be detected. Currently supported only for webhooks that target an action type of GitHub.
deregisterWebhookWithThirdPartyAsync
in interface AWSCodePipelineAsync
public Future<DeregisterWebhookWithThirdPartyResult> deregisterWebhookWithThirdPartyAsync(DeregisterWebhookWithThirdPartyRequest request, AsyncHandler<DeregisterWebhookWithThirdPartyRequest,DeregisterWebhookWithThirdPartyResult> asyncHandler)
AWSCodePipelineAsync
Removes the connection between the webhook that was created by CodePipeline and the external tool with events to be detected. Currently supported only for webhooks that target an action type of GitHub.
deregisterWebhookWithThirdPartyAsync
in interface AWSCodePipelineAsync
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)
AWSCodePipelineAsync
Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline.
disableStageTransitionAsync
in interface AWSCodePipelineAsync
request
- Represents the input of a DisableStageTransition
action.public Future<DisableStageTransitionResult> disableStageTransitionAsync(DisableStageTransitionRequest request, AsyncHandler<DisableStageTransitionRequest,DisableStageTransitionResult> asyncHandler)
AWSCodePipelineAsync
Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline.
disableStageTransitionAsync
in interface AWSCodePipelineAsync
request
- 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)
AWSCodePipelineAsync
Enables artifacts in a pipeline to transition to a stage in a pipeline.
enableStageTransitionAsync
in interface AWSCodePipelineAsync
request
- Represents the input of an EnableStageTransition
action.public Future<EnableStageTransitionResult> enableStageTransitionAsync(EnableStageTransitionRequest request, AsyncHandler<EnableStageTransitionRequest,EnableStageTransitionResult> asyncHandler)
AWSCodePipelineAsync
Enables artifacts in a pipeline to transition to a stage in a pipeline.
enableStageTransitionAsync
in interface AWSCodePipelineAsync
request
- 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<GetActionTypeResult> getActionTypeAsync(GetActionTypeRequest request)
AWSCodePipelineAsync
Returns information about an action type created for an external provider, where the action is to be used by customers of the external provider. The action can be created with any supported integration model.
getActionTypeAsync
in interface AWSCodePipelineAsync
public Future<GetActionTypeResult> getActionTypeAsync(GetActionTypeRequest request, AsyncHandler<GetActionTypeRequest,GetActionTypeResult> asyncHandler)
AWSCodePipelineAsync
Returns information about an action type created for an external provider, where the action is to be used by customers of the external provider. The action can be created with any supported integration model.
getActionTypeAsync
in interface AWSCodePipelineAsync
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)
AWSCodePipelineAsync
Returns information about a job. Used for custom actions only.
When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.
getJobDetailsAsync
in interface AWSCodePipelineAsync
request
- Represents the input of a GetJobDetails
action.public Future<GetJobDetailsResult> getJobDetailsAsync(GetJobDetailsRequest request, AsyncHandler<GetJobDetailsRequest,GetJobDetailsResult> asyncHandler)
AWSCodePipelineAsync
Returns information about a job. Used for custom actions only.
When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.
getJobDetailsAsync
in interface AWSCodePipelineAsync
request
- 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)
AWSCodePipelineAsync
Returns the metadata, structure, stages, and actions of a pipeline. Can be used to return the entire structure of a pipeline in JSON format, which can then be modified and used to update the pipeline structure with UpdatePipeline.
getPipelineAsync
in interface AWSCodePipelineAsync
request
- Represents the input of a GetPipeline
action.public Future<GetPipelineResult> getPipelineAsync(GetPipelineRequest request, AsyncHandler<GetPipelineRequest,GetPipelineResult> asyncHandler)
AWSCodePipelineAsync
Returns the metadata, structure, stages, and actions of a pipeline. Can be used to return the entire structure of a pipeline in JSON format, which can then be modified and used to update the pipeline structure with UpdatePipeline.
getPipelineAsync
in interface AWSCodePipelineAsync
request
- 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)
AWSCodePipelineAsync
Returns information about an execution of a pipeline, including details about artifacts, the pipeline execution ID, and the name, version, and status of the pipeline.
getPipelineExecutionAsync
in interface AWSCodePipelineAsync
request
- Represents the input of a GetPipelineExecution
action.public Future<GetPipelineExecutionResult> getPipelineExecutionAsync(GetPipelineExecutionRequest request, AsyncHandler<GetPipelineExecutionRequest,GetPipelineExecutionResult> asyncHandler)
AWSCodePipelineAsync
Returns information about an execution of a pipeline, including details about artifacts, the pipeline execution ID, and the name, version, and status of the pipeline.
getPipelineExecutionAsync
in interface AWSCodePipelineAsync
request
- 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)
AWSCodePipelineAsync
Returns information about the state of a pipeline, including the stages and actions.
Values returned in the revisionId
and revisionUrl
fields indicate the source revision
information, such as the commit ID, for the current state.
getPipelineStateAsync
in interface AWSCodePipelineAsync
request
- Represents the input of a GetPipelineState
action.public Future<GetPipelineStateResult> getPipelineStateAsync(GetPipelineStateRequest request, AsyncHandler<GetPipelineStateRequest,GetPipelineStateResult> asyncHandler)
AWSCodePipelineAsync
Returns information about the state of a pipeline, including the stages and actions.
Values returned in the revisionId
and revisionUrl
fields indicate the source revision
information, such as the commit ID, for the current state.
getPipelineStateAsync
in interface AWSCodePipelineAsync
request
- 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)
AWSCodePipelineAsync
Requests the details of a job for a third party action. Used for partner actions only.
When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.
getThirdPartyJobDetailsAsync
in interface AWSCodePipelineAsync
request
- Represents the input of a GetThirdPartyJobDetails
action.public Future<GetThirdPartyJobDetailsResult> getThirdPartyJobDetailsAsync(GetThirdPartyJobDetailsRequest request, AsyncHandler<GetThirdPartyJobDetailsRequest,GetThirdPartyJobDetailsResult> asyncHandler)
AWSCodePipelineAsync
Requests the details of a job for a third party action. Used for partner actions only.
When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.
getThirdPartyJobDetailsAsync
in interface AWSCodePipelineAsync
request
- 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<ListActionExecutionsResult> listActionExecutionsAsync(ListActionExecutionsRequest request)
AWSCodePipelineAsync
Lists the action executions that have occurred in a pipeline.
listActionExecutionsAsync
in interface AWSCodePipelineAsync
public Future<ListActionExecutionsResult> listActionExecutionsAsync(ListActionExecutionsRequest request, AsyncHandler<ListActionExecutionsRequest,ListActionExecutionsResult> asyncHandler)
AWSCodePipelineAsync
Lists the action executions that have occurred in a pipeline.
listActionExecutionsAsync
in interface AWSCodePipelineAsync
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)
AWSCodePipelineAsync
Gets a summary of all CodePipeline action types associated with your account.
listActionTypesAsync
in interface AWSCodePipelineAsync
request
- Represents the input of a ListActionTypes
action.public Future<ListActionTypesResult> listActionTypesAsync(ListActionTypesRequest request, AsyncHandler<ListActionTypesRequest,ListActionTypesResult> asyncHandler)
AWSCodePipelineAsync
Gets a summary of all CodePipeline action types associated with your account.
listActionTypesAsync
in interface AWSCodePipelineAsync
request
- 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)
AWSCodePipelineAsync
Gets a summary of the most recent executions for a pipeline.
When applying the filter for pipeline executions that have succeeded in the stage, the operation returns all executions in the current pipeline version beginning on February 1, 2024.
listPipelineExecutionsAsync
in interface AWSCodePipelineAsync
request
- Represents the input of a ListPipelineExecutions
action.public Future<ListPipelineExecutionsResult> listPipelineExecutionsAsync(ListPipelineExecutionsRequest request, AsyncHandler<ListPipelineExecutionsRequest,ListPipelineExecutionsResult> asyncHandler)
AWSCodePipelineAsync
Gets a summary of the most recent executions for a pipeline.
When applying the filter for pipeline executions that have succeeded in the stage, the operation returns all executions in the current pipeline version beginning on February 1, 2024.
listPipelineExecutionsAsync
in interface AWSCodePipelineAsync
request
- 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)
AWSCodePipelineAsync
Gets a summary of all of the pipelines associated with your account.
listPipelinesAsync
in interface AWSCodePipelineAsync
request
- Represents the input of a ListPipelines
action.public Future<ListPipelinesResult> listPipelinesAsync(ListPipelinesRequest request, AsyncHandler<ListPipelinesRequest,ListPipelinesResult> asyncHandler)
AWSCodePipelineAsync
Gets a summary of all of the pipelines associated with your account.
listPipelinesAsync
in interface AWSCodePipelineAsync
request
- 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<ListRuleExecutionsResult> listRuleExecutionsAsync(ListRuleExecutionsRequest request)
AWSCodePipelineAsync
Lists the rule executions that have occurred in a pipeline configured for conditions with rules.
listRuleExecutionsAsync
in interface AWSCodePipelineAsync
public Future<ListRuleExecutionsResult> listRuleExecutionsAsync(ListRuleExecutionsRequest request, AsyncHandler<ListRuleExecutionsRequest,ListRuleExecutionsResult> asyncHandler)
AWSCodePipelineAsync
Lists the rule executions that have occurred in a pipeline configured for conditions with rules.
listRuleExecutionsAsync
in interface AWSCodePipelineAsync
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<ListRuleTypesResult> listRuleTypesAsync(ListRuleTypesRequest request)
AWSCodePipelineAsync
Lists the rules for the condition.
listRuleTypesAsync
in interface AWSCodePipelineAsync
public Future<ListRuleTypesResult> listRuleTypesAsync(ListRuleTypesRequest request, AsyncHandler<ListRuleTypesRequest,ListRuleTypesResult> asyncHandler)
AWSCodePipelineAsync
Lists the rules for the condition.
listRuleTypesAsync
in interface AWSCodePipelineAsync
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<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request)
AWSCodePipelineAsync
Gets the set of key-value pairs (metadata) that are used to manage the resource.
listTagsForResourceAsync
in interface AWSCodePipelineAsync
public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
AWSCodePipelineAsync
Gets the set of key-value pairs (metadata) that are used to manage the resource.
listTagsForResourceAsync
in interface AWSCodePipelineAsync
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)
AWSCodePipelineAsync
Gets a listing of all the webhooks in this Amazon Web Services Region for this account. The output lists all webhooks and includes the webhook URL and ARN and the configuration for each webhook.
listWebhooksAsync
in interface AWSCodePipelineAsync
public Future<ListWebhooksResult> listWebhooksAsync(ListWebhooksRequest request, AsyncHandler<ListWebhooksRequest,ListWebhooksResult> asyncHandler)
AWSCodePipelineAsync
Gets a listing of all the webhooks in this Amazon Web Services Region for this account. The output lists all webhooks and includes the webhook URL and ARN and the configuration for each webhook.
listWebhooksAsync
in interface AWSCodePipelineAsync
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<OverrideStageConditionResult> overrideStageConditionAsync(OverrideStageConditionRequest request)
AWSCodePipelineAsync
Used to override a stage condition.
overrideStageConditionAsync
in interface AWSCodePipelineAsync
public Future<OverrideStageConditionResult> overrideStageConditionAsync(OverrideStageConditionRequest request, AsyncHandler<OverrideStageConditionRequest,OverrideStageConditionResult> asyncHandler)
AWSCodePipelineAsync
Used to override a stage condition.
overrideStageConditionAsync
in interface AWSCodePipelineAsync
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)
AWSCodePipelineAsync
Returns information about any jobs for CodePipeline to act on. PollForJobs
is valid only for action
types with "Custom" in the owner field. If the action type contains AWS
or ThirdParty
in the owner field, the PollForJobs
action returns an error.
When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.
pollForJobsAsync
in interface AWSCodePipelineAsync
request
- Represents the input of a PollForJobs
action.public Future<PollForJobsResult> pollForJobsAsync(PollForJobsRequest request, AsyncHandler<PollForJobsRequest,PollForJobsResult> asyncHandler)
AWSCodePipelineAsync
Returns information about any jobs for CodePipeline to act on. PollForJobs
is valid only for action
types with "Custom" in the owner field. If the action type contains AWS
or ThirdParty
in the owner field, the PollForJobs
action returns an error.
When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.
pollForJobsAsync
in interface AWSCodePipelineAsync
request
- 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)
AWSCodePipelineAsync
Determines whether there are any third party jobs for a job worker to act on. Used for partner actions only.
When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts.
pollForThirdPartyJobsAsync
in interface AWSCodePipelineAsync
request
- Represents the input of a PollForThirdPartyJobs
action.public Future<PollForThirdPartyJobsResult> pollForThirdPartyJobsAsync(PollForThirdPartyJobsRequest request, AsyncHandler<PollForThirdPartyJobsRequest,PollForThirdPartyJobsResult> asyncHandler)
AWSCodePipelineAsync
Determines whether there are any third party jobs for a job worker to act on. Used for partner actions only.
When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts.
pollForThirdPartyJobsAsync
in interface AWSCodePipelineAsync
request
- 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)
AWSCodePipelineAsync
Provides information to CodePipeline about new revisions to a source.
putActionRevisionAsync
in interface AWSCodePipelineAsync
request
- Represents the input of a PutActionRevision
action.public Future<PutActionRevisionResult> putActionRevisionAsync(PutActionRevisionRequest request, AsyncHandler<PutActionRevisionRequest,PutActionRevisionResult> asyncHandler)
AWSCodePipelineAsync
Provides information to CodePipeline about new revisions to a source.
putActionRevisionAsync
in interface AWSCodePipelineAsync
request
- 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)
AWSCodePipelineAsync
Provides the response to a manual approval request to CodePipeline. Valid responses include Approved and Rejected.
putApprovalResultAsync
in interface AWSCodePipelineAsync
request
- Represents the input of a PutApprovalResult
action.public Future<PutApprovalResultResult> putApprovalResultAsync(PutApprovalResultRequest request, AsyncHandler<PutApprovalResultRequest,PutApprovalResultResult> asyncHandler)
AWSCodePipelineAsync
Provides the response to a manual approval request to CodePipeline. Valid responses include Approved and Rejected.
putApprovalResultAsync
in interface AWSCodePipelineAsync
request
- 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)
AWSCodePipelineAsync
Represents the failure of a job as returned to the pipeline by a job worker. Used for custom actions only.
putJobFailureResultAsync
in interface AWSCodePipelineAsync
request
- Represents the input of a PutJobFailureResult
action.public Future<PutJobFailureResultResult> putJobFailureResultAsync(PutJobFailureResultRequest request, AsyncHandler<PutJobFailureResultRequest,PutJobFailureResultResult> asyncHandler)
AWSCodePipelineAsync
Represents the failure of a job as returned to the pipeline by a job worker. Used for custom actions only.
putJobFailureResultAsync
in interface AWSCodePipelineAsync
request
- 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)
AWSCodePipelineAsync
Represents the success of a job as returned to the pipeline by a job worker. Used for custom actions only.
putJobSuccessResultAsync
in interface AWSCodePipelineAsync
request
- Represents the input of a PutJobSuccessResult
action.public Future<PutJobSuccessResultResult> putJobSuccessResultAsync(PutJobSuccessResultRequest request, AsyncHandler<PutJobSuccessResultRequest,PutJobSuccessResultResult> asyncHandler)
AWSCodePipelineAsync
Represents the success of a job as returned to the pipeline by a job worker. Used for custom actions only.
putJobSuccessResultAsync
in interface AWSCodePipelineAsync
request
- 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)
AWSCodePipelineAsync
Represents the failure of a third party job as returned to the pipeline by a job worker. Used for partner actions only.
putThirdPartyJobFailureResultAsync
in interface AWSCodePipelineAsync
request
- Represents the input of a PutThirdPartyJobFailureResult
action.public Future<PutThirdPartyJobFailureResultResult> putThirdPartyJobFailureResultAsync(PutThirdPartyJobFailureResultRequest request, AsyncHandler<PutThirdPartyJobFailureResultRequest,PutThirdPartyJobFailureResultResult> asyncHandler)
AWSCodePipelineAsync
Represents the failure of a third party job as returned to the pipeline by a job worker. Used for partner actions only.
putThirdPartyJobFailureResultAsync
in interface AWSCodePipelineAsync
request
- 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)
AWSCodePipelineAsync
Represents the success of a third party job as returned to the pipeline by a job worker. Used for partner actions only.
putThirdPartyJobSuccessResultAsync
in interface AWSCodePipelineAsync
request
- Represents the input of a PutThirdPartyJobSuccessResult
action.public Future<PutThirdPartyJobSuccessResultResult> putThirdPartyJobSuccessResultAsync(PutThirdPartyJobSuccessResultRequest request, AsyncHandler<PutThirdPartyJobSuccessResultRequest,PutThirdPartyJobSuccessResultResult> asyncHandler)
AWSCodePipelineAsync
Represents the success of a third party job as returned to the pipeline by a job worker. Used for partner actions only.
putThirdPartyJobSuccessResultAsync
in interface AWSCodePipelineAsync
request
- 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)
AWSCodePipelineAsync
Defines a webhook and returns a unique webhook URL generated by CodePipeline. This URL can be supplied to third party source hosting providers to call every time there's a code change. When CodePipeline receives a POST request on this URL, the pipeline defined in the webhook is started as long as the POST request satisfied the authentication and filtering requirements supplied when defining the webhook. RegisterWebhookWithThirdParty and DeregisterWebhookWithThirdParty APIs can be used to automatically configure supported third parties to call the generated webhook URL.
putWebhookAsync
in interface AWSCodePipelineAsync
public Future<PutWebhookResult> putWebhookAsync(PutWebhookRequest request, AsyncHandler<PutWebhookRequest,PutWebhookResult> asyncHandler)
AWSCodePipelineAsync
Defines a webhook and returns a unique webhook URL generated by CodePipeline. This URL can be supplied to third party source hosting providers to call every time there's a code change. When CodePipeline receives a POST request on this URL, the pipeline defined in the webhook is started as long as the POST request satisfied the authentication and filtering requirements supplied when defining the webhook. RegisterWebhookWithThirdParty and DeregisterWebhookWithThirdParty APIs can be used to automatically configure supported third parties to call the generated webhook URL.
putWebhookAsync
in interface AWSCodePipelineAsync
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<RegisterWebhookWithThirdPartyResult> registerWebhookWithThirdPartyAsync(RegisterWebhookWithThirdPartyRequest request)
AWSCodePipelineAsync
Configures a connection between the webhook that was created and the external tool with events to be detected.
registerWebhookWithThirdPartyAsync
in interface AWSCodePipelineAsync
public Future<RegisterWebhookWithThirdPartyResult> registerWebhookWithThirdPartyAsync(RegisterWebhookWithThirdPartyRequest request, AsyncHandler<RegisterWebhookWithThirdPartyRequest,RegisterWebhookWithThirdPartyResult> asyncHandler)
AWSCodePipelineAsync
Configures a connection between the webhook that was created and the external tool with events to be detected.
registerWebhookWithThirdPartyAsync
in interface AWSCodePipelineAsync
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)
AWSCodePipelineAsync
You can retry a stage that has failed without having to run a pipeline again from the beginning. You do this by either retrying the failed actions in a stage or by retrying all actions in the stage starting from the first action in the stage. When you retry the failed actions in a stage, all actions that are still in progress continue working, and failed actions are triggered again. When you retry a failed stage from the first action in the stage, the stage cannot have any actions in progress. Before a stage can be retried, it must either have all actions failed or some actions failed and some succeeded.
retryStageExecutionAsync
in interface AWSCodePipelineAsync
request
- Represents the input of a RetryStageExecution
action.public Future<RetryStageExecutionResult> retryStageExecutionAsync(RetryStageExecutionRequest request, AsyncHandler<RetryStageExecutionRequest,RetryStageExecutionResult> asyncHandler)
AWSCodePipelineAsync
You can retry a stage that has failed without having to run a pipeline again from the beginning. You do this by either retrying the failed actions in a stage or by retrying all actions in the stage starting from the first action in the stage. When you retry the failed actions in a stage, all actions that are still in progress continue working, and failed actions are triggered again. When you retry a failed stage from the first action in the stage, the stage cannot have any actions in progress. Before a stage can be retried, it must either have all actions failed or some actions failed and some succeeded.
retryStageExecutionAsync
in interface AWSCodePipelineAsync
request
- 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<RollbackStageResult> rollbackStageAsync(RollbackStageRequest request)
AWSCodePipelineAsync
Rolls back a stage execution.
rollbackStageAsync
in interface AWSCodePipelineAsync
public Future<RollbackStageResult> rollbackStageAsync(RollbackStageRequest request, AsyncHandler<RollbackStageRequest,RollbackStageResult> asyncHandler)
AWSCodePipelineAsync
Rolls back a stage execution.
rollbackStageAsync
in interface AWSCodePipelineAsync
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)
AWSCodePipelineAsync
Starts the specified pipeline. Specifically, it begins processing the latest commit to the source location specified as part of the pipeline.
startPipelineExecutionAsync
in interface AWSCodePipelineAsync
request
- Represents the input of a StartPipelineExecution
action.public Future<StartPipelineExecutionResult> startPipelineExecutionAsync(StartPipelineExecutionRequest request, AsyncHandler<StartPipelineExecutionRequest,StartPipelineExecutionResult> asyncHandler)
AWSCodePipelineAsync
Starts the specified pipeline. Specifically, it begins processing the latest commit to the source location specified as part of the pipeline.
startPipelineExecutionAsync
in interface AWSCodePipelineAsync
request
- 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<StopPipelineExecutionResult> stopPipelineExecutionAsync(StopPipelineExecutionRequest request)
AWSCodePipelineAsync
Stops the specified pipeline execution. You choose to either stop the pipeline execution by completing
in-progress actions without starting subsequent actions, or by abandoning in-progress actions. While completing
or abandoning in-progress actions, the pipeline execution is in a Stopping
state. After all
in-progress actions are completed or abandoned, the pipeline execution is in a Stopped
state.
stopPipelineExecutionAsync
in interface AWSCodePipelineAsync
public Future<StopPipelineExecutionResult> stopPipelineExecutionAsync(StopPipelineExecutionRequest request, AsyncHandler<StopPipelineExecutionRequest,StopPipelineExecutionResult> asyncHandler)
AWSCodePipelineAsync
Stops the specified pipeline execution. You choose to either stop the pipeline execution by completing
in-progress actions without starting subsequent actions, or by abandoning in-progress actions. While completing
or abandoning in-progress actions, the pipeline execution is in a Stopping
state. After all
in-progress actions are completed or abandoned, the pipeline execution is in a Stopped
state.
stopPipelineExecutionAsync
in interface AWSCodePipelineAsync
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<TagResourceResult> tagResourceAsync(TagResourceRequest request)
AWSCodePipelineAsync
Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.
tagResourceAsync
in interface AWSCodePipelineAsync
public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
AWSCodePipelineAsync
Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.
tagResourceAsync
in interface AWSCodePipelineAsync
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<UntagResourceResult> untagResourceAsync(UntagResourceRequest request)
AWSCodePipelineAsync
Removes tags from an Amazon Web Services resource.
untagResourceAsync
in interface AWSCodePipelineAsync
public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
AWSCodePipelineAsync
Removes tags from an Amazon Web Services resource.
untagResourceAsync
in interface AWSCodePipelineAsync
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<UpdateActionTypeResult> updateActionTypeAsync(UpdateActionTypeRequest request)
AWSCodePipelineAsync
Updates an action type that was created with any supported integration model, where the action type is to be used
by customers of the action type provider. Use a JSON file with the action definition and
UpdateActionType
to provide the full structure.
updateActionTypeAsync
in interface AWSCodePipelineAsync
public Future<UpdateActionTypeResult> updateActionTypeAsync(UpdateActionTypeRequest request, AsyncHandler<UpdateActionTypeRequest,UpdateActionTypeResult> asyncHandler)
AWSCodePipelineAsync
Updates an action type that was created with any supported integration model, where the action type is to be used
by customers of the action type provider. Use a JSON file with the action definition and
UpdateActionType
to provide the full structure.
updateActionTypeAsync
in interface AWSCodePipelineAsync
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)
AWSCodePipelineAsync
Updates a specified pipeline with edits or changes to its structure. Use a JSON file with the pipeline structure
and UpdatePipeline
to provide the full structure of the pipeline. Updating the pipeline increases
the version number of the pipeline by 1.
updatePipelineAsync
in interface AWSCodePipelineAsync
request
- Represents the input of an UpdatePipeline
action.public Future<UpdatePipelineResult> updatePipelineAsync(UpdatePipelineRequest request, AsyncHandler<UpdatePipelineRequest,UpdatePipelineResult> asyncHandler)
AWSCodePipelineAsync
Updates a specified pipeline with edits or changes to its structure. Use a JSON file with the pipeline structure
and UpdatePipeline
to provide the full structure of the pipeline. Updating the pipeline increases
the version number of the pipeline by 1.
updatePipelineAsync
in interface AWSCodePipelineAsync
request
- 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 AWSCodePipeline
shutdown
in class AWSCodePipelineClient