health_describe_event_details_for_organization: Returns detailed information about one or more specified...

Description Usage Arguments Value Request syntax

View source: R/health_operations.R

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:

For more information, see Event.

Usage

1
2
health_describe_event_details_for_organization(
  organizationEventDetailFilters, locale)

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.

Value

A list with the following syntax:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
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"
    )
  )
)

Request syntax

1
2
3
4
5
6
7
8
9
svc$describe_event_details_for_organization(
  organizationEventDetailFilters = list(
    list(
      eventArn = "string",
      awsAccountId = "string"
    )
  ),
  locale = "string"
)

paws.management documentation built on March 8, 2021, 1:07 a.m.