|
AWS SDK for C++
0.14.3
AWS SDK for C++
|
#include <CodePipelineClient.h>
Inheritance diagram for Aws::CodePipeline::CodePipelineClient:Public Types | |
| typedef Aws::Client::AWSJsonClient | BASECLASS |
| Public Types inherited from Aws::Client::AWSJsonClient | |
| typedef AWSClient | BASECLASS |
<fullname>AWS CodePipeline</fullname>
Overview
This is the AWS CodePipeline API Reference. This guide provides descriptions of the actions and data types for AWS CodePipeline. Some functionality for your pipeline is only configurable through the API. For additional information, see the AWS CodePipeline User Guide.
You can use the AWS CodePipeline API to work with pipelines, stages, actions, gates, and transitions, as described below.
Pipelines are models of automated release processes. Each pipeline is uniquely named, and consists of actions, gates, and stages.
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 a pipeline structure.
GetPipelineState, which returns information about the current state of the stages and actions of a pipeline.
ListPipelines, which gets a summary of all of the pipelines associated with your account.
StartPipelineExecution, which runs the the most recent revision of an artifact through the pipeline.
UpdatePipeline, which updates a pipeline with edits or changes to the structure of the pipeline.
Pipelines include stages, which are which are logical groupings of gates and actions. Each stage contains one or more actions that must complete before the next stage begins. A stage will result in success or failure. If a stage fails, then the pipeline stops at that stage and will remain stopped until either a new version of an artifact appears in the source location, or a user takes action to re-run 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, also refer to the AWS CodePipeline Pipeline Structure Reference.
Pipeline stages include actions, which are categorized into categories such as source or build actions performed within 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.
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 AWS CodePipeline
For third-party integrators or developers who want to create their own integrations with AWS CodePipeline, the expected sequence varies from the standard API user. In order to integrate with AWS CodePipeline, developers will 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 upon,
PutJobFailureResult, which provides details of a job failure, and
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 AWS CodePipeline. Partner actions are created by members of the AWS 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 upon,
PutThirdPartyJobFailureResult, which provides details of a job failure, and
PutThirdPartyJobSuccessResult, which provides details of a job success.
Definition at line 264 of file CodePipelineClient.h.
Definition at line 267 of file CodePipelineClient.h.
| Aws::CodePipeline::CodePipelineClient::CodePipelineClient | ( | const Client::ClientConfiguration & | clientConfiguration = Client::ClientConfiguration() | ) |
Initializes client to use DefaultCredentialProviderChain, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
| Aws::CodePipeline::CodePipelineClient::CodePipelineClient | ( | const Auth::AWSCredentials & | credentials, |
| const Client::ClientConfiguration & | clientConfiguration = Client::ClientConfiguration() |
||
| ) |
Initializes client to use SimpleAWSCredentialsProvider, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
| Aws::CodePipeline::CodePipelineClient::CodePipelineClient | ( | const std::shared_ptr< Auth::AWSCredentialsProvider > & | credentialsProvider, |
| const Client::ClientConfiguration & | clientConfiguration = Client::ClientConfiguration() |
||
| ) |
Initializes client to use specified credentials provider with specified client config. If http client factory is not supplied, the default http client factory will be used
|
virtual |
|
virtual |
Returns information about a specified job and whether that job has been received by the job worker. Only used for custom actions.
|
virtual |
Returns information about a specified job and whether that job has been received by the job worker. Only used for custom actions.
Queues the request into a thread executor and triggers associated callback when operation has finished.
|
virtual |
Returns information about a specified job and whether that job has been received by the job worker. Only used for custom actions.
returns a future to the operation so that it can be executed in parallel to other requests.
|
virtual |
Confirms a job worker has received the specified job. Only used for partner actions.
|
virtual |
Confirms a job worker has received the specified job. Only used for partner actions.
Queues the request into a thread executor and triggers associated callback when operation has finished.
|
virtual |
Confirms a job worker has received the specified job. Only used for partner actions.
returns a future to the operation so that it can be executed in parallel to other requests.
|
virtual |
Creates a new custom action that can be used in all pipelines associated with the AWS account. Only used for custom actions.
|
virtual |
Creates a new custom action that can be used in all pipelines associated with the AWS account. Only used for custom actions.
Queues the request into a thread executor and triggers associated callback when operation has finished.
|
virtual |
Creates a new custom action that can be used in all pipelines associated with the AWS account. Only used for custom actions.
returns a future to the operation so that it can be executed in parallel to other requests.
|
virtual |
Creates a pipeline.
|
virtual |
Creates a pipeline.
Queues the request into a thread executor and triggers associated callback when operation has finished.
|
virtual |
Creates a pipeline.
returns a future to the operation so that it can be executed in parallel to other requests.
|
virtual |
Marks a custom action as deleted. PollForJobs for the custom action will fail after the action is marked for deletion. Only used for custom actions.
<important>
You cannot recreate a custom action after it has been deleted unless you increase the version number of the action.
</important>
|
virtual |
Marks a custom action as deleted. PollForJobs for the custom action will fail after the action is marked for deletion. Only used for custom actions.
<important>
You cannot recreate a custom action after it has been deleted unless you increase the version number of the action.
</important>
Queues the request into a thread executor and triggers associated callback when operation has finished.
|
virtual |
Marks a custom action as deleted. PollForJobs for the custom action will fail after the action is marked for deletion. Only used for custom actions.
<important>
You cannot recreate a custom action after it has been deleted unless you increase the version number of the action.
</important>
returns a future to the operation so that it can be executed in parallel to other requests.
|
virtual |
Deletes the specified pipeline.
|
virtual |
Deletes the specified pipeline.
Queues the request into a thread executor and triggers associated callback when operation has finished.
|
virtual |
Deletes the specified pipeline.
returns a future to the operation so that it can be executed in parallel to other requests.
|
virtual |
Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline.
|
virtual |
Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline.
Queues the request into a thread executor and triggers associated callback when operation has finished.
|
virtual |
Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline.
returns a future to the operation so that it can be executed in parallel to other requests.
|
virtual |
Enables artifacts in a pipeline to transition to a stage in a pipeline.
|
virtual |
Enables artifacts in a pipeline to transition to a stage in a pipeline.
Queues the request into a thread executor and triggers associated callback when operation has finished.
|
virtual |
Enables artifacts in a pipeline to transition to a stage in a pipeline.
returns a future to the operation so that it can be executed in parallel to other requests.
|
virtual |
Returns information about a job. Only used for custom actions.
<important>
When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API returns any secret values defined for the action.
</important>
|
virtual |
Returns information about a job. Only used for custom actions.
<important>
When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API returns any secret values defined for the action.
</important>
Queues the request into a thread executor and triggers associated callback when operation has finished.
|
virtual |
Returns information about a job. Only used for custom actions.
<important>
When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API returns any secret values defined for the action.
</important>
returns a future to the operation so that it can be executed in parallel to other requests.
|
virtual |
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.
|
virtual |
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.
Queues the request into a thread executor and triggers associated callback when operation has finished.
|
virtual |
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.
returns a future to the operation so that it can be executed in parallel to other requests.
|
virtual |
Returns information about the state of a pipeline, including the stages and actions.
|
virtual |
Returns information about the state of a pipeline, including the stages and actions.
Queues the request into a thread executor and triggers associated callback when operation has finished.
|
virtual |
Returns information about the state of a pipeline, including the stages and actions.
returns a future to the operation so that it can be executed in parallel to other requests.
|
virtual |
Requests the details of a job for a third party action. Only used for partner actions.
<important>
When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API returns any secret values defined for the action.
</important>
|
virtual |
Requests the details of a job for a third party action. Only used for partner actions.
<important>
When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API returns any secret values defined for the action.
</important>
Queues the request into a thread executor and triggers associated callback when operation has finished.
|
virtual |
Requests the details of a job for a third party action. Only used for partner actions.
<important>
When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API returns any secret values defined for the action.
</important>
returns a future to the operation so that it can be executed in parallel to other requests.
|
virtual |
Gets a summary of all AWS CodePipeline action types associated with your account.
|
virtual |
Gets a summary of all AWS CodePipeline action types associated with your account.
Queues the request into a thread executor and triggers associated callback when operation has finished.
|
virtual |
Gets a summary of all AWS CodePipeline action types associated with your account.
returns a future to the operation so that it can be executed in parallel to other requests.
|
virtual |
Gets a summary of all of the pipelines associated with your account.
|
virtual |
Gets a summary of all of the pipelines associated with your account.
Queues the request into a thread executor and triggers associated callback when operation has finished.
|
virtual |
Gets a summary of all of the pipelines associated with your account.
returns a future to the operation so that it can be executed in parallel to other requests.
|
virtual |
Returns information about any jobs for AWS CodePipeline to act upon.
<important>
When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API returns any secret values defined for the action.
</important>
|
virtual |
Returns information about any jobs for AWS CodePipeline to act upon.
<important>
When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API returns any secret values defined for the action.
</important>
Queues the request into a thread executor and triggers associated callback when operation has finished.
|
virtual |
Returns information about any jobs for AWS CodePipeline to act upon.
<important>
When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API returns any secret values defined for the action.
</important>
returns a future to the operation so that it can be executed in parallel to other requests.
|
virtual |
Determines whether there are any third party jobs for a job worker to act on. Only used for partner actions.
<important>
When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts.
</important>
|
virtual |
Determines whether there are any third party jobs for a job worker to act on. Only used for partner actions.
<important>
When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts.
</important>
Queues the request into a thread executor and triggers associated callback when operation has finished.
|
virtual |
Determines whether there are any third party jobs for a job worker to act on. Only used for partner actions.
<important>
When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts.
</important>
returns a future to the operation so that it can be executed in parallel to other requests.
|
virtual |
Provides information to AWS CodePipeline about new revisions to a source.
|
virtual |
Provides information to AWS CodePipeline about new revisions to a source.
Queues the request into a thread executor and triggers associated callback when operation has finished.
|
virtual |
Provides information to AWS CodePipeline about new revisions to a source.
returns a future to the operation so that it can be executed in parallel to other requests.
|
virtual |
Provides the response to a manual approval request to AWS CodePipeline. Valid responses include Approved and Rejected.
|
virtual |
Provides the response to a manual approval request to AWS CodePipeline. Valid responses include Approved and Rejected.
Queues the request into a thread executor and triggers associated callback when operation has finished.
|
virtual |
Provides the response to a manual approval request to AWS CodePipeline. Valid responses include Approved and Rejected.
returns a future to the operation so that it can be executed in parallel to other requests.
|
virtual |
Represents the failure of a job as returned to the pipeline by a job worker. Only used for custom actions.
|
virtual |
Represents the failure of a job as returned to the pipeline by a job worker. Only used for custom actions.
Queues the request into a thread executor and triggers associated callback when operation has finished.
|
virtual |
Represents the failure of a job as returned to the pipeline by a job worker. Only used for custom actions.
returns a future to the operation so that it can be executed in parallel to other requests.
|
virtual |
Represents the success of a job as returned to the pipeline by a job worker. Only used for custom actions.
|
virtual |
Represents the success of a job as returned to the pipeline by a job worker. Only used for custom actions.
Queues the request into a thread executor and triggers associated callback when operation has finished.
|
virtual |
Represents the success of a job as returned to the pipeline by a job worker. Only used for custom actions.
returns a future to the operation so that it can be executed in parallel to other requests.
|
virtual |
Represents the failure of a third party job as returned to the pipeline by a job worker. Only used for partner actions.
|
virtual |
Represents the failure of a third party job as returned to the pipeline by a job worker. Only used for partner actions.
Queues the request into a thread executor and triggers associated callback when operation has finished.
|
virtual |
Represents the failure of a third party job as returned to the pipeline by a job worker. Only used for partner actions.
returns a future to the operation so that it can be executed in parallel to other requests.
|
virtual |
Represents the success of a third party job as returned to the pipeline by a job worker. Only used for partner actions.
|
virtual |
Represents the success of a third party job as returned to the pipeline by a job worker. Only used for partner actions.
Queues the request into a thread executor and triggers associated callback when operation has finished.
|
virtual |
Represents the success of a third party job as returned to the pipeline by a job worker. Only used for partner actions.
returns a future to the operation so that it can be executed in parallel to other requests.
|
virtual |
Resumes the pipeline execution by retrying the last failed actions in a stage.
|
virtual |
Resumes the pipeline execution by retrying the last failed actions in a stage.
Queues the request into a thread executor and triggers associated callback when operation has finished.
|
virtual |
Resumes the pipeline execution by retrying the last failed actions in a stage.
returns a future to the operation so that it can be executed in parallel to other requests.
|
virtual |
Starts the specified pipeline. Specifically, it begins processing the latest commit to the source location specified as part of the pipeline.
|
virtual |
Starts the specified pipeline. Specifically, it begins processing the latest commit to the source location specified as part of the pipeline.
Queues the request into a thread executor and triggers associated callback when operation has finished.
|
virtual |
Starts the specified pipeline. Specifically, it begins processing the latest commit to the source location specified as part of the pipeline.
returns a future to the operation so that it can be executed in parallel to other requests.
|
virtual |
Updates a specified pipeline with edits or changes to its structure. Use a JSON file with the pipeline structure in conjunction with UpdatePipeline to provide the full structure of the pipeline. Updating the pipeline increases the version number of the pipeline by 1.
|
virtual |
Updates a specified pipeline with edits or changes to its structure. Use a JSON file with the pipeline structure in conjunction with UpdatePipeline to provide the full structure of the pipeline. Updating the pipeline increases the version number of the pipeline by 1.
Queues the request into a thread executor and triggers associated callback when operation has finished.
|
virtual |
Updates a specified pipeline with edits or changes to its structure. Use a JSON file with the pipeline structure in conjunction with UpdatePipeline to provide the full structure of the pipeline. Updating the pipeline increases the version number of the pipeline by 1.
returns a future to the operation so that it can be executed in parallel to other requests.
1.8.11
