CodePipelineClient Class

Member Function Documentation

CodePipelineClient::CodePipelineClient(const QtAws::Core::AwsRegion::Region region = QtAws::Core::AwsRegion::InvalidRegion, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

Constructs a CodePipelineClient object.

The new client object will region, credentials, and manager for network operations.

The new object will be owned by parent, if set.

CodePipelineClient::CodePipelineClient(const QUrl &endpoint, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

This function overloads CodePipelineClient().

This overload allows the caller to specify the specific endpoint to send requests to. Typically, it is easier to use the alternative constructor, which allows the caller to specify an AWS region instead, in which case this client will determine the correct endpoint for the given region automatically (via AwsEndpoint::getEndpoint).

See also QtAws::Core::AwsEndpoint::getEndpoint.

[slot] AcknowledgeJobResponse *CodePipelineClient::acknowledgeJob(const AcknowledgeJobRequest &request)

Sends request to the CodePipelineClient service, and returns a pointer to an AcknowledgeJobResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns information about a specified job and whether that job has been received by the job worker. Only used for custom

[slot] AcknowledgeThirdPartyJobResponse *CodePipelineClient::acknowledgeThirdPartyJob(const AcknowledgeThirdPartyJobRequest &request)

Sends request to the CodePipelineClient service, and returns a pointer to an AcknowledgeThirdPartyJobResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Confirms a job worker has received the specified job. Only used for partner

[slot] CreateCustomActionTypeResponse *CodePipelineClient::createCustomActionType(const CreateCustomActionTypeRequest &request)

Sends request to the CodePipelineClient service, and returns a pointer to an CreateCustomActionTypeResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates a new custom action that can be used in all pipelines associated with the AWS account. Only used for custom

[slot] CreatePipelineResponse *CodePipelineClient::createPipeline(const CreatePipelineRequest &request)

Sends request to the CodePipelineClient service, and returns a pointer to an CreatePipelineResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates a

[slot] DeleteCustomActionTypeResponse *CodePipelineClient::deleteCustomActionType(const DeleteCustomActionTypeRequest &request)

Sends request to the CodePipelineClient service, and returns a pointer to an DeleteCustomActionTypeResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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> <b>

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

[slot] DeletePipelineResponse *CodePipelineClient::deletePipeline(const DeletePipelineRequest &request)

Sends request to the CodePipelineClient service, and returns a pointer to an DeletePipelineResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes the specified

[slot] DeleteWebhookResponse *CodePipelineClient::deleteWebhook(const DeleteWebhookRequest &request)

Sends request to the CodePipelineClient service, and returns a pointer to an DeleteWebhookResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes a previously created webhook by name. Deleting the webhook stops AWS CodePipeline from starting a pipeline every time an external event occurs. The API will return 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

[slot] DeregisterWebhookWithThirdPartyResponse *CodePipelineClient::deregisterWebhookWithThirdParty(const DeregisterWebhookWithThirdPartyRequest &request)

Sends request to the CodePipelineClient service, and returns a pointer to an DeregisterWebhookWithThirdPartyResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Removes the connection between the webhook that was created by CodePipeline and the external tool with events to be detected. Currently only supported for webhooks that target an action type of

[slot] DisableStageTransitionResponse *CodePipelineClient::disableStageTransition(const DisableStageTransitionRequest &request)

Sends request to the CodePipelineClient service, and returns a pointer to an DisableStageTransitionResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Prevents artifacts in a pipeline from transitioning to the next stage in the

[slot] EnableStageTransitionResponse *CodePipelineClient::enableStageTransition(const EnableStageTransitionRequest &request)

Sends request to the CodePipelineClient service, and returns a pointer to an EnableStageTransitionResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Enables artifacts in a pipeline to transition to a stage in a

[slot] GetJobDetailsResponse *CodePipelineClient::getJobDetails(const GetJobDetailsRequest &request)

Sends request to the CodePipelineClient service, and returns a pointer to an GetJobDetailsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns information about a job. Only used for custom

actions> <b>

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

[slot] GetPipelineResponse *CodePipelineClient::getPipeline(const GetPipelineRequest &request)

Sends request to the CodePipelineClient service, and returns a pointer to an GetPipelineResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] GetPipelineExecutionResponse *CodePipelineClient::getPipelineExecution(const GetPipelineExecutionRequest &request)

Sends request to the CodePipelineClient service, and returns a pointer to an GetPipelineExecutionResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns information about an execution of a pipeline, including details about artifacts, the pipeline execution ID, and the name, version, and status of the

[slot] GetPipelineStateResponse *CodePipelineClient::getPipelineState(const GetPipelineStateRequest &request)

Sends request to the CodePipelineClient service, and returns a pointer to an GetPipelineStateResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns information about the state of a pipeline, including the stages and

[slot] GetThirdPartyJobDetailsResponse *CodePipelineClient::getThirdPartyJobDetails(const GetThirdPartyJobDetailsRequest &request)

Sends request to the CodePipelineClient service, and returns a pointer to an GetThirdPartyJobDetailsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Requests the details of a job for a third party action. Only used for partner

actions> <b>

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

[slot] ListActionTypesResponse *CodePipelineClient::listActionTypes(const ListActionTypesRequest &request)

Sends request to the CodePipelineClient service, and returns a pointer to an ListActionTypesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Gets a summary of all AWS CodePipeline action types associated with your

[slot] ListPipelineExecutionsResponse *CodePipelineClient::listPipelineExecutions(const ListPipelineExecutionsRequest &request)

Sends request to the CodePipelineClient service, and returns a pointer to an ListPipelineExecutionsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Gets a summary of the most recent executions for a

[slot] ListPipelinesResponse *CodePipelineClient::listPipelines(const ListPipelinesRequest &request)

Sends request to the CodePipelineClient service, and returns a pointer to an ListPipelinesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Gets a summary of all of the pipelines associated with your

[slot] ListWebhooksResponse *CodePipelineClient::listWebhooks(const ListWebhooksRequest &request)

Sends request to the CodePipelineClient service, and returns a pointer to an ListWebhooksResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Gets a listing of all the webhooks in this region for this account. The output lists all webhooks and includes the webhook URL and ARN, as well the configuration for each

[slot] PollForJobsResponse *CodePipelineClient::pollForJobs(const PollForJobsRequest &request)

Sends request to the CodePipelineClient service, and returns a pointer to an PollForJobsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns information about any jobs for AWS CodePipeline to act upon. PollForJobs is only valid 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> <b>

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

[slot] PollForThirdPartyJobsResponse *CodePipelineClient::pollForThirdPartyJobs(const PollForThirdPartyJobsRequest &request)

Sends request to the CodePipelineClient service, and returns a pointer to an PollForThirdPartyJobsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Determines whether there are any third party jobs for a job worker to act on. Only used for partner

actions> <b>

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

[slot] PutActionRevisionResponse *CodePipelineClient::putActionRevision(const PutActionRevisionRequest &request)

Sends request to the CodePipelineClient service, and returns a pointer to an PutActionRevisionResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Provides information to AWS CodePipeline about new revisions to a

[slot] PutApprovalResultResponse *CodePipelineClient::putApprovalResult(const PutApprovalResultRequest &request)

Sends request to the CodePipelineClient service, and returns a pointer to an PutApprovalResultResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Provides the response to a manual approval request to AWS CodePipeline. Valid responses include Approved and

[slot] PutJobFailureResultResponse *CodePipelineClient::putJobFailureResult(const PutJobFailureResultRequest &request)

Sends request to the CodePipelineClient service, and returns a pointer to an PutJobFailureResultResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Represents the failure of a job as returned to the pipeline by a job worker. Only used for custom

[slot] PutJobSuccessResultResponse *CodePipelineClient::putJobSuccessResult(const PutJobSuccessResultRequest &request)

Sends request to the CodePipelineClient service, and returns a pointer to an PutJobSuccessResultResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Represents the success of a job as returned to the pipeline by a job worker. Only used for custom

[slot] PutThirdPartyJobFailureResultResponse *CodePipelineClient::putThirdPartyJobFailureResult(const PutThirdPartyJobFailureResultRequest &request)

Sends request to the CodePipelineClient service, and returns a pointer to an PutThirdPartyJobFailureResultResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Represents the failure of a third party job as returned to the pipeline by a job worker. Only used for partner

[slot] PutThirdPartyJobSuccessResultResponse *CodePipelineClient::putThirdPartyJobSuccessResult(const PutThirdPartyJobSuccessResultRequest &request)

Sends request to the CodePipelineClient service, and returns a pointer to an PutThirdPartyJobSuccessResultResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Represents the success of a third party job as returned to the pipeline by a job worker. Only used for partner

[slot] PutWebhookResponse *CodePipelineClient::putWebhook(const PutWebhookRequest &request)

Sends request to the CodePipelineClient service, and returns a pointer to an PutWebhookResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] RegisterWebhookWithThirdPartyResponse *CodePipelineClient::registerWebhookWithThirdParty(const RegisterWebhookWithThirdPartyRequest &request)

Sends request to the CodePipelineClient service, and returns a pointer to an RegisterWebhookWithThirdPartyResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Configures a connection between the webhook that was created and the external tool with events to be

[slot] RetryStageExecutionResponse *CodePipelineClient::retryStageExecution(const RetryStageExecutionRequest &request)

Sends request to the CodePipelineClient service, and returns a pointer to an RetryStageExecutionResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Resumes the pipeline execution by retrying the last failed actions in a

[slot] StartPipelineExecutionResponse *CodePipelineClient::startPipelineExecution(const StartPipelineExecutionRequest &request)

Sends request to the CodePipelineClient service, and returns a pointer to an StartPipelineExecutionResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Starts the specified pipeline. Specifically, it begins processing the latest commit to the source location specified as part of the

[slot] UpdatePipelineResponse *CodePipelineClient::updatePipeline(const UpdatePipelineRequest &request)

Sends request to the CodePipelineClient service, and returns a pointer to an UpdatePipelineResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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