AWS CodePipeline
CodePipeline Overview This is the CodePipeline API Reference. This guide provides descriptions of the actions and data types for CodePipeline. Some…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
CodePipeline
Overview
This is the CodePipeline API Reference. This guide provides descriptions
of the actions and data types for CodePipeline. Some functionality for your
pipeline can only be configured through the API. For more information, see the
CodePipeline User Guide .
You can use the CodePipeline API to work with pipelines, stages, actions,
and transitions.
Pipelines are models of automated release processes. Each pipeline
is uniquely named, and consists of stages, actions, and transitions.
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 the pipeline
structure and pipeline metadata, including the pipeline Amazon Resource Name
(ARN).
GetPipelineExecution , which returns information about a
specific execution of a pipeline.
GetPipelineState , which returns information about the current
state of the stages and actions of a pipeline.
ListActionExecutions , which returns action-level details
for past executions. The details include full stage and action-level details,
including individual action duration, status, any errors that occurred during
the execution, and input and output artifact location details.
ListPipelines , which gets a summary of all of the pipelines
associated with your account.
ListPipelineExecutions , which gets a summary of the most
recent executions for a pipeline.
StartPipelineExecution , which runs the most recent revision of
an artifact through the pipeline.
StopPipelineExecution , which stops the specified pipeline
execution from continuing through the pipeline.
UpdatePipeline , which updates a pipeline with edits or changes
to the structure of the pipeline.
Pipelines include stages . Each stage contains one or more
actions that must complete before the next stage begins. A stage results in success or
failure. If a stage fails, the pipeline stops at that stage and remains stopped until
either a new version of an artifact appears in the source location, or a user takes
action to rerun 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, see
CodePipeline
Pipeline Structure Reference .
Pipeline stages include actions that are categorized into
categories such as source or build actions performed in 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 . Valid
action categories are:
Source
Build
Test
Deploy
Approval
Invoke
Compute
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 CodePipeline
For third-party integrators or developers who want to create their own integrations
with CodePipeline, the expected sequence varies from the standard API user. To
integrate with CodePipeline, developers 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.
…
Endpoints 44
- POSTAcknowledge job
/#X-Amz-Target=CodePipeline_20150709.AcknowledgeJobReturns information about a specified job and whether that job has been received by the job worker. Used for custom actions only. - POSTAcknowledge third party job
/#X-Amz-Target=CodePipeline_20150709.AcknowledgeThirdPartyJobConfirms a job worker has received the specified job. Used for partner actions only. - POSTCreate custom action type
/#X-Amz-Target=CodePipeline_20150709.CreateCustomActionTypeCreates a new custom action that can be used in all pipelines associated with the Amazon Web Services account. Only used for custom actions. - POSTCreate pipeline
/#X-Amz-Target=CodePipeline_20150709.CreatePipelineCreates a pipeline. In the pipeline structure, you must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you… - POSTDelete custom action type
/#X-Amz-Target=CodePipeline_20150709.DeleteCustomActionTypeMarks 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… - POSTDelete pipeline
/#X-Amz-Target=CodePipeline_20150709.DeletePipelineDeletes the specified pipeline. - POSTDelete webhook
/#X-Amz-Target=CodePipeline_20150709.DeleteWebhookDeletes a previously created webhook by name. Deleting the webhook stops CodePipeline from starting a pipeline every time an external event occurs. The API… - POSTDeregister webhook with third party
/#X-Amz-Target=CodePipeline_20150709.DeregisterWebhookWithThirdPartyRemoves the connection between the webhook that was created by CodePipeline and the external tool with events to be detected. Currently supported only for… - POSTDisable stage transition
/#X-Amz-Target=CodePipeline_20150709.DisableStageTransitionPrevents artifacts in a pipeline from transitioning to the next stage in the pipeline. - POSTEnable stage transition
/#X-Amz-Target=CodePipeline_20150709.EnableStageTransitionEnables artifacts in a pipeline to transition to a stage in a pipeline. - POSTGet action type
/#X-Amz-Target=CodePipeline_20150709.GetActionTypeReturns 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… - POSTGet job details
/#X-Amz-Target=CodePipeline_20150709.GetJobDetailsReturns information about a job. Used for custom actions only. When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to… - POSTGet pipeline
/#X-Amz-Target=CodePipeline_20150709.GetPipelineReturns 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… - POSTGet pipeline execution
/#X-Amz-Target=CodePipeline_20150709.GetPipelineExecutionReturns information about an execution of a pipeline, including details about artifacts, the pipeline execution ID, and the name, version, and status of the… - POSTGet pipeline state
/#X-Amz-Target=CodePipeline_20150709.GetPipelineStateReturns information about the state of a pipeline, including the stages and actions. Values returned in the revisionId and revisionUrl fields indicate the… - POSTGet third party job details
/#X-Amz-Target=CodePipeline_20150709.GetThirdPartyJobDetailsRequests 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… - POSTList action executions
/#X-Amz-Target=CodePipeline_20150709.ListActionExecutionsLists the action executions that have occurred in a pipeline. - POSTList action types
/#X-Amz-Target=CodePipeline_20150709.ListActionTypesGets a summary of all CodePipeline action types associated with your account. - POSTList deploy action execution targets
/#X-Amz-Target=CodePipeline_20150709.ListDeployActionExecutionTargetsLists the targets for the deploy action. - POSTList pipeline executions
/#X-Amz-Target=CodePipeline_20150709.ListPipelineExecutionsGets 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… - POSTList pipelines
/#X-Amz-Target=CodePipeline_20150709.ListPipelinesGets a summary of all of the pipelines associated with your account. - POSTList rule executions
/#X-Amz-Target=CodePipeline_20150709.ListRuleExecutionsLists the rule executions that have occurred in a pipeline configured for conditions with rules. - POSTList rule types
/#X-Amz-Target=CodePipeline_20150709.ListRuleTypesLists the rules for the condition. For more information about conditions, see Stage conditions and How do stage conditions work? .For more information about… - POSTList tags for resource
/#X-Amz-Target=CodePipeline_20150709.ListTagsForResourceGets the set of key-value pairs (metadata) that are used to manage the resource. - POSTList webhooks
/#X-Amz-Target=CodePipeline_20150709.ListWebhooksGets 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… - POSTOverride stage condition
/#X-Amz-Target=CodePipeline_20150709.OverrideStageConditionUsed to override a stage condition. For more information about conditions, see Stage conditions and How do stage conditions work? . - POSTPoll for jobs
/#X-Amz-Target=CodePipeline_20150709.PollForJobsReturns 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… - POSTPoll for third party jobs
/#X-Amz-Target=CodePipeline_20150709.PollForThirdPartyJobsDetermines 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… - POSTPut action revision
/#X-Amz-Target=CodePipeline_20150709.PutActionRevisionProvides information to CodePipeline about new revisions to a source. - POSTPut approval result
/#X-Amz-Target=CodePipeline_20150709.PutApprovalResultProvides the response to a manual approval request to CodePipeline. Valid responses include Approved and Rejected. - POSTPut job failure result
/#X-Amz-Target=CodePipeline_20150709.PutJobFailureResultRepresents the failure of a job as returned to the pipeline by a job worker. Used for custom actions only. - POSTPut job success result
/#X-Amz-Target=CodePipeline_20150709.PutJobSuccessResultRepresents the success of a job as returned to the pipeline by a job worker. Used for custom actions only. - POSTPut third party job failure result
/#X-Amz-Target=CodePipeline_20150709.PutThirdPartyJobFailureResultRepresents the failure of a third party job as returned to the pipeline by a job worker. Used for partner actions only. - POSTPut third party job success result
/#X-Amz-Target=CodePipeline_20150709.PutThirdPartyJobSuccessResultRepresents the success of a third party job as returned to the pipeline by a job worker. Used for partner actions only. - POSTPut webhook
/#X-Amz-Target=CodePipeline_20150709.PutWebhookDefines 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… - POSTRegister webhook with third party
/#X-Amz-Target=CodePipeline_20150709.RegisterWebhookWithThirdPartyConfigures a connection between the webhook that was created and the external tool with events to be detected. - POSTRetry stage execution
/#X-Amz-Target=CodePipeline_20150709.RetryStageExecutionYou 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… - POSTRollback stage
/#X-Amz-Target=CodePipeline_20150709.RollbackStageRolls back a stage execution. - POSTStart pipeline execution
/#X-Amz-Target=CodePipeline_20150709.StartPipelineExecutionStarts the specified pipeline. Specifically, it begins processing the latest commit to the source location specified as part of the pipeline. - POSTStop pipeline execution
/#X-Amz-Target=CodePipeline_20150709.StopPipelineExecutionStops the specified pipeline execution. You choose to either stop the pipeline execution by completing in-progress actions without starting subsequent… - POSTTag resource
/#X-Amz-Target=CodePipeline_20150709.TagResourceAdds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource. - POSTUntag resource
/#X-Amz-Target=CodePipeline_20150709.UntagResourceRemoves tags from an Amazon Web Services resource. - POSTUpdate action type
/#X-Amz-Target=CodePipeline_20150709.UpdateActionTypeUpdates 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.… - POSTUpdate pipeline
/#X-Amz-Target=CodePipeline_20150709.UpdatePipelineUpdates a specified pipeline with edits or changes to its structure. Use a JSON file with the pipeline structure and UpdatePipeline to provide the full…
API details
- Base URL
https://codepipeline.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 44 operations on 44 pathsPOST 44
- Description format
- AWS Smithy model, API version
2015-07-09 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the AWS CodePipeline in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the AWS CodePipeline collection, without the publisher's secrets.
- Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Acknowledge job” (POST /#X-Amz-Target=CodePipeline_20150709.AcknowledgeJob), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the AWS CodePipeline?
CodePipeline Overview This is the CodePipeline API Reference. This guide provides descriptions of the actions and data types for CodePipeline. Some… It is listed under Developer tools and has 44 endpoints.
Who publishes the AWS CodePipeline?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the AWS CodePipeline?
Requests go to https://codepipeline.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the AWS CodePipeline?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the AWS CodePipeline have?
44 operations on 44 paths (44 POST).
Is forking the AWS CodePipeline free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.