put_resource_policy¶
Operation¶
put_resource_policy
¶
put_resource_policy(request: PutResourcePolicyInput | PutResourcePolicyInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[PutResourcePolicyInputDict]) -> 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 |
|---|---|---|---|
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 |
put_resource_policy
async
¶
put_resource_policy(request: PutResourcePolicyInput | PutResourcePolicyInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[PutResourcePolicyInputDict]) -> 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 |
|---|---|---|---|
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 |
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¶
expected_revision_id
instance-attribute
¶
expected_revision_id: str | 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
instance-attribute
¶
The JSON-formatted resource policy to associate with the knowledge base.
PutResourcePolicyInput
dataclass
¶
Bases: _SerdeShape
Dataclass for PutResourcePolicyInput structure.
Attributes¶
expected_revision_id
class-attribute
instance-attribute
¶
expected_revision_id: str | 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.
Output¶
PutResourcePolicyOutput
dataclass
¶
Bases: _SerdeShape
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
¶
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.