Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.QuickSight.DescribeTemplate

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes a template's metadata.

Synopsis

data DescribeTemplate = DescribeTemplate' {
- aliasName :: Maybe Text
- versionNumber :: Maybe Natural
- awsAccountId :: Text
- templateId :: Text
}
newDescribeTemplate :: Text -> Text -> DescribeTemplate
describeTemplate_aliasName :: Lens' DescribeTemplate (Maybe Text)
describeTemplate_versionNumber :: Lens' DescribeTemplate (Maybe Natural)
describeTemplate_awsAccountId :: Lens' DescribeTemplate Text
describeTemplate_templateId :: Lens' DescribeTemplate Text
data DescribeTemplateResponse = DescribeTemplateResponse' {
- requestId :: Maybe Text
- template :: Maybe Template
- status :: Int
}
newDescribeTemplateResponse :: Int -> DescribeTemplateResponse
describeTemplateResponse_requestId :: Lens' DescribeTemplateResponse (Maybe Text)
describeTemplateResponse_template :: Lens' DescribeTemplateResponse (Maybe Template)
describeTemplateResponse_status :: Lens' DescribeTemplateResponse Int

Creating a Request

data DescribeTemplate Source #

See: newDescribeTemplate smart constructor.

Constructors

DescribeTemplate'

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
(Optional) The number for the version to describe. If a VersionNumber parameter value isn't provided, the latest version of the template is described.
awsAccountId :: Text
The ID of the Amazon Web Services account that contains the template that you're describing.
templateId :: Text
The ID for the template.

Instances

Instances details

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

newDescribeTemplate Source #

Arguments

:: Text	`$sel:awsAccountId:DescribeTemplate'`
-> Text	`$sel:templateId:DescribeTemplate'`
-> DescribeTemplate

Create a value of DescribeTemplate 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:aliasName:DescribeTemplate', describeTemplate_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.

$sel:versionNumber:DescribeTemplate', describeTemplate_versionNumber - (Optional) The number for the version to describe. If a VersionNumber parameter value isn't provided, the latest version of the template is described.

$sel:awsAccountId:DescribeTemplate', describeTemplate_awsAccountId - The ID of the Amazon Web Services account that contains the template that you're describing.

$sel:templateId:DescribeTemplate', describeTemplate_templateId - The ID for the template.

Request Lenses

describeTemplate_aliasName :: Lens' DescribeTemplate (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.

describeTemplate_versionNumber :: Lens' DescribeTemplate (Maybe Natural) Source #

(Optional) The number for the version to describe. If a VersionNumber parameter value isn't provided, the latest version of the template is described.

describeTemplate_awsAccountId :: Lens' DescribeTemplate Text Source #

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

describeTemplate_templateId :: Lens' DescribeTemplate Text Source #

The ID for the template.

Destructuring the Response

data DescribeTemplateResponse Source #

See: newDescribeTemplateResponse smart constructor.

Constructors

DescribeTemplateResponse'
Fields requestId :: Maybe Text The Amazon Web Services request ID for this operation. template :: Maybe Template The template structure for the object you want to describe. status :: Int The HTTP status of the request.

Instances

Instances details

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

newDescribeTemplateResponse Source #

Arguments

:: Int	`$sel:status:DescribeTemplateResponse'`
-> DescribeTemplateResponse

Create a value of DescribeTemplateResponse 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:requestId:DescribeTemplateResponse', describeTemplateResponse_requestId - The Amazon Web Services request ID for this operation.

$sel:template:DescribeTemplateResponse', describeTemplateResponse_template - The template structure for the object you want to describe.

$sel:status:DescribeTemplateResponse', describeTemplateResponse_status - The HTTP status of the request.

Response Lenses

describeTemplateResponse_requestId :: Lens' DescribeTemplateResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

describeTemplateResponse_template :: Lens' DescribeTemplateResponse (Maybe Template) Source #

The template structure for the object you want to describe.

describeTemplateResponse_status :: Lens' DescribeTemplateResponse Int Source #

The HTTP status of the request.