Class AWSCodePipelineAsyncClient
- java.lang.Object
-
- com.amazonaws.AmazonWebServiceClient
-
- com.amazonaws.services.codepipeline.AWSCodePipelineClient
-
- com.amazonaws.services.codepipeline.AWSCodePipelineAsyncClient
-
- All Implemented Interfaces:
AWSCodePipeline
,AWSCodePipelineAsync
@ThreadSafe public class AWSCodePipelineAsyncClient extends AWSCodePipelineClient implements AWSCodePipelineAsync
Interface for accessing CodePipeline asynchronously. Each asynchronous method will return a Java Future object representing the asynchronous operation; overloads which accept anAsyncHandler
can be used to receive notification when an asynchronous operation completes.AWS CodePipeline OverviewThis is the AWS CodePipeline API Reference. This guide provides descriptions of the actions and data types for AWS CodePipeline. Some functionality for your pipeline is only configurable through the API. For additional information, see the AWS CodePipeline User Guide.
You can use the AWS CodePipeline API to work with pipelines, stages, actions, gates, and transitions, as described below.
Pipelines are models of automated release processes. Each pipeline is uniquely named, and consists of actions, gates, and stages.
You can work with pipelines by calling:
- CreatePipeline, which creates a uniquely-named pipeline.
- DeletePipeline, which deletes the specified pipeline.
- GetPipeline, which returns information about a pipeline structure.
- GetPipelineState, which returns information about the current state of the stages and actions of a pipeline.
- ListPipelines, which gets a summary of all of the pipelines associated with your account.
- StartPipelineExecution, which runs the the most recent revision of an artifact through the pipeline.
- UpdatePipeline, which updates a pipeline with edits or changes to the structure of the pipeline.
Pipelines include stages, which are which are logical groupings of gates and actions. Each stage contains one or more actions that must complete before the next stage begins. A stage will result in success or failure. If a stage fails, then the pipeline stops at that stage and will remain stopped until either a new version of an artifact appears in the source location, or a user takes action to re-run the most recent artifact through the pipeline. You can call GetPipelineState, which displays the status of a pipeline, including the status of stages in the pipeline, or GetPipeline, which returns the entire structure of the pipeline, including the stages of that pipeline. For more information about the structure of stages and actions, also refer to the AWS CodePipeline Pipeline Structure Reference.
Pipeline stages include actions, which are categorized into categories such as source or build actions performed within a stage of a pipeline. For example, you can use a source action to import artifacts into a pipeline from a source such as Amazon S3. Like stages, you do not work with actions directly in most cases, but you do define and interact with actions when working with pipeline operations such as CreatePipeline and GetPipelineState.
Pipelines also include transitions, which allow the transition of artifacts from one stage to the next in a pipeline after the actions in one stage complete.
You can work with transitions by calling:
- DisableStageTransition, which prevents artifacts from transitioning to the next stage in a pipeline.
- EnableStageTransition, which enables transition of artifacts between stages in a pipeline.
Using the API to integrate with AWS CodePipeline
For third-party integrators or developers who want to create their own integrations with AWS CodePipeline, the expected sequence varies from the standard API user. In order to integrate with AWS CodePipeline, developers will need to work with the following items:
- Jobs, which are instances of an action. For example, a job for a source
action might import a revision of an artifact from a source.
You can work with jobs by calling:
- AcknowledgeJob, which confirms whether a job worker has received the specified job,
- GetJobDetails, which returns the details of a job,
- PollForJobs, which determines whether there are any jobs to act upon,
- PutJobFailureResult, which provides details of a job failure, and
- PutJobSuccessResult, which provides details of a job success.
- Third party jobs, which are instances of an action created by a partner
action and integrated into AWS CodePipeline. Partner actions are created by
members of the AWS Partner Network.
You can work with third party jobs by calling:
- AcknowledgeThirdPartyJob, which confirms whether a job worker has received the specified job,
- GetThirdPartyJobDetails, which requests the details of a job for a partner action,
- PollForThirdPartyJobs, which determines whether there are any jobs to act upon,
- PutThirdPartyJobFailureResult, which provides details of a job failure, and
- PutThirdPartyJobSuccessResult, which provides details of a job success.
-
-
Field Summary
-
Fields inherited from class com.amazonaws.services.codepipeline.AWSCodePipelineClient
configFactory
-
Fields inherited from class com.amazonaws.AmazonWebServiceClient
client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset
-
-
Constructor Summary
Constructors Constructor Description AWSCodePipelineAsyncClient()
Constructs a new asynchronous client to invoke service methods on CodePipeline.AWSCodePipelineAsyncClient(AWSCredentials awsCredentials)
Constructs a new asynchronous client to invoke service methods on CodePipeline using the specified AWS account credentials.AWSCodePipelineAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
Constructs a new asynchronous client to invoke service methods on CodePipeline using the specified AWS account credentials provider.AWSCodePipelineAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
Constructs a new asynchronous client to invoke service methods on CodePipeline using the provided AWS account credentials provider and client configuration options.AWSCodePipelineAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on CodePipeline using the specified AWS account credentials provider, executor service, and client configuration options.AWSCodePipelineAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on CodePipeline using the specified AWS account credentials provider and executor service.AWSCodePipelineAsyncClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration, ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on CodePipeline using the specified AWS account credentials, executor service, and client configuration options.AWSCodePipelineAsyncClient(AWSCredentials awsCredentials, ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on CodePipeline using the specified AWS account credentials and executor service.AWSCodePipelineAsyncClient(ClientConfiguration clientConfiguration)
Constructs a new asynchronous client to invoke service methods on CodePipeline.
-
Method Summary
-
Methods inherited from class com.amazonaws.services.codepipeline.AWSCodePipelineClient
acknowledgeJob, acknowledgeThirdPartyJob, createCustomActionType, createPipeline, deleteCustomActionType, deletePipeline, disableStageTransition, enableStageTransition, getCachedResponseMetadata, getJobDetails, getPipeline, getPipelineState, getThirdPartyJobDetails, listActionTypes, listPipelines, pollForJobs, pollForThirdPartyJobs, putActionRevision, putJobFailureResult, putJobSuccessResult, putThirdPartyJobFailureResult, putThirdPartyJobSuccessResult, startPipelineExecution, updatePipeline
-
Methods inherited from class com.amazonaws.AmazonWebServiceClient
addRequestHandler, addRequestHandler, beforeMarshalling, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getEndpointPrefix, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface com.amazonaws.services.codepipeline.AWSCodePipeline
acknowledgeJob, acknowledgeThirdPartyJob, createCustomActionType, createPipeline, deleteCustomActionType, deletePipeline, disableStageTransition, enableStageTransition, getCachedResponseMetadata, getJobDetails, getPipeline, getPipelineState, getThirdPartyJobDetails, listActionTypes, listPipelines, pollForJobs, pollForThirdPartyJobs, putActionRevision, putJobFailureResult, putJobSuccessResult, putThirdPartyJobFailureResult, putThirdPartyJobSuccessResult, setEndpoint, setRegion, startPipelineExecution, updatePipeline
-
-
-
-
Constructor Detail
-
AWSCodePipelineAsyncClient
public AWSCodePipelineAsyncClient()
Constructs a new asynchronous client to invoke service methods on CodePipeline. A credentials provider chain will be used that searches for credentials in this order:- Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
- Java System Properties - aws.accessKeyId and aws.secretKey
- Credential profiles file at the default location (~/.aws/credentials) shared by all AWS SDKs and the AWS CLI
- Instance profile credentials delivered through the Amazon EC2 metadata service
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).
-
AWSCodePipelineAsyncClient
public AWSCodePipelineAsyncClient(ClientConfiguration clientConfiguration)
Constructs a new asynchronous client to invoke service methods on CodePipeline. A credentials provider chain will be used that searches for credentials in this order:- Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
- Java System Properties - aws.accessKeyId and aws.secretKey
- Credential profiles file at the default location (~/.aws/credentials) shared by all AWS SDKs and the AWS CLI
- Instance profile credentials delivered through the Amazon EC2 metadata service
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()
.- Parameters:
clientConfiguration
- The client configuration options controlling how this client connects to CodePipeline (ex: proxy settings, retry counts, etc).- See Also:
DefaultAWSCredentialsProviderChain
,Executors.newFixedThreadPool(int)
-
AWSCodePipelineAsyncClient
public AWSCodePipelineAsyncClient(AWSCredentials awsCredentials)
Constructs a new asynchronous client to invoke service methods on CodePipeline using the specified AWS account credentials.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).
- Parameters:
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.- See Also:
Executors.newFixedThreadPool(int)
-
AWSCodePipelineAsyncClient
public AWSCodePipelineAsyncClient(AWSCredentials awsCredentials, ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on CodePipeline using the specified AWS account credentials and executor service. Default client settings will be used.- Parameters:
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.
-
AWSCodePipelineAsyncClient
public AWSCodePipelineAsyncClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration, ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on CodePipeline using the specified AWS account credentials, executor service, and client configuration options.- Parameters:
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.
-
AWSCodePipelineAsyncClient
public AWSCodePipelineAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
Constructs a new asynchronous client to invoke service methods on CodePipeline using the specified AWS account credentials provider. Default client settings will be used.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).
- Parameters:
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.- See Also:
Executors.newFixedThreadPool(int)
-
AWSCodePipelineAsyncClient
public AWSCodePipelineAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
Constructs a new asynchronous client to invoke service methods on CodePipeline using the provided AWS account credentials provider and client configuration options.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()
.- Parameters:
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).- See Also:
DefaultAWSCredentialsProviderChain
,Executors.newFixedThreadPool(int)
-
AWSCodePipelineAsyncClient
public AWSCodePipelineAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on CodePipeline using the specified AWS account credentials provider and executor service. Default client settings will be used.- Parameters:
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.
-
AWSCodePipelineAsyncClient
public AWSCodePipelineAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on CodePipeline using the specified AWS account credentials provider, executor service, and client configuration options.- Parameters:
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.
-
-
Method Detail
-
getExecutorService
public ExecutorService getExecutorService()
Returns the executor service used by this client to execute async requests.- Returns:
- The executor service used by this client to execute async requests.
-
acknowledgeJobAsync
public Future<AcknowledgeJobResult> acknowledgeJobAsync(AcknowledgeJobRequest request)
Description copied from interface:AWSCodePipelineAsync
Returns information about a specified job and whether that job has been received by the job worker. Only used for custom actions.
- Specified by:
acknowledgeJobAsync
in interfaceAWSCodePipelineAsync
- Parameters:
request
- Represents the input of an acknowledge job action.- Returns:
- A Java Future containing the result of the AcknowledgeJob operation returned by the service.
-
acknowledgeJobAsync
public Future<AcknowledgeJobResult> acknowledgeJobAsync(AcknowledgeJobRequest request, AsyncHandler<AcknowledgeJobRequest,AcknowledgeJobResult> asyncHandler)
Description copied from interface:AWSCodePipelineAsync
Returns information about a specified job and whether that job has been received by the job worker. Only used for custom actions.
- Specified by:
acknowledgeJobAsync
in interfaceAWSCodePipelineAsync
- Parameters:
request
- Represents the input of an acknowledge job action.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the AcknowledgeJob operation returned by the service.
-
acknowledgeThirdPartyJobAsync
public Future<AcknowledgeThirdPartyJobResult> acknowledgeThirdPartyJobAsync(AcknowledgeThirdPartyJobRequest request)
Description copied from interface:AWSCodePipelineAsync
Confirms a job worker has received the specified job. Only used for partner actions.
- Specified by:
acknowledgeThirdPartyJobAsync
in interfaceAWSCodePipelineAsync
- Parameters:
request
- Represents the input of an acknowledge third party job action.- Returns:
- A Java Future containing the result of the AcknowledgeThirdPartyJob operation returned by the service.
-
acknowledgeThirdPartyJobAsync
public Future<AcknowledgeThirdPartyJobResult> acknowledgeThirdPartyJobAsync(AcknowledgeThirdPartyJobRequest request, AsyncHandler<AcknowledgeThirdPartyJobRequest,AcknowledgeThirdPartyJobResult> asyncHandler)
Description copied from interface:AWSCodePipelineAsync
Confirms a job worker has received the specified job. Only used for partner actions.
- Specified by:
acknowledgeThirdPartyJobAsync
in interfaceAWSCodePipelineAsync
- Parameters:
request
- Represents the input of an acknowledge third party job action.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the AcknowledgeThirdPartyJob operation returned by the service.
-
createCustomActionTypeAsync
public Future<CreateCustomActionTypeResult> createCustomActionTypeAsync(CreateCustomActionTypeRequest request)
Description copied from interface:AWSCodePipelineAsync
Creates a new custom action that can be used in all pipelines associated with the AWS account. Only used for custom actions.
- Specified by:
createCustomActionTypeAsync
in interfaceAWSCodePipelineAsync
- Parameters:
request
- Represents the input of a create custom action operation.- Returns:
- A Java Future containing the result of the CreateCustomActionType operation returned by the service.
-
createCustomActionTypeAsync
public Future<CreateCustomActionTypeResult> createCustomActionTypeAsync(CreateCustomActionTypeRequest request, AsyncHandler<CreateCustomActionTypeRequest,CreateCustomActionTypeResult> asyncHandler)
Description copied from interface:AWSCodePipelineAsync
Creates a new custom action that can be used in all pipelines associated with the AWS account. Only used for custom actions.
- Specified by:
createCustomActionTypeAsync
in interfaceAWSCodePipelineAsync
- Parameters:
request
- Represents the input of a create custom action operation.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the CreateCustomActionType operation returned by the service.
-
createPipelineAsync
public Future<CreatePipelineResult> createPipelineAsync(CreatePipelineRequest request)
Description copied from interface:AWSCodePipelineAsync
Creates a pipeline.
- Specified by:
createPipelineAsync
in interfaceAWSCodePipelineAsync
- Parameters:
request
- Represents the input of a create pipeline action.- Returns:
- A Java Future containing the result of the CreatePipeline operation returned by the service.
-
createPipelineAsync
public Future<CreatePipelineResult> createPipelineAsync(CreatePipelineRequest request, AsyncHandler<CreatePipelineRequest,CreatePipelineResult> asyncHandler)
Description copied from interface:AWSCodePipelineAsync
Creates a pipeline.
- Specified by:
createPipelineAsync
in interfaceAWSCodePipelineAsync
- Parameters:
request
- Represents the input of a create pipeline action.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the CreatePipeline operation returned by the service.
-
deleteCustomActionTypeAsync
public Future<DeleteCustomActionTypeResult> deleteCustomActionTypeAsync(DeleteCustomActionTypeRequest request)
Description copied from interface:AWSCodePipelineAsync
Marks a custom action as deleted. PollForJobs for the custom action will fail after the action is marked for deletion. Only used for custom actions.
You cannot recreate a custom action after it has been deleted unless you increase the version number of the action.
- Specified by:
deleteCustomActionTypeAsync
in interfaceAWSCodePipelineAsync
- Parameters:
request
- Represents the input of a delete custom action operation. The custom action will be marked as deleted.- Returns:
- A Java Future containing the result of the DeleteCustomActionType operation returned by the service.
-
deleteCustomActionTypeAsync
public Future<DeleteCustomActionTypeResult> deleteCustomActionTypeAsync(DeleteCustomActionTypeRequest request, AsyncHandler<DeleteCustomActionTypeRequest,DeleteCustomActionTypeResult> asyncHandler)
Description copied from interface:AWSCodePipelineAsync
Marks a custom action as deleted. PollForJobs for the custom action will fail after the action is marked for deletion. Only used for custom actions.
You cannot recreate a custom action after it has been deleted unless you increase the version number of the action.
- Specified by:
deleteCustomActionTypeAsync
in interfaceAWSCodePipelineAsync
- Parameters:
request
- Represents the input of a delete custom action operation. The custom action will be marked as deleted.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the DeleteCustomActionType operation returned by the service.
-
deletePipelineAsync
public Future<DeletePipelineResult> deletePipelineAsync(DeletePipelineRequest request)
Description copied from interface:AWSCodePipelineAsync
Deletes the specified pipeline.
- Specified by:
deletePipelineAsync
in interfaceAWSCodePipelineAsync
- Parameters:
request
- Represents the input of a delete pipeline action.- Returns:
- A Java Future containing the result of the DeletePipeline operation returned by the service.
-
deletePipelineAsync
public Future<DeletePipelineResult> deletePipelineAsync(DeletePipelineRequest request, AsyncHandler<DeletePipelineRequest,DeletePipelineResult> asyncHandler)
Description copied from interface:AWSCodePipelineAsync
Deletes the specified pipeline.
- Specified by:
deletePipelineAsync
in interfaceAWSCodePipelineAsync
- Parameters:
request
- Represents the input of a delete pipeline action.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the DeletePipeline operation returned by the service.
-
disableStageTransitionAsync
public Future<DisableStageTransitionResult> disableStageTransitionAsync(DisableStageTransitionRequest request)
Description copied from interface:AWSCodePipelineAsync
Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline.
- Specified by:
disableStageTransitionAsync
in interfaceAWSCodePipelineAsync
- Parameters:
request
- Represents the input of a disable stage transition input action.- Returns:
- A Java Future containing the result of the DisableStageTransition operation returned by the service.
-
disableStageTransitionAsync
public Future<DisableStageTransitionResult> disableStageTransitionAsync(DisableStageTransitionRequest request, AsyncHandler<DisableStageTransitionRequest,DisableStageTransitionResult> asyncHandler)
Description copied from interface:AWSCodePipelineAsync
Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline.
- Specified by:
disableStageTransitionAsync
in interfaceAWSCodePipelineAsync
- Parameters:
request
- Represents the input of a disable stage transition input action.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the DisableStageTransition operation returned by the service.
-
enableStageTransitionAsync
public Future<EnableStageTransitionResult> enableStageTransitionAsync(EnableStageTransitionRequest request)
Description copied from interface:AWSCodePipelineAsync
Enables artifacts in a pipeline to transition to a stage in a pipeline.
- Specified by:
enableStageTransitionAsync
in interfaceAWSCodePipelineAsync
- Parameters:
request
- Represents the input of an enable stage transition action.- Returns:
- A Java Future containing the result of the EnableStageTransition operation returned by the service.
-
enableStageTransitionAsync
public Future<EnableStageTransitionResult> enableStageTransitionAsync(EnableStageTransitionRequest request, AsyncHandler<EnableStageTransitionRequest,EnableStageTransitionResult> asyncHandler)
Description copied from interface:AWSCodePipelineAsync
Enables artifacts in a pipeline to transition to a stage in a pipeline.
- Specified by:
enableStageTransitionAsync
in interfaceAWSCodePipelineAsync
- Parameters:
request
- Represents the input of an enable stage transition action.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the EnableStageTransition operation returned by the service.
-
getJobDetailsAsync
public Future<GetJobDetailsResult> getJobDetailsAsync(GetJobDetailsRequest request)
Description copied from interface:AWSCodePipelineAsync
Returns information about a job. Only used for custom actions.
When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API returns any secret values defined for the action.
- Specified by:
getJobDetailsAsync
in interfaceAWSCodePipelineAsync
- Parameters:
request
- Represents the input of a get job details action.- Returns:
- A Java Future containing the result of the GetJobDetails operation returned by the service.
-
getJobDetailsAsync
public Future<GetJobDetailsResult> getJobDetailsAsync(GetJobDetailsRequest request, AsyncHandler<GetJobDetailsRequest,GetJobDetailsResult> asyncHandler)
Description copied from interface:AWSCodePipelineAsync
Returns information about a job. Only used for custom actions.
When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API returns any secret values defined for the action.
- Specified by:
getJobDetailsAsync
in interfaceAWSCodePipelineAsync
- Parameters:
request
- Represents the input of a get job details action.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the GetJobDetails operation returned by the service.
-
getPipelineAsync
public Future<GetPipelineResult> getPipelineAsync(GetPipelineRequest request)
Description copied from interface: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.
- Specified by:
getPipelineAsync
in interfaceAWSCodePipelineAsync
- Parameters:
request
- Represents the input of a get pipeline action.- Returns:
- A Java Future containing the result of the GetPipeline operation returned by the service.
-
getPipelineAsync
public Future<GetPipelineResult> getPipelineAsync(GetPipelineRequest request, AsyncHandler<GetPipelineRequest,GetPipelineResult> asyncHandler)
Description copied from interface: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.
- Specified by:
getPipelineAsync
in interfaceAWSCodePipelineAsync
- Parameters:
request
- Represents the input of a get pipeline action.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the GetPipeline operation returned by the service.
-
getPipelineStateAsync
public Future<GetPipelineStateResult> getPipelineStateAsync(GetPipelineStateRequest request)
Description copied from interface:AWSCodePipelineAsync
Returns information about the state of a pipeline, including the stages, actions, and details about the last run of the pipeline.
- Specified by:
getPipelineStateAsync
in interfaceAWSCodePipelineAsync
- Parameters:
request
- Represents the input of a get pipeline state action.- Returns:
- A Java Future containing the result of the GetPipelineState operation returned by the service.
-
getPipelineStateAsync
public Future<GetPipelineStateResult> getPipelineStateAsync(GetPipelineStateRequest request, AsyncHandler<GetPipelineStateRequest,GetPipelineStateResult> asyncHandler)
Description copied from interface:AWSCodePipelineAsync
Returns information about the state of a pipeline, including the stages, actions, and details about the last run of the pipeline.
- Specified by:
getPipelineStateAsync
in interfaceAWSCodePipelineAsync
- Parameters:
request
- Represents the input of a get pipeline state action.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the GetPipelineState operation returned by the service.
-
getThirdPartyJobDetailsAsync
public Future<GetThirdPartyJobDetailsResult> getThirdPartyJobDetailsAsync(GetThirdPartyJobDetailsRequest request)
Description copied from interface:AWSCodePipelineAsync
Requests the details of a job for a third party action. Only used for partner actions.
When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API returns any secret values defined for the action.
- Specified by:
getThirdPartyJobDetailsAsync
in interfaceAWSCodePipelineAsync
- Parameters:
request
- Represents the input of a get third party job details action.- Returns:
- A Java Future containing the result of the GetThirdPartyJobDetails operation returned by the service.
-
getThirdPartyJobDetailsAsync
public Future<GetThirdPartyJobDetailsResult> getThirdPartyJobDetailsAsync(GetThirdPartyJobDetailsRequest request, AsyncHandler<GetThirdPartyJobDetailsRequest,GetThirdPartyJobDetailsResult> asyncHandler)
Description copied from interface:AWSCodePipelineAsync
Requests the details of a job for a third party action. Only used for partner actions.
When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API returns any secret values defined for the action.
- Specified by:
getThirdPartyJobDetailsAsync
in interfaceAWSCodePipelineAsync
- Parameters:
request
- Represents the input of a get third party job details action.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the GetThirdPartyJobDetails operation returned by the service.
-
listActionTypesAsync
public Future<ListActionTypesResult> listActionTypesAsync(ListActionTypesRequest request)
Description copied from interface:AWSCodePipelineAsync
Gets a summary of all AWS CodePipeline action types associated with your account.
- Specified by:
listActionTypesAsync
in interfaceAWSCodePipelineAsync
- Parameters:
request
- Represents the input of a list action types action.- Returns:
- A Java Future containing the result of the ListActionTypes operation returned by the service.
-
listActionTypesAsync
public Future<ListActionTypesResult> listActionTypesAsync(ListActionTypesRequest request, AsyncHandler<ListActionTypesRequest,ListActionTypesResult> asyncHandler)
Description copied from interface:AWSCodePipelineAsync
Gets a summary of all AWS CodePipeline action types associated with your account.
- Specified by:
listActionTypesAsync
in interfaceAWSCodePipelineAsync
- Parameters:
request
- Represents the input of a list action types action.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the ListActionTypes operation returned by the service.
-
listPipelinesAsync
public Future<ListPipelinesResult> listPipelinesAsync(ListPipelinesRequest request)
Description copied from interface:AWSCodePipelineAsync
Gets a summary of all of the pipelines associated with your account.
- Specified by:
listPipelinesAsync
in interfaceAWSCodePipelineAsync
- Parameters:
request
- Represents the input of a list pipelines action.- Returns:
- A Java Future containing the result of the ListPipelines operation returned by the service.
-
listPipelinesAsync
public Future<ListPipelinesResult> listPipelinesAsync(ListPipelinesRequest request, AsyncHandler<ListPipelinesRequest,ListPipelinesResult> asyncHandler)
Description copied from interface:AWSCodePipelineAsync
Gets a summary of all of the pipelines associated with your account.
- Specified by:
listPipelinesAsync
in interfaceAWSCodePipelineAsync
- Parameters:
request
- Represents the input of a list pipelines action.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the ListPipelines operation returned by the service.
-
pollForJobsAsync
public Future<PollForJobsResult> pollForJobsAsync(PollForJobsRequest request)
Description copied from interface:AWSCodePipelineAsync
Returns information about any jobs for AWS CodePipeline to act upon.
When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API returns any secret values defined for the action.
- Specified by:
pollForJobsAsync
in interfaceAWSCodePipelineAsync
- Parameters:
request
- Represents the input of a poll for jobs action.- Returns:
- A Java Future containing the result of the PollForJobs operation returned by the service.
-
pollForJobsAsync
public Future<PollForJobsResult> pollForJobsAsync(PollForJobsRequest request, AsyncHandler<PollForJobsRequest,PollForJobsResult> asyncHandler)
Description copied from interface:AWSCodePipelineAsync
Returns information about any jobs for AWS CodePipeline to act upon.
When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API returns any secret values defined for the action.
- Specified by:
pollForJobsAsync
in interfaceAWSCodePipelineAsync
- Parameters:
request
- Represents the input of a poll for jobs action.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the PollForJobs operation returned by the service.
-
pollForThirdPartyJobsAsync
public Future<PollForThirdPartyJobsResult> pollForThirdPartyJobsAsync(PollForThirdPartyJobsRequest request)
Description copied from interface:AWSCodePipelineAsync
Determines whether there are any third party jobs for a job worker to act on. Only used for partner actions.
When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts.
- Specified by:
pollForThirdPartyJobsAsync
in interfaceAWSCodePipelineAsync
- Parameters:
request
- Represents the input of a poll for third party jobs action.- Returns:
- A Java Future containing the result of the PollForThirdPartyJobs operation returned by the service.
-
pollForThirdPartyJobsAsync
public Future<PollForThirdPartyJobsResult> pollForThirdPartyJobsAsync(PollForThirdPartyJobsRequest request, AsyncHandler<PollForThirdPartyJobsRequest,PollForThirdPartyJobsResult> asyncHandler)
Description copied from interface:AWSCodePipelineAsync
Determines whether there are any third party jobs for a job worker to act on. Only used for partner actions.
When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts.
- Specified by:
pollForThirdPartyJobsAsync
in interfaceAWSCodePipelineAsync
- Parameters:
request
- Represents the input of a poll for third party jobs action.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the PollForThirdPartyJobs operation returned by the service.
-
putActionRevisionAsync
public Future<PutActionRevisionResult> putActionRevisionAsync(PutActionRevisionRequest request)
Description copied from interface:AWSCodePipelineAsync
Provides information to AWS CodePipeline about new revisions to a source.
- Specified by:
putActionRevisionAsync
in interfaceAWSCodePipelineAsync
- Parameters:
request
- Represents the input of a put action revision action.- Returns:
- A Java Future containing the result of the PutActionRevision operation returned by the service.
-
putActionRevisionAsync
public Future<PutActionRevisionResult> putActionRevisionAsync(PutActionRevisionRequest request, AsyncHandler<PutActionRevisionRequest,PutActionRevisionResult> asyncHandler)
Description copied from interface:AWSCodePipelineAsync
Provides information to AWS CodePipeline about new revisions to a source.
- Specified by:
putActionRevisionAsync
in interfaceAWSCodePipelineAsync
- Parameters:
request
- Represents the input of a put action revision action.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the PutActionRevision operation returned by the service.
-
putJobFailureResultAsync
public Future<PutJobFailureResultResult> putJobFailureResultAsync(PutJobFailureResultRequest request)
Description copied from interface:AWSCodePipelineAsync
Represents the failure of a job as returned to the pipeline by a job worker. Only used for custom actions.
- Specified by:
putJobFailureResultAsync
in interfaceAWSCodePipelineAsync
- Parameters:
request
- Represents the input of a put job failure result action.- Returns:
- A Java Future containing the result of the PutJobFailureResult operation returned by the service.
-
putJobFailureResultAsync
public Future<PutJobFailureResultResult> putJobFailureResultAsync(PutJobFailureResultRequest request, AsyncHandler<PutJobFailureResultRequest,PutJobFailureResultResult> asyncHandler)
Description copied from interface:AWSCodePipelineAsync
Represents the failure of a job as returned to the pipeline by a job worker. Only used for custom actions.
- Specified by:
putJobFailureResultAsync
in interfaceAWSCodePipelineAsync
- Parameters:
request
- Represents the input of a put job failure result action.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the PutJobFailureResult operation returned by the service.
-
putJobSuccessResultAsync
public Future<PutJobSuccessResultResult> putJobSuccessResultAsync(PutJobSuccessResultRequest request)
Description copied from interface:AWSCodePipelineAsync
Represents the success of a job as returned to the pipeline by a job worker. Only used for custom actions.
- Specified by:
putJobSuccessResultAsync
in interfaceAWSCodePipelineAsync
- Parameters:
request
- Represents the input of a put job success result action.- Returns:
- A Java Future containing the result of the PutJobSuccessResult operation returned by the service.
-
putJobSuccessResultAsync
public Future<PutJobSuccessResultResult> putJobSuccessResultAsync(PutJobSuccessResultRequest request, AsyncHandler<PutJobSuccessResultRequest,PutJobSuccessResultResult> asyncHandler)
Description copied from interface:AWSCodePipelineAsync
Represents the success of a job as returned to the pipeline by a job worker. Only used for custom actions.
- Specified by:
putJobSuccessResultAsync
in interfaceAWSCodePipelineAsync
- Parameters:
request
- Represents the input of a put job success result action.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the PutJobSuccessResult operation returned by the service.
-
putThirdPartyJobFailureResultAsync
public Future<PutThirdPartyJobFailureResultResult> putThirdPartyJobFailureResultAsync(PutThirdPartyJobFailureResultRequest request)
Description copied from interface:AWSCodePipelineAsync
Represents the failure of a third party job as returned to the pipeline by a job worker. Only used for partner actions.
- Specified by:
putThirdPartyJobFailureResultAsync
in interfaceAWSCodePipelineAsync
- Parameters:
request
- Represents the input of a third party job failure result action.- Returns:
- A Java Future containing the result of the PutThirdPartyJobFailureResult operation returned by the service.
-
putThirdPartyJobFailureResultAsync
public Future<PutThirdPartyJobFailureResultResult> putThirdPartyJobFailureResultAsync(PutThirdPartyJobFailureResultRequest request, AsyncHandler<PutThirdPartyJobFailureResultRequest,PutThirdPartyJobFailureResultResult> asyncHandler)
Description copied from interface:AWSCodePipelineAsync
Represents the failure of a third party job as returned to the pipeline by a job worker. Only used for partner actions.
- Specified by:
putThirdPartyJobFailureResultAsync
in interfaceAWSCodePipelineAsync
- Parameters:
request
- Represents the input of a third party job failure result action.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the PutThirdPartyJobFailureResult operation returned by the service.
-
putThirdPartyJobSuccessResultAsync
public Future<PutThirdPartyJobSuccessResultResult> putThirdPartyJobSuccessResultAsync(PutThirdPartyJobSuccessResultRequest request)
Description copied from interface:AWSCodePipelineAsync
Represents the success of a third party job as returned to the pipeline by a job worker. Only used for partner actions.
- Specified by:
putThirdPartyJobSuccessResultAsync
in interfaceAWSCodePipelineAsync
- Parameters:
request
- Represents the input of a put third party job success result action.- Returns:
- A Java Future containing the result of the PutThirdPartyJobSuccessResult operation returned by the service.
-
putThirdPartyJobSuccessResultAsync
public Future<PutThirdPartyJobSuccessResultResult> putThirdPartyJobSuccessResultAsync(PutThirdPartyJobSuccessResultRequest request, AsyncHandler<PutThirdPartyJobSuccessResultRequest,PutThirdPartyJobSuccessResultResult> asyncHandler)
Description copied from interface:AWSCodePipelineAsync
Represents the success of a third party job as returned to the pipeline by a job worker. Only used for partner actions.
- Specified by:
putThirdPartyJobSuccessResultAsync
in interfaceAWSCodePipelineAsync
- Parameters:
request
- Represents the input of a put third party job success result action.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the PutThirdPartyJobSuccessResult operation returned by the service.
-
startPipelineExecutionAsync
public Future<StartPipelineExecutionResult> startPipelineExecutionAsync(StartPipelineExecutionRequest request)
Description copied from interface:AWSCodePipelineAsync
Starts the specified pipeline. Specifically, it begins processing the latest commit to the source location specified as part of the pipeline.
- Specified by:
startPipelineExecutionAsync
in interfaceAWSCodePipelineAsync
- Parameters:
request
- Represents the input of a start pipeline execution action.- Returns:
- A Java Future containing the result of the StartPipelineExecution operation returned by the service.
-
startPipelineExecutionAsync
public Future<StartPipelineExecutionResult> startPipelineExecutionAsync(StartPipelineExecutionRequest request, AsyncHandler<StartPipelineExecutionRequest,StartPipelineExecutionResult> asyncHandler)
Description copied from interface:AWSCodePipelineAsync
Starts the specified pipeline. Specifically, it begins processing the latest commit to the source location specified as part of the pipeline.
- Specified by:
startPipelineExecutionAsync
in interfaceAWSCodePipelineAsync
- Parameters:
request
- Represents the input of a start pipeline execution action.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the StartPipelineExecution operation returned by the service.
-
updatePipelineAsync
public Future<UpdatePipelineResult> updatePipelineAsync(UpdatePipelineRequest request)
Description copied from interface:AWSCodePipelineAsync
Updates a specified pipeline with edits or changes to its structure. Use a JSON file with the pipeline structure in conjunction with UpdatePipeline to provide the full structure of the pipeline. Updating the pipeline increases the version number of the pipeline by 1.
- Specified by:
updatePipelineAsync
in interfaceAWSCodePipelineAsync
- Parameters:
request
- Represents the input of an update pipeline action.- Returns:
- A Java Future containing the result of the UpdatePipeline operation returned by the service.
-
updatePipelineAsync
public Future<UpdatePipelineResult> updatePipelineAsync(UpdatePipelineRequest request, AsyncHandler<UpdatePipelineRequest,UpdatePipelineResult> asyncHandler)
Description copied from interface:AWSCodePipelineAsync
Updates a specified pipeline with edits or changes to its structure. Use a JSON file with the pipeline structure in conjunction with UpdatePipeline to provide the full structure of the pipeline. Updating the pipeline increases the version number of the pipeline by 1.
- Specified by:
updatePipelineAsync
in interfaceAWSCodePipelineAsync
- Parameters:
request
- Represents the input of an update pipeline action.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the UpdatePipeline operation returned by the service.
-
shutdown
public void shutdown()
Shuts down the client, releasing all managed resources. This includes forcibly terminating all pending asynchronous service calls. Clients who wish to give pending asynchronous service calls time to complete should callgetExecutorService().shutdown()
followed bygetExecutorService().awaitTermination()
prior to calling this method.- Specified by:
shutdown
in interfaceAWSCodePipeline
- Overrides:
shutdown
in classAmazonWebServiceClient
-
-