amazonka-health-2.0: Amazon Health APIs and Notifications SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.AWSHealth.DescribeEventDetailsForOrganization

Description

Returns detailed information about one or more specified events for one or more Amazon Web Services accounts in your organization. This information includes standard event data (such as the Amazon Web Services Region and service), an event description, and (depending on the event) possible metadata. This operation doesn't return affected entities, such as the resources related to the event. To return affected entities, use the DescribeAffectedEntitiesForOrganization operation.

Before you can call this operation, you must first enable Health to work with Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's management account.

When you call the DescribeEventDetailsForOrganization operation, specify the organizationEventDetailFilters object in the request. Depending on the Health event type, note the following differences:

  • To return event details for a public event, you must specify a null value for the awsAccountId parameter. If you specify an account ID for a public event, Health returns an error message because public events aren't specific to an account.
  • To return event details for an event that is specific to an account in your organization, you must specify the awsAccountId parameter in the request. If you don't specify an account ID, Health returns an error message because the event is specific to an account in your organization.

For more information, see Event.

This operation doesn't support resource-level permissions. You can't 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.

Synopsis

Creating a Request

data DescribeEventDetailsForOrganization Source #

Constructors

DescribeEventDetailsForOrganization' 

Fields

Instances

Instances details
ToJSON DescribeEventDetailsForOrganization Source # 
Instance details

Defined in Amazonka.AWSHealth.DescribeEventDetailsForOrganization

ToHeaders DescribeEventDetailsForOrganization Source # 
Instance details

Defined in Amazonka.AWSHealth.DescribeEventDetailsForOrganization

ToPath DescribeEventDetailsForOrganization Source # 
Instance details

Defined in Amazonka.AWSHealth.DescribeEventDetailsForOrganization

ToQuery DescribeEventDetailsForOrganization Source # 
Instance details

Defined in Amazonka.AWSHealth.DescribeEventDetailsForOrganization

AWSRequest DescribeEventDetailsForOrganization Source # 
Instance details

Defined in Amazonka.AWSHealth.DescribeEventDetailsForOrganization

Generic DescribeEventDetailsForOrganization Source # 
Instance details

Defined in Amazonka.AWSHealth.DescribeEventDetailsForOrganization

Read DescribeEventDetailsForOrganization Source # 
Instance details

Defined in Amazonka.AWSHealth.DescribeEventDetailsForOrganization

Show DescribeEventDetailsForOrganization Source # 
Instance details

Defined in Amazonka.AWSHealth.DescribeEventDetailsForOrganization

NFData DescribeEventDetailsForOrganization Source # 
Instance details

Defined in Amazonka.AWSHealth.DescribeEventDetailsForOrganization

Eq DescribeEventDetailsForOrganization Source # 
Instance details

Defined in Amazonka.AWSHealth.DescribeEventDetailsForOrganization

Hashable DescribeEventDetailsForOrganization Source # 
Instance details

Defined in Amazonka.AWSHealth.DescribeEventDetailsForOrganization

type AWSResponse DescribeEventDetailsForOrganization Source # 
Instance details

Defined in Amazonka.AWSHealth.DescribeEventDetailsForOrganization

type Rep DescribeEventDetailsForOrganization Source # 
Instance details

Defined in Amazonka.AWSHealth.DescribeEventDetailsForOrganization

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

newDescribeEventDetailsForOrganization Source #

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

$sel:organizationEventDetailFilters:DescribeEventDetailsForOrganization', describeEventDetailsForOrganization_organizationEventDetailFilters - A set of JSON elements that includes the awsAccountId and the eventArn.

Request Lenses

describeEventDetailsForOrganization_locale :: Lens' DescribeEventDetailsForOrganization (Maybe Text) Source #

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

Destructuring the Response

data DescribeEventDetailsForOrganizationResponse Source #

Constructors

DescribeEventDetailsForOrganizationResponse' 

Fields

Instances

Instances details
Generic DescribeEventDetailsForOrganizationResponse Source # 
Instance details

Defined in Amazonka.AWSHealth.DescribeEventDetailsForOrganization

Read DescribeEventDetailsForOrganizationResponse Source # 
Instance details

Defined in Amazonka.AWSHealth.DescribeEventDetailsForOrganization

Show DescribeEventDetailsForOrganizationResponse Source # 
Instance details

Defined in Amazonka.AWSHealth.DescribeEventDetailsForOrganization

NFData DescribeEventDetailsForOrganizationResponse Source # 
Instance details

Defined in Amazonka.AWSHealth.DescribeEventDetailsForOrganization

Eq DescribeEventDetailsForOrganizationResponse Source # 
Instance details

Defined in Amazonka.AWSHealth.DescribeEventDetailsForOrganization

type Rep DescribeEventDetailsForOrganizationResponse Source # 
Instance details

Defined in Amazonka.AWSHealth.DescribeEventDetailsForOrganization

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

newDescribeEventDetailsForOrganizationResponse Source #

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

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

$sel:httpStatus:DescribeEventDetailsForOrganizationResponse', describeEventDetailsForOrganizationResponse_httpStatus - The response's http status code.

Response Lenses