Describe Event Bus

eventbridge_describe_event_bus

R Documentation

Displays details about an event bus in your account¶

Description¶

Displays details about an event bus in your account. This can include the external Amazon Web Services 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 put_permission.

For more information about partner event buses, see create_event_bus.

Usage¶

eventbridge_describe_event_bus(Name)

Arguments¶

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

Value¶

A list with the following syntax:

list(
  Name = "string",
  Arn = "string",
  Description = "string",
  KmsKeyIdentifier = "string",
  DeadLetterConfig = list(
    Arn = "string"
  ),
  Policy = "string",
  CreationTime = as.POSIXct(
    "2015-01-01"
  ),
  LastModifiedTime = as.POSIXct(
    "2015-01-01"
  )
)

Request syntax¶

svc$describe_event_bus(
  Name = "string"
)