{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE TypeFamilies #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -fno-warn-unused-binds #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-unused-matches #-}

-- Derived from AWS service descriptions, licensed under Apache 2.0.

-- |
-- Module      : Amazonka.AWSHealth.DescribeEvents
-- Copyright   : (c) 2013-2021 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay <brendan.g.hay+amazonka@gmail.com>
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Returns information about events that meet the specified filter
-- criteria. Events are returned in a summary form and do not include the
-- detailed description, any additional metadata that depends on the event
-- type, or any affected resources. To retrieve that information, use the
-- <https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetails.html DescribeEventDetails>
-- and
-- <https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntities.html DescribeAffectedEntities>
-- operations.
--
-- If no filter criteria are specified, all events are returned. Results
-- are sorted by @lastModifiedTime@, starting with the most recent event.
--
-- -   When you call the @DescribeEvents@ operation and specify an entity
--     for the @entityValues@ parameter, AWS Health might return public
--     events that aren\'t specific to that resource. For example, if you
--     call @DescribeEvents@ and specify an ID for an Amazon Elastic
--     Compute Cloud (Amazon EC2) instance, AWS Health might return events
--     that aren\'t specific to that resource or service. To get events
--     that are specific to a service, use the @services@ parameter in the
--     @filter@ object. For more information, see
--     <https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html Event>.
--
-- -   This API operation uses pagination. Specify the @nextToken@
--     parameter in the next request to return more results.
--
-- This operation returns paginated results.
module Amazonka.AWSHealth.DescribeEvents
  ( -- * Creating a Request
    DescribeEvents (..),
    newDescribeEvents,

    -- * Request Lenses
    describeEvents_locale,
    describeEvents_nextToken,
    describeEvents_filter,
    describeEvents_maxResults,

    -- * Destructuring the Response
    DescribeEventsResponse (..),
    newDescribeEventsResponse,

    -- * Response Lenses
    describeEventsResponse_nextToken,
    describeEventsResponse_events,
    describeEventsResponse_httpStatus,
  )
where

import Amazonka.AWSHealth.Types
import qualified Amazonka.Core as Core
import qualified Amazonka.Lens as Lens
import qualified Amazonka.Prelude as Prelude
import qualified Amazonka.Request as Request
import qualified Amazonka.Response as Response

-- | /See:/ 'newDescribeEvents' smart constructor.
data DescribeEvents = DescribeEvents'
  { -- | The locale (language) to return information in. English (en) is the
    -- default and the only supported value at this time.
    DescribeEvents -> Maybe Text
locale :: Prelude.Maybe Prelude.Text,
    -- | If the results of a search are large, only a portion of the results are
    -- returned, and a @nextToken@ pagination token is returned in the
    -- response. To retrieve the next batch of results, reissue the search
    -- request and include the returned token. When all results have been
    -- returned, the response does not contain a pagination token value.
    DescribeEvents -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text,
    -- | Values to narrow the results returned.
    DescribeEvents -> Maybe EventFilter
filter' :: Prelude.Maybe EventFilter,
    -- | The maximum number of items to return in one batch, between 10 and 100,
    -- inclusive.
    DescribeEvents -> Maybe Natural
maxResults :: Prelude.Maybe Prelude.Natural
  }
  deriving (DescribeEvents -> DescribeEvents -> Bool
(DescribeEvents -> DescribeEvents -> Bool)
-> (DescribeEvents -> DescribeEvents -> Bool) -> Eq DescribeEvents
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DescribeEvents -> DescribeEvents -> Bool
$c/= :: DescribeEvents -> DescribeEvents -> Bool
== :: DescribeEvents -> DescribeEvents -> Bool
$c== :: DescribeEvents -> DescribeEvents -> Bool
Prelude.Eq, ReadPrec [DescribeEvents]
ReadPrec DescribeEvents
Int -> ReadS DescribeEvents
ReadS [DescribeEvents]
(Int -> ReadS DescribeEvents)
-> ReadS [DescribeEvents]
-> ReadPrec DescribeEvents
-> ReadPrec [DescribeEvents]
-> Read DescribeEvents
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DescribeEvents]
$creadListPrec :: ReadPrec [DescribeEvents]
readPrec :: ReadPrec DescribeEvents
$creadPrec :: ReadPrec DescribeEvents
readList :: ReadS [DescribeEvents]
$creadList :: ReadS [DescribeEvents]
readsPrec :: Int -> ReadS DescribeEvents
$creadsPrec :: Int -> ReadS DescribeEvents
Prelude.Read, Int -> DescribeEvents -> ShowS
[DescribeEvents] -> ShowS
DescribeEvents -> String
(Int -> DescribeEvents -> ShowS)
-> (DescribeEvents -> String)
-> ([DescribeEvents] -> ShowS)
-> Show DescribeEvents
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DescribeEvents] -> ShowS
$cshowList :: [DescribeEvents] -> ShowS
show :: DescribeEvents -> String
$cshow :: DescribeEvents -> String
showsPrec :: Int -> DescribeEvents -> ShowS
$cshowsPrec :: Int -> DescribeEvents -> ShowS
Prelude.Show, (forall x. DescribeEvents -> Rep DescribeEvents x)
-> (forall x. Rep DescribeEvents x -> DescribeEvents)
-> Generic DescribeEvents
forall x. Rep DescribeEvents x -> DescribeEvents
forall x. DescribeEvents -> Rep DescribeEvents x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep DescribeEvents x -> DescribeEvents
$cfrom :: forall x. DescribeEvents -> Rep DescribeEvents x
Prelude.Generic)

-- |
-- Create a value of 'DescribeEvents' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'locale', 'describeEvents_locale' - The locale (language) to return information in. English (en) is the
-- default and the only supported value at this time.
--
-- 'nextToken', 'describeEvents_nextToken' - If the results of a search are large, only a portion of the results are
-- returned, and a @nextToken@ pagination token is returned in the
-- response. To retrieve the next batch of results, reissue the search
-- request and include the returned token. When all results have been
-- returned, the response does not contain a pagination token value.
--
-- 'filter'', 'describeEvents_filter' - Values to narrow the results returned.
--
-- 'maxResults', 'describeEvents_maxResults' - The maximum number of items to return in one batch, between 10 and 100,
-- inclusive.
newDescribeEvents ::
  DescribeEvents
newDescribeEvents :: DescribeEvents
newDescribeEvents =
  DescribeEvents' :: Maybe Text
-> Maybe Text
-> Maybe EventFilter
-> Maybe Natural
-> DescribeEvents
DescribeEvents'
    { $sel:locale:DescribeEvents' :: Maybe Text
locale = Maybe Text
forall a. Maybe a
Prelude.Nothing,
      $sel:nextToken:DescribeEvents' :: Maybe Text
nextToken = Maybe Text
forall a. Maybe a
Prelude.Nothing,
      $sel:filter':DescribeEvents' :: Maybe EventFilter
filter' = Maybe EventFilter
forall a. Maybe a
Prelude.Nothing,
      $sel:maxResults:DescribeEvents' :: Maybe Natural
maxResults = Maybe Natural
forall a. Maybe a
Prelude.Nothing
    }

-- | The locale (language) to return information in. English (en) is the
-- default and the only supported value at this time.
describeEvents_locale :: Lens.Lens' DescribeEvents (Prelude.Maybe Prelude.Text)
describeEvents_locale :: (Maybe Text -> f (Maybe Text))
-> DescribeEvents -> f DescribeEvents
describeEvents_locale = (DescribeEvents -> Maybe Text)
-> (DescribeEvents -> Maybe Text -> DescribeEvents)
-> Lens DescribeEvents DescribeEvents (Maybe Text) (Maybe Text)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeEvents' {Maybe Text
locale :: Maybe Text
$sel:locale:DescribeEvents' :: DescribeEvents -> Maybe Text
locale} -> Maybe Text
locale) (\s :: DescribeEvents
s@DescribeEvents' {} Maybe Text
a -> DescribeEvents
s {$sel:locale:DescribeEvents' :: Maybe Text
locale = Maybe Text
a} :: DescribeEvents)

-- | If the results of a search are large, only a portion of the results are
-- returned, and a @nextToken@ pagination token is returned in the
-- response. To retrieve the next batch of results, reissue the search
-- request and include the returned token. When all results have been
-- returned, the response does not contain a pagination token value.
describeEvents_nextToken :: Lens.Lens' DescribeEvents (Prelude.Maybe Prelude.Text)
describeEvents_nextToken :: (Maybe Text -> f (Maybe Text))
-> DescribeEvents -> f DescribeEvents
describeEvents_nextToken = (DescribeEvents -> Maybe Text)
-> (DescribeEvents -> Maybe Text -> DescribeEvents)
-> Lens DescribeEvents DescribeEvents (Maybe Text) (Maybe Text)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeEvents' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:DescribeEvents' :: DescribeEvents -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: DescribeEvents
s@DescribeEvents' {} Maybe Text
a -> DescribeEvents
s {$sel:nextToken:DescribeEvents' :: Maybe Text
nextToken = Maybe Text
a} :: DescribeEvents)

-- | Values to narrow the results returned.
describeEvents_filter :: Lens.Lens' DescribeEvents (Prelude.Maybe EventFilter)
describeEvents_filter :: (Maybe EventFilter -> f (Maybe EventFilter))
-> DescribeEvents -> f DescribeEvents
describeEvents_filter = (DescribeEvents -> Maybe EventFilter)
-> (DescribeEvents -> Maybe EventFilter -> DescribeEvents)
-> Lens
     DescribeEvents
     DescribeEvents
     (Maybe EventFilter)
     (Maybe EventFilter)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeEvents' {Maybe EventFilter
filter' :: Maybe EventFilter
$sel:filter':DescribeEvents' :: DescribeEvents -> Maybe EventFilter
filter'} -> Maybe EventFilter
filter') (\s :: DescribeEvents
s@DescribeEvents' {} Maybe EventFilter
a -> DescribeEvents
s {$sel:filter':DescribeEvents' :: Maybe EventFilter
filter' = Maybe EventFilter
a} :: DescribeEvents)

-- | The maximum number of items to return in one batch, between 10 and 100,
-- inclusive.
describeEvents_maxResults :: Lens.Lens' DescribeEvents (Prelude.Maybe Prelude.Natural)
describeEvents_maxResults :: (Maybe Natural -> f (Maybe Natural))
-> DescribeEvents -> f DescribeEvents
describeEvents_maxResults = (DescribeEvents -> Maybe Natural)
-> (DescribeEvents -> Maybe Natural -> DescribeEvents)
-> Lens
     DescribeEvents DescribeEvents (Maybe Natural) (Maybe Natural)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeEvents' {Maybe Natural
maxResults :: Maybe Natural
$sel:maxResults:DescribeEvents' :: DescribeEvents -> Maybe Natural
maxResults} -> Maybe Natural
maxResults) (\s :: DescribeEvents
s@DescribeEvents' {} Maybe Natural
a -> DescribeEvents
s {$sel:maxResults:DescribeEvents' :: Maybe Natural
maxResults = Maybe Natural
a} :: DescribeEvents)

instance Core.AWSPager DescribeEvents where
  page :: DescribeEvents
-> AWSResponse DescribeEvents -> Maybe DescribeEvents
page DescribeEvents
rq AWSResponse DescribeEvents
rs
    | Maybe Text -> Bool
forall a. AWSTruncated a => a -> Bool
Core.stop
        ( AWSResponse DescribeEvents
DescribeEventsResponse
rs
            DescribeEventsResponse
-> Getting (First Text) DescribeEventsResponse Text -> Maybe Text
forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? (Maybe Text -> Const (First Text) (Maybe Text))
-> DescribeEventsResponse
-> Const (First Text) DescribeEventsResponse
Lens' DescribeEventsResponse (Maybe Text)
describeEventsResponse_nextToken
              ((Maybe Text -> Const (First Text) (Maybe Text))
 -> DescribeEventsResponse
 -> Const (First Text) DescribeEventsResponse)
-> ((Text -> Const (First Text) Text)
    -> Maybe Text -> Const (First Text) (Maybe Text))
-> Getting (First Text) DescribeEventsResponse Text
forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. (Text -> Const (First Text) Text)
-> Maybe Text -> Const (First Text) (Maybe Text)
forall a b. Prism (Maybe a) (Maybe b) a b
Lens._Just
        ) =
      Maybe DescribeEvents
forall a. Maybe a
Prelude.Nothing
    | Maybe [Event] -> Bool
forall a. AWSTruncated a => a -> Bool
Core.stop
        ( AWSResponse DescribeEvents
DescribeEventsResponse
rs
            DescribeEventsResponse
-> Getting (First [Event]) DescribeEventsResponse [Event]
-> Maybe [Event]
forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? (Maybe [Event] -> Const (First [Event]) (Maybe [Event]))
-> DescribeEventsResponse
-> Const (First [Event]) DescribeEventsResponse
Lens' DescribeEventsResponse (Maybe [Event])
describeEventsResponse_events ((Maybe [Event] -> Const (First [Event]) (Maybe [Event]))
 -> DescribeEventsResponse
 -> Const (First [Event]) DescribeEventsResponse)
-> (([Event] -> Const (First [Event]) [Event])
    -> Maybe [Event] -> Const (First [Event]) (Maybe [Event]))
-> Getting (First [Event]) DescribeEventsResponse [Event]
forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. ([Event] -> Const (First [Event]) [Event])
-> Maybe [Event] -> Const (First [Event]) (Maybe [Event])
forall a b. Prism (Maybe a) (Maybe b) a b
Lens._Just
        ) =
      Maybe DescribeEvents
forall a. Maybe a
Prelude.Nothing
    | Bool
Prelude.otherwise =
      DescribeEvents -> Maybe DescribeEvents
forall a. a -> Maybe a
Prelude.Just (DescribeEvents -> Maybe DescribeEvents)
-> DescribeEvents -> Maybe DescribeEvents
forall a b. (a -> b) -> a -> b
Prelude.$
        DescribeEvents
rq
          DescribeEvents
-> (DescribeEvents -> DescribeEvents) -> DescribeEvents
forall a b. a -> (a -> b) -> b
Prelude.& (Maybe Text -> Identity (Maybe Text))
-> DescribeEvents -> Identity DescribeEvents
Lens DescribeEvents DescribeEvents (Maybe Text) (Maybe Text)
describeEvents_nextToken
          ((Maybe Text -> Identity (Maybe Text))
 -> DescribeEvents -> Identity DescribeEvents)
-> Maybe Text -> DescribeEvents -> DescribeEvents
forall s t a b. ASetter s t a b -> b -> s -> t
Lens..~ AWSResponse DescribeEvents
DescribeEventsResponse
rs
          DescribeEventsResponse
-> Getting (First Text) DescribeEventsResponse Text -> Maybe Text
forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? (Maybe Text -> Const (First Text) (Maybe Text))
-> DescribeEventsResponse
-> Const (First Text) DescribeEventsResponse
Lens' DescribeEventsResponse (Maybe Text)
describeEventsResponse_nextToken ((Maybe Text -> Const (First Text) (Maybe Text))
 -> DescribeEventsResponse
 -> Const (First Text) DescribeEventsResponse)
-> ((Text -> Const (First Text) Text)
    -> Maybe Text -> Const (First Text) (Maybe Text))
-> Getting (First Text) DescribeEventsResponse Text
forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. (Text -> Const (First Text) Text)
-> Maybe Text -> Const (First Text) (Maybe Text)
forall a b. Prism (Maybe a) (Maybe b) a b
Lens._Just

instance Core.AWSRequest DescribeEvents where
  type
    AWSResponse DescribeEvents =
      DescribeEventsResponse
  request :: DescribeEvents -> Request DescribeEvents
request = Service -> DescribeEvents -> Request DescribeEvents
forall a. (ToRequest a, ToJSON a) => Service -> a -> Request a
Request.postJSON Service
defaultService
  response :: Logger
-> Service
-> Proxy DescribeEvents
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse DescribeEvents)))
response =
    (Int
 -> ResponseHeaders
 -> Object
 -> Either String (AWSResponse DescribeEvents))
-> Logger
-> Service
-> Proxy DescribeEvents
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse DescribeEvents)))
forall (m :: * -> *) a.
MonadResource m =>
(Int -> ResponseHeaders -> Object -> Either String (AWSResponse a))
-> Logger
-> Service
-> Proxy a
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse a)))
Response.receiveJSON
      ( \Int
s ResponseHeaders
h Object
x ->
          Maybe Text -> Maybe [Event] -> Int -> DescribeEventsResponse
DescribeEventsResponse'
            (Maybe Text -> Maybe [Event] -> Int -> DescribeEventsResponse)
-> Either String (Maybe Text)
-> Either String (Maybe [Event] -> Int -> DescribeEventsResponse)
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x Object -> Text -> Either String (Maybe Text)
forall a. FromJSON a => Object -> Text -> Either String (Maybe a)
Core..?> Text
"nextToken")
            Either String (Maybe [Event] -> Int -> DescribeEventsResponse)
-> Either String (Maybe [Event])
-> Either String (Int -> DescribeEventsResponse)
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x Object -> Text -> Either String (Maybe (Maybe [Event]))
forall a. FromJSON a => Object -> Text -> Either String (Maybe a)
Core..?> Text
"events" Either String (Maybe (Maybe [Event]))
-> Maybe [Event] -> Either String (Maybe [Event])
forall (f :: * -> *) a. Functor f => f (Maybe a) -> a -> f a
Core..!@ Maybe [Event]
forall a. Monoid a => a
Prelude.mempty)
            Either String (Int -> DescribeEventsResponse)
-> Either String Int -> Either String DescribeEventsResponse
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Int -> Either String Int
forall (f :: * -> *) a. Applicative f => a -> f a
Prelude.pure (Int -> Int
forall a. Enum a => a -> Int
Prelude.fromEnum Int
s))
      )

instance Prelude.Hashable DescribeEvents

instance Prelude.NFData DescribeEvents

instance Core.ToHeaders DescribeEvents where
  toHeaders :: DescribeEvents -> ResponseHeaders
toHeaders =
    ResponseHeaders -> DescribeEvents -> ResponseHeaders
forall a b. a -> b -> a
Prelude.const
      ( [ResponseHeaders] -> ResponseHeaders
forall a. Monoid a => [a] -> a
Prelude.mconcat
          [ HeaderName
"X-Amz-Target"
              HeaderName -> ByteString -> ResponseHeaders
forall a. ToHeader a => HeaderName -> a -> ResponseHeaders
Core.=# ( ByteString
"AWSHealth_20160804.DescribeEvents" ::
                          Prelude.ByteString
                      ),
            HeaderName
"Content-Type"
              HeaderName -> ByteString -> ResponseHeaders
forall a. ToHeader a => HeaderName -> a -> ResponseHeaders
Core.=# ( ByteString
"application/x-amz-json-1.1" ::
                          Prelude.ByteString
                      )
          ]
      )

instance Core.ToJSON DescribeEvents where
  toJSON :: DescribeEvents -> Value
toJSON DescribeEvents' {Maybe Natural
Maybe Text
Maybe EventFilter
maxResults :: Maybe Natural
filter' :: Maybe EventFilter
nextToken :: Maybe Text
locale :: Maybe Text
$sel:maxResults:DescribeEvents' :: DescribeEvents -> Maybe Natural
$sel:filter':DescribeEvents' :: DescribeEvents -> Maybe EventFilter
$sel:nextToken:DescribeEvents' :: DescribeEvents -> Maybe Text
$sel:locale:DescribeEvents' :: DescribeEvents -> Maybe Text
..} =
    [Pair] -> Value
Core.object
      ( [Maybe Pair] -> [Pair]
forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Text
"locale" Text -> Text -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..=) (Text -> Pair) -> Maybe Text -> Maybe Pair
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
locale,
            (Text
"nextToken" Text -> Text -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..=) (Text -> Pair) -> Maybe Text -> Maybe Pair
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
nextToken,
            (Text
"filter" Text -> EventFilter -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..=) (EventFilter -> Pair) -> Maybe EventFilter -> Maybe Pair
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe EventFilter
filter',
            (Text
"maxResults" Text -> Natural -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..=) (Natural -> Pair) -> Maybe Natural -> Maybe Pair
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Natural
maxResults
          ]
      )

instance Core.ToPath DescribeEvents where
  toPath :: DescribeEvents -> ByteString
toPath = ByteString -> DescribeEvents -> ByteString
forall a b. a -> b -> a
Prelude.const ByteString
"/"

instance Core.ToQuery DescribeEvents where
  toQuery :: DescribeEvents -> QueryString
toQuery = QueryString -> DescribeEvents -> QueryString
forall a b. a -> b -> a
Prelude.const QueryString
forall a. Monoid a => a
Prelude.mempty

-- | /See:/ 'newDescribeEventsResponse' smart constructor.
data DescribeEventsResponse = DescribeEventsResponse'
  { -- | If the results of a search are large, only a portion of the results are
    -- returned, and a @nextToken@ pagination token is returned in the
    -- response. To retrieve the next batch of results, reissue the search
    -- request and include the returned token. When all results have been
    -- returned, the response does not contain a pagination token value.
    DescribeEventsResponse -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text,
    -- | The events that match the specified filter criteria.
    DescribeEventsResponse -> Maybe [Event]
events :: Prelude.Maybe [Event],
    -- | The response's http status code.
    DescribeEventsResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (DescribeEventsResponse -> DescribeEventsResponse -> Bool
(DescribeEventsResponse -> DescribeEventsResponse -> Bool)
-> (DescribeEventsResponse -> DescribeEventsResponse -> Bool)
-> Eq DescribeEventsResponse
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DescribeEventsResponse -> DescribeEventsResponse -> Bool
$c/= :: DescribeEventsResponse -> DescribeEventsResponse -> Bool
== :: DescribeEventsResponse -> DescribeEventsResponse -> Bool
$c== :: DescribeEventsResponse -> DescribeEventsResponse -> Bool
Prelude.Eq, ReadPrec [DescribeEventsResponse]
ReadPrec DescribeEventsResponse
Int -> ReadS DescribeEventsResponse
ReadS [DescribeEventsResponse]
(Int -> ReadS DescribeEventsResponse)
-> ReadS [DescribeEventsResponse]
-> ReadPrec DescribeEventsResponse
-> ReadPrec [DescribeEventsResponse]
-> Read DescribeEventsResponse
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DescribeEventsResponse]
$creadListPrec :: ReadPrec [DescribeEventsResponse]
readPrec :: ReadPrec DescribeEventsResponse
$creadPrec :: ReadPrec DescribeEventsResponse
readList :: ReadS [DescribeEventsResponse]
$creadList :: ReadS [DescribeEventsResponse]
readsPrec :: Int -> ReadS DescribeEventsResponse
$creadsPrec :: Int -> ReadS DescribeEventsResponse
Prelude.Read, Int -> DescribeEventsResponse -> ShowS
[DescribeEventsResponse] -> ShowS
DescribeEventsResponse -> String
(Int -> DescribeEventsResponse -> ShowS)
-> (DescribeEventsResponse -> String)
-> ([DescribeEventsResponse] -> ShowS)
-> Show DescribeEventsResponse
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DescribeEventsResponse] -> ShowS
$cshowList :: [DescribeEventsResponse] -> ShowS
show :: DescribeEventsResponse -> String
$cshow :: DescribeEventsResponse -> String
showsPrec :: Int -> DescribeEventsResponse -> ShowS
$cshowsPrec :: Int -> DescribeEventsResponse -> ShowS
Prelude.Show, (forall x. DescribeEventsResponse -> Rep DescribeEventsResponse x)
-> (forall x.
    Rep DescribeEventsResponse x -> DescribeEventsResponse)
-> Generic DescribeEventsResponse
forall x. Rep DescribeEventsResponse x -> DescribeEventsResponse
forall x. DescribeEventsResponse -> Rep DescribeEventsResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep DescribeEventsResponse x -> DescribeEventsResponse
$cfrom :: forall x. DescribeEventsResponse -> Rep DescribeEventsResponse x
Prelude.Generic)

-- |
-- Create a value of 'DescribeEventsResponse' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'nextToken', 'describeEventsResponse_nextToken' - If the results of a search are large, only a portion of the results are
-- returned, and a @nextToken@ pagination token is returned in the
-- response. To retrieve the next batch of results, reissue the search
-- request and include the returned token. When all results have been
-- returned, the response does not contain a pagination token value.
--
-- 'events', 'describeEventsResponse_events' - The events that match the specified filter criteria.
--
-- 'httpStatus', 'describeEventsResponse_httpStatus' - The response's http status code.
newDescribeEventsResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  DescribeEventsResponse
newDescribeEventsResponse :: Int -> DescribeEventsResponse
newDescribeEventsResponse Int
pHttpStatus_ =
  DescribeEventsResponse' :: Maybe Text -> Maybe [Event] -> Int -> DescribeEventsResponse
DescribeEventsResponse'
    { $sel:nextToken:DescribeEventsResponse' :: Maybe Text
nextToken =
        Maybe Text
forall a. Maybe a
Prelude.Nothing,
      $sel:events:DescribeEventsResponse' :: Maybe [Event]
events = Maybe [Event]
forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:DescribeEventsResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | If the results of a search are large, only a portion of the results are
-- returned, and a @nextToken@ pagination token is returned in the
-- response. To retrieve the next batch of results, reissue the search
-- request and include the returned token. When all results have been
-- returned, the response does not contain a pagination token value.
describeEventsResponse_nextToken :: Lens.Lens' DescribeEventsResponse (Prelude.Maybe Prelude.Text)
describeEventsResponse_nextToken :: (Maybe Text -> f (Maybe Text))
-> DescribeEventsResponse -> f DescribeEventsResponse
describeEventsResponse_nextToken = (DescribeEventsResponse -> Maybe Text)
-> (DescribeEventsResponse -> Maybe Text -> DescribeEventsResponse)
-> Lens' DescribeEventsResponse (Maybe Text)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeEventsResponse' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:DescribeEventsResponse' :: DescribeEventsResponse -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: DescribeEventsResponse
s@DescribeEventsResponse' {} Maybe Text
a -> DescribeEventsResponse
s {$sel:nextToken:DescribeEventsResponse' :: Maybe Text
nextToken = Maybe Text
a} :: DescribeEventsResponse)

-- | The events that match the specified filter criteria.
describeEventsResponse_events :: Lens.Lens' DescribeEventsResponse (Prelude.Maybe [Event])
describeEventsResponse_events :: (Maybe [Event] -> f (Maybe [Event]))
-> DescribeEventsResponse -> f DescribeEventsResponse
describeEventsResponse_events = (DescribeEventsResponse -> Maybe [Event])
-> (DescribeEventsResponse
    -> Maybe [Event] -> DescribeEventsResponse)
-> Lens' DescribeEventsResponse (Maybe [Event])
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeEventsResponse' {Maybe [Event]
events :: Maybe [Event]
$sel:events:DescribeEventsResponse' :: DescribeEventsResponse -> Maybe [Event]
events} -> Maybe [Event]
events) (\s :: DescribeEventsResponse
s@DescribeEventsResponse' {} Maybe [Event]
a -> DescribeEventsResponse
s {$sel:events:DescribeEventsResponse' :: Maybe [Event]
events = Maybe [Event]
a} :: DescribeEventsResponse) ((Maybe [Event] -> f (Maybe [Event]))
 -> DescribeEventsResponse -> f DescribeEventsResponse)
-> ((Maybe [Event] -> f (Maybe [Event]))
    -> Maybe [Event] -> f (Maybe [Event]))
-> (Maybe [Event] -> f (Maybe [Event]))
-> DescribeEventsResponse
-> f DescribeEventsResponse
forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. AnIso [Event] [Event] [Event] [Event]
-> Iso
     (Maybe [Event]) (Maybe [Event]) (Maybe [Event]) (Maybe [Event])
forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping AnIso [Event] [Event] [Event] [Event]
forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | The response's http status code.
describeEventsResponse_httpStatus :: Lens.Lens' DescribeEventsResponse Prelude.Int
describeEventsResponse_httpStatus :: (Int -> f Int)
-> DescribeEventsResponse -> f DescribeEventsResponse
describeEventsResponse_httpStatus = (DescribeEventsResponse -> Int)
-> (DescribeEventsResponse -> Int -> DescribeEventsResponse)
-> Lens DescribeEventsResponse DescribeEventsResponse Int Int
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeEventsResponse' {Int
httpStatus :: Int
$sel:httpStatus:DescribeEventsResponse' :: DescribeEventsResponse -> Int
httpStatus} -> Int
httpStatus) (\s :: DescribeEventsResponse
s@DescribeEventsResponse' {} Int
a -> DescribeEventsResponse
s {$sel:httpStatus:DescribeEventsResponse' :: Int
httpStatus = Int
a} :: DescribeEventsResponse)

instance Prelude.NFData DescribeEventsResponse