Class: Aws::IoTSiteWise::Types::DescribeDashboardResponse

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#dashboard_arnString

The ARN of the dashboard, which has the following format.

arn:$\{Partition\}:iotsitewise:$\{Region\}:$\{Account\}:dashboard/$\{DashboardId\}

Returns:

  • (String)


2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 2288

class DescribeDashboardResponse < Struct.new(
  :dashboard_id,
  :dashboard_arn,
  :dashboard_name,
  :project_id,
  :dashboard_description,
  :dashboard_definition,
  :dashboard_creation_date,
  :dashboard_last_update_date)
  SENSITIVE = []
  include Aws::Structure
end

#dashboard_creation_dateTime

The date the dashboard was created, in Unix epoch time.

Returns:

  • (Time)


2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 2288

class DescribeDashboardResponse < Struct.new(
  :dashboard_id,
  :dashboard_arn,
  :dashboard_name,
  :project_id,
  :dashboard_description,
  :dashboard_definition,
  :dashboard_creation_date,
  :dashboard_last_update_date)
  SENSITIVE = []
  include Aws::Structure
end

#dashboard_definitionString

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

Returns:

  • (String)


2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 2288

class DescribeDashboardResponse < Struct.new(
  :dashboard_id,
  :dashboard_arn,
  :dashboard_name,
  :project_id,
  :dashboard_description,
  :dashboard_definition,
  :dashboard_creation_date,
  :dashboard_last_update_date)
  SENSITIVE = []
  include Aws::Structure
end

#dashboard_descriptionString

The dashboard's description.

Returns:

  • (String)


2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 2288

class DescribeDashboardResponse < Struct.new(
  :dashboard_id,
  :dashboard_arn,
  :dashboard_name,
  :project_id,
  :dashboard_description,
  :dashboard_definition,
  :dashboard_creation_date,
  :dashboard_last_update_date)
  SENSITIVE = []
  include Aws::Structure
end

#dashboard_idString

The ID of the dashboard.

Returns:

  • (String)


2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 2288

class DescribeDashboardResponse < Struct.new(
  :dashboard_id,
  :dashboard_arn,
  :dashboard_name,
  :project_id,
  :dashboard_description,
  :dashboard_definition,
  :dashboard_creation_date,
  :dashboard_last_update_date)
  SENSITIVE = []
  include Aws::Structure
end

#dashboard_last_update_dateTime

The date the dashboard was last updated, in Unix epoch time.

Returns:

  • (Time)


2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 2288

class DescribeDashboardResponse < Struct.new(
  :dashboard_id,
  :dashboard_arn,
  :dashboard_name,
  :project_id,
  :dashboard_description,
  :dashboard_definition,
  :dashboard_creation_date,
  :dashboard_last_update_date)
  SENSITIVE = []
  include Aws::Structure
end

#dashboard_nameString

The name of the dashboard.

Returns:

  • (String)


2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 2288

class DescribeDashboardResponse < Struct.new(
  :dashboard_id,
  :dashboard_arn,
  :dashboard_name,
  :project_id,
  :dashboard_description,
  :dashboard_definition,
  :dashboard_creation_date,
  :dashboard_last_update_date)
  SENSITIVE = []
  include Aws::Structure
end

#project_idString

The ID of the project that the dashboard is in.

Returns:

  • (String)


2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 2288

class DescribeDashboardResponse < Struct.new(
  :dashboard_id,
  :dashboard_arn,
  :dashboard_name,
  :project_id,
  :dashboard_description,
  :dashboard_definition,
  :dashboard_creation_date,
  :dashboard_last_update_date)
  SENSITIVE = []
  include Aws::Structure
end