libZSservicesZSamazonka-healthZSamazonka-health
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.AWSHealth.Types.OrganizationEventDetailsErrorItem

Description

 
Synopsis

Documentation

data OrganizationEventDetailsErrorItem Source #

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.

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

    The name of the error.

  • 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 AWS account ID in the request.
    • We couldn't find an account specific event for the specified AWS account. To find an event that is public, you must enter a null value for the AWS account ID in the request.
    • Your AWS account doesn't include the AWS Support plan required to use the AWS Health API. You must have either a Business or Enterprise Support plan.

Instances

Instances details
Eq OrganizationEventDetailsErrorItem Source # 
Instance details

Defined in Amazonka.AWSHealth.Types.OrganizationEventDetailsErrorItem

Read OrganizationEventDetailsErrorItem Source # 
Instance details

Defined in Amazonka.AWSHealth.Types.OrganizationEventDetailsErrorItem

Show OrganizationEventDetailsErrorItem Source # 
Instance details

Defined in Amazonka.AWSHealth.Types.OrganizationEventDetailsErrorItem

Generic OrganizationEventDetailsErrorItem Source # 
Instance details

Defined in Amazonka.AWSHealth.Types.OrganizationEventDetailsErrorItem

Associated Types

type Rep OrganizationEventDetailsErrorItem :: Type -> Type #

NFData OrganizationEventDetailsErrorItem Source # 
Instance details

Defined in Amazonka.AWSHealth.Types.OrganizationEventDetailsErrorItem

Hashable OrganizationEventDetailsErrorItem Source # 
Instance details

Defined in Amazonka.AWSHealth.Types.OrganizationEventDetailsErrorItem

FromJSON OrganizationEventDetailsErrorItem Source # 
Instance details

Defined in Amazonka.AWSHealth.Types.OrganizationEventDetailsErrorItem

type Rep OrganizationEventDetailsErrorItem Source # 
Instance details

Defined in Amazonka.AWSHealth.Types.OrganizationEventDetailsErrorItem

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

newOrganizationEventDetailsErrorItem :: OrganizationEventDetailsErrorItem Source #

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

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

$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 AWS account ID in the request.
  • We couldn't find an account specific event for the specified AWS account. To find an event that is public, you must enter a null value for the AWS account ID in the request.
  • Your AWS account doesn't include the AWS Support plan required to use the AWS Health API. You must have either a Business or Enterprise Support plan.

organizationEventDetailsErrorItem_eventArn :: Lens' OrganizationEventDetailsErrorItem (Maybe Text) Source #

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_errorMessage :: Lens' OrganizationEventDetailsErrorItem (Maybe Text) Source #

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 AWS account ID in the request.
  • We couldn't find an account specific event for the specified AWS account. To find an event that is public, you must enter a null value for the AWS account ID in the request.
  • Your AWS account doesn't include the AWS Support plan required to use the AWS Health API. You must have either a Business or Enterprise Support plan.