Amazonka.QuickSight.UpdateTemplate

Updates a template from an existing Amazon QuickSight analysis or another template.

Creating a Request

data UpdateTemplate

See: newUpdateTemplate smart constructor.

Constructors

UpdateTemplate'

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

  The name for the template.

• sourceEntity :: Maybe TemplateSourceEntity

  The entity that you are using as a source when you update 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.

• versionDescription :: Maybe Text

  A description of the current template version that is being updated. Every time you call UpdateTemplate, you create a new version of the template. Each version of the template maintains a description of the version in the VersionDescription field.

• awsAccountId :: Text

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

• templateId :: Text

  The ID for the template.

Instances

ToJSON UpdateTemplate

Defined in Amazonka.QuickSight.UpdateTemplate

Methods

toJSON :: UpdateTemplate -> Value

toEncoding :: UpdateTemplate -> Encoding

toJSONList :: [UpdateTemplate] -> Value

toEncodingList :: [UpdateTemplate] -> Encoding

ToHeaders UpdateTemplate

Defined in Amazonka.QuickSight.UpdateTemplate

Methods

toHeaders :: UpdateTemplate -> [Header]

ToPath UpdateTemplate

Defined in Amazonka.QuickSight.UpdateTemplate

Methods

toPath :: UpdateTemplate -> ByteString

ToQuery UpdateTemplate

Defined in Amazonka.QuickSight.UpdateTemplate

Methods

toQuery :: UpdateTemplate -> QueryString

AWSRequest UpdateTemplate

Defined in Amazonka.QuickSight.UpdateTemplate

Associated Types

type AWSResponse UpdateTemplate

Methods

request :: (Service -> Service) -> UpdateTemplate -> Request UpdateTemplate

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateTemplate -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateTemplate)))

Generic UpdateTemplate

Defined in Amazonka.QuickSight.UpdateTemplate

Associated Types

type Rep UpdateTemplate :: Type -> Type

Methods

from :: UpdateTemplate -> Rep UpdateTemplate x

to :: Rep UpdateTemplate x -> UpdateTemplate

Show UpdateTemplate

Defined in Amazonka.QuickSight.UpdateTemplate

Methods

showsPrec :: Int -> UpdateTemplate -> ShowS

show :: UpdateTemplate -> String

showList :: [UpdateTemplate] -> ShowS

NFData UpdateTemplate

Defined in Amazonka.QuickSight.UpdateTemplate

Methods

rnf :: UpdateTemplate -> ()

Eq UpdateTemplate

Defined in Amazonka.QuickSight.UpdateTemplate

Methods

(==) :: UpdateTemplate -> UpdateTemplate -> Bool

(/=) :: UpdateTemplate -> UpdateTemplate -> Bool

Hashable UpdateTemplate

Defined in Amazonka.QuickSight.UpdateTemplate

Methods

hashWithSalt :: Int -> UpdateTemplate -> Int

hash :: UpdateTemplate -> Int

type AWSResponse UpdateTemplate

Defined in Amazonka.QuickSight.UpdateTemplate

type AWSResponse UpdateTemplate = UpdateTemplateResponse

type Rep UpdateTemplate

Defined in Amazonka.QuickSight.UpdateTemplate

type Rep UpdateTemplate = D1 ('MetaData "UpdateTemplate" "Amazonka.QuickSight.UpdateTemplate" "amazonka-quicksight-2.0-9P6nV9koXl6GTlt8ZjS7C9" 'False) (C1 ('MetaCons "UpdateTemplate'" '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 "sourceEntity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TemplateSourceEntity)))) :*: (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)))))

newUpdateTemplate

Arguments

:: Text

UpdateTemplate

-> Text

UpdateTemplate

-> UpdateTemplate

Create a value of UpdateTemplate 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:UpdateTemplate', updateTemplate_definition - The definition of a template.

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

UpdateTemplate, updateTemplate_name - The name for the template.

$sel:sourceEntity:UpdateTemplate', updateTemplate_sourceEntity - The entity that you are using as a source when you update 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.

$sel:versionDescription:UpdateTemplate', updateTemplate_versionDescription - A description of the current template version that is being updated. Every time you call UpdateTemplate, you create a new version of the template. Each version of the template maintains a description of the version in the VersionDescription field.

UpdateTemplate, updateTemplate_awsAccountId - The ID of the Amazon Web Services account that contains the template that you're updating.

UpdateTemplate, updateTemplate_templateId - The ID for the template.

Request Lenses

updateTemplate_definition :: Lens' UpdateTemplate (Maybe TemplateVersionDefinition)

The definition of a template.

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

updateTemplate_name :: Lens' UpdateTemplate (Maybe Text)

The name for the template.

updateTemplate_sourceEntity :: Lens' UpdateTemplate (Maybe TemplateSourceEntity)

The entity that you are using as a source when you update 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.

updateTemplate_versionDescription :: Lens' UpdateTemplate (Maybe Text)

A description of the current template version that is being updated. Every time you call UpdateTemplate, you create a new version of the template. Each version of the template maintains a description of the version in the VersionDescription field.

updateTemplate_awsAccountId :: Lens' UpdateTemplate Text

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

updateTemplate_templateId :: Lens' UpdateTemplate Text

The ID for the template.

Destructuring the Response

data UpdateTemplateResponse

See: newUpdateTemplateResponse smart constructor.

Constructors

UpdateTemplateResponse'

Fields

• arn :: Maybe Text

  The Amazon Resource Name (ARN) for the template.

• creationStatus :: Maybe ResourceStatus

  The creation status of the template.

• requestId :: Maybe Text

  The Amazon Web Services request ID for this operation.

• templateId :: Maybe Text

  The ID for 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

Generic UpdateTemplateResponse

Defined in Amazonka.QuickSight.UpdateTemplate

Associated Types

type Rep UpdateTemplateResponse :: Type -> Type

Methods

from :: UpdateTemplateResponse -> Rep UpdateTemplateResponse x

to :: Rep UpdateTemplateResponse x -> UpdateTemplateResponse

Read UpdateTemplateResponse

Defined in Amazonka.QuickSight.UpdateTemplate

Methods

readsPrec :: Int -> ReadS UpdateTemplateResponse

readList :: ReadS [UpdateTemplateResponse]

readPrec :: ReadPrec UpdateTemplateResponse

readListPrec :: ReadPrec [UpdateTemplateResponse]

Show UpdateTemplateResponse

Defined in Amazonka.QuickSight.UpdateTemplate

Methods

showsPrec :: Int -> UpdateTemplateResponse -> ShowS

show :: UpdateTemplateResponse -> String

showList :: [UpdateTemplateResponse] -> ShowS

NFData UpdateTemplateResponse

Defined in Amazonka.QuickSight.UpdateTemplate

Methods

rnf :: UpdateTemplateResponse -> ()

Eq UpdateTemplateResponse

Defined in Amazonka.QuickSight.UpdateTemplate

Methods

(==) :: UpdateTemplateResponse -> UpdateTemplateResponse -> Bool

(/=) :: UpdateTemplateResponse -> UpdateTemplateResponse -> Bool

type Rep UpdateTemplateResponse

Defined in Amazonka.QuickSight.UpdateTemplate

type Rep UpdateTemplateResponse = D1 ('MetaData "UpdateTemplateResponse" "Amazonka.QuickSight.UpdateTemplate" "amazonka-quicksight-2.0-9P6nV9koXl6GTlt8ZjS7C9" 'False) (C1 ('MetaCons "UpdateTemplateResponse'" '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)))))

newUpdateTemplateResponse

Arguments

:: Int

UpdateTemplateResponse

-> UpdateTemplateResponse

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

UpdateTemplateResponse, updateTemplateResponse_arn - The Amazon Resource Name (ARN) for the template.

UpdateTemplateResponse, updateTemplateResponse_creationStatus - The creation status of the template.

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

UpdateTemplate, updateTemplateResponse_templateId - The ID for the template.

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

UpdateTemplateResponse, updateTemplateResponse_status - The HTTP status of the request.

Response Lenses

updateTemplateResponse_arn :: Lens' UpdateTemplateResponse (Maybe Text)

The Amazon Resource Name (ARN) for the template.

updateTemplateResponse_creationStatus :: Lens' UpdateTemplateResponse (Maybe ResourceStatus)

The creation status of the template.

updateTemplateResponse_requestId :: Lens' UpdateTemplateResponse (Maybe Text)

The Amazon Web Services request ID for this operation.

updateTemplateResponse_templateId :: Lens' UpdateTemplateResponse (Maybe Text)

The ID for the template.

updateTemplateResponse_versionArn :: Lens' UpdateTemplateResponse (Maybe Text)

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

updateTemplateResponse_status :: Lens' UpdateTemplateResponse Int

The HTTP status of the request.