1. Packages
  2. AWS Native
  3. API Docs
  4. iotsitewise
  5. getDashboard

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi

aws-native.iotsitewise.getDashboard

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi

    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>
    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]
    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:iotsitewise:getDashboard
      arguments:
        # arguments dictionary

    The following arguments are supported:

    DashboardId string
    The ID of the dashboard.
    DashboardId string
    The ID of the dashboard.
    dashboardId String
    The ID of the dashboard.
    dashboardId string
    The ID of the dashboard.
    dashboard_id str
    The ID of the dashboard.
    dashboardId 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 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

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi