Interface CodePipelineClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
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.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptiondefault AcknowledgeJobResponse
acknowledgeJob
(Consumer<AcknowledgeJobRequest.Builder> acknowledgeJobRequest) Returns information about a specified job and whether that job has been received by the job worker.default AcknowledgeJobResponse
acknowledgeJob
(AcknowledgeJobRequest acknowledgeJobRequest) Returns information about a specified job and whether that job has been received by the job worker.default AcknowledgeThirdPartyJobResponse
acknowledgeThirdPartyJob
(Consumer<AcknowledgeThirdPartyJobRequest.Builder> acknowledgeThirdPartyJobRequest) Confirms a job worker has received the specified job.default AcknowledgeThirdPartyJobResponse
acknowledgeThirdPartyJob
(AcknowledgeThirdPartyJobRequest acknowledgeThirdPartyJobRequest) Confirms a job worker has received the specified job.static CodePipelineClientBuilder
builder()
Create a builder that can be used to configure and create aCodePipelineClient
.static CodePipelineClient
create()
Create aCodePipelineClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.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.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.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) This is a variant oflistActionExecutions(software.amazon.awssdk.services.codepipeline.model.ListActionExecutionsRequest)
operation.default ListActionExecutionsIterable
listActionExecutionsPaginator
(ListActionExecutionsRequest listActionExecutionsRequest) This is a variant oflistActionExecutions(software.amazon.awssdk.services.codepipeline.model.ListActionExecutionsRequest)
operation.default ListActionTypesResponse
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
This is a variant oflistActionTypes(software.amazon.awssdk.services.codepipeline.model.ListActionTypesRequest)
operation.default ListActionTypesIterable
listActionTypesPaginator
(Consumer<ListActionTypesRequest.Builder> listActionTypesRequest) This is a variant oflistActionTypes(software.amazon.awssdk.services.codepipeline.model.ListActionTypesRequest)
operation.default ListActionTypesIterable
listActionTypesPaginator
(ListActionTypesRequest listActionTypesRequest) This is a variant oflistActionTypes(software.amazon.awssdk.services.codepipeline.model.ListActionTypesRequest)
operation.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) This is a variant oflistPipelineExecutions(software.amazon.awssdk.services.codepipeline.model.ListPipelineExecutionsRequest)
operation.default ListPipelineExecutionsIterable
listPipelineExecutionsPaginator
(ListPipelineExecutionsRequest listPipelineExecutionsRequest) This is a variant oflistPipelineExecutions(software.amazon.awssdk.services.codepipeline.model.ListPipelineExecutionsRequest)
operation.default ListPipelinesResponse
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
This is a variant oflistPipelines(software.amazon.awssdk.services.codepipeline.model.ListPipelinesRequest)
operation.default ListPipelinesIterable
listPipelinesPaginator
(Consumer<ListPipelinesRequest.Builder> listPipelinesRequest) This is a variant oflistPipelines(software.amazon.awssdk.services.codepipeline.model.ListPipelinesRequest)
operation.default ListPipelinesIterable
listPipelinesPaginator
(ListPipelinesRequest listPipelinesRequest) This is a variant oflistPipelines(software.amazon.awssdk.services.codepipeline.model.ListPipelinesRequest)
operation.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) This is a variant oflistTagsForResource(software.amazon.awssdk.services.codepipeline.model.ListTagsForResourceRequest)
operation.default ListTagsForResourceIterable
listTagsForResourcePaginator
(ListTagsForResourceRequest listTagsForResourceRequest) This is a variant oflistTagsForResource(software.amazon.awssdk.services.codepipeline.model.ListTagsForResourceRequest)
operation.default ListWebhooksResponse
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
This is a variant oflistWebhooks(software.amazon.awssdk.services.codepipeline.model.ListWebhooksRequest)
operation.default ListWebhooksIterable
listWebhooksPaginator
(Consumer<ListWebhooksRequest.Builder> listWebhooksRequest) This is a variant oflistWebhooks(software.amazon.awssdk.services.codepipeline.model.ListWebhooksRequest)
operation.default ListWebhooksIterable
listWebhooksPaginator
(ListWebhooksRequest listWebhooksRequest) This is a variant oflistWebhooks(software.amazon.awssdk.services.codepipeline.model.ListWebhooksRequest)
operation.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.putThirdPartyJobFailureResult
(Consumer<PutThirdPartyJobFailureResultRequest.Builder> putThirdPartyJobFailureResultRequest) Represents the failure of a third party job as returned to the pipeline by a job worker.putThirdPartyJobFailureResult
(PutThirdPartyJobFailureResultRequest putThirdPartyJobFailureResultRequest) Represents the failure of a third party job as returned to the pipeline by a job worker.putThirdPartyJobSuccessResult
(Consumer<PutThirdPartyJobSuccessResultRequest.Builder> putThirdPartyJobSuccessResultRequest) Represents the success of a third party job as returned to the pipeline by a job worker.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.registerWebhookWithThirdParty
(Consumer<RegisterWebhookWithThirdPartyRequest.Builder> registerWebhookWithThirdPartyRequest) Configures a connection between the webhook that was created and the external tool with events to be detected.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 RollbackStageResponse
rollbackStage
(Consumer<RollbackStageRequest.Builder> rollbackStageRequest) Rolls back a stage execution.default RollbackStageResponse
rollbackStage
(RollbackStageRequest rollbackStageRequest) Rolls back a stage execution.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic 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.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
acknowledgeJob
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.
- Parameters:
acknowledgeJobRequest
- Represents the input of an AcknowledgeJob action.- Returns:
- Result of the AcknowledgeJob operation returned by the service.
- See Also:
-
acknowledgeJob
default 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 viaAcknowledgeJobRequest.builder()
- Parameters:
acknowledgeJobRequest
- AConsumer
that will call methods onAcknowledgeJobRequest.Builder
to create a request. Represents the input of an AcknowledgeJob action.- Returns:
- Result of the AcknowledgeJob operation returned by the service.
- See Also:
-
acknowledgeThirdPartyJob
default 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.
- Parameters:
acknowledgeThirdPartyJobRequest
- Represents the input of an AcknowledgeThirdPartyJob action.- Returns:
- Result of the AcknowledgeThirdPartyJob operation returned by the service.
- See Also:
-
acknowledgeThirdPartyJob
default 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 viaAcknowledgeThirdPartyJobRequest.builder()
- Parameters:
acknowledgeThirdPartyJobRequest
- AConsumer
that will call methods onAcknowledgeThirdPartyJobRequest.Builder
to create a request. Represents the input of an AcknowledgeThirdPartyJob action.- Returns:
- Result of the AcknowledgeThirdPartyJob operation returned by the service.
- See Also:
-
createCustomActionType
default 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.
- Parameters:
createCustomActionTypeRequest
- Represents the input of a CreateCustomActionType operation.- Returns:
- Result of the CreateCustomActionType operation returned by the service.
- See Also:
-
createCustomActionType
default 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 viaCreateCustomActionTypeRequest.builder()
- Parameters:
createCustomActionTypeRequest
- AConsumer
that will call methods onCreateCustomActionTypeRequest.Builder
to create a request. Represents the input of a CreateCustomActionType operation.- Returns:
- Result of the CreateCustomActionType operation returned by the service.
- See Also:
-
createPipeline
default 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
orartifactStores
in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must useartifactStores
.- Parameters:
createPipelineRequest
- Represents the input of aCreatePipeline
action.- Returns:
- Result of the CreatePipeline operation returned by the service.
- See Also:
-
createPipeline
default 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
orartifactStores
in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must useartifactStores
.
This is a convenience which creates an instance of the
CreatePipelineRequest.Builder
avoiding the need to create one manually viaCreatePipelineRequest.builder()
- Parameters:
createPipelineRequest
- AConsumer
that will call methods onCreatePipelineRequest.Builder
to create a request. Represents the input of aCreatePipeline
action.- Returns:
- Result of the CreatePipeline operation returned by the service.
- See Also:
-
deleteCustomActionType
default 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.
- Parameters:
deleteCustomActionTypeRequest
- Represents the input of aDeleteCustomActionType
operation. The custom action will be marked as deleted.- Returns:
- Result of the DeleteCustomActionType operation returned by the service.
- See Also:
-
deleteCustomActionType
default 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 viaDeleteCustomActionTypeRequest.builder()
- Parameters:
deleteCustomActionTypeRequest
- AConsumer
that will call methods onDeleteCustomActionTypeRequest.Builder
to create a request. Represents the input of aDeleteCustomActionType
operation. The custom action will be marked as deleted.- Returns:
- Result of the DeleteCustomActionType operation returned by the service.
- See Also:
-
deletePipeline
default DeletePipelineResponse deletePipeline(DeletePipelineRequest deletePipelineRequest) throws ValidationException, ConcurrentModificationException, AwsServiceException, SdkClientException, CodePipelineException Deletes the specified pipeline.
- Parameters:
deletePipelineRequest
- Represents the input of aDeletePipeline
action.- Returns:
- Result of the DeletePipeline operation returned by the service.
- See Also:
-
deletePipeline
default 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 viaDeletePipelineRequest.builder()
- Parameters:
deletePipelineRequest
- AConsumer
that will call methods onDeletePipelineRequest.Builder
to create a request. Represents the input of aDeletePipeline
action.- Returns:
- Result of the DeletePipeline operation returned by the service.
- See Also:
-
deleteWebhook
default 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.
- Parameters:
deleteWebhookRequest
-- Returns:
- Result of the DeleteWebhook operation returned by the service.
- See Also:
-
deleteWebhook
default 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 viaDeleteWebhookRequest.builder()
- Parameters:
deleteWebhookRequest
- AConsumer
that will call methods onDeleteWebhookRequest.Builder
to create a request.- Returns:
- Result of the DeleteWebhook operation returned by the service.
- See Also:
-
deregisterWebhookWithThirdParty
default 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.
- Parameters:
deregisterWebhookWithThirdPartyRequest
-- Returns:
- Result of the DeregisterWebhookWithThirdParty operation returned by the service.
- See Also:
-
deregisterWebhookWithThirdParty
default 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 viaDeregisterWebhookWithThirdPartyRequest.builder()
- Parameters:
deregisterWebhookWithThirdPartyRequest
- AConsumer
that will call methods onDeregisterWebhookWithThirdPartyRequest.Builder
to create a request.- Returns:
- Result of the DeregisterWebhookWithThirdParty operation returned by the service.
- See Also:
-
disableStageTransition
default 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.
- Parameters:
disableStageTransitionRequest
- Represents the input of aDisableStageTransition
action.- Returns:
- Result of the DisableStageTransition operation returned by the service.
- See Also:
-
disableStageTransition
default 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 viaDisableStageTransitionRequest.builder()
- Parameters:
disableStageTransitionRequest
- AConsumer
that will call methods onDisableStageTransitionRequest.Builder
to create a request. Represents the input of aDisableStageTransition
action.- Returns:
- Result of the DisableStageTransition operation returned by the service.
- See Also:
-
enableStageTransition
default EnableStageTransitionResponse enableStageTransition(EnableStageTransitionRequest enableStageTransitionRequest) throws ValidationException, PipelineNotFoundException, StageNotFoundException, AwsServiceException, SdkClientException, CodePipelineException Enables artifacts in a pipeline to transition to a stage in a pipeline.
- Parameters:
enableStageTransitionRequest
- Represents the input of anEnableStageTransition
action.- Returns:
- Result of the EnableStageTransition operation returned by the service.
- See Also:
-
enableStageTransition
default 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 viaEnableStageTransitionRequest.builder()
- Parameters:
enableStageTransitionRequest
- AConsumer
that will call methods onEnableStageTransitionRequest.Builder
to create a request. Represents the input of anEnableStageTransition
action.- Returns:
- Result of the EnableStageTransition operation returned by the service.
- See Also:
-
getActionType
default 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.
- Parameters:
getActionTypeRequest
-- Returns:
- Result of the GetActionType operation returned by the service.
- See Also:
-
getActionType
default 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 viaGetActionTypeRequest.builder()
- Parameters:
getActionTypeRequest
- AConsumer
that will call methods onGetActionTypeRequest.Builder
to create a request.- Returns:
- Result of the GetActionType operation returned by the service.
- See Also:
-
getJobDetails
default 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.
- Parameters:
getJobDetailsRequest
- Represents the input of aGetJobDetails
action.- Returns:
- Result of the GetJobDetails operation returned by the service.
- See Also:
-
getJobDetails
default 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 viaGetJobDetailsRequest.builder()
- Parameters:
getJobDetailsRequest
- AConsumer
that will call methods onGetJobDetailsRequest.Builder
to create a request. Represents the input of aGetJobDetails
action.- Returns:
- Result of the GetJobDetails operation returned by the service.
- See Also:
-
getPipeline
default 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.
- Parameters:
getPipelineRequest
- Represents the input of aGetPipeline
action.- Returns:
- Result of the GetPipeline operation returned by the service.
- See Also:
-
getPipeline
default 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 viaGetPipelineRequest.builder()
- Parameters:
getPipelineRequest
- AConsumer
that will call methods onGetPipelineRequest.Builder
to create a request. Represents the input of aGetPipeline
action.- Returns:
- Result of the GetPipeline operation returned by the service.
- See Also:
-
getPipelineExecution
default 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.
- Parameters:
getPipelineExecutionRequest
- Represents the input of aGetPipelineExecution
action.- Returns:
- Result of the GetPipelineExecution operation returned by the service.
- See Also:
-
getPipelineExecution
default 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 viaGetPipelineExecutionRequest.builder()
- Parameters:
getPipelineExecutionRequest
- AConsumer
that will call methods onGetPipelineExecutionRequest.Builder
to create a request. Represents the input of aGetPipelineExecution
action.- Returns:
- Result of the GetPipelineExecution operation returned by the service.
- See Also:
-
getPipelineState
default 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
andrevisionUrl
fields indicate the source revision information, such as the commit ID, for the current state.- Parameters:
getPipelineStateRequest
- Represents the input of aGetPipelineState
action.- Returns:
- Result of the GetPipelineState operation returned by the service.
- See Also:
-
getPipelineState
default 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
andrevisionUrl
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 viaGetPipelineStateRequest.builder()
- Parameters:
getPipelineStateRequest
- AConsumer
that will call methods onGetPipelineStateRequest.Builder
to create a request. Represents the input of aGetPipelineState
action.- Returns:
- Result of the GetPipelineState operation returned by the service.
- See Also:
-
getThirdPartyJobDetails
default 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.
- Parameters:
getThirdPartyJobDetailsRequest
- Represents the input of aGetThirdPartyJobDetails
action.- Returns:
- Result of the GetThirdPartyJobDetails operation returned by the service.
- See Also:
-
getThirdPartyJobDetails
default 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 viaGetThirdPartyJobDetailsRequest.builder()
- Parameters:
getThirdPartyJobDetailsRequest
- AConsumer
that will call methods onGetThirdPartyJobDetailsRequest.Builder
to create a request. Represents the input of aGetThirdPartyJobDetails
action.- Returns:
- Result of the GetThirdPartyJobDetails operation returned by the service.
- See Also:
-
listActionExecutions
default ListActionExecutionsResponse listActionExecutions(ListActionExecutionsRequest listActionExecutionsRequest) throws ValidationException, PipelineNotFoundException, InvalidNextTokenException, PipelineExecutionNotFoundException, AwsServiceException, SdkClientException, CodePipelineException Lists the action executions that have occurred in a pipeline.
- Parameters:
listActionExecutionsRequest
-- Returns:
- Result of the ListActionExecutions operation returned by the service.
- See Also:
-
listActionExecutions
default 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 viaListActionExecutionsRequest.builder()
- Parameters:
listActionExecutionsRequest
- AConsumer
that will call methods onListActionExecutionsRequest.Builder
to create a request.- Returns:
- Result of the ListActionExecutions operation returned by the service.
- See Also:
-
listActionExecutionsPaginator
default ListActionExecutionsIterable listActionExecutionsPaginator(ListActionExecutionsRequest listActionExecutionsRequest) throws ValidationException, PipelineNotFoundException, InvalidNextTokenException, PipelineExecutionNotFoundException, AwsServiceException, SdkClientException, CodePipelineException 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 Streamsoftware.amazon.awssdk.services.codepipeline.paginators.ListActionExecutionsIterable responses = client.listActionExecutionsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
listActionExecutionsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listActionExecutionsPaginator
default ListActionExecutionsIterable listActionExecutionsPaginator(Consumer<ListActionExecutionsRequest.Builder> listActionExecutionsRequest) throws ValidationException, PipelineNotFoundException, InvalidNextTokenException, PipelineExecutionNotFoundException, AwsServiceException, SdkClientException, CodePipelineException 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 Streamsoftware.amazon.awssdk.services.codepipeline.paginators.ListActionExecutionsIterable responses = client.listActionExecutionsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListActionExecutionsRequest.builder()
- Parameters:
listActionExecutionsRequest
- AConsumer
that will call methods onListActionExecutionsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listActionTypes
default ListActionTypesResponse listActionTypes(ListActionTypesRequest listActionTypesRequest) throws ValidationException, InvalidNextTokenException, AwsServiceException, SdkClientException, CodePipelineException Gets a summary of all CodePipeline action types associated with your account.
- Parameters:
listActionTypesRequest
- Represents the input of aListActionTypes
action.- Returns:
- Result of the ListActionTypes operation returned by the service.
- See Also:
-
listActionTypes
default 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 viaListActionTypesRequest.builder()
- Parameters:
listActionTypesRequest
- AConsumer
that will call methods onListActionTypesRequest.Builder
to create a request. Represents the input of aListActionTypes
action.- Returns:
- Result of the ListActionTypes operation returned by the service.
- See Also:
-
listActionTypes
default ListActionTypesResponse listActionTypes() throws ValidationException, InvalidNextTokenException, AwsServiceException, SdkClientException, CodePipelineExceptionGets a summary of all CodePipeline action types associated with your account.
- Returns:
- Result of the ListActionTypes operation returned by the service.
- See Also:
-
listActionTypesPaginator
default ListActionTypesIterable listActionTypesPaginator() throws ValidationException, InvalidNextTokenException, AwsServiceException, SdkClientException, CodePipelineExceptionThis 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 Streamsoftware.amazon.awssdk.services.codepipeline.paginators.ListActionTypesIterable responses = client.listActionTypesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listActionTypesPaginator
default ListActionTypesIterable listActionTypesPaginator(ListActionTypesRequest listActionTypesRequest) throws ValidationException, InvalidNextTokenException, AwsServiceException, SdkClientException, CodePipelineException 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 Streamsoftware.amazon.awssdk.services.codepipeline.paginators.ListActionTypesIterable responses = client.listActionTypesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
listActionTypesRequest
- Represents the input of aListActionTypes
action.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listActionTypesPaginator
default ListActionTypesIterable listActionTypesPaginator(Consumer<ListActionTypesRequest.Builder> listActionTypesRequest) throws ValidationException, InvalidNextTokenException, AwsServiceException, SdkClientException, CodePipelineException 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 Streamsoftware.amazon.awssdk.services.codepipeline.paginators.ListActionTypesIterable responses = client.listActionTypesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListActionTypesRequest.builder()
- Parameters:
listActionTypesRequest
- AConsumer
that will call methods onListActionTypesRequest.Builder
to create a request. Represents the input of aListActionTypes
action.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listPipelineExecutions
default ListPipelineExecutionsResponse listPipelineExecutions(ListPipelineExecutionsRequest listPipelineExecutionsRequest) throws ValidationException, PipelineNotFoundException, InvalidNextTokenException, AwsServiceException, SdkClientException, CodePipelineException Gets a summary of the most recent executions for a pipeline.
- Parameters:
listPipelineExecutionsRequest
- Represents the input of aListPipelineExecutions
action.- Returns:
- Result of the ListPipelineExecutions operation returned by the service.
- See Also:
-
listPipelineExecutions
default 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 viaListPipelineExecutionsRequest.builder()
- Parameters:
listPipelineExecutionsRequest
- AConsumer
that will call methods onListPipelineExecutionsRequest.Builder
to create a request. Represents the input of aListPipelineExecutions
action.- Returns:
- Result of the ListPipelineExecutions operation returned by the service.
- See Also:
-
listPipelineExecutionsPaginator
default ListPipelineExecutionsIterable listPipelineExecutionsPaginator(ListPipelineExecutionsRequest listPipelineExecutionsRequest) throws ValidationException, PipelineNotFoundException, InvalidNextTokenException, AwsServiceException, SdkClientException, CodePipelineException 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 Streamsoftware.amazon.awssdk.services.codepipeline.paginators.ListPipelineExecutionsIterable responses = client.listPipelineExecutionsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
listPipelineExecutionsRequest
- Represents the input of aListPipelineExecutions
action.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listPipelineExecutionsPaginator
default ListPipelineExecutionsIterable listPipelineExecutionsPaginator(Consumer<ListPipelineExecutionsRequest.Builder> listPipelineExecutionsRequest) throws ValidationException, PipelineNotFoundException, InvalidNextTokenException, AwsServiceException, SdkClientException, CodePipelineException 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 Streamsoftware.amazon.awssdk.services.codepipeline.paginators.ListPipelineExecutionsIterable responses = client.listPipelineExecutionsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListPipelineExecutionsRequest.builder()
- Parameters:
listPipelineExecutionsRequest
- AConsumer
that will call methods onListPipelineExecutionsRequest.Builder
to create a request. Represents the input of aListPipelineExecutions
action.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listPipelines
default ListPipelinesResponse listPipelines(ListPipelinesRequest listPipelinesRequest) throws ValidationException, InvalidNextTokenException, AwsServiceException, SdkClientException, CodePipelineException Gets a summary of all of the pipelines associated with your account.
- Parameters:
listPipelinesRequest
- Represents the input of aListPipelines
action.- Returns:
- Result of the ListPipelines operation returned by the service.
- See Also:
-
listPipelines
default 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 viaListPipelinesRequest.builder()
- Parameters:
listPipelinesRequest
- AConsumer
that will call methods onListPipelinesRequest.Builder
to create a request. Represents the input of aListPipelines
action.- Returns:
- Result of the ListPipelines operation returned by the service.
- See Also:
-
listPipelines
default ListPipelinesResponse listPipelines() throws ValidationException, InvalidNextTokenException, AwsServiceException, SdkClientException, CodePipelineExceptionGets a summary of all of the pipelines associated with your account.
- Returns:
- Result of the ListPipelines operation returned by the service.
- See Also:
-
listPipelinesPaginator
default ListPipelinesIterable listPipelinesPaginator() throws ValidationException, InvalidNextTokenException, AwsServiceException, SdkClientException, CodePipelineExceptionThis 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 Streamsoftware.amazon.awssdk.services.codepipeline.paginators.ListPipelinesIterable responses = client.listPipelinesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listPipelinesPaginator
default ListPipelinesIterable listPipelinesPaginator(ListPipelinesRequest listPipelinesRequest) throws ValidationException, InvalidNextTokenException, AwsServiceException, SdkClientException, CodePipelineException 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 Streamsoftware.amazon.awssdk.services.codepipeline.paginators.ListPipelinesIterable responses = client.listPipelinesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
listPipelinesRequest
- Represents the input of aListPipelines
action.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listPipelinesPaginator
default ListPipelinesIterable listPipelinesPaginator(Consumer<ListPipelinesRequest.Builder> listPipelinesRequest) throws ValidationException, InvalidNextTokenException, AwsServiceException, SdkClientException, CodePipelineException 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 Streamsoftware.amazon.awssdk.services.codepipeline.paginators.ListPipelinesIterable responses = client.listPipelinesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListPipelinesRequest.builder()
- Parameters:
listPipelinesRequest
- AConsumer
that will call methods onListPipelinesRequest.Builder
to create a request. Represents the input of aListPipelines
action.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTagsForResource
default 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.
- Parameters:
listTagsForResourceRequest
-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listTagsForResource
default 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 viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listTagsForResourcePaginator
default ListTagsForResourceIterable listTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest) throws ValidationException, ResourceNotFoundException, InvalidNextTokenException, InvalidArnException, AwsServiceException, SdkClientException, CodePipelineException 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 Streamsoftware.amazon.awssdk.services.codepipeline.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
listTagsForResourceRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTagsForResourcePaginator
default ListTagsForResourceIterable listTagsForResourcePaginator(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws ValidationException, ResourceNotFoundException, InvalidNextTokenException, InvalidArnException, AwsServiceException, SdkClientException, CodePipelineException 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 Streamsoftware.amazon.awssdk.services.codepipeline.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listWebhooks
default 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.
- Parameters:
listWebhooksRequest
-- Returns:
- Result of the ListWebhooks operation returned by the service.
- See Also:
-
listWebhooks
default 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 viaListWebhooksRequest.builder()
- Parameters:
listWebhooksRequest
- AConsumer
that will call methods onListWebhooksRequest.Builder
to create a request.- Returns:
- Result of the ListWebhooks operation returned by the service.
- See Also:
-
listWebhooks
default ListWebhooksResponse listWebhooks() throws ValidationException, InvalidNextTokenException, AwsServiceException, SdkClientException, CodePipelineExceptionGets 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.
- Returns:
- Result of the ListWebhooks operation returned by the service.
- See Also:
-
listWebhooksPaginator
default ListWebhooksIterable listWebhooksPaginator() throws ValidationException, InvalidNextTokenException, AwsServiceException, SdkClientException, CodePipelineExceptionThis 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 Streamsoftware.amazon.awssdk.services.codepipeline.paginators.ListWebhooksIterable responses = client.listWebhooksPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listWebhooksPaginator
default ListWebhooksIterable listWebhooksPaginator(ListWebhooksRequest listWebhooksRequest) throws ValidationException, InvalidNextTokenException, AwsServiceException, SdkClientException, CodePipelineException 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 Streamsoftware.amazon.awssdk.services.codepipeline.paginators.ListWebhooksIterable responses = client.listWebhooksPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
listWebhooksRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listWebhooksPaginator
default ListWebhooksIterable listWebhooksPaginator(Consumer<ListWebhooksRequest.Builder> listWebhooksRequest) throws ValidationException, InvalidNextTokenException, AwsServiceException, SdkClientException, CodePipelineException 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 Streamsoftware.amazon.awssdk.services.codepipeline.paginators.ListWebhooksIterable responses = client.listWebhooksPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListWebhooksRequest.builder()
- Parameters:
listWebhooksRequest
- AConsumer
that will call methods onListWebhooksRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
pollForJobs
default 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 containsAWS
orThirdParty
in the owner field, thePollForJobs
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.
- Parameters:
pollForJobsRequest
- Represents the input of aPollForJobs
action.- Returns:
- Result of the PollForJobs operation returned by the service.
- See Also:
-
pollForJobs
default 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 containsAWS
orThirdParty
in the owner field, thePollForJobs
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 viaPollForJobsRequest.builder()
- Parameters:
pollForJobsRequest
- AConsumer
that will call methods onPollForJobsRequest.Builder
to create a request. Represents the input of aPollForJobs
action.- Returns:
- Result of the PollForJobs operation returned by the service.
- See Also:
-
pollForThirdPartyJobs
default 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.
- Parameters:
pollForThirdPartyJobsRequest
- Represents the input of aPollForThirdPartyJobs
action.- Returns:
- Result of the PollForThirdPartyJobs operation returned by the service.
- See Also:
-
pollForThirdPartyJobs
default 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 viaPollForThirdPartyJobsRequest.builder()
- Parameters:
pollForThirdPartyJobsRequest
- AConsumer
that will call methods onPollForThirdPartyJobsRequest.Builder
to create a request. Represents the input of aPollForThirdPartyJobs
action.- Returns:
- Result of the PollForThirdPartyJobs operation returned by the service.
- See Also:
-
putActionRevision
default PutActionRevisionResponse putActionRevision(PutActionRevisionRequest putActionRevisionRequest) throws PipelineNotFoundException, StageNotFoundException, ActionNotFoundException, ValidationException, AwsServiceException, SdkClientException, CodePipelineException Provides information to CodePipeline about new revisions to a source.
- Parameters:
putActionRevisionRequest
- Represents the input of aPutActionRevision
action.- Returns:
- Result of the PutActionRevision operation returned by the service.
- See Also:
-
putActionRevision
default 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 viaPutActionRevisionRequest.builder()
- Parameters:
putActionRevisionRequest
- AConsumer
that will call methods onPutActionRevisionRequest.Builder
to create a request. Represents the input of aPutActionRevision
action.- Returns:
- Result of the PutActionRevision operation returned by the service.
- See Also:
-
putApprovalResult
default 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.
- Parameters:
putApprovalResultRequest
- Represents the input of aPutApprovalResult
action.- Returns:
- Result of the PutApprovalResult operation returned by the service.
- See Also:
-
putApprovalResult
default 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 viaPutApprovalResultRequest.builder()
- Parameters:
putApprovalResultRequest
- AConsumer
that will call methods onPutApprovalResultRequest.Builder
to create a request. Represents the input of aPutApprovalResult
action.- Returns:
- Result of the PutApprovalResult operation returned by the service.
- See Also:
-
putJobFailureResult
default 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.
- Parameters:
putJobFailureResultRequest
- Represents the input of aPutJobFailureResult
action.- Returns:
- Result of the PutJobFailureResult operation returned by the service.
- See Also:
-
putJobFailureResult
default 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 viaPutJobFailureResultRequest.builder()
- Parameters:
putJobFailureResultRequest
- AConsumer
that will call methods onPutJobFailureResultRequest.Builder
to create a request. Represents the input of aPutJobFailureResult
action.- Returns:
- Result of the PutJobFailureResult operation returned by the service.
- See Also:
-
putJobSuccessResult
default 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.
- Parameters:
putJobSuccessResultRequest
- Represents the input of aPutJobSuccessResult
action.- Returns:
- Result of the PutJobSuccessResult operation returned by the service.
- See Also:
-
putJobSuccessResult
default 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 viaPutJobSuccessResultRequest.builder()
- Parameters:
putJobSuccessResultRequest
- AConsumer
that will call methods onPutJobSuccessResultRequest.Builder
to create a request. Represents the input of aPutJobSuccessResult
action.- Returns:
- Result of the PutJobSuccessResult operation returned by the service.
- See Also:
-
putThirdPartyJobFailureResult
default 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.
- Parameters:
putThirdPartyJobFailureResultRequest
- Represents the input of aPutThirdPartyJobFailureResult
action.- Returns:
- Result of the PutThirdPartyJobFailureResult operation returned by the service.
- See Also:
-
putThirdPartyJobFailureResult
default 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 viaPutThirdPartyJobFailureResultRequest.builder()
- Parameters:
putThirdPartyJobFailureResultRequest
- AConsumer
that will call methods onPutThirdPartyJobFailureResultRequest.Builder
to create a request. Represents the input of aPutThirdPartyJobFailureResult
action.- Returns:
- Result of the PutThirdPartyJobFailureResult operation returned by the service.
- See Also:
-
putThirdPartyJobSuccessResult
default 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.
- Parameters:
putThirdPartyJobSuccessResultRequest
- Represents the input of aPutThirdPartyJobSuccessResult
action.- Returns:
- Result of the PutThirdPartyJobSuccessResult operation returned by the service.
- See Also:
-
putThirdPartyJobSuccessResult
default 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 viaPutThirdPartyJobSuccessResultRequest.builder()
- Parameters:
putThirdPartyJobSuccessResultRequest
- AConsumer
that will call methods onPutThirdPartyJobSuccessResultRequest.Builder
to create a request. Represents the input of aPutThirdPartyJobSuccessResult
action.- Returns:
- Result of the PutThirdPartyJobSuccessResult operation returned by the service.
- See Also:
-
putWebhook
default 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.
- Parameters:
putWebhookRequest
-- Returns:
- Result of the PutWebhook operation returned by the service.
- See Also:
-
putWebhook
default 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 viaPutWebhookRequest.builder()
- Parameters:
putWebhookRequest
- AConsumer
that will call methods onPutWebhookRequest.Builder
to create a request.- Returns:
- Result of the PutWebhook operation returned by the service.
- See Also:
-
registerWebhookWithThirdParty
default 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.
- Parameters:
registerWebhookWithThirdPartyRequest
-- Returns:
- Result of the RegisterWebhookWithThirdParty operation returned by the service.
- See Also:
-
registerWebhookWithThirdParty
default 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 viaRegisterWebhookWithThirdPartyRequest.builder()
- Parameters:
registerWebhookWithThirdPartyRequest
- AConsumer
that will call methods onRegisterWebhookWithThirdPartyRequest.Builder
to create a request.- Returns:
- Result of the RegisterWebhookWithThirdParty operation returned by the service.
- See Also:
-
retryStageExecution
default 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.
- Parameters:
retryStageExecutionRequest
- Represents the input of aRetryStageExecution
action.- Returns:
- Result of the RetryStageExecution operation returned by the service.
- See Also:
-
retryStageExecution
default 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 viaRetryStageExecutionRequest.builder()
- Parameters:
retryStageExecutionRequest
- AConsumer
that will call methods onRetryStageExecutionRequest.Builder
to create a request. Represents the input of aRetryStageExecution
action.- Returns:
- Result of the RetryStageExecution operation returned by the service.
- See Also:
-
rollbackStage
default RollbackStageResponse rollbackStage(RollbackStageRequest rollbackStageRequest) throws ValidationException, ConflictException, PipelineNotFoundException, PipelineExecutionNotFoundException, PipelineExecutionOutdatedException, StageNotFoundException, UnableToRollbackStageException, AwsServiceException, SdkClientException, CodePipelineException Rolls back a stage execution.
- Parameters:
rollbackStageRequest
-- Returns:
- Result of the RollbackStage operation returned by the service.
- See Also:
-
rollbackStage
default RollbackStageResponse rollbackStage(Consumer<RollbackStageRequest.Builder> rollbackStageRequest) throws ValidationException, ConflictException, PipelineNotFoundException, PipelineExecutionNotFoundException, PipelineExecutionOutdatedException, StageNotFoundException, UnableToRollbackStageException, AwsServiceException, SdkClientException, CodePipelineException Rolls back a stage execution.
This is a convenience which creates an instance of the
RollbackStageRequest.Builder
avoiding the need to create one manually viaRollbackStageRequest.builder()
- Parameters:
rollbackStageRequest
- AConsumer
that will call methods onRollbackStageRequest.Builder
to create a request.- Returns:
- Result of the RollbackStage operation returned by the service.
- See Also:
-
startPipelineExecution
default StartPipelineExecutionResponse startPipelineExecution(StartPipelineExecutionRequest startPipelineExecutionRequest) throws ValidationException, ConflictException, PipelineNotFoundException, ConcurrentPipelineExecutionsLimitExceededException, AwsServiceException, SdkClientException, CodePipelineException Starts the specified pipeline. Specifically, it begins processing the latest commit to the source location specified as part of the pipeline.
- Parameters:
startPipelineExecutionRequest
- Represents the input of aStartPipelineExecution
action.- Returns:
- Result of the StartPipelineExecution operation returned by the service.
- See Also:
-
startPipelineExecution
default StartPipelineExecutionResponse startPipelineExecution(Consumer<StartPipelineExecutionRequest.Builder> startPipelineExecutionRequest) throws ValidationException, ConflictException, PipelineNotFoundException, ConcurrentPipelineExecutionsLimitExceededException, 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 viaStartPipelineExecutionRequest.builder()
- Parameters:
startPipelineExecutionRequest
- AConsumer
that will call methods onStartPipelineExecutionRequest.Builder
to create a request. Represents the input of aStartPipelineExecution
action.- Returns:
- Result of the StartPipelineExecution operation returned by the service.
- See Also:
-
stopPipelineExecution
default 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 aStopped
state.- Parameters:
stopPipelineExecutionRequest
-- Returns:
- Result of the StopPipelineExecution operation returned by the service.
- See Also:
-
stopPipelineExecution
default 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 aStopped
state.
This is a convenience which creates an instance of the
StopPipelineExecutionRequest.Builder
avoiding the need to create one manually viaStopPipelineExecutionRequest.builder()
- Parameters:
stopPipelineExecutionRequest
- AConsumer
that will call methods onStopPipelineExecutionRequest.Builder
to create a request.- Returns:
- Result of the StopPipelineExecution operation returned by the service.
- See Also:
-
tagResource
default 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.
- Parameters:
tagResourceRequest
-- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
tagResource
default 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 viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ValidationException, ResourceNotFoundException, InvalidArnException, InvalidTagsException, ConcurrentModificationException, AwsServiceException, SdkClientException, CodePipelineException Removes tags from an Amazon Web Services resource.
- Parameters:
untagResourceRequest
-- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
untagResource
default 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 viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
updateActionType
default 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.- Parameters:
updateActionTypeRequest
-- Returns:
- Result of the UpdateActionType operation returned by the service.
- See Also:
-
updateActionType
default 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 viaUpdateActionTypeRequest.builder()
- Parameters:
updateActionTypeRequest
- AConsumer
that will call methods onUpdateActionTypeRequest.Builder
to create a request.- Returns:
- Result of the UpdateActionType operation returned by the service.
- See Also:
-
updatePipeline
default 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.- Parameters:
updatePipelineRequest
- Represents the input of anUpdatePipeline
action.- Returns:
- Result of the UpdatePipeline operation returned by the service.
- See Also:
-
updatePipeline
default 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 viaUpdatePipelineRequest.builder()
- Parameters:
updatePipelineRequest
- AConsumer
that will call methods onUpdatePipelineRequest.Builder
to create a request. Represents the input of anUpdatePipeline
action.- Returns:
- Result of the UpdatePipeline operation returned by the service.
- See Also:
-
create
Create aCodePipelineClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aCodePipelineClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-