We recommend new projects start with resources from the AWS provider.
aws-native.quicksight.getDashboard
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
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:
- AwsAccount stringId 
- The ID of the AWS account where you want to create the dashboard.
- DashboardId string
- The ID for the dashboard, also added to the IAM policy.
- AwsAccount stringId 
- The ID of the AWS account where you want to create the dashboard.
- DashboardId string
- The ID for the dashboard, also added to the IAM policy.
- awsAccount StringId 
- The ID of the AWS account where you want to create the dashboard.
- dashboardId String
- The ID for the dashboard, also added to the IAM policy.
- awsAccount stringId 
- The ID of the AWS account where you want to create the dashboard.
- dashboardId 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.
- awsAccount StringId 
- The ID of the AWS account where you want to create the dashboard.
- dashboardId String
- The ID for the dashboard, also added to the IAM policy.
getDashboard Result
The following output properties are available:
- Arn string
- CreatedTime string
- LastPublished stringTime 
- LastUpdated stringTime 
- LinkEntities 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
- CreatedTime string
- LastPublished stringTime 
- LastUpdated stringTime 
- LinkEntities []string
- A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.
- Name string
- The display name of the dashboard.
- Permissions
[]DashboardResource 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
DashboardVersion 
- arn String
- createdTime String
- lastPublished StringTime 
- lastUpdated StringTime 
- linkEntities 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<DashboardResource 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
DashboardVersion 
- arn string
- createdTime string
- lastPublished stringTime 
- lastUpdated stringTime 
- linkEntities string[]
- A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.
- name string
- The display name of the dashboard.
- permissions
DashboardResource 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
DashboardVersion 
- 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[DashboardResource 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
DashboardVersion 
- arn String
- createdTime String
- lastPublished StringTime 
- lastUpdated StringTime 
- linkEntities 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.
- violatedEntities List<Property Map>
DashboardErrorType  
DashboardResourcePermission  
DashboardResourceStatus  
DashboardSheet 
DashboardVersion 
- Arn string
- CreatedTime string
- DataSet 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> 
- SourceEntity stringArn 
- Status
Pulumi.Aws Native. Quick Sight. Dashboard Resource Status 
- The HTTP status of the request.
- ThemeArn string
- VersionNumber double
- Arn string
- CreatedTime string
- DataSet []stringArns 
- Description string
- Errors
[]DashboardError 
- Sheets
[]DashboardSheet 
- SourceEntity stringArn 
- Status
DashboardResource Status 
- The HTTP status of the request.
- ThemeArn string
- VersionNumber float64
- arn String
- createdTime String
- dataSet List<String>Arns 
- description String
- errors
List<DashboardError> 
- sheets
List<DashboardSheet> 
- sourceEntity StringArn 
- status
DashboardResource Status 
- The HTTP status of the request.
- themeArn String
- versionNumber Double
- arn string
- createdTime string
- dataSet string[]Arns 
- description string
- errors
DashboardError[] 
- sheets
DashboardSheet[] 
- sourceEntity stringArn 
- status
DashboardResource Status 
- The HTTP status of the request.
- themeArn string
- versionNumber number
- arn str
- created_time str
- data_set_ Sequence[str]arns 
- description str
- errors
Sequence[DashboardError] 
- sheets
Sequence[DashboardSheet] 
- source_entity_ strarn 
- status
DashboardResource Status 
- The HTTP status of the request.
- theme_arn str
- version_number float
- arn String
- createdTime String
- dataSet List<String>Arns 
- description String
- errors List<Property Map>
- sheets List<Property Map>
- sourceEntity StringArn 
- status "CREATION_IN_PROGRESS" | "CREATION_SUCCESSFUL" | "CREATION_FAILED" | "UPDATE_IN_PROGRESS" | "UPDATE_SUCCESSFUL" | "UPDATE_FAILED" | "DELETED"
- The HTTP status of the request.
- themeArn String
- versionNumber 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.