Amazon CodePipeline Executions API

openapi: 3.1.0
info:
  title: AWS CodePipeline Executions API
  version: '2015-07-09'
  description: Generated from AWS's published Smithy model for AWS CodePipeline. 2 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://codepipeline.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /#GetPipelineExecution:
    post:
      operationId: GetPipelineExecution
      summary: Get Pipeline Execution
      description: 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.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/GetPipelineExecutionOutput'
        '400':
          description: PipelineExecutionNotFoundException; PipelineNotFoundException; ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/PipelineExecutionNotFoundException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - CodePipeline_20150709.GetPipelineExecution
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/GetPipelineExecutionInput'
      tags:
      - Executions
  /#StartPipelineExecution:
    post:
      operationId: StartPipelineExecution
      summary: Start Pipeline Execution
      description: Starts the specified pipeline. Specifically, it begins processing the latest commit to the source location
        specified as part of the pipeline.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/StartPipelineExecutionOutput'
        '400':
          description: ConcurrentPipelineExecutionsLimitExceededException; PipelineNotFoundException; ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ConcurrentPipelineExecutionsLimitExceededException'
        '409':
          description: ConflictException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ConflictException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - CodePipeline_20150709.StartPipelineExecution
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/StartPipelineExecutionInput'
      tags:
      - Executions
components:
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
        request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: codepipeline
  schemas:
    ArtifactRevision:
      type: object
      properties:
        name:
          type: string
          description: The name of an artifact. This name might be system-generated, such as "MyApp", or defined by the user
            when an action is created.
        revisionId:
          type: string
          description: The revision ID of the artifact.
        revisionChangeIdentifier:
          type: string
          description: An additional identifier for a revision, such as a commit date or, for artifacts stored in Amazon S3
            buckets, the ETag value.
        revisionSummary:
          type: string
          description: Summary information about the most recent revision of the artifact. For GitHub and CodeCommit repositories,
            the commit message. For Amazon S3 buckets or actions, the user-provided content of a codepipeline-artifact-revision-summary
            key specified in the object metadata.
        created:
          type: string
          format: date-time
          description: The date and time when the most recent revision of the artifact was created, in timestamp format.
        revisionUrl:
          type: string
          description: The commit ID for the artifact revision. For artifacts stored in GitHub or CodeCommit repositories,
            the commit ID is linked to a commit details page.
    ConcurrentPipelineExecutionsLimitExceededException:
      type: object
      properties:
        message:
          type: string
    ConflictException:
      type: object
      properties:
        message:
          type: string
    ExecutionTrigger:
      type: object
      properties:
        triggerType:
          type: string
          enum:
          - CreatePipeline
          - StartPipelineExecution
          - PollForSourceChanges
          - Webhook
          - CloudWatchEvent
          - PutActionRevision
          - WebhookV2
          - ManualRollback
          - AutomatedRollback
          description: The type of change-detection method, command, or user interaction that started a pipeline execution.
        triggerDetail:
          type: string
          description: Detail related to the event that started a pipeline execution, such as the webhook ARN of the webhook
            that triggered the pipeline execution or the user ARN for a user-initiated start-pipeline-execution CLI command.
    GetPipelineExecutionInput:
      type: object
      properties:
        pipelineName:
          type: string
          description: The name of the pipeline about which you want to get execution details.
        pipelineExecutionId:
          type: string
          description: The ID of the pipeline execution about which you want to get execution details.
      required:
      - pipelineName
      - pipelineExecutionId
    GetPipelineExecutionOutput:
      type: object
      properties:
        pipelineExecution:
          $ref: '#/components/schemas/PipelineExecution'
    PipelineExecution:
      type: object
      properties:
        pipelineName:
          type: string
          description: The name of the pipeline with the specified pipeline execution.
        pipelineVersion:
          type: integer
          description: The version number of the pipeline with the specified pipeline execution.
        pipelineExecutionId:
          type: string
          description: The ID of the pipeline execution.
        status:
          type: string
          enum:
          - Cancelled
          - InProgress
          - Stopped
          - Stopping
          - Succeeded
          - Superseded
          - Failed
          description: 'The status of the pipeline execution. Cancelled: The pipeline’s definition was updated before the
            pipeline execution could be completed. InProgress: The pipeline execution is currently running. Stopped: The pipeline
            execution was manually stopped. For more information, see Stopped Executions. Stopping: The pipeline execution
            received a request to be manually stopped. Depending on the selected stop mode, the execution is either completing
            or abandoning in-progress actions. For more information, see Stopped Executions. Succeeded: The pipeline execution
            was completed successfully. Superseded: Whi'
        statusSummary:
          type: string
          description: A summary that contains a description of the pipeline execution status.
        artifactRevisions:
          type: array
          items:
            $ref: '#/components/schemas/ArtifactRevision'
          description: A list of ArtifactRevision objects included in a pipeline execution.
        variables:
          type: array
          items:
            $ref: '#/components/schemas/ResolvedPipelineVariable'
          description: A list of pipeline variables used for the pipeline execution.
        trigger:
          $ref: '#/components/schemas/ExecutionTrigger'
        executionMode:
          type: string
          enum:
          - QUEUED
          - SUPERSEDED
          - PARALLEL
          description: The method that the pipeline will use to handle multiple executions. The default mode is SUPERSEDED.
        executionType:
          type: string
          enum:
          - STANDARD
          - ROLLBACK
          description: The type of the pipeline execution.
        rollbackMetadata:
          $ref: '#/components/schemas/PipelineRollbackMetadata'
    PipelineExecutionNotFoundException:
      type: object
      properties:
        message:
          type: string
          description: The message provided to the user in the event of an exception.
    PipelineRollbackMetadata:
      type: object
      properties:
        rollbackTargetPipelineExecutionId:
          type: string
          description: The pipeline execution ID to which the stage will be rolled back.
    PipelineVariable:
      type: object
      properties:
        name:
          type: string
          description: The name of a pipeline-level variable.
        value:
          type: string
          description: The value of a pipeline-level variable.
      required:
      - name
      - value
    ResolvedPipelineVariable:
      type: object
      properties:
        name:
          type: string
          description: The name of a pipeline-level variable.
        resolvedValue:
          type: string
          description: The resolved value of a pipeline-level variable.
    SourceRevisionOverride:
      type: object
      properties:
        actionName:
          type: string
          description: The name of the action where the override will be applied.
        revisionType:
          type: string
          enum:
          - COMMIT_ID
          - IMAGE_DIGEST
          - S3_OBJECT_VERSION_ID
          - S3_OBJECT_KEY
          description: The type of source revision, based on the source provider. For example, the revision type for the CodeCommit
            action provider is the commit ID.
        revisionValue:
          type: string
          description: The source revision, or version of your source artifact, with the changes that you want to run in the
            pipeline execution.
      required:
      - actionName
      - revisionType
      - revisionValue
    StartPipelineExecutionInput:
      type: object
      properties:
        name:
          type: string
          description: The name of the pipeline to start.
        variables:
          type: array
          items:
            $ref: '#/components/schemas/PipelineVariable'
          description: A list that overrides pipeline variables for a pipeline execution that's being started. Variable names
            must match [A-Za-z0-9@\-_]+, and the values can be anything except an empty string.
        clientRequestToken:
          type: string
          description: The system-generated unique ID used to identify a unique execution request.
        sourceRevisions:
          type: array
          items:
            $ref: '#/components/schemas/SourceRevisionOverride'
          description: A list that allows you to specify, or override, the source revision for a pipeline execution that's
            being started. A source revision is the version with all the changes to your application code, or source artifact,
            for the pipeline execution.
      required:
      - name
    StartPipelineExecutionOutput:
      type: object
      properties:
        pipelineExecutionId:
          type: string
          description: The unique system-generated ID of the pipeline execution that was started.
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/codepipeline/service/2015-07-09/codepipeline-2015-07-09.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)