put_resource_policy¶
Operation¶
put_resource_policy
async
¶
put_resource_policy(input: PutResourcePolicyInput, plugins: list[Plugin] | None = None) -> PutResourcePolicyOutput
Adds a resource-based policy to a Lambda resource. Resource-based policies grant access to other Amazon Web Services accounts, organizations, or services. Resource-based policies apply to a single Lambda resource (for example, a function, function version, or function alias).
Warning
This operation replaces any existing policy on the Lambda resource. If you previously added permissions using the AddPermission operation, the new policy overwrites those permissions.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
PutResourcePolicyInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
PutResourcePolicyOutput
|
An instance of |
Input¶
PutResourcePolicyInput
dataclass
¶
Dataclass for PutResourcePolicyInput structure.
Attributes¶
policy
class-attribute
instance-attribute
¶
policy: str | None = None
The policy document you want to add to your Lambda resource. This is formatted as a JSON string.
For more information, see Working with resource-based policies in Lambda in the Lambda Developer Guide.
resource_arn
class-attribute
instance-attribute
¶
resource_arn: str | None = None
The Amazon Resource Name (ARN) of the Lambda resource you want to add the policy to. You can use a qualified or an unqualified ARN. The value must be a complete ARN, and the operation does not accept wildcard characters.
revision_id
class-attribute
instance-attribute
¶
revision_id: str | None = None
The revision ID that the existing policy must match for the replacement
to proceed. If the revision ID doesn't match, the operation fails with
a PreconditionFailedException error. To retrieve the current revision
ID, use the GetResourcePolicy operation.
Output¶
PutResourcePolicyOutput
dataclass
¶
Dataclass for PutResourcePolicyOutput structure.