Request Syntax Request Parameters Response Elements Errors Examples See Also

PutPermission

Running PutPermission permits the specified Amazon account or Amazon organization to put events to the specified event bus. Amazon EventBridge 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 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 organization, you can run PutPermission once specifying Principal as "*" and specifying the Amazon 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 Accounts in the Amazon EventBridge User Guide.

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

Request Syntax


{
   "Action": "string",
   "Condition": { 
      "Key": "string",
      "Type": "string",
      "Value": "string"
   },
   "EventBusName": "string",
   "Policy": "string",
   "Principal": "string",
   "StatementId": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Action

The action that you are enabling the other account to perform.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: events:[a-zA-Z]+

Required: No

Condition

This parameter enables you to limit the permission to accounts that fulfill a certain condition, such as being a member of a certain Amazon organization. For more information about Amazon Organizations, see What Is Amazon Organizations in the Amazon Organizations User Guide.

If you specify Condition with an Amazon organization ID, and specify "*" as the value for Principal, you grant permission to all the accounts in the named organization.

The Condition is a JSON string which must contain Type, Key, and Value fields.

Type: Condition object

Required: No

EventBusName

The name of the event bus associated with the rule. If you omit this, the default event bus is used.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [\.\-_A-Za-z0-9]+

Required: No

Policy

A JSON string that describes the permission policy statement. You can include a Policy parameter in the request instead of using the StatementId, Action, Principal, or Condition parameters.

Type: String

Required: No

Principal

The 12-digit Amazon account ID that you are permitting to put events to your default event bus. Specify "*" to permit any account to put events to your default event bus.

If you specify "*" without specifying Condition, avoid creating rules that may match undesirable events. To create more secure rules, make sure that the event pattern for each rule contains an account field with a specific account ID from which to receive events. Rules with an account field do not match any events sent from other accounts.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 12.

Pattern: (\d{12}|\*)

Required: No

StatementId

An identifier string for the external account that you are granting permissions to. If you later want to revoke the permission for this external account, specify this StatementId when you run RemovePermission.

Note

Each StatementId must be unique.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [a-zA-Z0-9-_]+

Required: No

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

ConcurrentModificationException

There is concurrent modification on a rule, target, archive, or replay.

HTTP Status Code: 400

InternalException

This exception occurs due to unexpected causes.

HTTP Status Code: 500

OperationDisabledException

The operation you are attempting is not available in this region.

HTTP Status Code: 400

PolicyLengthExceededException

The event bus policy is too long. For more information, see the limits.

HTTP Status Code: 400

ResourceNotFoundException

An entity that you specified does not exist.

HTTP Status Code: 400

Examples

The following example enables the current account to receive events from account 111122223333.

Example

This example illustrates one usage of PutPermission.

Sample Request


POST / HTTP/1.1
Host: events.<region>.<domain>
x-amz-Date: <Date>
Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=content-type;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid, Signature=<Signature>
User-Agent: <UserAgentString>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Connection: Keep-Alive 
X-Amz-Target: AWSEvents.PutPermission

{
   "Action":"events:PutEvents"
   "Principal":"111122223333"
   "StatementId":"MyStatement"
 
}

Example

The following example grants permissions to all accounts in the organization with an ID of o-1234567890

Sample Request


POST / HTTP/1.1
Host: events.<region>.<domain>
x-amz-Date: <Date>
Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=content-type;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid, Signature=<Signature>
User-Agent: <UserAgentString>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Connection: Keep-Alive 
X-Amz-Target: AWSEvents.PutPermission

{
   "Action":"events:PutEvents"
   "Principal":"*"
   "Condition": '{"Type" : "StringEquals", "Key": "aws:PrincipalOrgID", "Value": "o-1234567890"}'
   "StatementId":"MyStatement"
 
}