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

Creates or updates a resource-based policy for a resource with the specified resourceArn.

Note

This feature is currently available only for AgentCore Runtime and Gateway.

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

Creates or updates a resource-based policy for a resource with the specified resourceArn.

Note

This feature is currently available only for AgentCore Runtime and Gateway.

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 resource policy to create or update.

resource_arn instance-attribute
resource_arn: Required[str]

The Amazon Resource Name (ARN) of the resource for which to create or update the resource policy.

PutResourcePolicyInput dataclass

Bases: _SerdeShape

Dataclass for PutResourcePolicyInput structure.

Attributes

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

The resource policy to create or update.

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

The Amazon Resource Name (ARN) of the resource for which to create or update the resource policy.

Output

PutResourcePolicyOutput dataclass

Bases: _SerdeShape

Dataclass for PutResourcePolicyOutput structure.

Attributes

policy instance-attribute
policy: str

The resource policy that was created or updated.

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.