com.amazonaws.service.codepipeline

Interface AWSCodePipeline

All Known Subinterfaces:

AWSCodePipelineAsync

All Known Implementing Classes:

AWSCodePipelineAsyncClient, AWSCodePipelineClient

public interface AWSCodePipeline

Interface for accessing CodePipeline.

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.
• 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.

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,
  • 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,
  • 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.

Method Summary

Methods

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.
void	deleteCustomActionType(DeleteCustomActionTypeRequest deleteCustomActionTypeRequest) Marks a custom action as deleted.
void	deletePipeline(DeletePipelineRequest deletePipelineRequest) Deletes the specified pipeline.
void	disableStageTransition(DisableStageTransitionRequest disableStageTransitionRequest) Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline.
void	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.
GetPipelineStateResult	getPipelineState(GetPipelineStateRequest getPipelineStateRequest) Returns information about the state of a pipeline, including the stages, actions, and details about the last run of the pipeline.
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.
void	putJobFailureResult(PutJobFailureResultRequest putJobFailureResultRequest) Represents the failure of a job as returned to the pipeline by a job worker.
void	putJobSuccessResult(PutJobSuccessResultRequest putJobSuccessResultRequest) Represents the success of a job as returned to the pipeline by a job worker.
void	putThirdPartyJobFailureResult(PutThirdPartyJobFailureResultRequest putThirdPartyJobFailureResultRequest) Represents the failure of a third party job as returned to the pipeline by a job worker.
void	putThirdPartyJobSuccessResult(PutThirdPartyJobSuccessResultRequest putThirdPartyJobSuccessResultRequest) Represents the success of a third party job as returned to the pipeline by a job worker.
void	setEndpoint(String endpoint) Overrides the default endpoint for this client ("https://codepipeline.us-east-1.amazonaws.com").
void	setRegion(Region region) An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartPipelineExecutionResult	startPipelineExecution(StartPipelineExecutionRequest startPipelineExecutionRequest) Starts the specified pipeline.
UpdatePipelineResult	updatePipeline(UpdatePipelineRequest updatePipelineRequest) Updates a specified pipeline with edits or changes to its structure.

Method Detail

setEndpoint

void setEndpoint(String endpoint)

Overrides the default endpoint for this client ("https://codepipeline.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.

Callers can pass in just the endpoint (ex: "codepipeline.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://codepipeline.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.

For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID= 3912

This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

endpoint - The endpoint (ex: "codepipeline.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://codepipeline.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.

setRegion

void setRegion(Region region)

An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.

By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.

This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region. Must not be null and must be a region where the service is available.

See Also:

Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration), Region.isServiceSupported(String)

acknowledgeJob

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.

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.

acknowledgeThirdPartyJob

AcknowledgeThirdPartyJobResult acknowledgeThirdPartyJob(AcknowledgeThirdPartyJobRequest acknowledgeThirdPartyJobRequest)

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

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

createCustomActionType

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.

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.

createPipeline

CreatePipelineResult createPipeline(CreatePipelineRequest createPipelineRequest)

Creates a pipeline.

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 - The specified gate declaration was specified in an invalid format.

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.

deleteCustomActionType

void 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.

Parameters:

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

Throws:

ValidationException - The validation was specified in an invalid format.

deletePipeline

void deletePipeline(DeletePipelineRequest deletePipelineRequest)

Deletes the specified pipeline.

Parameters:

deletePipelineRequest - Represents the input of a delete pipeline action.

Throws:

ValidationException - The validation was specified in an invalid format.

disableStageTransition

void disableStageTransition(DisableStageTransitionRequest disableStageTransitionRequest)

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

Parameters:

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

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.

enableStageTransition

void enableStageTransition(EnableStageTransitionRequest enableStageTransitionRequest)

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

Parameters:

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

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.

getJobDetails

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.

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.

getPipeline

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.

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.

getPipelineState

GetPipelineStateResult getPipelineState(GetPipelineStateRequest getPipelineStateRequest)

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

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.

getThirdPartyJobDetails

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.

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.

listActionTypes

ListActionTypesResult listActionTypes(ListActionTypesRequest listActionTypesRequest)

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

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.

listPipelines

ListPipelinesResult listPipelines(ListPipelinesRequest listPipelinesRequest)

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

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.

pollForJobs

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.

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.

pollForThirdPartyJobs

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.

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.

putActionRevision

PutActionRevisionResult putActionRevision(PutActionRevisionRequest putActionRevisionRequest)

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

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.

putJobFailureResult

void putJobFailureResult(PutJobFailureResultRequest putJobFailureResultRequest)

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

Parameters:

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

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.

putJobSuccessResult

void putJobSuccessResult(PutJobSuccessResultRequest putJobSuccessResultRequest)

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

Parameters:

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

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.

putThirdPartyJobFailureResult

void 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.

Parameters:

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

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

putThirdPartyJobSuccessResult

void 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.

Parameters:

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

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

startPipelineExecution

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.

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.

updatePipeline

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.

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 - The specified gate declaration was specified in an invalid format.

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

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

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 a request.

Parameters:

request - The originally executed request.

Returns:

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