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

Class: Aws::Health::Types::EventFilter

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

Overview

Note:

When passing EventFilter as input to an Aws::Client method, you can use a vanilla Hash:

{
  event_arns: ["eventArn"],
  event_type_codes: ["eventType"],
  services: ["service"],
  regions: ["region"],
  availability_zones: ["availabilityZone"],
  start_times: [
    {
      from: Time.now,
      to: Time.now,
    },
  ],
  end_times: [
    {
      from: Time.now,
      to: Time.now,
    },
  ],
  last_updated_times: [
    {
      from: Time.now,
      to: Time.now,
    },
  ],
  entity_arns: ["entityArn"],
  entity_values: ["entityValue"],
  event_type_categories: ["issue"], # accepts issue, accountNotification, scheduledChange, investigation
  tags: [
    {
      "tagKey" => "tagValue",
    },
  ],
  event_status_codes: ["open"], # accepts open, closed, upcoming
}

The values to use to filter results from the DescribeEvents and DescribeEventAggregates operations.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#availability_zonesArray<String>

A list of AWS availability zones.

Returns:

  • (Array<String>)

    A list of AWS availability zones.

#end_timesArray<Types::DateTimeRange>

A list of dates and times that the event ended.

Returns:

#entity_arnsArray<String>

A list of entity ARNs (unique identifiers).

Returns:

  • (Array<String>)

    A list of entity ARNs (unique identifiers).

#entity_valuesArray<String>

A list of entity identifiers, such as EC2 instance IDs (i-34ab692e) or EBS volumes (vol-426ab23e).

Returns:

  • (Array<String>)

    A list of entity identifiers, such as EC2 instance IDs (i-34ab692e) or EBS volumes (vol-426ab23e).

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

    A list of event ARNs (unique identifiers).

#event_status_codesArray<String>

A list of event status codes.

Returns:

  • (Array<String>)

    A list of event status codes.

#event_type_categoriesArray<String>

A list of event type category codes (issue, scheduledChange, or accountNotification).

Returns:

  • (Array<String>)

    A list of event type category codes (issue, scheduledChange, or accountNotification).

#event_type_codesArray<String>

A list of unique identifiers for event types. For example, "AWS_EC2_SYSTEM_MAINTENANCE_EVENT","AWS_RDS_MAINTENANCE_SCHEDULED".

Returns:

  • (Array<String>)

    A list of unique identifiers for event types.

#last_updated_timesArray<Types::DateTimeRange>

A list of dates and times that the event was last updated.

Returns:

#regionsArray<String>

A list of AWS regions.

Returns:

  • (Array<String>)

    A list of AWS regions.

#servicesArray<String>

The AWS services associated with the event. For example, EC2, RDS.

Returns:

  • (Array<String>)

    The AWS services associated with the event.

#start_timesArray<Types::DateTimeRange>

A list of dates and times that the event began.

Returns:

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

    A map of entity tags attached to the affected entity.