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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates an analysis in Amazon QuickSight.

Synopsis

data CreateAnalysis = CreateAnalysis' {
- themeArn :: Maybe Text
- parameters :: Maybe Parameters
- permissions :: Maybe (NonEmpty ResourcePermission)
- tags :: Maybe (NonEmpty Tag)
- awsAccountId :: Text
- analysisId :: Text
- name :: Text
- sourceEntity :: AnalysisSourceEntity
}
newCreateAnalysis :: Text -> Text -> Text -> AnalysisSourceEntity -> CreateAnalysis
createAnalysis_themeArn :: Lens' CreateAnalysis (Maybe Text)
createAnalysis_parameters :: Lens' CreateAnalysis (Maybe Parameters)
createAnalysis_permissions :: Lens' CreateAnalysis (Maybe (NonEmpty ResourcePermission))
createAnalysis_tags :: Lens' CreateAnalysis (Maybe (NonEmpty Tag))
createAnalysis_awsAccountId :: Lens' CreateAnalysis Text
createAnalysis_analysisId :: Lens' CreateAnalysis Text
createAnalysis_name :: Lens' CreateAnalysis Text
createAnalysis_sourceEntity :: Lens' CreateAnalysis AnalysisSourceEntity
data CreateAnalysisResponse = CreateAnalysisResponse' {
- requestId :: Maybe Text
- analysisId :: Maybe Text
- arn :: Maybe Text
- creationStatus :: Maybe ResourceStatus
- status :: Int
}
newCreateAnalysisResponse :: Int -> CreateAnalysisResponse
createAnalysisResponse_requestId :: Lens' CreateAnalysisResponse (Maybe Text)
createAnalysisResponse_analysisId :: Lens' CreateAnalysisResponse (Maybe Text)
createAnalysisResponse_arn :: Lens' CreateAnalysisResponse (Maybe Text)
createAnalysisResponse_creationStatus :: Lens' CreateAnalysisResponse (Maybe ResourceStatus)
createAnalysisResponse_status :: Lens' CreateAnalysisResponse Int

Creating a Request

data CreateAnalysis Source #

See: newCreateAnalysis smart constructor.

Constructors

CreateAnalysis'

Fields

themeArn :: Maybe Text
The 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.
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.
permissions :: Maybe (NonEmpty ResourcePermission)
A structure that describes the principals and the resource-level permissions on an analysis. You can use the Permissions structure to grant permissions by providing a list of Identity and Access Management (IAM) action information for each principal listed by Amazon Resource Name (ARN).
To specify no permissions, omit Permissions.
tags :: Maybe (NonEmpty Tag)
Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.
awsAccountId :: Text
The ID of the Amazon Web Services account where you are creating an analysis.
analysisId :: Text
The ID for the analysis that you're creating. This ID displays in the URL of the analysis.
name :: Text
A descriptive name for the analysis that you're creating. This name displays for the analysis in the Amazon QuickSight console.
sourceEntity :: AnalysisSourceEntity
A source entity to use for the analysis that you're creating. This metadata structure contains details that describe a source template and one or more datasets.

Instances

Instances details

Eq CreateAnalysis Source #
Instance details Defined in Amazonka.QuickSight.CreateAnalysis Methods (==) :: CreateAnalysis -> CreateAnalysis -> Bool # (/=) :: CreateAnalysis -> CreateAnalysis -> Bool #
Read CreateAnalysis Source #
Instance details Defined in Amazonka.QuickSight.CreateAnalysis Methods readsPrec :: Int -> ReadS CreateAnalysis # readList :: ReadS [CreateAnalysis] # readPrec :: ReadPrec CreateAnalysis # readListPrec :: ReadPrec [CreateAnalysis] #
Show CreateAnalysis Source #
Instance details Defined in Amazonka.QuickSight.CreateAnalysis Methods showsPrec :: Int -> CreateAnalysis -> ShowS # show :: CreateAnalysis -> String # showList :: [CreateAnalysis] -> ShowS #
Generic CreateAnalysis Source #
Instance details Defined in Amazonka.QuickSight.CreateAnalysis Associated Types type Rep CreateAnalysis :: Type -> Type # Methods from :: CreateAnalysis -> Rep CreateAnalysis x # to :: Rep CreateAnalysis x -> CreateAnalysis #
NFData CreateAnalysis Source #
Instance details Defined in Amazonka.QuickSight.CreateAnalysis Methods rnf :: CreateAnalysis -> () #
Hashable CreateAnalysis Source #
Instance details Defined in Amazonka.QuickSight.CreateAnalysis Methods hashWithSalt :: Int -> CreateAnalysis -> Int # hash :: CreateAnalysis -> Int #
ToJSON CreateAnalysis Source #
Instance details Defined in Amazonka.QuickSight.CreateAnalysis Methods toJSON :: CreateAnalysis -> Value # toEncoding :: CreateAnalysis -> Encoding # toJSONList :: [CreateAnalysis] -> Value # toEncodingList :: [CreateAnalysis] -> Encoding #
AWSRequest CreateAnalysis Source #
Instance details Defined in Amazonka.QuickSight.CreateAnalysis Associated Types type AWSResponse CreateAnalysis # Methods request :: CreateAnalysis -> Request CreateAnalysis # response :: MonadResource m => Logger -> Service -> Proxy CreateAnalysis -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateAnalysis))) #
ToHeaders CreateAnalysis Source #
Instance details Defined in Amazonka.QuickSight.CreateAnalysis Methods toHeaders :: CreateAnalysis -> [Header] #
ToPath CreateAnalysis Source #
Instance details Defined in Amazonka.QuickSight.CreateAnalysis Methods toPath :: CreateAnalysis -> ByteString #
ToQuery CreateAnalysis Source #
Instance details Defined in Amazonka.QuickSight.CreateAnalysis Methods toQuery :: CreateAnalysis -> QueryString #
type Rep CreateAnalysis Source #
Instance details Defined in Amazonka.QuickSight.CreateAnalysis type Rep CreateAnalysis = D1 ('MetaData "CreateAnalysis" "Amazonka.QuickSight.CreateAnalysis" "libZSservicesZSamazonka-quicksightZSamazonka-quicksight" 'False) (C1 ('MetaCons "CreateAnalysis'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "themeArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Parameters))) :: (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 "analysisId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "sourceEntity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AnalysisSourceEntity)))))
type AWSResponse CreateAnalysis Source #
Instance details Defined in Amazonka.QuickSight.CreateAnalysis type AWSResponse CreateAnalysis = CreateAnalysisResponse

newCreateAnalysis Source #

Arguments

:: Text	`$sel:awsAccountId:CreateAnalysis'`
-> Text	`$sel:analysisId:CreateAnalysis'`
-> Text	`$sel:name:CreateAnalysis'`
-> AnalysisSourceEntity	`$sel:sourceEntity:CreateAnalysis'`
-> CreateAnalysis

Create a value of CreateAnalysis 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:themeArn:CreateAnalysis', createAnalysis_themeArn - The 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.

$sel:parameters:CreateAnalysis', createAnalysis_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:permissions:CreateAnalysis', createAnalysis_permissions - A structure that describes the principals and the resource-level permissions on an analysis. You can use the Permissions structure to grant permissions by providing a list of Identity and Access Management (IAM) action information for each principal listed by Amazon Resource Name (ARN).

To specify no permissions, omit Permissions.

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

$sel:awsAccountId:CreateAnalysis', createAnalysis_awsAccountId - The ID of the Amazon Web Services account where you are creating an analysis.

$sel:analysisId:CreateAnalysis', createAnalysis_analysisId - The ID for the analysis that you're creating. This ID displays in the URL of the analysis.

$sel:name:CreateAnalysis', createAnalysis_name - A descriptive name for the analysis that you're creating. This name displays for the analysis in the Amazon QuickSight console.

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

Request Lenses

createAnalysis_themeArn :: Lens' CreateAnalysis (Maybe Text) Source #

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

createAnalysis_parameters :: Lens' CreateAnalysis (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.

createAnalysis_permissions :: Lens' CreateAnalysis (Maybe (NonEmpty ResourcePermission)) Source #

A structure that describes the principals and the resource-level permissions on an analysis. You can use the Permissions structure to grant permissions by providing a list of Identity and Access Management (IAM) action information for each principal listed by Amazon Resource Name (ARN).

To specify no permissions, omit Permissions.

createAnalysis_tags :: Lens' CreateAnalysis (Maybe (NonEmpty Tag)) Source #

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

createAnalysis_awsAccountId :: Lens' CreateAnalysis Text Source #

The ID of the Amazon Web Services account where you are creating an analysis.

createAnalysis_analysisId :: Lens' CreateAnalysis Text Source #

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

createAnalysis_name :: Lens' CreateAnalysis Text Source #

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

createAnalysis_sourceEntity :: Lens' CreateAnalysis AnalysisSourceEntity Source #

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

Destructuring the Response

data CreateAnalysisResponse Source #

See: newCreateAnalysisResponse smart constructor.

Constructors

CreateAnalysisResponse'
Fields requestId :: Maybe Text The Amazon Web Services request ID for this operation. analysisId :: Maybe Text The ID of the analysis. arn :: Maybe Text The ARN for the analysis. creationStatus :: Maybe ResourceStatus The status of the creation of the analysis. status :: Int The HTTP status of the request.

Instances

Instances details

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