health_describe_event_details_for_organization: Returns detailed information about one or more specified events for one or more accounts in your organization

Description

Returns detailed information about one or more specified events for one or more accounts in your organization. Information includes standard event data (Region, service, and so on, as returned by describe_events_for_organization), a detailed event description, and possible additional metadata that depends upon the nature of the event. Affected entities are not included; to retrieve those, use the describe_affected_entities_for_organization operation.

Before you can call this operation, you must first enable AWS Health to work with AWS Organizations. To do this, call the enable_health_service_access_for_organization operation from your organization's master account.

When you call the describe_event_details_for_organization operation, you specify the organizationEventDetailFilters object in the request. Depending on the AWS Health event type, note the following differences:

If the event is public, the awsAccountId parameter must be empty. If you specify an account ID for a public event, then an error message is returned. That's because the event might apply to all AWS accounts and isn't specific to an account in your organization.
If the event is specific to an account, then you must specify the awsAccountId parameter in the request. If you don't specify an account ID, an error message returns because the event is specific to an AWS account in your organization.

For more information, see Event.

Usage

health_describe_event_details_for_organization(
  organizationEventDetailFilters, locale)

Value

A list with the following syntax:

list(
  successfulSet = list(
    list(
      awsAccountId = "string",
      event = list(
        arn = "string",
        service = "string",
        eventTypeCode = "string",
        eventTypeCategory = "issue"|"accountNotification"|"scheduledChange"|"investigation",
        region = "string",
        availabilityZone = "string",
        startTime = as.POSIXct(
          "2015-01-01"
        ),
        endTime = as.POSIXct(
          "2015-01-01"
        ),
        lastUpdatedTime = as.POSIXct(
          "2015-01-01"
        ),
        statusCode = "open"|"closed"|"upcoming",
        eventScopeCode = "PUBLIC"|"ACCOUNT_SPECIFIC"|"NONE"
      ),
      eventDescription = list(
        latestDescription = "string"
      ),
      eventMetadata = list(
        "string"
      )
    )
  ),
  failedSet = list(
    list(
      awsAccountId = "string",
      eventArn = "string",
      errorName = "string",
      errorMessage = "string"
    )
  )
)

Arguments

organizationEventDetailFilters: [required] A set of JSON elements that includes the awsAccountId and the eventArn.
locale: The locale (language) to return information in. English (en) is the default and the only supported value at this time.

Request syntax

svc$describe_event_details_for_organization(
  organizationEventDetailFilters = list(
    list(
      eventArn = "string",
      awsAccountId = "string"
    )
  ),
  locale = "string"
)