AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: Aws::Health::Types::EntityFilter

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

{
  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
}

The values to use to filter results from the EntityFilter operation.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#entity_arnsArray<String>

A list of entity ARNs (unique identifiers).

Returns:

  • (Array<String>)


963
964
965
966
967
968
969
970
971
972
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 963

class EntityFilter < Struct.new(
  :event_arns,
  :entity_arns,
  :entity_values,
  :last_updated_times,
  :tags,
  :status_codes)
  SENSITIVE = []
  include Aws::Structure
end

#entity_valuesArray<String>

A list of IDs for affected entities.

Returns:

  • (Array<String>)


963
964
965
966
967
968
969
970
971
972
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 963

class EntityFilter < Struct.new(
  :event_arns,
  :entity_arns,
  :entity_values,
  :last_updated_times,
  :tags,
  :status_codes)
  SENSITIVE = []
  include Aws::Structure
end

#event_arnsArray<String>

A list of event ARNs (unique identifiers). For example: "arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-CDE456", "arn:aws:health:us-west-1::event/EBS/AWS_EBS_LOST_VOLUME/AWS_EBS_LOST_VOLUME_CHI789_JKL101"

Returns:

  • (Array<String>)


963
964
965
966
967
968
969
970
971
972
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 963

class EntityFilter < Struct.new(
  :event_arns,
  :entity_arns,
  :entity_values,
  :last_updated_times,
  :tags,
  :status_codes)
  SENSITIVE = []
  include Aws::Structure
end

#last_updated_timesArray<Types::DateTimeRange>

A list of the most recent dates and times that the entity was updated.

Returns:



963
964
965
966
967
968
969
970
971
972
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 963

class EntityFilter < Struct.new(
  :event_arns,
  :entity_arns,
  :entity_values,
  :last_updated_times,
  :tags,
  :status_codes)
  SENSITIVE = []
  include Aws::Structure
end

#status_codesArray<String>

A list of entity status codes (IMPAIRED, UNIMPAIRED, or UNKNOWN).

Returns:

  • (Array<String>)


963
964
965
966
967
968
969
970
971
972
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 963

class EntityFilter < Struct.new(
  :event_arns,
  :entity_arns,
  :entity_values,
  :last_updated_times,
  :tags,
  :status_codes)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Hash<String,String>>

A map of entity tags attached to the affected entity.

Currently, the tags property isn't supported.

Returns:

  • (Array<Hash<String,String>>)


963
964
965
966
967
968
969
970
971
972
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 963

class EntityFilter < Struct.new(
  :event_arns,
  :entity_arns,
  :entity_values,
  :last_updated_times,
  :tags,
  :status_codes)
  SENSITIVE = []
  include Aws::Structure
end