Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

CodePipeline

import { CodePipeline } from "https://aws-api.deno.dev/v0.4/services/codepipeline.ts?docs=full";
class CodePipeline {
constructor(apiFactory: client.ApiFactory);
async acknowledgeJob(params: AcknowledgeJobInput, opts?: client.RequestOptions): Promise<AcknowledgeJobOutput>;
async acknowledgeThirdPartyJob(params: AcknowledgeThirdPartyJobInput, opts?: client.RequestOptions): Promise<AcknowledgeThirdPartyJobOutput>;
async createCustomActionType(params: CreateCustomActionTypeInput, opts?: client.RequestOptions): Promise<CreateCustomActionTypeOutput>;
async createPipeline(params: CreatePipelineInput, opts?: client.RequestOptions): Promise<CreatePipelineOutput>;
async deleteCustomActionType(params: DeleteCustomActionTypeInput, opts?: client.RequestOptions): Promise<void>;
async deletePipeline(params: DeletePipelineInput, opts?: client.RequestOptions): Promise<void>;
async deleteWebhook(params: DeleteWebhookInput, opts?: client.RequestOptions): Promise<void>;
async deregisterWebhookWithThirdParty(params?: DeregisterWebhookWithThirdPartyInput, opts?: client.RequestOptions): Promise<void>;
async disableStageTransition(params: DisableStageTransitionInput, opts?: client.RequestOptions): Promise<void>;
async enableStageTransition(params: EnableStageTransitionInput, opts?: client.RequestOptions): Promise<void>;
async getActionType(params: GetActionTypeInput, opts?: client.RequestOptions): Promise<GetActionTypeOutput>;
async getJobDetails(params: GetJobDetailsInput, opts?: client.RequestOptions): Promise<GetJobDetailsOutput>;
async getPipeline(params: GetPipelineInput, opts?: client.RequestOptions): Promise<GetPipelineOutput>;
async getPipelineExecution(params: GetPipelineExecutionInput, opts?: client.RequestOptions): Promise<GetPipelineExecutionOutput>;
async getPipelineState(params: GetPipelineStateInput, opts?: client.RequestOptions): Promise<GetPipelineStateOutput>;
async getThirdPartyJobDetails(params: GetThirdPartyJobDetailsInput, opts?: client.RequestOptions): Promise<GetThirdPartyJobDetailsOutput>;
async listActionExecutions(params: ListActionExecutionsInput, opts?: client.RequestOptions): Promise<ListActionExecutionsOutput>;
async listActionTypes(params?: ListActionTypesInput, opts?: client.RequestOptions): Promise<ListActionTypesOutput>;
async listPipelineExecutions(params: ListPipelineExecutionsInput, opts?: client.RequestOptions): Promise<ListPipelineExecutionsOutput>;
async listPipelines(params?: ListPipelinesInput, opts?: client.RequestOptions): Promise<ListPipelinesOutput>;
async listTagsForResource(params: ListTagsForResourceInput, opts?: client.RequestOptions): Promise<ListTagsForResourceOutput>;
async listWebhooks(params?: ListWebhooksInput, opts?: client.RequestOptions): Promise<ListWebhooksOutput>;
async pollForJobs(params: PollForJobsInput, opts?: client.RequestOptions): Promise<PollForJobsOutput>;
async pollForThirdPartyJobs(params: PollForThirdPartyJobsInput, opts?: client.RequestOptions): Promise<PollForThirdPartyJobsOutput>;
async putActionRevision(params: PutActionRevisionInput, opts?: client.RequestOptions): Promise<PutActionRevisionOutput>;
async putApprovalResult(params: PutApprovalResultInput, opts?: client.RequestOptions): Promise<PutApprovalResultOutput>;
async putJobFailureResult(params: PutJobFailureResultInput, opts?: client.RequestOptions): Promise<void>;
async putJobSuccessResult(params: PutJobSuccessResultInput, opts?: client.RequestOptions): Promise<void>;
async putThirdPartyJobFailureResult(params: PutThirdPartyJobFailureResultInput, opts?: client.RequestOptions): Promise<void>;
async putThirdPartyJobSuccessResult(params: PutThirdPartyJobSuccessResultInput, opts?: client.RequestOptions): Promise<void>;
async putWebhook(params: PutWebhookInput, opts?: client.RequestOptions): Promise<PutWebhookOutput>;
async registerWebhookWithThirdParty(params?: RegisterWebhookWithThirdPartyInput, opts?: client.RequestOptions): Promise<void>;
async retryStageExecution(params: RetryStageExecutionInput, opts?: client.RequestOptions): Promise<RetryStageExecutionOutput>;
async startPipelineExecution(params: StartPipelineExecutionInput, opts?: client.RequestOptions): Promise<StartPipelineExecutionOutput>;
async stopPipelineExecution(params: StopPipelineExecutionInput, opts?: client.RequestOptions): Promise<StopPipelineExecutionOutput>;
async tagResource(params: TagResourceInput, opts?: client.RequestOptions): Promise<void>;
async untagResource(params: UntagResourceInput, opts?: client.RequestOptions): Promise<void>;
async updateActionType(params: UpdateActionTypeInput, opts?: client.RequestOptions): Promise<void>;
async updatePipeline(params: UpdatePipelineInput, opts?: client.RequestOptions): Promise<UpdatePipelineOutput>;
 
static ApiMetadata: client.ApiMetadata;
}

§Constructors

§
new CodePipeline(apiFactory: client.ApiFactory)
[src]

§Methods

§
acknowledgeJob(params: AcknowledgeJobInput, opts?: client.RequestOptions): Promise<AcknowledgeJobOutput>
[src]

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

§

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

§

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

§
createPipeline(params: CreatePipelineInput, opts?: client.RequestOptions): Promise<CreatePipelineOutput>
[src]

Creates a pipeline.

Note: 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.

§
deleteCustomActionType(params: DeleteCustomActionTypeInput, opts?: client.RequestOptions): Promise<void>
[src]

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

! IMPORTANT: ! 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.

§
deletePipeline(params: DeletePipelineInput, opts?: client.RequestOptions): Promise<void>
[src]

Deletes the specified pipeline.

§
deleteWebhook(params: DeleteWebhookInput, opts?: client.RequestOptions): Promise<void>
[src]

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

§
deregisterWebhookWithThirdParty(params?: DeregisterWebhookWithThirdPartyInput, opts?: client.RequestOptions): Promise<void>
[src]

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.

§
disableStageTransition(params: DisableStageTransitionInput, opts?: client.RequestOptions): Promise<void>
[src]

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

§
enableStageTransition(params: EnableStageTransitionInput, opts?: client.RequestOptions): Promise<void>
[src]

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

§
getActionType(params: GetActionTypeInput, opts?: client.RequestOptions): Promise<GetActionTypeOutput>
[src]

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.

§
getJobDetails(params: GetJobDetailsInput, opts?: client.RequestOptions): Promise<GetJobDetailsOutput>
[src]

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

! IMPORTANT: ! When this API is called, AWS 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.

§
getPipeline(params: GetPipelineInput, opts?: client.RequestOptions): Promise<GetPipelineOutput>
[src]

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 information about an execution of a pipeline, including details about artifacts, the pipeline execution ID, and the name, version, and status of the pipeline.

§
getPipelineState(params: GetPipelineStateInput, opts?: client.RequestOptions): Promise<GetPipelineStateOutput>
[src]

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

Note: Values returned in the revisionId and revisionUrl fields indicate the source revision information, such as the commit ID, for the current state.

§

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

! IMPORTANT: ! When this API is called, AWS 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.

§

Lists the action executions that have occurred in a pipeline.

§
listActionTypes(params?: ListActionTypesInput, opts?: client.RequestOptions): Promise<ListActionTypesOutput>
[src]

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

§

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

§
listPipelines(params?: ListPipelinesInput, opts?: client.RequestOptions): Promise<ListPipelinesOutput>
[src]

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

§

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

§
listWebhooks(params?: ListWebhooksInput, opts?: client.RequestOptions): Promise<ListWebhooksOutput>
[src]

Gets a listing of all the webhooks in this AWS Region for this account. The output lists all webhooks and includes the webhook URL and ARN and the configuration for each webhook.

§
pollForJobs(params: PollForJobsInput, opts?: client.RequestOptions): Promise<PollForJobsOutput>
[src]

Returns information about any jobs for AWS 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.

! IMPORTANT: ! When this API is called, AWS 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.

§

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

! IMPORTANT: ! When this API is called, AWS 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.

§

Provides information to AWS CodePipeline about new revisions to a source.

§

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

§
putJobFailureResult(params: PutJobFailureResultInput, opts?: client.RequestOptions): Promise<void>
[src]

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

§
putJobSuccessResult(params: PutJobSuccessResultInput, opts?: client.RequestOptions): Promise<void>
[src]

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

§
putThirdPartyJobFailureResult(params: PutThirdPartyJobFailureResultInput, opts?: client.RequestOptions): Promise<void>
[src]

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

§
putThirdPartyJobSuccessResult(params: PutThirdPartyJobSuccessResultInput, opts?: client.RequestOptions): Promise<void>
[src]

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

§
putWebhook(params: PutWebhookInput, opts?: client.RequestOptions): Promise<PutWebhookOutput>
[src]

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.

§
registerWebhookWithThirdParty(params?: RegisterWebhookWithThirdPartyInput, opts?: client.RequestOptions): Promise<void>
[src]

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

§

Resumes the pipeline execution by retrying the last failed actions in a stage. You can retry a stage immediately if any of the actions in the stage fail. When you retry, all actions that are still in progress continue working, and failed actions are triggered again.

§

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

§

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.

§
tagResource(params: TagResourceInput, opts?: client.RequestOptions): Promise<void>
[src]

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

§
untagResource(params: UntagResourceInput, opts?: client.RequestOptions): Promise<void>
[src]

Removes tags from an AWS resource.

§
updateActionType(params: UpdateActionTypeInput, opts?: client.RequestOptions): Promise<void>
[src]

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.

§
updatePipeline(params: UpdatePipelineInput, opts?: client.RequestOptions): Promise<UpdatePipelineOutput>
[src]

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.

§Static Properties