DescribeEventsRequest Class | AWS SDK for .NET V3

Container for the parameters to the DescribeEvents operation. Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days. Events specific to a particular DB instance, DB security group, database snapshot, or DB parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.Neptune.AmazonNeptuneRequest
      Amazon.Neptune.Model.DescribeEventsRequest

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

Syntax

public class DescribeEventsRequest : AmazonNeptuneRequest
         IAmazonWebServiceRequest

The DescribeEventsRequest type exposes the following members

Constructors

	Name	Description
	DescribeEventsRequest()

Properties

Name	Type	Description
Duration	System.Int32	Gets and sets the property Duration. The number of minutes to retrieve events for. Default: 60
EndTime	System.DateTime	Gets and sets the property EndTimeUtc. This property is deprecated. Setting this property results in non-UTC DateTimes not being marshalled correctly. Use EndTimeUtc instead. Setting either EndTime or EndTimeUtc results in both EndTime and EndTimeUtc being assigned, the latest assignment to either one of the two property is reflected in the value of both. EndTime is provided for backwards compatibility only and assigning a non-Utc DateTime to it results in the wrong timestamp being passed to the service. The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page. Example: 2009-07-08T18:00Z
EndTimeUtc	System.DateTime	Gets and sets the property EndTimeUtc. The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page. Example: 2009-07-08T18:00Z
EventCategories	System.Collections.Generic.List<System.String>	Gets and sets the property EventCategories. A list of event categories that trigger notifications for a event notification subscription.
Filters	System.Collections.Generic.List<Amazon.Neptune.Model.Filter>	Gets and sets the property Filters. This parameter is not currently supported.
Marker	System.String	Gets and sets the property Marker. An optional pagination token provided by a previous DescribeEvents request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.
MaxRecords	System.Int32	Gets and sets the property MaxRecords. The maximum number of records to include in the response. If more records exist than the specified `MaxRecords` value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100.
SourceIdentifier	System.String	Gets and sets the property SourceIdentifier. The identifier of the event source for which events are returned. If not specified, then all sources are included in the response. Constraints: If SourceIdentifier is supplied, SourceType must also be provided. If the source type is `DBInstance`, then a `DBInstanceIdentifier` must be supplied. If the source type is `DBSecurityGroup`, a `DBSecurityGroupName` must be supplied. If the source type is `DBParameterGroup`, a `DBParameterGroupName` must be supplied. If the source type is `DBSnapshot`, a `DBSnapshotIdentifier` must be supplied. Cannot end with a hyphen or contain two consecutive hyphens.
SourceType	Amazon.Neptune.SourceType	Gets and sets the property SourceType. The event source to retrieve events for. If no value is specified, all events are returned.
StartTime	System.DateTime	Gets and sets the property StartTimeUtc. This property is deprecated. Setting this property results in non-UTC DateTimes not being marshalled correctly. Use StartTimeUtc instead. Setting either StartTime or StartTimeUtc results in both StartTime and StartTimeUtc being assigned, the latest assignment to either one of the two property is reflected in the value of both. StartTime is provided for backwards compatibility only and assigning a non-Utc DateTime to it results in the wrong timestamp being passed to the service. The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page. Example: 2009-07-08T18:00Z
StartTimeUtc	System.DateTime	Gets and sets the property StartTimeUtc. The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page. Example: 2009-07-08T18:00Z

Examples

This example lists information for all backup-related events for the specified DB instance for the past 7 days (7 days * 24 hours * 60 minutes = 10,080 minutes).

To list information about events


var response = client.DescribeEvents(new DescribeEventsRequest 
{
    Duration = 10080,
    EventCategories = new List<string> {
        "backup"
    },
    SourceIdentifier = "mymysqlinstance",
    SourceType = "db-instance"
});

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5