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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Provides a detailed description of the definition of a template.

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

Synopsis

Creating a Request

data DescribeTemplateDefinition Source #

See: newDescribeTemplateDefinition smart constructor.

Constructors

DescribeTemplateDefinition'

Fields

aliasName :: Maybe Text
The alias of the template that you want to describe. If you name a specific alias, you describe the version that the alias points to. You can specify the latest version of the template by providing the keyword $LATEST in the AliasName parameter. The keyword $PUBLISHED doesn't apply to templates.
versionNumber :: Maybe Natural
The version number of the template.
awsAccountId :: Text
The ID of the Amazon Web Services account that contains the template. You must be using the Amazon Web Services account that the template is in.
templateId :: Text
The ID of the template that you're describing.

Instances

Instances details

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

newDescribeTemplateDefinition Source #

Arguments

:: Text	`DescribeTemplateDefinition`
-> Text	`DescribeTemplateDefinition`
-> DescribeTemplateDefinition

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

DescribeTemplateDefinition, describeTemplateDefinition_aliasName - The alias of the template that you want to describe. If you name a specific alias, you describe the version that the alias points to. You can specify the latest version of the template by providing the keyword $LATEST in the AliasName parameter. The keyword $PUBLISHED doesn't apply to templates.

DescribeTemplateDefinition, describeTemplateDefinition_versionNumber - The version number of the template.

DescribeTemplateDefinition, describeTemplateDefinition_awsAccountId - The ID of the Amazon Web Services account that contains the template. You must be using the Amazon Web Services account that the template is in.

DescribeTemplateDefinition, describeTemplateDefinition_templateId - The ID of the template that you're describing.

Request Lenses

describeTemplateDefinition_aliasName :: Lens' DescribeTemplateDefinition (Maybe Text) Source #

The alias of the template that you want to describe. If you name a specific alias, you describe the version that the alias points to. You can specify the latest version of the template by providing the keyword $LATEST in the AliasName parameter. The keyword $PUBLISHED doesn't apply to templates.

describeTemplateDefinition_versionNumber :: Lens' DescribeTemplateDefinition (Maybe Natural) Source #

The version number of the template.

describeTemplateDefinition_awsAccountId :: Lens' DescribeTemplateDefinition Text Source #

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

describeTemplateDefinition_templateId :: Lens' DescribeTemplateDefinition Text Source #

The ID of the template that you're describing.

Destructuring the Response

data DescribeTemplateDefinitionResponse Source #

See: newDescribeTemplateDefinitionResponse smart constructor.

Constructors

DescribeTemplateDefinitionResponse'

Fields

definition :: Maybe TemplateVersionDefinition
The definition of the template.
A definition is the data model of all features in a Dashboard, Template, or Analysis.
errors :: Maybe (NonEmpty TemplateError)
Errors associated with the template version.
name :: Maybe Text
The descriptive name of the template.
requestId :: Maybe Text
The Amazon Web Services request ID for this operation.

resourceStatus :: Maybe ResourceStatus

Status associated with the template.

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

templateId :: Maybe Text
The ID of the template described.
themeArn :: Maybe Text
The ARN of the theme of the template.
status :: Int
The HTTP status of the request.

Instances

Instances details

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

newDescribeTemplateDefinitionResponse Source #

Arguments

:: Int	`DescribeTemplateDefinitionResponse`
-> DescribeTemplateDefinitionResponse

Create a value of DescribeTemplateDefinitionResponse 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:definition:DescribeTemplateDefinitionResponse', describeTemplateDefinitionResponse_definition - The definition of the template.

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

DescribeTemplateDefinitionResponse, describeTemplateDefinitionResponse_errors - Errors associated with the template version.

DescribeTemplateDefinitionResponse, describeTemplateDefinitionResponse_name - The descriptive name of the template.

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

$sel:resourceStatus:DescribeTemplateDefinitionResponse', describeTemplateDefinitionResponse_resourceStatus - Status associated with the template.

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

DescribeTemplateDefinition, describeTemplateDefinitionResponse_templateId - The ID of the template described.

DescribeTemplateDefinitionResponse, describeTemplateDefinitionResponse_themeArn - The ARN of the theme of the template.

DescribeTemplateDefinitionResponse, describeTemplateDefinitionResponse_status - The HTTP status of the request.

Response Lenses

describeTemplateDefinitionResponse_definition :: Lens' DescribeTemplateDefinitionResponse (Maybe TemplateVersionDefinition) Source #

The definition of the template.

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

describeTemplateDefinitionResponse_errors :: Lens' DescribeTemplateDefinitionResponse (Maybe (NonEmpty TemplateError)) Source #

Errors associated with the template version.

describeTemplateDefinitionResponse_name :: Lens' DescribeTemplateDefinitionResponse (Maybe Text) Source #

The descriptive name of the template.

describeTemplateDefinitionResponse_requestId :: Lens' DescribeTemplateDefinitionResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

describeTemplateDefinitionResponse_resourceStatus :: Lens' DescribeTemplateDefinitionResponse (Maybe ResourceStatus) Source #

Status associated with the template.

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

describeTemplateDefinitionResponse_templateId :: Lens' DescribeTemplateDefinitionResponse (Maybe Text) Source #

The ID of the template described.

describeTemplateDefinitionResponse_themeArn :: Lens' DescribeTemplateDefinitionResponse (Maybe Text) Source #

The ARN of the theme of the template.

describeTemplateDefinitionResponse_status :: Lens' DescribeTemplateDefinitionResponse Int Source #

The HTTP status of the request.