Class: Aws::Health::Types::OrganizationEventDetailsErrorItem

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-health/lib/aws-sdk-health/types.rb

Overview

Error information returned when a DescribeEventDetailsForOrganization operation can't find a specified event.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#aws_account_idString

Error information returned when a DescribeEventDetailsForOrganization operation can't find a specified event.

Returns:

  • (String)


1725
1726
1727
1728
1729
1730
1731
1732
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 1725

class OrganizationEventDetailsErrorItem < Struct.new(
  :aws_account_id,
  :event_arn,
  :error_name,
  :error_message)
  SENSITIVE = []
  include Aws::Structure
end

#error_messageString

A message that describes the error.

If you call the DescribeEventDetailsForOrganization operation and receive one of the following errors, follow the recommendations in the message:

  • We couldn't find a public event that matches your request. To find an event that is account specific, you must enter an Amazon Web Services account ID in the request.

  • We couldn't find an account specific event for the specified Amazon Web Services account. To find an event that is public, you must enter a null value for the Amazon Web Services account ID in the request.

  • Your Amazon Web Services account doesn't include the Amazon Web Services Support plan required to use the Health API. You must have either a Business, Enterprise On-Ramp, or Enterprise Support plan.

Returns:

  • (String)


1725
1726
1727
1728
1729
1730
1731
1732
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 1725

class OrganizationEventDetailsErrorItem < Struct.new(
  :aws_account_id,
  :event_arn,
  :error_name,
  :error_message)
  SENSITIVE = []
  include Aws::Structure
end

#error_nameString

The name of the error.

Returns:

  • (String)


1725
1726
1727
1728
1729
1730
1731
1732
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 1725

class OrganizationEventDetailsErrorItem < Struct.new(
  :aws_account_id,
  :event_arn,
  :error_name,
  :error_message)
  SENSITIVE = []
  include Aws::Structure
end

#event_arnString

The unique identifier for the event. The event ARN has the arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID format.

For example, an event ARN might look like the following:

arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456

Returns:

  • (String)


1725
1726
1727
1728
1729
1730
1731
1732
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 1725

class OrganizationEventDetailsErrorItem < Struct.new(
  :aws_account_id,
  :event_arn,
  :error_name,
  :error_message)
  SENSITIVE = []
  include Aws::Structure
end