boto3: where is the Payload attribute of the object returned by `Lambda.Client.invoke` documented?

Question

I'd like to read the documentation (if it exists) describing the attributes and methods of the Payload attribute in the object returned by Lambda.Client.invoke` in the boto3 library . I haven't been able to find it by searching and browsing the boto3 docs. Please post a link to the official docs, not an explanation.

Given the state of the boto3 docs, is it preferable to just use API calls directly?

Riku_Kobayashi · Answer

Hello.

"'Payload'" included in the response is called "StreamingBody", so you need to use "read()" to check the contents.  
https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/lambda/client/invoke.html

"StreamingBody" is described in the following document.  
https://botocore.amazonaws.com/v1/documentation/api/latest/reference/response.html

For example, if you check the response without using "read()", it will look like the following.　　
```
import boto3

client = boto3.client('lambda')

response = client.invoke(
        FunctionName='kobayashi-test')
print(response["Payload"])
```

```

You can check the return of the Lambda you called by using "read()".  
```
import boto3

client = boto3.client('lambda')

response = client.invoke(
        FunctionName='kobayashi-test')
print(response["Payload"].read())
```

```
b'{"statusCode": 200, "body": "\"Hello from Lambda!\""}'
```

boto3: where is the Payload attribute of the object returned by `Lambda.Client.invoke` documented?

関連するコンテンツ