You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::Health::Types::DescribeEventAggregatesRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::Health::Types::DescribeEventAggregatesRequest
- Defined in:
- (unknown)
Overview
When passing DescribeEventAggregatesRequest 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
},
aggregate_field: "eventTypeCategory", # required, accepts eventTypeCategory
max_results: 1,
next_token: "nextToken",
}
Instance Attribute Summary collapse
-
#aggregate_field ⇒ String
The only currently supported value is
eventTypeCategory
. -
#filter ⇒ Types::EventFilter
Values to narrow the results returned.
-
#max_results ⇒ 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.
Instance Attribute Details
#aggregate_field ⇒ String
The only currently supported value is eventTypeCategory
.
Possible values:
- eventTypeCategory
#filter ⇒ Types::EventFilter
Values to narrow the results returned.
#max_results ⇒ 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.