@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSCodePipeline
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSCodePipeline instead.
Overview
This is the CodePipeline API Reference. This guide provides descriptions of the actions and data types for CodePipeline. Some functionality for your pipeline can only be configured through the API. For more information, see the CodePipeline User Guide.
You can use the CodePipeline API to work with pipelines, stages, actions, and transitions.
Pipelines are models of automated release processes. Each pipeline is uniquely named, and consists of stages, actions, and transitions.
You can work with pipelines by calling:
CreatePipeline, which creates a uniquely named pipeline.
DeletePipeline, which deletes the specified pipeline.
GetPipeline, which returns information about the pipeline structure and pipeline metadata, including the pipeline Amazon Resource Name (ARN).
GetPipelineExecution, which returns information about a specific execution of a pipeline.
GetPipelineState, which returns information about the current state of the stages and actions of a pipeline.
ListActionExecutions, which returns action-level details for past executions. The details include full stage and action-level details, including individual action duration, status, any errors that occurred during the execution, and input and output artifact location details.
ListPipelines, which gets a summary of all of the pipelines associated with your account.
ListPipelineExecutions, which gets a summary of the most recent executions for a pipeline.
StartPipelineExecution, which runs the most recent revision of an artifact through the pipeline.
StopPipelineExecution, which stops the specified pipeline execution from continuing through the pipeline.
UpdatePipeline, which updates a pipeline with edits or changes to the structure of the pipeline.
Pipelines include stages. Each stage contains one or more actions that must complete before the next stage begins. A stage results in success or failure. If a stage fails, the pipeline stops at that stage and remains stopped until either a new version of an artifact appears in the source location, or a user takes action to rerun the most recent artifact through the pipeline. You can call GetPipelineState, which displays the status of a pipeline, including the status of stages in the pipeline, or GetPipeline, which returns the entire structure of the pipeline, including the stages of that pipeline. For more information about the structure of stages and actions, see CodePipeline Pipeline Structure Reference.
Pipeline stages include actions that are categorized into categories such as source or build actions performed in a stage of a pipeline. For example, you can use a source action to import artifacts into a pipeline from a source such as Amazon S3. Like stages, you do not work with actions directly in most cases, but you do define and interact with actions when working with pipeline operations such as CreatePipeline and GetPipelineState. Valid action categories are:
Source
Build
Test
Deploy
Approval
Invoke
Pipelines also include transitions, which allow the transition of artifacts from one stage to the next in a pipeline after the actions in one stage complete.
You can work with transitions by calling:
DisableStageTransition, which prevents artifacts from transitioning to the next stage in a pipeline.
EnableStageTransition, which enables transition of artifacts between stages in a pipeline.
Using the API to integrate with CodePipeline
For third-party integrators or developers who want to create their own integrations with CodePipeline, the expected sequence varies from the standard API user. To integrate with CodePipeline, developers need to work with the following items:
Jobs, which are instances of an action. For example, a job for a source action might import a revision of an artifact from a source.
You can work with jobs by calling:
AcknowledgeJob, which confirms whether a job worker has received the specified job.
GetJobDetails, which returns the details of a job.
PollForJobs, which determines whether there are any jobs to act on.
PutJobFailureResult, which provides details of a job failure.
PutJobSuccessResult, which provides details of a job success.
Third party jobs, which are instances of an action created by a partner action and integrated into CodePipeline. Partner actions are created by members of the Amazon Web Services Partner Network.
You can work with third party jobs by calling:
AcknowledgeThirdPartyJob, which confirms whether a job worker has received the specified job.
GetThirdPartyJobDetails, which requests the details of a job for a partner action.
PollForThirdPartyJobs, which determines whether there are any jobs to act on.
PutThirdPartyJobFailureResult, which provides details of a job failure.
PutThirdPartyJobSuccessResult, which provides details of a job success.
| Modifier and Type | Field and Description |
|---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
| 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 Amazon Web Services 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.
|
DeleteWebhookResult |
deleteWebhook (DeleteWebhookRequest deleteWebhookRequest)
Deletes a previously created webhook by name.
|
DeregisterWebhookWithThirdPartyResult |
deregisterWebhookWithThirdParty (DeregisterWebhookWithThirdPartyRequest deregisterWebhookWithThirdPartyRequest)
Removes the connection between the webhook that was created by CodePipeline and the external tool with events to
be detected.
|
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.
|
GetActionTypeResult |
getActionType (GetActionTypeRequest getActionTypeRequest)
Returns information about an action type created for an external provider, where the action is to be used by
customers of the external provider.
|
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.
|
ListActionExecutionsResult |
listActionExecutions (ListActionExecutionsRequest listActionExecutionsRequest)
Lists the action executions that have occurred in a pipeline.
|
ListActionTypesResult |
listActionTypes (ListActionTypesRequest listActionTypesRequest)
Gets a summary of all CodePipeline action types associated with your account.
|
ListPipelineExecutionsResult |
listPipelineExecutions (ListPipelineExecutionsRequest listPipelineExecutionsRequest)
Gets a summary of the most recent executions for a pipeline.
|
ListPipelinesResult |
listPipelines (ListPipelinesRequest listPipelinesRequest)
Gets a summary of all of the pipelines associated with your account.
|
ListRuleExecutionsResult |
listRuleExecutions (ListRuleExecutionsRequest listRuleExecutionsRequest)
Lists the rule executions that have occurred in a pipeline configured for conditions with rules.
|
ListRuleTypesResult |
listRuleTypes (ListRuleTypesRequest listRuleTypesRequest)
Lists the rules for the condition.
|
ListTagsForResourceResult |
listTagsForResource (ListTagsForResourceRequest listTagsForResourceRequest)
Gets the set of key-value pairs (metadata) that are used to manage the resource.
|
ListWebhooksResult |
listWebhooks (ListWebhooksRequest listWebhooksRequest)
Gets a listing of all the webhooks in this Amazon Web Services Region for this account.
|
OverrideStageConditionResult |
overrideStageCondition (OverrideStageConditionRequest overrideStageConditionRequest)
Used to override a stage condition.
|
PollForJobsResult |
pollForJobs (PollForJobsRequest pollForJobsRequest)
Returns information about any jobs for CodePipeline to act on.
|
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 CodePipeline about new revisions to a source.
|
PutApprovalResultResult |
putApprovalResult (PutApprovalResultRequest putApprovalResultRequest)
Provides the response to a manual approval request to 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.
|
PutWebhookResult |
putWebhook (PutWebhookRequest putWebhookRequest)
Defines a webhook and returns a unique webhook URL generated by CodePipeline.
|
RegisterWebhookWithThirdPartyResult |
registerWebhookWithThirdParty (RegisterWebhookWithThirdPartyRequest registerWebhookWithThirdPartyRequest)
Configures a connection between the webhook that was created and the external tool with events to be detected.
|
RetryStageExecutionResult |
retryStageExecution (RetryStageExecutionRequest retryStageExecutionRequest)
You can retry a stage that has failed without having to run a pipeline again from the beginning.
|
RollbackStageResult |
rollbackStage (RollbackStageRequest rollbackStageRequest)
Rolls back a stage execution.
|
void |
setEndpoint (String endpoint)
Deprecated.
use
AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for
example:
builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion)); |
void |
setRegion (Region region)
Deprecated.
use
AwsClientBuilder#setRegion(String) |
void |
shutdown ()
Shuts down this client object, releasing any resources that might be held open.
|
StartPipelineExecutionResult |
startPipelineExecution (StartPipelineExecutionRequest startPipelineExecutionRequest)
Starts the specified pipeline.
|
StopPipelineExecutionResult |
stopPipelineExecution (StopPipelineExecutionRequest stopPipelineExecutionRequest)
Stops the specified pipeline execution.
|
TagResourceResult |
tagResource (TagResourceRequest tagResourceRequest)
Adds to or modifies the tags of the given resource.
|
UntagResourceResult |
untagResource (UntagResourceRequest untagResourceRequest)
Removes tags from an Amazon Web Services resource.
|
UpdateActionTypeResult |
updateActionType (UpdateActionTypeRequest updateActionTypeRequest)
Updates an action type that was created with any supported integration model, where the action type is to be used
by customers of the action type provider.
|
UpdatePipelineResult |
updatePipeline (UpdatePipelineRequest updatePipelineRequest)
Updates a specified pipeline with edits or changes to its structure.
|
static final String ENDPOINT_PREFIX
@Deprecated void setEndpoint(String endpoint)
AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for
example:
builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
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: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint
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.
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.@Deprecated void setRegion(Region region)
AwsClientBuilder#setRegion(String)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.
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.Region.getRegion(com.amazonaws.regions.Regions),
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration),
Region.isServiceSupported(String) AcknowledgeJobResult acknowledgeJob(AcknowledgeJobRequest acknowledgeJobRequest)
Returns information about a specified job and whether that job has been received by the job worker. Used for custom actions only.
acknowledgeJobRequest - Represents the input of an AcknowledgeJob action.ValidationException - The validation was specified in an invalid format.InvalidNonceException - The nonce was specified in an invalid format.JobNotFoundException - The job was specified in an invalid format or cannot be found.AcknowledgeThirdPartyJobResult acknowledgeThirdPartyJob(AcknowledgeThirdPartyJobRequest acknowledgeThirdPartyJobRequest)
Confirms a job worker has received the specified job. Used for partner actions only.
acknowledgeThirdPartyJobRequest - Represents the input of an AcknowledgeThirdPartyJob action.ValidationException - The validation was specified in an invalid format.InvalidNonceException - The nonce was specified in an invalid format.JobNotFoundException - The job was specified in an invalid format or cannot be found.InvalidClientTokenException - The client token was specified in an invalid formatCreateCustomActionTypeResult createCustomActionType(CreateCustomActionTypeRequest createCustomActionTypeRequest)
Creates a new custom action that can be used in all pipelines associated with the Amazon Web Services account. Only used for custom actions.
createCustomActionTypeRequest - Represents the input of a CreateCustomActionType operation.ValidationException - The validation was specified in an invalid format.LimitExceededException - The number of pipelines associated with the Amazon Web Services account has exceeded the limit allowed
for the account.TooManyTagsException - The tags limit for a resource has been exceeded.InvalidTagsException - The specified resource tags are invalid.ConcurrentModificationException - Unable to modify the tag due to a simultaneous update request.CreatePipelineResult createPipeline(CreatePipelineRequest createPipelineRequest)
Creates a pipeline.
In the pipeline structure, you must include either artifactStore or artifactStores in
your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use
artifactStores.
createPipelineRequest - Represents the input of a CreatePipeline action.ValidationException - The validation was specified in an invalid format.PipelineNameInUseException - The specified pipeline name is already in use.InvalidStageDeclarationException - The stage declaration was specified in an invalid format.InvalidActionDeclarationException - The action declaration was specified in an invalid format.InvalidBlockerDeclarationException - Reserved for future use.InvalidStructureException - The structure was specified in an invalid format.LimitExceededException - The number of pipelines associated with the Amazon Web Services account has exceeded the limit allowed
for the account.TooManyTagsException - The tags limit for a resource has been exceeded.InvalidTagsException - The specified resource tags are invalid.ConcurrentModificationException - Unable to modify the tag due to a simultaneous update request.DeleteCustomActionTypeResult deleteCustomActionType(DeleteCustomActionTypeRequest deleteCustomActionTypeRequest)
Marks a custom action as deleted. PollForJobs for the custom action fails after the action is marked
for deletion. Used for custom actions only.
To re-create a custom action after it has been deleted you must use a string in the version field that has never been used before. This string can be an incremented version number, for example. To restore a deleted custom action, use a JSON file that is identical to the deleted action, including the original string in the version field.
deleteCustomActionTypeRequest - Represents the input of a DeleteCustomActionType operation. The custom action will be marked
as deleted.ValidationException - The validation was specified in an invalid format.ConcurrentModificationException - Unable to modify the tag due to a simultaneous update request.DeletePipelineResult deletePipeline(DeletePipelineRequest deletePipelineRequest)
Deletes the specified pipeline.
deletePipelineRequest - Represents the input of a DeletePipeline action.ValidationException - The validation was specified in an invalid format.ConcurrentModificationException - Unable to modify the tag due to a simultaneous update request.DeleteWebhookResult deleteWebhook(DeleteWebhookRequest deleteWebhookRequest)
Deletes a previously created webhook by name. Deleting the webhook stops CodePipeline from starting a pipeline every time an external event occurs. The API returns successfully when trying to delete a webhook that is already deleted. If a deleted webhook is re-created by calling PutWebhook with the same name, it will have a different URL.
deleteWebhookRequest - ValidationException - The validation was specified in an invalid format.ConcurrentModificationException - Unable to modify the tag due to a simultaneous update request.DeregisterWebhookWithThirdPartyResult deregisterWebhookWithThirdParty(DeregisterWebhookWithThirdPartyRequest deregisterWebhookWithThirdPartyRequest)
Removes the connection between the webhook that was created by CodePipeline and the external tool with events to be detected. Currently supported only for webhooks that target an action type of GitHub.
deregisterWebhookWithThirdPartyRequest - ValidationException - The validation was specified in an invalid format.WebhookNotFoundException - The specified webhook was entered in an invalid format or cannot be found.DisableStageTransitionResult disableStageTransition(DisableStageTransitionRequest disableStageTransitionRequest)
Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline.
disableStageTransitionRequest - Represents the input of a DisableStageTransition action.ValidationException - The validation was specified in an invalid format.PipelineNotFoundException - The pipeline was specified in an invalid format or cannot be found.StageNotFoundException - The stage was specified in an invalid format or cannot be found.EnableStageTransitionResult enableStageTransition(EnableStageTransitionRequest enableStageTransitionRequest)
Enables artifacts in a pipeline to transition to a stage in a pipeline.
enableStageTransitionRequest - Represents the input of an EnableStageTransition action.ValidationException - The validation was specified in an invalid format.PipelineNotFoundException - The pipeline was specified in an invalid format or cannot be found.StageNotFoundException - The stage was specified in an invalid format or cannot be found.GetActionTypeResult getActionType(GetActionTypeRequest getActionTypeRequest)
Returns information about an action type created for an external provider, where the action is to be used by customers of the external provider. The action can be created with any supported integration model.
getActionTypeRequest - ActionTypeNotFoundException - The specified action type cannot be found.ValidationException - The validation was specified in an invalid format.GetJobDetailsResult getJobDetails(GetJobDetailsRequest getJobDetailsRequest)
Returns information about a job. Used for custom actions only.
When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.
getJobDetailsRequest - Represents the input of a GetJobDetails action.ValidationException - The validation was specified in an invalid format.JobNotFoundException - The job was specified in an invalid format or cannot be found.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.
getPipelineRequest - Represents the input of a GetPipeline action.ValidationException - The validation was specified in an invalid format.PipelineNotFoundException - The pipeline was specified in an invalid format or cannot be found.PipelineVersionNotFoundException - The pipeline version was specified in an invalid format or cannot be found.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.
getPipelineExecutionRequest - Represents the input of a GetPipelineExecution action.ValidationException - The validation was specified in an invalid format.PipelineNotFoundException - The 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.GetPipelineStateResult getPipelineState(GetPipelineStateRequest getPipelineStateRequest)
Returns information about the state of a pipeline, including the stages and actions.
Values returned in the revisionId and revisionUrl fields indicate the source revision
information, such as the commit ID, for the current state.
getPipelineStateRequest - Represents the input of a GetPipelineState action.ValidationException - The validation was specified in an invalid format.PipelineNotFoundException - The pipeline was specified in an invalid format or cannot be found.GetThirdPartyJobDetailsResult getThirdPartyJobDetails(GetThirdPartyJobDetailsRequest getThirdPartyJobDetailsRequest)
Requests the details of a job for a third party action. Used for partner actions only.
When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.
getThirdPartyJobDetailsRequest - Represents the input of a GetThirdPartyJobDetails action.JobNotFoundException - The 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 job was specified in an invalid format or cannot be found.ListActionExecutionsResult listActionExecutions(ListActionExecutionsRequest listActionExecutionsRequest)
Lists the action executions that have occurred in a pipeline.
listActionExecutionsRequest - ValidationException - The validation was specified in an invalid format.PipelineNotFoundException - The 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 provide is the token
returned by a previous call.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.ListActionTypesResult listActionTypes(ListActionTypesRequest listActionTypesRequest)
Gets a summary of all CodePipeline action types associated with your account.
listActionTypesRequest - Represents the input of a ListActionTypes 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 provide is the token
returned by a previous call.ListPipelineExecutionsResult listPipelineExecutions(ListPipelineExecutionsRequest listPipelineExecutionsRequest)
Gets a summary of the most recent executions for a pipeline.
When applying the filter for pipeline executions that have succeeded in the stage, the operation returns all executions in the current pipeline version beginning on February 1, 2024.
listPipelineExecutionsRequest - Represents the input of a ListPipelineExecutions action.ValidationException - The validation was specified in an invalid format.PipelineNotFoundException - The 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 provide is the token
returned by a previous call.ListPipelinesResult listPipelines(ListPipelinesRequest listPipelinesRequest)
Gets a summary of all of the pipelines associated with your account.
listPipelinesRequest - Represents the input of a ListPipelines 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 provide is the token
returned by a previous call.ListRuleExecutionsResult listRuleExecutions(ListRuleExecutionsRequest listRuleExecutionsRequest)
Lists the rule executions that have occurred in a pipeline configured for conditions with rules.
listRuleExecutionsRequest - ValidationException - The validation was specified in an invalid format.PipelineNotFoundException - The 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 provide is the token
returned by a previous call.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.ListRuleTypesResult listRuleTypes(ListRuleTypesRequest listRuleTypesRequest)
Lists the rules for the condition.
listRuleTypesRequest - 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 provide is the token
returned by a previous call.ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Gets the set of key-value pairs (metadata) that are used to manage the resource.
listTagsForResourceRequest - ValidationException - The validation was specified in an invalid format.ResourceNotFoundException - The resource was specified in an invalid format.InvalidNextTokenException - The next token was specified in an invalid format. Make sure that the next token you provide is the token
returned by a previous call.InvalidArnException - The specified resource ARN is invalid.ListWebhooksResult listWebhooks(ListWebhooksRequest listWebhooksRequest)
Gets a listing of all the webhooks in this Amazon Web Services Region for this account. The output lists all webhooks and includes the webhook URL and ARN and the configuration for each webhook.
listWebhooksRequest - 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 provide is the token
returned by a previous call.OverrideStageConditionResult overrideStageCondition(OverrideStageConditionRequest overrideStageConditionRequest)
Used to override a stage condition.
overrideStageConditionRequest - ValidationException - The validation was specified in an invalid format.ConflictException - Your request cannot be handled because the pipeline is busy handling ongoing activities. Try again later.PipelineNotFoundException - The pipeline was specified in an invalid format or cannot be found.StageNotFoundException - The stage was specified in an invalid format or cannot be found.ConditionNotOverridableException - Unable to override because the condition does not allow overrides.NotLatestPipelineExecutionException - The stage has failed in a later run of the pipeline and the pipelineExecutionId associated
with the request is out of date.ConcurrentPipelineExecutionsLimitExceededException - The pipeline has reached the limit for concurrent pipeline executions.PollForJobsResult pollForJobs(PollForJobsRequest pollForJobsRequest)
Returns information about any jobs for CodePipeline to act on. PollForJobs is valid only for action
types with "Custom" in the owner field. If the action type contains AWS or ThirdParty
in the owner field, the PollForJobs action returns an error.
When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.
pollForJobsRequest - Represents the input of a PollForJobs action.ValidationException - The validation was specified in an invalid format.ActionTypeNotFoundException - The specified action type cannot be found.PollForThirdPartyJobsResult pollForThirdPartyJobs(PollForThirdPartyJobsRequest pollForThirdPartyJobsRequest)
Determines whether there are any third party jobs for a job worker to act on. Used for partner actions only.
When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts.
pollForThirdPartyJobsRequest - Represents the input of a PollForThirdPartyJobs action.ActionTypeNotFoundException - The specified action type cannot be found.ValidationException - The validation was specified in an invalid format.PutActionRevisionResult putActionRevision(PutActionRevisionRequest putActionRevisionRequest)
Provides information to CodePipeline about new revisions to a source.
putActionRevisionRequest - Represents the input of a PutActionRevision action.PipelineNotFoundException - The pipeline was specified in an invalid format or cannot be found.StageNotFoundException - The 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.ConcurrentPipelineExecutionsLimitExceededException - The pipeline has reached the limit for concurrent pipeline executions.PutApprovalResultResult putApprovalResult(PutApprovalResultRequest putApprovalResultRequest)
Provides the response to a manual approval request to CodePipeline. Valid responses include Approved and Rejected.
putApprovalResultRequest - Represents the input of a PutApprovalResult action.InvalidApprovalTokenException - The approval request already received a response or has expired.ApprovalAlreadyCompletedException - The approval action has already been approved or rejected.PipelineNotFoundException - The pipeline was specified in an invalid format or cannot be found.StageNotFoundException - The 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.PutJobFailureResultResult putJobFailureResult(PutJobFailureResultRequest putJobFailureResultRequest)
Represents the failure of a job as returned to the pipeline by a job worker. Used for custom actions only.
putJobFailureResultRequest - Represents the input of a PutJobFailureResult action.ValidationException - The validation was specified in an invalid format.JobNotFoundException - The job was specified in an invalid format or cannot be found.InvalidJobStateException - The job state was specified in an invalid format.PutJobSuccessResultResult putJobSuccessResult(PutJobSuccessResultRequest putJobSuccessResultRequest)
Represents the success of a job as returned to the pipeline by a job worker. Used for custom actions only.
putJobSuccessResultRequest - Represents the input of a PutJobSuccessResult action.ValidationException - The validation was specified in an invalid format.JobNotFoundException - The job was specified in an invalid format or cannot be found.InvalidJobStateException - The job state was specified in an invalid format.OutputVariablesSizeExceededException - Exceeded the total size limit for all variables in the pipeline.PutThirdPartyJobFailureResultResult putThirdPartyJobFailureResult(PutThirdPartyJobFailureResultRequest putThirdPartyJobFailureResultRequest)
Represents the failure of a third party job as returned to the pipeline by a job worker. Used for partner actions only.
putThirdPartyJobFailureResultRequest - Represents the input of a PutThirdPartyJobFailureResult action.ValidationException - The validation was specified in an invalid format.JobNotFoundException - The job was specified in an invalid format or cannot be found.InvalidJobStateException - The job state was specified in an invalid format.InvalidClientTokenException - The client token was specified in an invalid formatPutThirdPartyJobSuccessResultResult putThirdPartyJobSuccessResult(PutThirdPartyJobSuccessResultRequest putThirdPartyJobSuccessResultRequest)
Represents the success of a third party job as returned to the pipeline by a job worker. Used for partner actions only.
putThirdPartyJobSuccessResultRequest - Represents the input of a PutThirdPartyJobSuccessResult action.ValidationException - The validation was specified in an invalid format.JobNotFoundException - The job was specified in an invalid format or cannot be found.InvalidJobStateException - The job state was specified in an invalid format.InvalidClientTokenException - The client token was specified in an invalid formatPutWebhookResult putWebhook(PutWebhookRequest putWebhookRequest)
Defines a webhook and returns a unique webhook URL generated by CodePipeline. This URL can be supplied to third party source hosting providers to call every time there's a code change. When CodePipeline receives a POST request on this URL, the pipeline defined in the webhook is started as long as the POST request satisfied the authentication and filtering requirements supplied when defining the webhook. RegisterWebhookWithThirdParty and DeregisterWebhookWithThirdParty APIs can be used to automatically configure supported third parties to call the generated webhook URL.
putWebhookRequest - ValidationException - The validation was specified in an invalid format.LimitExceededException - The number of pipelines associated with the Amazon Web Services account has exceeded the limit allowed
for the account.InvalidWebhookFilterPatternException - The specified event filter rule is in an invalid format.InvalidWebhookAuthenticationParametersException - The specified authentication type is in an invalid format.PipelineNotFoundException - The pipeline was specified in an invalid format or cannot be found.TooManyTagsException - The tags limit for a resource has been exceeded.InvalidTagsException - The specified resource tags are invalid.ConcurrentModificationException - Unable to modify the tag due to a simultaneous update request.RegisterWebhookWithThirdPartyResult registerWebhookWithThirdParty(RegisterWebhookWithThirdPartyRequest registerWebhookWithThirdPartyRequest)
Configures a connection between the webhook that was created and the external tool with events to be detected.
registerWebhookWithThirdPartyRequest - ValidationException - The validation was specified in an invalid format.WebhookNotFoundException - The specified webhook was entered in an invalid format or cannot be found.RetryStageExecutionResult retryStageExecution(RetryStageExecutionRequest retryStageExecutionRequest)
You can retry a stage that has failed without having to run a pipeline again from the beginning. You do this by either retrying the failed actions in a stage or by retrying all actions in the stage starting from the first action in the stage. When you retry the failed actions in a stage, all actions that are still in progress continue working, and failed actions are triggered again. When you retry a failed stage from the first action in the stage, the stage cannot have any actions in progress. Before a stage can be retried, it must either have all actions failed or some actions failed and some succeeded.
retryStageExecutionRequest - Represents the input of a RetryStageExecution action.ValidationException - The validation was specified in an invalid format.ConflictException - Your request cannot be handled because the pipeline is busy handling ongoing activities. Try again later.PipelineNotFoundException - The pipeline was specified in an invalid format or cannot be found.StageNotFoundException - The stage was specified in an invalid format or cannot be found.StageNotRetryableException - Unable to retry. The pipeline structure or stage state might have changed while actions awaited retry, or
the stage contains no failed actions.NotLatestPipelineExecutionException - The stage has failed in a later run of the pipeline and the pipelineExecutionId associated
with the request is out of date.ConcurrentPipelineExecutionsLimitExceededException - The pipeline has reached the limit for concurrent pipeline executions.RollbackStageResult rollbackStage(RollbackStageRequest rollbackStageRequest)
Rolls back a stage execution.
rollbackStageRequest - ValidationException - The validation was specified in an invalid format.ConflictException - Your request cannot be handled because the pipeline is busy handling ongoing activities. Try again later.PipelineNotFoundException - The 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.PipelineExecutionOutdatedException - The specified pipeline execution is outdated and cannot be used as a target pipeline execution for
rollback.StageNotFoundException - The stage was specified in an invalid format or cannot be found.UnableToRollbackStageException - Unable to roll back the stage. The cause might be if the pipeline version has changed since the target
pipeline execution was deployed, the stage is currently running, or an incorrect target pipeline
execution ID was provided.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.
startPipelineExecutionRequest - Represents the input of a StartPipelineExecution action.ValidationException - The validation was specified in an invalid format.ConflictException - Your request cannot be handled because the pipeline is busy handling ongoing activities. Try again later.PipelineNotFoundException - The pipeline was specified in an invalid format or cannot be found.ConcurrentPipelineExecutionsLimitExceededException - The pipeline has reached the limit for concurrent pipeline executions.StopPipelineExecutionResult stopPipelineExecution(StopPipelineExecutionRequest stopPipelineExecutionRequest)
Stops the specified pipeline execution. You choose to either stop the pipeline execution by completing
in-progress actions without starting subsequent actions, or by abandoning in-progress actions. While completing
or abandoning in-progress actions, the pipeline execution is in a Stopping state. After all
in-progress actions are completed or abandoned, the pipeline execution is in a Stopped state.
stopPipelineExecutionRequest - ValidationException - The validation was specified in an invalid format.ConflictException - Your request cannot be handled because the pipeline is busy handling ongoing activities. Try again later.PipelineNotFoundException - The pipeline was specified in an invalid format or cannot be found.PipelineExecutionNotStoppableException - Unable to stop the pipeline execution. The execution might already be in a Stopped state, or
it might no longer be in progress.DuplicatedStopRequestException - The pipeline execution is already in a Stopping state. If you already chose to stop and
wait, you cannot make that request again. You can choose to stop and abandon now, but be aware that this
option can lead to failed tasks or out of sequence tasks. If you already chose to stop and abandon, you
cannot make that request again.TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.
tagResourceRequest - ValidationException - The validation was specified in an invalid format.ResourceNotFoundException - The resource was specified in an invalid format.InvalidArnException - The specified resource ARN is invalid.TooManyTagsException - The tags limit for a resource has been exceeded.InvalidTagsException - The specified resource tags are invalid.ConcurrentModificationException - Unable to modify the tag due to a simultaneous update request.UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
Removes tags from an Amazon Web Services resource.
untagResourceRequest - ValidationException - The validation was specified in an invalid format.ResourceNotFoundException - The resource was specified in an invalid format.InvalidArnException - The specified resource ARN is invalid.InvalidTagsException - The specified resource tags are invalid.ConcurrentModificationException - Unable to modify the tag due to a simultaneous update request.UpdateActionTypeResult updateActionType(UpdateActionTypeRequest updateActionTypeRequest)
Updates an action type that was created with any supported integration model, where the action type is to be used
by customers of the action type provider. Use a JSON file with the action definition and
UpdateActionType to provide the full structure.
updateActionTypeRequest - RequestFailedException - The request failed because of an unknown error, exception, or failure.ValidationException - The validation was specified in an invalid format.ActionTypeNotFoundException - The specified action type cannot be found.UpdatePipelineResult updatePipeline(UpdatePipelineRequest updatePipelineRequest)
Updates a specified pipeline with edits or changes to its structure. Use a JSON file with the pipeline structure
and UpdatePipeline to provide the full structure of the pipeline. Updating the pipeline increases
the version number of the pipeline by 1.
updatePipelineRequest - Represents the input of an UpdatePipeline action.ValidationException - The validation was specified in an invalid format.InvalidStageDeclarationException - The stage declaration was specified in an invalid format.InvalidActionDeclarationException - The action declaration was specified in an invalid format.InvalidBlockerDeclarationException - Reserved for future use.InvalidStructureException - The structure was specified in an invalid format.LimitExceededException - The number of pipelines associated with the Amazon Web Services account has exceeded the limit allowed
for the account.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
request - The originally executed request.