DescribeAffectedEntitiesRequest Class

Container for the parameters to the DescribeAffectedEntities operation. Returns a list of entities that have been affected by the specified events, based on the specified filter criteria. Entities can refer to individual customer resources, groups of customer resources, or any other construct, depending on the Amazon Web Service. Events that have impact beyond that of the affected entities, or where the extent of impact is unknown, include at least one entity indicating this.

At least one event ARN is required.

This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.
This operation supports resource-level permissions. You can 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.DescribeAffectedEntitiesRequest

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

Syntax

public class DescribeAffectedEntitiesRequest : AmazonAWSHealthRequest
         IAmazonWebServiceRequest

The DescribeAffectedEntitiesRequest type exposes the following members

Constructors

	Name	Description
	DescribeAffectedEntitiesRequest()

Properties

Name	Type	Description
Filter	Amazon.AWSHealth.Model.EntityFilter	Gets and sets the property Filter. Values to narrow the results returned. At least one event ARN is required.
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.
MaxResults	System.Int32	Gets and sets the property MaxResults. The maximum number of items to return in one batch, between 10 and 100, inclusive.
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.

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