1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. quicksight
  5. getDashboard

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi

aws-native.quicksight.getDashboard

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 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)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws-native:quicksight:getDashboard
      arguments:
        # arguments dictionary

    The following arguments are supported:

    AwsAccountId string
    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.
    AwsAccountId string
    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.
    awsAccountId String
    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.
    awsAccountId string
    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_id str
    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.
    awsAccountId String
    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
    LastPublishedTime string
    LastUpdatedTime string
    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.AwsNative.QuickSight.Outputs.DashboardResourcePermission>

    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.

    Tags List<Pulumi.AwsNative.Outputs.Tag>
    Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.
    Version Pulumi.AwsNative.QuickSight.Outputs.DashboardVersion
    Arn string
    CreatedTime string
    LastPublishedTime string
    LastUpdatedTime string
    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 []DashboardResourcePermission

    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.

    Tags 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
    lastPublishedTime String
    lastUpdatedTime String
    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<DashboardResourcePermission>

    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.

    tags 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
    lastPublishedTime string
    lastUpdatedTime string
    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 DashboardResourcePermission[]

    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.

    tags 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_time str
    last_updated_time str
    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[DashboardResourcePermission]

    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.

    tags 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
    lastPublishedTime String
    lastUpdatedTime String
    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.

    tags 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

    DashboardErrorType

    DashboardResourcePermission

    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

    DashboardResourceStatus

    DashboardSheet

    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

    DashboardVersion

    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

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi