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

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 EventFilter data as a 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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#availability_zonesArray<String>

A list of AWS Availability Zones.

Returns:

  • (Array<String>)


1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 1344

class EventFilter < Struct.new(
  :event_arns,
  :event_type_codes,
  :services,
  :regions,
  :availability_zones,
  :start_times,
  :end_times,
  :last_updated_times,
  :entity_arns,
  :entity_values,
  :event_type_categories,
  :tags,
  :event_status_codes)
  SENSITIVE = []
  include Aws::Structure
end

#end_timesArray<Types::DateTimeRange>

A list of dates and times that the event ended.

Returns:



1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 1344

class EventFilter < Struct.new(
  :event_arns,
  :event_type_codes,
  :services,
  :regions,
  :availability_zones,
  :start_times,
  :end_times,
  :last_updated_times,
  :entity_arns,
  :entity_values,
  :event_type_categories,
  :tags,
  :event_status_codes)
  SENSITIVE = []
  include Aws::Structure
end

#entity_arnsArray<String>

A list of entity ARNs (unique identifiers).

Returns:

  • (Array<String>)


1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 1344

class EventFilter < Struct.new(
  :event_arns,
  :event_type_codes,
  :services,
  :regions,
  :availability_zones,
  :start_times,
  :end_times,
  :last_updated_times,
  :entity_arns,
  :entity_values,
  :event_type_categories,
  :tags,
  :event_status_codes)
  SENSITIVE = []
  include Aws::Structure
end

#entity_valuesArray<String>

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

Returns:

  • (Array<String>)


1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 1344

class EventFilter < Struct.new(
  :event_arns,
  :event_type_codes,
  :services,
  :regions,
  :availability_zones,
  :start_times,
  :end_times,
  :last_updated_times,
  :entity_arns,
  :entity_values,
  :event_type_categories,
  :tags,
  :event_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>)


1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 1344

class EventFilter < Struct.new(
  :event_arns,
  :event_type_codes,
  :services,
  :regions,
  :availability_zones,
  :start_times,
  :end_times,
  :last_updated_times,
  :entity_arns,
  :entity_values,
  :event_type_categories,
  :tags,
  :event_status_codes)
  SENSITIVE = []
  include Aws::Structure
end

#event_status_codesArray<String>

A list of event status codes.

Returns:

  • (Array<String>)


1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 1344

class EventFilter < Struct.new(
  :event_arns,
  :event_type_codes,
  :services,
  :regions,
  :availability_zones,
  :start_times,
  :end_times,
  :last_updated_times,
  :entity_arns,
  :entity_values,
  :event_type_categories,
  :tags,
  :event_status_codes)
  SENSITIVE = []
  include Aws::Structure
end

#event_type_categoriesArray<String>

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

Returns:

  • (Array<String>)


1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 1344

class EventFilter < Struct.new(
  :event_arns,
  :event_type_codes,
  :services,
  :regions,
  :availability_zones,
  :start_times,
  :end_times,
  :last_updated_times,
  :entity_arns,
  :entity_values,
  :event_type_categories,
  :tags,
  :event_status_codes)
  SENSITIVE = []
  include Aws::Structure
end

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


1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 1344

class EventFilter < Struct.new(
  :event_arns,
  :event_type_codes,
  :services,
  :regions,
  :availability_zones,
  :start_times,
  :end_times,
  :last_updated_times,
  :entity_arns,
  :entity_values,
  :event_type_categories,
  :tags,
  :event_status_codes)
  SENSITIVE = []
  include Aws::Structure
end

#last_updated_timesArray<Types::DateTimeRange>

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

Returns:



1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 1344

class EventFilter < Struct.new(
  :event_arns,
  :event_type_codes,
  :services,
  :regions,
  :availability_zones,
  :start_times,
  :end_times,
  :last_updated_times,
  :entity_arns,
  :entity_values,
  :event_type_categories,
  :tags,
  :event_status_codes)
  SENSITIVE = []
  include Aws::Structure
end

#regionsArray<String>

A list of AWS Regions.

Returns:

  • (Array<String>)


1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 1344

class EventFilter < Struct.new(
  :event_arns,
  :event_type_codes,
  :services,
  :regions,
  :availability_zones,
  :start_times,
  :end_times,
  :last_updated_times,
  :entity_arns,
  :entity_values,
  :event_type_categories,
  :tags,
  :event_status_codes)
  SENSITIVE = []
  include Aws::Structure
end

#servicesArray<String>

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

Returns:

  • (Array<String>)


1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 1344

class EventFilter < Struct.new(
  :event_arns,
  :event_type_codes,
  :services,
  :regions,
  :availability_zones,
  :start_times,
  :end_times,
  :last_updated_times,
  :entity_arns,
  :entity_values,
  :event_type_categories,
  :tags,
  :event_status_codes)
  SENSITIVE = []
  include Aws::Structure
end

#start_timesArray<Types::DateTimeRange>

A list of dates and times that the event began.

Returns:



1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 1344

class EventFilter < Struct.new(
  :event_arns,
  :event_type_codes,
  :services,
  :regions,
  :availability_zones,
  :start_times,
  :end_times,
  :last_updated_times,
  :entity_arns,
  :entity_values,
  :event_type_categories,
  :tags,
  :event_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>>)


1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 1344

class EventFilter < Struct.new(
  :event_arns,
  :event_type_codes,
  :services,
  :regions,
  :availability_zones,
  :start_times,
  :end_times,
  :last_updated_times,
  :entity_arns,
  :entity_values,
  :event_type_categories,
  :tags,
  :event_status_codes)
  SENSITIVE = []
  include Aws::Structure
end