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 list of event descriptions matching criteria up to the last 6 weeks.

This action returns the most recent 1,000 events from the specified NextToken.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.ElasticBeanstalk.AmazonElasticBeanstalkRequest
      Amazon.ElasticBeanstalk.Model.DescribeEventsRequest

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

Syntax

C#
public class DescribeEventsRequest : AmazonElasticBeanstalkRequest
         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 ApplicationName System.String

Gets and sets the property ApplicationName.

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those associated with this application.

Public Property 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.

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur up to, but not including, the EndTime.

Public Property EndTimeUtc System.DateTime

Gets and sets the property EndTimeUtc.

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur up to, but not including, the EndTime.

Public Property EnvironmentId System.String

Gets and sets the property EnvironmentId.

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment.

Public Property EnvironmentName System.String

Gets and sets the property EnvironmentName.

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment.

Public Property MaxRecords System.Int32

Gets and sets the property MaxRecords.

Specifies the maximum number of events that can be returned, beginning with the most recent event.

Public Property NextToken System.String

Gets and sets the property NextToken.

Pagination token. If specified, the events return the next batch of results.

Public Property PlatformArn System.String

Gets and sets the property PlatformArn.

The ARN of a custom platform version. If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this custom platform version.

Public Property RequestId System.String

Gets and sets the property RequestId.

If specified, AWS Elastic Beanstalk restricts the described events to include only those associated with this request ID.

Public Property Severity Amazon.ElasticBeanstalk.EventSeverity

Gets and sets the property Severity.

If specified, limits the events returned from this call to include only those with the specified severity or higher.

Public Property 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.

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur on or after this time.

Public Property StartTimeUtc System.DateTime

Gets and sets the property StartTimeUtc.

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur on or after this time.

Public Property TemplateName System.String

Gets and sets the property TemplateName.

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that are associated with this environment configuration.

Public Property VersionLabel System.String

Gets and sets the property VersionLabel.

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this application version.

Examples

The following operation retrieves events for an environment named my-env:

To view events for an environment


var client = new AmazonElasticBeanstalkClient();
var response = client.DescribeEvents(new DescribeEventsRequest 
{
    EnvironmentName = "my-env"
});

List<EventDescription> events = response.Events;

            

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