{-# 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.DAX.DescribeEvents
-- Copyright : (c) 2013-2023 Brendan Hay
-- License : Mozilla Public License, v. 2.0.
-- Maintainer : Brendan Hay
-- Stability : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Returns events related to DAX clusters and parameter groups. You can
-- obtain events specific to a particular DAX cluster or parameter group by
-- providing the name as a parameter.
--
-- By default, only the events occurring within the last 24 hours are
-- returned; however, you can retrieve up to 14 days\' worth of events if
-- necessary.
--
-- This operation returns paginated results.
module Amazonka.DAX.DescribeEvents
( -- * Creating a Request
DescribeEvents (..),
newDescribeEvents,
-- * Request Lenses
describeEvents_duration,
describeEvents_endTime,
describeEvents_maxResults,
describeEvents_nextToken,
describeEvents_sourceName,
describeEvents_sourceType,
describeEvents_startTime,
-- * Destructuring the Response
DescribeEventsResponse (..),
newDescribeEventsResponse,
-- * Response Lenses
describeEventsResponse_events,
describeEventsResponse_nextToken,
describeEventsResponse_httpStatus,
)
where
import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import Amazonka.DAX.Types
import qualified Amazonka.Data as Data
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 number of minutes\' worth of events to retrieve.
duration :: Prelude.Maybe Prelude.Int,
-- | The end of the time interval for which to retrieve events, specified in
-- ISO 8601 format.
endTime :: Prelude.Maybe Data.POSIX,
-- | The maximum number of results to include in the response. If more
-- results exist than the specified @MaxResults@ value, a token is included
-- in the response so that the remaining results can be retrieved.
--
-- The value for @MaxResults@ must be between 20 and 100.
maxResults :: Prelude.Maybe Prelude.Int,
-- | An optional token returned from a prior request. Use this token for
-- pagination of results from this action. If this parameter is specified,
-- the response includes only results beyond the token, up to the value
-- specified by @MaxResults@.
nextToken :: Prelude.Maybe Prelude.Text,
-- | The identifier of the event source for which events will be returned. If
-- not specified, then all sources are included in the response.
sourceName :: Prelude.Maybe Prelude.Text,
-- | The event source to retrieve events for. If no value is specified, all
-- events are returned.
sourceType :: Prelude.Maybe SourceType,
-- | The beginning of the time interval to retrieve events for, specified in
-- ISO 8601 format.
startTime :: Prelude.Maybe Data.POSIX
}
deriving (Prelude.Eq, Prelude.Read, Prelude.Show, 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:
--
-- 'duration', 'describeEvents_duration' - The number of minutes\' worth of events to retrieve.
--
-- 'endTime', 'describeEvents_endTime' - The end of the time interval for which to retrieve events, specified in
-- ISO 8601 format.
--
-- 'maxResults', 'describeEvents_maxResults' - The maximum number of results to include in the response. If more
-- results exist than the specified @MaxResults@ value, a token is included
-- in the response so that the remaining results can be retrieved.
--
-- The value for @MaxResults@ must be between 20 and 100.
--
-- 'nextToken', 'describeEvents_nextToken' - An optional token returned from a prior request. Use this token for
-- pagination of results from this action. If this parameter is specified,
-- the response includes only results beyond the token, up to the value
-- specified by @MaxResults@.
--
-- 'sourceName', 'describeEvents_sourceName' - The identifier of the event source for which events will be returned. If
-- not specified, then all sources are included in the response.
--
-- 'sourceType', 'describeEvents_sourceType' - The event source to retrieve events for. If no value is specified, all
-- events are returned.
--
-- 'startTime', 'describeEvents_startTime' - The beginning of the time interval to retrieve events for, specified in
-- ISO 8601 format.
newDescribeEvents ::
DescribeEvents
newDescribeEvents =
DescribeEvents'
{ duration = Prelude.Nothing,
endTime = Prelude.Nothing,
maxResults = Prelude.Nothing,
nextToken = Prelude.Nothing,
sourceName = Prelude.Nothing,
sourceType = Prelude.Nothing,
startTime = Prelude.Nothing
}
-- | The number of minutes\' worth of events to retrieve.
describeEvents_duration :: Lens.Lens' DescribeEvents (Prelude.Maybe Prelude.Int)
describeEvents_duration = Lens.lens (\DescribeEvents' {duration} -> duration) (\s@DescribeEvents' {} a -> s {duration = a} :: DescribeEvents)
-- | The end of the time interval for which to retrieve events, specified in
-- ISO 8601 format.
describeEvents_endTime :: Lens.Lens' DescribeEvents (Prelude.Maybe Prelude.UTCTime)
describeEvents_endTime = Lens.lens (\DescribeEvents' {endTime} -> endTime) (\s@DescribeEvents' {} a -> s {endTime = a} :: DescribeEvents) Prelude.. Lens.mapping Data._Time
-- | The maximum number of results to include in the response. If more
-- results exist than the specified @MaxResults@ value, a token is included
-- in the response so that the remaining results can be retrieved.
--
-- The value for @MaxResults@ must be between 20 and 100.
describeEvents_maxResults :: Lens.Lens' DescribeEvents (Prelude.Maybe Prelude.Int)
describeEvents_maxResults = Lens.lens (\DescribeEvents' {maxResults} -> maxResults) (\s@DescribeEvents' {} a -> s {maxResults = a} :: DescribeEvents)
-- | An optional token returned from a prior request. Use this token for
-- pagination of results from this action. If this parameter is specified,
-- the response includes only results beyond the token, up to the value
-- specified by @MaxResults@.
describeEvents_nextToken :: Lens.Lens' DescribeEvents (Prelude.Maybe Prelude.Text)
describeEvents_nextToken = Lens.lens (\DescribeEvents' {nextToken} -> nextToken) (\s@DescribeEvents' {} a -> s {nextToken = a} :: DescribeEvents)
-- | The identifier of the event source for which events will be returned. If
-- not specified, then all sources are included in the response.
describeEvents_sourceName :: Lens.Lens' DescribeEvents (Prelude.Maybe Prelude.Text)
describeEvents_sourceName = Lens.lens (\DescribeEvents' {sourceName} -> sourceName) (\s@DescribeEvents' {} a -> s {sourceName = a} :: DescribeEvents)
-- | The event source to retrieve events for. If no value is specified, all
-- events are returned.
describeEvents_sourceType :: Lens.Lens' DescribeEvents (Prelude.Maybe SourceType)
describeEvents_sourceType = Lens.lens (\DescribeEvents' {sourceType} -> sourceType) (\s@DescribeEvents' {} a -> s {sourceType = a} :: DescribeEvents)
-- | The beginning of the time interval to retrieve events for, specified in
-- ISO 8601 format.
describeEvents_startTime :: Lens.Lens' DescribeEvents (Prelude.Maybe Prelude.UTCTime)
describeEvents_startTime = Lens.lens (\DescribeEvents' {startTime} -> startTime) (\s@DescribeEvents' {} a -> s {startTime = a} :: DescribeEvents) Prelude.. Lens.mapping Data._Time
instance Core.AWSPager DescribeEvents where
page rq rs
| Core.stop
( rs
Lens.^? describeEventsResponse_nextToken
Prelude.. Lens._Just
) =
Prelude.Nothing
| Core.stop
( rs
Lens.^? describeEventsResponse_events
Prelude.. Lens._Just
) =
Prelude.Nothing
| Prelude.otherwise =
Prelude.Just
Prelude.$ rq
Prelude.& describeEvents_nextToken
Lens..~ rs
Lens.^? describeEventsResponse_nextToken
Prelude.. Lens._Just
instance Core.AWSRequest DescribeEvents where
type
AWSResponse DescribeEvents =
DescribeEventsResponse
request overrides =
Request.postJSON (overrides defaultService)
response =
Response.receiveJSON
( \s h x ->
DescribeEventsResponse'
Prelude.<$> (x Data..?> "Events" Core..!@ Prelude.mempty)
Prelude.<*> (x Data..?> "NextToken")
Prelude.<*> (Prelude.pure (Prelude.fromEnum s))
)
instance Prelude.Hashable DescribeEvents where
hashWithSalt _salt DescribeEvents' {..} =
_salt
`Prelude.hashWithSalt` duration
`Prelude.hashWithSalt` endTime
`Prelude.hashWithSalt` maxResults
`Prelude.hashWithSalt` nextToken
`Prelude.hashWithSalt` sourceName
`Prelude.hashWithSalt` sourceType
`Prelude.hashWithSalt` startTime
instance Prelude.NFData DescribeEvents where
rnf DescribeEvents' {..} =
Prelude.rnf duration
`Prelude.seq` Prelude.rnf endTime
`Prelude.seq` Prelude.rnf maxResults
`Prelude.seq` Prelude.rnf nextToken
`Prelude.seq` Prelude.rnf sourceName
`Prelude.seq` Prelude.rnf sourceType
`Prelude.seq` Prelude.rnf startTime
instance Data.ToHeaders DescribeEvents where
toHeaders =
Prelude.const
( Prelude.mconcat
[ "X-Amz-Target"
Data.=# ("AmazonDAXV3.DescribeEvents" :: Prelude.ByteString),
"Content-Type"
Data.=# ( "application/x-amz-json-1.1" ::
Prelude.ByteString
)
]
)
instance Data.ToJSON DescribeEvents where
toJSON DescribeEvents' {..} =
Data.object
( Prelude.catMaybes
[ ("Duration" Data..=) Prelude.<$> duration,
("EndTime" Data..=) Prelude.<$> endTime,
("MaxResults" Data..=) Prelude.<$> maxResults,
("NextToken" Data..=) Prelude.<$> nextToken,
("SourceName" Data..=) Prelude.<$> sourceName,
("SourceType" Data..=) Prelude.<$> sourceType,
("StartTime" Data..=) Prelude.<$> startTime
]
)
instance Data.ToPath DescribeEvents where
toPath = Prelude.const "/"
instance Data.ToQuery DescribeEvents where
toQuery = Prelude.const Prelude.mempty
-- | /See:/ 'newDescribeEventsResponse' smart constructor.
data DescribeEventsResponse = DescribeEventsResponse'
{ -- | An array of events. Each element in the array represents one event.
events :: Prelude.Maybe [Event],
-- | Provides an identifier to allow retrieval of paginated results.
nextToken :: Prelude.Maybe Prelude.Text,
-- | The response's http status code.
httpStatus :: Prelude.Int
}
deriving (Prelude.Eq, Prelude.Read, Prelude.Show, 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:
--
-- 'events', 'describeEventsResponse_events' - An array of events. Each element in the array represents one event.
--
-- 'nextToken', 'describeEventsResponse_nextToken' - Provides an identifier to allow retrieval of paginated results.
--
-- 'httpStatus', 'describeEventsResponse_httpStatus' - The response's http status code.
newDescribeEventsResponse ::
-- | 'httpStatus'
Prelude.Int ->
DescribeEventsResponse
newDescribeEventsResponse pHttpStatus_ =
DescribeEventsResponse'
{ events = Prelude.Nothing,
nextToken = Prelude.Nothing,
httpStatus = pHttpStatus_
}
-- | An array of events. Each element in the array represents one event.
describeEventsResponse_events :: Lens.Lens' DescribeEventsResponse (Prelude.Maybe [Event])
describeEventsResponse_events = Lens.lens (\DescribeEventsResponse' {events} -> events) (\s@DescribeEventsResponse' {} a -> s {events = a} :: DescribeEventsResponse) Prelude.. Lens.mapping Lens.coerced
-- | Provides an identifier to allow retrieval of paginated results.
describeEventsResponse_nextToken :: Lens.Lens' DescribeEventsResponse (Prelude.Maybe Prelude.Text)
describeEventsResponse_nextToken = Lens.lens (\DescribeEventsResponse' {nextToken} -> nextToken) (\s@DescribeEventsResponse' {} a -> s {nextToken = a} :: DescribeEventsResponse)
-- | The response's http status code.
describeEventsResponse_httpStatus :: Lens.Lens' DescribeEventsResponse Prelude.Int
describeEventsResponse_httpStatus = Lens.lens (\DescribeEventsResponse' {httpStatus} -> httpStatus) (\s@DescribeEventsResponse' {} a -> s {httpStatus = a} :: DescribeEventsResponse)
instance Prelude.NFData DescribeEventsResponse where
rnf DescribeEventsResponse' {..} =
Prelude.rnf events
`Prelude.seq` Prelude.rnf nextToken
`Prelude.seq` Prelude.rnf httpStatus