AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

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 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 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)


1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 1869

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

#dashboard_definitionString

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

Returns:

  • (String)


1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 1869

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

#dashboard_descriptionString

A description for the dashboard.

Returns:

  • (String)


1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 1869

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

#dashboard_nameString

A friendly name for the dashboard.

Returns:

  • (String)


1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 1869

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

#project_idString

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

Returns:

  • (String)


1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 1869

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

#tagsHash<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>)


1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 1869

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