The #X Amz Target=SimpleWorkflowService.GetWorkflowExecutionHistory API from Amazon Simple Workflow Service — 1 operation(s) for #x amz target=simpleworkflowservice.getworkflowexecutionhistory.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/amazon-swf-x-amz-target-simpleworkflowservice-getworkflowexecutionhistory-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
version: 1.0.0
x-release: v4
title: 'Amazon Simple Workflow Service #X Amz Target=SimpleWorkflowService.CountClosedWorkflowExecutions #X Amz Target=SimpleWorkflowService.CountClosedWorkflowExecutions #X Amz Target=SimpleWorkflowService.GetWorkflowExecutionHistory #X Amz Target=SimpleWorkflowService.GetWorkflowExecutionHistory 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
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.GetWorkflowExecutionHistory'
paths:
/#X-Amz-Target=SimpleWorkflowService.GetWorkflowExecutionHistory:
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: GetWorkflowExecutionHistory
description: <p>Returns the history of the specified workflow execution. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the <code>nextPageToken</code> 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>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/History'
'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/GetWorkflowExecutionHistoryInput'
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.GetWorkflowExecutionHistory
example: SimpleWorkflowService.GetWorkflowExecutionHistory
summary: Amazon SWF Get Workflow Execution History
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- '#X Amz Target=SimpleWorkflowService.GetWorkflowExecutionHistory'
components:
schemas:
PageToken:
type: string
maxLength: 2048
WorkflowExecutionFailedEventAttributes:
type: object
required:
- decisionTaskCompletedEventId
properties:
reason:
allOf:
- $ref: '#/components/schemas/FailureReason'
- description: The descriptive reason provided for the failure.
details:
allOf:
- $ref: '#/components/schemas/Data'
- description: The details of the failure.
decisionTaskCompletedEventId:
allOf:
- $ref: '#/components/schemas/EventId'
- description: The ID of the <code>DecisionTaskCompleted</code> event corresponding to the decision task that resulted in the <code>FailWorkflowExecution</code> decision to fail this execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
description: Provides the details of the <code>WorkflowExecutionFailed</code> event.
ChildWorkflowExecutionCompletedEventAttributes:
type: object
required:
- workflowExecution
- workflowType
- initiatedEventId
- startedEventId
properties:
workflowExecution:
allOf:
- $ref: '#/components/schemas/WorkflowExecution'
- description: The child workflow execution that was completed.
workflowType:
allOf:
- $ref: '#/components/schemas/WorkflowType'
- description: The type of the child workflow execution.
result:
allOf:
- $ref: '#/components/schemas/Data'
- description: The result of the child workflow execution.
initiatedEventId:
allOf:
- $ref: '#/components/schemas/EventId'
- description: The ID of the <code>StartChildWorkflowExecutionInitiated</code> event corresponding to the <code>StartChildWorkflowExecution</code> <a>Decision</a> to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
startedEventId:
allOf:
- $ref: '#/components/schemas/EventId'
- description: The ID of the <code>ChildWorkflowExecutionStarted</code> event recorded when this child workflow execution was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
description: Provides the details of the <code>ChildWorkflowExecutionCompleted</code> event.
ChildPolicy:
type: string
enum:
- TERMINATE
- REQUEST_CANCEL
- ABANDON
TimerFiredEventAttributes:
type: object
required:
- timerId
- startedEventId
properties:
timerId:
allOf:
- $ref: '#/components/schemas/TimerId'
- description: The unique ID of the timer that fired.
startedEventId:
allOf:
- $ref: '#/components/schemas/EventId'
- description: The ID of the <code>TimerStarted</code> event that was recorded when this timer was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
description: Provides the details of the <code>TimerFired</code> event.
WorkflowExecutionCanceledEventAttributes:
type: object
required:
- decisionTaskCompletedEventId
properties:
details:
allOf:
- $ref: '#/components/schemas/Data'
- description: The details of the cancellation.
decisionTaskCompletedEventId:
allOf:
- $ref: '#/components/schemas/EventId'
- description: The ID of the <code>DecisionTaskCompleted</code> event corresponding to the decision task that resulted in the <code>CancelWorkflowExecution</code> decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
description: Provides the details of the <code>WorkflowExecutionCanceled</code> event.
TimerCanceledEventAttributes:
type: object
required:
- timerId
- startedEventId
- decisionTaskCompletedEventId
properties:
timerId:
allOf:
- $ref: '#/components/schemas/TimerId'
- description: The unique ID of the timer that was canceled.
startedEventId:
allOf:
- $ref: '#/components/schemas/EventId'
- description: The ID of the <code>TimerStarted</code> event that was recorded when this timer was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
decisionTaskCompletedEventId:
allOf:
- $ref: '#/components/schemas/EventId'
- description: The ID of the <code>DecisionTaskCompleted</code> event corresponding to the decision task that resulted in the <code>CancelTimer</code> decision to cancel this timer. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
description: ' Provides the details of the <code>TimerCanceled</code> event. '
WorkflowExecutionTimedOutEventAttributes:
type: object
required:
- timeoutType
- childPolicy
properties:
timeoutType:
allOf:
- $ref: '#/components/schemas/WorkflowExecutionTimeoutType'
- description: The type of timeout that caused this event.
childPolicy:
allOf:
- $ref: '#/components/schemas/ChildPolicy'
- description: <p>The policy used for the child workflow executions of this workflow execution.</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>
description: Provides the details of the <code>WorkflowExecutionTimedOut</code> event.
CancelTimerFailedCause:
type: string
enum:
- TIMER_ID_UNKNOWN
- OPERATION_NOT_PERMITTED
UnknownResourceFault: {}
ScheduleActivityTaskFailedEventAttributes:
type: object
required:
- activityType
- activityId
- cause
- decisionTaskCompletedEventId
properties:
activityType:
allOf:
- $ref: '#/components/schemas/ActivityType'
- description: The activity type provided in the <code>ScheduleActivityTask</code> decision that failed.
activityId:
allOf:
- $ref: '#/components/schemas/ActivityId'
- description: The activityId provided in the <code>ScheduleActivityTask</code> decision that failed.
cause:
allOf:
- $ref: '#/components/schemas/ScheduleActivityTaskFailedCause'
- description: <p>The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.</p> <note> <p>If <code>cause</code> is set to <code>OPERATION_NOT_PERMITTED</code>, the decision failed because it lacked sufficient permissions. 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> </note>
decisionTaskCompletedEventId:
allOf:
- $ref: '#/components/schemas/EventId'
- description: The ID of the <code>DecisionTaskCompleted</code> event corresponding to the decision that resulted in the scheduling of this activity task. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
description: Provides the details of the <code>ScheduleActivityTaskFailed</code> event.
CompleteWorkflowExecutionFailedEventAttributes:
type: object
required:
- cause
- decisionTaskCompletedEventId
properties:
cause:
allOf:
- $ref: '#/components/schemas/CompleteWorkflowExecutionFailedCause'
- description: <p>The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.</p> <note> <p>If <code>cause</code> is set to <code>OPERATION_NOT_PERMITTED</code>, the decision failed because it lacked sufficient permissions. 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> </note>
decisionTaskCompletedEventId:
allOf:
- $ref: '#/components/schemas/EventId'
- description: The ID of the <code>DecisionTaskCompleted</code> event corresponding to the decision task that resulted in the <code>CompleteWorkflowExecution</code> decision to complete this execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
description: Provides the details of the <code>CompleteWorkflowExecutionFailed</code> event.
Identity:
type: string
maxLength: 256
DecisionTaskTimeoutType:
type: string
enum:
- START_TO_CLOSE
Name:
type: string
minLength: 1
maxLength: 256
TimerId:
type: string
minLength: 1
maxLength: 256
ActivityTaskFailedEventAttributes:
type: object
required:
- scheduledEventId
- startedEventId
properties:
reason:
allOf:
- $ref: '#/components/schemas/FailureReason'
- description: The reason provided for the failure.
details:
allOf:
- $ref: '#/components/schemas/Data'
- description: The details of the failure.
scheduledEventId:
allOf:
- $ref: '#/components/schemas/EventId'
- description: The ID of the <code>ActivityTaskScheduled</code> event that was recorded when this activity task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
startedEventId:
allOf:
- $ref: '#/components/schemas/EventId'
- description: The ID of the <code>ActivityTaskStarted</code> event recorded when this activity task was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
description: Provides the details of the <code>ActivityTaskFailed</code> event.
MarkerName:
type: string
minLength: 1
maxLength: 256
StartTimerFailedEventAttributes:
type: object
required:
- timerId
- cause
- decisionTaskCompletedEventId
properties:
timerId:
allOf:
- $ref: '#/components/schemas/TimerId'
- description: The timerId provided in the <code>StartTimer</code> decision that failed.
cause:
allOf:
- $ref: '#/components/schemas/StartTimerFailedCause'
- description: <p>The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.</p> <note> <p>If <code>cause</code> is set to <code>OPERATION_NOT_PERMITTED</code>, the decision failed because it lacked sufficient permissions. 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> </note>
decisionTaskCompletedEventId:
allOf:
- $ref: '#/components/schemas/EventId'
- description: The ID of the <code>DecisionTaskCompleted</code> event corresponding to the decision task that resulted in the <code>StartTimer</code> decision for this activity task. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
description: Provides the details of the <code>StartTimerFailed</code> event.
DecisionTaskScheduledEventAttributes:
type: object
required:
- taskList
properties:
taskList:
allOf:
- $ref: '#/components/schemas/TaskList'
- description: The name of the task list in which the decision task was scheduled.
taskPriority:
allOf:
- $ref: '#/components/schemas/TaskPriority'
- description: <p> A task priority that, if set, specifies the priority for this decision task. 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>
startToCloseTimeout:
allOf:
- $ref: '#/components/schemas/DurationInSecondsOptional'
- description: <p>The maximum duration for this decision task. The task is considered timed out if it doesn't completed within this duration.</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>
description: Provides details about the <code>DecisionTaskScheduled</code> event.
StartChildWorkflowExecutionFailedEventAttributes:
type: object
required:
- workflowType
- cause
- workflowId
- initiatedEventId
- decisionTaskCompletedEventId
properties:
workflowType:
allOf:
- $ref: '#/components/schemas/WorkflowType'
- description: The workflow type provided in the <code>StartChildWorkflowExecution</code> <a>Decision</a> that failed.
cause:
allOf:
- $ref: '#/components/schemas/StartChildWorkflowExecutionFailedCause'
- description: <p>The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.</p> <note> <p>When <code>cause</code> is set to <code>OPERATION_NOT_PERMITTED</code>, the decision fails because it lacks sufficient permissions. 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> </note>
workflowId:
allOf:
- $ref: '#/components/schemas/WorkflowId'
- description: The <code>workflowId</code> of the child workflow execution.
initiatedEventId:
allOf:
- $ref: '#/components/schemas/EventId'
- description: <p>When the <code>cause</code> is <code>WORKFLOW_ALREADY_RUNNING</code>, <code>initiatedEventId</code> is the ID of the <code>StartChildWorkflowExecutionInitiated</code> event that corresponds to the <code>StartChildWorkflowExecution</code> <a>Decision</a> to start the workflow execution. You can use this information to diagnose problems by tracing back the chain of events leading up to this event.</p> <p>When the <code>cause</code> isn't <code>WORKFLOW_ALREADY_RUNNING</code>, <code>initiatedEventId</code> is set to <code>0</code> because the <code>StartChildWorkflowExecutionInitiated</code> event doesn't exist.</p>
decisionTaskCompletedEventId:
allOf:
- $ref: '#/components/schemas/EventId'
- description: The ID of the <code>DecisionTaskCompleted</code> event corresponding to the decision task that resulted in the <code>StartChildWorkflowExecution</code> <a>Decision</a> to request this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events.
control:
allOf:
- $ref: '#/components/schemas/Data'
- description: The data attached to the event that the decider can use in subsequent workflow tasks. This data isn't sent to the child workflow execution.
description: Provides the details of the <code>StartChildWorkflowExecutionFailed</code> event.
ScheduleActivityTaskFailedCause:
type: string
enum:
- ACTIVITY_TYPE_DEPRECATED
- ACTIVITY_TYPE_DOES_NOT_EXIST
- ACTIVITY_ID_ALREADY_IN_USE
- OPEN_ACTIVITIES_LIMIT_EXCEEDED
- ACTIVITY_CREATION_RATE_EXCEEDED
- DEFAULT_SCHEDULE_TO_CLOSE_TIMEOUT_UNDEFINED
- DEFAULT_TASK_LIST_UNDEFINED
- DEFAULT_SCHEDULE_TO_START_TIMEOUT_UNDEFINED
- DEFAULT_START_TO_CLOSE_TIMEOUT_UNDEFINED
- DEFAULT_HEARTBEAT_TIMEOUT_UNDEFINED
- OPERATION_NOT_PERMITTED
SignalExternalWorkflowExecutionFailedEventAttributes:
type: object
required:
- workflowId
- cause
- initiatedEventId
- decisionTaskCompletedEventId
properties:
workflowId:
allOf:
- $ref: '#/components/schemas/WorkflowId'
- description: The <code>workflowId</code> of the external workflow execution that the signal was being delivered to.
runId:
allOf:
- $ref: '#/components/schemas/WorkflowRunIdOptional'
- description: The <code>runId</code> of the external workflow execution that the signal was being delivered to.
cause:
allOf:
- $ref: '#/components/schemas/SignalExternalWorkflowExecutionFailedCause'
- description: <p>The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.</p> <note> <p>If <code>cause</code> is set to <code>OPERATION_NOT_PERMITTED</code>, the decision failed because it lacked sufficient permissions. 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> </note>
initiatedEventId:
allOf:
- $ref: '#/components/schemas/EventId'
- description: The ID of the <code>SignalExternalWorkflowExecutionInitiated</code> event corresponding to the <code>SignalExternalWorkflowExecution</code> decision to request this signal. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
decisionTaskCompletedEventId:
allOf:
- $ref: '#/components/schemas/EventId'
- description: The ID of the <code>DecisionTaskCompleted</code> event corresponding to the decision task that resulted in the <code>SignalExternalWorkflowExecution</code> decision for this signal. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
control:
allOf:
- $ref: '#/components/schemas/Data'
- description: The data attached to the event that the decider can use in subsequent workflow tasks. This data isn't sent to the workflow execution.
description: Provides the details of the <code>SignalExternalWorkflowExecutionFailed</code> event.
TaskPriority:
type: string
FailWorkflowExecutionFailedEventAttributes:
type: object
required:
- cause
- decisionTaskCompletedEventId
properties:
cause:
allOf:
- $ref: '#/components/schemas/FailWorkflowExecutionFailedCause'
- description: <p>The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.</p> <note> <p>If <code>cause</code> is set to <code>OPERATION_NOT_PERMITTED</code>, the decision failed because it lacked sufficient permissions. 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> </note>
decisionTaskCompletedEventId:
allOf:
- $ref: '#/components/schemas/EventId'
- description: The ID of the <code>DecisionTaskCompleted</code> event corresponding to the decision task that resulted in the <code>FailWorkflowExecution</code> decision to fail this execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
description: Provides the details of the <code>FailWorkflowExecutionFailed</code> event.
CauseMessage:
type: string
maxLength: 1728
PageSize:
type: integer
minimum: 0
maximum: 1000
WorkflowExecutionTerminatedEventAttributes:
type: object
required:
- childPolicy
properties:
reason:
allOf:
- $ref: '#/components/schemas/TerminateReason'
- description: The reason provided for the termination.
details:
allOf:
- $ref: '#/components/schemas/Data'
- description: The details provided for the termination.
childPolicy:
allOf:
- $ref: '#/components/schemas/ChildPolicy'
- description: <p>The policy used for the child workflow executions of this workflow execution.</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>
cause:
allOf:
- $ref: '#/components/schemas/WorkflowExecutionTerminatedCause'
- description: If set, indicates that the workflow execution was automatically terminated, and specifies the cause. This happens if the parent workflow execution times out or is terminated and the child policy is set to terminate child executions.
description: Provides the details of the <code>WorkflowExecutionTerminated</code> event.
LambdaFunctionCompletedEventAttributes:
type: object
required:
- scheduledEventId
- startedEventId
properties:
scheduledEventId:
allOf:
- $ref: '#/components/schemas/EventId'
- description: The ID of the <code>LambdaFunctionScheduled</code> event that was recorded when this Lambda task was scheduled. To help diagnose issues, use this information to trace back the chain of events leading up to this event.
startedEventId:
allOf:
- $ref: '#/components/schemas/EventId'
- description: The ID of the <code>LambdaFunctionStarted</code> event recorded when this activity task started. To help diagnose issues, use this information to trace back the chain of events leading up to this event.
result:
allOf:
- $ref: '#/components/schemas/Data'
- description: The results of the Lambda task.
description: Provides the details of the <code>LambdaFunctionCompleted</code> event. It isn't set for other event types.
LambdaFunctionFailedEventAttributes:
type: object
required:
- scheduledEventId
- startedEventId
properties:
scheduledEventId:
allOf:
- $ref: '#/components/schemas/EventId'
- description: The ID of the <code>LambdaFunctionScheduled</code> event that was recorded when this activity task was scheduled. To help diagnose issues, use this information to trace back the chain of events leading up to this event.
startedEventId:
allOf:
- $ref: '#/components/schemas/EventId'
- description: The ID of the <code>LambdaFunctionStarted</code> event recorded when this activity task started. To help diagnose issues, use this information to trace back the chain of events leading up to this event.
reason:
allOf:
- $ref: '#/components/schemas/FailureReason'
- description: The reason provided for the failure.
details:
allOf:
- $ref: '#/components/schemas/Data'
- description: The details of the failure.
description: Provides the details of the <code>LambdaFunctionFailed</code> event. It isn't set for other event types.
Arn:
type: string
minLength: 1
maxLen
# --- truncated at 32 KB (125 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amazon-swf/refs/heads/main/openapi/amazon-swf-x-amz-target-simpleworkflowservice-getworkflowexecutionhistory-api-openapi.yml