1. Packages
  2. AWS Native
  3. API Docs
  4. quicksight
  5. getAnalysis

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.3 published on Wednesday, Jun 12, 2024 by Pulumi

aws-native.quicksight.getAnalysis

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.3 published on Wednesday, Jun 12, 2024 by Pulumi

    Definition of the AWS::QuickSight::Analysis Resource Type.

    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>
    def get_analysis(analysis_id: Optional[str] = None,
                     aws_account_id: Optional[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,
                     opts: Optional[InvokeOptions] = None) -> Output[GetAnalysisResult]
    func LookupAnalysis(ctx *Context, args *LookupAnalysisArgs, opts ...InvokeOption) (*LookupAnalysisResult, error)
    func LookupAnalysisOutput(ctx *Context, args *LookupAnalysisOutputArgs, opts ...InvokeOption) LookupAnalysisResultOutput

    > 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)
    }
    public static CompletableFuture<GetAnalysisResult> getAnalysis(GetAnalysisArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws-native:quicksight:getAnalysis
      arguments:
        # arguments dictionary

    The following arguments are supported:

    AnalysisId string
    The ID for the analysis that you're creating. This ID displays in the URL of the analysis.
    AwsAccountId string
    The ID of the AWS account where you are creating an analysis.
    AnalysisId string
    The ID for the analysis that you're creating. This ID displays in the URL of the analysis.
    AwsAccountId string
    The ID of the AWS account where you are creating an analysis.
    analysisId String
    The ID for the analysis that you're creating. This ID displays in the URL of the analysis.
    awsAccountId String
    The ID of the AWS account where you are creating an analysis.
    analysisId string
    The ID for the analysis that you're creating. This ID displays in the URL of the analysis.
    awsAccountId string
    The ID of the AWS account where you are creating an analysis.
    analysis_id str
    The ID for the analysis that you're creating. This ID displays in the URL of the analysis.
    aws_account_id str
    The ID of the AWS account where you are creating an analysis.
    analysisId String
    The ID for the analysis that you're creating. This ID displays in the URL of the analysis.
    awsAccountId String
    The ID of the AWS account where you are creating an analysis.

    getAnalysis Result

    The following output properties are available:

    Arn string
    CreatedTime string
    DataSetArns List<string>
    Errors List<Pulumi.AwsNative.QuickSight.Outputs.AnalysisError>
    LastUpdatedTime string
    Name string
    Permissions List<Pulumi.AwsNative.QuickSight.Outputs.AnalysisResourcePermission>

    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 AWS Identity and Access Management (IAM) action information for each principal listed by Amazon Resource Name (ARN).

    To specify no permissions, omit Permissions .

    Sheets List<Pulumi.AwsNative.QuickSight.Outputs.AnalysisSheet>
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.
    ThemeArn string
    Arn string
    CreatedTime string
    DataSetArns []string
    Errors []AnalysisError
    LastUpdatedTime string
    Name string
    Permissions []AnalysisResourcePermission

    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 AWS Identity and Access Management (IAM) action information for each principal listed by Amazon Resource Name (ARN).

    To specify no permissions, omit Permissions .

    Sheets []AnalysisSheet
    Tags Tag
    Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.
    ThemeArn string
    arn String
    createdTime String
    dataSetArns List<String>
    errors List<AnalysisError>
    lastUpdatedTime String
    name String
    permissions List<AnalysisResourcePermission>

    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 AWS Identity and Access Management (IAM) action information for each principal listed by Amazon Resource Name (ARN).

    To specify no permissions, omit Permissions .

    sheets List<AnalysisSheet>
    tags List<Tag>
    Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.
    themeArn String
    arn string
    createdTime string
    dataSetArns string[]
    errors AnalysisError[]
    lastUpdatedTime string
    name string
    permissions AnalysisResourcePermission[]

    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 AWS Identity and Access Management (IAM) action information for each principal listed by Amazon Resource Name (ARN).

    To specify no permissions, omit Permissions .

    sheets AnalysisSheet[]
    tags Tag[]
    Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.
    themeArn string
    arn str
    created_time str
    data_set_arns Sequence[str]
    errors Sequence[AnalysisError]
    last_updated_time str
    name str
    permissions Sequence[AnalysisResourcePermission]

    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 AWS Identity and Access Management (IAM) action information for each principal listed by Amazon Resource Name (ARN).

    To specify no permissions, omit Permissions .

    sheets Sequence[AnalysisSheet]
    tags Sequence[root_Tag]
    Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.
    theme_arn str
    arn String
    createdTime String
    dataSetArns List<String>
    errors List<Property Map>
    lastUpdatedTime String
    name String
    permissions List<Property Map>

    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 AWS Identity and Access Management (IAM) action information for each principal listed by Amazon Resource Name (ARN).

    To specify no permissions, omit Permissions .

    sheets List<Property Map>
    tags List<Property Map>
    Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.
    themeArn String

    Supporting Types

    AnalysisEntity

    Path string
    The hierarchical path of the entity within the analysis, template, or dashboard definition tree.
    Path string
    The hierarchical path of the entity within the analysis, template, or dashboard definition tree.
    path String
    The hierarchical path of the entity within the analysis, template, or dashboard definition tree.
    path string
    The hierarchical path of the entity within the analysis, template, or dashboard definition tree.
    path str
    The hierarchical path of the entity within the analysis, template, or dashboard definition tree.
    path String
    The hierarchical path of the entity within the analysis, template, or dashboard definition tree.

    AnalysisError

    Message string
    Type AnalysisErrorType
    The type of the analysis error.
    ViolatedEntities []AnalysisEntity
    message string
    type AnalysisErrorType
    The type of the analysis error.
    violatedEntities AnalysisEntity[]

    AnalysisErrorType

    AnalysisResourcePermission

    Actions List<string>
    Principal string
    Actions []string
    Principal string
    actions List<String>
    principal String
    actions string[]
    principal string
    actions Sequence[str]
    principal str
    actions List<String>
    principal String

    AnalysisSheet

    Name string
    SheetId string
    Name string
    SheetId string
    name String
    sheetId String
    name string
    sheetId string
    name str
    sheet_id str
    name String
    sheetId String

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.108.3 published on Wednesday, Jun 12, 2024 by Pulumi