AWS Fundamentals Logo
AWS Fundamentals
aws codepipeline

AWS AWS CodePipeline CLI Commands

44 CLI commands available for AWS CodePipeline.

CommandSample
acknowledge-job

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

acknowledge-third-party-job

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

create-custom-action-type

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

create-pipeline

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.

delete-custom-action-type

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 i

delete-pipeline

Deletes the specified pipeline.

delete-webhook

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

deregister-webhook-with-third-party

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.

disable-stage-transition

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

enable-stage-transition

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

get-action-type

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.

get-job-details

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 sec

get-pipeline

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.

get-pipeline-execution

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.

get-pipeline-state

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.

get-third-party-job-details

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

list-action-executions

Lists the action executions that have occurred in a pipeline.

list-action-types

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

list-deploy-action-execution-targets

Lists the targets for the deploy action.

list-pipeline-executions

Gets a summary of the most recent executions for a pipeline. When applying the filter for pipeline executions that have succeeded in the stage, the operation returns all executions in the current pipeline version beginning on February 1, 2024.

list-pipelines

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

list-rule-executions

Lists the rule executions that have occurred in a pipeline configured for conditions with rules.

list-rule-types

Lists the rules for the condition. For more information about conditions, see Stage conditions and How do stage conditions work?.For more information about rules, see the CodePipeline rule reference.

list-tags-for-resource

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

list-webhooks

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. If a secret token was provided, it will be redacted in the response.

override-stage-condition

Used to override a stage condition. For more information about conditions, see Stage conditions and How do stage conditions work?.

poll-for-jobs

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 tempor

poll-for-third-party-jobs

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 o

put-action-revision

Provides information to CodePipeline about new revisions to a source.

put-approval-result

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

put-job-failure-result

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

put-job-success-result

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

put-third-party-job-failure-result

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

put-third-party-job-success-result

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

put-webhook

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 th

register-webhook-with-third-party

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

retry-stage-execution

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

rollback-stage

Rolls back a stage execution.

start-pipeline-execution

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

stop-pipeline-execution

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

tag-resource

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

untag-resource

Removes tags from an Amazon Web Services resource.

update-action-type

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.

update-pipeline

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.

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Stats

Total Commands44
ServiceCodePipeline