

# PutFunctionEventInvokeConfig
<a name="API_PutFunctionEventInvokeConfig"></a>

関数、バージョン、エイリアスで[非同期呼び出し](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html)のオプションを設定します。関数、バージョン、エイリアスの設定が既に存在する場合は、このオペレーションによって設定が上書きされます。設定を除外すると、それらの設定は削除されます。他のオプションの既存の設定に影響を与えずに 1 つのオプションを設定するには、[UpdateFunctionEventInvokeConfig](API_UpdateFunctionEventInvokeConfig.md) を使用します。

デフォルトでは、関数がエラーを返した場合、Lambda は非同期呼び出しを 2 回再試行します。イベントは最大 6 時間キューに保持されます。イベントがすべての処理に失敗した場合、または非同期呼び出しキューに長時間残っている場合、Lambda はそれを破棄します。廃棄されたイベントを保持するには、[UpdateFunctionConfiguration](API_UpdateFunctionConfiguration.md) を使用してデッドレターキューを設定します。

呼び出しレコードをキュー、トピック、関数、イベントバスに送信するには、[送信先](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-async-destinations)を指定します。成功した呼び出し (on-success) とすべての処理試行に失敗したイベント (on-failure) に別々の送信先を設定できます。デッドレターキューに加えて、またはデッドレターキューの代わりに送信先を設定できます。

## リクエストの構文
<a name="API_PutFunctionEventInvokeConfig_RequestSyntax"></a>

```
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 リクエストパラメータ
<a name="API_PutFunctionEventInvokeConfig_RequestParameters"></a>

リクエストでは、次の URI パラメータを使用します。

 ** [FunctionName](#API_PutFunctionEventInvokeConfig_RequestSyntax) **   <a name="lambda-PutFunctionEventInvokeConfig-request-FunctionName"></a>
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](#API_PutFunctionEventInvokeConfig_RequestSyntax) **   <a name="lambda-PutFunctionEventInvokeConfig-request-Qualifier"></a>
バージョン番号またはエイリアス名。  
長さの制限: 最小長は 1 です。最大長は 128 です。  
Pattern: `(|[a-zA-Z0-9$_-]+)` 

## リクエストボディ
<a name="API_PutFunctionEventInvokeConfig_RequestBody"></a>

リクエストは以下の JSON 形式のデータを受け入れます。

 ** [DestinationConfig](#API_PutFunctionEventInvokeConfig_RequestSyntax) **   <a name="lambda-PutFunctionEventInvokeConfig-request-DestinationConfig"></a>
処理のために関数に送信された後のイベントの宛先。  

**送信先**
+  **関数** - Lambda 関数の Amazon リソースネーム (ARN)。
+  **キュー** - 標準 SQS キューの ARN。
+  **トピック** - 標準 SNS トピックの ARN。
+  **イベントバス** - Amazon EventBridge イベントバスの ARN。
タイプ: [DestinationConfig](API_DestinationConfig.md) オブジェクト  
必須: いいえ

 ** [MaximumEventAgeInSeconds](#API_PutFunctionEventInvokeConfig_RequestSyntax) **   <a name="lambda-PutFunctionEventInvokeConfig-request-MaximumEventAgeInSeconds"></a>
Lambda が処理のために関数に送信するリクエストの最大存続時間です。  
タイプ: 整数  
値の範囲: 最小値 は 60 です。最大値は 21,600 です。  
必須: いいえ

 ** [MaximumRetryAttempts](#API_PutFunctionEventInvokeConfig_RequestSyntax) **   <a name="lambda-PutFunctionEventInvokeConfig-request-MaximumRetryAttempts"></a>
関数がエラーを返すときの最大再試行回数です。  
タイプ: 整数  
値の範囲: 最小値 は 0 です。最大値は 2 です。  
必須: いいえ

## レスポンスの構文
<a name="API_PutFunctionEventInvokeConfig_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "DestinationConfig": { 
      "OnFailure": { 
         "Destination": "string"
      },
      "OnSuccess": { 
         "Destination": "string"
      }
   },
   "FunctionArn": "string",
   "LastModified": number,
   "MaximumEventAgeInSeconds": number,
   "MaximumRetryAttempts": number
}
```

## レスポンス要素
<a name="API_PutFunctionEventInvokeConfig_ResponseElements"></a>

アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

サービスから以下のデータが JSON 形式で返されます。

 ** [DestinationConfig](#API_PutFunctionEventInvokeConfig_ResponseSyntax) **   <a name="lambda-PutFunctionEventInvokeConfig-response-DestinationConfig"></a>
処理のために関数に送信された後のイベントの宛先。  

**送信先**
+  **関数** - Lambda 関数の Amazon リソースネーム (ARN)。
+  **キュー** - 標準 SQS キューの ARN。
+  **トピック** - 標準 SNS トピックの ARN。
+  **イベントバス** - Amazon EventBridge イベントバスの ARN。
型: [DestinationConfig](API_DestinationConfig.md) オブジェクト

 ** [FunctionArn](#API_PutFunctionEventInvokeConfig_ResponseSyntax) **   <a name="lambda-PutFunctionEventInvokeConfig-response-FunctionArn"></a>
関数の 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](#API_PutFunctionEventInvokeConfig_ResponseSyntax) **   <a name="lambda-PutFunctionEventInvokeConfig-response-LastModified"></a>
設定が最後に更新された日時 (UNIX タイム秒単位)。  
型: Timestamp

 ** [MaximumEventAgeInSeconds](#API_PutFunctionEventInvokeConfig_ResponseSyntax) **   <a name="lambda-PutFunctionEventInvokeConfig-response-MaximumEventAgeInSeconds"></a>
Lambda が処理のために関数に送信するリクエストの最大存続時間です。  
タイプ: 整数  
値の範囲: 最小値 は 60 です。最大値は 21,600 です。

 ** [MaximumRetryAttempts](#API_PutFunctionEventInvokeConfig_ResponseSyntax) **   <a name="lambda-PutFunctionEventInvokeConfig-response-MaximumRetryAttempts"></a>
関数がエラーを返すときの最大再試行回数です。  
タイプ: 整数  
値の範囲: 最小値 は 0 です。最大値は 2 です。

## エラー
<a name="API_PutFunctionEventInvokeConfig_Errors"></a>

すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。

 ** InvalidParameterValueException **   
リクエストに含まれているパラメータの 1 つが無効です。  
HTTP ステータスコード：400

 ** ResourceConflictException **   
リソースが既に存在しているか、別のオペレーションが進行中です。  
HTTP ステータスコード: 409

 ** ResourceNotFoundException **   
リクエストで指定されたリソースは存在しません。  
HTTP ステータスコード: 404

 ** ServiceException **   
AWS Lambda サービスで内部エラーが発生しました。  
HTTP ステータスコード: 500

 ** TooManyRequestsException **   
リクエストスループット制限を超えました。詳細については、「[Lambda クォータ](https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-limits.html#api-requests)」を参照してください。  
HTTP ステータスコード: 429

## 以下の資料も参照してください。
<a name="API_PutFunctionEventInvokeConfig_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  「[AWS コマンドラインインターフェイス](https://docs.aws.amazon.com/goto/aws-cli/lambda-2015-03-31/PutFunctionEventInvokeConfig)」 
+  「[AWS SDK for .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/lambda-2015-03-31/PutFunctionEventInvokeConfig)」 
+  「[AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lambda-2015-03-31/PutFunctionEventInvokeConfig)」 
+  「[AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/lambda-2015-03-31/PutFunctionEventInvokeConfig)」 
+  「[AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lambda-2015-03-31/PutFunctionEventInvokeConfig)」 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lambda-2015-03-31/PutFunctionEventInvokeConfig) 
+  「[AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lambda-2015-03-31/PutFunctionEventInvokeConfig)」 
+  「[AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lambda-2015-03-31/PutFunctionEventInvokeConfig)」 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lambda-2015-03-31/PutFunctionEventInvokeConfig) 