AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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 EnableHealthServiceAccessForOrganization 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.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginDescribeAffectedEntitiesForOrganization and EndDescribeAffectedEntitiesForOrganization.

Namespace: Amazon.AWSHealth
Assembly: AWSSDK.AWSHealth.dll
Version: 3.x.y.z

Syntax

C#
public abstract Task<DescribeAffectedEntitiesForOrganizationResponse> DescribeAffectedEntitiesForOrganizationAsync(
         DescribeAffectedEntitiesForOrganizationRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.AWSHealth.Model.DescribeAffectedEntitiesForOrganizationRequest

Container for the necessary parameters to execute the DescribeAffectedEntitiesForOrganization service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the DescribeAffectedEntitiesForOrganization service method, as returned by AWSHealth.

Exceptions

ExceptionCondition
InvalidPaginationTokenException The specified pagination token (nextToken) is not valid.
UnsupportedLocaleException The specified locale is not supported.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also