DeleteOrganizationConfigRule.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.Config.DeleteOrganizationConfigRule
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Deletes the specified organization Config rule and all of its evaluation
-- results from all member accounts in that organization.
--
-- Only a management account and a delegated administrator account can
-- delete an organization Config rule. When calling this API with a
-- delegated administrator, you must ensure Organizations
-- @ListDelegatedAdministrator@ permissions are added.
--
-- Config sets the state of a rule to DELETE_IN_PROGRESS until the deletion
-- is complete. You cannot update a rule while it is in this state.
module Amazonka.Config.DeleteOrganizationConfigRule
  ( -- * Creating a Request
    DeleteOrganizationConfigRule (..),
    newDeleteOrganizationConfigRule,

    -- * Request Lenses
    deleteOrganizationConfigRule_organizationConfigRuleName,

    -- * Destructuring the Response
    DeleteOrganizationConfigRuleResponse (..),
    newDeleteOrganizationConfigRuleResponse,
  )
where

import Amazonka.Config.Types
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 qualified Amazonka.Response as Response

-- | /See:/ 'newDeleteOrganizationConfigRule' smart constructor.
data DeleteOrganizationConfigRule = DeleteOrganizationConfigRule'
  { -- | The name of organization Config rule that you want to delete.
    organizationConfigRuleName :: Prelude.Text
  }
  deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic)

-- |
-- Create a value of 'DeleteOrganizationConfigRule' 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:
--
-- 'organizationConfigRuleName', 'deleteOrganizationConfigRule_organizationConfigRuleName' - The name of organization Config rule that you want to delete.
newDeleteOrganizationConfigRule ::
  -- | 'organizationConfigRuleName'
  Prelude.Text ->
  DeleteOrganizationConfigRule
newDeleteOrganizationConfigRule
  pOrganizationConfigRuleName_ =
    DeleteOrganizationConfigRule'
      { organizationConfigRuleName =
          pOrganizationConfigRuleName_
      }

-- | The name of organization Config rule that you want to delete.
deleteOrganizationConfigRule_organizationConfigRuleName :: Lens.Lens' DeleteOrganizationConfigRule Prelude.Text
deleteOrganizationConfigRule_organizationConfigRuleName = Lens.lens (\DeleteOrganizationConfigRule' {organizationConfigRuleName} -> organizationConfigRuleName) (\s@DeleteOrganizationConfigRule' {} a -> s {organizationConfigRuleName = a} :: DeleteOrganizationConfigRule)

instance Core.AWSRequest DeleteOrganizationConfigRule where
  type
    AWSResponse DeleteOrganizationConfigRule =
      DeleteOrganizationConfigRuleResponse
  request overrides =
    Request.postJSON (overrides defaultService)
  response =
    Response.receiveNull
      DeleteOrganizationConfigRuleResponse'

instance
  Prelude.Hashable
    DeleteOrganizationConfigRule
  where
  hashWithSalt _salt DeleteOrganizationConfigRule' {..} =
    _salt
      `Prelude.hashWithSalt` organizationConfigRuleName

instance Prelude.NFData DeleteOrganizationConfigRule where
  rnf DeleteOrganizationConfigRule' {..} =
    Prelude.rnf organizationConfigRuleName

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

instance Data.ToJSON DeleteOrganizationConfigRule where
  toJSON DeleteOrganizationConfigRule' {..} =
    Data.object
      ( Prelude.catMaybes
          [ Prelude.Just
              ( "OrganizationConfigRuleName"
                  Data..= organizationConfigRuleName
              )
          ]
      )

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

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

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

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

instance
  Prelude.NFData
    DeleteOrganizationConfigRuleResponse
  where
  rnf _ = ()