We recommend new projects start with resources from the AWS provider.
published on Monday, Mar 9, 2026 by Pulumi
We recommend new projects start with resources from the AWS provider.
published on Monday, Mar 9, 2026 by Pulumi
Definition of the AWS::QuickSight::Dashboard Resource Type.
Using getDashboard
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 getDashboard(args: GetDashboardArgs, opts?: InvokeOptions): Promise<GetDashboardResult>
function getDashboardOutput(args: GetDashboardOutputArgs, opts?: InvokeOptions): Output<GetDashboardResult>def get_dashboard(aws_account_id: Optional[str] = None,
dashboard_id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetDashboardResult
def get_dashboard_output(aws_account_id: Optional[pulumi.Input[str]] = None,
dashboard_id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetDashboardResult]func LookupDashboard(ctx *Context, args *LookupDashboardArgs, opts ...InvokeOption) (*LookupDashboardResult, error)
func LookupDashboardOutput(ctx *Context, args *LookupDashboardOutputArgs, opts ...InvokeOption) LookupDashboardResultOutput> Note: This function is named LookupDashboard in the Go SDK.
public static class GetDashboard
{
public static Task<GetDashboardResult> InvokeAsync(GetDashboardArgs args, InvokeOptions? opts = null)
public static Output<GetDashboardResult> Invoke(GetDashboardInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetDashboardResult> getDashboard(GetDashboardArgs args, InvokeOptions options)
public static Output<GetDashboardResult> getDashboard(GetDashboardArgs args, InvokeOptions options)
fn::invoke:
function: aws-native:quicksight:getDashboard
arguments:
# arguments dictionaryThe following arguments are supported:
- Aws
Account stringId - The ID of the AWS account where you want to create the dashboard.
- Dashboard
Id string - The ID for the dashboard, also added to the IAM policy.
- Aws
Account stringId - The ID of the AWS account where you want to create the dashboard.
- Dashboard
Id string - The ID for the dashboard, also added to the IAM policy.
- aws
Account StringId - The ID of the AWS account where you want to create the dashboard.
- dashboard
Id String - The ID for the dashboard, also added to the IAM policy.
- aws
Account stringId - The ID of the AWS account where you want to create the dashboard.
- dashboard
Id string - The ID for the dashboard, also added to the IAM policy.
- aws_
account_ strid - The ID of the AWS account where you want to create the dashboard.
- dashboard_
id str - The ID for the dashboard, also added to the IAM policy.
- aws
Account StringId - The ID of the AWS account where you want to create the dashboard.
- dashboard
Id String - The ID for the dashboard, also added to the IAM policy.
getDashboard Result
The following output properties are available:
- Arn string
- Created
Time string - Last
Published stringTime - Last
Updated stringTime - Link
Entities List<string> - A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.
- Name string
- The display name of the dashboard.
- Permissions
List<Pulumi.
Aws Native. Quick Sight. Outputs. Dashboard Resource Permission> A structure that contains the permissions of the dashboard. You can use this structure for granting permissions by providing a list of IAM action information for each principal ARN.
To specify no permissions, omit the permissions list.
-
List<Pulumi.
Aws Native. Outputs. Tag> - Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.
- Version
Pulumi.
Aws Native. Quick Sight. Outputs. Dashboard Version
- Arn string
- Created
Time string - Last
Published stringTime - Last
Updated stringTime - Link
Entities []string - A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.
- Name string
- The display name of the dashboard.
- Permissions
[]Dashboard
Resource Permission A structure that contains the permissions of the dashboard. You can use this structure for granting permissions by providing a list of IAM action information for each principal ARN.
To specify no permissions, omit the permissions list.
- Tag
- Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.
- Version
Dashboard
Version
- arn String
- created
Time String - last
Published StringTime - last
Updated StringTime - link
Entities List<String> - A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.
- name String
- The display name of the dashboard.
- permissions
List<Dashboard
Resource Permission> A structure that contains the permissions of the dashboard. You can use this structure for granting permissions by providing a list of IAM action information for each principal ARN.
To specify no permissions, omit the permissions list.
- List<Tag>
- Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.
- version
Dashboard
Version
- arn string
- created
Time string - last
Published stringTime - last
Updated stringTime - link
Entities string[] - A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.
- name string
- The display name of the dashboard.
- permissions
Dashboard
Resource Permission[] A structure that contains the permissions of the dashboard. You can use this structure for granting permissions by providing a list of IAM action information for each principal ARN.
To specify no permissions, omit the permissions list.
- Tag[]
- Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.
- version
Dashboard
Version
- arn str
- created_
time str - last_
published_ strtime - last_
updated_ strtime - link_
entities Sequence[str] - A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.
- name str
- The display name of the dashboard.
- permissions
Sequence[Dashboard
Resource Permission] A structure that contains the permissions of the dashboard. You can use this structure for granting permissions by providing a list of IAM action information for each principal ARN.
To specify no permissions, omit the permissions list.
- Sequence[root_Tag]
- Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.
- version
Dashboard
Version
- arn String
- created
Time String - last
Published StringTime - last
Updated StringTime - link
Entities List<String> - A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.
- name String
- The display name of the dashboard.
- permissions List<Property Map>
A structure that contains the permissions of the dashboard. You can use this structure for granting permissions by providing a list of IAM action information for each principal ARN.
To specify no permissions, omit the permissions list.
- List<Property Map>
- Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.
- version Property Map
Supporting Types
DashboardEntity
- 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.
DashboardError
- 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"
- Type.
- violated
Entities List<Property Map>
DashboardErrorType
DashboardResourcePermission
DashboardResourceStatus
DashboardSheet
DashboardVersion
- Arn string
- Created
Time string - Data
Set List<string>Arns - Description string
- Errors
List<Pulumi.
Aws Native. Quick Sight. Inputs. Dashboard Error> - Sheets
List<Pulumi.
Aws Native. Quick Sight. Inputs. Dashboard Sheet> - Source
Entity stringArn - Status
Pulumi.
Aws Native. Quick Sight. Dashboard Resource Status - The HTTP status of the request.
- Theme
Arn string - Version
Number double
- Arn string
- Created
Time string - Data
Set []stringArns - Description string
- Errors
[]Dashboard
Error - Sheets
[]Dashboard
Sheet - Source
Entity stringArn - Status
Dashboard
Resource Status - The HTTP status of the request.
- Theme
Arn string - Version
Number float64
- arn String
- created
Time String - data
Set List<String>Arns - description String
- errors
List<Dashboard
Error> - sheets
List<Dashboard
Sheet> - source
Entity StringArn - status
Dashboard
Resource Status - The HTTP status of the request.
- theme
Arn String - version
Number Double
- arn string
- created
Time string - data
Set string[]Arns - description string
- errors
Dashboard
Error[] - sheets
Dashboard
Sheet[] - source
Entity stringArn - status
Dashboard
Resource Status - The HTTP status of the request.
- theme
Arn string - version
Number number
- arn str
- created_
time str - data_
set_ Sequence[str]arns - description str
- errors
Sequence[Dashboard
Error] - sheets
Sequence[Dashboard
Sheet] - source_
entity_ strarn - status
Dashboard
Resource Status - The HTTP status of the request.
- theme_
arn str - version_
number float
- arn String
- created
Time String - data
Set List<String>Arns - description String
- errors List<Property Map>
- sheets List<Property Map>
- source
Entity StringArn - status "CREATION_IN_PROGRESS" | "CREATION_SUCCESSFUL" | "CREATION_FAILED" | "UPDATE_IN_PROGRESS" | "UPDATE_SUCCESSFUL" | "UPDATE_FAILED" | "PENDING_UPDATE" | "DELETED"
- The HTTP status of the request.
- theme
Arn String - version
Number Number
Tag
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.
published on Monday, Mar 9, 2026 by Pulumi
