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

Class: Aws::Health::Types::DescribeEventAggregatesRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-health/lib/aws-sdk-health/types.rb

Overview

Note:

When making an API call, you may pass DescribeEventAggregatesRequest data as a 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
    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

Instance Attribute Details

#aggregate_fieldString

The only currently supported value is eventTypeCategory.

Returns:

  • (String)


269
270
271
272
273
274
275
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 269

class DescribeEventAggregatesRequest < Struct.new(
  :filter,
  :aggregate_field,
  :max_results,
  :next_token)
  include Aws::Structure
end

#filterTypes::EventFilter

Values to narrow the results returned.

Returns:



269
270
271
272
273
274
275
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 269

class DescribeEventAggregatesRequest < Struct.new(
  :filter,
  :aggregate_field,
  :max_results,
  :next_token)
  include Aws::Structure
end

#max_resultsInteger

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

Returns:

  • (Integer)


269
270
271
272
273
274
275
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 269

class DescribeEventAggregatesRequest < Struct.new(
  :filter,
  :aggregate_field,
  :max_results,
  :next_token)
  include Aws::Structure
end

#next_tokenString

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)


269
270
271
272
273
274
275
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 269

class DescribeEventAggregatesRequest < Struct.new(
  :filter,
  :aggregate_field,
  :max_results,
  :next_token)
  include Aws::Structure
end