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 events related to cache clusters, cache security groups, and cache parameter groups. You can obtain events specific to a particular cache cluster, cache security group, or cache parameter group by providing the name as a parameter.

By default, only the events occurring within the last hour are returned; however, you can retrieve up to 14 days' worth of events if necessary.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.ElastiCache.AmazonElastiCacheRequest
      Amazon.ElastiCache.Model.DescribeEventsRequest

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

Syntax

C#
public class DescribeEventsRequest : AmazonElastiCacheRequest
         IAmazonWebServiceRequest

The DescribeEventsRequest type exposes the following members

Constructors

NameDescription
Public Method DescribeEventsRequest()

Empty constructor used to set properties independently even when a simple constructor is available

Properties

NameTypeDescription
Public Property Duration System.Int32

Gets and sets the property Duration.

The number of minutes worth of events to retrieve.

Public Property EndTime System.DateTime

Gets and sets the property EndTime.

The end of the time interval for which to retrieve events, specified in ISO 8601 format.

Example: 2017-03-30T07:03:49.555Z

Public Property Marker System.String

Gets and sets the property Marker.

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Public Property 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 marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

Public Property SourceIdentifier System.String

Gets and sets the property SourceIdentifier.

The identifier of the event source for which events are returned. If not specified, all sources are included in the response.

Public Property SourceType Amazon.ElastiCache.SourceType

Gets and sets the property SourceType.

The event source to retrieve events for. If no value is specified, all events are returned.

Public Property StartTime System.DateTime

Gets and sets the property StartTime.

The beginning of the time interval to retrieve events for, specified in ISO 8601 format.

Example: 2017-03-30T07:03:49.555Z

Examples

Describes all the cache-cluster events for the past 120 minutes.

DescribeEvents


var response = client.DescribeEvents(new DescribeEventsRequest 
{
    Duration = 360,
    SourceType = "cache-cluster"
});

List events = response.Events;
string marker = response.Marker;

            

Describes all the replication-group events from 3:00P to 5:00P on November 11, 2016.

DescribeEvents


var response = client.DescribeEvents(new DescribeEventsRequest 
{
    Duration = 360,
    SourceType = "cache-cluster"
});

List events = response.Events;
string marker = response.Marker;

            

Version Information

.NET Standard:
Supported in: 1.3

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

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms