Lambda 関数 URL の呼び出し

version

このイベントでのペイロード形式のバージョン。現在 Lambda 関数 URL では、ペイロード形式バージョン 2.0 をサポートしています。

2.0

routeKey

関数 URL ではこのパラメーターを使用しません。Lambda は、プレースホルダーとしてこの値に $default を設定します。

$default

rawPath

リクエストパス。例えば、リクエスト URL が https://{url-id}.lambda-url.{region}.on.aws/example/test/demo の場合は、raw パス値は /example/test/demo となります。

/example/test/demo

rawQueryString

リクエストのクエリ文字列パラメータを含む raw 文字列。サポートされている文字は、a-z、A-Z、0-9、.、_、-、%、&、=、+ などです。

"?parameter1=value1&parameter2=value2"

cookies

リクエストの一部として送信されたすべての Cookie を含む配列。

["Cookie_1=Value_1", "Cookie_2=Value_2"]

headers

キーと値のペアで表されるリクエストヘッダーのリスト。

{"header1": "value1", "header2": "value2"}

queryStringParameters

リクエストに対するクエリパラメータです。例えば、リクエスト URL が https://{url-id}.lambda-url.{region}.on.aws/example?name=Jane である場合の queryStringParameters の値は、キーに name を、値に Jane を持つ、JSON オブジェクトとなります

{"name": "Jane"}

requestContext

リクエストに関する追加的な情報 (requestId、リクエストの発行時刻、および AWS Identity and Access Management (IAM) 経由で承認された場合は発信者の身元、その他) を含むオブジェクト。

requestContext.accountId

関数所有者の AWS アカウント ID。

"123456789012"

requestContext.apiId

関数 URL ID。

"33anwqw8fj"

requestContext.authentication

関数 URL ではこのパラメーターを使用しません。Lambda では null がセットされます。

null

requestContext.authorizer

関数 URL で AWS_IAM の認証タイプが使用されている場合の、発信者の ID に関する情報を含むオブジェクト。それ以外の場合、Lambda はこれに null をセットします。

requestContext.authorizer.iam.accessKey

発信者 ID のアクセスキー。

"AKIAIOSFODNN7EXAMPLE"

requestContext.authorizer.iam.accountId

発信者アイデンティティの AWS アカウント ID。

"111122223333"

requestContext.authorizer.iam.callerId

発信者の ID (ユーザー ID)。

"AIDACKCEVSQ6C2EXAMPLE"

requestContext.authorizer.iam.cognitoIdentity

関数 URL ではこのパラメーターを使用しません。Lambda は、この値に null を設定するか、JSON からこれを除外します。

null

requestContext.authorizer.iam.principalOrgId

発信者の身元に関連付けられているプリンシパル組織 ID。

"AIDACKCEVSQORGEXAMPLE"

requestContext.authorizer.iam.userArn

発信者の身元のユーザー Amazon リソースネーム (ARN)。

"arn:aws:iam::111122223333:user/example-user"

requestContext.authorizer.iam.userId

発信者の身元のユーザー ID。

"AIDACOSFODNN7EXAMPLE2"

requestContext.domainName

関数 URL のドメイン名。

"<url-id>.lambda-url.us-west-2.on.aws"

requestContext.domainPrefix

関数 URL のドメインプレフィックス。

"<url-id>"

requestContext.http

HTTP リクエストの詳細を含むオブジェクト。

requestContext.http.method

リクエストで使用されている HTTP メソッド。有効な値には、GET、POST、PUT、HEAD、OPTIONS、PATCH および DELETE があります。

GET

requestContext.http.path

リクエストパス。例えば、リクエスト URL が https://{url-id}.lambda-url.{region}.on.aws/example/test/demo であれば、パス値は /example/test/demo となります。

/example/test/demo

requestContext.http.protocol

リクエストのプロトコル。

HTTP/1.1

requestContext.http.sourceIp

リクエストを発行した即時 TCP 接続のソース IP アドレス。

123.123.123.123

requestContext.http.userAgent

User-Agent リクエストヘッダー値。

Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) Gecko/20100101 Firefox/42.0

requestContext.requestId

呼び出しリクエストの ID。この ID は、関数に関連する呼び出しログをトレースするために使用できます。

e1506fd5-9e7b-434f-bd42-4f8fa224b599

requestContext.routeKey

関数 URL ではこのパラメーターを使用しません。Lambda は、プレースホルダーとしてこの値に $default を設定します。

$default

requestContext.stage

関数 URL ではこのパラメーターを使用しません。Lambda は、プレースホルダーとしてこの値に $default を設定します。

$default

requestContext.time

リクエストのタイムスタンプです。

"07/Sep/2021:22:50:22 +0000"

requestContext.timeEpoch

リクエストのタイムスタンプ (Unix エポック秒)。

"1631055022677"

body

リクエスト本文。リクエストのコンテンツタイプがバイナリの場合、本文は base64 でエンコードされます。

{"key1": "value1", "key2": "value2"}

pathParameters

関数 URL ではこのパラメーターを使用しません。Lambda は、この値に null を設定するか、JSON からこれを除外します。

null

isBase64Encoded

ボディがバイナリペイロードで base64 でエンコードされている場合は TRUE、それ以外の場合は FALSE です。

FALSE

stageVariables

関数 URL ではこのパラメーターを使用しません。Lambda は、この値に null を設定するか、JSON からこれを除外します。

null

"Hello, world!"

{
  "statusCode": 200,
  "body": "Hello, world!",
  "headers": {
    "content-type": "application/json"
  },
  "isBase64Encoded": false
}

HTTP/2 200
date: Wed, 08 Sep 2021 18:02:24 GMT
content-type: application/json
content-length: 15

"Hello, world!"

{
  "message": "Hello, world!"
}

{
  "statusCode": 200,
  "body": {
    "message": "Hello, world!"
  },
  "headers": {
    "content-type": "application/json"
  },
  "isBase64Encoded": false
}

HTTP/2 200
date: Wed, 08 Sep 2021 18:02:24 GMT
content-type: application/json
content-length: 34

{
  "message": "Hello, world!"
}

{
   "statusCode": 201,
    "headers": {
        "Content-Type": "application/json",
        "My-Custom-Header": "Custom Value"
    },
    "body": JSON.stringify({
        "message": "Hello, world!"
    }),
    "isBase64Encoded": false
}

{
   "statusCode": 201,
    "headers": {
        "Content-Type": "application/json",
        "My-Custom-Header": "Custom Value"
    },
    "body": JSON.stringify({
        "message": "Hello, world!"
    }),
    "isBase64Encoded": false
}

HTTP/2 201
date: Wed, 08 Sep 2021 18:02:24 GMT
content-type: application/json
content-length: 27
my-custom-header: Custom Value

{
  "message": "Hello, world!"
}

{
   "statusCode": 201,
    "headers": {
        "Content-Type": "application/json",
        "My-Custom-Header": "Custom Value"
    },
    "body": JSON.stringify({
        "message": "Hello, world!"
    }),
    "cookies": [
        "Cookie_1=Value1; Expires=21 Oct 2021 07:48 GMT",
        "Cookie_2=Value2; Max-Age=78000"
    ],
    "isBase64Encoded": false
}

HTTP/2 201
date: Wed, 08 Sep 2021 18:02:24 GMT
content-type: application/json
content-length: 27
my-custom-header: Custom Value
set-cookie: Cookie_1=Value2; Expires=21 Oct 2021 07:48 GMT
set-cookie: Cookie_2=Value2; Max-Age=78000

{
  "message": "Hello, world!"
}