Skip to content

Describe Affected Entities For Organization

health_describe_affected_entities_for_organization R Documentation

Returns a list of entities that have been affected by one or more events for one or more accounts in your organization in Organizations, based on the filter criteria

Description

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

At least one event Amazon Resource Name (ARN) and account ID are required.

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

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

  • This operation doesn't support resource-level permissions. You can't use this operation to allow or deny access to specific Health events. For more information, see Resource- and action-based conditions in the Health User Guide.

Usage

health_describe_affected_entities_for_organization(
  organizationEntityFilters, locale, nextToken, maxResults,
  organizationEntityAccountFilters)

Arguments

organizationEntityFilters

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.

organizationEntityAccountFilters

A JSON set of elements including the awsAccountId, eventArn and a set of statusCodes.

Value

A list with the following syntax: 

list(
  entities = list(
    list(
      entityArn = "string",
      eventArn = "string",
      entityValue = "string",
      entityUrl = "string",
      awsAccountId = "string",
      lastUpdatedTime = as.POSIXct(
        "2015-01-01"
      ),
      statusCode = "IMPAIRED"|"UNIMPAIRED"|"UNKNOWN"|"PENDING"|"RESOLVED",
      tags = list(
        "string"
      )
    )
  ),
  failedSet = list(
    list(
      awsAccountId = "string",
      eventArn = "string",
      errorName = "string",
      errorMessage = "string"
    )
  ),
  nextToken = "string"
)

Request syntax

svc$describe_affected_entities_for_organization(
  organizationEntityFilters = list(
    list(
      eventArn = "string",
      awsAccountId = "string"
    )
  ),
  locale = "string",
  nextToken = "string",
  maxResults = 123,
  organizationEntityAccountFilters = list(
    list(
      eventArn = "string",
      awsAccountId = "string",
      statusCodes = list(
        "IMPAIRED"|"UNIMPAIRED"|"UNKNOWN"|"PENDING"|"RESOLVED"
      )
    )
  )
)