openapi: 3.1.0 info: title: 'Amazon Step Functions Executions #X Amz Target=AWSStepFunctions.GetExecutionHistory API' description: Amazon Step Functions is a serverless workflow orchestration service that lets you coordinate distributed applications and microservices using visual workflows. This API enables you to create and manage state machines, start and monitor executions, and retrieve execution history. version: '2016-11-23' contact: name: Amazon Web Services url: https://aws.amazon.com/contact-us/ termsOfService: https://aws.amazon.com/service-terms/ servers: - url: https://states.{region}.amazonaws.com description: Amazon Step Functions Regional Endpoint variables: region: default: us-east-1 description: AWS Region security: - sigv4Auth: [] tags: - name: '#X Amz Target=AWSStepFunctions.GetExecutionHistory' paths: /#X-Amz-Target=AWSStepFunctions.GetExecutionHistory: 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: GetExecutionHistory description:

Returns the history of the specified execution as a list of events. By default, the results are returned in ascending order of the timeStamp of the events. Use the reverseOrder parameter to get the latest events first.

If nextToken is returned, there are more results available. The value of nextToken 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 an HTTP 400 InvalidToken error.

This API action is not supported by EXPRESS state machines.

responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetExecutionHistoryOutput' examples: GetExecutionHistory200Example: summary: Default GetExecutionHistory 200 x-microcks-default: true value: events: example-value nextToken: example-value '480': description: ExecutionDoesNotExist content: application/json: schema: $ref: '#/components/schemas/ExecutionDoesNotExist' examples: GetExecutionHistory480Example: summary: Default GetExecutionHistory 480 x-microcks-default: true value: example-value '481': description: InvalidArn content: application/json: schema: $ref: '#/components/schemas/InvalidArn' examples: GetExecutionHistory481Example: summary: Default GetExecutionHistory 481 x-microcks-default: true value: example-value '482': description: InvalidToken content: application/json: schema: $ref: '#/components/schemas/InvalidToken' examples: GetExecutionHistory482Example: summary: Default GetExecutionHistory 482 x-microcks-default: true value: example-value requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GetExecutionHistoryInput' examples: GetExecutionHistoryRequestExample: summary: Default GetExecutionHistory request x-microcks-default: true value: executionArn: arn:aws:service:us-east-1:123456789012:resource/example maxResults: example-value reverseOrder: example-value nextToken: example-value includeExecutionData: example-value 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 - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSStepFunctions.GetExecutionHistory summary: Amazon Get Execution History x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - '#X Amz Target=AWSStepFunctions.GetExecutionHistory' components: schemas: HistoryEventType: type: string enum: - ActivityFailed - ActivityScheduled - ActivityScheduleFailed - ActivityStarted - ActivitySucceeded - ActivityTimedOut - ChoiceStateEntered - ChoiceStateExited - ExecutionAborted - ExecutionFailed - ExecutionStarted - ExecutionSucceeded - ExecutionTimedOut - FailStateEntered - LambdaFunctionFailed - LambdaFunctionScheduled - LambdaFunctionScheduleFailed - LambdaFunctionStarted - LambdaFunctionStartFailed - LambdaFunctionSucceeded - LambdaFunctionTimedOut - MapIterationAborted - MapIterationFailed - MapIterationStarted - MapIterationSucceeded - MapStateAborted - MapStateEntered - MapStateExited - MapStateFailed - MapStateStarted - MapStateSucceeded - ParallelStateAborted - ParallelStateEntered - ParallelStateExited - ParallelStateFailed - ParallelStateStarted - ParallelStateSucceeded - PassStateEntered - PassStateExited - SucceedStateEntered - SucceedStateExited - TaskFailed - TaskScheduled - TaskStarted - TaskStartFailed - TaskStateAborted - TaskStateEntered - TaskStateExited - TaskSubmitFailed - TaskSubmitted - TaskSucceeded - TaskTimedOut - WaitStateAborted - WaitStateEntered - WaitStateExited - MapRunAborted - MapRunFailed - MapRunStarted - MapRunSucceeded ActivitySucceededEventDetails: type: object properties: output: allOf: - $ref: '#/components/schemas/SensitiveData' - description: The JSON data output by the activity task. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding. outputDetails: allOf: - $ref: '#/components/schemas/HistoryEventExecutionDataDetails' - description: Contains details about the output of an execution history event. description: Contains details about an activity that successfully terminated during an execution. LambdaFunctionSucceededEventDetails: type: object properties: output: allOf: - $ref: '#/components/schemas/SensitiveData' - description: The JSON data output by the Lambda function. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding. outputDetails: allOf: - $ref: '#/components/schemas/HistoryEventExecutionDataDetails' - description: Contains details about the output of an execution history event. description: Contains details about a Lambda function that successfully terminated during an execution. ExecutionAbortedEventDetails: type: object properties: error: allOf: - $ref: '#/components/schemas/SensitiveError' - description: The error code of the failure. cause: allOf: - $ref: '#/components/schemas/SensitiveCause' - description: A more detailed explanation of the cause of the failure. description: Contains details about an abort of an execution. LambdaFunctionFailedEventDetails: type: object properties: error: allOf: - $ref: '#/components/schemas/SensitiveError' - description: The error code of the failure. cause: allOf: - $ref: '#/components/schemas/SensitiveCause' - description: A more detailed explanation of the cause of the failure. description: Contains details about a Lambda function that failed during an execution. MapStateStartedEventDetails: type: object properties: length: allOf: - $ref: '#/components/schemas/UnsignedInteger' - description: The size of the array for Map state iterations. description: Details about a Map state that was started. IncludeExecutionDataGetExecutionHistory: type: boolean MapRunStartedEventDetails: type: object properties: mapRunArn: allOf: - $ref: '#/components/schemas/LongArn' - description: The Amazon Resource Name (ARN) of a Map Run that was started. description: Contains details about a Map Run that was started during a state machine execution. LambdaFunctionScheduleFailedEventDetails: type: object properties: error: allOf: - $ref: '#/components/schemas/SensitiveError' - description: The error code of the failure. cause: allOf: - $ref: '#/components/schemas/SensitiveCause' - description: A more detailed explanation of the cause of the failure. description: Contains details about a failed Lambda function schedule event that occurred during an execution. UnsignedInteger: type: integer minimum: 0 TaskFailedEventDetails: type: object required: - resourceType - resource properties: resourceType: allOf: - $ref: '#/components/schemas/Name' - description: The service name of the resource in a task state. resource: allOf: - $ref: '#/components/schemas/Name' - description: The action of the resource called by a task state. error: allOf: - $ref: '#/components/schemas/SensitiveError' - description: The error code of the failure. cause: allOf: - $ref: '#/components/schemas/SensitiveCause' - description: A more detailed explanation of the cause of the failure. description: Contains details about a task failure event. ActivityScheduleFailedEventDetails: type: object properties: error: allOf: - $ref: '#/components/schemas/SensitiveError' - description: The error code of the failure. cause: allOf: - $ref: '#/components/schemas/SensitiveCause' - description: A more detailed explanation of the cause of the failure. description: Contains details about an activity schedule failure that occurred during an execution. HistoryEventList: type: array description: Contains details about the events that occurred during an execution. items: $ref: '#/components/schemas/HistoryEvent' PageSize: type: integer minimum: 0 maximum: 1000 StateEnteredEventDetails: type: object required: - name properties: name: allOf: - $ref: '#/components/schemas/Name' - description: The name of the state. input: allOf: - $ref: '#/components/schemas/SensitiveData' - description: The string that contains the JSON input data for the state. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding. inputDetails: allOf: - $ref: '#/components/schemas/HistoryEventExecutionDataDetails' - description: Contains details about the input for an execution history event. description: Contains details about a state entered during an execution. Name: type: string minLength: 1 maxLength: 80 TaskSubmittedEventDetails: type: object required: - resourceType - resource properties: resourceType: allOf: - $ref: '#/components/schemas/Name' - description: The service name of the resource in a task state. resource: allOf: - $ref: '#/components/schemas/Name' - description: The action of the resource called by a task state. output: allOf: - $ref: '#/components/schemas/SensitiveData' - description: The response from a resource when a task has started. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding. outputDetails: allOf: - $ref: '#/components/schemas/HistoryEventExecutionDataDetails' - description: Contains details about the output of an execution history event. description: Contains details about a task submitted to a resource . GetExecutionHistoryOutput: type: object required: - events properties: events: allOf: - $ref: '#/components/schemas/HistoryEventList' - description: The list of events that occurred in the execution. nextToken: allOf: - $ref: '#/components/schemas/PageToken' - description: If nextToken is returned, there are more results available. The value of nextToken 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 an HTTP 400 InvalidToken error. HistoryEvent: type: object required: - timestamp - type - id properties: timestamp: allOf: - $ref: '#/components/schemas/Timestamp' - description: The date and time the event occurred. type: allOf: - $ref: '#/components/schemas/HistoryEventType' - description: The type of the event. id: allOf: - $ref: '#/components/schemas/EventId' - description: The id of the event. Events are numbered sequentially, starting at one. previousEventId: allOf: - $ref: '#/components/schemas/EventId' - description: The id of the previous event. activityFailedEventDetails: $ref: '#/components/schemas/ActivityFailedEventDetails' activityScheduleFailedEventDetails: allOf: - $ref: '#/components/schemas/ActivityScheduleFailedEventDetails' - description: Contains details about an activity schedule event that failed during an execution. activityScheduledEventDetails: $ref: '#/components/schemas/ActivityScheduledEventDetails' activityStartedEventDetails: $ref: '#/components/schemas/ActivityStartedEventDetails' activitySucceededEventDetails: $ref: '#/components/schemas/ActivitySucceededEventDetails' activityTimedOutEventDetails: $ref: '#/components/schemas/ActivityTimedOutEventDetails' taskFailedEventDetails: allOf: - $ref: '#/components/schemas/TaskFailedEventDetails' - description: Contains details about the failure of a task. taskScheduledEventDetails: allOf: - $ref: '#/components/schemas/TaskScheduledEventDetails' - description: Contains details about a task that was scheduled. taskStartFailedEventDetails: allOf: - $ref: '#/components/schemas/TaskStartFailedEventDetails' - description: Contains details about a task that failed to start. taskStartedEventDetails: allOf: - $ref: '#/components/schemas/TaskStartedEventDetails' - description: Contains details about a task that was started. taskSubmitFailedEventDetails: allOf: - $ref: '#/components/schemas/TaskSubmitFailedEventDetails' - description: Contains details about a task that where the submit failed. taskSubmittedEventDetails: allOf: - $ref: '#/components/schemas/TaskSubmittedEventDetails' - description: Contains details about a submitted task. taskSucceededEventDetails: allOf: - $ref: '#/components/schemas/TaskSucceededEventDetails' - description: Contains details about a task that succeeded. taskTimedOutEventDetails: allOf: - $ref: '#/components/schemas/TaskTimedOutEventDetails' - description: Contains details about a task that timed out. executionFailedEventDetails: $ref: '#/components/schemas/ExecutionFailedEventDetails' executionStartedEventDetails: $ref: '#/components/schemas/ExecutionStartedEventDetails' executionSucceededEventDetails: $ref: '#/components/schemas/ExecutionSucceededEventDetails' executionAbortedEventDetails: $ref: '#/components/schemas/ExecutionAbortedEventDetails' executionTimedOutEventDetails: $ref: '#/components/schemas/ExecutionTimedOutEventDetails' mapStateStartedEventDetails: allOf: - $ref: '#/components/schemas/MapStateStartedEventDetails' - description: Contains details about Map state that was started. mapIterationStartedEventDetails: allOf: - $ref: '#/components/schemas/MapIterationEventDetails' - description: Contains details about an iteration of a Map state that was started. mapIterationSucceededEventDetails: allOf: - $ref: '#/components/schemas/MapIterationEventDetails' - description: Contains details about an iteration of a Map state that succeeded. mapIterationFailedEventDetails: allOf: - $ref: '#/components/schemas/MapIterationEventDetails' - description: Contains details about an iteration of a Map state that failed. mapIterationAbortedEventDetails: allOf: - $ref: '#/components/schemas/MapIterationEventDetails' - description: Contains details about an iteration of a Map state that was aborted. lambdaFunctionFailedEventDetails: $ref: '#/components/schemas/LambdaFunctionFailedEventDetails' lambdaFunctionScheduleFailedEventDetails: $ref: '#/components/schemas/LambdaFunctionScheduleFailedEventDetails' lambdaFunctionScheduledEventDetails: $ref: '#/components/schemas/LambdaFunctionScheduledEventDetails' lambdaFunctionStartFailedEventDetails: allOf: - $ref: '#/components/schemas/LambdaFunctionStartFailedEventDetails' - description: Contains details about a lambda function that failed to start during an execution. lambdaFunctionSucceededEventDetails: allOf: - $ref: '#/components/schemas/LambdaFunctionSucceededEventDetails' - description: Contains details about a Lambda function that terminated successfully during an execution. lambdaFunctionTimedOutEventDetails: $ref: '#/components/schemas/LambdaFunctionTimedOutEventDetails' stateEnteredEventDetails: $ref: '#/components/schemas/StateEnteredEventDetails' stateExitedEventDetails: $ref: '#/components/schemas/StateExitedEventDetails' mapRunStartedEventDetails: allOf: - $ref: '#/components/schemas/MapRunStartedEventDetails' - description: Contains details, such as mapRunArn, and the start date and time of a Map Run. mapRunArn is the Amazon Resource Name (ARN) of the Map Run that was started. mapRunFailedEventDetails: allOf: - $ref: '#/components/schemas/MapRunFailedEventDetails' - description: Contains error and cause details about a Map Run that failed. description: Contains details about the events of an execution. ActivityTimedOutEventDetails: type: object properties: error: allOf: - $ref: '#/components/schemas/SensitiveError' - description: The error code of the failure. cause: allOf: - $ref: '#/components/schemas/SensitiveCause' - description: A more detailed explanation of the cause of the timeout. description: Contains details about an activity timeout that occurred during an execution. TaskCredentials: type: object properties: roleArn: allOf: - $ref: '#/components/schemas/LongArn' - description: The ARN of an IAM role that Step Functions assumes for the task. The role can allow cross-account access to resources. description: Contains details about the credentials that Step Functions uses for a task. ExecutionFailedEventDetails: type: object properties: error: allOf: - $ref: '#/components/schemas/SensitiveError' - description: The error code of the failure. cause: allOf: - $ref: '#/components/schemas/SensitiveCause' - description: A more detailed explanation of the cause of the failure. description: Contains details about an execution failure event. TaskTimedOutEventDetails: type: object required: - resourceType - resource properties: resourceType: allOf: - $ref: '#/components/schemas/Name' - description: The service name of the resource in a task state. resource: allOf: - $ref: '#/components/schemas/Name' - description: The action of the resource called by a task state. error: allOf: - $ref: '#/components/schemas/SensitiveError' - description: The error code of the failure. cause: allOf: - $ref: '#/components/schemas/SensitiveCause' - description: A more detailed explanation of the cause of the failure. description: Contains details about a resource timeout that occurred during an execution. InvalidArn: {} ExecutionDoesNotExist: {} ExecutionTimedOutEventDetails: type: object properties: error: allOf: - $ref: '#/components/schemas/SensitiveError' - description: The error code of the failure. cause: allOf: - $ref: '#/components/schemas/SensitiveCause' - description: A more detailed explanation of the cause of the timeout. description: Contains details about the execution timeout that occurred during the execution. TaskStartFailedEventDetails: type: object required: - resourceType - resource properties: resourceType: allOf: - $ref: '#/components/schemas/Name' - description: The service name of the resource in a task state. resource: allOf: - $ref: '#/components/schemas/Name' - description: The action of the resource called by a task state. error: allOf: - $ref: '#/components/schemas/SensitiveError' - description: The error code of the failure. cause: allOf: - $ref: '#/components/schemas/SensitiveCause' - description: A more detailed explanation of the cause of the failure. description: Contains details about a task that failed to start during an execution. InvalidToken: {} SensitiveData: type: string maxLength: 262144 format: password TimeoutInSeconds: type: integer MapIterationEventDetails: type: object properties: name: allOf: - $ref: '#/components/schemas/Name' - description: The name of the iteration’s parent Map state. index: allOf: - $ref: '#/components/schemas/UnsignedInteger' - description: The index of the array belonging to the Map state iteration. description: Contains details about an iteration of a Map state. Identity: type: string maxLength: 256 ExecutionStartedEventDetails: type: object properties: input: allOf: - $ref: '#/components/schemas/SensitiveData' - description: The JSON data input to the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding. inputDetails: allOf: - $ref: '#/components/schemas/HistoryEventExecutionDataDetails' - description: Contains details about the input for an execution history event. roleArn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the IAM role used for executing Lambda tasks. stateMachineAliasArn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) that identifies a state machine alias used for starting the state machine execution. stateMachineVersionArn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) that identifies a state machine version used for starting the state machine execution. description: Contains details about the start of the execution. ReverseOrder: type: boolean ExecutionSucceededEventDetails: type: object properties: output: allOf: - $ref: '#/components/schemas/SensitiveData' - description: The JSON data output by the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding. outputDetails: allOf: - $ref: '#/components/schemas/HistoryEventExecutionDataDetails' - description: Contains details about the output of an execution history event. description: Contains details about the successful termination of the execution. LambdaFunctionScheduledEventDetails: type: object required: - resource properties: resource: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the scheduled Lambda function. input: allOf: - $ref: '#/components/schemas/SensitiveData' - description: The JSON data input to the Lambda function. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding. inputDetails: allOf: - $ref: '#/components/schemas/HistoryEventExecutionDataDetails' - description: Contains details about input for an execution history event. timeoutInSeconds: allOf: - $ref: '#/components/schemas/TimeoutInSeconds' - description: The maximum allowed duration of the Lambda function. taskCredentials: allOf: - $ref: '#/components/schemas/TaskCredentials' - description: The credentials that Step Functions uses for the task. description: Contains details about a Lambda function scheduled during an execution. TaskSubmitFailedEventDetails: type: object required: - resourceType - resource properties: resourceType: allOf: - $ref: '#/components/schemas/Name' - description: The service name of the resource in a task state. resource: allOf: - $ref: '#/components/schemas/Name' - description: The action of the resource called by a task state. error: allOf: - $ref: '#/components/schemas/SensitiveError' - description: The error code of the failure. cause: allOf: - $ref: '#/components/schemas/SensitiveCause' - description: A more detailed explanation of the cause of the failure. description: Contains details about a task that failed to submit during an execution. SensitiveError: type: string minLength: 0 maxLength: 256 format: password MapRunFailedEventDetails: type: object properties: error: allOf: - $ref: '#/components/schemas/SensitiveError' - description: The error code of the Map Run failure. cause: allOf: - $ref: '#/components/schemas/SensitiveCause' - description: A more detailed explanation of the cause of the failure. description: Contains details about a Map Run failure event that occurred during a state machine execution. SensitiveCause: type: string minLength: 0 maxLength: 32768 format: password ActivityStartedEventDetails: type: object properties: workerName: allOf: - $ref: '#/components/schemas/Identity' - description: The name of the worker that the task is assigned to. These names are provided by the workers when calling GetActivityTask. description: Contains details about the start of an activity during an execution. LongArn: type: string minLength: 1 maxLength: 2000 truncated: type: boolean TaskStartedEventDetails: type: object required: - resourceType - resource properties: resourceType: allOf: - $ref: '#/components/schemas/Name' - description: The service name of the resource in a task state. resource: allOf: - $ref: '#/components/schemas/Name' - description: The action of the resource called by a task state. description: Contains details about the start of a task during an execution. LambdaFunctionTimedOutEventDetails: type: object properties: error: allOf: - $ref: '#/components/schemas/SensitiveError' - description: The error code of the failure. cause: allOf: - $ref: '#/components/schemas/SensitiveCause' - description: A more detailed explanation of the cause of the timeout. description: Contains details about a Lambda function timeout that occurred during an execution. GetExecutionHistoryInput: type: object required: - executionArn title: GetExecutionHistoryInput properties: executionArn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the execution. maxResults: allOf: - $ref: '#/components/schemas/PageSize' - description:

The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.

This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

reverseOrder: allOf: - $ref: '#/components/schemas/ReverseOrder' - description: Lists events in descending order of their timeStamp. nextToken: allOf: - $ref: '#/components/schemas/PageToken' - description: If nextToken is returned, there are more results available. The value of nextToken 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 an HTTP 400 InvalidToken error. includeExecutionData: allOf: - $ref: '#/components/schemas/IncludeExecutionDataGetExecutionHistory' - description: You can select whether execution data (input or output of a history event) is returned. The default is true. TaskSucceededEventDetails: type: object required: - resourceType - resource properties: resourceType: allOf: - $ref: '#/components/schemas/Name' - description: The service name of the resource in a task state. resource: allOf: - $ref: '#/components/schemas/Name' - description: The action of the resource called by a task state. output: allOf: - $ref: '#/components/schemas/SensitiveData' - description: The full JSON response from a resource when a task has succeeded. This response becomes the output of the related task. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding. outputDetails: allOf: - $ref: '#/components/schemas/HistoryEventExecutionDataDetails' - description: Contains details about the output of an execution history event. description: Contains details about the successful completion of a task state. ActivityScheduledEventDetails: type: object required: - resource properties: resource: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the scheduled activity. input: allOf: - $ref: '#/components/schemas/SensitiveData' - description: The JSON data input to the activity task. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding. inputDetails: allOf: - $ref: '#/components/schemas/HistoryEventExecutionDataDetails' - description: Contains details about the input for an execution history event. timeoutInSeconds: allOf: - $ref: '#/components/schemas/TimeoutInSeconds' - description: The maximum allowed duration of the activity task. heartbeatInSeconds: allOf: - $ref: '#/components/schemas/TimeoutInSeconds' - description: The maximum allowed duration between two heartbeats for the activity task. description: Contains details about an activity scheduled during an execution. Arn: type: string minLength: 1 maxLength: 256 Timestamp: type: string format: date-time LambdaFunctionStartFailedEventDetails: type: object properties: error: allOf: - $ref: '#/components/schemas/SensitiveError' - description: The error code of the failure. cause: allOf: - $ref: '#/components/schemas/SensitiveCause' - description: A more detailed explanation of the cause of the failure. description: Contains details about a lambda function that failed to start during an execution. StateExitedEventDetails: type: object required: - name properties: name: allOf: - $ref: '#/components/schemas/Name' - description: '

The name of the state.

A name must not contain:

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

' output: allOf: - $ref: '#/components/schemas/SensitiveData' - description: The JSON output data of the state. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding. outputDetails: allOf: - $ref: '#/components/schemas/HistoryEventExecutionDataDetails' - description: Contains details about the output of an execution history event. description: Contains details about an exit from a state during an execution. TaskScheduledEventDetails: type: object required: - resourceType - resource - region - parameters properties: resourceType: allOf: - $ref: '#/components/schemas/Name' - description: The service name of the resource in a task state. resource: allOf: - $ref: '#/components/schemas/Name' - description: The action of the resource called by a task state. region: allOf: - $ref: '#/components/schemas/Name' - description: The region of the scheduled task parameters: allOf: - $ref: '#/components/schemas/ConnectorParameters' - description: The JSON data passed to the resource referenced in a task state. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding. timeoutInSeconds: allOf: - $ref: '#/components/schemas/TimeoutInSeconds' - description: The maximum allowed duration of the task. heartbeatInSeconds: allOf: - $ref: '#/components/schemas/TimeoutInSeconds' - description: The maximum allowed duration between two heartbeats for the task. taskCredentials: allOf: - $ref: '#/components/schemas/TaskCredentials' - description: The credentials that Step Functions uses for the task. description: Contains details about a task scheduled during an execution. ConnectorParameters: type: string minLength: 0 maxLength: 262144 format: password HistoryEventExecutionDataDetails: type: object properties: truncated: allOf: - $ref: '#/components/schemas/truncated' - description: Indicates whether input or output was truncated in the response. Always false for API calls. description: Provides details about input or output in an execution history event. PageToken: type: string minLength: 1 maxLength: 1024 EventId: type: integer ActivityFailedEventDetails: type: object properties: error: allOf: - $ref: '#/components/schemas/SensitiveError' - description: The error code of the failure. cause: allOf: - $ref: '#/components/schemas/SensitiveCause' - description: A more detailed explanation of the cause of the failure. description: Contains details about an activity that failed during an execution. parameters: 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-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-Credential: name: X-Amz-Credential 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-Algorithm: name: X-Amz-Algorithm in: header schema: type: string required: false securitySchemes: sigv4Auth: type: apiKey name: Authorization in: header description: AWS Signature Version 4 authentication externalDocs: description: Amazon Step Functions API Reference url: https://docs.aws.amazon.com/step-functions/latest/apireference/