@pulumi/aws-native
Version:
The Pulumi AWS Cloud Control Provider enables you to build, deploy, and manage [any AWS resource that's supported by the AWS Cloud Control API](https://github.com/pulumi/pulumi-aws-native/blob/master/provider/cmd/pulumi-gen-aws-native/supported-types.txt)
75 lines (74 loc) • 2.66 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* Definition of the AWS::QuickSight::Analysis Resource Type.
*/
export declare function getAnalysis(args: GetAnalysisArgs, opts?: pulumi.InvokeOptions): Promise<GetAnalysisResult>;
export interface GetAnalysisArgs {
/**
* The ID for the analysis that you're creating. This ID displays in the URL of the analysis.
*/
analysisId: string;
/**
* The ID of the AWS account where you are creating an analysis.
*/
awsAccountId: string;
}
export interface GetAnalysisResult {
/**
* <p>The Amazon Resource Name (ARN) of the analysis.</p>
*/
readonly arn?: string;
/**
* <p>The time that the analysis was created.</p>
*/
readonly createdTime?: string;
/**
* <p>The ARNs of the datasets of the analysis.</p>
*/
readonly dataSetArns?: string[];
/**
* <p>Errors associated with the analysis.</p>
*/
readonly errors?: outputs.quicksight.AnalysisError[];
/**
* <p>The time that the analysis was last updated.</p>
*/
readonly lastUpdatedTime?: string;
/**
* <p>The descriptive name of the analysis.</p>
*/
readonly name?: string;
/**
* 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` .
*/
readonly permissions?: outputs.quicksight.AnalysisResourcePermission[];
/**
* <p>A list of the associated sheets with the unique identifier and name of each sheet.</p>
*/
readonly sheets?: outputs.quicksight.AnalysisSheet[];
/**
* Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.
*/
readonly tags?: outputs.Tag[];
/**
* <p>The ARN of the theme of the analysis.</p>
*/
readonly themeArn?: string;
}
/**
* Definition of the AWS::QuickSight::Analysis Resource Type.
*/
export declare function getAnalysisOutput(args: GetAnalysisOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetAnalysisResult>;
export interface GetAnalysisOutputArgs {
/**
* The ID for the analysis that you're creating. This ID displays in the URL of the analysis.
*/
analysisId: pulumi.Input<string>;
/**
* The ID of the AWS account where you are creating an analysis.
*/
awsAccountId: pulumi.Input<string>;
}