AWS SDK for PHP 3.x

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.
AssociateMulticastGroupWithFuotaTask ( array $params = [] ): Associate a multicast group with a FUOTA task.
AssociateWirelessDeviceWithFuotaTask ( array $params = [] ): Associate a wireless device with a FUOTA task.
AssociateWirelessDeviceWithMulticastGroup ( array $params = [] ): Associates a wireless device with a multicast group.
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.
CancelMulticastGroupSession ( array $params = [] ): Cancels an existing multicast group session.
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.
CreateFuotaTask ( array $params = [] ): Creates a FUOTA task.
CreateMulticastGroup ( array $params = [] ): Creates a multicast group.
CreateNetworkAnalyzerConfiguration ( array $params = [] ): Creates a new network analyzer configuration.
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.
DeleteFuotaTask ( array $params = [] ): Deletes a FUOTA task.
DeleteMulticastGroup ( array $params = [] ): Deletes a multicast group if it is not in use by a fuota task.
DeleteNetworkAnalyzerConfiguration ( array $params = [] ): Deletes a network analyzer configuration.
DeleteQueuedMessages ( array $params = [] ): Remove queued messages from the downlink queue.
DeleteServiceProfile ( array $params = [] ): Deletes a service profile.
DeleteWirelessDevice ( array $params = [] ): Deletes a wireless device.
DeleteWirelessDeviceImportTask ( array $params = [] ): Delete an import task.
DeleteWirelessGateway ( array $params = [] ): Deletes a wireless gateway.
DeleteWirelessGatewayTask ( array $params = [] ): Deletes a wireless gateway task.
DeleteWirelessGatewayTaskDefinition ( array $params = [] ): Deletes a wireless gateway task definition.
DeregisterWirelessDevice ( array $params = [] ): Deregister a wireless device from AWS IoT Wireless.
DisassociateAwsAccountFromPartnerAccount ( array $params = [] ): Disassociates your AWS account from a partner account.
DisassociateMulticastGroupFromFuotaTask ( array $params = [] ): Disassociates a multicast group from a fuota task.
DisassociateWirelessDeviceFromFuotaTask ( array $params = [] ): Disassociates a wireless device from a FUOTA task.
DisassociateWirelessDeviceFromMulticastGroup ( array $params = [] ): Disassociates a wireless device from a multicast group.
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.
GetEventConfigurationByResourceTypes ( array $params = [] ): Get the event configuration based on resource types.
GetFuotaTask ( array $params = [] ): Gets information about a FUOTA task.
GetLogLevelsByResourceTypes ( array $params = [] ): Returns current default log levels or log levels by resource types.
GetMetricConfiguration ( array $params = [] ): Get the metric configuration status for this AWS account.
GetMetrics ( array $params = [] ): Get the summary metrics for this AWS account.
GetMulticastGroup ( array $params = [] ): Gets information about a multicast group.
GetMulticastGroupSession ( array $params = [] ): Gets information about a multicast group session.
GetNetworkAnalyzerConfiguration ( array $params = [] ): Get network analyzer configuration.
GetPartnerAccount ( array $params = [] ): Gets information about a partner account.
GetPosition ( array $params = [] ): Get the position information for a given resource.
GetPositionConfiguration ( array $params = [] ): Get position configuration for a given resource.
GetPositionEstimate ( array $params = [] ): Get estimated position information as a payload in GeoJSON format.
GetResourceEventConfiguration ( array $params = [] ): Get the event configuration for a particular resource identifier.
GetResourceLogLevel ( array $params = [] ): Fetches the log-level override, if any, for a given resource-ID and resource-type.
GetResourcePosition ( array $params = [] ): Get the position information for a given wireless device or a wireless gateway resource.
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.
GetWirelessDeviceImportTask ( array $params = [] ): Get information about an import task and count of device onboarding summary information for the import task.
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.
ListDevicesForWirelessDeviceImportTask ( array $params = [] ): List the Sidewalk devices in an import task and their onboarding status.
ListEventConfigurations ( array $params = [] ): List event configurations where at least one event topic has been enabled.
ListFuotaTasks ( array $params = [] ): Lists the FUOTA tasks registered to your AWS account.
ListMulticastGroups ( array $params = [] ): Lists the multicast groups registered to your AWS account.
ListMulticastGroupsByFuotaTask ( array $params = [] ): List all multicast groups associated with a fuota task.
ListNetworkAnalyzerConfigurations ( array $params = [] ): Lists the network analyzer configurations.
ListPartnerAccounts ( array $params = [] ): Lists the partner accounts associated with your AWS account.
ListPositionConfigurations ( array $params = [] ): List position configurations for a given resource, such as positioning solvers.
ListQueuedMessages ( array $params = [] ): List queued messages in the downlink queue.
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.
ListWirelessDeviceImportTasks ( array $params = [] ): List wireless devices that have been added to an import task.
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.
PutPositionConfiguration ( array $params = [] ): Put position configuration for a given resource.
PutResourceLogLevel ( array $params = [] ): Sets the log-level override for a resource-ID and resource-type.
ResetAllResourceLogLevels ( array $params = [] ): Removes the log-level overrides for all resources; both wireless devices and wireless gateways.
ResetResourceLogLevel ( array $params = [] ): Removes the log-level override, if any, for a specific resource-ID and resource-type.
SendDataToMulticastGroup ( array $params = [] ): Sends the specified data to a multicast group.
SendDataToWirelessDevice ( array $params = [] ): Sends a decrypted application data frame to a device.
StartBulkAssociateWirelessDeviceWithMulticastGroup ( array $params = [] ): Starts a bulk association of all qualifying wireless devices with a multicast group.
StartBulkDisassociateWirelessDeviceFromMulticastGroup ( array $params = [] ): Starts a bulk disassociatin of all qualifying wireless devices from a multicast group.
StartFuotaTask ( array $params = [] ): Starts a FUOTA task.
StartMulticastGroupSession ( array $params = [] ): Starts a multicast group session.
StartSingleWirelessDeviceImportTask ( array $params = [] ): Start import task for a single wireless device.
StartWirelessDeviceImportTask ( array $params = [] ): Start import task for provisioning Sidewalk devices in bulk using an S3 CSV file.
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.
UpdateEventConfigurationByResourceTypes ( array $params = [] ): Update the event configuration based on resource types.
UpdateFuotaTask ( array $params = [] ): Updates properties of a FUOTA task.
UpdateLogLevelsByResourceTypes ( array $params = [] ): Set default log level, or log levels by resource types.
UpdateMetricConfiguration ( array $params = [] ): Update the summary metric configuration.
UpdateMulticastGroup ( array $params = [] ): Updates properties of a multicast group session.
UpdateNetworkAnalyzerConfiguration ( array $params = [] ): Update network analyzer configuration.
UpdatePartnerAccount ( array $params = [] ): Updates properties of a partner account.
UpdatePosition ( array $params = [] ): Update the position information of a resource.
UpdateResourceEventConfiguration ( array $params = [] ): Update the event configuration for a particular resource identifier.
UpdateResourcePosition ( array $params = [] ): Update the position information of a given wireless device or a wireless gateway resource.
UpdateWirelessDevice ( array $params = [] ): Updates properties of a wireless device.
UpdateWirelessDeviceImportTask ( array $params = [] ): Update an import task to add more devices to the task.
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:

ListDestinations
ListDeviceProfiles
ListFuotaTasks
ListMulticastGroups
ListMulticastGroupsByFuotaTask
ListNetworkAnalyzerConfigurations
ListPositionConfigurations
ListQueuedMessages
ListServiceProfiles
ListWirelessDevices
ListWirelessGateways

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. The client token is used to implement idempotency. It ensures that the request completes no more than one time. If you retry a request with the same token and the same parameters, the request will complete successfully. However, if you try to create a new resource using the same token but different parameters, an HTTP 409 conflict occurs. If you omit this value, AWS SDKs will automatically generate a unique client request. For more information about idempotency, see Ensuring idempotency in Amazon EC2 API requests.

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

ValidationException:
The input did not meet the specified constraints.
ResourceNotFoundException:
Resource does not exist.
InternalServerException:
An unexpected error occurred while processing a request.
ThrottlingException:
The request was denied because it exceeded the allowed API request rate.
ConflictException:
Adding, updating, or deleting the resource can cause an inconsistent state.
AccessDeniedException:
User does not have permission to perform this action.

AssociateMulticastGroupWithFuotaTask

$result = $client->associateMulticastGroupWithFuotaTask([/* ... */]);
$promise = $client->associateMulticastGroupWithFuotaTaskAsync([/* ... */]);

Associate a multicast group with a FUOTA task.

Parameter Syntax

$result = $client->associateMulticastGroupWithFuotaTask([
    'Id' => '<string>', // REQUIRED
    'MulticastGroupId' => '<string>', // REQUIRED
]);

Parameter Details

Members

Id

Required: Yes
Type: string

The ID of a FUOTA task.

MulticastGroupId

Required: Yes
Type: string

The ID of the multicast group.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:
The input did not meet the specified constraints.
AccessDeniedException:
User does not have permission to perform this action.
ResourceNotFoundException:
Resource does not exist.
ConflictException:
Adding, updating, or deleting the resource can cause an inconsistent state.
ThrottlingException:
The request was denied because it exceeded the allowed API request rate.
InternalServerException:
An unexpected error occurred while processing a request.

AssociateWirelessDeviceWithFuotaTask

$result = $client->associateWirelessDeviceWithFuotaTask([/* ... */]);
$promise = $client->associateWirelessDeviceWithFuotaTaskAsync([/* ... */]);

Associate a wireless device with a FUOTA task.

Parameter Syntax

$result = $client->associateWirelessDeviceWithFuotaTask([
    'Id' => '<string>', // REQUIRED
    'WirelessDeviceId' => '<string>', // REQUIRED
]);

Parameter Details

Members

Id

Required: Yes
Type: string

The ID of a FUOTA task.

WirelessDeviceId

Required: Yes
Type: string

The ID of the wireless device.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:
The input did not meet the specified constraints.
AccessDeniedException:
User does not have permission to perform this action.
ResourceNotFoundException:
Resource does not exist.
ConflictException:
Adding, updating, or deleting the resource can cause an inconsistent state.
ThrottlingException:
The request was denied because it exceeded the allowed API request rate.
InternalServerException:
An unexpected error occurred while processing a request.

AssociateWirelessDeviceWithMulticastGroup

$result = $client->associateWirelessDeviceWithMulticastGroup([/* ... */]);
$promise = $client->associateWirelessDeviceWithMulticastGroupAsync([/* ... */]);

Associates a wireless device with a multicast group.

Parameter Syntax

$result = $client->associateWirelessDeviceWithMulticastGroup([
    'Id' => '<string>', // REQUIRED
    'WirelessDeviceId' => '<string>', // REQUIRED
]);

Parameter Details

Members

Id

Required: Yes
Type: string

The ID of the multicast group.

WirelessDeviceId

Required: Yes
Type: string

The ID of the wireless device.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:
The input did not meet the specified constraints.
AccessDeniedException:
User does not have permission to perform this action.
ResourceNotFoundException:
Resource does not exist.
ConflictException:
Adding, updating, or deleting the resource can cause an inconsistent state.
ThrottlingException:
The request was denied because it exceeded the allowed API request rate.
InternalServerException:
An unexpected error occurred while processing a request.

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

Id

Required: Yes
Type: string

The ID of the resource to update.

ThingArn

Required: Yes
Type: string

The ARN of the thing to associate with the wireless device.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:
The input did not meet the specified constraints.
AccessDeniedException:
User does not have permission to perform this action.
ResourceNotFoundException:
Resource does not exist.
ConflictException:
Adding, updating, or deleting the resource can cause an inconsistent state.
ThrottlingException:
The request was denied because it exceeded the allowed API request rate.
InternalServerException:
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

Id

Required: Yes
Type: string

The ID of the resource to update.

IotCertificateId

Required: Yes
Type: string

The ID of the certificate to associate with the wireless gateway.

Result Syntax

[
    'IotCertificateId' => '<string>',
]

Result Details

Members

IotCertificateId

Type: string

The ID of the certificate associated with the wireless gateway.

Errors

ValidationException:
The input did not meet the specified constraints.
AccessDeniedException:
User does not have permission to perform this action.
ResourceNotFoundException:
Resource does not exist.
ConflictException:
Adding, updating, or deleting the resource can cause an inconsistent state.
InternalServerException:
An unexpected error occurred while processing a request.
ThrottlingException:
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

Id

Required: Yes
Type: string

The ID of the resource to update.

ThingArn

Required: Yes
Type: string

The ARN of the thing to associate with the wireless gateway.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:
The input did not meet the specified constraints.
ResourceNotFoundException:
Resource does not exist.
AccessDeniedException:
User does not have permission to perform this action.
ConflictException:
Adding, updating, or deleting the resource can cause an inconsistent state.
ThrottlingException:
The request was denied because it exceeded the allowed API request rate.
InternalServerException:
An unexpected error occurred while processing a request.

CancelMulticastGroupSession

$result = $client->cancelMulticastGroupSession([/* ... */]);
$promise = $client->cancelMulticastGroupSessionAsync([/* ... */]);

Cancels an existing multicast group session.

Parameter Syntax

$result = $client->cancelMulticastGroupSession([
    'Id' => '<string>', // REQUIRED
]);

Parameter Details

Members

Id

Required: Yes
Type: string

The ID of the multicast group.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:
The input did not meet the specified constraints.
ResourceNotFoundException:
Resource does not exist.
AccessDeniedException:
User does not have permission to perform this action.
ConflictException:
Adding, updating, or deleting the resource can cause an inconsistent state.
InternalServerException:
An unexpected error occurred while processing a request.
ThrottlingException:
The request was denied because it exceeded the allowed API request rate.

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

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

Arn

Type: string

The Amazon Resource Name of the new resource.

Name

Type: string

The name of the new resource.

Errors

ValidationException:
The input did not meet the specified constraints.
ResourceNotFoundException:
Resource does not exist.
AccessDeniedException:
User does not have permission to perform this action.
ConflictException:
Adding, updating, or deleting the resource can cause an inconsistent state.
InternalServerException:
An unexpected error occurred while processing a request.
ThrottlingException:
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>',
    'Sidewalk' => [
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

ClientRequestToken

Type: string

LoRaWAN

Type: LoRaWANDeviceProfile structure

The device profile information to use to create the device profile.

Name

Type: string

The name of the new resource.

Sidewalk

Type: SidewalkCreateDeviceProfile structure

The Sidewalk-related information for creating the Sidewalk device profile.

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

Arn

Type: string

The Amazon Resource Name of the new resource.

Id

Type: string

The ID of the new device profile.

Errors

ValidationException:
The input did not meet the specified constraints.
AccessDeniedException:
User does not have permission to perform this action.
ConflictException:
Adding, updating, or deleting the resource can cause an inconsistent state.
InternalServerException:
An unexpected error occurred while processing a request.
ThrottlingException:
The request was denied because it exceeded the allowed API request rate.

CreateFuotaTask

$result = $client->createFuotaTask([/* ... */]);
$promise = $client->createFuotaTaskAsync([/* ... */]);

Creates a FUOTA task.

Parameter Syntax

$result = $client->createFuotaTask([
    'ClientRequestToken' => '<string>',
    'Description' => '<string>',
    'FirmwareUpdateImage' => '<string>', // REQUIRED
    'FirmwareUpdateRole' => '<string>', // REQUIRED
    'FragmentIntervalMS' => <integer>,
    'FragmentSizeBytes' => <integer>,
    'LoRaWAN' => [
        'RfRegion' => 'EU868|US915|AU915|AS923-1|AS923-2|AS923-3|AS923-4|EU433|CN470|CN779|RU864|KR920|IN865',
    ],
    'Name' => '<string>',
    'RedundancyPercent' => <integer>,
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

ClientRequestToken

Type: string

Description

Type: string

The description of the new resource.

FirmwareUpdateImage

Required: Yes
Type: string

The S3 URI points to a firmware update image that is to be used with a FUOTA task.

FirmwareUpdateRole

Required: Yes
Type: string

The firmware update role that is to be used with a FUOTA task.

FragmentIntervalMS

Type: int

The interval for sending fragments in milliseconds, rounded to the nearest second.

This interval only determines the timing for when the Cloud sends down the fragments to yor device. There can be a delay for when your device will receive these fragments. This delay depends on the device's class and the communication delay with the cloud.

FragmentSizeBytes

Type: int

The size of each fragment in bytes. This parameter is supported only for FUOTA tasks with multicast groups.

LoRaWAN

Type: LoRaWANFuotaTask structure

The LoRaWAN information used with a FUOTA task.

Name

Type: string

The name of a FUOTA task.

RedundancyPercent

Type: int

The percentage of the added fragments that are redundant. For example, if the size of the firmware image file is 100 bytes and the fragment size is 10 bytes, with RedundancyPercent set to 50(%), the final number of encoded fragments is (100 / 10) + (100 / 10 * 50%) = 15.

Tags

Type: Array of Tag structures

The tag to attach to the specified resource. Tags are metadata that you can use to manage a resource.

Result Syntax

[
    'Arn' => '<string>',
    'Id' => '<string>',
]

Result Details

Members

Arn

Type: string

The arn of a FUOTA task.

Id

Type: string

The ID of a FUOTA task.

Errors

ValidationException:
The input did not meet the specified constraints.
ResourceNotFoundException:
Resource does not exist.
AccessDeniedException:
User does not have permission to perform this action.
ConflictException:
Adding, updating, or deleting the resource can cause an inconsistent state.
InternalServerException:
An unexpected error occurred while processing a request.
ThrottlingException:
The request was denied because it exceeded the allowed API request rate.

CreateMulticastGroup

$result = $client->createMulticastGroup([/* ... */]);
$promise = $client->createMulticastGroupAsync([/* ... */]);

Creates a multicast group.

Parameter Syntax

$result = $client->createMulticastGroup([
    'ClientRequestToken' => '<string>',
    'Description' => '<string>',
    'LoRaWAN' => [ // REQUIRED
        'DlClass' => 'ClassB|ClassC',
        'RfRegion' => 'EU868|US915|AU915|AS923-1|AS923-2|AS923-3|AS923-4|EU433|CN470|CN779|RU864|KR920|IN865',
    ],
    'Name' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

ClientRequestToken

Type: string

Description

Type: string

The description of the multicast group.

LoRaWAN

Required: Yes
Type: LoRaWANMulticast structure

The LoRaWAN information that is to be used with the multicast group.

Name

Type: string

The name of the multicast group.

Tags

Type: Array of Tag structures

The tag to attach to the specified resource. Tags are metadata that you can use to manage a resource.

Result Syntax

[
    'Arn' => '<string>',
    'Id' => '<string>',
]

Result Details

Members

Arn

Type: string

The arn of the multicast group.

Id

Type: string

The ID of the multicast group.

Errors

ValidationException:
The input did not meet the specified constraints.
ResourceNotFoundException:
Resource does not exist.
AccessDeniedException:
User does not have permission to perform this action.
ConflictException:
Adding, updating, or deleting the resource can cause an inconsistent state.
InternalServerException:
An unexpected error occurred while processing a request.
ThrottlingException:
The request was denied because it exceeded the allowed API request rate.

CreateNetworkAnalyzerConfiguration

$result = $client->createNetworkAnalyzerConfiguration([/* ... */]);
$promise = $client->createNetworkAnalyzerConfigurationAsync([/* ... */]);

Creates a new network analyzer configuration.

Parameter Syntax

$result = $client->createNetworkAnalyzerConfiguration([
    'ClientRequestToken' => '<string>',
    'Description' => '<string>',
    'MulticastGroups' => ['<string>', ...],
    'Name' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'TraceContent' => [
        'LogLevel' => 'INFO|ERROR|DISABLED',
        'MulticastFrameInfo' => 'ENABLED|DISABLED',
        'WirelessDeviceFrameInfo' => 'ENABLED|DISABLED',
    ],
    'WirelessDevices' => ['<string>', ...],
    'WirelessGateways' => ['<string>', ...],
]);

Parameter Details

Members

ClientRequestToken

Type: string

Description

Type: string

The description of the new resource.

MulticastGroups

Type: Array of strings

Multicast Group resources to add to the network analyzer configruation. Provide the MulticastGroupId of the resource to add in the input array.

Name

Required: Yes
Type: string

Name of the network analyzer configuration.

Tags

Type: Array of Tag structures

The tag to attach to the specified resource. Tags are metadata that you can use to manage a resource.

TraceContent

Type: TraceContent structure

Trace content for your wireless devices, gateways, and multicast groups.

WirelessDevices

Type: Array of strings

Wireless device resources to add to the network analyzer configuration. Provide the WirelessDeviceId of the resource to add in the input array.

WirelessGateways

Type: Array of strings

Wireless gateway resources to add to the network analyzer configuration. Provide the WirelessGatewayId of the resource to add in the input array.

Result Syntax

[
    'Arn' => '<string>',
    'Name' => '<string>',
]

Result Details

Members

Arn

Type: string

The Amazon Resource Name of the new resource.

Name

Type: string

Name of the network analyzer configuration.

Errors

ValidationException:
The input did not meet the specified constraints.
ResourceNotFoundException:
Resource does not exist.
AccessDeniedException:
User does not have permission to perform this action.
ConflictException:
Adding, updating, or deleting the resource can cause an inconsistent state.
InternalServerException:
An unexpected error occurred while processing a request.
ThrottlingException:
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,
        'DrMax' => <integer>,
        'DrMin' => <integer>,
        'PrAllowed' => true || false,
        'RaAllowed' => true || false,
    ],
    'Name' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

ClientRequestToken

Type: string

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

Arn

Type: string

The Amazon Resource Name of the new resource.

Id

Type: string

The ID of the new service profile.

Errors

ValidationException:
The input did not meet the specified constraints.
AccessDeniedException:
User does not have permission to perform this action.
ConflictException:
Adding, updating, or deleting the resource can cause an inconsistent state.
InternalServerException:
An unexpected error occurred while processing a request.
ThrottlingException:
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>',
            'FCntStart' => <integer>,
            'SessionKeys' => [
                'AppSKey' => '<string>',
                'NwkSKey' => '<string>',
            ],
        ],
        'AbpV1_1' => [
            'DevAddr' => '<string>',
            'FCntStart' => <integer>,
            'SessionKeys' => [
                'AppSKey' => '<string>',
                'FNwkSIntKey' => '<string>',
                'NwkSEncKey' => '<string>',
                'SNwkSIntKey' => '<string>',
            ],
        ],
        'DevEui' => '<string>',
        'DeviceProfileId' => '<string>',
        'FPorts' => [
            'Applications' => [
                [
                    'DestinationName' => '<string>',
                    'FPort' => <integer>,
                    'Type' => 'SemtechGeolocation',
                ],
                // ...
            ],
            'ClockSync' => <integer>,
            'Fuota' => <integer>,
            'Multicast' => <integer>,
            'Positioning' => [
                'ClockSync' => <integer>,
                'Gnss' => <integer>,
                'Stream' => <integer>,
            ],
        ],
        'OtaaV1_0_x' => [
            'AppEui' => '<string>',
            'AppKey' => '<string>',
            'GenAppKey' => '<string>',
            'JoinEui' => '<string>',
        ],
        'OtaaV1_1' => [
            'AppKey' => '<string>',
            'JoinEui' => '<string>',
            'NwkKey' => '<string>',
        ],
        'ServiceProfileId' => '<string>',
    ],
    'Name' => '<string>',
    'Positioning' => 'Enabled|Disabled',
    'Sidewalk' => [
        'DeviceProfileId' => '<string>',
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'Type' => 'Sidewalk|LoRaWAN', // REQUIRED
]);

Parameter Details

Members

ClientRequestToken

Type: string

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.

Positioning

Type: string

FPort values for the GNSS, stream, and ClockSync functions of the positioning information.

Sidewalk

Type: SidewalkCreateWirelessDevice structure

The device configuration information to use to create the Sidewalk device.

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

Arn

Type: string

The Amazon Resource Name of the new resource.

Id

Type: string

The ID of the new wireless device.

Errors

ValidationException:
The input did not meet the specified constraints.
ResourceNotFoundException:
Resource does not exist.
AccessDeniedException:
User does not have permission to perform this action.
ConflictException:
Adding, updating, or deleting the resource can cause an inconsistent state.
InternalServerException:
An unexpected error occurred while processing a request.
ThrottlingException:
The request was denied because it exceeded the allowed API request rate.

CreateWirelessGateway

$result = $client->createWirelessGateway([/* ... */]);
$promise = $client->createWirelessGatewayAsync([/* ... */]);

Provisions a wireless gateway.

When provisioning a wireless gateway, you might run into duplication errors for the following reasons.

If you specify a GatewayEui value that already exists.
If you used a ClientRequestToken with the same parameters within the last 10 minutes.

To avoid this error, make sure that you use unique identifiers and parameters for each request within the specified time period.

Parameter Syntax

$result = $client->createWirelessGateway([
    'ClientRequestToken' => '<string>',
    'Description' => '<string>',
    'LoRaWAN' => [ // REQUIRED
        'Beaconing' => [
            'DataRate' => <integer>,
            'Frequencies' => [<integer>, ...],
        ],
        'GatewayEui' => '<string>',
        'JoinEuiFilters' => [
            ['<string>', ...],
            // ...
        ],
        'MaxEirp' => <float>,
        'NetIdFilters' => ['<string>', ...],
        'RfRegion' => '<string>',
        'SubBands' => [<integer>, ...],
    ],
    'Name' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

ClientRequestToken

Type: string

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

Arn

Type: string

The Amazon Resource Name of the new resource.

Id

Type: string

The ID of the new wireless gateway.

Errors

ValidationException:
The input did not meet the specified constraints.
AccessDeniedException:
User does not have permission to perform this action.
ConflictException:
Adding, updating, or deleting the resource can cause an inconsistent state.
InternalServerException:
An unexpected error occurred while processing a request.
ThrottlingException:
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

Id

Required: Yes
Type: string

The ID of the resource to update.

WirelessGatewayTaskDefinitionId

Required: Yes
Type: string

The ID of the WirelessGatewayTaskDefinition.

Result Syntax

[
    'Status' => 'PENDING|IN_PROGRESS|FIRST_RETRY|SECOND_RETRY|COMPLETED|FAILED',
    'WirelessGatewayTaskDefinitionId' => '<string>',
]

Result Details

Members

Status

Type: string

The status of the request.

WirelessGatewayTaskDefinitionId

Type: string

The ID of the WirelessGatewayTaskDefinition.

Errors

ValidationException:
The input did not meet the specified constraints.
AccessDeniedException:
User does not have permission to perform this action.
ResourceNotFoundException:
Resource does not exist.
ConflictException:
Adding, updating, or deleting the resource can cause an inconsistent state.
InternalServerException:
An unexpected error occurred while processing a request.
ThrottlingException:
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 calling CreateWirelessGatewayTask.

ClientRequestToken

Type: string

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

Arn

Type: string

The Amazon Resource Name of the resource.

Id

Type: string

The ID of the new wireless gateway task definition.

Errors

ValidationException:
The input did not meet the specified constraints.
AccessDeniedException:
User does not have permission to perform this action.
ResourceNotFoundException:
Resource does not exist.
ConflictException:
Adding, updating, or deleting the resource can cause an inconsistent state.
InternalServerException:
An unexpected error occurred while processing a request.
ThrottlingException:
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

Members

Name

Required: Yes
Type: string

The name of the resource to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:
The input did not meet the specified constraints.
ResourceNotFoundException:
Resource does not exist.
AccessDeniedException:
User does not have permission to perform this action.
InternalServerException:
An unexpected error occurred while processing a request.
ConflictException:
Adding, updating, or deleting the resource can cause an inconsistent state.
ThrottlingException:
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

Members

Id

Required: Yes
Type: string

The ID of the resource to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:
The input did not meet the specified constraints.
AccessDeniedException:
User does not have permission to perform this action.
ResourceNotFoundException:
Resource does not exist.
InternalServerException:
An unexpected error occurred while processing a request.
ConflictException:
Adding, updating, or deleting the resource can cause an inconsistent state.
ThrottlingException:
The request was denied because it exceeded the allowed API request rate.

DeleteFuotaTask

$result = $client->deleteFuotaTask([/* ... */]);
$promise = $client->deleteFuotaTaskAsync([/* ... */]);

Deletes a FUOTA task.

Parameter Syntax

$result = $client->deleteFuotaTask([
    'Id' => '<string>', // REQUIRED
]);

Parameter Details

Members

Id

Required: Yes
Type: string

The ID of a FUOTA task.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:
The input did not meet the specified constraints.
ResourceNotFoundException:
Resource does not exist.
AccessDeniedException:
User does not have permission to perform this action.
InternalServerException:
An unexpected error occurred while processing a request.
ThrottlingException:
The request was denied because it exceeded the allowed API request rate.

DeleteMulticastGroup

$result = $client->deleteMulticastGroup([/* ... */]);
$promise = $client->deleteMulticastGroupAsync([/* ... */]);

Deletes a multicast group if it is not in use by a fuota task.

Parameter Syntax

$result = $client->deleteMulticastGroup([
    'Id' => '<string>', // REQUIRED
]);

Parameter Details

Members

Id

Required: Yes
Type: string

The ID of the multicast group.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:
The input did not meet the specified constraints.
ResourceNotFoundException:
Resource does not exist.
AccessDeniedException:
User does not have permission to perform this action.
ConflictException:
Adding, updating, or deleting the resource can cause an inconsistent state.
InternalServerException:
An unexpected error occurred while processing a request.
ThrottlingException:
The request was denied because it exceeded the allowed API request rate.

DeleteNetworkAnalyzerConfiguration

$result = $client->deleteNetworkAnalyzerConfiguration([/* ... */]);
$promise = $client->deleteNetworkAnalyzerConfigurationAsync([/* ... */]);

Deletes a network analyzer configuration.

Parameter Syntax

$result = $client->deleteNetworkAnalyzerConfiguration([
    'ConfigurationName' => '<string>', // REQUIRED
]);

Parameter Details

Members

ConfigurationName

Required: Yes
Type: string

Name of the network analyzer configuration.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:
The input did not meet the specified constraints.
ResourceNotFoundException:
Resource does not exist.
AccessDeniedException:
User does not have permission to perform this action.
InternalServerException:
An unexpected error occurred while processing a request.
ConflictException:
Adding, updating, or deleting the resource can cause an inconsistent state.
ThrottlingException:
The request was denied because it exceeded the allowed API request rate.

DeleteQueuedMessages

$result = $client->deleteQueuedMessages([/* ... */]);
$promise = $client->deleteQueuedMessagesAsync([/* ... */]);

Remove queued messages from the downlink queue.

Parameter Syntax

$result = $client->deleteQueuedMessages([
    'Id' => '<string>', // REQUIRED
    'MessageId' => '<string>', // REQUIRED
    'WirelessDeviceType' => 'Sidewalk|LoRaWAN',
]);

Parameter Details

Members

Id

Required: Yes
Type: string

The ID of a given wireless device for which downlink messages will be deleted.

MessageId

Required: Yes
Type: string

If message ID is "*", it cleares the entire downlink queue for a given device, specified by the wireless device ID. Otherwise, the downlink message with the specified message ID will be deleted.

WirelessDeviceType

Type: string

The wireless device type, which can be either Sidewalk or LoRaWAN.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:
The input did not meet the specified constraints.
ResourceNotFoundException:
Resource does not exist.
ThrottlingException:
The request was denied because it exceeded the allowed API request rate.
InternalServerException:
An unexpected error occurred while processing a request.
AccessDeniedException:
User does not have permission to perform this action.

DeleteServiceProfile

$result = $client->deleteServiceProfile([/* ... */]);
$promise = $client->deleteServiceProfileAsync([/* ... */]);

Deletes a service profile.

Parameter Syntax

$result = $client->deleteServiceProfile([
    'Id' => '<string>', // REQUIRED
]);

Parameter Details

Members

Id

Required: Yes
Type: string

The ID of the resource to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:
The input did not meet the specified constraints.
AccessDeniedException:
User does not have permission to perform this action.
ResourceNotFoundException:
Resource does not exist.
InternalServerException:
An unexpected error occurred while processing a request.
ConflictException:
Adding, updating, or deleting the resource can cause an inconsistent state.
ThrottlingException:
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

Members

Id

Required: Yes
Type: string

The ID of the resource to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:
The input did not meet the specified constraints.
ResourceNotFoundException:
Resource does not exist.
AccessDeniedException:
User does not have permission to perform this action.
InternalServerException:
An unexpected error occurred while processing a request.
ThrottlingException:
The request was denied because it exceeded the allowed API request rate.

DeleteWirelessDeviceImportTask

$result = $client->deleteWirelessDeviceImportTask([/* ... */]);
$promise = $client->deleteWirelessDeviceImportTaskAsync([/* ... */]);

Delete an import task.

Parameter Syntax

$result = $client->deleteWirelessDeviceImportTask([
    'Id' => '<string>', // REQUIRED
]);

Parameter Details

Members

Id

Required: Yes
Type: string

The unique identifier of the import task to be deleted.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:
The input did not meet the specified constraints.
AccessDeniedException:
User does not have permission to perform this action.
ResourceNotFoundException:
Resource does not exist.
InternalServerException:
An unexpected error occurred while processing a request.
ConflictException:
Adding, updating, or deleting the resource can cause an inconsistent state.
ThrottlingException:
The request was denied because it exceeded the allowed API request rate.

DeleteWirelessGateway

$result = $client->deleteWirelessGateway([/* ... */]);
$promise = $client->deleteWirelessGatewayAsync([/* ... */]);

Deletes a wireless gateway.

When deleting a wireless gateway, you might run into duplication errors for the following reasons.

If you specify a GatewayEui value that already exists.
If you used a ClientRequestToken with the same parameters within the last 10 minutes.

To avoid this error, make sure that you use unique identifiers and parameters for each request within the specified time period.

Parameter Syntax

$result = $client->deleteWirelessGateway([
    'Id' => '<string>', // REQUIRED
]);

Parameter Details

Members

Id

Required: Yes
Type: string

The ID of the resource to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:
The input did not meet the specified constraints.
ResourceNotFoundException:
Resource does not exist.
AccessDeniedException:
User does not have permission to perform this action.
InternalServerException:
An unexpected error occurred while processing a request.
ThrottlingException:
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

Members

Id

Required: Yes
Type: string

The ID of the resource to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:
The input did not meet the specified constraints.
AccessDeniedException:
User does not have permission to perform this action.
ResourceNotFoundException:
Resource does not exist.
InternalServerException:
An unexpected error occurred while processing a request.
ThrottlingException:
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

Members

Id

Required: Yes
Type: string

The ID of the resource to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:
The input did not meet the specified constraints.
AccessDeniedException:
User does not have permission to perform this action.
ResourceNotFoundException:
Resource does not exist.
InternalServerException:
An unexpected error occurred while processing a request.
ThrottlingException:
The request was denied because it exceeded the allowed API request rate.

DeregisterWirelessDevice

$result = $client->deregisterWirelessDevice([/* ... */]);
$promise = $client->deregisterWirelessDeviceAsync([/* ... */]);

Deregister a wireless device from AWS IoT Wireless.

Parameter Syntax

$result = $client->deregisterWirelessDevice([
    'Identifier' => '<string>', // REQUIRED
    'WirelessDeviceType' => 'Sidewalk|LoRaWAN',
]);

Parameter Details

Members

Identifier

Required: Yes
Type: string

The identifier of the wireless device to deregister from AWS IoT Wireless.

WirelessDeviceType

Type: string

The type of wireless device to deregister from AWS IoT Wireless, which can be LoRaWAN or Sidewalk.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:
The input did not meet the specified constraints.
ResourceNotFoundException:
Resource does not exist.
InternalServerException:
An unexpected error occurred while processing a request.
ThrottlingException:
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

PartnerAccountId

Required: Yes
Type: string

The partner account ID to disassociate from the AWS account.

PartnerType

Required: Yes
Type: string

The partner type.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:
The input did not meet the specified constraints.
ResourceNotFoundException:
Resource does not exist.
InternalServerException:
An unexpected error occurred while processing a request.
ThrottlingException:
The request was denied because it exceeded the allowed API request rate.

DisassociateMulticastGroupFromFuotaTask

$result = $client->disassociateMulticastGroupFromFuotaTask([/* ... */]);
$promise = $client->disassociateMulticastGroupFromFuotaTaskAsync([/* ... */]);

Disassociates a multicast group from a fuota task.

Parameter Syntax

$result = $client->disassociateMulticastGroupFromFuotaTask([
    'Id' => '<string>', // REQUIRED
    'MulticastGroupId' => '<string>', // REQUIRED
]);

Parameter Details

Members

Id

Required: Yes
Type: string

The ID of a FUOTA task.

MulticastGroupId

Required: Yes
Type: string

The ID of the multicast group.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:
The input did not meet the specified constraints.
AccessDeniedException:
User does not have permission to perform this action.
ResourceNotFoundException:
Resource does not exist.
ConflictException:
Adding, updating, or deleting the resource can cause an inconsistent state.
InternalServerException:
An unexpected error occurred while processing a request.

DisassociateWirelessDeviceFromFuotaTask

$result = $client->disassociateWirelessDeviceFromFuotaTask([/* ... */]);
$promise = $client->disassociateWirelessDeviceFromFuotaTaskAsync([/* ... */]);

Disassociates a wireless device from a FUOTA task.

Parameter Syntax

$result = $client->disassociateWirelessDeviceFromFuotaTask([
    'Id' => '<string>', // REQUIRED
    'WirelessDeviceId' => '<string>', // REQUIRED
]);

Parameter Details

Members

Id

Required: Yes
Type: string

The ID of a FUOTA task.

WirelessDeviceId

Required: Yes
Type: string

The ID of the wireless device.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:
The input did not meet the specified constraints.
AccessDeniedException:
User does not have permission to perform this action.
ResourceNotFoundException:
Resource does not exist.
ConflictException:
Adding, updating, or deleting the resource can cause an inconsistent state.
ThrottlingException:
The request was denied because it exceeded the allowed API request rate.
InternalServerException:
An unexpected error occurred while processing a request.

DisassociateWirelessDeviceFromMulticastGroup

$result = $client->disassociateWirelessDeviceFromMulticastGroup([/* ... */]);
$promise = $client->disassociateWirelessDeviceFromMulticastGroupAsync([/* ... */]);

Disassociates a wireless device from a multicast group.

Parameter Syntax

$result = $client->disassociateWirelessDeviceFromMulticastGroup([
    'Id' => '<string>', // REQUIRED
    'WirelessDeviceId' => '<string>', // REQUIRED
]);

Parameter Details

Members

Id

Required: Yes
Type: string

The ID of the multicast group.

WirelessDeviceId

Required: Yes
Type: string

The ID of the wireless device.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:
The input did not meet the specified constraints.
AccessDeniedException:
User does not have permission to perform this action.
ResourceNotFoundException:
Resource does not exist.
ThrottlingException:
The request was denied because it exceeded the allowed API request rate.
InternalServerException:
An unexpected error occurred while processing a request.

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

Members

Id

Required: Yes
Type: string

The ID of the resource to update.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:
The input did not meet the specified constraints.
AccessDeniedException:
User does not have permission to perform this action.
ResourceNotFoundException:
Resource does not exist.
ConflictException:
Adding, updating, or deleting the resource can cause an inconsistent state.
ThrottlingException:
The request was denied because it exceeded the allowed API request rate.
InternalServerException:
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

Members

Id

Required: Yes
Type: string

The ID of the resource to update.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:
The input did not meet the specified constraints.
AccessDeniedException:
User does not have permission to perform this action.
ResourceNotFoundException:
Resource does not exist.
InternalServerException:
An unexpected error occurred while processing a request.
ThrottlingException:
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

Members

Id

Required: Yes
Type: string

The ID of the resource to update.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:
The input did not meet the specified constraints.
AccessDeniedException:
User does not have permission to perform this action.
ResourceNotFoundException:
Resource does not exist.
ConflictException:
Adding, updating, or deleting the resource can cause an inconsistent state.
ThrottlingException:
The request was denied because it exceeded the allowed API request rate.
InternalServerException:
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

Members

Name

Required: Yes
Type: string

The name of the resource to get.

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

ValidationException:
The input did not meet the specified constraints.
ResourceNotFoundException:
Resource does not exist.
AccessDeniedException:
User does not have permission to perform this action.
InternalServerException:
An unexpected error occurred while processing a request.
ThrottlingException:
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

Members

Id

Required: Yes
Type: string

The ID of the resource to get.

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>',
    'Sidewalk' => [
        'ApplicationServerPublicKey' => '<string>',
        'DakCertificateMetadata' => [
            [
                'ApId' => '<string>',
                'CertificateId' => '<string>',
                'DeviceTypeId' => '<string>',
                'FactorySupport' => true || false,
                'MaxAllowedSignature' => <integer>,
            ],
            // ...
        ],
        'QualificationStatus' => true || false,
    ],
]

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.

Sidewalk

Type: SidewalkGetDeviceProfile structure

Information about the Sidewalk parameters in the device profile.

Errors

ValidationException:
The input did not meet the specified constraints.
AccessDeniedException:
User does not have permission to perform this action.
ResourceNotFoundException:
Resource does not exist.
InternalServerException:
An unexpected error occurred while processing a request.
ThrottlingException:
The request was denied because it exceeded the allowed API request rate.

GetEventConfigurationByResourceTypes

$result = $client->getEventConfigurationByResourceTypes([/* ... */]);
$promise = $client->getEventConfigurationByResourceTypesAsync([/* ... */]);

Get the event configuration based on resource types.

Parameter Syntax

$result = $client->getEventConfigurationByResourceTypes([
]);

Parameter Details

Members

Result Syntax

[
    'ConnectionStatus' => [
        'LoRaWAN' => [
            'WirelessGatewayEventTopic' => 'Enabled|Disabled',
        ],
    ],
    'DeviceRegistrationState' => [
        'Sidewalk' => [
            'WirelessDeviceEventTopic' => 'Enabled|Disabled',
        ],
    ],
    'Join' => [
        'LoRaWAN' => [
            'WirelessDeviceEventTopic' => 'Enabled|Disabled',
        ],
    ],
    'MessageDeliveryStatus' => [
        'Sidewalk' => [
            'WirelessDeviceEventTopic' => 'Enabled|Disabled',
        ],
    ],
    'Proximity' => [
        'Sidewalk' => [
            'WirelessDeviceEventTopic' => 'Enabled|Disabled',
        ],
    ],
]

Result Details

Members

ConnectionStatus

Type: ConnectionStatusResourceTypeEventConfiguration structure

Resource type event configuration for the connection status event.

DeviceRegistrationState

Type: DeviceRegistrationStateResourceTypeEventConfiguration structure

Resource type event configuration for the device registration state event.

Join

Type: JoinResourceTypeEventConfiguration structure

Resource type event configuration for the join event.

MessageDeliveryStatus

Type: MessageDeliveryStatusResourceTypeEventConfiguration structure

Resource type event configuration object for the message delivery status event.

Proximity

Type: ProximityResourceTypeEventConfiguration structure

Resource type event configuration for the proximity event.

Errors

AccessDeniedException:
User does not have permission to perform this action.
ThrottlingException:
The request was denied because it exceeded the allowed API request rate.
InternalServerException:
An unexpected error occurred while processing a request.

GetFuotaTask

$result = $client->getFuotaTask([/* ... */]);
$promise = $client->getFuotaTaskAsync([/* ... */]);

Gets information about a FUOTA task.

Parameter Syntax

$result = $client->getFuotaTask([
    'Id' => '<string>', // REQUIRED
]);

Parameter Details

Members

Id

Required: Yes
Type: string

The ID of a FUOTA task.

Result Syntax

[
    'Arn' => '<string>',
    'CreatedAt' => <DateTime>,
    'Description' => '<string>',
    'FirmwareUpdateImage' => '<string>',
    'FirmwareUpdateRole' => '<string>',
    'FragmentIntervalMS' => <integer>,
    'FragmentSizeBytes' => <integer>,
    'Id' => '<string>',
    'LoRaWAN' => [
        'RfRegion' => '<string>',
        'StartTime' => <DateTime>,
    ],
    'Name' => '<string>',
    'RedundancyPercent' => <integer>,
    'Status' => 'Pending|FuotaSession_Waiting|In_FuotaSession|FuotaDone|Delete_Waiting',
]

Result Details

Members

Arn

Type: string

The arn of a FUOTA task.

CreatedAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

Created at timestamp for the resource.

Description

Type: string

The description of the new resource.

FirmwareUpdateImage

Type: string

The S3 URI points to a firmware update image that is to be used with a FUOTA task.

FirmwareUpdateRole

Type: string

The firmware update role that is to be used with a FUOTA task.

FragmentIntervalMS

Type: int

The interval for sending fragments in milliseconds, rounded to the nearest second.

FragmentSizeBytes

Type: int

The size of each fragment in bytes. This parameter is supported only for FUOTA tasks with multicast groups.

Id

Type: string

The ID of a FUOTA task.

LoRaWAN

Type: LoRaWANFuotaTaskGetInfo structure

The LoRaWAN information returned from getting a FUOTA task.

Name

Type: string

The name of a FUOTA task.

RedundancyPercent

Type: int

Status

Type: string

The status of a FUOTA task.

Errors

ValidationException:
The input did not meet the specified constraints.
ResourceNotFoundException:
Resource does not exist.
AccessDeniedException:
User does not have permission to perform this action.
InternalServerException:
An unexpected error occurred while processing a request.
ThrottlingException:
The request was denied because it exceeded the allowed API request rate.

GetLogLevelsByResourceTypes

$result = $client->getLogLevelsByResourceTypes([/* ... */]);
$promise = $client->getLogLevelsByResourceTypesAsync([/* ... */]);

Returns current default log levels or log levels by resource types. Based on resource types, log levels can be for wireless device log options or wireless gateway log options.

Parameter Syntax

$result = $client->getLogLevelsByResourceTypes([
]);

Parameter Details

Members

Result Syntax

[
    'DefaultLogLevel' => 'INFO|ERROR|DISABLED',
    'WirelessDeviceLogOptions' => [
        [
            'Events' => [
                [
                    'Event' => 'Join|Rejoin|Uplink_Data|Downlink_Data|Registration',
                    'LogLevel' => 'INFO|ERROR|DISABLED',
                ],
                // ...
            ],
            'LogLevel' => 'INFO|ERROR|DISABLED',
            'Type' => 'Sidewalk|LoRaWAN',
        ],
        // ...
    ],
    'WirelessGatewayLogOptions' => [
        [
            'Events' => [
                [
                    'Event' => 'CUPS_Request|Certificate',
                    'LogLevel' => 'INFO|ERROR|DISABLED',
                ],
                // ...
            ],
            'LogLevel' => 'INFO|ERROR|DISABLED',
            'Type' => 'LoRaWAN',
        ],
        // ...
    ],
]

Result Details

Members

DefaultLogLevel

Type: string

The log level for a log message. The log levels can be disabled, or set to ERROR to display less verbose logs containing only error information, or to INFO for more detailed logs.

WirelessDeviceLogOptions

Type: Array of WirelessDeviceLogOption structures

The list of wireless device log options.

WirelessGatewayLogOptions

Type: Array of WirelessGatewayLogOption structures

The list of wireless gateway log options.

Errors

AccessDeniedException:
User does not have permission to perform this action.
InternalServerException:
An unexpected error occurred while processing a request.
ResourceNotFoundException:
Resource does not exist.
ThrottlingException:
The request was denied because it exceeded the allowed API request rate.
ValidationException:
The input did not meet the specified constraints.

GetMetricConfiguration

$result = $client->getMetricConfiguration([/* ... */]);
$promise = $client->getMetricConfigurationAsync([/* ... */]);

Get the metric configuration status for this AWS account.

Parameter Syntax

$result = $client->getMetricConfiguration([
]);

Parameter Details

Members

Result Syntax

[
    'SummaryMetric' => [
        'Status' => 'Enabled|Disabled',
    ],
]

Result Details

Members

SummaryMetric

Type: SummaryMetricConfiguration structure

The configuration status of the AWS account for summary metric aggregation.

Errors

ValidationException:
The input did not meet the specified constraints.
ResourceNotFoundException:
Resource does not exist.
AccessDeniedException:
User does not have permission to perform this action.
ConflictException:
Adding, updating, or deleting the resource can cause an inconsistent state.
InternalServerException:
An unexpected error occurred while processing a request.
ThrottlingException:
The request was denied because it exceeded the allowed API request rate.

GetMetrics

$result = $client->getMetrics([/* ... */]);
$promise = $client->getMetricsAsync([/* ... */]);

Get the summary metrics for this AWS account.

Parameter Syntax

$result = $client->getMetrics([
    'SummaryMetricQueries' => [
        [
            'AggregationPeriod' => 'OneHour|OneDay|OneWeek',
            'Dimensions' => [
                [
                    'name' => 'DeviceId|GatewayId',
                    'value' => '<string>',
                ],
                // ...
            ],
            'EndTimestamp' => <integer || string || DateTime>,
            'MetricName' => 'DeviceRSSI|DeviceSNR|DeviceUplinkCount|DeviceDownlinkCount|DeviceUplinkLostCount|DeviceUplinkLostRate|DeviceJoinRequestCount|DeviceJoinAcceptCount|DeviceRoamingUplinkCount|DeviceRoamingDownlinkCount|GatewayUpTime|GatewayDownTime|GatewayRSSI|GatewaySNR|GatewayUplinkCount|GatewayDownlinkCount|GatewayJoinRequestCount|GatewayJoinAcceptCount|AwsAccountUplinkCount|AwsAccountDownlinkCount|AwsAccountUplinkLostCount|AwsAccountUplinkLostRate|AwsAccountJoinRequestCount|AwsAccountJoinAcceptCount|AwsAccountRoamingUplinkCount|AwsAccountRoamingDownlinkCount|AwsAccountDeviceCount|AwsAccountGatewayCount|AwsAccountActiveDeviceCount|AwsAccountActiveGatewayCount',
            'QueryId' => '<string>',
            'StartTimestamp' => <integer || string || DateTime>,
        ],
        // ...
    ],
]);

Parameter Details

Members

SummaryMetricQueries

Type: Array of SummaryMetricQuery structures

The list of queries to retrieve the summary metrics.

Result Syntax

[
    'SummaryMetricQueryResults' => [
        [
            'AggregationPeriod' => 'OneHour|OneDay|OneWeek',
            'Dimensions' => [
                [
                    'name' => 'DeviceId|GatewayId',
                    'value' => '<string>',
                ],
                // ...
            ],
            'EndTimestamp' => <DateTime>,
            'Error' => '<string>',
            'MetricName' => 'DeviceRSSI|DeviceSNR|DeviceUplinkCount|DeviceDownlinkCount|DeviceUplinkLostCount|DeviceUplinkLostRate|DeviceJoinRequestCount|DeviceJoinAcceptCount|DeviceRoamingUplinkCount|DeviceRoamingDownlinkCount|GatewayUpTime|GatewayDownTime|GatewayRSSI|GatewaySNR|GatewayUplinkCount|GatewayDownlinkCount|GatewayJoinRequestCount|GatewayJoinAcceptCount|AwsAccountUplinkCount|AwsAccountDownlinkCount|AwsAccountUplinkLostCount|AwsAccountUplinkLostRate|AwsAccountJoinRequestCount|AwsAccountJoinAcceptCount|AwsAccountRoamingUplinkCount|AwsAccountRoamingDownlinkCount|AwsAccountDeviceCount|AwsAccountGatewayCount|AwsAccountActiveDeviceCount|AwsAccountActiveGatewayCount',
            'QueryId' => '<string>',
            'QueryStatus' => 'Succeeded|Failed',
            'StartTimestamp' => <DateTime>,
            'Timestamps' => [<DateTime>, ...],
            'Unit' => '<string>',
            'Values' => [
                [
                    'Avg' => <float>,
                    'Max' => <float>,
                    'Min' => <float>,
                    'P90' => <float>,
                    'Std' => <float>,
                    'Sum' => <float>,
                ],
                // ...
            ],
        ],
        // ...
    ],
]

Result Details

Members

SummaryMetricQueryResults

Type: Array of SummaryMetricQueryResult structures

The list of summary metrics that were retrieved.

Errors

ValidationException:
The input did not meet the specified constraints.
ResourceNotFoundException:
Resource does not exist.
AccessDeniedException:
User does not have permission to perform this action.
ConflictException:
Adding, updating, or deleting the resource can cause an inconsistent state.
InternalServerException:
An unexpected error occurred while processing a request.
ThrottlingException:
The request was denied because it exceeded the allowed API request rate.

GetMulticastGroup

$result = $client->getMulticastGroup([/* ... */]);
$promise = $client->getMulticastGroupAsync([/* ... */]);

Gets information about a multicast group.

Parameter Syntax

$result = $client->getMulticastGroup([
    'Id' => '<string>', // REQUIRED
]);

Parameter Details

Members

Id

Required: Yes
Type: string

The ID of the multicast group.

Result Syntax

[
    'Arn' => '<string>',
    'CreatedAt' => <DateTime>,
    'Description' => '<string>',
    'Id' => '<string>',
    'LoRaWAN' => [
        'DlClass' => 'ClassB|ClassC',
        'NumberOfDevicesInGroup' => <integer>,
        'NumberOfDevicesRequested' => <integer>,
        'RfRegion' => 'EU868|US915|AU915|AS923-1|AS923-2|AS923-3|AS923-4|EU433|CN470|CN779|RU864|KR920|IN865',
    ],
    'Name' => '<string>',
    'Status' => '<string>',
]

Result Details

Members

Arn

Type: string

The arn of the multicast group.

CreatedAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

Created at timestamp for the resource.

Description

Type: string

The description of the new resource.

Id

Type: string

The ID of the multicast group.

LoRaWAN

Type: LoRaWANMulticastGet structure

The LoRaWAN information that is to be returned from getting multicast group information.

Name

Type: string

The name of the multicast group.

Status

Type: string

The status of the multicast group.

Errors

ValidationException:
The input did not meet the specified constraints.
ResourceNotFoundException:
Resource does not exist.
AccessDeniedException:
User does not have permission to perform this action.
InternalServerException:
An unexpected error occurred while processing a request.
ThrottlingException:
The request was denied because it exceeded the allowed API request rate.

GetMulticastGroupSession

$result = $client->getMulticastGroupSession([/* ... */]);
$promise = $client->getMulticastGroupSessionAsync([/* ... */]);

Gets information about a multicast group session.

Parameter Syntax

$result = $client->getMulticastGroupSession([
    'Id' => '<string>', // REQUIRED
]);

Parameter Details

Members

Id

Required: Yes
Type: string

The ID of the multicast group.

Result Syntax

[
    'LoRaWAN' => [
        'DlDr' => <integer>,
        'DlFreq' => <integer>,
        'PingSlotPeriod' => <integer>,
        'SessionStartTime' => <DateTime>,
        'SessionTimeout' => <integer>,
    ],
]

Result Details

Members

LoRaWAN

Type: LoRaWANMulticastSession structure

The LoRaWAN information used with the multicast session.

Errors

ValidationException:
The input did not meet the specified constraints.
ResourceNotFoundException:
Resource does not exist.
AccessDeniedException:
User does not have permission to perform this action.
InternalServerException:
An unexpected error occurred while processing a request.
ThrottlingException:
The request was denied because it exceeded the allowed API request rate.

GetNetworkAnalyzerConfiguration

$result = $client->getNetworkAnalyzerConfiguration([/* ... */]);
$promise = $client->getNetworkAnalyzerConfigurationAsync([/* ... */]);

Get network analyzer configuration.

Parameter Syntax

$result = $client->getNetworkAnalyzerConfiguration([
    'ConfigurationName' => '<string>', // REQUIRED
]);

Parameter Details

Members

ConfigurationName

Required: Yes
Type: string

Name of the network analyzer configuration.

Result Syntax

[
    'Arn' => '<string>',
    'Description' => '<string>',
    'MulticastGroups' => ['<string>', ...],
    'Name' => '<string>',
    'TraceContent' => [
        'LogLevel' => 'INFO|ERROR|DISABLED',
        'MulticastFrameInfo' => 'ENABLED|DISABLED',
        'WirelessDeviceFrameInfo' => 'ENABLED|DISABLED',
    ],
    'WirelessDevices' => ['<string>', ...],
    'WirelessGateways' => ['<string>', ...],
]

Result Details

Members

Arn

Type: string

The Amazon Resource Name of the new resource.

Description

Type: string

The description of the new resource.

MulticastGroups

Type: Array of strings

List of multicast group resources that have been added to the network analyzer configuration.

Name

Type: string

Name of the network analyzer configuration.

TraceContent

Type: TraceContent structure

Trace content for your wireless devices, gateways, and multicast groups.

WirelessDevices

Type: Array of strings

List of wireless device resources that have been added to the network analyzer configuration.

WirelessGateways

Type: Array of strings

List of wireless gateway resources that have been added to the network analyzer configuration.

Errors

ValidationException:
The input did not meet the specified constraints.
AccessDeniedException:
User does not have permission to perform this action.
ResourceNotFoundException:
Resource does not exist.
InternalServerException:
An unexpected error occurred while processing a request.
ThrottlingException:
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

PartnerAccountId

Required: Yes
Type: string

The partner account ID to disassociate from the AWS account.

PartnerType

Required: Yes
Type: string

The partner type.

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

ValidationException:
The input did not meet the specified constraints.
ResourceNotFoundException:
Resource does not exist.
InternalServerException:
An unexpected error occurred while processing a request.
ThrottlingException:
The request was denied because it exceeded the allowed API request rate.

GetPosition

$result = $client->getPosition([/* ... */]);
$promise = $client->getPositionAsync([/* ... */]);

Get the position information for a given resource.

This action is no longer supported. Calls to retrieve the position information should use the GetResourcePosition API operation instead.

Parameter Syntax

$result = $client->getPosition([
    'ResourceIdentifier' => '<string>', // REQUIRED
    'ResourceType' => 'WirelessDevice|WirelessGateway', // REQUIRED
]);

Parameter Details

Members

ResourceIdentifier

Required: Yes
Type: string

Resource identifier used to retrieve the position information.

ResourceType

Required: Yes
Type: string

Resource type of the resource for which position information is retrieved.

Result Syntax

[
    'Accuracy' => [
        'HorizontalAccuracy' => <float>,
        'VerticalAccuracy' => <float>,
    ],
    'Position' => [<float>, ...],
    'SolverProvider' => 'Semtech',
    'SolverType' => 'GNSS',
    'SolverVersion' => '<string>',
    'Timestamp' => '<string>',
]

Result Details

Members

Accuracy

Type: Accuracy structure

The accuracy of the estimated position in meters. An empty value indicates that no position data is available. A value of ‘0.0’ value indicates that position data is available. This data corresponds to the position information that you specified instead of the position computed by solver.

Position

Type: Array of floats

The position information of the resource.

SolverProvider

Type: string

The vendor of the positioning solver.

SolverType

Type: string

The type of solver used to identify the position of the resource.

SolverVersion

Type: string

The version of the positioning solver.

Timestamp

Type: string

The timestamp at which the device's position was determined.

Errors

ValidationException:
The input did not meet the specified constraints.
AccessDeniedException:
User does not have permission to perform this action.
ResourceNotFoundException:
Resource does not exist.
ThrottlingException:
The request was denied because it exceeded the allowed API request rate.
InternalServerException:
An unexpected error occurred while processing a request.

GetPositionConfiguration

$result = $client->getPositionConfiguration([/* ... */]);
$promise = $client->getPositionConfigurationAsync([/* ... */]);

Get position configuration for a given resource.

This action is no longer supported. Calls to retrieve the position configuration should use the GetResourcePosition API operation instead.

Parameter Syntax

$result = $client->getPositionConfiguration([
    'ResourceIdentifier' => '<string>', // REQUIRED
    'ResourceType' => 'WirelessDevice|WirelessGateway', // REQUIRED
]);

Parameter Details

Members

ResourceIdentifier

Required: Yes
Type: string

Resource identifier used in a position configuration.

ResourceType

Required: Yes
Type: string

Resource type of the resource for which position configuration is retrieved.

Result Syntax

[
    'Destination' => '<string>',
    'Solvers' => [
        'SemtechGnss' => [
            'Fec' => 'ROSE|NONE',
            'Provider' => 'Semtech',
            'Status' => 'Enabled|Disabled',
            'Type' => 'GNSS',
        ],
    ],
]

Result Details

Members

Destination

Type: string

The position data destination that describes the AWS IoT rule that processes the device's position data for use by AWS IoT Core for LoRaWAN.

Solvers

Type: PositionSolverDetails structure

The wrapper for the solver configuration details object.

Errors

ValidationException:
The input did not meet the specified constraints.
AccessDeniedException:
User does not have permission to perform this action.
ResourceNotFoundException:
Resource does not exist.
ThrottlingException:
The request was denied because it exceeded the allowed API request rate.
InternalServerException:
An unexpected error occurred while processing a request.

GetPositionEstimate

$result = $client->getPositionEstimate([/* ... */]);
$promise = $client->getPositionEstimateAsync([/* ... */]);

Get estimated position information as a payload in GeoJSON format. The payload measurement data is resolved using solvers that are provided by third-party vendors.

Parameter Syntax

$result = $client->getPositionEstimate([
    'CellTowers' => [
        'Cdma' => [
            [
                'BaseLat' => <float>,
                'BaseLng' => <float>,
                'BaseStationId' => <integer>, // REQUIRED
                'CdmaLocalId' => [
                    'CdmaChannel' => <integer>, // REQUIRED
                    'PnOffset' => <integer>, // REQUIRED
                ],
                'CdmaNmr' => [
                    [
                        'BaseStationId' => <integer>,
                        'CdmaChannel' => <integer>, // REQUIRED
                        'PilotPower' => <integer>,
                        'PnOffset' => <integer>, // REQUIRED
                    ],
                    // ...
                ],
                'NetworkId' => <integer>, // REQUIRED
                'PilotPower' => <integer>,
                'RegistrationZone' => <integer>,
                'SystemId' => <integer>, // REQUIRED
            ],
            // ...
        ],
        'Gsm' => [
            [
                'GeranCid' => <integer>, // REQUIRED
                'GsmLocalId' => [
                    'Bcch' => <integer>, // REQUIRED
                    'Bsic' => <integer>, // REQUIRED
                ],
                'GsmNmr' => [
                    [
                        'Bcch' => <integer>, // REQUIRED
                        'Bsic' => <integer>, // REQUIRED
                        'GlobalIdentity' => [
                            'GeranCid' => <integer>, // REQUIRED
                            'Lac' => <integer>, // REQUIRED
                        ],
                        'RxLevel' => <integer>,
                    ],
                    // ...
                ],
                'GsmTimingAdvance' => <integer>,
                'Lac' => <integer>, // REQUIRED
                'Mcc' => <integer>, // REQUIRED
                'Mnc' => <integer>, // REQUIRED
                'RxLevel' => <integer>,
            ],
            // ...
        ],
        'Lte' => [
            [
                'EutranCid' => <integer>, // REQUIRED
                'LteLocalId' => [
                    'Earfcn' => <integer>, // REQUIRED
                    'Pci' => <integer>, // REQUIRED
                ],
                'LteNmr' => [
                    [
                        'Earfcn' => <integer>, // REQUIRED
                        'EutranCid' => <integer>, // REQUIRED
                        'Pci' => <integer>, // REQUIRED
                        'Rsrp' => <integer>,
                        'Rsrq' => <float>,
                    ],
                    // ...
                ],
                'LteTimingAdvance' => <integer>,
                'Mcc' => <integer>, // REQUIRED
                'Mnc' => <integer>, // REQUIRED
                'NrCapable' => true || false,
                'Rsrp' => <integer>,
                'Rsrq' => <float>,
                'Tac' => <integer>,
            ],
            // ...
        ],
        'Tdscdma' => [
            [
                'Lac' => <integer>,
                'Mcc' => <integer>, // REQUIRED
                'Mnc' => <integer>, // REQUIRED
                'PathLoss' => <integer>,
                'Rscp' => <integer>,
                'TdscdmaLocalId' => [
                    'CellParams' => <integer>, // REQUIRED
                    'Uarfcn' => <integer>, // REQUIRED
                ],
                'TdscdmaNmr' => [
                    [
                        'CellParams' => <integer>, // REQUIRED
                        'PathLoss' => <integer>,
                        'Rscp' => <integer>,
                        'Uarfcn' => <integer>, // REQUIRED
                        'UtranCid' => <integer>,
                    ],
                    // ...
                ],
                'TdscdmaTimingAdvance' => <integer>,
                'UtranCid' => <integer>, // REQUIRED
            ],
            // ...
        ],
        'Wcdma' => [
            [
                'Lac' => <integer>,
                'Mcc' => <integer>, // REQUIRED
                'Mnc' => <integer>, // REQUIRED
                'PathLoss' => <integer>,
                'Rscp' => <integer>,
                'UtranCid' => <integer>, // REQUIRED
                'WcdmaLocalId' => [
                    'Psc' => <integer>, // REQUIRED
                    'Uarfcndl' => <integer>, // REQUIRED
                ],
                'WcdmaNmr' => [
                    [
                        'PathLoss' => <integer>,
                        'Psc' => <integer>, // REQUIRED
                        'Rscp' => <integer>,
                        'Uarfcndl' => <integer>, // REQUIRED
                        'UtranCid' => <integer>, // REQUIRED
                    ],
                    // ...
                ],
            ],
            // ...
        ],
    ],
    'Gnss' => [
        'AssistAltitude' => <float>,
        'AssistPosition' => [<float>, ...],
        'CaptureTime' => <float>,
        'CaptureTimeAccuracy' => <float>,
        'Payload' => '<string>', // REQUIRED
        'Use2DSolver' => true || false,
    ],
    'Ip' => [
        'IpAddress' => '<string>', // REQUIRED
    ],
    'Timestamp' => <integer || string || DateTime>,
    'WiFiAccessPoints' => [
        [
            'MacAddress' => '<string>', // REQUIRED
            'Rss' => <integer>, // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

CellTowers

Type: CellTowers structure

Retrieves an estimated device position by resolving measurement data from cellular radio towers. The position is resolved using HERE's cellular-based solver.

Gnss

Type: Gnss structure

Retrieves an estimated device position by resolving the global navigation satellite system (GNSS) scan data. The position is resolved using the GNSS solver powered by LoRa Cloud.

Ip

Type: Ip structure

Retrieves an estimated device position by resolving the IP address information from the device. The position is resolved using MaxMind's IP-based solver.

Timestamp

Type: timestamp (string|DateTime or anything parsable by strtotime)

Optional information that specifies the time when the position information will be resolved. It uses the Unix timestamp format. If not specified, the time at which the request was received will be used.

WiFiAccessPoints

Type: Array of WiFiAccessPoint structures

Retrieves an estimated device position by resolving WLAN measurement data. The position is resolved using HERE's Wi-Fi based solver.

Result Syntax

[
    'GeoJsonPayload' => <string || resource || Psr\Http\Message\StreamInterface>,
]

Result Details

Members

GeoJsonPayload

Type: blob (string|resource|Psr\Http\Message\StreamInterface)

The position information of the resource, displayed as a JSON payload. The payload is of type blob and uses the GeoJSON format, which a format that's used to encode geographic data structures. A sample payload contains the timestamp information, the WGS84 coordinates of the location, and the accuracy and confidence level. For more information and examples, see Resolve device location (console).

Errors

ValidationException:
The input did not meet the specified constraints.
AccessDeniedException:
User does not have permission to perform this action.
ResourceNotFoundException:
Resource does not exist.
ThrottlingException:
The request was denied because it exceeded the allowed API request rate.
InternalServerException:
An unexpected error occurred while processing a request.

GetResourceEventConfiguration

$result = $client->getResourceEventConfiguration([/* ... */]);
$promise = $client->getResourceEventConfigurationAsync([/* ... */]);

Get the event configuration for a particular resource identifier.

Parameter Syntax

$result = $client->getResourceEventConfiguration([
    'Identifier' => '<string>', // REQUIRED
    'IdentifierType' => 'PartnerAccountId|DevEui|GatewayEui|WirelessDeviceId|WirelessGatewayId', // REQUIRED
    'PartnerType' => 'Sidewalk',
]);

Parameter Details

Members

Identifier

Required: Yes
Type: string

Resource identifier to opt in for event messaging.

IdentifierType

Required: Yes
Type: string

Identifier type of the particular resource identifier for event configuration.

PartnerType

Type: string

Partner type of the resource if the identifier type is PartnerAccountId.

Result Syntax

[
    'ConnectionStatus' => [
        'LoRaWAN' => [
            'GatewayEuiEventTopic' => 'Enabled|Disabled',
        ],
        'WirelessGatewayIdEventTopic' => 'Enabled|Disabled',
    ],
    'DeviceRegistrationState' => [
        'Sidewalk' => [
            'AmazonIdEventTopic' => 'Enabled|Disabled',
        ],
        'WirelessDeviceIdEventTopic' => 'Enabled|Disabled',
    ],
    'Join' => [
        'LoRaWAN' => [
            'DevEuiEventTopic' => 'Enabled|Disabled',
        ],
        'WirelessDeviceIdEventTopic' => 'Enabled|Disabled',
    ],
    'MessageDeliveryStatus' => [
        'Sidewalk' => [
            'AmazonIdEventTopic' => 'Enabled|Disabled',
        ],
        'WirelessDeviceIdEventTopic' => 'Enabled|Disabled',
    ],
    'Proximity' => [
        'Sidewalk' => [
            'AmazonIdEventTopic' => 'Enabled|Disabled',
        ],
        'WirelessDeviceIdEventTopic' => 'Enabled|Disabled',
    ],
]

Result Details

Members

ConnectionStatus

Type: ConnectionStatusEventConfiguration structure

Event configuration for the connection status event.

DeviceRegistrationState

Type: DeviceRegistrationStateEventConfiguration structure

Event configuration for the device registration state event.

Join

Type: JoinEventConfiguration structure

Event configuration for the join event.

MessageDeliveryStatus

Type: MessageDeliveryStatusEventConfiguration structure

Event configuration for the message delivery status event.

Proximity

Type: ProximityEventConfiguration structure

Event configuration for the proximity event.

Errors

ValidationException:
The input did not meet the specified constraints.
AccessDeniedException:
User does not have permission to perform this action.
ThrottlingException:
The request was denied because it exceeded the allowed API request rate.
ResourceNotFoundException:
Resource does not exist.
InternalServerException:
An unexpected error occurred while processing a request.

GetResourceLogLevel

$result = $client->getResourceLogLevel([/* ... */]);
$promise = $client->getResourceLogLevelAsync([/* ... */]);

Fetches the log-level override, if any, for a given resource-ID and resource-type. It can be used for a wireless device or a wireless gateway.

Parameter Syntax

$result = $client->getResourceLogLevel([
    'ResourceIdentifier' => '<string>', // REQUIRED
    'ResourceType' => '<string>', // REQUIRED
]);

Parameter Details

Members

ResourceIdentifier

Required: Yes
Type: string

The identifier of the resource. For a Wireless Device, it is the wireless device ID. For a wireless gateway, it is the wireless gateway ID.

ResourceType

Required: Yes
Type: string

The type of the resource, which can be WirelessDevice or WirelessGateway.

Result Syntax

[
    'LogLevel' => 'INFO|ERROR|DISABLED',
]

Result Details

Members

LogLevel

Type: string

The log level for a log message. The log levels can be disabled, or set to ERROR to display less verbose logs containing only error information, or to INFO for more detailed logs.

Errors

AccessDeniedException:
User does not have permission to perform this action.
InternalServerException:
An unexpected error occurred while processing a request.
ResourceNotFoundException:
Resource does not exist.
ThrottlingException:
The request was denied because it exceeded the allowed API request rate.
ValidationException:
The input did not meet the specified constraints.

GetResourcePosition

$result = $client->getResourcePosition([/* ... */]);
$promise = $client->getResourcePositionAsync([/* ... */]);

Get the position information for a given wireless device or a wireless gateway resource. The position information uses the World Geodetic System (WGS84).

Parameter Syntax

$result = $client->getResourcePosition([
    'ResourceIdentifier' => '<string>', // REQUIRED
    'ResourceType' => 'WirelessDevice|WirelessGateway', // REQUIRED
]);

Parameter Details

Members

ResourceIdentifier

Required: Yes
Type: string

The identifier of the resource for which position information is retrieved. It can be the wireless device ID or the wireless gateway ID, depending on the resource type.

ResourceType

Required: Yes
Type: string

The type of resource for which position information is retrieved, which can be a wireless device or a wireless gateway.

Result Syntax

[
    'GeoJsonPayload' => <string || resource || Psr\Http\Message\StreamInterface>,
]

Result Details

Members

GeoJsonPayload

Type: blob (string|resource|Psr\Http\Message\StreamInterface)

The position information of the resource, displayed as a JSON payload. The payload uses the GeoJSON format, which a format that's used to encode geographic data structures. For more information, see GeoJSON.

Errors

ValidationException:
The input did not meet the specified constraints.
AccessDeniedException:
User does not have permission to perform this action.
ResourceNotFoundException:
Resource does not exist.
ThrottlingException:
The request was denied because it exceeded the allowed API request rate.
InternalServerException:
An unexpected error occurred while processing a request.

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

ServiceType

Type: string

The service type for which to get endpoint information about. Can be CUPS for the Configuration and Update Server endpoint, or LNS for the LoRaWAN Network Server endpoint or CLAIM for the global endpoint.

Result Syntax

[
    'ServerTrust' => '<string>',
    'ServiceEndpoint' => '<string>',
    'ServiceType' => 'CUPS|LNS',
]

Result Details

Members

ServerTrust

Type: string

The Root CA of the server trust certificate.

ServiceEndpoint

Type: string

The service endpoint value.

ServiceType

Type: string

The endpoint's service type.

Errors

ValidationException:
The input did not meet the specified constraints.
AccessDeniedException:
User does not have permission to perform this action.
InternalServerException:
An unexpected error occurred while processing a request.
ThrottlingException:
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

Members

Id

Required: Yes
Type: string

The ID of the resource to get.

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

ValidationException:
The input did not meet the specified constraints.
AccessDeniedException:
User does not have permission to perform this action.
ResourceNotFoundException:
Resource does not exist.
InternalServerException:
An unexpected error occurred while processing a request.
ThrottlingException:
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|SidewalkManufacturingSn', // REQUIRED
]);

Parameter Details

Members

Identifier

Required: Yes
Type: string

The identifier of the wireless device to get.

IdentifierType

Required: Yes
Type: string

The type of identifier used in identifier.

Result Syntax

[
    'Arn' => '<string>',
    'Description' => '<string>',
    'DestinationName' => '<string>',
    'Id' => '<string>',
    'LoRaWAN' => [
        'AbpV1_0_x' => [
            'DevAddr' => '<string>',
            'FCntStart' => <integer>,
            'SessionKeys' => [
                'AppSKey' => '<string>',
                'NwkSKey' => '<string>',
            ],
        ],
        'AbpV1_1' => [
            'DevAddr' => '<string>',
            'FCntStart' => <integer>,
            'SessionKeys' => [
                'AppSKey' => '<string>',
                'FNwkSIntKey' => '<string>',
                'NwkSEncKey' => '<string>',
                'SNwkSIntKey' => '<string>',
            ],
        ],
        'DevEui' => '<string>',
        'DeviceProfileId' => '<string>',
        'FPorts' => [
            'Applications' => [
                [
                    'DestinationName' => '<string>',
                    'FPort' => <integer>,
                    'Type' => 'SemtechGeolocation',
                ],
                // ...
            ],
            'ClockSync' => <integer>,
            'Fuota' => <integer>,
            'Multicast' => <integer>,
            'Positioning' => [
                'ClockSync' => <integer>,
                'Gnss' => <integer>,
                'Stream' => <integer>,
            ],
        ],
        'OtaaV1_0_x' => [
            'AppEui' => '<string>',
            'AppKey' => '<string>',
            'GenAppKey' => '<string>',
            'JoinEui' => '<string>',
        ],
        'OtaaV1_1' => [
            'AppKey' => '<string>',
            'JoinEui' => '<string>',
            'NwkKey' => '<string>',
        ],
        'ServiceProfileId' => '<string>',
    ],
    'Name' => '<string>',
    'Positioning' => 'Enabled|Disabled',
    'Sidewalk' => [
        'AmazonId' => '<string>',
        'CertificateId' => '<string>',
        'DeviceCertificates' => [
            [
                'SigningAlg' => 'Ed25519|P256r1',
                'Value' => '<string>',
            ],
            // ...
        ],
        'DeviceProfileId' => '<string>',
        'PrivateKeys' => [
            [
                'SigningAlg' => 'Ed25519|P256r1',
                'Value' => '<string>',
            ],
            // ...
        ],
        'SidewalkId' => '<string>',
        'SidewalkManufacturingSn' => '<string>',
        'Status' => 'PROVISIONED|REGISTERED|ACTIVATED|UNKNOWN',
    ],
    '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.

Positioning

Type: string

FPort values for the GNSS, stream, and ClockSync functions of the positioning information.

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

ValidationException:
The input did not meet the specified constraints.
AccessDeniedException:
User does not have permission to perform this action.
ResourceNotFoundException:
Resource does not exist.
InternalServerException:
An unexpected error occurred while processing a request.
ThrottlingException:
The request was denied because it exceeded the allowed API request rate.

GetWirelessDeviceImportTask

$result = $client->getWirelessDeviceImportTask([/* ... */]);
$promise = $client->getWirelessDeviceImportTaskAsync([/* ... */]);

Get information about an import task and count of device onboarding summary information for the import task.

Parameter Syntax

$result = $client->getWirelessDeviceImportTask([
    'Id' => '<string>', // REQUIRED
]);

Parameter Details

Members

Id

Required: Yes
Type: string

The identifier of the import task for which information is requested.

Result Syntax

[
    'Arn' => '<string>',
    'CreationTime' => <DateTime>,
    'DestinationName' => '<string>',
    'FailedImportedDeviceCount' => <integer>,
    'Id' => '<string>',
    'InitializedImportedDeviceCount' => <integer>,
    'OnboardedImportedDeviceCount' => <integer>,
    'PendingImportedDeviceCount' => <integer>,
    'Sidewalk' => [
        'DeviceCreationFileList' => ['<string>', ...],
        'Role' => '<string>',
    ],
    'Status' => 'INITIALIZING|INITIALIZED|PENDING|COMPLETE|FAILED|DELETING',
    'StatusReason' => '<string>',
]

Result Details

Members

Arn

Type: string

The ARN (Amazon Resource Name) of the import task.

CreationTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the import task was created.

DestinationName

Type: string

The name of the destination that's assigned to the wireless devices in the import task.

FailedImportedDeviceCount

Type: long (int|float)

The number of devices in the import task that failed to onboard to the import task.

Id

Type: string

The identifier of the import task for which information is retrieved.

InitializedImportedDeviceCount

Type: long (int|float)

The number of devices in the import task that are waiting for the control log to start processing.

OnboardedImportedDeviceCount

Type: long (int|float)

The number of devices in the import task that have been onboarded to the import task.

PendingImportedDeviceCount

Type: long (int|float)

The number of devices in the import task that are waiting in the import task queue to be onboarded.

Sidewalk

Type: SidewalkGetStartImportInfo structure

The Sidewalk-related information about an import task.

Status

Type: string

The import task status.

StatusReason

Type: string

The reason for the provided status information, such as a validation error that causes the import task to fail.

Errors

ValidationException:
The input did not meet the specified constraints.
AccessDeniedException:
User does not have permission to perform this action.
ResourceNotFoundException:
Resource does not exist.
InternalServerException:
An unexpected error occurred while processing a request.
ConflictException:
Adding, updating, or deleting the resource can cause an inconsistent state.
ThrottlingException:
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

WirelessDeviceId

Required: Yes
Type: string

The ID of the wireless device for which to get the data.

Result Syntax

[
    'LastUplinkReceivedAt' => '<string>',
    'LoRaWAN' => [
        'DataRate' => <integer>,
        'DevEui' => '<string>',
        'FPort' => <integer>,
        'Frequency' => <integer>,
        'Gateways' => [
            [
                'GatewayEui' => '<string>',
                'Rssi' => <float>,
                'Snr' => <float>,
            ],
            // ...
        ],
        'PublicGateways' => [
            [
                'DlAllowed' => true || false,
                'Id' => '<string>',
                'ProviderNetId' => '<string>',
                'RfRegion' => '<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.

This value is only valid for 3 months.

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

ValidationException:
The input did not meet the specified constraints.
AccessDeniedException:
User does not have permission to perform this action.
ResourceNotFoundException:
Resource does not exist.
InternalServerException:
An unexpected error occurred while processing a request.
ThrottlingException:
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

Identifier

Required: Yes
Type: string

The identifier of the wireless gateway to get.

IdentifierType

Required: Yes
Type: string

The type of identifier used in identifier.

Result Syntax

[
    'Arn' => '<string>',
    'Description' => '<string>',
    'Id' => '<string>',
    'LoRaWAN' => [
        'Beaconing' => [
            'DataRate' => <integer>,
            'Frequencies' => [<integer>, ...],
        ],
        'GatewayEui' => '<string>',
        'JoinEuiFilters' => [
            ['<string>', ...],
            // ...
        ],
        'MaxEirp' => <float>,
        'NetIdFilters' => ['<string>', ...],
        'RfRegion' => '<string>',
        'SubBands' => [<integer>, ...],
    ],
    '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

ValidationException:
The input did not meet the specified constraints.
ResourceNotFoundException:
Resource does not exist.
AccessDeniedException:
User does not have permission to perform this action.
InternalServerException:
An unexpected error occurred while processing a request.
ThrottlingException:
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

Members

Id

Required: Yes
Type: string

The ID of the resource to get.

Result Syntax

[
    'IotCertificateId' => '<string>',
    'LoRaWANNetworkServerCertificateId' => '<string>',
]

Result Details

Members

IotCertificateId

Type: string

The ID of the certificate associated with the wireless gateway.

LoRaWANNetworkServerCertificateId

Type: string

The ID of the certificate that is associated with the wireless gateway and used for the LoRaWANNetworkServer endpoint.

Errors

ValidationException:
The input did not meet the specified constraints.
AccessDeniedException:
User does not have permission to perform this action.
ResourceNotFoundException:
Resource does not exist.
InternalServerException:
An unexpected error occurred while processing a request.
ThrottlingException:
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

Members

Id

Required: Yes
Type: string

The ID of the resource to get.

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

ValidationException:
The input did not meet the specified constraints.
AccessDeniedException:
User does not have permission to perform this action.
ResourceNotFoundException:
Resource does not exist.
InternalServerException:
An unexpected error occurred while processing a request.
ThrottlingException:
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

WirelessGatewayId

Required: Yes
Type: string

The ID of the wireless gateway for which to get the data.

Result Syntax

[
    'ConnectionStatus' => 'Connected|Disconnected',
    'LastUplinkReceivedAt' => '<string>',
    'WirelessGatewayId' => '<string>',
]

Result Details

Members

ConnectionStatus

Type: string

The connection status of the wireless gateway.

LastUplinkReceivedAt

Type: string

The date and time when the most recent uplink was received.

This value is only valid for 3 months.

WirelessGatewayId

Type: string

The ID of the wireless gateway.

Errors

ValidationException:
The input did not meet the specified constraints.
AccessDeniedException:
User does not have permission to perform this action.
ResourceNotFoundException:
Resource does not exist.
InternalServerException:
An unexpected error occurred while processing a request.
ThrottlingException:
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

Members

Id

Required: Yes
Type: string

The ID of the resource to get.

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.

This value is only valid for 3 months.

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

ValidationException:
The input did not meet the specified constraints.
AccessDeniedException:
User does not have permission to perform this action.
ResourceNotFoundException:
Resource does not exist.
InternalServerException:
An unexpected error occurred while processing a request.
ThrottlingException:
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

Members

Id

Required: Yes
Type: string

The ID of the resource to get.

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 calling CreateWirelessGatewayTask.

Name

Type: string

The name of the resource.

Update

Type: UpdateWirelessGatewayTaskCreate structure

Information about the gateways to update.

Errors

ValidationException:
The input did not meet the specified constraints.
AccessDeniedException:
User does not have permission to perform this action.
ResourceNotFoundException:
Resource does not exist.
InternalServerException:
An unexpected error occurred while processing a request.
ThrottlingException:
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

MaxResults

Type: int

The maximum number of results to return in this operation.

NextToken

Type: string

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

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

ValidationException:
The input did not meet the specified constraints.
AccessDeniedException:
User does not have permission to perform this action.
InternalServerException:
An unexpected error occurred while processing a request.
ThrottlingException:
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([
    'DeviceProfileType' => 'Sidewalk|LoRaWAN',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

DeviceProfileType

Type: string

A filter to list only device profiles that use this type, which can be LoRaWAN or Sidewalk.

MaxResults

Type: int

The maximum number of results to return in this operation.

NextToken

Type: string

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

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

ValidationException:
The input did not meet the specified constraints.
AccessDeniedException:
User does not have permission to perform this action.
InternalServerException:
An unexpected error occurred while processing a request.
ThrottlingException:
The request was denied because it exceeded the allowed API request rate.

ListDevicesForWirelessDeviceImportTask

$result = $client->listDevicesForWirelessDeviceImportTask([/* ... */]);
$promise = $client->listDevicesForWirelessDeviceImportTaskAsync([/* ... */]);

List the Sidewalk devices in an import task and their onboarding status.

Parameter Syntax

$result = $client->listDevicesForWirelessDeviceImportTask([
    'Id' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'Status' => 'INITIALIZED|PENDING|ONBOARDED|FAILED',
]);

Parameter Details

Members

Id

Required: Yes
Type: string

The identifier of the import task for which wireless devices are listed.

MaxResults

Type: int

The maximum number of results to return in this operation.

NextToken

Type: string

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

Status

Type: string

The status of the devices in the import task.

Result Syntax

[
    'DestinationName' => '<string>',
    'ImportedWirelessDeviceList' => [
        [
            'Sidewalk' => [
                'LastUpdateTime' => <DateTime>,
                'OnboardingStatus' => 'INITIALIZED|PENDING|ONBOARDED|FAILED',
                'OnboardingStatusReason' => '<string>',
                'SidewalkManufacturingSn' => '<string>',
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

DestinationName

Type: string

The name of the Sidewalk destination that describes the IoT rule to route messages received from devices in an import task that are onboarded to AWS IoT Wireless.

ImportedWirelessDeviceList

Type: Array of ImportedWirelessDevice structures

List of wireless devices in an import task and their onboarding status.

NextToken

Type: string

The token to use to get the next set of results, or null if there are no additional results.

Errors

ValidationException:
The input did not meet the specified constraints.
AccessDeniedException:
User does not have permission to perform this action.
ResourceNotFoundException:
Resource does not exist.
InternalServerException:
An unexpected error occurred while processing a request.
ConflictException:
Adding, updating, or deleting the resource can cause an inconsistent state.
ThrottlingException:
The request was denied because it exceeded the allowed API request rate.

ListEventConfigurations

$result = $client->listEventConfigurations([/* ... */]);
$promise = $client->listEventConfigurationsAsync([/* ... */]);

List event configurations where at least one event topic has been enabled.

Parameter Syntax

$result = $client->listEventConfigurations([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ResourceType' => 'SidewalkAccount|WirelessDevice|WirelessGateway', // REQUIRED
]);

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 nextToken value from a previous response; otherwise null to receive the first set of results.

ResourceType

Required: Yes
Type: string

Resource type to filter event configurations.

Result Syntax

[
    'EventConfigurationsList' => [
        [
            'Events' => [
                'ConnectionStatus' => [
                    'LoRaWAN' => [
                        'GatewayEuiEventTopic' => 'Enabled|Disabled',
                    ],
                    'WirelessGatewayIdEventTopic' => 'Enabled|Disabled',
                ],
                'DeviceRegistrationState' => [
                    'Sidewalk' => [
                        'AmazonIdEventTopic' => 'Enabled|Disabled',
                    ],
                    'WirelessDeviceIdEventTopic' => 'Enabled|Disabled',
                ],
                'Join' => [
                    'LoRaWAN' => [
                        'DevEuiEventTopic' => 'Enabled|Disabled',
                    ],
                    'WirelessDeviceIdEventTopic' => 'Enabled|Disabled',
                ],
                'MessageDeliveryStatus' => [
                    'Sidewalk' => [
                        'AmazonIdEventTopic' => 'Enabled|Disabled',
                    ],
                    'WirelessDeviceIdEventTopic' => 'Enabled|Disabled',
                ],
                'Proximity' => [
                    'Sidewalk' => [
                        'AmazonIdEventTopic' => 'Enabled|Disabled',
                    ],
                    'WirelessDeviceIdEventTopic' => 'Enabled|Disabled',
                ],
            ],
            'Identifier' => '<string>',
            'IdentifierType' => 'PartnerAccountId|DevEui|GatewayEui|WirelessDeviceId|WirelessGatewayId',
            'PartnerType' => 'Sidewalk',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

EventConfigurationsList

Type: Array of EventConfigurationItem structures

Event configurations of all events for a single resource.

NextToken

Type: string

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

Errors

ValidationException:
The input did not meet the specified constraints.
AccessDeniedException:
User does not have permission to perform this action.
ThrottlingException:
The request was denied because it exceeded the allowed API request rate.
InternalServerException:
An unexpected error occurred while processing a request.

ListFuotaTasks

$result = $client->listFuotaTasks([/* ... */]);
$promise = $client->listFuotaTasksAsync([/* ... */]);

Lists the FUOTA tasks registered to your AWS account.

Parameter Syntax

$result = $client->listFuotaTasks([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

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 nextToken value from a previous response; otherwise null to receive the first set of results.

Result Syntax

[
    'FuotaTaskList' => [
        [
            'Arn' => '<string>',
            'Id' => '<string>',
            'Name' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

FuotaTaskList

Type: Array of FuotaTask structures

Lists the FUOTA tasks registered to your AWS account.

NextToken

Type: string

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

Errors

ValidationException:
The input did not meet the specified constraints.
AccessDeniedException:
User does not have permission to perform this action.
InternalServerException:
An unexpected error occurred while processing a request.
ThrottlingException:
The request was denied because it exceeded the allowed API request rate.

ListMulticastGroups

$result = $client->listMulticastGroups([/* ... */]);
$promise = $client->listMulticastGroupsAsync([/* ... */]);

Lists the multicast groups registered to your AWS account.

Parameter Syntax

$result = $client->listMulticastGroups([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

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 nextToken value from a previous response; otherwise null to receive the first set of results.

Result Syntax

[
    'MulticastGroupList' => [
        [
            'Arn' => '<string>',
            'Id' => '<string>',
            'Name' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

MulticastGroupList

Type: Array of MulticastGroup structures

List of multicast groups.

NextToken

Type: string

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

Errors

ValidationException:
The input did not meet the specified constraints.
AccessDeniedException:
User does not have permission to perform this action.
InternalServerException:
An unexpected error occurred while processing a request.
ThrottlingException:
The request was denied because it exceeded the allowed API request rate.

ListMulticastGroupsByFuotaTask

$result = $client->listMulticastGroupsByFuotaTask([/* ... */]);
$promise = $client->listMulticastGroupsByFuotaTaskAsync([/* ... */]);

List all multicast groups associated with a fuota task.

Parameter Syntax

$result = $client->listMulticastGroupsByFuotaTask([
    'Id' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

Id

Required: Yes
Type: string

The ID of a FUOTA task.

MaxResults

Type: int

The maximum number of results to return in this operation.

NextToken

Type: string

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

Result Syntax

[
    'MulticastGroupList' => [
        [
            'Id' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

MulticastGroupList

Type: Array of MulticastGroupByFuotaTask structures

List of multicast groups associated with a FUOTA task.

NextToken

Type: string

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

Errors

ValidationException:
The input did not meet the specified constraints.
AccessDeniedException:
User does not have permission to perform this action.
InternalServerException:
An unexpected error occurred while processing a request.
ResourceNotFoundException:
Resource does not exist.
ThrottlingException:
The request was denied because it exceeded the allowed API request rate.

ListNetworkAnalyzerConfigurations

$result = $client->listNetworkAnalyzerConfigurations([/* ... */]);
$promise = $client->listNetworkAnalyzerConfigurationsAsync([/* ... */]);

Lists the network analyzer configurations.

Parameter Syntax

$result = $client->listNetworkAnalyzerConfigurations([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

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 nextToken value from a previous response; otherwise null to receive the first set of results.

Result Syntax

[
    'NetworkAnalyzerConfigurationList' => [
        [
            'Arn' => '<string>',
            'Name' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

NetworkAnalyzerConfigurationList

Type: Array of NetworkAnalyzerConfigurations structures

The list of network analyzer configurations.

NextToken

Type: string

The token to use to get the next set of results, or null if there are no additional results.

Errors

ValidationException:
The input did not meet the specified constraints.
AccessDeniedException:
User does not have permission to perform this action.
InternalServerException:
An unexpected error occurred while processing a request.
ThrottlingException:
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

MaxResults

Type: int

The maximum number of results to return in this operation.

NextToken

Type: string

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

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

ValidationException:
The input did not meet the specified constraints.
ResourceNotFoundException:
Resource does not exist.
InternalServerException:
An unexpected error occurred while processing a request.
ThrottlingException:
The request was denied because it exceeded the allowed API request rate.

ListPositionConfigurations

$result = $client->listPositionConfigurations([/* ... */]);
$promise = $client->listPositionConfigurationsAsync([/* ... */]);

List position configurations for a given resource, such as positioning solvers.

This action is no longer supported. Calls to retrieve position information should use the GetResourcePosition API operation instead.

Parameter Syntax

$result = $client->listPositionConfigurations([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ResourceType' => 'WirelessDevice|WirelessGateway',
]);

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 nextToken value from a previous response; otherwise null to receive the first set of results.

ResourceType

Type: string

Resource type for which position configurations are listed.

Result Syntax

[
    'NextToken' => '<string>',
    'PositionConfigurationList' => [
        [
            'Destination' => '<string>',
            'ResourceIdentifier' => '<string>',
            'ResourceType' => 'WirelessDevice|WirelessGateway',
            'Solvers' => [
                'SemtechGnss' => [
                    'Fec' => 'ROSE|NONE',
                    'Provider' => 'Semtech',
                    'Status' => 'Enabled|Disabled',
                    'Type' => 'GNSS',
                ],
            ],
        ],
        // ...
    ],
]

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.

PositionConfigurationList

Type: Array of PositionConfigurationItem structures

A list of position configurations.

Errors

ValidationException:
The input did not meet the specified constraints.
AccessDeniedException:
User does not have permission to perform this action.
ThrottlingException:
The request was denied because it exceeded the allowed API request rate.
InternalServerException:
An unexpected error occurred while processing a request.

ListQueuedMessages

$result = $client->listQueuedMessages([/* ... */]);
$promise = $client->listQueuedMessagesAsync([/* ... */]);

List queued messages in the downlink queue.

Parameter Syntax

$result = $client->listQueuedMessages([
    'Id' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'WirelessDeviceType' => 'Sidewalk|LoRaWAN',
]);

Parameter Details

Members

Id

Required: Yes
Type: string

The ID of a given wireless device which the downlink message packets are being sent.

MaxResults

Type: int

The maximum number of results to return in this operation.

NextToken

Type: string

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

WirelessDeviceType

Type: string

The wireless device type, whic can be either Sidewalk or LoRaWAN.

Result Syntax

[
    'DownlinkQueueMessagesList' => [
        [
            'LoRaWAN' => [
                'FPort' => <integer>,
                'ParticipatingGateways' => [
                    'DownlinkMode' => 'SEQUENTIAL|CONCURRENT|USING_UPLINK_GATEWAY',
                    'GatewayList' => [
                        [
                            'DownlinkFrequency' => <integer>,
                            'GatewayId' => '<string>',
                        ],
                        // ...
                    ],
                    'TransmissionInterval' => <integer>,
                ],
            ],
            'MessageId' => '<string>',
            'ReceivedAt' => '<string>',
            'TransmitMode' => <integer>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

DownlinkQueueMessagesList

Type: Array of DownlinkQueueMessage structures

The messages in the downlink queue.

NextToken

Type: string

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

Errors

ValidationException:
The input did not meet the specified constraints.
ResourceNotFoundException:
Resource does not exist.
InternalServerException:
An unexpected error occurred while processing a request.
ThrottlingException:
The request was denied because it exceeded the allowed API request rate.
AccessDeniedException:
User does not have permission to perform this action.

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

MaxResults

Type: int

The maximum number of results to return in this operation.

NextToken

Type: string

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

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

ValidationException:
The input did not meet the specified constraints.
AccessDeniedException:
User does not have permission to perform this action.
InternalServerException:
An unexpected error occurred while processing a request.
ThrottlingException:
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

ResourceArn

Required: Yes
Type: string

The ARN of the resource for which you want to list tags.

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

ValidationException:
The input did not meet the specified constraints.
ResourceNotFoundException:
Resource does not exist.
ConflictException:
Adding, updating, or deleting the resource can cause an inconsistent state.
InternalServerException:
An unexpected error occurred while processing a request.
ThrottlingException:
The request was denied because it exceeded the allowed API request rate.

ListWirelessDeviceImportTasks

$result = $client->listWirelessDeviceImportTasks([/* ... */]);
$promise = $client->listWirelessDeviceImportTasksAsync([/* ... */]);

List wireless devices that have been added to an import task.

Parameter Syntax

$result = $client->listWirelessDeviceImportTasks([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

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 nextToken value from a previous response; otherwise null to receive the first set of results.

Result Syntax

[
    'NextToken' => '<string>',
    'WirelessDeviceImportTaskList' => [
        [
            'Arn' => '<string>',
            'CreationTime' => <DateTime>,
            'DestinationName' => '<string>',
            'FailedImportedDeviceCount' => <integer>,
            'Id' => '<string>',
            'InitializedImportedDeviceCount' => <integer>,
            'OnboardedImportedDeviceCount' => <integer>,
            'PendingImportedDeviceCount' => <integer>,
            'Sidewalk' => [
                'DeviceCreationFileList' => ['<string>', ...],
                'Role' => '<string>',
            ],
            'Status' => 'INITIALIZING|INITIALIZED|PENDING|COMPLETE|FAILED|DELETING',
            'StatusReason' => '<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.

WirelessDeviceImportTaskList

Type: Array of WirelessDeviceImportTask structures

List of import tasks and summary information of onboarding status of devices in each import task.

Errors

ValidationException:
The input did not meet the specified constraints.
AccessDeniedException:
User does not have permission to perform this action.
ResourceNotFoundException:
Resource does not exist.
InternalServerException:
An unexpected error occurred while processing a request.
ConflictException:
Adding, updating, or deleting the resource can cause an inconsistent state.
ThrottlingException:
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>',
    'FuotaTaskId' => '<string>',
    'MaxResults' => <integer>,
    'MulticastGroupId' => '<string>',
    '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.

FuotaTaskId

Type: string

The ID of a FUOTA task.

MaxResults

Type: int

The maximum number of results to return in this operation.

MulticastGroupId

Type: string

The ID of the multicast group.

NextToken

Type: string

To retrieve the next set of results, the nextToken value 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>',
            'FuotaDeviceStatus' => 'Initial|Package_Not_Supported|FragAlgo_unsupported|Not_enough_memory|FragIndex_unsupported|Wrong_descriptor|SessionCnt_replay|MissingFrag|MemoryError|MICError|Successful|Device_exist_in_conflict_fuota_task',
            'Id' => '<string>',
            'LastUplinkReceivedAt' => '<string>',
            'LoRaWAN' => [
                'DevEui' => '<string>',
            ],
            'McGroupId' => <integer>,
            'MulticastDeviceStatus' => '<string>',
            'Name' => '<string>',
            'Sidewalk' => [
                'AmazonId' => '<string>',
                'DeviceCertificates' => [
                    [
                        'SigningAlg' => 'Ed25519|P256r1',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'DeviceProfileId' => '<string>',
                'SidewalkId' => '<string>',
                'SidewalkManufacturingSn' => '<string>',
                'Status' => 'PROVISIONED|REGISTERED|ACTIVATED|UNKNOWN',
            ],
            '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

ValidationException:
The input did not meet the specified constraints.
InternalServerException:
An unexpected error occurred while processing a request.
ThrottlingException:
The request was denied because it exceeded the allowed API request rate.
AccessDeniedException:
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 nextToken value 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

ValidationException:
The input did not meet the specified constraints.
AccessDeniedException:
User does not have permission to perform this action.
InternalServerException:
An unexpected error occurred while processing a request.
ThrottlingException:
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

MaxResults

Type: int

The maximum number of results to return in this operation.

NextToken

Type: string

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

Result Syntax

[
    'NextToken' => '<string>',
    'WirelessGatewayList' => [
        [
            'Arn' => '<string>',
            'Description' => '<string>',
            'Id' => '<string>',
            'LastUplinkReceivedAt' => '<string>',
            'LoRaWAN' => [
                'Beaconing' => [
                    'DataRate' => <integer>,
                    'Frequencies' => [<integer>, ...],
                ],
                'GatewayEui' => '<string>',
                'JoinEuiFilters' => [
                    ['<string>', ...],
                    // ...
                ],
                'MaxEirp' => <float>,
                'NetIdFilters' => ['<string>', ...],
                'RfRegion' => '<string>',
                'SubBands' => [<integer>, ...],
            ],
            '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

ValidationException:
The input did not meet the specified constraints.
InternalServerException:
An unexpected error occurred while processing a request.
ThrottlingException:
The request was denied because it exceeded the allowed API request rate.
AccessDeniedException:
User does not have permission to perform this action.

PutPositionConfiguration

$result = $client->putPositionConfiguration([/* ... */]);
$promise = $client->putPositionConfigurationAsync([/* ... */]);

Put position configuration for a given resource.

This action is no longer supported. Calls to update the position configuration should use the UpdateResourcePosition API operation instead.

Parameter Syntax

$result = $client->putPositionConfiguration([
    'Destination' => '<string>',
    'ResourceIdentifier' => '<string>', // REQUIRED
    'ResourceType' => 'WirelessDevice|WirelessGateway', // REQUIRED
    'Solvers' => [
        'SemtechGnss' => [
            'Fec' => 'ROSE|NONE', // REQUIRED
            'Status' => 'Enabled|Disabled', // REQUIRED
        ],
    ],
]);

Parameter Details

Members

Destination

Type: string

The position data destination that describes the AWS IoT rule that processes the device's position data for use by AWS IoT Core for LoRaWAN.

ResourceIdentifier

Required: Yes
Type: string

Resource identifier used to update the position configuration.

ResourceType

Required: Yes
Type: string

Resource type of the resource for which you want to update the position configuration.

Solvers

Type: PositionSolverConfigurations structure

The positioning solvers used to update the position configuration of the resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:
The input did not meet the specified constraints.
AccessDeniedException:
User does not have permission to perform this action.
ResourceNotFoundException:
Resource does not exist.
ThrottlingException:
The request was denied because it exceeded the allowed API request rate.
InternalServerException:
An unexpected error occurred while processing a request.

PutResourceLogLevel

$result = $client->putResourceLogLevel([/* ... */]);
$promise = $client->putResourceLogLevelAsync([/* ... */]);

Sets the log-level override for a resource-ID and resource-type. This option can be specified for a wireless gateway or a wireless device. A limit of 200 log level override can be set per account.

Parameter Syntax

$result = $client->putResourceLogLevel([
    'LogLevel' => 'INFO|ERROR|DISABLED', // REQUIRED
    'ResourceIdentifier' => '<string>', // REQUIRED
    'ResourceType' => '<string>', // REQUIRED
]);

Parameter Details

Members

LogLevel

Required: Yes
Type: string

The log level for a log message. The log levels can be disabled, or set to ERROR to display less verbose logs containing only error information, or to INFO for more detailed logs.

ResourceIdentifier

Required: Yes
Type: string

The identifier of the resource. For a Wireless Device, it is the wireless device ID. For a wireless gateway, it is the wireless gateway ID.

ResourceType

Required: Yes
Type: string

The type of the resource, which can be WirelessDevice or WirelessGateway.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:
User does not have permission to perform this action.
InternalServerException:
An unexpected error occurred while processing a request.
ResourceNotFoundException:
Resource does not exist.
ThrottlingException:
The request was denied because it exceeded the allowed API request rate.
ValidationException:
The input did not meet the specified constraints.

ResetAllResourceLogLevels

$result = $client->resetAllResourceLogLevels([/* ... */]);
$promise = $client->resetAllResourceLogLevelsAsync([/* ... */]);

Removes the log-level overrides for all resources; both wireless devices and wireless gateways.

Parameter Syntax

$result = $client->resetAllResourceLogLevels([
]);

Parameter Details

Members

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:
User does not have permission to perform this action.
InternalServerException:
An unexpected error occurred while processing a request.
ResourceNotFoundException:
Resource does not exist.
ThrottlingException:
The request was denied because it exceeded the allowed API request rate.
ValidationException:
The input did not meet the specified constraints.

ResetResourceLogLevel

$result = $client->resetResourceLogLevel([/* ... */]);
$promise = $client->resetResourceLogLevelAsync([/* ... */]);

Removes the log-level override, if any, for a specific resource-ID and resource-type. It can be used for a wireless device or a wireless gateway.

Parameter Syntax

$result = $client->resetResourceLogLevel([
    'ResourceIdentifier' => '<string>', // REQUIRED
    'ResourceType' => '<string>', // REQUIRED
]);

Parameter Details

Members

ResourceIdentifier

Required: Yes
Type: string

The identifier of the resource. For a Wireless Device, it is the wireless device ID. For a wireless gateway, it is the wireless gateway ID.

ResourceType

Required: Yes
Type: string

The type of the resource, which can be WirelessDevice or WirelessGateway.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:
User does not have permission to perform this action.
InternalServerException:
An unexpected error occurred while processing a request.
ResourceNotFoundException:
Resource does not exist.
ThrottlingException:
The request was denied because it exceeded the allowed API request rate.
ValidationException:
The input did not meet the specified constraints.

SendDataToMulticastGroup

$result = $client->sendDataToMulticastGroup([/* ... */]);
$promise = $client->sendDataToMulticastGroupAsync([/* ... */]);

Sends the specified data to a multicast group.

Parameter Syntax

$result = $client->sendDataToMulticastGroup([
    'Id' => '<string>', // REQUIRED
    'PayloadData' => '<string>', // REQUIRED
    'WirelessMetadata' => [ // REQUIRED
        'LoRaWAN' => [
            'FPort' => <integer>,
        ],
    ],
]);

Parameter Details

Members

Id

Required: Yes
Type: string

The ID of the multicast group.

PayloadData

Required: Yes
Type: string

The binary to be sent to the end device, encoded in base64.

WirelessMetadata

Required: Yes
Type: MulticastWirelessMetadata structure

Wireless metadata that is to be sent to multicast group.

Result Syntax

[
    'MessageId' => '<string>',
]

Result Details

Members

MessageId

Type: string

ID of a multicast group message.

Errors

ValidationException:
The input did not meet the specified constraints.
ResourceNotFoundException:
Resource does not exist.
AccessDeniedException:
User does not have permission to perform this action.
ConflictException:
Adding, updating, or deleting the resource can cause an inconsistent state.
InternalServerException:
An unexpected error occurred while processing a request.
ThrottlingException:
The request was denied because it exceeded the allowed API request rate.

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>,
            'ParticipatingGateways' => [
                'DownlinkMode' => 'SEQUENTIAL|CONCURRENT|USING_UPLINK_GATEWAY', // REQUIRED
                'GatewayList' => [ // REQUIRED
                    [
                        'DownlinkFrequency' => <integer>, // REQUIRED
                        'GatewayId' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
                'TransmissionInterval' => <integer>, // REQUIRED
            ],
        ],
        'Sidewalk' => [
            'AckModeRetryDurationSecs' => <integer>,
            'MessageType' => 'CUSTOM_COMMAND_ID_NOTIFY|CUSTOM_COMMAND_ID_GET|CUSTOM_COMMAND_ID_SET|CUSTOM_COMMAND_ID_RESP',
            '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 binary to be sent to the end device, encoded in base64.

TransmitMode

Required: Yes
Type: int

The transmit mode to use to send data to the wireless device. Can be: 0 for UM (unacknowledge mode) or 1 for AM (acknowledge mode).

WirelessMetadata

Type: WirelessMetadata structure

Metadata about the message request.

Result Syntax

[
    'MessageId' => '<string>',
]

Result Details

Members

MessageId

Type: string

The ID of the message sent to the wireless device.

Errors

ValidationException:
The input did not meet the specified constraints.
ResourceNotFoundException:
Resource does not exist.
ThrottlingException:
The request was denied because it exceeded the allowed API request rate.
InternalServerException:
An unexpected error occurred while processing a request.

StartBulkAssociateWirelessDeviceWithMulticastGroup

$result = $client->startBulkAssociateWirelessDeviceWithMulticastGroup([/* ... */]);
$promise = $client->startBulkAssociateWirelessDeviceWithMulticastGroupAsync([/* ... */]);

Starts a bulk association of all qualifying wireless devices with a multicast group.

Parameter Syntax

$result = $client->startBulkAssociateWirelessDeviceWithMulticastGroup([
    'Id' => '<string>', // REQUIRED
    'QueryString' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

Id

Required: Yes
Type: string

The ID of the multicast group.

QueryString

Type: string

Query string used to search for wireless devices as part of the bulk associate and disassociate process.

Tags

Type: Array of Tag structures

The tag to attach to the specified resource. Tags are metadata that you can use to manage a resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:
The input did not meet the specified constraints.
ResourceNotFoundException:
Resource does not exist.
AccessDeniedException:
User does not have permission to perform this action.
InternalServerException:
An unexpected error occurred while processing a request.
ThrottlingException:
The request was denied because it exceeded the allowed API request rate.

StartBulkDisassociateWirelessDeviceFromMulticastGroup

$result = $client->startBulkDisassociateWirelessDeviceFromMulticastGroup([/* ... */]);
$promise = $client->startBulkDisassociateWirelessDeviceFromMulticastGroupAsync([/* ... */]);

Starts a bulk disassociatin of all qualifying wireless devices from a multicast group.

Parameter Syntax

$result = $client->startBulkDisassociateWirelessDeviceFromMulticastGroup([
    'Id' => '<string>', // REQUIRED
    'QueryString' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

Id

Required: Yes
Type: string

The ID of the multicast group.

QueryString

Type: string

Query string used to search for wireless devices as part of the bulk associate and disassociate process.

Tags

Type: Array of Tag structures

The tag to attach to the specified resource. Tags are metadata that you can use to manage a resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:
The input did not meet the specified constraints.
ResourceNotFoundException:
Resource does not exist.
AccessDeniedException:
User does not have permission to perform this action.
InternalServerException:
An unexpected error occurred while processing a request.
ThrottlingException:
The request was denied because it exceeded the allowed API request rate.

StartFuotaTask

$result = $client->startFuotaTask([/* ... */]);
$promise = $client->startFuotaTaskAsync([/* ... */]);

Starts a FUOTA task.

Parameter Syntax

$result = $client->startFuotaTask([
    'Id' => '<string>', // REQUIRED
    'LoRaWAN' => [
        'StartTime' => <integer || string || DateTime>,
    ],
]);

Parameter Details

Members

Id

Required: Yes
Type: string

The ID of a FUOTA task.

LoRaWAN

Type: LoRaWANStartFuotaTask structure

The LoRaWAN information used to start a FUOTA task.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:
The input did not meet the specified constraints.
AccessDeniedException:
User does not have permission to perform this action.
ResourceNotFoundException:
Resource does not exist.
ConflictException:
Adding, updating, or deleting the resource can cause an inconsistent state.
ThrottlingException:
The request was denied because it exceeded the allowed API request rate.
InternalServerException:
An unexpected error occurred while processing a request.

StartMulticastGroupSession

$result = $client->startMulticastGroupSession([/* ... */]);
$promise = $client->startMulticastGroupSessionAsync([/* ... */]);

Starts a multicast group session.

Parameter Syntax

$result = $client->startMulticastGroupSession([
    'Id' => '<string>', // REQUIRED
    'LoRaWAN' => [ // REQUIRED
        'DlDr' => <integer>,
        'DlFreq' => <integer>,
        'PingSlotPeriod' => <integer>,
        'SessionStartTime' => <integer || string || DateTime>,
        'SessionTimeout' => <integer>,
    ],
]);

Parameter Details

Members

Id

Required: Yes
Type: string

The ID of the multicast group.

LoRaWAN

Required: Yes
Type: LoRaWANMulticastSession structure

The LoRaWAN information used with the multicast session.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:
The input did not meet the specified constraints.
ResourceNotFoundException:
Resource does not exist.
AccessDeniedException:
User does not have permission to perform this action.
ConflictException:
Adding, updating, or deleting the resource can cause an inconsistent state.
InternalServerException:
An unexpected error occurred while processing a request.
ThrottlingException:
The request was denied because it exceeded the allowed API request rate.

StartSingleWirelessDeviceImportTask

$result = $client->startSingleWirelessDeviceImportTask([/* ... */]);
$promise = $client->startSingleWirelessDeviceImportTaskAsync([/* ... */]);

Start import task for a single wireless device.

Parameter Syntax

$result = $client->startSingleWirelessDeviceImportTask([
    'ClientRequestToken' => '<string>',
    'DestinationName' => '<string>', // REQUIRED
    'DeviceName' => '<string>',
    'Sidewalk' => [ // REQUIRED
        'SidewalkManufacturingSn' => '<string>',
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

ClientRequestToken

Type: string

DestinationName

Required: Yes
Type: string

The name of the Sidewalk destination that describes the IoT rule to route messages from the device in the import task that will be onboarded to AWS IoT Wireless.

DeviceName

Type: string

The name of the wireless device for which an import task is being started.

Sidewalk

Required: Yes
Type: SidewalkSingleStartImportInfo structure

The Sidewalk-related parameters for importing a single wireless device.

Tags

Type: Array of Tag structures

The tag to attach to the specified resource. Tags are metadata that you can use to manage a resource.

Result Syntax

[
    'Arn' => '<string>',
    'Id' => '<string>',
]

Result Details

Members

Arn

Type: string

The ARN (Amazon Resource Name) of the import task.

Id

Type: string

The import task ID.

Errors

ValidationException:
The input did not meet the specified constraints.
AccessDeniedException:
User does not have permission to perform this action.
ResourceNotFoundException:
Resource does not exist.
InternalServerException:
An unexpected error occurred while processing a request.
ConflictException:
Adding, updating, or deleting the resource can cause an inconsistent state.
ThrottlingException:
The request was denied because it exceeded the allowed API request rate.

StartWirelessDeviceImportTask

$result = $client->startWirelessDeviceImportTask([/* ... */]);
$promise = $client->startWirelessDeviceImportTaskAsync([/* ... */]);

Start import task for provisioning Sidewalk devices in bulk using an S3 CSV file.

Parameter Syntax

$result = $client->startWirelessDeviceImportTask([
    'ClientRequestToken' => '<string>',
    'DestinationName' => '<string>', // REQUIRED
    'Sidewalk' => [ // REQUIRED
        'DeviceCreationFile' => '<string>',
        'Role' => '<string>',
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

ClientRequestToken

Type: string

DestinationName

Required: Yes
Type: string

The name of the Sidewalk destination that describes the IoT rule to route messages from the devices in the import task that are onboarded to AWS IoT Wireless.

Sidewalk

Required: Yes
Type: SidewalkStartImportInfo structure

The Sidewalk-related parameters for importing wireless devices that need to be provisioned in bulk.

Tags

Type: Array of Tag structures

The tag to attach to the specified resource. Tags are metadata that you can use to manage a resource.

Result Syntax

[
    'Arn' => '<string>',
    'Id' => '<string>',
]

Result Details

Members

Arn

Type: string

The ARN (Amazon Resource Name) of the import task.

Id

Type: string

The import task ID.

Errors

ValidationException:
The input did not meet the specified constraints.
AccessDeniedException:
User does not have permission to perform this action.
ResourceNotFoundException:
Resource does not exist.
InternalServerException:
An unexpected error occurred while processing a request.
ConflictException:
Adding, updating, or deleting the resource can cause an inconsistent state.
ThrottlingException:
The request was denied because it exceeded the allowed API request rate.

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

The results for this operation are always empty.

Errors

ValidationException:
The input did not meet the specified constraints.
ResourceNotFoundException:
Resource does not exist.
ConflictException:
Adding, updating, or deleting the resource can cause an inconsistent state.
InternalServerException:
An unexpected error occurred while processing a request.
ThrottlingException:
The request was denied because it exceeded the allowed API request rate.
TooManyTagsException:
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

Members

Id

Required: Yes
Type: string

The ID of the wireless device to test.

Result Syntax

[
    'Result' => '<string>',
]

Result Details

Members

Result

Type: string

The result returned by the test.

Errors

ValidationException:
The input did not meet the specified constraints.
ResourceNotFoundException:
Resource does not exist.
ThrottlingException:
The request was denied because it exceeded the allowed API request rate.
InternalServerException:
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

ResourceArn

Required: Yes
Type: string

The ARN of the resource to remove tags from.

TagKeys

Required: Yes
Type: Array of strings

A list of the keys of the tags to remove from the resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:
The input did not meet the specified constraints.
ResourceNotFoundException:
Resource does not exist.
ConflictException:
Adding, updating, or deleting the resource can cause an inconsistent state.
InternalServerException:
An unexpected error occurred while processing a request.
ThrottlingException:
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

The results for this operation are always empty.

Errors

ValidationException:
The input did not meet the specified constraints.
ResourceNotFoundException:
Resource does not exist.
AccessDeniedException:
User does not have permission to perform this action.
InternalServerException:
An unexpected error occurred while processing a request.
ThrottlingException:
The request was denied because it exceeded the allowed API request rate.

UpdateEventConfigurationByResourceTypes

$result = $client->updateEventConfigurationByResourceTypes([/* ... */]);
$promise = $client->updateEventConfigurationByResourceTypesAsync([/* ... */]);

Update the event configuration based on resource types.

Parameter Syntax

$result = $client->updateEventConfigurationByResourceTypes([
    'ConnectionStatus' => [
        'LoRaWAN' => [
            'WirelessGatewayEventTopic' => 'Enabled|Disabled',
        ],
    ],
    'DeviceRegistrationState' => [
        'Sidewalk' => [
            'WirelessDeviceEventTopic' => 'Enabled|Disabled',
        ],
    ],
    'Join' => [
        'LoRaWAN' => [
            'WirelessDeviceEventTopic' => 'Enabled|Disabled',
        ],
    ],
    'MessageDeliveryStatus' => [
        'Sidewalk' => [
            'WirelessDeviceEventTopic' => 'Enabled|Disabled',
        ],
    ],
    'Proximity' => [
        'Sidewalk' => [
            'WirelessDeviceEventTopic' => 'Enabled|Disabled',
        ],
    ],
]);

Parameter Details

Members

ConnectionStatus

Type: ConnectionStatusResourceTypeEventConfiguration structure

Connection status resource type event configuration object for enabling and disabling wireless gateway topic.

DeviceRegistrationState

Type: DeviceRegistrationStateResourceTypeEventConfiguration structure

Device registration state resource type event configuration object for enabling and disabling wireless gateway topic.

Join

Type: JoinResourceTypeEventConfiguration structure

Join resource type event configuration object for enabling and disabling wireless device topic.

MessageDeliveryStatus

Type: MessageDeliveryStatusResourceTypeEventConfiguration structure

Message delivery status resource type event configuration object for enabling and disabling wireless device topic.

Proximity

Type: ProximityResourceTypeEventConfiguration structure

Proximity resource type event configuration object for enabling and disabling wireless gateway topic.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:
The input did not meet the specified constraints.
AccessDeniedException:
User does not have permission to perform this action.
ThrottlingException:
The request was denied because it exceeded the allowed API request rate.
InternalServerException:
An unexpected error occurred while processing a request.

UpdateFuotaTask

$result = $client->updateFuotaTask([/* ... */]);
$promise = $client->updateFuotaTaskAsync([/* ... */]);

Updates properties of a FUOTA task.

Parameter Syntax

$result = $client->updateFuotaTask([
    'Description' => '<string>',
    'FirmwareUpdateImage' => '<string>',
    'FirmwareUpdateRole' => '<string>',
    'FragmentIntervalMS' => <integer>,
    'FragmentSizeBytes' => <integer>,
    'Id' => '<string>', // REQUIRED
    'LoRaWAN' => [
        'RfRegion' => 'EU868|US915|AU915|AS923-1|AS923-2|AS923-3|AS923-4|EU433|CN470|CN779|RU864|KR920|IN865',
    ],
    'Name' => '<string>',
    'RedundancyPercent' => <integer>,
]);

Parameter Details

Members

Description

Type: string

The description of the new resource.

FirmwareUpdateImage

Type: string

The S3 URI points to a firmware update image that is to be used with a FUOTA task.

FirmwareUpdateRole

Type: string

The firmware update role that is to be used with a FUOTA task.

FragmentIntervalMS

Type: int

The interval for sending fragments in milliseconds, rounded to the nearest second.

FragmentSizeBytes

Type: int

The size of each fragment in bytes. This parameter is supported only for FUOTA tasks with multicast groups.

Id

Required: Yes
Type: string

The ID of a FUOTA task.

LoRaWAN

Type: LoRaWANFuotaTask structure

The LoRaWAN information used with a FUOTA task.

Name

Type: string

The name of a FUOTA task.

RedundancyPercent

Type: int

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:
The input did not meet the specified constraints.
ResourceNotFoundException:
Resource does not exist.
AccessDeniedException:
User does not have permission to perform this action.
ConflictException:
Adding, updating, or deleting the resource can cause an inconsistent state.
InternalServerException:
An unexpected error occurred while processing a request.
ThrottlingException:
The request was denied because it exceeded the allowed API request rate.

UpdateLogLevelsByResourceTypes

$result = $client->updateLogLevelsByResourceTypes([/* ... */]);
$promise = $client->updateLogLevelsByResourceTypesAsync([/* ... */]);

Set default log level, or log levels by resource types. This can be for wireless device log options or wireless gateways log options and is used to control the log messages that'll be displayed in CloudWatch.

Parameter Syntax

$result = $client->updateLogLevelsByResourceTypes([
    'DefaultLogLevel' => 'INFO|ERROR|DISABLED',
    'WirelessDeviceLogOptions' => [
        [
            'Events' => [
                [
                    'Event' => 'Join|Rejoin|Uplink_Data|Downlink_Data|Registration', // REQUIRED
                    'LogLevel' => 'INFO|ERROR|DISABLED', // REQUIRED
                ],
                // ...
            ],
            'LogLevel' => 'INFO|ERROR|DISABLED', // REQUIRED
            'Type' => 'Sidewalk|LoRaWAN', // REQUIRED
        ],
        // ...
    ],
    'WirelessGatewayLogOptions' => [
        [
            'Events' => [
                [
                    'Event' => 'CUPS_Request|Certificate', // REQUIRED
                    'LogLevel' => 'INFO|ERROR|DISABLED', // REQUIRED
                ],
                // ...
            ],
            'LogLevel' => 'INFO|ERROR|DISABLED', // REQUIRED
            'Type' => 'LoRaWAN', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

DefaultLogLevel

Type: string

The log level for a log message. The log levels can be disabled, or set to ERROR to display less verbose logs containing only error information, or to INFO for more detailed logs.

WirelessDeviceLogOptions

Type: Array of WirelessDeviceLogOption structures

The list of wireless device log options.

WirelessGatewayLogOptions

Type: Array of WirelessGatewayLogOption structures

The list of wireless gateway log options.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:
User does not have permission to perform this action.
ConflictException:
Adding, updating, or deleting the resource can cause an inconsistent state.
InternalServerException:
An unexpected error occurred while processing a request.
ResourceNotFoundException:
Resource does not exist.
ThrottlingException:
The request was denied because it exceeded the allowed API request rate.
ValidationException:
The input did not meet the specified constraints.

UpdateMetricConfiguration

$result = $client->updateMetricConfiguration([/* ... */]);
$promise = $client->updateMetricConfigurationAsync([/* ... */]);

Update the summary metric configuration.

Parameter Syntax

$result = $client->updateMetricConfiguration([
    'SummaryMetric' => [
        'Status' => 'Enabled|Disabled',
    ],
]);

Parameter Details

Members

SummaryMetric

Type: SummaryMetricConfiguration structure

The value to be used to set summary metric configuration.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:
The input did not meet the specified constraints.
ResourceNotFoundException:
Resource does not exist.
AccessDeniedException:
User does not have permission to perform this action.
ConflictException:
Adding, updating, or deleting the resource can cause an inconsistent state.
InternalServerException:
An unexpected error occurred while processing a request.
ThrottlingException:
The request was denied because it exceeded the allowed API request rate.

UpdateMulticastGroup

$result = $client->updateMulticastGroup([/* ... */]);
$promise = $client->updateMulticastGroupAsync([/* ... */]);

Updates properties of a multicast group session.

Parameter Syntax

$result = $client->updateMulticastGroup([
    'Description' => '<string>',
    'Id' => '<string>', // REQUIRED
    'LoRaWAN' => [
        'DlClass' => 'ClassB|ClassC',
        'RfRegion' => 'EU868|US915|AU915|AS923-1|AS923-2|AS923-3|AS923-4|EU433|CN470|CN779|RU864|KR920|IN865',
    ],
    'Name' => '<string>',
]);

Parameter Details

Members

Description

Type: string

The description of the new resource.

Id

Required: Yes
Type: string

The ID of the multicast group.

LoRaWAN

Type: LoRaWANMulticast structure

The LoRaWAN information that is to be used with the multicast group.

Name

Type: string

The name of the multicast group.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:
The input did not meet the specified constraints.
ResourceNotFoundException:
Resource does not exist.
AccessDeniedException:
User does not have permission to perform this action.
ConflictException:
Adding, updating, or deleting the resource can cause an inconsistent state.
InternalServerException:
An unexpected error occurred while processing a request.
ThrottlingException:
The request was denied because it exceeded the allowed API request rate.

UpdateNetworkAnalyzerConfiguration

$result = $client->updateNetworkAnalyzerConfiguration([/* ... */]);
$promise = $client->updateNetworkAnalyzerConfigurationAsync([/* ... */]);

Update network analyzer configuration.

Parameter Syntax

$result = $client->updateNetworkAnalyzerConfiguration([
    'ConfigurationName' => '<string>', // REQUIRED
    'Description' => '<string>',
    'MulticastGroupsToAdd' => ['<string>', ...],
    'MulticastGroupsToRemove' => ['<string>', ...],
    'TraceContent' => [
        'LogLevel' => 'INFO|ERROR|DISABLED',
        'MulticastFrameInfo' => 'ENABLED|DISABLED',
        'WirelessDeviceFrameInfo' => 'ENABLED|DISABLED',
    ],
    'WirelessDevicesToAdd' => ['<string>', ...],
    'WirelessDevicesToRemove' => ['<string>', ...],
    'WirelessGatewaysToAdd' => ['<string>', ...],
    'WirelessGatewaysToRemove' => ['<string>', ...],
]);

Parameter Details

Members

ConfigurationName

Required: Yes
Type: string

Name of the network analyzer configuration.

Description

Type: string

The description of the new resource.

MulticastGroupsToAdd

Type: Array of strings

Multicast group resources to add to the network analyzer configuration. Provide the MulticastGroupId of the resource to add in the input array.

MulticastGroupsToRemove

Type: Array of strings

Multicast group resources to remove from the network analyzer configuration. Provide the MulticastGroupId of the resources to remove in the input array.

TraceContent

Type: TraceContent structure

Trace content for your wireless devices, gateways, and multicast groups.

WirelessDevicesToAdd

Type: Array of strings

Wireless device resources to add to the network analyzer configuration. Provide the WirelessDeviceId of the resource to add in the input array.

WirelessDevicesToRemove

Type: Array of strings

Wireless device resources to remove from the network analyzer configuration. Provide the WirelessDeviceId of the resources to remove in the input array.

WirelessGatewaysToAdd

Type: Array of strings

Wireless gateway resources to add to the network analyzer configuration. Provide the WirelessGatewayId of the resource to add in the input array.

WirelessGatewaysToRemove

Type: Array of strings

Wireless gateway resources to remove from the network analyzer configuration. Provide the WirelessGatewayId of the resources to remove in the input array.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:
The input did not meet the specified constraints.
AccessDeniedException:
User does not have permission to perform this action.
ResourceNotFoundException:
Resource does not exist.
InternalServerException:
An unexpected error occurred while processing a request.
ThrottlingException:
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

The results for this operation are always empty.

Errors

ValidationException:
The input did not meet the specified constraints.
ResourceNotFoundException:
Resource does not exist.
InternalServerException:
An unexpected error occurred while processing a request.
ThrottlingException:
The request was denied because it exceeded the allowed API request rate.

UpdatePosition

$result = $client->updatePosition([/* ... */]);
$promise = $client->updatePositionAsync([/* ... */]);

Update the position information of a resource.

This action is no longer supported. Calls to update the position information should use the UpdateResourcePosition API operation instead.

Parameter Syntax

$result = $client->updatePosition([
    'Position' => [<float>, ...], // REQUIRED
    'ResourceIdentifier' => '<string>', // REQUIRED
    'ResourceType' => 'WirelessDevice|WirelessGateway', // REQUIRED
]);

Parameter Details

Members

Position

Required: Yes
Type: Array of floats

The position information of the resource.

ResourceIdentifier

Required: Yes
Type: string

Resource identifier of the resource for which position is updated.

ResourceType

Required: Yes
Type: string

Resource type of the resource for which position is updated.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:
The input did not meet the specified constraints.
AccessDeniedException:
User does not have permission to perform this action.
ResourceNotFoundException:
Resource does not exist.
ThrottlingException:
The request was denied because it exceeded the allowed API request rate.
InternalServerException:
An unexpected error occurred while processing a request.

UpdateResourceEventConfiguration

$result = $client->updateResourceEventConfiguration([/* ... */]);
$promise = $client->updateResourceEventConfigurationAsync([/* ... */]);

Update the event configuration for a particular resource identifier.

Parameter Syntax

$result = $client->updateResourceEventConfiguration([
    'ConnectionStatus' => [
        'LoRaWAN' => [
            'GatewayEuiEventTopic' => 'Enabled|Disabled',
        ],
        'WirelessGatewayIdEventTopic' => 'Enabled|Disabled',
    ],
    'DeviceRegistrationState' => [
        'Sidewalk' => [
            'AmazonIdEventTopic' => 'Enabled|Disabled',
        ],
        'WirelessDeviceIdEventTopic' => 'Enabled|Disabled',
    ],
    'Identifier' => '<string>', // REQUIRED
    'IdentifierType' => 'PartnerAccountId|DevEui|GatewayEui|WirelessDeviceId|WirelessGatewayId', // REQUIRED
    'Join' => [
        'LoRaWAN' => [
            'DevEuiEventTopic' => 'Enabled|Disabled',
        ],
        'WirelessDeviceIdEventTopic' => 'Enabled|Disabled',
    ],
    'MessageDeliveryStatus' => [
        'Sidewalk' => [
            'AmazonIdEventTopic' => 'Enabled|Disabled',
        ],
        'WirelessDeviceIdEventTopic' => 'Enabled|Disabled',
    ],
    'PartnerType' => 'Sidewalk',
    'Proximity' => [
        'Sidewalk' => [
            'AmazonIdEventTopic' => 'Enabled|Disabled',
        ],
        'WirelessDeviceIdEventTopic' => 'Enabled|Disabled',
    ],
]);

Parameter Details

Members

ConnectionStatus

Type: ConnectionStatusEventConfiguration structure

Event configuration for the connection status event.

DeviceRegistrationState

Type: DeviceRegistrationStateEventConfiguration structure

Event configuration for the device registration state event.

Identifier

Required: Yes
Type: string

Resource identifier to opt in for event messaging.

IdentifierType

Required: Yes
Type: string

Identifier type of the particular resource identifier for event configuration.

Join

Type: JoinEventConfiguration structure

Event configuration for the join event.

MessageDeliveryStatus

Type: MessageDeliveryStatusEventConfiguration structure

Event configuration for the message delivery status event.

PartnerType

Type: string

Partner type of the resource if the identifier type is PartnerAccountId

Proximity

Type: ProximityEventConfiguration structure

Event configuration for the proximity event.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:
The input did not meet the specified constraints.
AccessDeniedException:
User does not have permission to perform this action.
ConflictException:
Adding, updating, or deleting the resource can cause an inconsistent state.
ThrottlingException:
The request was denied because it exceeded the allowed API request rate.
ResourceNotFoundException:
Resource does not exist.
InternalServerException:
An unexpected error occurred while processing a request.

UpdateResourcePosition

$result = $client->updateResourcePosition([/* ... */]);
$promise = $client->updateResourcePositionAsync([/* ... */]);

Update the position information of a given wireless device or a wireless gateway resource. The position coordinates are based on the World Geodetic System (WGS84).

Parameter Syntax

$result = $client->updateResourcePosition([
    'GeoJsonPayload' => <string || resource || Psr\Http\Message\StreamInterface>,
    'ResourceIdentifier' => '<string>', // REQUIRED
    'ResourceType' => 'WirelessDevice|WirelessGateway', // REQUIRED
]);

Parameter Details

Members

GeoJsonPayload

Type: blob (string|resource|Psr\Http\Message\StreamInterface)

ResourceIdentifier

Required: Yes
Type: string

The identifier of the resource for which position information is updated. It can be the wireless device ID or the wireless gateway ID, depending on the resource type.

ResourceType

Required: Yes
Type: string

The type of resource for which position information is updated, which can be a wireless device or a wireless gateway.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:
The input did not meet the specified constraints.
AccessDeniedException:
User does not have permission to perform this action.
ResourceNotFoundException:
Resource does not exist.
ThrottlingException:
The request was denied because it exceeded the allowed API request rate.
InternalServerException:
An unexpected error occurred while processing a request.

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' => [
        'AbpV1_0_x' => [
            'FCntStart' => <integer>,
        ],
        'AbpV1_1' => [
            'FCntStart' => <integer>,
        ],
        'DeviceProfileId' => '<string>',
        'FPorts' => [
            'Applications' => [
                [
                    'DestinationName' => '<string>',
                    'FPort' => <integer>,
                    'Type' => 'SemtechGeolocation',
                ],
                // ...
            ],
            'Positioning' => [
                'ClockSync' => <integer>,
                'Gnss' => <integer>,
                'Stream' => <integer>,
            ],
        ],
        'ServiceProfileId' => '<string>',
    ],
    'Name' => '<string>',
    'Positioning' => 'Enabled|Disabled',
]);

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.

Positioning

Type: string

FPort values for the GNSS, stream, and ClockSync functions of the positioning information.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:
The input did not meet the specified constraints.
ResourceNotFoundException:
Resource does not exist.
AccessDeniedException:
User does not have permission to perform this action.
InternalServerException:
An unexpected error occurred while processing a request.
ThrottlingException:
The request was denied because it exceeded the allowed API request rate.

UpdateWirelessDeviceImportTask

$result = $client->updateWirelessDeviceImportTask([/* ... */]);
$promise = $client->updateWirelessDeviceImportTaskAsync([/* ... */]);

Update an import task to add more devices to the task.

Parameter Syntax

$result = $client->updateWirelessDeviceImportTask([
    'Id' => '<string>', // REQUIRED
    'Sidewalk' => [ // REQUIRED
        'DeviceCreationFile' => '<string>',
    ],
]);

Parameter Details

Members

Id

Required: Yes
Type: string

The identifier of the import task to be updated.

Sidewalk

Required: Yes
Type: SidewalkUpdateImportInfo structure

The Sidewalk-related parameters of the import task to be updated.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:
The input did not meet the specified constraints.
AccessDeniedException:
User does not have permission to perform this action.
ResourceNotFoundException:
Resource does not exist.
InternalServerException:
An unexpected error occurred while processing a request.
ConflictException:
Adding, updating, or deleting the resource can cause an inconsistent state.
ThrottlingException:
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
    'JoinEuiFilters' => [
        ['<string>', ...],
        // ...
    ],
    'MaxEirp' => <float>,
    'Name' => '<string>',
    'NetIdFilters' => ['<string>', ...],
]);

Parameter Details

Members

Description

Type: string

A new description of the resource.

Id

Required: Yes
Type: string

The ID of the resource to update.

JoinEuiFilters

Type: Array of stringss

A list of JoinEuiRange used by LoRa gateways to filter LoRa frames.

MaxEirp

Type: float

The MaxEIRP value.

Name

Type: string

The new name of the resource.

NetIdFilters

Type: Array of strings

A list of NetId values that are used by LoRa gateways to filter the uplink frames.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:
The input did not meet the specified constraints.
ResourceNotFoundException:
Resource does not exist.
AccessDeniedException:
User does not have permission to perform this action.
InternalServerException:
An unexpected error occurred while processing a request.
ThrottlingException:
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.

FCntStart

Type: int

The FCnt init 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.

FCntStart

Type: int

The FCnt init value.

SessionKeys

Type: SessionKeysAbpV1_1 structure

Session keys for ABP v1.1

AccessDeniedException

Description

User does not have permission to perform this action.

Members

Message

Type: string

Accuracy

Description

Members

HorizontalAccuracy

Type: float

The horizontal accuracy of the estimated position, which is the difference between the estimated location and the actual device location.

VerticalAccuracy

Type: float

The vertical accuracy of the estimated position, which is the difference between the estimated altitude and actual device latitude in meters.

ApplicationConfig

Description

LoRaWAN application configuration, which can be used to perform geolocation.

Members

DestinationName

Type: string

The name of the position data destination that describes the AWS IoT rule that processes the device's position data for use by AWS IoT Core for LoRaWAN.

FPort

Type: int

The Fport value.

Type

Type: string

Application type, which can be specified to obtain real-time position information of your LoRaWAN device.

Beaconing

Description

Beaconing parameters for configuring the wireless gateways.

Members

DataRate

Type: int

The data rate for gateways that are sending the beacons.

Frequencies

Type: Array of ints

The frequency list for the gateways to send the beacons.

CdmaLocalId

Description

CDMA local ID information, which corresponds to the local identification parameters of a CDMA cell.

Members

CdmaChannel

Required: Yes
Type: int

CDMA channel information.

PnOffset

Required: Yes
Type: int

Pseudo-noise offset, which is a characteristic of the signal from a cell on a radio tower.

CdmaNmrObj

Description

CDMA object for network measurement reports.

Members

BaseStationId

Type: int

CDMA base station ID (BSID).

CdmaChannel

Required: Yes
Type: int

CDMA channel information.

PilotPower

Type: int

Transmit power level of the pilot signal, measured in dBm (decibel-milliwatts).

PnOffset

Required: Yes
Type: int

Pseudo-noise offset, which is a characteristic of the signal from a cell on a radio tower.

CdmaObj

Description

CDMA (Code-division multiple access) object.

Members

BaseLat

Type: float

CDMA base station latitude in degrees.

BaseLng

Type: float

CDMA base station longitude in degrees.

BaseStationId

Required: Yes
Type: int

CDMA base station ID (BSID).

CdmaLocalId

Type: CdmaLocalId structure

CDMA local identification (local ID) parameters.

CdmaNmr

Type: Array of CdmaNmrObj structures

CDMA network measurement reports.

NetworkId

Required: Yes
Type: int

CDMA network ID (NID).

PilotPower

Type: int

Transmit power level of the pilot signal, measured in dBm (decibel-milliwatts).

RegistrationZone

Type: int

CDMA registration zone (RZ).

SystemId

Required: Yes
Type: int

CDMA system ID (SID).

CellTowers

Description

The cell towers that were used to perform the measurements.

Members

Cdma

Type: Array of CdmaObj structures

CDMA object information.

Gsm

Type: Array of GsmObj structures

GSM object information.

Lte

Type: Array of LteObj structures

LTE object information.

Tdscdma

Type: Array of TdscdmaObj structures

TD-SCDMA object information.

Wcdma

Type: Array of WcdmaObj structures

WCDMA object information.

CertificateList

Description

List of sidewalk certificates.

Members

SigningAlg

Required: Yes
Type: string

The certificate chain algorithm provided by sidewalk.

Value

Required: Yes
Type: string

The value of the chosen sidewalk certificate.

ConflictException

Description

Adding, updating, or deleting the resource can cause an inconsistent state.

Members

Message

Type: string

ResourceId

Type: string

Id of the resource in the conflicting operation.

ResourceType

Type: string

Type of the resource in the conflicting operation.

ConnectionStatusEventConfiguration

Description

Connection status event configuration object for enabling or disabling topic.

Members

LoRaWAN

Type: LoRaWANConnectionStatusEventNotificationConfigurations structure

Connection status event configuration object for enabling or disabling LoRaWAN related event topics.

WirelessGatewayIdEventTopic

Type: string

Denotes whether the wireless gateway ID connection status event topic is enabled or disabled.

ConnectionStatusResourceTypeEventConfiguration

Description

Connection status resource type event configuration object for enabling or disabling topic.

Members

LoRaWAN

Type: LoRaWANConnectionStatusResourceTypeEventConfiguration structure

Connection status resource type event configuration object for enabling or disabling LoRaWAN related event topics.

DakCertificateMetadata

Description

The device attestation key (DAK) information.

Members

ApId

Type: string

The advertised product ID (APID) that's used for pre-production and production applications.

CertificateId

Required: Yes
Type: string

The certificate ID for the DAK.

DeviceTypeId

Type: string

The device type ID that's used for prototyping applications.

FactorySupport

Type: boolean

Whether factory support has been enabled.

MaxAllowedSignature

Type: int

The maximum number of signatures that the DAK can sign. A value of -1 indicates that there's no device limit.

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

Arn

Type: string

The Amazon Resource Name of the resource.

Id

Type: string

The ID of the device profile.

Name

Type: string

The name of the resource.

DeviceRegistrationStateEventConfiguration

Description

Device registration state event configuration object for enabling and disabling relevant topics.

Members

Sidewalk

Type: SidewalkEventNotificationConfigurations structure

Device registration state event configuration object for enabling or disabling Sidewalk related event topics.

WirelessDeviceIdEventTopic

Type: string

Denotes whether the wireless device ID device registration state event topic is enabled or disabled.

DeviceRegistrationStateResourceTypeEventConfiguration

Description

Device registration state resource type event configuration object for enabling or disabling topic.

Members

Sidewalk

Type: SidewalkResourceTypeEventConfiguration structure

Device registration resource type state event configuration object for enabling or disabling Sidewalk related event topics.

Dimension

Description

The required list of dimensions for the metric.

Members

name

Type: string

The name of the dimension.

value

Type: string

The dimension's value.

DownlinkQueueMessage

Description

The message in the downlink queue.

Members

LoRaWAN

Type: LoRaWANSendDataToDevice structure

LoRaWAN router info.

MessageId

Type: string

The message ID assigned by IoT Wireless to each downlink message, which helps identify the message.

ReceivedAt

Type: string

The time at which Iot Wireless received the downlink message.

TransmitMode

Type: int

The transmit mode to use for sending data to the wireless device. This can be 0 for UM (unacknowledge mode) or 1 for AM (acknowledge mode).

EventConfigurationItem

Description

Event configuration object for a single resource.

Members

Events

Type: EventNotificationItemConfigurations structure

Object of all event configurations and the status of the event topics.

Identifier

Type: string

Resource identifier opted in for event messaging.

IdentifierType

Type: string

Identifier type of the particular resource identifier for event configuration.

PartnerType

Type: string

Partner type of the resource if the identifier type is PartnerAccountId.

EventNotificationItemConfigurations

Description

Object of all event configurations and the status of the event topics.

Members

ConnectionStatus

Type: ConnectionStatusEventConfiguration structure

Connection status event configuration for an event configuration item.

DeviceRegistrationState

Type: DeviceRegistrationStateEventConfiguration structure

Device registration state event configuration for an event configuration item.

Join

Type: JoinEventConfiguration structure

Join event configuration for an event configuration item.

MessageDeliveryStatus

Type: MessageDeliveryStatusEventConfiguration structure

Message delivery status event configuration for an event configuration item.

Proximity

Type: ProximityEventConfiguration structure

Proximity event configuration for an event configuration item.

FPorts

Description

List of FPort assigned for different LoRaWAN application packages to use

Members

Applications

Type: Array of ApplicationConfig structures

Optional LoRaWAN application information, which can be used for geolocation.

ClockSync

Type: int

The Fport value.

Fuota

Type: int

The Fport value.

Multicast

Type: int

The Fport value.

Positioning

Type: Positioning structure

FPort values for the GNSS, stream, and ClockSync functions of the positioning information.

FuotaTask

Description

A FUOTA task.

Members

Arn

Type: string

The arn of a FUOTA task.

Id

Type: string

The ID of a FUOTA task.

Name

Type: string

The name of a FUOTA task.

GatewayListItem

Description

Gateway list item object that specifies the frequency and list of gateways for which the downlink message should be sent.

Members

DownlinkFrequency

Required: Yes
Type: int

The frequency to use for the gateways when sending a downlink message to the wireless device.

GatewayId

Required: Yes
Type: string

The ID of the wireless gateways that you want to add to the list of gateways when sending downlink messages.

GlobalIdentity

Description

Global identity information.

Members

GeranCid

Required: Yes
Type: int

GERAN (GSM EDGE Radio Access Network) cell global identifier.

Lac

Required: Yes
Type: int

Location area code of the global identity.

Gnss

Description

Global navigation satellite system (GNSS) object used for positioning.

Members

AssistAltitude

Type: float

Optional assistance altitude, which is the altitude of the device at capture time, specified in meters above the WGS84 reference ellipsoid.

AssistPosition

Type: Array of floats

Optional assistance position information, specified using latitude and longitude values in degrees. The coordinates are inside the WGS84 reference frame.

CaptureTime

Type: float

Optional parameter that gives an estimate of the time when the GNSS scan information is taken, in seconds GPS time (GPST). If capture time is not specified, the local server time is used.

CaptureTimeAccuracy

Type: float

Optional value that gives the capture time estimate accuracy, in seconds. If capture time accuracy is not specified, default value of 300 is used.

Payload

Required: Yes
Type: string

Payload that contains the GNSS scan result, or NAV message, in hexadecimal notation.

Use2DSolver

Type: boolean

Optional parameter that forces 2D solve, which modifies the positioning algorithm to a 2D solution problem. When this parameter is specified, the assistance altitude should have an accuracy of at least 10 meters.

GsmLocalId

Description

GSM local ID information, which corresponds to the local identification parameters of a GSM cell.

Members

Bcch

Required: Yes
Type: int

GSM broadcast control channel.

Bsic

Required: Yes
Type: int

GSM base station identity code (BSIC).

GsmNmrObj

Description

GSM object for network measurement reports.

Members

Bcch

Required: Yes
Type: int

GSM broadcast control channel.

Bsic

Required: Yes
Type: int

GSM base station identity code (BSIC).

GlobalIdentity

Type: GlobalIdentity structure

Global identity information of the GSM object.

RxLevel

Type: int

Rx level, which is the received signal power, measured in dBm (decibel-milliwatts).

GsmObj

Description

GSM object.

Members

GeranCid

Required: Yes
Type: int

GERAN (GSM EDGE Radio Access Network) Cell Global Identifier.

GsmLocalId

Type: GsmLocalId structure

GSM local identification (local ID) information.

GsmNmr

Type: Array of GsmNmrObj structures

GSM object for network measurement reports.

GsmTimingAdvance

Type: int

Timing advance value, which corresponds to the length of time a signal takes to reach the base station from a mobile phone.

Lac

Required: Yes
Type: int

Location area code.

Mcc

Required: Yes
Type: int

Mobile Country Code.

Mnc

Required: Yes
Type: int

Mobile Network Code.

RxLevel

Type: int

Rx level, which is the received signal power, measured in dBm (decibel-milliwatts).

ImportedSidewalkDevice

Description

Information about a Sidewalk device that has been added to an import task.

Members

LastUpdateTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the status information was last updated.

OnboardingStatus

Type: string

The onboarding status of the Sidewalk device in the import task.

OnboardingStatusReason

Type: string

The reason for the onboarding status information for the Sidewalk device.

SidewalkManufacturingSn

Type: string

The Sidewalk manufacturing serial number (SMSN) of the Sidewalk device.

ImportedWirelessDevice

Description

Information about a wireless device that has been added to an import task.

Members

Sidewalk

Type: ImportedSidewalkDevice structure

The Sidewalk-related information about a device that has been added to an import task.

InternalServerException

Description

An unexpected error occurred while processing a request.

Members

Message

Type: string

Ip

Description

IP address used for resolving device location.

Members

IpAddress

Required: Yes
Type: string

IP address information.

JoinEventConfiguration

Description

Join event configuration object for enabling or disabling topic.

Members

LoRaWAN

Type: LoRaWANJoinEventNotificationConfigurations structure

Join event configuration object for enabling or disabling LoRaWAN related event topics.

WirelessDeviceIdEventTopic

Type: string

Denotes whether the wireless device ID join event topic is enabled or disabled.

JoinResourceTypeEventConfiguration

Description

Join resource type event configuration object for enabling or disabling topic.

Members

LoRaWAN

Type: LoRaWANJoinResourceTypeEventConfiguration structure

Join resource type event configuration object for enabling or disabling LoRaWAN related event topics.

LoRaWANConnectionStatusEventNotificationConfigurations

Description

Object for LoRaWAN connection status resource type event configuration.

Members

GatewayEuiEventTopic

Type: string

Denotes whether the gateway EUI connection status event topic is enabled or disabled.

LoRaWANConnectionStatusResourceTypeEventConfiguration

Description

Object for LoRaWAN connection status resource type event configuration.

Members

WirelessGatewayEventTopic

Type: string

Denotes whether the wireless gateway connection status event topic is enabled or disabled.

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.

FPorts

Type: FPorts structure

List of FPort assigned for different LoRaWAN application packages to use

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.

PublicGateways

Type: Array of LoRaWANPublicGatewayMetadata structures

Information about the LoRaWAN public network 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. It ranges from 0 to 15.

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.

LoRaWANFuotaTask

Description

The LoRaWAN information used with a FUOTA task.

Members

RfRegion

Type: string

Supported RfRegions

LoRaWANFuotaTaskGetInfo

Description

The LoRaWAN information returned from getting a FUOTA task.

Members

RfRegion

Type: string

The frequency band (RFRegion) value.

StartTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

Start time of a FUOTA task.

LoRaWANGateway

Description

LoRaWANGateway object.

Members

Beaconing

Type: Beaconing structure

Beaconing object information, which consists of the data rate and frequency parameters.

GatewayEui

Type: string

The gateway's EUI value.

JoinEuiFilters

Type: Array of stringss

A list of JoinEuiRange used by LoRa gateways to filter LoRa frames.

MaxEirp

Type: float

The MaxEIRP value.

NetIdFilters

Type: Array of strings

A list of NetId values that are used by LoRa gateways to filter the uplink frames.

RfRegion

Type: string

The frequency band (RFRegion) value.

SubBands

Type: Array of ints

A list of integer indicating which sub bands are supported by LoRa gateway.

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

GatewayEui

Type: string

The gateway's EUI value.

Rssi

Type: double

The RSSI value.

Snr

Type: double

The SNR value.

LoRaWANGatewayVersion

Description

LoRaWANGatewayVersion object.

Members

Model

Type: string

The model number of the wireless gateway.

PackageVersion

Type: string

The version of the wireless gateway firmware.

Station

Type: string

The basic station version of the wireless gateway.

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.

LoRaWANJoinEventNotificationConfigurations

Description

Object for LoRaWAN join resource type event configuration.

Members

DevEuiEventTopic

Type: string

Denotes whether the Dev EUI join event topic is enabled or disabled.

LoRaWANJoinResourceTypeEventConfiguration

Description

Object for LoRaWAN join resource type event configuration.

Members

WirelessDeviceEventTopic

Type: string

Denotes whether the wireless device join event topic is enabled or disabled.

LoRaWANListDevice

Description

LoRaWAN object for list functions.

Members

DevEui

Type: string

The DevEUI value.

LoRaWANMulticast

Description

The LoRaWAN information that is to be used with the multicast group.

Members

DlClass

Type: string

DlClass for LoRaWAM, valid values are ClassB and ClassC.

RfRegion

Type: string

Supported RfRegions

LoRaWANMulticastGet

Description

The LoRaWAN information that is to be returned from getting multicast group information.

Members

DlClass

Type: string

DlClass for LoRaWAM, valid values are ClassB and ClassC.

NumberOfDevicesInGroup

Type: int

Number of devices that are associated to the multicast group.

NumberOfDevicesRequested

Type: int

Number of devices that are requested to be associated with the multicast group.

RfRegion

Type: string

Supported RfRegions

LoRaWANMulticastMetadata

Description

The metadata information of the LoRaWAN multicast group.

Members

FPort

Type: int

The Fport value.

LoRaWANMulticastSession

Description

The LoRaWAN information used with the multicast session.

Members

DlDr

Type: int

Downlink data rate.

DlFreq

Type: int

Downlink frequency.

PingSlotPeriod

Type: int

The PingSlotPeriod value.

SessionStartTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

Timestamp of when the multicast group session is to start.

SessionTimeout

Type: int

How long before a multicast group session is to timeout.

LoRaWANPublicGatewayMetadata

Description

LoRaWAN public gateway metadata.

Members

DlAllowed

Type: boolean

Boolean that indicates whether downlink is allowed using the network.

Id

Type: string

The ID of the gateways that are operated by the network provider.

ProviderNetId

Type: string

The ID of the LoRaWAN public network provider.

RfRegion

Type: string

The frequency band (RFRegion) value.

Rssi

Type: double

The RSSI (received signal strength indicator) value.

Snr

Type: double

The SNR (signal to noise ratio) value.

LoRaWANSendDataToDevice

Description

LoRaWAN router info.

Members

FPort

Type: int

The Fport value.

ParticipatingGateways

Type: ParticipatingGateways structure

Choose the gateways that you want to use for the downlink data traffic when the wireless device is running in class B or class C mode.

LoRaWANServiceProfile

Description

LoRaWANServiceProfile object.

Members

AddGwMetadata

Type: boolean

The AddGWMetaData value.

DrMax

Type: int

The DrMax value.

DrMin

Type: int

The DrMin 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.

LoRaWANStartFuotaTask

Description

The LoRaWAN information used to start a FUOTA task.

Members

StartTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

Start time of a FUOTA task.

LoRaWANUpdateDevice

Description

LoRaWAN object for update functions.

Members

AbpV1_0_x

Type: UpdateAbpV1_0_x structure

ABP device object for update APIs for v1.0.x

AbpV1_1

Type: UpdateAbpV1_1 structure

ABP device object for update APIs for v1.1

DeviceProfileId

Type: string

The ID of the device profile for the wireless device.

FPorts

Type: UpdateFPorts structure

FPorts object for the positioning information of the device.

ServiceProfileId

Type: string

The ID of the service profile.

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.

LteLocalId

Description

LTE local identification (local ID) information.

Members

Earfcn

Required: Yes
Type: int

Evolved universal terrestrial radio access (E-UTRA) absolute radio frequency channel number (FCN).

Pci

Required: Yes
Type: int

Physical cell ID.

LteNmrObj

Description

LTE object for network measurement reports.

Members

Earfcn

Required: Yes
Type: int

E-UTRA (Evolved universal terrestrial Radio Access) absolute radio frequency channel Number (EARFCN).

EutranCid

Required: Yes
Type: int

E-UTRAN (Evolved Universal Terrestrial Radio Access Network) cell global identifier (EUTRANCID).

Pci

Required: Yes
Type: int

Physical cell ID.

Rsrp

Type: int

Signal power of the reference signal received, measured in dBm (decibel-milliwatts).

Rsrq

Type: float

Signal quality of the reference Signal received, measured in decibels (dB).

LteObj

Description

LTE object.

Members

EutranCid

Required: Yes
Type: int

E-UTRAN (Evolved Universal Terrestrial Radio Access Network) Cell Global Identifier.

LteLocalId

Type: LteLocalId structure

LTE local identification (local ID) information.

LteNmr

Type: Array of LteNmrObj structures

LTE object for network measurement reports.

LteTimingAdvance

Type: int

LTE timing advance.

Mcc

Required: Yes
Type: int

Mobile Country Code.

Mnc

Required: Yes
Type: int

Mobile Network Code.

NrCapable

Type: boolean

Parameter that determines whether the LTE object is capable of supporting NR (new radio).

Rsrp

Type: int

Signal power of the reference signal received, measured in dBm (decibel-milliwatts).

Rsrq

Type: float

Signal quality of the reference Signal received, measured in decibels (dB).

Tac

Type: int

LTE tracking area code.

MessageDeliveryStatusEventConfiguration

Description

Message delivery status event configuration object for enabling and disabling relevant topics.

Members

Sidewalk

Type: SidewalkEventNotificationConfigurations structure

SidewalkEventNotificationConfigurations object, which is the event configuration object for Sidewalk-related event topics.

WirelessDeviceIdEventTopic

Type: string

Denotes whether the wireless device ID message delivery status event topic is enabled or disabled.

MessageDeliveryStatusResourceTypeEventConfiguration

Description

Message delivery status resource type event configuration object for enabling or disabling relevant topic.

Members

Sidewalk

Type: SidewalkResourceTypeEventConfiguration structure

Sidewalk resource type event configuration object for enabling or disabling topic.

MetricQueryValue

Description

The aggregated values of the metric.

Members

Avg

Type: double

The average of the values of all data points collected during the aggregation period.

Max

Type: double

The maximum of the values of all the data points collected during the aggregation period.

Min

Type: double

The minimum of the values of all data points collected during the aggregation period.

P90

Type: double

The 90th percentile of the values of all data points collected during the aggregation period.

Std

Type: double

The standard deviation of the values of all data points collected during the aggregation period.

Sum

Type: double

The sum of the values of all data points collected during the aggregation period.

MulticastGroup

Description

A multicast group.

Members

Arn

Type: string

The arn of the multicast group.

Id

Type: string

The ID of the multicast group.

Name

Type: string

The name of the multicast group.

MulticastGroupByFuotaTask

Description

A multicast group that is associated with a FUOTA task.

Members

Id

Type: string

The ID of the multicast group.

MulticastWirelessMetadata

Description

Wireless metadata that is to be sent to multicast group.

Members

LoRaWAN

Type: LoRaWANMulticastMetadata structure

The metadata information of the LoRaWAN multicast group.

NetworkAnalyzerConfigurations

Description

Network analyzer configurations.

Members

Arn

Type: string

The Amazon Resource Name of the new resource.

Name

Type: string

Name of the network analyzer configuration.

OtaaV1_0_x

Description

OTAA device object for v1.0.x

Members

AppEui

Type: string

The AppEUI value. You specify this value when using LoRaWAN versions v1.0.2 or v1.0.3.

AppKey

Type: string

The AppKey value.

GenAppKey

Type: string

The GenAppKey value.

JoinEui

Type: string

The JoinEUI value. You specify this value instead of the AppEUI when using LoRaWAN version v1.0.4.

OtaaV1_1

Description

OTAA device object for v1.1

Members

AppKey

Type: string

The AppKey value.

JoinEui

Type: string

The JoinEUI value.

NwkKey

Type: string

The NwkKey value.

ParticipatingGateways

Description

Specify the list of gateways to which you want to send downlink data traffic when the wireless device is running in class B or class C mode.

Members

DownlinkMode

Required: Yes
Type: string

Indicates whether to send the downlink message in sequential mode or concurrent mode, or to use only the chosen gateways from the previous uplink message transmission.

GatewayList

Required: Yes
Type: Array of GatewayListItem structures

The list of gateways that you want to use for sending the downlink data traffic.

TransmissionInterval

Required: Yes
Type: int

The duration of time for which AWS IoT Core for LoRaWAN will wait before transmitting the payload to the next gateway.

PositionConfigurationItem

Description

The wrapper for a position configuration.

Members

Destination

Type: string

The position data destination that describes the AWS IoT rule that processes the device's position data for use by AWS IoT Core for LoRaWAN.

ResourceIdentifier

Type: string

Resource identifier for the position configuration.

ResourceType

Type: string

Resource type of the resource for the position configuration.

Solvers

Type: PositionSolverDetails structure

The details of the positioning solver object used to compute the location.

PositionSolverConfigurations

Description

The wrapper for position solver configurations.

Members

SemtechGnss

Type: SemtechGnssConfiguration structure

The Semtech GNSS solver configuration object.

PositionSolverDetails

Description

The wrapper for position solver details.

Members

SemtechGnss

Type: SemtechGnssDetail structure

The Semtech GNSS solver object details.

Positioning

Description

The FPorts for the position information.

Members

ClockSync

Type: int

The Fport value.

Gnss

Type: int

The Fport value.

Stream

Type: int

The Fport value.

ProximityEventConfiguration

Description

Proximity event configuration object for enabling and disabling relevant topics.

Members

Sidewalk

Type: SidewalkEventNotificationConfigurations structure

Proximity event configuration object for enabling or disabling Sidewalk related event topics.

WirelessDeviceIdEventTopic

Type: string

Denotes whether the wireless device ID proximity event topic is enabled or disabled.

ProximityResourceTypeEventConfiguration

Description

Proximity resource type event configuration object for enabling or disabling topic.

Members

Sidewalk

Type: SidewalkResourceTypeEventConfiguration structure

Proximity resource type event configuration object for enabling and disabling wireless device topic.

ResourceNotFoundException

Description

Resource does not exist.

Members

Message

Type: string

ResourceId

Type: string

Id of the not found resource.

ResourceType

Type: string

Type of the font found resource.

SemtechGnssConfiguration

Description

Information about the Semtech GNSS solver configuration.

Members

Fec

Required: Yes
Type: string

Whether forward error correction is enabled.

Status

Required: Yes
Type: string

The status indicating whether the solver is enabled.

SemtechGnssDetail

Description

Details of the Semtech GNSS solver object.

Members

Fec

Type: string

Whether forward error correction is enabled.

Provider

Type: string

The vendor of the solver object.

Status

Type: string

The status indicating whether the solver is enabled.

Type

Type: string

The type of positioning solver used.

ServiceProfile

Description

Information about a service profile.

Members

Arn

Type: string

The Amazon Resource Name of the resource.

Id

Type: string

The ID of the service profile.

Name

Type: string

The name of the resource.

SessionKeysAbpV1_0_x

Description

Session keys for ABP v1.1

Members

AppSKey

Type: string

The AppSKey value.

NwkSKey

Type: string

The NwkSKey value.

SessionKeysAbpV1_1

Description

Session keys for ABP v1.1

Members

AppSKey

Type: string

The AppSKey value.

FNwkSIntKey

Type: string

The FNwkSIntKey value.

NwkSEncKey

Type: string

The NwkSEncKey value.

SNwkSIntKey

Type: string

The SNwkSIntKey value.

SidewalkAccountInfo

Description

Information about a Sidewalk account.

Members

AmazonId

Type: string

The Sidewalk Amazon ID.

AppServerPrivateKey

Type: string

The Sidewalk application server private key.

SidewalkAccountInfoWithFingerprint

Description

Information about a Sidewalk account.

Members

AmazonId

Type: string

The Sidewalk Amazon ID.

Arn

Type: string

The Amazon Resource Name of the resource.

Fingerprint

Type: string

The fingerprint of the Sidewalk application server private key.

SidewalkCreateDeviceProfile

Description

Sidewalk object for creating a device profile.

Members

SidewalkCreateWirelessDevice

Description

Sidewalk object for creating a wireless device.

Members

DeviceProfileId

Type: string

The ID of the Sidewalk device profile.

SidewalkDevice

Description

Sidewalk device object.

Members

AmazonId

Type: string

The Sidewalk Amazon ID.

CertificateId

Type: string

The ID of the Sidewalk device profile.

DeviceCertificates

Type: Array of CertificateList structures

The sidewalk device certificates for Ed25519 and P256r1.

DeviceProfileId

Type: string

The ID of the Sidewalk device profile.

PrivateKeys

Type: Array of CertificateList structures

The Sidewalk device private keys that will be used for onboarding the device.

SidewalkId

Type: string

The sidewalk device identification.

SidewalkManufacturingSn

Type: string

The Sidewalk manufacturing series number.

Status

Type: string

The Sidewalk device status, such as provisioned or registered.

SidewalkDeviceMetadata

Description

MetaData for Sidewalk device.

Members

BatteryLevel

Type: string

Sidewalk device battery level.

DeviceState

Type: string

Device state defines the device status of sidewalk device.

Event

Type: string

Sidewalk device status notification.

Rssi

Type: int

The RSSI value.

SidewalkEventNotificationConfigurations

Description

SidewalkEventNotificationConfigurations object, which is the event configuration object for Sidewalk-related event topics.

Members

AmazonIdEventTopic

Type: string

Denotes whether the Amazon ID event topic is enabled or disabled.

SidewalkGetDeviceProfile

Description

Gets information about a Sidewalk device profile.

Members

ApplicationServerPublicKey

Type: string

The Sidewalk application server public key.

DakCertificateMetadata

Type: Array of DakCertificateMetadata structures

The DAK certificate information of the Sidewalk device profile.

QualificationStatus

Type: boolean

Gets information about the certification status of a Sidewalk device profile.

SidewalkGetStartImportInfo

Description

Sidewalk-related information for devices in an import task that are being onboarded.

Members

DeviceCreationFileList

Type: Array of strings

List of Sidewalk devices that are added to the import task.

Role

Type: string

The IAM role that allows AWS IoT Wireless to access the CSV file in the S3 bucket.

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.

DeviceProfileId

Type: string

Sidewalk object used by list functions.

SidewalkId

Type: string

The sidewalk device identification.

SidewalkManufacturingSn

Type: string

The Sidewalk manufacturing series number.

Status

Type: string

The status of the Sidewalk devices, such as provisioned or registered.

SidewalkResourceTypeEventConfiguration

Description

Sidewalk resource type event configuration object for enabling or disabling topic.

Members

WirelessDeviceEventTopic

Type: string

Denotes whether the wireless device join event topic is enabled or disabled.

SidewalkSendDataToDevice

Description

Information about a Sidewalk router.

Members

AckModeRetryDurationSecs

Type: int

The duration of time in seconds to retry sending the ACK.

MessageType

Type: string

Sidewalk device message type. Default value is CUSTOM_COMMAND_ID_NOTIFY.

Seq

Type: int

The sequence number.

SidewalkSingleStartImportInfo

Description

Information about an import task created for an individual Sidewalk device.

Members

SidewalkManufacturingSn

Type: string

The Sidewalk manufacturing serial number (SMSN) of the device added to the import task.

SidewalkStartImportInfo

Description

Information about an import task created for bulk provisioning.

Members

DeviceCreationFile

Type: string

The CSV file contained in an S3 bucket that's used for adding devices to an import task.

Role

Type: string

The IAM role that allows AWS IoT Wireless to access the CSV file in the S3 bucket.

SidewalkUpdateAccount

Description

Sidewalk update.

Members

AppServerPrivateKey

Type: string

The new Sidewalk application server private key.

SidewalkUpdateImportInfo

Description

Sidewalk object information for updating an import task.

Members

DeviceCreationFile

Type: string

The CSV file contained in an S3 bucket that's used for appending devices to an existing import task.

SummaryMetricConfiguration

Description

The configuration of summary metrics.

Members

Status

Type: string

The status of the configuration of summary metrics.

SummaryMetricQuery

Description

The summary metric query object.

Members

AggregationPeriod

Type: string

The aggregation period of the summary metric.

Dimensions

Type: Array of Dimension structures

The dimensions of the summary metric.

EndTimestamp

Type: timestamp (string|DateTime or anything parsable by strtotime)

The end timestamp for the summary metric query.

MetricName

Type: string

The name of the metric.

QueryId

Type: string

The id of the summary metric query.

StartTimestamp

Type: timestamp (string|DateTime or anything parsable by strtotime)

The start timestamp for the summary metric query.

SummaryMetricQueryResult

Description

The result of the summary metrics aggregation operation.

Members

AggregationPeriod

Type: string

The aggregation period of the metric.

Dimensions

Type: Array of Dimension structures

The dimensions of the metric.

EndTimestamp

Type: timestamp (string|DateTime or anything parsable by strtotime)

The end timestamp for the summary metric query.

Error

Type: string

The error message for the summary metric query result.

MetricName

Type: string

The name of the summary metric query result.

QueryId

Type: string

The ID of the summary metric results query operation.

QueryStatus

Type: string

The status of the summary metric query result.

StartTimestamp

Type: timestamp (string|DateTime or anything parsable by strtotime)

The start timestamp for the summary metric query.

Timestamps

Type: Array of timestamp (string|DateTime or anything parsable by strtotime)s

The timestamp of each aggregation result.

Unit

Type: string

The units of measurement to be used for interpreting the aggregation result.

Values

Type: Array of MetricQueryValue structures

The list of aggregated summary metric query results.

TdscdmaLocalId

Description

TD-SCDMA local identification (local Id) information.

Members

CellParams

Required: Yes
Type: int

Cell parameters for TD-SCDMA.

Uarfcn

Required: Yes
Type: int

TD-SCDMA UTRA (Universal Terrestrial Radio Access Network) absolute RF channel number (UARFCN).

TdscdmaNmrObj

Description

TD-SCDMA object for network measurement reports.

Members

CellParams

Required: Yes
Type: int

Cell parameters for TD-SCDMA network measurement reports object.

PathLoss

Type: int

Path loss, or path attenuation, is the reduction in power density of an electromagnetic wave as it propagates through space.

Rscp

Type: int

Code power of the received signal, measured in decibel-milliwatts (dBm).

Uarfcn

Required: Yes
Type: int

TD-SCDMA UTRA (Universal Terrestrial Radio Access Network) absolute RF channel number.

UtranCid

Type: int

UTRAN (UMTS Terrestrial Radio Access Network) cell global identifier.

TdscdmaObj

Description

TD-SCDMA object.

Members

Lac

Type: int

Location Area Code.

Mcc

Required: Yes
Type: int

Mobile Country Code.

Mnc

Required: Yes
Type: int

Mobile Network Code.

PathLoss

Type: int

Path loss, or path attenuation, is the reduction in power density of an electromagnetic wave as it propagates through space.

Rscp

Type: int

Signal power of the received signal (Received Signal Code Power), measured in decibel-milliwatts (dBm).

TdscdmaLocalId

Type: TdscdmaLocalId structure

TD-SCDMA local identification (local ID) information.

TdscdmaNmr

Type: Array of TdscdmaNmrObj structures

TD-SCDMA object for network measurement reports.

TdscdmaTimingAdvance

Type: int

TD-SCDMA Timing advance.

UtranCid

Required: Yes
Type: int

UTRAN (UMTS Terrestrial Radio Access Network) Cell Global Identifier.

ThrottlingException

Description

The request was denied because it exceeded the allowed API request rate.

Members

Message

Type: string

TooManyTagsException

Description

The request was denied because the resource can't have any more tags.

Members

Message

Type: string

ResourceName

Type: string

Name of the resource that exceeds maximum number of tags allowed.

TraceContent

Description

Trace content for your wireless devices, gateways, and multicast groups.

Members

LogLevel

Type: string

The log level for a log message. The log levels can be disabled, or set to ERROR to display less verbose logs containing only error information, or to INFO for more detailed logs.

MulticastFrameInfo

Type: string

FrameInfo of your multicast group resources for the trace content. Use FrameInfo to debug the multicast communication between your multicast groups and the network server.

WirelessDeviceFrameInfo

Type: string

FrameInfo of your wireless device resources for the trace content. Use FrameInfo to debug the communication between your LoRaWAN end devices and the network server.

UpdateAbpV1_0_x

Description

ABP device object for LoRaWAN specification v1.0.x

Members

FCntStart

Type: int

The FCnt init value.

UpdateAbpV1_1

Description

ABP device object for LoRaWAN specification v1.1

Members

FCntStart

Type: int

The FCnt init value.

UpdateFPorts

Description

Object for updating the FPorts information.

Members

Applications

Type: Array of ApplicationConfig structures

LoRaWAN application, which can be used for geolocation by activating positioning.

Positioning

Type: Positioning structure

Positioning FPorts for the ClockSync, Stream, and GNSS functions.

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

Description

The input did not meet the specified constraints.

Members

Message

Type: string

WcdmaLocalId

Description

WCDMA local identification (local ID) information.

Members

Psc

Required: Yes
Type: int

Primary Scrambling Code.

Uarfcndl

Required: Yes
Type: int

WCDMA UTRA Absolute RF Channel Number downlink.

WcdmaNmrObj

Description

Network Measurement Reports.

Members

PathLoss

Type: int

Path loss, or path attenuation, is the reduction in power density of an electromagnetic wave as it propagates through space.

Psc

Required: Yes
Type: int

Primary Scrambling Code.

Rscp

Type: int

Received Signal Code Power (signal power) (dBm)

Uarfcndl

Required: Yes
Type: int

WCDMA UTRA Absolute RF Channel Number downlink.

UtranCid

Required: Yes
Type: int

UTRAN (UMTS Terrestrial Radio Access Network) Cell Global Identifier.

WcdmaObj

Description

WCDMA.

Members

Lac

Type: int

Location Area Code.

Mcc

Required: Yes
Type: int

Mobile Country Code.

Mnc

Required: Yes
Type: int

Mobile Network Code.

PathLoss

Type: int

Path loss, or path attenuation, is the reduction in power density of an electromagnetic wave as it propagates through space.

Rscp

Type: int

Received Signal Code Power (signal power) (dBm).

UtranCid

Required: Yes
Type: int

UTRAN (UMTS Terrestrial Radio Access Network) Cell Global Identifier.

WcdmaLocalId

Type: WcdmaLocalId structure

WCDMA local ID information.

WcdmaNmr

Type: Array of WcdmaNmrObj structures

WCDMA object for network measurement reports.

WiFiAccessPoint

Description

Wi-Fi access point.

Members

MacAddress

Required: Yes
Type: string

Wi-Fi MAC Address.

Rss

Required: Yes
Type: int

Received signal strength (dBm) of the WLAN measurement data.

WirelessDeviceEventLogOption

Description

The log options for a wireless device event and can be used to set log levels for a specific wireless device event.

For a LoRaWAN device, possible events for a log messsage are: Join, Rejoin, Downlink_Data, and Uplink_Data. For a Sidewalk device, possible events for a log message are Registration, Downlink_Data, and Uplink_Data.

Members

Event

Required: Yes
Type: string

The event for a log message, if the log message is tied to a wireless device.

LogLevel

Required: Yes
Type: string

The log level for a log message. The log levels can be disabled, or set to ERROR to display less verbose logs containing only error information, or to INFO for more detailed logs.

WirelessDeviceImportTask

Description

Information about an import task for wireless devices.

Members

Arn

Type: string

The ARN (Amazon Resource Name) of the wireless device import task.

CreationTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the import task was created.

DestinationName

Type: string

The name of the Sidewalk destination that that describes the IoT rule to route messages from the device in the import task that will be onboarded to AWS IoT Wireless

FailedImportedDeviceCount

Type: long (int|float)

The summary information of count of wireless devices in an import task that failed to onboarded to the import task.

Id

Type: string

The ID of the wireless device import task.

InitializedImportedDeviceCount

Type: long (int|float)

The summary information of count of wireless devices that are waiting for the control log to be added to an import task.

OnboardedImportedDeviceCount

Type: long (int|float)

The summary information of count of wireless devices in an import task that have been onboarded to the import task.

PendingImportedDeviceCount

Type: long (int|float)

The summary information of count of wireless devices in an import task that are waiting in the queue to be onboarded.

Sidewalk

Type: SidewalkGetStartImportInfo structure

The Sidewalk-related information of the wireless device import task.

Status

Type: string

The status information of the wireless device import task.

StatusReason

Type: string

The reason that provides additional information about the import task status.

WirelessDeviceLogOption

Description

The log options for wireless devices and can be used to set log levels for a specific type of wireless device.

Members

Events

Type: Array of WirelessDeviceEventLogOption structures

The list of wireless device event log options.

LogLevel

Required: Yes
Type: string

The log level for a log message. The log levels can be disabled, or set to ERROR to display less verbose logs containing only error information, or to INFO for more detailed logs.

Type

Required: Yes
Type: string

The wireless device type.

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.

FuotaDeviceStatus

Type: string

The status of a wireless device in a FUOTA task.

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.

Theis value is only valid for 3 months.

LoRaWAN

Type: LoRaWANListDevice structure

LoRaWAN device info.

McGroupId

Type: int

Id of the multicast group.

MulticastDeviceStatus

Type: string

The status of the wireless device in the multicast group.

Name

Type: string

The name of the resource.

Sidewalk

Type: SidewalkListDevice structure

The Sidewalk account credentials.

Type

Type: string

The wireless device type.

WirelessGatewayEventLogOption

Description

The log options for a wireless gateway event and can be used to set log levels for a specific wireless gateway event.

For a LoRaWAN gateway, possible events for a log message are CUPS_Request and Certificate.

Members

Event

Required: Yes
Type: string

The event for a log message, if the log message is tied to a wireless gateway.

LogLevel

Required: Yes
Type: string

The log level for a log message. The log levels can be disabled, or set to ERROR to display less verbose logs containing only error information, or to INFO for more detailed logs.

WirelessGatewayLogOption

Description

The log options for wireless gateways and can be used to set log levels for a specific type of wireless gateway.

Members

Events

Type: Array of WirelessGatewayEventLogOption structures

The list of wireless gateway event log options.

LogLevel

Required: Yes
Type: string

The log level for a log message. The log levels can be disabled, or set to ERROR to display less verbose logs containing only error information, or to INFO for more detailed logs.

Type

Required: Yes
Type: string

The wireless gateway 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.

This value is only valid for 3 months.

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.

AWS IoT Wireless 2020-11-22

Operation Summary

Paginators

Operations

AssociateAwsAccountWithPartnerAccount

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

AssociateMulticastGroupWithFuotaTask

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

AssociateWirelessDeviceWithFuotaTask

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

AssociateWirelessDeviceWithMulticastGroup

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

AssociateWirelessDeviceWithThing

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

AssociateWirelessGatewayWithCertificate

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

AssociateWirelessGatewayWithThing

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

CancelMulticastGroupSession

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

CreateDestination

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateDeviceProfile

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateFuotaTask

Parameter Syntax