2023/04/07 - AWS Lambda - 1 new 4 updated api methods
Changes This release adds a new Lambda InvokeWithResponseStream API to support streaming Lambda function responses. The release also adds a new InvokeMode parameter to Function Url APIs to control whether the response will be streamed or buffered.
Configure your Lambda functions to stream response payloads back to clients. For more information, see Configuring a Lambda function to stream responses.
See also: AWS API Documentation
Request Syntax
client.invoke_with_response_stream(
FunctionName='string',
InvocationType='RequestResponse'|'DryRun',
LogType='None'|'Tail',
ClientContext='string',
Qualifier='string',
Payload=b'bytes'|file
)
string
[REQUIRED]
The name of the Lambda function.
Name formats
Function name – my-function .
Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function .
Partial ARN – 123456789012:function:my-function .
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
string
Use one of the following options:
RequestResponse (default) – Invoke the function synchronously. Keep the connection open until the function returns a response or times out. The API operation response includes the function response and additional data.
DryRun – Validate parameter values and verify that the IAM user or role has permission to invoke the function.
string
Set to Tail to include the execution log in the response. Applies to synchronously invoked functions only.
string
Up to 3,583 bytes of base64-encoded data about the invoking client to pass to the function in the context object.
string
The alias name.
bytes or seekable file-like object
The JSON that you want to provide to your Lambda function as input.
You can enter the JSON directly. For example, --payload '{ "key": "value" }' . You can also specify a file path. For example, --payload file://payload.json .
dict
The response of this operation contains an :class:`.EventStream` member. When iterated the :class:`.EventStream` will yield events based on the structure below, where only one of the top level keys will be present for any given event.
Response Syntax
{
'StatusCode': 123,
'ExecutedVersion': 'string',
'EventStream': EventStream({
'PayloadChunk': {
'Payload': b'bytes'|file
},
'InvokeComplete': {
'ErrorCode': 'string',
'ErrorDetails': 'string',
'LogResult': 'string'
}
}),
'ResponseStreamContentType': 'string'
}
Response Structure
(dict) --
StatusCode (integer) --
For a successful request, the HTTP status code is in the 200 range. For the RequestResponse invocation type, this status code is 200. For the DryRun invocation type, this status code is 204.
ExecutedVersion (string) --
The version of the function that executed. When you invoke a function with an alias, this indicates which version the alias resolved to.
EventStream (:class:`.EventStream`) --
The stream of response payloads.
PayloadChunk (dict) --
A chunk of the streamed response payload.
Payload (bytes or seekable file-like object) --
Data returned by your Lambda function.
InvokeComplete (dict) --
An object that's returned when the stream has ended and all the payload chunks have been returned.
ErrorCode (string) --
An error code.
ErrorDetails (string) --
The details of any returned error.
LogResult (string) --
The last 4 KB of the execution log, which is base64-encoded.
ResponseStreamContentType (string) --
The type of data the stream is returning.
{'InvokeMode': 'BUFFERED | RESPONSE_STREAM'}
Creates a Lambda function URL with the specified configuration parameters. A function URL is a dedicated HTTP(S) endpoint that you can use to invoke your function.
See also: AWS API Documentation
Request Syntax
client.create_function_url_config(
FunctionName='string',
Qualifier='string',
AuthType='NONE'|'AWS_IAM',
Cors={
'AllowCredentials': True|False,
'AllowHeaders': [
'string',
],
'AllowMethods': [
'string',
],
'AllowOrigins': [
'string',
],
'ExposeHeaders': [
'string',
],
'MaxAge': 123
},
InvokeMode='BUFFERED'|'RESPONSE_STREAM'
)
string
[REQUIRED]
The name of the Lambda function.
Name formats
Function name – my-function .
Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function .
Partial ARN – 123456789012:function:my-function .
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
string
The alias name.
string
[REQUIRED]
The type of authentication that your function URL uses. Set to AWS_IAM if you want to restrict access to authenticated users only. Set to NONE if you want to bypass IAM authentication to create a public endpoint. For more information, see Security and auth model for Lambda function URLs.
dict
The cross-origin resource sharing (CORS) settings for your function URL.
AllowCredentials (boolean) --
Whether to allow cookies or other credentials in requests to your function URL. The default is false .
AllowHeaders (list) --
The HTTP headers that origins can include in requests to your function URL. For example: Date , Keep-Alive , X-Custom-Header .
(string) --
AllowMethods (list) --
The HTTP methods that are allowed when calling your function URL. For example: GET , POST , DELETE , or the wildcard character ( * ).
(string) --
AllowOrigins (list) --
The origins that can access your function URL. You can list any number of specific origins, separated by a comma. For example: https://www.example.com , http://localhost:60905 .
Alternatively, you can grant access to all origins using the wildcard character ( * ).
(string) --
ExposeHeaders (list) --
The HTTP headers in your function response that you want to expose to origins that call your function URL. For example: Date , Keep-Alive , X-Custom-Header .
(string) --
MaxAge (integer) --
The maximum amount of time, in seconds, that web browsers can cache results of a preflight request. By default, this is set to 0 , which means that the browser doesn't cache results.
string
Use one of the following options:
BUFFERED – This is the default option. Lambda invokes your function using the Invoke API operation. Invocation results are available when the payload is complete. The maximum payload size is 6 MB.
RESPONSE_STREAM – Your function streams payload results as they become available. Lambda invokes your function using the InvokeWithResponseStream API operation. The maximum response payload size is 20 MB, however, you can request a quota increase.
dict
Response Syntax
{
'FunctionUrl': 'string',
'FunctionArn': 'string',
'AuthType': 'NONE'|'AWS_IAM',
'Cors': {
'AllowCredentials': True|False,
'AllowHeaders': [
'string',
],
'AllowMethods': [
'string',
],
'AllowOrigins': [
'string',
],
'ExposeHeaders': [
'string',
],
'MaxAge': 123
},
'CreationTime': 'string',
'InvokeMode': 'BUFFERED'|'RESPONSE_STREAM'
}
Response Structure
(dict) --
FunctionUrl (string) --
The HTTP URL endpoint for your function.
FunctionArn (string) --
The Amazon Resource Name (ARN) of your function.
AuthType (string) --
The type of authentication that your function URL uses. Set to AWS_IAM if you want to restrict access to authenticated users only. Set to NONE if you want to bypass IAM authentication to create a public endpoint. For more information, see Security and auth model for Lambda function URLs.
Cors (dict) --
The cross-origin resource sharing (CORS) settings for your function URL.
AllowCredentials (boolean) --
Whether to allow cookies or other credentials in requests to your function URL. The default is false .
AllowHeaders (list) --
The HTTP headers that origins can include in requests to your function URL. For example: Date , Keep-Alive , X-Custom-Header .
(string) --
AllowMethods (list) --
The HTTP methods that are allowed when calling your function URL. For example: GET , POST , DELETE , or the wildcard character ( * ).
(string) --
AllowOrigins (list) --
The origins that can access your function URL. You can list any number of specific origins, separated by a comma. For example: https://www.example.com , http://localhost:60905 .
Alternatively, you can grant access to all origins using the wildcard character ( * ).
(string) --
ExposeHeaders (list) --
The HTTP headers in your function response that you want to expose to origins that call your function URL. For example: Date , Keep-Alive , X-Custom-Header .
(string) --
MaxAge (integer) --
The maximum amount of time, in seconds, that web browsers can cache results of a preflight request. By default, this is set to 0 , which means that the browser doesn't cache results.
CreationTime (string) --
When the function URL was created, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
InvokeMode (string) --
Use one of the following options:
BUFFERED – This is the default option. Lambda invokes your function using the Invoke API operation. Invocation results are available when the payload is complete. The maximum payload size is 6 MB.
RESPONSE_STREAM – Your function streams payload results as they become available. Lambda invokes your function using the InvokeWithResponseStream API operation. The maximum response payload size is 20 MB, however, you can request a quota increase.
{'InvokeMode': 'BUFFERED | RESPONSE_STREAM'}
Returns details about a Lambda function URL.
See also: AWS API Documentation
Request Syntax
client.get_function_url_config(
FunctionName='string',
Qualifier='string'
)
string
[REQUIRED]
The name of the Lambda function.
Name formats
Function name – my-function .
Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function .
Partial ARN – 123456789012:function:my-function .
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
string
The alias name.
dict
Response Syntax
{
'FunctionUrl': 'string',
'FunctionArn': 'string',
'AuthType': 'NONE'|'AWS_IAM',
'Cors': {
'AllowCredentials': True|False,
'AllowHeaders': [
'string',
],
'AllowMethods': [
'string',
],
'AllowOrigins': [
'string',
],
'ExposeHeaders': [
'string',
],
'MaxAge': 123
},
'CreationTime': 'string',
'LastModifiedTime': 'string',
'InvokeMode': 'BUFFERED'|'RESPONSE_STREAM'
}
Response Structure
(dict) --
FunctionUrl (string) --
The HTTP URL endpoint for your function.
FunctionArn (string) --
The Amazon Resource Name (ARN) of your function.
AuthType (string) --
The type of authentication that your function URL uses. Set to AWS_IAM if you want to restrict access to authenticated users only. Set to NONE if you want to bypass IAM authentication to create a public endpoint. For more information, see Security and auth model for Lambda function URLs.
Cors (dict) --
The cross-origin resource sharing (CORS) settings for your function URL.
AllowCredentials (boolean) --
Whether to allow cookies or other credentials in requests to your function URL. The default is false .
AllowHeaders (list) --
The HTTP headers that origins can include in requests to your function URL. For example: Date , Keep-Alive , X-Custom-Header .
(string) --
AllowMethods (list) --
The HTTP methods that are allowed when calling your function URL. For example: GET , POST , DELETE , or the wildcard character ( * ).
(string) --
AllowOrigins (list) --
The origins that can access your function URL. You can list any number of specific origins, separated by a comma. For example: https://www.example.com , http://localhost:60905 .
Alternatively, you can grant access to all origins using the wildcard character ( * ).
(string) --
ExposeHeaders (list) --
The HTTP headers in your function response that you want to expose to origins that call your function URL. For example: Date , Keep-Alive , X-Custom-Header .
(string) --
MaxAge (integer) --
The maximum amount of time, in seconds, that web browsers can cache results of a preflight request. By default, this is set to 0 , which means that the browser doesn't cache results.
CreationTime (string) --
When the function URL was created, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
LastModifiedTime (string) --
When the function URL configuration was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
InvokeMode (string) --
Use one of the following options:
BUFFERED – This is the default option. Lambda invokes your function using the Invoke API operation. Invocation results are available when the payload is complete. The maximum payload size is 6 MB.
RESPONSE_STREAM – Your function streams payload results as they become available. Lambda invokes your function using the InvokeWithResponseStream API operation. The maximum response payload size is 20 MB, however, you can request a quota increase.
{'FunctionUrlConfigs': {'InvokeMode': 'BUFFERED | RESPONSE_STREAM'}}
Returns a list of Lambda function URLs for the specified function.
See also: AWS API Documentation
Request Syntax
client.list_function_url_configs(
FunctionName='string',
Marker='string',
MaxItems=123
)
string
[REQUIRED]
The name of the Lambda function.
Name formats
Function name – my-function .
Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function .
Partial ARN – 123456789012:function:my-function .
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
string
Specify the pagination token that's returned by a previous request to retrieve the next page of results.
integer
The maximum number of function URLs to return in the response. Note that ListFunctionUrlConfigs returns a maximum of 50 items in each response, even if you set the number higher.
dict
Response Syntax
{
'FunctionUrlConfigs': [
{
'FunctionUrl': 'string',
'FunctionArn': 'string',
'CreationTime': 'string',
'LastModifiedTime': 'string',
'Cors': {
'AllowCredentials': True|False,
'AllowHeaders': [
'string',
],
'AllowMethods': [
'string',
],
'AllowOrigins': [
'string',
],
'ExposeHeaders': [
'string',
],
'MaxAge': 123
},
'AuthType': 'NONE'|'AWS_IAM',
'InvokeMode': 'BUFFERED'|'RESPONSE_STREAM'
},
],
'NextMarker': 'string'
}
Response Structure
(dict) --
FunctionUrlConfigs (list) --
A list of function URL configurations.
(dict) --
Details about a Lambda function URL.
FunctionUrl (string) --
The HTTP URL endpoint for your function.
FunctionArn (string) --
The Amazon Resource Name (ARN) of your function.
CreationTime (string) --
When the function URL was created, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
LastModifiedTime (string) --
When the function URL configuration was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
Cors (dict) --
The cross-origin resource sharing (CORS) settings for your function URL.
AllowCredentials (boolean) --
Whether to allow cookies or other credentials in requests to your function URL. The default is false .
AllowHeaders (list) --
The HTTP headers that origins can include in requests to your function URL. For example: Date , Keep-Alive , X-Custom-Header .
(string) --
AllowMethods (list) --
The HTTP methods that are allowed when calling your function URL. For example: GET , POST , DELETE , or the wildcard character ( * ).
(string) --
AllowOrigins (list) --
The origins that can access your function URL. You can list any number of specific origins, separated by a comma. For example: https://www.example.com , http://localhost:60905 .
Alternatively, you can grant access to all origins using the wildcard character ( * ).
(string) --
ExposeHeaders (list) --
The HTTP headers in your function response that you want to expose to origins that call your function URL. For example: Date , Keep-Alive , X-Custom-Header .
(string) --
MaxAge (integer) --
The maximum amount of time, in seconds, that web browsers can cache results of a preflight request. By default, this is set to 0 , which means that the browser doesn't cache results.
AuthType (string) --
The type of authentication that your function URL uses. Set to AWS_IAM if you want to restrict access to authenticated users only. Set to NONE if you want to bypass IAM authentication to create a public endpoint. For more information, see Security and auth model for Lambda function URLs.
InvokeMode (string) --
Use one of the following options:
BUFFERED – This is the default option. Lambda invokes your function using the Invoke API operation. Invocation results are available when the payload is complete. The maximum payload size is 6 MB.
RESPONSE_STREAM – Your function streams payload results as they become available. Lambda invokes your function using the InvokeWithResponseStream API operation. The maximum response payload size is 20 MB, however, you can request a quota increase.
NextMarker (string) --
The pagination token that's included if more results are available.
{'InvokeMode': 'BUFFERED | RESPONSE_STREAM'}
Updates the configuration for a Lambda function URL.
See also: AWS API Documentation
Request Syntax
client.update_function_url_config(
FunctionName='string',
Qualifier='string',
AuthType='NONE'|'AWS_IAM',
Cors={
'AllowCredentials': True|False,
'AllowHeaders': [
'string',
],
'AllowMethods': [
'string',
],
'AllowOrigins': [
'string',
],
'ExposeHeaders': [
'string',
],
'MaxAge': 123
},
InvokeMode='BUFFERED'|'RESPONSE_STREAM'
)
string
[REQUIRED]
The name of the Lambda function.
Name formats
Function name – my-function .
Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function .
Partial ARN – 123456789012:function:my-function .
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
string
The alias name.
string
The type of authentication that your function URL uses. Set to AWS_IAM if you want to restrict access to authenticated users only. Set to NONE if you want to bypass IAM authentication to create a public endpoint. For more information, see Security and auth model for Lambda function URLs.
dict
The cross-origin resource sharing (CORS) settings for your function URL.
AllowCredentials (boolean) --
Whether to allow cookies or other credentials in requests to your function URL. The default is false .
AllowHeaders (list) --
The HTTP headers that origins can include in requests to your function URL. For example: Date , Keep-Alive , X-Custom-Header .
(string) --
AllowMethods (list) --
The HTTP methods that are allowed when calling your function URL. For example: GET , POST , DELETE , or the wildcard character ( * ).
(string) --
AllowOrigins (list) --
The origins that can access your function URL. You can list any number of specific origins, separated by a comma. For example: https://www.example.com , http://localhost:60905 .
Alternatively, you can grant access to all origins using the wildcard character ( * ).
(string) --
ExposeHeaders (list) --
The HTTP headers in your function response that you want to expose to origins that call your function URL. For example: Date , Keep-Alive , X-Custom-Header .
(string) --
MaxAge (integer) --
The maximum amount of time, in seconds, that web browsers can cache results of a preflight request. By default, this is set to 0 , which means that the browser doesn't cache results.
string
Use one of the following options:
BUFFERED – This is the default option. Lambda invokes your function using the Invoke API operation. Invocation results are available when the payload is complete. The maximum payload size is 6 MB.
RESPONSE_STREAM – Your function streams payload results as they become available. Lambda invokes your function using the InvokeWithResponseStream API operation. The maximum response payload size is 20 MB, however, you can request a quota increase.
dict
Response Syntax
{
'FunctionUrl': 'string',
'FunctionArn': 'string',
'AuthType': 'NONE'|'AWS_IAM',
'Cors': {
'AllowCredentials': True|False,
'AllowHeaders': [
'string',
],
'AllowMethods': [
'string',
],
'AllowOrigins': [
'string',
],
'ExposeHeaders': [
'string',
],
'MaxAge': 123
},
'CreationTime': 'string',
'LastModifiedTime': 'string',
'InvokeMode': 'BUFFERED'|'RESPONSE_STREAM'
}
Response Structure
(dict) --
FunctionUrl (string) --
The HTTP URL endpoint for your function.
FunctionArn (string) --
The Amazon Resource Name (ARN) of your function.
AuthType (string) --
The type of authentication that your function URL uses. Set to AWS_IAM if you want to restrict access to authenticated users only. Set to NONE if you want to bypass IAM authentication to create a public endpoint. For more information, see Security and auth model for Lambda function URLs.
Cors (dict) --
The cross-origin resource sharing (CORS) settings for your function URL.
AllowCredentials (boolean) --
Whether to allow cookies or other credentials in requests to your function URL. The default is false .
AllowHeaders (list) --
The HTTP headers that origins can include in requests to your function URL. For example: Date , Keep-Alive , X-Custom-Header .
(string) --
AllowMethods (list) --
The HTTP methods that are allowed when calling your function URL. For example: GET , POST , DELETE , or the wildcard character ( * ).
(string) --
AllowOrigins (list) --
The origins that can access your function URL. You can list any number of specific origins, separated by a comma. For example: https://www.example.com , http://localhost:60905 .
Alternatively, you can grant access to all origins using the wildcard character ( * ).
(string) --
ExposeHeaders (list) --
The HTTP headers in your function response that you want to expose to origins that call your function URL. For example: Date , Keep-Alive , X-Custom-Header .
(string) --
MaxAge (integer) --
The maximum amount of time, in seconds, that web browsers can cache results of a preflight request. By default, this is set to 0 , which means that the browser doesn't cache results.
CreationTime (string) --
When the function URL was created, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
LastModifiedTime (string) --
When the function URL configuration was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
InvokeMode (string) --
Use one of the following options:
BUFFERED – This is the default option. Lambda invokes your function using the Invoke API operation. Invocation results are available when the payload is complete. The maximum payload size is 6 MB.
RESPONSE_STREAM – Your function streams payload results as they become available. Lambda invokes your function using the InvokeWithResponseStream API operation. The maximum response payload size is 20 MB, however, you can request a quota increase.