GetFunctionConfiguration - AWS Lambda

GetFunctionConfiguration

Lambda 関数またはバージョンのバージョン固有の設定を返します。出力には、関数のバージョン間で異なるオプションのみが含まれます。これらの設定を変更するには、 UpdateFunctionConfiguration を使用します。

関数レベルの設定を含む、関数のすべての詳細を取得するには、 GetFunction を使用します。

リクエストの構文

GET /2015-03-31/functions/FunctionName/configuration?Qualifier=Qualifier HTTP/1.1

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 です。最大長は 170 です。

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$_-]+)

リクエストボディ

リクエストにリクエストボディがありません。

レスポンスの構文

HTTP/1.1 200 Content-type: application/json { "CodeSha256": "string", "CodeSize": number, "DeadLetterConfig": { "TargetArn": "string" }, "Description": "string", "Environment": { "Error": { "ErrorCode": "string", "Message": "string" }, "Variables": { "string" : "string" } }, "FileSystemConfigs": [ { "Arn": "string", "LocalMountPath": "string" } ], "FunctionArn": "string", "FunctionName": "string", "Handler": "string", "ImageConfigResponse": { "Error": { "ErrorCode": "string", "Message": "string" }, "ImageConfig": { "Command": [ "string" ], "EntryPoint": [ "string" ], "WorkingDirectory": "string" } }, "KMSKeyArn": "string", "LastModified": "string", "LastUpdateStatus": "string", "LastUpdateStatusReason": "string", "LastUpdateStatusReasonCode": "string", "Layers": [ { "Arn": "string", "CodeSize": number, "SigningJobArn": "string", "SigningProfileVersionArn": "string" } ], "MasterArn": "string", "MemorySize": number, "PackageType": "string", "RevisionId": "string", "Role": "string", "Runtime": "string", "SigningJobArn": "string", "SigningProfileVersionArn": "string", "State": "string", "StateReason": "string", "StateReasonCode": "string", "Timeout": number, "TracingConfig": { "Mode": "string" }, "Version": "string", "VpcConfig": { "SecurityGroupIds": [ "string" ], "SubnetIds": [ "string" ], "VpcId": "string" } }

レスポンス要素

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

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

CodeSha256

関数のデプロイパッケージの SHA256 ハッシュ。

型: 文字列

CodeSize

関数のデプロイパッケージのサイズ (バイト単位)。

Type: Long

DeadLetterConfig

関数のデッドレターキュー。

タイプ: DeadLetterConfig オブジェクト

Description

関数の説明。

型: 文字列

長さの制限: 最小長は 0 です。最大長は 256 です。

Environment

関数の環境変数

タイプ: EnvironmentResponse オブジェクト

FileSystemConfigs

Amazon EFS ファイルシステムの接続設定。

タイプ: FileSystemConfig オブジェクトの配列

配列メンバー: 最大数は 1 項目です。

FunctionArn

関数の Amazon リソースネーム (ARN)。

型: 文字列

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-_]+))?

FunctionName

関数の名前。

型: 文字列

長さの制限: 最小長は 1 です。最大長は 170 です。

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-_]+))?

Handler

Lambda が関数の実行を開始するために呼び出す関数。

型: 文字列

長さの制限: 最大長は 128 です。

Pattern: [^\s]+

ImageConfigResponse

関数のイメージ設定値。

タイプ: ImageConfigResponse オブジェクト

KMSKeyArn

関数の環境変数を暗号化するために使用される KMS キー。このキーは、カスタマー管理の CMK を設定している場合にのみ返されます。

型: 文字列

Pattern: (arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|()

LastModified

関数が最後に更新された日付と時刻 (ISO-8601 形式 (YYYY-MM-DDThh:mm:ss.sTZD))。

型: 文字列

LastUpdateStatus

関数で最後に実行された更新のステータス。これは、関数の作成完了後、最初に Successful に設定されます。

型: 文字列

有効な値: Successful | Failed | InProgress

LastUpdateStatusReason

関数で最後に実行された更新の理由。

型: 文字列

LastUpdateStatusReasonCode

関数で最後に実行された更新の理由コード。

型: 文字列

有効な値: EniLimitExceeded | InsufficientRolePermissions | InvalidConfiguration | InternalError | SubnetOutOfIPAddresses | InvalidSubnet | InvalidSecurityGroup | ImageDeleted | ImageAccessDenied | InvalidImage

Layers

関数のレイヤー

タイプ: Layer オブジェクトの配列

MasterArn

Lambda@Edge 関数の場合、マスター関数の ARN。

型: 文字列

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-_]+))?

MemorySize

実行時に関数で使用できるメモリの量。

タイプ: 整数

値の範囲: 最小値 は 128 です。最大値は 10,240 です。

PackageType

デプロイパッケージのタイプ。コンテナイメージでは Image に設定し、.zip ファイルアーカイブでは Zip を設定します。

型: 文字列

有効な値: Zip | Image

RevisionId

関数またはエイリアスの最新の更新リビジョン。

型: 文字列

Role

関数の実行ロール。

型: 文字列

Pattern: arn:(aws[a-zA-Z-]*)?:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+

Runtime

Lambda 関数のランタイム環境。

型: 文字列

有効な値: nodejs | nodejs4.3 | nodejs6.10 | nodejs8.10 | nodejs10.x | nodejs12.x | nodejs14.x | java8 | java8.al2 | java11 | python2.7 | python3.6 | python3.7 | python3.8 | python3.9 | dotnetcore1.0 | dotnetcore2.0 | dotnetcore2.1 | dotnetcore3.1 | nodejs4.3-edge | go1.x | ruby2.5 | ruby2.7 | provided | provided.al2

SigningJobArn

署名ジョブの ARN。

型: 文字列

Pattern: arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-])+:([a-z]{2}(-gov)?-[a-z]+-\d{1})?:(\d{12})?:(.*)

SigningProfileVersionArn

署名プロファイルバージョンの ARN。

型: 文字列

Pattern: arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-])+:([a-z]{2}(-gov)?-[a-z]+-\d{1})?:(\d{12})?:(.*)

State

関数の現在の状態。状態が Inactive の場合、関数を呼び出すことで再アクティブ化できます。

型: 文字列

有効な値: Pending | Active | Inactive | Failed

StateReason

関数の現在の状態の理由。

型: 文字列

StateReasonCode

関数の現在の状態の理由コード。コードが Creating のときは、関数を呼び出したり変更したりすることはできません。

型: 文字列

有効な値: Idle | Creating | Restoring | EniLimitExceeded | InsufficientRolePermissions | InvalidConfiguration | InternalError | SubnetOutOfIPAddresses | InvalidSubnet | InvalidSecurityGroup | ImageDeleted | ImageAccessDenied | InvalidImage

Timeout

Lambda が関数を停止するまでに関数に許可する実行時間 (秒)。

タイプ: 整数

値の範囲: 最小値 は 1 です。

TracingConfig

関数の AWS X-Ray トレース設定。

タイプ: TracingConfigResponse オブジェクト

Version

Lambda 関数のバージョン。

型: 文字列

長さの制限: 最小長は 1 です。最大長は 1024 です。

Pattern: (\$LATEST|[0-9]+)

VpcConfig

関数のネットワーク設定。

タイプ: VpcConfigResponse オブジェクト

Errors

InvalidParameterValueException

リクエストに含まれているパラメータの 1 つが無効です。

HTTP ステータスコード: 400

ResourceNotFoundException

リクエストで指定されたリソースは存在しません。

HTTP ステータスコード: 404

ServiceException

AWS Lambda サービスで内部エラーが発生しました。

HTTP ステータスコード: 500

TooManyRequestsException

リクエストスループット制限を超えました。

HTTP ステータスコード: 429

以下の資料も参照してください。

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、次を参照してください。