Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.QuickSight.DescribeDashboardPermissions

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes read and write permissions for a dashboard.

Synopsis

Creating a Request

data DescribeDashboardPermissions Source #

See: newDescribeDashboardPermissions smart constructor.

Constructors

DescribeDashboardPermissions'
Fields awsAccountId :: Text The ID of the Amazon Web Services account that contains the dashboard that you're describing permissions for. dashboardId :: Text The ID for the dashboard, also added to the IAM policy.

Instances

Instances details

ToHeaders DescribeDashboardPermissions Source #
Instance details Defined in Amazonka.QuickSight.DescribeDashboardPermissions Methods toHeaders :: DescribeDashboardPermissions -> [Header] #
ToPath DescribeDashboardPermissions Source #
Instance details Defined in Amazonka.QuickSight.DescribeDashboardPermissions Methods toPath :: DescribeDashboardPermissions -> ByteString #
ToQuery DescribeDashboardPermissions Source #
Instance details Defined in Amazonka.QuickSight.DescribeDashboardPermissions Methods toQuery :: DescribeDashboardPermissions -> QueryString #
AWSRequest DescribeDashboardPermissions Source #
Instance details Defined in Amazonka.QuickSight.DescribeDashboardPermissions Associated Types type AWSResponse DescribeDashboardPermissions # Methods request :: (Service -> Service) -> DescribeDashboardPermissions -> Request DescribeDashboardPermissions # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeDashboardPermissions -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeDashboardPermissions))) #
Generic DescribeDashboardPermissions Source #
Instance details Defined in Amazonka.QuickSight.DescribeDashboardPermissions Associated Types type Rep DescribeDashboardPermissions :: Type -> Type # Methods from :: DescribeDashboardPermissions -> Rep DescribeDashboardPermissions x # to :: Rep DescribeDashboardPermissions x -> DescribeDashboardPermissions #
Read DescribeDashboardPermissions Source #
Instance details Defined in Amazonka.QuickSight.DescribeDashboardPermissions Methods readsPrec :: Int -> ReadS DescribeDashboardPermissions # readList :: ReadS [DescribeDashboardPermissions] # readPrec :: ReadPrec DescribeDashboardPermissions # readListPrec :: ReadPrec [DescribeDashboardPermissions] #
Show DescribeDashboardPermissions Source #
Instance details Defined in Amazonka.QuickSight.DescribeDashboardPermissions Methods showsPrec :: Int -> DescribeDashboardPermissions -> ShowS # show :: DescribeDashboardPermissions -> String # showList :: [DescribeDashboardPermissions] -> ShowS #
NFData DescribeDashboardPermissions Source #
Instance details Defined in Amazonka.QuickSight.DescribeDashboardPermissions Methods rnf :: DescribeDashboardPermissions -> () #
Eq DescribeDashboardPermissions Source #
Instance details Defined in Amazonka.QuickSight.DescribeDashboardPermissions Methods (==) :: DescribeDashboardPermissions -> DescribeDashboardPermissions -> Bool # (/=) :: DescribeDashboardPermissions -> DescribeDashboardPermissions -> Bool #
Hashable DescribeDashboardPermissions Source #
Instance details Defined in Amazonka.QuickSight.DescribeDashboardPermissions Methods hashWithSalt :: Int -> DescribeDashboardPermissions -> Int # hash :: DescribeDashboardPermissions -> Int #
type AWSResponse DescribeDashboardPermissions Source #
Instance details Defined in Amazonka.QuickSight.DescribeDashboardPermissions type AWSResponse DescribeDashboardPermissions = DescribeDashboardPermissionsResponse
type Rep DescribeDashboardPermissions Source #
Instance details Defined in Amazonka.QuickSight.DescribeDashboardPermissions type Rep DescribeDashboardPermissions = D1 ('MetaData "DescribeDashboardPermissions" "Amazonka.QuickSight.DescribeDashboardPermissions" "amazonka-quicksight-2.0-9P6nV9koXl6GTlt8ZjS7C9" 'False) (C1 ('MetaCons "DescribeDashboardPermissions'" 'PrefixI 'True) (S1 ('MetaSel ('Just "awsAccountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "dashboardId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeDashboardPermissions Source #

Arguments

:: Text	`DescribeDashboardPermissions`
-> Text	`DescribeDashboardPermissions`
-> DescribeDashboardPermissions

Create a value of DescribeDashboardPermissions with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeDashboardPermissions, describeDashboardPermissions_awsAccountId - The ID of the Amazon Web Services account that contains the dashboard that you're describing permissions for.

DescribeDashboardPermissions, describeDashboardPermissions_dashboardId - The ID for the dashboard, also added to the IAM policy.

Request Lenses

describeDashboardPermissions_awsAccountId :: Lens' DescribeDashboardPermissions Text Source #

The ID of the Amazon Web Services account that contains the dashboard that you're describing permissions for.

describeDashboardPermissions_dashboardId :: Lens' DescribeDashboardPermissions Text Source #

The ID for the dashboard, also added to the IAM policy.

Destructuring the Response

data DescribeDashboardPermissionsResponse Source #

See: newDescribeDashboardPermissionsResponse smart constructor.

Constructors

DescribeDashboardPermissionsResponse'

Fields

dashboardArn :: Maybe Text
The Amazon Resource Name (ARN) of the dashboard.
dashboardId :: Maybe Text
The ID for the dashboard.
linkSharingConfiguration :: Maybe LinkSharingConfiguration
A structure that contains the configuration of a shareable link that grants access to the dashboard. Your users can use the link to view and interact with the dashboard, if the dashboard has been shared with them. For more information about sharing dashboards, see Sharing Dashboards.
permissions :: Maybe (NonEmpty ResourcePermission)
A structure that contains the permissions for the dashboard.
requestId :: Maybe Text
The Amazon Web Services request ID for this operation.
status :: Int
The HTTP status of the request.

Instances

Instances details

Generic DescribeDashboardPermissionsResponse Source #
Instance details Defined in Amazonka.QuickSight.DescribeDashboardPermissions Associated Types type Rep DescribeDashboardPermissionsResponse :: Type -> Type # Methods from :: DescribeDashboardPermissionsResponse -> Rep DescribeDashboardPermissionsResponse x # to :: Rep DescribeDashboardPermissionsResponse x -> DescribeDashboardPermissionsResponse #
Read DescribeDashboardPermissionsResponse Source #
Instance details Defined in Amazonka.QuickSight.DescribeDashboardPermissions Methods readsPrec :: Int -> ReadS DescribeDashboardPermissionsResponse # readList :: ReadS [DescribeDashboardPermissionsResponse] # readPrec :: ReadPrec DescribeDashboardPermissionsResponse # readListPrec :: ReadPrec [DescribeDashboardPermissionsResponse] #
Show DescribeDashboardPermissionsResponse Source #
Instance details Defined in Amazonka.QuickSight.DescribeDashboardPermissions Methods showsPrec :: Int -> DescribeDashboardPermissionsResponse -> ShowS # show :: DescribeDashboardPermissionsResponse -> String # showList :: [DescribeDashboardPermissionsResponse] -> ShowS #
NFData DescribeDashboardPermissionsResponse Source #
Instance details Defined in Amazonka.QuickSight.DescribeDashboardPermissions Methods rnf :: DescribeDashboardPermissionsResponse -> () #
Eq DescribeDashboardPermissionsResponse Source #
Instance details Defined in Amazonka.QuickSight.DescribeDashboardPermissions Methods (==) :: DescribeDashboardPermissionsResponse -> DescribeDashboardPermissionsResponse -> Bool # (/=) :: DescribeDashboardPermissionsResponse -> DescribeDashboardPermissionsResponse -> Bool #
type Rep DescribeDashboardPermissionsResponse Source #
Instance details Defined in Amazonka.QuickSight.DescribeDashboardPermissions type Rep DescribeDashboardPermissionsResponse = D1 ('MetaData "DescribeDashboardPermissionsResponse" "Amazonka.QuickSight.DescribeDashboardPermissions" "amazonka-quicksight-2.0-9P6nV9koXl6GTlt8ZjS7C9" 'False) (C1 ('MetaCons "DescribeDashboardPermissionsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dashboardArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "dashboardId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "linkSharingConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LinkSharingConfiguration)))) :: (S1 ('MetaSel ('Just "permissions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty ResourcePermission))) :: (S1 ('MetaSel ('Just "requestId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newDescribeDashboardPermissionsResponse Source #

Arguments

:: Int	`DescribeDashboardPermissionsResponse`
-> DescribeDashboardPermissionsResponse

Create a value of DescribeDashboardPermissionsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:dashboardArn:DescribeDashboardPermissionsResponse', describeDashboardPermissionsResponse_dashboardArn - The Amazon Resource Name (ARN) of the dashboard.

DescribeDashboardPermissions, describeDashboardPermissionsResponse_dashboardId - The ID for the dashboard.

$sel:linkSharingConfiguration:DescribeDashboardPermissionsResponse', describeDashboardPermissionsResponse_linkSharingConfiguration - A structure that contains the configuration of a shareable link that grants access to the dashboard. Your users can use the link to view and interact with the dashboard, if the dashboard has been shared with them. For more information about sharing dashboards, see Sharing Dashboards.

DescribeDashboardPermissionsResponse, describeDashboardPermissionsResponse_permissions - A structure that contains the permissions for the dashboard.

$sel:requestId:DescribeDashboardPermissionsResponse', describeDashboardPermissionsResponse_requestId - The Amazon Web Services request ID for this operation.

DescribeDashboardPermissionsResponse, describeDashboardPermissionsResponse_status - The HTTP status of the request.

Response Lenses

describeDashboardPermissionsResponse_dashboardArn :: Lens' DescribeDashboardPermissionsResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the dashboard.

describeDashboardPermissionsResponse_dashboardId :: Lens' DescribeDashboardPermissionsResponse (Maybe Text) Source #

The ID for the dashboard.

describeDashboardPermissionsResponse_linkSharingConfiguration :: Lens' DescribeDashboardPermissionsResponse (Maybe LinkSharingConfiguration) Source #

A structure that contains the configuration of a shareable link that grants access to the dashboard. Your users can use the link to view and interact with the dashboard, if the dashboard has been shared with them. For more information about sharing dashboards, see Sharing Dashboards.

describeDashboardPermissionsResponse_permissions :: Lens' DescribeDashboardPermissionsResponse (Maybe (NonEmpty ResourcePermission)) Source #

A structure that contains the permissions for the dashboard.

describeDashboardPermissionsResponse_requestId :: Lens' DescribeDashboardPermissionsResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

describeDashboardPermissionsResponse_status :: Lens' DescribeDashboardPermissionsResponse Int Source #

The HTTP status of the request.