AWS Native is in preview. AWS Classic is fully supported.
aws-native.quicksight.getAnalysis
Explore with Pulumi AI
AWS Native is in preview. AWS Classic is fully supported.
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:
- Analysis
Id string - The ID for the analysis that you're creating. This ID displays in the URL of the analysis.
- Aws
Account stringId - The ID of the AWS account where you are creating an analysis.
- Analysis
Id string - The ID for the analysis that you're creating. This ID displays in the URL of the analysis.
- Aws
Account stringId - The ID of the AWS account where you are creating an analysis.
- analysis
Id String - The ID for the analysis that you're creating. This ID displays in the URL of the analysis.
- aws
Account StringId - The ID of the AWS account where you are creating an analysis.
- analysis
Id string - The ID for the analysis that you're creating. This ID displays in the URL of the analysis.
- aws
Account stringId - 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_ strid - The ID of the AWS account where you are creating an analysis.
- analysis
Id String - The ID for the analysis that you're creating. This ID displays in the URL of the analysis.
- aws
Account StringId - The ID of the AWS account where you are creating an analysis.
getAnalysis Result
The following output properties are available:
- Arn string
- Created
Time string - Data
Set List<string>Arns - Errors
List<Pulumi.
Aws Native. Quick Sight. Outputs. Analysis Error> - Last
Updated stringTime - Name string
- Permissions
List<Pulumi.
Aws Native. Quick Sight. Outputs. Analysis Resource Permission> 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.
Aws Native. Quick Sight. Outputs. Analysis Sheet> - List<Pulumi.
Aws Native. Outputs. Tag> - Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.
- Theme
Arn string
- Arn string
- Created
Time string - Data
Set []stringArns - Errors
[]Analysis
Error - Last
Updated stringTime - Name string
- Permissions
[]Analysis
Resource Permission 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
[]Analysis
Sheet - Tag
- Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.
- Theme
Arn string
- arn String
- created
Time String - data
Set List<String>Arns - errors
List<Analysis
Error> - last
Updated StringTime - name String
- permissions
List<Analysis
Resource Permission> 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<Analysis
Sheet> - List<Tag>
- Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.
- theme
Arn String
- arn string
- created
Time string - data
Set string[]Arns - errors
Analysis
Error[] - last
Updated stringTime - name string
- permissions
Analysis
Resource Permission[] 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
Analysis
Sheet[] - Tag[]
- Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.
- theme
Arn string
- arn str
- created_
time str - data_
set_ Sequence[str]arns - errors
Sequence[Analysis
Error] - last_
updated_ strtime - name str
- permissions
Sequence[Analysis
Resource Permission] 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[Analysis
Sheet] - 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
- created
Time String - data
Set List<String>Arns - errors List<Property Map>
- last
Updated StringTime - 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>
- List<Property Map>
- Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.
- theme
Arn 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
Pulumi.
Aws Native. Quick Sight. Analysis Error Type - The type of the analysis error.
- Violated
Entities List<Pulumi.Aws Native. Quick Sight. Inputs. Analysis Entity>
- Message string
- Type
Analysis
Error Type - The type of the analysis error.
- Violated
Entities []AnalysisEntity
- message String
- type
Analysis
Error Type - The type of the analysis error.
- violated
Entities List<AnalysisEntity>
- message string
- type
Analysis
Error Type - The type of the analysis error.
- violated
Entities AnalysisEntity[]
- message str
- type
Analysis
Error Type - The type of the analysis error.
- violated_
entities Sequence[AnalysisEntity]
- message String
- type "ACCESS_DENIED" | "SOURCE_NOT_FOUND" | "DATA_SET_NOT_FOUND" | "INTERNAL_FAILURE" | "PARAMETER_VALUE_INCOMPATIBLE" | "PARAMETER_TYPE_INVALID" | "PARAMETER_NOT_FOUND" | "COLUMN_TYPE_MISMATCH" | "COLUMN_GEOGRAPHIC_ROLE_MISMATCH" | "COLUMN_REPLACEMENT_MISSING"
- The type of the analysis error.
- violated
Entities List<Property Map>
AnalysisErrorType
AnalysisResourcePermission
AnalysisSheet
Tag
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
AWS Native is in preview. AWS Classic is fully supported.