Class: Aws::Health::Types::DescribeAffectedEntitiesRequest

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::EntityFilter

Values to narrow the results returned. At least one event ARN is required.

Returns:



323
324
325
326
327
328
329
330
 
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 323

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


323
324
325
326
327
328
329
330
 
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 323

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


323
324
325
326
327
328
329
330
 
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 323

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


323
324
325
326
327
328
329
330
 
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 323

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