openapi: 3.1.0
info:
title: 'Amazon Step Functions Executions #X Amz Target=AWSStepFunctions.SendTaskFailure 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.SendTaskFailure'
paths:
/#X-Amz-Target=AWSStepFunctions.SendTaskFailure:
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: SendTaskFailure
description: Used by activity workers and task states using the callback pattern to report that the task identified by the taskToken failed.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SendTaskFailureOutput'
examples:
SendTaskFailure200Example:
summary: Default SendTaskFailure 200
x-microcks-default: true
value: {}
'480':
description: TaskDoesNotExist
content:
application/json:
schema:
$ref: '#/components/schemas/TaskDoesNotExist'
examples:
SendTaskFailure480Example:
summary: Default SendTaskFailure 480
x-microcks-default: true
value: example-value
'481':
description: InvalidToken
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidToken'
examples:
SendTaskFailure481Example:
summary: Default SendTaskFailure 481
x-microcks-default: true
value: example-value
'482':
description: TaskTimedOut
content:
application/json:
schema:
$ref: '#/components/schemas/TaskTimedOut'
examples:
SendTaskFailure482Example:
summary: Default SendTaskFailure 482
x-microcks-default: true
value: example-value
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SendTaskFailureInput'
examples:
SendTaskFailureRequestExample:
summary: Default SendTaskFailure request
x-microcks-default: true
value:
taskToken: example-value
error: example-value
cause: example-value
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSStepFunctions.SendTaskFailure
summary: Amazon Send Task Failure
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- '#X Amz Target=AWSStepFunctions.SendTaskFailure'
components:
schemas:
SensitiveError:
type: string
minLength: 0
maxLength: 256
format: password
SensitiveCause:
type: string
minLength: 0
maxLength: 32768
format: password
InvalidToken: {}
SendTaskFailureOutput:
type: object
properties: {}
TaskToken:
type: string
minLength: 1
maxLength: 1024
TaskTimedOut: {}
SendTaskFailureInput:
type: object
required:
- taskToken
title: SendTaskFailureInput
properties:
taskToken:
allOf:
- $ref: '#/components/schemas/TaskToken'
- description: The token that represents this task. Task tokens are generated by Step Functions when tasks are assigned to a worker, or in the context object when a workflow enters a task state. See GetActivityTaskOutput$taskToken.
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.
TaskDoesNotExist: {}
parameters:
X-Amz-Signature:
name: X-Amz-Signature
in: header
schema:
type: string
required: false
X-Amz-Algorithm:
name: X-Amz-Algorithm
in: header
schema:
type: string
required: false
X-Amz-Date:
name: X-Amz-Date
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-Security-Token:
name: X-Amz-Security-Token
in: header
schema:
type: string
required: false
X-Amz-Credential:
name: X-Amz-Credential
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/