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 DescribeEvents operation. Returns information about events that meet the specified filter criteria. Events are returned in a summary form and do not include the detailed description, any additional metadata that depends on the event type, or any affected resources. To retrieve that information, use the DescribeEventDetails and DescribeAffectedEntities operations.

If no filter criteria are specified, all events are returned. Results are sorted by lastModifiedTime, starting with the most recent event.

  • When you call the DescribeEvents operation and specify an entity for the entityValues parameter, Health might return public events that aren't specific to that resource. For example, if you call DescribeEvents and specify an ID for an Amazon Elastic Compute Cloud (Amazon EC2) instance, Health might return events that aren't specific to that resource or service. To get events that are specific to a service, use the services parameter in the filter object. For more information, see Event.

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

Inheritance Hierarchy

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

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

Syntax

C# 
public class DescribeEventsRequest : AmazonAWSHealthRequest
         IAmazonWebServiceRequest

The DescribeEventsRequest type exposes the following members

Constructors

NameDescription
Public Method DescribeEventsRequest()

Properties

NameTypeDescription
Public Property Filter Amazon.AWSHealth.Model.EventFilter

Gets and sets the property Filter.

Values to narrow the results returned.

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.

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