LookupEvents#

Description#

Describes the list of events according to specified parameters.

Request Parameters#

  • EndTime — End date of event retrieving.

    • Type: Integer

    • Required: No

    • Constraints: If both parameters StartTime and EndTime are set, then first shouldn’t be more than second

  • LookupAttributes — List of search attributes.

    • Type: List of LookupAttribute objects

    • Required: No

    • Length constraints: At this moment the list can only contain one element

  • MaxResults — Requested number of elements.

    • Type: Integer

    • Required: No

    • Valid range: from 1 to 1000

    • Default value: 50

  • NextToken — The token used to get the next page with the last request results. It should be sent with same parameters with which it was received.

    • Type: String

    • Required: No

  • StartTime — Starting date of event selection.

    • Type: Integer

    • Required: No

    • Constraints: If both parameters StartTime and EndTime are set, then first shouldn’t be more than second

Response Elements#

  • Events — List of events.

    • Type: List of Event objects

  • NextToken — The token used to get the next page with the last request results. It should be sent with same parameters with which it was received.

    • Type: String

Examples#

c2-ct LookupEvents
c2-ct LookupEvents StartTime <start-time> EndTime <end-time>
c2-ct LookupEvents StartTime <start-time> MaxResults <max-results>
c2-ct LookupEvents StartTime <start-time> LookupAttributes.1.AttributeKey <key> LookupAttributes.1.AttributeValue <value>

NextToken usage example

$ c2-ct LookupEvents StartTime <start-time> EndTime <end-time>

{
    [
        <returned-events>
    ],
    "NextToken": <next-token-1>
}

$ c2-ct LookupEvents StartTime <start-time> EndTime <end-time> NextToken <next-token-1>

Attention

In this example, if you use any other value except <next-token-1> for NextToken, it will raise an error.