amazonka-pinpoint-email-2.0: gen/Amazonka/PinpointEmail/GetConfigurationSetEventDestinations.hs
{-# 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.PinpointEmail.GetConfigurationSetEventDestinations
-- Copyright : (c) 2013-2023 Brendan Hay
-- License : Mozilla Public License, v. 2.0.
-- Maintainer : Brendan Hay
-- Stability : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Retrieve a list of event destinations that are associated with a
-- configuration set.
--
-- In Amazon Pinpoint, /events/ include message sends, deliveries, opens,
-- clicks, bounces, and complaints. /Event destinations/ are places that
-- you can send information about these events to. For example, you can
-- send event data to Amazon SNS to receive notifications when you receive
-- bounces or complaints, or you can use Amazon Kinesis Data Firehose to
-- stream data to Amazon S3 for long-term storage.
module Amazonka.PinpointEmail.GetConfigurationSetEventDestinations
( -- * Creating a Request
GetConfigurationSetEventDestinations (..),
newGetConfigurationSetEventDestinations,
-- * Request Lenses
getConfigurationSetEventDestinations_configurationSetName,
-- * Destructuring the Response
GetConfigurationSetEventDestinationsResponse (..),
newGetConfigurationSetEventDestinationsResponse,
-- * Response Lenses
getConfigurationSetEventDestinationsResponse_eventDestinations,
getConfigurationSetEventDestinationsResponse_httpStatus,
)
where
import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import Amazonka.PinpointEmail.Types
import qualified Amazonka.Prelude as Prelude
import qualified Amazonka.Request as Request
import qualified Amazonka.Response as Response
-- | A request to obtain information about the event destinations for a
-- configuration set.
--
-- /See:/ 'newGetConfigurationSetEventDestinations' smart constructor.
data GetConfigurationSetEventDestinations = GetConfigurationSetEventDestinations'
{ -- | The name of the configuration set that contains the event destination.
configurationSetName :: Prelude.Text
}
deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic)
-- |
-- Create a value of 'GetConfigurationSetEventDestinations' 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:
--
-- 'configurationSetName', 'getConfigurationSetEventDestinations_configurationSetName' - The name of the configuration set that contains the event destination.
newGetConfigurationSetEventDestinations ::
-- | 'configurationSetName'
Prelude.Text ->
GetConfigurationSetEventDestinations
newGetConfigurationSetEventDestinations
pConfigurationSetName_ =
GetConfigurationSetEventDestinations'
{ configurationSetName =
pConfigurationSetName_
}
-- | The name of the configuration set that contains the event destination.
getConfigurationSetEventDestinations_configurationSetName :: Lens.Lens' GetConfigurationSetEventDestinations Prelude.Text
getConfigurationSetEventDestinations_configurationSetName = Lens.lens (\GetConfigurationSetEventDestinations' {configurationSetName} -> configurationSetName) (\s@GetConfigurationSetEventDestinations' {} a -> s {configurationSetName = a} :: GetConfigurationSetEventDestinations)
instance
Core.AWSRequest
GetConfigurationSetEventDestinations
where
type
AWSResponse GetConfigurationSetEventDestinations =
GetConfigurationSetEventDestinationsResponse
request overrides =
Request.get (overrides defaultService)
response =
Response.receiveJSON
( \s h x ->
GetConfigurationSetEventDestinationsResponse'
Prelude.<$> ( x
Data..?> "EventDestinations"
Core..!@ Prelude.mempty
)
Prelude.<*> (Prelude.pure (Prelude.fromEnum s))
)
instance
Prelude.Hashable
GetConfigurationSetEventDestinations
where
hashWithSalt
_salt
GetConfigurationSetEventDestinations' {..} =
_salt `Prelude.hashWithSalt` configurationSetName
instance
Prelude.NFData
GetConfigurationSetEventDestinations
where
rnf GetConfigurationSetEventDestinations' {..} =
Prelude.rnf configurationSetName
instance
Data.ToHeaders
GetConfigurationSetEventDestinations
where
toHeaders =
Prelude.const
( Prelude.mconcat
[ "Content-Type"
Data.=# ( "application/x-amz-json-1.1" ::
Prelude.ByteString
)
]
)
instance
Data.ToPath
GetConfigurationSetEventDestinations
where
toPath GetConfigurationSetEventDestinations' {..} =
Prelude.mconcat
[ "/v1/email/configuration-sets/",
Data.toBS configurationSetName,
"/event-destinations"
]
instance
Data.ToQuery
GetConfigurationSetEventDestinations
where
toQuery = Prelude.const Prelude.mempty
-- | Information about an event destination for a configuration set.
--
-- /See:/ 'newGetConfigurationSetEventDestinationsResponse' smart constructor.
data GetConfigurationSetEventDestinationsResponse = GetConfigurationSetEventDestinationsResponse'
{ -- | An array that includes all of the events destinations that have been
-- configured for the configuration set.
eventDestinations :: Prelude.Maybe [EventDestination],
-- | The response's http status code.
httpStatus :: Prelude.Int
}
deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic)
-- |
-- Create a value of 'GetConfigurationSetEventDestinationsResponse' 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:
--
-- 'eventDestinations', 'getConfigurationSetEventDestinationsResponse_eventDestinations' - An array that includes all of the events destinations that have been
-- configured for the configuration set.
--
-- 'httpStatus', 'getConfigurationSetEventDestinationsResponse_httpStatus' - The response's http status code.
newGetConfigurationSetEventDestinationsResponse ::
-- | 'httpStatus'
Prelude.Int ->
GetConfigurationSetEventDestinationsResponse
newGetConfigurationSetEventDestinationsResponse
pHttpStatus_ =
GetConfigurationSetEventDestinationsResponse'
{ eventDestinations =
Prelude.Nothing,
httpStatus = pHttpStatus_
}
-- | An array that includes all of the events destinations that have been
-- configured for the configuration set.
getConfigurationSetEventDestinationsResponse_eventDestinations :: Lens.Lens' GetConfigurationSetEventDestinationsResponse (Prelude.Maybe [EventDestination])
getConfigurationSetEventDestinationsResponse_eventDestinations = Lens.lens (\GetConfigurationSetEventDestinationsResponse' {eventDestinations} -> eventDestinations) (\s@GetConfigurationSetEventDestinationsResponse' {} a -> s {eventDestinations = a} :: GetConfigurationSetEventDestinationsResponse) Prelude.. Lens.mapping Lens.coerced
-- | The response's http status code.
getConfigurationSetEventDestinationsResponse_httpStatus :: Lens.Lens' GetConfigurationSetEventDestinationsResponse Prelude.Int
getConfigurationSetEventDestinationsResponse_httpStatus = Lens.lens (\GetConfigurationSetEventDestinationsResponse' {httpStatus} -> httpStatus) (\s@GetConfigurationSetEventDestinationsResponse' {} a -> s {httpStatus = a} :: GetConfigurationSetEventDestinationsResponse)
instance
Prelude.NFData
GetConfigurationSetEventDestinationsResponse
where
rnf GetConfigurationSetEventDestinationsResponse' {..} =
Prelude.rnf eventDestinations
`Prelude.seq` Prelude.rnf httpStatus