ProvisionDeviceCommand

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. Name the configuration archive certificates-omni_device-name.zip and transfer it to the device within 5 minutes. Use the included USB storage device and connect it to the USB 3.0 port next to the HDMI output.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { PanoramaClient, ProvisionDeviceCommand } from "@aws-sdk/client-panorama"; // ES Modules import
// const { PanoramaClient, ProvisionDeviceCommand } = require("@aws-sdk/client-panorama"); // CommonJS import
const client = new PanoramaClient(config);
const input = { // ProvisionDeviceRequest
  Name: "STRING_VALUE", // required
  Description: "STRING_VALUE",
  Tags: { // TagMap
    "<keys>": "STRING_VALUE",
  },
  NetworkingConfiguration: { // NetworkPayload
    Ethernet0: { // EthernetPayload
      ConnectionType: "STRING_VALUE", // required
      StaticIpConnectionInfo: { // StaticIpConnectionInfo
        IpAddress: "STRING_VALUE", // required
        Mask: "STRING_VALUE", // required
        Dns: [ // DnsList // required
          "STRING_VALUE",
        ],
        DefaultGateway: "STRING_VALUE", // required
      },
    },
    Ethernet1: {
      ConnectionType: "STRING_VALUE", // required
      StaticIpConnectionInfo: {
        IpAddress: "STRING_VALUE", // required
        Mask: "STRING_VALUE", // required
        Dns: [ // required
          "STRING_VALUE",
        ],
        DefaultGateway: "STRING_VALUE", // required
      },
    },
    Ntp: { // NtpPayload
      NtpServers: [ // NtpServerList // required
        "STRING_VALUE",
      ],
    },
  },
};
const command = new ProvisionDeviceCommand(input);
const response = await client.send(command);
// { // ProvisionDeviceResponse
//   DeviceId: "STRING_VALUE",
//   Arn: "STRING_VALUE", // required
//   Status: "STRING_VALUE", // required
//   Certificates: new Uint8Array(),
//   IotThingName: "STRING_VALUE",
// };

ProvisionDeviceCommand Input

See ProvisionDeviceCommandInput for more details

Parameter
Type
Description
Name
Required
string | undefined

A name for the device.

Description
string | undefined

A description for the device.

NetworkingConfiguration
NetworkPayload | undefined

A networking configuration for the device.

Tags
Record<string, string> | undefined

Tags for the device.

ProvisionDeviceCommand Output

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
Arn
Required
string | undefined

The device's ARN.

Status
Required
DeviceStatus | undefined

The device's status.

Certificates
Uint8Array | undefined

The device's configuration bundle.

DeviceId
string | undefined

The device's ID.

IotThingName
string | undefined

The device's IoT thing name.

Throws

Name
Fault
Details
AccessDeniedException
client

The requestor does not have permission to access the target action or resource.

ConflictException
client

The target resource is in use.

InternalServerException
server

An internal error occurred.

ServiceQuotaExceededException
client

The request would cause a limit to be exceeded.

ValidationException
client

The request contains an invalid parameter value.

PanoramaServiceException
Base exception class for all service exceptions from Panorama service.