amazonka-resiliencehub-2.0: gen/Amazonka/ResilienceHub/DescribeApp.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.ResilienceHub.DescribeApp
-- Copyright : (c) 2013-2023 Brendan Hay
-- License : Mozilla Public License, v. 2.0.
-- Maintainer : Brendan Hay
-- Stability : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Describes an AWS Resilience Hub application.
module Amazonka.ResilienceHub.DescribeApp
( -- * Creating a Request
DescribeApp (..),
newDescribeApp,
-- * Request Lenses
describeApp_appArn,
-- * Destructuring the Response
DescribeAppResponse (..),
newDescribeAppResponse,
-- * Response Lenses
describeAppResponse_httpStatus,
describeAppResponse_app,
)
where
import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import qualified Amazonka.Prelude as Prelude
import qualified Amazonka.Request as Request
import Amazonka.ResilienceHub.Types
import qualified Amazonka.Response as Response
-- | /See:/ 'newDescribeApp' smart constructor.
data DescribeApp = DescribeApp'
{ -- | The Amazon Resource Name (ARN) of the application. The format for this
-- ARN is: arn:@partition@:resiliencehub:@region@:@account@:app\/@app-id@.
-- For more information about ARNs, see
-- <https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html Amazon Resource Names (ARNs)>
-- in the /AWS General Reference/.
appArn :: Prelude.Text
}
deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic)
-- |
-- Create a value of 'DescribeApp' 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:
--
-- 'appArn', 'describeApp_appArn' - The Amazon Resource Name (ARN) of the application. The format for this
-- ARN is: arn:@partition@:resiliencehub:@region@:@account@:app\/@app-id@.
-- For more information about ARNs, see
-- <https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html Amazon Resource Names (ARNs)>
-- in the /AWS General Reference/.
newDescribeApp ::
-- | 'appArn'
Prelude.Text ->
DescribeApp
newDescribeApp pAppArn_ =
DescribeApp' {appArn = pAppArn_}
-- | The Amazon Resource Name (ARN) of the application. The format for this
-- ARN is: arn:@partition@:resiliencehub:@region@:@account@:app\/@app-id@.
-- For more information about ARNs, see
-- <https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html Amazon Resource Names (ARNs)>
-- in the /AWS General Reference/.
describeApp_appArn :: Lens.Lens' DescribeApp Prelude.Text
describeApp_appArn = Lens.lens (\DescribeApp' {appArn} -> appArn) (\s@DescribeApp' {} a -> s {appArn = a} :: DescribeApp)
instance Core.AWSRequest DescribeApp where
type AWSResponse DescribeApp = DescribeAppResponse
request overrides =
Request.postJSON (overrides defaultService)
response =
Response.receiveJSON
( \s h x ->
DescribeAppResponse'
Prelude.<$> (Prelude.pure (Prelude.fromEnum s))
Prelude.<*> (x Data..:> "app")
)
instance Prelude.Hashable DescribeApp where
hashWithSalt _salt DescribeApp' {..} =
_salt `Prelude.hashWithSalt` appArn
instance Prelude.NFData DescribeApp where
rnf DescribeApp' {..} = Prelude.rnf appArn
instance Data.ToHeaders DescribeApp where
toHeaders =
Prelude.const
( Prelude.mconcat
[ "Content-Type"
Data.=# ( "application/x-amz-json-1.1" ::
Prelude.ByteString
)
]
)
instance Data.ToJSON DescribeApp where
toJSON DescribeApp' {..} =
Data.object
( Prelude.catMaybes
[Prelude.Just ("appArn" Data..= appArn)]
)
instance Data.ToPath DescribeApp where
toPath = Prelude.const "/describe-app"
instance Data.ToQuery DescribeApp where
toQuery = Prelude.const Prelude.mempty
-- | /See:/ 'newDescribeAppResponse' smart constructor.
data DescribeAppResponse = DescribeAppResponse'
{ -- | The response's http status code.
httpStatus :: Prelude.Int,
-- | The specified application, returned as an object with details including
-- compliance status, creation time, description, resiliency score, and
-- more.
app :: App
}
deriving (Prelude.Eq, Prelude.Show, Prelude.Generic)
-- |
-- Create a value of 'DescribeAppResponse' 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', 'describeAppResponse_httpStatus' - The response's http status code.
--
-- 'app', 'describeAppResponse_app' - The specified application, returned as an object with details including
-- compliance status, creation time, description, resiliency score, and
-- more.
newDescribeAppResponse ::
-- | 'httpStatus'
Prelude.Int ->
-- | 'app'
App ->
DescribeAppResponse
newDescribeAppResponse pHttpStatus_ pApp_ =
DescribeAppResponse'
{ httpStatus = pHttpStatus_,
app = pApp_
}
-- | The response's http status code.
describeAppResponse_httpStatus :: Lens.Lens' DescribeAppResponse Prelude.Int
describeAppResponse_httpStatus = Lens.lens (\DescribeAppResponse' {httpStatus} -> httpStatus) (\s@DescribeAppResponse' {} a -> s {httpStatus = a} :: DescribeAppResponse)
-- | The specified application, returned as an object with details including
-- compliance status, creation time, description, resiliency score, and
-- more.
describeAppResponse_app :: Lens.Lens' DescribeAppResponse App
describeAppResponse_app = Lens.lens (\DescribeAppResponse' {app} -> app) (\s@DescribeAppResponse' {} a -> s {app = a} :: DescribeAppResponse)
instance Prelude.NFData DescribeAppResponse where
rnf DescribeAppResponse' {..} =
Prelude.rnf httpStatus
`Prelude.seq` Prelude.rnf app