Skip to content

DynamoDB  >  Operations  >  get_resource_policy

get_resource_policy

Operation

get_resource_policy async

get_resource_policy(input: GetResourcePolicyInput, plugins: list[Plugin] | None = None) -> GetResourcePolicyOutput

Returns the resource-based policy document attached to the resource, which can be a table or stream, in JSON format.

GetResourcePolicy follows an eventually consistent model. The following list describes the outcomes when you issue the GetResourcePolicy request immediately after issuing another request:

  • If you issue a GetResourcePolicy request immediately after a PutResourcePolicy request, DynamoDB might return a PolicyNotFoundException.

  • If you issue a GetResourcePolicyrequest immediately after a DeleteResourcePolicy request, DynamoDB might return the policy that was present before the deletion request.

  • If you issue a GetResourcePolicy request immediately after a CreateTable request, which includes a resource-based policy, DynamoDB might return a ResourceNotFoundException or a PolicyNotFoundException.

Because GetResourcePolicy uses an eventually consistent query, the metadata for your policy or table might not be available at that moment. Wait for a few seconds, and then retry the GetResourcePolicy request.

After a GetResourcePolicy request returns a policy created using the PutResourcePolicy request, the policy will be applied in the authorization of requests to the resource. Because this process is eventually consistent, it will take some time to apply the policy to all requests to a resource. Policies that you attach while creating a table using the CreateTable request will always be applied to all requests for that table.

Parameters:

Name Type Description Default
input GetResourcePolicyInput

An instance of GetResourcePolicyInput.

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
GetResourcePolicyOutput

An instance of GetResourcePolicyOutput.

Input

GetResourcePolicyInput dataclass

Dataclass for GetResourcePolicyInput structure.

Attributes

resource_arn class-attribute instance-attribute
resource_arn: str | None = None

The Amazon Resource Name (ARN) of the DynamoDB resource to which the policy is attached. The resources you can specify include tables and streams.

Output

GetResourcePolicyOutput dataclass

Dataclass for GetResourcePolicyOutput structure.

Attributes

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

The resource-based policy document attached to the resource, which can be a table or stream, in JSON format.

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

A unique string that represents the revision ID of the policy. If you're comparing revision IDs, make sure to always use string comparison logic.