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

Result Syntax

[
    'Arn' => '<string>',
    'Sidewalk' => [
        'AmazonId' => '<string>',
        'AppServerPrivateKey' => '<string>',
    ],
]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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.

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[
    'Arn' => '<string>',
    'Description' => '<string>',
    'Expression' => '<string>',
    'ExpressionType' => 'RuleName|MqttTopic',
    'Name' => '<string>',
    'RoleArn' => '<string>',
]

Result Details

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

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

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

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

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

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

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

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

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

Result Syntax

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

Result Details

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|DeviceRoamingRSSI|DeviceRoamingSNR|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

Result Syntax

[
    'SummaryMetricQueryResults' => [
        [
            'AggregationPeriod' => 'OneHour|OneDay|OneWeek',
            'Dimensions' => [
                [
                    'name' => 'DeviceId|GatewayId',
                    'value' => '<string>',
                ],
                // ...
            ],
            'EndTimestamp' => <DateTime>,
            'Error' => '<string>',
            'MetricName' => 'DeviceRSSI|DeviceSNR|DeviceRoamingRSSI|DeviceRoamingSNR|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

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

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

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

Result Syntax

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

Result Details

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

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

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

Result Syntax

[
    'AccountLinked' => true || false,
    'Sidewalk' => [
        'AmazonId' => '<string>',
        'Arn' => '<string>',
        'Fingerprint' => '<string>',
    ],
]

Result Details

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.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

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

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

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

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

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

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

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

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

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

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

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

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

Result Syntax

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

Result Details

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

Result Syntax

[
    'LoRaWAN' => [
        'CurrentVersion' => [
            'Model' => '<string>',
            'PackageVersion' => '<string>',
            'Station' => '<string>',
        ],
    ],
]

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

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

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

Result Syntax

[
    'DestinationList' => [
        [
            'Arn' => '<string>',
            'Description' => '<string>',
            'Expression' => '<string>',
            'ExpressionType' => 'RuleName|MqttTopic',
            'Name' => '<string>',
            'RoleArn' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

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

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

Result Syntax

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

Result Details

Errors