addPermission method

Future<AddPermissionResponse> addPermission({ required String action, required String functionName, required String principal, required String statementId, String? eventSourceToken, String? qualifier, String? revisionId, String? sourceAccount, String? sourceArn, })

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.

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

May throw ServiceException. May throw ResourceNotFoundException. May throw ResourceConflictException. May throw InvalidParameterValueException. May throw PolicyLengthExceededException. May throw TooManyRequestsException. May throw PreconditionFailedException.

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

Parameter functionName : 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.

Parameter principal : 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.

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

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

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

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

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

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

Implementation

Future<AddPermissionResponse> addPermission({
  required String action,
  required String functionName,
  required String principal,
  required String statementId,
  String? eventSourceToken,
  String? qualifier,
  String? revisionId,
  String? sourceAccount,
  String? sourceArn,
}) async {
  ArgumentError.checkNotNull(action, 'action');
  ArgumentError.checkNotNull(functionName, 'functionName');
  _s.validateStringLength(
    'functionName',
    functionName,
    1,
    140,
    isRequired: true,
  );
  ArgumentError.checkNotNull(principal, 'principal');
  ArgumentError.checkNotNull(statementId, 'statementId');
  _s.validateStringLength(
    'statementId',
    statementId,
    1,
    100,
    isRequired: true,
  );
  _s.validateStringLength(
    'eventSourceToken',
    eventSourceToken,
    0,
    256,
  );
  _s.validateStringLength(
    'qualifier',
    qualifier,
    1,
    128,
  );
  final $query = <String, List<String>>{
    if (qualifier != null) 'Qualifier': [qualifier],
  };
  final $payload = <String, dynamic>{
    'Action': action,
    'Principal': principal,
    'StatementId': statementId,
    if (eventSourceToken != null) 'EventSourceToken': eventSourceToken,
    if (revisionId != null) 'RevisionId': revisionId,
    if (sourceAccount != null) 'SourceAccount': sourceAccount,
    if (sourceArn != null) 'SourceArn': sourceArn,
  };
  final response = await _protocol.send(
    payload: $payload,
    method: 'POST',
    requestUri:
        '/2015-03-31/functions/${Uri.encodeComponent(functionName)}/policy',
    queryParams: $query,
    exceptionFnMap: _exceptionFns,
  );
  return AddPermissionResponse.fromJson(response);
}