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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Provides a detailed description of the definition of a dashboard.

If you do not need to know details about the content of a dashboard, for instance if you are trying to check the status of a recently created or updated dashboard, use the DescribeDashboard instead.

Synopsis

Creating a Request

data DescribeDashboardDefinition Source #

See: newDescribeDashboardDefinition smart constructor.

Constructors

DescribeDashboardDefinition'
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 DescribeDashboardDefinition Source #
Instance details Defined in Amazonka.QuickSight.DescribeDashboardDefinition Methods toHeaders :: DescribeDashboardDefinition -> [Header] #
ToPath DescribeDashboardDefinition Source #
Instance details Defined in Amazonka.QuickSight.DescribeDashboardDefinition Methods toPath :: DescribeDashboardDefinition -> ByteString #
ToQuery DescribeDashboardDefinition Source #
Instance details Defined in Amazonka.QuickSight.DescribeDashboardDefinition Methods toQuery :: DescribeDashboardDefinition -> QueryString #
AWSRequest DescribeDashboardDefinition Source #
Instance details Defined in Amazonka.QuickSight.DescribeDashboardDefinition Associated Types type AWSResponse DescribeDashboardDefinition # Methods request :: (Service -> Service) -> DescribeDashboardDefinition -> Request DescribeDashboardDefinition # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeDashboardDefinition -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeDashboardDefinition))) #
Generic DescribeDashboardDefinition Source #
Instance details Defined in Amazonka.QuickSight.DescribeDashboardDefinition Associated Types type Rep DescribeDashboardDefinition :: Type -> Type # Methods from :: DescribeDashboardDefinition -> Rep DescribeDashboardDefinition x # to :: Rep DescribeDashboardDefinition x -> DescribeDashboardDefinition #
Read DescribeDashboardDefinition Source #
Instance details Defined in Amazonka.QuickSight.DescribeDashboardDefinition Methods readsPrec :: Int -> ReadS DescribeDashboardDefinition # readList :: ReadS [DescribeDashboardDefinition] # readPrec :: ReadPrec DescribeDashboardDefinition # readListPrec :: ReadPrec [DescribeDashboardDefinition] #
Show DescribeDashboardDefinition Source #
Instance details Defined in Amazonka.QuickSight.DescribeDashboardDefinition Methods showsPrec :: Int -> DescribeDashboardDefinition -> ShowS # show :: DescribeDashboardDefinition -> String # showList :: [DescribeDashboardDefinition] -> ShowS #
NFData DescribeDashboardDefinition Source #
Instance details Defined in Amazonka.QuickSight.DescribeDashboardDefinition Methods rnf :: DescribeDashboardDefinition -> () #
Eq DescribeDashboardDefinition Source #
Instance details Defined in Amazonka.QuickSight.DescribeDashboardDefinition Methods (==) :: DescribeDashboardDefinition -> DescribeDashboardDefinition -> Bool # (/=) :: DescribeDashboardDefinition -> DescribeDashboardDefinition -> Bool #
Hashable DescribeDashboardDefinition Source #
Instance details Defined in Amazonka.QuickSight.DescribeDashboardDefinition Methods hashWithSalt :: Int -> DescribeDashboardDefinition -> Int # hash :: DescribeDashboardDefinition -> Int #
type AWSResponse DescribeDashboardDefinition Source #
Instance details Defined in Amazonka.QuickSight.DescribeDashboardDefinition type AWSResponse DescribeDashboardDefinition = DescribeDashboardDefinitionResponse
type Rep DescribeDashboardDefinition Source #
Instance details Defined in Amazonka.QuickSight.DescribeDashboardDefinition type Rep DescribeDashboardDefinition = D1 ('MetaData "DescribeDashboardDefinition" "Amazonka.QuickSight.DescribeDashboardDefinition" "amazonka-quicksight-2.0-9P6nV9koXl6GTlt8ZjS7C9" 'False) (C1 ('MetaCons "DescribeDashboardDefinition'" '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))))

newDescribeDashboardDefinition Source #

Arguments

:: Text	`DescribeDashboardDefinition`
-> Text	`DescribeDashboardDefinition`
-> DescribeDashboardDefinition

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

DescribeDashboardDefinition, describeDashboardDefinition_aliasName - The alias name.

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

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

DescribeDashboardDefinition, describeDashboardDefinition_dashboardId - The ID for the dashboard.

Request Lenses

describeDashboardDefinition_aliasName :: Lens' DescribeDashboardDefinition (Maybe Text) Source #

The alias name.

describeDashboardDefinition_versionNumber :: Lens' DescribeDashboardDefinition (Maybe Natural) Source #

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

describeDashboardDefinition_awsAccountId :: Lens' DescribeDashboardDefinition Text Source #

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

describeDashboardDefinition_dashboardId :: Lens' DescribeDashboardDefinition Text Source #

The ID for the dashboard.

Destructuring the Response

data DescribeDashboardDefinitionResponse Source #

See: newDescribeDashboardDefinitionResponse smart constructor.

Constructors

DescribeDashboardDefinitionResponse'

Fields

dashboardId :: Maybe Text
The ID of the dashboard described.
definition :: Maybe DashboardVersionDefinition
The definition of a dashboard.
A definition is the data model of all features in a Dashboard, Template, or Analysis.
errors :: Maybe (NonEmpty DashboardError)
Errors associated with this dashboard version.
name :: Maybe Text
The display name of the dashboard.
requestId :: Maybe Text
The Amazon Web Services request ID for this operation.

resourceStatus :: Maybe ResourceStatus

Status associated with the dashboard version.

```
CREATION_IN_PROGRESS
```
```
CREATION_SUCCESSFUL
```
```
CREATION_FAILED
```
```
UPDATE_IN_PROGRESS
```
```
UPDATE_SUCCESSFUL
```
```
UPDATE_FAILED
```
```
DELETED
```

themeArn :: Maybe Text
The ARN of the theme of the dashboard.
status :: Int
The HTTP status of the request.

Instances

Instances details

Generic DescribeDashboardDefinitionResponse Source #
Instance details Defined in Amazonka.QuickSight.DescribeDashboardDefinition Associated Types type Rep DescribeDashboardDefinitionResponse :: Type -> Type # Methods from :: DescribeDashboardDefinitionResponse -> Rep DescribeDashboardDefinitionResponse x # to :: Rep DescribeDashboardDefinitionResponse x -> DescribeDashboardDefinitionResponse #
Show DescribeDashboardDefinitionResponse Source #
Instance details Defined in Amazonka.QuickSight.DescribeDashboardDefinition Methods showsPrec :: Int -> DescribeDashboardDefinitionResponse -> ShowS # show :: DescribeDashboardDefinitionResponse -> String # showList :: [DescribeDashboardDefinitionResponse] -> ShowS #
NFData DescribeDashboardDefinitionResponse Source #
Instance details Defined in Amazonka.QuickSight.DescribeDashboardDefinition Methods rnf :: DescribeDashboardDefinitionResponse -> () #
Eq DescribeDashboardDefinitionResponse Source #
Instance details Defined in Amazonka.QuickSight.DescribeDashboardDefinition Methods (==) :: DescribeDashboardDefinitionResponse -> DescribeDashboardDefinitionResponse -> Bool # (/=) :: DescribeDashboardDefinitionResponse -> DescribeDashboardDefinitionResponse -> Bool #
type Rep DescribeDashboardDefinitionResponse Source #
Instance details Defined in Amazonka.QuickSight.DescribeDashboardDefinition type Rep DescribeDashboardDefinitionResponse = D1 ('MetaData "DescribeDashboardDefinitionResponse" "Amazonka.QuickSight.DescribeDashboardDefinition" "amazonka-quicksight-2.0-9P6nV9koXl6GTlt8ZjS7C9" 'False) (C1 ('MetaCons "DescribeDashboardDefinitionResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "dashboardId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "definition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DashboardVersionDefinition))) :: (S1 ('MetaSel ('Just "errors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DashboardError))) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "requestId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "resourceStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ResourceStatus))) :: (S1 ('MetaSel ('Just "themeArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newDescribeDashboardDefinitionResponse Source #

Arguments

:: Int	`DescribeDashboardDefinitionResponse`
-> DescribeDashboardDefinitionResponse

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

DescribeDashboardDefinition, describeDashboardDefinitionResponse_dashboardId - The ID of the dashboard described.

$sel:definition:DescribeDashboardDefinitionResponse', describeDashboardDefinitionResponse_definition - The definition of a dashboard.

A definition is the data model of all features in a Dashboard, Template, or Analysis.

DescribeDashboardDefinitionResponse, describeDashboardDefinitionResponse_errors - Errors associated with this dashboard version.

DescribeDashboardDefinitionResponse, describeDashboardDefinitionResponse_name - The display name of the dashboard.

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

$sel:resourceStatus:DescribeDashboardDefinitionResponse', describeDashboardDefinitionResponse_resourceStatus - Status associated with the dashboard version.

```
CREATION_IN_PROGRESS
```
```
CREATION_SUCCESSFUL
```
```
CREATION_FAILED
```
```
UPDATE_IN_PROGRESS
```
```
UPDATE_SUCCESSFUL
```
```
UPDATE_FAILED
```
```
DELETED
```

DescribeDashboardDefinitionResponse, describeDashboardDefinitionResponse_themeArn - The ARN of the theme of the dashboard.

DescribeDashboardDefinitionResponse, describeDashboardDefinitionResponse_status - The HTTP status of the request.

Response Lenses

describeDashboardDefinitionResponse_dashboardId :: Lens' DescribeDashboardDefinitionResponse (Maybe Text) Source #

The ID of the dashboard described.

describeDashboardDefinitionResponse_definition :: Lens' DescribeDashboardDefinitionResponse (Maybe DashboardVersionDefinition) Source #

The definition of a dashboard.

A definition is the data model of all features in a Dashboard, Template, or Analysis.

describeDashboardDefinitionResponse_errors :: Lens' DescribeDashboardDefinitionResponse (Maybe (NonEmpty DashboardError)) Source #

Errors associated with this dashboard version.

describeDashboardDefinitionResponse_name :: Lens' DescribeDashboardDefinitionResponse (Maybe Text) Source #

The display name of the dashboard.

describeDashboardDefinitionResponse_requestId :: Lens' DescribeDashboardDefinitionResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

describeDashboardDefinitionResponse_resourceStatus :: Lens' DescribeDashboardDefinitionResponse (Maybe ResourceStatus) Source #

Status associated with the dashboard version.

```
CREATION_IN_PROGRESS
```
```
CREATION_SUCCESSFUL
```
```
CREATION_FAILED
```
```
UPDATE_IN_PROGRESS
```
```
UPDATE_SUCCESSFUL
```
```
UPDATE_FAILED
```
```
DELETED
```

describeDashboardDefinitionResponse_themeArn :: Lens' DescribeDashboardDefinitionResponse (Maybe Text) Source #

The ARN of the theme of the dashboard.

describeDashboardDefinitionResponse_status :: Lens' DescribeDashboardDefinitionResponse Int Source #

The HTTP status of the request.