Amazon CodePipeline #X Amz Target=CodePipeline 20150709.GetPipelineState API

openapi: 3.0.0
info:
  version: '2015-07-09'
  x-release: v4
  title: 'AWS CodePipeline Executions #X Amz Target=CodePipeline 20150709.GetPipelineState 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: '#X Amz Target=CodePipeline 20150709.GetPipelineState'
paths:
  /#X-Amz-Target=CodePipeline_20150709.GetPipelineState:
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
    post:
      operationId: GetPipelineState
      description: <p>Returns information about the state of a pipeline, including the stages and actions.</p> <note> <p>Values returned in the <code>revisionId</code> and <code>revisionUrl</code> fields indicate the source revision information, such as the commit ID, for the current state.</p> </note>
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPipelineStateOutput'
              examples:
                GetPipelineState200Example:
                  summary: Default GetPipelineState 200 response
                  x-microcks-default: true
                  value:
                    pipelineName: example-resource
                    pipelineVersion: 1.0.0
                    stageStates: example-value
                    created: example-value
                    updated: example-value
        '480':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
              examples:
                GetPipelineState480Example:
                  summary: Default GetPipelineState 480 response
                  x-microcks-default: true
                  value: example-value
        '481':
          description: PipelineNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PipelineNotFoundException'
              examples:
                GetPipelineState481Example:
                  summary: Default GetPipelineState 481 response
                  x-microcks-default: true
                  value: example-value
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetPipelineStateInput'
            examples:
              GetPipelineStateRequestExample:
                summary: Default GetPipelineState request
                x-microcks-default: true
                value:
                  name: example-resource
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - CodePipeline_20150709.GetPipelineState
      summary: Amazon CodePipeline Get Pipeline State
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - '#X Amz Target=CodePipeline 20150709.GetPipelineState'
components:
  schemas:
    GetPipelineStateInput:
      type: object
      required:
      - name
      title: GetPipelineStateInput
      properties:
        name:
          allOf:
          - $ref: '#/components/schemas/PipelineName'
          - description: The name of the pipeline about which you want to get information.
      description: Represents the input of a <code>GetPipelineState</code> action.
    ActionName:
      type: string
      pattern: '[A-Za-z0-9.@\-_]+'
      minLength: 1
      maxLength: 100
    DisabledReason:
      type: string
      pattern: '[a-zA-Z0-9!@ \(\)\.\*\?\-]+'
      minLength: 1
      maxLength: 300
    Message:
      type: string
      minLength: 1
      maxLength: 5000
    PipelineVersion:
      type: integer
      minimum: 1
    Revision:
      type: string
      minLength: 1
      maxLength: 1500
    ValidationException: {}
    StageState:
      type: object
      properties:
        stageName:
          allOf:
          - $ref: '#/components/schemas/StageName'
          - description: The name of the stage.
        inboundExecution:
          $ref: '#/components/schemas/StageExecution'
        inboundTransitionState:
          allOf:
          - $ref: '#/components/schemas/TransitionState'
          - description: The state of the inbound transition, which is either enabled or disabled.
        actionStates:
          allOf:
          - $ref: '#/components/schemas/ActionStateList'
          - description: The state of the stage.
        latestExecution:
          allOf:
          - $ref: '#/components/schemas/StageExecution'
          - description: Information about the latest execution in the stage, including its ID and status.
      description: Represents information about the state of the stage.
    LastChangedBy:
      type: string
    Enabled:
      type: boolean
    ActionRevision:
      type: object
      required:
      - revisionId
      - revisionChangeId
      - created
      properties:
        revisionId:
          allOf:
          - $ref: '#/components/schemas/Revision'
          - description: The system-generated unique ID that identifies the revision number of the action.
        revisionChangeId:
          allOf:
          - $ref: '#/components/schemas/RevisionChangeIdentifier'
          - description: The unique identifier of the change that set the state to this revision (for example, a deployment ID or timestamp).
        created:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: The date and time when the most recent version of the action was created, in timestamp format.
      description: Represents information about the version (or revision) of an action.
    ActionExecution:
      type: object
      properties:
        actionExecutionId:
          allOf:
          - $ref: '#/components/schemas/ActionExecutionId'
          - description: <p>ID of the workflow action execution in the current stage. Use the <a>GetPipelineState</a> action to retrieve the current action execution details of the current stage.</p> <note> <p>For older executions, this field might be empty. The action execution ID is available for executions run on or after March 2020.</p> </note>
        status:
          allOf:
          - $ref: '#/components/schemas/ActionExecutionStatus'
          - description: The status of the action, or for a completed action, the last status of the action.
        summary:
          allOf:
          - $ref: '#/components/schemas/ExecutionSummary'
          - description: A summary of the run of the action.
        lastStatusChange:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: The last status change of the action.
        token:
          allOf:
          - $ref: '#/components/schemas/ActionExecutionToken'
          - description: The system-generated token used to identify a unique approval request. The token for each open approval request can be obtained using the <code>GetPipelineState</code> command. It is used to validate that the approval request corresponding to this token is still valid.
        lastUpdatedBy:
          allOf:
          - $ref: '#/components/schemas/LastUpdatedBy'
          - description: The ARN of the user who last changed the pipeline.
        externalExecutionId:
          allOf:
          - $ref: '#/components/schemas/ExecutionId'
          - description: The external ID of the run of the action.
        externalExecutionUrl:
          allOf:
          - $ref: '#/components/schemas/Url'
          - description: The URL of a resource external to Amazon Web Services that is used when running the action (for example, an external repository URL).
        percentComplete:
          allOf:
          - $ref: '#/components/schemas/Percentage'
          - description: A percentage of completeness of the action as it runs.
        errorDetails:
          allOf:
          - $ref: '#/components/schemas/ErrorDetails'
          - description: The details of an error returned by a URL external to Amazon Web Services.
      description: Represents information about the run of an action.
    GetPipelineStateOutput:
      type: object
      properties:
        pipelineName:
          allOf:
          - $ref: '#/components/schemas/PipelineName'
          - description: The name of the pipeline for which you want to get the state.
        pipelineVersion:
          allOf:
          - $ref: '#/components/schemas/PipelineVersion'
          - description: <p>The version number of the pipeline.</p> <note> <p>A newly created pipeline is always assigned a version number of <code>1</code>.</p> </note>
        stageStates:
          allOf:
          - $ref: '#/components/schemas/StageStateList'
          - description: A list of the pipeline stage output information, including stage name, state, most recent run details, whether the stage is disabled, and other data.
        created:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: The date and time the pipeline was created, in timestamp format.
        updated:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: The date and time the pipeline was last updated, in timestamp format.
      description: Represents the output of a <code>GetPipelineState</code> action.
    ActionExecutionToken:
      type: string
    LastUpdatedBy:
      type: string
    PipelineName:
      type: string
      pattern: '[A-Za-z0-9.@\-_]+'
      minLength: 1
      maxLength: 100
    ExecutionSummary:
      type: string
      minLength: 1
      maxLength: 2048
    Url:
      type: string
      minLength: 1
      maxLength: 2048
    StageExecution:
      type: object
      required:
      - pipelineExecutionId
      - status
      properties:
        pipelineExecutionId:
          allOf:
          - $ref: '#/components/schemas/PipelineExecutionId'
          - description: The ID of the pipeline execution associated with the stage.
        status:
          allOf:
          - $ref: '#/components/schemas/StageExecutionStatus'
          - description: <p>The status of the stage, or for a completed stage, the last status of the stage.</p> <note> <p>A status of cancelled means that the pipeline’s definition was updated before the stage execution could be completed.</p> </note>
      description: Represents information about the run of a stage.
    PipelineExecutionId:
      type: string
      pattern: '[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}'
    ExecutionId:
      type: string
      minLength: 1
      maxLength: 1500
    ActionExecutionStatus:
      type: string
      enum:
      - InProgress
      - Abandoned
      - Succeeded
      - Failed
    PipelineNotFoundException: {}
    ErrorDetails:
      type: object
      properties:
        code:
          allOf:
          - $ref: '#/components/schemas/Code'
          - description: The system ID or number code of the error.
        message:
          allOf:
          - $ref: '#/components/schemas/Message'
          - description: The text of the error message.
      description: Represents information about an error in CodePipeline.
    Percentage:
      type: integer
      minimum: 0
      maximum: 100
    StageName:
      type: string
      pattern: '[A-Za-z0-9.@\-_]+'
      minLength: 1
      maxLength: 100
    ActionStateList:
      type: array
      items:
        $ref: '#/components/schemas/ActionState'
    StageStateList:
      type: array
      items:
        $ref: '#/components/schemas/StageState'
    RevisionChangeIdentifier:
      type: string
      minLength: 1
      maxLength: 100
    ActionState:
      type: object
      properties:
        actionName:
          allOf:
          - $ref: '#/components/schemas/ActionName'
          - description: The name of the action.
        currentRevision:
          allOf:
          - $ref: '#/components/schemas/ActionRevision'
          - description: Represents information about the version (or revision) of an action.
        latestExecution:
          allOf:
          - $ref: '#/components/schemas/ActionExecution'
          - description: Represents information about the run of an action.
        entityUrl:
          allOf:
          - $ref: '#/components/schemas/Url'
          - description: A URL link for more information about the state of the action, such as a deployment group details page.
        revisionUrl:
          allOf:
          - $ref: '#/components/schemas/Url'
          - description: A URL link for more information about the revision, such as a commit details page.
      description: Represents information about the state of an action.
    Timestamp:
      type: string
      format: date-time
    LastChangedAt:
      type: string
      format: date-time
    ActionExecutionId:
      type: string
    Code:
      type: string
    StageExecutionStatus:
      type: string
      enum:
      - Cancelled
      - InProgress
      - Failed
      - Stopped
      - Stopping
      - Succeeded
    TransitionState:
      type: object
      properties:
        enabled:
          allOf:
          - $ref: '#/components/schemas/Enabled'
          - description: Whether the transition between stages is enabled (true) or disabled (false).
        lastChangedBy:
          allOf:
          - $ref: '#/components/schemas/LastChangedBy'
          - description: The ID of the user who last changed the transition state.
        lastChangedAt:
          allOf:
          - $ref: '#/components/schemas/LastChangedAt'
          - description: The timestamp when the transition state was last changed.
        disabledReason:
          allOf:
          - $ref: '#/components/schemas/DisabledReason'
          - description: The user-specified reason why the transition between two stages of a pipeline was disabled.
      description: Represents information about the state of transitions between one stage and another stage.
  parameters:
    X-Amz-SignedHeaders:
      name: X-Amz-SignedHeaders
      in: header
      schema:
        type: string
      required: false
    X-Amz-Signature:
      name: X-Amz-Signature
      in: header
      schema:
        type: string
      required: false
    X-Amz-Security-Token:
      name: X-Amz-Security-Token
      in: header
      schema:
        type: string
      required: false
    X-Amz-Content-Sha256:
      name: X-Amz-Content-Sha256
      in: header
      schema:
        type: string
      required: false
    X-Amz-Date:
      name: X-Amz-Date
      in: header
      schema:
        type: string
      required: false
    X-Amz-Credential:
      name: X-Amz-Credential
      in: header
      schema:
        type: string
      required: false
    X-Amz-Algorithm:
      name: X-Amz-Algorithm
      in: header
      schema:
        type: string
      required: false
  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