1. Packages
  2. AWS
  3. API Docs
  4. quicksight
  5. getAnalysis
AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi

aws.quicksight.getAnalysis

Explore with Pulumi AI

AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi
Deprecated: aws.quicksight/getanalysis.getAnalysis has been deprecated in favor of aws.quicksight/getquicksightanalysis.getQuicksightAnalysis

Data source for managing an AWS QuickSight Analysis.

Example Usage

Basic Usage

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

const example = aws.quicksight.getQuicksightAnalysis({
    analysisId: "example-id",
});
Copy
import pulumi
import pulumi_aws as aws

example = aws.quicksight.get_quicksight_analysis(analysis_id="example-id")
Copy
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.GetQuicksightAnalysis(ctx, &quicksight.GetQuicksightAnalysisArgs{
			AnalysisId: "example-id",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = Aws.Quicksight.GetQuicksightAnalysis.Invoke(new()
    {
        AnalysisId = "example-id",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.quicksight.QuicksightFunctions;
import com.pulumi.aws.quicksight.inputs.GetQuicksightAnalysisArgs;
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) {
        final var example = QuicksightFunctions.getQuicksightAnalysis(GetQuicksightAnalysisArgs.builder()
            .analysisId("example-id")
            .build());

    }
}
Copy
variables:
  example:
    fn::invoke:
      function: aws:quicksight:getQuicksightAnalysis
      arguments:
        analysisId: example-id
Copy

Using getAnalysis

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getAnalysis(args: GetAnalysisArgs, opts?: InvokeOptions): Promise<GetAnalysisResult>
function getAnalysisOutput(args: GetAnalysisOutputArgs, opts?: InvokeOptions): Output<GetAnalysisResult>
Copy
def get_analysis(analysis_id: Optional[str] = None,
                 aws_account_id: Optional[str] = None,
                 tags: Optional[Mapping[str, str]] = None,
                 opts: Optional[InvokeOptions] = None) -> GetAnalysisResult
def get_analysis_output(analysis_id: Optional[pulumi.Input[str]] = None,
                 aws_account_id: Optional[pulumi.Input[str]] = None,
                 tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetAnalysisResult]
Copy
func LookupAnalysis(ctx *Context, args *LookupAnalysisArgs, opts ...InvokeOption) (*LookupAnalysisResult, error)
func LookupAnalysisOutput(ctx *Context, args *LookupAnalysisOutputArgs, opts ...InvokeOption) LookupAnalysisResultOutput
Copy

> Note: This function is named LookupAnalysis in the Go SDK.

public static class GetAnalysis 
{
    public static Task<GetAnalysisResult> InvokeAsync(GetAnalysisArgs args, InvokeOptions? opts = null)
    public static Output<GetAnalysisResult> Invoke(GetAnalysisInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetAnalysisResult> getAnalysis(GetAnalysisArgs args, InvokeOptions options)
public static Output<GetAnalysisResult> getAnalysis(GetAnalysisArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws:quicksight/getAnalysis:getAnalysis
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

AnalysisId This property is required. string

Identifier for the analysis.

The following arguments are optional:

AwsAccountId string
AWS account ID.
Tags Dictionary<string, string>
AnalysisId This property is required. string

Identifier for the analysis.

The following arguments are optional:

AwsAccountId string
AWS account ID.
Tags map[string]string
analysisId This property is required. String

Identifier for the analysis.

The following arguments are optional:

awsAccountId String
AWS account ID.
tags Map<String,String>
analysisId This property is required. string

Identifier for the analysis.

The following arguments are optional:

awsAccountId string
AWS account ID.
tags {[key: string]: string}
analysis_id This property is required. str

Identifier for the analysis.

The following arguments are optional:

aws_account_id str
AWS account ID.
tags Mapping[str, str]
analysisId This property is required. String

Identifier for the analysis.

The following arguments are optional:

awsAccountId String
AWS account ID.
tags Map<String>

getAnalysis Result

The following output properties are available:

AnalysisId string
Arn string
AwsAccountId string
CreatedTime string
Id string
The provider-assigned unique ID for this managed resource.
LastPublishedTime string
LastUpdatedTime string
Name string
Permissions List<GetAnalysisPermission>
Status string
Tags Dictionary<string, string>
ThemeArn string
AnalysisId string
Arn string
AwsAccountId string
CreatedTime string
Id string
The provider-assigned unique ID for this managed resource.
LastPublishedTime string
LastUpdatedTime string
Name string
Permissions []GetAnalysisPermission
Status string
Tags map[string]string
ThemeArn string
analysisId String
arn String
awsAccountId String
createdTime String
id String
The provider-assigned unique ID for this managed resource.
lastPublishedTime String
lastUpdatedTime String
name String
permissions List<GetAnalysisPermission>
status String
tags Map<String,String>
themeArn String
analysisId string
arn string
awsAccountId string
createdTime string
id string
The provider-assigned unique ID for this managed resource.
lastPublishedTime string
lastUpdatedTime string
name string
permissions GetAnalysisPermission[]
status string
tags {[key: string]: string}
themeArn string
analysis_id str
arn str
aws_account_id str
created_time str
id str
The provider-assigned unique ID for this managed resource.
last_published_time str
last_updated_time str
name str
permissions Sequence[GetAnalysisPermission]
status str
tags Mapping[str, str]
theme_arn str
analysisId String
arn String
awsAccountId String
createdTime String
id String
The provider-assigned unique ID for this managed resource.
lastPublishedTime String
lastUpdatedTime String
name String
permissions List<Property Map>
status String
tags Map<String>
themeArn String

Supporting Types

GetAnalysisPermission

Actions This property is required. List<string>
Principal This property is required. string
Actions This property is required. []string
Principal This property is required. string
actions This property is required. List<String>
principal This property is required. String
actions This property is required. string[]
principal This property is required. string
actions This property is required. Sequence[str]
principal This property is required. str
actions This property is required. List<String>
principal This property is required. String

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.77.0 published on Wednesday, Apr 9, 2025 by Pulumi