PutRuntimeManagementConfig
関数のバージョンのランタイム管理設定を実行します。詳細については、「ランタイム更新」を参照してください。
リクエストの構文
PUT /2021-07-20/functions/FunctionName
/runtime-management-config?Qualifier=Qualifier
HTTP/1.1
Content-type: application/json
{
"RuntimeVersionArn": "string
",
"UpdateRuntimeOn": "string
"
}
URI リクエストパラメータ
リクエストでは、次の URI パラメータを使用します。
- FunctionName
-
Lambda 関数の名前
名前の形式
-
関数名 –
my-function
。 -
関数 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
-
関数のバージョンを指定します。これは、
$LATEST
または発行済みのバージョン番号にすることができます。値が指定されていない場合は、$LATEST
バージョンの設定が返されます。長さの制限:最小長は 1 です。最大長は 128 です。
Pattern:
(|[a-zA-Z0-9$_-]+)
リクエストボディ
リクエストは以下の JSON 形式のデータを受け入れます。
- RuntimeVersionArn
-
関数に使用させるランタイムバージョンの ARN です。
注記
これが必要となるのは、手動のランタイム更新モードを使用している場合のみです。
型: 文字列
長さ制限: 最小長は 26 です。最大長は 2,048 です。
パターン:
^arn:(aws[a-zA-Z-]*):lambda:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\d{1}::runtime:.+$
必須: いいえ
- UpdateRuntimeOn
-
ランタイム更新モードを指定します。
-
自動 (デフォルト) – 2 フェーズのランタイムバージョンロールアウトを使用して、最新のセキュアなランタイムバージョンに自動的に更新します。ランタイム更新のメリットを常に得るためにも、これは大半のお客様にとって最良のオプションです。
-
関数の更新 – 関数が更新されると、Lambda が関数のランタイムを最新のセキュアなランタイムバージョンに更新します。このアプローチは、ランタイム更新を関数デプロイと同期させることから、ランタイム更新が適用されるタイミングを制御することができるとともに、まれに発生するランタイム更新の非互換性を早期に検出して緩和することが可能になります。この設定を使用するときは、関数を定期的に更新して、それらのランタイムを最新の状態に保つ必要があります。
-
手動 – 関数設定でランタイムバージョンを指定します。関数は、このランタイムバージョンを恒久的に使用します。このアプローチでは、新しいランタイムバージョンに既存の関数との互換性がないというまれな状況でも、関数を以前のランタイムバージョンにロールバックすることができます。詳細については、「ランタイムバージョンをロールバックする」を参照してください。
型: 文字列
有効な値:
Auto | Manual | FunctionUpdate
必須: はい
-
レスポンスの構文
HTTP/1.1 200
Content-type: application/json
{
"FunctionArn": "string",
"RuntimeVersionArn": "string",
"UpdateRuntimeOn": "string"
}
レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
- FunctionArn
-
関数の 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-_]+))?
- RuntimeVersionArn
-
関数が使用するように設定されているランタイムのARN です。ランタイム更新モードが手動の場合は ARN が返され、それ以外の場合は
null
が返されます。型: 文字列
長さ制限: 最小長は 26 です。最大長は 2,048 です。
パターン:
^arn:(aws[a-zA-Z-]*):lambda:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\d{1}::runtime:.+$
- UpdateRuntimeOn
-
ランタイム更新モードです。
型: 文字列
有効な値:
Auto | Manual | FunctionUpdate
エラー
すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。
- InvalidParameterValueException
-
リクエストに含まれているパラメータの 1 つが無効です。
HTTP ステータスコード:400
- ResourceConflictException
-
リソースが既に存在しているか、別のオペレーションが進行中です。
HTTP ステータスコード: 409
- ResourceNotFoundException
-
リクエストで指定されたリソースは存在しません。
HTTP ステータスコード: 404
- ServiceException
-
AWS Lambda サービスで内部エラーが発生しました。
HTTP ステータスコード: 500
- TooManyRequestsException
-
リクエストスループット制限を超えました。詳細については、「Lambda クォータ」を参照してください。
HTTP ステータスコード: 429
以下の資料も参照してください。
言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。