aws-sdk
Version:
AWS SDK for JavaScript
2,026 lines (2,025 loc) • 120 kB
JSON
{
"version": "2.0",
"metadata": {
"apiVersion": "2020-11-22",
"endpointPrefix": "api.iotwireless",
"protocol": "rest-json",
"protocols": [
"rest-json"
],
"serviceFullName": "AWS IoT Wireless",
"serviceId": "IoT Wireless",
"signatureVersion": "v4",
"signingName": "iotwireless",
"uid": "iotwireless-2020-11-22",
"auth": [
"aws.auth#sigv4"
]
},
"operations": {
"AssociateAwsAccountWithPartnerAccount": {
"http": {
"requestUri": "/partner-accounts"
},
"input": {
"type": "structure",
"required": [
"Sidewalk"
],
"members": {
"Sidewalk": {
"shape": "S2"
},
"ClientRequestToken": {
"idempotencyToken": true
},
"Tags": {
"shape": "S6"
}
}
},
"output": {
"type": "structure",
"members": {
"Sidewalk": {
"shape": "S2"
},
"Arn": {}
}
}
},
"AssociateMulticastGroupWithFuotaTask": {
"http": {
"method": "PUT",
"requestUri": "/fuota-tasks/{Id}/multicast-group",
"responseCode": 204
},
"input": {
"type": "structure",
"required": [
"Id",
"MulticastGroupId"
],
"members": {
"Id": {
"location": "uri",
"locationName": "Id"
},
"MulticastGroupId": {}
}
},
"output": {
"type": "structure",
"members": {}
}
},
"AssociateWirelessDeviceWithFuotaTask": {
"http": {
"method": "PUT",
"requestUri": "/fuota-tasks/{Id}/wireless-device",
"responseCode": 204
},
"input": {
"type": "structure",
"required": [
"Id",
"WirelessDeviceId"
],
"members": {
"Id": {
"location": "uri",
"locationName": "Id"
},
"WirelessDeviceId": {}
}
},
"output": {
"type": "structure",
"members": {}
}
},
"AssociateWirelessDeviceWithMulticastGroup": {
"http": {
"method": "PUT",
"requestUri": "/multicast-groups/{Id}/wireless-device",
"responseCode": 204
},
"input": {
"type": "structure",
"required": [
"Id",
"WirelessDeviceId"
],
"members": {
"Id": {
"location": "uri",
"locationName": "Id"
},
"WirelessDeviceId": {}
}
},
"output": {
"type": "structure",
"members": {}
}
},
"AssociateWirelessDeviceWithThing": {
"http": {
"method": "PUT",
"requestUri": "/wireless-devices/{Id}/thing",
"responseCode": 204
},
"input": {
"type": "structure",
"required": [
"Id",
"ThingArn"
],
"members": {
"Id": {
"location": "uri",
"locationName": "Id"
},
"ThingArn": {}
}
},
"output": {
"type": "structure",
"members": {}
}
},
"AssociateWirelessGatewayWithCertificate": {
"http": {
"method": "PUT",
"requestUri": "/wireless-gateways/{Id}/certificate"
},
"input": {
"type": "structure",
"required": [
"Id",
"IotCertificateId"
],
"members": {
"Id": {
"location": "uri",
"locationName": "Id"
},
"IotCertificateId": {}
}
},
"output": {
"type": "structure",
"members": {
"IotCertificateId": {}
}
}
},
"AssociateWirelessGatewayWithThing": {
"http": {
"method": "PUT",
"requestUri": "/wireless-gateways/{Id}/thing",
"responseCode": 204
},
"input": {
"type": "structure",
"required": [
"Id",
"ThingArn"
],
"members": {
"Id": {
"location": "uri",
"locationName": "Id"
},
"ThingArn": {}
}
},
"output": {
"type": "structure",
"members": {}
}
},
"CancelMulticastGroupSession": {
"http": {
"method": "DELETE",
"requestUri": "/multicast-groups/{Id}/session",
"responseCode": 204
},
"input": {
"type": "structure",
"required": [
"Id"
],
"members": {
"Id": {
"location": "uri",
"locationName": "Id"
}
}
},
"output": {
"type": "structure",
"members": {}
}
},
"CreateDestination": {
"http": {
"requestUri": "/destinations",
"responseCode": 201
},
"input": {
"type": "structure",
"required": [
"Name",
"ExpressionType",
"Expression",
"RoleArn"
],
"members": {
"Name": {},
"ExpressionType": {},
"Expression": {},
"Description": {},
"RoleArn": {},
"Tags": {
"shape": "S6"
},
"ClientRequestToken": {
"idempotencyToken": true
}
}
},
"output": {
"type": "structure",
"members": {
"Arn": {},
"Name": {}
}
}
},
"CreateDeviceProfile": {
"http": {
"requestUri": "/device-profiles",
"responseCode": 201
},
"input": {
"type": "structure",
"members": {
"Name": {},
"LoRaWAN": {
"shape": "S16"
},
"Tags": {
"shape": "S6"
},
"ClientRequestToken": {
"idempotencyToken": true
},
"Sidewalk": {
"type": "structure",
"members": {}
}
}
},
"output": {
"type": "structure",
"members": {
"Arn": {},
"Id": {}
}
}
},
"CreateFuotaTask": {
"http": {
"requestUri": "/fuota-tasks",
"responseCode": 201
},
"input": {
"type": "structure",
"required": [
"FirmwareUpdateImage",
"FirmwareUpdateRole"
],
"members": {
"Name": {},
"Description": {},
"ClientRequestToken": {
"idempotencyToken": true
},
"LoRaWAN": {
"shape": "S1x"
},
"FirmwareUpdateImage": {},
"FirmwareUpdateRole": {},
"Tags": {
"shape": "S6"
},
"RedundancyPercent": {
"type": "integer"
},
"FragmentSizeBytes": {
"type": "integer"
},
"FragmentIntervalMS": {
"type": "integer"
}
}
},
"output": {
"type": "structure",
"members": {
"Arn": {},
"Id": {}
}
}
},
"CreateMulticastGroup": {
"http": {
"requestUri": "/multicast-groups",
"responseCode": 201
},
"input": {
"type": "structure",
"required": [
"LoRaWAN"
],
"members": {
"Name": {},
"Description": {},
"ClientRequestToken": {
"idempotencyToken": true
},
"LoRaWAN": {
"shape": "S28"
},
"Tags": {
"shape": "S6"
}
}
},
"output": {
"type": "structure",
"members": {
"Arn": {},
"Id": {}
}
}
},
"CreateNetworkAnalyzerConfiguration": {
"http": {
"requestUri": "/network-analyzer-configurations",
"responseCode": 201
},
"input": {
"type": "structure",
"required": [
"Name"
],
"members": {
"Name": {},
"TraceContent": {
"shape": "S2e"
},
"WirelessDevices": {
"shape": "S2i"
},
"WirelessGateways": {
"shape": "S2j"
},
"Description": {},
"Tags": {
"shape": "S6"
},
"ClientRequestToken": {
"idempotencyToken": true
},
"MulticastGroups": {
"shape": "S2k"
}
}
},
"output": {
"type": "structure",
"members": {
"Arn": {},
"Name": {}
}
}
},
"CreateServiceProfile": {
"http": {
"requestUri": "/service-profiles",
"responseCode": 201
},
"input": {
"type": "structure",
"members": {
"Name": {},
"LoRaWAN": {
"type": "structure",
"members": {
"AddGwMetadata": {
"type": "boolean"
},
"DrMin": {
"type": "integer"
},
"DrMax": {
"type": "integer"
},
"PrAllowed": {
"type": "boolean"
},
"RaAllowed": {
"type": "boolean"
}
}
},
"Tags": {
"shape": "S6"
},
"ClientRequestToken": {
"idempotencyToken": true
}
}
},
"output": {
"type": "structure",
"members": {
"Arn": {},
"Id": {}
}
}
},
"CreateWirelessDevice": {
"http": {
"requestUri": "/wireless-devices",
"responseCode": 201
},
"input": {
"type": "structure",
"required": [
"Type",
"DestinationName"
],
"members": {
"Type": {},
"Name": {},
"Description": {},
"DestinationName": {},
"ClientRequestToken": {
"idempotencyToken": true
},
"LoRaWAN": {
"shape": "S31"
},
"Tags": {
"shape": "S6"
},
"Positioning": {},
"Sidewalk": {
"type": "structure",
"members": {
"DeviceProfileId": {}
}
}
}
},
"output": {
"type": "structure",
"members": {
"Arn": {},
"Id": {}
}
}
},
"CreateWirelessGateway": {
"http": {
"requestUri": "/wireless-gateways",
"responseCode": 201
},
"input": {
"type": "structure",
"required": [
"LoRaWAN"
],
"members": {
"Name": {},
"Description": {},
"LoRaWAN": {
"shape": "S3x"
},
"Tags": {
"shape": "S6"
},
"ClientRequestToken": {
"idempotencyToken": true
}
}
},
"output": {
"type": "structure",
"members": {
"Arn": {},
"Id": {}
}
}
},
"CreateWirelessGatewayTask": {
"http": {
"requestUri": "/wireless-gateways/{Id}/tasks",
"responseCode": 201
},
"input": {
"type": "structure",
"required": [
"Id",
"WirelessGatewayTaskDefinitionId"
],
"members": {
"Id": {
"location": "uri",
"locationName": "Id"
},
"WirelessGatewayTaskDefinitionId": {}
}
},
"output": {
"type": "structure",
"members": {
"WirelessGatewayTaskDefinitionId": {},
"Status": {}
}
}
},
"CreateWirelessGatewayTaskDefinition": {
"http": {
"requestUri": "/wireless-gateway-task-definitions",
"responseCode": 201
},
"input": {
"type": "structure",
"required": [
"AutoCreateTasks"
],
"members": {
"AutoCreateTasks": {
"type": "boolean"
},
"Name": {},
"Update": {
"shape": "S4j"
},
"ClientRequestToken": {
"idempotencyToken": true
},
"Tags": {
"shape": "S6"
}
}
},
"output": {
"type": "structure",
"members": {
"Id": {},
"Arn": {}
}
}
},
"DeleteDestination": {
"http": {
"method": "DELETE",
"requestUri": "/destinations/{Name}",
"responseCode": 204
},
"input": {
"type": "structure",
"required": [
"Name"
],
"members": {
"Name": {
"location": "uri",
"locationName": "Name"
}
}
},
"output": {
"type": "structure",
"members": {}
}
},
"DeleteDeviceProfile": {
"http": {
"method": "DELETE",
"requestUri": "/device-profiles/{Id}",
"responseCode": 204
},
"input": {
"type": "structure",
"required": [
"Id"
],
"members": {
"Id": {
"location": "uri",
"locationName": "Id"
}
}
},
"output": {
"type": "structure",
"members": {}
}
},
"DeleteFuotaTask": {
"http": {
"method": "DELETE",
"requestUri": "/fuota-tasks/{Id}",
"responseCode": 204
},
"input": {
"type": "structure",
"required": [
"Id"
],
"members": {
"Id": {
"location": "uri",
"locationName": "Id"
}
}
},
"output": {
"type": "structure",
"members": {}
}
},
"DeleteMulticastGroup": {
"http": {
"method": "DELETE",
"requestUri": "/multicast-groups/{Id}",
"responseCode": 204
},
"input": {
"type": "structure",
"required": [
"Id"
],
"members": {
"Id": {
"location": "uri",
"locationName": "Id"
}
}
},
"output": {
"type": "structure",
"members": {}
}
},
"DeleteNetworkAnalyzerConfiguration": {
"http": {
"method": "DELETE",
"requestUri": "/network-analyzer-configurations/{ConfigurationName}",
"responseCode": 204
},
"input": {
"type": "structure",
"required": [
"ConfigurationName"
],
"members": {
"ConfigurationName": {
"location": "uri",
"locationName": "ConfigurationName"
}
}
},
"output": {
"type": "structure",
"members": {}
}
},
"DeleteQueuedMessages": {
"http": {
"method": "DELETE",
"requestUri": "/wireless-devices/{Id}/data",
"responseCode": 204
},
"input": {
"type": "structure",
"required": [
"Id",
"MessageId"
],
"members": {
"Id": {
"location": "uri",
"locationName": "Id"
},
"MessageId": {
"location": "querystring",
"locationName": "messageId"
},
"WirelessDeviceType": {
"location": "querystring",
"locationName": "WirelessDeviceType"
}
}
},
"output": {
"type": "structure",
"members": {}
}
},
"DeleteServiceProfile": {
"http": {
"method": "DELETE",
"requestUri": "/service-profiles/{Id}",
"responseCode": 204
},
"input": {
"type": "structure",
"required": [
"Id"
],
"members": {
"Id": {
"location": "uri",
"locationName": "Id"
}
}
},
"output": {
"type": "structure",
"members": {}
}
},
"DeleteWirelessDevice": {
"http": {
"method": "DELETE",
"requestUri": "/wireless-devices/{Id}",
"responseCode": 204
},
"input": {
"type": "structure",
"required": [
"Id"
],
"members": {
"Id": {
"location": "uri",
"locationName": "Id"
}
}
},
"output": {
"type": "structure",
"members": {}
}
},
"DeleteWirelessDeviceImportTask": {
"http": {
"method": "DELETE",
"requestUri": "/wireless_device_import_task/{Id}",
"responseCode": 204
},
"input": {
"type": "structure",
"required": [
"Id"
],
"members": {
"Id": {
"location": "uri",
"locationName": "Id"
}
}
},
"output": {
"type": "structure",
"members": {}
}
},
"DeleteWirelessGateway": {
"http": {
"method": "DELETE",
"requestUri": "/wireless-gateways/{Id}",
"responseCode": 204
},
"input": {
"type": "structure",
"required": [
"Id"
],
"members": {
"Id": {
"location": "uri",
"locationName": "Id"
}
}
},
"output": {
"type": "structure",
"members": {}
}
},
"DeleteWirelessGatewayTask": {
"http": {
"method": "DELETE",
"requestUri": "/wireless-gateways/{Id}/tasks",
"responseCode": 204
},
"input": {
"type": "structure",
"required": [
"Id"
],
"members": {
"Id": {
"location": "uri",
"locationName": "Id"
}
}
},
"output": {
"type": "structure",
"members": {}
}
},
"DeleteWirelessGatewayTaskDefinition": {
"http": {
"method": "DELETE",
"requestUri": "/wireless-gateway-task-definitions/{Id}",
"responseCode": 204
},
"input": {
"type": "structure",
"required": [
"Id"
],
"members": {
"Id": {
"location": "uri",
"locationName": "Id"
}
}
},
"output": {
"type": "structure",
"members": {}
}
},
"DeregisterWirelessDevice": {
"http": {
"method": "PATCH",
"requestUri": "/wireless-devices/{Identifier}/deregister"
},
"input": {
"type": "structure",
"required": [
"Identifier"
],
"members": {
"Identifier": {
"location": "uri",
"locationName": "Identifier"
},
"WirelessDeviceType": {
"location": "querystring",
"locationName": "WirelessDeviceType"
}
}
},
"output": {
"type": "structure",
"members": {}
}
},
"DisassociateAwsAccountFromPartnerAccount": {
"http": {
"method": "DELETE",
"requestUri": "/partner-accounts/{PartnerAccountId}",
"responseCode": 204
},
"input": {
"type": "structure",
"required": [
"PartnerAccountId",
"PartnerType"
],
"members": {
"PartnerAccountId": {
"location": "uri",
"locationName": "PartnerAccountId"
},
"PartnerType": {
"location": "querystring",
"locationName": "partnerType"
}
}
},
"output": {
"type": "structure",
"members": {}
}
},
"DisassociateMulticastGroupFromFuotaTask": {
"http": {
"method": "DELETE",
"requestUri": "/fuota-tasks/{Id}/multicast-groups/{MulticastGroupId}",
"responseCode": 204
},
"input": {
"type": "structure",
"required": [
"Id",
"MulticastGroupId"
],
"members": {
"Id": {
"location": "uri",
"locationName": "Id"
},
"MulticastGroupId": {
"location": "uri",
"locationName": "MulticastGroupId"
}
}
},
"output": {
"type": "structure",
"members": {}
}
},
"DisassociateWirelessDeviceFromFuotaTask": {
"http": {
"method": "DELETE",
"requestUri": "/fuota-tasks/{Id}/wireless-devices/{WirelessDeviceId}",
"responseCode": 204
},
"input": {
"type": "structure",
"required": [
"Id",
"WirelessDeviceId"
],
"members": {
"Id": {
"location": "uri",
"locationName": "Id"
},
"WirelessDeviceId": {
"location": "uri",
"locationName": "WirelessDeviceId"
}
}
},
"output": {
"type": "structure",
"members": {}
}
},
"DisassociateWirelessDeviceFromMulticastGroup": {
"http": {
"method": "DELETE",
"requestUri": "/multicast-groups/{Id}/wireless-devices/{WirelessDeviceId}",
"responseCode": 204
},
"input": {
"type": "structure",
"required": [
"Id",
"WirelessDeviceId"
],
"members": {
"Id": {
"location": "uri",
"locationName": "Id"
},
"WirelessDeviceId": {
"location": "uri",
"locationName": "WirelessDeviceId"
}
}
},
"output": {
"type": "structure",
"members": {}
}
},
"DisassociateWirelessDeviceFromThing": {
"http": {
"method": "DELETE",
"requestUri": "/wireless-devices/{Id}/thing",
"responseCode": 204
},
"input": {
"type": "structure",
"required": [
"Id"
],
"members": {
"Id": {
"location": "uri",
"locationName": "Id"
}
}
},
"output": {
"type": "structure",
"members": {}
}
},
"DisassociateWirelessGatewayFromCertificate": {
"http": {
"method": "DELETE",
"requestUri": "/wireless-gateways/{Id}/certificate",
"responseCode": 204
},
"input": {
"type": "structure",
"required": [
"Id"
],
"members": {
"Id": {
"location": "uri",
"locationName": "Id"
}
}
},
"output": {
"type": "structure",
"members": {}
}
},
"DisassociateWirelessGatewayFromThing": {
"http": {
"method": "DELETE",
"requestUri": "/wireless-gateways/{Id}/thing",
"responseCode": 204
},
"input": {
"type": "structure",
"required": [
"Id"
],
"members": {
"Id": {
"location": "uri",
"locationName": "Id"
}
}
},
"output": {
"type": "structure",
"members": {}
}
},
"GetDestination": {
"http": {
"method": "GET",
"requestUri": "/destinations/{Name}"
},
"input": {
"type": "structure",
"required": [
"Name"
],
"members": {
"Name": {
"location": "uri",
"locationName": "Name"
}
}
},
"output": {
"type": "structure",
"members": {
"Arn": {},
"Name": {},
"Expression": {},
"ExpressionType": {},
"Description": {},
"RoleArn": {}
}
}
},
"GetDeviceProfile": {
"http": {
"method": "GET",
"requestUri": "/device-profiles/{Id}"
},
"input": {
"type": "structure",
"required": [
"Id"
],
"members": {
"Id": {
"location": "uri",
"locationName": "Id"
}
}
},
"output": {
"type": "structure",
"members": {
"Arn": {},
"Name": {},
"Id": {},
"LoRaWAN": {
"shape": "S16"
},
"Sidewalk": {
"type": "structure",
"members": {
"ApplicationServerPublicKey": {
"type": "string",
"sensitive": true
},
"QualificationStatus": {
"type": "boolean"
},
"DakCertificateMetadata": {
"type": "list",
"member": {
"type": "structure",
"required": [
"CertificateId"
],
"members": {
"CertificateId": {},
"MaxAllowedSignature": {
"type": "integer"
},
"FactorySupport": {
"type": "boolean"
},
"ApId": {},
"DeviceTypeId": {}
}
}
}
}
}
}
}
},
"GetEventConfigurationByResourceTypes": {
"http": {
"method": "GET",
"requestUri": "/event-configurations-resource-types"
},
"input": {
"type": "structure",
"members": {}
},
"output": {
"type": "structure",
"members": {
"DeviceRegistrationState": {
"shape": "S6j"
},
"Proximity": {
"shape": "S6m"
},
"Join": {
"shape": "S6n"
},
"ConnectionStatus": {
"shape": "S6p"
},
"MessageDeliveryStatus": {
"shape": "S6r"
}
}
}
},
"GetFuotaTask": {
"http": {
"method": "GET",
"requestUri": "/fuota-tasks/{Id}"
},
"input": {
"type": "structure",
"required": [
"Id"
],
"members": {
"Id": {
"location": "uri",
"locationName": "Id"
}
}
},
"output": {
"type": "structure",
"members": {
"Arn": {},
"Id": {},
"Status": {},
"Name": {},
"Description": {},
"LoRaWAN": {
"type": "structure",
"members": {
"RfRegion": {},
"StartTime": {
"shape": "S6w"
}
}
},
"FirmwareUpdateImage": {},
"FirmwareUpdateRole": {},
"CreatedAt": {
"type": "timestamp"
},
"RedundancyPercent": {
"type": "integer"
},
"FragmentSizeBytes": {
"type": "integer"
},
"FragmentIntervalMS": {
"type": "integer"
}
}
}
},
"GetLogLevelsByResourceTypes": {
"http": {
"method": "GET",
"requestUri": "/log-levels",
"responseCode": 200
},
"input": {
"type": "structure",
"members": {}
},
"output": {
"type": "structure",
"members": {
"DefaultLogLevel": {},
"WirelessGatewayLogOptions": {
"shape": "S70"
},
"WirelessDeviceLogOptions": {
"shape": "S76"
}
}
}
},
"GetMetricConfiguration": {
"http": {
"method": "GET",
"requestUri": "/metric-configuration",
"responseCode": 200
},
"input": {
"type": "structure",
"members": {}
},
"output": {
"type": "structure",
"members": {
"SummaryMetric": {
"shape": "S7d"
}
}
}
},
"GetMetrics": {
"http": {
"requestUri": "/metrics"
},
"input": {
"type": "structure",
"members": {
"SummaryMetricQueries": {
"type": "list",
"member": {
"type": "structure",
"members": {
"QueryId": {},
"MetricName": {},
"Dimensions": {
"shape": "S7k"
},
"AggregationPeriod": {},
"StartTimestamp": {
"type": "timestamp"
},
"EndTimestamp": {
"type": "timestamp"
}
}
}
}
}
},
"output": {
"type": "structure",
"members": {
"SummaryMetricQueryResults": {
"type": "list",
"member": {
"type": "structure",
"members": {
"QueryId": {},
"QueryStatus": {},
"Error": {},
"MetricName": {},
"Dimensions": {
"shape": "S7k"
},
"AggregationPeriod": {},
"StartTimestamp": {
"type": "timestamp"
},
"EndTimestamp": {
"type": "timestamp"
},
"Timestamps": {
"type": "list",
"member": {
"type": "timestamp"
}
},
"Values": {
"type": "list",
"member": {
"type": "structure",
"members": {
"Min": {
"type": "double"
},
"Max": {
"type": "double"
},
"Sum": {
"type": "double"
},
"Avg": {
"type": "double"
},
"Std": {
"type": "double"
},
"P90": {
"type": "double"
}
}
}
},
"Unit": {}
}
}
}
}
}
},
"GetMulticastGroup": {
"http": {
"method": "GET",
"requestUri": "/multicast-groups/{Id}"
},
"input": {
"type": "structure",
"required": [
"Id"
],
"members": {
"Id": {
"location": "uri",
"locationName": "Id"
}
}
},
"output": {
"type": "structure",
"members": {
"Arn": {},
"Id": {},
"Name": {},
"Description": {},
"Status": {},
"LoRaWAN": {
"type": "structure",
"members": {
"RfRegion": {},
"DlClass": {},
"NumberOfDevicesRequested": {
"type": "integer"
},
"NumberOfDevicesInGroup": {
"type": "integer"
}
}
},
"CreatedAt": {
"type": "timestamp"
}
}
}
},
"GetMulticastGroupSession": {
"http": {
"method": "GET",
"requestUri": "/multicast-groups/{Id}/session"
},
"input": {
"type": "structure",
"required": [
"Id"
],
"members": {
"Id": {
"location": "uri",
"locationName": "Id"
}
}
},
"output": {
"type": "structure",
"members": {
"LoRaWAN": {
"shape": "S8f"
}
}
}
},
"GetNetworkAnalyzerConfiguration": {
"http": {
"method": "GET",
"requestUri": "/network-analyzer-configurations/{ConfigurationName}",
"responseCode": 200
},
"input": {
"type": "structure",
"required": [
"ConfigurationName"
],
"members": {
"ConfigurationName": {
"location": "uri",
"locationName": "ConfigurationName"
}
}
},
"output": {
"type": "structure",
"members": {
"TraceContent": {
"shape": "S2e"
},
"WirelessDevices": {
"shape": "S2i"
},
"WirelessGateways": {
"shape": "S2j"
},
"Description": {},
"Arn": {},
"Name": {},
"MulticastGroups": {
"shape": "S2k"
}
}
}
},
"GetPartnerAccount": {
"http": {
"method": "GET",
"requestUri": "/partner-accounts/{PartnerAccountId}"
},
"input": {
"type": "structure",
"required": [
"PartnerAccountId",
"PartnerType"
],
"members": {
"PartnerAccountId": {
"location": "uri",
"locationName": "PartnerAccountId"
},
"PartnerType": {
"location": "querystring",
"locationName": "partnerType"
}
}
},
"output": {
"type": "structure",
"members": {
"Sidewalk": {
"shape": "S8o"
},
"AccountLinked": {
"type": "boolean"
}
}
}
},
"GetPosition": {
"http": {
"method": "GET",
"requestUri": "/positions/{ResourceIdentifier}"
},
"input": {
"type": "structure",
"required": [
"ResourceIdentifier",
"ResourceType"
],
"members": {
"ResourceIdentifier": {
"location": "uri",
"locationName": "ResourceIdentifier"
},
"ResourceType": {
"location": "querystring",
"locationName": "resourceType"
}
},
"deprecated": true,
"deprecatedMessage": "This operation is no longer supported."
},
"output": {
"type": "structure",
"members": {
"Position": {
"shape": "S8v"
},
"Accuracy": {
"type": "structure",
"members": {
"HorizontalAccuracy": {
"type": "float"
},
"VerticalAccuracy": {
"type": "float"
}
}
},
"SolverType": {},
"SolverProvider": {},
"SolverVersion": {},
"Timestamp": {}
},
"deprecated": true,
"deprecatedMessage": "This operation is no longer supported."
},
"deprecated": true,
"deprecatedMessage": "This operation is no longer supported."
},
"GetPositionConfiguration": {
"http": {
"method": "GET",
"requestUri": "/position-configurations/{ResourceIdentifier}",
"responseCode": 200
},
"input": {
"type": "structure",
"required": [
"ResourceIdentifier",
"ResourceType"
],
"members": {
"ResourceIdentifier": {
"location": "uri",
"locationName": "ResourceIdentifier"
},
"ResourceType": {
"location": "querystring",
"locationName": "resourceType"
}
},
"deprecated": true,
"deprecatedMessage": "This operation is no longer supported."
},
"output": {
"type": "structure",
"members": {
"Solvers": {
"shape": "S96"
},
"Destination": {}
},
"deprecated": true,
"deprecatedMessage": "This operation is no longer supported."
},
"deprecated": true,
"deprecatedMessage": "This operation is no longer supported."
},
"GetPositionEstimate": {
"http": {
"requestUri": "/position-estimate"
},
"input": {
"type": "structure",
"members": {
"WiFiAccessPoints": {
"type": "list",
"member": {
"type": "structure",
"required": [
"MacAddress",
"Rss"
],
"members": {
"MacAddress": {},
"Rss": {
"type": "integer"
}
}
}
},
"CellTowers": {
"type": "structure",
"members": {
"Gsm": {
"type": "list",
"member": {
"type": "structure",
"required": [
"Mcc",
"Mnc",
"Lac",
"GeranCid"
],
"members": {
"Mcc": {
"type": "integer"
},
"Mnc": {
"type": "integer"
},
"Lac": {
"type": "integer"
},
"GeranCid": {
"type": "integer"
},
"GsmLocalId": {
"type": "structure",
"required": [
"Bsic",
"Bcch"
],
"members": {
"Bsic": {
"type": "integer"
},
"Bcch": {
"type": "integer"
}
}
},
"GsmTimingAdvance": {
"type": "integer"
},
"RxLevel": {
"type": "integer"
},
"GsmNmr": {
"type": "list",
"member": {
"type": "structure",
"required": [
"Bsic",
"Bcch"
],
"members": {
"Bsic": {
"type": "integer"
},
"Bcch": {
"type": "integer"
},
"RxLevel": {
"type": "integer"
},
"GlobalIdentity": {
"type": "structure",
"required": [
"Lac",
"GeranCid"
],
"members": {
"Lac": {
"type": "integer"
},
"GeranCid": {
"type": "integer"
}
}
}
}
}
}
}
}
},
"Wcdma": {
"type": "list",
"member": {
"type": "structure",
"required": [
"Mcc",
"Mnc",
"UtranCid"
],
"members": {
"Mcc": {
"type": "integer"
},
"Mnc": {
"type": "integer"
},
"Lac": {
"type": "integer"
},
"UtranCid": {
"type": "integer"
},
"WcdmaLocalId": {
"type": "structure",
"required": [
"Uarfcndl",
"Psc"
],
"members": {
"Uarfcndl": {
"type": "integer"
},
"Psc": {
"type": "integer"
}
}
},
"Rscp": {
"type": "integer"
},
"PathLoss": {
"type": "integer"
},
"WcdmaNmr": {
"type": "list",
"member": {
"type": "structure",
"required": [
"Uarfcndl",
"Psc",
"UtranCid"
],
"members": {
"Uarfcndl": {
"type": "integer"
},
"Psc": {
"type": "integer"
},
"UtranCid": {
"type": "integer"
},
"Rscp": {
"type": "integer"
},
"PathLoss": {
"type": "integer"
}
}
}
}
}
}
},
"Tdscdma": {
"type": "list",
"member": {
"type": "structure",
"required": [
"Mcc",
"Mnc",
"UtranCid"
],
"members": {
"Mcc": {
"type": "integer"
},
"Mnc": {
"type": "integer"
},
"Lac": {
"type": "integer"
},
"UtranCid": {
"type": "integer"
},
"TdscdmaLocalId": {
"type": "structure",
"required": [
"Uarfcn",
"CellParams"
],
"members": {
"Uarfcn": {
"type": "integer"
},
"CellParams": {
"type": "integer"
}
}
},
"TdscdmaTimingAdvance": {
"type": "integer"
},
"Rscp": {
"type": "integer"
},
"PathLoss": {
"type": "integer"
},
"TdscdmaNmr": {
"type": "list",
"member": {
"type": "structure",
"required": [
"Uarfcn",
"CellParams"
],
"members": {
"Uarfcn": {
"type": "integer"
},
"CellParams": {
"type": "integer"
},
"UtranCid": {
"type": "integer"
},
"Rscp": {
"type": "integer"
},
"PathLoss": {
"type": "integer"
}
}
}
}
}
}
},
"Lte": {
"type": "list",
"member": {
"type": "structure",
"required": [
"Mcc",
"Mnc",
"EutranCid"
],
"members": {
"Mcc": {
"type": "integer"
},
"Mnc": {
"type": "integer"
},
"EutranCid": {
"type": "integer"
},
"Tac": {
"type": "integer"
},
"LteLocalId": {
"type": "structure",
"required": [
"Pci",
"Earfcn"
],
"members": {
"Pci": {
"type": "integer"
},
"Earfcn": {
"type": "integer"
}
}
},
"LteTimingAdvance": {
"type": "integer"
},
"Rsrp": {
"type": "integer"
},
"Rsrq": {
"type": "float"
},
"NrCapable": {
"type": "boolean"
},
"LteNmr": {
"type": "list",
"member": {
"type": "structure",
"required": [
"Pci",
"Earfcn",
"EutranCid"
],
"members": {
"Pci": {
"type": "integer"
},
"Earfcn": {
"type": "integer"
},
"EutranCid": {
"type": "integer"
},
"Rsrp": {
"type": "integer"
},
"Rsrq": {
"type": "float"
}
}
}
}
}
}
},
"Cdma": {
"type": "list",
"member": {
"type": "structure",
"required": [
"SystemId",
"NetworkId",
"BaseStationId"
],
"members": {
"SystemId": {
"type": "integer"
},
"NetworkId": {
"type": "integer"
},
"BaseStationId": {
"type": "integer"
},
"RegistrationZone": {
"type": "integer"
},
"CdmaLocalId": {
"type": "structure",
"required": [
"PnOffset",
"CdmaChannel"
],
"members": {
"PnOffset": {
"type": "integer"
},
"CdmaChannel": {
"type": "integer"
}
}
},
"PilotPower": {
"type": "integer"
},
"BaseLat": {
"type": "float"
},
"BaseLng": {
"type": "float"
},
"CdmaNmr": {
"type": "list",
"member": {
"type": "structure",
"required": [
"PnOffset",
"CdmaChannel"
],
"members": {
"PnOffset": {
"type": "integer"
},
"CdmaChannel": {
"type": "integer"
},
"PilotPower": {
"type": "integer"
},
"BaseStationId": {
"type": "integer"
}
}
}