PutFunctionEventInvokeConfig
関数、バージョン、エイリアスで非同期呼び出しのオプションを設定します。関数、バージョン、エイリアスの設定が既に存在する場合は、このオペレーションによって設定が上書きされます。設定を除外すると、それらの設定は削除されます。他のオプションの既存の設定に影響を与えずに 1 つのオプションを設定するには、UpdateFunctionEventInvokeConfig を使用します。
デフォルトでは、関数がエラーを返した場合、Lambda は非同期呼び出しを 2 回再試行します。イベントは最大 6 時間キューに保持されます。イベントがすべての処理に失敗した場合、または非同期呼び出しキューに長時間残っている場合、Lambda はそれを破棄します。廃棄されたイベントを保持するには、UpdateFunctionConfiguration を使用してデッドレターキューを設定します。
呼び出しレコードをキュー、トピック、関数、イベントバスに送信するには、送信先を指定します。成功した呼び出し (on-success) とすべての処理試行に失敗したイベント (on-failure) に別々の送信先を設定できます。デッドレターキューに加えて、またはデッドレターキューの代わりに送信先を設定できます。
リクエストの構文
PUT /2019-09-25/functions/FunctionName/event-invoke-config?Qualifier=Qualifier HTTP/1.1
Content-type: application/json
{
"DestinationConfig": {
"OnFailure": {
"Destination": "string"
},
"OnSuccess": {
"Destination": "string"
}
},
"MaximumEventAgeInSeconds": number,
"MaximumRetryAttempts": number
}URI リクエストパラメータ
リクエストでは、次の URI パラメータを使用します。
- FunctionName
-
Lambda 関数、バージョン、またはエイリアスの名前。
名前の形式
-
関数名 -
my-function(名前のみ)、my-function:v1(エイリアス付き)。 -
関数 ARN -
arn:aws:lambda:us-west-2:123456789012:function:my-function。 -
部分的な ARN -
123456789012:function:my-function
バージョン番号またはエイリアスを任意の形式に追加できます。完全な ARN にのみ適用される長さの制限。関数名のみを指定する場合、64 文字の長さに制限されます。
長さの制限: 最小長は 1 です。最大長は 140 です。
Pattern:
(arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}(-gov)?-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))?必須: はい
-
- Qualifier
-
バージョン番号またはエイリアス名。
長さの制限: 最小長は 1 です。最大長は 128 です。
Pattern:
(|[a-zA-Z0-9$_-]+)
リクエストボディ
リクエストは以下の JSON 形式のデータを受け入れます。
- DestinationConfig
-
処理のために関数に送信された後のイベントの宛先。
送信先
-
関数 - Lambda 関数の Amazon リソースネーム (ARN)。
-
キュー - 標準 SQS キューの ARN。
-
トピック - 標準 SNS トピックの ARN。
-
イベントバス - Amazon EventBridge イベントバスの ARN。
タイプ: DestinationConfig オブジェクト
必須: いいえ
-
- MaximumEventAgeInSeconds
-
Lambda が処理のために関数に送信するリクエストの最大存続時間です。
タイプ: 整数
値の範囲: 最小値 は 60 です。最大値は 21,600 です。
必須: いいえ
- MaximumRetryAttempts
-
関数がエラーを返すときの最大再試行回数です。
タイプ: 整数
値の範囲: 最小値 は 0 です。最大値は 2 です。
必須: いいえ
レスポンスの構文
HTTP/1.1 200
Content-type: application/json
{
"DestinationConfig": {
"OnFailure": {
"Destination": "string"
},
"OnSuccess": {
"Destination": "string"
}
},
"FunctionArn": "string",
"LastModified": number,
"MaximumEventAgeInSeconds": number,
"MaximumRetryAttempts": number
}レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
- DestinationConfig
-
処理のために関数に送信された後のイベントの宛先。
送信先
-
関数 - Lambda 関数の Amazon リソースネーム (ARN)。
-
キュー - 標準 SQS キューの ARN。
-
トピック - 標準 SNS トピックの ARN。
-
イベントバス - Amazon EventBridge イベントバスの ARN。
型: DestinationConfig オブジェクト
-
- FunctionArn
-
関数の Amazon リソースネーム (ARN)。
型: 文字列
パターン:
arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}(-gov)?-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-_]+(:(\$LATEST|[a-zA-Z0-9-_]+))? - LastModified
-
設定が最後に更新された日時 (UNIX タイム秒単位)。
型: Timestamp
- MaximumEventAgeInSeconds
-
Lambda が処理のために関数に送信するリクエストの最大存続時間です。
タイプ: 整数
値の範囲: 最小値 は 60 です。最大値は 21,600 です。
- MaximumRetryAttempts
-
関数がエラーを返すときの最大再試行回数です。
タイプ: 整数
値の範囲: 最小値 は 0 です。最大値は 2 です。
エラー
すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。
- InvalidParameterValueException
-
リクエストに含まれているパラメータの 1 つが無効です。
HTTP ステータスコード：400
- ResourceConflictException
-
リソースが既に存在しているか、別のオペレーションが進行中です。
HTTP ステータスコード: 409
- ResourceNotFoundException
-
リクエストで指定されたリソースは存在しません。
HTTP ステータスコード: 404
- ServiceException
-
AWS Lambda サービスで内部エラーが発生しました。
HTTP ステータスコード: 500
- TooManyRequestsException
-
リクエストスループット制限を超えました。詳細については、「Lambda クォータ」を参照してください。
HTTP ステータスコード: 429
以下の資料も参照してください。
言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
