Class: Aws::IoTTwinMaker::Types::GetEntityResponse

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#are_all_components_returnedBoolean

This flag notes whether all components are returned in the API response. The maximum number of components returned is 30.

Returns:

  • (Boolean)


1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
# File 'lib/aws-sdk-iottwinmaker/types.rb', line 1629

class GetEntityResponse < Struct.new(
  :entity_id,
  :entity_name,
  :arn,
  :status,
  :workspace_id,
  :description,
  :components,
  :parent_entity_id,
  :has_child_entities,
  :creation_date_time,
  :update_date_time,
  :sync_source,
  :are_all_components_returned)
  SENSITIVE = []
  include Aws::Structure
end

#arnString

The ARN of the entity.

Returns:

  • (String)


1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
# File 'lib/aws-sdk-iottwinmaker/types.rb', line 1629

class GetEntityResponse < Struct.new(
  :entity_id,
  :entity_name,
  :arn,
  :status,
  :workspace_id,
  :description,
  :components,
  :parent_entity_id,
  :has_child_entities,
  :creation_date_time,
  :update_date_time,
  :sync_source,
  :are_all_components_returned)
  SENSITIVE = []
  include Aws::Structure
end

#componentsHash<String,Types::ComponentResponse>

An object that maps strings to the components in the entity. Each string in the mapping must be unique to this object.

Returns:



1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
# File 'lib/aws-sdk-iottwinmaker/types.rb', line 1629

class GetEntityResponse < Struct.new(
  :entity_id,
  :entity_name,
  :arn,
  :status,
  :workspace_id,
  :description,
  :components,
  :parent_entity_id,
  :has_child_entities,
  :creation_date_time,
  :update_date_time,
  :sync_source,
  :are_all_components_returned)
  SENSITIVE = []
  include Aws::Structure
end

#creation_date_timeTime

The date and time when the entity was created.

Returns:

  • (Time)


1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
# File 'lib/aws-sdk-iottwinmaker/types.rb', line 1629

class GetEntityResponse < Struct.new(
  :entity_id,
  :entity_name,
  :arn,
  :status,
  :workspace_id,
  :description,
  :components,
  :parent_entity_id,
  :has_child_entities,
  :creation_date_time,
  :update_date_time,
  :sync_source,
  :are_all_components_returned)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

The description of the entity.

Returns:

  • (String)


1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
# File 'lib/aws-sdk-iottwinmaker/types.rb', line 1629

class GetEntityResponse < Struct.new(
  :entity_id,
  :entity_name,
  :arn,
  :status,
  :workspace_id,
  :description,
  :components,
  :parent_entity_id,
  :has_child_entities,
  :creation_date_time,
  :update_date_time,
  :sync_source,
  :are_all_components_returned)
  SENSITIVE = []
  include Aws::Structure
end

#entity_idString

The ID of the entity.

Returns:

  • (String)


1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
# File 'lib/aws-sdk-iottwinmaker/types.rb', line 1629

class GetEntityResponse < Struct.new(
  :entity_id,
  :entity_name,
  :arn,
  :status,
  :workspace_id,
  :description,
  :components,
  :parent_entity_id,
  :has_child_entities,
  :creation_date_time,
  :update_date_time,
  :sync_source,
  :are_all_components_returned)
  SENSITIVE = []
  include Aws::Structure
end

#entity_nameString

The name of the entity.

Returns:

  • (String)


1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
# File 'lib/aws-sdk-iottwinmaker/types.rb', line 1629

class GetEntityResponse < Struct.new(
  :entity_id,
  :entity_name,
  :arn,
  :status,
  :workspace_id,
  :description,
  :components,
  :parent_entity_id,
  :has_child_entities,
  :creation_date_time,
  :update_date_time,
  :sync_source,
  :are_all_components_returned)
  SENSITIVE = []
  include Aws::Structure
end

#has_child_entitiesBoolean

A Boolean value that specifies whether the entity has associated child entities.

Returns:

  • (Boolean)


1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
# File 'lib/aws-sdk-iottwinmaker/types.rb', line 1629

class GetEntityResponse < Struct.new(
  :entity_id,
  :entity_name,
  :arn,
  :status,
  :workspace_id,
  :description,
  :components,
  :parent_entity_id,
  :has_child_entities,
  :creation_date_time,
  :update_date_time,
  :sync_source,
  :are_all_components_returned)
  SENSITIVE = []
  include Aws::Structure
end

#parent_entity_idString

The ID of the parent entity for this entity.

Returns:

  • (String)


1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
# File 'lib/aws-sdk-iottwinmaker/types.rb', line 1629

class GetEntityResponse < Struct.new(
  :entity_id,
  :entity_name,
  :arn,
  :status,
  :workspace_id,
  :description,
  :components,
  :parent_entity_id,
  :has_child_entities,
  :creation_date_time,
  :update_date_time,
  :sync_source,
  :are_all_components_returned)
  SENSITIVE = []
  include Aws::Structure
end

#statusTypes::Status

The current status of the entity.

Returns:



1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
# File 'lib/aws-sdk-iottwinmaker/types.rb', line 1629

class GetEntityResponse < Struct.new(
  :entity_id,
  :entity_name,
  :arn,
  :status,
  :workspace_id,
  :description,
  :components,
  :parent_entity_id,
  :has_child_entities,
  :creation_date_time,
  :update_date_time,
  :sync_source,
  :are_all_components_returned)
  SENSITIVE = []
  include Aws::Structure
end

#sync_sourceString

The syncSource of the sync job, if this entity was created by a sync job.

Returns:

  • (String)


1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
# File 'lib/aws-sdk-iottwinmaker/types.rb', line 1629

class GetEntityResponse < Struct.new(
  :entity_id,
  :entity_name,
  :arn,
  :status,
  :workspace_id,
  :description,
  :components,
  :parent_entity_id,
  :has_child_entities,
  :creation_date_time,
  :update_date_time,
  :sync_source,
  :are_all_components_returned)
  SENSITIVE = []
  include Aws::Structure
end

#update_date_timeTime

The date and time when the entity was last updated.

Returns:

  • (Time)


1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
# File 'lib/aws-sdk-iottwinmaker/types.rb', line 1629

class GetEntityResponse < Struct.new(
  :entity_id,
  :entity_name,
  :arn,
  :status,
  :workspace_id,
  :description,
  :components,
  :parent_entity_id,
  :has_child_entities,
  :creation_date_time,
  :update_date_time,
  :sync_source,
  :are_all_components_returned)
  SENSITIVE = []
  include Aws::Structure
end

#workspace_idString

The ID of the workspace.

Returns:

  • (String)


1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
# File 'lib/aws-sdk-iottwinmaker/types.rb', line 1629

class GetEntityResponse < Struct.new(
  :entity_id,
  :entity_name,
  :arn,
  :status,
  :workspace_id,
  :description,
  :components,
  :parent_entity_id,
  :has_child_entities,
  :creation_date_time,
  :update_date_time,
  :sync_source,
  :are_all_components_returned)
  SENSITIVE = []
  include Aws::Structure
end