@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSCodePipelineClient extends AmazonWebServiceClient implements AWSCodePipeline
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 can only be configured through the API. For more information, see the AWS CodePipeline User Guide.
You can use the AWS 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 AWS 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 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. To integrate with AWS 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 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 on.
PutThirdPartyJobFailureResult, which provides details of a job failure.
PutThirdPartyJobSuccessResult, which provides details of a job success.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
Constructor and Description |
---|
AWSCodePipelineClient()
Deprecated.
|
AWSCodePipelineClient(AWSCredentials awsCredentials)
Deprecated.
use
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example:
AWSCodePipelineClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build(); |
AWSCodePipelineClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
|
AWSCodePipelineClient(AWSCredentialsProvider awsCredentialsProvider)
Deprecated.
|
AWSCodePipelineClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
|
AWSCodePipelineClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
|
AWSCodePipelineClient(ClientConfiguration clientConfiguration)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
AcknowledgeJobResult |
acknowledgeJob(AcknowledgeJobRequest request)
Returns information about a specified job and whether that job has been received by the job worker.
|
AcknowledgeThirdPartyJobResult |
acknowledgeThirdPartyJob(AcknowledgeThirdPartyJobRequest request)
Confirms a job worker has received the specified job.
|
static AWSCodePipelineClientBuilder |
builder() |
CreateCustomActionTypeResult |
createCustomActionType(CreateCustomActionTypeRequest request)
Creates a new custom action that can be used in all pipelines associated with the AWS account.
|
CreatePipelineResult |
createPipeline(CreatePipelineRequest request)
Creates a pipeline.
|
DeleteCustomActionTypeResult |
deleteCustomActionType(DeleteCustomActionTypeRequest request)
Marks a custom action as deleted.
|
DeletePipelineResult |
deletePipeline(DeletePipelineRequest request)
Deletes the specified pipeline.
|
DeleteWebhookResult |
deleteWebhook(DeleteWebhookRequest request)
Deletes a previously created webhook by name.
|
DeregisterWebhookWithThirdPartyResult |
deregisterWebhookWithThirdParty(DeregisterWebhookWithThirdPartyRequest request)
Removes the connection between the webhook that was created by CodePipeline and the external tool with events to
be detected.
|
DisableStageTransitionResult |
disableStageTransition(DisableStageTransitionRequest request)
Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline.
|
EnableStageTransitionResult |
enableStageTransition(EnableStageTransitionRequest request)
Enables artifacts in a pipeline to transition to a stage in a pipeline.
|
GetActionTypeResult |
getActionType(GetActionTypeRequest request)
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 request)
Returns information about a job.
|
GetPipelineResult |
getPipeline(GetPipelineRequest request)
Returns the metadata, structure, stages, and actions of a pipeline.
|
GetPipelineExecutionResult |
getPipelineExecution(GetPipelineExecutionRequest request)
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 request)
Returns information about the state of a pipeline, including the stages and actions.
|
GetThirdPartyJobDetailsResult |
getThirdPartyJobDetails(GetThirdPartyJobDetailsRequest request)
Requests the details of a job for a third party action.
|
ListActionExecutionsResult |
listActionExecutions(ListActionExecutionsRequest request)
Lists the action executions that have occurred in a pipeline.
|
ListActionTypesResult |
listActionTypes(ListActionTypesRequest request)
Gets a summary of all AWS CodePipeline action types associated with your account.
|
ListPipelineExecutionsResult |
listPipelineExecutions(ListPipelineExecutionsRequest request)
Gets a summary of the most recent executions for a pipeline.
|
ListPipelinesResult |
listPipelines(ListPipelinesRequest request)
Gets a summary of all of the pipelines associated with your account.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
Gets the set of key-value pairs (metadata) that are used to manage the resource.
|
ListWebhooksResult |
listWebhooks(ListWebhooksRequest request)
Gets a listing of all the webhooks in this AWS Region for this account.
|
PollForJobsResult |
pollForJobs(PollForJobsRequest request)
Returns information about any jobs for AWS CodePipeline to act on.
|
PollForThirdPartyJobsResult |
pollForThirdPartyJobs(PollForThirdPartyJobsRequest request)
Determines whether there are any third party jobs for a job worker to act on.
|
PutActionRevisionResult |
putActionRevision(PutActionRevisionRequest request)
Provides information to AWS CodePipeline about new revisions to a source.
|
PutApprovalResultResult |
putApprovalResult(PutApprovalResultRequest request)
Provides the response to a manual approval request to AWS CodePipeline.
|
PutJobFailureResultResult |
putJobFailureResult(PutJobFailureResultRequest request)
Represents the failure of a job as returned to the pipeline by a job worker.
|
PutJobSuccessResultResult |
putJobSuccessResult(PutJobSuccessResultRequest request)
Represents the success of a job as returned to the pipeline by a job worker.
|
PutThirdPartyJobFailureResultResult |
putThirdPartyJobFailureResult(PutThirdPartyJobFailureResultRequest request)
Represents the failure of a third party job as returned to the pipeline by a job worker.
|
PutThirdPartyJobSuccessResultResult |
putThirdPartyJobSuccessResult(PutThirdPartyJobSuccessResultRequest request)
Represents the success of a third party job as returned to the pipeline by a job worker.
|
PutWebhookResult |
putWebhook(PutWebhookRequest request)
Defines a webhook and returns a unique webhook URL generated by CodePipeline.
|
RegisterWebhookWithThirdPartyResult |
registerWebhookWithThirdParty(RegisterWebhookWithThirdPartyRequest request)
Configures a connection between the webhook that was created and the external tool with events to be detected.
|
RetryStageExecutionResult |
retryStageExecution(RetryStageExecutionRequest request)
Resumes the pipeline execution by retrying the last failed actions in a stage.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held
open.
|
StartPipelineExecutionResult |
startPipelineExecution(StartPipelineExecutionRequest request)
Starts the specified pipeline.
|
StopPipelineExecutionResult |
stopPipelineExecution(StopPipelineExecutionRequest request)
Stops the specified pipeline execution.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Adds to or modifies the tags of the given resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Removes tags from an AWS resource.
|
UpdateActionTypeResult |
updateActionType(UpdateActionTypeRequest request)
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 request)
Updates a specified pipeline with edits or changes to its structure.
|
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
setEndpoint, setRegion
@Deprecated public AWSCodePipelineClient()
AWSCodePipelineClientBuilder.defaultClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain
@Deprecated public AWSCodePipelineClient(ClientConfiguration clientConfiguration)
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration
- The client configuration options controlling how this client connects to CodePipeline (ex: proxy settings,
retry counts, etc.).DefaultAWSCredentialsProviderChain
@Deprecated public AWSCodePipelineClient(AWSCredentials awsCredentials)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
for example:
AWSCodePipelineClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.@Deprecated public AWSCodePipelineClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to CodePipeline (ex: proxy settings,
retry counts, etc.).@Deprecated public AWSCodePipelineClient(AWSCredentialsProvider awsCredentialsProvider)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.@Deprecated public AWSCodePipelineClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to CodePipeline (ex: proxy settings,
retry counts, etc.).@Deprecated public AWSCodePipelineClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
and
AwsClientBuilder.withMetricsCollector(RequestMetricCollector)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to CodePipeline (ex: proxy settings,
retry counts, etc.).requestMetricCollector
- optional request metric collectorpublic static AWSCodePipelineClientBuilder builder()
public AcknowledgeJobResult acknowledgeJob(AcknowledgeJobRequest request)
Returns information about a specified job and whether that job has been received by the job worker. Used for custom actions only.
acknowledgeJob
in interface AWSCodePipeline
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.public AcknowledgeThirdPartyJobResult acknowledgeThirdPartyJob(AcknowledgeThirdPartyJobRequest request)
Confirms a job worker has received the specified job. Used for partner actions only.
acknowledgeThirdPartyJob
in interface AWSCodePipeline
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 formatpublic CreateCustomActionTypeResult createCustomActionType(CreateCustomActionTypeRequest request)
Creates a new custom action that can be used in all pipelines associated with the AWS account. Only used for custom actions.
createCustomActionType
in interface AWSCodePipeline
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 AWS 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.public CreatePipelineResult createPipeline(CreatePipelineRequest request)
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
.
createPipeline
in interface AWSCodePipeline
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 AWS 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.public DeleteCustomActionTypeResult deleteCustomActionType(DeleteCustomActionTypeRequest request)
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.
deleteCustomActionType
in interface AWSCodePipeline
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.public DeletePipelineResult deletePipeline(DeletePipelineRequest request)
Deletes the specified pipeline.
deletePipeline
in interface AWSCodePipeline
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.public DeleteWebhookResult deleteWebhook(DeleteWebhookRequest request)
Deletes a previously created webhook by name. Deleting the webhook stops AWS 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.
deleteWebhook
in interface AWSCodePipeline
deleteWebhookRequest
- ValidationException
- The validation was specified in an invalid format.ConcurrentModificationException
- Unable to modify the tag due to a simultaneous update request.public DeregisterWebhookWithThirdPartyResult deregisterWebhookWithThirdParty(DeregisterWebhookWithThirdPartyRequest request)
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.
deregisterWebhookWithThirdParty
in interface AWSCodePipeline
deregisterWebhookWithThirdPartyRequest
- ValidationException
- The validation was specified in an invalid format.WebhookNotFoundException
- The specified webhook was entered in an invalid format or cannot be found.public DisableStageTransitionResult disableStageTransition(DisableStageTransitionRequest request)
Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline.
disableStageTransition
in interface AWSCodePipeline
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.public EnableStageTransitionResult enableStageTransition(EnableStageTransitionRequest request)
Enables artifacts in a pipeline to transition to a stage in a pipeline.
enableStageTransition
in interface AWSCodePipeline
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.public GetActionTypeResult getActionType(GetActionTypeRequest request)
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.
getActionType
in interface AWSCodePipeline
getActionTypeRequest
- ActionTypeNotFoundException
- The specified action type cannot be found.ValidationException
- The validation was specified in an invalid format.public GetJobDetailsResult getJobDetails(GetJobDetailsRequest request)
Returns information about a job. Used for custom actions only.
When this API is called, AWS 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.
getJobDetails
in interface AWSCodePipeline
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.public GetPipelineResult getPipeline(GetPipelineRequest request)
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.
getPipeline
in interface AWSCodePipeline
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.public GetPipelineExecutionResult getPipelineExecution(GetPipelineExecutionRequest request)
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.
getPipelineExecution
in interface AWSCodePipeline
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.public GetPipelineStateResult getPipelineState(GetPipelineStateRequest request)
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.
getPipelineState
in interface AWSCodePipeline
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.public GetThirdPartyJobDetailsResult getThirdPartyJobDetails(GetThirdPartyJobDetailsRequest request)
Requests the details of a job for a third party action. Used for partner actions only.
When this API is called, AWS 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.
getThirdPartyJobDetails
in interface AWSCodePipeline
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.public ListActionExecutionsResult listActionExecutions(ListActionExecutionsRequest request)
Lists the action executions that have occurred in a pipeline.
listActionExecutions
in interface AWSCodePipeline
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.public ListActionTypesResult listActionTypes(ListActionTypesRequest request)
Gets a summary of all AWS CodePipeline action types associated with your account.
listActionTypes
in interface AWSCodePipeline
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.public ListPipelineExecutionsResult listPipelineExecutions(ListPipelineExecutionsRequest request)
Gets a summary of the most recent executions for a pipeline.
listPipelineExecutions
in interface AWSCodePipeline
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.public ListPipelinesResult listPipelines(ListPipelinesRequest request)
Gets a summary of all of the pipelines associated with your account.
listPipelines
in interface AWSCodePipeline
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.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
Gets the set of key-value pairs (metadata) that are used to manage the resource.
listTagsForResource
in interface AWSCodePipeline
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.public ListWebhooksResult listWebhooks(ListWebhooksRequest request)
Gets a listing of all the webhooks in this AWS Region for this account. The output lists all webhooks and includes the webhook URL and ARN and the configuration for each webhook.
listWebhooks
in interface AWSCodePipeline
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.public PollForJobsResult pollForJobs(PollForJobsRequest request)
Returns information about any jobs for AWS 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, AWS 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.
pollForJobs
in interface AWSCodePipeline
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.public PollForThirdPartyJobsResult pollForThirdPartyJobs(PollForThirdPartyJobsRequest request)
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, AWS 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.
pollForThirdPartyJobs
in interface AWSCodePipeline
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.public PutActionRevisionResult putActionRevision(PutActionRevisionRequest request)
Provides information to AWS CodePipeline about new revisions to a source.
putActionRevision
in interface AWSCodePipeline
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.public PutApprovalResultResult putApprovalResult(PutApprovalResultRequest request)
Provides the response to a manual approval request to AWS CodePipeline. Valid responses include Approved and Rejected.
putApprovalResult
in interface AWSCodePipeline
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.public PutJobFailureResultResult putJobFailureResult(PutJobFailureResultRequest request)
Represents the failure of a job as returned to the pipeline by a job worker. Used for custom actions only.
putJobFailureResult
in interface AWSCodePipeline
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.public PutJobSuccessResultResult putJobSuccessResult(PutJobSuccessResultRequest request)
Represents the success of a job as returned to the pipeline by a job worker. Used for custom actions only.
putJobSuccessResult
in interface AWSCodePipeline
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.public PutThirdPartyJobFailureResultResult putThirdPartyJobFailureResult(PutThirdPartyJobFailureResultRequest request)
Represents the failure of a third party job as returned to the pipeline by a job worker. Used for partner actions only.
putThirdPartyJobFailureResult
in interface AWSCodePipeline
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 formatpublic PutThirdPartyJobSuccessResultResult putThirdPartyJobSuccessResult(PutThirdPartyJobSuccessResultRequest request)
Represents the success of a third party job as returned to the pipeline by a job worker. Used for partner actions only.
putThirdPartyJobSuccessResult
in interface AWSCodePipeline
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 formatpublic PutWebhookResult putWebhook(PutWebhookRequest request)
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.
putWebhook
in interface AWSCodePipeline
putWebhookRequest
- 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.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.public RegisterWebhookWithThirdPartyResult registerWebhookWithThirdParty(RegisterWebhookWithThirdPartyRequest request)
Configures a connection between the webhook that was created and the external tool with events to be detected.
registerWebhookWithThirdParty
in interface AWSCodePipeline
registerWebhookWithThirdPartyRequest
- ValidationException
- The validation was specified in an invalid format.WebhookNotFoundException
- The specified webhook was entered in an invalid format or cannot be found.public RetryStageExecutionResult retryStageExecution(RetryStageExecutionRequest request)
Resumes the pipeline execution by retrying the last failed actions in a stage. You can retry a stage immediately if any of the actions in the stage fail. When you retry, all actions that are still in progress continue working, and failed actions are triggered again.
retryStageExecution
in interface AWSCodePipeline
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.public StartPipelineExecutionResult startPipelineExecution(StartPipelineExecutionRequest request)
Starts the specified pipeline. Specifically, it begins processing the latest commit to the source location specified as part of the pipeline.
startPipelineExecution
in interface AWSCodePipeline
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.public StopPipelineExecutionResult stopPipelineExecution(StopPipelineExecutionRequest request)
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.
stopPipelineExecution
in interface AWSCodePipeline
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.public TagResourceResult tagResource(TagResourceRequest request)
Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.
tagResource
in interface AWSCodePipeline
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.public UntagResourceResult untagResource(UntagResourceRequest request)
Removes tags from an AWS resource.
untagResource
in interface AWSCodePipeline
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.public UpdateActionTypeResult updateActionType(UpdateActionTypeRequest request)
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.
updateActionType
in interface AWSCodePipeline
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.public UpdatePipelineResult updatePipeline(UpdatePipelineRequest request)
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.
updatePipeline
in interface AWSCodePipeline
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 AWS account has exceeded the limit allowed for the account.public 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 the request.
getCachedResponseMetadata
in interface AWSCodePipeline
request
- The originally executed requestpublic void shutdown()
AmazonWebServiceClient
shutdown
in interface AWSCodePipeline
shutdown
in class AmazonWebServiceClient