AWS Lambda

{'PrincipalOrgID': 'string'}

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'
)

type FunctionName

string

param FunctionName

[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.

type StatementId

string

param StatementId

[REQUIRED]

A statement identifier that differentiates the statement from others in the same policy.

type Action

string

param Action

[REQUIRED]

The action that the principal can use on the function. For example, lambda:InvokeFunction or lambda:GetFunction .

type Principal

string

param Principal

[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.

type SourceArn

string

param SourceArn

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.

type SourceAccount

string

param SourceAccount

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.

type EventSourceToken

string

param EventSourceToken

For Alexa Smart Home functions, a token that must be supplied by the invoker.

type Qualifier

string

param Qualifier

Specify a version or alias to add permissions to a published version of the function.

type RevisionId

string

param RevisionId

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.

type PrincipalOrgID

string

param PrincipalOrgID

The identifier for your organization in Organizations. Use this to grant permissions to all the Amazon Web Services accounts under this organization.

rtype

dict

returns

Response Syntax

{
    'Statement': 'string'
}

Response Structure

• (dict) --

  • Statement (string) --

    The permission statement that's added to the function policy.