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

Class: Aws::Health::Types::OrganizationEventFilter

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

Overview

Note:

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

Returned by:

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

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

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

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_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_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.

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_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.

Returns: