class Aws::IoTTwinMaker::Types::CreateEntityRequest
@note When making an API call, you may pass CreateEntityRequest
data as a hash: { components: { "Name" => { component_type_id: "ComponentTypeId", description: "Description", properties: { "Name" => { definition: { configuration: { "Name" => "Value", }, data_type: { allowed_values: [ { boolean_value: false, double_value: 1.0, expression: "Expression", integer_value: 1, list_value: { # recursive DataValueList }, long_value: 1, map_value: { "String" => { # recursive DataValue }, }, relationship_value: { target_component_name: "Name", target_entity_id: "EntityId", }, string_value: "String", }, ], nested_type: { # recursive DataType }, relationship: { relationship_type: "String", target_component_type_id: "ComponentTypeId", }, type: "RELATIONSHIP", # required, accepts RELATIONSHIP, STRING, LONG, BOOLEAN, INTEGER, DOUBLE, LIST, MAP unit_of_measure: "String", }, default_value: { boolean_value: false, double_value: 1.0, expression: "Expression", integer_value: 1, list_value: [ { # recursive DataValue }, ], long_value: 1, map_value: { "String" => { # recursive DataValue }, }, relationship_value: { target_component_name: "Name", target_entity_id: "EntityId", }, string_value: "String", }, is_external_id: false, is_required_in_entity: false, is_stored_externally: false, is_time_series: false, }, update_type: "UPDATE", # accepts UPDATE, DELETE, CREATE value: { boolean_value: false, double_value: 1.0, expression: "Expression", integer_value: 1, list_value: [ { # recursive DataValue }, ], long_value: 1, map_value: { "String" => { # recursive DataValue }, }, relationship_value: { target_component_name: "Name", target_entity_id: "EntityId", }, string_value: "String", }, }, }, }, }, description: "Description", entity_id: "EntityId", entity_name: "EntityName", # required parent_entity_id: "ParentEntityId", tags: { "TagKey" => "TagValue", }, workspace_id: "Id", # required }
@!attribute [rw] components
An object that maps strings to the components in the entity. Each string in the mapping must be unique to this object. @return [Hash<String,Types::ComponentRequest>]
@!attribute [rw] description
The description of the entity. @return [String]
@!attribute [rw] entity_id
The ID of the entity. @return [String]
@!attribute [rw] entity_name
The name of the entity. @return [String]
@!attribute [rw] parent_entity_id
The ID of the entity's parent entity. @return [String]
@!attribute [rw] tags
Metadata that you can use to manage the entity. @return [Hash<String,String>]
@!attribute [rw] workspace_id
The ID of the workspace that contains the entity. @return [String]
Constants
- SENSITIVE