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

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

Overview

Note:

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

{
  dashboard_id: "ID", # required
  dashboard_name: "Name", # required
  dashboard_description: "Description",
  dashboard_definition: "DashboardDefinition", # required
  client_token: "ClientToken",
}

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)


5042
5043
5044
5045
5046
5047
5048
5049
5050
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 5042

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 AWS IoT SiteWise User Guide.

Returns:

  • (String)


5042
5043
5044
5045
5046
5047
5048
5049
5050
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 5042

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)


5042
5043
5044
5045
5046
5047
5048
5049
5050
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 5042

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)


5042
5043
5044
5045
5046
5047
5048
5049
5050
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 5042

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)


5042
5043
5044
5045
5046
5047
5048
5049
5050
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 5042

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