AWSHealth.hs

{-# OPTIONS_GHC -fno-warn-duplicate-exports #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}

-- |
-- Module      : Amazonka.AWSHealth
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Derived from API version @2016-08-04@ of the AWS service descriptions, licensed under Apache 2.0.
--
-- Health
--
-- The Health API provides programmatic access to the Health information
-- that appears in the
-- <https://phd.aws.amazon.com/phd/home#/ Personal Health Dashboard>. You
-- can use the API operations to get information about events that might
-- affect your Amazon Web Services services and resources.
--
-- -   You must have a Business, Enterprise On-Ramp, or Enterprise Support
--     plan from
--     <http://aws.amazon.com/premiumsupport/ Amazon Web Services Support>
--     to use the Health API. If you call the Health API from an Amazon Web
--     Services account that doesn\'t have a Business, Enterprise On-Ramp,
--     or Enterprise Support plan, you receive a
--     @SubscriptionRequiredException@ error.
--
-- -   You can use the Health endpoint health.us-east-1.amazonaws.com
--     (HTTPS) to call the Health API operations. Health supports a
--     multi-Region application architecture and has two regional endpoints
--     in an active-passive configuration. You can use the high
--     availability endpoint example to determine which Amazon Web Services
--     Region is active, so that you can get the latest information from
--     the API. For more information, see
--     <https://docs.aws.amazon.com/health/latest/ug/health-api.html Accessing the Health API>
--     in the /Health User Guide/.
--
-- For authentication of requests, Health uses the
-- <https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html Signature Version 4 Signing Process>.
--
-- If your Amazon Web Services account is part of Organizations, you can
-- use the Health organizational view feature. This feature provides a
-- centralized view of Health events across all accounts in your
-- organization. You can aggregate Health events in real time to identify
-- accounts in your organization that are affected by an operational event
-- or get notified of security vulnerabilities. Use the organizational view
-- API operations to enable this feature and return event information. For
-- more information, see
-- <https://docs.aws.amazon.com/health/latest/ug/aggregate-events.html Aggregating Health events>
-- in the /Health User Guide/.
--
-- When you use the Health API operations to return Health events, see the
-- following recommendations:
--
-- -   Use the
--     <https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html#AWSHealth-Type-Event-eventScopeCode eventScopeCode>
--     parameter to specify whether to return Health events that are public
--     or account-specific.
--
-- -   Use pagination to view all events from the response. For example, if
--     you call the @DescribeEventsForOrganization@ operation to get all
--     events in your organization, you might receive several page results.
--     Specify the @nextToken@ in the next request to return more results.
module Amazonka.AWSHealth
  ( -- * Service Configuration
    defaultService,

    -- * Errors
    -- $errors

    -- ** ConcurrentModificationException
    _ConcurrentModificationException,

    -- ** InvalidPaginationToken
    _InvalidPaginationToken,

    -- ** UnsupportedLocale
    _UnsupportedLocale,

    -- * Waiters
    -- $waiters

    -- * Operations
    -- $operations

    -- ** DescribeAffectedAccountsForOrganization (Paginated)
    DescribeAffectedAccountsForOrganization (DescribeAffectedAccountsForOrganization'),
    newDescribeAffectedAccountsForOrganization,
    DescribeAffectedAccountsForOrganizationResponse (DescribeAffectedAccountsForOrganizationResponse'),
    newDescribeAffectedAccountsForOrganizationResponse,

    -- ** DescribeAffectedEntities (Paginated)
    DescribeAffectedEntities (DescribeAffectedEntities'),
    newDescribeAffectedEntities,
    DescribeAffectedEntitiesResponse (DescribeAffectedEntitiesResponse'),
    newDescribeAffectedEntitiesResponse,

    -- ** DescribeAffectedEntitiesForOrganization (Paginated)
    DescribeAffectedEntitiesForOrganization (DescribeAffectedEntitiesForOrganization'),
    newDescribeAffectedEntitiesForOrganization,
    DescribeAffectedEntitiesForOrganizationResponse (DescribeAffectedEntitiesForOrganizationResponse'),
    newDescribeAffectedEntitiesForOrganizationResponse,

    -- ** DescribeEntityAggregates
    DescribeEntityAggregates (DescribeEntityAggregates'),
    newDescribeEntityAggregates,
    DescribeEntityAggregatesResponse (DescribeEntityAggregatesResponse'),
    newDescribeEntityAggregatesResponse,

    -- ** DescribeEventAggregates (Paginated)
    DescribeEventAggregates (DescribeEventAggregates'),
    newDescribeEventAggregates,
    DescribeEventAggregatesResponse (DescribeEventAggregatesResponse'),
    newDescribeEventAggregatesResponse,

    -- ** DescribeEventDetails
    DescribeEventDetails (DescribeEventDetails'),
    newDescribeEventDetails,
    DescribeEventDetailsResponse (DescribeEventDetailsResponse'),
    newDescribeEventDetailsResponse,

    -- ** DescribeEventDetailsForOrganization
    DescribeEventDetailsForOrganization (DescribeEventDetailsForOrganization'),
    newDescribeEventDetailsForOrganization,
    DescribeEventDetailsForOrganizationResponse (DescribeEventDetailsForOrganizationResponse'),
    newDescribeEventDetailsForOrganizationResponse,

    -- ** DescribeEventTypes (Paginated)
    DescribeEventTypes (DescribeEventTypes'),
    newDescribeEventTypes,
    DescribeEventTypesResponse (DescribeEventTypesResponse'),
    newDescribeEventTypesResponse,

    -- ** DescribeEvents (Paginated)
    DescribeEvents (DescribeEvents'),
    newDescribeEvents,
    DescribeEventsResponse (DescribeEventsResponse'),
    newDescribeEventsResponse,

    -- ** DescribeEventsForOrganization (Paginated)
    DescribeEventsForOrganization (DescribeEventsForOrganization'),
    newDescribeEventsForOrganization,
    DescribeEventsForOrganizationResponse (DescribeEventsForOrganizationResponse'),
    newDescribeEventsForOrganizationResponse,

    -- ** DescribeHealthServiceStatusForOrganization
    DescribeHealthServiceStatusForOrganization (DescribeHealthServiceStatusForOrganization'),
    newDescribeHealthServiceStatusForOrganization,
    DescribeHealthServiceStatusForOrganizationResponse (DescribeHealthServiceStatusForOrganizationResponse'),
    newDescribeHealthServiceStatusForOrganizationResponse,

    -- ** DisableHealthServiceAccessForOrganization
    DisableHealthServiceAccessForOrganization (DisableHealthServiceAccessForOrganization'),
    newDisableHealthServiceAccessForOrganization,
    DisableHealthServiceAccessForOrganizationResponse (DisableHealthServiceAccessForOrganizationResponse'),
    newDisableHealthServiceAccessForOrganizationResponse,

    -- ** EnableHealthServiceAccessForOrganization
    EnableHealthServiceAccessForOrganization (EnableHealthServiceAccessForOrganization'),
    newEnableHealthServiceAccessForOrganization,
    EnableHealthServiceAccessForOrganizationResponse (EnableHealthServiceAccessForOrganizationResponse'),
    newEnableHealthServiceAccessForOrganizationResponse,

    -- * Types

    -- ** EntityStatusCode
    EntityStatusCode (..),

    -- ** EventAggregateField
    EventAggregateField (..),

    -- ** EventScopeCode
    EventScopeCode (..),

    -- ** EventStatusCode
    EventStatusCode (..),

    -- ** EventTypeCategory
    EventTypeCategory (..),

    -- ** AffectedEntity
    AffectedEntity (AffectedEntity'),
    newAffectedEntity,

    -- ** DateTimeRange
    DateTimeRange (DateTimeRange'),
    newDateTimeRange,

    -- ** EntityAggregate
    EntityAggregate (EntityAggregate'),
    newEntityAggregate,

    -- ** EntityFilter
    EntityFilter (EntityFilter'),
    newEntityFilter,

    -- ** Event
    Event (Event'),
    newEvent,

    -- ** EventAccountFilter
    EventAccountFilter (EventAccountFilter'),
    newEventAccountFilter,

    -- ** EventAggregate
    EventAggregate (EventAggregate'),
    newEventAggregate,

    -- ** EventDescription
    EventDescription (EventDescription'),
    newEventDescription,

    -- ** EventDetails
    EventDetails (EventDetails'),
    newEventDetails,

    -- ** EventDetailsErrorItem
    EventDetailsErrorItem (EventDetailsErrorItem'),
    newEventDetailsErrorItem,

    -- ** EventFilter
    EventFilter (EventFilter'),
    newEventFilter,

    -- ** EventType
    EventType (EventType'),
    newEventType,

    -- ** EventTypeFilter
    EventTypeFilter (EventTypeFilter'),
    newEventTypeFilter,

    -- ** OrganizationAffectedEntitiesErrorItem
    OrganizationAffectedEntitiesErrorItem (OrganizationAffectedEntitiesErrorItem'),
    newOrganizationAffectedEntitiesErrorItem,

    -- ** OrganizationEvent
    OrganizationEvent (OrganizationEvent'),
    newOrganizationEvent,

    -- ** OrganizationEventDetails
    OrganizationEventDetails (OrganizationEventDetails'),
    newOrganizationEventDetails,

    -- ** OrganizationEventDetailsErrorItem
    OrganizationEventDetailsErrorItem (OrganizationEventDetailsErrorItem'),
    newOrganizationEventDetailsErrorItem,

    -- ** OrganizationEventFilter
    OrganizationEventFilter (OrganizationEventFilter'),
    newOrganizationEventFilter,
  )
where

import Amazonka.AWSHealth.DescribeAffectedAccountsForOrganization
import Amazonka.AWSHealth.DescribeAffectedEntities
import Amazonka.AWSHealth.DescribeAffectedEntitiesForOrganization
import Amazonka.AWSHealth.DescribeEntityAggregates
import Amazonka.AWSHealth.DescribeEventAggregates
import Amazonka.AWSHealth.DescribeEventDetails
import Amazonka.AWSHealth.DescribeEventDetailsForOrganization
import Amazonka.AWSHealth.DescribeEventTypes
import Amazonka.AWSHealth.DescribeEvents
import Amazonka.AWSHealth.DescribeEventsForOrganization
import Amazonka.AWSHealth.DescribeHealthServiceStatusForOrganization
import Amazonka.AWSHealth.DisableHealthServiceAccessForOrganization
import Amazonka.AWSHealth.EnableHealthServiceAccessForOrganization
import Amazonka.AWSHealth.Lens
import Amazonka.AWSHealth.Types
import Amazonka.AWSHealth.Waiters

-- $errors
-- Error matchers are designed for use with the functions provided by
-- <http://hackage.haskell.org/package/lens/docs/Control-Exception-Lens.html Control.Exception.Lens>.
-- This allows catching (and rethrowing) service specific errors returned
-- by 'AWSHealth'.

-- $operations
-- Some AWS operations return results that are incomplete and require subsequent
-- requests in order to obtain the entire result set. The process of sending
-- subsequent requests to continue where a previous request left off is called
-- pagination. For example, the 'ListObjects' operation of Amazon S3 returns up to
-- 1000 objects at a time, and you must send subsequent requests with the
-- appropriate Marker in order to retrieve the next page of results.
--
-- Operations that have an 'AWSPager' instance can transparently perform subsequent
-- requests, correctly setting Markers and other request facets to iterate through
-- the entire result set of a truncated API operation. Operations which support
-- this have an additional note in the documentation.
--
-- Many operations have the ability to filter results on the server side. See the
-- individual operation parameters for details.

-- $waiters
-- Waiters poll by repeatedly sending a request until some remote success condition
-- configured by the 'Wait' specification is fulfilled. The 'Wait' specification
-- determines how many attempts should be made, in addition to delay and retry strategies.