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

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

{
  filter: { # required
    event_arns: ["eventArn"], # required
    entity_arns: ["entityArn"],
    entity_values: ["entityValue"],
    last_updated_times: [
      {
        from: Time.now,
        to: Time.now,
      },
    ],
    tags: [
      {
        "tagKey" => "tagValue",
      },
    ],
    status_codes: ["IMPAIRED"], # accepts IMPAIRED, UNIMPAIRED, UNKNOWN
  },
  locale: "locale",
  next_token: "nextToken",
  max_results: 1,
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#filterTypes::EntityFilter

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

Returns:



347
348
349
350
351
352
353
354
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 347

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


347
348
349
350
351
352
353
354
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 347

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

#max_resultsInteger

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

Returns:

  • (Integer)


347
348
349
350
351
352
353
354
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 347

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


347
348
349
350
351
352
353
354
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 347

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