AutoCloseable@Generated("software.amazon.awssdk:codegen") public interface CodePipelineClient extends AutoCloseable
builder() method.
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.
| Modifier and Type | Field | Description |
|---|---|---|
static String |
SERVICE_NAME |
| Modifier and Type | Method | Description |
|---|---|---|
default AcknowledgeJobResponse |
acknowledgeJob(AcknowledgeJobRequest acknowledgeJobRequest) |
Returns information about a specified job and whether that job has been received by the job worker.
|
default AcknowledgeThirdPartyJobResponse |
acknowledgeThirdPartyJob(AcknowledgeThirdPartyJobRequest acknowledgeThirdPartyJobRequest) |
Confirms a job worker has received the specified job.
|
static CodePipelineClientBuilder |
builder() |
Create a builder that can be used to configure and create a
CodePipelineClient. |
static CodePipelineClient |
create() |
Create a
CodePipelineClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CreateCustomActionTypeResponse |
createCustomActionType(CreateCustomActionTypeRequest createCustomActionTypeRequest) |
Creates a new custom action that can be used in all pipelines associated with the AWS account.
|
default CreatePipelineResponse |
createPipeline(CreatePipelineRequest createPipelineRequest) |
Creates a pipeline.
|
default DeleteCustomActionTypeResponse |
deleteCustomActionType(DeleteCustomActionTypeRequest deleteCustomActionTypeRequest) |
Marks a custom action as deleted.
|
default DeletePipelineResponse |
deletePipeline(DeletePipelineRequest deletePipelineRequest) |
Deletes the specified pipeline.
|
default DisableStageTransitionResponse |
disableStageTransition(DisableStageTransitionRequest disableStageTransitionRequest) |
Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline.
|
default EnableStageTransitionResponse |
enableStageTransition(EnableStageTransitionRequest enableStageTransitionRequest) |
Enables artifacts in a pipeline to transition to a stage in a pipeline.
|
default GetJobDetailsResponse |
getJobDetails(GetJobDetailsRequest getJobDetailsRequest) |
Returns information about a job.
|
default GetPipelineResponse |
getPipeline(GetPipelineRequest getPipelineRequest) |
Returns the metadata, structure, stages, and actions of a pipeline.
|
default GetPipelineExecutionResponse |
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.
|
default GetPipelineStateResponse |
getPipelineState(GetPipelineStateRequest getPipelineStateRequest) |
Returns information about the state of a pipeline, including the stages and actions.
|
default GetThirdPartyJobDetailsResponse |
getThirdPartyJobDetails(GetThirdPartyJobDetailsRequest getThirdPartyJobDetailsRequest) |
Requests the details of a job for a third party action.
|
default ListActionTypesResponse |
listActionTypes(ListActionTypesRequest listActionTypesRequest) |
Gets a summary of all AWS CodePipeline action types associated with your account.
|
default ListPipelineExecutionsResponse |
listPipelineExecutions(ListPipelineExecutionsRequest listPipelineExecutionsRequest) |
Gets a summary of the most recent executions for a pipeline.
|
default ListPipelinesResponse |
listPipelines(ListPipelinesRequest listPipelinesRequest) |
Gets a summary of all of the pipelines associated with your account.
|
default PollForJobsResponse |
pollForJobs(PollForJobsRequest pollForJobsRequest) |
Returns information about any jobs for AWS CodePipeline to act upon.
|
default PollForThirdPartyJobsResponse |
pollForThirdPartyJobs(PollForThirdPartyJobsRequest pollForThirdPartyJobsRequest) |
Determines whether there are any third party jobs for a job worker to act on.
|
default PutActionRevisionResponse |
putActionRevision(PutActionRevisionRequest putActionRevisionRequest) |
Provides information to AWS CodePipeline about new revisions to a source.
|
default PutApprovalResultResponse |
putApprovalResult(PutApprovalResultRequest putApprovalResultRequest) |
Provides the response to a manual approval request to AWS CodePipeline.
|
default PutJobFailureResultResponse |
putJobFailureResult(PutJobFailureResultRequest putJobFailureResultRequest) |
Represents the failure of a job as returned to the pipeline by a job worker.
|
default PutJobSuccessResultResponse |
putJobSuccessResult(PutJobSuccessResultRequest putJobSuccessResultRequest) |
Represents the success of a job as returned to the pipeline by a job worker.
|
default PutThirdPartyJobFailureResultResponse |
putThirdPartyJobFailureResult(PutThirdPartyJobFailureResultRequest putThirdPartyJobFailureResultRequest) |
Represents the failure of a third party job as returned to the pipeline by a job worker.
|
default PutThirdPartyJobSuccessResultResponse |
putThirdPartyJobSuccessResult(PutThirdPartyJobSuccessResultRequest putThirdPartyJobSuccessResultRequest) |
Represents the success of a third party job as returned to the pipeline by a job worker.
|
default RetryStageExecutionResponse |
retryStageExecution(RetryStageExecutionRequest retryStageExecutionRequest) |
Resumes the pipeline execution by retrying the last failed actions in a stage.
|
static ServiceMetadata |
serviceMetadata() |
|
default StartPipelineExecutionResponse |
startPipelineExecution(StartPipelineExecutionRequest startPipelineExecutionRequest) |
Starts the specified pipeline.
|
default UpdatePipelineResponse |
updatePipeline(UpdatePipelineRequest updatePipelineRequest) |
Updates a specified pipeline with edits or changes to its structure.
|
closestatic final String SERVICE_NAME
static CodePipelineClient create()
CodePipelineClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static CodePipelineClientBuilder builder()
CodePipelineClient.default AcknowledgeJobResponse acknowledgeJob(AcknowledgeJobRequest acknowledgeJobRequest) throws ValidationException, InvalidNonceException, JobNotFoundException, SdkBaseException, SdkClientException, CodePipelineException
Returns information about a specified job and whether that job has been received by the job worker. Only used for custom actions.
acknowledgeJobRequest - Represents the input of an acknowledge job action.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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)CodePipelineException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault AcknowledgeThirdPartyJobResponse acknowledgeThirdPartyJob(AcknowledgeThirdPartyJobRequest acknowledgeThirdPartyJobRequest) throws ValidationException, InvalidNonceException, JobNotFoundException, InvalidClientTokenException, SdkBaseException, SdkClientException, CodePipelineException
Confirms a job worker has received the specified job. Only used for partner actions.
acknowledgeThirdPartyJobRequest - Represents the input of an acknowledge third party job action.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 formatSdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)CodePipelineException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreateCustomActionTypeResponse createCustomActionType(CreateCustomActionTypeRequest createCustomActionTypeRequest) throws ValidationException, LimitExceededException, SdkBaseException, SdkClientException, CodePipelineException
Creates a new custom action that can be used in all pipelines associated with the AWS account. Only used for custom actions.
createCustomActionTypeRequest - Represents the input of a create custom action operation.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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)CodePipelineException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreatePipelineResponse createPipeline(CreatePipelineRequest createPipelineRequest) throws ValidationException, PipelineNameInUseException, InvalidStageDeclarationException, InvalidActionDeclarationException, InvalidBlockerDeclarationException, InvalidStructureException, LimitExceededException, SdkBaseException, SdkClientException, CodePipelineException
Creates a pipeline.
createPipelineRequest - Represents the input of a create pipeline action.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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)CodePipelineException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteCustomActionTypeResponse deleteCustomActionType(DeleteCustomActionTypeRequest deleteCustomActionTypeRequest) throws ValidationException, SdkBaseException, SdkClientException, CodePipelineException
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.
deleteCustomActionTypeRequest - Represents the input of a delete custom action operation. The custom action will be marked as deleted.ValidationException - The validation was specified in an invalid format.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)CodePipelineException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeletePipelineResponse deletePipeline(DeletePipelineRequest deletePipelineRequest) throws ValidationException, SdkBaseException, SdkClientException, CodePipelineException
Deletes the specified pipeline.
deletePipelineRequest - Represents the input of a delete pipeline action.ValidationException - The validation was specified in an invalid format.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)CodePipelineException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DisableStageTransitionResponse disableStageTransition(DisableStageTransitionRequest disableStageTransitionRequest) throws ValidationException, PipelineNotFoundException, StageNotFoundException, SdkBaseException, SdkClientException, CodePipelineException
Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline.
disableStageTransitionRequest - Represents the input of a disable stage transition input action.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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)CodePipelineException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault EnableStageTransitionResponse enableStageTransition(EnableStageTransitionRequest enableStageTransitionRequest) throws ValidationException, PipelineNotFoundException, StageNotFoundException, SdkBaseException, SdkClientException, CodePipelineException
Enables artifacts in a pipeline to transition to a stage in a pipeline.
enableStageTransitionRequest - Represents the input of an enable stage transition action.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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)CodePipelineException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetJobDetailsResponse getJobDetails(GetJobDetailsRequest getJobDetailsRequest) throws ValidationException, JobNotFoundException, SdkBaseException, SdkClientException, CodePipelineException
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.
getJobDetailsRequest - Represents the input of a get job details action.ValidationException - The validation was specified in an invalid format.JobNotFoundException - The specified job was specified in an invalid format or cannot be found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)CodePipelineException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetPipelineResponse getPipeline(GetPipelineRequest getPipelineRequest) throws ValidationException, PipelineNotFoundException, PipelineVersionNotFoundException, SdkBaseException, SdkClientException, CodePipelineException
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.
getPipelineRequest - Represents the input of a get pipeline action.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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)CodePipelineException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetPipelineExecutionResponse getPipelineExecution(GetPipelineExecutionRequest getPipelineExecutionRequest) throws ValidationException, PipelineNotFoundException, PipelineExecutionNotFoundException, SdkBaseException, SdkClientException, CodePipelineException
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.
getPipelineExecutionRequest - Represents the input of a get pipeline execution action.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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)CodePipelineException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetPipelineStateResponse getPipelineState(GetPipelineStateRequest getPipelineStateRequest) throws ValidationException, PipelineNotFoundException, SdkBaseException, SdkClientException, CodePipelineException
Returns information about the state of a pipeline, including the stages and actions.
getPipelineStateRequest - Represents the input of a get pipeline state action.ValidationException - The validation was specified in an invalid format.PipelineNotFoundException - The specified pipeline was specified in an invalid format or cannot be found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)CodePipelineException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetThirdPartyJobDetailsResponse getThirdPartyJobDetails(GetThirdPartyJobDetailsRequest getThirdPartyJobDetailsRequest) throws JobNotFoundException, ValidationException, InvalidClientTokenException, InvalidJobException, SdkBaseException, SdkClientException, CodePipelineException
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.
getThirdPartyJobDetailsRequest - Represents the input of a get third party job details action.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 formatInvalidJobException - The specified job was specified in an invalid format or cannot be found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)CodePipelineException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListActionTypesResponse listActionTypes(ListActionTypesRequest listActionTypesRequest) throws ValidationException, InvalidNextTokenException, SdkBaseException, SdkClientException, CodePipelineException
Gets a summary of all AWS CodePipeline action types associated with your account.
listActionTypesRequest - Represents the input of a list action types action.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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)CodePipelineException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListPipelineExecutionsResponse listPipelineExecutions(ListPipelineExecutionsRequest listPipelineExecutionsRequest) throws ValidationException, PipelineNotFoundException, InvalidNextTokenException, SdkBaseException, SdkClientException, CodePipelineException
Gets a summary of the most recent executions for a pipeline.
listPipelineExecutionsRequest - Represents the input of a list pipeline executions action.ValidationException - The validation was specified in an invalid format.PipelineNotFoundException - The specified pipeline was specified in an invalid format or cannot be found.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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)CodePipelineException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListPipelinesResponse listPipelines(ListPipelinesRequest listPipelinesRequest) throws InvalidNextTokenException, SdkBaseException, SdkClientException, CodePipelineException
Gets a summary of all of the pipelines associated with your account.
listPipelinesRequest - Represents the input of a list pipelines action.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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)CodePipelineException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault PollForJobsResponse pollForJobs(PollForJobsRequest pollForJobsRequest) throws ValidationException, ActionTypeNotFoundException, SdkBaseException, SdkClientException, CodePipelineException
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.
pollForJobsRequest - Represents the input of a poll for jobs action.ValidationException - The validation was specified in an invalid format.ActionTypeNotFoundException - The specified action type cannot be found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)CodePipelineException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault PollForThirdPartyJobsResponse pollForThirdPartyJobs(PollForThirdPartyJobsRequest pollForThirdPartyJobsRequest) throws ActionTypeNotFoundException, ValidationException, SdkBaseException, SdkClientException, CodePipelineException
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.
pollForThirdPartyJobsRequest - Represents the input of a poll for third party jobs action.ActionTypeNotFoundException - The specified action type cannot be found.ValidationException - The validation was specified in an invalid format.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)CodePipelineException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault PutActionRevisionResponse putActionRevision(PutActionRevisionRequest putActionRevisionRequest) throws PipelineNotFoundException, StageNotFoundException, ActionNotFoundException, ValidationException, SdkBaseException, SdkClientException, CodePipelineException
Provides information to AWS CodePipeline about new revisions to a source.
putActionRevisionRequest - Represents the input of a put action revision action.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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)CodePipelineException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault PutApprovalResultResponse putApprovalResult(PutApprovalResultRequest putApprovalResultRequest) throws InvalidApprovalTokenException, ApprovalAlreadyCompletedException, PipelineNotFoundException, StageNotFoundException, ActionNotFoundException, ValidationException, SdkBaseException, SdkClientException, CodePipelineException
Provides the response to a manual approval request to AWS CodePipeline. Valid responses include Approved and Rejected.
putApprovalResultRequest - Represents the input of a put approval result action.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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)CodePipelineException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault PutJobFailureResultResponse putJobFailureResult(PutJobFailureResultRequest putJobFailureResultRequest) throws ValidationException, JobNotFoundException, InvalidJobStateException, SdkBaseException, SdkClientException, CodePipelineException
Represents the failure of a job as returned to the pipeline by a job worker. Only used for custom actions.
putJobFailureResultRequest - Represents the input of a put job failure result action.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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)CodePipelineException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault PutJobSuccessResultResponse putJobSuccessResult(PutJobSuccessResultRequest putJobSuccessResultRequest) throws ValidationException, JobNotFoundException, InvalidJobStateException, SdkBaseException, SdkClientException, CodePipelineException
Represents the success of a job as returned to the pipeline by a job worker. Only used for custom actions.
putJobSuccessResultRequest - Represents the input of a put job success result action.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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)CodePipelineException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault PutThirdPartyJobFailureResultResponse putThirdPartyJobFailureResult(PutThirdPartyJobFailureResultRequest putThirdPartyJobFailureResultRequest) throws ValidationException, JobNotFoundException, InvalidJobStateException, InvalidClientTokenException, SdkBaseException, SdkClientException, CodePipelineException
Represents the failure of a third party job as returned to the pipeline by a job worker. Only used for partner actions.
putThirdPartyJobFailureResultRequest - Represents the input of a third party job failure result action.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 formatSdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)CodePipelineException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault PutThirdPartyJobSuccessResultResponse putThirdPartyJobSuccessResult(PutThirdPartyJobSuccessResultRequest putThirdPartyJobSuccessResultRequest) throws ValidationException, JobNotFoundException, InvalidJobStateException, InvalidClientTokenException, SdkBaseException, SdkClientException, CodePipelineException
Represents the success of a third party job as returned to the pipeline by a job worker. Only used for partner actions.
putThirdPartyJobSuccessResultRequest - Represents the input of a put third party job success result action.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 formatSdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)CodePipelineException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault RetryStageExecutionResponse retryStageExecution(RetryStageExecutionRequest retryStageExecutionRequest) throws ValidationException, PipelineNotFoundException, StageNotFoundException, StageNotRetryableException, NotLatestPipelineExecutionException, SdkBaseException, SdkClientException, CodePipelineException
Resumes the pipeline execution by retrying the last failed actions in a stage.
retryStageExecutionRequest - Represents the input of a retry stage execution action.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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)CodePipelineException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault StartPipelineExecutionResponse startPipelineExecution(StartPipelineExecutionRequest startPipelineExecutionRequest) throws ValidationException, PipelineNotFoundException, SdkBaseException, SdkClientException, CodePipelineException
Starts the specified pipeline. Specifically, it begins processing the latest commit to the source location specified as part of the pipeline.
startPipelineExecutionRequest - Represents the input of a start pipeline execution action.ValidationException - The validation was specified in an invalid format.PipelineNotFoundException - The specified pipeline was specified in an invalid format or cannot be found.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)CodePipelineException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault UpdatePipelineResponse updatePipeline(UpdatePipelineRequest updatePipelineRequest) throws ValidationException, InvalidStageDeclarationException, InvalidActionDeclarationException, InvalidBlockerDeclarationException, InvalidStructureException, SdkBaseException, SdkClientException, CodePipelineException
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.
updatePipelineRequest - Represents the input of an update pipeline action.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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)CodePipelineException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typestatic ServiceMetadata serviceMetadata()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.