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

openapi: 3.0.0
info:
  version: '2015-07-09'
  x-release: v4
  title: 'AWS CodePipeline Executions #X Amz Target=CodePipeline 20150709.ListActionExecutions 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.ListActionExecutions'
paths:
  /#X-Amz-Target=CodePipeline_20150709.ListActionExecutions:
    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: ListActionExecutions
      description: Lists the action executions that have occurred in a pipeline.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListActionExecutionsOutput'
              examples:
                ListActionExecutions200Example:
                  summary: Default ListActionExecutions 200 response
                  x-microcks-default: true
                  value:
                    actionExecutionDetails: example-value
                    nextToken: example-value
        '480':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
              examples:
                ListActionExecutions480Example:
                  summary: Default ListActionExecutions 480 response
                  x-microcks-default: true
                  value: example-value
        '481':
          description: PipelineNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PipelineNotFoundException'
              examples:
                ListActionExecutions481Example:
                  summary: Default ListActionExecutions 481 response
                  x-microcks-default: true
                  value: example-value
        '482':
          description: InvalidNextTokenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidNextTokenException'
              examples:
                ListActionExecutions482Example:
                  summary: Default ListActionExecutions 482 response
                  x-microcks-default: true
                  value: example-value
        '483':
          description: PipelineExecutionNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PipelineExecutionNotFoundException'
              examples:
                ListActionExecutions483Example:
                  summary: Default ListActionExecutions 483 response
                  x-microcks-default: true
                  value: example-value
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListActionExecutionsInput'
            examples:
              ListActionExecutionsRequestExample:
                summary: Default ListActionExecutions request
                x-microcks-default: true
                value:
                  pipelineName: example-resource
                  filter: example-value
                  maxResults: example-value
                  nextToken: example-value
      parameters:
      - name: maxResults
        in: query
        schema:
          type: string
        description: Pagination limit
        required: false
      - name: nextToken
        in: query
        schema:
          type: string
        description: Pagination token
        required: false
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - CodePipeline_20150709.ListActionExecutions
      summary: Amazon CodePipeline List Action Executions
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - '#X Amz Target=CodePipeline 20150709.ListActionExecutions'
components:
  schemas:
    ActionExecutionInput:
      type: object
      properties:
        actionTypeId:
          $ref: '#/components/schemas/ActionTypeId'
        configuration:
          allOf:
          - $ref: '#/components/schemas/ActionConfigurationMap'
          - description: Configuration data for an action execution.
        resolvedConfiguration:
          allOf:
          - $ref: '#/components/schemas/ResolvedActionConfigurationMap'
          - description: Configuration data for an action execution with all variable references replaced with their real values for the execution.
        roleArn:
          allOf:
          - $ref: '#/components/schemas/RoleArn'
          - description: 'The ARN of the IAM service role that performs the declared action. This is assumed through the roleArn for the pipeline. '
        region:
          allOf:
          - $ref: '#/components/schemas/AWSRegionName'
          - description: The Amazon Web Services Region for the action, such as us-east-1.
        inputArtifacts:
          allOf:
          - $ref: '#/components/schemas/ArtifactDetailList'
          - description: Details of input artifacts of the action that correspond to the action execution.
        namespace:
          allOf:
          - $ref: '#/components/schemas/ActionNamespace'
          - description: The variable namespace associated with the action. All variables produced as output by this action fall under this namespace.
      description: Input information used for an action execution.
    InvalidNextTokenException: {}
    OutputVariablesValue:
      type: string
    ActionExecutionFilter:
      type: object
      properties:
        pipelineExecutionId:
          allOf:
          - $ref: '#/components/schemas/PipelineExecutionId'
          - description: The pipeline execution ID used to filter action execution history.
      description: Filter values for the action execution.
    String:
      type: string
    ActionName:
      type: string
      pattern: '[A-Za-z0-9.@\-_]+'
      minLength: 1
      maxLength: 100
    ActionCategory:
      type: string
      enum:
      - Source
      - Build
      - Deploy
      - Test
      - Invoke
      - Approval
    OutputVariablesMap:
      type: object
      additionalProperties:
        $ref: '#/components/schemas/OutputVariablesValue'
    AWSRegionName:
      type: string
      minLength: 4
      maxLength: 30
    ListActionExecutionsInput:
      type: object
      required:
      - pipelineName
      title: ListActionExecutionsInput
      properties:
        pipelineName:
          allOf:
          - $ref: '#/components/schemas/PipelineName'
          - description: ' The name of the pipeline for which you want to list action execution history.'
        filter:
          allOf:
          - $ref: '#/components/schemas/ActionExecutionFilter'
          - description: Input information used to filter action execution history.
        maxResults:
          allOf:
          - $ref: '#/components/schemas/MaxResults'
          - description: <p>The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned nextToken value. Action execution history is retained for up to 12 months, based on action execution start times. Default value is 100. </p> <note> <p>Detailed execution history is available for executions run on or after February 21, 2019.</p> </note>
        nextToken:
          allOf:
          - $ref: '#/components/schemas/NextToken'
          - description: The token that was returned from the previous <code>ListActionExecutions</code> call, which can be used to return the next set of action executions in the list.
    ActionConfigurationMap:
      type: object
      additionalProperties:
        $ref: '#/components/schemas/ActionConfigurationValue'
    ActionExecutionOutput:
      type: object
      properties:
        outputArtifacts:
          allOf:
          - $ref: '#/components/schemas/ArtifactDetailList'
          - description: Details of output artifacts of the action that correspond to the action execution.
        executionResult:
          allOf:
          - $ref: '#/components/schemas/ActionExecutionResult'
          - description: Execution result information listed in the output details for an action execution.
        outputVariables:
          allOf:
          - $ref: '#/components/schemas/OutputVariablesMap'
          - description: The outputVariables field shows the key-value pairs that were output as part of that execution.
      description: Output details listed for an action execution, such as the action execution result.
    PipelineVersion:
      type: integer
      minimum: 1
    ResolvedActionConfigurationMap:
      type: object
      additionalProperties:
        $ref: '#/components/schemas/String'
    PipelineExecutionNotFoundException: {}
    ActionExecutionDetailList:
      type: array
      items:
        $ref: '#/components/schemas/ActionExecutionDetail'
    ActionExecutionDetail:
      type: object
      properties:
        pipelineExecutionId:
          allOf:
          - $ref: '#/components/schemas/PipelineExecutionId'
          - description: The pipeline execution ID for the action execution.
        actionExecutionId:
          allOf:
          - $ref: '#/components/schemas/ActionExecutionId'
          - description: The action execution ID.
        pipelineVersion:
          allOf:
          - $ref: '#/components/schemas/PipelineVersion'
          - description: The version of the pipeline where the action was run.
        stageName:
          allOf:
          - $ref: '#/components/schemas/StageName'
          - description: The name of the stage that contains the action.
        actionName:
          allOf:
          - $ref: '#/components/schemas/ActionName'
          - description: The name of the action.
        startTime:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: The start time of the action execution.
        lastUpdateTime:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: The last update time of the action execution.
        status:
          allOf:
          - $ref: '#/components/schemas/ActionExecutionStatus'
          - description: ' The status of the action execution. Status categories are <code>InProgress</code>, <code>Succeeded</code>, and <code>Failed</code>.'
        input:
          allOf:
          - $ref: '#/components/schemas/ActionExecutionInput'
          - description: Input details for the action execution, such as role ARN, Region, and input artifacts.
        output:
          allOf:
          - $ref: '#/components/schemas/ActionExecutionOutput'
          - description: Output details for the action execution, such as the action execution result.
      description: 'Returns information about an execution of an action, including the action execution ID, and the name, version, and timing of the action. '
    ListActionExecutionsOutput:
      type: object
      properties:
        actionExecutionDetails:
          allOf:
          - $ref: '#/components/schemas/ActionExecutionDetailList'
          - description: The details for a list of recent executions, such as action execution ID.
        nextToken:
          allOf:
          - $ref: '#/components/schemas/NextToken'
          - description: If the amount of returned information is significantly large, an identifier is also returned and can be used in a subsequent <code>ListActionExecutions</code> call to return the next set of action executions in the list.
    ValidationException: {}
    MaxResults:
      type: integer
      minimum: 1
      maximum: 100
    S3Key:
      type: string
      minLength: 1
      maxLength: 100
    ActionOwner:
      type: string
      enum:
      - AWS
      - ThirdParty
      - Custom
    RoleArn:
      type: string
      pattern: arn:aws(-[\w]+)*:iam::[0-9]{12}:role/.*
      maxLength: 1024
    ExternalExecutionSummary:
      type: string
    ArtifactDetail:
      type: object
      properties:
        name:
          allOf:
          - $ref: '#/components/schemas/ArtifactName'
          - description: The artifact object name for the action execution.
        s3location:
          allOf:
          - $ref: '#/components/schemas/S3Location'
          - description: The Amazon S3 artifact location for the action execution.
      description: Artifact details for the action execution, such as the artifact location.
    NextToken:
      type: string
      minLength: 1
      maxLength: 2048
    PipelineName:
      type: string
      pattern: '[A-Za-z0-9.@\-_]+'
      minLength: 1
      maxLength: 100
    Version:
      type: string
      pattern: '[0-9A-Za-z_-]+'
      minLength: 1
      maxLength: 9
    ActionExecutionResult:
      type: object
      properties:
        externalExecutionId:
          allOf:
          - $ref: '#/components/schemas/ExternalExecutionId'
          - description: The action provider's external ID for the action execution.
        externalExecutionSummary:
          allOf:
          - $ref: '#/components/schemas/ExternalExecutionSummary'
          - description: The action provider's summary for the action execution.
        externalExecutionUrl:
          allOf:
          - $ref: '#/components/schemas/Url'
          - description: The deepest external link to the external resource (for example, a repository URL or deployment endpoint) that is used when running the action.
      description: Execution result information, such as the external execution ID.
    Url:
      type: string
      minLength: 1
      maxLength: 2048
    PipelineExecutionId:
      type: string
      pattern: '[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}'
    ActionTypeId:
      type: object
      required:
      - category
      - owner
      - provider
      - version
      properties:
        category:
          allOf:
          - $ref: '#/components/schemas/ActionCategory'
          - description: <p>A category defines what kind of action can be taken in the stage, and constrains the provider type for the action. Valid categories are limited to one of the following values. </p> <ul> <li> <p>Source</p> </li> <li> <p>Build</p> </li> <li> <p>Test</p> </li> <li> <p>Deploy</p> </li> <li> <p>Invoke</p> </li> <li> <p>Approval</p> </li> </ul>
        owner:
          allOf:
          - $ref: '#/components/schemas/ActionOwner'
          - description: 'The creator of the action being called. There are three valid values for the <code>Owner</code> field in the action category section within your pipeline structure: <code>AWS</code>, <code>ThirdParty</code>, and <code>Custom</code>. For more information, see <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html#actions-valid-providers">Valid Action Types and Providers in CodePipeline</a>.'
        provider:
          allOf:
          - $ref: '#/components/schemas/ActionProvider'
          - description: The provider of the service being called by the action. Valid providers are determined by the action category. For example, an action in the Deploy category type might have a provider of CodeDeploy, which would be specified as <code>CodeDeploy</code>. For more information, see <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html#actions-valid-providers">Valid Action Types and Providers in CodePipeline</a>.
        version:
          allOf:
          - $ref: '#/components/schemas/Version'
          - description: A string that describes the action version.
      description: Represents information about an action type.
    ExternalExecutionId:
      type: string
    ActionProvider:
      type: string
      pattern: '[0-9A-Za-z_-]+'
      minLength: 1
      maxLength: 35
    ActionExecutionStatus:
      type: string
      enum:
      - InProgress
      - Abandoned
      - Succeeded
      - Failed
    ActionConfigurationValue:
      type: string
      minLength: 1
      maxLength: 1000
    PipelineNotFoundException: {}
    StageName:
      type: string
      pattern: '[A-Za-z0-9.@\-_]+'
      minLength: 1
      maxLength: 100
    Timestamp:
      type: string
      format: date-time
    ArtifactName:
      type: string
      pattern: '[a-zA-Z0-9_\-]+'
      minLength: 1
      maxLength: 100
    ArtifactDetailList:
      type: array
      items:
        $ref: '#/components/schemas/ArtifactDetail'
    S3Bucket:
      type: string
      minLength: 3
      maxLength: 63
    ActionExecutionId:
      type: string
    S3Location:
      type: object
      properties:
        bucket:
          allOf:
          - $ref: '#/components/schemas/S3Bucket'
          - description: The Amazon S3 artifact bucket for an action's artifacts.
        key:
          allOf:
          - $ref: '#/components/schemas/S3Key'
          - description: The artifact name.
      description: The Amazon S3 artifact location for an action's artifacts.
    ActionNamespace:
      type: string
      pattern: '[A-Za-z0-9@\-_]+'
      minLength: 1
      maxLength: 100
  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