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.DescribeDashboard

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Provides a summary for a dashboard.

Synopsis

data DescribeDashboard = DescribeDashboard' {
- aliasName :: Maybe Text
- versionNumber :: Maybe Natural
- awsAccountId :: Text
- dashboardId :: Text
}
newDescribeDashboard :: Text -> Text -> DescribeDashboard
describeDashboard_aliasName :: Lens' DescribeDashboard (Maybe Text)
describeDashboard_versionNumber :: Lens' DescribeDashboard (Maybe Natural)
describeDashboard_awsAccountId :: Lens' DescribeDashboard Text
describeDashboard_dashboardId :: Lens' DescribeDashboard Text
data DescribeDashboardResponse = DescribeDashboardResponse' {
- dashboard :: Maybe Dashboard
- requestId :: Maybe Text
- status :: Int
}
newDescribeDashboardResponse :: Int -> DescribeDashboardResponse
describeDashboardResponse_dashboard :: Lens' DescribeDashboardResponse (Maybe Dashboard)
describeDashboardResponse_requestId :: Lens' DescribeDashboardResponse (Maybe Text)
describeDashboardResponse_status :: Lens' DescribeDashboardResponse Int

Creating a Request

data DescribeDashboard Source #

See: newDescribeDashboard smart constructor.

Constructors

DescribeDashboard'
Fields aliasName :: Maybe Text The alias name. versionNumber :: Maybe Natural The version number for the dashboard. If a version number isn't passed, the latest published dashboard version is described. awsAccountId :: Text The ID of the Amazon Web Services account that contains the dashboard that you're describing. dashboardId :: Text The ID for the dashboard.

Instances

Instances details

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

newDescribeDashboard Source #

Arguments

:: Text	`DescribeDashboard`
-> Text	`DescribeDashboard`
-> DescribeDashboard

Create a value of DescribeDashboard 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:

DescribeDashboard, describeDashboard_aliasName - The alias name.

DescribeDashboard, describeDashboard_versionNumber - The version number for the dashboard. If a version number isn't passed, the latest published dashboard version is described.

DescribeDashboard, describeDashboard_awsAccountId - The ID of the Amazon Web Services account that contains the dashboard that you're describing.

DescribeDashboard, describeDashboard_dashboardId - The ID for the dashboard.

Request Lenses

describeDashboard_aliasName :: Lens' DescribeDashboard (Maybe Text) Source #

The alias name.

describeDashboard_versionNumber :: Lens' DescribeDashboard (Maybe Natural) Source #

The version number for the dashboard. If a version number isn't passed, the latest published dashboard version is described.

describeDashboard_awsAccountId :: Lens' DescribeDashboard Text Source #

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

describeDashboard_dashboardId :: Lens' DescribeDashboard Text Source #

The ID for the dashboard.

Destructuring the Response

data DescribeDashboardResponse Source #

See: newDescribeDashboardResponse smart constructor.

Constructors

DescribeDashboardResponse'
Fields dashboard :: Maybe Dashboard Information about the dashboard. requestId :: Maybe Text The Amazon Web Services request ID for this operation. status :: Int The HTTP status of this request.

Instances

Instances details

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

newDescribeDashboardResponse Source #

Arguments

:: Int	`DescribeDashboardResponse`
-> DescribeDashboardResponse

Create a value of DescribeDashboardResponse 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:

DescribeDashboardResponse, describeDashboardResponse_dashboard - Information about the dashboard.

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

DescribeDashboardResponse, describeDashboardResponse_status - The HTTP status of this request.

Response Lenses

describeDashboardResponse_dashboard :: Lens' DescribeDashboardResponse (Maybe Dashboard) Source #

Information about the dashboard.

describeDashboardResponse_requestId :: Lens' DescribeDashboardResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

describeDashboardResponse_status :: Lens' DescribeDashboardResponse Int Source #

The HTTP status of this request.