{-# 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.KinesisAnalytics.AddApplicationOutput
-- 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)
--
-- This documentation is for version 1 of the Amazon Kinesis Data Analytics
-- API, which only supports SQL applications. Version 2 of the API supports
-- SQL and Java applications. For more information about version 2, see
-- </kinesisanalytics/latest/apiv2/Welcome.html Amazon Kinesis Data Analytics API V2 Documentation>.
--
-- Adds an external destination to your Amazon Kinesis Analytics
-- application.
--
-- If you want Amazon Kinesis Analytics to deliver data from an
-- in-application stream within your application to an external destination
-- (such as an Amazon Kinesis stream, an Amazon Kinesis Firehose delivery
-- stream, or an AWS Lambda function), you add the relevant configuration
-- to your application using this operation. You can configure one or more
-- outputs for your application. Each output configuration maps an
-- in-application stream and an external destination.
--
-- You can use one of the output configurations to deliver data from your
-- in-application error stream to an external destination so that you can
-- analyze the errors. For more information, see
-- <https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-output.html Understanding Application Output (Destination)>.
--
-- Any configuration update, including adding a streaming source using this
-- operation, results in a new version of the application. You can use the
-- <https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html DescribeApplication>
-- operation to find the current application version.
--
-- For the limits on the number of application inputs and outputs you can
-- configure, see
-- <https://docs.aws.amazon.com/kinesisanalytics/latest/dev/limits.html Limits>.
--
-- This operation requires permissions to perform the
-- @kinesisanalytics:AddApplicationOutput@ action.
module Amazonka.KinesisAnalytics.AddApplicationOutput
  ( -- * Creating a Request
    AddApplicationOutput (..),
    newAddApplicationOutput,

    -- * Request Lenses
    addApplicationOutput_applicationName,
    addApplicationOutput_currentApplicationVersionId,
    addApplicationOutput_output,

    -- * Destructuring the Response
    AddApplicationOutputResponse (..),
    newAddApplicationOutputResponse,

    -- * Response Lenses
    addApplicationOutputResponse_httpStatus,
  )
where

import qualified Amazonka.Core as Core
import Amazonka.KinesisAnalytics.Types
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:/ 'newAddApplicationOutput' smart constructor.
data AddApplicationOutput = AddApplicationOutput'
  { -- | Name of the application to which you want to add the output
    -- configuration.
    AddApplicationOutput -> Text
applicationName :: Prelude.Text,
    -- | Version of the application to which you want to add the output
    -- configuration. You can use the
    -- <https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html DescribeApplication>
    -- operation to get the current application version. If the version
    -- specified is not the current version, the
    -- @ConcurrentModificationException@ is returned.
    AddApplicationOutput -> Natural
currentApplicationVersionId :: Prelude.Natural,
    -- | An array of objects, each describing one output configuration. In the
    -- output configuration, you specify the name of an in-application stream,
    -- a destination (that is, an Amazon Kinesis stream, an Amazon Kinesis
    -- Firehose delivery stream, or an AWS Lambda function), and record the
    -- formation to use when writing to the destination.
    AddApplicationOutput -> Output
output :: Output
  }
  deriving (AddApplicationOutput -> AddApplicationOutput -> Bool
(AddApplicationOutput -> AddApplicationOutput -> Bool)
-> (AddApplicationOutput -> AddApplicationOutput -> Bool)
-> Eq AddApplicationOutput
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: AddApplicationOutput -> AddApplicationOutput -> Bool
$c/= :: AddApplicationOutput -> AddApplicationOutput -> Bool
== :: AddApplicationOutput -> AddApplicationOutput -> Bool
$c== :: AddApplicationOutput -> AddApplicationOutput -> Bool
Prelude.Eq, ReadPrec [AddApplicationOutput]
ReadPrec AddApplicationOutput
Int -> ReadS AddApplicationOutput
ReadS [AddApplicationOutput]
(Int -> ReadS AddApplicationOutput)
-> ReadS [AddApplicationOutput]
-> ReadPrec AddApplicationOutput
-> ReadPrec [AddApplicationOutput]
-> Read AddApplicationOutput
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [AddApplicationOutput]
$creadListPrec :: ReadPrec [AddApplicationOutput]
readPrec :: ReadPrec AddApplicationOutput
$creadPrec :: ReadPrec AddApplicationOutput
readList :: ReadS [AddApplicationOutput]
$creadList :: ReadS [AddApplicationOutput]
readsPrec :: Int -> ReadS AddApplicationOutput
$creadsPrec :: Int -> ReadS AddApplicationOutput
Prelude.Read, Int -> AddApplicationOutput -> ShowS
[AddApplicationOutput] -> ShowS
AddApplicationOutput -> String
(Int -> AddApplicationOutput -> ShowS)
-> (AddApplicationOutput -> String)
-> ([AddApplicationOutput] -> ShowS)
-> Show AddApplicationOutput
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [AddApplicationOutput] -> ShowS
$cshowList :: [AddApplicationOutput] -> ShowS
show :: AddApplicationOutput -> String
$cshow :: AddApplicationOutput -> String
showsPrec :: Int -> AddApplicationOutput -> ShowS
$cshowsPrec :: Int -> AddApplicationOutput -> ShowS
Prelude.Show, (forall x. AddApplicationOutput -> Rep AddApplicationOutput x)
-> (forall x. Rep AddApplicationOutput x -> AddApplicationOutput)
-> Generic AddApplicationOutput
forall x. Rep AddApplicationOutput x -> AddApplicationOutput
forall x. AddApplicationOutput -> Rep AddApplicationOutput x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep AddApplicationOutput x -> AddApplicationOutput
$cfrom :: forall x. AddApplicationOutput -> Rep AddApplicationOutput x
Prelude.Generic)

-- |
-- Create a value of 'AddApplicationOutput' 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:
--
-- 'applicationName', 'addApplicationOutput_applicationName' - Name of the application to which you want to add the output
-- configuration.
--
-- 'currentApplicationVersionId', 'addApplicationOutput_currentApplicationVersionId' - Version of the application to which you want to add the output
-- configuration. You can use the
-- <https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html DescribeApplication>
-- operation to get the current application version. If the version
-- specified is not the current version, the
-- @ConcurrentModificationException@ is returned.
--
-- 'output', 'addApplicationOutput_output' - An array of objects, each describing one output configuration. In the
-- output configuration, you specify the name of an in-application stream,
-- a destination (that is, an Amazon Kinesis stream, an Amazon Kinesis
-- Firehose delivery stream, or an AWS Lambda function), and record the
-- formation to use when writing to the destination.
newAddApplicationOutput ::
  -- | 'applicationName'
  Prelude.Text ->
  -- | 'currentApplicationVersionId'
  Prelude.Natural ->
  -- | 'output'
  Output ->
  AddApplicationOutput
newAddApplicationOutput :: Text -> Natural -> Output -> AddApplicationOutput
newAddApplicationOutput
  Text
pApplicationName_
  Natural
pCurrentApplicationVersionId_
  Output
pOutput_ =
    AddApplicationOutput' :: Text -> Natural -> Output -> AddApplicationOutput
AddApplicationOutput'
      { $sel:applicationName:AddApplicationOutput' :: Text
applicationName =
          Text
pApplicationName_,
        $sel:currentApplicationVersionId:AddApplicationOutput' :: Natural
currentApplicationVersionId =
          Natural
pCurrentApplicationVersionId_,
        $sel:output:AddApplicationOutput' :: Output
output = Output
pOutput_
      }

-- | Name of the application to which you want to add the output
-- configuration.
addApplicationOutput_applicationName :: Lens.Lens' AddApplicationOutput Prelude.Text
addApplicationOutput_applicationName :: (Text -> f Text) -> AddApplicationOutput -> f AddApplicationOutput
addApplicationOutput_applicationName = (AddApplicationOutput -> Text)
-> (AddApplicationOutput -> Text -> AddApplicationOutput)
-> Lens AddApplicationOutput AddApplicationOutput Text Text
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\AddApplicationOutput' {Text
applicationName :: Text
$sel:applicationName:AddApplicationOutput' :: AddApplicationOutput -> Text
applicationName} -> Text
applicationName) (\s :: AddApplicationOutput
s@AddApplicationOutput' {} Text
a -> AddApplicationOutput
s {$sel:applicationName:AddApplicationOutput' :: Text
applicationName = Text
a} :: AddApplicationOutput)

-- | Version of the application to which you want to add the output
-- configuration. You can use the
-- <https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html DescribeApplication>
-- operation to get the current application version. If the version
-- specified is not the current version, the
-- @ConcurrentModificationException@ is returned.
addApplicationOutput_currentApplicationVersionId :: Lens.Lens' AddApplicationOutput Prelude.Natural
addApplicationOutput_currentApplicationVersionId :: (Natural -> f Natural)
-> AddApplicationOutput -> f AddApplicationOutput
addApplicationOutput_currentApplicationVersionId = (AddApplicationOutput -> Natural)
-> (AddApplicationOutput -> Natural -> AddApplicationOutput)
-> Lens AddApplicationOutput AddApplicationOutput Natural Natural
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\AddApplicationOutput' {Natural
currentApplicationVersionId :: Natural
$sel:currentApplicationVersionId:AddApplicationOutput' :: AddApplicationOutput -> Natural
currentApplicationVersionId} -> Natural
currentApplicationVersionId) (\s :: AddApplicationOutput
s@AddApplicationOutput' {} Natural
a -> AddApplicationOutput
s {$sel:currentApplicationVersionId:AddApplicationOutput' :: Natural
currentApplicationVersionId = Natural
a} :: AddApplicationOutput)

-- | An array of objects, each describing one output configuration. In the
-- output configuration, you specify the name of an in-application stream,
-- a destination (that is, an Amazon Kinesis stream, an Amazon Kinesis
-- Firehose delivery stream, or an AWS Lambda function), and record the
-- formation to use when writing to the destination.
addApplicationOutput_output :: Lens.Lens' AddApplicationOutput Output
addApplicationOutput_output :: (Output -> f Output)
-> AddApplicationOutput -> f AddApplicationOutput
addApplicationOutput_output = (AddApplicationOutput -> Output)
-> (AddApplicationOutput -> Output -> AddApplicationOutput)
-> Lens AddApplicationOutput AddApplicationOutput Output Output
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\AddApplicationOutput' {Output
output :: Output
$sel:output:AddApplicationOutput' :: AddApplicationOutput -> Output
output} -> Output
output) (\s :: AddApplicationOutput
s@AddApplicationOutput' {} Output
a -> AddApplicationOutput
s {$sel:output:AddApplicationOutput' :: Output
output = Output
a} :: AddApplicationOutput)

instance Core.AWSRequest AddApplicationOutput where
  type
    AWSResponse AddApplicationOutput =
      AddApplicationOutputResponse
  request :: AddApplicationOutput -> Request AddApplicationOutput
request = Service -> AddApplicationOutput -> Request AddApplicationOutput
forall a. (ToRequest a, ToJSON a) => Service -> a -> Request a
Request.postJSON Service
defaultService
  response :: Logger
-> Service
-> Proxy AddApplicationOutput
-> ClientResponse ClientBody
-> m (Either
        Error (ClientResponse (AWSResponse AddApplicationOutput)))
response =
    (Int
 -> ResponseHeaders
 -> ()
 -> Either String (AWSResponse AddApplicationOutput))
-> Logger
-> Service
-> Proxy AddApplicationOutput
-> ClientResponse ClientBody
-> m (Either
        Error (ClientResponse (AWSResponse AddApplicationOutput)))
forall (m :: * -> *) a.
MonadResource m =>
(Int -> ResponseHeaders -> () -> Either String (AWSResponse a))
-> Logger
-> Service
-> Proxy a
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse a)))
Response.receiveEmpty
      ( \Int
s ResponseHeaders
h ()
x ->
          Int -> AddApplicationOutputResponse
AddApplicationOutputResponse'
            (Int -> AddApplicationOutputResponse)
-> Either String Int -> Either String AddApplicationOutputResponse
forall (f :: * -> *) a b. Functor 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 AddApplicationOutput

instance Prelude.NFData AddApplicationOutput

instance Core.ToHeaders AddApplicationOutput where
  toHeaders :: AddApplicationOutput -> ResponseHeaders
toHeaders =
    ResponseHeaders -> AddApplicationOutput -> 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
"KinesisAnalytics_20150814.AddApplicationOutput" ::
                          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 AddApplicationOutput where
  toJSON :: AddApplicationOutput -> Value
toJSON AddApplicationOutput' {Natural
Text
Output
output :: Output
currentApplicationVersionId :: Natural
applicationName :: Text
$sel:output:AddApplicationOutput' :: AddApplicationOutput -> Output
$sel:currentApplicationVersionId:AddApplicationOutput' :: AddApplicationOutput -> Natural
$sel:applicationName:AddApplicationOutput' :: AddApplicationOutput -> Text
..} =
    [Pair] -> Value
Core.object
      ( [Maybe Pair] -> [Pair]
forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ Pair -> Maybe Pair
forall a. a -> Maybe a
Prelude.Just
              (Text
"ApplicationName" Text -> Text -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..= Text
applicationName),
            Pair -> Maybe Pair
forall a. a -> Maybe a
Prelude.Just
              ( Text
"CurrentApplicationVersionId"
                  Text -> Natural -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..= Natural
currentApplicationVersionId
              ),
            Pair -> Maybe Pair
forall a. a -> Maybe a
Prelude.Just (Text
"Output" Text -> Output -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..= Output
output)
          ]
      )

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

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

-- |
--
-- /See:/ 'newAddApplicationOutputResponse' smart constructor.
data AddApplicationOutputResponse = AddApplicationOutputResponse'
  { -- | The response's http status code.
    AddApplicationOutputResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (AddApplicationOutputResponse
-> AddApplicationOutputResponse -> Bool
(AddApplicationOutputResponse
 -> AddApplicationOutputResponse -> Bool)
-> (AddApplicationOutputResponse
    -> AddApplicationOutputResponse -> Bool)
-> Eq AddApplicationOutputResponse
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: AddApplicationOutputResponse
-> AddApplicationOutputResponse -> Bool
$c/= :: AddApplicationOutputResponse
-> AddApplicationOutputResponse -> Bool
== :: AddApplicationOutputResponse
-> AddApplicationOutputResponse -> Bool
$c== :: AddApplicationOutputResponse
-> AddApplicationOutputResponse -> Bool
Prelude.Eq, ReadPrec [AddApplicationOutputResponse]
ReadPrec AddApplicationOutputResponse
Int -> ReadS AddApplicationOutputResponse
ReadS [AddApplicationOutputResponse]
(Int -> ReadS AddApplicationOutputResponse)
-> ReadS [AddApplicationOutputResponse]
-> ReadPrec AddApplicationOutputResponse
-> ReadPrec [AddApplicationOutputResponse]
-> Read AddApplicationOutputResponse
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [AddApplicationOutputResponse]
$creadListPrec :: ReadPrec [AddApplicationOutputResponse]
readPrec :: ReadPrec AddApplicationOutputResponse
$creadPrec :: ReadPrec AddApplicationOutputResponse
readList :: ReadS [AddApplicationOutputResponse]
$creadList :: ReadS [AddApplicationOutputResponse]
readsPrec :: Int -> ReadS AddApplicationOutputResponse
$creadsPrec :: Int -> ReadS AddApplicationOutputResponse
Prelude.Read, Int -> AddApplicationOutputResponse -> ShowS
[AddApplicationOutputResponse] -> ShowS
AddApplicationOutputResponse -> String
(Int -> AddApplicationOutputResponse -> ShowS)
-> (AddApplicationOutputResponse -> String)
-> ([AddApplicationOutputResponse] -> ShowS)
-> Show AddApplicationOutputResponse
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [AddApplicationOutputResponse] -> ShowS
$cshowList :: [AddApplicationOutputResponse] -> ShowS
show :: AddApplicationOutputResponse -> String
$cshow :: AddApplicationOutputResponse -> String
showsPrec :: Int -> AddApplicationOutputResponse -> ShowS
$cshowsPrec :: Int -> AddApplicationOutputResponse -> ShowS
Prelude.Show, (forall x.
 AddApplicationOutputResponse -> Rep AddApplicationOutputResponse x)
-> (forall x.
    Rep AddApplicationOutputResponse x -> AddApplicationOutputResponse)
-> Generic AddApplicationOutputResponse
forall x.
Rep AddApplicationOutputResponse x -> AddApplicationOutputResponse
forall x.
AddApplicationOutputResponse -> Rep AddApplicationOutputResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep AddApplicationOutputResponse x -> AddApplicationOutputResponse
$cfrom :: forall x.
AddApplicationOutputResponse -> Rep AddApplicationOutputResponse x
Prelude.Generic)

-- |
-- Create a value of 'AddApplicationOutputResponse' 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:
--
-- 'httpStatus', 'addApplicationOutputResponse_httpStatus' - The response's http status code.
newAddApplicationOutputResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  AddApplicationOutputResponse
newAddApplicationOutputResponse :: Int -> AddApplicationOutputResponse
newAddApplicationOutputResponse Int
pHttpStatus_ =
  AddApplicationOutputResponse' :: Int -> AddApplicationOutputResponse
AddApplicationOutputResponse'
    { $sel:httpStatus:AddApplicationOutputResponse' :: Int
httpStatus =
        Int
pHttpStatus_
    }

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

instance Prelude.NFData AddApplicationOutputResponse