Skip to content

Describe Events

elasticbeanstalk_describe_events R Documentation

Returns list of event descriptions matching criteria up to the last 6 weeks

Description

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.

Usage

elasticbeanstalk_describe_events(ApplicationName, VersionLabel,
  TemplateName, EnvironmentId, EnvironmentName, PlatformArn, RequestId,
  Severity, StartTime, EndTime, MaxRecords, NextToken)

Arguments

ApplicationName

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

VersionLabel

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

TemplateName

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

EnvironmentId

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

EnvironmentName

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

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.

RequestId

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

Severity

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

StartTime

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

EndTime

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

MaxRecords

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

NextToken

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

Value

A list with the following syntax: 

list(
  Events = list(
    list(
      EventDate = as.POSIXct(
        "2015-01-01"
      ),
      Message = "string",
      ApplicationName = "string",
      VersionLabel = "string",
      TemplateName = "string",
      EnvironmentName = "string",
      PlatformArn = "string",
      RequestId = "string",
      Severity = "TRACE"|"DEBUG"|"INFO"|"WARN"|"ERROR"|"FATAL"
    )
  ),
  NextToken = "string"
)

Request syntax

svc$describe_events(
  ApplicationName = "string",
  VersionLabel = "string",
  TemplateName = "string",
  EnvironmentId = "string",
  EnvironmentName = "string",
  PlatformArn = "string",
  RequestId = "string",
  Severity = "TRACE"|"DEBUG"|"INFO"|"WARN"|"ERROR"|"FATAL",
  StartTime = as.POSIXct(
    "2015-01-01"
  ),
  EndTime = as.POSIXct(
    "2015-01-01"
  ),
  MaxRecords = 123,
  NextToken = "string"
)

Examples

## Not run: 
# The following operation retrieves events for an environment named
# my-env:
svc$describe_events(
  EnvironmentName = "my-env"
)

## End(Not run)