createDevice method

Future<CreateDeviceResponse> createDevice({ required String globalNetworkId, AWSLocation? awsLocation, String? description, Location? location, String? model, String? serialNumber, String? siteId, List<Tag>? tags, String? type, String? vendor, })

Creates a new device in a global network. If you specify both a site ID and a location, the location of the site is used for visualization in the Network Manager console.

May throw ValidationException. May throw ServiceQuotaExceededException. May throw AccessDeniedException. May throw ResourceNotFoundException. May throw ConflictException. May throw ThrottlingException. May throw InternalServerException.

Parameter globalNetworkId : The ID of the global network.

Parameter awsLocation : The AWS location of the device.

Parameter description : A description of the device.

Length Constraints: Maximum length of 256 characters.

Parameter location : The location of the device.

Parameter model : The model of the device.

Length Constraints: Maximum length of 128 characters.

Parameter serialNumber : The serial number of the device.

Length Constraints: Maximum length of 128 characters.

Parameter siteId : The ID of the site.

Parameter tags : The tags to apply to the resource during creation.

Parameter type : The type of the device.

Parameter vendor : The vendor of the device.

Length Constraints: Maximum length of 128 characters.

Implementation

Future<CreateDeviceResponse> createDevice({
  required String globalNetworkId,
  AWSLocation? awsLocation,
  String? description,
  Location? location,
  String? model,
  String? serialNumber,
  String? siteId,
  List<Tag>? tags,
  String? type,
  String? vendor,
}) async {
  ArgumentError.checkNotNull(globalNetworkId, 'globalNetworkId');
  final $payload = <String, dynamic>{
    if (awsLocation != null) 'AWSLocation': awsLocation,
    if (description != null) 'Description': description,
    if (location != null) 'Location': location,
    if (model != null) 'Model': model,
    if (serialNumber != null) 'SerialNumber': serialNumber,
    if (siteId != null) 'SiteId': siteId,
    if (tags != null) 'Tags': tags,
    if (type != null) 'Type': type,
    if (vendor != null) 'Vendor': vendor,
  };
  final response = await _protocol.send(
    payload: $payload,
    method: 'POST',
    requestUri:
        '/global-networks/${Uri.encodeComponent(globalNetworkId)}/devices',
    exceptionFnMap: _exceptionFns,
  );
  return CreateDeviceResponse.fromJson(response);
}