IAmazonLambda.AddPermission Method (AddPermissionRequest)

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.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to AddPermissionAsync.

Namespace: Amazon.Lambda
Assembly: AWSSDK.Lambda.dll
Version: 3.x.y.z

Syntax

public abstract AddPermissionResponse AddPermission(
         AddPermissionRequest request
)

Parameters

request: Type: Amazon.Lambda.Model.AddPermissionRequest

Container for the necessary parameters to execute the AddPermission service method.

Return Value

Type: AddPermissionResponse

The response from the AddPermission service method, as returned by Lambda.

Exceptions

Exception	Condition
InvalidParameterValueException	One of the parameters in the request is not valid.
PolicyLengthExceededException	The permissions policy for the resource is too large. For more information, see Lambda quotas.
PreconditionFailedException	The RevisionId provided does not match the latest RevisionId for the Lambda function or alias. Call the GetFunction or the GetAlias API operation to retrieve the latest RevisionId for your resource.
ResourceConflictException	The resource already exists, or another operation is in progress.
ResourceNotFoundException	The resource specified in the request does not exist.
ServiceException	The Lambda service encountered an internal error.
TooManyRequestsException	The request throughput limit was exceeded. For more information, see Lambda quotas.

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.

To grant Amazon S3 permission to invoke a function


var response = client.AddPermission(new AddPermissionRequest 
{
    Action = "lambda:InvokeFunction",
    FunctionName = "my-function",
    Principal = "s3.amazonaws.com",
    SourceAccount = "123456789012",
    SourceArn = "arn:aws:s3:::my-bucket-1xpuxmplzrlbh/*",
    StatementId = "s3"
});

string statement = response.Statement;

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

To grant another account permission to invoke a function


var response = client.AddPermission(new AddPermissionRequest 
{
    Action = "lambda:InvokeFunction",
    FunctionName = "my-function",
    Principal = "223456789012",
    StatementId = "xaccount"
});

string statement = response.Statement;

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

IAmazonLambda.AddPermission (AddPermissionRequest)

Method