add_permission - Boto3 1.34.74 documentation

May 2024 · 4 minute read

Grants an Amazon Web Service, Amazon Web Services account, or Amazon Web Services 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, the principal is a domain-style identifier that the service defines, such as s3.amazonaws.com or sns.amazonaws.com. For Amazon Web 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 operation adds a statement to a resource-based permissions policy for the function. For more information about function policies, see Using resource-based policies for Lambda.

See also: AWS API Documentation

Request Syntax

response = 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' ) 
Parameters:Return type:

dict

Returns:

Response Syntax

{ 'Statement': 'string' } 

Response Structure

Exceptions

Examples

The following example adds permission for Amazon S3 to invoke a Lambda function named my-function for notifications from a bucket named my-bucket-1xpuxmplzrlbh in account 123456789012.

response = client.add_permission( Action='lambda:InvokeFunction', FunctionName='my-function', Principal='s3.amazonaws.com', SourceAccount='123456789012', SourceArn='arn:aws:s3:::my-bucket-1xpuxmplzrlbh/*', StatementId='s3', ) print(response) 

Expected Output:

{ 'Statement': '{"Sid":"s3","Effect":"Allow","Principal":{"Service":"s3.amazonaws.com"},"Action":"lambda:InvokeFunction","Resource":"arn:aws:lambda:us-east-2:123456789012:function:my-function","Condition":{"StringEquals":{"AWS:SourceAccount":"123456789012"},"ArnLike":{"AWS:SourceArn":"arn:aws:s3:::my-bucket-1xpuxmplzrlbh"}}}', 'ResponseMetadata': { '...': '...', }, } 

The following example adds permission for account 223456789012 invoke a Lambda function named my-function.

response = client.add_permission( Action='lambda:InvokeFunction', FunctionName='my-function', Principal='223456789012', StatementId='xaccount', ) print(response) 

Expected Output:

{ 'Statement': '{"Sid":"xaccount","Effect":"Allow","Principal":{"AWS":"arn:aws:iam::223456789012:root"},"Action":"lambda:InvokeFunction","Resource":"arn:aws:lambda:us-east-2:123456789012:function:my-function"}', 'ResponseMetadata': { '...': '...', }, } 

ncG1vNJzZmian6m8dHrAppizp56WxLR6wqikaK5hZLGwr9SmnKeskam2sLqOmqeiZ5yWwaa%2F02ipnp6Vp7Kvr8Roqp6qpp6wpr%2BOpZimmpSWfKS4yJ6lrWeRmbGgvMSrpKKro568r3rHraSl