health_describe_affected_entities_for_organization: Returns a list of entities that have been affected by one or...

Description Usage Arguments Value Request syntax

View source: R/health_operations.R

Description

Returns a list of entities that have been affected by one or more events for one or more accounts in your organization in AWS Organizations, based on the filter criteria. Entities can refer to individual customer resources, groups of customer resources, or any other construct, depending on the AWS service.

At least one event Amazon Resource Name (ARN) and account ID are required. Results are sorted by the lastUpdatedTime of the entity, starting with the most recent.

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.

This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.

Usage

1
2
health_describe_affected_entities_for_organization(
  organizationEntityFilters, locale, nextToken, maxResults)

Arguments

organizationEntityFilters

[required] A JSON set of elements including 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.

nextToken

If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.

maxResults

The maximum number of items to return in one batch, between 10 and 100, inclusive.

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
list(
  entities = list(
    list(
      entityArn = "string",
      eventArn = "string",
      entityValue = "string",
      entityUrl = "string",
      awsAccountId = "string",
      lastUpdatedTime = as.POSIXct(
        "2015-01-01"
      ),
      statusCode = "IMPAIRED"|"UNIMPAIRED"|"UNKNOWN",
      tags = list(
        "string"
      )
    )
  ),
  failedSet = list(
    list(
      awsAccountId = "string",
      eventArn = "string",
      errorName = "string",
      errorMessage = "string"
    )
  ),
  nextToken = "string"
)

Request syntax

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
svc$describe_affected_entities_for_organization(
  organizationEntityFilters = list(
    list(
      eventArn = "string",
      awsAccountId = "string"
    )
  ),
  locale = "string",
  nextToken = "string",
  maxResults = 123
)

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