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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates an analysis in Amazon QuickSight

Synopsis

data UpdateAnalysis = UpdateAnalysis' {
- definition :: Maybe AnalysisDefinition
- parameters :: Maybe Parameters
- sourceEntity :: Maybe AnalysisSourceEntity
- themeArn :: Maybe Text
- awsAccountId :: Text
- analysisId :: Text
- name :: Text
}
newUpdateAnalysis :: Text -> Text -> Text -> UpdateAnalysis
updateAnalysis_definition :: Lens' UpdateAnalysis (Maybe AnalysisDefinition)
updateAnalysis_parameters :: Lens' UpdateAnalysis (Maybe Parameters)
updateAnalysis_sourceEntity :: Lens' UpdateAnalysis (Maybe AnalysisSourceEntity)
updateAnalysis_themeArn :: Lens' UpdateAnalysis (Maybe Text)
updateAnalysis_awsAccountId :: Lens' UpdateAnalysis Text
updateAnalysis_analysisId :: Lens' UpdateAnalysis Text
updateAnalysis_name :: Lens' UpdateAnalysis Text
data UpdateAnalysisResponse = UpdateAnalysisResponse' {
- analysisId :: Maybe Text
- arn :: Maybe Text
- requestId :: Maybe Text
- updateStatus :: Maybe ResourceStatus
- status :: Int
}
newUpdateAnalysisResponse :: Int -> UpdateAnalysisResponse
updateAnalysisResponse_analysisId :: Lens' UpdateAnalysisResponse (Maybe Text)
updateAnalysisResponse_arn :: Lens' UpdateAnalysisResponse (Maybe Text)
updateAnalysisResponse_requestId :: Lens' UpdateAnalysisResponse (Maybe Text)
updateAnalysisResponse_updateStatus :: Lens' UpdateAnalysisResponse (Maybe ResourceStatus)
updateAnalysisResponse_status :: Lens' UpdateAnalysisResponse Int

Creating a Request

data UpdateAnalysis Source #

See: newUpdateAnalysis smart constructor.

Constructors

UpdateAnalysis'

Fields

definition :: Maybe AnalysisDefinition
The definition of an analysis.
A definition is the data model of all features in a Dashboard, Template, or Analysis.
parameters :: Maybe Parameters
The parameter names and override values that you want to use. An analysis can have any parameter type, and some parameters might accept multiple values.
sourceEntity :: Maybe AnalysisSourceEntity
A source entity to use for the analysis that you're updating. This metadata structure contains details that describe a source template and one or more datasets.
themeArn :: Maybe Text
The Amazon Resource Name (ARN) for the theme to apply to the analysis that you're creating. To see the theme in the Amazon QuickSight console, make sure that you have access to it.
awsAccountId :: Text
The ID of the Amazon Web Services account that contains the analysis that you're updating.
analysisId :: Text
The ID for the analysis that you're updating. This ID displays in the URL of the analysis.
name :: Text
A descriptive name for the analysis that you're updating. This name displays for the analysis in the Amazon QuickSight console.

Instances

Instances details

ToJSON UpdateAnalysis Source #
Instance details Defined in Amazonka.QuickSight.UpdateAnalysis Methods toJSON :: UpdateAnalysis -> Value # toEncoding :: UpdateAnalysis -> Encoding # toJSONList :: [UpdateAnalysis] -> Value # toEncodingList :: [UpdateAnalysis] -> Encoding #
ToHeaders UpdateAnalysis Source #
Instance details Defined in Amazonka.QuickSight.UpdateAnalysis Methods toHeaders :: UpdateAnalysis -> [Header] #
ToPath UpdateAnalysis Source #
Instance details Defined in Amazonka.QuickSight.UpdateAnalysis Methods toPath :: UpdateAnalysis -> ByteString #
ToQuery UpdateAnalysis Source #
Instance details Defined in Amazonka.QuickSight.UpdateAnalysis Methods toQuery :: UpdateAnalysis -> QueryString #
AWSRequest UpdateAnalysis Source #
Instance details Defined in Amazonka.QuickSight.UpdateAnalysis Associated Types type AWSResponse UpdateAnalysis # Methods request :: (Service -> Service) -> UpdateAnalysis -> Request UpdateAnalysis # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateAnalysis -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateAnalysis))) #
Generic UpdateAnalysis Source #
Instance details Defined in Amazonka.QuickSight.UpdateAnalysis Associated Types type Rep UpdateAnalysis :: Type -> Type # Methods from :: UpdateAnalysis -> Rep UpdateAnalysis x # to :: Rep UpdateAnalysis x -> UpdateAnalysis #
Show UpdateAnalysis Source #
Instance details Defined in Amazonka.QuickSight.UpdateAnalysis Methods showsPrec :: Int -> UpdateAnalysis -> ShowS # show :: UpdateAnalysis -> String # showList :: [UpdateAnalysis] -> ShowS #
NFData UpdateAnalysis Source #
Instance details Defined in Amazonka.QuickSight.UpdateAnalysis Methods rnf :: UpdateAnalysis -> () #
Eq UpdateAnalysis Source #
Instance details Defined in Amazonka.QuickSight.UpdateAnalysis Methods (==) :: UpdateAnalysis -> UpdateAnalysis -> Bool # (/=) :: UpdateAnalysis -> UpdateAnalysis -> Bool #
Hashable UpdateAnalysis Source #
Instance details Defined in Amazonka.QuickSight.UpdateAnalysis Methods hashWithSalt :: Int -> UpdateAnalysis -> Int # hash :: UpdateAnalysis -> Int #
type AWSResponse UpdateAnalysis Source #
Instance details Defined in Amazonka.QuickSight.UpdateAnalysis type AWSResponse UpdateAnalysis = UpdateAnalysisResponse
type Rep UpdateAnalysis Source #
Instance details Defined in Amazonka.QuickSight.UpdateAnalysis type Rep UpdateAnalysis = D1 ('MetaData "UpdateAnalysis" "Amazonka.QuickSight.UpdateAnalysis" "amazonka-quicksight-2.0-9P6nV9koXl6GTlt8ZjS7C9" 'False) (C1 ('MetaCons "UpdateAnalysis'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "definition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AnalysisDefinition)) :: (S1 ('MetaSel ('Just "parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Parameters)) :: S1 ('MetaSel ('Just "sourceEntity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AnalysisSourceEntity)))) :: ((S1 ('MetaSel ('Just "themeArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "awsAccountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "analysisId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newUpdateAnalysis Source #

Arguments

:: Text	`UpdateAnalysis`
-> Text	`UpdateAnalysis`
-> Text	`UpdateAnalysis`
-> UpdateAnalysis

Create a value of UpdateAnalysis 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:UpdateAnalysis', updateAnalysis_definition - The definition of an analysis.

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

$sel:parameters:UpdateAnalysis', updateAnalysis_parameters - The parameter names and override values that you want to use. An analysis can have any parameter type, and some parameters might accept multiple values.

$sel:sourceEntity:UpdateAnalysis', updateAnalysis_sourceEntity - A source entity to use for the analysis that you're updating. This metadata structure contains details that describe a source template and one or more datasets.

UpdateAnalysis, updateAnalysis_themeArn - The Amazon Resource Name (ARN) for the theme to apply to the analysis that you're creating. To see the theme in the Amazon QuickSight console, make sure that you have access to it.

UpdateAnalysis, updateAnalysis_awsAccountId - The ID of the Amazon Web Services account that contains the analysis that you're updating.

UpdateAnalysis, updateAnalysis_analysisId - The ID for the analysis that you're updating. This ID displays in the URL of the analysis.

UpdateAnalysis, updateAnalysis_name - A descriptive name for the analysis that you're updating. This name displays for the analysis in the Amazon QuickSight console.

Request Lenses

updateAnalysis_definition :: Lens' UpdateAnalysis (Maybe AnalysisDefinition) Source #

The definition of an analysis.

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

updateAnalysis_parameters :: Lens' UpdateAnalysis (Maybe Parameters) Source #

The parameter names and override values that you want to use. An analysis can have any parameter type, and some parameters might accept multiple values.

updateAnalysis_sourceEntity :: Lens' UpdateAnalysis (Maybe AnalysisSourceEntity) Source #

A source entity to use for the analysis that you're updating. This metadata structure contains details that describe a source template and one or more datasets.

updateAnalysis_themeArn :: Lens' UpdateAnalysis (Maybe Text) Source #

The Amazon Resource Name (ARN) for the theme to apply to the analysis that you're creating. To see the theme in the Amazon QuickSight console, make sure that you have access to it.

updateAnalysis_awsAccountId :: Lens' UpdateAnalysis Text Source #

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

updateAnalysis_analysisId :: Lens' UpdateAnalysis Text Source #

The ID for the analysis that you're updating. This ID displays in the URL of the analysis.

updateAnalysis_name :: Lens' UpdateAnalysis Text Source #

A descriptive name for the analysis that you're updating. This name displays for the analysis in the Amazon QuickSight console.

Destructuring the Response

data UpdateAnalysisResponse Source #

See: newUpdateAnalysisResponse smart constructor.

Constructors

UpdateAnalysisResponse'
Fields analysisId :: Maybe Text The ID of the analysis. arn :: Maybe Text The ARN of the analysis that you're updating. requestId :: Maybe Text The Amazon Web Services request ID for this operation. updateStatus :: Maybe ResourceStatus The update status of the last update that was made to the analysis. status :: Int The HTTP status of the request.

Instances

Instances details

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

newUpdateAnalysisResponse Source #

Arguments

:: Int	`UpdateAnalysisResponse`
-> UpdateAnalysisResponse

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

UpdateAnalysis, updateAnalysisResponse_analysisId - The ID of the analysis.

UpdateAnalysisResponse, updateAnalysisResponse_arn - The ARN of the analysis that you're updating.

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

$sel:updateStatus:UpdateAnalysisResponse', updateAnalysisResponse_updateStatus - The update status of the last update that was made to the analysis.

UpdateAnalysisResponse, updateAnalysisResponse_status - The HTTP status of the request.

Response Lenses

updateAnalysisResponse_analysisId :: Lens' UpdateAnalysisResponse (Maybe Text) Source #

The ID of the analysis.

updateAnalysisResponse_arn :: Lens' UpdateAnalysisResponse (Maybe Text) Source #

The ARN of the analysis that you're updating.

updateAnalysisResponse_requestId :: Lens' UpdateAnalysisResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

updateAnalysisResponse_updateStatus :: Lens' UpdateAnalysisResponse (Maybe ResourceStatus) Source #

The update status of the last update that was made to the analysis.

updateAnalysisResponse_status :: Lens' UpdateAnalysisResponse Int Source #

The HTTP status of the request.