libZSservicesZSamazonka-quicksightZSamazonka-quicksight
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.QuickSight.CreateTemplate

Description

Creates a template from an existing Amazon QuickSight analysis or template. You can use the resulting template to create a dashboard.

A template is an entity in Amazon QuickSight that encapsulates the metadata required to create an analysis and that you can use to create s dashboard. A template adds a layer of abstraction by using placeholders to replace the dataset associated with the analysis. You can use templates to create dashboards by replacing dataset placeholders with datasets that follow the same schema that was used to create the source analysis and template.

Synopsis

Creating a Request

data CreateTemplate Source #

See: newCreateTemplate smart constructor.

Constructors

CreateTemplate' 

Fields

  • versionDescription :: Maybe Text

    A description of the current template version being created. This API operation creates the first version of the template. Every time UpdateTemplate is called, a new version is created. Each version of the template maintains a description of the version in the VersionDescription field.

  • name :: Maybe Text

    A display name for the template.

  • permissions :: Maybe (NonEmpty ResourcePermission)

    A list of resource permissions to be set on the template.

  • tags :: Maybe (NonEmpty Tag)

    Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.

  • awsAccountId :: Text

    The ID for the Amazon Web Services account that the group is in. You use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

  • templateId :: Text

    An ID for the template that you want to create. This template is unique per Amazon Web Services Region; in each Amazon Web Services account.

  • sourceEntity :: TemplateSourceEntity

    The entity that you are using as a source when you create the template. In SourceEntity, you specify the type of object you're using as source: SourceTemplate for a template or SourceAnalysis for an analysis. Both of these require an Amazon Resource Name (ARN). For SourceTemplate, specify the ARN of the source template. For SourceAnalysis, specify the ARN of the source analysis. The SourceTemplate ARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region.

    Use the DataSetReferences entity within SourceTemplate or SourceAnalysis to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.

Instances

Instances details
Eq CreateTemplate Source # 
Instance details

Defined in Amazonka.QuickSight.CreateTemplate

Methods

(==) :: CreateTemplate -> CreateTemplate -> Bool #

(/=) :: CreateTemplate -> CreateTemplate -> Bool #

Read CreateTemplate Source # 
Instance details

Defined in Amazonka.QuickSight.CreateTemplate

Methods

readsPrec :: Int -> ReadS CreateTemplate #

readList :: ReadS [CreateTemplate] #

readPrec :: ReadPrec CreateTemplate #

readListPrec :: ReadPrec [CreateTemplate] #

Show CreateTemplate Source # 
Instance details

Defined in Amazonka.QuickSight.CreateTemplate

Methods

showsPrec :: Int -> CreateTemplate -> ShowS #

show :: CreateTemplate -> String #

showList :: [CreateTemplate] -> ShowS #

Generic CreateTemplate Source # 
Instance details

Defined in Amazonka.QuickSight.CreateTemplate

Associated Types

type Rep CreateTemplate :: Type -> Type #

Methods

from :: CreateTemplate -> Rep CreateTemplate x #

to :: Rep CreateTemplate x -> CreateTemplate #

NFData CreateTemplate Source # 
Instance details

Defined in Amazonka.QuickSight.CreateTemplate

Methods

rnf :: CreateTemplate -> () #

Hashable CreateTemplate Source # 
Instance details

Defined in Amazonka.QuickSight.CreateTemplate

Methods

hashWithSalt :: Int -> CreateTemplate -> Int #

hash :: CreateTemplate -> Int #

ToJSON CreateTemplate Source # 
Instance details

Defined in Amazonka.QuickSight.CreateTemplate

Methods

toJSON :: CreateTemplate -> Value #

toEncoding :: CreateTemplate -> Encoding #

toJSONList :: [CreateTemplate] -> Value #

toEncodingList :: [CreateTemplate] -> Encoding #

AWSRequest CreateTemplate Source # 
Instance details

Defined in Amazonka.QuickSight.CreateTemplate

Associated Types

type AWSResponse CreateTemplate #

Methods

request :: CreateTemplate -> Request CreateTemplate #

response :: MonadResource m => Logger -> Service -> Proxy CreateTemplate -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateTemplate))) #

ToHeaders CreateTemplate Source # 
Instance details

Defined in Amazonka.QuickSight.CreateTemplate

Methods

toHeaders :: CreateTemplate -> [Header] #

ToPath CreateTemplate Source # 
Instance details

Defined in Amazonka.QuickSight.CreateTemplate

Methods

toPath :: CreateTemplate -> ByteString #

ToQuery CreateTemplate Source # 
Instance details

Defined in Amazonka.QuickSight.CreateTemplate

Methods

toQuery :: CreateTemplate -> QueryString #

type Rep CreateTemplate Source # 
Instance details

Defined in Amazonka.QuickSight.CreateTemplate

type Rep CreateTemplate = D1 ('MetaData "CreateTemplate" "Amazonka.QuickSight.CreateTemplate" "libZSservicesZSamazonka-quicksightZSamazonka-quicksight" 'False) (C1 ('MetaCons "CreateTemplate'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "versionDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "permissions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty ResourcePermission))))) :*: ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Tag))) :*: S1 ('MetaSel ('Just "awsAccountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "templateId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "sourceEntity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TemplateSourceEntity)))))
type AWSResponse CreateTemplate Source # 
Instance details

Defined in Amazonka.QuickSight.CreateTemplate

type AWSResponse CreateTemplate = CreateTemplateResponse

newCreateTemplate Source #

Arguments

:: Text

$sel:awsAccountId:CreateTemplate'

-> Text

$sel:templateId:CreateTemplate'

-> TemplateSourceEntity

$sel:sourceEntity:CreateTemplate'

-> CreateTemplate 

Create a value of CreateTemplate 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:versionDescription:CreateTemplate', createTemplate_versionDescription - A description of the current template version being created. This API operation creates the first version of the template. Every time UpdateTemplate is called, a new version is created. Each version of the template maintains a description of the version in the VersionDescription field.

$sel:name:CreateTemplate', createTemplate_name - A display name for the template.

$sel:permissions:CreateTemplate', createTemplate_permissions - A list of resource permissions to be set on the template.

$sel:tags:CreateTemplate', createTemplate_tags - Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.

$sel:awsAccountId:CreateTemplate', createTemplate_awsAccountId - The ID for the Amazon Web Services account that the group is in. You use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

$sel:templateId:CreateTemplate', createTemplate_templateId - An ID for the template that you want to create. This template is unique per Amazon Web Services Region; in each Amazon Web Services account.

$sel:sourceEntity:CreateTemplate', createTemplate_sourceEntity - The entity that you are using as a source when you create the template. In SourceEntity, you specify the type of object you're using as source: SourceTemplate for a template or SourceAnalysis for an analysis. Both of these require an Amazon Resource Name (ARN). For SourceTemplate, specify the ARN of the source template. For SourceAnalysis, specify the ARN of the source analysis. The SourceTemplate ARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region.

Use the DataSetReferences entity within SourceTemplate or SourceAnalysis to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.

Request Lenses

createTemplate_versionDescription :: Lens' CreateTemplate (Maybe Text) Source #

A description of the current template version being created. This API operation creates the first version of the template. Every time UpdateTemplate is called, a new version is created. Each version of the template maintains a description of the version in the VersionDescription field.

createTemplate_name :: Lens' CreateTemplate (Maybe Text) Source #

A display name for the template.

createTemplate_permissions :: Lens' CreateTemplate (Maybe (NonEmpty ResourcePermission)) Source #

A list of resource permissions to be set on the template.

createTemplate_tags :: Lens' CreateTemplate (Maybe (NonEmpty Tag)) Source #

Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.

createTemplate_awsAccountId :: Lens' CreateTemplate Text Source #

The ID for the Amazon Web Services account that the group is in. You use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

createTemplate_templateId :: Lens' CreateTemplate Text Source #

An ID for the template that you want to create. This template is unique per Amazon Web Services Region; in each Amazon Web Services account.

createTemplate_sourceEntity :: Lens' CreateTemplate TemplateSourceEntity Source #

The entity that you are using as a source when you create the template. In SourceEntity, you specify the type of object you're using as source: SourceTemplate for a template or SourceAnalysis for an analysis. Both of these require an Amazon Resource Name (ARN). For SourceTemplate, specify the ARN of the source template. For SourceAnalysis, specify the ARN of the source analysis. The SourceTemplate ARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region.

Use the DataSetReferences entity within SourceTemplate or SourceAnalysis to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.

Destructuring the Response

data CreateTemplateResponse Source #

See: newCreateTemplateResponse smart constructor.

Constructors

CreateTemplateResponse' 

Fields

Instances

Instances details
Eq CreateTemplateResponse Source # 
Instance details

Defined in Amazonka.QuickSight.CreateTemplate

Methods

(==) :: CreateTemplateResponse -> CreateTemplateResponse -> Bool #

(/=) :: CreateTemplateResponse -> CreateTemplateResponse -> Bool #

Read CreateTemplateResponse Source # 
Instance details

Defined in Amazonka.QuickSight.CreateTemplate

Methods

readsPrec :: Int -> ReadS CreateTemplateResponse #

readList :: ReadS [CreateTemplateResponse] #

readPrec :: ReadPrec CreateTemplateResponse #

readListPrec :: ReadPrec [CreateTemplateResponse] #

Show CreateTemplateResponse Source # 
Instance details

Defined in Amazonka.QuickSight.CreateTemplate

Methods

showsPrec :: Int -> CreateTemplateResponse -> ShowS #

show :: CreateTemplateResponse -> String #

showList :: [CreateTemplateResponse] -> ShowS #

Generic CreateTemplateResponse Source # 
Instance details

Defined in Amazonka.QuickSight.CreateTemplate

Associated Types

type Rep CreateTemplateResponse :: Type -> Type #

Methods

from :: CreateTemplateResponse -> Rep CreateTemplateResponse x #

to :: Rep CreateTemplateResponse x -> CreateTemplateResponse #

NFData CreateTemplateResponse Source # 
Instance details

Defined in Amazonka.QuickSight.CreateTemplate

Methods

rnf :: CreateTemplateResponse -> () #

type Rep CreateTemplateResponse Source # 
Instance details

Defined in Amazonka.QuickSight.CreateTemplate

type Rep CreateTemplateResponse = D1 ('MetaData "CreateTemplateResponse" "Amazonka.QuickSight.CreateTemplate" "libZSservicesZSamazonka-quicksightZSamazonka-quicksight" 'False) (C1 ('MetaCons "CreateTemplateResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "requestId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "creationStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ResourceStatus)))) :*: (S1 ('MetaSel ('Just "templateId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "versionArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newCreateTemplateResponse Source #

Arguments

:: Int

$sel:status:CreateTemplateResponse'

-> CreateTemplateResponse 

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

$sel:arn:CreateTemplateResponse', createTemplateResponse_arn - The ARN for the template.

$sel:creationStatus:CreateTemplateResponse', createTemplateResponse_creationStatus - The template creation status.

$sel:templateId:CreateTemplate', createTemplateResponse_templateId - The ID of the template.

$sel:versionArn:CreateTemplateResponse', createTemplateResponse_versionArn - The ARN for the template, including the version information of the first version.

$sel:status:CreateTemplateResponse', createTemplateResponse_status - The HTTP status of the request.

Response Lenses

createTemplateResponse_requestId :: Lens' CreateTemplateResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

createTemplateResponse_arn :: Lens' CreateTemplateResponse (Maybe Text) Source #

The ARN for the template.

createTemplateResponse_creationStatus :: Lens' CreateTemplateResponse (Maybe ResourceStatus) Source #

The template creation status.

createTemplateResponse_templateId :: Lens' CreateTemplateResponse (Maybe Text) Source #

The ID of the template.

createTemplateResponse_versionArn :: Lens' CreateTemplateResponse (Maybe Text) Source #

The ARN for the template, including the version information of the first version.

createTemplateResponse_status :: Lens' CreateTemplateResponse Int Source #

The HTTP status of the request.