\nOverview\n
\nThis is the CodePipeline API Reference. This guide provides descriptions\nof the actions and data types for CodePipeline. Some functionality for your\npipeline can only be configured through the API. For more information, see the CodePipeline User Guide.
\nYou can use the CodePipeline API to work with pipelines, stages, actions,\nand transitions.
\n\nPipelines are models of automated release processes. Each pipeline\nis uniquely named, and consists of stages, actions, and transitions.
\nYou can work with pipelines by calling:
\n\nCreatePipeline, which creates a uniquely named\npipeline.
\n\nDeletePipeline, which deletes the specified\npipeline.
\n\nGetPipeline, which returns information about the pipeline\nstructure and pipeline metadata, including the pipeline Amazon Resource Name\n(ARN).
\n\nGetPipelineExecution, which returns information about a\nspecific execution of a pipeline.
\n\nGetPipelineState, which returns information about the current\nstate of the stages and actions of a pipeline.
\n\nListActionExecutions, which returns action-level details\nfor past executions. The details include full stage and action-level details,\nincluding individual action duration, status, any errors that occurred during\nthe execution, and input and output artifact location details.
\n\nListPipelines, which gets a summary of all of the pipelines\nassociated with your account.
\n\nListPipelineExecutions, which gets a summary of the most\nrecent executions for a pipeline.
\n\nStartPipelineExecution, which runs the most recent revision of\nan artifact through the pipeline.
\n\nStopPipelineExecution, which stops the specified pipeline\nexecution from continuing through the pipeline.
\n\nUpdatePipeline, which updates a pipeline with edits or changes\nto the structure of the pipeline.
\nPipelines include stages. Each stage contains one or more\nactions that must complete before the next stage begins. A stage results in success or\nfailure. If a stage fails, the pipeline stops at that stage and remains stopped until\neither a new version of an artifact appears in the source location, or a user takes\naction to rerun the most recent artifact through the pipeline. You can call GetPipelineState, which displays the status of a pipeline, including the\nstatus of stages in the pipeline, or GetPipeline, which returns the\nentire structure of the pipeline, including the stages of that pipeline. For more\ninformation about the structure of stages and actions, see CodePipeline\nPipeline Structure Reference.
\nPipeline stages include actions that are categorized into\ncategories such as source or build actions performed in a stage of a pipeline. For\nexample, you can use a source action to import artifacts into a pipeline from a source\nsuch as Amazon S3. Like stages, you do not work with actions directly in most cases, but\nyou do define and interact with actions when working with pipeline operations such as\nCreatePipeline and GetPipelineState. Valid\naction categories are:
\nSource
\nBuild
\nTest
\nDeploy
\nApproval
\nInvoke
\nCompute
\nPipelines also include transitions, which allow the transition\nof artifacts from one stage to the next in a pipeline after the actions in one stage\ncomplete.
\nYou can work with transitions by calling:
\n\nDisableStageTransition, which prevents artifacts from\ntransitioning to the next stage in a pipeline.
\n\nEnableStageTransition, which enables transition of artifacts\nbetween stages in a pipeline.
\n\nUsing the API to integrate with CodePipeline\n
\nFor third-party integrators or developers who want to create their own integrations\nwith CodePipeline, the expected sequence varies from the standard API user. To\nintegrate with CodePipeline, developers need to work with the following\nitems:
\n\nJobs, which are instances of an action. For\nexample, a job for a source action might import a revision of an artifact from a source.
\nYou can work with jobs by calling:
\n\nAcknowledgeJob, which confirms whether a job worker has\nreceived the specified job.
\n\nGetJobDetails, which returns the details of a job.
\n\nPollForJobs, which determines whether there are any jobs to\nact on.
\n\nPutJobFailureResult, which provides details of a job failure.\n
\n\nPutJobSuccessResult, which provides details of a job\nsuccess.
\n\nThird party jobs, which are instances of an action\ncreated by a partner action and integrated into CodePipeline. Partner actions are\ncreated by members of the Amazon Web Services Partner Network.
\nYou can work with third party jobs by calling:
\n\nAcknowledgeThirdPartyJob, which confirms whether a job worker\nhas received the specified job.
\n\nGetThirdPartyJobDetails, which requests the details of a job\nfor a partner action.
\n\nPollForThirdPartyJobs, which determines whether there are any\njobs to act on.
\n\nPutThirdPartyJobFailureResult, which provides details of a job\nfailure.
\n\nPutThirdPartyJobSuccessResult, which provides details of a job\nsuccess.
\n