Skip to content

Latest commit

 

History

History

amazonaws_iotwireless

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
README.md
README.md
 
 
index.js
index.js
 
 
openapi.json
openapi.json
 
 
package.json
package.json
 
 

README.md

@datafire/amazonaws_iotwireless

Client library for AWS IoT Wireless

Installation and Usage

npm install --save @datafire/amazonaws_iotwireless
let amazonaws_iotwireless = require('@datafire/amazonaws_iotwireless').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

.then(data => {
  console.log(data);
});

Description

AWS IoT Wireless API documentation

Actions

ListDestinations

amazonaws_iotwireless.ListDestinations({}, context)

Input

  • input object
    • maxResults integer
    • nextToken string
    • MaxResults string
    • NextToken string

Output

CreateDestination

amazonaws_iotwireless.CreateDestination({
  "Name": "",
  "ExpressionType": "",
  "Expression": "",
  "RoleArn": ""
}, context)

Input

  • input object
    • ClientRequestToken string: Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.
    • Description string: The description of the new resource.
    • Expression required string: The rule name or topic rule to send messages to.
    • ExpressionType required string (values: RuleName): The type of value in Expression.
    • Name required string: The name of the new resource.
    • RoleArn required string: The ARN of the IAM Role that authorizes the destination.
    • Tags array: The tags to attach to the new destination. Tags are metadata that can be used to manage a resource.

Output

Output schema unknown

DeleteDestination

amazonaws_iotwireless.DeleteDestination({
  "Name": ""
}, context)

Input

  • input object
    • Name required string

Output

Output schema unknown

GetDestination

amazonaws_iotwireless.GetDestination({
  "Name": ""
}, context)

Input

  • input object
    • Name required string

Output

UpdateDestination

amazonaws_iotwireless.UpdateDestination({
  "Name": ""
}, context)

Input

  • input object
    • Name required string
    • Description string: A new description of the resource.
    • Expression string: The new rule name or topic rule to send messages to.
    • ExpressionType string (values: RuleName): The type of value in Expression.
    • RoleArn string: The ARN of the IAM Role that authorizes the destination.

Output

Output schema unknown

ListDeviceProfiles

amazonaws_iotwireless.ListDeviceProfiles({}, context)

Input

  • input object
    • nextToken string
    • maxResults integer
    • MaxResults string
    • NextToken string

Output

CreateDeviceProfile

amazonaws_iotwireless.CreateDeviceProfile({}, context)

Input

  • input object
    • ClientRequestToken string: Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.
    • LoRaWAN object: LoRaWANDeviceProfile object.
      • ClassBTimeout
      • ClassCTimeout
      • FactoryPresetFreqsList
      • MacVersion
      • MaxDutyCycle
      • MaxEirp
      • PingSlotDr
      • PingSlotFreq
      • PingSlotPeriod
      • RegParamsRevision
      • RfRegion
      • RxDataRate2
      • RxDelay1
      • RxDrOffset1
      • RxFreq2
      • Supports32BitFCnt
      • SupportsClassB
      • SupportsClassC
      • SupportsJoin
    • Name string: The name of the new resource.
    • Tags array: The tags to attach to the new device profile Tags are metadata that can be used to manage a resource.

Output

Output schema unknown

DeleteDeviceProfile

amazonaws_iotwireless.DeleteDeviceProfile({
  "Id": ""
}, context)

Input

  • input object
    • Id required string

Output

Output schema unknown

GetDeviceProfile

amazonaws_iotwireless.GetDeviceProfile({
  "Id": ""
}, context)

Input

  • input object
    • Id required string

Output

ListPartnerAccounts

amazonaws_iotwireless.ListPartnerAccounts({}, context)

Input

  • input object
    • nextToken string
    • maxResults integer

Output

AssociateAwsAccountWithPartnerAccount

amazonaws_iotwireless.AssociateAwsAccountWithPartnerAccount({
  "Sidewalk": {}
}, context)

Input

  • input object
    • ClientRequestToken string: Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.
    • Sidewalk required object: Information about a Sidewalk account.
      • AmazonId
      • AppServerPrivateKey

Output

DisassociateAwsAccountFromPartnerAccount

amazonaws_iotwireless.DisassociateAwsAccountFromPartnerAccount({
  "PartnerAccountId": "",
  "partnerType": ""
}, context)

Input

  • input object
    • PartnerAccountId required string
    • partnerType required string

Output

Output schema unknown

GetPartnerAccount

amazonaws_iotwireless.GetPartnerAccount({
  "PartnerAccountId": "",
  "partnerType": ""
}, context)

Input

  • input object
    • PartnerAccountId required string
    • partnerType required string

Output

UpdatePartnerAccount

amazonaws_iotwireless.UpdatePartnerAccount({
  "PartnerAccountId": "",
  "partnerType": "",
  "Sidewalk": {}
}, context)

Input

  • input object
    • PartnerAccountId required string
    • partnerType required string
    • Sidewalk required object: Sidewalk update.
      • AppServerPrivateKey

Output

Output schema unknown

GetServiceEndpoint

amazonaws_iotwireless.GetServiceEndpoint({}, context)

Input

  • input object
    • serviceType string

Output

ListServiceProfiles

amazonaws_iotwireless.ListServiceProfiles({}, context)

Input

  • input object
    • nextToken string
    • maxResults integer
    • MaxResults string
    • NextToken string

Output

CreateServiceProfile

amazonaws_iotwireless.CreateServiceProfile({}, context)

Input

  • input object
    • ClientRequestToken string: Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.
    • LoRaWAN object: LoRaWANServiceProfile object.
      • AddGwMetadata
    • Name string: The name of the new resource.
    • Tags array: The tags to attach to the new service profile. Tags are metadata that can be used to manage a resource.

Output

Output schema unknown

DeleteServiceProfile

amazonaws_iotwireless.DeleteServiceProfile({
  "Id": ""
}, context)

Input

  • input object
    • Id required string

Output

Output schema unknown

GetServiceProfile

amazonaws_iotwireless.GetServiceProfile({
  "Id": ""
}, context)

Input

  • input object
    • Id required string

Output

ListTagsForResource

amazonaws_iotwireless.ListTagsForResource({
  "resourceArn": ""
}, context)

Input

  • input object
    • resourceArn required string

Output

TagResource

amazonaws_iotwireless.TagResource({
  "resourceArn": "",
  "Tags": []
}, context)

Input

  • input object
    • resourceArn required string
    • Tags required array: Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.

Output

Output schema unknown

UntagResource

amazonaws_iotwireless.UntagResource({
  "resourceArn": "",
  "tagKeys": []
}, context)

Input

  • input object
    • resourceArn required string
    • tagKeys required array

Output

Output schema unknown

ListWirelessDevices

amazonaws_iotwireless.ListWirelessDevices({}, context)

Input

  • input object
    • maxResults integer
    • nextToken string
    • destinationName string
    • deviceProfileId string
    • serviceProfileId string
    • wirelessDeviceType string
    • MaxResults string
    • NextToken string

Output

CreateWirelessDevice

amazonaws_iotwireless.CreateWirelessDevice({
  "Type": "",
  "DestinationName": ""
}, context)

Input

  • input object
    • ClientRequestToken string: Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.
    • Description string: The description of the new resource.
    • DestinationName required string: The name of the destination to assign to the new wireless device.
    • LoRaWAN object: LoRa object for create functions.
      • AbpV1_0_x
        • DevAddr
        • SessionKeys
          • AppSKey
          • NwkSKey
      • AbpV1_1
        • DevAddr
        • SessionKeys
          • AppSKey
          • FNwkSIntKey
          • NwkSEncKey
          • SNwkSIntKey
      • DevEui
      • DeviceProfileId
      • OtaaV1_0_x
        • AppEui
        • AppKey
      • OtaaV1_1
        • AppKey
        • JoinEui
        • NwkKey
      • ServiceProfileId
    • Name string: The name of the new resource.
    • Type required string (values: Sidewalk, LoRaWAN): The wireless device type.

Output

Output schema unknown

GetWirelessDevice

amazonaws_iotwireless.GetWirelessDevice({
  "Identifier": "",
  "identifierType": ""
}, context)

Input

  • input object
    • Identifier required string
    • identifierType required string

Output

DeleteWirelessDevice

amazonaws_iotwireless.DeleteWirelessDevice({
  "Id": ""
}, context)

Input

  • input object
    • Id required string

Output

Output schema unknown

UpdateWirelessDevice

amazonaws_iotwireless.UpdateWirelessDevice({
  "Id": ""
}, context)

Input

  • input object
    • Id required string
    • Description string: A new description of the resource.
    • DestinationName string: The name of the new destination for the device.
    • LoRaWAN object: LoRa object for update functions.
      • DeviceProfileId
      • ServiceProfileId
    • Name string: The new name of the resource.

Output

Output schema unknown

SendDataToWirelessDevice

amazonaws_iotwireless.SendDataToWirelessDevice({
  "Id": "",
  "TransmitMode": 0,
  "PayloadData": ""
}, context)

Input

  • input object
    • Id required string
    • PayloadData required string: The message payload to send.
    • TransmitMode required integer: The transmit mode to use to send data to the wireless device. Can be: 0 for UM (unacknowledge mode), 1 for AM (acknowledge mode), or 2 for (TM) transparent mode.
    • WirelessMetadata object: WirelessMetadata object.
      • LoRaWAN
        • FPort
      • Sidewalk
        • Seq

Output

Output schema unknown

GetWirelessDeviceStatistics

amazonaws_iotwireless.GetWirelessDeviceStatistics({
  "Id": ""
}, context)

Input

  • input object
    • Id required string

Output

TestWirelessDevice

amazonaws_iotwireless.TestWirelessDevice({
  "Id": ""
}, context)

Input

  • input object
    • Id required string

Output

DisassociateWirelessDeviceFromThing

amazonaws_iotwireless.DisassociateWirelessDeviceFromThing({
  "Id": ""
}, context)

Input

  • input object
    • Id required string

Output

Output schema unknown

AssociateWirelessDeviceWithThing

amazonaws_iotwireless.AssociateWirelessDeviceWithThing({
  "Id": "",
  "ThingArn": ""
}, context)

Input

  • input object
    • Id required string
    • ThingArn required string: The ARN of the thing to associate with the wireless device.

Output

Output schema unknown

ListWirelessGatewayTaskDefinitions

amazonaws_iotwireless.ListWirelessGatewayTaskDefinitions({}, context)

Input

  • input object
    • maxResults integer
    • nextToken string
    • taskDefinitionType string

Output

CreateWirelessGatewayTaskDefinition

amazonaws_iotwireless.CreateWirelessGatewayTaskDefinition({
  "AutoCreateTasks": true
}, context)

Input

  • input object
    • AutoCreateTasks required boolean: Whether to automatically create tasks using this task definition for all gateways with the specified current version. If false, the task must me created by calling CreateWirelessGatewayTask.
    • ClientRequestToken string: Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.
    • Name string: The name of the new resource.
    • Update object: UpdateWirelessGatewayTaskCreate object.
      • LoRaWAN
        • CurrentVersion
          • Model
          • PackageVersion
          • Station
        • SigKeyCrc
        • UpdateSignature
        • UpdateVersion
          • Model
          • PackageVersion
          • Station
      • UpdateDataRole
      • UpdateDataSource

Output

Output schema unknown

DeleteWirelessGatewayTaskDefinition

amazonaws_iotwireless.DeleteWirelessGatewayTaskDefinition({
  "Id": ""
}, context)

Input

  • input object
    • Id required string

Output

Output schema unknown

GetWirelessGatewayTaskDefinition

amazonaws_iotwireless.GetWirelessGatewayTaskDefinition({
  "Id": ""
}, context)

Input

  • input object
    • Id required string

Output

ListWirelessGateways

amazonaws_iotwireless.ListWirelessGateways({}, context)

Input

  • input object
    • nextToken string
    • maxResults integer
    • MaxResults string
    • NextToken string

Output

CreateWirelessGateway

amazonaws_iotwireless.CreateWirelessGateway({
  "LoRaWAN": {}
}, context)

Input

  • input object
    • ClientRequestToken string: Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.
    • Description string: The description of the new resource.
    • LoRaWAN required object: LoRaWANGateway object.
      • GatewayEui
      • RfRegion
    • Name string: The name of the new resource.
    • Tags array: The tags to attach to the new wireless gateway. Tags are metadata that can be used to manage a resource.

Output

Output schema unknown

GetWirelessGateway

amazonaws_iotwireless.GetWirelessGateway({
  "Identifier": "",
  "identifierType": ""
}, context)

Input

  • input object
    • Identifier required string
    • identifierType required string

Output

DeleteWirelessGateway

amazonaws_iotwireless.DeleteWirelessGateway({
  "Id": ""
}, context)

Input

  • input object
    • Id required string

Output

Output schema unknown

UpdateWirelessGateway

amazonaws_iotwireless.UpdateWirelessGateway({
  "Id": ""
}, context)

Input

  • input object
    • Id required string
    • Description string: A new description of the resource.
    • Name string: The new name of the resource.

Output

Output schema unknown

DisassociateWirelessGatewayFromCertificate

amazonaws_iotwireless.DisassociateWirelessGatewayFromCertificate({
  "Id": ""
}, context)

Input

  • input object
    • Id required string

Output

Output schema unknown

GetWirelessGatewayCertificate

amazonaws_iotwireless.GetWirelessGatewayCertificate({
  "Id": ""
}, context)

Input

  • input object
    • Id required string

Output

AssociateWirelessGatewayWithCertificate

amazonaws_iotwireless.AssociateWirelessGatewayWithCertificate({
  "Id": "",
  "IotCertificateId": ""
}, context)

Input

  • input object
    • Id required string
    • IotCertificateId required string: The ID of the certificate to associate with the wireless gateway.

Output

GetWirelessGatewayFirmwareInformation

amazonaws_iotwireless.GetWirelessGatewayFirmwareInformation({
  "Id": ""
}, context)

Input

  • input object
    • Id required string

Output

GetWirelessGatewayStatistics

amazonaws_iotwireless.GetWirelessGatewayStatistics({
  "Id": ""
}, context)

Input

  • input object
    • Id required string

Output

DeleteWirelessGatewayTask

amazonaws_iotwireless.DeleteWirelessGatewayTask({
  "Id": ""
}, context)

Input

  • input object
    • Id required string

Output

Output schema unknown

GetWirelessGatewayTask

amazonaws_iotwireless.GetWirelessGatewayTask({
  "Id": ""
}, context)

Input

  • input object
    • Id required string

Output

CreateWirelessGatewayTask

amazonaws_iotwireless.CreateWirelessGatewayTask({
  "Id": "",
  "WirelessGatewayTaskDefinitionId": ""
}, context)

Input

  • input object
    • Id required string
    • WirelessGatewayTaskDefinitionId required string: The ID of the WirelessGatewayTaskDefinition.

Output

Output schema unknown

DisassociateWirelessGatewayFromThing

amazonaws_iotwireless.DisassociateWirelessGatewayFromThing({
  "Id": ""
}, context)

Input

  • input object
    • Id required string

Output

Output schema unknown

AssociateWirelessGatewayWithThing

amazonaws_iotwireless.AssociateWirelessGatewayWithThing({
  "Id": "",
  "ThingArn": ""
}, context)

Input

  • input object
    • Id required string
    • ThingArn required string: The ARN of the thing to associate with the wireless gateway.

Output

Output schema unknown

Definitions

AbpV1_0_x

  • AbpV1_0_x object: ABP device object for LoRaWAN specification v1.0.x
    • DevAddr
    • SessionKeys
      • AppSKey
      • NwkSKey

AbpV1_1

  • AbpV1_1 object: ABP device object for LoRaWAN specification v1.1
    • DevAddr
    • SessionKeys
      • AppSKey
      • FNwkSIntKey
      • NwkSEncKey
      • SNwkSIntKey

AccessDeniedException

AccountLinked

  • AccountLinked boolean

AddGwMetadata

  • AddGwMetadata boolean

AmazonId

  • AmazonId string

AmazonResourceName

  • AmazonResourceName string

AppEui

  • AppEui string

AppKey

  • AppKey string

AppSKey

  • AppSKey string

AppServerPrivateKey

  • AppServerPrivateKey string

AssociateAwsAccountWithPartnerAccountRequest

  • AssociateAwsAccountWithPartnerAccountRequest object
    • ClientRequestToken
    • Sidewalk required
      • AmazonId
      • AppServerPrivateKey

AssociateAwsAccountWithPartnerAccountResponse

  • AssociateAwsAccountWithPartnerAccountResponse object
    • Sidewalk
      • AmazonId
      • AppServerPrivateKey

AssociateWirelessDeviceWithThingRequest

  • AssociateWirelessDeviceWithThingRequest object
    • ThingArn required

AssociateWirelessDeviceWithThingResponse

  • AssociateWirelessDeviceWithThingResponse object

AssociateWirelessGatewayWithCertificateRequest

  • AssociateWirelessGatewayWithCertificateRequest object
    • IotCertificateId required

AssociateWirelessGatewayWithCertificateResponse

  • AssociateWirelessGatewayWithCertificateResponse object
    • IotCertificateId

AssociateWirelessGatewayWithThingRequest

  • AssociateWirelessGatewayWithThingRequest object
    • ThingArn required

AssociateWirelessGatewayWithThingResponse

  • AssociateWirelessGatewayWithThingResponse object

AutoCreateTasks

  • AutoCreateTasks boolean

CertificatePEM

  • CertificatePEM string

ChannelMask

  • ChannelMask string

ClassBTimeout

  • ClassBTimeout integer

ClassCTimeout

  • ClassCTimeout integer

ClientRequestToken

  • ClientRequestToken string

ConflictException

Crc

  • Crc integer

CreateDestinationRequest

  • CreateDestinationRequest object
    • ClientRequestToken
    • Description
    • Expression required
    • ExpressionType required
    • Name required
    • RoleArn required
    • Tags

CreateDestinationResponse

  • CreateDestinationResponse object
    • Arn
    • Name

CreateDeviceProfileRequest

  • CreateDeviceProfileRequest object
    • ClientRequestToken
    • LoRaWAN
      • ClassBTimeout
      • ClassCTimeout
      • FactoryPresetFreqsList
      • MacVersion
      • MaxDutyCycle
      • MaxEirp
      • PingSlotDr
      • PingSlotFreq
      • PingSlotPeriod
      • RegParamsRevision
      • RfRegion
      • RxDataRate2
      • RxDelay1
      • RxDrOffset1
      • RxFreq2
      • Supports32BitFCnt
      • SupportsClassB
      • SupportsClassC
      • SupportsJoin
    • Name
    • Tags

CreateDeviceProfileResponse

  • CreateDeviceProfileResponse object
    • Arn
    • Id

CreateServiceProfileRequest

  • CreateServiceProfileRequest object
    • ClientRequestToken
    • LoRaWAN
      • AddGwMetadata
    • Name
    • Tags

CreateServiceProfileResponse

  • CreateServiceProfileResponse object
    • Arn
    • Id

CreateWirelessDeviceRequest

  • CreateWirelessDeviceRequest object
    • ClientRequestToken
    • Description
    • DestinationName required
    • LoRaWAN
      • AbpV1_0_x
        • DevAddr
        • SessionKeys
          • AppSKey
          • NwkSKey
      • AbpV1_1
        • DevAddr
        • SessionKeys
          • AppSKey
          • FNwkSIntKey
          • NwkSEncKey
          • SNwkSIntKey
      • DevEui
      • DeviceProfileId
      • OtaaV1_0_x
        • AppEui
        • AppKey
      • OtaaV1_1
        • AppKey
        • JoinEui
        • NwkKey
      • ServiceProfileId
    • Name
    • Type required

CreateWirelessDeviceResponse

  • CreateWirelessDeviceResponse object
    • Arn
    • Id

CreateWirelessGatewayRequest

  • CreateWirelessGatewayRequest object
    • ClientRequestToken
    • Description
    • LoRaWAN required
      • GatewayEui
      • RfRegion
    • Name
    • Tags

CreateWirelessGatewayResponse

  • CreateWirelessGatewayResponse object
    • Arn
    • Id

CreateWirelessGatewayTaskDefinitionRequest

  • CreateWirelessGatewayTaskDefinitionRequest object
    • AutoCreateTasks required
    • ClientRequestToken
    • Name
    • Update
      • LoRaWAN
        • CurrentVersion
          • Model
          • PackageVersion
          • Station
        • SigKeyCrc
        • UpdateSignature
        • UpdateVersion
          • Model
          • PackageVersion
          • Station
      • UpdateDataRole
      • UpdateDataSource

CreateWirelessGatewayTaskDefinitionResponse

  • CreateWirelessGatewayTaskDefinitionResponse object
    • Id

CreateWirelessGatewayTaskRequest

  • CreateWirelessGatewayTaskRequest object
    • WirelessGatewayTaskDefinitionId required

CreateWirelessGatewayTaskResponse

  • CreateWirelessGatewayTaskResponse object
    • Status
    • WirelessGatewayTaskDefinitionId

DeleteDestinationRequest

  • DeleteDestinationRequest object

DeleteDestinationResponse

  • DeleteDestinationResponse object

DeleteDeviceProfileRequest

  • DeleteDeviceProfileRequest object

DeleteDeviceProfileResponse

  • DeleteDeviceProfileResponse object

DeleteServiceProfileRequest

  • DeleteServiceProfileRequest object

DeleteServiceProfileResponse

  • DeleteServiceProfileResponse object

DeleteWirelessDeviceRequest

  • DeleteWirelessDeviceRequest object

DeleteWirelessDeviceResponse

  • DeleteWirelessDeviceResponse object

DeleteWirelessGatewayRequest

  • DeleteWirelessGatewayRequest object

DeleteWirelessGatewayResponse

  • DeleteWirelessGatewayResponse object

DeleteWirelessGatewayTaskDefinitionRequest

  • DeleteWirelessGatewayTaskDefinitionRequest object

DeleteWirelessGatewayTaskDefinitionResponse

  • DeleteWirelessGatewayTaskDefinitionResponse object

DeleteWirelessGatewayTaskRequest

  • DeleteWirelessGatewayTaskRequest object

DeleteWirelessGatewayTaskResponse

  • DeleteWirelessGatewayTaskResponse object

Description

  • Description string

DestinationArn

  • DestinationArn string

DestinationList

DestinationName

  • DestinationName string

Destinations

  • Destinations object: Describes a destination.
    • Arn
    • Description
    • Expression
    • ExpressionType
    • Name
    • RoleArn

DevAddr

  • DevAddr string

DevEui

  • DevEui string

DevStatusReqFreq

  • DevStatusReqFreq integer

DeviceProfile

  • DeviceProfile object: Describes a device profile.
    • Arn
    • Id
    • Name

DeviceProfileArn

  • DeviceProfileArn string

DeviceProfileId

  • DeviceProfileId string

DeviceProfileList

DeviceProfileName

  • DeviceProfileName string

DisassociateAwsAccountFromPartnerAccountRequest

  • DisassociateAwsAccountFromPartnerAccountRequest object

DisassociateAwsAccountFromPartnerAccountResponse

  • DisassociateAwsAccountFromPartnerAccountResponse object

DisassociateWirelessDeviceFromThingRequest

  • DisassociateWirelessDeviceFromThingRequest object

DisassociateWirelessDeviceFromThingResponse

  • DisassociateWirelessDeviceFromThingResponse object

DisassociateWirelessGatewayFromCertificateRequest

  • DisassociateWirelessGatewayFromCertificateRequest object

DisassociateWirelessGatewayFromCertificateResponse

  • DisassociateWirelessGatewayFromCertificateResponse object

DisassociateWirelessGatewayFromThingRequest

  • DisassociateWirelessGatewayFromThingRequest object

DisassociateWirelessGatewayFromThingResponse

  • DisassociateWirelessGatewayFromThingResponse object

DlBucketSize

  • DlBucketSize integer

DlRate

  • DlRate integer

DlRatePolicy

  • DlRatePolicy string

Double

  • Double number

DrMax

  • DrMax integer

DrMin

  • DrMin integer

EndPoint

  • EndPoint string

Expression

  • Expression string

ExpressionType

  • ExpressionType string (values: RuleName)

FNwkSIntKey

  • FNwkSIntKey string

FPort

  • FPort integer

FactoryPresetFreqsList

GatewayEui

  • GatewayEui string

GetDestinationRequest

  • GetDestinationRequest object

GetDestinationResponse

  • GetDestinationResponse object
    • Arn
    • Description
    • Expression
    • ExpressionType
    • Name
    • RoleArn

GetDeviceProfileRequest

  • GetDeviceProfileRequest object

GetDeviceProfileResponse

  • GetDeviceProfileResponse object
    • Arn
    • Id
    • LoRaWAN
      • ClassBTimeout
      • ClassCTimeout
      • FactoryPresetFreqsList
      • MacVersion
      • MaxDutyCycle
      • MaxEirp
      • PingSlotDr
      • PingSlotFreq
      • PingSlotPeriod
      • RegParamsRevision
      • RfRegion
      • RxDataRate2
      • RxDelay1
      • RxDrOffset1
      • RxFreq2
      • Supports32BitFCnt
      • SupportsClassB
      • SupportsClassC
      • SupportsJoin
    • Name

GetPartnerAccountRequest

  • GetPartnerAccountRequest object

GetPartnerAccountResponse

  • GetPartnerAccountResponse object
    • AccountLinked
    • Sidewalk
      • AmazonId
      • AppServerPrivateKey

GetServiceEndpointRequest

  • GetServiceEndpointRequest object

GetServiceEndpointResponse

  • GetServiceEndpointResponse object
    • ServerTrust
    • ServiceEndpoint
    • ServiceType

GetServiceProfileRequest

  • GetServiceProfileRequest object

GetServiceProfileResponse

  • GetServiceProfileResponse object
    • Arn
    • Id
    • LoRaWAN
      • AddGwMetadata
      • ChannelMask
      • DevStatusReqFreq
      • DlBucketSize
      • DlRate
      • DlRatePolicy
      • DrMax
      • DrMin
      • HrAllowed
      • MinGwDiversity
      • NwkGeoLoc
      • PrAllowed
      • RaAllowed
      • ReportDevStatusBattery
      • ReportDevStatusMargin
      • TargetPer
      • UlBucketSize
      • UlRate
      • UlRatePolicy
    • Name

GetWirelessDeviceRequest

  • GetWirelessDeviceRequest object

GetWirelessDeviceResponse

  • GetWirelessDeviceResponse object
    • Arn
    • Description
    • DestinationName
    • Id
    • LoRaWAN
      • AbpV1_0_x
        • DevAddr
        • SessionKeys
          • AppSKey
          • NwkSKey
      • AbpV1_1
        • DevAddr
        • SessionKeys
          • AppSKey
          • FNwkSIntKey
          • NwkSEncKey
          • SNwkSIntKey
      • DevEui
      • DeviceProfileId
      • OtaaV1_0_x
        • AppEui
        • AppKey
      • OtaaV1_1
        • AppKey
        • JoinEui
        • NwkKey
      • ServiceProfileId
    • Name
    • ThingArn
    • ThingName
    • Type

GetWirelessDeviceStatisticsRequest

  • GetWirelessDeviceStatisticsRequest object

GetWirelessDeviceStatisticsResponse

  • GetWirelessDeviceStatisticsResponse object
    • LastUplinkReceivedAt
    • LoRaWAN
    • WirelessDeviceId

GetWirelessGatewayCertificateRequest

  • GetWirelessGatewayCertificateRequest object

GetWirelessGatewayCertificateResponse

  • GetWirelessGatewayCertificateResponse object
    • IotCertificateId

GetWirelessGatewayFirmwareInformationRequest

  • GetWirelessGatewayFirmwareInformationRequest object

GetWirelessGatewayFirmwareInformationResponse

  • GetWirelessGatewayFirmwareInformationResponse object
    • LoRaWAN
      • CurrentVersion
        • Model
        • PackageVersion
        • Station

GetWirelessGatewayRequest

  • GetWirelessGatewayRequest object

GetWirelessGatewayResponse

  • GetWirelessGatewayResponse object
    • Arn
    • Description
    • Id
    • LoRaWAN
      • GatewayEui
      • RfRegion
    • Name
    • ThingArn
    • ThingName

GetWirelessGatewayStatisticsRequest

  • GetWirelessGatewayStatisticsRequest object

GetWirelessGatewayStatisticsResponse

  • GetWirelessGatewayStatisticsResponse object
    • LastUplinkReceivedAt
    • WirelessGatewayId

GetWirelessGatewayTaskDefinitionRequest

  • GetWirelessGatewayTaskDefinitionRequest object

GetWirelessGatewayTaskDefinitionResponse

  • GetWirelessGatewayTaskDefinitionResponse object
    • AutoCreateTasks
    • Name
    • Update
      • LoRaWAN
        • CurrentVersion
          • Model
          • PackageVersion
          • Station
        • SigKeyCrc
        • UpdateSignature
        • UpdateVersion
          • Model
          • PackageVersion
          • Station
      • UpdateDataRole
      • UpdateDataSource

GetWirelessGatewayTaskRequest

  • GetWirelessGatewayTaskRequest object

GetWirelessGatewayTaskResponse

  • GetWirelessGatewayTaskResponse object
    • LastUplinkReceivedAt
    • Status
    • TaskCreatedAt
    • WirelessGatewayId
    • WirelessGatewayTaskDefinitionId

HrAllowed

  • HrAllowed boolean

ISODateTimeString

  • ISODateTimeString string

Identifier

  • Identifier string

Integer

  • Integer integer

InternalServerException

IotCertificateId

  • IotCertificateId string

JoinEui

  • JoinEui string

ListDestinationsRequest

  • ListDestinationsRequest object

ListDestinationsResponse

  • ListDestinationsResponse object

ListDeviceProfilesRequest

  • ListDeviceProfilesRequest object

ListDeviceProfilesResponse

  • ListDeviceProfilesResponse object

ListPartnerAccountsRequest

  • ListPartnerAccountsRequest object

ListPartnerAccountsResponse

ListServiceProfilesRequest

  • ListServiceProfilesRequest object

ListServiceProfilesResponse

  • ListServiceProfilesResponse object

ListTagsForResourceRequest

  • ListTagsForResourceRequest object

ListTagsForResourceResponse

  • ListTagsForResourceResponse object
    • Tags

ListWirelessDevicesRequest

  • ListWirelessDevicesRequest object

ListWirelessDevicesResponse

ListWirelessGatewayTaskDefinitionsRequest

  • ListWirelessGatewayTaskDefinitionsRequest object

ListWirelessGatewayTaskDefinitionsResponse

ListWirelessGatewaysRequest

  • ListWirelessGatewaysRequest object

ListWirelessGatewaysResponse

LoRaWANDevice

  • LoRaWANDevice object: LoRa object for create functions.
    • AbpV1_0_x
      • DevAddr
      • SessionKeys
        • AppSKey
        • NwkSKey
    • AbpV1_1
      • DevAddr
      • SessionKeys
        • AppSKey
        • FNwkSIntKey
        • NwkSEncKey
        • SNwkSIntKey
    • DevEui
    • DeviceProfileId
    • OtaaV1_0_x
      • AppEui
      • AppKey
    • OtaaV1_1
      • AppKey
      • JoinEui
      • NwkKey
    • ServiceProfileId

LoRaWANDeviceMetadata

  • LoRaWANDeviceMetadata object: LoRaWAN device metatdata.

LoRaWANDeviceProfile

  • LoRaWANDeviceProfile object: LoRaWANDeviceProfile object.
    • ClassBTimeout
    • ClassCTimeout
    • FactoryPresetFreqsList
    • MacVersion
    • MaxDutyCycle
    • MaxEirp
    • PingSlotDr
    • PingSlotFreq
    • PingSlotPeriod
    • RegParamsRevision
    • RfRegion
    • RxDataRate2
    • RxDelay1
    • RxDrOffset1
    • RxFreq2
    • Supports32BitFCnt
    • SupportsClassB
    • SupportsClassC
    • SupportsJoin

LoRaWANGateway

  • LoRaWANGateway object: LoRaWANGateway object.
    • GatewayEui
    • RfRegion

LoRaWANGatewayCurrentVersion

  • LoRaWANGatewayCurrentVersion object: LoRaWANGatewayCurrentVersion object.
    • CurrentVersion
      • Model
      • PackageVersion
      • Station

LoRaWANGatewayMetadata

  • LoRaWANGatewayMetadata object: LoRaWAN gateway metatdata.
    • GatewayEui
    • Rssi
    • Snr

LoRaWANGatewayMetadataList

LoRaWANGatewayVersion

  • LoRaWANGatewayVersion object: LoRaWANGatewayVersion object.
    • Model
    • PackageVersion
    • Station

LoRaWANGetServiceProfileInfo

  • LoRaWANGetServiceProfileInfo object: LoRaWANGetServiceProfileInfo object.
    • AddGwMetadata
    • ChannelMask
    • DevStatusReqFreq
    • DlBucketSize
    • DlRate
    • DlRatePolicy
    • DrMax
    • DrMin
    • HrAllowed
    • MinGwDiversity
    • NwkGeoLoc
    • PrAllowed
    • RaAllowed
    • ReportDevStatusBattery
    • ReportDevStatusMargin
    • TargetPer
    • UlBucketSize
    • UlRate
    • UlRatePolicy

LoRaWANListDevice

  • LoRaWANListDevice object: LoRaWAN object for list functions.
    • DevEui

LoRaWANSendDataToDevice

  • LoRaWANSendDataToDevice object: LoRaWAN router info.
    • FPort

LoRaWANServiceProfile

  • LoRaWANServiceProfile object: LoRaWANServiceProfile object.
    • AddGwMetadata

LoRaWANUpdateDevice

  • LoRaWANUpdateDevice object: LoRa object for update functions.
    • DeviceProfileId
    • ServiceProfileId

LoRaWANUpdateGatewayTaskCreate

  • LoRaWANUpdateGatewayTaskCreate object: LoRaWANUpdateGatewayTaskCreate object.
    • CurrentVersion
      • Model
      • PackageVersion
      • Station
    • SigKeyCrc
    • UpdateSignature
    • UpdateVersion
      • Model
      • PackageVersion
      • Station

LoRaWANUpdateGatewayTaskEntry

  • LoRaWANUpdateGatewayTaskEntry object: LoRaWANUpdateGatewayTaskEntry object.
    • CurrentVersion
      • Model
      • PackageVersion
      • Station
    • UpdateVersion
      • Model
      • PackageVersion
      • Station

MacVersion

  • MacVersion string

MaxDutyCycle

  • MaxDutyCycle integer

MaxEirp

  • MaxEirp integer

MaxResults

  • MaxResults integer

MessageId

  • MessageId string

MinGwDiversity

  • MinGwDiversity integer

Model

  • Model string

NextToken

  • NextToken string

NwkGeoLoc

  • NwkGeoLoc boolean

NwkKey

  • NwkKey string

NwkSEncKey

  • NwkSEncKey string

NwkSKey

  • NwkSKey string

OtaaV1_0_x

  • OtaaV1_0_x object: OTAA device object for v1.0.x
    • AppEui
    • AppKey

OtaaV1_1

  • OtaaV1_1 object: OTAA device object for v1.1
    • AppKey
    • JoinEui
    • NwkKey

PackageVersion

  • PackageVersion string

PartnerAccountId

  • PartnerAccountId string

PartnerType

  • PartnerType string (values: Sidewalk)

PayloadData

  • PayloadData string

PingSlotDr

  • PingSlotDr integer

PingSlotFreq

  • PingSlotFreq integer

PingSlotPeriod

  • PingSlotPeriod integer

PrAllowed

  • PrAllowed boolean

PresetFreq

  • PresetFreq integer

RaAllowed

  • RaAllowed boolean

RegParamsRevision

  • RegParamsRevision string

ReportDevStatusBattery

  • ReportDevStatusBattery boolean

ReportDevStatusMargin

  • ReportDevStatusMargin boolean

ResourceNotFoundException

Result

  • Result string

RfRegion

  • RfRegion string

RoleArn

  • RoleArn string

RxDataRate2

  • RxDataRate2 integer

RxDelay1

  • RxDelay1 integer

RxDrOffset1

  • RxDrOffset1 integer

RxFreq2

  • RxFreq2 integer

SNwkSIntKey

  • SNwkSIntKey string

SendDataToWirelessDeviceRequest

  • SendDataToWirelessDeviceRequest object
    • PayloadData required
    • TransmitMode required
    • WirelessMetadata
      • LoRaWAN
        • FPort
      • Sidewalk
        • Seq

SendDataToWirelessDeviceResponse

  • SendDataToWirelessDeviceResponse object
    • MessageId

Seq

  • Seq integer

ServiceProfile

  • ServiceProfile object: Information about a service profile.
    • Arn
    • Id
    • Name

ServiceProfileArn

  • ServiceProfileArn string

ServiceProfileId

  • ServiceProfileId string

ServiceProfileList

ServiceProfileName

  • ServiceProfileName string

SessionKeysAbpV1_0_x

  • SessionKeysAbpV1_0_x object: Session keys for ABP v1.1
    • AppSKey
    • NwkSKey

SessionKeysAbpV1_1

  • SessionKeysAbpV1_1 object: Session keys for ABP v1.1
    • AppSKey
    • FNwkSIntKey
    • NwkSEncKey
    • SNwkSIntKey

SidewalkAccountInfo

  • SidewalkAccountInfo object: Information about a Sidewalk account.
    • AmazonId
    • AppServerPrivateKey

SidewalkAccountInfoWithFingerprint

  • SidewalkAccountInfoWithFingerprint object: Information about a Sidewalk account.
    • AmazonId
    • AppServerPrivateKey

SidewalkAccountList

SidewalkListDevice

  • SidewalkListDevice object: Sidewalk object used by list functions.
    • AmazonId

SidewalkSendDataToDevice

  • SidewalkSendDataToDevice object: Information about a Sidewalk router.
    • Seq

SidewalkUpdateAccount

  • SidewalkUpdateAccount object: Sidewalk update.
    • AppServerPrivateKey

Station

  • Station string

Supports32BitFCnt

  • Supports32BitFCnt boolean

SupportsClassB

  • SupportsClassB boolean

SupportsClassC

  • SupportsClassC boolean

SupportsJoin

  • SupportsJoin boolean

Tag

  • Tag object: A simple label consisting of a customer-defined key-value pair
    • Key required
    • Value required

TagKey

  • TagKey string

TagKeyList

  • TagKeyList array

TagList

  • TagList array

TagResourceRequest

  • TagResourceRequest object
    • Tags required

TagResourceResponse

  • TagResourceResponse object

TagValue

  • TagValue string

TargetPer

  • TargetPer integer

TestWirelessDeviceRequest

  • TestWirelessDeviceRequest object

TestWirelessDeviceResponse

  • TestWirelessDeviceResponse object
    • Result

ThingArn

  • ThingArn string

ThingName

  • ThingName string

ThrottlingException

TooManyTagsException

TransmitMode

  • TransmitMode integer

UlBucketSize

  • UlBucketSize integer

UlRate

  • UlRate integer

UlRatePolicy

  • UlRatePolicy string

UntagResourceRequest

  • UntagResourceRequest object

UntagResourceResponse

  • UntagResourceResponse object

UpdateDataSource

  • UpdateDataSource string

UpdateDestinationRequest

  • UpdateDestinationRequest object
    • Description
    • Expression
    • ExpressionType
    • RoleArn

UpdateDestinationResponse

  • UpdateDestinationResponse object

UpdatePartnerAccountRequest

  • UpdatePartnerAccountRequest object
    • Sidewalk required
      • AppServerPrivateKey

UpdatePartnerAccountResponse

  • UpdatePartnerAccountResponse object

UpdateSignature

  • UpdateSignature string

UpdateWirelessDeviceRequest

  • UpdateWirelessDeviceRequest object
    • Description
    • DestinationName
    • LoRaWAN
      • DeviceProfileId
      • ServiceProfileId
    • Name

UpdateWirelessDeviceResponse

  • UpdateWirelessDeviceResponse object

UpdateWirelessGatewayRequest

  • UpdateWirelessGatewayRequest object
    • Description
    • Name

UpdateWirelessGatewayResponse

  • UpdateWirelessGatewayResponse object

UpdateWirelessGatewayTaskCreate

  • UpdateWirelessGatewayTaskCreate object: UpdateWirelessGatewayTaskCreate object.
    • LoRaWAN
      • CurrentVersion
        • Model
        • PackageVersion
        • Station
      • SigKeyCrc
      • UpdateSignature
      • UpdateVersion
        • Model
        • PackageVersion
        • Station
    • UpdateDataRole
    • UpdateDataSource

UpdateWirelessGatewayTaskEntry

  • UpdateWirelessGatewayTaskEntry object: UpdateWirelessGatewayTaskEntry object.
    • Id
    • LoRaWAN
      • CurrentVersion
        • Model
        • PackageVersion
        • Station
      • UpdateVersion
        • Model
        • PackageVersion
        • Station

ValidationException

WirelessDeviceArn

  • WirelessDeviceArn string

WirelessDeviceId

  • WirelessDeviceId string

WirelessDeviceIdType

  • WirelessDeviceIdType string (values: WirelessDeviceId, DevEui, ThingName)

WirelessDeviceName

  • WirelessDeviceName string

WirelessDeviceStatistics

  • WirelessDeviceStatistics object: Information about a wireless device's operation.
    • Arn
    • DestinationName
    • Id
    • LastUplinkReceivedAt
    • LoRaWAN
      • DevEui
    • Name
    • Sidewalk
      • AmazonId
    • Type

WirelessDeviceStatisticsList

WirelessDeviceType

  • WirelessDeviceType string (values: Sidewalk, LoRaWAN)

WirelessGatewayArn

  • WirelessGatewayArn string

WirelessGatewayId

  • WirelessGatewayId string

WirelessGatewayIdType

  • WirelessGatewayIdType string (values: GatewayEui, WirelessGatewayId, ThingName)

WirelessGatewayName

  • WirelessGatewayName string

WirelessGatewayServiceType

  • WirelessGatewayServiceType string (values: CUPS, LNS)

WirelessGatewayStatistics

  • WirelessGatewayStatistics object: Information about a wireless gateway's operation.
    • Arn
    • Description
    • Id
    • LastUplinkReceivedAt
    • LoRaWAN
      • GatewayEui
      • RfRegion
    • Name

WirelessGatewayStatisticsList

WirelessGatewayTaskDefinitionId

  • WirelessGatewayTaskDefinitionId string

WirelessGatewayTaskDefinitionList

WirelessGatewayTaskDefinitionType

  • WirelessGatewayTaskDefinitionType string (values: UPDATE)

WirelessGatewayTaskName

  • WirelessGatewayTaskName string

WirelessGatewayTaskStatus

  • WirelessGatewayTaskStatus string (values: PENDING, IN_PROGRESS, FIRST_RETRY, SECOND_RETRY, COMPLETED, FAILED)

WirelessMetadata

  • WirelessMetadata object: WirelessMetadata object.
    • LoRaWAN
      • FPort
    • Sidewalk
      • Seq