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.

Container for the parameters to the DescribeAffectedEntitiesForOrganization operation. 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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.AWSHealth.AmazonAWSHealthRequest
      Amazon.AWSHealth.Model.DescribeAffectedEntitiesForOrganizationRequest

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

Syntax

C#
public class DescribeAffectedEntitiesForOrganizationRequest : AmazonAWSHealthRequest
         IAmazonWebServiceRequest

The DescribeAffectedEntitiesForOrganizationRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property Locale System.String

Gets and sets the property Locale.

The locale (language) to return information in. English (en) is the default and the only supported value at this time.

Public Property MaxResults System.Int32

Gets and sets the property MaxResults.

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

Public Property NextToken System.String

Gets and sets the property 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.

Public Property OrganizationEntityAccountFilters System.Collections.Generic.List<Amazon.AWSHealth.Model.EntityAccountFilter>

Gets and sets the property OrganizationEntityAccountFilters.

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

Public Property OrganizationEntityFilters System.Collections.Generic.List<Amazon.AWSHealth.Model.EventAccountFilter>

Gets and sets the property OrganizationEntityFilters.

A JSON set of elements including the awsAccountId and the eventArn.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5