CloudTrail / Client / put_resource_policy

put_resource_policy#

CloudTrail.Client.put_resource_policy(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.put_resource_policy(
    ResourceArn='string',
    ResourcePolicy='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

  • ResourcePolicy (string) –

    [REQUIRED]

    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.

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 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

    • ResourcePolicy (string) –

      The JSON-formatted string of the Amazon Web Services 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.ResourcePolicyNotValidException

  • CloudTrail.Client.exceptions.ResourceNotFoundException

  • CloudTrail.Client.exceptions.ResourceTypeNotSupportedException

  • CloudTrail.Client.exceptions.ConflictException

  • CloudTrail.Client.exceptions.OperationNotPermittedException

  • CloudTrail.Client.exceptions.UnsupportedOperationException