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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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

data CreateTemplate = CreateTemplate' {
- definition :: Maybe TemplateVersionDefinition
- name :: Maybe Text
- permissions :: Maybe (NonEmpty ResourcePermission)
- sourceEntity :: Maybe TemplateSourceEntity
- tags :: Maybe (NonEmpty Tag)
- versionDescription :: Maybe Text
- awsAccountId :: Text
- templateId :: Text
}
newCreateTemplate :: Text -> Text -> CreateTemplate
createTemplate_definition :: Lens' CreateTemplate (Maybe TemplateVersionDefinition)
createTemplate_name :: Lens' CreateTemplate (Maybe Text)
createTemplate_permissions :: Lens' CreateTemplate (Maybe (NonEmpty ResourcePermission))
createTemplate_sourceEntity :: Lens' CreateTemplate (Maybe TemplateSourceEntity)
createTemplate_tags :: Lens' CreateTemplate (Maybe (NonEmpty Tag))
createTemplate_versionDescription :: Lens' CreateTemplate (Maybe Text)
createTemplate_awsAccountId :: Lens' CreateTemplate Text
createTemplate_templateId :: Lens' CreateTemplate Text
data CreateTemplateResponse = CreateTemplateResponse' {
- arn :: Maybe Text
- creationStatus :: Maybe ResourceStatus
- requestId :: Maybe Text
- templateId :: Maybe Text
- versionArn :: Maybe Text
- status :: Int
}
newCreateTemplateResponse :: Int -> CreateTemplateResponse
createTemplateResponse_arn :: Lens' CreateTemplateResponse (Maybe Text)
createTemplateResponse_creationStatus :: Lens' CreateTemplateResponse (Maybe ResourceStatus)
createTemplateResponse_requestId :: Lens' CreateTemplateResponse (Maybe Text)
createTemplateResponse_templateId :: Lens' CreateTemplateResponse (Maybe Text)
createTemplateResponse_versionArn :: Lens' CreateTemplateResponse (Maybe Text)
createTemplateResponse_status :: Lens' CreateTemplateResponse Int

Creating a Request

data CreateTemplate Source #

See: newCreateTemplate smart constructor.

Constructors

CreateTemplate'

Fields

definition :: Maybe TemplateVersionDefinition
The definition of a template.
A definition is the data model of all features in a Dashboard, Template, or Analysis.
name :: Maybe Text
A display name for the template.
permissions :: Maybe (NonEmpty ResourcePermission)
A list of resource permissions to be set on the template.
sourceEntity :: Maybe 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.
tags :: Maybe (NonEmpty Tag)
Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.
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.
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.

Instances

Instances details

ToJSON CreateTemplate Source #
Instance details Defined in Amazonka.QuickSight.CreateTemplate Methods toJSON :: CreateTemplate -> Value # toEncoding :: CreateTemplate -> Encoding # toJSONList :: [CreateTemplate] -> Value # toEncodingList :: [CreateTemplate] -> Encoding #
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 #
AWSRequest CreateTemplate Source #
Instance details Defined in Amazonka.QuickSight.CreateTemplate Associated Types type AWSResponse CreateTemplate # Methods request :: (Service -> Service) -> CreateTemplate -> Request CreateTemplate # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateTemplate -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateTemplate))) #
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 #
Show CreateTemplate Source #
Instance details Defined in Amazonka.QuickSight.CreateTemplate Methods showsPrec :: Int -> CreateTemplate -> ShowS # show :: CreateTemplate -> String # showList :: [CreateTemplate] -> ShowS #
NFData CreateTemplate Source #
Instance details Defined in Amazonka.QuickSight.CreateTemplate Methods rnf :: CreateTemplate -> () #
Eq CreateTemplate Source #
Instance details Defined in Amazonka.QuickSight.CreateTemplate Methods (==) :: CreateTemplate -> CreateTemplate -> Bool # (/=) :: CreateTemplate -> CreateTemplate -> Bool #
Hashable CreateTemplate Source #
Instance details Defined in Amazonka.QuickSight.CreateTemplate Methods hashWithSalt :: Int -> CreateTemplate -> Int # hash :: CreateTemplate -> Int #
type AWSResponse CreateTemplate Source #
Instance details Defined in Amazonka.QuickSight.CreateTemplate type AWSResponse CreateTemplate = CreateTemplateResponse
type Rep CreateTemplate Source #
Instance details Defined in Amazonka.QuickSight.CreateTemplate type Rep CreateTemplate = D1 ('MetaData "CreateTemplate" "Amazonka.QuickSight.CreateTemplate" "amazonka-quicksight-2.0-9P6nV9koXl6GTlt8ZjS7C9" 'False) (C1 ('MetaCons "CreateTemplate'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "definition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TemplateVersionDefinition)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "permissions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty ResourcePermission))) :: S1 ('MetaSel ('Just "sourceEntity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TemplateSourceEntity)))) :: ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Tag))) :: S1 ('MetaSel ('Just "versionDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "awsAccountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "templateId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateTemplate Source #

Arguments

:: Text	`CreateTemplate`
-> Text	`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:definition:CreateTemplate', createTemplate_definition - The definition of a template.

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

CreateTemplate, createTemplate_name - A display name for the template.

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

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

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

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

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.

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.

Request Lenses

createTemplate_definition :: Lens' CreateTemplate (Maybe TemplateVersionDefinition) Source #

The definition of a template.

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

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_sourceEntity :: Lens' CreateTemplate (Maybe 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.

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

Destructuring the Response

data CreateTemplateResponse Source #

See: newCreateTemplateResponse smart constructor.

Constructors

CreateTemplateResponse'

Fields

arn :: Maybe Text
The ARN for the template.
creationStatus :: Maybe ResourceStatus
The template creation status.
requestId :: Maybe Text
The Amazon Web Services request ID for this operation.
templateId :: Maybe Text
The ID of the template.
versionArn :: Maybe Text
The ARN for the template, including the version information of the first version.
status :: Int
The HTTP status of the request.

Instances

Instances details

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 #
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 #
NFData CreateTemplateResponse Source #
Instance details Defined in Amazonka.QuickSight.CreateTemplate Methods rnf :: CreateTemplateResponse -> () #
Eq CreateTemplateResponse Source #
Instance details Defined in Amazonka.QuickSight.CreateTemplate Methods (==) :: CreateTemplateResponse -> CreateTemplateResponse -> Bool # (/=) :: CreateTemplateResponse -> CreateTemplateResponse -> Bool #
type Rep CreateTemplateResponse Source #
Instance details Defined in Amazonka.QuickSight.CreateTemplate type Rep CreateTemplateResponse = D1 ('MetaData "CreateTemplateResponse" "Amazonka.QuickSight.CreateTemplate" "amazonka-quicksight-2.0-9P6nV9koXl6GTlt8ZjS7C9" 'False) (C1 ('MetaCons "CreateTemplateResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "creationStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ResourceStatus)) :: S1 ('MetaSel ('Just "requestId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (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	`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:

CreateTemplateResponse, createTemplateResponse_arn - The ARN for the template.

CreateTemplateResponse, createTemplateResponse_creationStatus - The template creation status.

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

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.

CreateTemplateResponse, createTemplateResponse_status - The HTTP status of the request.

Response Lenses

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

The ARN for the template.

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

The template creation status.

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

The Amazon Web Services request ID for this operation.

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.