Skip to content

/AWS1/IF_LMD=>ADDPERMISSION()

About AddPermission

Grants a principal 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 that the service defines, such as 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 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.

Method Signature

METHODS /AWS1/IF_LMD~ADDPERMISSION
  IMPORTING
    !IV_FUNCTIONNAME TYPE /AWS1/LMDNAMESPACEDFUNCNAME OPTIONAL
    !IV_STATEMENTID TYPE /AWS1/LMDSTATEMENTID OPTIONAL
    !IV_ACTION TYPE /AWS1/LMDACTION OPTIONAL
    !IV_PRINCIPAL TYPE /AWS1/LMDPRINCIPAL OPTIONAL
    !IV_SOURCEARN TYPE /AWS1/LMDARN OPTIONAL
    !IV_SOURCEACCOUNT TYPE /AWS1/LMDSOURCEOWNER OPTIONAL
    !IV_EVENTSOURCETOKEN TYPE /AWS1/LMDEVENTSOURCETOKEN OPTIONAL
    !IV_QUALIFIER TYPE /AWS1/LMDNUMERICLATPUBEDORAL00 OPTIONAL
    !IV_REVISIONID TYPE /AWS1/LMDSTRING OPTIONAL
    !IV_PRINCIPALORGID TYPE /AWS1/LMDPRINCIPALORGID OPTIONAL
    !IV_FUNCTIONURLAUTHTYPE TYPE /AWS1/LMDFUNCTIONURLAUTHTYPE OPTIONAL
    !IV_INVOKEDVIAFUNCTIONURL TYPE /AWS1/LMDINVOKEDVIAFUNCTIONURL OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_lmdaddpermresponse
  RAISING
    /AWS1/CX_LMDINVPARAMVALUEEX
    /AWS1/CX_LMDPOLICYLENGTHEXCDEX
    /AWS1/CX_LMDPRECONDFAILEDEX
    /AWS1/CX_LMDRESOURCECONFLICTEX
    /AWS1/CX_LMDRESOURCENOTFOUNDEX
    /AWS1/CX_LMDSERVICEEXCEPTION
    /AWS1/CX_LMDTOOMANYREQUESTSEX
    /AWS1/CX_LMDCLIENTEXC
    /AWS1/CX_LMDSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_functionname TYPE /AWS1/LMDNAMESPACEDFUNCNAME /AWS1/LMDNAMESPACEDFUNCNAME

The name or ARN 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.

iv_statementid TYPE /AWS1/LMDSTATEMENTID /AWS1/LMDSTATEMENTID

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

iv_action TYPE /AWS1/LMDACTION /AWS1/LMDACTION

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

iv_principal TYPE /AWS1/LMDPRINCIPAL /AWS1/LMDPRINCIPAL

The Amazon Web Services service, Amazon Web Services account, IAM user, or IAM role that invokes the function. If you specify a service, use SourceArn or SourceAccount to limit who can invoke the function through that service.

Optional arguments:

iv_sourcearn TYPE /AWS1/LMDARN /AWS1/LMDARN

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.

iv_sourceaccount TYPE /AWS1/LMDSOURCEOWNER /AWS1/LMDSOURCEOWNER

For Amazon Web Services service, the ID of the Amazon Web Services account that owns the resource. Use this together with SourceArn to ensure that the specified account owns the resource. It is possible for an Amazon S3 bucket to be deleted by its owner and recreated by another account.

iv_eventsourcetoken TYPE /AWS1/LMDEVENTSOURCETOKEN /AWS1/LMDEVENTSOURCETOKEN

For Alexa Smart Home functions, a token that the invoker must supply.

iv_qualifier TYPE /AWS1/LMDNUMERICLATPUBEDORAL00 /AWS1/LMDNUMERICLATPUBEDORAL00

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

iv_revisionid TYPE /AWS1/LMDSTRING /AWS1/LMDSTRING

Update the policy only 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.

iv_principalorgid TYPE /AWS1/LMDPRINCIPALORGID /AWS1/LMDPRINCIPALORGID

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

iv_functionurlauthtype TYPE /AWS1/LMDFUNCTIONURLAUTHTYPE /AWS1/LMDFUNCTIONURLAUTHTYPE

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 Control access to Lambda function URLs.

iv_invokedviafunctionurl TYPE /AWS1/LMDINVOKEDVIAFUNCTIONURL /AWS1/LMDINVOKEDVIAFUNCTIONURL

Indicates whether the permission applies when the function is invoked through a function URL.

RETURNING

oo_output TYPE REF TO /aws1/cl_lmdaddpermresponse /AWS1/CL_LMDADDPERMRESPONSE

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->addpermission(
  iv_action = |string|
  iv_eventsourcetoken = |string|
  iv_functionname = |string|
  iv_functionurlauthtype = |string|
  iv_invokedviafunctionurl = ABAP_TRUE
  iv_principal = |string|
  iv_principalorgid = |string|
  iv_qualifier = |string|
  iv_revisionid = |string|
  iv_sourceaccount = |string|
  iv_sourcearn = |string|
  iv_statementid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_string = lo_result->get_statement( ).
ENDIF.

To grant Amazon S3 permission to invoke a function

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.

DATA(lo_result) = lo_client->addpermission(
  iv_action = |lambda:InvokeFunction|
  iv_functionname = |my-function|
  iv_principal = |s3.amazonaws.com|
  iv_sourceaccount = |123456789012|
  iv_sourcearn = |arn:aws:s3:::my-bucket-1xpuxmplzrlbh/*|
  iv_statementid = |s3|
).

To grant another account permission to invoke a function

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

DATA(lo_result) = lo_client->addpermission(
  iv_action = |lambda:InvokeFunction|
  iv_functionname = |my-function|
  iv_principal = |223456789012|
  iv_statementid = |xaccount|
).