Amazon Simple Workflow Service #X Amz Target=SimpleWorkflowService.DescribeWorkflowExecution API

openapi: 3.0.0
info:
  version: '2012-01-25'
  x-release: v4
  title: 'Amazon Simple Workflow Service #X Amz Target=SimpleWorkflowService.CountClosedWorkflowExecutions #X Amz Target=SimpleWorkflowService.CountClosedWorkflowExecutions #X Amz Target=SimpleWorkflowService.DescribeWorkflowExecution API'
  description: <fullname>Amazon Simple Workflow Service</fullname> <p>The Amazon Simple Workflow Service (Amazon SWF) makes it easy to build applications that use Amazon's cloud to coordinate work across distributed components. In Amazon SWF, a <i>task</i> represents a logical unit of work that is performed by a component of your workflow. Coordinating tasks in a workflow involves managing intertask dependencies, scheduling, and concurrency in accordance with the logical flow of the application.</p> <p>Amazon SWF gives you full control over implementing tasks and coordinating them without worrying about underlying complexities such as tracking their progress and maintaining their state.</p> <p>This documentation serves as reference only. For a broader overview of the Amazon SWF programming model, see the <i> <a href="https://docs.aws.amazon.com/amazonswf/latest/developerguide/">Amazon SWF Developer Guide</a> </i>.</p>
  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: swf
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/swf-2012-01-25.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://swf.{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 Amazon SWF multi-region endpoint
- url: https://swf.{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 Amazon SWF multi-region endpoint
- url: http://swf.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon SWF endpoint for China (Beijing) and China (Ningxia)
- url: https://swf.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon SWF endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: '#X Amz Target=SimpleWorkflowService.DescribeWorkflowExecution'
paths:
  /#X-Amz-Target=SimpleWorkflowService.DescribeWorkflowExecution:
    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: DescribeWorkflowExecution
      description: <p>Returns information about the specified workflow execution including its type and some statistics.</p> <note> <p>This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.</p> </note> <p> <b>Access Control</b> </p> <p>You can use IAM policies to control this action's access to Amazon SWF resources as follows:</p> <ul> <li> <p>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</p> </li> <li> <p>Use an <code>Action</code> element to allow or deny permission to call this action.</p> </li> <li> <p>You cannot use an IAM policy to constrain this action's parameters.</p> </li> </ul> <p>If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <code>cause</code> parameter is set to <code>OPERATION_NOT_PERMITTED</code>. For details and example IAM policies, see <a href="https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF Workflows</a> in the <i>Amazon SWF Developer Guide</i>.</p>
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowExecutionDetail'
        '480':
          description: UnknownResourceFault
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnknownResourceFault'
        '481':
          description: OperationNotPermittedFault
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationNotPermittedFault'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeWorkflowExecutionInput'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SimpleWorkflowService.DescribeWorkflowExecution
        example: SimpleWorkflowService.DescribeWorkflowExecution
      summary: Amazon SWF Describe Workflow Execution
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - '#X Amz Target=SimpleWorkflowService.DescribeWorkflowExecution'
components:
  parameters:
    X-Amz-Credential:
      name: X-Amz-Credential
      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-Date:
      name: X-Amz-Date
      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-Content-Sha256:
      name: X-Amz-Content-Sha256
      in: header
      schema:
        type: string
      required: false
    X-Amz-Signature:
      name: X-Amz-Signature
      in: header
      schema:
        type: string
      required: false
  schemas:
    WorkflowId:
      type: string
      minLength: 1
      maxLength: 256
    UnknownResourceFault: {}
    WorkflowExecutionDetail:
      type: object
      required:
      - executionInfo
      - executionConfiguration
      - openCounts
      properties:
        executionInfo:
          allOf:
          - $ref: '#/components/schemas/WorkflowExecutionInfo'
          - description: Information about the workflow execution.
        executionConfiguration:
          allOf:
          - $ref: '#/components/schemas/WorkflowExecutionConfiguration'
          - description: The configuration settings for this workflow execution including timeout values, tasklist etc.
        openCounts:
          allOf:
          - $ref: '#/components/schemas/WorkflowExecutionOpenCounts'
          - description: The number of tasks for this workflow execution. This includes open and closed tasks of all types.
        latestActivityTaskTimestamp:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: The time when the last activity task was scheduled for this workflow execution. You can use this information to determine if the workflow has not made progress for an unusually long period of time and might require a corrective action.
        latestExecutionContext:
          allOf:
          - $ref: '#/components/schemas/Data'
          - description: The latest executionContext provided by the decider for this workflow execution. A decider can provide an executionContext (a free-form string) when closing a decision task using <a>RespondDecisionTaskCompleted</a>.
      description: Contains details about a workflow execution.
    Tag:
      type: string
      minLength: 0
      maxLength: 256
    WorkflowExecutionInfo:
      type: object
      required:
      - execution
      - workflowType
      - startTimestamp
      - executionStatus
      properties:
        execution:
          allOf:
          - $ref: '#/components/schemas/WorkflowExecution'
          - description: The workflow execution this information is about.
        workflowType:
          allOf:
          - $ref: '#/components/schemas/WorkflowType'
          - description: The type of the workflow execution.
        startTimestamp:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: The time when the execution was started.
        closeTimestamp:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: The time when the workflow execution was closed. Set only if the execution status is CLOSED.
        executionStatus:
          allOf:
          - $ref: '#/components/schemas/ExecutionStatus'
          - description: The current status of the execution.
        closeStatus:
          allOf:
          - $ref: '#/components/schemas/CloseStatus'
          - description: <p>If the execution status is closed then this specifies how the execution was closed:</p> <ul> <li> <p> <code>COMPLETED</code> – the execution was successfully completed.</p> </li> <li> <p> <code>CANCELED</code> – the execution was canceled.Cancellation allows the implementation to gracefully clean up before the execution is closed.</p> </li> <li> <p> <code>TERMINATED</code> – the execution was force terminated.</p> </li> <li> <p> <code>FAILED</code> – the execution failed to complete.</p> </li> <li> <p> <code>TIMED_OUT</code> – the execution did not complete in the alloted time and was automatically timed out.</p> </li> <li> <p> <code>CONTINUED_AS_NEW</code> – the execution is logically continued. This means the current execution was completed and a new execution was started to carry on the workflow.</p> </li> </ul>
        parent:
          allOf:
          - $ref: '#/components/schemas/WorkflowExecution'
          - description: If this workflow execution is a child of another execution then contains the workflow execution that started this execution.
        tagList:
          allOf:
          - $ref: '#/components/schemas/TagList'
          - description: The list of tags associated with the workflow execution. Tags can be used to identify and list workflow executions of interest through the visibility APIs. A workflow execution can have a maximum of 5 tags.
        cancelRequested:
          allOf:
          - $ref: '#/components/schemas/Canceled'
          - description: Set to true if a cancellation is requested for this workflow execution.
      description: Contains information about a workflow execution.
    ExecutionStatus:
      type: string
      enum:
      - OPEN
      - CLOSED
    ChildPolicy:
      type: string
      enum:
      - TERMINATE
      - REQUEST_CANCEL
      - ABANDON
    Count:
      type: integer
      minimum: 0
    OpenDecisionTasksCount:
      type: integer
      minimum: 0
      maximum: 1
    DomainName:
      type: string
      minLength: 1
      maxLength: 256
    OperationNotPermittedFault: {}
    TagList:
      type: array
      items:
        $ref: '#/components/schemas/Tag'
      maxItems: 5
    Arn:
      type: string
      minLength: 1
      maxLength: 1600
    WorkflowRunId:
      type: string
      minLength: 1
      maxLength: 64
    TaskList:
      type: object
      required:
      - name
      properties:
        name:
          allOf:
          - $ref: '#/components/schemas/Name'
          - description: The name of the task list.
      description: Represents a task list.
    TaskPriority:
      type: string
    WorkflowExecutionOpenCounts:
      type: object
      required:
      - openActivityTasks
      - openDecisionTasks
      - openTimers
      - openChildWorkflowExecutions
      properties:
        openActivityTasks:
          allOf:
          - $ref: '#/components/schemas/Count'
          - description: The count of activity tasks whose status is <code>OPEN</code>.
        openDecisionTasks:
          allOf:
          - $ref: '#/components/schemas/OpenDecisionTasksCount'
          - description: The count of decision tasks whose status is OPEN. A workflow execution can have at most one open decision task.
        openTimers:
          allOf:
          - $ref: '#/components/schemas/Count'
          - description: The count of timers started by this workflow execution that have not fired yet.
        openChildWorkflowExecutions:
          allOf:
          - $ref: '#/components/schemas/Count'
          - description: The count of child workflow executions whose status is <code>OPEN</code>.
        openLambdaFunctions:
          allOf:
          - $ref: '#/components/schemas/Count'
          - description: The count of Lambda tasks whose status is <code>OPEN</code>.
      description: Contains the counts of open tasks, child workflow executions and timers for a workflow execution.
    Canceled:
      type: boolean
    Name:
      type: string
      minLength: 1
      maxLength: 256
    WorkflowExecutionConfiguration:
      type: object
      required:
      - taskStartToCloseTimeout
      - executionStartToCloseTimeout
      - taskList
      - childPolicy
      properties:
        taskStartToCloseTimeout:
          allOf:
          - $ref: '#/components/schemas/DurationInSeconds'
          - description: <p>The maximum duration allowed for decision tasks for this workflow execution.</p> <p>The duration is specified in seconds, an integer greater than or equal to <code>0</code>. You can use <code>NONE</code> to specify unlimited duration.</p>
        executionStartToCloseTimeout:
          allOf:
          - $ref: '#/components/schemas/DurationInSeconds'
          - description: <p>The total duration for this workflow execution.</p> <p>The duration is specified in seconds, an integer greater than or equal to <code>0</code>. You can use <code>NONE</code> to specify unlimited duration.</p>
        taskList:
          allOf:
          - $ref: '#/components/schemas/TaskList'
          - description: The task list used for the decision tasks generated for this workflow execution.
        taskPriority:
          allOf:
          - $ref: '#/components/schemas/TaskPriority'
          - description: <p>The priority assigned to decision tasks for this workflow execution. Valid values are integers that range from Java's <code>Integer.MIN_VALUE</code> (-2147483648) to <code>Integer.MAX_VALUE</code> (2147483647). Higher numbers indicate higher priority.</p> <p>For more information about setting task priority, see <a href="https://docs.aws.amazon.com/amazonswf/latest/developerguide/programming-priority.html">Setting Task Priority</a> in the <i>Amazon SWF Developer Guide</i>.</p>
        childPolicy:
          allOf:
          - $ref: '#/components/schemas/ChildPolicy'
          - description: <p>The policy to use for the child workflow executions if this workflow execution is terminated, by calling the <a>TerminateWorkflowExecution</a> action explicitly or due to an expired timeout.</p> <p>The supported child policies are:</p> <ul> <li> <p> <code>TERMINATE</code> – The child executions are terminated.</p> </li> <li> <p> <code>REQUEST_CANCEL</code> – A request to cancel is attempted for each child execution by recording a <code>WorkflowExecutionCancelRequested</code> event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.</p> </li> <li> <p> <code>ABANDON</code> – No action is taken. The child executions continue to run.</p> </li> </ul>
        lambdaRole:
          allOf:
          - $ref: '#/components/schemas/Arn'
          - description: The IAM role attached to the child workflow execution.
      description: The configuration settings for a workflow execution including timeout values, tasklist etc. These configuration settings are determined from the defaults specified when registering the workflow type and those specified when starting the workflow execution.
    DescribeWorkflowExecutionInput:
      type: object
      required:
      - domain
      - execution
      title: DescribeWorkflowExecutionInput
      properties:
        domain:
          allOf:
          - $ref: '#/components/schemas/DomainName'
          - description: The name of the domain containing the workflow execution.
        execution:
          allOf:
          - $ref: '#/components/schemas/WorkflowExecution'
          - description: The workflow execution to describe.
    Data:
      type: string
      maxLength: 32768
    Version:
      type: string
      minLength: 1
      maxLength: 64
    WorkflowExecution:
      type: object
      required:
      - workflowId
      - runId
      properties:
        workflowId:
          allOf:
          - $ref: '#/components/schemas/WorkflowId'
          - description: The user defined identifier associated with the workflow execution.
        runId:
          allOf:
          - $ref: '#/components/schemas/WorkflowRunId'
          - description: A system-generated unique identifier for the workflow execution.
      description: Represents a workflow execution.
    WorkflowType:
      type: object
      required:
      - name
      - version
      properties:
        name:
          allOf:
          - $ref: '#/components/schemas/Name'
          - description: <p> The name of the workflow type.</p> <note> <p>The combination of workflow type name and version must be unique with in a domain.</p> </note>
        version:
          allOf:
          - $ref: '#/components/schemas/Version'
          - description: <p> The version of the workflow type.</p> <note> <p>The combination of workflow type name and version must be unique with in a domain.</p> </note>
      description: Represents a workflow type.
    Timestamp:
      type: string
      format: date-time
    DurationInSeconds:
      type: string
      minLength: 1
      maxLength: 8
    CloseStatus:
      type: string
      enum:
      - COMPLETED
      - FAILED
      - CANCELED
      - TERMINATED
      - CONTINUED_AS_NEW
      - TIMED_OUT
  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/swf/
x-hasEquivalentPaths: true