Package-level declarations

Types

Link copied to clipboard

Overview

Properties

Link copied to clipboard
const val SdkVersion: String
Link copied to clipboard
Link copied to clipboard
const val ServiceId: String

Functions

Link copied to clipboard

Returns information about a specified job and whether that job has been received by the job worker. Used for custom actions only.

Link copied to clipboard

Confirms a job worker has received the specified job. Used for partner actions only.

Link copied to clipboard

Creates a new custom action that can be used in all pipelines associated with the Amazon Web Services account. Only used for custom actions.

Link copied to clipboard

Creates a pipeline.

Link copied to clipboard

Marks a custom action as deleted. PollForJobs for the custom action fails after the action is marked for deletion. Used for custom actions only.

Link copied to clipboard

Deletes the specified pipeline.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

Returns information about a job. Used for custom actions only.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

Requests the details of a job for a third party action. Used for partner actions only.

Link copied to clipboard

Lists the action executions that have occurred in a pipeline.

Link copied to clipboard

Gets a summary of all CodePipeline action types associated with your account.

Link copied to clipboard

Gets a summary of the most recent executions for a pipeline.

Link copied to clipboard

Gets a summary of all of the pipelines associated with your account.

Link copied to clipboard

Gets the set of key-value pairs (metadata) that are used to manage the resource.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

Determines whether there are any third party jobs for a job worker to act on. Used for partner actions only.

Link copied to clipboard

Provides information to CodePipeline about new revisions to a source.

Link copied to clipboard

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

Link copied to clipboard

Represents the failure of a job as returned to the pipeline by a job worker. Used for custom actions only.

Link copied to clipboard

Represents the success of a job as returned to the pipeline by a job worker. Used for custom actions only.

Link copied to clipboard

Represents the failure of a third party job as returned to the pipeline by a job worker. Used for partner actions only.

Link copied to clipboard

Represents the success of a third party job as returned to the pipeline by a job worker. Used for partner actions only.

Link copied to clipboard
inline suspend fun CodePipelineClient.putWebhook(crossinline block: PutWebhookRequest.Builder.() -> Unit): PutWebhookResponse

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.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.

Link copied to clipboard

Removes tags from an Amazon Web Services resource.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.