AWSCodePipelineClient (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceClient
- - com.amazonaws.services.codepipeline.AWSCodePipelineClient

All Implemented Interfaces:

AWSCodePipeline

Direct Known Subclasses:

AWSCodePipelineAsyncClient
```
@ThreadSafe
public class AWSCodePipelineClient
extends AmazonWebServiceClient
implements AWSCodePipeline
```
Client for accessing CodePipeline. All service calls made using this client are blocking, and will not return until the service call completes.
AWS CodePipeline Overview
This is the AWS CodePipeline API Reference. This guide provides descriptions of the actions and data types for AWS CodePipeline. Some functionality for your pipeline is only configurable through the API. For additional information, see the AWS CodePipeline User Guide.

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

Pipelines are models of automated release processes. Each pipeline is uniquely named, and consists of actions, gates, and stages.

You can work with pipelines by calling:
- CreatePipeline, which creates a uniquely-named pipeline.
- DeletePipeline, which deletes the specified pipeline.
- GetPipeline, which returns information about a pipeline structure.
- GetPipelineState, which returns information about the current state of the stages and actions of a pipeline.
- ListPipelines, which gets a summary of all of the pipelines associated with your account.
- StartPipelineExecution, which runs the the most recent revision of an artifact through the pipeline.
- UpdatePipeline, which updates a pipeline with edits or changes to the structure of the pipeline.
Pipelines include stages, which are which are logical groupings of gates and actions. Each stage contains one or more actions that must complete before the next stage begins. A stage will result in success or failure. If a stage fails, then the pipeline stops at that stage and will remain stopped until either a new version of an artifact appears in the source location, or a user takes action to re-run the most recent artifact through the pipeline. You can call GetPipelineState, which displays the status of a pipeline, including the status of stages in the pipeline, or GetPipeline, which returns the entire structure of the pipeline, including the stages of that pipeline. For more information about the structure of stages and actions, also refer to the AWS CodePipeline Pipeline Structure Reference.

Pipeline stages include actions, which are categorized into categories such as source or build actions performed within a stage of a pipeline. For example, you can use a source action to import artifacts into a pipeline from a source such as Amazon S3. Like stages, you do not work with actions directly in most cases, but you do define and interact with actions when working with pipeline operations such as CreatePipeline and GetPipelineState.

Pipelines also include transitions, which allow the transition of artifacts from one stage to the next in a pipeline after the actions in one stage complete.

You can work with transitions by calling:
- DisableStageTransition, which prevents artifacts from transitioning to the next stage in a pipeline.
- EnableStageTransition, which enables transition of artifacts between stages in a pipeline.
Using the API to integrate with AWS CodePipeline

For third-party integrators or developers who want to create their own integrations with AWS CodePipeline, the expected sequence varies from the standard API user. In order to integrate with AWS CodePipeline, developers will need to work with the following items:
- Jobs, which are instances of an action. For example, a job for a source action might import a revision of an artifact from a source.
  You can work with jobs by calling:
  - AcknowledgeJob, which confirms whether a job worker has received the specified job,
  - GetJobDetails, which returns the details of a job,
  - PollForJobs, which determines whether there are any jobs to act upon,
  - PutJobFailureResult, which provides details of a job failure, and
  - PutJobSuccessResult, which provides details of a job success.
- Third party jobs, which are instances of an action created by a partner action and integrated into AWS CodePipeline. Partner actions are created by members of the AWS Partner Network.
  You can work with third party jobs by calling:
  - AcknowledgeThirdPartyJob, which confirms whether a job worker has received the specified job,
  - GetThirdPartyJobDetails, which requests the details of a job for a partner action,
  - PollForThirdPartyJobs, which determines whether there are any jobs to act upon,
  - PutThirdPartyJobFailureResult, which provides details of a job failure, and
  - PutThirdPartyJobSuccessResult, which provides details of a job success.

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceClient
  LOGGING_AWS_REQUEST_METRIC

Constructor Summary

Constructors
Constructor and Description
`AWSCodePipelineClient()` Constructs a new client to invoke service methods on CodePipeline.
`AWSCodePipelineClient(AWSCredentials awsCredentials)` Constructs a new client to invoke service methods on CodePipeline using the specified AWS account credentials.
`AWSCodePipelineClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)` Constructs a new client to invoke service methods on CodePipeline using the specified AWS account credentials and client configuration options.
`AWSCodePipelineClient(AWSCredentialsProvider awsCredentialsProvider)` Constructs a new client to invoke service methods on CodePipeline using the specified AWS account credentials provider.
`AWSCodePipelineClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)` Constructs a new client to invoke service methods on CodePipeline using the specified AWS account credentials provider and client configuration options.
`AWSCodePipelineClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)` Constructs a new client to invoke service methods on CodePipeline using the specified AWS account credentials provider, client configuration options, and request metric collector.
`AWSCodePipelineClient(ClientConfiguration clientConfiguration)` Constructs a new client to invoke service methods on CodePipeline.

Method Summary

Methods
Modifier and Type	Method and Description
`AcknowledgeJobResult`	`acknowledgeJob(AcknowledgeJobRequest acknowledgeJobRequest)` Returns information about a specified job and whether that job has been received by the job worker.
`AcknowledgeThirdPartyJobResult`	`acknowledgeThirdPartyJob(AcknowledgeThirdPartyJobRequest acknowledgeThirdPartyJobRequest)` Confirms a job worker has received the specified job.
`CreateCustomActionTypeResult`	`createCustomActionType(CreateCustomActionTypeRequest createCustomActionTypeRequest)` Creates a new custom action that can be used in all pipelines associated with the AWS account.
`CreatePipelineResult`	`createPipeline(CreatePipelineRequest createPipelineRequest)` Creates a pipeline.
`DeleteCustomActionTypeResult`	`deleteCustomActionType(DeleteCustomActionTypeRequest deleteCustomActionTypeRequest)` Marks a custom action as deleted.
`DeletePipelineResult`	`deletePipeline(DeletePipelineRequest deletePipelineRequest)` Deletes the specified pipeline.
`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.
`GetPipelineStateResult`	`getPipelineState(GetPipelineStateRequest getPipelineStateRequest)` Returns information about the state of a pipeline, including the stages, actions, and details about the last run of the pipeline.
`GetThirdPartyJobDetailsResult`	`getThirdPartyJobDetails(GetThirdPartyJobDetailsRequest getThirdPartyJobDetailsRequest)` Requests the details of a job for a third party action.
`ListActionTypesResult`	`listActionTypes(ListActionTypesRequest listActionTypesRequest)` Gets a summary of all AWS CodePipeline action types associated with your account.
`ListPipelinesResult`	`listPipelines(ListPipelinesRequest listPipelinesRequest)` Gets a summary of all of the pipelines associated with your account.
`PollForJobsResult`	`pollForJobs(PollForJobsRequest pollForJobsRequest)` Returns information about any jobs for AWS CodePipeline to act upon.
`PollForThirdPartyJobsResult`	`pollForThirdPartyJobs(PollForThirdPartyJobsRequest pollForThirdPartyJobsRequest)` Determines whether there are any third party jobs for a job worker to act on.
`PutActionRevisionResult`	`putActionRevision(PutActionRevisionRequest putActionRevisionRequest)` Provides information to AWS CodePipeline about new revisions to a source.
`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.
`StartPipelineExecutionResult`	`startPipelineExecution(StartPipelineExecutionRequest startPipelineExecutionRequest)` Starts the specified pipeline.
`UpdatePipelineResult`	`updatePipeline(UpdatePipelineRequest updatePipelineRequest)` Updates a specified pipeline with edits or changes to its structure.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.codepipeline.AWSCodePipeline
setEndpoint, setRegion, shutdown

- Constructor Detail
  - AWSCodePipelineClient
```
public AWSCodePipelineClient()
```
    Constructs a new client to invoke service methods on CodePipeline. A credentials provider chain will be used that searches for credentials in this order:
    - Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
    - Java System Properties - aws.accessKeyId and aws.secretKey
    - Instance profile credentials delivered through the Amazon EC2 metadata service
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    See Also:
    DefaultAWSCredentialsProviderChain
  - AWSCodePipelineClient
```
public AWSCodePipelineClient(ClientConfiguration clientConfiguration)
```
    Constructs a new client to invoke service methods on CodePipeline. A credentials provider chain will be used that searches for credentials in this order:
    - Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
    - Java System Properties - aws.accessKeyId and aws.secretKey
    - Instance profile credentials delivered through the Amazon EC2 metadata service
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    Parameters:
    clientConfiguration - The client configuration options controlling how this client connects to CodePipeline (ex: proxy settings, retry counts, etc.).
    See Also:
    DefaultAWSCredentialsProviderChain
  - AWSCodePipelineClient
```
public AWSCodePipelineClient(AWSCredentials awsCredentials)
```
    Constructs a new client to invoke service methods on CodePipeline using the specified AWS account credentials.
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    
    Parameters:
    awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
  - AWSCodePipelineClient
```
public AWSCodePipelineClient(AWSCredentials awsCredentials,
                     ClientConfiguration clientConfiguration)
```
    Constructs a new client to invoke service methods on CodePipeline using the specified AWS account credentials and client configuration options.
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    
    Parameters:
    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.).
  - AWSCodePipelineClient
```
public AWSCodePipelineClient(AWSCredentialsProvider awsCredentialsProvider)
```
    Constructs a new client to invoke service methods on CodePipeline using the specified AWS account credentials provider.
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    
    Parameters:
    awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
  - AWSCodePipelineClient
```
public AWSCodePipelineClient(AWSCredentialsProvider awsCredentialsProvider,
                     ClientConfiguration clientConfiguration)
```
    Constructs a new client to invoke service methods on CodePipeline using the specified AWS account credentials provider and client configuration options.
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    
    Parameters:
    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.).
  - AWSCodePipelineClient
```
public AWSCodePipelineClient(AWSCredentialsProvider awsCredentialsProvider,
                     ClientConfiguration clientConfiguration,
                     RequestMetricCollector requestMetricCollector)
```
    Constructs a new client to invoke service methods on CodePipeline using the specified AWS account credentials provider, client configuration options, and request metric collector.
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    
    Parameters:
    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 collector
- Method Detail
  - acknowledgeJob
```
public 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.
    Specified by:
    
    acknowledgeJob in interface AWSCodePipeline
    
    Parameters:
    acknowledgeJobRequest - Represents the input of an acknowledge job action.
    
    Returns:
    Result of the AcknowledgeJob operation returned by the service.
    
    Throws:
    
    ValidationException - The validation was specified in an invalid format.
    
    InvalidNonceException - The specified nonce was specified in an invalid format.
    
    JobNotFoundException - The specified job was specified in an invalid format or cannot be found.
    
    Samples:
    - Acknowledge a job for a custom action
      This example returns information about a specified job, including the status of that job if it exists. This is only used for job workers and custom actions in AWS CodePipeline. To determine the value of nonce and the job ID, use PollForJobs.
      
      AWSCodePipeline client = new AWSCodePipelineClient(); AcknowledgeJobRequest request = new AcknowledgeJobRequest() //Use the PollforJobs API to determine the ID of the job. .withJobId("11111111-abcd-1111-abcd-111111abcdef")//Use the PollforJobs API to determine the nonce for the job. .withNonce("3"); AcknowledgeJobResult response = client.acknowledgeJob(request);
  - acknowledgeThirdPartyJob
```
public AcknowledgeThirdPartyJobResult acknowledgeThirdPartyJob(AcknowledgeThirdPartyJobRequest acknowledgeThirdPartyJobRequest)
```
    Confirms a job worker has received the specified job. Only used for partner actions.
    
    Specified by:
    
    acknowledgeThirdPartyJob in interface AWSCodePipeline
    
    Parameters:
    acknowledgeThirdPartyJobRequest - Represents the input of an acknowledge third party job action.
    
    Returns:
    Result of the AcknowledgeThirdPartyJob operation returned by the service.
    
    Throws:
    
    ValidationException - The validation was specified in an invalid format.
    
    InvalidNonceException - The specified nonce was specified in an invalid format.
    
    JobNotFoundException - The specified job was specified in an invalid format or cannot be found.
    
    InvalidClientTokenException - The client token was specified in an invalid format
  - createCustomActionType
```
public 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.
    Specified by:
    
    createCustomActionType in interface AWSCodePipeline
    
    Parameters:
    createCustomActionTypeRequest - Represents the input of a create custom action operation.
    
    Returns:
    Result of the CreateCustomActionType operation returned by the service.
    
    Throws:
    
    ValidationException - The validation was specified in an invalid format.
    
    LimitExceededException - The number of pipelines associated with the AWS account has exceeded the limit allowed for the account.
    
    Samples:
    - Create a custom action
      This example creates a build custom action for AWS CodePipeline for a Jenkins build project. For more information about the requirements for creating a custom action, including the structure of the JSON file commonly used to help create custom actions, see Create a Custom Action in the AWS CodePipeline User Guide. For a walkthrough of creating a custom action in a pipeline, follow the Four-Stage Pipeline Tutorial.
      
      AWSCodePipeline client = new AWSCodePipelineClient(); CreateCustomActionTypeRequest request = new CreateCustomActionTypeRequest() //A new custom action always has a version of 1. This is required. .withVersion("1") .withCategory("Build") //The text in description will be displayed to your users, and can contain a maximum of 2048 characters. The value for name in configurationProperties is the name of the project, if any. In this example, this is the name of the build project on the Jenkins server .withConfigurationProperties( new ActionConfigurationProperty() .withName("MyJenkinsExampleBuildProject") .withType("String") .withRequired(true) .withKey(true) .withDescription( "The name of the build project must be provided when this action is added to the pipeline.") .withQueryable(false).withSecret(false)) //This is the minimum and maximum number of artifacts allowed as inputs for the action. For more information about input and output artifacts, see Pipeline Structure Reference in the AWS CodePipeline User Guide. .withInputArtifactDetails( new ArtifactDetails().withMaximumCount(1) .withMinimumCount(0))//This is the minimum and maximum number of artifacts allowed as outputs for the action. For more information about input and output artifacts, see Pipeline Structure Reference in the AWS CodePipeline User Guide. .withOutputArtifactDetails( new ArtifactDetails().withMaximumCount(1) .withMinimumCount(0))//In this example, this is the name given to the provider field when configuring the AWS CodePipeline Plugin for Jenkins. For more information, see the Four-Stage Pipeline Tutorial in the AWS CodePipeline User Guide. .withProvider("MyBuild-ProviderName")//entityUrlTemplate is the static link that provides information about the service provider for the action. In the example, the build system includes a static link to the Jenkins build project at the specific server address. Similarly, executionUrlTemplate is the dynamic link that will be updated with information about the current or most recent run of the action. .withSettings( new ActionTypeSettings() .withEntityUrlTemplate( "https://192.0.2.4/job/{Config:ProjectName}/") .withExecutionUrlTemplate( "https://192.0.2.4/job/{Config:ProjectName}/lastSuccessfulBuild/{ExternalExecutionId}/") .withRevisionUrlTemplate("none")); CreateCustomActionTypeResult response = client .createCustomActionType(request);
  - createPipeline
```
public CreatePipelineResult createPipeline(CreatePipelineRequest createPipelineRequest)
```
    Creates a pipeline.
    Specified by:
    
    createPipeline in interface AWSCodePipeline
    
    Parameters:
    createPipelineRequest - Represents the input of a create pipeline action.
    
    Returns:
    Result of the CreatePipeline operation returned by the service.
    
    Throws:
    
    ValidationException - The validation was specified in an invalid format.
    
    PipelineNameInUseException - The specified pipeline name is already in use.
    
    InvalidStageDeclarationException - The specified stage declaration was specified in an invalid format.
    
    InvalidActionDeclarationException - The specified action declaration was specified in an invalid format.
    
    InvalidBlockerDeclarationException - 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.
    
    Samples:
    - Create a pipeline
      This example creates a simple two-stage pipeline in AWS CodePipeline that uses an Amazon S3 bucket for its source stage and deploys code using AWS CodeDeploy. For more information about the requirements for creating a pipeline, including the structure of the JSON file commonly used to create a pipeline, see "Create a Pipeline" in the AWS CodePipeline User Guide.
      
      AWSCodePipeline client = new AWSCodePipelineClient(); CreatePipelineRequest request = new CreatePipelineRequest() .withPipeline(new PipelineDeclaration() .withVersion(1) .withName("MySecondPipeline") .withArtifactStore( new ArtifactStore() .withType("S3") .withLocation( "codepipeline-us-east-1-11EXAMPLE11")) .withRoleArn( "arn:aws:iam::111111111111:role/AWS-CodePipeline-Service") .withStages( new StageDeclaration() .withName("Source") .withActions( new ActionDeclaration() .withName("Source") .withActionTypeId( new ActionTypeId() .withVersion( "1") .withCategory( "Source") .withOwner( "AWS") .withProvider( "S3")) .addConfigurationEntry( "S3Bucket", "awscodepipeline-demo-bucket") .addConfigurationEntry( "S3ObjectKey", "aws-codepipeline-s3-aws-codedeploy_linux.zip") .withInputArtifacts() .withOutputArtifacts( new OutputArtifact() .withName("MyApp")) .withRunOrder(1)), new StageDeclaration() .withName("Beta") .withActions( new ActionDeclaration() .withName( "CodePipelineDemoFleet") .withActionTypeId( new ActionTypeId() .withVersion( "1") .withCategory( "Deploy") .withOwner( "AWS") .withProvider( "CodeDeploy")) .addConfigurationEntry( "ApplicationName", "CodePipelineDemoApplication") .addConfigurationEntry( "DeploymentGroupName", "CodePipelineDemoFleet") .withInputArtifacts( new InputArtifact() .withName("MyApp")) .withOutputArtifacts() .withRunOrder(1)))); CreatePipelineResult response = client.createPipeline(request);
  - deleteCustomActionType
```
public 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.
    
    You cannot recreate a custom action after it has been deleted unless you increase the version number of the action.
    Specified by:
    
    deleteCustomActionType in interface AWSCodePipeline
    
    Parameters:
    deleteCustomActionTypeRequest - Represents the input of a delete custom action 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.
    
    Samples:
    - Delete a custom action
      This example deletes a custom action in AWS CodePipeline by specifiying the action type, provider name, and version number of the action to be deleted. Only used for custom actions. Use the list-action-types command to view the correct values for category, version, and provider. After a custom action is deleted, PollForJobs for the custom action will fail. Warning: You cannot recreate a custom action after it has been deleted unless you increase the version number of the action.
      
      AWSCodePipeline client = new AWSCodePipelineClient(); DeleteCustomActionTypeRequest request = new DeleteCustomActionTypeRequest() //This is the current version number of the custom action. .withVersion("1")//This is the type of action that the custom action is, for example build or test. .withCategory("Build")//This is the provider of the service used in the custom action. In this example, the custom action is for a Jenkins build, and the name of the provider is the one configured in the AWS CodePipeline Plugin for Jenkins .withProvider("MyJenkinsProviderName"); DeleteCustomActionTypeResult response = client .deleteCustomActionType(request);
  - deletePipeline
```
public DeletePipelineResult deletePipeline(DeletePipelineRequest deletePipelineRequest)
```
    Deletes the specified pipeline.
    Specified by:
    
    deletePipeline in interface AWSCodePipeline
    
    Parameters:
    deletePipelineRequest - Represents the input of a delete pipeline action.
    
    Returns:
    Result of the DeletePipeline operation returned by the service.
    
    Throws:
    
    ValidationException - The validation was specified in an invalid format.
    
    Samples:
    - Delete a pipeline
      This example deletes a pipeline named MySecondPipeline from AWS CodePipeline. Use ListPipelines to view a list of pipelines associated with your AWS account.
      
      AWSCodePipeline client = new AWSCodePipelineClient(); DeletePipelineRequest request = new DeletePipelineRequest() //The name of the pipeline to delete. .withName("MySecondPipeline"); DeletePipelineResult response = client.deletePipeline(request);
  - disableStageTransition
```
public DisableStageTransitionResult disableStageTransition(DisableStageTransitionRequest disableStageTransitionRequest)
```
    Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline.
    Specified by:
    
    disableStageTransition in interface AWSCodePipeline
    
    Parameters:
    disableStageTransitionRequest - Represents the input of a disable stage transition input 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.
    
    Samples:
    - Disable transitions into or out of a stage
      This example disables transitions into the Beta stage of the MyFirstPipeline pipeline in AWS CodePipeline.
      
      AWSCodePipeline client = new AWSCodePipelineClient(); DisableStageTransitionRequest request = new DisableStageTransitionRequest() .withPipelineName("MyFirstPipeline") .withReason("An example reason").withStageName("Beta")//Valid values are Inbound, which prevents artifacts from transitioning into the stage and being processed by the actions in that stage, or Outbound, which prevents artifacts from transitioning out of the stage after they have been processed by the actions in that stage. .withTransitionType("Inbound"); DisableStageTransitionResult response = client .disableStageTransition(request);
  - enableStageTransition
```
public EnableStageTransitionResult enableStageTransition(EnableStageTransitionRequest enableStageTransitionRequest)
```
    Enables artifacts in a pipeline to transition to a stage in a pipeline.
    Specified by:
    
    enableStageTransition in interface AWSCodePipeline
    
    Parameters:
    enableStageTransitionRequest - Represents the input of an enable stage transition 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.
    
    Samples:
    - Enable transitions into or out of a stage
      This example enables transitions into the Beta stage of the MyFirstPipeline pipeline in AWS CodePipeline.
      
      AWSCodePipeline client = new AWSCodePipelineClient(); EnableStageTransitionRequest request = new EnableStageTransitionRequest() .withPipelineName("MyFirstPipeline").withStageName("Beta")//Valid values are Inbound, which allows artifacts to transition into the stage and be processed by the actions in that stage, or Outbound, which allows artifacts to transition out of the stage after they have been processed by the actions in that stage. .withTransitionType("Inbound"); EnableStageTransitionResult response = client .enableStageTransition(request);
  - getJobDetails
```
public 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.
    Specified by:
    
    getJobDetails in interface AWSCodePipeline
    
    Parameters:
    getJobDetailsRequest - Represents the input of a get job details action.
    
    Returns:
    Result of the GetJobDetails operation returned by the service.
    
    Throws:
    
    ValidationException - The validation was specified in an invalid format.
    
    JobNotFoundException - The specified job was specified in an invalid format or cannot be found.
    
    Samples:
    - Get the details of a job
      This example returns details about a job whose ID is represented by f4f4ff82-2d11-EXAMPLE. This command is only used for custom actions. When this command is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if required for the custom action. This command will also return any secret values defined for the action, if any are defined.
      
      AWSCodePipeline client = new AWSCodePipelineClient(); GetJobDetailsRequest request = new GetJobDetailsRequest() .withJobId("11111111-abcd-1111-abcd-111111abcdef"); GetJobDetailsResult response = client.getJobDetails(request);
  - getPipeline
```
public 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.
    Specified by:
    
    getPipeline in interface AWSCodePipeline
    
    Parameters:
    getPipelineRequest - Represents the input of a get pipeline action.
    
    Returns:
    Result of the GetPipeline operation returned by the service.
    
    Throws:
    
    ValidationException - The validation was specified in an invalid format.
    
    PipelineNotFoundException - The specified pipeline was specified in an invalid format or cannot be found.
    
    PipelineVersionNotFoundException - The specified pipeline version was specified in an invalid format or cannot be found.
    
    Samples:
    - View the structure of a pipeline
      This example returns the structure of a pipeline named MyFirstPipeline.
      
      AWSCodePipeline client = new AWSCodePipelineClient(); GetPipelineRequest request = new GetPipelineRequest() //This is an optional parameter. If you do not specify a version, the most current version of the pipeline structure is returned. .withVersion(123).withName("MyFirstPipeline"); GetPipelineResult response = client.getPipeline(request);
  - getPipelineState
```
public GetPipelineStateResult getPipelineState(GetPipelineStateRequest getPipelineStateRequest)
```
    Returns information about the state of a pipeline, including the stages, actions, and details about the last run of the pipeline.
    Specified by:
    
    getPipelineState in interface AWSCodePipeline
    
    Parameters:
    getPipelineStateRequest - Represents the input of a get pipeline state action.
    
    Returns:
    Result of the GetPipelineState operation returned by the service.
    
    Throws:
    
    ValidationException - The validation was specified in an invalid format.
    
    PipelineNotFoundException - The specified pipeline was specified in an invalid format or cannot be found.
    
    Samples:
    - View information about the state of a pipeline
      This example returns the most recent state of a pipeline named MyFirstPipeline.
      
      AWSCodePipeline client = new AWSCodePipelineClient(); GetPipelineStateRequest request = new GetPipelineStateRequest() .withName("MyFirstPipeline"); GetPipelineStateResult response = client.getPipelineState(request);
  - getThirdPartyJobDetails
```
public 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.
    
    Specified by:
    
    getThirdPartyJobDetails in interface AWSCodePipeline
    
    Parameters:
    getThirdPartyJobDetailsRequest - Represents the input of a get third party job details action.
    
    Returns:
    Result of the GetThirdPartyJobDetails operation returned by the service.
    
    Throws:
    
    JobNotFoundException - The specified job was specified in an invalid format or cannot be found.
    
    ValidationException - The validation was specified in an invalid format.
    
    InvalidClientTokenException - The client token was specified in an invalid format
    
    InvalidJobException - The specified job was specified in an invalid format or cannot be found.
  - listActionTypes
```
public ListActionTypesResult listActionTypes(ListActionTypesRequest listActionTypesRequest)
```
    Gets a summary of all AWS CodePipeline action types associated with your account.
    Specified by:
    
    listActionTypes in interface AWSCodePipeline
    
    Parameters:
    listActionTypesRequest - Represents the input of a list action types action.
    
    Returns:
    Result of the ListActionTypes operation returned by the service.
    
    Throws:
    
    ValidationException - The validation was specified in an invalid format.
    
    InvalidNextTokenException - The next token was specified in an invalid format. Make sure that the next token you provided is the token returned by a previous call.
    
    Samples:
    - View a summary of all action types associated with your account
      Used by itself, ListActionTypes returns the structure of all AWS CodePipeline actions available to your AWS account. This example uses the actionOwnerFilter option to limit the response to include only the structure of all custom actions defined for the account.
      
      AWSCodePipeline client = new AWSCodePipelineClient(); ListActionTypesRequest request = new ListActionTypesRequest() .withActionOwnerFilter("Custom").withNextToken(""); ListActionTypesResult response = client.listActionTypes(request);
  - listPipelines
```
public ListPipelinesResult listPipelines(ListPipelinesRequest listPipelinesRequest)
```
    Gets a summary of all of the pipelines associated with your account.
    Specified by:
    
    listPipelines in interface AWSCodePipeline
    
    Parameters:
    listPipelinesRequest - Represents the input of a list pipelines action.
    
    Returns:
    Result of the ListPipelines operation returned by the service.
    
    Throws:
    
    InvalidNextTokenException - The next token was specified in an invalid format. Make sure that the next token you provided is the token returned by a previous call.
    
    Samples:
    - View a summary of all pipelines associated with your account
      This example lists all AWS CodePipeline pipelines associated with the user's AWS account.
      
      AWSCodePipeline client = new AWSCodePipelineClient(); ListPipelinesRequest request = new ListPipelinesRequest(); ListPipelinesResult response = client.listPipelines(request);
  - pollForJobs
```
public PollForJobsResult pollForJobs(PollForJobsRequest pollForJobsRequest)
```
    Returns information about any jobs for AWS CodePipeline to act upon.
    
    When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API returns any secret values defined for the action.
    Specified by:
    
    pollForJobs in interface AWSCodePipeline
    
    Parameters:
    pollForJobsRequest - Represents the input of a poll for jobs action.
    
    Returns:
    Result of the PollForJobs operation returned by the service.
    
    Throws:
    
    ValidationException - The validation was specified in an invalid format.
    
    ActionTypeNotFoundException - The specified action type cannot be found.
    
    Samples:
    - View any available jobs
      This example returns information about any jobs for a job worker to act upon. This command is only used for custom actions. When this command is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline. This command will also return any secret values defined for the action, if any are defined.
      
      AWSCodePipeline client = new AWSCodePipelineClient(); PollForJobsRequest request = new PollForJobsRequest() .withActionTypeId( new ActionTypeId().withVersion("1") .withCategory("Test").withOwner("Custom") .withProvider("MyJenkinsProviderName")) .withMaxBatchSize(5) .addQueryParamEntry("ProjectName", "MyJenkinsTestProj"); PollForJobsResult response = client.pollForJobs(request);
  - pollForThirdPartyJobs
```
public 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.
    
    Specified by:
    
    pollForThirdPartyJobs in interface AWSCodePipeline
    
    Parameters:
    pollForThirdPartyJobsRequest - Represents the input of a poll for third party jobs action.
    
    Returns:
    Result of the PollForThirdPartyJobs operation returned by the service.
    
    Throws:
    
    ActionTypeNotFoundException - The specified action type cannot be found.
    
    ValidationException - The validation was specified in an invalid format.
  - putActionRevision
```
public PutActionRevisionResult putActionRevision(PutActionRevisionRequest putActionRevisionRequest)
```
    Provides information to AWS CodePipeline about new revisions to a source.
    
    Specified by:
    
    putActionRevision in interface AWSCodePipeline
    
    Parameters:
    putActionRevisionRequest - Represents the input of a put action revision action.
    
    Returns:
    Result of the PutActionRevision operation returned by the service.
    
    Throws:
    
    PipelineNotFoundException - The specified pipeline was specified in an invalid format or cannot be found.
    
    StageNotFoundException - The specified stage was specified in an invalid format or cannot be found.
    
    ActionNotFoundException - The specified action cannot be found.
    
    ValidationException - The validation was specified in an invalid format.
  - putJobFailureResult
```
public PutJobFailureResultResult putJobFailureResult(PutJobFailureResultRequest putJobFailureResultRequest)
```
    Represents the failure of a job as returned to the pipeline by a job worker. Only used for custom actions.
    
    Specified by:
    
    putJobFailureResult in interface AWSCodePipeline
    
    Parameters:
    putJobFailureResultRequest - Represents the input of a put job failure result 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.
  - putJobSuccessResult
```
public PutJobSuccessResultResult putJobSuccessResult(PutJobSuccessResultRequest putJobSuccessResultRequest)
```
    Represents the success of a job as returned to the pipeline by a job worker. Only used for custom actions.
    
    Specified by:
    
    putJobSuccessResult in interface AWSCodePipeline
    
    Parameters:
    putJobSuccessResultRequest - Represents the input of a put job success result 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.
  - putThirdPartyJobFailureResult
```
public 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.
    
    Specified by:
    
    putThirdPartyJobFailureResult in interface AWSCodePipeline
    
    Parameters:
    putThirdPartyJobFailureResultRequest - Represents the input of a third party job failure result 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
  - putThirdPartyJobSuccessResult
```
public 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.
    
    Specified by:
    
    putThirdPartyJobSuccessResult in interface AWSCodePipeline
    
    Parameters:
    putThirdPartyJobSuccessResultRequest - Represents the input of a put third party job success result 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
  - startPipelineExecution
```
public 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.
    Specified by:
    
    startPipelineExecution in interface AWSCodePipeline
    
    Parameters:
    startPipelineExecutionRequest - Represents the input of a start pipeline execution action.
    
    Returns:
    Result of the StartPipelineExecution operation returned by the service.
    
    Throws:
    
    ValidationException - The validation was specified in an invalid format.
    
    PipelineNotFoundException - The specified pipeline was specified in an invalid format or cannot be found.
    
    Samples:
    - Run the latest revision through a pipeline
      This example runs the latest revision present in the source stage of a pipeline through the pipeline named "MyFirstPipeline".
      
      AWSCodePipeline client = new AWSCodePipelineClient(); StartPipelineExecutionRequest request = new StartPipelineExecutionRequest() .withName("MyFirstPipeline"); StartPipelineExecutionResult response = client .startPipelineExecution(request);
  - updatePipeline
```
public 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.
    Specified by:
    
    updatePipeline in interface AWSCodePipeline
    
    Parameters:
    updatePipelineRequest - Represents the input of an update pipeline action.
    
    Returns:
    Result of the UpdatePipeline operation returned by the service.
    
    Throws:
    
    ValidationException - The validation was specified in an invalid format.
    
    InvalidStageDeclarationException - The specified stage declaration was specified in an invalid format.
    
    InvalidActionDeclarationException - The specified action declaration was specified in an invalid format.
    
    InvalidBlockerDeclarationException - Reserved for future use.
    
    InvalidStructureException - The specified structure was specified in an invalid format.
    
    Samples:
    - Update the structure of a pipeline
      This example updates the structure of a pipeline. The entire structure of the pipeline must be supplied, either by passing all of the parameters, or by using a pre-defined JSON file.
      
      AWSCodePipeline client = new AWSCodePipelineClient(); UpdatePipelineRequest request = new UpdatePipelineRequest() .withPipeline(new PipelineDeclaration() .withVersion(2) .withName("MyFirstPipeline") .withArtifactStore( new ArtifactStore() .withType("S3") .withLocation( "codepipeline-us-east-1-11EXAMPLE11")) .withRoleArn( "arn:aws:iam::111111111111:role/AWS-CodePipeline-Service") .withStages( new StageDeclaration() .withName("Source") .withActions( new ActionDeclaration() .withName("Source") .withActionTypeId( new ActionTypeId() .withVersion( "1") .withCategory( "Source") .withOwner( "AWS") .withProvider( "S3")) .addConfigurationEntry( "S3Bucket", "awscodepipeline-demo-bucket2") .addConfigurationEntry( "S3ObjectKey", "aws-codepipeline-s3-aws-codedeploy_linux.zip") .withInputArtifacts() .withOutputArtifacts( new OutputArtifact() .withName("MyApp")) .withRunOrder(1)), new StageDeclaration() .withName("Beta") .withActions( new ActionDeclaration() .withName( "CodePipelineDemoFleet") .withActionTypeId( new ActionTypeId() .withVersion( "1") .withCategory( "Deploy") .withOwner( "AWS") .withProvider( "CodeDeploy")) .addConfigurationEntry( "ApplicationName", "CodePipelineDemoApplication") .addConfigurationEntry( "DeploymentGroupName", "CodePipelineDemoFleet") .withInputArtifacts( new InputArtifact() .withName("MyApp")) .withOutputArtifacts() .withRunOrder(1)))); UpdatePipelineResult response = client.updatePipeline(request);
  - getCachedResponseMetadata
```
public 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 the request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AWSCodePipeline
    
    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?

Class AWSCodePipelineClient

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceClient

Methods inherited from class java.lang.Object

Methods inherited from interface com.amazonaws.services.codepipeline.AWSCodePipeline

Constructor Detail

AWSCodePipelineClient

AWSCodePipelineClient

AWSCodePipelineClient

AWSCodePipelineClient

AWSCodePipelineClient

AWSCodePipelineClient

AWSCodePipelineClient

Method Detail

acknowledgeJob

Acknowledge a job for a custom action

acknowledgeThirdPartyJob

createCustomActionType

Create a custom action

createPipeline

Create a pipeline

deleteCustomActionType

Delete a custom action

deletePipeline

Delete a pipeline

disableStageTransition

Disable transitions into or out of a stage

enableStageTransition

Enable transitions into or out of a stage

getJobDetails

Get the details of a job

getPipeline

View the structure of a pipeline

getPipelineState

View information about the state of a pipeline

getThirdPartyJobDetails

listActionTypes

View a summary of all action types associated with your account

listPipelines

View a summary of all pipelines associated with your account

pollForJobs

View any available jobs

pollForThirdPartyJobs

putActionRevision

putJobFailureResult

putJobSuccessResult

putThirdPartyJobFailureResult

putThirdPartyJobSuccessResult

startPipelineExecution

Run the latest revision through a pipeline

updatePipeline

Update the structure of a pipeline

getCachedResponseMetadata