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

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

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 DescribeEventsRequest 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
  },
  next_token: "nextToken",
  max_results: 1,
  locale: "locale",
}

Instance Attribute Summary collapse

Instance Attribute Details

#filterTypes::EventFilter

Values to narrow the results returned.

Returns:



479
480
481
482
483
484
485
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 479

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

#localeString

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

Returns:

  • (String)


479
480
481
482
483
484
485
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 479

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

#max_resultsInteger

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

Returns:

  • (Integer)


479
480
481
482
483
484
485
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 479

class DescribeEventsRequest < Struct.new(
  :filter,
  :next_token,
  :max_results,
  :locale)
  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)


479
480
481
482
483
484
485
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 479

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