CreateFunctionUrlConfig - AWS Lambda
リクエストの構文URI リクエストパラメータリクエストボディレスポンスの構文レスポンス要素エラー以下の資料も参照してください。

CreateFunctionUrlConfig

指定した設定パラメーターを使用して Lambda 関数 URL を作成します。関数 URL は、関数を呼び出すために使用する専用の HTTP エンドポイントです。

リクエストの構文

POST /2021-10-31/functions/FunctionName/url?Qualifier=Qualifier HTTP/1.1
Content-type: application/json

{
   "AuthType": "string",
   "Cors": { 
      "AllowCredentials": boolean,
      "AllowHeaders": [ "string" ],
      "AllowMethods": [ "string" ],
      "AllowOrigins": [ "string" ],
      "ExposeHeaders": [ "string" ],
      "MaxAge": number
   },
   "InvokeMode": "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

エイリアス名。

長さの制限：最小長は 1 です。最大長は 128 です。

Pattern: (^\$LATEST$)|((?!^[0-9]+$)([a-zA-Z0-9-_]+))

リクエストボディ

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

AuthType

関数 URL が使用する認証のタイプ。アクセスを認証されたユーザーのみに制限する場合、AWS_IAM に設定します。IAM 認証をバイパスしてパブリックエンドポイントを作成する場合は、値に NONE を設定します。詳細については、「Security and auth model for Lambda function URLs」(Lambda 関数 URL におけるセキュリティと認証モデル) を参照してください。

型: 文字列

有効な値: NONE | AWS_IAM

必須: はい

Cors

関数 URL のための、Cross-Origin Resource Sharing (CORS) 設定。

型: Cors オブジェクト

必須: いいえ

InvokeMode

以下のいずれかのオプションを使用します。

  • BUFFERED – これはデフォルトのオプションです。Lambda は Invoke API オペレーションを使用して関数を呼び出します。ペイロードが完了すると、呼び出し結果が表示されます。最大ペイロードサイズは 6 MB です。

  • RESPONSE_STREAM — 関数はペイロード結果が利用可能になるとストリーミングします。Lambda は InvokeWithResponseStream API オペレーションを使用して関数を呼び出します。最大レスポンスペイロードのサイズは 20 MB ですが、「クォータ引き上げをリクエスト」できます。

型: 文字列

有効な値: BUFFERED | RESPONSE_STREAM

必須：いいえ

レスポンスの構文

HTTP/1.1 201
Content-type: application/json

{
   "AuthType": "string",
   "Cors": { 
      "AllowCredentials": boolean,
      "AllowHeaders": [ "string" ],
      "AllowMethods": [ "string" ],
      "AllowOrigins": [ "string" ],
      "ExposeHeaders": [ "string" ],
      "MaxAge": number
   },
   "CreationTime": "string",
   "FunctionArn": "string",
   "FunctionUrl": "string",
   "InvokeMode": "string"
}

レスポンス要素

アクションが成功すると、HTTP 201 レスポンスが返されます。

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

AuthType

関数 URL が使用する認証のタイプ。アクセスを認証されたユーザーのみに制限する場合、AWS_IAM に設定します。IAM 認証をバイパスしてパブリックエンドポイントを作成する場合は、値に NONE を設定します。詳細については、「Security and auth model for Lambda function URLs」(Lambda 関数 URL におけるセキュリティと認証モデル) を参照してください。

型: 文字列

有効な値: NONE | AWS_IAM

Cors

関数 URL のための、Cross-Origin Resource Sharing (CORS) 設定。

型: Cors オブジェクト

CreationTime

ISO-8601 形式 (YYYY-MM-DDThh:mm:ss.sTZD) で示す関数 URL の作成時刻。

型: 文字列

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

FunctionUrl

関数の HTTP URL エンドポイント。

型: 文字列

長さ制限: 最小長は 40 です。最大長は 100 です。

InvokeMode

以下のいずれかのオプションを使用します。

  • BUFFERED – これはデフォルトのオプションです。Lambda は Invoke API オペレーションを使用して関数を呼び出します。ペイロードが完了すると、呼び出し結果が表示されます。最大ペイロードサイズは 6 MB です。

  • RESPONSE_STREAM — 関数はペイロード結果が利用可能になるとストリーミングします。Lambda は InvokeWithResponseStream API オペレーションを使用して関数を呼び出します。最大レスポンスペイロードのサイズは 20 MB ですが、「クォータ引き上げをリクエスト」できます。

型: 文字列

有効な値: BUFFERED | RESPONSE_STREAM

エラー

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

InvalidParameterValueException

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

HTTP ステータスコード：400

ResourceConflictException

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

HTTP ステータスコード: 409

ResourceNotFoundException

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

HTTP ステータスコード: 404

ServiceException

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

HTTP ステータスコード: 500

TooManyRequestsException

リクエストスループット制限を超えました。詳細については、「Lambda クォータ」を参照してください。

HTTP ステータスコード: 429

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

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