Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

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 or ARN 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 1600.

Pattern: (arn:aws[\w-]*:events:[a-z]{2}-[a-z]+-[\w-]+:[0-9]{12}:event-bus\/)?[/\.\-_A-Za-z0-9]+

Required: No

Response Syntax


{
   "Arn": "string",
   "CreationTime": number,
   "DeadLetterConfig": { 
      "Arn": "string"
   },
   "Description": "string",
   "KmsKeyIdentifier": "string",
   "LastModifiedTime": number,
   "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

CreationTime

The time the event bus was created.

Type: Timestamp

DeadLetterConfig

Configuration details of the Amazon SQS queue for EventBridge to use as a dead-letter queue (DLQ).

For more information, see Using dead-letter queues to process undelivered events in the EventBridge User Guide.

Type: DeadLetterConfig object

Description

The event bus description.

Type: String

Length Constraints: Maximum length of 512.

KmsKeyIdentifier

The identifier of the AWS KMS customer managed key for EventBridge to use to encrypt events on this event bus, if one has been specified.

For more information, see Data encryption in EventBridge in the Amazon EventBridge User Guide.

Type: String

Length Constraints: Maximum length of 2048.

LastModifiedTime

The time the event bus was last modified.

Type: Timestamp

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

This example illustrates one usage of DescribeEventBus.

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