You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::IoTSiteWise::Types::CreateDashboardRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateDashboardRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  project_id: "ID", # required
  dashboard_name: "Name", # required
  dashboard_description: "Description",
  dashboard_definition: "DashboardDefinition", # required
  client_token: "ClientToken",
  tags: {
    "TagKey" => "TagValue",
  },
}

Instance Attribute Summary collapse

Instance Attribute Details

#client_token ⇒ String

A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don\'t reuse this client token if a new idempotent request is required.

Returns:

  • (String) —

    A unique case-sensitive identifier that you can provide to ensure the idempotency of the request.

#dashboard_definition ⇒ String

The dashboard definition specified in a JSON literal. For detailed information, see Creating dashboards (CLI) in the AWS IoT SiteWise User Guide.

Returns:

  • (String) —

    The dashboard definition specified in a JSON literal.

#dashboard_description ⇒ String

A description for the dashboard.

Returns:

  • (String) —

    A description for the dashboard.

#dashboard_name ⇒ String

A friendly name for the dashboard.

Returns:

  • (String) —

    A friendly name for the dashboard.

#project_id ⇒ String

The ID of the project in which to create the dashboard.

Returns:

  • (String) —

    The ID of the project in which to create the dashboard.

#tags ⇒ Hash<String,String>

A list of key-value pairs that contain metadata for the dashboard. For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide.

Returns:

  • (Hash<String,String>) —

    A list of key-value pairs that contain metadata for the dashboard.