Amazonka.AWSHealth.DescribeEventDetails

Returns detailed information about one or more specified events. Information includes standard event data (Amazon Web Services Region, service, and so on, as returned by DescribeEvents), a detailed event description, and possible additional metadata that depends upon the nature of the event. Affected entities are not included. To retrieve the entities, use the DescribeAffectedEntities operation.

If a specified event can't be retrieved, an error message is returned for that event.

This operation supports resource-level permissions. You can use this operation to allow or deny access to specific Health events. For more information, see Resource- and action-based conditions in the Health User Guide.

Creating a Request

data DescribeEventDetails

See: newDescribeEventDetails smart constructor.

Constructors

DescribeEventDetails'

Fields

• locale :: Maybe Text

  The locale (language) to return information in. English (en) is the default and the only supported value at this time.

• eventArns :: NonEmpty Text

  A list of event ARNs (unique identifiers). For example: "arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-CDE456", "arn:aws:health:us-west-1::event/EBS/AWS_EBS_LOST_VOLUME/AWS_EBS_LOST_VOLUME_CHI789_JKL101"

Instances

ToJSON DescribeEventDetails

Defined in Amazonka.AWSHealth.DescribeEventDetails

Methods

toJSON :: DescribeEventDetails -> Value

toEncoding :: DescribeEventDetails -> Encoding

toJSONList :: [DescribeEventDetails] -> Value

toEncodingList :: [DescribeEventDetails] -> Encoding

ToHeaders DescribeEventDetails

Defined in Amazonka.AWSHealth.DescribeEventDetails

Methods

toHeaders :: DescribeEventDetails -> [Header]

ToPath DescribeEventDetails

Defined in Amazonka.AWSHealth.DescribeEventDetails

Methods

toPath :: DescribeEventDetails -> ByteString

ToQuery DescribeEventDetails

Defined in Amazonka.AWSHealth.DescribeEventDetails

Methods

toQuery :: DescribeEventDetails -> QueryString

AWSRequest DescribeEventDetails

Defined in Amazonka.AWSHealth.DescribeEventDetails

Associated Types

type AWSResponse DescribeEventDetails

Methods

request :: (Service -> Service) -> DescribeEventDetails -> Request DescribeEventDetails

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeEventDetails -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeEventDetails)))

Generic DescribeEventDetails

Defined in Amazonka.AWSHealth.DescribeEventDetails

Associated Types

type Rep DescribeEventDetails :: Type -> Type

Methods

from :: DescribeEventDetails -> Rep DescribeEventDetails x

to :: Rep DescribeEventDetails x -> DescribeEventDetails

Read DescribeEventDetails

Defined in Amazonka.AWSHealth.DescribeEventDetails

Methods

readsPrec :: Int -> ReadS DescribeEventDetails

readList :: ReadS [DescribeEventDetails]

readPrec :: ReadPrec DescribeEventDetails

readListPrec :: ReadPrec [DescribeEventDetails]

Show DescribeEventDetails

Defined in Amazonka.AWSHealth.DescribeEventDetails

Methods

showsPrec :: Int -> DescribeEventDetails -> ShowS

show :: DescribeEventDetails -> String

showList :: [DescribeEventDetails] -> ShowS

NFData DescribeEventDetails

Defined in Amazonka.AWSHealth.DescribeEventDetails

Methods

rnf :: DescribeEventDetails -> ()

Eq DescribeEventDetails

Defined in Amazonka.AWSHealth.DescribeEventDetails

Methods

(==) :: DescribeEventDetails -> DescribeEventDetails -> Bool

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

Hashable DescribeEventDetails

Defined in Amazonka.AWSHealth.DescribeEventDetails

Methods

hashWithSalt :: Int -> DescribeEventDetails -> Int

hash :: DescribeEventDetails -> Int

type AWSResponse DescribeEventDetails

Defined in Amazonka.AWSHealth.DescribeEventDetails

type AWSResponse DescribeEventDetails = DescribeEventDetailsResponse

type Rep DescribeEventDetails

Defined in Amazonka.AWSHealth.DescribeEventDetails

type Rep DescribeEventDetails = D1 ('MetaData "DescribeEventDetails" "Amazonka.AWSHealth.DescribeEventDetails" "amazonka-health-2.0-97kQZARXu4I8k4sVSmOp5K" 'False) (C1 ('MetaCons "DescribeEventDetails'" 'PrefixI 'True) (S1 ('MetaSel ('Just "locale") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "eventArns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Text))))

newDescribeEventDetails

Arguments

:: NonEmpty Text

DescribeEventDetails

-> DescribeEventDetails

Create a value of DescribeEventDetails 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:locale:DescribeEventDetails', describeEventDetails_locale - The locale (language) to return information in. English (en) is the default and the only supported value at this time.

DescribeEventDetails, describeEventDetails_eventArns - A list of event ARNs (unique identifiers). For example: "arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-CDE456", "arn:aws:health:us-west-1::event/EBS/AWS_EBS_LOST_VOLUME/AWS_EBS_LOST_VOLUME_CHI789_JKL101"

Request Lenses

describeEventDetails_locale :: Lens' DescribeEventDetails (Maybe Text)

The locale (language) to return information in. English (en) is the default and the only supported value at this time.

describeEventDetails_eventArns :: Lens' DescribeEventDetails (NonEmpty Text)

A list of event ARNs (unique identifiers). For example: "arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-CDE456", "arn:aws:health:us-west-1::event/EBS/AWS_EBS_LOST_VOLUME/AWS_EBS_LOST_VOLUME_CHI789_JKL101"

Destructuring the Response

data DescribeEventDetailsResponse

See: newDescribeEventDetailsResponse smart constructor.

Constructors

DescribeEventDetailsResponse'

Fields

• failedSet :: Maybe [EventDetailsErrorItem]

  Error messages for any events that could not be retrieved.

• successfulSet :: Maybe [EventDetails]

  Information about the events that could be retrieved.

• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribeEventDetailsResponse

Defined in Amazonka.AWSHealth.DescribeEventDetails

Associated Types

type Rep DescribeEventDetailsResponse :: Type -> Type

Methods

from :: DescribeEventDetailsResponse -> Rep DescribeEventDetailsResponse x

to :: Rep DescribeEventDetailsResponse x -> DescribeEventDetailsResponse

Read DescribeEventDetailsResponse

Defined in Amazonka.AWSHealth.DescribeEventDetails

Methods

readsPrec :: Int -> ReadS DescribeEventDetailsResponse

readList :: ReadS [DescribeEventDetailsResponse]

readPrec :: ReadPrec DescribeEventDetailsResponse

readListPrec :: ReadPrec [DescribeEventDetailsResponse]

Show DescribeEventDetailsResponse

Defined in Amazonka.AWSHealth.DescribeEventDetails

Methods

showsPrec :: Int -> DescribeEventDetailsResponse -> ShowS

show :: DescribeEventDetailsResponse -> String

showList :: [DescribeEventDetailsResponse] -> ShowS

NFData DescribeEventDetailsResponse

Defined in Amazonka.AWSHealth.DescribeEventDetails

Methods

rnf :: DescribeEventDetailsResponse -> ()

Eq DescribeEventDetailsResponse

Defined in Amazonka.AWSHealth.DescribeEventDetails

Methods

(==) :: DescribeEventDetailsResponse -> DescribeEventDetailsResponse -> Bool

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

type Rep DescribeEventDetailsResponse

Defined in Amazonka.AWSHealth.DescribeEventDetails

type Rep DescribeEventDetailsResponse = D1 ('MetaData "DescribeEventDetailsResponse" "Amazonka.AWSHealth.DescribeEventDetails" "amazonka-health-2.0-97kQZARXu4I8k4sVSmOp5K" 'False) (C1 ('MetaCons "DescribeEventDetailsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "failedSet") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EventDetailsErrorItem])) :*: (S1 ('MetaSel ('Just "successfulSet") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EventDetails])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeEventDetailsResponse

Arguments

:: Int

$sel:httpStatus:DescribeEventDetailsResponse'

-> DescribeEventDetailsResponse

Create a value of DescribeEventDetailsResponse 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:failedSet:DescribeEventDetailsResponse', describeEventDetailsResponse_failedSet - Error messages for any events that could not be retrieved.

$sel:successfulSet:DescribeEventDetailsResponse', describeEventDetailsResponse_successfulSet - Information about the events that could be retrieved.

$sel:httpStatus:DescribeEventDetailsResponse', describeEventDetailsResponse_httpStatus - The response's http status code.

Response Lenses

describeEventDetailsResponse_failedSet :: Lens' DescribeEventDetailsResponse (Maybe [EventDetailsErrorItem])

Error messages for any events that could not be retrieved.

describeEventDetailsResponse_successfulSet :: Lens' DescribeEventDetailsResponse (Maybe [EventDetails])

Information about the events that could be retrieved.

describeEventDetailsResponse_httpStatus :: Lens' DescribeEventDetailsResponse Int

The response's http status code.