health_describe_event_details: 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. Information includes standard event data (Region, service, and so on, as returned by describe_events), 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 operation.

If a specified event cannot be retrieved, an error message is returned for that event.

Usage

1
health_describe_event_details(eventArns, locale)

Arguments

eventArns

[required] A list of event ARNs (unique identifiers). For example: "arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-CDE456", "arn:aws:health:us-west-1::event/EBS/AWS_EBS_LOST_VOLUME/AWS_EBS_LOST_VOLUME_CHI789_JKL101"

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
list(
  successfulSet = list(
    list(
      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(
      eventArn = "string",
      errorName = "string",
      errorMessage = "string"
    )
  )
)

Request syntax

1
2
3
4
5
6
svc$describe_event_details(
  eventArns = list(
    "string"
  ),
  locale = "string"
)

paws.management documentation built on Aug. 23, 2021, 9:11 a.m.