Amazonka.AWSHealth.Types.OrganizationEventDetailsErrorItem

Documentation

data OrganizationEventDetailsErrorItem

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

See: newOrganizationEventDetailsErrorItem smart constructor.

Constructors

OrganizationEventDetailsErrorItem'

Fields

• awsAccountId :: Maybe Text

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

• errorMessage :: Maybe Text

  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.
• errorName :: Maybe Text

  The name of the error.

• eventArn :: Maybe Text

  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

Instances

FromJSON OrganizationEventDetailsErrorItem

Defined in Amazonka.AWSHealth.Types.OrganizationEventDetailsErrorItem

Methods

parseJSON :: Value -> Parser OrganizationEventDetailsErrorItem

parseJSONList :: Value -> Parser [OrganizationEventDetailsErrorItem]

Generic OrganizationEventDetailsErrorItem

Defined in Amazonka.AWSHealth.Types.OrganizationEventDetailsErrorItem

Associated Types

type Rep OrganizationEventDetailsErrorItem :: Type -> Type

Methods

from :: OrganizationEventDetailsErrorItem -> Rep OrganizationEventDetailsErrorItem x

to :: Rep OrganizationEventDetailsErrorItem x -> OrganizationEventDetailsErrorItem

Read OrganizationEventDetailsErrorItem

Defined in Amazonka.AWSHealth.Types.OrganizationEventDetailsErrorItem

Methods

readsPrec :: Int -> ReadS OrganizationEventDetailsErrorItem

readList :: ReadS [OrganizationEventDetailsErrorItem]

readPrec :: ReadPrec OrganizationEventDetailsErrorItem

readListPrec :: ReadPrec [OrganizationEventDetailsErrorItem]

Show OrganizationEventDetailsErrorItem

Defined in Amazonka.AWSHealth.Types.OrganizationEventDetailsErrorItem

Methods

showsPrec :: Int -> OrganizationEventDetailsErrorItem -> ShowS

show :: OrganizationEventDetailsErrorItem -> String

showList :: [OrganizationEventDetailsErrorItem] -> ShowS

NFData OrganizationEventDetailsErrorItem

Defined in Amazonka.AWSHealth.Types.OrganizationEventDetailsErrorItem

Methods

rnf :: OrganizationEventDetailsErrorItem -> ()

Eq OrganizationEventDetailsErrorItem

Defined in Amazonka.AWSHealth.Types.OrganizationEventDetailsErrorItem

Methods

(==) :: OrganizationEventDetailsErrorItem -> OrganizationEventDetailsErrorItem -> Bool

(/=) :: OrganizationEventDetailsErrorItem -> OrganizationEventDetailsErrorItem -> Bool

Hashable OrganizationEventDetailsErrorItem

Defined in Amazonka.AWSHealth.Types.OrganizationEventDetailsErrorItem

Methods

hashWithSalt :: Int -> OrganizationEventDetailsErrorItem -> Int

hash :: OrganizationEventDetailsErrorItem -> Int

type Rep OrganizationEventDetailsErrorItem

Defined in Amazonka.AWSHealth.Types.OrganizationEventDetailsErrorItem

type Rep OrganizationEventDetailsErrorItem = D1 ('MetaData "OrganizationEventDetailsErrorItem" "Amazonka.AWSHealth.Types.OrganizationEventDetailsErrorItem" "amazonka-health-2.0-97kQZARXu4I8k4sVSmOp5K" 'False) (C1 ('MetaCons "OrganizationEventDetailsErrorItem'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "awsAccountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "errorMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "errorName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "eventArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newOrganizationEventDetailsErrorItem :: OrganizationEventDetailsErrorItem

Create a value of OrganizationEventDetailsErrorItem with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:awsAccountId:OrganizationEventDetailsErrorItem', organizationEventDetailsErrorItem_awsAccountId - Error information returned when a DescribeEventDetailsForOrganization operation can't find a specified event.

$sel:errorMessage:OrganizationEventDetailsErrorItem', organizationEventDetailsErrorItem_errorMessage - 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.

$sel:errorName:OrganizationEventDetailsErrorItem', organizationEventDetailsErrorItem_errorName - The name of the error.

$sel:eventArn:OrganizationEventDetailsErrorItem', organizationEventDetailsErrorItem_eventArn - 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

organizationEventDetailsErrorItem_awsAccountId :: Lens' OrganizationEventDetailsErrorItem (Maybe Text)

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

organizationEventDetailsErrorItem_errorMessage :: Lens' OrganizationEventDetailsErrorItem (Maybe Text)

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.

organizationEventDetailsErrorItem_errorName :: Lens' OrganizationEventDetailsErrorItem (Maybe Text)

The name of the error.

organizationEventDetailsErrorItem_eventArn :: Lens' OrganizationEventDetailsErrorItem (Maybe Text)

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