@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface CodePipelineAsyncClient extends AwsClient
builder()
method.
Overview
This is the CodePipeline API Reference. This guide provides descriptions of the actions and data types for CodePipeline. Some functionality for your pipeline can only be configured through the API. For more information, see the CodePipeline User Guide.
You can use the CodePipeline API to work with pipelines, stages, actions, and transitions.
Pipelines are models of automated release processes. Each pipeline is uniquely named, and consists of stages, actions, and transitions.
You can work with pipelines by calling:
CreatePipeline, which creates a uniquely named pipeline.
DeletePipeline, which deletes the specified pipeline.
GetPipeline, which returns information about the pipeline structure and pipeline metadata, including the pipeline Amazon Resource Name (ARN).
GetPipelineExecution, which returns information about a specific execution of a pipeline.
GetPipelineState, which returns information about the current state of the stages and actions of a pipeline.
ListActionExecutions, which returns action-level details for past executions. The details include full stage and action-level details, including individual action duration, status, any errors that occurred during the execution, and input and output artifact location details.
ListPipelines, which gets a summary of all of the pipelines associated with your account.
ListPipelineExecutions, which gets a summary of the most recent executions for a pipeline.
StartPipelineExecution, which runs the most recent revision of an artifact through the pipeline.
StopPipelineExecution, which stops the specified pipeline execution from continuing through the pipeline.
UpdatePipeline, which updates a pipeline with edits or changes to the structure of the pipeline.
Pipelines include stages. Each stage contains one or more actions that must complete before the next stage begins. A stage results in success or failure. If a stage fails, the pipeline stops at that stage and remains stopped until either a new version of an artifact appears in the source location, or a user takes action to rerun the most recent artifact through the pipeline. You can call GetPipelineState, which displays the status of a pipeline, including the status of stages in the pipeline, or GetPipeline, which returns the entire structure of the pipeline, including the stages of that pipeline. For more information about the structure of stages and actions, see CodePipeline Pipeline Structure Reference.
Pipeline stages include actions that are categorized into categories such as source or build actions performed in a stage of a pipeline. For example, you can use a source action to import artifacts into a pipeline from a source such as Amazon S3. Like stages, you do not work with actions directly in most cases, but you do define and interact with actions when working with pipeline operations such as CreatePipeline and GetPipelineState. Valid action categories are:
Source
Build
Test
Deploy
Approval
Invoke
Pipelines also include transitions, which allow the transition of artifacts from one stage to the next in a pipeline after the actions in one stage complete.
You can work with transitions by calling:
DisableStageTransition, which prevents artifacts from transitioning to the next stage in a pipeline.
EnableStageTransition, which enables transition of artifacts between stages in a pipeline.
Using the API to integrate with CodePipeline
For third-party integrators or developers who want to create their own integrations with CodePipeline, the expected sequence varies from the standard API user. To integrate with CodePipeline, developers need to work with the following items:
Jobs, which are instances of an action. For example, a job for a source action might import a revision of an artifact from a source.
You can work with jobs by calling:
AcknowledgeJob, which confirms whether a job worker has received the specified job.
GetJobDetails, which returns the details of a job.
PollForJobs, which determines whether there are any jobs to act on.
PutJobFailureResult, which provides details of a job failure.
PutJobSuccessResult, which provides details of a job success.
Third party jobs, which are instances of an action created by a partner action and integrated into CodePipeline. Partner actions are created by members of the Amazon Web Services Partner Network.
You can work with third party jobs by calling:
AcknowledgeThirdPartyJob, which confirms whether a job worker has received the specified job.
GetThirdPartyJobDetails, which requests the details of a job for a partner action.
PollForThirdPartyJobs, which determines whether there are any jobs to act on.
PutThirdPartyJobFailureResult, which provides details of a job failure.
PutThirdPartyJobSuccessResult, which provides details of a job success.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
default CompletableFuture<AcknowledgeJobResponse> |
acknowledgeJob(AcknowledgeJobRequest acknowledgeJobRequest)
Returns information about a specified job and whether that job has been received by the job worker.
|
default CompletableFuture<AcknowledgeJobResponse> |
acknowledgeJob(Consumer<AcknowledgeJobRequest.Builder> acknowledgeJobRequest)
Returns information about a specified job and whether that job has been received by the job worker.
|
default CompletableFuture<AcknowledgeThirdPartyJobResponse> |
acknowledgeThirdPartyJob(AcknowledgeThirdPartyJobRequest acknowledgeThirdPartyJobRequest)
Confirms a job worker has received the specified job.
|
default CompletableFuture<AcknowledgeThirdPartyJobResponse> |
acknowledgeThirdPartyJob(Consumer<AcknowledgeThirdPartyJobRequest.Builder> acknowledgeThirdPartyJobRequest)
Confirms a job worker has received the specified job.
|
static CodePipelineAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
CodePipelineAsyncClient. |
static CodePipelineAsyncClient |
create()
Create a
CodePipelineAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CompletableFuture<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 CompletableFuture<CreateCustomActionTypeResponse> |
createCustomActionType(CreateCustomActionTypeRequest createCustomActionTypeRequest)
Creates a new custom action that can be used in all pipelines associated with the Amazon Web Services account.
|
default CompletableFuture<CreatePipelineResponse> |
createPipeline(Consumer<CreatePipelineRequest.Builder> createPipelineRequest)
Creates a pipeline.
|
default CompletableFuture<CreatePipelineResponse> |
createPipeline(CreatePipelineRequest createPipelineRequest)
Creates a pipeline.
|
default CompletableFuture<DeleteCustomActionTypeResponse> |
deleteCustomActionType(Consumer<DeleteCustomActionTypeRequest.Builder> deleteCustomActionTypeRequest)
Marks a custom action as deleted.
|
default CompletableFuture<DeleteCustomActionTypeResponse> |
deleteCustomActionType(DeleteCustomActionTypeRequest deleteCustomActionTypeRequest)
Marks a custom action as deleted.
|
default CompletableFuture<DeletePipelineResponse> |
deletePipeline(Consumer<DeletePipelineRequest.Builder> deletePipelineRequest)
Deletes the specified pipeline.
|
default CompletableFuture<DeletePipelineResponse> |
deletePipeline(DeletePipelineRequest deletePipelineRequest)
Deletes the specified pipeline.
|
default CompletableFuture<DeleteWebhookResponse> |
deleteWebhook(Consumer<DeleteWebhookRequest.Builder> deleteWebhookRequest)
Deletes a previously created webhook by name.
|
default CompletableFuture<DeleteWebhookResponse> |
deleteWebhook(DeleteWebhookRequest deleteWebhookRequest)
Deletes a previously created webhook by name.
|
default CompletableFuture<DeregisterWebhookWithThirdPartyResponse> |
deregisterWebhookWithThirdParty(Consumer<DeregisterWebhookWithThirdPartyRequest.Builder> deregisterWebhookWithThirdPartyRequest)
Removes the connection between the webhook that was created by CodePipeline and the external tool with events to
be detected.
|
default CompletableFuture<DeregisterWebhookWithThirdPartyResponse> |
deregisterWebhookWithThirdParty(DeregisterWebhookWithThirdPartyRequest deregisterWebhookWithThirdPartyRequest)
Removes the connection between the webhook that was created by CodePipeline and the external tool with events to
be detected.
|
default CompletableFuture<DisableStageTransitionResponse> |
disableStageTransition(Consumer<DisableStageTransitionRequest.Builder> disableStageTransitionRequest)
Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline.
|
default CompletableFuture<DisableStageTransitionResponse> |
disableStageTransition(DisableStageTransitionRequest disableStageTransitionRequest)
Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline.
|
default CompletableFuture<EnableStageTransitionResponse> |
enableStageTransition(Consumer<EnableStageTransitionRequest.Builder> enableStageTransitionRequest)
Enables artifacts in a pipeline to transition to a stage in a pipeline.
|
default CompletableFuture<EnableStageTransitionResponse> |
enableStageTransition(EnableStageTransitionRequest enableStageTransitionRequest)
Enables artifacts in a pipeline to transition to a stage in a pipeline.
|
default CompletableFuture<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 CompletableFuture<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 CompletableFuture<GetJobDetailsResponse> |
getJobDetails(Consumer<GetJobDetailsRequest.Builder> getJobDetailsRequest)
Returns information about a job.
|
default CompletableFuture<GetJobDetailsResponse> |
getJobDetails(GetJobDetailsRequest getJobDetailsRequest)
Returns information about a job.
|
default CompletableFuture<GetPipelineResponse> |
getPipeline(Consumer<GetPipelineRequest.Builder> getPipelineRequest)
Returns the metadata, structure, stages, and actions of a pipeline.
|
default CompletableFuture<GetPipelineResponse> |
getPipeline(GetPipelineRequest getPipelineRequest)
Returns the metadata, structure, stages, and actions of a pipeline.
|
default CompletableFuture<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 CompletableFuture<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 CompletableFuture<GetPipelineStateResponse> |
getPipelineState(Consumer<GetPipelineStateRequest.Builder> getPipelineStateRequest)
Returns information about the state of a pipeline, including the stages and actions.
|
default CompletableFuture<GetPipelineStateResponse> |
getPipelineState(GetPipelineStateRequest getPipelineStateRequest)
Returns information about the state of a pipeline, including the stages and actions.
|
default CompletableFuture<GetThirdPartyJobDetailsResponse> |
getThirdPartyJobDetails(Consumer<GetThirdPartyJobDetailsRequest.Builder> getThirdPartyJobDetailsRequest)
Requests the details of a job for a third party action.
|
default CompletableFuture<GetThirdPartyJobDetailsResponse> |
getThirdPartyJobDetails(GetThirdPartyJobDetailsRequest getThirdPartyJobDetailsRequest)
Requests the details of a job for a third party action.
|
default CompletableFuture<ListActionExecutionsResponse> |
listActionExecutions(Consumer<ListActionExecutionsRequest.Builder> listActionExecutionsRequest)
Lists the action executions that have occurred in a pipeline.
|
default CompletableFuture<ListActionExecutionsResponse> |
listActionExecutions(ListActionExecutionsRequest listActionExecutionsRequest)
Lists the action executions that have occurred in a pipeline.
|
default ListActionExecutionsPublisher |
listActionExecutionsPaginator(Consumer<ListActionExecutionsRequest.Builder> listActionExecutionsRequest)
Lists the action executions that have occurred in a pipeline.
|
default ListActionExecutionsPublisher |
listActionExecutionsPaginator(ListActionExecutionsRequest listActionExecutionsRequest)
Lists the action executions that have occurred in a pipeline.
|
default CompletableFuture<ListActionTypesResponse> |
listActionTypes()
Gets a summary of all CodePipeline action types associated with your account.
|
default CompletableFuture<ListActionTypesResponse> |
listActionTypes(Consumer<ListActionTypesRequest.Builder> listActionTypesRequest)
Gets a summary of all CodePipeline action types associated with your account.
|
default CompletableFuture<ListActionTypesResponse> |
listActionTypes(ListActionTypesRequest listActionTypesRequest)
Gets a summary of all CodePipeline action types associated with your account.
|
default ListActionTypesPublisher |
listActionTypesPaginator()
Gets a summary of all CodePipeline action types associated with your account.
|
default ListActionTypesPublisher |
listActionTypesPaginator(Consumer<ListActionTypesRequest.Builder> listActionTypesRequest)
Gets a summary of all CodePipeline action types associated with your account.
|
default ListActionTypesPublisher |
listActionTypesPaginator(ListActionTypesRequest listActionTypesRequest)
Gets a summary of all CodePipeline action types associated with your account.
|
default CompletableFuture<ListPipelineExecutionsResponse> |
listPipelineExecutions(Consumer<ListPipelineExecutionsRequest.Builder> listPipelineExecutionsRequest)
Gets a summary of the most recent executions for a pipeline.
|
default CompletableFuture<ListPipelineExecutionsResponse> |
listPipelineExecutions(ListPipelineExecutionsRequest listPipelineExecutionsRequest)
Gets a summary of the most recent executions for a pipeline.
|
default ListPipelineExecutionsPublisher |
listPipelineExecutionsPaginator(Consumer<ListPipelineExecutionsRequest.Builder> listPipelineExecutionsRequest)
Gets a summary of the most recent executions for a pipeline.
|
default ListPipelineExecutionsPublisher |
listPipelineExecutionsPaginator(ListPipelineExecutionsRequest listPipelineExecutionsRequest)
Gets a summary of the most recent executions for a pipeline.
|
default CompletableFuture<ListPipelinesResponse> |
listPipelines()
Gets a summary of all of the pipelines associated with your account.
|
default CompletableFuture<ListPipelinesResponse> |
listPipelines(Consumer<ListPipelinesRequest.Builder> listPipelinesRequest)
Gets a summary of all of the pipelines associated with your account.
|
default CompletableFuture<ListPipelinesResponse> |
listPipelines(ListPipelinesRequest listPipelinesRequest)
Gets a summary of all of the pipelines associated with your account.
|
default ListPipelinesPublisher |
listPipelinesPaginator()
Gets a summary of all of the pipelines associated with your account.
|
default ListPipelinesPublisher |
listPipelinesPaginator(Consumer<ListPipelinesRequest.Builder> listPipelinesRequest)
Gets a summary of all of the pipelines associated with your account.
|
default ListPipelinesPublisher |
listPipelinesPaginator(ListPipelinesRequest listPipelinesRequest)
Gets a summary of all of the pipelines associated with your account.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Gets the set of key-value pairs (metadata) that are used to manage the resource.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Gets the set of key-value pairs (metadata) that are used to manage the resource.
|
default ListTagsForResourcePublisher |
listTagsForResourcePaginator(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Gets the set of key-value pairs (metadata) that are used to manage the resource.
|
default ListTagsForResourcePublisher |
listTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest)
Gets the set of key-value pairs (metadata) that are used to manage the resource.
|
default CompletableFuture<ListWebhooksResponse> |
listWebhooks()
Gets a listing of all the webhooks in this Amazon Web Services Region for this account.
|
default CompletableFuture<ListWebhooksResponse> |
listWebhooks(Consumer<ListWebhooksRequest.Builder> listWebhooksRequest)
Gets a listing of all the webhooks in this Amazon Web Services Region for this account.
|
default CompletableFuture<ListWebhooksResponse> |
listWebhooks(ListWebhooksRequest listWebhooksRequest)
Gets a listing of all the webhooks in this Amazon Web Services Region for this account.
|
default ListWebhooksPublisher |
listWebhooksPaginator()
Gets a listing of all the webhooks in this Amazon Web Services Region for this account.
|
default ListWebhooksPublisher |
listWebhooksPaginator(Consumer<ListWebhooksRequest.Builder> listWebhooksRequest)
Gets a listing of all the webhooks in this Amazon Web Services Region for this account.
|
default ListWebhooksPublisher |
listWebhooksPaginator(ListWebhooksRequest listWebhooksRequest)
Gets a listing of all the webhooks in this Amazon Web Services Region for this account.
|
default CompletableFuture<PollForJobsResponse> |
pollForJobs(Consumer<PollForJobsRequest.Builder> pollForJobsRequest)
Returns information about any jobs for CodePipeline to act on.
|
default CompletableFuture<PollForJobsResponse> |
pollForJobs(PollForJobsRequest pollForJobsRequest)
Returns information about any jobs for CodePipeline to act on.
|
default CompletableFuture<PollForThirdPartyJobsResponse> |
pollForThirdPartyJobs(Consumer<PollForThirdPartyJobsRequest.Builder> pollForThirdPartyJobsRequest)
Determines whether there are any third party jobs for a job worker to act on.
|
default CompletableFuture<PollForThirdPartyJobsResponse> |
pollForThirdPartyJobs(PollForThirdPartyJobsRequest pollForThirdPartyJobsRequest)
Determines whether there are any third party jobs for a job worker to act on.
|
default CompletableFuture<PutActionRevisionResponse> |
putActionRevision(Consumer<PutActionRevisionRequest.Builder> putActionRevisionRequest)
Provides information to CodePipeline about new revisions to a source.
|
default CompletableFuture<PutActionRevisionResponse> |
putActionRevision(PutActionRevisionRequest putActionRevisionRequest)
Provides information to CodePipeline about new revisions to a source.
|
default CompletableFuture<PutApprovalResultResponse> |
putApprovalResult(Consumer<PutApprovalResultRequest.Builder> putApprovalResultRequest)
Provides the response to a manual approval request to CodePipeline.
|
default CompletableFuture<PutApprovalResultResponse> |
putApprovalResult(PutApprovalResultRequest putApprovalResultRequest)
Provides the response to a manual approval request to CodePipeline.
|
default CompletableFuture<PutJobFailureResultResponse> |
putJobFailureResult(Consumer<PutJobFailureResultRequest.Builder> putJobFailureResultRequest)
Represents the failure of a job as returned to the pipeline by a job worker.
|
default CompletableFuture<PutJobFailureResultResponse> |
putJobFailureResult(PutJobFailureResultRequest putJobFailureResultRequest)
Represents the failure of a job as returned to the pipeline by a job worker.
|
default CompletableFuture<PutJobSuccessResultResponse> |
putJobSuccessResult(Consumer<PutJobSuccessResultRequest.Builder> putJobSuccessResultRequest)
Represents the success of a job as returned to the pipeline by a job worker.
|
default CompletableFuture<PutJobSuccessResultResponse> |
putJobSuccessResult(PutJobSuccessResultRequest putJobSuccessResultRequest)
Represents the success of a job as returned to the pipeline by a job worker.
|
default CompletableFuture<PutThirdPartyJobFailureResultResponse> |
putThirdPartyJobFailureResult(Consumer<PutThirdPartyJobFailureResultRequest.Builder> putThirdPartyJobFailureResultRequest)
Represents the failure of a third party job as returned to the pipeline by a job worker.
|
default CompletableFuture<PutThirdPartyJobFailureResultResponse> |
putThirdPartyJobFailureResult(PutThirdPartyJobFailureResultRequest putThirdPartyJobFailureResultRequest)
Represents the failure of a third party job as returned to the pipeline by a job worker.
|
default CompletableFuture<PutThirdPartyJobSuccessResultResponse> |
putThirdPartyJobSuccessResult(Consumer<PutThirdPartyJobSuccessResultRequest.Builder> putThirdPartyJobSuccessResultRequest)
Represents the success of a third party job as returned to the pipeline by a job worker.
|
default CompletableFuture<PutThirdPartyJobSuccessResultResponse> |
putThirdPartyJobSuccessResult(PutThirdPartyJobSuccessResultRequest putThirdPartyJobSuccessResultRequest)
Represents the success of a third party job as returned to the pipeline by a job worker.
|
default CompletableFuture<PutWebhookResponse> |
putWebhook(Consumer<PutWebhookRequest.Builder> putWebhookRequest)
Defines a webhook and returns a unique webhook URL generated by CodePipeline.
|
default CompletableFuture<PutWebhookResponse> |
putWebhook(PutWebhookRequest putWebhookRequest)
Defines a webhook and returns a unique webhook URL generated by CodePipeline.
|
default CompletableFuture<RegisterWebhookWithThirdPartyResponse> |
registerWebhookWithThirdParty(Consumer<RegisterWebhookWithThirdPartyRequest.Builder> registerWebhookWithThirdPartyRequest)
Configures a connection between the webhook that was created and the external tool with events to be detected.
|
default CompletableFuture<RegisterWebhookWithThirdPartyResponse> |
registerWebhookWithThirdParty(RegisterWebhookWithThirdPartyRequest registerWebhookWithThirdPartyRequest)
Configures a connection between the webhook that was created and the external tool with events to be detected.
|
default CompletableFuture<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 CompletableFuture<RetryStageExecutionResponse> |
retryStageExecution(RetryStageExecutionRequest retryStageExecutionRequest)
You can retry a stage that has failed without having to run a pipeline again from the beginning.
|
default CodePipelineServiceClientConfiguration |
serviceClientConfiguration() |
default CompletableFuture<StartPipelineExecutionResponse> |
startPipelineExecution(Consumer<StartPipelineExecutionRequest.Builder> startPipelineExecutionRequest)
Starts the specified pipeline.
|
default CompletableFuture<StartPipelineExecutionResponse> |
startPipelineExecution(StartPipelineExecutionRequest startPipelineExecutionRequest)
Starts the specified pipeline.
|
default CompletableFuture<StopPipelineExecutionResponse> |
stopPipelineExecution(Consumer<StopPipelineExecutionRequest.Builder> stopPipelineExecutionRequest)
Stops the specified pipeline execution.
|
default CompletableFuture<StopPipelineExecutionResponse> |
stopPipelineExecution(StopPipelineExecutionRequest stopPipelineExecutionRequest)
Stops the specified pipeline execution.
|
default CompletableFuture<TagResourceResponse> |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Adds to or modifies the tags of the given resource.
|
default CompletableFuture<TagResourceResponse> |
tagResource(TagResourceRequest tagResourceRequest)
Adds to or modifies the tags of the given resource.
|
default CompletableFuture<UntagResourceResponse> |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes tags from an Amazon Web Services resource.
|
default CompletableFuture<UntagResourceResponse> |
untagResource(UntagResourceRequest untagResourceRequest)
Removes tags from an Amazon Web Services resource.
|
default CompletableFuture<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 CompletableFuture<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 CompletableFuture<UpdatePipelineResponse> |
updatePipeline(Consumer<UpdatePipelineRequest.Builder> updatePipelineRequest)
Updates a specified pipeline with edits or changes to its structure.
|
default CompletableFuture<UpdatePipelineResponse> |
updatePipeline(UpdatePipelineRequest updatePipelineRequest)
Updates a specified pipeline with edits or changes to its structure.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.default CompletableFuture<AcknowledgeJobResponse> acknowledgeJob(AcknowledgeJobRequest acknowledgeJobRequest)
Returns information about a specified job and whether that job has been received by the job worker. Used for custom actions only.
acknowledgeJobRequest - Represents the input of an AcknowledgeJob action.default CompletableFuture<AcknowledgeJobResponse> acknowledgeJob(Consumer<AcknowledgeJobRequest.Builder> acknowledgeJobRequest)
Returns information about a specified job and whether that job has been received by the job worker. Used for custom actions only.
This is a convenience which creates an instance of the AcknowledgeJobRequest.Builder avoiding the need to
create one manually via AcknowledgeJobRequest.builder()
acknowledgeJobRequest - A Consumer that will call methods on
AcknowledgeJobRequest.Builder to create a
request. Represents the input of an AcknowledgeJob action.default CompletableFuture<AcknowledgeThirdPartyJobResponse> acknowledgeThirdPartyJob(AcknowledgeThirdPartyJobRequest acknowledgeThirdPartyJobRequest)
Confirms a job worker has received the specified job. Used for partner actions only.
acknowledgeThirdPartyJobRequest - Represents the input of an AcknowledgeThirdPartyJob action.default CompletableFuture<AcknowledgeThirdPartyJobResponse> acknowledgeThirdPartyJob(Consumer<AcknowledgeThirdPartyJobRequest.Builder> acknowledgeThirdPartyJobRequest)
Confirms a job worker has received the specified job. Used for partner actions only.
This is a convenience which creates an instance of the AcknowledgeThirdPartyJobRequest.Builder avoiding
the need to create one manually via AcknowledgeThirdPartyJobRequest.builder()
acknowledgeThirdPartyJobRequest - A Consumer that will call methods on
AcknowledgeThirdPartyJobRequest.Builder to
create a request. Represents the input of an AcknowledgeThirdPartyJob action.default CompletableFuture<CreateCustomActionTypeResponse> createCustomActionType(CreateCustomActionTypeRequest createCustomActionTypeRequest)
Creates a new custom action that can be used in all pipelines associated with the Amazon Web Services account. Only used for custom actions.
createCustomActionTypeRequest - Represents the input of a CreateCustomActionType operation.default CompletableFuture<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. Only used for custom actions.
This is a convenience which creates an instance of the CreateCustomActionTypeRequest.Builder avoiding the
need to create one manually via CreateCustomActionTypeRequest.builder()
createCustomActionTypeRequest - A Consumer that will call methods on
CreateCustomActionTypeRequest.Builder to create
a request. Represents the input of a CreateCustomActionType operation.default CompletableFuture<CreatePipelineResponse> createPipeline(CreatePipelineRequest createPipelineRequest)
Creates a pipeline.
In the pipeline structure, you must include either artifactStore or artifactStores in
your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use
artifactStores.
createPipelineRequest - Represents the input of a CreatePipeline action.default CompletableFuture<CreatePipelineResponse> createPipeline(Consumer<CreatePipelineRequest.Builder> createPipelineRequest)
Creates a pipeline.
In the pipeline structure, you must include either artifactStore or artifactStores in
your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use
artifactStores.
This is a convenience which creates an instance of the CreatePipelineRequest.Builder avoiding the need to
create one manually via CreatePipelineRequest.builder()
createPipelineRequest - A Consumer that will call methods on
CreatePipelineRequest.Builder to create a
request. Represents the input of a CreatePipeline action.default CompletableFuture<DeleteCustomActionTypeResponse> deleteCustomActionType(DeleteCustomActionTypeRequest deleteCustomActionTypeRequest)
Marks a custom action as deleted. PollForJobs for the custom action fails after the action is marked
for deletion. Used for custom actions only.
To re-create a custom action after it has been deleted you must use a string in the version field that has never been used before. This string can be an incremented version number, for example. To restore a deleted custom action, use a JSON file that is identical to the deleted action, including the original string in the version field.
deleteCustomActionTypeRequest - Represents the input of a DeleteCustomActionType operation. The custom action will be marked
as deleted.default CompletableFuture<DeleteCustomActionTypeResponse> deleteCustomActionType(Consumer<DeleteCustomActionTypeRequest.Builder> deleteCustomActionTypeRequest)
Marks a custom action as deleted. PollForJobs for the custom action fails after the action is marked
for deletion. Used for custom actions only.
To re-create a custom action after it has been deleted you must use a string in the version field that has never been used before. This string can be an incremented version number, for example. To restore a deleted custom action, use a JSON file that is identical to the deleted action, including the original string in the version field.
This is a convenience which creates an instance of the DeleteCustomActionTypeRequest.Builder avoiding the
need to create one manually via DeleteCustomActionTypeRequest.builder()
deleteCustomActionTypeRequest - A Consumer that will call methods on
DeleteCustomActionTypeRequest.Builder to create
a request. Represents the input of a DeleteCustomActionType operation. The custom action will
be marked as deleted.default CompletableFuture<DeletePipelineResponse> deletePipeline(DeletePipelineRequest deletePipelineRequest)
Deletes the specified pipeline.
deletePipelineRequest - Represents the input of a DeletePipeline action.default CompletableFuture<DeletePipelineResponse> deletePipeline(Consumer<DeletePipelineRequest.Builder> deletePipelineRequest)
Deletes the specified pipeline.
This is a convenience which creates an instance of the DeletePipelineRequest.Builder avoiding the need to
create one manually via DeletePipelineRequest.builder()
deletePipelineRequest - A Consumer that will call methods on
DeletePipelineRequest.Builder to create a
request. Represents the input of a DeletePipeline action.default CompletableFuture<DeleteWebhookResponse> deleteWebhook(DeleteWebhookRequest deleteWebhookRequest)
Deletes a previously created webhook by name. Deleting the webhook stops CodePipeline from starting a pipeline every time an external event occurs. The API returns successfully when trying to delete a webhook that is already deleted. If a deleted webhook is re-created by calling PutWebhook with the same name, it will have a different URL.
deleteWebhookRequest - default CompletableFuture<DeleteWebhookResponse> deleteWebhook(Consumer<DeleteWebhookRequest.Builder> deleteWebhookRequest)
Deletes a previously created webhook by name. Deleting the webhook stops CodePipeline from starting a pipeline every time an external event occurs. The API returns successfully when trying to delete a webhook that is already deleted. If a deleted webhook is re-created by calling PutWebhook with the same name, it will have a different URL.
This is a convenience which creates an instance of the DeleteWebhookRequest.Builder avoiding the need to
create one manually via DeleteWebhookRequest.builder()
deleteWebhookRequest - A Consumer that will call methods on
DeleteWebhookRequest.Builder to create a
request.default CompletableFuture<DeregisterWebhookWithThirdPartyResponse> deregisterWebhookWithThirdParty(DeregisterWebhookWithThirdPartyRequest deregisterWebhookWithThirdPartyRequest)
Removes the connection between the webhook that was created by CodePipeline and the external tool with events to be detected. Currently supported only for webhooks that target an action type of GitHub.
deregisterWebhookWithThirdPartyRequest - default CompletableFuture<DeregisterWebhookWithThirdPartyResponse> deregisterWebhookWithThirdParty(Consumer<DeregisterWebhookWithThirdPartyRequest.Builder> deregisterWebhookWithThirdPartyRequest)
Removes the connection between the webhook that was created by CodePipeline and the external tool with events to be detected. Currently supported only for webhooks that target an action type of GitHub.
This is a convenience which creates an instance of the DeregisterWebhookWithThirdPartyRequest.Builder
avoiding the need to create one manually via DeregisterWebhookWithThirdPartyRequest.builder()
deregisterWebhookWithThirdPartyRequest - A Consumer that will call methods on
DeregisterWebhookWithThirdPartyRequest.Builder
to create a request.default CompletableFuture<DisableStageTransitionResponse> disableStageTransition(DisableStageTransitionRequest disableStageTransitionRequest)
Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline.
disableStageTransitionRequest - Represents the input of a DisableStageTransition action.default CompletableFuture<DisableStageTransitionResponse> disableStageTransition(Consumer<DisableStageTransitionRequest.Builder> disableStageTransitionRequest)
Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline.
This is a convenience which creates an instance of the DisableStageTransitionRequest.Builder avoiding the
need to create one manually via DisableStageTransitionRequest.builder()
disableStageTransitionRequest - A Consumer that will call methods on
DisableStageTransitionRequest.Builder to create
a request. Represents the input of a DisableStageTransition action.default CompletableFuture<EnableStageTransitionResponse> enableStageTransition(EnableStageTransitionRequest enableStageTransitionRequest)
Enables artifacts in a pipeline to transition to a stage in a pipeline.
enableStageTransitionRequest - Represents the input of an EnableStageTransition action.default CompletableFuture<EnableStageTransitionResponse> enableStageTransition(Consumer<EnableStageTransitionRequest.Builder> enableStageTransitionRequest)
Enables artifacts in a pipeline to transition to a stage in a pipeline.
This is a convenience which creates an instance of the EnableStageTransitionRequest.Builder avoiding the
need to create one manually via EnableStageTransitionRequest.builder()
enableStageTransitionRequest - A Consumer that will call methods on
EnableStageTransitionRequest.Builder to create
a request. Represents the input of an EnableStageTransition action.default CompletableFuture<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. The action can be created with any supported integration model.
getActionTypeRequest - default CompletableFuture<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. The action can be created with any supported integration model.
This is a convenience which creates an instance of the GetActionTypeRequest.Builder avoiding the need to
create one manually via GetActionTypeRequest.builder()
getActionTypeRequest - A Consumer that will call methods on
GetActionTypeRequest.Builder to create a
request.default CompletableFuture<GetJobDetailsResponse> getJobDetails(GetJobDetailsRequest getJobDetailsRequest)
Returns information about a job. Used for custom actions only.
When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.
getJobDetailsRequest - Represents the input of a GetJobDetails action.default CompletableFuture<GetJobDetailsResponse> getJobDetails(Consumer<GetJobDetailsRequest.Builder> getJobDetailsRequest)
Returns information about a job. Used for custom actions only.
When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.
This is a convenience which creates an instance of the GetJobDetailsRequest.Builder avoiding the need to
create one manually via GetJobDetailsRequest.builder()
getJobDetailsRequest - A Consumer that will call methods on
GetJobDetailsRequest.Builder to create a
request. Represents the input of a GetJobDetails action.default CompletableFuture<GetPipelineResponse> getPipeline(GetPipelineRequest getPipelineRequest)
Returns the metadata, structure, stages, and actions of a pipeline. Can be used to return the entire structure of a pipeline in JSON format, which can then be modified and used to update the pipeline structure with UpdatePipeline.
getPipelineRequest - Represents the input of a GetPipeline action.default CompletableFuture<GetPipelineResponse> getPipeline(Consumer<GetPipelineRequest.Builder> getPipelineRequest)
Returns the metadata, structure, stages, and actions of a pipeline. Can be used to return the entire structure of a pipeline in JSON format, which can then be modified and used to update the pipeline structure with UpdatePipeline.
This is a convenience which creates an instance of the GetPipelineRequest.Builder avoiding the need to
create one manually via GetPipelineRequest.builder()
getPipelineRequest - A Consumer that will call methods on
GetPipelineRequest.Builder to create a request.
Represents the input of a GetPipeline action.default CompletableFuture<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.
getPipelineExecutionRequest - Represents the input of a GetPipelineExecution action.default CompletableFuture<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.
This is a convenience which creates an instance of the GetPipelineExecutionRequest.Builder avoiding the
need to create one manually via GetPipelineExecutionRequest.builder()
getPipelineExecutionRequest - A Consumer that will call methods on
GetPipelineExecutionRequest.Builder to create a
request. Represents the input of a GetPipelineExecution action.default CompletableFuture<GetPipelineStateResponse> getPipelineState(GetPipelineStateRequest getPipelineStateRequest)
Returns information about the state of a pipeline, including the stages and actions.
Values returned in the revisionId and revisionUrl fields indicate the source revision
information, such as the commit ID, for the current state.
getPipelineStateRequest - Represents the input of a GetPipelineState action.default CompletableFuture<GetPipelineStateResponse> getPipelineState(Consumer<GetPipelineStateRequest.Builder> getPipelineStateRequest)
Returns information about the state of a pipeline, including the stages and actions.
Values returned in the revisionId and revisionUrl fields indicate the source revision
information, such as the commit ID, for the current state.
This is a convenience which creates an instance of the GetPipelineStateRequest.Builder avoiding the need
to create one manually via GetPipelineStateRequest.builder()
getPipelineStateRequest - A Consumer that will call methods on
GetPipelineStateRequest.Builder to create a
request. Represents the input of a GetPipelineState action.default CompletableFuture<GetThirdPartyJobDetailsResponse> getThirdPartyJobDetails(GetThirdPartyJobDetailsRequest getThirdPartyJobDetailsRequest)
Requests the details of a job for a third party action. Used for partner actions only.
When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.
getThirdPartyJobDetailsRequest - Represents the input of a GetThirdPartyJobDetails action.default CompletableFuture<GetThirdPartyJobDetailsResponse> getThirdPartyJobDetails(Consumer<GetThirdPartyJobDetailsRequest.Builder> getThirdPartyJobDetailsRequest)
Requests the details of a job for a third party action. Used for partner actions only.
When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.
This is a convenience which creates an instance of the GetThirdPartyJobDetailsRequest.Builder avoiding
the need to create one manually via GetThirdPartyJobDetailsRequest.builder()
getThirdPartyJobDetailsRequest - A Consumer that will call methods on
GetThirdPartyJobDetailsRequest.Builder to
create a request. Represents the input of a GetThirdPartyJobDetails action.default CompletableFuture<ListActionExecutionsResponse> listActionExecutions(ListActionExecutionsRequest listActionExecutionsRequest)
Lists the action executions that have occurred in a pipeline.
listActionExecutionsRequest - default CompletableFuture<ListActionExecutionsResponse> listActionExecutions(Consumer<ListActionExecutionsRequest.Builder> listActionExecutionsRequest)
Lists the action executions that have occurred in a pipeline.
This is a convenience which creates an instance of the ListActionExecutionsRequest.Builder avoiding the
need to create one manually via ListActionExecutionsRequest.builder()
listActionExecutionsRequest - A Consumer that will call methods on
ListActionExecutionsRequest.Builder to create a
request.default ListActionExecutionsPublisher listActionExecutionsPaginator(ListActionExecutionsRequest listActionExecutionsRequest)
Lists the action executions that have occurred in a pipeline.
This is a variant of
listActionExecutions(software.amazon.awssdk.services.codepipeline.model.ListActionExecutionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.codepipeline.paginators.ListActionExecutionsPublisher publisher = client.listActionExecutionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.codepipeline.paginators.ListActionExecutionsPublisher publisher = client.listActionExecutionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codepipeline.model.ListActionExecutionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.codepipeline.model.ListActionExecutionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listActionExecutions(software.amazon.awssdk.services.codepipeline.model.ListActionExecutionsRequest)
operation.
listActionExecutionsRequest - default ListActionExecutionsPublisher listActionExecutionsPaginator(Consumer<ListActionExecutionsRequest.Builder> listActionExecutionsRequest)
Lists the action executions that have occurred in a pipeline.
This is a variant of
listActionExecutions(software.amazon.awssdk.services.codepipeline.model.ListActionExecutionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.codepipeline.paginators.ListActionExecutionsPublisher publisher = client.listActionExecutionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.codepipeline.paginators.ListActionExecutionsPublisher publisher = client.listActionExecutionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codepipeline.model.ListActionExecutionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.codepipeline.model.ListActionExecutionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listActionExecutions(software.amazon.awssdk.services.codepipeline.model.ListActionExecutionsRequest)
operation.
This is a convenience which creates an instance of the ListActionExecutionsRequest.Builder avoiding the
need to create one manually via ListActionExecutionsRequest.builder()
listActionExecutionsRequest - A Consumer that will call methods on
ListActionExecutionsRequest.Builder to create a
request.default CompletableFuture<ListActionTypesResponse> listActionTypes(ListActionTypesRequest listActionTypesRequest)
Gets a summary of all CodePipeline action types associated with your account.
listActionTypesRequest - Represents the input of a ListActionTypes action.default CompletableFuture<ListActionTypesResponse> listActionTypes(Consumer<ListActionTypesRequest.Builder> listActionTypesRequest)
Gets a summary of all CodePipeline action types associated with your account.
This is a convenience which creates an instance of the ListActionTypesRequest.Builder avoiding the need
to create one manually via ListActionTypesRequest.builder()
listActionTypesRequest - A Consumer that will call methods on
ListActionTypesRequest.Builder to create a
request. Represents the input of a ListActionTypes action.default CompletableFuture<ListActionTypesResponse> listActionTypes()
Gets a summary of all CodePipeline action types associated with your account.
default ListActionTypesPublisher listActionTypesPaginator()
Gets a summary of all CodePipeline action types associated with your account.
This is a variant of
listActionTypes(software.amazon.awssdk.services.codepipeline.model.ListActionTypesRequest) operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.codepipeline.paginators.ListActionTypesPublisher publisher = client.listActionTypesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.codepipeline.paginators.ListActionTypesPublisher publisher = client.listActionTypesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codepipeline.model.ListActionTypesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.codepipeline.model.ListActionTypesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.
default ListActionTypesPublisher listActionTypesPaginator(ListActionTypesRequest listActionTypesRequest)
Gets a summary of all CodePipeline action types associated with your account.
This is a variant of
listActionTypes(software.amazon.awssdk.services.codepipeline.model.ListActionTypesRequest) operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.codepipeline.paginators.ListActionTypesPublisher publisher = client.listActionTypesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.codepipeline.paginators.ListActionTypesPublisher publisher = client.listActionTypesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codepipeline.model.ListActionTypesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.codepipeline.model.ListActionTypesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listActionTypes(software.amazon.awssdk.services.codepipeline.model.ListActionTypesRequest)
operation.
listActionTypesRequest - Represents the input of a ListActionTypes action.default ListActionTypesPublisher listActionTypesPaginator(Consumer<ListActionTypesRequest.Builder> listActionTypesRequest)
Gets a summary of all CodePipeline action types associated with your account.
This is a variant of
listActionTypes(software.amazon.awssdk.services.codepipeline.model.ListActionTypesRequest) operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.codepipeline.paginators.ListActionTypesPublisher publisher = client.listActionTypesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.codepipeline.paginators.ListActionTypesPublisher publisher = client.listActionTypesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codepipeline.model.ListActionTypesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.codepipeline.model.ListActionTypesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listActionTypes(software.amazon.awssdk.services.codepipeline.model.ListActionTypesRequest)
operation.
This is a convenience which creates an instance of the ListActionTypesRequest.Builder avoiding the need
to create one manually via ListActionTypesRequest.builder()
listActionTypesRequest - A Consumer that will call methods on
ListActionTypesRequest.Builder to create a
request. Represents the input of a ListActionTypes action.default CompletableFuture<ListPipelineExecutionsResponse> listPipelineExecutions(ListPipelineExecutionsRequest listPipelineExecutionsRequest)
Gets a summary of the most recent executions for a pipeline.
listPipelineExecutionsRequest - Represents the input of a ListPipelineExecutions action.default CompletableFuture<ListPipelineExecutionsResponse> listPipelineExecutions(Consumer<ListPipelineExecutionsRequest.Builder> listPipelineExecutionsRequest)
Gets a summary of the most recent executions for a pipeline.
This is a convenience which creates an instance of the ListPipelineExecutionsRequest.Builder avoiding the
need to create one manually via ListPipelineExecutionsRequest.builder()
listPipelineExecutionsRequest - A Consumer that will call methods on
ListPipelineExecutionsRequest.Builder to create
a request. Represents the input of a ListPipelineExecutions action.default ListPipelineExecutionsPublisher listPipelineExecutionsPaginator(ListPipelineExecutionsRequest listPipelineExecutionsRequest)
Gets a summary of the most recent executions for a pipeline.
This is a variant of
listPipelineExecutions(software.amazon.awssdk.services.codepipeline.model.ListPipelineExecutionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.codepipeline.paginators.ListPipelineExecutionsPublisher publisher = client.listPipelineExecutionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.codepipeline.paginators.ListPipelineExecutionsPublisher publisher = client.listPipelineExecutionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codepipeline.model.ListPipelineExecutionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.codepipeline.model.ListPipelineExecutionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPipelineExecutions(software.amazon.awssdk.services.codepipeline.model.ListPipelineExecutionsRequest)
operation.
listPipelineExecutionsRequest - Represents the input of a ListPipelineExecutions action.default ListPipelineExecutionsPublisher listPipelineExecutionsPaginator(Consumer<ListPipelineExecutionsRequest.Builder> listPipelineExecutionsRequest)
Gets a summary of the most recent executions for a pipeline.
This is a variant of
listPipelineExecutions(software.amazon.awssdk.services.codepipeline.model.ListPipelineExecutionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.codepipeline.paginators.ListPipelineExecutionsPublisher publisher = client.listPipelineExecutionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.codepipeline.paginators.ListPipelineExecutionsPublisher publisher = client.listPipelineExecutionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codepipeline.model.ListPipelineExecutionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.codepipeline.model.ListPipelineExecutionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPipelineExecutions(software.amazon.awssdk.services.codepipeline.model.ListPipelineExecutionsRequest)
operation.
This is a convenience which creates an instance of the ListPipelineExecutionsRequest.Builder avoiding the
need to create one manually via ListPipelineExecutionsRequest.builder()
listPipelineExecutionsRequest - A Consumer that will call methods on
ListPipelineExecutionsRequest.Builder to create
a request. Represents the input of a ListPipelineExecutions action.default CompletableFuture<ListPipelinesResponse> listPipelines(ListPipelinesRequest listPipelinesRequest)
Gets a summary of all of the pipelines associated with your account.
listPipelinesRequest - Represents the input of a ListPipelines action.default CompletableFuture<ListPipelinesResponse> listPipelines(Consumer<ListPipelinesRequest.Builder> listPipelinesRequest)
Gets a summary of all of the pipelines associated with your account.
This is a convenience which creates an instance of the ListPipelinesRequest.Builder avoiding the need to
create one manually via ListPipelinesRequest.builder()
listPipelinesRequest - A Consumer that will call methods on
ListPipelinesRequest.Builder to create a
request. Represents the input of a ListPipelines action.default CompletableFuture<ListPipelinesResponse> listPipelines()
Gets a summary of all of the pipelines associated with your account.
default ListPipelinesPublisher listPipelinesPaginator()
Gets a summary of all of the pipelines associated with your account.
This is a variant of
listPipelines(software.amazon.awssdk.services.codepipeline.model.ListPipelinesRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.codepipeline.paginators.ListPipelinesPublisher publisher = client.listPipelinesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.codepipeline.paginators.ListPipelinesPublisher publisher = client.listPipelinesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codepipeline.model.ListPipelinesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.codepipeline.model.ListPipelinesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.
default ListPipelinesPublisher listPipelinesPaginator(ListPipelinesRequest listPipelinesRequest)
Gets a summary of all of the pipelines associated with your account.
This is a variant of
listPipelines(software.amazon.awssdk.services.codepipeline.model.ListPipelinesRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.codepipeline.paginators.ListPipelinesPublisher publisher = client.listPipelinesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.codepipeline.paginators.ListPipelinesPublisher publisher = client.listPipelinesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codepipeline.model.ListPipelinesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.codepipeline.model.ListPipelinesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPipelines(software.amazon.awssdk.services.codepipeline.model.ListPipelinesRequest) operation.
listPipelinesRequest - Represents the input of a ListPipelines action.default ListPipelinesPublisher listPipelinesPaginator(Consumer<ListPipelinesRequest.Builder> listPipelinesRequest)
Gets a summary of all of the pipelines associated with your account.
This is a variant of
listPipelines(software.amazon.awssdk.services.codepipeline.model.ListPipelinesRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.codepipeline.paginators.ListPipelinesPublisher publisher = client.listPipelinesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.codepipeline.paginators.ListPipelinesPublisher publisher = client.listPipelinesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codepipeline.model.ListPipelinesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.codepipeline.model.ListPipelinesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPipelines(software.amazon.awssdk.services.codepipeline.model.ListPipelinesRequest) operation.
This is a convenience which creates an instance of the ListPipelinesRequest.Builder avoiding the need to
create one manually via ListPipelinesRequest.builder()
listPipelinesRequest - A Consumer that will call methods on
ListPipelinesRequest.Builder to create a
request. Represents the input of a ListPipelines action.default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Gets the set of key-value pairs (metadata) that are used to manage the resource.
listTagsForResourceRequest - default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Gets the set of key-value pairs (metadata) that are used to manage the resource.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on
ListTagsForResourceRequest.Builder to create a
request.default ListTagsForResourcePublisher listTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest)
Gets the set of key-value pairs (metadata) that are used to manage the resource.
This is a variant of
listTagsForResource(software.amazon.awssdk.services.codepipeline.model.ListTagsForResourceRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.codepipeline.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.codepipeline.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codepipeline.model.ListTagsForResourceResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.codepipeline.model.ListTagsForResourceResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTagsForResource(software.amazon.awssdk.services.codepipeline.model.ListTagsForResourceRequest)
operation.
listTagsForResourceRequest - default ListTagsForResourcePublisher listTagsForResourcePaginator(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Gets the set of key-value pairs (metadata) that are used to manage the resource.
This is a variant of
listTagsForResource(software.amazon.awssdk.services.codepipeline.model.ListTagsForResourceRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.codepipeline.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.codepipeline.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codepipeline.model.ListTagsForResourceResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.codepipeline.model.ListTagsForResourceResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTagsForResource(software.amazon.awssdk.services.codepipeline.model.ListTagsForResourceRequest)
operation.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on
ListTagsForResourceRequest.Builder to create a
request.default CompletableFuture<ListWebhooksResponse> listWebhooks(ListWebhooksRequest listWebhooksRequest)
Gets a listing of all the webhooks in this Amazon Web Services Region for this account. The output lists all webhooks and includes the webhook URL and ARN and the configuration for each webhook.
listWebhooksRequest - default CompletableFuture<ListWebhooksResponse> listWebhooks(Consumer<ListWebhooksRequest.Builder> listWebhooksRequest)
Gets a listing of all the webhooks in this Amazon Web Services Region for this account. The output lists all webhooks and includes the webhook URL and ARN and the configuration for each webhook.
This is a convenience which creates an instance of the ListWebhooksRequest.Builder avoiding the need to
create one manually via ListWebhooksRequest.builder()
listWebhooksRequest - A Consumer that will call methods on
ListWebhooksRequest.Builder to create a
request.default CompletableFuture<ListWebhooksResponse> listWebhooks()
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.
default ListWebhooksPublisher listWebhooksPaginator()
Gets a listing of all the webhooks in this Amazon Web Services Region for this account. The output lists all webhooks and includes the webhook URL and ARN and the configuration for each webhook.
This is a variant of
listWebhooks(software.amazon.awssdk.services.codepipeline.model.ListWebhooksRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.codepipeline.paginators.ListWebhooksPublisher publisher = client.listWebhooksPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.codepipeline.paginators.ListWebhooksPublisher publisher = client.listWebhooksPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codepipeline.model.ListWebhooksResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.codepipeline.model.ListWebhooksResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.
default ListWebhooksPublisher listWebhooksPaginator(ListWebhooksRequest listWebhooksRequest)
Gets a listing of all the webhooks in this Amazon Web Services Region for this account. The output lists all webhooks and includes the webhook URL and ARN and the configuration for each webhook.
This is a variant of
listWebhooks(software.amazon.awssdk.services.codepipeline.model.ListWebhooksRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.codepipeline.paginators.ListWebhooksPublisher publisher = client.listWebhooksPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.codepipeline.paginators.ListWebhooksPublisher publisher = client.listWebhooksPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codepipeline.model.ListWebhooksResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.codepipeline.model.ListWebhooksResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listWebhooks(software.amazon.awssdk.services.codepipeline.model.ListWebhooksRequest) operation.
listWebhooksRequest - default ListWebhooksPublisher listWebhooksPaginator(Consumer<ListWebhooksRequest.Builder> listWebhooksRequest)
Gets a listing of all the webhooks in this Amazon Web Services Region for this account. The output lists all webhooks and includes the webhook URL and ARN and the configuration for each webhook.
This is a variant of
listWebhooks(software.amazon.awssdk.services.codepipeline.model.ListWebhooksRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.codepipeline.paginators.ListWebhooksPublisher publisher = client.listWebhooksPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.codepipeline.paginators.ListWebhooksPublisher publisher = client.listWebhooksPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codepipeline.model.ListWebhooksResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.codepipeline.model.ListWebhooksResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listWebhooks(software.amazon.awssdk.services.codepipeline.model.ListWebhooksRequest) operation.
This is a convenience which creates an instance of the ListWebhooksRequest.Builder avoiding the need to
create one manually via ListWebhooksRequest.builder()
listWebhooksRequest - A Consumer that will call methods on
ListWebhooksRequest.Builder to create a
request.default CompletableFuture<PollForJobsResponse> pollForJobs(PollForJobsRequest pollForJobsRequest)
Returns information about any jobs for CodePipeline to act on. PollForJobs is valid only for action
types with "Custom" in the owner field. If the action type contains AWS or ThirdParty
in the owner field, the PollForJobs action returns an error.
When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.
pollForJobsRequest - Represents the input of a PollForJobs action.default CompletableFuture<PollForJobsResponse> pollForJobs(Consumer<PollForJobsRequest.Builder> pollForJobsRequest)
Returns information about any jobs for CodePipeline to act on. PollForJobs is valid only for action
types with "Custom" in the owner field. If the action type contains AWS or ThirdParty
in the owner field, the PollForJobs action returns an error.
When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.
This is a convenience which creates an instance of the PollForJobsRequest.Builder avoiding the need to
create one manually via PollForJobsRequest.builder()
pollForJobsRequest - A Consumer that will call methods on
PollForJobsRequest.Builder to create a request.
Represents the input of a PollForJobs action.default CompletableFuture<PollForThirdPartyJobsResponse> pollForThirdPartyJobs(PollForThirdPartyJobsRequest pollForThirdPartyJobsRequest)
Determines whether there are any third party jobs for a job worker to act on. Used for partner actions only.
When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts.
pollForThirdPartyJobsRequest - Represents the input of a PollForThirdPartyJobs action.default CompletableFuture<PollForThirdPartyJobsResponse> pollForThirdPartyJobs(Consumer<PollForThirdPartyJobsRequest.Builder> pollForThirdPartyJobsRequest)
Determines whether there are any third party jobs for a job worker to act on. Used for partner actions only.
When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts.
This is a convenience which creates an instance of the PollForThirdPartyJobsRequest.Builder avoiding the
need to create one manually via PollForThirdPartyJobsRequest.builder()
pollForThirdPartyJobsRequest - A Consumer that will call methods on
PollForThirdPartyJobsRequest.Builder to create
a request. Represents the input of a PollForThirdPartyJobs action.default CompletableFuture<PutActionRevisionResponse> putActionRevision(PutActionRevisionRequest putActionRevisionRequest)
Provides information to CodePipeline about new revisions to a source.
putActionRevisionRequest - Represents the input of a PutActionRevision action.default CompletableFuture<PutActionRevisionResponse> putActionRevision(Consumer<PutActionRevisionRequest.Builder> putActionRevisionRequest)
Provides information to CodePipeline about new revisions to a source.
This is a convenience which creates an instance of the PutActionRevisionRequest.Builder avoiding the need
to create one manually via PutActionRevisionRequest.builder()
putActionRevisionRequest - A Consumer that will call methods on
PutActionRevisionRequest.Builder to create a
request. Represents the input of a PutActionRevision action.default CompletableFuture<PutApprovalResultResponse> putApprovalResult(PutApprovalResultRequest putApprovalResultRequest)
Provides the response to a manual approval request to CodePipeline. Valid responses include Approved and Rejected.
putApprovalResultRequest - Represents the input of a PutApprovalResult action.default CompletableFuture<PutApprovalResultResponse> putApprovalResult(Consumer<PutApprovalResultRequest.Builder> putApprovalResultRequest)
Provides the response to a manual approval request to CodePipeline. Valid responses include Approved and Rejected.
This is a convenience which creates an instance of the PutApprovalResultRequest.Builder avoiding the need
to create one manually via PutApprovalResultRequest.builder()
putApprovalResultRequest - A Consumer that will call methods on
PutApprovalResultRequest.Builder to create a
request. Represents the input of a PutApprovalResult action.default CompletableFuture<PutJobFailureResultResponse> putJobFailureResult(PutJobFailureResultRequest putJobFailureResultRequest)
Represents the failure of a job as returned to the pipeline by a job worker. Used for custom actions only.
putJobFailureResultRequest - Represents the input of a PutJobFailureResult action.default CompletableFuture<PutJobFailureResultResponse> putJobFailureResult(Consumer<PutJobFailureResultRequest.Builder> putJobFailureResultRequest)
Represents the failure of a job as returned to the pipeline by a job worker. Used for custom actions only.
This is a convenience which creates an instance of the PutJobFailureResultRequest.Builder avoiding the
need to create one manually via PutJobFailureResultRequest.builder()
putJobFailureResultRequest - A Consumer that will call methods on
PutJobFailureResultRequest.Builder to create a
request. Represents the input of a PutJobFailureResult action.default CompletableFuture<PutJobSuccessResultResponse> putJobSuccessResult(PutJobSuccessResultRequest putJobSuccessResultRequest)
Represents the success of a job as returned to the pipeline by a job worker. Used for custom actions only.
putJobSuccessResultRequest - Represents the input of a PutJobSuccessResult action.default CompletableFuture<PutJobSuccessResultResponse> putJobSuccessResult(Consumer<PutJobSuccessResultRequest.Builder> putJobSuccessResultRequest)
Represents the success of a job as returned to the pipeline by a job worker. Used for custom actions only.
This is a convenience which creates an instance of the PutJobSuccessResultRequest.Builder avoiding the
need to create one manually via PutJobSuccessResultRequest.builder()
putJobSuccessResultRequest - A Consumer that will call methods on
PutJobSuccessResultRequest.Builder to create a
request. Represents the input of a PutJobSuccessResult action.default CompletableFuture<PutThirdPartyJobFailureResultResponse> putThirdPartyJobFailureResult(PutThirdPartyJobFailureResultRequest putThirdPartyJobFailureResultRequest)
Represents the failure of a third party job as returned to the pipeline by a job worker. Used for partner actions only.
putThirdPartyJobFailureResultRequest - Represents the input of a PutThirdPartyJobFailureResult action.default CompletableFuture<PutThirdPartyJobFailureResultResponse> putThirdPartyJobFailureResult(Consumer<PutThirdPartyJobFailureResultRequest.Builder> putThirdPartyJobFailureResultRequest)
Represents the failure of a third party job as returned to the pipeline by a job worker. Used for partner actions only.
This is a convenience which creates an instance of the PutThirdPartyJobFailureResultRequest.Builder
avoiding the need to create one manually via PutThirdPartyJobFailureResultRequest.builder()
putThirdPartyJobFailureResultRequest - A Consumer that will call methods on
PutThirdPartyJobFailureResultRequest.Builder to
create a request. Represents the input of a PutThirdPartyJobFailureResult action.default CompletableFuture<PutThirdPartyJobSuccessResultResponse> putThirdPartyJobSuccessResult(PutThirdPartyJobSuccessResultRequest putThirdPartyJobSuccessResultRequest)
Represents the success of a third party job as returned to the pipeline by a job worker. Used for partner actions only.
putThirdPartyJobSuccessResultRequest - Represents the input of a PutThirdPartyJobSuccessResult action.default CompletableFuture<PutThirdPartyJobSuccessResultResponse> putThirdPartyJobSuccessResult(Consumer<PutThirdPartyJobSuccessResultRequest.Builder> putThirdPartyJobSuccessResultRequest)
Represents the success of a third party job as returned to the pipeline by a job worker. Used for partner actions only.
This is a convenience which creates an instance of the PutThirdPartyJobSuccessResultRequest.Builder
avoiding the need to create one manually via PutThirdPartyJobSuccessResultRequest.builder()
putThirdPartyJobSuccessResultRequest - A Consumer that will call methods on
PutThirdPartyJobSuccessResultRequest.Builder to
create a request. Represents the input of a PutThirdPartyJobSuccessResult action.default CompletableFuture<PutWebhookResponse> putWebhook(PutWebhookRequest putWebhookRequest)
Defines a webhook and returns a unique webhook URL generated by CodePipeline. This URL can be supplied to third party source hosting providers to call every time there's a code change. When CodePipeline receives a POST request on this URL, the pipeline defined in the webhook is started as long as the POST request satisfied the authentication and filtering requirements supplied when defining the webhook. RegisterWebhookWithThirdParty and DeregisterWebhookWithThirdParty APIs can be used to automatically configure supported third parties to call the generated webhook URL.
putWebhookRequest - default CompletableFuture<PutWebhookResponse> putWebhook(Consumer<PutWebhookRequest.Builder> putWebhookRequest)
Defines a webhook and returns a unique webhook URL generated by CodePipeline. This URL can be supplied to third party source hosting providers to call every time there's a code change. When CodePipeline receives a POST request on this URL, the pipeline defined in the webhook is started as long as the POST request satisfied the authentication and filtering requirements supplied when defining the webhook. RegisterWebhookWithThirdParty and DeregisterWebhookWithThirdParty APIs can be used to automatically configure supported third parties to call the generated webhook URL.
This is a convenience which creates an instance of the PutWebhookRequest.Builder avoiding the need to
create one manually via PutWebhookRequest.builder()
putWebhookRequest - A Consumer that will call methods on
PutWebhookRequest.Builder to create a request.default CompletableFuture<RegisterWebhookWithThirdPartyResponse> registerWebhookWithThirdParty(RegisterWebhookWithThirdPartyRequest registerWebhookWithThirdPartyRequest)
Configures a connection between the webhook that was created and the external tool with events to be detected.
registerWebhookWithThirdPartyRequest - default CompletableFuture<RegisterWebhookWithThirdPartyResponse> registerWebhookWithThirdParty(Consumer<RegisterWebhookWithThirdPartyRequest.Builder> registerWebhookWithThirdPartyRequest)
Configures a connection between the webhook that was created and the external tool with events to be detected.
This is a convenience which creates an instance of the RegisterWebhookWithThirdPartyRequest.Builder
avoiding the need to create one manually via RegisterWebhookWithThirdPartyRequest.builder()
registerWebhookWithThirdPartyRequest - A Consumer that will call methods on
RegisterWebhookWithThirdPartyRequest.Builder to
create a request.default CompletableFuture<RetryStageExecutionResponse> retryStageExecution(RetryStageExecutionRequest retryStageExecutionRequest)
You can retry a stage that has failed without having to run a pipeline again from the beginning. You do this by either retrying the failed actions in a stage or by retrying all actions in the stage starting from the first action in the stage. When you retry the failed actions in a stage, all actions that are still in progress continue working, and failed actions are triggered again. When you retry a failed stage from the first action in the stage, the stage cannot have any actions in progress. Before a stage can be retried, it must either have all actions failed or some actions failed and some succeeded.
retryStageExecutionRequest - Represents the input of a RetryStageExecution action.pipelineExecutionId associated with the request is out of date.default CompletableFuture<RetryStageExecutionResponse> retryStageExecution(Consumer<RetryStageExecutionRequest.Builder> retryStageExecutionRequest)
You can retry a stage that has failed without having to run a pipeline again from the beginning. You do this by either retrying the failed actions in a stage or by retrying all actions in the stage starting from the first action in the stage. When you retry the failed actions in a stage, all actions that are still in progress continue working, and failed actions are triggered again. When you retry a failed stage from the first action in the stage, the stage cannot have any actions in progress. Before a stage can be retried, it must either have all actions failed or some actions failed and some succeeded.
This is a convenience which creates an instance of the RetryStageExecutionRequest.Builder avoiding the
need to create one manually via RetryStageExecutionRequest.builder()
retryStageExecutionRequest - A Consumer that will call methods on
RetryStageExecutionRequest.Builder to create a
request. Represents the input of a RetryStageExecution action.pipelineExecutionId associated with the request is out of date.default CompletableFuture<StartPipelineExecutionResponse> startPipelineExecution(StartPipelineExecutionRequest startPipelineExecutionRequest)
Starts the specified pipeline. Specifically, it begins processing the latest commit to the source location specified as part of the pipeline.
startPipelineExecutionRequest - Represents the input of a StartPipelineExecution action.default CompletableFuture<StartPipelineExecutionResponse> startPipelineExecution(Consumer<StartPipelineExecutionRequest.Builder> startPipelineExecutionRequest)
Starts the specified pipeline. Specifically, it begins processing the latest commit to the source location specified as part of the pipeline.
This is a convenience which creates an instance of the StartPipelineExecutionRequest.Builder avoiding the
need to create one manually via StartPipelineExecutionRequest.builder()
startPipelineExecutionRequest - A Consumer that will call methods on
StartPipelineExecutionRequest.Builder to create
a request. Represents the input of a StartPipelineExecution action.default CompletableFuture<StopPipelineExecutionResponse> stopPipelineExecution(StopPipelineExecutionRequest stopPipelineExecutionRequest)
Stops the specified pipeline execution. You choose to either stop the pipeline execution by completing
in-progress actions without starting subsequent actions, or by abandoning in-progress actions. While completing
or abandoning in-progress actions, the pipeline execution is in a Stopping state. After all
in-progress actions are completed or abandoned, the pipeline execution is in a Stopped state.
stopPipelineExecutionRequest - Stopped state, or it might no longer be in progress.Stopping state. If
you already chose to stop and wait, you cannot make that request again. You can choose to stop and
abandon now, but be aware that this option can lead to failed tasks or out of sequence tasks. If you
already chose to stop and abandon, you cannot make that request again.default CompletableFuture<StopPipelineExecutionResponse> stopPipelineExecution(Consumer<StopPipelineExecutionRequest.Builder> stopPipelineExecutionRequest)
Stops the specified pipeline execution. You choose to either stop the pipeline execution by completing
in-progress actions without starting subsequent actions, or by abandoning in-progress actions. While completing
or abandoning in-progress actions, the pipeline execution is in a Stopping state. After all
in-progress actions are completed or abandoned, the pipeline execution is in a Stopped state.
This is a convenience which creates an instance of the StopPipelineExecutionRequest.Builder avoiding the
need to create one manually via StopPipelineExecutionRequest.builder()
stopPipelineExecutionRequest - A Consumer that will call methods on
StopPipelineExecutionRequest.Builder to create
a request.Stopped state, or it might no longer be in progress.Stopping state. If
you already chose to stop and wait, you cannot make that request again. You can choose to stop and
abandon now, but be aware that this option can lead to failed tasks or out of sequence tasks. If you
already chose to stop and abandon, you cannot make that request again.default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)
Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.
tagResourceRequest - default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.
This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on
TagResourceRequest.Builder to create a request.default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)
Removes tags from an Amazon Web Services resource.
untagResourceRequest - default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes tags from an Amazon Web Services resource.
This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on
UntagResourceRequest.Builder to create a
request.default CompletableFuture<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. Use a JSON file with the action definition and
UpdateActionType to provide the full structure.
updateActionTypeRequest - default CompletableFuture<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. Use a JSON file with the action definition and
UpdateActionType to provide the full structure.
This is a convenience which creates an instance of the UpdateActionTypeRequest.Builder avoiding the need
to create one manually via UpdateActionTypeRequest.builder()
updateActionTypeRequest - A Consumer that will call methods on
UpdateActionTypeRequest.Builder to create a
request.default CompletableFuture<UpdatePipelineResponse> updatePipeline(UpdatePipelineRequest updatePipelineRequest)
Updates a specified pipeline with edits or changes to its structure. Use a JSON file with the pipeline structure
and UpdatePipeline to provide the full structure of the pipeline. Updating the pipeline increases
the version number of the pipeline by 1.
updatePipelineRequest - Represents the input of an UpdatePipeline action.default CompletableFuture<UpdatePipelineResponse> updatePipeline(Consumer<UpdatePipelineRequest.Builder> updatePipelineRequest)
Updates a specified pipeline with edits or changes to its structure. Use a JSON file with the pipeline structure
and UpdatePipeline to provide the full structure of the pipeline. Updating the pipeline increases
the version number of the pipeline by 1.
This is a convenience which creates an instance of the UpdatePipelineRequest.Builder avoiding the need to
create one manually via UpdatePipelineRequest.builder()
updatePipelineRequest - A Consumer that will call methods on
UpdatePipelineRequest.Builder to create a
request. Represents the input of an UpdatePipeline action.default CodePipelineServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientstatic CodePipelineAsyncClient create()
CodePipelineAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static CodePipelineAsyncClientBuilder builder()
CodePipelineAsyncClient.Copyright © 2023. All rights reserved.