Amazon EC2 Image Builder ListWorkflowStepExecutions API

openapi: 3.2.0
info:
  version: 1.0.0
  x-release: v4
  title: EC2 Image Builder CancelImageCreation List Workflow Step Executions API
  description: EC2 Image Builder is a fully managed Amazon Web Services service that makes it easier to automate the creation, management, and deployment of customized, secure, and up-to-date "golden" server images that are pre-installed and pre-configured with software and settings to meet specific IT standards.
  x-logo:
    url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
    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: imagebuilder
  x-aws-signingName: imagebuilder
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/imagebuilder-2019-12-02.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
    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://imagebuilder.{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 imagebuilder multi-region endpoint
- url: https://imagebuilder.{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 imagebuilder multi-region endpoint
- url: http://imagebuilder.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The imagebuilder endpoint for China (Beijing) and China (Ningxia)
- url: https://imagebuilder.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The imagebuilder endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: ListWorkflowStepExecutions
paths:
  /ListWorkflowStepExecutions:
    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: ListWorkflowStepExecutions
      description: Shows runtime data for each step in a runtime instance of the workflow that you specify in the request.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListWorkflowStepExecutionsResponse'
              examples:
                ListWorkflowStepExecutions200Example:
                  summary: Default ListWorkflowStepExecutions 200 response
                  x-microcks-default: true
                  value:
                    requestId: example-id-1234
                    steps: example-string
                    workflowBuildVersionArn: arn:aws:service:us-east-1:123456789012:resource/example
        '480':
          description: ServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceException'
              examples:
                ListWorkflowStepExecutions480Example:
                  summary: Default ListWorkflowStepExecutions 480 response
                  x-microcks-default: true
                  value: {}
        '481':
          description: ClientException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientException'
              examples:
                ListWorkflowStepExecutions481Example:
                  summary: Default ListWorkflowStepExecutions 481 response
                  x-microcks-default: true
                  value: {}
        '482':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableException'
        '483':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
        '484':
          description: InvalidPaginationTokenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidPaginationTokenException'
        '485':
          description: ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenException'
        '486':
          description: CallRateLimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CallRateLimitExceededException'
      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
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - workflowExecutionId
              properties:
                maxResults:
                  description: The maximum items to return in a request.
                  type: integer
                  minimum: 1
                  maximum: 25
                nextToken:
                  description: A token to specify where to start paginating. This is the NextToken from a previously truncated response.
                  type: string
                  minLength: 1
                  maxLength: 65535
                workflowExecutionId:
                  description: The unique identifier that Image Builder assigned to keep track of runtime details when it ran the workflow.
                  type: string
                  pattern: ^wf-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
      summary: Amazon EC2 Image Builder List Workflow Step Executions
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - ListWorkflowStepExecutions
components:
  parameters:
    X-Amz-Security-Token:
      name: X-Amz-Security-Token
      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
    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-Date:
      name: X-Amz-Date
      in: header
      schema:
        type: string
      required: false
    X-Amz-Content-Sha256:
      name: X-Amz-Content-Sha256
      in: header
      schema:
        type: string
      required: false
  schemas:
    WorkflowBuildVersionArn:
      type: string
      pattern: ^arn:aws(?:-[a-z]+)*:imagebuilder:[a-z]{2,}(?:-[a-z]+)+-[0-9]+:(?:[0-9]{12}|aws):workflow/(build|test|distribution)/[a-z0-9-_]+/[0-9]+\.[0-9]+\.[0-9]+/[0-9]+$
      maxLength: 1024
    WorkflowStepDescription:
      type: string
      minLength: 0
      maxLength: 500
    NonEmptyString:
      type: string
      minLength: 1
      maxLength: 1024
    WorkflowStepName:
      type: string
      pattern: ^[A-Za-z][A-Za-z0-9-_]{1,99}$
    ServiceUnavailableException: {}
    ClientException: {}
    PaginationToken:
      type: string
      minLength: 1
      maxLength: 65535
    ImageBuildVersionArn:
      type: string
      pattern: ^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):image/[a-z0-9-_]+/[0-9]+\.[0-9]+\.[0-9]+/[0-9]+$
    InvalidPaginationTokenException: {}
    InvalidRequestException: {}
    ServiceException: {}
    DateTime:
      type: string
    WorkflowStepExecutionRollbackStatus:
      type: string
      enum:
      - RUNNING
      - COMPLETED
      - SKIPPED
      - FAILED
    WorkflowStepExecutionId:
      type: string
      pattern: ^step-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
    ListWorkflowStepExecutionsResponse:
      type: object
      properties:
        requestId:
          allOf:
          - $ref: '#/components/schemas/NonEmptyString'
          - description: The request ID that uniquely identifies this request.
        steps:
          allOf:
          - $ref: '#/components/schemas/WorkflowStepExecutionsList'
          - description: Contains an array of runtime details that represents each step in this runtime instance of the workflow.
        workflowBuildVersionArn:
          allOf:
          - $ref: '#/components/schemas/WorkflowBuildVersionArn'
          - description: The build version ARN for the Image Builder workflow resource that defines the steps for this runtime instance of the workflow.
        workflowExecutionId:
          allOf:
          - $ref: '#/components/schemas/WorkflowExecutionId'
          - description: The unique identifier that Image Builder assigned to keep track of runtime details when it ran the workflow.
        imageBuildVersionArn:
          allOf:
          - $ref: '#/components/schemas/ImageBuildVersionArn'
          - description: The image build version resource ARN that's associated with the specified runtime instance of the workflow.
        message:
          allOf:
          - $ref: '#/components/schemas/ImageBuildMessage'
          - description: The output message from the list action, if applicable.
        nextToken:
          allOf:
          - $ref: '#/components/schemas/PaginationToken'
          - description: The next token used for paginated responses. When this field isn't empty, there are additional elements that the service has'ot included in this request. Use this token with the next request to retrieve additional objects.
    WorkflowStepExecutionsList:
      type: array
      items:
        $ref: '#/components/schemas/WorkflowStepMetadata'
    WorkflowStepMetadata:
      type: object
      properties:
        stepExecutionId:
          allOf:
          - $ref: '#/components/schemas/WorkflowStepExecutionId'
          - description: A unique identifier for the workflow step, assigned at runtime.
        name:
          allOf:
          - $ref: '#/components/schemas/WorkflowStepName'
          - description: The name of the workflow step.
        description:
          allOf:
          - $ref: '#/components/schemas/WorkflowStepDescription'
          - description: Description of the workflow step.
        action:
          allOf:
          - $ref: '#/components/schemas/WorkflowStepAction'
          - description: The step action name.
        status:
          allOf:
          - $ref: '#/components/schemas/WorkflowStepExecutionStatus'
          - description: Runtime status for the workflow step.
        rollbackStatus:
          allOf:
          - $ref: '#/components/schemas/WorkflowStepExecutionRollbackStatus'
          - description: Reports on the rollback status of the step, if applicable.
        message:
          allOf:
          - $ref: '#/components/schemas/WorkflowStepMessage'
          - description: Detailed output message that the workflow step provides at runtime.
        inputs:
          allOf:
          - $ref: '#/components/schemas/WorkflowStepInputs'
          - description: Input parameters that Image Builder provides for the workflow step.
        outputs:
          allOf:
          - $ref: '#/components/schemas/WorkflowStepOutputs'
          - description: The file names that the workflow step created as output for this runtime instance of the workflow.
        startTime:
          allOf:
          - $ref: '#/components/schemas/DateTime'
          - description: The timestamp when the workflow step started.
        endTime:
          allOf:
          - $ref: '#/components/schemas/DateTime'
          - description: The timestamp when the workflow step finished.
      description: Runtime details and status for the workflow step.
    ForbiddenException: {}
    CallRateLimitExceededException: {}
    WorkflowExecutionId:
      type: string
      pattern: ^wf-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
    WorkflowStepAction:
      type: string
      pattern: ^[A-Za-z][A-Za-z0-9-_]{1,99}$
    ImageBuildMessage:
      type: string
      minLength: 0
      maxLength: 500
    WorkflowStepMessage:
      type: string
      minLength: 0
      maxLength: 500
    WorkflowStepOutputs:
      type: string
    WorkflowStepExecutionStatus:
      type: string
      enum:
      - PENDING
      - SKIPPED
      - RUNNING
      - COMPLETED
      - FAILED
    WorkflowStepInputs:
      type: string
  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/imagebuilder/
x-hasEquivalentPaths: true