AWS v6.60.0, Nov 19 24

AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi

aws.quicksight.Analysis

Explore with Pulumi AI

AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi

pulumi/pulumi-aws

Example Usage

From Source Template

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.quicksight.Analysis("example", {
    analysisId: "example-id",
    name: "example-name",
    sourceEntity: {
        sourceTemplate: {
            arn: source.arn,
            dataSetReferences: [{
                dataSetArn: dataset.arn,
                dataSetPlaceholder: "1",
            }],
        },
    },
});

import pulumi
import pulumi_aws as aws

example = aws.quicksight.Analysis("example",
    analysis_id="example-id",
    name="example-name",
    source_entity={
        "source_template": {
            "arn": source["arn"],
            "data_set_references": [{
                "data_set_arn": dataset["arn"],
                "data_set_placeholder": "1",
            }],
        },
    })

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/quicksight"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := quicksight.NewAnalysis(ctx, "example", &quicksight.AnalysisArgs{
			AnalysisId: pulumi.String("example-id"),
			Name:       pulumi.String("example-name"),
			SourceEntity: &quicksight.AnalysisSourceEntityArgs{
				SourceTemplate: &quicksight.AnalysisSourceEntitySourceTemplateArgs{
					Arn: pulumi.Any(source.Arn),
					DataSetReferences: quicksight.AnalysisSourceEntitySourceTemplateDataSetReferenceArray{
						&quicksight.AnalysisSourceEntitySourceTemplateDataSetReferenceArgs{
							DataSetArn:         pulumi.Any(dataset.Arn),
							DataSetPlaceholder: pulumi.String("1"),
						},
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Quicksight.Analysis("example", new()
    {
        AnalysisId = "example-id",
        Name = "example-name",
        SourceEntity = new Aws.Quicksight.Inputs.AnalysisSourceEntityArgs
        {
            SourceTemplate = new Aws.Quicksight.Inputs.AnalysisSourceEntitySourceTemplateArgs
            {
                Arn = source.Arn,
                DataSetReferences = new[]
                {
                    new Aws.Quicksight.Inputs.AnalysisSourceEntitySourceTemplateDataSetReferenceArgs
                    {
                        DataSetArn = dataset.Arn,
                        DataSetPlaceholder = "1",
                    },
                },
            },
        },
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.quicksight.Analysis;
import com.pulumi.aws.quicksight.AnalysisArgs;
import com.pulumi.aws.quicksight.inputs.AnalysisSourceEntityArgs;
import com.pulumi.aws.quicksight.inputs.AnalysisSourceEntitySourceTemplateArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new Analysis("example", AnalysisArgs.builder()
            .analysisId("example-id")
            .name("example-name")
            .sourceEntity(AnalysisSourceEntityArgs.builder()
                .sourceTemplate(AnalysisSourceEntitySourceTemplateArgs.builder()
                    .arn(source.arn())
                    .dataSetReferences(AnalysisSourceEntitySourceTemplateDataSetReferenceArgs.builder()
                        .dataSetArn(dataset.arn())
                        .dataSetPlaceholder("1")
                        .build())
                    .build())
                .build())
            .build());

    }
}

resources:
  example:
    type: aws:quicksight:Analysis
    properties:
      analysisId: example-id
      name: example-name
      sourceEntity:
        sourceTemplate:
          arn: ${source.arn}
          dataSetReferences:
            - dataSetArn: ${dataset.arn}
              dataSetPlaceholder: '1'

With Definition

Coming soon!

Coming soon!

Coming soon!

Coming soon!

Coming soon!

resources:
  example:
    type: aws:quicksight:Analysis
    properties:
      analysisId: example-id
      name: example-name
      definition:
        dataSetIdentifiersDeclarations:
          - dataSetArn: ${dataset.arn}
            identifier: '1'
        sheets:
          - title: Example
            sheetId: Example1
            visuals:
              - lineChartVisual:
                  visualId: LineChart
                  title:
                    formatText:
                      plainText: Line Chart Example
                  chartConfiguration:
                    fieldWells:
                      lineChartAggregatedFieldWells:
                        categories:
                          - categoricalDimensionField:
                              fieldId: '1'
                              column:
                                dataSetIdentifier: '1'
                                columnName: Column1
                        values:
                          - categoricalMeasureField:
                              fieldId: '2'
                              column:
                                dataSetIdentifier: '1'
                                columnName: Column1
                              aggregationFunction: COUNT

Create Analysis Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Analysis(name: string, args: AnalysisArgs, opts?: CustomResourceOptions);

@overload
def Analysis(resource_name: str,
             args: AnalysisArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def Analysis(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             analysis_id: Optional[str] = None,
             aws_account_id: Optional[str] = None,
             name: Optional[str] = None,
             parameters: Optional[AnalysisParametersArgs] = None,
             permissions: Optional[Sequence[AnalysisPermissionArgs]] = None,
             recovery_window_in_days: Optional[int] = None,
             source_entity: Optional[AnalysisSourceEntityArgs] = None,
             tags: Optional[Mapping[str, str]] = None,
             theme_arn: Optional[str] = None)

func NewAnalysis(ctx *Context, name string, args AnalysisArgs, opts ...ResourceOption) (*Analysis, error)

public Analysis(string name, AnalysisArgs args, CustomResourceOptions? opts = null)

public Analysis(String name, AnalysisArgs args)
public Analysis(String name, AnalysisArgs args, CustomResourceOptions options)

type: aws:quicksight:Analysis
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args AnalysisArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args AnalysisArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args AnalysisArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args AnalysisArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args AnalysisArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var analysisResource = new Aws.Quicksight.Analysis("analysisResource", new()
{
    AnalysisId = "string",
    AwsAccountId = "string",
    Name = "string",
    Parameters = new Aws.Quicksight.Inputs.AnalysisParametersArgs
    {
        DateTimeParameters = new[]
        {
            new Aws.Quicksight.Inputs.AnalysisParametersDateTimeParameterArgs
            {
                Name = "string",
                Values = new[]
                {
                    "string",
                },
            },
        },
        DecimalParameters = new[]
        {
            new Aws.Quicksight.Inputs.AnalysisParametersDecimalParameterArgs
            {
                Name = "string",
                Values = new[]
                {
                    0,
                },
            },
        },
        IntegerParameters = new[]
        {
            new Aws.Quicksight.Inputs.AnalysisParametersIntegerParameterArgs
            {
                Name = "string",
                Values = new[]
                {
                    0,
                },
            },
        },
        StringParameters = new[]
        {
            new Aws.Quicksight.Inputs.AnalysisParametersStringParameterArgs
            {
                Name = "string",
                Values = new[]
                {
                    "string",
                },
            },
        },
    },
    Permissions = new[]
    {
        new Aws.Quicksight.Inputs.AnalysisPermissionArgs
        {
            Actions = new[]
            {
                "string",
            },
            Principal = "string",
        },
    },
    RecoveryWindowInDays = 0,
    SourceEntity = new Aws.Quicksight.Inputs.AnalysisSourceEntityArgs
    {
        SourceTemplate = new Aws.Quicksight.Inputs.AnalysisSourceEntitySourceTemplateArgs
        {
            Arn = "string",
            DataSetReferences = new[]
            {
                new Aws.Quicksight.Inputs.AnalysisSourceEntitySourceTemplateDataSetReferenceArgs
                {
                    DataSetArn = "string",
                    DataSetPlaceholder = "string",
                },
            },
        },
    },
    Tags = 
    {
        { "string", "string" },
    },
    ThemeArn = "string",
});

example, err := quicksight.NewAnalysis(ctx, "analysisResource", &quicksight.AnalysisArgs{
	AnalysisId:   pulumi.String("string"),
	AwsAccountId: pulumi.String("string"),
	Name:         pulumi.String("string"),
	Parameters: &quicksight.AnalysisParametersArgs{
		DateTimeParameters: quicksight.AnalysisParametersDateTimeParameterArray{
			&quicksight.AnalysisParametersDateTimeParameterArgs{
				Name: pulumi.String("string"),
				Values: pulumi.StringArray{
					pulumi.String("string"),
				},
			},
		},
		DecimalParameters: quicksight.AnalysisParametersDecimalParameterArray{
			&quicksight.AnalysisParametersDecimalParameterArgs{
				Name: pulumi.String("string"),
				Values: pulumi.Float64Array{
					pulumi.Float64(0),
				},
			},
		},
		IntegerParameters: quicksight.AnalysisParametersIntegerParameterArray{
			&quicksight.AnalysisParametersIntegerParameterArgs{
				Name: pulumi.String("string"),
				Values: pulumi.IntArray{
					pulumi.Int(0),
				},
			},
		},
		StringParameters: quicksight.AnalysisParametersStringParameterArray{
			&quicksight.AnalysisParametersStringParameterArgs{
				Name: pulumi.String("string"),
				Values: pulumi.StringArray{
					pulumi.String("string"),
				},
			},
		},
	},
	Permissions: quicksight.AnalysisPermissionArray{
		&quicksight.AnalysisPermissionArgs{
			Actions: pulumi.StringArray{
				pulumi.String("string"),
			},
			Principal: pulumi.String("string"),
		},
	},
	RecoveryWindowInDays: pulumi.Int(0),
	SourceEntity: &quicksight.AnalysisSourceEntityArgs{
		SourceTemplate: &quicksight.AnalysisSourceEntitySourceTemplateArgs{
			Arn: pulumi.String("string"),
			DataSetReferences: quicksight.AnalysisSourceEntitySourceTemplateDataSetReferenceArray{
				&quicksight.AnalysisSourceEntitySourceTemplateDataSetReferenceArgs{
					DataSetArn:         pulumi.String("string"),
					DataSetPlaceholder: pulumi.String("string"),
				},
			},
		},
	},
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	ThemeArn: pulumi.String("string"),
})

var analysisResource = new Analysis("analysisResource", AnalysisArgs.builder()
    .analysisId("string")
    .awsAccountId("string")
    .name("string")
    .parameters(AnalysisParametersArgs.builder()
        .dateTimeParameters(AnalysisParametersDateTimeParameterArgs.builder()
            .name("string")
            .values("string")
            .build())
        .decimalParameters(AnalysisParametersDecimalParameterArgs.builder()
            .name("string")
            .values(0)
            .build())
        .integerParameters(AnalysisParametersIntegerParameterArgs.builder()
            .name("string")
            .values(0)
            .build())
        .stringParameters(AnalysisParametersStringParameterArgs.builder()
            .name("string")
            .values("string")
            .build())
        .build())
    .permissions(AnalysisPermissionArgs.builder()
        .actions("string")
        .principal("string")
        .build())
    .recoveryWindowInDays(0)
    .sourceEntity(AnalysisSourceEntityArgs.builder()
        .sourceTemplate(AnalysisSourceEntitySourceTemplateArgs.builder()
            .arn("string")
            .dataSetReferences(AnalysisSourceEntitySourceTemplateDataSetReferenceArgs.builder()
                .dataSetArn("string")
                .dataSetPlaceholder("string")
                .build())
            .build())
        .build())
    .tags(Map.of("string", "string"))
    .themeArn("string")
    .build());

analysis_resource = aws.quicksight.Analysis("analysisResource",
    analysis_id="string",
    aws_account_id="string",
    name="string",
    parameters={
        "date_time_parameters": [{
            "name": "string",
            "values": ["string"],
        }],
        "decimal_parameters": [{
            "name": "string",
            "values": [0],
        }],
        "integer_parameters": [{
            "name": "string",
            "values": [0],
        }],
        "string_parameters": [{
            "name": "string",
            "values": ["string"],
        }],
    },
    permissions=[{
        "actions": ["string"],
        "principal": "string",
    }],
    recovery_window_in_days=0,
    source_entity={
        "source_template": {
            "arn": "string",
            "data_set_references": [{
                "data_set_arn": "string",
                "data_set_placeholder": "string",
            }],
        },
    },
    tags={
        "string": "string",
    },
    theme_arn="string")

const analysisResource = new aws.quicksight.Analysis("analysisResource", {
    analysisId: "string",
    awsAccountId: "string",
    name: "string",
    parameters: {
        dateTimeParameters: [{
            name: "string",
            values: ["string"],
        }],
        decimalParameters: [{
            name: "string",
            values: [0],
        }],
        integerParameters: [{
            name: "string",
            values: [0],
        }],
        stringParameters: [{
            name: "string",
            values: ["string"],
        }],
    },
    permissions: [{
        actions: ["string"],
        principal: "string",
    }],
    recoveryWindowInDays: 0,
    sourceEntity: {
        sourceTemplate: {
            arn: "string",
            dataSetReferences: [{
                dataSetArn: "string",
                dataSetPlaceholder: "string",
            }],
        },
    },
    tags: {
        string: "string",
    },
    themeArn: "string",
});

type: aws:quicksight:Analysis
properties:
    analysisId: string
    awsAccountId: string
    name: string
    parameters:
        dateTimeParameters:
            - name: string
              values:
                - string
        decimalParameters:
            - name: string
              values:
                - 0
        integerParameters:
            - name: string
              values:
                - 0
        stringParameters:
            - name: string
              values:
                - string
    permissions:
        - actions:
            - string
          principal: string
    recoveryWindowInDays: 0
    sourceEntity:
        sourceTemplate:
            arn: string
            dataSetReferences:
                - dataSetArn: string
                  dataSetPlaceholder: string
    tags:
        string: string
    themeArn: string

Analysis Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Analysis resource accepts the following input properties:

AnalysisId string

Identifier for the analysis.

AwsAccountId string

AWS account ID.

Name string

Display name for the analysis.

The following arguments are optional:

Parameters AnalysisParameters

The parameters for the creation of the analysis, which you want to use to override the default settings. An analysis can have any type of parameters, and some parameters might accept multiple values. See parameters.

Permissions List<AnalysisPermission>

A set of resource permissions on the analysis. Maximum of 64 items. See permissions.

RecoveryWindowInDays int

A value that specifies the number of days that Amazon QuickSight waits before it deletes the analysis. Use 0 to force deletion without recovery. Minimum value of 7. Maximum value of 30. Default to 30.

SourceEntity AnalysisSourceEntity

The entity that you are using as a source when you create the analysis (template). Only one of definition or source_entity should be configured. See source_entity.

Tags Dictionary<string, string>

Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

ThemeArn string

The Amazon Resource Name (ARN) of the theme that is being used for this analysis. The theme ARN must exist in the same AWS account where you create the analysis.

AnalysisId string

Identifier for the analysis.

AwsAccountId string

AWS account ID.

Name string

Display name for the analysis.

The following arguments are optional:

Parameters AnalysisParametersArgs

Permissions []AnalysisPermissionArgs

A set of resource permissions on the analysis. Maximum of 64 items. See permissions.

RecoveryWindowInDays int

SourceEntity AnalysisSourceEntityArgs

The entity that you are using as a source when you create the analysis (template). Only one of definition or source_entity should be configured. See source_entity.

Tags map[string]string

Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

ThemeArn string

The Amazon Resource Name (ARN) of the theme that is being used for this analysis. The theme ARN must exist in the same AWS account where you create the analysis.

analysisId String

Identifier for the analysis.

awsAccountId String

AWS account ID.

name String

Display name for the analysis.

The following arguments are optional:

parameters AnalysisParameters

permissions List<AnalysisPermission>

A set of resource permissions on the analysis. Maximum of 64 items. See permissions.

recoveryWindowInDays Integer

sourceEntity AnalysisSourceEntity

The entity that you are using as a source when you create the analysis (template). Only one of definition or source_entity should be configured. See source_entity.

tags Map<String,String>

Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

themeArn String

The Amazon Resource Name (ARN) of the theme that is being used for this analysis. The theme ARN must exist in the same AWS account where you create the analysis.

analysisId string

Identifier for the analysis.

awsAccountId string

AWS account ID.

name string

Display name for the analysis.

The following arguments are optional:

parameters AnalysisParameters

permissions AnalysisPermission[]

A set of resource permissions on the analysis. Maximum of 64 items. See permissions.

recoveryWindowInDays number

sourceEntity AnalysisSourceEntity

The entity that you are using as a source when you create the analysis (template). Only one of definition or source_entity should be configured. See source_entity.

tags {[key: string]: string}

Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

themeArn string

The Amazon Resource Name (ARN) of the theme that is being used for this analysis. The theme ARN must exist in the same AWS account where you create the analysis.

analysis_id str

Identifier for the analysis.

aws_account_id str

AWS account ID.

name str

Display name for the analysis.

The following arguments are optional:

parameters AnalysisParametersArgs

permissions Sequence[AnalysisPermissionArgs]

A set of resource permissions on the analysis. Maximum of 64 items. See permissions.

recovery_window_in_days int

source_entity AnalysisSourceEntityArgs

The entity that you are using as a source when you create the analysis (template). Only one of definition or source_entity should be configured. See source_entity.

tags Mapping[str, str]

Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

theme_arn str

The Amazon Resource Name (ARN) of the theme that is being used for this analysis. The theme ARN must exist in the same AWS account where you create the analysis.

analysisId String

Identifier for the analysis.

awsAccountId String

AWS account ID.

name String

Display name for the analysis.

The following arguments are optional:

parameters Property Map

permissions List<Property Map>

A set of resource permissions on the analysis. Maximum of 64 items. See permissions.

recoveryWindowInDays Number

sourceEntity Property Map

The entity that you are using as a source when you create the analysis (template). Only one of definition or source_entity should be configured. See source_entity.

tags Map<String>

Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

themeArn String

The Amazon Resource Name (ARN) of the theme that is being used for this analysis. The theme ARN must exist in the same AWS account where you create the analysis.

Outputs

All input properties are implicitly available as output properties. Additionally, the Analysis resource produces the following output properties:

Arn string: ARN of the analysis.
CreatedTime string: The time that the analysis was created.
Id string: The provider-assigned unique ID for this managed resource.
LastPublishedTime string
LastUpdatedTime string: The time that the analysis was last updated.
Status string: The analysis creation status.
TagsAll Dictionary<string, string>: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
Deprecated: Please use tags instead.

Arn string: ARN of the analysis.
CreatedTime string: The time that the analysis was created.
Id string: The provider-assigned unique ID for this managed resource.
LastPublishedTime string
LastUpdatedTime string: The time that the analysis was last updated.
Status string: The analysis creation status.
TagsAll map[string]string: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
Deprecated: Please use tags instead.

arn String: ARN of the analysis.
createdTime String: The time that the analysis was created.
id String: The provider-assigned unique ID for this managed resource.
lastPublishedTime String
lastUpdatedTime String: The time that the analysis was last updated.
status String: The analysis creation status.
tagsAll Map<String,String>: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
Deprecated: Please use tags instead.

arn string: ARN of the analysis.
createdTime string: The time that the analysis was created.
id string: The provider-assigned unique ID for this managed resource.
lastPublishedTime string
lastUpdatedTime string: The time that the analysis was last updated.
status string: The analysis creation status.
tagsAll {[key: string]: string}: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
Deprecated: Please use tags instead.

arn str: ARN of the analysis.
created_time str: The time that the analysis was created.
id str: The provider-assigned unique ID for this managed resource.
last_published_time str
last_updated_time str: The time that the analysis was last updated.
status str: The analysis creation status.
tags_all Mapping[str, str]: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
Deprecated: Please use tags instead.

arn String: ARN of the analysis.
createdTime String: The time that the analysis was created.
id String: The provider-assigned unique ID for this managed resource.
lastPublishedTime String
lastUpdatedTime String: The time that the analysis was last updated.
status String: The analysis creation status.
tagsAll Map<String>: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
Deprecated: Please use tags instead.

Look up Existing Analysis Resource

Get an existing Analysis resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: AnalysisState, opts?: CustomResourceOptions): Analysis

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        analysis_id: Optional[str] = None,
        arn: Optional[str] = None,
        aws_account_id: Optional[str] = None,
        created_time: Optional[str] = None,
        last_published_time: Optional[str] = None,
        last_updated_time: Optional[str] = None,
        name: Optional[str] = None,
        parameters: Optional[AnalysisParametersArgs] = None,
        permissions: Optional[Sequence[AnalysisPermissionArgs]] = None,
        recovery_window_in_days: Optional[int] = None,
        source_entity: Optional[AnalysisSourceEntityArgs] = None,
        status: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        theme_arn: Optional[str] = None) -> Analysis

func GetAnalysis(ctx *Context, name string, id IDInput, state *AnalysisState, opts ...ResourceOption) (*Analysis, error)

public static Analysis Get(string name, Input<string> id, AnalysisState? state, CustomResourceOptions? opts = null)

public static Analysis get(String name, Output<String> id, AnalysisState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

AnalysisId string

Identifier for the analysis.

Arn string

ARN of the analysis.

AwsAccountId string

AWS account ID.

CreatedTime string

The time that the analysis was created.

LastPublishedTime string

LastUpdatedTime string

The time that the analysis was last updated.

Name string

Display name for the analysis.

The following arguments are optional:

Parameters AnalysisParameters

Permissions List<AnalysisPermission>

A set of resource permissions on the analysis. Maximum of 64 items. See permissions.

RecoveryWindowInDays int

SourceEntity AnalysisSourceEntity

The entity that you are using as a source when you create the analysis (template). Only one of definition or source_entity should be configured. See source_entity.

Status string

The analysis creation status.

Tags Dictionary<string, string>

Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

TagsAll Dictionary<string, string>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

ThemeArn string

The Amazon Resource Name (ARN) of the theme that is being used for this analysis. The theme ARN must exist in the same AWS account where you create the analysis.

AnalysisId string

Identifier for the analysis.

Arn string

ARN of the analysis.

AwsAccountId string

AWS account ID.

CreatedTime string

The time that the analysis was created.

LastPublishedTime string

LastUpdatedTime string

The time that the analysis was last updated.

Name string

Display name for the analysis.

The following arguments are optional:

Parameters AnalysisParametersArgs

Permissions []AnalysisPermissionArgs

A set of resource permissions on the analysis. Maximum of 64 items. See permissions.

RecoveryWindowInDays int

SourceEntity AnalysisSourceEntityArgs

The entity that you are using as a source when you create the analysis (template). Only one of definition or source_entity should be configured. See source_entity.

Status string

The analysis creation status.

Tags map[string]string

Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

TagsAll map[string]string

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

ThemeArn string

The Amazon Resource Name (ARN) of the theme that is being used for this analysis. The theme ARN must exist in the same AWS account where you create the analysis.

analysisId String

Identifier for the analysis.

arn String

ARN of the analysis.

awsAccountId String

AWS account ID.

createdTime String

The time that the analysis was created.

lastPublishedTime String

lastUpdatedTime String

The time that the analysis was last updated.

name String

Display name for the analysis.

The following arguments are optional:

parameters AnalysisParameters

permissions List<AnalysisPermission>

A set of resource permissions on the analysis. Maximum of 64 items. See permissions.

recoveryWindowInDays Integer

sourceEntity AnalysisSourceEntity

The entity that you are using as a source when you create the analysis (template). Only one of definition or source_entity should be configured. See source_entity.

status String

The analysis creation status.

tags Map<String,String>

Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

tagsAll Map<String,String>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

themeArn String

The Amazon Resource Name (ARN) of the theme that is being used for this analysis. The theme ARN must exist in the same AWS account where you create the analysis.

analysisId string

Identifier for the analysis.

arn string

ARN of the analysis.

awsAccountId string

AWS account ID.

createdTime string

The time that the analysis was created.

lastPublishedTime string

lastUpdatedTime string

The time that the analysis was last updated.

name string

Display name for the analysis.

The following arguments are optional:

parameters AnalysisParameters

permissions AnalysisPermission[]

A set of resource permissions on the analysis. Maximum of 64 items. See permissions.

recoveryWindowInDays number

sourceEntity AnalysisSourceEntity

The entity that you are using as a source when you create the analysis (template). Only one of definition or source_entity should be configured. See source_entity.

status string

The analysis creation status.

tags {[key: string]: string}

Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

tagsAll {[key: string]: string}

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

themeArn string

The Amazon Resource Name (ARN) of the theme that is being used for this analysis. The theme ARN must exist in the same AWS account where you create the analysis.

analysis_id str

Identifier for the analysis.

arn str

ARN of the analysis.

aws_account_id str

AWS account ID.

created_time str

The time that the analysis was created.

last_published_time str

last_updated_time str

The time that the analysis was last updated.

name str

Display name for the analysis.

The following arguments are optional:

parameters AnalysisParametersArgs

permissions Sequence[AnalysisPermissionArgs]

A set of resource permissions on the analysis. Maximum of 64 items. See permissions.

recovery_window_in_days int

source_entity AnalysisSourceEntityArgs

The entity that you are using as a source when you create the analysis (template). Only one of definition or source_entity should be configured. See source_entity.

status str

The analysis creation status.

tags Mapping[str, str]

Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

tags_all Mapping[str, str]

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

theme_arn str

The Amazon Resource Name (ARN) of the theme that is being used for this analysis. The theme ARN must exist in the same AWS account where you create the analysis.

analysisId String

Identifier for the analysis.

arn String

ARN of the analysis.

awsAccountId String

AWS account ID.

createdTime String

The time that the analysis was created.

lastPublishedTime String

lastUpdatedTime String

The time that the analysis was last updated.

name String

Display name for the analysis.

The following arguments are optional:

parameters Property Map

permissions List<Property Map>

A set of resource permissions on the analysis. Maximum of 64 items. See permissions.

recoveryWindowInDays Number

sourceEntity Property Map

The entity that you are using as a source when you create the analysis (template). Only one of definition or source_entity should be configured. See source_entity.

status String

The analysis creation status.

tags Map<String>

Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

tagsAll Map<String>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

themeArn String

The Amazon Resource Name (ARN) of the theme that is being used for this analysis. The theme ARN must exist in the same AWS account where you create the analysis.

Supporting Types

AnalysisParameters, AnalysisParametersArgs

DateTimeParameters List<AnalysisParametersDateTimeParameter>: A list of parameters that have a data type of date-time. See AWS API Documentation for complete description.
DecimalParameters List<AnalysisParametersDecimalParameter>: A list of parameters that have a data type of decimal. See AWS API Documentation for complete description.
IntegerParameters List<AnalysisParametersIntegerParameter>: A list of parameters that have a data type of integer. See AWS API Documentation for complete description.
StringParameters List<AnalysisParametersStringParameter>: A list of parameters that have a data type of string. See AWS API Documentation for complete description.

DateTimeParameters []AnalysisParametersDateTimeParameter: A list of parameters that have a data type of date-time. See AWS API Documentation for complete description.
DecimalParameters []AnalysisParametersDecimalParameter: A list of parameters that have a data type of decimal. See AWS API Documentation for complete description.
IntegerParameters []AnalysisParametersIntegerParameter: A list of parameters that have a data type of integer. See AWS API Documentation for complete description.
StringParameters []AnalysisParametersStringParameter: A list of parameters that have a data type of string. See AWS API Documentation for complete description.

dateTimeParameters List<AnalysisParametersDateTimeParameter>: A list of parameters that have a data type of date-time. See AWS API Documentation for complete description.
decimalParameters List<AnalysisParametersDecimalParameter>: A list of parameters that have a data type of decimal. See AWS API Documentation for complete description.
integerParameters List<AnalysisParametersIntegerParameter>: A list of parameters that have a data type of integer. See AWS API Documentation for complete description.
stringParameters List<AnalysisParametersStringParameter>: A list of parameters that have a data type of string. See AWS API Documentation for complete description.

dateTimeParameters AnalysisParametersDateTimeParameter[]: A list of parameters that have a data type of date-time. See AWS API Documentation for complete description.
decimalParameters AnalysisParametersDecimalParameter[]: A list of parameters that have a data type of decimal. See AWS API Documentation for complete description.
integerParameters AnalysisParametersIntegerParameter[]: A list of parameters that have a data type of integer. See AWS API Documentation for complete description.
stringParameters AnalysisParametersStringParameter[]: A list of parameters that have a data type of string. See AWS API Documentation for complete description.

date_time_parameters Sequence[AnalysisParametersDateTimeParameter]: A list of parameters that have a data type of date-time. See AWS API Documentation for complete description.
decimal_parameters Sequence[AnalysisParametersDecimalParameter]: A list of parameters that have a data type of decimal. See AWS API Documentation for complete description.
integer_parameters Sequence[AnalysisParametersIntegerParameter]: A list of parameters that have a data type of integer. See AWS API Documentation for complete description.
string_parameters Sequence[AnalysisParametersStringParameter]: A list of parameters that have a data type of string. See AWS API Documentation for complete description.

dateTimeParameters List<Property Map>: A list of parameters that have a data type of date-time. See AWS API Documentation for complete description.
decimalParameters List<Property Map>: A list of parameters that have a data type of decimal. See AWS API Documentation for complete description.
integerParameters List<Property Map>: A list of parameters that have a data type of integer. See AWS API Documentation for complete description.
stringParameters List<Property Map>: A list of parameters that have a data type of string. See AWS API Documentation for complete description.

AnalysisParametersDateTimeParameter, AnalysisParametersDateTimeParameterArgs

Name string

Display name for the analysis.

The following arguments are optional:

Values List<string>

Name string

Display name for the analysis.

The following arguments are optional:

Values []string

name String

Display name for the analysis.

The following arguments are optional:

values List<String>

name string

Display name for the analysis.

The following arguments are optional:

values string[]

name str

Display name for the analysis.

The following arguments are optional:

values Sequence[str]

name String

Display name for the analysis.

The following arguments are optional:

values List<String>

AnalysisParametersDecimalParameter, AnalysisParametersDecimalParameterArgs

Name string

Display name for the analysis.

The following arguments are optional:

Values List<double>

Name string

Display name for the analysis.

The following arguments are optional:

Values []float64

name String

Display name for the analysis.

The following arguments are optional:

values List<Double>

name string

Display name for the analysis.

The following arguments are optional:

values number[]

name str

Display name for the analysis.

The following arguments are optional:

values Sequence[float]

name String

Display name for the analysis.

The following arguments are optional:

values List<Number>

AnalysisParametersIntegerParameter, AnalysisParametersIntegerParameterArgs

Name string

Display name for the analysis.

The following arguments are optional:

Values List<int>

Name string

Display name for the analysis.

The following arguments are optional:

Values []int

name String

Display name for the analysis.

The following arguments are optional:

values List<Integer>

name string

Display name for the analysis.

The following arguments are optional:

values number[]

name str

Display name for the analysis.

The following arguments are optional:

values Sequence[int]

name String

Display name for the analysis.

The following arguments are optional:

values List<Number>

AnalysisParametersStringParameter, AnalysisParametersStringParameterArgs

Name string

Display name for the analysis.

The following arguments are optional:

Values List<string>

Name string

Display name for the analysis.

The following arguments are optional:

Values []string

name String

Display name for the analysis.

The following arguments are optional:

values List<String>

name string

Display name for the analysis.

The following arguments are optional:

values string[]

name str

Display name for the analysis.

The following arguments are optional:

values Sequence[str]

name String

Display name for the analysis.

The following arguments are optional:

values List<String>

AnalysisPermission, AnalysisPermissionArgs

Actions List<string>: List of IAM actions to grant or revoke permissions on.
Principal string: ARN of the principal. See the ResourcePermission documentation for the applicable ARN values.

Actions []string: List of IAM actions to grant or revoke permissions on.
Principal string: ARN of the principal. See the ResourcePermission documentation for the applicable ARN values.

actions List<String>: List of IAM actions to grant or revoke permissions on.
principal String: ARN of the principal. See the ResourcePermission documentation for the applicable ARN values.

actions string[]: List of IAM actions to grant or revoke permissions on.
principal string: ARN of the principal. See the ResourcePermission documentation for the applicable ARN values.

actions Sequence[str]: List of IAM actions to grant or revoke permissions on.
principal str: ARN of the principal. See the ResourcePermission documentation for the applicable ARN values.

actions List<String>: List of IAM actions to grant or revoke permissions on.
principal String: ARN of the principal. See the ResourcePermission documentation for the applicable ARN values.

AnalysisSourceEntity, AnalysisSourceEntityArgs

SourceTemplate AnalysisSourceEntitySourceTemplate: The source template. See source_template.

SourceTemplate AnalysisSourceEntitySourceTemplate: The source template. See source_template.

sourceTemplate AnalysisSourceEntitySourceTemplate: The source template. See source_template.

sourceTemplate AnalysisSourceEntitySourceTemplate: The source template. See source_template.

source_template AnalysisSourceEntitySourceTemplate: The source template. See source_template.

sourceTemplate Property Map: The source template. See source_template.

AnalysisSourceEntitySourceTemplate, AnalysisSourceEntitySourceTemplateArgs

Arn string: The Amazon Resource Name (ARN) of the resource.
DataSetReferences List<AnalysisSourceEntitySourceTemplateDataSetReference>: List of dataset references. See data_set_references.

Arn string: The Amazon Resource Name (ARN) of the resource.
DataSetReferences []AnalysisSourceEntitySourceTemplateDataSetReference: List of dataset references. See data_set_references.

arn String: The Amazon Resource Name (ARN) of the resource.
dataSetReferences List<AnalysisSourceEntitySourceTemplateDataSetReference>: List of dataset references. See data_set_references.

arn string: The Amazon Resource Name (ARN) of the resource.
dataSetReferences AnalysisSourceEntitySourceTemplateDataSetReference[]: List of dataset references. See data_set_references.

arn str: The Amazon Resource Name (ARN) of the resource.
data_set_references Sequence[AnalysisSourceEntitySourceTemplateDataSetReference]: List of dataset references. See data_set_references.

arn String: The Amazon Resource Name (ARN) of the resource.
dataSetReferences List<Property Map>: List of dataset references. See data_set_references.

AnalysisSourceEntitySourceTemplateDataSetReference, AnalysisSourceEntitySourceTemplateDataSetReferenceArgs

DataSetArn string: Dataset Amazon Resource Name (ARN).
DataSetPlaceholder string: Dataset placeholder.

DataSetArn string: Dataset Amazon Resource Name (ARN).
DataSetPlaceholder string: Dataset placeholder.

dataSetArn String: Dataset Amazon Resource Name (ARN).
dataSetPlaceholder String: Dataset placeholder.

dataSetArn string: Dataset Amazon Resource Name (ARN).
dataSetPlaceholder string: Dataset placeholder.

data_set_arn str: Dataset Amazon Resource Name (ARN).
data_set_placeholder str: Dataset placeholder.

dataSetArn String: Dataset Amazon Resource Name (ARN).
dataSetPlaceholder String: Dataset placeholder.

Import

Using pulumi import, import a QuickSight Analysis using the AWS account ID and analysis ID separated by a comma (,). For example:

$ pulumi import aws:quicksight/analysis:Analysis example 123456789012,example-id

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository: AWS Classic pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.

AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi

pulumi/pulumi-aws

aws.quicksight.Analysis

On this page

On this page

Example Usage

From Source Template

With Definition

Create Analysis Resource

Constructor syntax

Parameters

Constructor example

Analysis Resource Properties

Inputs

Outputs

Look up Existing Analysis Resource

Supporting Types

AnalysisParameters, AnalysisParametersArgs

AnalysisParametersDateTimeParameter, AnalysisParametersDateTimeParameterArgs

AnalysisParametersDecimalParameter, AnalysisParametersDecimalParameterArgs

AnalysisParametersIntegerParameter, AnalysisParametersIntegerParameterArgs

AnalysisParametersStringParameter, AnalysisParametersStringParameterArgs

AnalysisPermission, AnalysisPermissionArgs

AnalysisSourceEntity, AnalysisSourceEntityArgs

AnalysisSourceEntitySourceTemplate, AnalysisSourceEntitySourceTemplateArgs

AnalysisSourceEntitySourceTemplateDataSetReference, AnalysisSourceEntitySourceTemplateDataSetReferenceArgs

Import

Package Details

On this page

On this page