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

Inherits:

Struct

• Object
• Struct
• Aws::IoTSiteWise::Types::DescribeDashboardResponse

Defined in:

gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #dashboard_arn ⇒ String

  The [ARN][1] of the dashboard, which has the following format.

• #dashboard_creation_date ⇒ Time

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

• #dashboard_definition ⇒ String

  The dashboard's definition JSON literal.

• #dashboard_description ⇒ String

  The dashboard's description.

• #dashboard_id ⇒ String

  The ID of the dashboard.

• #dashboard_last_update_date ⇒ Time

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

• #dashboard_name ⇒ String

  The name of the dashboard.

• #project_id ⇒ String

  The ID of the project that the dashboard is in.

Instance Attribute Details

#dashboard_arn ⇒ String

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

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

Returns:

• (String)

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

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_date ⇒ Time

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

Returns:

• (Time)

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

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_definition ⇒ String

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

Returns:

• (String)

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

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_description ⇒ String

The dashboard's description.

Returns:

• (String)

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

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_id ⇒ String

The ID of the dashboard.

Returns:

• (String)

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

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_date ⇒ Time

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

Returns:

• (Time)

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

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_name ⇒ String

The name of the dashboard.

Returns:

• (String)

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

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_id ⇒ String

The ID of the project that the dashboard is in.

Returns:

• (String)

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

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