You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Health::Types::DescribeEventsRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing DescribeEventsRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  filter: {
    event_arns: ["eventArn"],
    event_type_codes: ["eventType"],
    services: ["service"],
    regions: ["region"],
    availability_zones: ["availabilityZone"],
    start_times: [
      {
        from: Time.now,
        to: Time.now,
      },
    ],
    end_times: [
      {
        from: Time.now,
        to: Time.now,
      },
    ],
    last_updated_times: [
      {
        from: Time.now,
        to: Time.now,
      },
    ],
    entity_arns: ["entityArn"],
    entity_values: ["entityValue"],
    event_type_categories: ["issue"], # accepts issue, accountNotification, scheduledChange, investigation
    tags: [
      {
        "tagKey" => "tagValue",
      },
    ],
    event_status_codes: ["open"], # accepts open, closed, upcoming
  },
  next_token: "nextToken",
  max_results: 1,
  locale: "locale",
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#filter ⇒ Types::EventFilter

Values to narrow the results returned.

Returns:

#locale ⇒ String

The locale (language) to return information in. English (en) is the default and the only supported value at this time.

Returns:

  • (String) —

    The locale (language) to return information in.

#max_results ⇒ Integer

The maximum number of items to return in one batch, between 10 and 100, inclusive.

Returns:

  • (Integer) —

    The maximum number of items to return in one batch, between 10 and 100, inclusive.

#next_token ⇒ String

If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.

Returns:

  • (String) —

    If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response.