AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Attaches a resource-based permission policy to a CloudTrail channel that is used for an integration with an event source outside of Amazon Web Services. For more information about resource-based policies, see CloudTrail resource-based policy examples in the CloudTrail User Guide.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginPutResourcePolicy and EndPutResourcePolicy.

Namespace: Amazon.CloudTrail
Assembly: AWSSDK.CloudTrail.dll
Version: 3.x.y.z

Syntax

C#
public virtual Task<PutResourcePolicyResponse> PutResourcePolicyAsync(
         PutResourcePolicyRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.CloudTrail.Model.PutResourcePolicyRequest

Container for the necessary parameters to execute the PutResourcePolicy service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the PutResourcePolicy service method, as returned by CloudTrail.

Exceptions

ExceptionCondition
OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
ResourceARNNotValidException This exception is thrown when the provided resource does not exist, or the ARN format of the resource is not valid. The following is the valid format for a resource ARN: arn:aws:cloudtrail:us-east-2:123456789012:channel/MyChannel.
ResourceNotFoundException This exception is thrown when the specified resource is not found.
ResourcePolicyNotValidException This exception is thrown when the resouce-based policy has syntax errors, or contains a principal that is not valid. The following are requirements for the resource policy: Contains only one action: cloudtrail-data:PutAuditEvents Contains at least one statement. The policy can have a maximum of 20 statements. Each statement contains at least one principal. A statement can have a maximum of 50 principals.
ResourceTypeNotSupportedException This exception is thrown when the specified resource type is not supported by CloudTrail.
UnsupportedOperationException This exception is thrown when the requested operation is not supported.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also