Amazon CodePipeline Pipelines API

openapi: 3.0.0
info:
  version: '2015-07-09'
  x-release: v4
  title: AWS CodePipeline Executions Pipelines API
  description: <fullname>CodePipeline</fullname> <p> <b>Overview</b> </p> <p>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 <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/welcome.html">CodePipeline User Guide</a>.</p> <p>You can use the CodePipeline API to work with pipelines, stages, actions, and transitions.</p> <p> <i>Pipelines</i> are models of automated release processes. Each pipeline is uniquely named, and consists of stages, actions, and transitions. </p> <p>You can work with pipelines by calling:</p> <ul> <li> <p> <a>CreatePipeline</a>, which creates a uniquely named pipeline.</p> </li> <li> <p> <a>DeletePipeline</a>, which deletes the specified pipeline.</p> </li> <li> <p> <a>GetPipeline</a>, which returns information about the pipeline structure and pipeline metadata, including the pipeline Amazon Resource Name (ARN).</p> </li> <li> <p> <a>GetPipelineExecution</a>, which returns information about a specific execution of a pipeline.</p> </li> <li> <p> <a>GetPipelineState</a>, which returns information about the current state of the stages and actions of a pipeline.</p> </li> <li> <p> <a>ListActionExecutions</a>, 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.</p> </li> <li> <p> <a>ListPipelines</a>, which gets a summary of all of the pipelines associated with your account.</p> </li> <li> <p> <a>ListPipelineExecutions</a>, which gets a summary of the most recent executions for a pipeline.</p> </li> <li> <p> <a>StartPipelineExecution</a>, which runs the most recent revision of an artifact through the pipeline.</p> </li> <li> <p> <a>StopPipelineExecution</a>, which stops the specified pipeline execution from continuing through the pipeline.</p> </li> <li> <p> <a>UpdatePipeline</a>, which updates a pipeline with edits or changes to the structure of the pipeline.</p> </li> </ul> <p>Pipelines include <i>stages</i>. 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 <a>GetPipelineState</a>, which displays the status of a pipeline, including the status of stages in the pipeline, or <a>GetPipeline</a>, 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 <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/pipeline-structure.html">CodePipeline Pipeline Structure Reference</a>.</p> <p>Pipeline stages include <i>actions</i> 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 <a>CreatePipeline</a> and <a>GetPipelineState</a>. Valid action categories are:</p> <ul> <li> <p>Source</p> </li> <li> <p>Build</p> </li> <li> <p>Test</p> </li> <li> <p>Deploy</p> </li> <li> <p>Approval</p> </li> <li> <p>Invoke</p> </li> </ul> <p>Pipelines also include <i>transitions</i>, which allow the transition of artifacts from one stage to the next in a pipeline after the actions in one stage complete.</p> <p>You can work with transitions by calling:</p> <ul> <li> <p> <a>DisableStageTransition</a>, which prevents artifacts from transitioning to the next stage in a pipeline.</p> </li> <li> <p> <a>EnableStageTransition</a>, which enables transition of artifacts between stages in a pipeline. </p> </li> </ul> <p> <b>Using the API to integrate with CodePipeline</b> </p> <p>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:</p> <p> <b>Jobs</b>, which are instances of an action. For example, a job for a source action might import a revision of an artifact from a source. </p> <p>You can work with jobs by calling:</p> <ul> <li> <p> <a>AcknowledgeJob</a>, which confirms whether a job worker has received the specified job.</p> </li> <li> <p> <a>GetJobDetails</a>, which returns the details of a job.</p> </li> <li> <p> <a>PollForJobs</a>, which determines whether there are any jobs to act on.</p> </li> <li> <p> <a>PutJobFailureResult</a>, which provides details of a job failure. </p> </li> <li> <p> <a>PutJobSuccessResult</a>, which provides details of a job success.</p> </li> </ul> <p> <b>Third party jobs</b>, which are instances of an action created by a partner action and integrated into CodePipeline. Partner actions are created by members of the Amazon Web Services Partner Network.</p> <p>You can work with third party jobs by calling:</p> <ul> <li> <p> <a>AcknowledgeThirdPartyJob</a>, which confirms whether a job worker has received the specified job.</p> </li> <li> <p> <a>GetThirdPartyJobDetails</a>, which requests the details of a job for a partner action.</p> </li> <li> <p> <a>PollForThirdPartyJobs</a>, which determines whether there are any jobs to act on. </p> </li> <li> <p> <a>PutThirdPartyJobFailureResult</a>, which provides details of a job failure.</p> </li> <li> <p> <a>PutThirdPartyJobSuccessResult</a>, which provides details of a job success.</p> </li> </ul>
  x-logo:
    url: https://twitter.com/awscloud/profile_image?size=original
    backgroundColor: '#FFFFFF'
  termsOfService: https://aws.amazon.com/service-terms/
  contact:
    name: Mike Ralphson
    email: mike.ralphson@gmail.com
    url: https://github.com/mermade/aws2openapi
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: http://www.apache.org/licenses/
  x-providerName: amazonaws.com
  x-serviceName: codepipeline
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/codepipeline-2015-07-09.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
      version: 1.0.0
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
  x-apisguru-categories:
  - cloud
  x-preferred: true
servers:
- url: http://codepipeline.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The CodePipeline multi-region endpoint
- url: https://codepipeline.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The CodePipeline multi-region endpoint
- url: http://codepipeline.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The CodePipeline endpoint for China (Beijing) and China (Ningxia)
- url: https://codepipeline.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The CodePipeline endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: Pipelines
  description: Operations for managing CodePipeline pipelines
paths:
  /:
    post:
      operationId: CreatePipeline
      summary: Amazon CodePipeline Create a New Pipeline
      description: Creates a pipeline with the specified name and structure. A pipeline consists of stages and actions that process code changes.
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreatePipelineInput'
            examples:
              CreatePipelineRequestExample:
                summary: Default CreatePipeline request
                x-microcks-default: true
                value:
                  pipeline:
                    name: example-resource
                    roleArn: arn:aws:service:us-east-1:123456789012:resource/example
                    stages:
                    - {}
                    version: 1
                  tags:
                  - key: example-value
                    value: example-value
      responses:
        '200':
          description: Pipeline created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Pipeline'
              examples:
                CreatePipeline200Example:
                  summary: Default CreatePipeline 200 response
                  x-microcks-default: true
                  value:
                    name: example-resource
                    roleArn: arn:aws:service:us-east-1:123456789012:resource/example
                    stages:
                    - name: example-resource
                      actions: []
                    version: 1
        '400':
          description: Bad request
        '409':
          description: Pipeline already exists
      tags:
      - Pipelines
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /getPipeline:
    post:
      operationId: GetPipeline
      summary: Amazon CodePipeline Get Pipeline Details
      description: Returns the metadata, structure, stages, and actions of a pipeline.
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              type: object
              required:
              - name
              properties:
                name:
                  type: string
                  description: The name of the pipeline.
                version:
                  type: integer
                  description: The version number of the pipeline.
            examples:
              GetPipelineRequestExample:
                summary: Default GetPipeline request
                x-microcks-default: true
                value:
                  name: example-resource
                  version: 1
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Pipeline'
              examples:
                GetPipeline200Example:
                  summary: Default GetPipeline 200 response
                  x-microcks-default: true
                  value:
                    name: example-resource
                    roleArn: arn:aws:service:us-east-1:123456789012:resource/example
                    stages:
                    - name: example-resource
                      actions: []
                    version: 1
        '404':
          description: Pipeline not found
      tags:
      - Pipelines
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /listPipelines:
    post:
      operationId: ListPipelines
      summary: Amazon CodePipeline List Pipelines
      description: Gets a summary of all of the pipelines associated with your account.
      requestBody:
        required: false
        content:
          application/x-amz-json-1.1:
            schema:
              type: object
              properties:
                nextToken:
                  type: string
                maxResults:
                  type: integer
            examples:
              ListPipelinesRequestExample:
                summary: Default ListPipelines request
                x-microcks-default: true
                value:
                  nextToken: example-value
                  maxResults: 1
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PipelineList'
              examples:
                ListPipelines200Example:
                  summary: Default ListPipelines 200 response
                  x-microcks-default: true
                  value:
                    pipelines:
                    - name: example-resource
                      version: 1
                      created: example-value
                      updated: example-value
                    nextToken: example-value
      tags:
      - Pipelines
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /deletePipeline:
    post:
      operationId: DeletePipeline
      summary: Amazon CodePipeline Delete a Pipeline
      description: Deletes the specified pipeline.
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              type: object
              required:
              - name
              properties:
                name:
                  type: string
                  description: The name of the pipeline to delete.
            examples:
              DeletePipelineRequestExample:
                summary: Default DeletePipeline request
                x-microcks-default: true
                value:
                  name: example-resource
      responses:
        '200':
          description: Pipeline deleted successfully
        '404':
          description: Pipeline not found
      tags:
      - Pipelines
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    ActionDeclaration:
      type: object
      required:
      - name
      - actionTypeId
      properties:
        name:
          type: string
          description: The action declaration name.
        actionTypeId:
          type: object
          properties:
            category:
              type: string
              enum:
              - Source
              - Build
              - Deploy
              - Test
              - Invoke
              - Approval
            owner:
              type: string
            provider:
              type: string
            version:
              type: string
        configuration:
          type: object
          additionalProperties:
            type: string
        inputArtifacts:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
        outputArtifacts:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
    PipelineList:
      type: object
      properties:
        pipelines:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              version:
                type: integer
              created:
                type: string
                format: date-time
              updated:
                type: string
                format: date-time
        nextToken:
          type: string
    Tag:
      type: object
      properties:
        key:
          type: string
        value:
          type: string
    StageDeclaration:
      type: object
      required:
      - name
      - actions
      properties:
        name:
          type: string
          description: The name of the stage.
        actions:
          type: array
          items:
            $ref: '#/components/schemas/ActionDeclaration'
    Pipeline:
      type: object
      properties:
        name:
          type: string
          description: The name of the pipeline.
        roleArn:
          type: string
          description: The ARN of the IAM role used by the pipeline.
        stages:
          type: array
          items:
            $ref: '#/components/schemas/StageDeclaration'
        version:
          type: integer
          description: The version number of the pipeline.
    CreatePipelineInput:
      type: object
      required:
      - pipeline
      properties:
        pipeline:
          $ref: '#/components/schemas/Pipeline'
        tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
  securitySchemes:
    hmac:
      type: apiKey
      name: Authorization
      in: header
      description: Amazon Signature authorization v4
      x-amazon-apigateway-authtype: awsSigv4
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/codepipeline/
x-hasEquivalentPaths: true