DescribeCrossAccountAccessRole.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.Inspector.DescribeCrossAccountAccessRole
-- 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 the IAM role that enables Amazon Inspector to access your AWS
-- account.
module Amazonka.Inspector.DescribeCrossAccountAccessRole
  ( -- * Creating a Request
    DescribeCrossAccountAccessRole (..),
    newDescribeCrossAccountAccessRole,

    -- * Destructuring the Response
    DescribeCrossAccountAccessRoleResponse (..),
    newDescribeCrossAccountAccessRoleResponse,

    -- * Response Lenses
    describeCrossAccountAccessRoleResponse_httpStatus,
    describeCrossAccountAccessRoleResponse_roleArn,
    describeCrossAccountAccessRoleResponse_valid,
    describeCrossAccountAccessRoleResponse_registeredAt,
  )
where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import Amazonka.Inspector.Types
import qualified Amazonka.Prelude as Prelude
import qualified Amazonka.Request as Request
import qualified Amazonka.Response as Response

-- | /See:/ 'newDescribeCrossAccountAccessRole' smart constructor.
data DescribeCrossAccountAccessRole = DescribeCrossAccountAccessRole'
  {
  }
  deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic)

-- |
-- Create a value of 'DescribeCrossAccountAccessRole' 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.
newDescribeCrossAccountAccessRole ::
  DescribeCrossAccountAccessRole
newDescribeCrossAccountAccessRole =
  DescribeCrossAccountAccessRole'

instance
  Core.AWSRequest
    DescribeCrossAccountAccessRole
  where
  type
    AWSResponse DescribeCrossAccountAccessRole =
      DescribeCrossAccountAccessRoleResponse
  request overrides =
    Request.postJSON (overrides defaultService)
  response =
    Response.receiveJSON
      ( \s h x ->
          DescribeCrossAccountAccessRoleResponse'
            Prelude.<$> (Prelude.pure (Prelude.fromEnum s))
            Prelude.<*> (x Data..:> "roleArn")
            Prelude.<*> (x Data..:> "valid")
            Prelude.<*> (x Data..:> "registeredAt")
      )

instance
  Prelude.Hashable
    DescribeCrossAccountAccessRole
  where
  hashWithSalt _salt _ =
    _salt `Prelude.hashWithSalt` ()

instance
  Prelude.NFData
    DescribeCrossAccountAccessRole
  where
  rnf _ = ()

instance
  Data.ToHeaders
    DescribeCrossAccountAccessRole
  where
  toHeaders =
    Prelude.const
      ( Prelude.mconcat
          [ "X-Amz-Target"
              Data.=# ( "InspectorService.DescribeCrossAccountAccessRole" ::
                          Prelude.ByteString
                      ),
            "Content-Type"
              Data.=# ( "application/x-amz-json-1.1" ::
                          Prelude.ByteString
                      )
          ]
      )

instance Data.ToJSON DescribeCrossAccountAccessRole where
  toJSON = Prelude.const (Data.Object Prelude.mempty)

instance Data.ToPath DescribeCrossAccountAccessRole where
  toPath = Prelude.const "/"

instance Data.ToQuery DescribeCrossAccountAccessRole where
  toQuery = Prelude.const Prelude.mempty

-- | /See:/ 'newDescribeCrossAccountAccessRoleResponse' smart constructor.
data DescribeCrossAccountAccessRoleResponse = DescribeCrossAccountAccessRoleResponse'
  { -- | The response's http status code.
    httpStatus :: Prelude.Int,
    -- | The ARN that specifies the IAM role that Amazon Inspector uses to access
    -- your AWS account.
    roleArn :: Prelude.Text,
    -- | A Boolean value that specifies whether the IAM role has the necessary
    -- policies attached to enable Amazon Inspector to access your AWS account.
    valid :: Prelude.Bool,
    -- | The date when the cross-account access role was registered.
    registeredAt :: Data.POSIX
  }
  deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic)

-- |
-- Create a value of 'DescribeCrossAccountAccessRoleResponse' 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', 'describeCrossAccountAccessRoleResponse_httpStatus' - The response's http status code.
--
-- 'roleArn', 'describeCrossAccountAccessRoleResponse_roleArn' - The ARN that specifies the IAM role that Amazon Inspector uses to access
-- your AWS account.
--
-- 'valid', 'describeCrossAccountAccessRoleResponse_valid' - A Boolean value that specifies whether the IAM role has the necessary
-- policies attached to enable Amazon Inspector to access your AWS account.
--
-- 'registeredAt', 'describeCrossAccountAccessRoleResponse_registeredAt' - The date when the cross-account access role was registered.
newDescribeCrossAccountAccessRoleResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  -- | 'roleArn'
  Prelude.Text ->
  -- | 'valid'
  Prelude.Bool ->
  -- | 'registeredAt'
  Prelude.UTCTime ->
  DescribeCrossAccountAccessRoleResponse
newDescribeCrossAccountAccessRoleResponse
  pHttpStatus_
  pRoleArn_
  pValid_
  pRegisteredAt_ =
    DescribeCrossAccountAccessRoleResponse'
      { httpStatus =
          pHttpStatus_,
        roleArn = pRoleArn_,
        valid = pValid_,
        registeredAt =
          Data._Time Lens.# pRegisteredAt_
      }

-- | The response's http status code.
describeCrossAccountAccessRoleResponse_httpStatus :: Lens.Lens' DescribeCrossAccountAccessRoleResponse Prelude.Int
describeCrossAccountAccessRoleResponse_httpStatus = Lens.lens (\DescribeCrossAccountAccessRoleResponse' {httpStatus} -> httpStatus) (\s@DescribeCrossAccountAccessRoleResponse' {} a -> s {httpStatus = a} :: DescribeCrossAccountAccessRoleResponse)

-- | The ARN that specifies the IAM role that Amazon Inspector uses to access
-- your AWS account.
describeCrossAccountAccessRoleResponse_roleArn :: Lens.Lens' DescribeCrossAccountAccessRoleResponse Prelude.Text
describeCrossAccountAccessRoleResponse_roleArn = Lens.lens (\DescribeCrossAccountAccessRoleResponse' {roleArn} -> roleArn) (\s@DescribeCrossAccountAccessRoleResponse' {} a -> s {roleArn = a} :: DescribeCrossAccountAccessRoleResponse)

-- | A Boolean value that specifies whether the IAM role has the necessary
-- policies attached to enable Amazon Inspector to access your AWS account.
describeCrossAccountAccessRoleResponse_valid :: Lens.Lens' DescribeCrossAccountAccessRoleResponse Prelude.Bool
describeCrossAccountAccessRoleResponse_valid = Lens.lens (\DescribeCrossAccountAccessRoleResponse' {valid} -> valid) (\s@DescribeCrossAccountAccessRoleResponse' {} a -> s {valid = a} :: DescribeCrossAccountAccessRoleResponse)

-- | The date when the cross-account access role was registered.
describeCrossAccountAccessRoleResponse_registeredAt :: Lens.Lens' DescribeCrossAccountAccessRoleResponse Prelude.UTCTime
describeCrossAccountAccessRoleResponse_registeredAt = Lens.lens (\DescribeCrossAccountAccessRoleResponse' {registeredAt} -> registeredAt) (\s@DescribeCrossAccountAccessRoleResponse' {} a -> s {registeredAt = a} :: DescribeCrossAccountAccessRoleResponse) Prelude.. Data._Time

instance
  Prelude.NFData
    DescribeCrossAccountAccessRoleResponse
  where
  rnf DescribeCrossAccountAccessRoleResponse' {..} =
    Prelude.rnf httpStatus
      `Prelude.seq` Prelude.rnf roleArn
      `Prelude.seq` Prelude.rnf valid
      `Prelude.seq` Prelude.rnf registeredAt