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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing EntityFilter as input to an Aws::Client method, you can use a vanilla 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.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#entity_arns ⇒ Array<String>

A list of entity ARNs (unique identifiers).

Returns:

  • (Array<String>) —

    A list of entity ARNs (unique identifiers).

#entity_values ⇒ Array<String>

A list of IDs for affected entities.

Returns:

  • (Array<String>) —

    A list of IDs for affected entities.

#event_arns ⇒ Array<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>) —

    A list of event ARNs (unique identifiers).

#last_updated_times ⇒ Array<Types::DateTimeRange>

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

Returns:

  • (Array<Types::DateTimeRange>) —

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

#status_codes ⇒ Array<String>

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

Returns:

  • (Array<String>) —

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

#tags ⇒ Array<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>>) —

    A map of entity tags attached to the affected entity.