Describe Events

opsworkscm_describe_events

R Documentation

Describes events for a specified server

Description

Describes events for a specified server. Results are ordered by time, with newest events first.

This operation is synchronous.

A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid.

Usage

opsworkscm_describe_events(ServerName, NextToken, MaxResults)

Arguments

ServerName

[required] The name of the server for which you want to view events.

NextToken

NextToken is a string that is returned in some command responses. It indicates that not all entries have been returned, and that you must run at least one more request to get remaining items. To get remaining results, call describe_events again, and assign the token from the previous results as the value of the nextToken parameter. If there are no more results, the response object's nextToken parameter value is null. Setting a nextToken value that was not returned in your previous results causes an InvalidNextTokenException to occur.

MaxResults

To receive a paginated response, use this parameter to specify the maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

Value

A list with the following syntax:

list(
  ServerEvents = list(
    list(
      CreatedAt = as.POSIXct(
        "2015-01-01"
      ),
      ServerName = "string",
      Message = "string",
      LogUrl = "string"
    )
  ),
  NextToken = "string"
)

Request syntax

svc$describe_events(
  ServerName = "string",
  NextToken = "string",
  MaxResults = 123
)