AddPermissionCommand

Suggest an Edit

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 .

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { LambdaClient, AddPermissionCommand } from "@aws-sdk/client-lambda"; // ES Modules import
// const { LambdaClient, AddPermissionCommand } = require("@aws-sdk/client-lambda"); // CommonJS import
const client = new LambdaClient(config);
const input = { // AddPermissionRequest
  FunctionName: "STRING_VALUE", // required
  StatementId: "STRING_VALUE", // required
  Action: "STRING_VALUE", // required
  Principal: "STRING_VALUE", // required
  SourceArn: "STRING_VALUE",
  SourceAccount: "STRING_VALUE",
  EventSourceToken: "STRING_VALUE",
  Qualifier: "STRING_VALUE",
  RevisionId: "STRING_VALUE",
  PrincipalOrgID: "STRING_VALUE",
  FunctionUrlAuthType: "NONE" || "AWS_IAM",
};
const command = new AddPermissionCommand(input);
const response = await client.send(command);
// { // AddPermissionResponse
//   Statement: "STRING_VALUE",
// };

Example Usage

 Loading code editor

AddPermissionCommand Input

See AddPermissionCommandInput for more details

Parameter
Type
Description
Action
Required
string | undefined

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

FunctionName
Required
string | undefined

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.

Principal
Required
string | undefined

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.

StatementId
Required
string | undefined

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

EventSourceToken
string | undefined

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

FunctionUrlAuthType
FunctionUrlAuthType | undefined

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 Security and auth model for Lambda function URLs .

PrincipalOrgID
string | undefined

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

Qualifier
string | undefined

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

RevisionId
string | undefined

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.

SourceAccount
string | undefined

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.

SourceArn
string | undefined

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.

AddPermissionCommand Output

See AddPermissionCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
Statement
string | undefined

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

Throws

Name
Fault
Details
InvalidParameterValueException
client

One of the parameters in the request is not valid.

PolicyLengthExceededException
client

The permissions policy for the resource is too large. For more information, see Lambda quotas .

PreconditionFailedException
client

The RevisionId provided does not match the latest RevisionId for the Lambda function or alias.

  • For AddPermission and RemovePermission API operations: Call GetPolicy to retrieve the latest RevisionId for your resource.

  • For all other API operations: Call GetFunction or GetAlias to retrieve the latest RevisionId for your resource.

ResourceConflictException
client

The resource already exists, or another operation is in progress.

ResourceNotFoundException
client

The resource specified in the request does not exist.

ServiceException
server

The Lambda service encountered an internal error.

TooManyRequestsException
client

The request throughput limit was exceeded. For more information, see Lambda quotas .

LambdaServiceException
Base exception class for all service exceptions from Lambda service.