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 ]

get-wireless-device-import-task

Description

Get information about an import task and count of device onboarding summary information for the import task.

See also: AWS API Documentation

Synopsis

  get-wireless-device-import-task
--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

--id (string)

The identifier of the import task for which information is requested.

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

Id -> (string)

The identifier of the import task for which information is retrieved.

Arn -> (string)

The ARN (Amazon Resource Name) of the import task.

DestinationName -> (string)

The name of the destination that's assigned to the wireless devices in the import task.

Sidewalk -> (structure)

The Sidewalk-related information about an import task.

DeviceCreationFileList -> (list)

List of Sidewalk devices that are added to the import task.

(string)

Role -> (string)

The IAM role that allows AWS IoT Wireless to access the CSV file in the S3 bucket.

CreationTime -> (timestamp)

The time at which the import task was created.

Status -> (string)

The import task status.

StatusReason -> (string)

The reason for the provided status information, such as a validation error that causes the import task to fail.

InitializedImportedDeviceCount -> (long)

The number of devices in the import task that are waiting for the control log to start processing.

PendingImportedDeviceCount -> (long)

The number of devices in the import task that are waiting in the import task queue to be onboarded.

OnboardedImportedDeviceCount -> (long)

The number of devices in the import task that have been onboarded to the import task.

FailedImportedDeviceCount -> (long)

The number of devices in the import task that failed to onboard to the import task.