翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
SendWorkflowStepState
非同期カスタムステップ向けにコールバックを送信します。
ワークフローのカスタムステップの実行中に ExecutionId
、WorkflowId
、およびToken
がターゲットリソースに渡されます。ステータスの提供するだけでなく、コールバック付きでそれらを含める必要があります。
リクエストの構文
{
"ExecutionId": "string
",
"Status": "string
",
"Token": "string
",
"WorkflowId": "string
"
}
リクエストパラメータ
すべてのアクションに共通のパラメータの詳細については、「共通パラメータ」を参照してください。
リクエストは、次のJSON形式のデータを受け入れます。
- ExecutionId
-
ワークフローの一意の識別子。
型: 文字列
長さの制限: 最大長は 36 です。
Pattern:
[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}
必須:はい
- Status
-
指定したステップの成否を示します。
型: 文字列
有効な値:
SUCCESS | FAILURE
必須:はい
- Token
-
同じ実行内で複数の Lambda ステップについて複数のコールバックを区別するために使用されます。
型: 文字列
長さの制限:最小長は 1 です。最大長は 64 文字です。
Pattern:
\w+
必須:はい
- WorkflowId
-
ワークフローの一意の識別子。
型: 文字列
長さの制限: 固定長は 19 です。
Pattern:
w-([a-z0-9]{17})
必須:はい
レスポンス要素
アクションが成功すると、サービスは空のHTTP本文で 200 HTTP レスポンスを送り返します。
エラー
すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。
- AccessDeniedException
-
このアクションを実行する十分なアクセス権限がありません。
HTTP ステータスコード: 400
- InternalServiceError
-
この例外は、 AWS Transfer Family サービスでエラーが発生した場合にスローされます。
HTTP ステータスコード: 500
- InvalidRequestException
-
この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。
HTTP ステータスコード: 400
- ResourceNotFoundException
-
この例外は、 AWS Transfer Family サービスによってリソースが見つからない場合にスローされます。
HTTP ステータスコード: 400
- ServiceUnavailableException
-
AWS Transfer Family サービスが利用できないため、リクエストは失敗しました。
HTTP ステータスコード: 500
- ThrottlingException
-
リクエストのスロットリングにより、リクエストが拒否されました。
HTTP ステータスコード: 400
以下の資料も参照してください。
言語固有の のいずれかAPIでこれを使用する方法の詳細については AWS SDKs、以下を参照してください。