AWS IoT Wireless 2020-11-22
- Client: Aws\IoTWireless\IoTWirelessClient
- Service ID: iotwireless
- Version: 2020-11-22
This page describes the parameters and results for the operations of the AWS IoT Wireless (2020-11-22), and shows how to use the Aws\IoTWireless\IoTWirelessClient object to call the described operations. This documentation is specific to the 2020-11-22 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName'), where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */).
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */).
- AssociateAwsAccountWithPartnerAccount ( array $params = [] )
Associates a partner account with your AWS account.
- AssociateWirelessDeviceWithThing ( array $params = [] )
Associates a wireless device with a thing.
- AssociateWirelessGatewayWithCertificate ( array $params = [] )
Associates a wireless gateway with a certificate.
- AssociateWirelessGatewayWithThing ( array $params = [] )
Associates a wireless gateway with a thing.
- CreateDestination ( array $params = [] )
Creates a new destination that maps a device message to an AWS IoT rule.
- CreateDeviceProfile ( array $params = [] )
Creates a new device profile.
- CreateServiceProfile ( array $params = [] )
Creates a new service profile.
- CreateWirelessDevice ( array $params = [] )
Provisions a wireless device.
- CreateWirelessGateway ( array $params = [] )
Provisions a wireless gateway.
- CreateWirelessGatewayTask ( array $params = [] )
Creates a task for a wireless gateway.
- CreateWirelessGatewayTaskDefinition ( array $params = [] )
Creates a gateway task definition.
- DeleteDestination ( array $params = [] )
Deletes a destination.
- DeleteDeviceProfile ( array $params = [] )
Deletes a device profile.
- DeleteServiceProfile ( array $params = [] )
Deletes a service profile.
- DeleteWirelessDevice ( array $params = [] )
Deletes a wireless device.
- DeleteWirelessGateway ( array $params = [] )
Deletes a wireless gateway.
- DeleteWirelessGatewayTask ( array $params = [] )
Deletes a wireless gateway task.
- DeleteWirelessGatewayTaskDefinition ( array $params = [] )
Deletes a wireless gateway task definition.
- DisassociateAwsAccountFromPartnerAccount ( array $params = [] )
Disassociates your AWS account from a partner account.
- DisassociateWirelessDeviceFromThing ( array $params = [] )
Disassociates a wireless device from its currently associated thing.
- DisassociateWirelessGatewayFromCertificate ( array $params = [] )
Disassociates a wireless gateway from its currently associated certificate.
- DisassociateWirelessGatewayFromThing ( array $params = [] )
Disassociates a wireless gateway from its currently associated thing.
- GetDestination ( array $params = [] )
Gets information about a destination.
- GetDeviceProfile ( array $params = [] )
Gets information about a device profile.
- GetPartnerAccount ( array $params = [] )
Gets information about a partner account.
- GetServiceEndpoint ( array $params = [] )
Gets the account-specific endpoint for Configuration and Update Server (CUPS) protocol or LoRaWAN Network Server (LNS) connections.
- GetServiceProfile ( array $params = [] )
Gets information about a service profile.
- GetWirelessDevice ( array $params = [] )
Gets information about a wireless device.
- GetWirelessDeviceStatistics ( array $params = [] )
Gets operating information about a wireless device.
- GetWirelessGateway ( array $params = [] )
Gets information about a wireless gateway.
- GetWirelessGatewayCertificate ( array $params = [] )
Gets the ID of the certificate that is currently associated with a wireless gateway.
- GetWirelessGatewayFirmwareInformation ( array $params = [] )
Gets the firmware version and other information about a wireless gateway.
- GetWirelessGatewayStatistics ( array $params = [] )
Gets operating information about a wireless gateway.
- GetWirelessGatewayTask ( array $params = [] )
Gets information about a wireless gateway task.
- GetWirelessGatewayTaskDefinition ( array $params = [] )
Gets information about a wireless gateway task definition.
- ListDestinations ( array $params = [] )
Lists the destinations registered to your AWS account.
- ListDeviceProfiles ( array $params = [] )
Lists the device profiles registered to your AWS account.
- ListPartnerAccounts ( array $params = [] )
Lists the partner accounts associated with your AWS account.
- ListServiceProfiles ( array $params = [] )
Lists the service profiles registered to your AWS account.
- ListTagsForResource ( array $params = [] )
Lists the tags (metadata) you have assigned to the resource.
- ListWirelessDevices ( array $params = [] )
Lists the wireless devices registered to your AWS account.
- ListWirelessGatewayTaskDefinitions ( array $params = [] )
List the wireless gateway tasks definitions registered to your AWS account.
- ListWirelessGateways ( array $params = [] )
Lists the wireless gateways registered to your AWS account.
- SendDataToWirelessDevice ( array $params = [] )
Sends a decrypted application data frame to a device.
- TagResource ( array $params = [] )
Adds a tag to a resource.
- TestWirelessDevice ( array $params = [] )
Simulates a provisioned device by sending an uplink data payload of Hello.
- UntagResource ( array $params = [] )
Removes one or more tags from a resource.
- UpdateDestination ( array $params = [] )
Updates properties of a destination.
- UpdatePartnerAccount ( array $params = [] )
Updates properties of a partner account.
- UpdateWirelessDevice ( array $params = [] )
Updates properties of a wireless device.
- UpdateWirelessGateway ( array $params = [] )
Updates properties of a wireless gateway.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
Operations
AssociateAwsAccountWithPartnerAccount
$result = $client->associateAwsAccountWithPartnerAccount([/* ... */]); $promise = $client->associateAwsAccountWithPartnerAccountAsync([/* ... */]);
Associates a partner account with your AWS account.
Parameter Syntax
$result = $client->associateAwsAccountWithPartnerAccount([
'ClientRequestToken' => '<string>',
'Sidewalk' => [ // REQUIRED
'AmazonId' => '<string>',
'AppServerPrivateKey' => '<string>',
],
'Tags' => [
[
'Key' => '<string>', // REQUIRED
'Value' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- ClientRequestToken
-
- Type: 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: Yes
- Type: SidewalkAccountInfo structure
The Sidewalk account credentials.
- Tags
-
- Type: Array of Tag structures
The tags to attach to the specified resource. Tags are metadata that you can use to manage a resource.
Result Syntax
[
'Arn' => '<string>',
'Sidewalk' => [
'AmazonId' => '<string>',
'AppServerPrivateKey' => '<string>',
],
]
Result Details
Members
- Arn
-
- Type: string
The Amazon Resource Name of the resource.
- Sidewalk
-
- Type: SidewalkAccountInfo structure
The Sidewalk account credentials.
Errors
-
The input did not meet the specified constraints.
-
Resource does not exist.
-
An unexpected error occurred while processing a request.
-
The request was denied because it exceeded the allowed API request rate.
-
Adding, updating, or deleting the resource can cause an inconsistent state.
-
User does not have permission to perform this action.
AssociateWirelessDeviceWithThing
$result = $client->associateWirelessDeviceWithThing([/* ... */]); $promise = $client->associateWirelessDeviceWithThingAsync([/* ... */]);
Associates a wireless device with a thing.
Parameter Syntax
$result = $client->associateWirelessDeviceWithThing([
'Id' => '<string>', // REQUIRED
'ThingArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
The input did not meet the specified constraints.
-
User does not have permission to perform this action.
-
Resource does not exist.
-
Adding, updating, or deleting the resource can cause an inconsistent state.
-
The request was denied because it exceeded the allowed API request rate.
-
An unexpected error occurred while processing a request.
AssociateWirelessGatewayWithCertificate
$result = $client->associateWirelessGatewayWithCertificate([/* ... */]); $promise = $client->associateWirelessGatewayWithCertificateAsync([/* ... */]);
Associates a wireless gateway with a certificate.
Parameter Syntax
$result = $client->associateWirelessGatewayWithCertificate([
'Id' => '<string>', // REQUIRED
'IotCertificateId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'IotCertificateId' => '<string>',
]
Result Details
Members
Errors
-
The input did not meet the specified constraints.
-
User does not have permission to perform this action.
-
Resource does not exist.
-
Adding, updating, or deleting the resource can cause an inconsistent state.
-
An unexpected error occurred while processing a request.
-
The request was denied because it exceeded the allowed API request rate.
AssociateWirelessGatewayWithThing
$result = $client->associateWirelessGatewayWithThing([/* ... */]); $promise = $client->associateWirelessGatewayWithThingAsync([/* ... */]);
Associates a wireless gateway with a thing.
Parameter Syntax
$result = $client->associateWirelessGatewayWithThing([
'Id' => '<string>', // REQUIRED
'ThingArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
The input did not meet the specified constraints.
-
Resource does not exist.
-
User does not have permission to perform this action.
-
Adding, updating, or deleting the resource can cause an inconsistent state.
-
The request was denied because it exceeded the allowed API request rate.
-
An unexpected error occurred while processing a request.
CreateDestination
$result = $client->createDestination([/* ... */]); $promise = $client->createDestinationAsync([/* ... */]);
Creates a new destination that maps a device message to an AWS IoT rule.
Parameter Syntax
$result = $client->createDestination([
'ClientRequestToken' => '<string>',
'Description' => '<string>',
'Expression' => '<string>', // REQUIRED
'ExpressionType' => 'RuleName|MqttTopic', // REQUIRED
'Name' => '<string>', // REQUIRED
'RoleArn' => '<string>', // REQUIRED
'Tags' => [
[
'Key' => '<string>', // REQUIRED
'Value' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- ClientRequestToken
-
- Type: 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
-
- Type: string
The description of the new resource.
- Expression
-
- Required: Yes
- Type: string
The rule name or topic rule to send messages to.
- ExpressionType
-
- Required: Yes
- Type: string
The type of value in
Expression. - Name
-
- Required: Yes
- Type: string
The name of the new resource.
- RoleArn
-
- Required: Yes
- Type: string
The ARN of the IAM Role that authorizes the destination.
- Tags
-
- Type: Array of Tag structures
The tags to attach to the new destination. Tags are metadata that you can use to manage a resource.
Result Syntax
[
'Arn' => '<string>',
'Name' => '<string>',
]
Result Details
Members
Errors
-
The input did not meet the specified constraints.
-
Resource does not exist.
-
User does not have permission to perform this action.
-
Adding, updating, or deleting the resource can cause an inconsistent state.
-
An unexpected error occurred while processing a request.
-
The request was denied because it exceeded the allowed API request rate.
CreateDeviceProfile
$result = $client->createDeviceProfile([/* ... */]); $promise = $client->createDeviceProfileAsync([/* ... */]);
Creates a new device profile.
Parameter Syntax
$result = $client->createDeviceProfile([
'ClientRequestToken' => '<string>',
'LoRaWAN' => [
'ClassBTimeout' => <integer>,
'ClassCTimeout' => <integer>,
'FactoryPresetFreqsList' => [<integer>, ...],
'MacVersion' => '<string>',
'MaxDutyCycle' => <integer>,
'MaxEirp' => <integer>,
'PingSlotDr' => <integer>,
'PingSlotFreq' => <integer>,
'PingSlotPeriod' => <integer>,
'RegParamsRevision' => '<string>',
'RfRegion' => '<string>',
'RxDataRate2' => <integer>,
'RxDelay1' => <integer>,
'RxDrOffset1' => <integer>,
'RxFreq2' => <integer>,
'Supports32BitFCnt' => true || false,
'SupportsClassB' => true || false,
'SupportsClassC' => true || false,
'SupportsJoin' => true || false,
],
'Name' => '<string>',
'Tags' => [
[
'Key' => '<string>', // REQUIRED
'Value' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- ClientRequestToken
-
- Type: 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
-
- Type: LoRaWANDeviceProfile structure
The device profile information to use to create the device profile.
- Name
-
- Type: string
The name of the new resource.
- Tags
-
- Type: Array of Tag structures
The tags to attach to the new device profile. Tags are metadata that you can use to manage a resource.
Result Syntax
[
'Arn' => '<string>',
'Id' => '<string>',
]
Result Details
Members
Errors
-
The input did not meet the specified constraints.
-
User does not have permission to perform this action.
-
Adding, updating, or deleting the resource can cause an inconsistent state.
-
An unexpected error occurred while processing a request.
-
The request was denied because it exceeded the allowed API request rate.
CreateServiceProfile
$result = $client->createServiceProfile([/* ... */]); $promise = $client->createServiceProfileAsync([/* ... */]);
Creates a new service profile.
Parameter Syntax
$result = $client->createServiceProfile([
'ClientRequestToken' => '<string>',
'LoRaWAN' => [
'AddGwMetadata' => true || false,
],
'Name' => '<string>',
'Tags' => [
[
'Key' => '<string>', // REQUIRED
'Value' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- ClientRequestToken
-
- Type: 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
-
- Type: LoRaWANServiceProfile structure
The service profile information to use to create the service profile.
- Name
-
- Type: string
The name of the new resource.
- Tags
-
- Type: Array of Tag structures
The tags to attach to the new service profile. Tags are metadata that you can use to manage a resource.
Result Syntax
[
'Arn' => '<string>',
'Id' => '<string>',
]
Result Details
Members
Errors
-
The input did not meet the specified constraints.
-
User does not have permission to perform this action.
-
Adding, updating, or deleting the resource can cause an inconsistent state.
-
An unexpected error occurred while processing a request.
-
The request was denied because it exceeded the allowed API request rate.
CreateWirelessDevice
$result = $client->createWirelessDevice([/* ... */]); $promise = $client->createWirelessDeviceAsync([/* ... */]);
Provisions a wireless device.
Parameter Syntax
$result = $client->createWirelessDevice([
'ClientRequestToken' => '<string>',
'Description' => '<string>',
'DestinationName' => '<string>', // REQUIRED
'LoRaWAN' => [
'AbpV1_0_x' => [
'DevAddr' => '<string>',
'SessionKeys' => [
'AppSKey' => '<string>',
'NwkSKey' => '<string>',
],
],
'AbpV1_1' => [
'DevAddr' => '<string>',
'SessionKeys' => [
'AppSKey' => '<string>',
'FNwkSIntKey' => '<string>',
'NwkSEncKey' => '<string>',
'SNwkSIntKey' => '<string>',
],
],
'DevEui' => '<string>',
'DeviceProfileId' => '<string>',
'OtaaV1_0_x' => [
'AppEui' => '<string>',
'AppKey' => '<string>',
],
'OtaaV1_1' => [
'AppKey' => '<string>',
'JoinEui' => '<string>',
'NwkKey' => '<string>',
],
'ServiceProfileId' => '<string>',
],
'Name' => '<string>',
'Tags' => [
[
'Key' => '<string>', // REQUIRED
'Value' => '<string>', // REQUIRED
],
// ...
],
'Type' => 'Sidewalk|LoRaWAN', // REQUIRED
]);
Parameter Details
Members
- ClientRequestToken
-
- Type: 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
-
- Type: string
The description of the new resource.
- DestinationName
-
- Required: Yes
- Type: string
The name of the destination to assign to the new wireless device.
- LoRaWAN
-
- Type: LoRaWANDevice structure
The device configuration information to use to create the wireless device.
- Name
-
- Type: string
The name of the new resource.
- Tags
-
- Type: Array of Tag structures
The tags to attach to the new wireless device. Tags are metadata that you can use to manage a resource.
- Type
-
- Required: Yes
- Type: string
The wireless device type.
Result Syntax
[
'Arn' => '<string>',
'Id' => '<string>',
]
Result Details
Members
Errors
-
The input did not meet the specified constraints.
-
Resource does not exist.
-
User does not have permission to perform this action.
-
Adding, updating, or deleting the resource can cause an inconsistent state.
-
An unexpected error occurred while processing a request.
-
The request was denied because it exceeded the allowed API request rate.
CreateWirelessGateway
$result = $client->createWirelessGateway([/* ... */]); $promise = $client->createWirelessGatewayAsync([/* ... */]);
Provisions a wireless gateway.
Parameter Syntax
$result = $client->createWirelessGateway([
'ClientRequestToken' => '<string>',
'Description' => '<string>',
'LoRaWAN' => [ // REQUIRED
'GatewayEui' => '<string>',
'RfRegion' => '<string>',
],
'Name' => '<string>',
'Tags' => [
[
'Key' => '<string>', // REQUIRED
'Value' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- ClientRequestToken
-
- Type: 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
-
- Type: string
The description of the new resource.
- LoRaWAN
-
- Required: Yes
- Type: LoRaWANGateway structure
The gateway configuration information to use to create the wireless gateway.
- Name
-
- Type: string
The name of the new resource.
- Tags
-
- Type: Array of Tag structures
The tags to attach to the new wireless gateway. Tags are metadata that you can use to manage a resource.
Result Syntax
[
'Arn' => '<string>',
'Id' => '<string>',
]
Result Details
Members
Errors
-
The input did not meet the specified constraints.
-
User does not have permission to perform this action.
-
Adding, updating, or deleting the resource can cause an inconsistent state.
-
An unexpected error occurred while processing a request.
-
The request was denied because it exceeded the allowed API request rate.
CreateWirelessGatewayTask
$result = $client->createWirelessGatewayTask([/* ... */]); $promise = $client->createWirelessGatewayTaskAsync([/* ... */]);
Creates a task for a wireless gateway.
Parameter Syntax
$result = $client->createWirelessGatewayTask([
'Id' => '<string>', // REQUIRED
'WirelessGatewayTaskDefinitionId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'Status' => 'PENDING|IN_PROGRESS|FIRST_RETRY|SECOND_RETRY|COMPLETED|FAILED',
'WirelessGatewayTaskDefinitionId' => '<string>',
]
Result Details
Members
Errors
-
The input did not meet the specified constraints.
-
User does not have permission to perform this action.
-
Resource does not exist.
-
Adding, updating, or deleting the resource can cause an inconsistent state.
-
An unexpected error occurred while processing a request.
-
The request was denied because it exceeded the allowed API request rate.
CreateWirelessGatewayTaskDefinition
$result = $client->createWirelessGatewayTaskDefinition([/* ... */]); $promise = $client->createWirelessGatewayTaskDefinitionAsync([/* ... */]);
Creates a gateway task definition.
Parameter Syntax
$result = $client->createWirelessGatewayTaskDefinition([
'AutoCreateTasks' => true || false, // REQUIRED
'ClientRequestToken' => '<string>',
'Name' => '<string>',
'Tags' => [
[
'Key' => '<string>', // REQUIRED
'Value' => '<string>', // REQUIRED
],
// ...
],
'Update' => [
'LoRaWAN' => [
'CurrentVersion' => [
'Model' => '<string>',
'PackageVersion' => '<string>',
'Station' => '<string>',
],
'SigKeyCrc' => <integer>,
'UpdateSignature' => '<string>',
'UpdateVersion' => [
'Model' => '<string>',
'PackageVersion' => '<string>',
'Station' => '<string>',
],
],
'UpdateDataRole' => '<string>',
'UpdateDataSource' => '<string>',
],
]);
Parameter Details
Members
- AutoCreateTasks
-
- Required: Yes
- Type: 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 callingCreateWirelessGatewayTask. - ClientRequestToken
-
- Type: 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
-
- Type: string
The name of the new resource.
- Tags
-
- Type: Array of Tag structures
The tags to attach to the specified resource. Tags are metadata that you can use to manage a resource.
- Update
-
- Type: UpdateWirelessGatewayTaskCreate structure
Information about the gateways to update.
Result Syntax
[
'Arn' => '<string>',
'Id' => '<string>',
]
Result Details
Members
Errors
-
The input did not meet the specified constraints.
-
User does not have permission to perform this action.
-
Resource does not exist.
-
Adding, updating, or deleting the resource can cause an inconsistent state.
-
An unexpected error occurred while processing a request.
-
The request was denied because it exceeded the allowed API request rate.
DeleteDestination
$result = $client->deleteDestination([/* ... */]); $promise = $client->deleteDestinationAsync([/* ... */]);
Deletes a destination.
Parameter Syntax
$result = $client->deleteDestination([
'Name' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
The input did not meet the specified constraints.
-
Resource does not exist.
-
User does not have permission to perform this action.
-
An unexpected error occurred while processing a request.
-
Adding, updating, or deleting the resource can cause an inconsistent state.
-
The request was denied because it exceeded the allowed API request rate.
DeleteDeviceProfile
$result = $client->deleteDeviceProfile([/* ... */]); $promise = $client->deleteDeviceProfileAsync([/* ... */]);
Deletes a device profile.
Parameter Syntax
$result = $client->deleteDeviceProfile([
'Id' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
The input did not meet the specified constraints.
-
User does not have permission to perform this action.
-
Resource does not exist.
-
An unexpected error occurred while processing a request.
-
Adding, updating, or deleting the resource can cause an inconsistent state.
-
The request was denied because it exceeded the allowed API request rate.
DeleteServiceProfile
$result = $client->deleteServiceProfile([/* ... */]); $promise = $client->deleteServiceProfileAsync([/* ... */]);
Deletes a service profile.
Parameter Syntax
$result = $client->deleteServiceProfile([
'Id' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
The input did not meet the specified constraints.
-
User does not have permission to perform this action.
-
Resource does not exist.
-
An unexpected error occurred while processing a request.
-
Adding, updating, or deleting the resource can cause an inconsistent state.
-
The request was denied because it exceeded the allowed API request rate.
DeleteWirelessDevice
$result = $client->deleteWirelessDevice([/* ... */]); $promise = $client->deleteWirelessDeviceAsync([/* ... */]);
Deletes a wireless device.
Parameter Syntax
$result = $client->deleteWirelessDevice([
'Id' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
The input did not meet the specified constraints.
-
Resource does not exist.
-
User does not have permission to perform this action.
-
An unexpected error occurred while processing a request.
-
The request was denied because it exceeded the allowed API request rate.
DeleteWirelessGateway
$result = $client->deleteWirelessGateway([/* ... */]); $promise = $client->deleteWirelessGatewayAsync([/* ... */]);
Deletes a wireless gateway.
Parameter Syntax
$result = $client->deleteWirelessGateway([
'Id' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
The input did not meet the specified constraints.
-
Resource does not exist.
-
User does not have permission to perform this action.
-
An unexpected error occurred while processing a request.
-
The request was denied because it exceeded the allowed API request rate.
DeleteWirelessGatewayTask
$result = $client->deleteWirelessGatewayTask([/* ... */]); $promise = $client->deleteWirelessGatewayTaskAsync([/* ... */]);
Deletes a wireless gateway task.
Parameter Syntax
$result = $client->deleteWirelessGatewayTask([
'Id' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
The input did not meet the specified constraints.
-
User does not have permission to perform this action.
-
Resource does not exist.
-
An unexpected error occurred while processing a request.
-
The request was denied because it exceeded the allowed API request rate.
DeleteWirelessGatewayTaskDefinition
$result = $client->deleteWirelessGatewayTaskDefinition([/* ... */]); $promise = $client->deleteWirelessGatewayTaskDefinitionAsync([/* ... */]);
Deletes a wireless gateway task definition. Deleting this task definition does not affect tasks that are currently in progress.
Parameter Syntax
$result = $client->deleteWirelessGatewayTaskDefinition([
'Id' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
The input did not meet the specified constraints.
-
User does not have permission to perform this action.
-
Resource does not exist.
-
An unexpected error occurred while processing a request.
-
The request was denied because it exceeded the allowed API request rate.
DisassociateAwsAccountFromPartnerAccount
$result = $client->disassociateAwsAccountFromPartnerAccount([/* ... */]); $promise = $client->disassociateAwsAccountFromPartnerAccountAsync([/* ... */]);
Disassociates your AWS account from a partner account. If PartnerAccountId and PartnerType are null, disassociates your AWS account from all partner accounts.
Parameter Syntax
$result = $client->disassociateAwsAccountFromPartnerAccount([
'PartnerAccountId' => '<string>', // REQUIRED
'PartnerType' => 'Sidewalk', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
The input did not meet the specified constraints.
-
Resource does not exist.
-
An unexpected error occurred while processing a request.
-
The request was denied because it exceeded the allowed API request rate.
DisassociateWirelessDeviceFromThing
$result = $client->disassociateWirelessDeviceFromThing([/* ... */]); $promise = $client->disassociateWirelessDeviceFromThingAsync([/* ... */]);
Disassociates a wireless device from its currently associated thing.
Parameter Syntax
$result = $client->disassociateWirelessDeviceFromThing([
'Id' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
The input did not meet the specified constraints.
-
User does not have permission to perform this action.
-
Resource does not exist.
-
Adding, updating, or deleting the resource can cause an inconsistent state.
-
The request was denied because it exceeded the allowed API request rate.
-
An unexpected error occurred while processing a request.
DisassociateWirelessGatewayFromCertificate
$result = $client->disassociateWirelessGatewayFromCertificate([/* ... */]); $promise = $client->disassociateWirelessGatewayFromCertificateAsync([/* ... */]);
Disassociates a wireless gateway from its currently associated certificate.
Parameter Syntax
$result = $client->disassociateWirelessGatewayFromCertificate([
'Id' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
The input did not meet the specified constraints.
-
User does not have permission to perform this action.
-
Resource does not exist.
-
An unexpected error occurred while processing a request.
-
The request was denied because it exceeded the allowed API request rate.
DisassociateWirelessGatewayFromThing
$result = $client->disassociateWirelessGatewayFromThing([/* ... */]); $promise = $client->disassociateWirelessGatewayFromThingAsync([/* ... */]);
Disassociates a wireless gateway from its currently associated thing.
Parameter Syntax
$result = $client->disassociateWirelessGatewayFromThing([
'Id' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
The input did not meet the specified constraints.
-
User does not have permission to perform this action.
-
Resource does not exist.
-
Adding, updating, or deleting the resource can cause an inconsistent state.
-
The request was denied because it exceeded the allowed API request rate.
-
An unexpected error occurred while processing a request.
GetDestination
$result = $client->getDestination([/* ... */]); $promise = $client->getDestinationAsync([/* ... */]);
Gets information about a destination.
Parameter Syntax
$result = $client->getDestination([
'Name' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'Arn' => '<string>',
'Description' => '<string>',
'Expression' => '<string>',
'ExpressionType' => 'RuleName|MqttTopic',
'Name' => '<string>',
'RoleArn' => '<string>',
]
Result Details
Members
- Arn
-
- Type: string
The Amazon Resource Name of the resource.
- Description
-
- Type: string
The description of the resource.
- Expression
-
- Type: string
The rule name or topic rule to send messages to.
- ExpressionType
-
- Type: string
The type of value in
Expression. - Name
-
- Type: string
The name of the resource.
- RoleArn
-
- Type: string
The ARN of the IAM Role that authorizes the destination.
Errors
-
The input did not meet the specified constraints.
-
Resource does not exist.
-
User does not have permission to perform this action.
-
An unexpected error occurred while processing a request.
-
The request was denied because it exceeded the allowed API request rate.
GetDeviceProfile
$result = $client->getDeviceProfile([/* ... */]); $promise = $client->getDeviceProfileAsync([/* ... */]);
Gets information about a device profile.
Parameter Syntax
$result = $client->getDeviceProfile([
'Id' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'Arn' => '<string>',
'Id' => '<string>',
'LoRaWAN' => [
'ClassBTimeout' => <integer>,
'ClassCTimeout' => <integer>,
'FactoryPresetFreqsList' => [<integer>, ...],
'MacVersion' => '<string>',
'MaxDutyCycle' => <integer>,
'MaxEirp' => <integer>,
'PingSlotDr' => <integer>,
'PingSlotFreq' => <integer>,
'PingSlotPeriod' => <integer>,
'RegParamsRevision' => '<string>',
'RfRegion' => '<string>',
'RxDataRate2' => <integer>,
'RxDelay1' => <integer>,
'RxDrOffset1' => <integer>,
'RxFreq2' => <integer>,
'Supports32BitFCnt' => true || false,
'SupportsClassB' => true || false,
'SupportsClassC' => true || false,
'SupportsJoin' => true || false,
],
'Name' => '<string>',
]
Result Details
Members
- Arn
-
- Type: string
The Amazon Resource Name of the resource.
- Id
-
- Type: string
The ID of the device profile.
- LoRaWAN
-
- Type: LoRaWANDeviceProfile structure
Information about the device profile.
- Name
-
- Type: string
The name of the resource.
Errors
-
The input did not meet the specified constraints.
-
User does not have permission to perform this action.
-
Resource does not exist.
-
An unexpected error occurred while processing a request.
-
The request was denied because it exceeded the allowed API request rate.
GetPartnerAccount
$result = $client->getPartnerAccount([/* ... */]); $promise = $client->getPartnerAccountAsync([/* ... */]);
Gets information about a partner account. If PartnerAccountId and PartnerType are null, returns all partner accounts.
Parameter Syntax
$result = $client->getPartnerAccount([
'PartnerAccountId' => '<string>', // REQUIRED
'PartnerType' => 'Sidewalk', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'AccountLinked' => true || false,
'Sidewalk' => [
'AmazonId' => '<string>',
'Arn' => '<string>',
'Fingerprint' => '<string>',
],
]
Result Details
Members
- AccountLinked
-
- Type: boolean
Whether the partner account is linked to the AWS account.
- Sidewalk
-
- Type: SidewalkAccountInfoWithFingerprint structure
The Sidewalk account credentials.
Errors
-
The input did not meet the specified constraints.
-
Resource does not exist.
-
An unexpected error occurred while processing a request.
-
The request was denied because it exceeded the allowed API request rate.
GetServiceEndpoint
$result = $client->getServiceEndpoint([/* ... */]); $promise = $client->getServiceEndpointAsync([/* ... */]);
Gets the account-specific endpoint for Configuration and Update Server (CUPS) protocol or LoRaWAN Network Server (LNS) connections.
Parameter Syntax
$result = $client->getServiceEndpoint([
'ServiceType' => 'CUPS|LNS',
]);
Parameter Details
Members
Result Syntax
[
'ServerTrust' => '<string>',
'ServiceEndpoint' => '<string>',
'ServiceType' => 'CUPS|LNS',
]
Result Details
Members
Errors
-
The input did not meet the specified constraints.
-
User does not have permission to perform this action.
-
An unexpected error occurred while processing a request.
-
The request was denied because it exceeded the allowed API request rate.
GetServiceProfile
$result = $client->getServiceProfile([/* ... */]); $promise = $client->getServiceProfileAsync([/* ... */]);
Gets information about a service profile.
Parameter Syntax
$result = $client->getServiceProfile([
'Id' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'Arn' => '<string>',
'Id' => '<string>',
'LoRaWAN' => [
'AddGwMetadata' => true || false,
'ChannelMask' => '<string>',
'DevStatusReqFreq' => <integer>,
'DlBucketSize' => <integer>,
'DlRate' => <integer>,
'DlRatePolicy' => '<string>',
'DrMax' => <integer>,
'DrMin' => <integer>,
'HrAllowed' => true || false,
'MinGwDiversity' => <integer>,
'NwkGeoLoc' => true || false,
'PrAllowed' => true || false,
'RaAllowed' => true || false,
'ReportDevStatusBattery' => true || false,
'ReportDevStatusMargin' => true || false,
'TargetPer' => <integer>,
'UlBucketSize' => <integer>,
'UlRate' => <integer>,
'UlRatePolicy' => '<string>',
],
'Name' => '<string>',
]
Result Details
Members
- Arn
-
- Type: string
The Amazon Resource Name of the resource.
- Id
-
- Type: string
The ID of the service profile.
- LoRaWAN
-
- Type: LoRaWANGetServiceProfileInfo structure
Information about the service profile.
- Name
-
- Type: string
The name of the resource.
Errors
-
The input did not meet the specified constraints.
-
User does not have permission to perform this action.
-
Resource does not exist.
-
An unexpected error occurred while processing a request.
-
The request was denied because it exceeded the allowed API request rate.
GetWirelessDevice
$result = $client->getWirelessDevice([/* ... */]); $promise = $client->getWirelessDeviceAsync([/* ... */]);
Gets information about a wireless device.
Parameter Syntax
$result = $client->getWirelessDevice([
'Identifier' => '<string>', // REQUIRED
'IdentifierType' => 'WirelessDeviceId|DevEui|ThingName', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'Arn' => '<string>',
'Description' => '<string>',
'DestinationName' => '<string>',
'Id' => '<string>',
'LoRaWAN' => [
'AbpV1_0_x' => [
'DevAddr' => '<string>',
'SessionKeys' => [
'AppSKey' => '<string>',
'NwkSKey' => '<string>',
],
],
'AbpV1_1' => [
'DevAddr' => '<string>',
'SessionKeys' => [
'AppSKey' => '<string>',
'FNwkSIntKey' => '<string>',
'NwkSEncKey' => '<string>',
'SNwkSIntKey' => '<string>',
],
],
'DevEui' => '<string>',
'DeviceProfileId' => '<string>',
'OtaaV1_0_x' => [
'AppEui' => '<string>',
'AppKey' => '<string>',
],
'OtaaV1_1' => [
'AppKey' => '<string>',
'JoinEui' => '<string>',
'NwkKey' => '<string>',
],
'ServiceProfileId' => '<string>',
],
'Name' => '<string>',
'Sidewalk' => [
'DeviceCertificates' => [
[
'SigningAlg' => 'Ed25519|P256r1',
'Value' => '<string>',
],
// ...
],
'SidewalkId' => '<string>',
'SidewalkManufacturingSn' => '<string>',
],
'ThingArn' => '<string>',
'ThingName' => '<string>',
'Type' => 'Sidewalk|LoRaWAN',
]
Result Details
Members
- Arn
-
- Type: string
The Amazon Resource Name of the resource.
- Description
-
- Type: string
The description of the resource.
- DestinationName
-
- Type: string
The name of the destination to which the device is assigned.
- Id
-
- Type: string
The ID of the wireless device.
- LoRaWAN
-
- Type: LoRaWANDevice structure
Information about the wireless device.
- Name
-
- Type: string
The name of the resource.
- Sidewalk
-
- Type: SidewalkDevice structure
Sidewalk device object.
- ThingArn
-
- Type: string
The ARN of the thing associated with the wireless device.
- ThingName
-
- Type: string
The name of the thing associated with the wireless device. The value is empty if a thing isn't associated with the device.
- Type
-
- Type: string
The wireless device type.
Errors
-
The input did not meet the specified constraints.
-
User does not have permission to perform this action.
-
Resource does not exist.
-
An unexpected error occurred while processing a request.
-
The request was denied because it exceeded the allowed API request rate.
GetWirelessDeviceStatistics
$result = $client->getWirelessDeviceStatistics([/* ... */]); $promise = $client->getWirelessDeviceStatisticsAsync([/* ... */]);
Gets operating information about a wireless device.
Parameter Syntax
$result = $client->getWirelessDeviceStatistics([
'WirelessDeviceId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'LastUplinkReceivedAt' => '<string>',
'LoRaWAN' => [
'DataRate' => <integer>,
'DevEui' => '<string>',
'FPort' => <integer>,
'Frequency' => <integer>,
'Gateways' => [
[
'GatewayEui' => '<string>',
'Rssi' => <float>,
'Snr' => <float>,
],
// ...
],
'Timestamp' => '<string>',
],
'Sidewalk' => [
'BatteryLevel' => 'normal|low|critical',
'DeviceState' => 'Provisioned|RegisteredNotSeen|RegisteredReachable|RegisteredUnreachable',
'Event' => 'discovered|lost|ack|nack|passthrough',
'Rssi' => <integer>,
],
'WirelessDeviceId' => '<string>',
]
Result Details
Members
- LastUplinkReceivedAt
-
- Type: string
The date and time when the most recent uplink was received.
- LoRaWAN
-
- Type: LoRaWANDeviceMetadata structure
Information about the wireless device's operations.
- Sidewalk
-
- Type: SidewalkDeviceMetadata structure
MetaData for Sidewalk device.
- WirelessDeviceId
-
- Type: string
The ID of the wireless device.
Errors
-
The input did not meet the specified constraints.
-
User does not have permission to perform this action.
-
Resource does not exist.
-
An unexpected error occurred while processing a request.
-
The request was denied because it exceeded the allowed API request rate.
GetWirelessGateway
$result = $client->getWirelessGateway([/* ... */]); $promise = $client->getWirelessGatewayAsync([/* ... */]);
Gets information about a wireless gateway.
Parameter Syntax
$result = $client->getWirelessGateway([
'Identifier' => '<string>', // REQUIRED
'IdentifierType' => 'GatewayEui|WirelessGatewayId|ThingName', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'Arn' => '<string>',
'Description' => '<string>',
'Id' => '<string>',
'LoRaWAN' => [
'GatewayEui' => '<string>',
'RfRegion' => '<string>',
],
'Name' => '<string>',
'ThingArn' => '<string>',
'ThingName' => '<string>',
]
Result Details
Members
- Arn
-
- Type: string
The Amazon Resource Name of the resource.
- Description
-
- Type: string
The description of the resource.
- Id
-
- Type: string
The ID of the wireless gateway.
- LoRaWAN
-
- Type: LoRaWANGateway structure
Information about the wireless gateway.
- Name
-
- Type: string
The name of the resource.
- ThingArn
-
- Type: string
The ARN of the thing associated with the wireless gateway.
- ThingName
-
- Type: string
The name of the thing associated with the wireless gateway. The value is empty if a thing isn't associated with the gateway.
Errors
-
The input did not meet the specified constraints.
-
Resource does not exist.
-
User does not have permission to perform this action.
-
An unexpected error occurred while processing a request.
-
The request was denied because it exceeded the allowed API request rate.
GetWirelessGatewayCertificate
$result = $client->getWirelessGatewayCertificate([/* ... */]); $promise = $client->getWirelessGatewayCertificateAsync([/* ... */]);
Gets the ID of the certificate that is currently associated with a wireless gateway.
Parameter Syntax
$result = $client->getWirelessGatewayCertificate([
'Id' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'IotCertificateId' => '<string>',
'LoRaWANNetworkServerCertificateId' => '<string>',
]
Result Details
Members
Errors
-
The input did not meet the specified constraints.
-
User does not have permission to perform this action.
-
Resource does not exist.
-
An unexpected error occurred while processing a request.
-
The request was denied because it exceeded the allowed API request rate.
GetWirelessGatewayFirmwareInformation
$result = $client->getWirelessGatewayFirmwareInformation([/* ... */]); $promise = $client->getWirelessGatewayFirmwareInformationAsync([/* ... */]);
Gets the firmware version and other information about a wireless gateway.
Parameter Syntax
$result = $client->getWirelessGatewayFirmwareInformation([
'Id' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'LoRaWAN' => [
'CurrentVersion' => [
'Model' => '<string>',
'PackageVersion' => '<string>',
'Station' => '<string>',
],
],
]
Result Details
Members
- LoRaWAN
-
- Type: LoRaWANGatewayCurrentVersion structure
Information about the wireless gateway's firmware.
Errors
-
The input did not meet the specified constraints.
-
User does not have permission to perform this action.
-
Resource does not exist.
-
An unexpected error occurred while processing a request.
-
The request was denied because it exceeded the allowed API request rate.
GetWirelessGatewayStatistics
$result = $client->getWirelessGatewayStatistics([/* ... */]); $promise = $client->getWirelessGatewayStatisticsAsync([/* ... */]);
Gets operating information about a wireless gateway.
Parameter Syntax
$result = $client->getWirelessGatewayStatistics([
'WirelessGatewayId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'ConnectionStatus' => 'Connected|Disconnected',
'LastUplinkReceivedAt' => '<string>',
'WirelessGatewayId' => '<string>',
]
Result Details
Members
Errors
-
The input did not meet the specified constraints.
-
User does not have permission to perform this action.
-
Resource does not exist.
-
An unexpected error occurred while processing a request.
-
The request was denied because it exceeded the allowed API request rate.
GetWirelessGatewayTask
$result = $client->getWirelessGatewayTask([/* ... */]); $promise = $client->getWirelessGatewayTaskAsync([/* ... */]);
Gets information about a wireless gateway task.
Parameter Syntax
$result = $client->getWirelessGatewayTask([
'Id' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'LastUplinkReceivedAt' => '<string>',
'Status' => 'PENDING|IN_PROGRESS|FIRST_RETRY|SECOND_RETRY|COMPLETED|FAILED',
'TaskCreatedAt' => '<string>',
'WirelessGatewayId' => '<string>',
'WirelessGatewayTaskDefinitionId' => '<string>',
]
Result Details
Members
- LastUplinkReceivedAt
-
- Type: string
The date and time when the most recent uplink was received.
- Status
-
- Type: string
The status of the request.
- TaskCreatedAt
-
- Type: string
The date and time when the task was created.
- WirelessGatewayId
-
- Type: string
The ID of the wireless gateway.
- WirelessGatewayTaskDefinitionId
-
- Type: string
The ID of the WirelessGatewayTask.
Errors
-
The input did not meet the specified constraints.
-
User does not have permission to perform this action.
-
Resource does not exist.
-
An unexpected error occurred while processing a request.
-
The request was denied because it exceeded the allowed API request rate.
GetWirelessGatewayTaskDefinition
$result = $client->getWirelessGatewayTaskDefinition([/* ... */]); $promise = $client->getWirelessGatewayTaskDefinitionAsync([/* ... */]);
Gets information about a wireless gateway task definition.
Parameter Syntax
$result = $client->getWirelessGatewayTaskDefinition([
'Id' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'Arn' => '<string>',
'AutoCreateTasks' => true || false,
'Name' => '<string>',
'Update' => [
'LoRaWAN' => [
'CurrentVersion' => [
'Model' => '<string>',
'PackageVersion' => '<string>',
'Station' => '<string>',
],
'SigKeyCrc' => <integer>,
'UpdateSignature' => '<string>',
'UpdateVersion' => [
'Model' => '<string>',
'PackageVersion' => '<string>',
'Station' => '<string>',
],
],
'UpdateDataRole' => '<string>',
'UpdateDataSource' => '<string>',
],
]
Result Details
Members
- Arn
-
- Type: string
The Amazon Resource Name of the resource.
- AutoCreateTasks
-
- Type: 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 callingCreateWirelessGatewayTask. - Name
-
- Type: string
The name of the resource.
- Update
-
- Type: UpdateWirelessGatewayTaskCreate structure
Information about the gateways to update.
Errors
-
The input did not meet the specified constraints.
-
User does not have permission to perform this action.
-
Resource does not exist.
-
An unexpected error occurred while processing a request.
-
The request was denied because it exceeded the allowed API request rate.
ListDestinations
$result = $client->listDestinations([/* ... */]); $promise = $client->listDestinationsAsync([/* ... */]);
Lists the destinations registered to your AWS account.
Parameter Syntax
$result = $client->listDestinations([
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'DestinationList' => [
[
'Arn' => '<string>',
'Description' => '<string>',
'Expression' => '<string>',
'ExpressionType' => 'RuleName|MqttTopic',
'Name' => '<string>',
'RoleArn' => '<string>',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- DestinationList
-
- Type: Array of Destinations structures
The list of destinations.
- NextToken
-
- Type: string
The token to use to get the next set of results, or null if there are no additional results.
Errors
-
The input did not meet the specified constraints.
-
User does not have permission to perform this action.
-
An unexpected error occurred while processing a request.
-
The request was denied because it exceeded the allowed API request rate.
ListDeviceProfiles
$result = $client->listDeviceProfiles([/* ... */]); $promise = $client->listDeviceProfilesAsync([/* ... */]);
Lists the device profiles registered to your AWS account.
Parameter Syntax
$result = $client->listDeviceProfiles([
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'DeviceProfileList' => [
[
'Arn' => '<string>',
'Id' => '<string>',
'Name' => '<string>',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- DeviceProfileList
-
- Type: Array of DeviceProfile structures
The list of device profiles.
- NextToken
-
- Type: string
The token to use to get the next set of results, or null if there are no additional results.
Errors
-
The input did not meet the specified constraints.
-
User does not have permission to perform this action.
-
An unexpected error occurred while processing a request.
-
The request was denied because it exceeded the allowed API request rate.
ListPartnerAccounts
$result = $client->listPartnerAccounts([/* ... */]); $promise = $client->listPartnerAccountsAsync([/* ... */]);
Lists the partner accounts associated with your AWS account.
Parameter Syntax
$result = $client->listPartnerAccounts([
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'NextToken' => '<string>',
'Sidewalk' => [
[
'AmazonId' => '<string>',
'Arn' => '<string>',
'Fingerprint' => '<string>',
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
The token to use to get the next set of results, or null if there are no additional results.
- Sidewalk
-
- Type: Array of SidewalkAccountInfoWithFingerprint structures
The Sidewalk account credentials.
Errors
-
The input did not meet the specified constraints.
-
Resource does not exist.
-
An unexpected error occurred while processing a request.
-
The request was denied because it exceeded the allowed API request rate.
ListServiceProfiles
$result = $client->listServiceProfiles([/* ... */]); $promise = $client->listServiceProfilesAsync([/* ... */]);
Lists the service profiles registered to your AWS account.
Parameter Syntax
$result = $client->listServiceProfiles([
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'NextToken' => '<string>',
'ServiceProfileList' => [
[
'Arn' => '<string>',
'Id' => '<string>',
'Name' => '<string>',
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
The token to use to get the next set of results, or null if there are no additional results.
- ServiceProfileList
-
- Type: Array of ServiceProfile structures
The list of service profiles.
Errors
-
The input did not meet the specified constraints.
-
User does not have permission to perform this action.
-
An unexpected error occurred while processing a request.
-
The request was denied because it exceeded the allowed API request rate.
ListTagsForResource
$result = $client->listTagsForResource([/* ... */]); $promise = $client->listTagsForResourceAsync([/* ... */]);
Lists the tags (metadata) you have assigned to the resource.
Parameter Syntax
$result = $client->listTagsForResource([
'ResourceArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
]
Result Details
Members
- Tags
-
- Type: Array of Tag structures
The tags to attach to the specified resource. Tags are metadata that you can use to manage a resource.
Errors
-
The input did not meet the specified constraints.
-
Resource does not exist.
-
Adding, updating, or deleting the resource can cause an inconsistent state.
-
An unexpected error occurred while processing a request.
-
The request was denied because it exceeded the allowed API request rate.
ListWirelessDevices
$result = $client->listWirelessDevices([/* ... */]); $promise = $client->listWirelessDevicesAsync([/* ... */]);
Lists the wireless devices registered to your AWS account.
Parameter Syntax
$result = $client->listWirelessDevices([
'DestinationName' => '<string>',
'DeviceProfileId' => '<string>',
'MaxResults' => <integer>,
'NextToken' => '<string>',
'ServiceProfileId' => '<string>',
'WirelessDeviceType' => 'Sidewalk|LoRaWAN',
]);
Parameter Details
Members
- DestinationName
-
- Type: string
A filter to list only the wireless devices that use this destination.
- DeviceProfileId
-
- Type: string
A filter to list only the wireless devices that use this device profile.
- MaxResults
-
- Type: int
The maximum number of results to return in this operation.
- NextToken
-
- Type: string
To retrieve the next set of results, the
nextTokenvalue from a previous response; otherwise null to receive the first set of results. - ServiceProfileId
-
- Type: string
A filter to list only the wireless devices that use this service profile.
- WirelessDeviceType
-
- Type: string
A filter to list only the wireless devices that use this wireless device type.
Result Syntax
[
'NextToken' => '<string>',
'WirelessDeviceList' => [
[
'Arn' => '<string>',
'DestinationName' => '<string>',
'Id' => '<string>',
'LastUplinkReceivedAt' => '<string>',
'LoRaWAN' => [
'DevEui' => '<string>',
],
'Name' => '<string>',
'Sidewalk' => [
'AmazonId' => '<string>',
'DeviceCertificates' => [
[
'SigningAlg' => 'Ed25519|P256r1',
'Value' => '<string>',
],
// ...
],
'SidewalkId' => '<string>',
'SidewalkManufacturingSn' => '<string>',
],
'Type' => 'Sidewalk|LoRaWAN',
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
The token to use to get the next set of results, or null if there are no additional results.
- WirelessDeviceList
-
- Type: Array of WirelessDeviceStatistics structures
The ID of the wireless device.
Errors
-
The input did not meet the specified constraints.
-
An unexpected error occurred while processing a request.
-
The request was denied because it exceeded the allowed API request rate.
-
User does not have permission to perform this action.
ListWirelessGatewayTaskDefinitions
$result = $client->listWirelessGatewayTaskDefinitions([/* ... */]); $promise = $client->listWirelessGatewayTaskDefinitionsAsync([/* ... */]);
List the wireless gateway tasks definitions registered to your AWS account.
Parameter Syntax
$result = $client->listWirelessGatewayTaskDefinitions([
'MaxResults' => <integer>,
'NextToken' => '<string>',
'TaskDefinitionType' => 'UPDATE',
]);
Parameter Details
Members
- MaxResults
-
- Type: int
The maximum number of results to return in this operation.
- NextToken
-
- Type: string
To retrieve the next set of results, the
nextTokenvalue from a previous response; otherwise null to receive the first set of results. - TaskDefinitionType
-
- Type: string
A filter to list only the wireless gateway task definitions that use this task definition type.
Result Syntax
[
'NextToken' => '<string>',
'TaskDefinitions' => [
[
'Arn' => '<string>',
'Id' => '<string>',
'LoRaWAN' => [
'CurrentVersion' => [
'Model' => '<string>',
'PackageVersion' => '<string>',
'Station' => '<string>',
],
'UpdateVersion' => [
'Model' => '<string>',
'PackageVersion' => '<string>',
'Station' => '<string>',
],
],
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
The token to use to get the next set of results, or null if there are no additional results.
- TaskDefinitions
-
- Type: Array of UpdateWirelessGatewayTaskEntry structures
The list of task definitions.
Errors
-
The input did not meet the specified constraints.
-
User does not have permission to perform this action.
-
An unexpected error occurred while processing a request.
-
The request was denied because it exceeded the allowed API request rate.
ListWirelessGateways
$result = $client->listWirelessGateways([/* ... */]); $promise = $client->listWirelessGatewaysAsync([/* ... */]);
Lists the wireless gateways registered to your AWS account.
Parameter Syntax
$result = $client->listWirelessGateways([
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'NextToken' => '<string>',
'WirelessGatewayList' => [
[
'Arn' => '<string>',
'Description' => '<string>',
'Id' => '<string>',
'LastUplinkReceivedAt' => '<string>',
'LoRaWAN' => [
'GatewayEui' => '<string>',
'RfRegion' => '<string>',
],
'Name' => '<string>',
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
The token to use to get the next set of results, or null if there are no additional results.
- WirelessGatewayList
-
- Type: Array of WirelessGatewayStatistics structures
The ID of the wireless gateway.
Errors
-
The input did not meet the specified constraints.
-
An unexpected error occurred while processing a request.
-
The request was denied because it exceeded the allowed API request rate.
-
User does not have permission to perform this action.
SendDataToWirelessDevice
$result = $client->sendDataToWirelessDevice([/* ... */]); $promise = $client->sendDataToWirelessDeviceAsync([/* ... */]);
Sends a decrypted application data frame to a device.
Parameter Syntax
$result = $client->sendDataToWirelessDevice([
'Id' => '<string>', // REQUIRED
'PayloadData' => '<string>', // REQUIRED
'TransmitMode' => <integer>, // REQUIRED
'WirelessMetadata' => [
'LoRaWAN' => [
'FPort' => <integer>,
],
'Sidewalk' => [
'Seq' => <integer>,
],
],
]);
Parameter Details
Members
- Id
-
- Required: Yes
- Type: string
The ID of the wireless device to receive the data.
- PayloadData
-
- Required: Yes
- Type: string
The message payload to send.
- TransmitMode
-
- Required: Yes
- Type: int
The transmit mode to use to send data to the wireless device. Can be:
0for UM (unacknowledge mode) or1for AM (acknowledge mode). - WirelessMetadata
-
- Type: WirelessMetadata structure
Metadata about the message request.
Result Syntax
[
'MessageId' => '<string>',
]
Result Details
Errors
-
The input did not meet the specified constraints.
-
Resource does not exist.
-
The request was denied because it exceeded the allowed API request rate.
-
An unexpected error occurred while processing a request.
TagResource
$result = $client->tagResource([/* ... */]); $promise = $client->tagResourceAsync([/* ... */]);
Adds a tag to a resource.
Parameter Syntax
$result = $client->tagResource([
'ResourceArn' => '<string>', // REQUIRED
'Tags' => [ // REQUIRED
[
'Key' => '<string>', // REQUIRED
'Value' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- ResourceArn
-
- Required: Yes
- Type: string
The ARN of the resource to add tags to.
- Tags
-
- Required: Yes
- Type: Array of Tag structures
Adds to or modifies the tags of the given resource. Tags are metadata that you can use to manage a resource.
Result Syntax
[]
Result Details
Errors
-
The input did not meet the specified constraints.
-
Resource does not exist.
-
Adding, updating, or deleting the resource can cause an inconsistent state.
-
An unexpected error occurred while processing a request.
-
The request was denied because it exceeded the allowed API request rate.
-
The request was denied because the resource can't have any more tags.
TestWirelessDevice
$result = $client->testWirelessDevice([/* ... */]); $promise = $client->testWirelessDeviceAsync([/* ... */]);
Simulates a provisioned device by sending an uplink data payload of Hello.
Parameter Syntax
$result = $client->testWirelessDevice([
'Id' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'Result' => '<string>',
]
Result Details
Errors
-
The input did not meet the specified constraints.
-
Resource does not exist.
-
The request was denied because it exceeded the allowed API request rate.
-
An unexpected error occurred while processing a request.
UntagResource
$result = $client->untagResource([/* ... */]); $promise = $client->untagResourceAsync([/* ... */]);
Removes one or more tags from a resource.
Parameter Syntax
$result = $client->untagResource([
'ResourceArn' => '<string>', // REQUIRED
'TagKeys' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
The input did not meet the specified constraints.
-
Resource does not exist.
-
Adding, updating, or deleting the resource can cause an inconsistent state.
-
An unexpected error occurred while processing a request.
-
The request was denied because it exceeded the allowed API request rate.
UpdateDestination
$result = $client->updateDestination([/* ... */]); $promise = $client->updateDestinationAsync([/* ... */]);
Updates properties of a destination.
Parameter Syntax
$result = $client->updateDestination([
'Description' => '<string>',
'Expression' => '<string>',
'ExpressionType' => 'RuleName|MqttTopic',
'Name' => '<string>', // REQUIRED
'RoleArn' => '<string>',
]);
Parameter Details
Members
- Description
-
- Type: string
A new description of the resource.
- Expression
-
- Type: string
The new rule name or topic rule to send messages to.
- ExpressionType
-
- Type: string
The type of value in
Expression. - Name
-
- Required: Yes
- Type: string
The new name of the resource.
- RoleArn
-
- Type: string
The ARN of the IAM Role that authorizes the destination.
Result Syntax
[]
Result Details
Errors
-
The input did not meet the specified constraints.
-
Resource does not exist.
-
User does not have permission to perform this action.
-
An unexpected error occurred while processing a request.
-
The request was denied because it exceeded the allowed API request rate.
UpdatePartnerAccount
$result = $client->updatePartnerAccount([/* ... */]); $promise = $client->updatePartnerAccountAsync([/* ... */]);
Updates properties of a partner account.
Parameter Syntax
$result = $client->updatePartnerAccount([
'PartnerAccountId' => '<string>', // REQUIRED
'PartnerType' => 'Sidewalk', // REQUIRED
'Sidewalk' => [ // REQUIRED
'AppServerPrivateKey' => '<string>',
],
]);
Parameter Details
Members
- PartnerAccountId
-
- Required: Yes
- Type: string
The ID of the partner account to update.
- PartnerType
-
- Required: Yes
- Type: string
The partner type.
- Sidewalk
-
- Required: Yes
- Type: SidewalkUpdateAccount structure
The Sidewalk account credentials.
Result Syntax
[]
Result Details
Errors
-
The input did not meet the specified constraints.
-
Resource does not exist.
-
An unexpected error occurred while processing a request.
-
The request was denied because it exceeded the allowed API request rate.
UpdateWirelessDevice
$result = $client->updateWirelessDevice([/* ... */]); $promise = $client->updateWirelessDeviceAsync([/* ... */]);
Updates properties of a wireless device.
Parameter Syntax
$result = $client->updateWirelessDevice([
'Description' => '<string>',
'DestinationName' => '<string>',
'Id' => '<string>', // REQUIRED
'LoRaWAN' => [
'DeviceProfileId' => '<string>',
'ServiceProfileId' => '<string>',
],
'Name' => '<string>',
]);
Parameter Details
Members
- Description
-
- Type: string
A new description of the resource.
- DestinationName
-
- Type: string
The name of the new destination for the device.
- Id
-
- Required: Yes
- Type: string
The ID of the resource to update.
- LoRaWAN
-
- Type: LoRaWANUpdateDevice structure
The updated wireless device's configuration.
- Name
-
- Type: string
The new name of the resource.
Result Syntax
[]
Result Details
Errors
-
The input did not meet the specified constraints.
-
Resource does not exist.
-
User does not have permission to perform this action.
-
An unexpected error occurred while processing a request.
-
The request was denied because it exceeded the allowed API request rate.
UpdateWirelessGateway
$result = $client->updateWirelessGateway([/* ... */]); $promise = $client->updateWirelessGatewayAsync([/* ... */]);
Updates properties of a wireless gateway.
Parameter Syntax
$result = $client->updateWirelessGateway([
'Description' => '<string>',
'Id' => '<string>', // REQUIRED
'Name' => '<string>',
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
The input did not meet the specified constraints.
-
Resource does not exist.
-
User does not have permission to perform this action.
-
An unexpected error occurred while processing a request.
-
The request was denied because it exceeded the allowed API request rate.
Shapes
AbpV1_0_x
Description
ABP device object for LoRaWAN specification v1.0.x
Members
- DevAddr
-
- Type: string
The DevAddr value.
- SessionKeys
-
- Type: SessionKeysAbpV1_0_x structure
Session keys for ABP v1.0.x
AbpV1_1
Description
ABP device object for LoRaWAN specification v1.1
Members
- DevAddr
-
- Type: string
The DevAddr value.
- SessionKeys
-
- Type: SessionKeysAbpV1_1 structure
Session keys for ABP v1.1
AccessDeniedException
CertificateList
Description
List of sidewalk certificates.
Members
ConflictException
Description
Adding, updating, or deleting the resource can cause an inconsistent state.
Members
Destinations
Description
Describes a destination.
Members
- Arn
-
- Type: string
The Amazon Resource Name of the resource.
- Description
-
- Type: string
The description of the resource.
- Expression
-
- Type: string
The rule name or topic rule to send messages to.
- ExpressionType
-
- Type: string
The type of value in
Expression. - Name
-
- Type: string
The name of the resource.
- RoleArn
-
- Type: string
The ARN of the IAM Role that authorizes the destination.
DeviceProfile
Description
Describes a device profile.
Members
InternalServerException
LoRaWANDevice
Description
LoRaWAN object for create functions.
Members
- AbpV1_0_x
-
- Type: AbpV1_0_x structure
LoRaWAN object for create APIs
- AbpV1_1
-
- Type: AbpV1_1 structure
ABP device object for create APIs for v1.1
- DevEui
-
- Type: string
The DevEUI value.
- DeviceProfileId
-
- Type: string
The ID of the device profile for the new wireless device.
- OtaaV1_0_x
-
- Type: OtaaV1_0_x structure
OTAA device object for create APIs for v1.0.x
- OtaaV1_1
-
- Type: OtaaV1_1 structure
OTAA device object for v1.1 for create APIs
- ServiceProfileId
-
- Type: string
The ID of the service profile.
LoRaWANDeviceMetadata
Description
LoRaWAN device metatdata.
Members
- DataRate
-
- Type: int
The DataRate value.
- DevEui
-
- Type: string
The DevEUI value.
- FPort
-
- Type: int
The FPort value.
- Frequency
-
- Type: int
The device's channel frequency in Hz.
- Gateways
-
- Type: Array of LoRaWANGatewayMetadata structures
Information about the gateways accessed by the device.
- Timestamp
-
- Type: string
The date and time of the metadata.
LoRaWANDeviceProfile
Description
LoRaWANDeviceProfile object.
Members
- ClassBTimeout
-
- Type: int
The ClassBTimeout value.
- ClassCTimeout
-
- Type: int
The ClassCTimeout value.
- FactoryPresetFreqsList
-
- Type: Array of ints
The list of values that make up the FactoryPresetFreqs value.
- MacVersion
-
- Type: string
The MAC version (such as OTAA 1.1 or OTAA 1.0.3) to use with this device profile.
- MaxDutyCycle
-
- Type: int
The MaxDutyCycle value.
- MaxEirp
-
- Type: int
The MaxEIRP value.
- PingSlotDr
-
- Type: int
The PingSlotDR value.
- PingSlotFreq
-
- Type: int
The PingSlotFreq value.
- PingSlotPeriod
-
- Type: int
The PingSlotPeriod value.
- RegParamsRevision
-
- Type: string
The version of regional parameters.
- RfRegion
-
- Type: string
The frequency band (RFRegion) value.
- RxDataRate2
-
- Type: int
The RXDataRate2 value.
- RxDelay1
-
- Type: int
The RXDelay1 value.
- RxDrOffset1
-
- Type: int
The RXDROffset1 value.
- RxFreq2
-
- Type: int
The RXFreq2 value.
- Supports32BitFCnt
-
- Type: boolean
The Supports32BitFCnt value.
- SupportsClassB
-
- Type: boolean
The SupportsClassB value.
- SupportsClassC
-
- Type: boolean
The SupportsClassC value.
- SupportsJoin
-
- Type: boolean
The SupportsJoin value.
LoRaWANGateway
Description
LoRaWANGateway object.
Members
LoRaWANGatewayCurrentVersion
Description
LoRaWANGatewayCurrentVersion object.
Members
- CurrentVersion
-
- Type: LoRaWANGatewayVersion structure
The version of the gateways that should receive the update.
LoRaWANGatewayMetadata
Description
LoRaWAN gateway metatdata.
Members
LoRaWANGatewayVersion
Description
LoRaWANGatewayVersion object.
Members
LoRaWANGetServiceProfileInfo
Description
LoRaWANGetServiceProfileInfo object.
Members
- AddGwMetadata
-
- Type: boolean
The AddGWMetaData value.
- ChannelMask
-
- Type: string
The ChannelMask value.
- DevStatusReqFreq
-
- Type: int
The DevStatusReqFreq value.
- DlBucketSize
-
- Type: int
The DLBucketSize value.
- DlRate
-
- Type: int
The DLRate value.
- DlRatePolicy
-
- Type: string
The DLRatePolicy value.
- DrMax
-
- Type: int
The DRMax value.
- DrMin
-
- Type: int
The DRMin value.
- HrAllowed
-
- Type: boolean
The HRAllowed value that describes whether handover roaming is allowed.
- MinGwDiversity
-
- Type: int
The MinGwDiversity value.
- NwkGeoLoc
-
- Type: boolean
The NwkGeoLoc value.
- PrAllowed
-
- Type: boolean
The PRAllowed value that describes whether passive roaming is allowed.
- RaAllowed
-
- Type: boolean
The RAAllowed value that describes whether roaming activation is allowed.
- ReportDevStatusBattery
-
- Type: boolean
The ReportDevStatusBattery value.
- ReportDevStatusMargin
-
- Type: boolean
The ReportDevStatusMargin value.
- TargetPer
-
- Type: int
The TargetPER value.
- UlBucketSize
-
- Type: int
The ULBucketSize value.
- UlRate
-
- Type: int
The ULRate value.
- UlRatePolicy
-
- Type: string
The ULRatePolicy value.
LoRaWANListDevice
LoRaWANSendDataToDevice
LoRaWANServiceProfile
Description
LoRaWANServiceProfile object.
Members
LoRaWANUpdateDevice
Description
LoRaWAN object for update functions.
Members
LoRaWANUpdateGatewayTaskCreate
Description
LoRaWANUpdateGatewayTaskCreate object.
Members
- CurrentVersion
-
- Type: LoRaWANGatewayVersion structure
The version of the gateways that should receive the update.
- SigKeyCrc
-
- Type: long (int|float)
The CRC of the signature private key to check.
- UpdateSignature
-
- Type: string
The signature used to verify the update firmware.
- UpdateVersion
-
- Type: LoRaWANGatewayVersion structure
The firmware version to update the gateway to.
LoRaWANUpdateGatewayTaskEntry
Description
LoRaWANUpdateGatewayTaskEntry object.
Members
- CurrentVersion
-
- Type: LoRaWANGatewayVersion structure
The version of the gateways that should receive the update.
- UpdateVersion
-
- Type: LoRaWANGatewayVersion structure
The firmware version to update the gateway to.
OtaaV1_0_x
Description
OTAA device object for v1.0.x
Members
OtaaV1_1
Description
OTAA device object for v1.1
Members
ResourceNotFoundException
Description
Resource does not exist.
Members
ServiceProfile
Description
Information about a service profile.
Members
SessionKeysAbpV1_0_x
Description
Session keys for ABP v1.1
Members
SessionKeysAbpV1_1
Description
Session keys for ABP v1.1
Members
SidewalkAccountInfo
Description
Information about a Sidewalk account.
Members
SidewalkAccountInfoWithFingerprint
Description
Information about a Sidewalk account.
Members
SidewalkDevice
Description
Sidewalk device object.
Members
- DeviceCertificates
-
- Type: Array of CertificateList structures
The sidewalk device certificates for Ed25519 and P256r1.
- SidewalkId
-
- Type: string
The sidewalk device identification.
- SidewalkManufacturingSn
-
- Type: string
The Sidewalk manufacturing series number.
SidewalkDeviceMetadata
Description
MetaData for Sidewalk device.
Members
SidewalkListDevice
Description
Sidewalk object used by list functions.
Members
- AmazonId
-
- Type: string
The Sidewalk Amazon ID.
- DeviceCertificates
-
- Type: Array of CertificateList structures
The sidewalk device certificates for Ed25519 and P256r1.
- SidewalkId
-
- Type: string
The sidewalk device identification.
- SidewalkManufacturingSn
-
- Type: string
The Sidewalk manufacturing series number.
SidewalkSendDataToDevice
SidewalkUpdateAccount
Description
Sidewalk update.
Members
Tag
Description
A simple label consisting of a customer-defined key-value pair
Members
ThrottlingException
Description
The request was denied because it exceeded the allowed API request rate.
Members
TooManyTagsException
Description
The request was denied because the resource can't have any more tags.
Members
UpdateWirelessGatewayTaskCreate
Description
UpdateWirelessGatewayTaskCreate object.
Members
- LoRaWAN
-
- Type: LoRaWANUpdateGatewayTaskCreate structure
The properties that relate to the LoRaWAN wireless gateway.
- UpdateDataRole
-
- Type: string
The IAM role used to read data from the S3 bucket.
- UpdateDataSource
-
- Type: string
The link to the S3 bucket.
UpdateWirelessGatewayTaskEntry
Description
UpdateWirelessGatewayTaskEntry object.
Members
- Arn
-
- Type: string
The Amazon Resource Name of the resource.
- Id
-
- Type: string
The ID of the new wireless gateway task entry.
- LoRaWAN
-
- Type: LoRaWANUpdateGatewayTaskEntry structure
The properties that relate to the LoRaWAN wireless gateway.
ValidationException
WirelessDeviceStatistics
Description
Information about a wireless device's operation.
Members
- Arn
-
- Type: string
The Amazon Resource Name of the resource.
- DestinationName
-
- Type: string
The name of the destination to which the device is assigned.
- Id
-
- Type: string
The ID of the wireless device reporting the data.
- LastUplinkReceivedAt
-
- Type: string
The date and time when the most recent uplink was received.
- LoRaWAN
-
- Type: LoRaWANListDevice structure
LoRaWAN device info.
- Name
-
- Type: string
The name of the resource.
- Sidewalk
-
- Type: SidewalkListDevice structure
The Sidewalk account credentials.
- Type
-
- Type: string
The wireless device type.
WirelessGatewayStatistics
Description
Information about a wireless gateway's operation.
Members
- Arn
-
- Type: string
The Amazon Resource Name of the resource.
- Description
-
- Type: string
The description of the resource.
- Id
-
- Type: string
The ID of the wireless gateway reporting the data.
- LastUplinkReceivedAt
-
- Type: string
The date and time when the most recent uplink was received.
- LoRaWAN
-
- Type: LoRaWANGateway structure
LoRaWAN gateway info.
- Name
-
- Type: string
The name of the resource.
WirelessMetadata
Description
WirelessMetadata object.
Members
- LoRaWAN
-
- Type: LoRaWANSendDataToDevice structure
LoRaWAN device info.
- Sidewalk
-
- Type: SidewalkSendDataToDevice structure
The Sidewalk account credentials.