{-# 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.QuickSight.DescribeAnalysisPermissions -- Copyright : (c) 2013-2023 Brendan Hay -- License : Mozilla Public License, v. 2.0. -- Maintainer : Brendan Hay -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- -- Provides the read and write permissions for an analysis. module Amazonka.QuickSight.DescribeAnalysisPermissions ( -- * Creating a Request DescribeAnalysisPermissions (..), newDescribeAnalysisPermissions, -- * Request Lenses describeAnalysisPermissions_awsAccountId, describeAnalysisPermissions_analysisId, -- * Destructuring the Response DescribeAnalysisPermissionsResponse (..), newDescribeAnalysisPermissionsResponse, -- * Response Lenses describeAnalysisPermissionsResponse_analysisArn, describeAnalysisPermissionsResponse_analysisId, describeAnalysisPermissionsResponse_permissions, describeAnalysisPermissionsResponse_requestId, describeAnalysisPermissionsResponse_status, ) 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 Amazonka.QuickSight.Types import qualified Amazonka.Request as Request import qualified Amazonka.Response as Response -- | /See:/ 'newDescribeAnalysisPermissions' smart constructor. data DescribeAnalysisPermissions = DescribeAnalysisPermissions' { -- | The ID of the Amazon Web Services account that contains the analysis -- whose permissions you\'re describing. You must be using the Amazon Web -- Services account that the analysis is in. awsAccountId :: Prelude.Text, -- | The ID of the analysis whose permissions you\'re describing. The ID is -- part of the analysis URL. analysisId :: Prelude.Text } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'DescribeAnalysisPermissions' 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: -- -- 'awsAccountId', 'describeAnalysisPermissions_awsAccountId' - The ID of the Amazon Web Services account that contains the analysis -- whose permissions you\'re describing. You must be using the Amazon Web -- Services account that the analysis is in. -- -- 'analysisId', 'describeAnalysisPermissions_analysisId' - The ID of the analysis whose permissions you\'re describing. The ID is -- part of the analysis URL. newDescribeAnalysisPermissions :: -- | 'awsAccountId' Prelude.Text -> -- | 'analysisId' Prelude.Text -> DescribeAnalysisPermissions newDescribeAnalysisPermissions pAwsAccountId_ pAnalysisId_ = DescribeAnalysisPermissions' { awsAccountId = pAwsAccountId_, analysisId = pAnalysisId_ } -- | The ID of the Amazon Web Services account that contains the analysis -- whose permissions you\'re describing. You must be using the Amazon Web -- Services account that the analysis is in. describeAnalysisPermissions_awsAccountId :: Lens.Lens' DescribeAnalysisPermissions Prelude.Text describeAnalysisPermissions_awsAccountId = Lens.lens (\DescribeAnalysisPermissions' {awsAccountId} -> awsAccountId) (\s@DescribeAnalysisPermissions' {} a -> s {awsAccountId = a} :: DescribeAnalysisPermissions) -- | The ID of the analysis whose permissions you\'re describing. The ID is -- part of the analysis URL. describeAnalysisPermissions_analysisId :: Lens.Lens' DescribeAnalysisPermissions Prelude.Text describeAnalysisPermissions_analysisId = Lens.lens (\DescribeAnalysisPermissions' {analysisId} -> analysisId) (\s@DescribeAnalysisPermissions' {} a -> s {analysisId = a} :: DescribeAnalysisPermissions) instance Core.AWSRequest DescribeAnalysisPermissions where type AWSResponse DescribeAnalysisPermissions = DescribeAnalysisPermissionsResponse request overrides = Request.get (overrides defaultService) response = Response.receiveJSON ( \s h x -> DescribeAnalysisPermissionsResponse' Prelude.<$> (x Data..?> "AnalysisArn") Prelude.<*> (x Data..?> "AnalysisId") Prelude.<*> (x Data..?> "Permissions") Prelude.<*> (x Data..?> "RequestId") Prelude.<*> (Prelude.pure (Prelude.fromEnum s)) ) instance Prelude.Hashable DescribeAnalysisPermissions where hashWithSalt _salt DescribeAnalysisPermissions' {..} = _salt `Prelude.hashWithSalt` awsAccountId `Prelude.hashWithSalt` analysisId instance Prelude.NFData DescribeAnalysisPermissions where rnf DescribeAnalysisPermissions' {..} = Prelude.rnf awsAccountId `Prelude.seq` Prelude.rnf analysisId instance Data.ToHeaders DescribeAnalysisPermissions where toHeaders = Prelude.const ( Prelude.mconcat [ "Content-Type" Data.=# ( "application/x-amz-json-1.0" :: Prelude.ByteString ) ] ) instance Data.ToPath DescribeAnalysisPermissions where toPath DescribeAnalysisPermissions' {..} = Prelude.mconcat [ "/accounts/", Data.toBS awsAccountId, "/analyses/", Data.toBS analysisId, "/permissions" ] instance Data.ToQuery DescribeAnalysisPermissions where toQuery = Prelude.const Prelude.mempty -- | /See:/ 'newDescribeAnalysisPermissionsResponse' smart constructor. data DescribeAnalysisPermissionsResponse = DescribeAnalysisPermissionsResponse' { -- | The Amazon Resource Name (ARN) of the analysis whose permissions you\'re -- describing. analysisArn :: Prelude.Maybe Prelude.Text, -- | The ID of the analysis whose permissions you\'re describing. analysisId :: Prelude.Maybe Prelude.Text, -- | A structure that describes the principals and the resource-level -- permissions on an analysis. permissions :: Prelude.Maybe (Prelude.NonEmpty ResourcePermission), -- | The Amazon Web Services request ID for this operation. requestId :: Prelude.Maybe Prelude.Text, -- | The HTTP status of the request. status :: Prelude.Int } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'DescribeAnalysisPermissionsResponse' 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: -- -- 'analysisArn', 'describeAnalysisPermissionsResponse_analysisArn' - The Amazon Resource Name (ARN) of the analysis whose permissions you\'re -- describing. -- -- 'analysisId', 'describeAnalysisPermissionsResponse_analysisId' - The ID of the analysis whose permissions you\'re describing. -- -- 'permissions', 'describeAnalysisPermissionsResponse_permissions' - A structure that describes the principals and the resource-level -- permissions on an analysis. -- -- 'requestId', 'describeAnalysisPermissionsResponse_requestId' - The Amazon Web Services request ID for this operation. -- -- 'status', 'describeAnalysisPermissionsResponse_status' - The HTTP status of the request. newDescribeAnalysisPermissionsResponse :: -- | 'status' Prelude.Int -> DescribeAnalysisPermissionsResponse newDescribeAnalysisPermissionsResponse pStatus_ = DescribeAnalysisPermissionsResponse' { analysisArn = Prelude.Nothing, analysisId = Prelude.Nothing, permissions = Prelude.Nothing, requestId = Prelude.Nothing, status = pStatus_ } -- | The Amazon Resource Name (ARN) of the analysis whose permissions you\'re -- describing. describeAnalysisPermissionsResponse_analysisArn :: Lens.Lens' DescribeAnalysisPermissionsResponse (Prelude.Maybe Prelude.Text) describeAnalysisPermissionsResponse_analysisArn = Lens.lens (\DescribeAnalysisPermissionsResponse' {analysisArn} -> analysisArn) (\s@DescribeAnalysisPermissionsResponse' {} a -> s {analysisArn = a} :: DescribeAnalysisPermissionsResponse) -- | The ID of the analysis whose permissions you\'re describing. describeAnalysisPermissionsResponse_analysisId :: Lens.Lens' DescribeAnalysisPermissionsResponse (Prelude.Maybe Prelude.Text) describeAnalysisPermissionsResponse_analysisId = Lens.lens (\DescribeAnalysisPermissionsResponse' {analysisId} -> analysisId) (\s@DescribeAnalysisPermissionsResponse' {} a -> s {analysisId = a} :: DescribeAnalysisPermissionsResponse) -- | A structure that describes the principals and the resource-level -- permissions on an analysis. describeAnalysisPermissionsResponse_permissions :: Lens.Lens' DescribeAnalysisPermissionsResponse (Prelude.Maybe (Prelude.NonEmpty ResourcePermission)) describeAnalysisPermissionsResponse_permissions = Lens.lens (\DescribeAnalysisPermissionsResponse' {permissions} -> permissions) (\s@DescribeAnalysisPermissionsResponse' {} a -> s {permissions = a} :: DescribeAnalysisPermissionsResponse) Prelude.. Lens.mapping Lens.coerced -- | The Amazon Web Services request ID for this operation. describeAnalysisPermissionsResponse_requestId :: Lens.Lens' DescribeAnalysisPermissionsResponse (Prelude.Maybe Prelude.Text) describeAnalysisPermissionsResponse_requestId = Lens.lens (\DescribeAnalysisPermissionsResponse' {requestId} -> requestId) (\s@DescribeAnalysisPermissionsResponse' {} a -> s {requestId = a} :: DescribeAnalysisPermissionsResponse) -- | The HTTP status of the request. describeAnalysisPermissionsResponse_status :: Lens.Lens' DescribeAnalysisPermissionsResponse Prelude.Int describeAnalysisPermissionsResponse_status = Lens.lens (\DescribeAnalysisPermissionsResponse' {status} -> status) (\s@DescribeAnalysisPermissionsResponse' {} a -> s {status = a} :: DescribeAnalysisPermissionsResponse) instance Prelude.NFData DescribeAnalysisPermissionsResponse where rnf DescribeAnalysisPermissionsResponse' {..} = Prelude.rnf analysisArn `Prelude.seq` Prelude.rnf analysisId `Prelude.seq` Prelude.rnf permissions `Prelude.seq` Prelude.rnf requestId `Prelude.seq` Prelude.rnf status