Class: Aws::IoTSiteWise::Types::UpdateDashboardRequest

Inherits:

Struct

• Object
• Struct
• Aws::IoTSiteWise::Types::UpdateDashboardRequest

Includes:

Structure

Defined in:

lib/aws-sdk-iotsitewise/types.rb

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 new dashboard definition, as specified in a JSON literal.

• #dashboard_description ⇒ String

  A new description for the dashboard.

• #dashboard_id ⇒ String

  The ID of the dashboard to update.

• #dashboard_name ⇒ String

  A new friendly name 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 'lib/aws-sdk-iotsitewise/types.rb', line 9343

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

#dashboard_definition ⇒ String

The new dashboard definition, as specified in a JSON literal.

• IoT SiteWise Monitor (Classic) see [Create dashboards (CLI)]

• IoT SiteWise Monitor (AI-aware) see [Create dashboards (CLI)]

in the *IoT SiteWise User Guide*

[1]: docs.aws.amazon.com/iot-sitewise/latest/userguide/create-dashboards-using-aws-cli.html [2]: docs.aws.amazon.com/iot-sitewise/latest/userguide/create-dashboards-ai-dashboard-cli.html

Returns:

• (String)

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

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

#dashboard_description ⇒ String

A new description for the dashboard.

Returns:

• (String)

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

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

#dashboard_id ⇒ String

The ID of the dashboard to update.

Returns:

• (String)

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

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

#dashboard_name ⇒ String

A new friendly name for the dashboard.

Returns:

• (String)

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

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