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-components

Description

This API lists the components of an entity.

See also: AWS API Documentation

Synopsis

  list-components
--workspace-id <value>
--entity-id <value>
[--component-path <value>]
[--max-results <value>]
[--next-token <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 workspace ID.

--entity-id (string)

The ID for the entity whose metadata (component/properties) is returned by the operation.

--component-path (string)

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

--max-results (integer)

The maximum number of results returned at one time. The default is 25.

--next-token (string)

The string that specifies the next page of results.

--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.

--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

componentSummaries -> (list)

A list of objects that contain information about the components.

(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.

nextToken -> (string)

The string that specifies the next page of component results.