Creates a device and returns a configuration archive. The configuration archive is a ZIP file that contains a provisioning certificate that is valid for 5 minutes. Transfer the configuration archive to the device with the included USB storage device within 5 minutes.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
provision-device
--name <value>
[--description <value>]
[--tags <value>]
[--networking-configuration <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
--name
(string)
A name for the device.
--description
(string)
A description for the device.
--tags
(map)
Tags for the device.
key -> (string)
value -> (string)
Shorthand Syntax:
KeyName1=string,KeyName2=string
JSON Syntax:
{"string": "string"
...}
--networking-configuration
(structure)
A networking configuration for the device.
Ethernet0 -> (structure)
Settings for Ethernet port 0.
ConnectionType -> (string)
How the device gets an IP address.
StaticIpConnectionInfo -> (structure)
Network configuration for a static IP connection.
IpAddress -> (string)
The connection’s IP address.
Mask -> (string)
The connection’s DNS mask.
Dns -> (list)
The connection’s DNS address.
(string)
DefaultGateway -> (string)
The connection’s default gateway.
Ethernet1 -> (structure)
Settings for Ethernet port 1.
ConnectionType -> (string)
How the device gets an IP address.
StaticIpConnectionInfo -> (structure)
Network configuration for a static IP connection.
IpAddress -> (string)
The connection’s IP address.
Mask -> (string)
The connection’s DNS mask.
Dns -> (list)
The connection’s DNS address.
(string)
DefaultGateway -> (string)
The connection’s default gateway.
JSON Syntax:
{
"Ethernet0": {
"ConnectionType": "STATIC_IP"|"DHCP",
"StaticIpConnectionInfo": {
"IpAddress": "string",
"Mask": "string",
"Dns": ["string", ...],
"DefaultGateway": "string"
}
},
"Ethernet1": {
"ConnectionType": "STATIC_IP"|"DHCP",
"StaticIpConnectionInfo": {
"IpAddress": "string",
"Mask": "string",
"Dns": ["string", ...],
"DefaultGateway": "string"
}
}
}
--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.
DeviceId -> (string)
The device’s ID.
Arn -> (string)
The device’s ARN.
Status -> (string)
The device’s status.
Certificates -> (blob)
The device’s configuration bundle.
IotThingName -> (string)
The device’s IoT thing name.