CloudTrail / Client / get_resource_policy

get_resource_policy#

CloudTrail.Client.get_resource_policy(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.get_resource_policy(
    ResourceArn='string'
)
Parameters:

ResourceArn (string) –

[REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'ResourceArn': 'string',
    'ResourcePolicy': 'string',
    'DelegatedAdminResourcePolicy': 'string'
}

Response Structure

  • (dict) –

    • ResourceArn (string) –

      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

    • ResourcePolicy (string) –

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

    • DelegatedAdminResourcePolicy (string) –

      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.

Exceptions

  • CloudTrail.Client.exceptions.ResourceARNNotValidException

  • CloudTrail.Client.exceptions.ResourceNotFoundException

  • CloudTrail.Client.exceptions.ResourcePolicyNotFoundException

  • CloudTrail.Client.exceptions.ResourceTypeNotSupportedException

  • CloudTrail.Client.exceptions.OperationNotPermittedException

  • CloudTrail.Client.exceptions.UnsupportedOperationException