Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. iotsitewise
  5. getDashboard

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

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.iotsitewise.getDashboard

Explore with Pulumi AI

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

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

Resource schema for AWS::IoTSiteWise::Dashboard

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>
Copy
def get_dashboard(dashboard_id: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetDashboardResult
def get_dashboard_output(dashboard_id: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetDashboardResult]
Copy
func LookupDashboard(ctx *Context, args *LookupDashboardArgs, opts ...InvokeOption) (*LookupDashboardResult, error)
func LookupDashboardOutput(ctx *Context, args *LookupDashboardOutputArgs, opts ...InvokeOption) LookupDashboardResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetDashboardResult> getDashboard(GetDashboardArgs args, InvokeOptions options)
public static Output<GetDashboardResult> getDashboard(GetDashboardArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws-native:iotsitewise:getDashboard
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

DashboardId This property is required. string
The ID of the dashboard.
DashboardId This property is required. string
The ID of the dashboard.
dashboardId This property is required. String
The ID of the dashboard.
dashboardId This property is required. string
The ID of the dashboard.
dashboard_id This property is required. str
The ID of the dashboard.
dashboardId This property is required. String
The ID of the dashboard.

getDashboard Result

The following output properties are available:

DashboardArn string
The ARN of the dashboard.
DashboardDefinition string
The dashboard definition specified in a JSON literal.
DashboardDescription string
A description for the dashboard.
DashboardId string
The ID of the dashboard.
DashboardName string
A friendly name for the dashboard.
Tags List<Pulumi.AwsNative.Outputs.Tag>
A list of key-value pairs that contain metadata for the dashboard.
DashboardArn string
The ARN of the dashboard.
DashboardDefinition string
The dashboard definition specified in a JSON literal.
DashboardDescription string
A description for the dashboard.
DashboardId string
The ID of the dashboard.
DashboardName string
A friendly name for the dashboard.
Tags Tag
A list of key-value pairs that contain metadata for the dashboard.
dashboardArn String
The ARN of the dashboard.
dashboardDefinition String
The dashboard definition specified in a JSON literal.
dashboardDescription String
A description for the dashboard.
dashboardId String
The ID of the dashboard.
dashboardName String
A friendly name for the dashboard.
tags List<Tag>
A list of key-value pairs that contain metadata for the dashboard.
dashboardArn string
The ARN of the dashboard.
dashboardDefinition string
The dashboard definition specified in a JSON literal.
dashboardDescription string
A description for the dashboard.
dashboardId string
The ID of the dashboard.
dashboardName string
A friendly name for the dashboard.
tags Tag[]
A list of key-value pairs that contain metadata for the dashboard.
dashboard_arn str
The ARN of the dashboard.
dashboard_definition str
The dashboard definition specified in a JSON literal.
dashboard_description str
A description for the dashboard.
dashboard_id str
The ID of the dashboard.
dashboard_name str
A friendly name for the dashboard.
tags Sequence[root_Tag]
A list of key-value pairs that contain metadata for the dashboard.
dashboardArn String
The ARN of the dashboard.
dashboardDefinition String
The dashboard definition specified in a JSON literal.
dashboardDescription String
A description for the dashboard.
dashboardId String
The ID of the dashboard.
dashboardName String
A friendly name for the dashboard.
tags List<Property Map>
A list of key-value pairs that contain metadata for the dashboard.

Supporting Types

Tag

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the 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.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native