Skip to content

put_resource_policy

Operation

put_resource_policy

put_resource_policy(request: PutResourcePolicyInput | PutResourcePolicyInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[PutResourcePolicyInputDict]) -> 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
request PutResourcePolicyInput | PutResourcePolicyInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[PutResourcePolicyInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
PutResourcePolicyOutput

An instance of PutResourcePolicyOutput.

put_resource_policy async

put_resource_policy(request: PutResourcePolicyInput | PutResourcePolicyInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[PutResourcePolicyInputDict]) -> 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
request PutResourcePolicyInput | PutResourcePolicyInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[PutResourcePolicyInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
PutResourcePolicyOutput

An instance of PutResourcePolicyOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

PutResourcePolicyInputDict

Bases: TypedDict

Dictionary form of PutResourcePolicyInput.

Attributes

policy instance-attribute
policy: Required[str]

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 instance-attribute
resource_arn: Required[str]

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 instance-attribute
revision_id: str | 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.

PutResourcePolicyInput dataclass

Bases: _SerdeShape

Dataclass for PutResourcePolicyInput structure.

Attributes

policy class-attribute instance-attribute
policy: str | 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 = ...

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

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

Bases: _SerdeShape

Dataclass for PutResourcePolicyOutput structure.

Attributes

policy class-attribute instance-attribute
policy: str | None = ...

The resource-based policy that Lambda adds to the resource.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

revision_id class-attribute instance-attribute
revision_id: str | None = ...

The revision ID of the policy that Lambda adds to your Lambda resource.