paws.compute (version 0.1.0)

lambda_add_permission: Grants an AWS service or another account permission to use a function

Description

Grants an AWS service or another account 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.

Usage

lambda_add_permission(FunctionName, StatementId, Action, Principal,
  SourceArn, SourceAccount, EventSourceToken, Qualifier, RevisionId)

Arguments

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.

StatementId

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

Action

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

Principal

[required] The AWS 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.

SourceArn

For AWS services, the ARN of the AWS resource that invokes the function. For example, an Amazon S3 bucket or Amazon SNS topic.

SourceAccount

For AWS services, the ID of the account that owns the resource. Use this instead of SourceArn to grant permission to resources that are owned by another account (for example, all of an account's Amazon S3 buckets). Or use it together with SourceArn to ensure that the resource is owned by the specified account. For example, an Amazon S3 bucket could be deleted by its owner and recreated by another account.

EventSourceToken

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

Qualifier

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

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.

Request syntax

svc$add_permission(
  FunctionName = "string",
  StatementId = "string",
  Action = "string",
  Principal = "string",
  SourceArn = "string",
  SourceAccount = "string",
  EventSourceToken = "string",
  Qualifier = "string",
  RevisionId = "string"
)

Details

To grant permission to another account, specify the account ID as the Principal. For AWS services, the principal is a domain-style identifier defined by the service, like s3.amazonaws.com or sns.amazonaws.com. For AWS services, you can also specify the ARN or owning account of the associated resource as the SourceArn or SourceAccount. 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 permission policy for the function. For more information about function policies, see Lambda Function Policies.

Examples

# NOT RUN {
# This example adds a permission for an S3 bucket to invoke a Lambda
# function.
# }
# NOT RUN {
svc$add_permission(
  Action = "lambda:InvokeFunction",
  FunctionName = "MyFunction",
  Principal = "s3.amazonaws.com",
  SourceAccount = "123456789012",
  SourceArn = "arn:aws:s3:::examplebucket/*",
  StatementId = "ID-1"
)
# }
# NOT RUN {
# }