Amazon EC2 Image Builder GetWorkflowExecution#workflowExecutionId API

openapi: 3.0.0
info:
  version: 2019-12-02
  x-release: v4
  title: EC2 Image Builder CancelImageCreation GetWorkflowExecution#workflowExecutionId 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
      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://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: GetWorkflowExecution#workflowExecutionId
paths:
  /GetWorkflowExecution#workflowExecutionId:
    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'
    get:
      operationId: GetWorkflowExecution
      description: Get the runtime information that was logged for a specific runtime instance of the workflow.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetWorkflowExecutionResponse'
              examples:
                GetWorkflowExecution200Example:
                  summary: Default GetWorkflowExecution 200 response
                  x-microcks-default: true
                  value:
                    requestId: example-id-1234
                    workflowBuildVersionArn: arn:aws:service:us-east-1:123456789012:resource/example
                    workflowExecutionId: example-id-1234
        '480':
          description: ServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceException'
              examples:
                GetWorkflowExecution480Example:
                  summary: Default GetWorkflowExecution 480 response
                  x-microcks-default: true
                  value: {}
        '481':
          description: ClientException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientException'
              examples:
                GetWorkflowExecution481Example:
                  summary: Default GetWorkflowExecution 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: ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenException'
        '485':
          description: CallRateLimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CallRateLimitExceededException'
      parameters:
      - name: workflowExecutionId
        in: query
        required: true
        description: Use the unique identifier for a runtime instance of the workflow to get runtime details.
        schema:
          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 Get Workflow Execution
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - GetWorkflowExecution#workflowExecutionId
components:
  parameters:
    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-Security-Token:
      name: X-Amz-Security-Token
      in: header
      schema:
        type: string
      required: false
    X-Amz-SignedHeaders:
      name: X-Amz-SignedHeaders
      in: header
      schema:
        type: string
      required: false
    X-Amz-Algorithm:
      name: X-Amz-Algorithm
      in: header
      schema:
        type: string
      required: false
    X-Amz-Signature:
      name: X-Amz-Signature
      in: header
      schema:
        type: string
      required: false
    X-Amz-Credential:
      name: X-Amz-Credential
      in: header
      schema:
        type: string
      required: false
  schemas:
    NonEmptyString:
      type: string
      minLength: 1
      maxLength: 1024
    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
    ServiceException: {}
    ImageBuildVersionArn:
      type: string
      pattern: ^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):image/[a-z0-9-_]+/[0-9]+\.[0-9]+\.[0-9]+/[0-9]+$
    DateTime:
      type: string
    ForbiddenException: {}
    WorkflowExecutionMessage:
      type: string
      minLength: 0
      maxLength: 500
    ServiceUnavailableException: {}
    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}$
    WorkflowType:
      type: string
      enum:
      - BUILD
      - TEST
      - DISTRIBUTION
    WorkflowStepCount:
      type: integer
    GetWorkflowExecutionResponse:
      type: object
      properties:
        requestId:
          allOf:
          - $ref: '#/components/schemas/NonEmptyString'
          - description: The request ID that uniquely identifies this request.
        workflowBuildVersionArn:
          allOf:
          - $ref: '#/components/schemas/WorkflowBuildVersionArn'
          - description: The Amazon Resource Name (ARN) of the build version for the Image Builder workflow resource that defines the specified 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 Amazon Resource Name (ARN) of the image resource build version that the specified runtime instance of the workflow created.
        type:
          allOf:
          - $ref: '#/components/schemas/WorkflowType'
          - description: The type of workflow that Image Builder ran for the specified runtime instance of the workflow.
        status:
          allOf:
          - $ref: '#/components/schemas/WorkflowExecutionStatus'
          - description: The current runtime status for the specified runtime instance of the workflow.
        message:
          allOf:
          - $ref: '#/components/schemas/WorkflowExecutionMessage'
          - description: The output message from the specified runtime instance of the workflow, if applicable.
        totalStepCount:
          allOf:
          - $ref: '#/components/schemas/WorkflowStepCount'
          - description: The total number of steps in the specified runtime instance of the workflow that ran. This number should equal the sum of the step counts for steps that succeeded, were skipped, and failed.
        totalStepsSucceeded:
          allOf:
          - $ref: '#/components/schemas/WorkflowStepCount'
          - description: A runtime count for the number of steps that ran successfully in the specified runtime instance of the workflow.
        totalStepsFailed:
          allOf:
          - $ref: '#/components/schemas/WorkflowStepCount'
          - description: A runtime count for the number of steps that failed in the specified runtime instance of the workflow.
        totalStepsSkipped:
          allOf:
          - $ref: '#/components/schemas/WorkflowStepCount'
          - description: A runtime count for the number of steps that were skipped in the specified runtime instance of the workflow.
        startTime:
          allOf:
          - $ref: '#/components/schemas/DateTime'
          - description: The timestamp when the specified runtime instance of the workflow started.
        endTime:
          allOf:
          - $ref: '#/components/schemas/DateTime'
          - description: The timestamp when the specified runtime instance of the workflow finished.
    CallRateLimitExceededException: {}
    ClientException: {}
    InvalidRequestException: {}
    WorkflowExecutionStatus:
      type: string
      enum:
      - PENDING
      - SKIPPED
      - RUNNING
      - COMPLETED
      - FAILED
      - ROLLBACK_IN_PROGRESS
      - ROLLBACK_COMPLETED
  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