@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 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 Amazon Web Services account.
|
CreatePipelineResult |
createPipeline (CreatePipelineRequest request)
Creates a pipeline.
|
DeleteCustomActionTypeResult |
deleteCustomActionType (DeleteCustomActionTypeRequest request)
Marks a custom action as deleted.
|
DeletePipelineResult |
deletePipeline (DeletePipelineRequest request)
Deletes the specified pipeline.
|
DeleteWebhookResult |
deleteWebhook (DeleteWebhookRequest request)
Deletes a previously created webhook by name.
|
DeregisterWebhookWithThirdPartyResult |
deregisterWebhookWithThirdParty (DeregisterWebhookWithThirdPartyRequest request)
Removes the connection between the webhook that was created by CodePipeline and the external tool with events to
be detected.
|
DisableStageTransitionResult |
disableStageTransition (DisableStageTransitionRequest request)
Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline.
|
EnableStageTransitionResult |
enableStageTransition (EnableStageTransitionRequest request)
Enables artifacts in a pipeline to transition to a stage in a pipeline.
|
GetActionTypeResult |
getActionType (GetActionTypeRequest request)
Returns information about an action type created for an external provider, where the action is to be used by
customers of the external provider.
|
ResponseMetadata |
getCachedResponseMetadata (AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetJobDetailsResult |
getJobDetails (GetJobDetailsRequest request)
Returns information about a job.
|
GetPipelineResult |
getPipeline (GetPipelineRequest request)
Returns the metadata, structure, stages, and actions of a pipeline.
|
GetPipelineExecutionResult |
getPipelineExecution (GetPipelineExecutionRequest request)
Returns information about an execution of a pipeline, including details about artifacts, the pipeline execution
ID, and the name, version, and status of the pipeline.
|
GetPipelineStateResult |
getPipelineState (GetPipelineStateRequest request)
Returns information about the state of a pipeline, including the stages and actions.
|
GetThirdPartyJobDetailsResult |
getThirdPartyJobDetails (GetThirdPartyJobDetailsRequest request)
Requests the details of a job for a third party action.
|
ListActionExecutionsResult |
listActionExecutions (ListActionExecutionsRequest request)
Lists the action executions that have occurred in a pipeline.
|
ListActionTypesResult |
listActionTypes (ListActionTypesRequest request)
Gets a summary of all 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.
|
ListRuleExecutionsResult |
listRuleExecutions (ListRuleExecutionsRequest request)
Lists the rule executions that have occurred in a pipeline configured for conditions with rules.
|
ListRuleTypesResult |
listRuleTypes (ListRuleTypesRequest request)
Lists the rules for the condition.
|
ListTagsForResourceResult |
listTagsForResource (ListTagsForResourceRequest request)
Gets the set of key-value pairs (metadata) that are used to manage the resource.
|
ListWebhooksResult |
listWebhooks (ListWebhooksRequest request)
Gets a listing of all the webhooks in this Amazon Web Services Region for this account.
|
OverrideStageConditionResult |
overrideStageCondition (OverrideStageConditionRequest request)
Used to override a stage condition.
|
PollForJobsResult |
pollForJobs (PollForJobsRequest request)
Returns information about any jobs for CodePipeline to act on.
|
PollForThirdPartyJobsResult |
pollForThirdPartyJobs (PollForThirdPartyJobsRequest request)
Determines whether there are any third party jobs for a job worker to act on.
|
PutActionRevisionResult |
putActionRevision (PutActionRevisionRequest request)
Provides information to CodePipeline about new revisions to a source.
|
PutApprovalResultResult |
putApprovalResult (PutApprovalResultRequest request)
Provides the response to a manual approval request to CodePipeline.
|
PutJobFailureResultResult |
putJobFailureResult (PutJobFailureResultRequest request)
Represents the failure of a job as returned to the pipeline by a job worker.
|
PutJobSuccessResultResult |
putJobSuccessResult (PutJobSuccessResultRequest request)
Represents the success of a job as returned to the pipeline by a job worker.
|
PutThirdPartyJobFailureResultResult |
putThirdPartyJobFailureResult (PutThirdPartyJobFailureResultRequest request)
Represents the failure of a third party job as returned to the pipeline by a job worker.
|
PutThirdPartyJobSuccessResultResult |
putThirdPartyJobSuccessResult (PutThirdPartyJobSuccessResultRequest request)
Represents the success of a third party job as returned to the pipeline by a job worker.
|
PutWebhookResult |
putWebhook (PutWebhookRequest request)
Defines a webhook and returns a unique webhook URL generated by CodePipeline.
|
RegisterWebhookWithThirdPartyResult |
registerWebhookWithThirdParty (RegisterWebhookWithThirdPartyRequest request)
Configures a connection between the webhook that was created and the external tool with events to be detected.
|
RetryStageExecutionResult |
retryStageExecution (RetryStageExecutionRequest request)
You can retry a stage that has failed without having to run a pipeline again from the beginning.
|
RollbackStageResult |
rollbackStage (RollbackStageRequest request)
Rolls back a stage execution.
|
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.
|
StopPipelineExecutionResult |
stopPipelineExecution (StopPipelineExecutionRequest request)
Stops the specified pipeline execution.
|
TagResourceResult |
tagResource (TagResourceRequest request)
Adds to or modifies the tags of the given resource.
|
UntagResourceResult |
untagResource (UntagResourceRequest request)
Removes tags from an Amazon Web Services resource.
|
UpdateActionTypeResult |
updateActionType (UpdateActionTypeRequest request)
Updates an action type that was created with any supported integration model, where the action type is to be used
by customers of the action type provider.
|
UpdatePipelineResult |
updatePipeline (UpdatePipelineRequest request)
Updates a specified pipeline with edits or changes to its structure.
|
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: 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.
setEndpoint in interface AWSCodePipeline 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.public void setRegion(Region region)
AWSCodePipeline AWSCodePipeline.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 AWSCodePipeline region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions)
for accessing a given region. Must not be null and must be a region where the service is available.Region.getRegion(com.amazonaws.regions.Regions),
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration),
Region.isServiceSupported(String) public AcknowledgeJobResult acknowledgeJob(AcknowledgeJobRequest request)
AWSCodePipeline Returns information about a specified job and whether that job has been received by the job worker. Used for custom actions only.
acknowledgeJob in interface AWSCodePipeline request - Represents the input of an AcknowledgeJob action.public AcknowledgeThirdPartyJobResult acknowledgeThirdPartyJob(AcknowledgeThirdPartyJobRequest request)
AWSCodePipeline Confirms a job worker has received the specified job. Used for partner actions only.
acknowledgeThirdPartyJob in interface AWSCodePipeline request - Represents the input of an AcknowledgeThirdPartyJob action.public CreateCustomActionTypeResult createCustomActionType(CreateCustomActionTypeRequest request)
AWSCodePipeline Creates a new custom action that can be used in all pipelines associated with the Amazon Web Services account. Only used for custom actions.
createCustomActionType in interface AWSCodePipeline request - Represents the input of a CreateCustomActionType operation.public CreatePipelineResult createPipeline(CreatePipelineRequest request)
AWSCodePipeline Creates a pipeline.
In the pipeline structure, you must include either artifactStore or artifactStores in
your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use
artifactStores.
createPipeline in interface AWSCodePipeline request - Represents the input of a CreatePipeline action.public DeleteCustomActionTypeResult deleteCustomActionType(DeleteCustomActionTypeRequest request)
AWSCodePipeline
Marks a custom action as deleted. PollForJobs for the custom action fails after the action is marked
for deletion. Used for custom actions only.
To re-create a custom action after it has been deleted you must use a string in the version field that has never been used before. This string can be an incremented version number, for example. To restore a deleted custom action, use a JSON file that is identical to the deleted action, including the original string in the version field.
deleteCustomActionType in interface AWSCodePipeline request - Represents the input of a DeleteCustomActionType operation. The custom action will be marked
as deleted.public DeletePipelineResult deletePipeline(DeletePipelineRequest request)
AWSCodePipeline Deletes the specified pipeline.
deletePipeline in interface AWSCodePipeline request - Represents the input of a DeletePipeline action.public DeleteWebhookResult deleteWebhook(DeleteWebhookRequest request)
AWSCodePipeline Deletes a previously created webhook by name. Deleting the webhook stops CodePipeline from starting a pipeline every time an external event occurs. The API returns successfully when trying to delete a webhook that is already deleted. If a deleted webhook is re-created by calling PutWebhook with the same name, it will have a different URL.
deleteWebhook in interface AWSCodePipeline public DeregisterWebhookWithThirdPartyResult deregisterWebhookWithThirdParty(DeregisterWebhookWithThirdPartyRequest request)
AWSCodePipeline Removes the connection between the webhook that was created by CodePipeline and the external tool with events to be detected. Currently supported only for webhooks that target an action type of GitHub.
deregisterWebhookWithThirdParty in interface AWSCodePipeline public DisableStageTransitionResult disableStageTransition(DisableStageTransitionRequest request)
AWSCodePipeline Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline.
disableStageTransition in interface AWSCodePipeline request - Represents the input of a DisableStageTransition action.public EnableStageTransitionResult enableStageTransition(EnableStageTransitionRequest request)
AWSCodePipeline Enables artifacts in a pipeline to transition to a stage in a pipeline.
enableStageTransition in interface AWSCodePipeline request - Represents the input of an EnableStageTransition action.public GetActionTypeResult getActionType(GetActionTypeRequest request)
AWSCodePipeline Returns information about an action type created for an external provider, where the action is to be used by customers of the external provider. The action can be created with any supported integration model.
getActionType in interface AWSCodePipeline public GetJobDetailsResult getJobDetails(GetJobDetailsRequest request)
AWSCodePipeline Returns information about a job. Used for custom actions only.
When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.
getJobDetails in interface AWSCodePipeline request - Represents the input of a GetJobDetails action.public GetPipelineResult getPipeline(GetPipelineRequest request)
AWSCodePipeline Returns the metadata, structure, stages, and actions of a pipeline. Can be used to return the entire structure of a pipeline in JSON format, which can then be modified and used to update the pipeline structure with UpdatePipeline.
getPipeline in interface AWSCodePipeline request - Represents the input of a GetPipeline action.public GetPipelineExecutionResult getPipelineExecution(GetPipelineExecutionRequest request)
AWSCodePipeline Returns information about an execution of a pipeline, including details about artifacts, the pipeline execution ID, and the name, version, and status of the pipeline.
getPipelineExecution in interface AWSCodePipeline request - Represents the input of a GetPipelineExecution action.public GetPipelineStateResult getPipelineState(GetPipelineStateRequest request)
AWSCodePipeline Returns information about the state of a pipeline, including the stages and actions.
Values returned in the revisionId and revisionUrl fields indicate the source revision
information, such as the commit ID, for the current state.
getPipelineState in interface AWSCodePipeline request - Represents the input of a GetPipelineState action.public GetThirdPartyJobDetailsResult getThirdPartyJobDetails(GetThirdPartyJobDetailsRequest request)
AWSCodePipeline Requests the details of a job for a third party action. Used for partner actions only.
When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.
getThirdPartyJobDetails in interface AWSCodePipeline request - Represents the input of a GetThirdPartyJobDetails action.public ListActionExecutionsResult listActionExecutions(ListActionExecutionsRequest request)
AWSCodePipeline Lists the action executions that have occurred in a pipeline.
listActionExecutions in interface AWSCodePipeline public ListActionTypesResult listActionTypes(ListActionTypesRequest request)
AWSCodePipeline Gets a summary of all CodePipeline action types associated with your account.
listActionTypes in interface AWSCodePipeline request - Represents the input of a ListActionTypes action.public ListPipelineExecutionsResult listPipelineExecutions(ListPipelineExecutionsRequest request)
AWSCodePipeline Gets a summary of the most recent executions for a pipeline.
When applying the filter for pipeline executions that have succeeded in the stage, the operation returns all executions in the current pipeline version beginning on February 1, 2024.
listPipelineExecutions in interface AWSCodePipeline request - Represents the input of a ListPipelineExecutions action.public ListPipelinesResult listPipelines(ListPipelinesRequest request)
AWSCodePipeline Gets a summary of all of the pipelines associated with your account.
listPipelines in interface AWSCodePipeline request - Represents the input of a ListPipelines action.public ListRuleExecutionsResult listRuleExecutions(ListRuleExecutionsRequest request)
AWSCodePipeline Lists the rule executions that have occurred in a pipeline configured for conditions with rules.
listRuleExecutions in interface AWSCodePipeline public ListRuleTypesResult listRuleTypes(ListRuleTypesRequest request)
AWSCodePipeline Lists the rules for the condition.
listRuleTypes in interface AWSCodePipeline public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AWSCodePipeline Gets the set of key-value pairs (metadata) that are used to manage the resource.
listTagsForResource in interface AWSCodePipeline public ListWebhooksResult listWebhooks(ListWebhooksRequest request)
AWSCodePipeline Gets a listing of all the webhooks in this Amazon Web Services Region for this account. The output lists all webhooks and includes the webhook URL and ARN and the configuration for each webhook.
listWebhooks in interface AWSCodePipeline public OverrideStageConditionResult overrideStageCondition(OverrideStageConditionRequest request)
AWSCodePipeline Used to override a stage condition.
overrideStageCondition in interface AWSCodePipeline public PollForJobsResult pollForJobs(PollForJobsRequest request)
AWSCodePipeline
Returns information about any jobs for CodePipeline to act on. PollForJobs is valid only for action
types with "Custom" in the owner field. If the action type contains AWS or ThirdParty
in the owner field, the PollForJobs action returns an error.
When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.
pollForJobs in interface AWSCodePipeline request - Represents the input of a PollForJobs action.public PollForThirdPartyJobsResult pollForThirdPartyJobs(PollForThirdPartyJobsRequest request)
AWSCodePipeline Determines whether there are any third party jobs for a job worker to act on. Used for partner actions only.
When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts.
pollForThirdPartyJobs in interface AWSCodePipeline request - Represents the input of a PollForThirdPartyJobs action.public PutActionRevisionResult putActionRevision(PutActionRevisionRequest request)
AWSCodePipeline Provides information to CodePipeline about new revisions to a source.
putActionRevision in interface AWSCodePipeline request - Represents the input of a PutActionRevision action.public PutApprovalResultResult putApprovalResult(PutApprovalResultRequest request)
AWSCodePipeline Provides the response to a manual approval request to CodePipeline. Valid responses include Approved and Rejected.
putApprovalResult in interface AWSCodePipeline request - Represents the input of a PutApprovalResult action.public PutJobFailureResultResult putJobFailureResult(PutJobFailureResultRequest request)
AWSCodePipeline Represents the failure of a job as returned to the pipeline by a job worker. Used for custom actions only.
putJobFailureResult in interface AWSCodePipeline request - Represents the input of a PutJobFailureResult action.public PutJobSuccessResultResult putJobSuccessResult(PutJobSuccessResultRequest request)
AWSCodePipeline Represents the success of a job as returned to the pipeline by a job worker. Used for custom actions only.
putJobSuccessResult in interface AWSCodePipeline request - Represents the input of a PutJobSuccessResult action.public PutThirdPartyJobFailureResultResult putThirdPartyJobFailureResult(PutThirdPartyJobFailureResultRequest request)
AWSCodePipeline Represents the failure of a third party job as returned to the pipeline by a job worker. Used for partner actions only.
putThirdPartyJobFailureResult in interface AWSCodePipeline request - Represents the input of a PutThirdPartyJobFailureResult action.public PutThirdPartyJobSuccessResultResult putThirdPartyJobSuccessResult(PutThirdPartyJobSuccessResultRequest request)
AWSCodePipeline Represents the success of a third party job as returned to the pipeline by a job worker. Used for partner actions only.
putThirdPartyJobSuccessResult in interface AWSCodePipeline request - Represents the input of a PutThirdPartyJobSuccessResult action.public PutWebhookResult putWebhook(PutWebhookRequest request)
AWSCodePipeline Defines a webhook and returns a unique webhook URL generated by CodePipeline. This URL can be supplied to third party source hosting providers to call every time there's a code change. When CodePipeline receives a POST request on this URL, the pipeline defined in the webhook is started as long as the POST request satisfied the authentication and filtering requirements supplied when defining the webhook. RegisterWebhookWithThirdParty and DeregisterWebhookWithThirdParty APIs can be used to automatically configure supported third parties to call the generated webhook URL.
putWebhook in interface AWSCodePipeline public RegisterWebhookWithThirdPartyResult registerWebhookWithThirdParty(RegisterWebhookWithThirdPartyRequest request)
AWSCodePipeline Configures a connection between the webhook that was created and the external tool with events to be detected.
registerWebhookWithThirdParty in interface AWSCodePipeline public RetryStageExecutionResult retryStageExecution(RetryStageExecutionRequest request)
AWSCodePipeline You can retry a stage that has failed without having to run a pipeline again from the beginning. You do this by either retrying the failed actions in a stage or by retrying all actions in the stage starting from the first action in the stage. When you retry the failed actions in a stage, all actions that are still in progress continue working, and failed actions are triggered again. When you retry a failed stage from the first action in the stage, the stage cannot have any actions in progress. Before a stage can be retried, it must either have all actions failed or some actions failed and some succeeded.
retryStageExecution in interface AWSCodePipeline request - Represents the input of a RetryStageExecution action.public RollbackStageResult rollbackStage(RollbackStageRequest request)
AWSCodePipeline Rolls back a stage execution.
rollbackStage in interface AWSCodePipeline public StartPipelineExecutionResult startPipelineExecution(StartPipelineExecutionRequest request)
AWSCodePipeline Starts the specified pipeline. Specifically, it begins processing the latest commit to the source location specified as part of the pipeline.
startPipelineExecution in interface AWSCodePipeline request - Represents the input of a StartPipelineExecution action.public StopPipelineExecutionResult stopPipelineExecution(StopPipelineExecutionRequest request)
AWSCodePipeline
Stops the specified pipeline execution. You choose to either stop the pipeline execution by completing
in-progress actions without starting subsequent actions, or by abandoning in-progress actions. While completing
or abandoning in-progress actions, the pipeline execution is in a Stopping state. After all
in-progress actions are completed or abandoned, the pipeline execution is in a Stopped state.
stopPipelineExecution in interface AWSCodePipeline public TagResourceResult tagResource(TagResourceRequest request)
AWSCodePipeline Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.
tagResource in interface AWSCodePipeline public UntagResourceResult untagResource(UntagResourceRequest request)
AWSCodePipeline Removes tags from an Amazon Web Services resource.
untagResource in interface AWSCodePipeline public UpdateActionTypeResult updateActionType(UpdateActionTypeRequest request)
AWSCodePipeline
Updates an action type that was created with any supported integration model, where the action type is to be used
by customers of the action type provider. Use a JSON file with the action definition and
UpdateActionType to provide the full structure.
updateActionType in interface AWSCodePipeline public UpdatePipelineResult updatePipeline(UpdatePipelineRequest request)
AWSCodePipeline
Updates a specified pipeline with edits or changes to its structure. Use a JSON file with the pipeline structure
and UpdatePipeline to provide the full structure of the pipeline. Updating the pipeline increases
the version number of the pipeline by 1.
updatePipeline in interface AWSCodePipeline request - Represents the input of an UpdatePipeline action.public void shutdown()
AWSCodePipeline shutdown in interface AWSCodePipeline public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AWSCodePipeline 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.
getCachedResponseMetadata in interface AWSCodePipeline request - The originally executed request.