Skip to content

get_resource_policy

Operation

get_resource_policy

get_resource_policy(request: GetResourcePolicyInput | GetResourcePolicyInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetResourcePolicyInputDict]) -> GetResourcePolicyOutput

Retrieves the resource policy associated with a knowledge base.

Parameters:

Name Type Description Default
request GetResourcePolicyInput | GetResourcePolicyInputDict | 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[GetResourcePolicyInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetResourcePolicyOutput

An instance of GetResourcePolicyOutput.

get_resource_policy async

get_resource_policy(request: GetResourcePolicyInput | GetResourcePolicyInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetResourcePolicyInputDict]) -> GetResourcePolicyOutput

Retrieves the resource policy associated with a knowledge base.

Parameters:

Name Type Description Default
request GetResourcePolicyInput | GetResourcePolicyInputDict | 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[GetResourcePolicyInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetResourcePolicyOutput

An instance of GetResourcePolicyOutput.

Input

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

GetResourcePolicyInputDict

Bases: TypedDict

Dictionary form of GetResourcePolicyInput.

Attributes

resource_arn instance-attribute
resource_arn: Required[str]

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

GetResourcePolicyInput dataclass

Bases: _SerdeShape

Dataclass for GetResourcePolicyInput structure.

Attributes

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

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

Output

GetResourcePolicyOutput dataclass

Bases: _SerdeShape

Dataclass for GetResourcePolicyOutput structure.

Attributes

policy instance-attribute
policy: str | JsonString

The JSON-formatted resource policy associated with the knowledge base.

resource_arn instance-attribute
resource_arn: str

The ARN of the knowledge base that the resource policy is associated with.

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

The revision identifier of the resource policy.