AWS CLI Command Reference

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

list-devices-for-wireless-device-import-task

Description

List the Sidewalk devices in an import task and their onboarding status.

See also: AWS API Documentation

Synopsis

  list-devices-for-wireless-device-import-task
--id <value>
[--max-results <value>]
[--next-token <value>]
[--status <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

--id (string)

The identifier of the import task for which wireless devices are listed.

--max-results (integer)

The maximum number of results to return in this operation.

--next-token (string)

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

--status (string)

The status of the devices in the import task.

Possible values:

  • INITIALIZED
  • PENDING
  • ONBOARDED
  • FAILED

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

NextToken -> (string)

The token to use to get the next set of results, or null if there are no additional results.

DestinationName -> (string)

The name of the Sidewalk destination that describes the IoT rule to route messages received from devices in an import task that are onboarded to AWS IoT Wireless.

ImportedWirelessDeviceList -> (list)

List of wireless devices in an import task and their onboarding status.

(structure)

Information about a wireless device that has been added to an import task.

Sidewalk -> (structure)

The Sidewalk-related information about a device that has been added to an import task.

SidewalkManufacturingSn -> (string)

The Sidewalk manufacturing serial number (SMSN) of the Sidewalk device.

OnboardingStatus -> (string)

The onboarding status of the Sidewalk device in the import task.

OnboardingStatusReason -> (string)

The reason for the onboarding status information for the Sidewalk device.

LastUpdateTime -> (timestamp)

The time at which the status information was last updated.