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

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#filter ⇒ Types::EventFilter

Values to narrow the results returned.

Returns:



688
689
690
691
692
693
694
695
 
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 688

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

#locale ⇒ String

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

Returns:

  • (String) 


688
689
690
691
692
693
694
695
 
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 688

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

#max_results ⇒ Integer

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

Returns:

  • (Integer) 


688
689
690
691
692
693
694
695
 
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 688

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

#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) 


688
689
690
691
692
693
694
695
 
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 688

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