{-# 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.Support.DescribeTrustedAdvisorCheckSummaries -- Copyright : (c) 2013-2023 Brendan Hay -- License : Mozilla Public License, v. 2.0. -- Maintainer : Brendan Hay -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- -- Returns the results for the Trusted Advisor check summaries for the -- check IDs that you specified. You can get the check IDs by calling the -- DescribeTrustedAdvisorChecks operation. -- -- The response contains an array of TrustedAdvisorCheckSummary objects. -- -- - You must have a Business, Enterprise On-Ramp, or Enterprise Support -- plan to use the Amazon Web Services Support API. -- -- - If you call the Amazon Web Services Support API from an account that -- doesn\'t have a Business, Enterprise On-Ramp, or Enterprise Support -- plan, the @SubscriptionRequiredException@ error message appears. For -- information about changing your support plan, see -- . -- -- To call the Trusted Advisor operations in the Amazon Web Services -- Support API, you must use the US East (N. Virginia) endpoint. Currently, -- the US West (Oregon) and Europe (Ireland) endpoints don\'t support the -- Trusted Advisor operations. For more information, see -- -- in the /Amazon Web Services Support User Guide/. module Amazonka.Support.DescribeTrustedAdvisorCheckSummaries ( -- * Creating a Request DescribeTrustedAdvisorCheckSummaries (..), newDescribeTrustedAdvisorCheckSummaries, -- * Request Lenses describeTrustedAdvisorCheckSummaries_checkIds, -- * Destructuring the Response DescribeTrustedAdvisorCheckSummariesResponse (..), newDescribeTrustedAdvisorCheckSummariesResponse, -- * Response Lenses describeTrustedAdvisorCheckSummariesResponse_httpStatus, describeTrustedAdvisorCheckSummariesResponse_summaries, ) 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 qualified Amazonka.Response as Response import Amazonka.Support.Types -- | /See:/ 'newDescribeTrustedAdvisorCheckSummaries' smart constructor. data DescribeTrustedAdvisorCheckSummaries = DescribeTrustedAdvisorCheckSummaries' { -- | The IDs of the Trusted Advisor checks. checkIds :: [Prelude.Text] } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'DescribeTrustedAdvisorCheckSummaries' with all optional fields omitted. -- -- Use or to modify other optional fields. -- -- The following record fields are available, with the corresponding lenses provided -- for backwards compatibility: -- -- 'checkIds', 'describeTrustedAdvisorCheckSummaries_checkIds' - The IDs of the Trusted Advisor checks. newDescribeTrustedAdvisorCheckSummaries :: DescribeTrustedAdvisorCheckSummaries newDescribeTrustedAdvisorCheckSummaries = DescribeTrustedAdvisorCheckSummaries' { checkIds = Prelude.mempty } -- | The IDs of the Trusted Advisor checks. describeTrustedAdvisorCheckSummaries_checkIds :: Lens.Lens' DescribeTrustedAdvisorCheckSummaries [Prelude.Text] describeTrustedAdvisorCheckSummaries_checkIds = Lens.lens (\DescribeTrustedAdvisorCheckSummaries' {checkIds} -> checkIds) (\s@DescribeTrustedAdvisorCheckSummaries' {} a -> s {checkIds = a} :: DescribeTrustedAdvisorCheckSummaries) Prelude.. Lens.coerced instance Core.AWSRequest DescribeTrustedAdvisorCheckSummaries where type AWSResponse DescribeTrustedAdvisorCheckSummaries = DescribeTrustedAdvisorCheckSummariesResponse request overrides = Request.postJSON (overrides defaultService) response = Response.receiveJSON ( \s h x -> DescribeTrustedAdvisorCheckSummariesResponse' Prelude.<$> (Prelude.pure (Prelude.fromEnum s)) Prelude.<*> (x Data..?> "summaries" Core..!@ Prelude.mempty) ) instance Prelude.Hashable DescribeTrustedAdvisorCheckSummaries where hashWithSalt _salt DescribeTrustedAdvisorCheckSummaries' {..} = _salt `Prelude.hashWithSalt` checkIds instance Prelude.NFData DescribeTrustedAdvisorCheckSummaries where rnf DescribeTrustedAdvisorCheckSummaries' {..} = Prelude.rnf checkIds instance Data.ToHeaders DescribeTrustedAdvisorCheckSummaries where toHeaders = Prelude.const ( Prelude.mconcat [ "X-Amz-Target" Data.=# ( "AWSSupport_20130415.DescribeTrustedAdvisorCheckSummaries" :: Prelude.ByteString ), "Content-Type" Data.=# ( "application/x-amz-json-1.1" :: Prelude.ByteString ) ] ) instance Data.ToJSON DescribeTrustedAdvisorCheckSummaries where toJSON DescribeTrustedAdvisorCheckSummaries' {..} = Data.object ( Prelude.catMaybes [Prelude.Just ("checkIds" Data..= checkIds)] ) instance Data.ToPath DescribeTrustedAdvisorCheckSummaries where toPath = Prelude.const "/" instance Data.ToQuery DescribeTrustedAdvisorCheckSummaries where toQuery = Prelude.const Prelude.mempty -- | The summaries of the Trusted Advisor checks returned by the -- DescribeTrustedAdvisorCheckSummaries operation. -- -- /See:/ 'newDescribeTrustedAdvisorCheckSummariesResponse' smart constructor. data DescribeTrustedAdvisorCheckSummariesResponse = DescribeTrustedAdvisorCheckSummariesResponse' { -- | The response's http status code. httpStatus :: Prelude.Int, -- | The summary information for the requested Trusted Advisor checks. summaries :: [TrustedAdvisorCheckSummary] } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'DescribeTrustedAdvisorCheckSummariesResponse' with all optional fields omitted. -- -- Use or to modify other optional fields. -- -- The following record fields are available, with the corresponding lenses provided -- for backwards compatibility: -- -- 'httpStatus', 'describeTrustedAdvisorCheckSummariesResponse_httpStatus' - The response's http status code. -- -- 'summaries', 'describeTrustedAdvisorCheckSummariesResponse_summaries' - The summary information for the requested Trusted Advisor checks. newDescribeTrustedAdvisorCheckSummariesResponse :: -- | 'httpStatus' Prelude.Int -> DescribeTrustedAdvisorCheckSummariesResponse newDescribeTrustedAdvisorCheckSummariesResponse pHttpStatus_ = DescribeTrustedAdvisorCheckSummariesResponse' { httpStatus = pHttpStatus_, summaries = Prelude.mempty } -- | The response's http status code. describeTrustedAdvisorCheckSummariesResponse_httpStatus :: Lens.Lens' DescribeTrustedAdvisorCheckSummariesResponse Prelude.Int describeTrustedAdvisorCheckSummariesResponse_httpStatus = Lens.lens (\DescribeTrustedAdvisorCheckSummariesResponse' {httpStatus} -> httpStatus) (\s@DescribeTrustedAdvisorCheckSummariesResponse' {} a -> s {httpStatus = a} :: DescribeTrustedAdvisorCheckSummariesResponse) -- | The summary information for the requested Trusted Advisor checks. describeTrustedAdvisorCheckSummariesResponse_summaries :: Lens.Lens' DescribeTrustedAdvisorCheckSummariesResponse [TrustedAdvisorCheckSummary] describeTrustedAdvisorCheckSummariesResponse_summaries = Lens.lens (\DescribeTrustedAdvisorCheckSummariesResponse' {summaries} -> summaries) (\s@DescribeTrustedAdvisorCheckSummariesResponse' {} a -> s {summaries = a} :: DescribeTrustedAdvisorCheckSummariesResponse) Prelude.. Lens.coerced instance Prelude.NFData DescribeTrustedAdvisorCheckSummariesResponse where rnf DescribeTrustedAdvisorCheckSummariesResponse' {..} = Prelude.rnf httpStatus `Prelude.seq` Prelude.rnf summaries