[ aws . iottwinmaker ]

list-entities

Description

Lists all entities in a workspace.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  list-entities
[--filters <value>]
[--max-results <value>]
[--next-token <value>]
--workspace-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--filters (list)

A list of objects that filter the request.

(structure)

An object that filters items in a list of entities.

componentTypeId -> (string)

The ID of the component type in the entities in the list.

parentEntityId -> (string)

The parent of the entities in the list.

Shorthand Syntax:

componentTypeId=string,parentEntityId=string ...

JSON Syntax:

[
  {
    "componentTypeId": "string",
    "parentEntityId": "string"
  }
  ...
]

--max-results (integer)

The maximum number of results to display.

--next-token (string)

The string that specifies the next page of results.

--workspace-id (string)

The ID of the workspace.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

entitySummaries -> (list)

A list of objects that contain information about the entities.

(structure)

An object that contains information about an entity.

arn -> (string)

The ARN of the entity.

creationDateTime -> (timestamp)

The date and time when the entity was created.

description -> (string)

The description of the entity.

entityId -> (string)

The ID of the entity.

entityName -> (string)

The name of the entity.

hasChildEntities -> (boolean)

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

parentEntityId -> (string)

The ID of the parent entity.

status -> (structure)

The current status of the entity.

error -> (structure)

The error message.

code -> (string)

The error code.

message -> (string)

The error message.

state -> (string)

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

updateDateTime -> (timestamp)

The last date and time when the entity was updated.

nextToken -> (string)

The string that specifies the next page of results.