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

Class: Aws::Health::Types::DescribeEventTypesRequest

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 DescribeEventTypesRequest data as a hash:

{
  filter: {
    event_type_codes: ["eventTypeCode"],
    services: ["service"],
    event_type_categories: ["issue"], # accepts issue, accountNotification, scheduledChange
  },
  locale: "locale",
  next_token: "nextToken",
  max_results: 1,
}

Instance Attribute Summary collapse

Instance Attribute Details

#filterTypes::EventTypeFilter

Values to narrow the results returned.



379
380
381
382
383
384
385
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 379

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


379
380
381
382
383
384
385
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 379

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

#max_resultsInteger

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

Returns:

  • (Integer)


379
380
381
382
383
384
385
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 379

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


379
380
381
382
383
384
385
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 379

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