AWSCodePipeline (AWS SDK for Java

All Known Subinterfaces:

AWSCodePipelineAsync

All Known Implementing Classes:

AbstractAWSCodePipeline, AbstractAWSCodePipelineAsync, AWSCodePipelineAsyncClient, AWSCodePipelineClient
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSCodePipeline
```
Interface for accessing CodePipeline.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSCodePipeline instead.

AWS CodePipeline
Overview

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

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

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 which 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 the most recent revision of an artifact through the pipeline.
- UpdatePipeline, which updates a pipeline with edits or changes to the structure of the pipeline.
Pipelines include stages. Each stage contains one or more actions that must complete before the next stage begins. A stage will result in success or failure. If a stage fails, then the pipeline stops at that stage and will remain stopped until either a new version of an artifact appears in the source location, or a user takes action to re-run the most recent artifact through the pipeline. You can call GetPipelineState, which displays the status of a pipeline, including the status of stages in the pipeline, or GetPipeline, which returns the entire structure of the pipeline, including the stages of that pipeline. For more information about the structure of stages and actions, also refer to the AWS CodePipeline Pipeline Structure Reference.

Pipeline stages include actions, which are categorized into categories such as source or build actions performed within a stage of a pipeline. For example, you can use a source action to import artifacts into a pipeline from a source such as Amazon S3. Like stages, you do not work with actions directly in most cases, but you do define and interact with actions when working with pipeline operations such as CreatePipeline and GetPipelineState. 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. In order to integrate with AWS CodePipeline, developers will need to work with the following items:

Jobs, which are instances of an action. For example, a job for a source action might import a revision of an artifact from a source.

You can work with jobs by calling:
- AcknowledgeJob, which confirms whether a job worker has received the specified job,
- GetJobDetails, which returns the details of a job,
- PollForJobs, which determines whether there are any jobs to act upon,
- PutJobFailureResult, which provides details of a job failure, and
- PutJobSuccessResult, which provides details of a job success.
Third party jobs, which are instances of an action created by a partner action and integrated into AWS CodePipeline. Partner actions are created by members of the AWS Partner Network.

You can work with third party jobs by calling:
- AcknowledgeThirdPartyJob, which confirms whether a job worker has received the specified job,
- GetThirdPartyJobDetails, which requests the details of a job for a partner action,
- PollForThirdPartyJobs, which determines whether there are any jobs to act upon,
- PutThirdPartyJobFailureResult, which provides details of a job failure, and
- PutThirdPartyJobSuccessResult, which provides details of a job success.

Field Summary

Fields
Modifier and Type Field and Description

static String ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.

Fields
Modifier and Type	Field and Description
`static String`	`ENDPOINT_PREFIX` The region metadata service name for computing region endpoints.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`AcknowledgeJobResult`	`acknowledgeJob(AcknowledgeJobRequest acknowledgeJobRequest)` Returns information about a specified job and whether that job has been received by the job worker.
`AcknowledgeThirdPartyJobResult`	`acknowledgeThirdPartyJob(AcknowledgeThirdPartyJobRequest acknowledgeThirdPartyJobRequest)` Confirms a job worker has received the specified job.
`CreateCustomActionTypeResult`	`createCustomActionType(CreateCustomActionTypeRequest createCustomActionTypeRequest)` Creates a new custom action that can be used in all pipelines associated with the AWS account.
`CreatePipelineResult`	`createPipeline(CreatePipelineRequest createPipelineRequest)` Creates a pipeline.
`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.
`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 AWS 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.
`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 region for this account.
`PollForJobsResult`	`pollForJobs(PollForJobsRequest pollForJobsRequest)` Returns information about any jobs for AWS CodePipeline to act upon.
`PollForThirdPartyJobsResult`	`pollForThirdPartyJobs(PollForThirdPartyJobsRequest pollForThirdPartyJobsRequest)` Determines whether there are any third party jobs for a job worker to act on.
`PutActionRevisionResult`	`putActionRevision(PutActionRevisionRequest putActionRevisionRequest)` Provides information to AWS CodePipeline about new revisions to a source.
`PutApprovalResultResult`	`putApprovalResult(PutApprovalResultRequest putApprovalResultRequest)` Provides the response to a manual approval request to AWS CodePipeline.
`PutJobFailureResultResult`	`putJobFailureResult(PutJobFailureResultRequest putJobFailureResultRequest)` Represents the failure of a job as returned to the pipeline by a job worker.
`PutJobSuccessResultResult`	`putJobSuccessResult(PutJobSuccessResultRequest putJobSuccessResultRequest)` Represents the success of a job as returned to the pipeline by a job worker.
`PutThirdPartyJobFailureResultResult`	`putThirdPartyJobFailureResult(PutThirdPartyJobFailureResultRequest putThirdPartyJobFailureResultRequest)` Represents the failure of a third party job as returned to the pipeline by a job worker.
`PutThirdPartyJobSuccessResultResult`	`putThirdPartyJobSuccessResult(PutThirdPartyJobSuccessResultRequest putThirdPartyJobSuccessResultRequest)` Represents the success of a third party job as returned to the pipeline by a job worker.
`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)` Resumes the pipeline execution by retrying the last failed actions in a stage.
`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.
`TagResourceResult`	`tagResource(TagResourceRequest tagResourceRequest)` Adds to or modifies the tags of the given resource.
`UntagResourceResult`	`untagResource(UntagResourceRequest untagResourceRequest)` Removes tags from an AWS resource.
`UpdatePipelineResult`	`updatePipeline(UpdatePipelineRequest updatePipelineRequest)` Updates a specified pipeline with edits or changes to its structure.

- Field Detail
  - ENDPOINT_PREFIX
```
static final String ENDPOINT_PREFIX
```
    The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.
    
    See Also:
    
    RegionUtils.getRegionsForService(String), Constant Field Values
- Method Detail
  - setEndpoint
```
@Deprecated
void setEndpoint(String endpoint)
```
    Deprecated. use AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for example: builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
    
    Overrides the default endpoint for this client ("https://codepipeline.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.
    Callers can pass in just the endpoint (ex: "codepipeline.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://codepipeline.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.
    For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: 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.
    
    Parameters:
    
    endpoint - The endpoint (ex: "codepipeline.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://codepipeline.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.
  - setRegion
```
@Deprecated
void setRegion(Region region)
```
    Deprecated. use AwsClientBuilder#setRegion(String)
    
    An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.
    By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.
    This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
    
    Parameters:
    
    region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region. Must not be null and must be a region where the service is available.
    
    See Also:
    
    Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration), Region.isServiceSupported(String)
  - acknowledgeJob
```
AcknowledgeJobResult acknowledgeJob(AcknowledgeJobRequest acknowledgeJobRequest)
```
    Returns information about a specified job and whether that job has been received by the job worker. Only used for custom actions.
    
    Parameters:
    
    acknowledgeJobRequest - Represents the input of an AcknowledgeJob action.
    
    Returns:
    
    Result of the AcknowledgeJob operation returned by the service.
    
    Throws:
    
    ValidationException - The validation was specified in an invalid format.
    
    InvalidNonceException - The specified nonce was specified in an invalid format.
    
    JobNotFoundException - The specified job was specified in an invalid format or cannot be found.
    
    See Also:
    
    AWS API Documentation
  - acknowledgeThirdPartyJob
```
AcknowledgeThirdPartyJobResult acknowledgeThirdPartyJob(AcknowledgeThirdPartyJobRequest acknowledgeThirdPartyJobRequest)
```
    Confirms a job worker has received the specified job. Only used for partner actions.
    
    Parameters:
    
    acknowledgeThirdPartyJobRequest - Represents the input of an AcknowledgeThirdPartyJob action.
    
    Returns:
    
    Result of the AcknowledgeThirdPartyJob operation returned by the service.
    
    Throws:
    
    ValidationException - The validation was specified in an invalid format.
    
    InvalidNonceException - The specified nonce was specified in an invalid format.
    
    JobNotFoundException - The specified job was specified in an invalid format or cannot be found.
    
    InvalidClientTokenException - The client token was specified in an invalid format
    
    See Also:
    
    AWS API Documentation
  - createCustomActionType
```
CreateCustomActionTypeResult createCustomActionType(CreateCustomActionTypeRequest createCustomActionTypeRequest)
```
    Creates a new custom action that can be used in all pipelines associated with the AWS account. Only used for custom actions.
    
    Parameters:
    
    createCustomActionTypeRequest - Represents the input of a CreateCustomActionType operation.
    
    Returns:
    
    Result of the CreateCustomActionType operation returned by the service.
    
    Throws:
    
    ValidationException - The validation was specified in an invalid format.
    
    LimitExceededException - The number of pipelines associated with the AWS account has exceeded the limit allowed for the account.
    
    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.
    
    See Also:
    
    AWS API Documentation
  - createPipeline
```
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.
    
    Parameters:
    
    createPipelineRequest - Represents the input of a CreatePipeline action.
    
    Returns:
    
    Result of the CreatePipeline operation returned by the service.
    
    Throws:
    
    ValidationException - The validation was specified in an invalid format.
    
    PipelineNameInUseException - The specified pipeline name is already in use.
    
    InvalidStageDeclarationException - The specified stage declaration was specified in an invalid format.
    
    InvalidActionDeclarationException - The specified action declaration was specified in an invalid format.
    
    InvalidBlockerDeclarationException - Reserved for future use.
    
    InvalidStructureException - The specified structure was specified in an invalid format.
    
    LimitExceededException - The number of pipelines associated with the AWS account has exceeded the limit allowed for the account.
    
    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.
    
    See Also:
    
    AWS API Documentation
  - deleteCustomActionType
```
DeleteCustomActionTypeResult deleteCustomActionType(DeleteCustomActionTypeRequest deleteCustomActionTypeRequest)
```
    Marks a custom action as deleted. PollForJobs for the custom action will fail after the action is marked for deletion. Only used for custom actions.
    
    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.
    
    Parameters:
    
    deleteCustomActionTypeRequest - Represents the input of a DeleteCustomActionType operation. The custom action will be marked as deleted.
    
    Returns:
    
    Result of the DeleteCustomActionType operation returned by the service.
    
    Throws:
    
    ValidationException - The validation was specified in an invalid format.
    
    ConcurrentModificationException - Unable to modify the tag due to a simultaneous update request.
    
    See Also:
    
    AWS API Documentation
  - deletePipeline
```
DeletePipelineResult deletePipeline(DeletePipelineRequest deletePipelineRequest)
```
    Deletes the specified pipeline.
    
    Parameters:
    
    deletePipelineRequest - Represents the input of a DeletePipeline action.
    
    Returns:
    
    Result of the DeletePipeline operation returned by the service.
    
    Throws:
    
    ValidationException - The validation was specified in an invalid format.
    
    ConcurrentModificationException - Unable to modify the tag due to a simultaneous update request.
    
    See Also:
    
    AWS API Documentation
  - deleteWebhook
```
DeleteWebhookResult deleteWebhook(DeleteWebhookRequest deleteWebhookRequest)
```
    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 will return 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.
    
    Parameters:
    
    deleteWebhookRequest -
    
    Returns:
    
    Result of the DeleteWebhook operation returned by the service.
    
    Throws:
    
    ValidationException - The validation was specified in an invalid format.
    
    ConcurrentModificationException - Unable to modify the tag due to a simultaneous update request.
    
    See Also:
    
    AWS API Documentation
  - deregisterWebhookWithThirdParty
```
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 only supported for webhooks that target an action type of GitHub.
    
    Parameters:
    
    deregisterWebhookWithThirdPartyRequest -
    
    Returns:
    
    Result of the DeregisterWebhookWithThirdParty operation returned by the service.
    
    Throws:
    
    ValidationException - The validation was specified in an invalid format.
    
    WebhookNotFoundException - The specified webhook was entered in an invalid format or cannot be found.
    
    See Also:
    
    AWS API Documentation
  - disableStageTransition
```
DisableStageTransitionResult disableStageTransition(DisableStageTransitionRequest disableStageTransitionRequest)
```
    Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline.
    
    Parameters:
    
    disableStageTransitionRequest - Represents the input of a DisableStageTransition action.
    
    Returns:
    
    Result of the DisableStageTransition operation returned by the service.
    
    Throws:
    
    ValidationException - The validation was specified in an invalid format.
    
    PipelineNotFoundException - The specified pipeline was specified in an invalid format or cannot be found.
    
    StageNotFoundException - The specified stage was specified in an invalid format or cannot be found.
    
    See Also:
    
    AWS API Documentation
  - enableStageTransition
```
EnableStageTransitionResult enableStageTransition(EnableStageTransitionRequest enableStageTransitionRequest)
```
    Enables artifacts in a pipeline to transition to a stage in a pipeline.
    
    Parameters:
    
    enableStageTransitionRequest - Represents the input of an EnableStageTransition action.
    
    Returns:
    
    Result of the EnableStageTransition operation returned by the service.
    
    Throws:
    
    ValidationException - The validation was specified in an invalid format.
    
    PipelineNotFoundException - The specified pipeline was specified in an invalid format or cannot be found.
    
    StageNotFoundException - The specified stage was specified in an invalid format or cannot be found.
    
    See Also:
    
    AWS API Documentation
  - getJobDetails
```
GetJobDetailsResult getJobDetails(GetJobDetailsRequest getJobDetailsRequest)
```
    Returns information about a job. Only used for custom actions.
    
    When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API returns any secret values defined for the action.
    
    Parameters:
    
    getJobDetailsRequest - Represents the input of a GetJobDetails action.
    
    Returns:
    
    Result of the GetJobDetails operation returned by the service.
    
    Throws:
    
    ValidationException - The validation was specified in an invalid format.
    
    JobNotFoundException - The specified job was specified in an invalid format or cannot be found.
    
    See Also:
    
    AWS API Documentation
  - getPipeline
```
GetPipelineResult getPipeline(GetPipelineRequest getPipelineRequest)
```
    Returns the metadata, structure, stages, and actions of a pipeline. Can be used to return the entire structure of a pipeline in JSON format, which can then be modified and used to update the pipeline structure with UpdatePipeline.
    
    Parameters:
    
    getPipelineRequest - Represents the input of a GetPipeline action.
    
    Returns:
    
    Result of the GetPipeline operation returned by the service.
    
    Throws:
    
    ValidationException - The validation was specified in an invalid format.
    
    PipelineNotFoundException - The specified pipeline was specified in an invalid format or cannot be found.
    
    PipelineVersionNotFoundException - The specified pipeline version was specified in an invalid format or cannot be found.
    
    See Also:
    
    AWS API Documentation
  - getPipelineExecution
```
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.
    
    Parameters:
    
    getPipelineExecutionRequest - Represents the input of a GetPipelineExecution action.
    
    Returns:
    
    Result of the GetPipelineExecution operation returned by the service.
    
    Throws:
    
    ValidationException - The validation was specified in an invalid format.
    
    PipelineNotFoundException - The specified pipeline was specified in an invalid format or cannot be found.
    
    PipelineExecutionNotFoundException - The pipeline execution was specified in an invalid format or cannot be found, or an execution ID does not belong to the specified pipeline.
    
    See Also:
    
    AWS API Documentation
  - getPipelineState
```
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.
    
    Parameters:
    
    getPipelineStateRequest - Represents the input of a GetPipelineState action.
    
    Returns:
    
    Result of the GetPipelineState operation returned by the service.
    
    Throws:
    
    ValidationException - The validation was specified in an invalid format.
    
    PipelineNotFoundException - The specified pipeline was specified in an invalid format or cannot be found.
    
    See Also:
    
    AWS API Documentation
  - getThirdPartyJobDetails
```
GetThirdPartyJobDetailsResult getThirdPartyJobDetails(GetThirdPartyJobDetailsRequest getThirdPartyJobDetailsRequest)
```
    Requests the details of a job for a third party action. Only used for partner actions.
    
    When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API returns any secret values defined for the action.
    
    Parameters:
    
    getThirdPartyJobDetailsRequest - Represents the input of a GetThirdPartyJobDetails action.
    
    Returns:
    
    Result of the GetThirdPartyJobDetails operation returned by the service.
    
    Throws:
    
    JobNotFoundException - The specified job was specified in an invalid format or cannot be found.
    
    ValidationException - The validation was specified in an invalid format.
    
    InvalidClientTokenException - The client token was specified in an invalid format
    
    InvalidJobException - The specified job was specified in an invalid format or cannot be found.
    
    See Also:
    
    AWS API Documentation
  - listActionExecutions
```
ListActionExecutionsResult listActionExecutions(ListActionExecutionsRequest listActionExecutionsRequest)
```
    Lists the action executions that have occurred in a pipeline.
    
    Parameters:
    
    listActionExecutionsRequest -
    
    Returns:
    
    Result of the ListActionExecutions operation returned by the service.
    
    Throws:
    
    ValidationException - The validation was specified in an invalid format.
    
    PipelineNotFoundException - The specified pipeline was specified in an invalid format or cannot be found.
    
    InvalidNextTokenException - The next token was specified in an invalid format. Make sure that the next token you provided is the token returned by a previous call.
    
    PipelineExecutionNotFoundException - The pipeline execution was specified in an invalid format or cannot be found, or an execution ID does not belong to the specified pipeline.
    
    See Also:
    
    AWS API Documentation
  - listActionTypes
```
ListActionTypesResult listActionTypes(ListActionTypesRequest listActionTypesRequest)
```
    Gets a summary of all AWS CodePipeline action types associated with your account.
    
    Parameters:
    
    listActionTypesRequest - Represents the input of a ListActionTypes action.
    
    Returns:
    
    Result of the ListActionTypes operation returned by the service.
    
    Throws:
    
    ValidationException - The validation was specified in an invalid format.
    
    InvalidNextTokenException - The next token was specified in an invalid format. Make sure that the next token you provided is the token returned by a previous call.
    
    See Also:
    
    AWS API Documentation
  - listPipelineExecutions
```
ListPipelineExecutionsResult listPipelineExecutions(ListPipelineExecutionsRequest listPipelineExecutionsRequest)
```
    Gets a summary of the most recent executions for a pipeline.
    
    Parameters:
    
    listPipelineExecutionsRequest - Represents the input of a ListPipelineExecutions action.
    
    Returns:
    
    Result of the ListPipelineExecutions operation returned by the service.
    
    Throws:
    
    ValidationException - The validation was specified in an invalid format.
    
    PipelineNotFoundException - The specified pipeline was specified in an invalid format or cannot be found.
    
    InvalidNextTokenException - The next token was specified in an invalid format. Make sure that the next token you provided is the token returned by a previous call.
    
    See Also:
    
    AWS API Documentation
  - listPipelines
```
ListPipelinesResult listPipelines(ListPipelinesRequest listPipelinesRequest)
```
    Gets a summary of all of the pipelines associated with your account.
    
    Parameters:
    
    listPipelinesRequest - Represents the input of a ListPipelines action.
    
    Returns:
    
    Result of the ListPipelines operation returned by the service.
    
    Throws:
    
    ValidationException - The validation was specified in an invalid format.
    
    InvalidNextTokenException - The next token was specified in an invalid format. Make sure that the next token you provided is the token returned by a previous call.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
```
    Gets the set of key/value pairs (metadata) that are used to manage the resource.
    
    Parameters:
    
    listTagsForResourceRequest -
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    Throws:
    
    ValidationException - The validation was specified in an invalid format.
    
    ResourceNotFoundException - The specified resource was specified in an invalid format.
    
    InvalidNextTokenException - The next token was specified in an invalid format. Make sure that the next token you provided is the token returned by a previous call.
    
    InvalidArnException - The specified resource ARN is invalid.
    
    See Also:
    
    AWS API Documentation
  - listWebhooks
```
ListWebhooksResult listWebhooks(ListWebhooksRequest listWebhooksRequest)
```
    Gets a listing of all the webhooks in this region for this account. The output lists all webhooks and includes the webhook URL and ARN, as well the configuration for each webhook.
    
    Parameters:
    
    listWebhooksRequest -
    
    Returns:
    
    Result of the ListWebhooks operation returned by the service.
    
    Throws:
    
    ValidationException - The validation was specified in an invalid format.
    
    InvalidNextTokenException - The next token was specified in an invalid format. Make sure that the next token you provided is the token returned by a previous call.
    
    See Also:
    
    AWS API Documentation
  - pollForJobs
```
PollForJobsResult pollForJobs(PollForJobsRequest pollForJobsRequest)
```
    Returns information about any jobs for AWS CodePipeline to act upon. PollForJobs is only valid 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 Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API returns any secret values defined for the action.
    
    Parameters:
    
    pollForJobsRequest - Represents the input of a PollForJobs action.
    
    Returns:
    
    Result of the PollForJobs operation returned by the service.
    
    Throws:
    
    ValidationException - The validation was specified in an invalid format.
    
    ActionTypeNotFoundException - The specified action type cannot be found.
    
    See Also:
    
    AWS API Documentation
  - pollForThirdPartyJobs
```
PollForThirdPartyJobsResult pollForThirdPartyJobs(PollForThirdPartyJobsRequest pollForThirdPartyJobsRequest)
```
    Determines whether there are any third party jobs for a job worker to act on. Only used for partner actions.
    
    When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts.
    
    Parameters:
    
    pollForThirdPartyJobsRequest - Represents the input of a PollForThirdPartyJobs action.
    
    Returns:
    
    Result of the PollForThirdPartyJobs operation returned by the service.
    
    Throws:
    
    ActionTypeNotFoundException - The specified action type cannot be found.
    
    ValidationException - The validation was specified in an invalid format.
    
    See Also:
    
    AWS API Documentation
  - putActionRevision
```
PutActionRevisionResult putActionRevision(PutActionRevisionRequest putActionRevisionRequest)
```
    Provides information to AWS CodePipeline about new revisions to a source.
    
    Parameters:
    
    putActionRevisionRequest - Represents the input of a PutActionRevision action.
    
    Returns:
    
    Result of the PutActionRevision operation returned by the service.
    
    Throws:
    
    PipelineNotFoundException - The specified pipeline was specified in an invalid format or cannot be found.
    
    StageNotFoundException - The specified stage was specified in an invalid format or cannot be found.
    
    ActionNotFoundException - The specified action cannot be found.
    
    ValidationException - The validation was specified in an invalid format.
    
    See Also:
    
    AWS API Documentation
  - putApprovalResult
```
PutApprovalResultResult putApprovalResult(PutApprovalResultRequest putApprovalResultRequest)
```
    Provides the response to a manual approval request to AWS CodePipeline. Valid responses include Approved and Rejected.
    
    Parameters:
    
    putApprovalResultRequest - Represents the input of a PutApprovalResult action.
    
    Returns:
    
    Result of the PutApprovalResult operation returned by the service.
    
    Throws:
    
    InvalidApprovalTokenException - The approval request already received a response or has expired.
    
    ApprovalAlreadyCompletedException - The approval action has already been approved or rejected.
    
    PipelineNotFoundException - The specified pipeline was specified in an invalid format or cannot be found.
    
    StageNotFoundException - The specified stage was specified in an invalid format or cannot be found.
    
    ActionNotFoundException - The specified action cannot be found.
    
    ValidationException - The validation was specified in an invalid format.
    
    See Also:
    
    AWS API Documentation
  - putJobFailureResult
```
PutJobFailureResultResult putJobFailureResult(PutJobFailureResultRequest putJobFailureResultRequest)
```
    Represents the failure of a job as returned to the pipeline by a job worker. Only used for custom actions.
    
    Parameters:
    
    putJobFailureResultRequest - Represents the input of a PutJobFailureResult action.
    
    Returns:
    
    Result of the PutJobFailureResult operation returned by the service.
    
    Throws:
    
    ValidationException - The validation was specified in an invalid format.
    
    JobNotFoundException - The specified job was specified in an invalid format or cannot be found.
    
    InvalidJobStateException - The specified job state was specified in an invalid format.
    
    See Also:
    
    AWS API Documentation
  - putJobSuccessResult
```
PutJobSuccessResultResult putJobSuccessResult(PutJobSuccessResultRequest putJobSuccessResultRequest)
```
    Represents the success of a job as returned to the pipeline by a job worker. Only used for custom actions.
    
    Parameters:
    
    putJobSuccessResultRequest - Represents the input of a PutJobSuccessResult action.
    
    Returns:
    
    Result of the PutJobSuccessResult operation returned by the service.
    
    Throws:
    
    ValidationException - The validation was specified in an invalid format.
    
    JobNotFoundException - The specified job was specified in an invalid format or cannot be found.
    
    InvalidJobStateException - The specified job state was specified in an invalid format.
    
    See Also:
    
    AWS API Documentation
  - putThirdPartyJobFailureResult
```
PutThirdPartyJobFailureResultResult putThirdPartyJobFailureResult(PutThirdPartyJobFailureResultRequest putThirdPartyJobFailureResultRequest)
```
    Represents the failure of a third party job as returned to the pipeline by a job worker. Only used for partner actions.
    
    Parameters:
    
    putThirdPartyJobFailureResultRequest - Represents the input of a PutThirdPartyJobFailureResult action.
    
    Returns:
    
    Result of the PutThirdPartyJobFailureResult operation returned by the service.
    
    Throws:
    
    ValidationException - The validation was specified in an invalid format.
    
    JobNotFoundException - The specified job was specified in an invalid format or cannot be found.
    
    InvalidJobStateException - The specified job state was specified in an invalid format.
    
    InvalidClientTokenException - The client token was specified in an invalid format
    
    See Also:
    
    AWS API Documentation
  - putThirdPartyJobSuccessResult
```
PutThirdPartyJobSuccessResultResult putThirdPartyJobSuccessResult(PutThirdPartyJobSuccessResultRequest putThirdPartyJobSuccessResultRequest)
```
    Represents the success of a third party job as returned to the pipeline by a job worker. Only used for partner actions.
    
    Parameters:
    
    putThirdPartyJobSuccessResultRequest - Represents the input of a PutThirdPartyJobSuccessResult action.
    
    Returns:
    
    Result of the PutThirdPartyJobSuccessResult operation returned by the service.
    
    Throws:
    
    ValidationException - The validation was specified in an invalid format.
    
    JobNotFoundException - The specified job was specified in an invalid format or cannot be found.
    
    InvalidJobStateException - The specified job state was specified in an invalid format.
    
    InvalidClientTokenException - The client token was specified in an invalid format
    
    See Also:
    
    AWS API Documentation
  - putWebhook
```
PutWebhookResult 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.
    
    Parameters:
    
    putWebhookRequest -
    
    Returns:
    
    Result of the PutWebhook operation returned by the service.
    
    Throws:
    
    ValidationException - The validation was specified in an invalid format.
    
    LimitExceededException - The number of pipelines associated with the AWS account has exceeded the limit allowed for the account.
    
    InvalidWebhookFilterPatternException - The specified event filter rule is in an invalid format.
    
    InvalidWebhookAuthenticationParametersException - The specified authentication type is in an invalid format.
    
    PipelineNotFoundException - The specified 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.
    
    See Also:
    
    AWS API Documentation
  - registerWebhookWithThirdParty
```
RegisterWebhookWithThirdPartyResult registerWebhookWithThirdParty(RegisterWebhookWithThirdPartyRequest registerWebhookWithThirdPartyRequest)
```
    Configures a connection between the webhook that was created and the external tool with events to be detected.
    
    Parameters:
    
    registerWebhookWithThirdPartyRequest -
    
    Returns:
    
    Result of the RegisterWebhookWithThirdParty operation returned by the service.
    
    Throws:
    
    ValidationException - The validation was specified in an invalid format.
    
    WebhookNotFoundException - The specified webhook was entered in an invalid format or cannot be found.
    
    See Also:
    
    AWS API Documentation
  - retryStageExecution
```
RetryStageExecutionResult retryStageExecution(RetryStageExecutionRequest retryStageExecutionRequest)
```
    Resumes the pipeline execution by retrying the last failed actions in a stage.
    
    Parameters:
    
    retryStageExecutionRequest - Represents the input of a RetryStageExecution action.
    
    Returns:
    
    Result of the RetryStageExecution operation returned by the service.
    
    Throws:
    
    ValidationException - The validation was specified in an invalid format.
    
    PipelineNotFoundException - The specified pipeline was specified in an invalid format or cannot be found.
    
    StageNotFoundException - The specified stage was specified in an invalid format or cannot be found.
    
    StageNotRetryableException - The specified stage can't be retried because the pipeline structure or stage state changed after the stage was not completed; the stage contains no failed actions; one or more actions are still in progress; or another retry attempt is already in progress.
    
    NotLatestPipelineExecutionException - The stage has failed in a later run of the pipeline and the pipelineExecutionId associated with the request is out of date.
    
    See Also:
    
    AWS API Documentation
  - startPipelineExecution
```
StartPipelineExecutionResult startPipelineExecution(StartPipelineExecutionRequest startPipelineExecutionRequest)
```
    Starts the specified pipeline. Specifically, it begins processing the latest commit to the source location specified as part of the pipeline.
    
    Parameters:
    
    startPipelineExecutionRequest - Represents the input of a StartPipelineExecution action.
    
    Returns:
    
    Result of the StartPipelineExecution operation returned by the service.
    
    Throws:
    
    ValidationException - The validation was specified in an invalid format.
    
    PipelineNotFoundException - The specified pipeline was specified in an invalid format or cannot be found.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
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.
    
    Parameters:
    
    tagResourceRequest -
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    Throws:
    
    ValidationException - The validation was specified in an invalid format.
    
    ResourceNotFoundException - The specified 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.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
```
    Removes tags from an AWS resource.
    
    Parameters:
    
    untagResourceRequest -
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    Throws:
    
    ValidationException - The validation was specified in an invalid format.
    
    ResourceNotFoundException - The specified 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.
    
    See Also:
    
    AWS API Documentation
  - updatePipeline
```
UpdatePipelineResult updatePipeline(UpdatePipelineRequest updatePipelineRequest)
```
    Updates a specified pipeline with edits or changes to its structure. Use a JSON file with the pipeline structure in conjunction with UpdatePipeline to provide the full structure of the pipeline. Updating the pipeline increases the version number of the pipeline by 1.
    
    Parameters:
    
    updatePipelineRequest - Represents the input of an UpdatePipeline action.
    
    Returns:
    
    Result of the UpdatePipeline operation returned by the service.
    
    Throws:
    
    ValidationException - The validation was specified in an invalid format.
    
    InvalidStageDeclarationException - The specified stage declaration was specified in an invalid format.
    
    InvalidActionDeclarationException - The specified action declaration was specified in an invalid format.
    
    InvalidBlockerDeclarationException - Reserved for future use.
    
    InvalidStructureException - The specified structure was specified in an invalid format.
    
    LimitExceededException - The number of pipelines associated with the AWS account has exceeded the limit allowed for the account.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
void shutdown()
```
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
  - getCachedResponseMetadata
```
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Did this page help you?

Interface AWSCodePipeline

Field Summary

Method Summary

Field Detail

ENDPOINT_PREFIX

Method Detail

setEndpoint

setRegion

acknowledgeJob

acknowledgeThirdPartyJob

createCustomActionType

createPipeline

deleteCustomActionType

deletePipeline

deleteWebhook

deregisterWebhookWithThirdParty

disableStageTransition

enableStageTransition

getJobDetails

getPipeline

getPipelineExecution

getPipelineState

getThirdPartyJobDetails

listActionExecutions

listActionTypes

listPipelineExecutions

listPipelines

listTagsForResource

listWebhooks

pollForJobs

pollForThirdPartyJobs

putActionRevision

putApprovalResult

putJobFailureResult

putJobSuccessResult

putThirdPartyJobFailureResult

putThirdPartyJobSuccessResult

putWebhook

registerWebhookWithThirdParty

retryStageExecution

startPipelineExecution

tagResource

untagResource

updatePipeline

shutdown

getCachedResponseMetadata