Amazon Simple Workflow Service #X Amz Target=SimpleWorkflowService.ListClosedWorkflowExecutions 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.ListClosedWorkflowExecutions 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.ListClosedWorkflowExecutions'
paths:
  /#X-Amz-Target=SimpleWorkflowService.ListClosedWorkflowExecutions:
    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: ListClosedWorkflowExecutions
      description: '<p>Returns a list of closed workflow executions in the specified domain that meet the filtering criteria. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.</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>Constrain the following parameters by using a <code>Condition</code> element with the appropriate keys.</p> <ul> <li> <p> <code>tagFilter.tag</code>: String constraint. The key is <code>swf:tagFilter.tag</code>.</p> </li> <li> <p> <code>typeFilter.name</code>: String constraint. The key is <code>swf:typeFilter.name</code>.</p> </li> <li> <p> <code>typeFilter.version</code>: String constraint. The key is <code>swf:typeFilter.version</code>.</p> </li> </ul> </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/WorkflowExecutionInfos'
        '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/ListClosedWorkflowExecutionsInput'
      parameters:
      - name: maximumPageSize
        in: query
        schema:
          type: string
        description: Pagination limit
        required: false
        example: example
      - name: nextPageToken
        in: query
        schema:
          type: string
        description: Pagination token
        required: false
        example: token123
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SimpleWorkflowService.ListClosedWorkflowExecutions
        example: SimpleWorkflowService.ListClosedWorkflowExecutions
      summary: Amazon SWF List Closed Workflow Executions
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - '#X Amz Target=SimpleWorkflowService.ListClosedWorkflowExecutions'
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: {}
    TagFilter:
      type: object
      required:
      - tag
      properties:
        tag:
          allOf:
          - $ref: '#/components/schemas/Tag'
          - description: '<p> Specifies the tag that must be associated with the execution for it to meet the filter criteria.</p> <p>Tags may only contain unicode letters, digits, whitespace, or these symbols: <code>_ . : / = + - @</code>.</p>'
      description: Used to filter the workflow executions in visibility APIs based on a tag.
    ReverseOrder:
      type: boolean
    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
    PageToken:
      type: string
      maxLength: 2048
    WorkflowTypeFilter:
      type: object
      required:
      - name
      properties:
        name:
          allOf:
          - $ref: '#/components/schemas/Name'
          - description: ' Name of the workflow type.'
        version:
          allOf:
          - $ref: '#/components/schemas/VersionOptional'
          - description: Version of the workflow type.
      description: Used to filter workflow execution query results by type. Each parameter, if specified, defines a rule that must be satisfied by each returned result.
    DomainName:
      type: string
      minLength: 1
      maxLength: 256
    CloseStatusFilter:
      type: object
      required:
      - status
      properties:
        status:
          allOf:
          - $ref: '#/components/schemas/CloseStatus'
          - description: ' The close status that must match the close status of an execution for it to meet the criteria of this filter.'
      description: Used to filter the closed workflow executions in visibility APIs by their close status.
    OperationNotPermittedFault: {}
    TagList:
      type: array
      items:
        $ref: '#/components/schemas/Tag'
      maxItems: 5
    WorkflowExecutionInfos:
      type: object
      required:
      - executionInfos
      properties:
        executionInfos:
          allOf:
          - $ref: '#/components/schemas/WorkflowExecutionInfoList'
          - description: The list of workflow information structures.
        nextPageToken:
          allOf:
          - $ref: '#/components/schemas/PageToken'
          - description: <p>If a <code>NextPageToken</code> was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in <code>nextPageToken</code>. Keep all other arguments unchanged.</p> <p>The configured <code>maximumPageSize</code> determines how many results can be returned in a single call.</p>
      description: Contains a paginated list of information about workflow executions.
    WorkflowRunId:
      type: string
      minLength: 1
      maxLength: 64
    WorkflowExecutionFilter:
      type: object
      required:
      - workflowId
      properties:
        workflowId:
          allOf:
          - $ref: '#/components/schemas/WorkflowId'
          - description: The workflowId to pass of match the criteria of this filter.
      description: Used to filter the workflow executions in visibility APIs by their <code>workflowId</code>.
    ListClosedWorkflowExecutionsInput:
      type: object
      required:
      - domain
      title: ListClosedWorkflowExecutionsInput
      properties:
        domain:
          allOf:
          - $ref: '#/components/schemas/DomainName'
          - description: The name of the domain that contains the workflow executions to list.
        startTimeFilter:
          allOf:
          - $ref: '#/components/schemas/ExecutionTimeFilter'
          - description: <p>If specified, the workflow executions are included in the returned results based on whether their start times are within the range specified by this filter. Also, if this parameter is specified, the returned results are ordered by their start times.</p> <note> <p> <code>startTimeFilter</code> and <code>closeTimeFilter</code> are mutually exclusive. You must specify one of these in a request but not both.</p> </note>
        closeTimeFilter:
          allOf:
          - $ref: '#/components/schemas/ExecutionTimeFilter'
          - description: <p>If specified, the workflow executions are included in the returned results based on whether their close times are within the range specified by this filter. Also, if this parameter is specified, the returned results are ordered by their close times.</p> <note> <p> <code>startTimeFilter</code> and <code>closeTimeFilter</code> are mutually exclusive. You must specify one of these in a request but not both.</p> </note>
        executionFilter:
          allOf:
          - $ref: '#/components/schemas/WorkflowExecutionFilter'
          - description: <p>If specified, only workflow executions matching the workflow ID specified in the filter are returned.</p> <note> <p> <code>closeStatusFilter</code>, <code>executionFilter</code>, <code>typeFilter</code> and <code>tagFilter</code> are mutually exclusive. You can specify at most one of these in a request.</p> </note>
        closeStatusFilter:
          allOf:
          - $ref: '#/components/schemas/CloseStatusFilter'
          - description: <p>If specified, only workflow executions that match this <i>close status</i> are listed. For example, if TERMINATED is specified, then only TERMINATED workflow executions are listed.</p> <note> <p> <code>closeStatusFilter</code>, <code>executionFilter</code>, <code>typeFilter</code> and <code>tagFilter</code> are mutually exclusive. You can specify at most one of these in a request.</p> </note>
        typeFilter:
          allOf:
          - $ref: '#/components/schemas/WorkflowTypeFilter'
          - description: <p>If specified, only executions of the type specified in the filter are returned.</p> <note> <p> <code>closeStatusFilter</code>, <code>executionFilter</code>, <code>typeFilter</code> and <code>tagFilter</code> are mutually exclusive. You can specify at most one of these in a request.</p> </note>
        tagFilter:
          allOf:
          - $ref: '#/components/schemas/TagFilter'
          - description: <p>If specified, only executions that have the matching tag are listed.</p> <note> <p> <code>closeStatusFilter</code>, <code>executionFilter</code>, <code>typeFilter</code> and <code>tagFilter</code> are mutually exclusive. You can specify at most one of these in a request.</p> </note>
        nextPageToken:
          allOf:
          - $ref: '#/components/schemas/PageToken'
          - description: '<p>If <code>NextPageToken</code> is returned there are more results available. The value of <code>NextPageToken</code> is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return a <code>400</code> error: "<code>Specified token has exceeded its maximum lifetime</code>". </p> <p>The configured <code>maximumPageSize</code> determines how many results can be returned in a single call. </p>'
        maximumPageSize:
          allOf:
          - $ref: '#/components/schemas/PageSize'
          - description: 'The maximum number of results that are returned per call. Use <code>nextPageToken</code> to obtain further pages of results. '
        reverseOrder:
          allOf:
          - $ref: '#/components/schemas/ReverseOrder'
          - description: When set to <code>true</code>, returns the results in reverse order. By default the results are returned in descending order of the start or the close time of the executions.
    PageSize:
      type: integer
      minimum: 0
      maximum: 1000
    Canceled:
      type: boolean
    VersionOptional:
      type: string
      maxLength: 64
    Name:
      type: string
      minLength: 1
      maxLength: 256
    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.
    WorkflowExecutionInfoList:
      type: array
      items:
        $ref: '#/components/schemas/WorkflowExecutionInfo'
    Timestamp:
      type: string
      format: date-time
    CloseStatus:
      type: string
      enum:
      - COMPLETED
      - FAILED
      - CANCELED
      - TERMINATED
      - CONTINUED_AS_NEW
      - TIMED_OUT
    ExecutionTimeFilter:
      type: object
      required:
      - oldestDate
      properties:
        oldestDate:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: Specifies the oldest start or close date and time to return.
        latestDate:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: Specifies the latest start or close date and time to return.
      description: 'Used to filter the workflow executions in visibility APIs by various time-based rules. Each parameter, if specified, defines a rule that must be satisfied by each returned query result. The parameter values are in the <a href="https://en.wikipedia.org/wiki/Unix_time">Unix Time format</a>. For example: <code>"oldestDate": 1325376070.</code> '
  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