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

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

Overview

Error information returned when a

DescribeEventDetailsForOrganization][1

operation can’t find a

specified event.

[1]: docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetailsForOrganization.html

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#aws_account_id ⇒ String

Error information returned when a

DescribeEventDetailsForOrganization][1

operation can’t find a

specified event.

[1]: docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetailsForOrganization.html

Returns:

  • (String) 


1584
1585
1586
1587
1588
1589
1590
1591
 
# File 'lib/aws-sdk-health/types.rb', line 1584

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

#error_message ⇒ String

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) 


1584
1585
1586
1587
1588
1589
1590
1591
 
# File 'lib/aws-sdk-health/types.rb', line 1584

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

#error_name ⇒ String

The name of the error.

Returns:

  • (String) 


1584
1585
1586
1587
1588
1589
1590
1591
 
# File 'lib/aws-sdk-health/types.rb', line 1584

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

#event_arn ⇒ String

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) 


1584
1585
1586
1587
1588
1589
1590
1591
 
# File 'lib/aws-sdk-health/types.rb', line 1584

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