@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAWSCodePipeline extends Object implements AWSCodePipeline
AWSCodePipeline. Convenient method forms pass through to the corresponding
overload that takes a request object, which throws an UnsupportedOperationException.ENDPOINT_PREFIX| Modifier | Constructor and Description |
|---|---|
protected |
AbstractAWSCodePipeline() |
| Modifier and Type | Method and Description |
|---|---|
AcknowledgeJobResult |
acknowledgeJob(AcknowledgeJobRequest request)
Returns information about a specified job and whether that job has been received by the job worker.
|
AcknowledgeThirdPartyJobResult |
acknowledgeThirdPartyJob(AcknowledgeThirdPartyJobRequest request)
Confirms a job worker has received the specified job.
|
CreateCustomActionTypeResult |
createCustomActionType(CreateCustomActionTypeRequest request)
Creates a new custom action that can be used in all pipelines associated with the AWS account.
|
CreatePipelineResult |
createPipeline(CreatePipelineRequest request)
Creates a pipeline.
|
DeleteCustomActionTypeResult |
deleteCustomActionType(DeleteCustomActionTypeRequest request)
Marks a custom action as deleted.
|
DeletePipelineResult |
deletePipeline(DeletePipelineRequest request)
Deletes the specified pipeline.
|
DisableStageTransitionResult |
disableStageTransition(DisableStageTransitionRequest request)
Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline.
|
EnableStageTransitionResult |
enableStageTransition(EnableStageTransitionRequest request)
Enables artifacts in a pipeline to transition to a stage in a pipeline.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetJobDetailsResult |
getJobDetails(GetJobDetailsRequest request)
Returns information about a job.
|
GetPipelineResult |
getPipeline(GetPipelineRequest request)
Returns the metadata, structure, stages, and actions of a pipeline.
|
GetPipelineExecutionResult |
getPipelineExecution(GetPipelineExecutionRequest request)
Returns information about an execution of a pipeline, including details about artifacts, the pipeline execution
ID, and the name, version, and status of the pipeline.
|
GetPipelineStateResult |
getPipelineState(GetPipelineStateRequest request)
Returns information about the state of a pipeline, including the stages and actions.
|
GetThirdPartyJobDetailsResult |
getThirdPartyJobDetails(GetThirdPartyJobDetailsRequest request)
Requests the details of a job for a third party action.
|
ListActionTypesResult |
listActionTypes(ListActionTypesRequest request)
Gets a summary of all AWS CodePipeline action types associated with your account.
|
ListPipelineExecutionsResult |
listPipelineExecutions(ListPipelineExecutionsRequest request)
Gets a summary of the most recent executions for a pipeline.
|
ListPipelinesResult |
listPipelines(ListPipelinesRequest request)
Gets a summary of all of the pipelines associated with your account.
|
PollForJobsResult |
pollForJobs(PollForJobsRequest request)
Returns information about any jobs for AWS CodePipeline to act upon.
|
PollForThirdPartyJobsResult |
pollForThirdPartyJobs(PollForThirdPartyJobsRequest request)
Determines whether there are any third party jobs for a job worker to act on.
|
PutActionRevisionResult |
putActionRevision(PutActionRevisionRequest request)
Provides information to AWS CodePipeline about new revisions to a source.
|
PutApprovalResultResult |
putApprovalResult(PutApprovalResultRequest request)
Provides the response to a manual approval request to AWS CodePipeline.
|
PutJobFailureResultResult |
putJobFailureResult(PutJobFailureResultRequest request)
Represents the failure of a job as returned to the pipeline by a job worker.
|
PutJobSuccessResultResult |
putJobSuccessResult(PutJobSuccessResultRequest request)
Represents the success of a job as returned to the pipeline by a job worker.
|
PutThirdPartyJobFailureResultResult |
putThirdPartyJobFailureResult(PutThirdPartyJobFailureResultRequest request)
Represents the failure of a third party job as returned to the pipeline by a job worker.
|
PutThirdPartyJobSuccessResultResult |
putThirdPartyJobSuccessResult(PutThirdPartyJobSuccessResultRequest request)
Represents the success of a third party job as returned to the pipeline by a job worker.
|
RetryStageExecutionResult |
retryStageExecution(RetryStageExecutionRequest request)
Resumes the pipeline execution by retrying the last failed actions in a stage.
|
void |
setEndpoint(String endpoint)
Overrides the default endpoint for this client ("https://codepipeline.us-east-1.amazonaws.com").
|
void |
setRegion(Region region)
An alternative to
AWSCodePipeline.setEndpoint(String), sets the regional endpoint for this client's
service calls. |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
StartPipelineExecutionResult |
startPipelineExecution(StartPipelineExecutionRequest request)
Starts the specified pipeline.
|
UpdatePipelineResult |
updatePipeline(UpdatePipelineRequest request)
Updates a specified pipeline with edits or changes to its structure.
|
public void setEndpoint(String endpoint)
AWSCodePipeline
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: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912
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.
setEndpoint in interface AWSCodePipelineendpoint - 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.public void setRegion(Region region)
AWSCodePipelineAWSCodePipeline.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.
setRegion in interface AWSCodePipelineregion - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions)
for accessing a given region. Must not be null and must be a region where the service is available.Region.getRegion(com.amazonaws.regions.Regions),
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration),
Region.isServiceSupported(String)public AcknowledgeJobResult acknowledgeJob(AcknowledgeJobRequest request)
AWSCodePipelineReturns information about a specified job and whether that job has been received by the job worker. Only used for custom actions.
acknowledgeJob in interface AWSCodePipelinerequest - Represents the input of an acknowledge job action.public AcknowledgeThirdPartyJobResult acknowledgeThirdPartyJob(AcknowledgeThirdPartyJobRequest request)
AWSCodePipelineConfirms a job worker has received the specified job. Only used for partner actions.
acknowledgeThirdPartyJob in interface AWSCodePipelinerequest - Represents the input of an acknowledge third party job action.public CreateCustomActionTypeResult createCustomActionType(CreateCustomActionTypeRequest request)
AWSCodePipelineCreates a new custom action that can be used in all pipelines associated with the AWS account. Only used for custom actions.
createCustomActionType in interface AWSCodePipelinerequest - Represents the input of a create custom action operation.public CreatePipelineResult createPipeline(CreatePipelineRequest request)
AWSCodePipelineCreates a pipeline.
createPipeline in interface AWSCodePipelinerequest - Represents the input of a create pipeline action.public DeleteCustomActionTypeResult deleteCustomActionType(DeleteCustomActionTypeRequest request)
AWSCodePipelineMarks 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.
deleteCustomActionType in interface AWSCodePipelinerequest - Represents the input of a delete custom action operation. The custom action will be marked as deleted.public DeletePipelineResult deletePipeline(DeletePipelineRequest request)
AWSCodePipelineDeletes the specified pipeline.
deletePipeline in interface AWSCodePipelinerequest - Represents the input of a delete pipeline action.public DisableStageTransitionResult disableStageTransition(DisableStageTransitionRequest request)
AWSCodePipelinePrevents artifacts in a pipeline from transitioning to the next stage in the pipeline.
disableStageTransition in interface AWSCodePipelinerequest - Represents the input of a disable stage transition input action.public EnableStageTransitionResult enableStageTransition(EnableStageTransitionRequest request)
AWSCodePipelineEnables artifacts in a pipeline to transition to a stage in a pipeline.
enableStageTransition in interface AWSCodePipelinerequest - Represents the input of an enable stage transition action.public GetJobDetailsResult getJobDetails(GetJobDetailsRequest request)
AWSCodePipelineReturns 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.
getJobDetails in interface AWSCodePipelinerequest - Represents the input of a get job details action.public GetPipelineResult getPipeline(GetPipelineRequest request)
AWSCodePipelineReturns the metadata, structure, stages, and actions of a pipeline. Can be used to return the entire structure of a pipeline in JSON format, which can then be modified and used to update the pipeline structure with UpdatePipeline.
getPipeline in interface AWSCodePipelinerequest - Represents the input of a get pipeline action.public GetPipelineExecutionResult getPipelineExecution(GetPipelineExecutionRequest request)
AWSCodePipelineReturns information about an execution of a pipeline, including details about artifacts, the pipeline execution ID, and the name, version, and status of the pipeline.
getPipelineExecution in interface AWSCodePipelinerequest - Represents the input of a get pipeline execution action.public GetPipelineStateResult getPipelineState(GetPipelineStateRequest request)
AWSCodePipelineReturns information about the state of a pipeline, including the stages and actions.
getPipelineState in interface AWSCodePipelinerequest - Represents the input of a get pipeline state action.public GetThirdPartyJobDetailsResult getThirdPartyJobDetails(GetThirdPartyJobDetailsRequest request)
AWSCodePipelineRequests 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.
getThirdPartyJobDetails in interface AWSCodePipelinerequest - Represents the input of a get third party job details action.public ListActionTypesResult listActionTypes(ListActionTypesRequest request)
AWSCodePipelineGets a summary of all AWS CodePipeline action types associated with your account.
listActionTypes in interface AWSCodePipelinerequest - Represents the input of a list action types action.public ListPipelineExecutionsResult listPipelineExecutions(ListPipelineExecutionsRequest request)
AWSCodePipelineGets a summary of the most recent executions for a pipeline.
listPipelineExecutions in interface AWSCodePipelinerequest - Represents the input of a list pipeline executions action.public ListPipelinesResult listPipelines(ListPipelinesRequest request)
AWSCodePipelineGets a summary of all of the pipelines associated with your account.
listPipelines in interface AWSCodePipelinerequest - Represents the input of a list pipelines action.public PollForJobsResult pollForJobs(PollForJobsRequest request)
AWSCodePipelineReturns 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.
pollForJobs in interface AWSCodePipelinerequest - Represents the input of a poll for jobs action.public PollForThirdPartyJobsResult pollForThirdPartyJobs(PollForThirdPartyJobsRequest request)
AWSCodePipelineDetermines 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.
pollForThirdPartyJobs in interface AWSCodePipelinerequest - Represents the input of a poll for third party jobs action.public PutActionRevisionResult putActionRevision(PutActionRevisionRequest request)
AWSCodePipelineProvides information to AWS CodePipeline about new revisions to a source.
putActionRevision in interface AWSCodePipelinerequest - Represents the input of a put action revision action.public PutApprovalResultResult putApprovalResult(PutApprovalResultRequest request)
AWSCodePipelineProvides the response to a manual approval request to AWS CodePipeline. Valid responses include Approved and Rejected.
putApprovalResult in interface AWSCodePipelinerequest - Represents the input of a put approval result action.public PutJobFailureResultResult putJobFailureResult(PutJobFailureResultRequest request)
AWSCodePipelineRepresents the failure of a job as returned to the pipeline by a job worker. Only used for custom actions.
putJobFailureResult in interface AWSCodePipelinerequest - Represents the input of a put job failure result action.public PutJobSuccessResultResult putJobSuccessResult(PutJobSuccessResultRequest request)
AWSCodePipelineRepresents the success of a job as returned to the pipeline by a job worker. Only used for custom actions.
putJobSuccessResult in interface AWSCodePipelinerequest - Represents the input of a put job success result action.public PutThirdPartyJobFailureResultResult putThirdPartyJobFailureResult(PutThirdPartyJobFailureResultRequest request)
AWSCodePipelineRepresents the failure of a third party job as returned to the pipeline by a job worker. Only used for partner actions.
putThirdPartyJobFailureResult in interface AWSCodePipelinerequest - Represents the input of a third party job failure result action.public PutThirdPartyJobSuccessResultResult putThirdPartyJobSuccessResult(PutThirdPartyJobSuccessResultRequest request)
AWSCodePipelineRepresents the success of a third party job as returned to the pipeline by a job worker. Only used for partner actions.
putThirdPartyJobSuccessResult in interface AWSCodePipelinerequest - Represents the input of a put third party job success result action.public RetryStageExecutionResult retryStageExecution(RetryStageExecutionRequest request)
AWSCodePipelineResumes the pipeline execution by retrying the last failed actions in a stage.
retryStageExecution in interface AWSCodePipelinerequest - Represents the input of a retry stage execution action.public StartPipelineExecutionResult startPipelineExecution(StartPipelineExecutionRequest request)
AWSCodePipelineStarts the specified pipeline. Specifically, it begins processing the latest commit to the source location specified as part of the pipeline.
startPipelineExecution in interface AWSCodePipelinerequest - Represents the input of a start pipeline execution action.public UpdatePipelineResult updatePipeline(UpdatePipelineRequest request)
AWSCodePipelineUpdates 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.
updatePipeline in interface AWSCodePipelinerequest - Represents the input of an update pipeline action.public void shutdown()
AWSCodePipelineshutdown in interface AWSCodePipelinepublic ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AWSCodePipelineResponse 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.
getCachedResponseMetadata in interface AWSCodePipelinerequest - The originally executed request.Copyright © 2017. All rights reserved.