Amazon EventBridge
API Reference (API Version 2015-10-07)

DescribeEventBus

Displays details about an event bus in your account. This can include the external AWS accounts that are permitted to write events to your default event bus, and the associated policy. For custom event buses and partner event buses, it displays the name, ARN, policy, state, and creation time.

To enable your account to receive events from other accounts on its default event bus, use PutPermission.

For more information about partner event buses, see CreateEventBus.

Request Syntax

{ "Name": "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.

Name

The name of the event bus to show details for. If you omit this, the default event bus is displayed.

Type: String

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

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

Required: No

Response Syntax

{ "Arn": "string", "Name": "string", "Policy": "string" }

Response Elements

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

The following data is returned in JSON format by the service.

Arn

The Amazon Resource Name (ARN) of the account permitted to write events to the current account.

Type: String

Name

The name of the event bus. Currently, this is always default.

Type: String

Policy

The policy that enables the external account to send events to your account.

Type: String

Errors

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

InternalException

This exception occurs due to unexpected causes.

HTTP Status Code: 500

ResourceNotFoundException

An entity that you specified doesn't exist.

HTTP Status Code: 400

Examples

Example

The following example is run in account 444455556666, which has granted permission to AWS account 111122223333 to send events to 444455556666.

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

Example

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: <RequestId> Content-Type: application/x-amz-json-1.1 Content-Length: <PayloadSizeBytes> Date: <Date> { "Policy": { "Version":"2012-10-17", "Statement":[ { "Sid": "mysid", "Effect": "Allow", "Principal":{ "AWS": "arn:aws:iam::111122223333:root" }, "Action":"events:PutEvents", "Resource": "arn:aws:events:us-east-1:444455556666:event-bus/default" } ] }, "Name": "default", "Arn": "arn:aws:events:us-east-1:444455556666:event-bus/default" }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: