Skip to content

AddPermissionRequest

Source code in docs_src/capo_lambda/types/add_permission_request.py
class AddPermissionRequest(TypedDict, closed=True):
    function_name: "capo_lambda.types.namespaced_function_name.NamespacedFunctionName"
    """<p>The name or ARN of the Lambda function, version, or alias.</p> <p class="title"> <b>Name formats</b> </p> <ul> <li> <p> <b>Function name</b> – <code>my-function</code> (name-only), <code>my-function:v1</code> (with alias).</p> </li> <li> <p> <b>Function ARN</b> – <code>arn:aws:lambda:us-west-2:123456789012:function:my-function</code>.</p> </li> <li> <p> <b>Partial ARN</b> – <code>123456789012:function:my-function</code>.</p> </li> </ul> <p>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.</p>"""
    statement_id: "capo_lambda.types.statement_id.StatementId"
    """<p>A statement identifier that differentiates the statement from others in the same policy.</p>"""
    action: "capo_lambda.types.action.Action"
    """<p>The action that the principal can use on the function. For example, <code>lambda:InvokeFunction</code> or <code>lambda:GetFunction</code>.</p>"""
    principal: "capo_lambda.types.principal.Principal"
    """<p>The Amazon Web Services service, Amazon Web Services account, IAM user, or IAM role that invokes the function. If you specify a service, use <code>SourceArn</code> or <code>SourceAccount</code> to limit who can invoke the function through that service.</p>"""
    source_arn: NotRequired["capo_lambda.types.arn.Arn"]
    """<p>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.</p> <p>Note that Lambda configures the comparison using the <code>StringLike</code> operator.</p>"""
    function_url_auth_type: NotRequired[
        "capo_lambda.types.function_url_auth_type.FunctionUrlAuthType"
    ]
    """<p>The type of authentication that your function URL uses. Set to <code>AWS_IAM</code> if you want to restrict access to authenticated users only. Set to <code>NONE</code> if you want to bypass IAM authentication to create a public endpoint. For more information, see <a href="https://docs.aws.amazon.com/lambda/latest/dg/urls-auth.html">Control access to Lambda function URLs</a>.</p>"""
    invoked_via_function_url: NotRequired[
        "capo_lambda.types.invoked_via_function_url.InvokedViaFunctionUrl"
    ]
    """<p>Indicates whether the permission applies when the function is invoked through a function URL. </p>"""
    source_account: NotRequired["capo_lambda.types.source_owner.SourceOwner"]
    """<p>For Amazon Web Services service, the ID of the Amazon Web Services account that owns the resource. Use this together with <code>SourceArn</code> 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.</p>"""
    event_source_token: NotRequired[
        "capo_lambda.types.event_source_token.EventSourceToken"
    ]
    """<p>For Alexa Smart Home functions, a token that the invoker must supply.</p>"""
    qualifier: NotRequired[
        "capo_lambda.types.numeric_latest_published_or_alias_qualifier.NumericLatestPublishedOrAliasQualifier"
    ]
    """<p>Specify a version or alias to add permissions to a published version of the function.</p>"""
    revision_id: NotRequired["capo_lambda.types.string.String"]
    """<p>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.</p>"""
    principal_org_id: NotRequired["capo_lambda.types.principal_org_id.PrincipalOrgID"]
    """<p>The identifier for your organization in Organizations. Use this to grant permissions to all the Amazon Web Services accounts under this organization.</p>"""

action instance-attribute

action: Action

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

event_source_token instance-attribute

event_source_token: NotRequired[EventSourceToken]

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

function_name instance-attribute

function_name: NamespacedFunctionName

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.

function_url_auth_type instance-attribute

function_url_auth_type: NotRequired[FunctionUrlAuthType]

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.

invoked_via_function_url instance-attribute

invoked_via_function_url: NotRequired[InvokedViaFunctionUrl]

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

principal instance-attribute

principal: Principal

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.

principal_org_id instance-attribute

principal_org_id: NotRequired[PrincipalOrgID]

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

qualifier instance-attribute

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

revision_id instance-attribute

revision_id: NotRequired[String]

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.

source_account instance-attribute

source_account: NotRequired[SourceOwner]

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.

source_arn instance-attribute

source_arn: NotRequired[Arn]

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.

statement_id instance-attribute

statement_id: StatementId

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