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

Inherits:

Struct

• Object
• Struct
• Aws::IoTSiteWise::Types::CreateDashboardRequest

Defined in:

gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb

Overview

Note:

When making an API call, you may pass CreateDashboardRequest data as a hash:

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

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #client_token ⇒ 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.

• #dashboard_description ⇒ String

  A description for the dashboard.

• #dashboard_name ⇒ String

  A friendly name for the dashboard.

• #project_id ⇒ 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.

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.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

• (String)

# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 2690

class CreateDashboardRequest < Struct.new(
  :project_id,
  :dashboard_name,
  :dashboard_description,
  :dashboard_definition,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#dashboard_definition ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 2690

class CreateDashboardRequest < Struct.new(
  :project_id,
  :dashboard_name,
  :dashboard_description,
  :dashboard_definition,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#dashboard_description ⇒ String

A description for the dashboard.

Returns:

• (String)

# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 2690

class CreateDashboardRequest < Struct.new(
  :project_id,
  :dashboard_name,
  :dashboard_description,
  :dashboard_definition,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#dashboard_name ⇒ String

A friendly name for the dashboard.

Returns:

• (String)

# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 2690

class CreateDashboardRequest < Struct.new(
  :project_id,
  :dashboard_name,
  :dashboard_description,
  :dashboard_definition,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#project_id ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 2690

class CreateDashboardRequest < Struct.new(
  :project_id,
  :dashboard_name,
  :dashboard_description,
  :dashboard_definition,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

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

Returns:

• (Hash<String,String>)

# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 2690

class CreateDashboardRequest < Struct.new(
  :project_id,
  :dashboard_name,
  :dashboard_description,
  :dashboard_definition,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end