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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Provides a detailed description of the definition of an analysis.

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

Synopsis

Creating a Request

data DescribeAnalysisDefinition Source #

See: newDescribeAnalysisDefinition smart constructor.

Constructors

DescribeAnalysisDefinition'
Fields awsAccountId :: Text The ID of the Amazon Web Services account that contains the analysis. You must be using the Amazon Web Services account that the analysis is in. analysisId :: Text The ID of the analysis that you're describing. The ID is part of the URL of the analysis.

Instances

Instances details

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

newDescribeAnalysisDefinition Source #

Arguments

:: Text	`DescribeAnalysisDefinition`
-> Text	`DescribeAnalysisDefinition`
-> DescribeAnalysisDefinition

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

DescribeAnalysisDefinition, describeAnalysisDefinition_awsAccountId - The ID of the Amazon Web Services account that contains the analysis. You must be using the Amazon Web Services account that the analysis is in.

DescribeAnalysisDefinition, describeAnalysisDefinition_analysisId - The ID of the analysis that you're describing. The ID is part of the URL of the analysis.

Request Lenses

describeAnalysisDefinition_awsAccountId :: Lens' DescribeAnalysisDefinition Text Source #

The ID of the Amazon Web Services account that contains the analysis. You must be using the Amazon Web Services account that the analysis is in.

describeAnalysisDefinition_analysisId :: Lens' DescribeAnalysisDefinition Text Source #

The ID of the analysis that you're describing. The ID is part of the URL of the analysis.

Destructuring the Response

data DescribeAnalysisDefinitionResponse Source #

See: newDescribeAnalysisDefinitionResponse smart constructor.

Constructors

DescribeAnalysisDefinitionResponse'

Fields

analysisId :: Maybe Text
The ID of the analysis described.
definition :: Maybe AnalysisDefinition
The definition of an analysis.
A definition is the data model of all features in a Dashboard, Template, or Analysis.
errors :: Maybe (NonEmpty AnalysisError)
Errors associated with the analysis.
name :: Maybe Text
The descriptive name of the analysis.
requestId :: Maybe Text
The Amazon Web Services request ID for this operation.

resourceStatus :: Maybe ResourceStatus

Status associated with the analysis.

```
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 analysis.
status :: Int
The HTTP status of the request.

Instances

Instances details

Generic DescribeAnalysisDefinitionResponse Source #
Instance details Defined in Amazonka.QuickSight.DescribeAnalysisDefinition Associated Types type Rep DescribeAnalysisDefinitionResponse :: Type -> Type # Methods from :: DescribeAnalysisDefinitionResponse -> Rep DescribeAnalysisDefinitionResponse x # to :: Rep DescribeAnalysisDefinitionResponse x -> DescribeAnalysisDefinitionResponse #
Show DescribeAnalysisDefinitionResponse Source #
Instance details Defined in Amazonka.QuickSight.DescribeAnalysisDefinition Methods showsPrec :: Int -> DescribeAnalysisDefinitionResponse -> ShowS # show :: DescribeAnalysisDefinitionResponse -> String # showList :: [DescribeAnalysisDefinitionResponse] -> ShowS #
NFData DescribeAnalysisDefinitionResponse Source #
Instance details Defined in Amazonka.QuickSight.DescribeAnalysisDefinition Methods rnf :: DescribeAnalysisDefinitionResponse -> () #
Eq DescribeAnalysisDefinitionResponse Source #
Instance details Defined in Amazonka.QuickSight.DescribeAnalysisDefinition Methods (==) :: DescribeAnalysisDefinitionResponse -> DescribeAnalysisDefinitionResponse -> Bool # (/=) :: DescribeAnalysisDefinitionResponse -> DescribeAnalysisDefinitionResponse -> Bool #
type Rep DescribeAnalysisDefinitionResponse Source #
Instance details Defined in Amazonka.QuickSight.DescribeAnalysisDefinition type Rep DescribeAnalysisDefinitionResponse = D1 ('MetaData "DescribeAnalysisDefinitionResponse" "Amazonka.QuickSight.DescribeAnalysisDefinition" "amazonka-quicksight-2.0-9P6nV9koXl6GTlt8ZjS7C9" 'False) (C1 ('MetaCons "DescribeAnalysisDefinitionResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "analysisId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "definition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AnalysisDefinition))) :: (S1 ('MetaSel ('Just "errors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty AnalysisError))) :: 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)))))

newDescribeAnalysisDefinitionResponse Source #

Arguments

:: Int	`DescribeAnalysisDefinitionResponse`
-> DescribeAnalysisDefinitionResponse

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

DescribeAnalysisDefinition, describeAnalysisDefinitionResponse_analysisId - The ID of the analysis described.

$sel:definition:DescribeAnalysisDefinitionResponse', describeAnalysisDefinitionResponse_definition - The definition of an analysis.

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

DescribeAnalysisDefinitionResponse, describeAnalysisDefinitionResponse_errors - Errors associated with the analysis.

DescribeAnalysisDefinitionResponse, describeAnalysisDefinitionResponse_name - The descriptive name of the analysis.

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

$sel:resourceStatus:DescribeAnalysisDefinitionResponse', describeAnalysisDefinitionResponse_resourceStatus - Status associated with the analysis.

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

DescribeAnalysisDefinitionResponse, describeAnalysisDefinitionResponse_themeArn - The ARN of the theme of the analysis.

DescribeAnalysisDefinitionResponse, describeAnalysisDefinitionResponse_status - The HTTP status of the request.

Response Lenses

describeAnalysisDefinitionResponse_analysisId :: Lens' DescribeAnalysisDefinitionResponse (Maybe Text) Source #

The ID of the analysis described.

describeAnalysisDefinitionResponse_definition :: Lens' DescribeAnalysisDefinitionResponse (Maybe AnalysisDefinition) Source #

The definition of an analysis.

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

describeAnalysisDefinitionResponse_errors :: Lens' DescribeAnalysisDefinitionResponse (Maybe (NonEmpty AnalysisError)) Source #

Errors associated with the analysis.

describeAnalysisDefinitionResponse_name :: Lens' DescribeAnalysisDefinitionResponse (Maybe Text) Source #

The descriptive name of the analysis.

describeAnalysisDefinitionResponse_requestId :: Lens' DescribeAnalysisDefinitionResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

describeAnalysisDefinitionResponse_resourceStatus :: Lens' DescribeAnalysisDefinitionResponse (Maybe ResourceStatus) Source #

Status associated with the analysis.

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

describeAnalysisDefinitionResponse_themeArn :: Lens' DescribeAnalysisDefinitionResponse (Maybe Text) Source #

The ARN of the theme of the analysis.

describeAnalysisDefinitionResponse_status :: Lens' DescribeAnalysisDefinitionResponse Int Source #

The HTTP status of the request.