CreateFunction - AWS Lambda

CreateFunction

Lambda 関数を作成します。関数を作成するには、デプロイパッケージ実行ロールが必要です。デプロイパッケージは、関数コードを含む .zip ファイルアーカイブまたはコンテナイメージです。実行ロールにより、リクエストをトレースするためのログストリーミングや X-Ray 用の Amazon CloudWatch Logs などの AWS サービスを使用するアクセス許可が関数に付与されます。

デプロイパッケージがコンテナイメージの場合は、パッケージの種類を Image に設定します。コンテナイメージの場合、コードプロパティに Amazon ECR レジストリのコンテナイメージの URI を含める必要があります。ハンドラープロパティとランタイムプロパティを指定する必要はありません。

デプロイパッケージが.zip ファイルアーカイブの場合は、パッケージの種類を Zip に設定します。.zip ファイルアーカイブの場合、code プロパティは .zip ファイルの場所を指定します。また、ハンドラープロパティとランタイムプロパティも指定する必要があります。デプロイパッケージのコードは、関数のターゲット命令セットアーキテクチャと互換性がある必要があります (x86-64またはarm64)。アーキテクチャを指定しない場合、デフォルト値はx86-64になります。

関数を作成すると、Lambda はその関数のインスタンスとそのサポートリソースをプロビジョニングします。関数を VPC に接続する場合、このプロセスには 1 分ほどかかる場合があります。この間は、関数を呼び出したり変更したりすることはできません。 GetFunctionConfiguration からのレスポンスのStateStateReasonStateReasonCode フィールドは、関数を呼び出す準備ができていることを示します。詳細については、「関数の状態」を参照してください。

関数には未公開バージョンがあり、公開バージョンやエイリアスを持つことができます。関数のコードと設定を更新すると、未公開バージョンが変更されます。公開バージョンは、変更不可能な関数コードと設定のスナップショットです。エイリアスは、バージョンにマップする名前付きリソースです。このリソースは、別のバージョンにマップするために変更できます。Publish パラメータを使用して、初期設定から関数のバージョン 1 を作成します。

その他のパラメーターを使用すると、バージョン固有の関数レベルの設定を構成できます。バージョン固有の設定は、後で UpdateFunctionConfiguration により変更できます。関数レベルの設定は、関数の未公開バージョンと公開バージョンの両方に適用され、タグ ( TagResource ) と関数ごとの同時実行制限 ( PutFunctionConcurrency ) を含みます。

デプロイパッケージが .zip ファイルアーカイブの場合は、コード署名を使用できます。この関数のコード署名を有効にするには、コード署名設定の ARN を指定します。ユーザーが UpdateFunctionCode を使用してコードパッケージのデプロイを試みると、そのパッケージに信頼できる発行元からの有効な署名があるかどうかが、Lambda によりチェックされます。code-signing の設定には、一連の署名プロファイルが含まれており、このプロファイルにより、関数から信頼された発行元が定義されます。

別のアカウントまたは AWS サービスで関数を呼び出すには、 AddPermission を使用して、リソースベースの IAM ポリシーを作成し、アクセス許可を付与します。関数レベル、バージョン、エイリアスでアクセス許可を付与できます。

関数を直接呼び出すには、 Invoke を使用します。他の AWS サービスのイベントに応答して関数を呼び出すには、イベントソースマッピング ( CreateEventSourceMapping ) を作成するか、他のサービスで関数トリガーを設定します。詳細については、「関数の呼び出し」を参照してください。

リクエストの構文

POST /2015-03-31/functions HTTP/1.1 Content-type: application/json { "Architectures": [ "string" ], "Code": { "ImageUri": "string", "S3Bucket": "string", "S3Key": "string", "S3ObjectVersion": "string", "ZipFile": blob }, "CodeSigningConfigArn": "string", "DeadLetterConfig": { "TargetArn": "string" }, "Description": "string", "Environment": { "Variables": { "string" : "string" } }, "FileSystemConfigs": [ { "Arn": "string", "LocalMountPath": "string" } ], "FunctionName": "string", "Handler": "string", "ImageConfig": { "Command": [ "string" ], "EntryPoint": [ "string" ], "WorkingDirectory": "string" }, "KMSKeyArn": "string", "Layers": [ "string" ], "MemorySize": number, "PackageType": "string", "Publish": boolean, "Role": "string", "Runtime": "string", "Tags": { "string" : "string" }, "Timeout": number, "TracingConfig": { "Mode": "string" }, "VpcConfig": { "SecurityGroupIds": [ "string" ], "SubnetIds": [ "string" ] } }

URI リクエストパラメータ

リクエストでは URI パラメータを使用しません。

リクエストボディ

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

Architectures

関数がサポートする命令セットアーキテクチャです。有効な値 (arm64 または x86_64) の 1 つを含む文字列配列を入力します。デフォルト値は x86_64 です。

タイプ: 文字列の配列

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

有効な値: x86_64 | arm64

必須: いいえ

Code

関数のコード。

タイプ: FunctionCode オブジェクト

必須: はい

CodeSigningConfigArn

この関数のコード署名を有効にするには、コード署名設定の ARN を指定します。コード署名の設定には、一連の署名プロファイルが含まれており、このプロファイルにより、関数の信頼された発行元が定義されます。

型: 文字列

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

Pattern: arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\d{1}:\d{12}:code-signing-config:csc-[a-z0-9]{17}

必須: いいえ

DeadLetterConfig

処理に失敗したときに Lambda が非同期イベントを送信するキューまたはトピックを指定するデッドレターキュー設定。詳細については、「デッドレターキュー」を参照してください。

タイプ: DeadLetterConfig オブジェクト

必須: いいえ

Description

関数の説明です。

型: 文字列

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

必須: いいえ

Environment

実行中に関数コードからアクセス可能な環境変数。

タイプ: Environment オブジェクト

必須: いいえ

FileSystemConfigs

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

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

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

必須: いいえ

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

必須: はい

Handler

関数を実行するために Lambda が呼び出すコード内のメソッドの名前。形式にはファイル名を含めます。また、ランタイムに応じて名前空間や他の修飾子を含めることもできます。詳細については、「プログラミングモデル」を参照してください。

型: 文字列

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

Pattern: [^\s]+

必須: いいえ

ImageConfig

コンテナイメージ Dockerfile の値を上書きするコンテナイメージ設定値

タイプ: ImageConfig オブジェクト

必須: いいえ

KMSKeyArn

関数の環境変数の暗号化に使用される AWS キー管理サービス (AWS KMS) キーの ARN。指定されない場合、AWS Lambda はデフォルトのサービスキーを使用します。

型: 文字列

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

必須: いいえ

Layers

関数の実行環境に追加する関数レイヤーのリスト。その ARN ごとに各レイヤーを指定します (バージョンも含めます)。

タイプ: 文字列の配列

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

Pattern: arn:[a-zA-Z0-9-]+:lambda:[a-zA-Z0-9-]+:\d{12}:layer:[a-zA-Z0-9-_]+:[0-9]+

必須: いいえ

MemorySize

実行時に関数で使用できるメモリの量。関数のメモリを増やすと、関数の CPU 割り当ても増えます。デフォルト値は 128 MB です。値には、1 MB の任意の倍数を指定できます。

タイプ: 整数

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

必須: いいえ

PackageType

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

型: 文字列

有効な値: Zip | Image

必須: いいえ

Publish

true に設定すると、作成中に関数の最初のバージョンが公開されます。

タイプ: ブール値

必須: いいえ

Role

関数の実行ロールの Amazon リソースネーム (ARN)。

型: 文字列

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

必須: はい

Runtime

関数のランタイムの識別子。

型: 文字列

有効な値: 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

必須: いいえ

Tags

関数に適用するタグのリスト。

型: 文字列から文字列へのマッピング

必須: いいえ

Timeout

Lambda が関数を停止するまでに関数に許可する実行時間 (秒)。デフォルト値は 3 秒です。最大許容値は 900 秒です。詳細については、「Lambda 実行環境」をご参照ください。

タイプ: 整数

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

必須: いいえ

TracingConfig

ModeActive に設定し、X-Ray で着信リクエストのサブセットをサンプリングおよびトレースします。

タイプ: TracingConfig オブジェクト

必須: いいえ

VpcConfig

VPC の AWS リソースへのネットワーク接続の場合は、VPC のセキュリティグループとサブネットのリストを指定します。関数を VPC に接続する場合は、その VPC を介してのみリソースとインターネットにアクセスできます。詳細については、「VPC 設定」を参照してください。

タイプ: VpcConfig オブジェクト

必須: いいえ

レスポンスの構文

HTTP/1.1 201 Content-type: application/json { "Architectures": [ "string" ], "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 201 レスポンスが返されます。

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

Architectures

関数がサポートする命令セットアーキテクチャです。アーキテクチャは、有効な値の 1 つを含む文字列配列です。デフォルトアーキテクチャ値はx86_64です。

タイプ: 文字列の配列

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

有効な値: x86_64 | arm64

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

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

型: 文字列

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

CodeSigningConfigNotFoundException

指定されたコード署名設定が存在しません。

HTTP ステータスコード: 404

CodeStorageExceededException

アカウントあたりの最大合計コードサイズを超えました。詳細はこちら

HTTP ステータスコード: 400

CodeVerificationFailedException

コード署名が、署名の不一致または有効期限の検証チェックの 1 つ以上に失敗し、コード署名ポリシーが ENSORCE に設定されています。Lambda はデプロイをブロックします。

HTTP ステータスコード: 400

InvalidCodeSignatureException

コード署名が整合性チェックに失敗しました。コード署名ポリシーが WARN に設定されていても、整合性チェックに失敗した場合、Lambda は常にデプロイをブロックします。

HTTP ステータスコード: 400

InvalidParameterValueException

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

HTTP ステータスコード: 400

ResourceConflictException

リソースが既に存在しているか、別のオペレーションが進行中です。

HTTP ステータスコード: 409

ResourceNotFoundException

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

HTTP ステータスコード: 404

ServiceException

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

HTTP ステータスコード: 500

TooManyRequestsException

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

HTTP ステータスコード: 429

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

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