Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . iottwinmaker ]

get-entity

Description

Retrieves information about an entity.

See also: AWS API Documentation

Synopsis

  get-entity
--workspace-id <value>
--entity-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--workspace-id (string)

The ID of the workspace.

--entity-id (string)

The ID of the entity.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

entityId -> (string)

The ID of the entity.

entityName -> (string)

The name of the entity.

arn -> (string)

The ARN of the entity.

status -> (structure)

The current status of the entity.

state -> (string)

The current state of the entity, component, component type, or workspace.

error -> (structure)

The error message.

code -> (string)

The error code.

message -> (string)

The error message.

workspaceId -> (string)

The ID of the workspace.

description -> (string)

The description of the entity.

components -> (map)

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

key -> (string)

value -> (structure)

An object that returns information about a component type create or update request.

componentName -> (string)

The name of the component.

description -> (string)

The description of the component type.

componentTypeId -> (string)

The ID of the component type.

status -> (structure)

The status of the component type.

state -> (string)

The current state of the entity, component, component type, or workspace.

error -> (structure)

The error message.

code -> (string)

The error code.

message -> (string)

The error message.

definedIn -> (string)

The name of the property definition set in the request.

properties -> (map)

An object that maps strings to the properties to set in the component type. Each string in the mapping must be unique to this object.

key -> (string)

value -> (structure)

An object that contains information about a property response.

definition -> (structure)

An object that specifies information about a property.

dataType -> (structure)

An object that contains information about the data type.

type -> (string)

The underlying type of the data type.

nestedType -> (structure)

The nested type in the data type.

type -> (string)

The underlying type of the data type.

( ... recursive ... )allowedValues -> (list)

The allowed values for this data type.

(structure)

An object that specifies a value for a property.

booleanValue -> (boolean)

A Boolean value.

doubleValue -> (double)

A double value.

integerValue -> (integer)

An integer value.

longValue -> (long)

A long value.

stringValue -> (string)

A string value.

listValue -> (list)

A list of multiple values.

(structure)

An object that specifies a value for a property.

booleanValue -> (boolean)

A Boolean value.

doubleValue -> (double)

A double value.

integerValue -> (integer)

An integer value.

longValue -> (long)

A long value.

stringValue -> (string)

A string value.

mapValue -> (map)

An object that maps strings to multiple DataValue objects.

key -> (string)

( ... recursive ... )

relationshipValue -> (structure)

A value that relates a component to another component.

targetEntityId -> (string)

The ID of the target entity associated with this relationship value.

targetComponentName -> (string)

The name of the target component associated with the relationship value.

expression -> (string)

An expression that produces the value.

mapValue -> (map)

An object that maps strings to multiple DataValue objects.

key -> (string)

value -> (structure)

An object that specifies a value for a property.

booleanValue -> (boolean)

A Boolean value.

doubleValue -> (double)

A double value.

integerValue -> (integer)

An integer value.

longValue -> (long)

A long value.

stringValue -> (string)

A string value.

listValue -> (list)

A list of multiple values.

( ... recursive ... )

mapValue -> (map)

An object that maps strings to multiple DataValue objects.

key -> (string)

( ... recursive ... )

relationshipValue -> (structure)

A value that relates a component to another component.

targetEntityId -> (string)

The ID of the target entity associated with this relationship value.

targetComponentName -> (string)

The name of the target component associated with the relationship value.

expression -> (string)

An expression that produces the value.

relationshipValue -> (structure)

A value that relates a component to another component.

targetEntityId -> (string)

The ID of the target entity associated with this relationship value.

targetComponentName -> (string)

The name of the target component associated with the relationship value.

expression -> (string)

An expression that produces the value.

unitOfMeasure -> (string)

The unit of measure used in this data type.

relationship -> (structure)

A relationship that associates a component with another component.

targetComponentTypeId -> (string)

The ID of the target component type associated with this relationship.

relationshipType -> (string)

The type of the relationship.

allowedValues -> (list)

The allowed values for this data type.

(structure)

An object that specifies a value for a property.

booleanValue -> (boolean)

A Boolean value.

doubleValue -> (double)

A double value.

integerValue -> (integer)

An integer value.

longValue -> (long)

A long value.

stringValue -> (string)

A string value.

listValue -> (list)

A list of multiple values.

(structure)

An object that specifies a value for a property.

booleanValue -> (boolean)

A Boolean value.

doubleValue -> (double)

A double value.

integerValue -> (integer)

An integer value.

longValue -> (long)

A long value.

stringValue -> (string)

A string value.

mapValue -> (map)

An object that maps strings to multiple DataValue objects.

key -> (string)

( ... recursive ... )

relationshipValue -> (structure)

A value that relates a component to another component.

targetEntityId -> (string)

The ID of the target entity associated with this relationship value.

targetComponentName -> (string)

The name of the target component associated with the relationship value.

expression -> (string)

An expression that produces the value.

mapValue -> (map)

An object that maps strings to multiple DataValue objects.

key -> (string)

value -> (structure)

An object that specifies a value for a property.

booleanValue -> (boolean)

A Boolean value.

doubleValue -> (double)

A double value.

integerValue -> (integer)

An integer value.

longValue -> (long)

A long value.

stringValue -> (string)

A string value.

listValue -> (list)

A list of multiple values.

( ... recursive ... )

mapValue -> (map)

An object that maps strings to multiple DataValue objects.

key -> (string)

( ... recursive ... )

relationshipValue -> (structure)

A value that relates a component to another component.

targetEntityId -> (string)

The ID of the target entity associated with this relationship value.

targetComponentName -> (string)

The name of the target component associated with the relationship value.

expression -> (string)

An expression that produces the value.

relationshipValue -> (structure)

A value that relates a component to another component.

targetEntityId -> (string)

The ID of the target entity associated with this relationship value.

targetComponentName -> (string)

The name of the target component associated with the relationship value.

expression -> (string)

An expression that produces the value.

unitOfMeasure -> (string)

The unit of measure used in this data type.

relationship -> (structure)

A relationship that associates a component with another component.

targetComponentTypeId -> (string)

The ID of the target component type associated with this relationship.

relationshipType -> (string)

The type of the relationship.

isTimeSeries -> (boolean)

A Boolean value that specifies whether the property consists of time series data.

isRequiredInEntity -> (boolean)

A Boolean value that specifies whether the property is required in an entity.

isExternalId -> (boolean)

A Boolean value that specifies whether the property ID comes from an external data store.

isStoredExternally -> (boolean)

A Boolean value that specifies whether the property is stored externally.

isImported -> (boolean)

A Boolean value that specifies whether the property definition is imported from an external data store.

isFinal -> (boolean)

A Boolean value that specifies whether the property definition can be updated.

isInherited -> (boolean)

A Boolean value that specifies whether the property definition is inherited from a parent entity.

defaultValue -> (structure)

An object that contains the default value.

booleanValue -> (boolean)

A Boolean value.

doubleValue -> (double)

A double value.

integerValue -> (integer)

An integer value.

longValue -> (long)

A long value.

stringValue -> (string)

A string value.

listValue -> (list)

A list of multiple values.

(structure)

An object that specifies a value for a property.

booleanValue -> (boolean)

A Boolean value.

doubleValue -> (double)

A double value.

integerValue -> (integer)

An integer value.

longValue -> (long)

A long value.

stringValue -> (string)

A string value.

listValue -> (list)

A list of multiple values.

( ... recursive ... )

mapValue -> (map)

An object that maps strings to multiple DataValue objects.

key -> (string)

( ... recursive ... )

relationshipValue -> (structure)

A value that relates a component to another component.

targetEntityId -> (string)

The ID of the target entity associated with this relationship value.

targetComponentName -> (string)

The name of the target component associated with the relationship value.

expression -> (string)

An expression that produces the value.

mapValue -> (map)

An object that maps strings to multiple DataValue objects.

key -> (string)

value -> (structure)

An object that specifies a value for a property.

booleanValue -> (boolean)

A Boolean value.

doubleValue -> (double)

A double value.

integerValue -> (integer)

An integer value.

longValue -> (long)

A long value.

stringValue -> (string)

A string value.

listValue -> (list)

A list of multiple values.

( ... recursive ... )

mapValue -> (map)

An object that maps strings to multiple DataValue objects.

key -> (string)

( ... recursive ... )

relationshipValue -> (structure)

A value that relates a component to another component.

targetEntityId -> (string)

The ID of the target entity associated with this relationship value.

targetComponentName -> (string)

The name of the target component associated with the relationship value.

expression -> (string)

An expression that produces the value.

relationshipValue -> (structure)

A value that relates a component to another component.

targetEntityId -> (string)

The ID of the target entity associated with this relationship value.

targetComponentName -> (string)

The name of the target component associated with the relationship value.

expression -> (string)

An expression that produces the value.

configuration -> (map)

A mapping that specifies configuration information about the property.

key -> (string)

value -> (string)

displayName -> (string)

A friendly name for the property.

value -> (structure)

The value of the property.

booleanValue -> (boolean)

A Boolean value.

doubleValue -> (double)

A double value.

integerValue -> (integer)

An integer value.

longValue -> (long)

A long value.

stringValue -> (string)

A string value.

listValue -> (list)

A list of multiple values.

(structure)

An object that specifies a value for a property.

booleanValue -> (boolean)

A Boolean value.

doubleValue -> (double)

A double value.

integerValue -> (integer)

An integer value.

longValue -> (long)

A long value.

stringValue -> (string)

A string value.

listValue -> (list)

A list of multiple values.

( ... recursive ... )

mapValue -> (map)

An object that maps strings to multiple DataValue objects.

key -> (string)

( ... recursive ... )

relationshipValue -> (structure)

A value that relates a component to another component.

targetEntityId -> (string)

The ID of the target entity associated with this relationship value.

targetComponentName -> (string)

The name of the target component associated with the relationship value.

expression -> (string)

An expression that produces the value.

mapValue -> (map)

An object that maps strings to multiple DataValue objects.

key -> (string)

value -> (structure)

An object that specifies a value for a property.

booleanValue -> (boolean)

A Boolean value.

doubleValue -> (double)

A double value.

integerValue -> (integer)

An integer value.

longValue -> (long)

A long value.

stringValue -> (string)

A string value.

listValue -> (list)

A list of multiple values.

( ... recursive ... )

mapValue -> (map)

An object that maps strings to multiple DataValue objects.

key -> (string)

( ... recursive ... )

relationshipValue -> (structure)

A value that relates a component to another component.

targetEntityId -> (string)

The ID of the target entity associated with this relationship value.

targetComponentName -> (string)

The name of the target component associated with the relationship value.

expression -> (string)

An expression that produces the value.

relationshipValue -> (structure)

A value that relates a component to another component.

targetEntityId -> (string)

The ID of the target entity associated with this relationship value.

targetComponentName -> (string)

The name of the target component associated with the relationship value.

expression -> (string)

An expression that produces the value.

areAllPropertyValuesReturned -> (boolean)

This flag notes whether all values of a list or map type property are returned in the API response. The maximum number of values per property returned is 50.

propertyGroups -> (map)

The property groups.

key -> (string)

value -> (structure)

The component property group response.

groupType -> (string)

The group type.

propertyNames -> (list)

The names of properties

(string)

isInherited -> (boolean)

A Boolean value that specifies whether the property group is inherited from a parent entity

syncSource -> (string)

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

areAllPropertiesReturned -> (boolean)

This flag notes whether all properties of the component are returned in the API response. The maximum number of properties returned is 800.

compositeComponents -> (map)

This lists objects that contain information about the compositeComponents .

key -> (string)

value -> (structure)

An object that returns information about a component summary.

componentName -> (string)

The name of the component.

componentTypeId -> (string)

The ID of the component type.

definedIn -> (string)

The name of the property definition set in the request.

description -> (string)

The description of the component request.

propertyGroups -> (map)

The property groups.

key -> (string)

value -> (structure)

The component property group response.

groupType -> (string)

The group type.

propertyNames -> (list)

The names of properties

(string)

isInherited -> (boolean)

A Boolean value that specifies whether the property group is inherited from a parent entity

status -> (structure)

The status of the component type.

state -> (string)

The current state of the entity, component, component type, or workspace.

error -> (structure)

The error message.

code -> (string)

The error code.

message -> (string)

The error message.

syncSource -> (string)

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

componentPath -> (string)

This string specifies the path to the composite component, starting from the top-level component.

areAllCompositeComponentsReturned -> (boolean)

This flag notes whether all compositeComponents are returned in the API response.

parentEntityId -> (string)

The ID of the parent entity for this entity.

hasChildEntities -> (boolean)

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

creationDateTime -> (timestamp)

The date and time when the entity was created.

updateDateTime -> (timestamp)

The date and time when the entity was last updated.

syncSource -> (string)

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

areAllComponentsReturned -> (boolean)

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