@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface CodePipelineClient extends AwsClient
builder() method.
Overview
This is the CodePipeline API Reference. This guide provides descriptions of the actions and data types for CodePipeline. Some functionality for your pipeline can only be configured through the API. For more information, see the CodePipeline User Guide.
You can use the CodePipeline API to work with pipelines, stages, actions, and transitions.
Pipelines are models of automated release processes. Each pipeline is uniquely named, and consists of stages, actions, and transitions.
You can work with pipelines by calling:
CreatePipeline, which creates a uniquely named pipeline.
DeletePipeline, which deletes the specified pipeline.
GetPipeline, which returns information about the pipeline structure and pipeline metadata, including the pipeline Amazon Resource Name (ARN).
GetPipelineExecution, which returns information about a specific execution of a pipeline.
GetPipelineState, which returns information about the current state of the stages and actions of a pipeline.
ListActionExecutions, which returns action-level details for past executions. The details include full stage and action-level details, including individual action duration, status, any errors that occurred during the execution, and input and output artifact location details.
ListPipelines, which gets a summary of all of the pipelines associated with your account.
ListPipelineExecutions, which gets a summary of the most recent executions for a pipeline.
StartPipelineExecution, which runs the most recent revision of an artifact through the pipeline.
StopPipelineExecution, which stops the specified pipeline execution from continuing through the pipeline.
UpdatePipeline, which updates a pipeline with edits or changes to the structure of the pipeline.
Pipelines include stages. Each stage contains one or more actions that must complete before the next stage begins. A stage results in success or failure. If a stage fails, the pipeline stops at that stage and remains stopped until either a new version of an artifact appears in the source location, or a user takes action to rerun the most recent artifact through the pipeline. You can call GetPipelineState, which displays the status of a pipeline, including the status of stages in the pipeline, or GetPipeline, which returns the entire structure of the pipeline, including the stages of that pipeline. For more information about the structure of stages and actions, see CodePipeline Pipeline Structure Reference.
Pipeline stages include actions that are categorized into categories such as source or build actions performed in a stage of a pipeline. For example, you can use a source action to import artifacts into a pipeline from a source such as Amazon S3. Like stages, you do not work with actions directly in most cases, but you do define and interact with actions when working with pipeline operations such as CreatePipeline and GetPipelineState. Valid action categories are:
Source
Build
Test
Deploy
Approval
Invoke
Pipelines also include transitions, which allow the transition of artifacts from one stage to the next in a pipeline after the actions in one stage complete.
You can work with transitions by calling:
DisableStageTransition, which prevents artifacts from transitioning to the next stage in a pipeline.
EnableStageTransition, which enables transition of artifacts between stages in a pipeline.
Using the API to integrate with CodePipeline
For third-party integrators or developers who want to create their own integrations with CodePipeline, the expected sequence varies from the standard API user. To integrate with CodePipeline, developers need to work with the following items:
Jobs, which are instances of an action. For example, a job for a source action might import a revision of an artifact from a source.
You can work with jobs by calling:
AcknowledgeJob, which confirms whether a job worker has received the specified job.
GetJobDetails, which returns the details of a job.
PollForJobs, which determines whether there are any jobs to act on.
PutJobFailureResult, which provides details of a job failure.
PutJobSuccessResult, which provides details of a job success.
Third party jobs, which are instances of an action created by a partner action and integrated into CodePipeline. Partner actions are created by members of the Amazon Web Services Partner Network.
You can work with third party jobs by calling:
AcknowledgeThirdPartyJob, which confirms whether a job worker has received the specified job.
GetThirdPartyJobDetails, which requests the details of a job for a partner action.
PollForThirdPartyJobs, which determines whether there are any jobs to act on.
PutThirdPartyJobFailureResult, which provides details of a job failure.
PutThirdPartyJobSuccessResult, which provides details of a job success.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
default AcknowledgeJobResponse |
acknowledgeJob(AcknowledgeJobRequest acknowledgeJobRequest)
Returns information about a specified job and whether that job has been received by the job worker.
|
default AcknowledgeJobResponse |
acknowledgeJob(Consumer<AcknowledgeJobRequest.Builder> acknowledgeJobRequest)
Returns information about a specified job and whether that job has been received by the job worker.
|
default AcknowledgeThirdPartyJobResponse |
acknowledgeThirdPartyJob(AcknowledgeThirdPartyJobRequest acknowledgeThirdPartyJobRequest)
Confirms a job worker has received the specified job.
|
default AcknowledgeThirdPartyJobResponse |
acknowledgeThirdPartyJob(Consumer<AcknowledgeThirdPartyJobRequest.Builder> acknowledgeThirdPartyJobRequest)
Confirms a job worker has received the specified job.
|
static CodePipelineClientBuilder |
builder()
Create a builder that can be used to configure and create a
CodePipelineClient. |
static CodePipelineClient |
create()
Create a
CodePipelineClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CreateCustomActionTypeResponse |
createCustomActionType(Consumer<CreateCustomActionTypeRequest.Builder> createCustomActionTypeRequest)
Creates a new custom action that can be used in all pipelines associated with the Amazon Web Services account.
|
default CreateCustomActionTypeResponse |
createCustomActionType(CreateCustomActionTypeRequest createCustomActionTypeRequest)
Creates a new custom action that can be used in all pipelines associated with the Amazon Web Services account.
|
default CreatePipelineResponse |
createPipeline(Consumer<CreatePipelineRequest.Builder> createPipelineRequest)
Creates a pipeline.
|
default CreatePipelineResponse |
createPipeline(CreatePipelineRequest createPipelineRequest)
Creates a pipeline.
|
default DeleteCustomActionTypeResponse |
deleteCustomActionType(Consumer<DeleteCustomActionTypeRequest.Builder> deleteCustomActionTypeRequest)
Marks a custom action as deleted.
|
default DeleteCustomActionTypeResponse |
deleteCustomActionType(DeleteCustomActionTypeRequest deleteCustomActionTypeRequest)
Marks a custom action as deleted.
|
default DeletePipelineResponse |
deletePipeline(Consumer<DeletePipelineRequest.Builder> deletePipelineRequest)
Deletes the specified pipeline.
|
default DeletePipelineResponse |
deletePipeline(DeletePipelineRequest deletePipelineRequest)
Deletes the specified pipeline.
|
default DeleteWebhookResponse |
deleteWebhook(Consumer<DeleteWebhookRequest.Builder> deleteWebhookRequest)
Deletes a previously created webhook by name.
|
default DeleteWebhookResponse |
deleteWebhook(DeleteWebhookRequest deleteWebhookRequest)
Deletes a previously created webhook by name.
|
default DeregisterWebhookWithThirdPartyResponse |
deregisterWebhookWithThirdParty(Consumer<DeregisterWebhookWithThirdPartyRequest.Builder> deregisterWebhookWithThirdPartyRequest)
Removes the connection between the webhook that was created by CodePipeline and the external tool with events to
be detected.
|
default DeregisterWebhookWithThirdPartyResponse |
deregisterWebhookWithThirdParty(DeregisterWebhookWithThirdPartyRequest deregisterWebhookWithThirdPartyRequest)
Removes the connection between the webhook that was created by CodePipeline and the external tool with events to
be detected.
|
default DisableStageTransitionResponse |
disableStageTransition(Consumer<DisableStageTransitionRequest.Builder> disableStageTransitionRequest)
Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline.
|
default DisableStageTransitionResponse |
disableStageTransition(DisableStageTransitionRequest disableStageTransitionRequest)
Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline.
|
default EnableStageTransitionResponse |
enableStageTransition(Consumer<EnableStageTransitionRequest.Builder> enableStageTransitionRequest)
Enables artifacts in a pipeline to transition to a stage in a pipeline.
|
default EnableStageTransitionResponse |
enableStageTransition(EnableStageTransitionRequest enableStageTransitionRequest)
Enables artifacts in a pipeline to transition to a stage in a pipeline.
|
default GetActionTypeResponse |
getActionType(Consumer<GetActionTypeRequest.Builder> getActionTypeRequest)
Returns information about an action type created for an external provider, where the action is to be used by
customers of the external provider.
|
default GetActionTypeResponse |
getActionType(GetActionTypeRequest getActionTypeRequest)
Returns information about an action type created for an external provider, where the action is to be used by
customers of the external provider.
|
default GetJobDetailsResponse |
getJobDetails(Consumer<GetJobDetailsRequest.Builder> getJobDetailsRequest)
Returns information about a job.
|
default GetJobDetailsResponse |
getJobDetails(GetJobDetailsRequest getJobDetailsRequest)
Returns information about a job.
|
default GetPipelineResponse |
getPipeline(Consumer<GetPipelineRequest.Builder> getPipelineRequest)
Returns the metadata, structure, stages, and actions of a pipeline.
|
default GetPipelineResponse |
getPipeline(GetPipelineRequest getPipelineRequest)
Returns the metadata, structure, stages, and actions of a pipeline.
|
default GetPipelineExecutionResponse |
getPipelineExecution(Consumer<GetPipelineExecutionRequest.Builder> getPipelineExecutionRequest)
Returns information about an execution of a pipeline, including details about artifacts, the pipeline execution
ID, and the name, version, and status of the pipeline.
|
default GetPipelineExecutionResponse |
getPipelineExecution(GetPipelineExecutionRequest getPipelineExecutionRequest)
Returns information about an execution of a pipeline, including details about artifacts, the pipeline execution
ID, and the name, version, and status of the pipeline.
|
default GetPipelineStateResponse |
getPipelineState(Consumer<GetPipelineStateRequest.Builder> getPipelineStateRequest)
Returns information about the state of a pipeline, including the stages and actions.
|
default GetPipelineStateResponse |
getPipelineState(GetPipelineStateRequest getPipelineStateRequest)
Returns information about the state of a pipeline, including the stages and actions.
|
default GetThirdPartyJobDetailsResponse |
getThirdPartyJobDetails(Consumer<GetThirdPartyJobDetailsRequest.Builder> getThirdPartyJobDetailsRequest)
Requests the details of a job for a third party action.
|
default GetThirdPartyJobDetailsResponse |
getThirdPartyJobDetails(GetThirdPartyJobDetailsRequest getThirdPartyJobDetailsRequest)
Requests the details of a job for a third party action.
|
default ListActionExecutionsResponse |
listActionExecutions(Consumer<ListActionExecutionsRequest.Builder> listActionExecutionsRequest)
Lists the action executions that have occurred in a pipeline.
|
default ListActionExecutionsResponse |
listActionExecutions(ListActionExecutionsRequest listActionExecutionsRequest)
Lists the action executions that have occurred in a pipeline.
|
default ListActionExecutionsIterable |
listActionExecutionsPaginator(Consumer<ListActionExecutionsRequest.Builder> listActionExecutionsRequest)
Lists the action executions that have occurred in a pipeline.
|
default ListActionExecutionsIterable |
listActionExecutionsPaginator(ListActionExecutionsRequest listActionExecutionsRequest)
Lists the action executions that have occurred in a pipeline.
|
default ListActionTypesResponse |
listActionTypes()
Gets a summary of all CodePipeline action types associated with your account.
|
default ListActionTypesResponse |
listActionTypes(Consumer<ListActionTypesRequest.Builder> listActionTypesRequest)
Gets a summary of all CodePipeline action types associated with your account.
|
default ListActionTypesResponse |
listActionTypes(ListActionTypesRequest listActionTypesRequest)
Gets a summary of all CodePipeline action types associated with your account.
|
default ListActionTypesIterable |
listActionTypesPaginator()
Gets a summary of all CodePipeline action types associated with your account.
|
default ListActionTypesIterable |
listActionTypesPaginator(Consumer<ListActionTypesRequest.Builder> listActionTypesRequest)
Gets a summary of all CodePipeline action types associated with your account.
|
default ListActionTypesIterable |
listActionTypesPaginator(ListActionTypesRequest listActionTypesRequest)
Gets a summary of all CodePipeline action types associated with your account.
|
default ListPipelineExecutionsResponse |
listPipelineExecutions(Consumer<ListPipelineExecutionsRequest.Builder> listPipelineExecutionsRequest)
Gets a summary of the most recent executions for a pipeline.
|
default ListPipelineExecutionsResponse |
listPipelineExecutions(ListPipelineExecutionsRequest listPipelineExecutionsRequest)
Gets a summary of the most recent executions for a pipeline.
|
default ListPipelineExecutionsIterable |
listPipelineExecutionsPaginator(Consumer<ListPipelineExecutionsRequest.Builder> listPipelineExecutionsRequest)
Gets a summary of the most recent executions for a pipeline.
|
default ListPipelineExecutionsIterable |
listPipelineExecutionsPaginator(ListPipelineExecutionsRequest listPipelineExecutionsRequest)
Gets a summary of the most recent executions for a pipeline.
|
default ListPipelinesResponse |
listPipelines()
Gets a summary of all of the pipelines associated with your account.
|
default ListPipelinesResponse |
listPipelines(Consumer<ListPipelinesRequest.Builder> listPipelinesRequest)
Gets a summary of all of the pipelines associated with your account.
|
default ListPipelinesResponse |
listPipelines(ListPipelinesRequest listPipelinesRequest)
Gets a summary of all of the pipelines associated with your account.
|
default ListPipelinesIterable |
listPipelinesPaginator()
Gets a summary of all of the pipelines associated with your account.
|
default ListPipelinesIterable |
listPipelinesPaginator(Consumer<ListPipelinesRequest.Builder> listPipelinesRequest)
Gets a summary of all of the pipelines associated with your account.
|
default ListPipelinesIterable |
listPipelinesPaginator(ListPipelinesRequest listPipelinesRequest)
Gets a summary of all of the pipelines associated with your account.
|
default ListTagsForResourceResponse |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Gets the set of key-value pairs (metadata) that are used to manage the resource.
|
default ListTagsForResourceResponse |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Gets the set of key-value pairs (metadata) that are used to manage the resource.
|
default ListTagsForResourceIterable |
listTagsForResourcePaginator(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Gets the set of key-value pairs (metadata) that are used to manage the resource.
|
default ListTagsForResourceIterable |
listTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest)
Gets the set of key-value pairs (metadata) that are used to manage the resource.
|
default ListWebhooksResponse |
listWebhooks()
Gets a listing of all the webhooks in this Amazon Web Services Region for this account.
|
default ListWebhooksResponse |
listWebhooks(Consumer<ListWebhooksRequest.Builder> listWebhooksRequest)
Gets a listing of all the webhooks in this Amazon Web Services Region for this account.
|
default ListWebhooksResponse |
listWebhooks(ListWebhooksRequest listWebhooksRequest)
Gets a listing of all the webhooks in this Amazon Web Services Region for this account.
|
default ListWebhooksIterable |
listWebhooksPaginator()
Gets a listing of all the webhooks in this Amazon Web Services Region for this account.
|
default ListWebhooksIterable |
listWebhooksPaginator(Consumer<ListWebhooksRequest.Builder> listWebhooksRequest)
Gets a listing of all the webhooks in this Amazon Web Services Region for this account.
|
default ListWebhooksIterable |
listWebhooksPaginator(ListWebhooksRequest listWebhooksRequest)
Gets a listing of all the webhooks in this Amazon Web Services Region for this account.
|
default PollForJobsResponse |
pollForJobs(Consumer<PollForJobsRequest.Builder> pollForJobsRequest)
Returns information about any jobs for CodePipeline to act on.
|
default PollForJobsResponse |
pollForJobs(PollForJobsRequest pollForJobsRequest)
Returns information about any jobs for CodePipeline to act on.
|
default PollForThirdPartyJobsResponse |
pollForThirdPartyJobs(Consumer<PollForThirdPartyJobsRequest.Builder> pollForThirdPartyJobsRequest)
Determines whether there are any third party jobs for a job worker to act on.
|
default PollForThirdPartyJobsResponse |
pollForThirdPartyJobs(PollForThirdPartyJobsRequest pollForThirdPartyJobsRequest)
Determines whether there are any third party jobs for a job worker to act on.
|
default PutActionRevisionResponse |
putActionRevision(Consumer<PutActionRevisionRequest.Builder> putActionRevisionRequest)
Provides information to CodePipeline about new revisions to a source.
|
default PutActionRevisionResponse |
putActionRevision(PutActionRevisionRequest putActionRevisionRequest)
Provides information to CodePipeline about new revisions to a source.
|
default PutApprovalResultResponse |
putApprovalResult(Consumer<PutApprovalResultRequest.Builder> putApprovalResultRequest)
Provides the response to a manual approval request to CodePipeline.
|
default PutApprovalResultResponse |
putApprovalResult(PutApprovalResultRequest putApprovalResultRequest)
Provides the response to a manual approval request to CodePipeline.
|
default PutJobFailureResultResponse |
putJobFailureResult(Consumer<PutJobFailureResultRequest.Builder> putJobFailureResultRequest)
Represents the failure of a job as returned to the pipeline by a job worker.
|
default PutJobFailureResultResponse |
putJobFailureResult(PutJobFailureResultRequest putJobFailureResultRequest)
Represents the failure of a job as returned to the pipeline by a job worker.
|
default PutJobSuccessResultResponse |
putJobSuccessResult(Consumer<PutJobSuccessResultRequest.Builder> putJobSuccessResultRequest)
Represents the success of a job as returned to the pipeline by a job worker.
|
default PutJobSuccessResultResponse |
putJobSuccessResult(PutJobSuccessResultRequest putJobSuccessResultRequest)
Represents the success of a job as returned to the pipeline by a job worker.
|
default PutThirdPartyJobFailureResultResponse |
putThirdPartyJobFailureResult(Consumer<PutThirdPartyJobFailureResultRequest.Builder> putThirdPartyJobFailureResultRequest)
Represents the failure of a third party job as returned to the pipeline by a job worker.
|
default PutThirdPartyJobFailureResultResponse |
putThirdPartyJobFailureResult(PutThirdPartyJobFailureResultRequest putThirdPartyJobFailureResultRequest)
Represents the failure of a third party job as returned to the pipeline by a job worker.
|
default PutThirdPartyJobSuccessResultResponse |
putThirdPartyJobSuccessResult(Consumer<PutThirdPartyJobSuccessResultRequest.Builder> putThirdPartyJobSuccessResultRequest)
Represents the success of a third party job as returned to the pipeline by a job worker.
|
default PutThirdPartyJobSuccessResultResponse |
putThirdPartyJobSuccessResult(PutThirdPartyJobSuccessResultRequest putThirdPartyJobSuccessResultRequest)
Represents the success of a third party job as returned to the pipeline by a job worker.
|
default PutWebhookResponse |
putWebhook(Consumer<PutWebhookRequest.Builder> putWebhookRequest)
Defines a webhook and returns a unique webhook URL generated by CodePipeline.
|
default PutWebhookResponse |
putWebhook(PutWebhookRequest putWebhookRequest)
Defines a webhook and returns a unique webhook URL generated by CodePipeline.
|
default RegisterWebhookWithThirdPartyResponse |
registerWebhookWithThirdParty(Consumer<RegisterWebhookWithThirdPartyRequest.Builder> registerWebhookWithThirdPartyRequest)
Configures a connection between the webhook that was created and the external tool with events to be detected.
|
default RegisterWebhookWithThirdPartyResponse |
registerWebhookWithThirdParty(RegisterWebhookWithThirdPartyRequest registerWebhookWithThirdPartyRequest)
Configures a connection between the webhook that was created and the external tool with events to be detected.
|
default RetryStageExecutionResponse |
retryStageExecution(Consumer<RetryStageExecutionRequest.Builder> retryStageExecutionRequest)
You can retry a stage that has failed without having to run a pipeline again from the beginning.
|
default RetryStageExecutionResponse |
retryStageExecution(RetryStageExecutionRequest retryStageExecutionRequest)
You can retry a stage that has failed without having to run a pipeline again from the beginning.
|
default CodePipelineServiceClientConfiguration |
serviceClientConfiguration() |
static ServiceMetadata |
serviceMetadata() |
default StartPipelineExecutionResponse |
startPipelineExecution(Consumer<StartPipelineExecutionRequest.Builder> startPipelineExecutionRequest)
Starts the specified pipeline.
|
default StartPipelineExecutionResponse |
startPipelineExecution(StartPipelineExecutionRequest startPipelineExecutionRequest)
Starts the specified pipeline.
|
default StopPipelineExecutionResponse |
stopPipelineExecution(Consumer<StopPipelineExecutionRequest.Builder> stopPipelineExecutionRequest)
Stops the specified pipeline execution.
|
default StopPipelineExecutionResponse |
stopPipelineExecution(StopPipelineExecutionRequest stopPipelineExecutionRequest)
Stops the specified pipeline execution.
|
default TagResourceResponse |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Adds to or modifies the tags of the given resource.
|
default TagResourceResponse |
tagResource(TagResourceRequest tagResourceRequest)
Adds to or modifies the tags of the given resource.
|
default UntagResourceResponse |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes tags from an Amazon Web Services resource.
|
default UntagResourceResponse |
untagResource(UntagResourceRequest untagResourceRequest)
Removes tags from an Amazon Web Services resource.
|
default UpdateActionTypeResponse |
updateActionType(Consumer<UpdateActionTypeRequest.Builder> updateActionTypeRequest)
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.
|
default UpdateActionTypeResponse |
updateActionType(UpdateActionTypeRequest updateActionTypeRequest)
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.
|
default UpdatePipelineResponse |
updatePipeline(Consumer<UpdatePipelineRequest.Builder> updatePipelineRequest)
Updates a specified pipeline with edits or changes to its structure.
|
default UpdatePipelineResponse |
updatePipeline(UpdatePipelineRequest updatePipelineRequest)
Updates a specified pipeline with edits or changes to its structure.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.default AcknowledgeJobResponse acknowledgeJob(AcknowledgeJobRequest acknowledgeJobRequest) throws ValidationException, InvalidNonceException, JobNotFoundException, AwsServiceException, SdkClientException, CodePipelineException
Returns information about a specified job and whether that job has been received by the job worker. Used for custom actions only.
acknowledgeJobRequest - Represents the input of an AcknowledgeJob action.ValidationException - The validation was specified in an invalid format.InvalidNonceException - The nonce was specified in an invalid format.JobNotFoundException - The job was specified in an invalid format or cannot be found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault AcknowledgeJobResponse acknowledgeJob(Consumer<AcknowledgeJobRequest.Builder> acknowledgeJobRequest) throws ValidationException, InvalidNonceException, JobNotFoundException, AwsServiceException, SdkClientException, CodePipelineException
Returns information about a specified job and whether that job has been received by the job worker. Used for custom actions only.
This is a convenience which creates an instance of the AcknowledgeJobRequest.Builder avoiding the need to
create one manually via AcknowledgeJobRequest.builder()
acknowledgeJobRequest - A Consumer that will call methods on
AcknowledgeJobRequest.Builder to create a
request. Represents the input of an AcknowledgeJob action.ValidationException - The validation was specified in an invalid format.InvalidNonceException - The nonce was specified in an invalid format.JobNotFoundException - The job was specified in an invalid format or cannot be found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault AcknowledgeThirdPartyJobResponse acknowledgeThirdPartyJob(AcknowledgeThirdPartyJobRequest acknowledgeThirdPartyJobRequest) throws ValidationException, InvalidNonceException, JobNotFoundException, InvalidClientTokenException, AwsServiceException, SdkClientException, CodePipelineException
Confirms a job worker has received the specified job. Used for partner actions only.
acknowledgeThirdPartyJobRequest - Represents the input of an AcknowledgeThirdPartyJob action.ValidationException - The validation was specified in an invalid format.InvalidNonceException - The nonce was specified in an invalid format.JobNotFoundException - The job was specified in an invalid format or cannot be found.InvalidClientTokenException - The client token was specified in an invalid formatSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault AcknowledgeThirdPartyJobResponse acknowledgeThirdPartyJob(Consumer<AcknowledgeThirdPartyJobRequest.Builder> acknowledgeThirdPartyJobRequest) throws ValidationException, InvalidNonceException, JobNotFoundException, InvalidClientTokenException, AwsServiceException, SdkClientException, CodePipelineException
Confirms a job worker has received the specified job. Used for partner actions only.
This is a convenience which creates an instance of the AcknowledgeThirdPartyJobRequest.Builder avoiding
the need to create one manually via AcknowledgeThirdPartyJobRequest.builder()
acknowledgeThirdPartyJobRequest - A Consumer that will call methods on
AcknowledgeThirdPartyJobRequest.Builder to
create a request. Represents the input of an AcknowledgeThirdPartyJob action.ValidationException - The validation was specified in an invalid format.InvalidNonceException - The nonce was specified in an invalid format.JobNotFoundException - The job was specified in an invalid format or cannot be found.InvalidClientTokenException - The client token was specified in an invalid formatSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateCustomActionTypeResponse createCustomActionType(CreateCustomActionTypeRequest createCustomActionTypeRequest) throws ValidationException, LimitExceededException, TooManyTagsException, InvalidTagsException, ConcurrentModificationException, AwsServiceException, SdkClientException, CodePipelineException
Creates a new custom action that can be used in all pipelines associated with the Amazon Web Services account. Only used for custom actions.
createCustomActionTypeRequest - Represents the input of a CreateCustomActionType operation.ValidationException - The validation was specified in an invalid format.LimitExceededException - The number of pipelines associated with the Amazon Web Services account has exceeded the limit allowed
for the account.TooManyTagsException - The tags limit for a resource has been exceeded.InvalidTagsException - The specified resource tags are invalid.ConcurrentModificationException - Unable to modify the tag due to a simultaneous update request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateCustomActionTypeResponse createCustomActionType(Consumer<CreateCustomActionTypeRequest.Builder> createCustomActionTypeRequest) throws ValidationException, LimitExceededException, TooManyTagsException, InvalidTagsException, ConcurrentModificationException, AwsServiceException, SdkClientException, CodePipelineException
Creates a new custom action that can be used in all pipelines associated with the Amazon Web Services account. Only used for custom actions.
This is a convenience which creates an instance of the CreateCustomActionTypeRequest.Builder avoiding the
need to create one manually via CreateCustomActionTypeRequest.builder()
createCustomActionTypeRequest - A Consumer that will call methods on
CreateCustomActionTypeRequest.Builder to create
a request. Represents the input of a CreateCustomActionType operation.ValidationException - The validation was specified in an invalid format.LimitExceededException - The number of pipelines associated with the Amazon Web Services account has exceeded the limit allowed
for the account.TooManyTagsException - The tags limit for a resource has been exceeded.InvalidTagsException - The specified resource tags are invalid.ConcurrentModificationException - Unable to modify the tag due to a simultaneous update request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreatePipelineResponse createPipeline(CreatePipelineRequest createPipelineRequest) throws ValidationException, PipelineNameInUseException, InvalidStageDeclarationException, InvalidActionDeclarationException, InvalidBlockerDeclarationException, InvalidStructureException, LimitExceededException, TooManyTagsException, InvalidTagsException, ConcurrentModificationException, AwsServiceException, SdkClientException, CodePipelineException
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.
createPipelineRequest - Represents the input of a CreatePipeline action.ValidationException - The validation was specified in an invalid format.PipelineNameInUseException - The specified pipeline name is already in use.InvalidStageDeclarationException - The stage declaration was specified in an invalid format.InvalidActionDeclarationException - The action declaration was specified in an invalid format.InvalidBlockerDeclarationException - Reserved for future use.InvalidStructureException - The structure was specified in an invalid format.LimitExceededException - The number of pipelines associated with the Amazon Web Services account has exceeded the limit allowed
for the account.TooManyTagsException - The tags limit for a resource has been exceeded.InvalidTagsException - The specified resource tags are invalid.ConcurrentModificationException - Unable to modify the tag due to a simultaneous update request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreatePipelineResponse createPipeline(Consumer<CreatePipelineRequest.Builder> createPipelineRequest) throws ValidationException, PipelineNameInUseException, InvalidStageDeclarationException, InvalidActionDeclarationException, InvalidBlockerDeclarationException, InvalidStructureException, LimitExceededException, TooManyTagsException, InvalidTagsException, ConcurrentModificationException, AwsServiceException, SdkClientException, CodePipelineException
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.
This is a convenience which creates an instance of the CreatePipelineRequest.Builder avoiding the need to
create one manually via CreatePipelineRequest.builder()
createPipelineRequest - A Consumer that will call methods on
CreatePipelineRequest.Builder to create a
request. Represents the input of a CreatePipeline action.ValidationException - The validation was specified in an invalid format.PipelineNameInUseException - The specified pipeline name is already in use.InvalidStageDeclarationException - The stage declaration was specified in an invalid format.InvalidActionDeclarationException - The action declaration was specified in an invalid format.InvalidBlockerDeclarationException - Reserved for future use.InvalidStructureException - The structure was specified in an invalid format.LimitExceededException - The number of pipelines associated with the Amazon Web Services account has exceeded the limit allowed
for the account.TooManyTagsException - The tags limit for a resource has been exceeded.InvalidTagsException - The specified resource tags are invalid.ConcurrentModificationException - Unable to modify the tag due to a simultaneous update request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteCustomActionTypeResponse deleteCustomActionType(DeleteCustomActionTypeRequest deleteCustomActionTypeRequest) throws ValidationException, ConcurrentModificationException, AwsServiceException, SdkClientException, CodePipelineException
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.
deleteCustomActionTypeRequest - Represents the input of a DeleteCustomActionType operation. The custom action will be marked
as deleted.ValidationException - The validation was specified in an invalid format.ConcurrentModificationException - Unable to modify the tag due to a simultaneous update request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteCustomActionTypeResponse deleteCustomActionType(Consumer<DeleteCustomActionTypeRequest.Builder> deleteCustomActionTypeRequest) throws ValidationException, ConcurrentModificationException, AwsServiceException, SdkClientException, CodePipelineException
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.
This is a convenience which creates an instance of the DeleteCustomActionTypeRequest.Builder avoiding the
need to create one manually via DeleteCustomActionTypeRequest.builder()
deleteCustomActionTypeRequest - A Consumer that will call methods on
DeleteCustomActionTypeRequest.Builder to create
a request. Represents the input of a DeleteCustomActionType operation. The custom action will
be marked as deleted.ValidationException - The validation was specified in an invalid format.ConcurrentModificationException - Unable to modify the tag due to a simultaneous update request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeletePipelineResponse deletePipeline(DeletePipelineRequest deletePipelineRequest) throws ValidationException, ConcurrentModificationException, AwsServiceException, SdkClientException, CodePipelineException
Deletes the specified pipeline.
deletePipelineRequest - Represents the input of a DeletePipeline action.ValidationException - The validation was specified in an invalid format.ConcurrentModificationException - Unable to modify the tag due to a simultaneous update request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeletePipelineResponse deletePipeline(Consumer<DeletePipelineRequest.Builder> deletePipelineRequest) throws ValidationException, ConcurrentModificationException, AwsServiceException, SdkClientException, CodePipelineException
Deletes the specified pipeline.
This is a convenience which creates an instance of the DeletePipelineRequest.Builder avoiding the need to
create one manually via DeletePipelineRequest.builder()
deletePipelineRequest - A Consumer that will call methods on
DeletePipelineRequest.Builder to create a
request. Represents the input of a DeletePipeline action.ValidationException - The validation was specified in an invalid format.ConcurrentModificationException - Unable to modify the tag due to a simultaneous update request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteWebhookResponse deleteWebhook(DeleteWebhookRequest deleteWebhookRequest) throws ValidationException, ConcurrentModificationException, AwsServiceException, SdkClientException, CodePipelineException
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.
deleteWebhookRequest - ValidationException - The validation was specified in an invalid format.ConcurrentModificationException - Unable to modify the tag due to a simultaneous update request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteWebhookResponse deleteWebhook(Consumer<DeleteWebhookRequest.Builder> deleteWebhookRequest) throws ValidationException, ConcurrentModificationException, AwsServiceException, SdkClientException, CodePipelineException
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.
This is a convenience which creates an instance of the DeleteWebhookRequest.Builder avoiding the need to
create one manually via DeleteWebhookRequest.builder()
deleteWebhookRequest - A Consumer that will call methods on
DeleteWebhookRequest.Builder to create a
request.ValidationException - The validation was specified in an invalid format.ConcurrentModificationException - Unable to modify the tag due to a simultaneous update request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeregisterWebhookWithThirdPartyResponse deregisterWebhookWithThirdParty(DeregisterWebhookWithThirdPartyRequest deregisterWebhookWithThirdPartyRequest) throws ValidationException, WebhookNotFoundException, AwsServiceException, SdkClientException, CodePipelineException
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.
deregisterWebhookWithThirdPartyRequest - ValidationException - The validation was specified in an invalid format.WebhookNotFoundException - The specified webhook was entered in an invalid format or cannot be found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeregisterWebhookWithThirdPartyResponse deregisterWebhookWithThirdParty(Consumer<DeregisterWebhookWithThirdPartyRequest.Builder> deregisterWebhookWithThirdPartyRequest) throws ValidationException, WebhookNotFoundException, AwsServiceException, SdkClientException, CodePipelineException
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.
This is a convenience which creates an instance of the DeregisterWebhookWithThirdPartyRequest.Builder
avoiding the need to create one manually via DeregisterWebhookWithThirdPartyRequest.builder()
deregisterWebhookWithThirdPartyRequest - A Consumer that will call methods on
DeregisterWebhookWithThirdPartyRequest.Builder
to create a request.ValidationException - The validation was specified in an invalid format.WebhookNotFoundException - The specified webhook was entered in an invalid format or cannot be found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DisableStageTransitionResponse disableStageTransition(DisableStageTransitionRequest disableStageTransitionRequest) throws ValidationException, PipelineNotFoundException, StageNotFoundException, AwsServiceException, SdkClientException, CodePipelineException
Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline.
disableStageTransitionRequest - Represents the input of a DisableStageTransition action.ValidationException - The validation was specified in an invalid format.PipelineNotFoundException - The pipeline was specified in an invalid format or cannot be found.StageNotFoundException - The stage was specified in an invalid format or cannot be found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DisableStageTransitionResponse disableStageTransition(Consumer<DisableStageTransitionRequest.Builder> disableStageTransitionRequest) throws ValidationException, PipelineNotFoundException, StageNotFoundException, AwsServiceException, SdkClientException, CodePipelineException
Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline.
This is a convenience which creates an instance of the DisableStageTransitionRequest.Builder avoiding the
need to create one manually via DisableStageTransitionRequest.builder()
disableStageTransitionRequest - A Consumer that will call methods on
DisableStageTransitionRequest.Builder to create
a request. Represents the input of a DisableStageTransition action.ValidationException - The validation was specified in an invalid format.PipelineNotFoundException - The pipeline was specified in an invalid format or cannot be found.StageNotFoundException - The stage was specified in an invalid format or cannot be found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault EnableStageTransitionResponse enableStageTransition(EnableStageTransitionRequest enableStageTransitionRequest) throws ValidationException, PipelineNotFoundException, StageNotFoundException, AwsServiceException, SdkClientException, CodePipelineException
Enables artifacts in a pipeline to transition to a stage in a pipeline.
enableStageTransitionRequest - Represents the input of an EnableStageTransition action.ValidationException - The validation was specified in an invalid format.PipelineNotFoundException - The pipeline was specified in an invalid format or cannot be found.StageNotFoundException - The stage was specified in an invalid format or cannot be found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault EnableStageTransitionResponse enableStageTransition(Consumer<EnableStageTransitionRequest.Builder> enableStageTransitionRequest) throws ValidationException, PipelineNotFoundException, StageNotFoundException, AwsServiceException, SdkClientException, CodePipelineException
Enables artifacts in a pipeline to transition to a stage in a pipeline.
This is a convenience which creates an instance of the EnableStageTransitionRequest.Builder avoiding the
need to create one manually via EnableStageTransitionRequest.builder()
enableStageTransitionRequest - A Consumer that will call methods on
EnableStageTransitionRequest.Builder to create
a request. Represents the input of an EnableStageTransition action.ValidationException - The validation was specified in an invalid format.PipelineNotFoundException - The pipeline was specified in an invalid format or cannot be found.StageNotFoundException - The stage was specified in an invalid format or cannot be found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetActionTypeResponse getActionType(GetActionTypeRequest getActionTypeRequest) throws ActionTypeNotFoundException, ValidationException, AwsServiceException, SdkClientException, CodePipelineException
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.
getActionTypeRequest - ActionTypeNotFoundException - The specified action type cannot be found.ValidationException - The validation was specified in an invalid format.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetActionTypeResponse getActionType(Consumer<GetActionTypeRequest.Builder> getActionTypeRequest) throws ActionTypeNotFoundException, ValidationException, AwsServiceException, SdkClientException, CodePipelineException
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.
This is a convenience which creates an instance of the GetActionTypeRequest.Builder avoiding the need to
create one manually via GetActionTypeRequest.builder()
getActionTypeRequest - A Consumer that will call methods on
GetActionTypeRequest.Builder to create a
request.ActionTypeNotFoundException - The specified action type cannot be found.ValidationException - The validation was specified in an invalid format.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetJobDetailsResponse getJobDetails(GetJobDetailsRequest getJobDetailsRequest) throws ValidationException, JobNotFoundException, AwsServiceException, SdkClientException, CodePipelineException
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.
getJobDetailsRequest - Represents the input of a GetJobDetails action.ValidationException - The validation was specified in an invalid format.JobNotFoundException - The job was specified in an invalid format or cannot be found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetJobDetailsResponse getJobDetails(Consumer<GetJobDetailsRequest.Builder> getJobDetailsRequest) throws ValidationException, JobNotFoundException, AwsServiceException, SdkClientException, CodePipelineException
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.
This is a convenience which creates an instance of the GetJobDetailsRequest.Builder avoiding the need to
create one manually via GetJobDetailsRequest.builder()
getJobDetailsRequest - A Consumer that will call methods on
GetJobDetailsRequest.Builder to create a
request. Represents the input of a GetJobDetails action.ValidationException - The validation was specified in an invalid format.JobNotFoundException - The job was specified in an invalid format or cannot be found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetPipelineResponse getPipeline(GetPipelineRequest getPipelineRequest) throws ValidationException, PipelineNotFoundException, PipelineVersionNotFoundException, AwsServiceException, SdkClientException, CodePipelineException
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.
getPipelineRequest - Represents the input of a GetPipeline action.ValidationException - The validation was specified in an invalid format.PipelineNotFoundException - The pipeline was specified in an invalid format or cannot be found.PipelineVersionNotFoundException - The pipeline version was specified in an invalid format or cannot be found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetPipelineResponse getPipeline(Consumer<GetPipelineRequest.Builder> getPipelineRequest) throws ValidationException, PipelineNotFoundException, PipelineVersionNotFoundException, AwsServiceException, SdkClientException, CodePipelineException
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.
This is a convenience which creates an instance of the GetPipelineRequest.Builder avoiding the need to
create one manually via GetPipelineRequest.builder()
getPipelineRequest - A Consumer that will call methods on
GetPipelineRequest.Builder to create a request.
Represents the input of a GetPipeline action.ValidationException - The validation was specified in an invalid format.PipelineNotFoundException - The pipeline was specified in an invalid format or cannot be found.PipelineVersionNotFoundException - The pipeline version was specified in an invalid format or cannot be found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetPipelineExecutionResponse getPipelineExecution(GetPipelineExecutionRequest getPipelineExecutionRequest) throws ValidationException, PipelineNotFoundException, PipelineExecutionNotFoundException, AwsServiceException, SdkClientException, CodePipelineException
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.
getPipelineExecutionRequest - Represents the input of a GetPipelineExecution action.ValidationException - The validation was specified in an invalid format.PipelineNotFoundException - The pipeline was specified in an invalid format or cannot be found.PipelineExecutionNotFoundException - The pipeline execution was specified in an invalid format or cannot be found, or an execution ID does not
belong to the specified pipeline.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetPipelineExecutionResponse getPipelineExecution(Consumer<GetPipelineExecutionRequest.Builder> getPipelineExecutionRequest) throws ValidationException, PipelineNotFoundException, PipelineExecutionNotFoundException, AwsServiceException, SdkClientException, CodePipelineException
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.
This is a convenience which creates an instance of the GetPipelineExecutionRequest.Builder avoiding the
need to create one manually via GetPipelineExecutionRequest.builder()
getPipelineExecutionRequest - A Consumer that will call methods on
GetPipelineExecutionRequest.Builder to create a
request. Represents the input of a GetPipelineExecution action.ValidationException - The validation was specified in an invalid format.PipelineNotFoundException - The pipeline was specified in an invalid format or cannot be found.PipelineExecutionNotFoundException - The pipeline execution was specified in an invalid format or cannot be found, or an execution ID does not
belong to the specified pipeline.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetPipelineStateResponse getPipelineState(GetPipelineStateRequest getPipelineStateRequest) throws ValidationException, PipelineNotFoundException, AwsServiceException, SdkClientException, CodePipelineException
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.
getPipelineStateRequest - Represents the input of a GetPipelineState action.ValidationException - The validation was specified in an invalid format.PipelineNotFoundException - The pipeline was specified in an invalid format or cannot be found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetPipelineStateResponse getPipelineState(Consumer<GetPipelineStateRequest.Builder> getPipelineStateRequest) throws ValidationException, PipelineNotFoundException, AwsServiceException, SdkClientException, CodePipelineException
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.
This is a convenience which creates an instance of the GetPipelineStateRequest.Builder avoiding the need
to create one manually via GetPipelineStateRequest.builder()
getPipelineStateRequest - A Consumer that will call methods on
GetPipelineStateRequest.Builder to create a
request. Represents the input of a GetPipelineState action.ValidationException - The validation was specified in an invalid format.PipelineNotFoundException - The pipeline was specified in an invalid format or cannot be found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetThirdPartyJobDetailsResponse getThirdPartyJobDetails(GetThirdPartyJobDetailsRequest getThirdPartyJobDetailsRequest) throws JobNotFoundException, ValidationException, InvalidClientTokenException, InvalidJobException, AwsServiceException, SdkClientException, CodePipelineException
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.
getThirdPartyJobDetailsRequest - Represents the input of a GetThirdPartyJobDetails action.JobNotFoundException - The job was specified in an invalid format or cannot be found.ValidationException - The validation was specified in an invalid format.InvalidClientTokenException - The client token was specified in an invalid formatInvalidJobException - The job was specified in an invalid format or cannot be found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetThirdPartyJobDetailsResponse getThirdPartyJobDetails(Consumer<GetThirdPartyJobDetailsRequest.Builder> getThirdPartyJobDetailsRequest) throws JobNotFoundException, ValidationException, InvalidClientTokenException, InvalidJobException, AwsServiceException, SdkClientException, CodePipelineException
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.
This is a convenience which creates an instance of the GetThirdPartyJobDetailsRequest.Builder avoiding
the need to create one manually via GetThirdPartyJobDetailsRequest.builder()
getThirdPartyJobDetailsRequest - A Consumer that will call methods on
GetThirdPartyJobDetailsRequest.Builder to
create a request. Represents the input of a GetThirdPartyJobDetails action.JobNotFoundException - The job was specified in an invalid format or cannot be found.ValidationException - The validation was specified in an invalid format.InvalidClientTokenException - The client token was specified in an invalid formatInvalidJobException - The job was specified in an invalid format or cannot be found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListActionExecutionsResponse listActionExecutions(ListActionExecutionsRequest listActionExecutionsRequest) throws ValidationException, PipelineNotFoundException, InvalidNextTokenException, PipelineExecutionNotFoundException, AwsServiceException, SdkClientException, CodePipelineException
Lists the action executions that have occurred in a pipeline.
listActionExecutionsRequest - ValidationException - The validation was specified in an invalid format.PipelineNotFoundException - The pipeline was specified in an invalid format or cannot be found.InvalidNextTokenException - The next token was specified in an invalid format. Make sure that the next token you provide is the token
returned by a previous call.PipelineExecutionNotFoundException - The pipeline execution was specified in an invalid format or cannot be found, or an execution ID does not
belong to the specified pipeline.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListActionExecutionsResponse listActionExecutions(Consumer<ListActionExecutionsRequest.Builder> listActionExecutionsRequest) throws ValidationException, PipelineNotFoundException, InvalidNextTokenException, PipelineExecutionNotFoundException, AwsServiceException, SdkClientException, CodePipelineException
Lists the action executions that have occurred in a pipeline.
This is a convenience which creates an instance of the ListActionExecutionsRequest.Builder avoiding the
need to create one manually via ListActionExecutionsRequest.builder()
listActionExecutionsRequest - A Consumer that will call methods on
ListActionExecutionsRequest.Builder to create a
request.ValidationException - The validation was specified in an invalid format.PipelineNotFoundException - The pipeline was specified in an invalid format or cannot be found.InvalidNextTokenException - The next token was specified in an invalid format. Make sure that the next token you provide is the token
returned by a previous call.PipelineExecutionNotFoundException - The pipeline execution was specified in an invalid format or cannot be found, or an execution ID does not
belong to the specified pipeline.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListActionExecutionsIterable listActionExecutionsPaginator(ListActionExecutionsRequest listActionExecutionsRequest) throws ValidationException, PipelineNotFoundException, InvalidNextTokenException, PipelineExecutionNotFoundException, AwsServiceException, SdkClientException, CodePipelineException
Lists the action executions that have occurred in a pipeline.
This is a variant of
listActionExecutions(software.amazon.awssdk.services.codepipeline.model.ListActionExecutionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.codepipeline.paginators.ListActionExecutionsIterable responses = client.listActionExecutionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.codepipeline.paginators.ListActionExecutionsIterable responses = client
.listActionExecutionsPaginator(request);
for (software.amazon.awssdk.services.codepipeline.model.ListActionExecutionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.codepipeline.paginators.ListActionExecutionsIterable responses = client.listActionExecutionsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listActionExecutions(software.amazon.awssdk.services.codepipeline.model.ListActionExecutionsRequest)
operation.
listActionExecutionsRequest - ValidationException - The validation was specified in an invalid format.PipelineNotFoundException - The pipeline was specified in an invalid format or cannot be found.InvalidNextTokenException - The next token was specified in an invalid format. Make sure that the next token you provide is the token
returned by a previous call.PipelineExecutionNotFoundException - The pipeline execution was specified in an invalid format or cannot be found, or an execution ID does not
belong to the specified pipeline.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListActionExecutionsIterable listActionExecutionsPaginator(Consumer<ListActionExecutionsRequest.Builder> listActionExecutionsRequest) throws ValidationException, PipelineNotFoundException, InvalidNextTokenException, PipelineExecutionNotFoundException, AwsServiceException, SdkClientException, CodePipelineException
Lists the action executions that have occurred in a pipeline.
This is a variant of
listActionExecutions(software.amazon.awssdk.services.codepipeline.model.ListActionExecutionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.codepipeline.paginators.ListActionExecutionsIterable responses = client.listActionExecutionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.codepipeline.paginators.ListActionExecutionsIterable responses = client
.listActionExecutionsPaginator(request);
for (software.amazon.awssdk.services.codepipeline.model.ListActionExecutionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.codepipeline.paginators.ListActionExecutionsIterable responses = client.listActionExecutionsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listActionExecutions(software.amazon.awssdk.services.codepipeline.model.ListActionExecutionsRequest)
operation.
This is a convenience which creates an instance of the ListActionExecutionsRequest.Builder avoiding the
need to create one manually via ListActionExecutionsRequest.builder()
listActionExecutionsRequest - A Consumer that will call methods on
ListActionExecutionsRequest.Builder to create a
request.ValidationException - The validation was specified in an invalid format.PipelineNotFoundException - The pipeline was specified in an invalid format or cannot be found.InvalidNextTokenException - The next token was specified in an invalid format. Make sure that the next token you provide is the token
returned by a previous call.PipelineExecutionNotFoundException - The pipeline execution was specified in an invalid format or cannot be found, or an execution ID does not
belong to the specified pipeline.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListActionTypesResponse listActionTypes(ListActionTypesRequest listActionTypesRequest) throws ValidationException, InvalidNextTokenException, AwsServiceException, SdkClientException, CodePipelineException
Gets a summary of all CodePipeline action types associated with your account.
listActionTypesRequest - Represents the input of a ListActionTypes action.ValidationException - The validation was specified in an invalid format.InvalidNextTokenException - The next token was specified in an invalid format. Make sure that the next token you provide is the token
returned by a previous call.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListActionTypesResponse listActionTypes(Consumer<ListActionTypesRequest.Builder> listActionTypesRequest) throws ValidationException, InvalidNextTokenException, AwsServiceException, SdkClientException, CodePipelineException
Gets a summary of all CodePipeline action types associated with your account.
This is a convenience which creates an instance of the ListActionTypesRequest.Builder avoiding the need
to create one manually via ListActionTypesRequest.builder()
listActionTypesRequest - A Consumer that will call methods on
ListActionTypesRequest.Builder to create a
request. Represents the input of a ListActionTypes action.ValidationException - The validation was specified in an invalid format.InvalidNextTokenException - The next token was specified in an invalid format. Make sure that the next token you provide is the token
returned by a previous call.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListActionTypesResponse listActionTypes() throws ValidationException, InvalidNextTokenException, AwsServiceException, SdkClientException, CodePipelineException
Gets a summary of all CodePipeline action types associated with your account.
ValidationException - The validation was specified in an invalid format.InvalidNextTokenException - The next token was specified in an invalid format. Make sure that the next token you provide is the token
returned by a previous call.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistActionTypes(ListActionTypesRequest),
AWS
API Documentationdefault ListActionTypesIterable listActionTypesPaginator() throws ValidationException, InvalidNextTokenException, AwsServiceException, SdkClientException, CodePipelineException
Gets a summary of all CodePipeline action types associated with your account.
This is a variant of
listActionTypes(software.amazon.awssdk.services.codepipeline.model.ListActionTypesRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.codepipeline.paginators.ListActionTypesIterable responses = client.listActionTypesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.codepipeline.paginators.ListActionTypesIterable responses = client
.listActionTypesPaginator(request);
for (software.amazon.awssdk.services.codepipeline.model.ListActionTypesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.codepipeline.paginators.ListActionTypesIterable responses = client.listActionTypesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listActionTypes(software.amazon.awssdk.services.codepipeline.model.ListActionTypesRequest)
operation.
ValidationException - The validation was specified in an invalid format.InvalidNextTokenException - The next token was specified in an invalid format. Make sure that the next token you provide is the token
returned by a previous call.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistActionTypesPaginator(ListActionTypesRequest),
AWS
API Documentationdefault ListActionTypesIterable listActionTypesPaginator(ListActionTypesRequest listActionTypesRequest) throws ValidationException, InvalidNextTokenException, AwsServiceException, SdkClientException, CodePipelineException
Gets a summary of all CodePipeline action types associated with your account.
This is a variant of
listActionTypes(software.amazon.awssdk.services.codepipeline.model.ListActionTypesRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.codepipeline.paginators.ListActionTypesIterable responses = client.listActionTypesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.codepipeline.paginators.ListActionTypesIterable responses = client
.listActionTypesPaginator(request);
for (software.amazon.awssdk.services.codepipeline.model.ListActionTypesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.codepipeline.paginators.ListActionTypesIterable responses = client.listActionTypesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listActionTypes(software.amazon.awssdk.services.codepipeline.model.ListActionTypesRequest)
operation.
listActionTypesRequest - Represents the input of a ListActionTypes action.ValidationException - The validation was specified in an invalid format.InvalidNextTokenException - The next token was specified in an invalid format. Make sure that the next token you provide is the token
returned by a previous call.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListActionTypesIterable listActionTypesPaginator(Consumer<ListActionTypesRequest.Builder> listActionTypesRequest) throws ValidationException, InvalidNextTokenException, AwsServiceException, SdkClientException, CodePipelineException
Gets a summary of all CodePipeline action types associated with your account.
This is a variant of
listActionTypes(software.amazon.awssdk.services.codepipeline.model.ListActionTypesRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.codepipeline.paginators.ListActionTypesIterable responses = client.listActionTypesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.codepipeline.paginators.ListActionTypesIterable responses = client
.listActionTypesPaginator(request);
for (software.amazon.awssdk.services.codepipeline.model.ListActionTypesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.codepipeline.paginators.ListActionTypesIterable responses = client.listActionTypesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listActionTypes(software.amazon.awssdk.services.codepipeline.model.ListActionTypesRequest)
operation.
This is a convenience which creates an instance of the ListActionTypesRequest.Builder avoiding the need
to create one manually via ListActionTypesRequest.builder()
listActionTypesRequest - A Consumer that will call methods on
ListActionTypesRequest.Builder to create a
request. Represents the input of a ListActionTypes action.ValidationException - The validation was specified in an invalid format.InvalidNextTokenException - The next token was specified in an invalid format. Make sure that the next token you provide is the token
returned by a previous call.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListPipelineExecutionsResponse listPipelineExecutions(ListPipelineExecutionsRequest listPipelineExecutionsRequest) throws ValidationException, PipelineNotFoundException, InvalidNextTokenException, AwsServiceException, SdkClientException, CodePipelineException
Gets a summary of the most recent executions for a pipeline.
listPipelineExecutionsRequest - Represents the input of a ListPipelineExecutions action.ValidationException - The validation was specified in an invalid format.PipelineNotFoundException - The pipeline was specified in an invalid format or cannot be found.InvalidNextTokenException - The next token was specified in an invalid format. Make sure that the next token you provide is the token
returned by a previous call.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListPipelineExecutionsResponse listPipelineExecutions(Consumer<ListPipelineExecutionsRequest.Builder> listPipelineExecutionsRequest) throws ValidationException, PipelineNotFoundException, InvalidNextTokenException, AwsServiceException, SdkClientException, CodePipelineException
Gets a summary of the most recent executions for a pipeline.
This is a convenience which creates an instance of the ListPipelineExecutionsRequest.Builder avoiding the
need to create one manually via ListPipelineExecutionsRequest.builder()
listPipelineExecutionsRequest - A Consumer that will call methods on
ListPipelineExecutionsRequest.Builder to create
a request. Represents the input of a ListPipelineExecutions action.ValidationException - The validation was specified in an invalid format.PipelineNotFoundException - The pipeline was specified in an invalid format or cannot be found.InvalidNextTokenException - The next token was specified in an invalid format. Make sure that the next token you provide is the token
returned by a previous call.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListPipelineExecutionsIterable listPipelineExecutionsPaginator(ListPipelineExecutionsRequest listPipelineExecutionsRequest) throws ValidationException, PipelineNotFoundException, InvalidNextTokenException, AwsServiceException, SdkClientException, CodePipelineException
Gets a summary of the most recent executions for a pipeline.
This is a variant of
listPipelineExecutions(software.amazon.awssdk.services.codepipeline.model.ListPipelineExecutionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.codepipeline.paginators.ListPipelineExecutionsIterable responses = client.listPipelineExecutionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.codepipeline.paginators.ListPipelineExecutionsIterable responses = client
.listPipelineExecutionsPaginator(request);
for (software.amazon.awssdk.services.codepipeline.model.ListPipelineExecutionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.codepipeline.paginators.ListPipelineExecutionsIterable responses = client.listPipelineExecutionsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPipelineExecutions(software.amazon.awssdk.services.codepipeline.model.ListPipelineExecutionsRequest)
operation.
listPipelineExecutionsRequest - Represents the input of a ListPipelineExecutions action.ValidationException - The validation was specified in an invalid format.PipelineNotFoundException - The pipeline was specified in an invalid format or cannot be found.InvalidNextTokenException - The next token was specified in an invalid format. Make sure that the next token you provide is the token
returned by a previous call.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListPipelineExecutionsIterable listPipelineExecutionsPaginator(Consumer<ListPipelineExecutionsRequest.Builder> listPipelineExecutionsRequest) throws ValidationException, PipelineNotFoundException, InvalidNextTokenException, AwsServiceException, SdkClientException, CodePipelineException
Gets a summary of the most recent executions for a pipeline.
This is a variant of
listPipelineExecutions(software.amazon.awssdk.services.codepipeline.model.ListPipelineExecutionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.codepipeline.paginators.ListPipelineExecutionsIterable responses = client.listPipelineExecutionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.codepipeline.paginators.ListPipelineExecutionsIterable responses = client
.listPipelineExecutionsPaginator(request);
for (software.amazon.awssdk.services.codepipeline.model.ListPipelineExecutionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.codepipeline.paginators.ListPipelineExecutionsIterable responses = client.listPipelineExecutionsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPipelineExecutions(software.amazon.awssdk.services.codepipeline.model.ListPipelineExecutionsRequest)
operation.
This is a convenience which creates an instance of the ListPipelineExecutionsRequest.Builder avoiding the
need to create one manually via ListPipelineExecutionsRequest.builder()
listPipelineExecutionsRequest - A Consumer that will call methods on
ListPipelineExecutionsRequest.Builder to create
a request. Represents the input of a ListPipelineExecutions action.ValidationException - The validation was specified in an invalid format.PipelineNotFoundException - The pipeline was specified in an invalid format or cannot be found.InvalidNextTokenException - The next token was specified in an invalid format. Make sure that the next token you provide is the token
returned by a previous call.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListPipelinesResponse listPipelines(ListPipelinesRequest listPipelinesRequest) throws ValidationException, InvalidNextTokenException, AwsServiceException, SdkClientException, CodePipelineException
Gets a summary of all of the pipelines associated with your account.
listPipelinesRequest - Represents the input of a ListPipelines action.ValidationException - The validation was specified in an invalid format.InvalidNextTokenException - The next token was specified in an invalid format. Make sure that the next token you provide is the token
returned by a previous call.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListPipelinesResponse listPipelines(Consumer<ListPipelinesRequest.Builder> listPipelinesRequest) throws ValidationException, InvalidNextTokenException, AwsServiceException, SdkClientException, CodePipelineException
Gets a summary of all of the pipelines associated with your account.
This is a convenience which creates an instance of the ListPipelinesRequest.Builder avoiding the need to
create one manually via ListPipelinesRequest.builder()
listPipelinesRequest - A Consumer that will call methods on
ListPipelinesRequest.Builder to create a
request. Represents the input of a ListPipelines action.ValidationException - The validation was specified in an invalid format.InvalidNextTokenException - The next token was specified in an invalid format. Make sure that the next token you provide is the token
returned by a previous call.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListPipelinesResponse listPipelines() throws ValidationException, InvalidNextTokenException, AwsServiceException, SdkClientException, CodePipelineException
Gets a summary of all of the pipelines associated with your account.
ValidationException - The validation was specified in an invalid format.InvalidNextTokenException - The next token was specified in an invalid format. Make sure that the next token you provide is the token
returned by a previous call.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistPipelines(ListPipelinesRequest),
AWS
API Documentationdefault ListPipelinesIterable listPipelinesPaginator() throws ValidationException, InvalidNextTokenException, AwsServiceException, SdkClientException, CodePipelineException
Gets a summary of all of the pipelines associated with your account.
This is a variant of
listPipelines(software.amazon.awssdk.services.codepipeline.model.ListPipelinesRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.codepipeline.paginators.ListPipelinesIterable responses = client.listPipelinesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.codepipeline.paginators.ListPipelinesIterable responses = client
.listPipelinesPaginator(request);
for (software.amazon.awssdk.services.codepipeline.model.ListPipelinesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.codepipeline.paginators.ListPipelinesIterable responses = client.listPipelinesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPipelines(software.amazon.awssdk.services.codepipeline.model.ListPipelinesRequest) operation.
ValidationException - The validation was specified in an invalid format.InvalidNextTokenException - The next token was specified in an invalid format. Make sure that the next token you provide is the token
returned by a previous call.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistPipelinesPaginator(ListPipelinesRequest),
AWS
API Documentationdefault ListPipelinesIterable listPipelinesPaginator(ListPipelinesRequest listPipelinesRequest) throws ValidationException, InvalidNextTokenException, AwsServiceException, SdkClientException, CodePipelineException
Gets a summary of all of the pipelines associated with your account.
This is a variant of
listPipelines(software.amazon.awssdk.services.codepipeline.model.ListPipelinesRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.codepipeline.paginators.ListPipelinesIterable responses = client.listPipelinesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.codepipeline.paginators.ListPipelinesIterable responses = client
.listPipelinesPaginator(request);
for (software.amazon.awssdk.services.codepipeline.model.ListPipelinesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.codepipeline.paginators.ListPipelinesIterable responses = client.listPipelinesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPipelines(software.amazon.awssdk.services.codepipeline.model.ListPipelinesRequest) operation.
listPipelinesRequest - Represents the input of a ListPipelines action.ValidationException - The validation was specified in an invalid format.InvalidNextTokenException - The next token was specified in an invalid format. Make sure that the next token you provide is the token
returned by a previous call.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListPipelinesIterable listPipelinesPaginator(Consumer<ListPipelinesRequest.Builder> listPipelinesRequest) throws ValidationException, InvalidNextTokenException, AwsServiceException, SdkClientException, CodePipelineException
Gets a summary of all of the pipelines associated with your account.
This is a variant of
listPipelines(software.amazon.awssdk.services.codepipeline.model.ListPipelinesRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.codepipeline.paginators.ListPipelinesIterable responses = client.listPipelinesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.codepipeline.paginators.ListPipelinesIterable responses = client
.listPipelinesPaginator(request);
for (software.amazon.awssdk.services.codepipeline.model.ListPipelinesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.codepipeline.paginators.ListPipelinesIterable responses = client.listPipelinesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPipelines(software.amazon.awssdk.services.codepipeline.model.ListPipelinesRequest) operation.
This is a convenience which creates an instance of the ListPipelinesRequest.Builder avoiding the need to
create one manually via ListPipelinesRequest.builder()
listPipelinesRequest - A Consumer that will call methods on
ListPipelinesRequest.Builder to create a
request. Represents the input of a ListPipelines action.ValidationException - The validation was specified in an invalid format.InvalidNextTokenException - The next token was specified in an invalid format. Make sure that the next token you provide is the token
returned by a previous call.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws ValidationException, ResourceNotFoundException, InvalidNextTokenException, InvalidArnException, AwsServiceException, SdkClientException, CodePipelineException
Gets the set of key-value pairs (metadata) that are used to manage the resource.
listTagsForResourceRequest - ValidationException - The validation was specified in an invalid format.ResourceNotFoundException - The resource was specified in an invalid format.InvalidNextTokenException - The next token was specified in an invalid format. Make sure that the next token you provide is the token
returned by a previous call.InvalidArnException - The specified resource ARN is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws ValidationException, ResourceNotFoundException, InvalidNextTokenException, InvalidArnException, AwsServiceException, SdkClientException, CodePipelineException
Gets the set of key-value pairs (metadata) that are used to manage the resource.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on
ListTagsForResourceRequest.Builder to create a
request.ValidationException - The validation was specified in an invalid format.ResourceNotFoundException - The resource was specified in an invalid format.InvalidNextTokenException - The next token was specified in an invalid format. Make sure that the next token you provide is the token
returned by a previous call.InvalidArnException - The specified resource ARN is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTagsForResourceIterable listTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest) throws ValidationException, ResourceNotFoundException, InvalidNextTokenException, InvalidArnException, AwsServiceException, SdkClientException, CodePipelineException
Gets the set of key-value pairs (metadata) that are used to manage the resource.
This is a variant of
listTagsForResource(software.amazon.awssdk.services.codepipeline.model.ListTagsForResourceRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.codepipeline.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.codepipeline.paginators.ListTagsForResourceIterable responses = client
.listTagsForResourcePaginator(request);
for (software.amazon.awssdk.services.codepipeline.model.ListTagsForResourceResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.codepipeline.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTagsForResource(software.amazon.awssdk.services.codepipeline.model.ListTagsForResourceRequest)
operation.
listTagsForResourceRequest - ValidationException - The validation was specified in an invalid format.ResourceNotFoundException - The resource was specified in an invalid format.InvalidNextTokenException - The next token was specified in an invalid format. Make sure that the next token you provide is the token
returned by a previous call.InvalidArnException - The specified resource ARN is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTagsForResourceIterable listTagsForResourcePaginator(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws ValidationException, ResourceNotFoundException, InvalidNextTokenException, InvalidArnException, AwsServiceException, SdkClientException, CodePipelineException
Gets the set of key-value pairs (metadata) that are used to manage the resource.
This is a variant of
listTagsForResource(software.amazon.awssdk.services.codepipeline.model.ListTagsForResourceRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.codepipeline.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.codepipeline.paginators.ListTagsForResourceIterable responses = client
.listTagsForResourcePaginator(request);
for (software.amazon.awssdk.services.codepipeline.model.ListTagsForResourceResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.codepipeline.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTagsForResource(software.amazon.awssdk.services.codepipeline.model.ListTagsForResourceRequest)
operation.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on
ListTagsForResourceRequest.Builder to create a
request.ValidationException - The validation was specified in an invalid format.ResourceNotFoundException - The resource was specified in an invalid format.InvalidNextTokenException - The next token was specified in an invalid format. Make sure that the next token you provide is the token
returned by a previous call.InvalidArnException - The specified resource ARN is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListWebhooksResponse listWebhooks(ListWebhooksRequest listWebhooksRequest) throws ValidationException, InvalidNextTokenException, AwsServiceException, SdkClientException, CodePipelineException
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.
listWebhooksRequest - ValidationException - The validation was specified in an invalid format.InvalidNextTokenException - The next token was specified in an invalid format. Make sure that the next token you provide is the token
returned by a previous call.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListWebhooksResponse listWebhooks(Consumer<ListWebhooksRequest.Builder> listWebhooksRequest) throws ValidationException, InvalidNextTokenException, AwsServiceException, SdkClientException, CodePipelineException
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.
This is a convenience which creates an instance of the ListWebhooksRequest.Builder avoiding the need to
create one manually via ListWebhooksRequest.builder()
listWebhooksRequest - A Consumer that will call methods on
ListWebhooksRequest.Builder to create a
request.ValidationException - The validation was specified in an invalid format.InvalidNextTokenException - The next token was specified in an invalid format. Make sure that the next token you provide is the token
returned by a previous call.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListWebhooksResponse listWebhooks() throws ValidationException, InvalidNextTokenException, AwsServiceException, SdkClientException, CodePipelineException
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.
ValidationException - The validation was specified in an invalid format.InvalidNextTokenException - The next token was specified in an invalid format. Make sure that the next token you provide is the token
returned by a previous call.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistWebhooks(ListWebhooksRequest),
AWS API
Documentationdefault ListWebhooksIterable listWebhooksPaginator() throws ValidationException, InvalidNextTokenException, AwsServiceException, SdkClientException, CodePipelineException
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.
This is a variant of
listWebhooks(software.amazon.awssdk.services.codepipeline.model.ListWebhooksRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.codepipeline.paginators.ListWebhooksIterable responses = client.listWebhooksPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.codepipeline.paginators.ListWebhooksIterable responses = client
.listWebhooksPaginator(request);
for (software.amazon.awssdk.services.codepipeline.model.ListWebhooksResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.codepipeline.paginators.ListWebhooksIterable responses = client.listWebhooksPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listWebhooks(software.amazon.awssdk.services.codepipeline.model.ListWebhooksRequest) operation.
ValidationException - The validation was specified in an invalid format.InvalidNextTokenException - The next token was specified in an invalid format. Make sure that the next token you provide is the token
returned by a previous call.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistWebhooksPaginator(ListWebhooksRequest),
AWS API
Documentationdefault ListWebhooksIterable listWebhooksPaginator(ListWebhooksRequest listWebhooksRequest) throws ValidationException, InvalidNextTokenException, AwsServiceException, SdkClientException, CodePipelineException
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.
This is a variant of
listWebhooks(software.amazon.awssdk.services.codepipeline.model.ListWebhooksRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.codepipeline.paginators.ListWebhooksIterable responses = client.listWebhooksPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.codepipeline.paginators.ListWebhooksIterable responses = client
.listWebhooksPaginator(request);
for (software.amazon.awssdk.services.codepipeline.model.ListWebhooksResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.codepipeline.paginators.ListWebhooksIterable responses = client.listWebhooksPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listWebhooks(software.amazon.awssdk.services.codepipeline.model.ListWebhooksRequest) operation.
listWebhooksRequest - ValidationException - The validation was specified in an invalid format.InvalidNextTokenException - The next token was specified in an invalid format. Make sure that the next token you provide is the token
returned by a previous call.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListWebhooksIterable listWebhooksPaginator(Consumer<ListWebhooksRequest.Builder> listWebhooksRequest) throws ValidationException, InvalidNextTokenException, AwsServiceException, SdkClientException, CodePipelineException
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.
This is a variant of
listWebhooks(software.amazon.awssdk.services.codepipeline.model.ListWebhooksRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.codepipeline.paginators.ListWebhooksIterable responses = client.listWebhooksPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.codepipeline.paginators.ListWebhooksIterable responses = client
.listWebhooksPaginator(request);
for (software.amazon.awssdk.services.codepipeline.model.ListWebhooksResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.codepipeline.paginators.ListWebhooksIterable responses = client.listWebhooksPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listWebhooks(software.amazon.awssdk.services.codepipeline.model.ListWebhooksRequest) operation.
This is a convenience which creates an instance of the ListWebhooksRequest.Builder avoiding the need to
create one manually via ListWebhooksRequest.builder()
listWebhooksRequest - A Consumer that will call methods on
ListWebhooksRequest.Builder to create a
request.ValidationException - The validation was specified in an invalid format.InvalidNextTokenException - The next token was specified in an invalid format. Make sure that the next token you provide is the token
returned by a previous call.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PollForJobsResponse pollForJobs(PollForJobsRequest pollForJobsRequest) throws ValidationException, ActionTypeNotFoundException, AwsServiceException, SdkClientException, CodePipelineException
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.
pollForJobsRequest - Represents the input of a PollForJobs action.ValidationException - The validation was specified in an invalid format.ActionTypeNotFoundException - The specified action type cannot be found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PollForJobsResponse pollForJobs(Consumer<PollForJobsRequest.Builder> pollForJobsRequest) throws ValidationException, ActionTypeNotFoundException, AwsServiceException, SdkClientException, CodePipelineException
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.
This is a convenience which creates an instance of the PollForJobsRequest.Builder avoiding the need to
create one manually via PollForJobsRequest.builder()
pollForJobsRequest - A Consumer that will call methods on
PollForJobsRequest.Builder to create a request.
Represents the input of a PollForJobs action.ValidationException - The validation was specified in an invalid format.ActionTypeNotFoundException - The specified action type cannot be found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PollForThirdPartyJobsResponse pollForThirdPartyJobs(PollForThirdPartyJobsRequest pollForThirdPartyJobsRequest) throws ActionTypeNotFoundException, ValidationException, AwsServiceException, SdkClientException, CodePipelineException
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.
pollForThirdPartyJobsRequest - Represents the input of a PollForThirdPartyJobs action.ActionTypeNotFoundException - The specified action type cannot be found.ValidationException - The validation was specified in an invalid format.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PollForThirdPartyJobsResponse pollForThirdPartyJobs(Consumer<PollForThirdPartyJobsRequest.Builder> pollForThirdPartyJobsRequest) throws ActionTypeNotFoundException, ValidationException, AwsServiceException, SdkClientException, CodePipelineException
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.
This is a convenience which creates an instance of the PollForThirdPartyJobsRequest.Builder avoiding the
need to create one manually via PollForThirdPartyJobsRequest.builder()
pollForThirdPartyJobsRequest - A Consumer that will call methods on
PollForThirdPartyJobsRequest.Builder to create
a request. Represents the input of a PollForThirdPartyJobs action.ActionTypeNotFoundException - The specified action type cannot be found.ValidationException - The validation was specified in an invalid format.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutActionRevisionResponse putActionRevision(PutActionRevisionRequest putActionRevisionRequest) throws PipelineNotFoundException, StageNotFoundException, ActionNotFoundException, ValidationException, AwsServiceException, SdkClientException, CodePipelineException
Provides information to CodePipeline about new revisions to a source.
putActionRevisionRequest - Represents the input of a PutActionRevision action.PipelineNotFoundException - The pipeline was specified in an invalid format or cannot be found.StageNotFoundException - The stage was specified in an invalid format or cannot be found.ActionNotFoundException - The specified action cannot be found.ValidationException - The validation was specified in an invalid format.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutActionRevisionResponse putActionRevision(Consumer<PutActionRevisionRequest.Builder> putActionRevisionRequest) throws PipelineNotFoundException, StageNotFoundException, ActionNotFoundException, ValidationException, AwsServiceException, SdkClientException, CodePipelineException
Provides information to CodePipeline about new revisions to a source.
This is a convenience which creates an instance of the PutActionRevisionRequest.Builder avoiding the need
to create one manually via PutActionRevisionRequest.builder()
putActionRevisionRequest - A Consumer that will call methods on
PutActionRevisionRequest.Builder to create a
request. Represents the input of a PutActionRevision action.PipelineNotFoundException - The pipeline was specified in an invalid format or cannot be found.StageNotFoundException - The stage was specified in an invalid format or cannot be found.ActionNotFoundException - The specified action cannot be found.ValidationException - The validation was specified in an invalid format.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutApprovalResultResponse putApprovalResult(PutApprovalResultRequest putApprovalResultRequest) throws InvalidApprovalTokenException, ApprovalAlreadyCompletedException, PipelineNotFoundException, StageNotFoundException, ActionNotFoundException, ValidationException, AwsServiceException, SdkClientException, CodePipelineException
Provides the response to a manual approval request to CodePipeline. Valid responses include Approved and Rejected.
putApprovalResultRequest - Represents the input of a PutApprovalResult action.InvalidApprovalTokenException - The approval request already received a response or has expired.ApprovalAlreadyCompletedException - The approval action has already been approved or rejected.PipelineNotFoundException - The pipeline was specified in an invalid format or cannot be found.StageNotFoundException - The stage was specified in an invalid format or cannot be found.ActionNotFoundException - The specified action cannot be found.ValidationException - The validation was specified in an invalid format.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutApprovalResultResponse putApprovalResult(Consumer<PutApprovalResultRequest.Builder> putApprovalResultRequest) throws InvalidApprovalTokenException, ApprovalAlreadyCompletedException, PipelineNotFoundException, StageNotFoundException, ActionNotFoundException, ValidationException, AwsServiceException, SdkClientException, CodePipelineException
Provides the response to a manual approval request to CodePipeline. Valid responses include Approved and Rejected.
This is a convenience which creates an instance of the PutApprovalResultRequest.Builder avoiding the need
to create one manually via PutApprovalResultRequest.builder()
putApprovalResultRequest - A Consumer that will call methods on
PutApprovalResultRequest.Builder to create a
request. Represents the input of a PutApprovalResult action.InvalidApprovalTokenException - The approval request already received a response or has expired.ApprovalAlreadyCompletedException - The approval action has already been approved or rejected.PipelineNotFoundException - The pipeline was specified in an invalid format or cannot be found.StageNotFoundException - The stage was specified in an invalid format or cannot be found.ActionNotFoundException - The specified action cannot be found.ValidationException - The validation was specified in an invalid format.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutJobFailureResultResponse putJobFailureResult(PutJobFailureResultRequest putJobFailureResultRequest) throws ValidationException, JobNotFoundException, InvalidJobStateException, AwsServiceException, SdkClientException, CodePipelineException
Represents the failure of a job as returned to the pipeline by a job worker. Used for custom actions only.
putJobFailureResultRequest - Represents the input of a PutJobFailureResult action.ValidationException - The validation was specified in an invalid format.JobNotFoundException - The job was specified in an invalid format or cannot be found.InvalidJobStateException - The job state was specified in an invalid format.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutJobFailureResultResponse putJobFailureResult(Consumer<PutJobFailureResultRequest.Builder> putJobFailureResultRequest) throws ValidationException, JobNotFoundException, InvalidJobStateException, AwsServiceException, SdkClientException, CodePipelineException
Represents the failure of a job as returned to the pipeline by a job worker. Used for custom actions only.
This is a convenience which creates an instance of the PutJobFailureResultRequest.Builder avoiding the
need to create one manually via PutJobFailureResultRequest.builder()
putJobFailureResultRequest - A Consumer that will call methods on
PutJobFailureResultRequest.Builder to create a
request. Represents the input of a PutJobFailureResult action.ValidationException - The validation was specified in an invalid format.JobNotFoundException - The job was specified in an invalid format or cannot be found.InvalidJobStateException - The job state was specified in an invalid format.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutJobSuccessResultResponse putJobSuccessResult(PutJobSuccessResultRequest putJobSuccessResultRequest) throws ValidationException, JobNotFoundException, InvalidJobStateException, OutputVariablesSizeExceededException, AwsServiceException, SdkClientException, CodePipelineException
Represents the success of a job as returned to the pipeline by a job worker. Used for custom actions only.
putJobSuccessResultRequest - Represents the input of a PutJobSuccessResult action.ValidationException - The validation was specified in an invalid format.JobNotFoundException - The job was specified in an invalid format or cannot be found.InvalidJobStateException - The job state was specified in an invalid format.OutputVariablesSizeExceededException - Exceeded the total size limit for all variables in the pipeline.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutJobSuccessResultResponse putJobSuccessResult(Consumer<PutJobSuccessResultRequest.Builder> putJobSuccessResultRequest) throws ValidationException, JobNotFoundException, InvalidJobStateException, OutputVariablesSizeExceededException, AwsServiceException, SdkClientException, CodePipelineException
Represents the success of a job as returned to the pipeline by a job worker. Used for custom actions only.
This is a convenience which creates an instance of the PutJobSuccessResultRequest.Builder avoiding the
need to create one manually via PutJobSuccessResultRequest.builder()
putJobSuccessResultRequest - A Consumer that will call methods on
PutJobSuccessResultRequest.Builder to create a
request. Represents the input of a PutJobSuccessResult action.ValidationException - The validation was specified in an invalid format.JobNotFoundException - The job was specified in an invalid format or cannot be found.InvalidJobStateException - The job state was specified in an invalid format.OutputVariablesSizeExceededException - Exceeded the total size limit for all variables in the pipeline.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutThirdPartyJobFailureResultResponse putThirdPartyJobFailureResult(PutThirdPartyJobFailureResultRequest putThirdPartyJobFailureResultRequest) throws ValidationException, JobNotFoundException, InvalidJobStateException, InvalidClientTokenException, AwsServiceException, SdkClientException, CodePipelineException
Represents the failure of a third party job as returned to the pipeline by a job worker. Used for partner actions only.
putThirdPartyJobFailureResultRequest - Represents the input of a PutThirdPartyJobFailureResult action.ValidationException - The validation was specified in an invalid format.JobNotFoundException - The job was specified in an invalid format or cannot be found.InvalidJobStateException - The job state was specified in an invalid format.InvalidClientTokenException - The client token was specified in an invalid formatSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutThirdPartyJobFailureResultResponse putThirdPartyJobFailureResult(Consumer<PutThirdPartyJobFailureResultRequest.Builder> putThirdPartyJobFailureResultRequest) throws ValidationException, JobNotFoundException, InvalidJobStateException, InvalidClientTokenException, AwsServiceException, SdkClientException, CodePipelineException
Represents the failure of a third party job as returned to the pipeline by a job worker. Used for partner actions only.
This is a convenience which creates an instance of the PutThirdPartyJobFailureResultRequest.Builder
avoiding the need to create one manually via PutThirdPartyJobFailureResultRequest.builder()
putThirdPartyJobFailureResultRequest - A Consumer that will call methods on
PutThirdPartyJobFailureResultRequest.Builder to
create a request. Represents the input of a PutThirdPartyJobFailureResult action.ValidationException - The validation was specified in an invalid format.JobNotFoundException - The job was specified in an invalid format or cannot be found.InvalidJobStateException - The job state was specified in an invalid format.InvalidClientTokenException - The client token was specified in an invalid formatSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutThirdPartyJobSuccessResultResponse putThirdPartyJobSuccessResult(PutThirdPartyJobSuccessResultRequest putThirdPartyJobSuccessResultRequest) throws ValidationException, JobNotFoundException, InvalidJobStateException, InvalidClientTokenException, AwsServiceException, SdkClientException, CodePipelineException
Represents the success of a third party job as returned to the pipeline by a job worker. Used for partner actions only.
putThirdPartyJobSuccessResultRequest - Represents the input of a PutThirdPartyJobSuccessResult action.ValidationException - The validation was specified in an invalid format.JobNotFoundException - The job was specified in an invalid format or cannot be found.InvalidJobStateException - The job state was specified in an invalid format.InvalidClientTokenException - The client token was specified in an invalid formatSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutThirdPartyJobSuccessResultResponse putThirdPartyJobSuccessResult(Consumer<PutThirdPartyJobSuccessResultRequest.Builder> putThirdPartyJobSuccessResultRequest) throws ValidationException, JobNotFoundException, InvalidJobStateException, InvalidClientTokenException, AwsServiceException, SdkClientException, CodePipelineException
Represents the success of a third party job as returned to the pipeline by a job worker. Used for partner actions only.
This is a convenience which creates an instance of the PutThirdPartyJobSuccessResultRequest.Builder
avoiding the need to create one manually via PutThirdPartyJobSuccessResultRequest.builder()
putThirdPartyJobSuccessResultRequest - A Consumer that will call methods on
PutThirdPartyJobSuccessResultRequest.Builder to
create a request. Represents the input of a PutThirdPartyJobSuccessResult action.ValidationException - The validation was specified in an invalid format.JobNotFoundException - The job was specified in an invalid format or cannot be found.InvalidJobStateException - The job state was specified in an invalid format.InvalidClientTokenException - The client token was specified in an invalid formatSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutWebhookResponse putWebhook(PutWebhookRequest putWebhookRequest) throws ValidationException, LimitExceededException, InvalidWebhookFilterPatternException, InvalidWebhookAuthenticationParametersException, PipelineNotFoundException, TooManyTagsException, InvalidTagsException, ConcurrentModificationException, AwsServiceException, SdkClientException, CodePipelineException
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.
putWebhookRequest - ValidationException - The validation was specified in an invalid format.LimitExceededException - The number of pipelines associated with the Amazon Web Services account has exceeded the limit allowed
for the account.InvalidWebhookFilterPatternException - The specified event filter rule is in an invalid format.InvalidWebhookAuthenticationParametersException - The specified authentication type is in an invalid format.PipelineNotFoundException - The pipeline was specified in an invalid format or cannot be found.TooManyTagsException - The tags limit for a resource has been exceeded.InvalidTagsException - The specified resource tags are invalid.ConcurrentModificationException - Unable to modify the tag due to a simultaneous update request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutWebhookResponse putWebhook(Consumer<PutWebhookRequest.Builder> putWebhookRequest) throws ValidationException, LimitExceededException, InvalidWebhookFilterPatternException, InvalidWebhookAuthenticationParametersException, PipelineNotFoundException, TooManyTagsException, InvalidTagsException, ConcurrentModificationException, AwsServiceException, SdkClientException, CodePipelineException
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.
This is a convenience which creates an instance of the PutWebhookRequest.Builder avoiding the need to
create one manually via PutWebhookRequest.builder()
putWebhookRequest - A Consumer that will call methods on
PutWebhookRequest.Builder to create a request.ValidationException - The validation was specified in an invalid format.LimitExceededException - The number of pipelines associated with the Amazon Web Services account has exceeded the limit allowed
for the account.InvalidWebhookFilterPatternException - The specified event filter rule is in an invalid format.InvalidWebhookAuthenticationParametersException - The specified authentication type is in an invalid format.PipelineNotFoundException - The pipeline was specified in an invalid format or cannot be found.TooManyTagsException - The tags limit for a resource has been exceeded.InvalidTagsException - The specified resource tags are invalid.ConcurrentModificationException - Unable to modify the tag due to a simultaneous update request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RegisterWebhookWithThirdPartyResponse registerWebhookWithThirdParty(RegisterWebhookWithThirdPartyRequest registerWebhookWithThirdPartyRequest) throws ValidationException, WebhookNotFoundException, AwsServiceException, SdkClientException, CodePipelineException
Configures a connection between the webhook that was created and the external tool with events to be detected.
registerWebhookWithThirdPartyRequest - ValidationException - The validation was specified in an invalid format.WebhookNotFoundException - The specified webhook was entered in an invalid format or cannot be found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RegisterWebhookWithThirdPartyResponse registerWebhookWithThirdParty(Consumer<RegisterWebhookWithThirdPartyRequest.Builder> registerWebhookWithThirdPartyRequest) throws ValidationException, WebhookNotFoundException, AwsServiceException, SdkClientException, CodePipelineException
Configures a connection between the webhook that was created and the external tool with events to be detected.
This is a convenience which creates an instance of the RegisterWebhookWithThirdPartyRequest.Builder
avoiding the need to create one manually via RegisterWebhookWithThirdPartyRequest.builder()
registerWebhookWithThirdPartyRequest - A Consumer that will call methods on
RegisterWebhookWithThirdPartyRequest.Builder to
create a request.ValidationException - The validation was specified in an invalid format.WebhookNotFoundException - The specified webhook was entered in an invalid format or cannot be found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RetryStageExecutionResponse retryStageExecution(RetryStageExecutionRequest retryStageExecutionRequest) throws ValidationException, ConflictException, PipelineNotFoundException, StageNotFoundException, StageNotRetryableException, NotLatestPipelineExecutionException, AwsServiceException, SdkClientException, CodePipelineException
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.
retryStageExecutionRequest - Represents the input of a RetryStageExecution action.ValidationException - The validation was specified in an invalid format.ConflictException - Your request cannot be handled because the pipeline is busy handling ongoing activities. Try again later.PipelineNotFoundException - The pipeline was specified in an invalid format or cannot be found.StageNotFoundException - The stage was specified in an invalid format or cannot be found.StageNotRetryableException - Unable to retry. The pipeline structure or stage state might have changed while actions awaited retry, or
the stage contains no failed actions.NotLatestPipelineExecutionException - The stage has failed in a later run of the pipeline and the pipelineExecutionId associated
with the request is out of date.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RetryStageExecutionResponse retryStageExecution(Consumer<RetryStageExecutionRequest.Builder> retryStageExecutionRequest) throws ValidationException, ConflictException, PipelineNotFoundException, StageNotFoundException, StageNotRetryableException, NotLatestPipelineExecutionException, AwsServiceException, SdkClientException, CodePipelineException
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.
This is a convenience which creates an instance of the RetryStageExecutionRequest.Builder avoiding the
need to create one manually via RetryStageExecutionRequest.builder()
retryStageExecutionRequest - A Consumer that will call methods on
RetryStageExecutionRequest.Builder to create a
request. Represents the input of a RetryStageExecution action.ValidationException - The validation was specified in an invalid format.ConflictException - Your request cannot be handled because the pipeline is busy handling ongoing activities. Try again later.PipelineNotFoundException - The pipeline was specified in an invalid format or cannot be found.StageNotFoundException - The stage was specified in an invalid format or cannot be found.StageNotRetryableException - Unable to retry. The pipeline structure or stage state might have changed while actions awaited retry, or
the stage contains no failed actions.NotLatestPipelineExecutionException - The stage has failed in a later run of the pipeline and the pipelineExecutionId associated
with the request is out of date.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StartPipelineExecutionResponse startPipelineExecution(StartPipelineExecutionRequest startPipelineExecutionRequest) throws ValidationException, ConflictException, PipelineNotFoundException, AwsServiceException, SdkClientException, CodePipelineException
Starts the specified pipeline. Specifically, it begins processing the latest commit to the source location specified as part of the pipeline.
startPipelineExecutionRequest - Represents the input of a StartPipelineExecution action.ValidationException - The validation was specified in an invalid format.ConflictException - Your request cannot be handled because the pipeline is busy handling ongoing activities. Try again later.PipelineNotFoundException - The pipeline was specified in an invalid format or cannot be found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StartPipelineExecutionResponse startPipelineExecution(Consumer<StartPipelineExecutionRequest.Builder> startPipelineExecutionRequest) throws ValidationException, ConflictException, PipelineNotFoundException, AwsServiceException, SdkClientException, CodePipelineException
Starts the specified pipeline. Specifically, it begins processing the latest commit to the source location specified as part of the pipeline.
This is a convenience which creates an instance of the StartPipelineExecutionRequest.Builder avoiding the
need to create one manually via StartPipelineExecutionRequest.builder()
startPipelineExecutionRequest - A Consumer that will call methods on
StartPipelineExecutionRequest.Builder to create
a request. Represents the input of a StartPipelineExecution action.ValidationException - The validation was specified in an invalid format.ConflictException - Your request cannot be handled because the pipeline is busy handling ongoing activities. Try again later.PipelineNotFoundException - The pipeline was specified in an invalid format or cannot be found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StopPipelineExecutionResponse stopPipelineExecution(StopPipelineExecutionRequest stopPipelineExecutionRequest) throws ValidationException, ConflictException, PipelineNotFoundException, PipelineExecutionNotStoppableException, DuplicatedStopRequestException, AwsServiceException, SdkClientException, CodePipelineException
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.
stopPipelineExecutionRequest - ValidationException - The validation was specified in an invalid format.ConflictException - Your request cannot be handled because the pipeline is busy handling ongoing activities. Try again later.PipelineNotFoundException - The pipeline was specified in an invalid format or cannot be found.PipelineExecutionNotStoppableException - Unable to stop the pipeline execution. The execution might already be in a Stopped state, or
it might no longer be in progress.DuplicatedStopRequestException - The pipeline execution is already in a Stopping state. If you already chose to stop and
wait, you cannot make that request again. You can choose to stop and abandon now, but be aware that this
option can lead to failed tasks or out of sequence tasks. If you already chose to stop and abandon, you
cannot make that request again.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StopPipelineExecutionResponse stopPipelineExecution(Consumer<StopPipelineExecutionRequest.Builder> stopPipelineExecutionRequest) throws ValidationException, ConflictException, PipelineNotFoundException, PipelineExecutionNotStoppableException, DuplicatedStopRequestException, AwsServiceException, SdkClientException, CodePipelineException
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.
This is a convenience which creates an instance of the StopPipelineExecutionRequest.Builder avoiding the
need to create one manually via StopPipelineExecutionRequest.builder()
stopPipelineExecutionRequest - A Consumer that will call methods on
StopPipelineExecutionRequest.Builder to create
a request.ValidationException - The validation was specified in an invalid format.ConflictException - Your request cannot be handled because the pipeline is busy handling ongoing activities. Try again later.PipelineNotFoundException - The pipeline was specified in an invalid format or cannot be found.PipelineExecutionNotStoppableException - Unable to stop the pipeline execution. The execution might already be in a Stopped state, or
it might no longer be in progress.DuplicatedStopRequestException - The pipeline execution is already in a Stopping state. If you already chose to stop and
wait, you cannot make that request again. You can choose to stop and abandon now, but be aware that this
option can lead to failed tasks or out of sequence tasks. If you already chose to stop and abandon, you
cannot make that request again.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws ValidationException, ResourceNotFoundException, InvalidArnException, TooManyTagsException, InvalidTagsException, ConcurrentModificationException, AwsServiceException, SdkClientException, CodePipelineException
Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.
tagResourceRequest - ValidationException - The validation was specified in an invalid format.ResourceNotFoundException - The resource was specified in an invalid format.InvalidArnException - The specified resource ARN is invalid.TooManyTagsException - The tags limit for a resource has been exceeded.InvalidTagsException - The specified resource tags are invalid.ConcurrentModificationException - Unable to modify the tag due to a simultaneous update request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws ValidationException, ResourceNotFoundException, InvalidArnException, TooManyTagsException, InvalidTagsException, ConcurrentModificationException, AwsServiceException, SdkClientException, CodePipelineException
Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.
This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on
TagResourceRequest.Builder to create a request.ValidationException - The validation was specified in an invalid format.ResourceNotFoundException - The resource was specified in an invalid format.InvalidArnException - The specified resource ARN is invalid.TooManyTagsException - The tags limit for a resource has been exceeded.InvalidTagsException - The specified resource tags are invalid.ConcurrentModificationException - Unable to modify the tag due to a simultaneous update request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ValidationException, ResourceNotFoundException, InvalidArnException, InvalidTagsException, ConcurrentModificationException, AwsServiceException, SdkClientException, CodePipelineException
Removes tags from an Amazon Web Services resource.
untagResourceRequest - ValidationException - The validation was specified in an invalid format.ResourceNotFoundException - The resource was specified in an invalid format.InvalidArnException - The specified resource ARN is invalid.InvalidTagsException - The specified resource tags are invalid.ConcurrentModificationException - Unable to modify the tag due to a simultaneous update request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws ValidationException, ResourceNotFoundException, InvalidArnException, InvalidTagsException, ConcurrentModificationException, AwsServiceException, SdkClientException, CodePipelineException
Removes tags from an Amazon Web Services resource.
This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on
UntagResourceRequest.Builder to create a
request.ValidationException - The validation was specified in an invalid format.ResourceNotFoundException - The resource was specified in an invalid format.InvalidArnException - The specified resource ARN is invalid.InvalidTagsException - The specified resource tags are invalid.ConcurrentModificationException - Unable to modify the tag due to a simultaneous update request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateActionTypeResponse updateActionType(UpdateActionTypeRequest updateActionTypeRequest) throws RequestFailedException, ValidationException, ActionTypeNotFoundException, AwsServiceException, SdkClientException, CodePipelineException
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.
updateActionTypeRequest - RequestFailedException - The request failed because of an unknown error, exception, or failure.ValidationException - The validation was specified in an invalid format.ActionTypeNotFoundException - The specified action type cannot be found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateActionTypeResponse updateActionType(Consumer<UpdateActionTypeRequest.Builder> updateActionTypeRequest) throws RequestFailedException, ValidationException, ActionTypeNotFoundException, AwsServiceException, SdkClientException, CodePipelineException
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.
This is a convenience which creates an instance of the UpdateActionTypeRequest.Builder avoiding the need
to create one manually via UpdateActionTypeRequest.builder()
updateActionTypeRequest - A Consumer that will call methods on
UpdateActionTypeRequest.Builder to create a
request.RequestFailedException - The request failed because of an unknown error, exception, or failure.ValidationException - The validation was specified in an invalid format.ActionTypeNotFoundException - The specified action type cannot be found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdatePipelineResponse updatePipeline(UpdatePipelineRequest updatePipelineRequest) throws ValidationException, InvalidStageDeclarationException, InvalidActionDeclarationException, InvalidBlockerDeclarationException, InvalidStructureException, LimitExceededException, AwsServiceException, SdkClientException, CodePipelineException
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.
updatePipelineRequest - Represents the input of an UpdatePipeline action.ValidationException - The validation was specified in an invalid format.InvalidStageDeclarationException - The stage declaration was specified in an invalid format.InvalidActionDeclarationException - The action declaration was specified in an invalid format.InvalidBlockerDeclarationException - Reserved for future use.InvalidStructureException - The structure was specified in an invalid format.LimitExceededException - The number of pipelines associated with the Amazon Web Services account has exceeded the limit allowed
for the account.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdatePipelineResponse updatePipeline(Consumer<UpdatePipelineRequest.Builder> updatePipelineRequest) throws ValidationException, InvalidStageDeclarationException, InvalidActionDeclarationException, InvalidBlockerDeclarationException, InvalidStructureException, LimitExceededException, AwsServiceException, SdkClientException, CodePipelineException
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.
This is a convenience which creates an instance of the UpdatePipelineRequest.Builder avoiding the need to
create one manually via UpdatePipelineRequest.builder()
updatePipelineRequest - A Consumer that will call methods on
UpdatePipelineRequest.Builder to create a
request. Represents the input of an UpdatePipeline action.ValidationException - The validation was specified in an invalid format.InvalidStageDeclarationException - The stage declaration was specified in an invalid format.InvalidActionDeclarationException - The action declaration was specified in an invalid format.InvalidBlockerDeclarationException - Reserved for future use.InvalidStructureException - The structure was specified in an invalid format.LimitExceededException - The number of pipelines associated with the Amazon Web Services account has exceeded the limit allowed
for the account.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodePipelineException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionstatic CodePipelineClient create()
CodePipelineClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static CodePipelineClientBuilder builder()
CodePipelineClient.static ServiceMetadata serviceMetadata()
default CodePipelineServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientCopyright © 2023. All rights reserved.