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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-iotsitewise/types.rb

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_tokenString

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)


8744
8745
8746
8747
8748
8749
8750
8751
8752
# File 'lib/aws-sdk-iotsitewise/types.rb', line 8744

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

#dashboard_definitionString

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

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

Returns:

  • (String)


8744
8745
8746
8747
8748
8749
8750
8751
8752
# File 'lib/aws-sdk-iotsitewise/types.rb', line 8744

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

#dashboard_descriptionString

A new description for the dashboard.

Returns:

  • (String)


8744
8745
8746
8747
8748
8749
8750
8751
8752
# File 'lib/aws-sdk-iotsitewise/types.rb', line 8744

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

#dashboard_idString

The ID of the dashboard to update.

Returns:

  • (String)


8744
8745
8746
8747
8748
8749
8750
8751
8752
# File 'lib/aws-sdk-iotsitewise/types.rb', line 8744

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

#dashboard_nameString

A new friendly name for the dashboard.

Returns:

  • (String)


8744
8745
8746
8747
8748
8749
8750
8751
8752
# File 'lib/aws-sdk-iotsitewise/types.rb', line 8744

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