Skip to content

CloudTrail  >  Operations  >  get_resource_policy

get_resource_policy

Operation

get_resource_policy async 

get_resource_policy(input: GetResourcePolicyInput, plugins: list[Plugin] | None = None) -> GetResourcePolicyOutput

Retrieves the JSON text of the resource-based policy document attached to the CloudTrail event data store, dashboard, or channel.

Parameters:

Name Type Description Default
input GetResourcePolicyInput

An instance of GetResourcePolicyInput.

 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
GetResourcePolicyOutput

An instance of GetResourcePolicyOutput.

Input

GetResourcePolicyInput dataclass

Dataclass for GetResourcePolicyInput structure.

Attributes

resource_arn class-attribute instance-attribute 
resource_arn: str | None = 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

Output

GetResourcePolicyOutput dataclass

Dataclass for GetResourcePolicyOutput structure.

Attributes

delegated_admin_resource_policy class-attribute instance-attribute 
delegated_admin_resource_policy: str | None = 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 = None

The Amazon Resource Name (ARN) of the CloudTrail event data store, dashboard, or channel attached to 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 = None

A JSON-formatted string that contains the resource-based policy attached to the CloudTrail event data store, dashboard, or channel.