put_resource_policy¶
Operation¶
put_resource_policy
¶
put_resource_policy(request: PutResourcePolicyInput | PutResourcePolicyInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[PutResourcePolicyInputDict]) -> PutResourcePolicyOutput
Attaches a resource-based permission policy to a CloudTrail event data store, dashboard, or channel. For more information about resource-based policies, see CloudTrail resource-based policy examples in the CloudTrail User Guide.
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
Attaches a resource-based permission policy to a CloudTrail event data store, dashboard, or channel. For more information about resource-based policies, see CloudTrail resource-based policy examples in the CloudTrail User Guide.
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¶
resource_arn
instance-attribute
¶
The Amazon Resource Name (ARN) of the CloudTrail event data store, dashboard, or channel attached to the resource-based policy.
Example event data store ARN format:
arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE
Example dashboard ARN format:
arn:aws:cloudtrail:us-east-1:123456789012:dashboard/exampleDash
Example channel ARN format:
arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890
resource_policy
instance-attribute
¶
A JSON-formatted string for an Amazon Web Services resource-based policy.
For example resource-based policies, see CloudTrail resource-based policy examples in the CloudTrail User Guide.
PutResourcePolicyInput
dataclass
¶
Bases: _SerdeShape
Dataclass for PutResourcePolicyInput structure.
Attributes¶
resource_arn
class-attribute
instance-attribute
¶
resource_arn: str | None = ...
The Amazon Resource Name (ARN) of the CloudTrail event data store, dashboard, or channel attached to the resource-based policy.
Example event data store ARN format:
arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE
Example dashboard ARN format:
arn:aws:cloudtrail:us-east-1:123456789012:dashboard/exampleDash
Example channel ARN format:
arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890
resource_policy
class-attribute
instance-attribute
¶
resource_policy: str | None = ...
A JSON-formatted string for an Amazon Web Services resource-based policy.
For example resource-based policies, see CloudTrail resource-based policy examples in the CloudTrail User Guide.
Output¶
PutResourcePolicyOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for PutResourcePolicyOutput structure.
Attributes¶
delegated_admin_resource_policy
class-attribute
instance-attribute
¶
delegated_admin_resource_policy: str | None = ...
The default resource-based policy that is automatically generated for the delegated administrator of an Organizations organization. This policy will be evaluated in tandem with any policy you submit for the resource. For more information about this policy, see Default resource policy for delegated administrators.
resource_arn
class-attribute
instance-attribute
¶
resource_arn: str | None = ...
The Amazon Resource Name (ARN) of the CloudTrail event data store, dashboard, or channel attached to the resource-based policy.
Example event data store ARN format:
arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE
Example dashboard ARN format:
arn:aws:cloudtrail:us-east-1:123456789012:dashboard/exampleDash
Example channel ARN format:
arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890
resource_policy
class-attribute
instance-attribute
¶
resource_policy: str | None = ...
The JSON-formatted string of the Amazon Web Services resource-based policy attached to the CloudTrail event data store, dashboard, or channel.
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.