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

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

{
  event_type_codes: ["eventType"],
  aws_account_ids: ["accountId"],
  services: ["service"],
  regions: ["region"],
  start_time: {
    from: Time.now,
    to: Time.now,
  },
  end_time: {
    from: Time.now,
    to: Time.now,
  },
  last_updated_time: {
    from: Time.now,
    to: Time.now,
  },
  entity_arns: ["entityArn"],
  entity_values: ["entityValue"],
  event_type_categories: ["issue"], # accepts issue, accountNotification, scheduledChange, investigation
  event_status_codes: ["open"], # accepts open, closed, upcoming
}

The values to filter results from the DescribeEventsForOrganization operation.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#aws_account_idsArray<String>

A list of 12-digit AWS account numbers that contains the affected entities.

Returns:

  • (Array<String>)


1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 1836

class OrganizationEventFilter < Struct.new(
  :event_type_codes,
  :aws_account_ids,
  :services,
  :regions,
  :start_time,
  :end_time,
  :last_updated_time,
  :entity_arns,
  :entity_values,
  :event_type_categories,
  :event_status_codes)
  SENSITIVE = []
  include Aws::Structure
end

#end_timeTypes::DateTimeRange

A range of dates and times that is used by the EventFilter and EntityFilter objects. If from is set and to is set: match items where the timestamp (startTime, endTime, or lastUpdatedTime) is between from and to inclusive. If from is set and to is not set: match items where the timestamp value is equal to or after from. If from is not set and to is set: match items where the timestamp value is equal to or before to.



1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 1836

class OrganizationEventFilter < Struct.new(
  :event_type_codes,
  :aws_account_ids,
  :services,
  :regions,
  :start_time,
  :end_time,
  :last_updated_time,
  :entity_arns,
  :entity_values,
  :event_type_categories,
  :event_status_codes)
  SENSITIVE = []
  include Aws::Structure
end

#entity_arnsArray<String>

A list of entity ARNs (unique identifiers).

Returns:

  • (Array<String>)


1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 1836

class OrganizationEventFilter < Struct.new(
  :event_type_codes,
  :aws_account_ids,
  :services,
  :regions,
  :start_time,
  :end_time,
  :last_updated_time,
  :entity_arns,
  :entity_values,
  :event_type_categories,
  :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>)


1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 1836

class OrganizationEventFilter < Struct.new(
  :event_type_codes,
  :aws_account_ids,
  :services,
  :regions,
  :start_time,
  :end_time,
  :last_updated_time,
  :entity_arns,
  :entity_values,
  :event_type_categories,
  :event_status_codes)
  SENSITIVE = []
  include Aws::Structure
end

#event_status_codesArray<String>

A list of event status codes.

Returns:

  • (Array<String>)


1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 1836

class OrganizationEventFilter < Struct.new(
  :event_type_codes,
  :aws_account_ids,
  :services,
  :regions,
  :start_time,
  :end_time,
  :last_updated_time,
  :entity_arns,
  :entity_values,
  :event_type_categories,
  :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>)


1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 1836

class OrganizationEventFilter < Struct.new(
  :event_type_codes,
  :aws_account_ids,
  :services,
  :regions,
  :start_time,
  :end_time,
  :last_updated_time,
  :entity_arns,
  :entity_values,
  :event_type_categories,
  :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>)


1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 1836

class OrganizationEventFilter < Struct.new(
  :event_type_codes,
  :aws_account_ids,
  :services,
  :regions,
  :start_time,
  :end_time,
  :last_updated_time,
  :entity_arns,
  :entity_values,
  :event_type_categories,
  :event_status_codes)
  SENSITIVE = []
  include Aws::Structure
end

#last_updated_timeTypes::DateTimeRange

A range of dates and times that is used by the EventFilter and EntityFilter objects. If from is set and to is set: match items where the timestamp (startTime, endTime, or lastUpdatedTime) is between from and to inclusive. If from is set and to is not set: match items where the timestamp value is equal to or after from. If from is not set and to is set: match items where the timestamp value is equal to or before to.



1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 1836

class OrganizationEventFilter < Struct.new(
  :event_type_codes,
  :aws_account_ids,
  :services,
  :regions,
  :start_time,
  :end_time,
  :last_updated_time,
  :entity_arns,
  :entity_values,
  :event_type_categories,
  :event_status_codes)
  SENSITIVE = []
  include Aws::Structure
end

#regionsArray<String>

A list of AWS Regions.

Returns:

  • (Array<String>)


1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 1836

class OrganizationEventFilter < Struct.new(
  :event_type_codes,
  :aws_account_ids,
  :services,
  :regions,
  :start_time,
  :end_time,
  :last_updated_time,
  :entity_arns,
  :entity_values,
  :event_type_categories,
  :event_status_codes)
  SENSITIVE = []
  include Aws::Structure
end

#servicesArray<String>

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

Returns:

  • (Array<String>)


1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 1836

class OrganizationEventFilter < Struct.new(
  :event_type_codes,
  :aws_account_ids,
  :services,
  :regions,
  :start_time,
  :end_time,
  :last_updated_time,
  :entity_arns,
  :entity_values,
  :event_type_categories,
  :event_status_codes)
  SENSITIVE = []
  include Aws::Structure
end

#start_timeTypes::DateTimeRange

A range of dates and times that is used by the EventFilter and EntityFilter objects. If from is set and to is set: match items where the timestamp (startTime, endTime, or lastUpdatedTime) is between from and to inclusive. If from is set and to is not set: match items where the timestamp value is equal to or after from. If from is not set and to is set: match items where the timestamp value is equal to or before to.



1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 1836

class OrganizationEventFilter < Struct.new(
  :event_type_codes,
  :aws_account_ids,
  :services,
  :regions,
  :start_time,
  :end_time,
  :last_updated_time,
  :entity_arns,
  :entity_values,
  :event_type_categories,
  :event_status_codes)
  SENSITIVE = []
  include Aws::Structure
end