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.

Running PutPermission permits the specified Amazon Web Services account or Amazon Web Services organization to put events to the specified event bus. Amazon EventBridge (CloudWatch Events) rules in your account are triggered by these events arriving to an event bus in your account.

For another account to send events to your account, that external account must have an EventBridge rule with your account's event bus as a target.

To enable multiple Amazon Web Services accounts to put events to your event bus, run PutPermission once for each of these accounts. Or, if all the accounts are members of the same Amazon Web Services organization, you can run PutPermission once specifying Principal as "*" and specifying the Amazon Web Services organization ID in Condition, to grant permissions to all accounts in that organization.

If you grant permissions using an organization, then accounts in that organization must specify a RoleArn with proper permissions when they use PutTarget to add your account's event bus as a target. For more information, see Sending and Receiving Events Between Amazon Web Services Accounts in the Amazon EventBridge User Guide.

The permission policy on the event bus cannot exceed 10 KB in size.

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 BeginPutPermission and EndPutPermission.

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

Syntax

C#
public virtual Task<PutPermissionResponse> PutPermissionAsync(
         PutPermissionRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.CloudWatchEvents.Model.PutPermissionRequest

Container for the necessary parameters to execute the PutPermission 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 PutPermission service method, as returned by CloudWatchEvents.

Exceptions

ExceptionCondition
ConcurrentModificationException There is concurrent modification on a rule, target, archive, or replay.
InternalException This exception occurs due to unexpected causes.
OperationDisabledException The operation you are attempting is not available in this region.
PolicyLengthExceededException The event bus policy is too long. For more information, see the limits.
ResourceNotFoundException An entity that you specified does not exist.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also