2022/04/06 - AWS Lambda - 5 new 1 updated api methods
Changes This release adds new APIs for creating and managing Lambda Function URLs and adds a new FunctionUrlAuthType parameter to the AddPermission API. Customers can use Function URLs to create built-in HTTPS endpoints on their functions.
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'
}
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 IAM 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).
Deletes a Lambda function URL. When you delete a function URL, you can't recover it. Creating a new function URL results in a different URL address.
See also: AWS API Documentation
Request Syntax
client.delete_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.
None
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
}
)
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 IAM 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.
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'
}
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 IAM 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).
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'
},
],
'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 IAM 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.
NextMarker (string) --
The pagination token that's included if more results are available.
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
}
)
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 IAM 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.
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'
}
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 IAM 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).
{'FunctionUrlAuthType': 'NONE | AWS_IAM'}
Grants an Amazon Web Services service, account, or organization permission to use a function. You can apply the policy at the function level, or specify a qualifier to restrict access to a single version or alias. If you use a qualifier, the invoker must use the full Amazon Resource Name (ARN) of that version or alias to invoke the function. Note: Lambda does not support adding policies to version $LATEST.
To grant permission to another account, specify the account ID as the Principal . To grant permission to an organization defined in Organizations, specify the organization ID as the PrincipalOrgID . For Amazon Web Services services, the principal is a domain-style identifier defined by the service, like s3.amazonaws.com or sns.amazonaws.com . For Amazon Web Services services, you can also specify the ARN of the associated resource as the SourceArn . If you grant permission to a service principal without specifying the source, other accounts could potentially configure resources in their account to invoke your Lambda function.
This action adds a statement to a resource-based permissions policy for the function. For more information about function policies, see Lambda Function Policies.
See also: AWS API Documentation
Request Syntax
client.add_permission(
FunctionName='string',
StatementId='string',
Action='string',
Principal='string',
SourceArn='string',
SourceAccount='string',
EventSourceToken='string',
Qualifier='string',
RevisionId='string',
PrincipalOrgID='string',
FunctionUrlAuthType='NONE'|'AWS_IAM'
)
string
[REQUIRED]
The name of the Lambda function, version, or alias.
Name formats
Function name - my-function (name-only), my-function:v1 (with alias).
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function .
Partial ARN - 123456789012:function:my-function .
You can append a version number or alias to any of the formats. 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
[REQUIRED]
A statement identifier that differentiates the statement from others in the same policy.
string
[REQUIRED]
The action that the principal can use on the function. For example, lambda:InvokeFunction or lambda:GetFunction .
string
[REQUIRED]
The Amazon Web Services service or account that invokes the function. If you specify a service, use SourceArn or SourceAccount to limit who can invoke the function through that service.
string
For Amazon Web Services services, the ARN of the Amazon Web Services resource that invokes the function. For example, an Amazon S3 bucket or Amazon SNS topic.
Note that Lambda configures the comparison using the StringLike operator.
string
For Amazon S3, the ID of the account that owns the resource. Use this together with SourceArn to ensure that the resource is owned by the specified account. It is possible for an Amazon S3 bucket to be deleted by its owner and recreated by another account.
string
For Alexa Smart Home functions, a token that must be supplied by the invoker.
string
Specify a version or alias to add permissions to a published version of the function.
string
Only update the policy if the revision ID matches the ID that's specified. Use this option to avoid modifying a policy that has changed since you last read it.
string
The identifier for your organization in Organizations. Use this to grant permissions to all the Amazon Web Services accounts under this organization.
string
The type of authentication that your function URL uses. Set to AWS_IAM if you want to restrict access to authenticated IAM 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
Response Syntax
{
'Statement': 'string'
}
Response Structure
(dict) --
Statement (string) --
The permission statement that's added to the function policy.