Skip to content

Bedrock Agent  >  Operations  >  put_resource_policy

put_resource_policy

Operation

put_resource_policy async 

put_resource_policy(input: PutResourcePolicyInput, plugins: list[Plugin] | None = None) -> PutResourcePolicyOutput

Associates a resource policy with a knowledge base. A resource policy allows other AWS accounts to access the knowledge base. For more information, see Cross-account access for knowledge bases.

Parameters:

Name Type Description Default
input PutResourcePolicyInput

An instance of PutResourcePolicyInput.

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

Input

PutResourcePolicyInput dataclass

Dataclass for PutResourcePolicyInput structure.

Attributes

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

The expected revision identifier of the resource policy. Use this to prevent conflicts when multiple users update the same policy concurrently. Specify the revisionId from the most recent GetResourcePolicy or PutResourcePolicy response.

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

The JSON-formatted resource policy to associate with the knowledge base.

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

The Amazon Resource Name (ARN) of the knowledge base to attach the resource policy to.

Output

PutResourcePolicyOutput dataclass

Dataclass for PutResourcePolicyOutput structure.

Attributes

resource_arn instance-attribute 
resource_arn: str

The ARN of the knowledge base that the resource policy was attached to.

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = field(default=EMPTY_RESPONSE_METADATA, repr=False, compare=False)

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

The revision identifier of the resource policy. Use this value in the expectedRevisionId field of a subsequent PutResourcePolicy or DeleteResourcePolicy request.