com.amazonaws.services.codepipeline

Class AWSCodePipelineClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.codepipeline.AWSCodePipelineClient

All Implemented Interfaces:

AWSCodePipeline

Direct Known Subclasses:

AWSCodePipelineAsyncClient

@ThreadSafe
public class AWSCodePipelineClient
extends AmazonWebServiceClient
implements AWSCodePipeline

Client for accessing CodePipeline. All service calls made using this client are blocking, and will not return until the service call completes.

AWS CodePipeline

Overview

This is the AWS CodePipeline API Reference. This guide provides descriptions of the actions and data types for AWS CodePipeline. Some functionality for your pipeline is only configurable through the API. For additional information, see the AWS CodePipeline User Guide.

You can use the AWS CodePipeline API to work with pipelines, stages, actions, gates, and transitions, as described below.

Pipelines are models of automated release processes. Each pipeline is uniquely named, and consists of actions, gates, and stages.

You can work with pipelines by calling:

• CreatePipeline, which creates a uniquely-named pipeline.

• DeletePipeline, which deletes the specified pipeline.

• GetPipeline, which returns information about a pipeline structure.

• GetPipelineExecution, which returns information about a specific execution of a pipeline.

• GetPipelineState, which returns information about the current state of the stages and actions of a pipeline.

• ListPipelines, which gets a summary of all of the pipelines associated with your account.

• StartPipelineExecution, which runs the the most recent revision of an artifact through the pipeline.

• UpdatePipeline, which updates a pipeline with edits or changes to the structure of the pipeline.

Pipelines include stages, which are 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.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.codepipeline.AWSCodePipeline

ENDPOINT_PREFIX

Constructor Summary

Constructors

Constructor and Description
AWSCodePipelineClient() Constructs a new client to invoke service methods on CodePipeline.
AWSCodePipelineClient(AWSCredentials awsCredentials) Constructs a new client to invoke service methods on CodePipeline using the specified AWS account credentials.
AWSCodePipelineClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on CodePipeline using the specified AWS account credentials and client configuration options.
AWSCodePipelineClient(AWSCredentialsProvider awsCredentialsProvider) Constructs a new client to invoke service methods on CodePipeline using the specified AWS account credentials provider.
AWSCodePipelineClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on CodePipeline using the specified AWS account credentials provider and client configuration options.
AWSCodePipelineClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector) Constructs a new client to invoke service methods on CodePipeline using the specified AWS account credentials provider, client configuration options, and request metric collector.
AWSCodePipelineClient(ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on CodePipeline.

Method Summary

Modifier and Type	Method and Description
AcknowledgeJobResult	acknowledgeJob(AcknowledgeJobRequest acknowledgeJobRequest) Returns information about a specified job and whether that job has been received by the job worker.
AcknowledgeThirdPartyJobResult	acknowledgeThirdPartyJob(AcknowledgeThirdPartyJobRequest acknowledgeThirdPartyJobRequest) Confirms a job worker has received the specified job.
CreateCustomActionTypeResult	createCustomActionType(CreateCustomActionTypeRequest createCustomActionTypeRequest) Creates a new custom action that can be used in all pipelines associated with the AWS account.
CreatePipelineResult	createPipeline(CreatePipelineRequest createPipelineRequest) Creates a pipeline.
DeleteCustomActionTypeResult	deleteCustomActionType(DeleteCustomActionTypeRequest deleteCustomActionTypeRequest) Marks a custom action as deleted.
DeletePipelineResult	deletePipeline(DeletePipelineRequest deletePipelineRequest) Deletes the specified pipeline.
DisableStageTransitionResult	disableStageTransition(DisableStageTransitionRequest disableStageTransitionRequest) Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline.
EnableStageTransitionResult	enableStageTransition(EnableStageTransitionRequest enableStageTransitionRequest) Enables artifacts in a pipeline to transition to a stage in a pipeline.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
GetJobDetailsResult	getJobDetails(GetJobDetailsRequest getJobDetailsRequest) Returns information about a job.
GetPipelineResult	getPipeline(GetPipelineRequest getPipelineRequest) Returns the metadata, structure, stages, and actions of a pipeline.
GetPipelineExecutionResult	getPipelineExecution(GetPipelineExecutionRequest getPipelineExecutionRequest) Returns information about an execution of a pipeline, including details about artifacts, the pipeline execution ID, and the name, version, and status of the pipeline.
GetPipelineStateResult	getPipelineState(GetPipelineStateRequest getPipelineStateRequest) Returns information about the state of a pipeline, including the stages and actions.
GetThirdPartyJobDetailsResult	getThirdPartyJobDetails(GetThirdPartyJobDetailsRequest getThirdPartyJobDetailsRequest) Requests the details of a job for a third party action.
ListActionTypesResult	listActionTypes(ListActionTypesRequest listActionTypesRequest) Gets a summary of all AWS CodePipeline action types associated with your account.
ListPipelinesResult	listPipelines(ListPipelinesRequest listPipelinesRequest) Gets a summary of all of the pipelines associated with your account.
PollForJobsResult	pollForJobs(PollForJobsRequest pollForJobsRequest) Returns information about any jobs for AWS CodePipeline to act upon.
PollForThirdPartyJobsResult	pollForThirdPartyJobs(PollForThirdPartyJobsRequest pollForThirdPartyJobsRequest) Determines whether there are any third party jobs for a job worker to act on.
PutActionRevisionResult	putActionRevision(PutActionRevisionRequest putActionRevisionRequest) Provides information to AWS CodePipeline about new revisions to a source.
PutApprovalResultResult	putApprovalResult(PutApprovalResultRequest putApprovalResultRequest) Provides the response to a manual approval request to AWS CodePipeline.
PutJobFailureResultResult	putJobFailureResult(PutJobFailureResultRequest putJobFailureResultRequest) Represents the failure of a job as returned to the pipeline by a job worker.
PutJobSuccessResultResult	putJobSuccessResult(PutJobSuccessResultRequest putJobSuccessResultRequest) Represents the success of a job as returned to the pipeline by a job worker.
PutThirdPartyJobFailureResultResult	putThirdPartyJobFailureResult(PutThirdPartyJobFailureResultRequest putThirdPartyJobFailureResultRequest) Represents the failure of a third party job as returned to the pipeline by a job worker.
PutThirdPartyJobSuccessResultResult	putThirdPartyJobSuccessResult(PutThirdPartyJobSuccessResultRequest putThirdPartyJobSuccessResultRequest) Represents the success of a third party job as returned to the pipeline by a job worker.
RetryStageExecutionResult	retryStageExecution(RetryStageExecutionRequest retryStageExecutionRequest) Resumes the pipeline execution by retrying the last failed actions in a stage.
StartPipelineExecutionResult	startPipelineExecution(StartPipelineExecutionRequest startPipelineExecutionRequest) Starts the specified pipeline.
UpdatePipelineResult	updatePipeline(UpdatePipelineRequest updatePipelineRequest) Updates a specified pipeline with edits or changes to its structure.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getEndpointPrefix, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.codepipeline.AWSCodePipeline

setEndpoint, setRegion, shutdown

Constructor Detail

AWSCodePipelineClient

public AWSCodePipelineClient()

Constructs a new 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
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

See Also:

DefaultAWSCredentialsProviderChain

AWSCodePipelineClient

public AWSCodePipelineClient(ClientConfiguration clientConfiguration)

Constructs a new 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
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

clientConfiguration - The client configuration options controlling how this client connects to CodePipeline (ex: proxy settings, retry counts, etc.).

See Also:

DefaultAWSCredentialsProviderChain

AWSCodePipelineClient

public AWSCodePipelineClient(AWSCredentials awsCredentials)

Constructs a new client to invoke service methods on CodePipeline using the specified AWS account credentials.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

AWSCodePipelineClient

public AWSCodePipelineClient(AWSCredentials awsCredentials,
                             ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on CodePipeline using the specified AWS account credentials and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to CodePipeline (ex: proxy settings, retry counts, etc.).

AWSCodePipelineClient

public AWSCodePipelineClient(AWSCredentialsProvider awsCredentialsProvider)

Constructs a new client to invoke service methods on CodePipeline using the specified AWS account credentials provider.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

AWSCodePipelineClient

public AWSCodePipelineClient(AWSCredentialsProvider awsCredentialsProvider,
                             ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on CodePipeline using the specified AWS account credentials provider and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to CodePipeline (ex: proxy settings, retry counts, etc.).

AWSCodePipelineClient

public AWSCodePipelineClient(AWSCredentialsProvider awsCredentialsProvider,
                             ClientConfiguration clientConfiguration,
                             RequestMetricCollector requestMetricCollector)

Constructs a new client to invoke service methods on CodePipeline using the specified AWS account credentials provider, client configuration options, and request metric collector.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to CodePipeline (ex: proxy settings, retry counts, etc.).

requestMetricCollector - optional request metric collector

Method Detail

acknowledgeJob

public AcknowledgeJobResult acknowledgeJob(AcknowledgeJobRequest acknowledgeJobRequest)

Returns information about a specified job and whether that job has been received by the job worker. Only used for custom actions.

Specified by:

acknowledgeJob in interface AWSCodePipeline

Parameters:

acknowledgeJobRequest - Represents the input of an acknowledge job action.

Returns:

Result of the AcknowledgeJob operation returned by the service.

Throws:

ValidationException - The validation was specified in an invalid format.

InvalidNonceException - The specified nonce was specified in an invalid format.

JobNotFoundException - The specified job was specified in an invalid format or cannot be found.

See Also:

AWS API Documentation

acknowledgeThirdPartyJob

public AcknowledgeThirdPartyJobResult acknowledgeThirdPartyJob(AcknowledgeThirdPartyJobRequest acknowledgeThirdPartyJobRequest)

Confirms a job worker has received the specified job. Only used for partner actions.

Specified by:

acknowledgeThirdPartyJob in interface AWSCodePipeline

Parameters:

acknowledgeThirdPartyJobRequest - Represents the input of an acknowledge third party job action.

Returns:

Result of the AcknowledgeThirdPartyJob operation returned by the service.

Throws:

ValidationException - The validation was specified in an invalid format.

InvalidNonceException - The specified nonce was specified in an invalid format.

JobNotFoundException - The specified job was specified in an invalid format or cannot be found.

InvalidClientTokenException - The client token was specified in an invalid format

See Also:

AWS API Documentation

createCustomActionType

public CreateCustomActionTypeResult createCustomActionType(CreateCustomActionTypeRequest createCustomActionTypeRequest)

Creates a new custom action that can be used in all pipelines associated with the AWS account. Only used for custom actions.

Specified by:

createCustomActionType in interface AWSCodePipeline

Parameters:

createCustomActionTypeRequest - Represents the input of a create custom action operation.

Returns:

Result of the CreateCustomActionType operation returned by the service.

Throws:

ValidationException - The validation was specified in an invalid format.

LimitExceededException - The number of pipelines associated with the AWS account has exceeded the limit allowed for the account.

See Also:

AWS API Documentation

createPipeline

public CreatePipelineResult createPipeline(CreatePipelineRequest createPipelineRequest)

Creates a pipeline.

Specified by:

createPipeline in interface AWSCodePipeline

Parameters:

createPipelineRequest - Represents the input of a create pipeline action.

Returns:

Result of the CreatePipeline operation returned by the service.

Throws:

ValidationException - The validation was specified in an invalid format.

PipelineNameInUseException - The specified pipeline name is already in use.

InvalidStageDeclarationException - The specified stage declaration was specified in an invalid format.

InvalidActionDeclarationException - The specified action declaration was specified in an invalid format.

InvalidBlockerDeclarationException - Reserved for future use.

InvalidStructureException - The specified structure was specified in an invalid format.

LimitExceededException - The number of pipelines associated with the AWS account has exceeded the limit allowed for the account.

See Also:

AWS API Documentation

deleteCustomActionType

public DeleteCustomActionTypeResult deleteCustomActionType(DeleteCustomActionTypeRequest deleteCustomActionTypeRequest)

Marks a custom action as deleted. PollForJobs for the custom action will fail after the action is marked for deletion. Only used for custom actions.

You cannot recreate a custom action after it has been deleted unless you increase the version number of the action.

Specified by:

deleteCustomActionType in interface AWSCodePipeline

Parameters:

deleteCustomActionTypeRequest - Represents the input of a delete custom action operation. The custom action will be marked as deleted.

Returns:

Result of the DeleteCustomActionType operation returned by the service.

Throws:

ValidationException - The validation was specified in an invalid format.

See Also:

AWS API Documentation

deletePipeline

public DeletePipelineResult deletePipeline(DeletePipelineRequest deletePipelineRequest)

Deletes the specified pipeline.

Specified by:

deletePipeline in interface AWSCodePipeline

Parameters:

deletePipelineRequest - Represents the input of a delete pipeline action.

Returns:

Result of the DeletePipeline operation returned by the service.

Throws:

ValidationException - The validation was specified in an invalid format.

See Also:

AWS API Documentation

disableStageTransition

public DisableStageTransitionResult disableStageTransition(DisableStageTransitionRequest disableStageTransitionRequest)

Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline.

Specified by:

disableStageTransition in interface AWSCodePipeline

Parameters:

disableStageTransitionRequest - Represents the input of a disable stage transition input action.

Returns:

Result of the DisableStageTransition operation returned by the service.

Throws:

ValidationException - The validation was specified in an invalid format.

PipelineNotFoundException - The specified pipeline was specified in an invalid format or cannot be found.

StageNotFoundException - The specified stage was specified in an invalid format or cannot be found.

See Also:

AWS API Documentation

enableStageTransition

public EnableStageTransitionResult enableStageTransition(EnableStageTransitionRequest enableStageTransitionRequest)

Enables artifacts in a pipeline to transition to a stage in a pipeline.

Specified by:

enableStageTransition in interface AWSCodePipeline

Parameters:

enableStageTransitionRequest - Represents the input of an enable stage transition action.

Returns:

Result of the EnableStageTransition operation returned by the service.

Throws:

ValidationException - The validation was specified in an invalid format.

PipelineNotFoundException - The specified pipeline was specified in an invalid format or cannot be found.

StageNotFoundException - The specified stage was specified in an invalid format or cannot be found.

See Also:

AWS API Documentation

getJobDetails

public GetJobDetailsResult getJobDetails(GetJobDetailsRequest getJobDetailsRequest)

Returns information about a job. Only used for custom actions.

When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API returns any secret values defined for the action.

Specified by:

getJobDetails in interface AWSCodePipeline

Parameters:

getJobDetailsRequest - Represents the input of a get job details action.

Returns:

Result of the GetJobDetails operation returned by the service.

Throws:

ValidationException - The validation was specified in an invalid format.

JobNotFoundException - The specified job was specified in an invalid format or cannot be found.

See Also:

AWS API Documentation

getPipeline

public GetPipelineResult getPipeline(GetPipelineRequest getPipelineRequest)

Returns the metadata, structure, stages, and actions of a pipeline. Can be used to return the entire structure of a pipeline in JSON format, which can then be modified and used to update the pipeline structure with UpdatePipeline.

Specified by:

getPipeline in interface AWSCodePipeline

Parameters:

getPipelineRequest - Represents the input of a get pipeline action.

Returns:

Result of the GetPipeline operation returned by the service.

Throws:

ValidationException - The validation was specified in an invalid format.

PipelineNotFoundException - The specified pipeline was specified in an invalid format or cannot be found.

PipelineVersionNotFoundException - The specified pipeline version was specified in an invalid format or cannot be found.

See Also:

AWS API Documentation

getPipelineExecution

public GetPipelineExecutionResult getPipelineExecution(GetPipelineExecutionRequest getPipelineExecutionRequest)

Returns information about an execution of a pipeline, including details about artifacts, the pipeline execution ID, and the name, version, and status of the pipeline.

Specified by:

getPipelineExecution in interface AWSCodePipeline

Parameters:

getPipelineExecutionRequest - Represents the input of a get pipeline execution action.

Returns:

Result of the GetPipelineExecution operation returned by the service.

Throws:

ValidationException - The validation was specified in an invalid format.

PipelineNotFoundException - The specified pipeline was specified in an invalid format or cannot be found.

PipelineExecutionNotFoundException - The pipeline execution was specified in an invalid format or cannot be found, or an execution ID does not belong to the specified pipeline.

See Also:

AWS API Documentation

getPipelineState

public GetPipelineStateResult getPipelineState(GetPipelineStateRequest getPipelineStateRequest)

Returns information about the state of a pipeline, including the stages and actions.

Specified by:

getPipelineState in interface AWSCodePipeline

Parameters:

getPipelineStateRequest - Represents the input of a get pipeline state action.

Returns:

Result of the GetPipelineState operation returned by the service.

Throws:

ValidationException - The validation was specified in an invalid format.

PipelineNotFoundException - The specified pipeline was specified in an invalid format or cannot be found.

See Also:

AWS API Documentation

getThirdPartyJobDetails

public GetThirdPartyJobDetailsResult getThirdPartyJobDetails(GetThirdPartyJobDetailsRequest getThirdPartyJobDetailsRequest)

Requests the details of a job for a third party action. Only used for partner actions.

When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API returns any secret values defined for the action.

Specified by:

getThirdPartyJobDetails in interface AWSCodePipeline

Parameters:

getThirdPartyJobDetailsRequest - Represents the input of a get third party job details action.

Returns:

Result of the GetThirdPartyJobDetails operation returned by the service.

Throws:

JobNotFoundException - The specified job was specified in an invalid format or cannot be found.

ValidationException - The validation was specified in an invalid format.

InvalidClientTokenException - The client token was specified in an invalid format

InvalidJobException - The specified job was specified in an invalid format or cannot be found.

See Also:

AWS API Documentation

listActionTypes

public ListActionTypesResult listActionTypes(ListActionTypesRequest listActionTypesRequest)

Gets a summary of all AWS CodePipeline action types associated with your account.

Specified by:

listActionTypes in interface AWSCodePipeline

Parameters:

listActionTypesRequest - Represents the input of a list action types action.

Returns:

Result of the ListActionTypes operation returned by the service.

Throws:

ValidationException - The validation was specified in an invalid format.

InvalidNextTokenException - The next token was specified in an invalid format. Make sure that the next token you provided is the token returned by a previous call.

See Also:

AWS API Documentation

listPipelines

public ListPipelinesResult listPipelines(ListPipelinesRequest listPipelinesRequest)

Gets a summary of all of the pipelines associated with your account.

Specified by:

listPipelines in interface AWSCodePipeline

Parameters:

listPipelinesRequest - Represents the input of a list pipelines action.

Returns:

Result of the ListPipelines operation returned by the service.

Throws:

InvalidNextTokenException - The next token was specified in an invalid format. Make sure that the next token you provided is the token returned by a previous call.

See Also:

AWS API Documentation

pollForJobs

public PollForJobsResult pollForJobs(PollForJobsRequest pollForJobsRequest)

Returns information about any jobs for AWS CodePipeline to act upon.

When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API returns any secret values defined for the action.

Specified by:

pollForJobs in interface AWSCodePipeline

Parameters:

pollForJobsRequest - Represents the input of a poll for jobs action.

Returns:

Result of the PollForJobs operation returned by the service.

Throws:

ValidationException - The validation was specified in an invalid format.

ActionTypeNotFoundException - The specified action type cannot be found.

See Also:

AWS API Documentation

pollForThirdPartyJobs

public PollForThirdPartyJobsResult pollForThirdPartyJobs(PollForThirdPartyJobsRequest pollForThirdPartyJobsRequest)

Determines whether there are any third party jobs for a job worker to act on. Only used for partner actions.

When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts.

Specified by:

pollForThirdPartyJobs in interface AWSCodePipeline

Parameters:

pollForThirdPartyJobsRequest - Represents the input of a poll for third party jobs action.

Returns:

Result of the PollForThirdPartyJobs operation returned by the service.

Throws:

ActionTypeNotFoundException - The specified action type cannot be found.

ValidationException - The validation was specified in an invalid format.

See Also:

AWS API Documentation

putActionRevision

public PutActionRevisionResult putActionRevision(PutActionRevisionRequest putActionRevisionRequest)

Provides information to AWS CodePipeline about new revisions to a source.

Specified by:

putActionRevision in interface AWSCodePipeline

Parameters:

putActionRevisionRequest - Represents the input of a put action revision action.

Returns:

Result of the PutActionRevision operation returned by the service.

Throws:

PipelineNotFoundException - The specified pipeline was specified in an invalid format or cannot be found.

StageNotFoundException - The specified stage was specified in an invalid format or cannot be found.

ActionNotFoundException - The specified action cannot be found.

ValidationException - The validation was specified in an invalid format.

See Also:

AWS API Documentation

putApprovalResult

public PutApprovalResultResult putApprovalResult(PutApprovalResultRequest putApprovalResultRequest)

Provides the response to a manual approval request to AWS CodePipeline. Valid responses include Approved and Rejected.

Specified by:

putApprovalResult in interface AWSCodePipeline

Parameters:

putApprovalResultRequest - Represents the input of a put approval result action.

Returns:

Result of the PutApprovalResult operation returned by the service.

Throws:

InvalidApprovalTokenException - The approval request already received a response or has expired.

ApprovalAlreadyCompletedException - The approval action has already been approved or rejected.

PipelineNotFoundException - The specified pipeline was specified in an invalid format or cannot be found.

StageNotFoundException - The specified stage was specified in an invalid format or cannot be found.

ActionNotFoundException - The specified action cannot be found.

ValidationException - The validation was specified in an invalid format.

See Also:

AWS API Documentation

putJobFailureResult

public PutJobFailureResultResult putJobFailureResult(PutJobFailureResultRequest putJobFailureResultRequest)

Represents the failure of a job as returned to the pipeline by a job worker. Only used for custom actions.

Specified by:

putJobFailureResult in interface AWSCodePipeline

Parameters:

putJobFailureResultRequest - Represents the input of a put job failure result action.

Returns:

Result of the PutJobFailureResult operation returned by the service.

Throws:

ValidationException - The validation was specified in an invalid format.

JobNotFoundException - The specified job was specified in an invalid format or cannot be found.

InvalidJobStateException - The specified job state was specified in an invalid format.

See Also:

AWS API Documentation

putJobSuccessResult

public PutJobSuccessResultResult putJobSuccessResult(PutJobSuccessResultRequest putJobSuccessResultRequest)

Represents the success of a job as returned to the pipeline by a job worker. Only used for custom actions.

Specified by:

putJobSuccessResult in interface AWSCodePipeline

Parameters:

putJobSuccessResultRequest - Represents the input of a put job success result action.

Returns:

Result of the PutJobSuccessResult operation returned by the service.

Throws:

ValidationException - The validation was specified in an invalid format.

JobNotFoundException - The specified job was specified in an invalid format or cannot be found.

InvalidJobStateException - The specified job state was specified in an invalid format.

See Also:

AWS API Documentation

putThirdPartyJobFailureResult

public PutThirdPartyJobFailureResultResult putThirdPartyJobFailureResult(PutThirdPartyJobFailureResultRequest putThirdPartyJobFailureResultRequest)

Represents the failure of a third party job as returned to the pipeline by a job worker. Only used for partner actions.

Specified by:

putThirdPartyJobFailureResult in interface AWSCodePipeline

Parameters:

putThirdPartyJobFailureResultRequest - Represents the input of a third party job failure result action.

Returns:

Result of the PutThirdPartyJobFailureResult operation returned by the service.

Throws:

ValidationException - The validation was specified in an invalid format.

JobNotFoundException - The specified job was specified in an invalid format or cannot be found.

InvalidJobStateException - The specified job state was specified in an invalid format.

InvalidClientTokenException - The client token was specified in an invalid format

See Also:

AWS API Documentation

putThirdPartyJobSuccessResult

public PutThirdPartyJobSuccessResultResult putThirdPartyJobSuccessResult(PutThirdPartyJobSuccessResultRequest putThirdPartyJobSuccessResultRequest)

Represents the success of a third party job as returned to the pipeline by a job worker. Only used for partner actions.

Specified by:

putThirdPartyJobSuccessResult in interface AWSCodePipeline

Parameters:

putThirdPartyJobSuccessResultRequest - Represents the input of a put third party job success result action.

Returns:

Result of the PutThirdPartyJobSuccessResult operation returned by the service.

Throws:

ValidationException - The validation was specified in an invalid format.

JobNotFoundException - The specified job was specified in an invalid format or cannot be found.

InvalidJobStateException - The specified job state was specified in an invalid format.

InvalidClientTokenException - The client token was specified in an invalid format

See Also:

AWS API Documentation

retryStageExecution

public RetryStageExecutionResult retryStageExecution(RetryStageExecutionRequest retryStageExecutionRequest)

Resumes the pipeline execution by retrying the last failed actions in a stage.

Specified by:

retryStageExecution in interface AWSCodePipeline

Parameters:

retryStageExecutionRequest - Represents the input of a retry stage execution action.

Returns:

Result of the RetryStageExecution operation returned by the service.

Throws:

ValidationException - The validation was specified in an invalid format.

PipelineNotFoundException - The specified pipeline was specified in an invalid format or cannot be found.

StageNotFoundException - The specified stage was specified in an invalid format or cannot be found.

StageNotRetryableException - The specified stage can't be retried because the pipeline structure or stage state changed after the stage was not completed; the stage contains no failed actions; one or more actions are still in progress; or another retry attempt is already in progress.

NotLatestPipelineExecutionException - The stage has failed in a later run of the pipeline and the pipelineExecutionId associated with the request is out of date.

See Also:

AWS API Documentation

startPipelineExecution

public StartPipelineExecutionResult startPipelineExecution(StartPipelineExecutionRequest startPipelineExecutionRequest)

Starts the specified pipeline. Specifically, it begins processing the latest commit to the source location specified as part of the pipeline.

Specified by:

startPipelineExecution in interface AWSCodePipeline

Parameters:

startPipelineExecutionRequest - Represents the input of a start pipeline execution action.

Returns:

Result of the StartPipelineExecution operation returned by the service.

Throws:

ValidationException - The validation was specified in an invalid format.

PipelineNotFoundException - The specified pipeline was specified in an invalid format or cannot be found.

See Also:

AWS API Documentation

updatePipeline

public UpdatePipelineResult updatePipeline(UpdatePipelineRequest updatePipelineRequest)

Updates a specified pipeline with edits or changes to its structure. Use a JSON file with the pipeline structure in conjunction with UpdatePipeline to provide the full structure of the pipeline. Updating the pipeline increases the version number of the pipeline by 1.

Specified by:

updatePipeline in interface AWSCodePipeline

Parameters:

updatePipelineRequest - Represents the input of an update pipeline action.

Returns:

Result of the UpdatePipeline operation returned by the service.

Throws:

ValidationException - The validation was specified in an invalid format.

InvalidStageDeclarationException - The specified stage declaration was specified in an invalid format.

InvalidActionDeclarationException - The specified action declaration was specified in an invalid format.

InvalidBlockerDeclarationException - Reserved for future use.

InvalidStructureException - The specified structure was specified in an invalid format.

See Also:

AWS API Documentation

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.

Specified by:

getCachedResponseMetadata in interface AWSCodePipeline

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.