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 ]

list-component-types

Description

Lists all component types in a workspace.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  list-component-types
[--filters <value>]
[--max-results <value>]
[--next-token <value>]
--workspace-id <value>
[--cli-input-json <value>]
[--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 component types.

Note

Only one object is accepted as a valid input.

extendsFrom -> (string)

The component type that the component types in the list extend.

isAbstract -> (boolean)

A Boolean value that specifies whether the component types in the list are abstract.

namespace -> (string)

The namespace to which the component types in the list belong.

Shorthand Syntax:

extendsFrom=string,isAbstract=boolean,namespace=string ...

JSON Syntax:

[
  {
    "extendsFrom": "string",
    "isAbstract": true|false,
    "namespace": "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 (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.

See 'aws help' for descriptions of global parameters.

Output

componentTypeSummaries -> (list)

A list of objects that contain information about the component types.

(structure)

An object that contains information about a component type.

arn -> (string)

The ARN of the component type.

componentTypeId -> (string)

The ID of the component type.

creationDateTime -> (timestamp)

The date and time when the component type was created.

description -> (string)

The description of the component type.

status -> (structure)

The current status of the component type.

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 date and time when the component type was last updated.

maxResults -> (integer)

Specifies the maximum number of results to display.

nextToken -> (string)

The string that specifies the next page of results.

workspaceId -> (string)

The ID of the workspace.