Table of Contents
IoTWireless.
Client
¶A low-level client representing AWS IoT Wireless
AWS IoT Wireless API documentation
client = session.create_client('iotwireless')
These are the available methods:
associate_aws_account_with_partner_account
(**kwargs)¶Associates a partner account with your AWS account.
See also: AWS API Documentation
Request Syntax
response = client.associate_aws_account_with_partner_account(
Sidewalk={
'AmazonId': 'string',
'AppServerPrivateKey': 'string'
},
ClientRequestToken='string'
)
Sidewalk (dict) –
[REQUIRED]
The Sidewalk account credentials.
AmazonId (string) –
The Sidewalk Amazon ID.
AppServerPrivateKey (string) –
The Sidewalk application server private key.
ClientRequestToken (string) –
Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.
This field is autopopulated if not provided.
dict
Response Syntax
{
'Sidewalk': {
'AmazonId': 'string',
'AppServerPrivateKey': 'string'
}
}
Response Structure
(dict) –
Sidewalk (dict) –
The Sidewalk account credentials.
AmazonId (string) –
The Sidewalk Amazon ID.
AppServerPrivateKey (string) –
The Sidewalk application server private key.
Exceptions
associate_wireless_device_with_thing
(**kwargs)¶Associates a wireless device with a thing.
See also: AWS API Documentation
Request Syntax
response = client.associate_wireless_device_with_thing(
Id='string',
ThingArn='string'
)
Id (string) –
[REQUIRED]
The ID of the resource to update.
ThingArn (string) –
[REQUIRED]
The ARN of the thing to associate with the wireless device.
dict
Response Syntax
{}
Response Structure
(dict) –
Exceptions
associate_wireless_gateway_with_certificate
(**kwargs)¶Associates a wireless gateway with a certificate.
See also: AWS API Documentation
Request Syntax
response = client.associate_wireless_gateway_with_certificate(
Id='string',
IotCertificateId='string'
)
Id (string) –
[REQUIRED]
The ID of the resource to update.
IotCertificateId (string) –
[REQUIRED]
The ID of the certificate to associate with the wireless gateway.
dict
Response Syntax
{
'IotCertificateId': 'string'
}
Response Structure
(dict) –
IotCertificateId (string) –
The ID of the certificate associated with the wireless gateway.
Exceptions
associate_wireless_gateway_with_thing
(**kwargs)¶Associates a wireless gateway with a thing.
See also: AWS API Documentation
Request Syntax
response = client.associate_wireless_gateway_with_thing(
Id='string',
ThingArn='string'
)
Id (string) –
[REQUIRED]
The ID of the resource to update.
ThingArn (string) –
[REQUIRED]
The ARN of the thing to associate with the wireless gateway.
dict
Response Syntax
{}
Response Structure
(dict) –
Exceptions
can_paginate
(operation_name)¶Check if an operation can be paginated.
operation_name (string) – The operation name. This is the same name
as the method name on the client. For example, if the
method name is create_foo
, and you’d normally invoke the
operation as client.create_foo(**kwargs)
, if the
create_foo
operation can be paginated, you can use the
call client.get_paginator("create_foo")
.
True
if the operation can be paginated,
False
otherwise.
create_destination
(**kwargs)¶Creates a new destination that maps a device message to an AWS IoT rule.
See also: AWS API Documentation
Request Syntax
response = client.create_destination(
Name='string',
ExpressionType='RuleName'|'MqttTopic',
Expression='string',
Description='string',
RoleArn='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
ClientRequestToken='string'
)
Name (string) –
[REQUIRED]
The name of the new resource.
ExpressionType (string) –
[REQUIRED]
The type of value in Expression
.
Expression (string) –
[REQUIRED]
The rule name or topic rule to send messages to.
Description (string) – The description of the new resource.
RoleArn (string) –
[REQUIRED]
The ARN of the IAM Role that authorizes the destination.
Tags (list) –
The tags to attach to the new destination. Tags are metadata that can be used to manage a resource.
(dict) –
A simple label consisting of a customer-defined key-value pair
Key (string) – [REQUIRED]
The tag’s key value.
Value (string) – [REQUIRED]
The tag’s value.
ClientRequestToken (string) –
Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.
This field is autopopulated if not provided.
dict
Response Syntax
{
'Arn': 'string',
'Name': 'string'
}
Response Structure
(dict) –
Arn (string) –
The Amazon Resource Name of the new resource.
Name (string) –
The name of the new resource.
Exceptions
create_device_profile
(**kwargs)¶Creates a new device profile.
See also: AWS API Documentation
Request Syntax
response = client.create_device_profile(
Name='string',
LoRaWAN={
'SupportsClassB': True|False,
'ClassBTimeout': 123,
'PingSlotPeriod': 123,
'PingSlotDr': 123,
'PingSlotFreq': 123,
'SupportsClassC': True|False,
'ClassCTimeout': 123,
'MacVersion': 'string',
'RegParamsRevision': 'string',
'RxDelay1': 123,
'RxDrOffset1': 123,
'RxDataRate2': 123,
'RxFreq2': 123,
'FactoryPresetFreqsList': [
123,
],
'MaxEirp': 123,
'MaxDutyCycle': 123,
'RfRegion': 'string',
'SupportsJoin': True|False,
'Supports32BitFCnt': True|False
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
ClientRequestToken='string'
)
Name (string) – The name of the new resource.
LoRaWAN (dict) –
The device profile information to use to create the device profile.
SupportsClassB (boolean) –
The SupportsClassB value.
ClassBTimeout (integer) –
The ClassBTimeout value.
PingSlotPeriod (integer) –
The PingSlotPeriod value.
PingSlotDr (integer) –
The PingSlotDR value.
PingSlotFreq (integer) –
The PingSlotFreq value.
SupportsClassC (boolean) –
The SupportsClassC value.
ClassCTimeout (integer) –
The ClassCTimeout value.
MacVersion (string) –
The MAC version (such as OTAA 1.1 or OTAA 1.0.3) to use with this device profile.
RegParamsRevision (string) –
The version of regional parameters.
RxDelay1 (integer) –
The RXDelay1 value.
RxDrOffset1 (integer) –
The RXDROffset1 value.
RxDataRate2 (integer) –
The RXDataRate2 value.
RxFreq2 (integer) –
The RXFreq2 value.
FactoryPresetFreqsList (list) –
The list of values that make up the FactoryPresetFreqs value.
(integer) –
MaxEirp (integer) –
The MaxEIRP value.
MaxDutyCycle (integer) –
The MaxDutyCycle value.
RfRegion (string) –
The frequency band (RFRegion) value.
SupportsJoin (boolean) –
The SupportsJoin value.
Supports32BitFCnt (boolean) –
The Supports32BitFCnt value.
Tags (list) –
The tags to attach to the new device profile Tags are metadata that can be used to manage a resource.
(dict) –
A simple label consisting of a customer-defined key-value pair
Key (string) – [REQUIRED]
The tag’s key value.
Value (string) – [REQUIRED]
The tag’s value.
ClientRequestToken (string) –
Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.
This field is autopopulated if not provided.
dict
Response Syntax
{
'Arn': 'string',
'Id': 'string'
}
Response Structure
(dict) –
Arn (string) –
The Amazon Resource Name of the new resource.
Id (string) –
The ID of the new device profile.
Exceptions
create_service_profile
(**kwargs)¶Creates a new service profile.
See also: AWS API Documentation
Request Syntax
response = client.create_service_profile(
Name='string',
LoRaWAN={
'AddGwMetadata': True|False
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
ClientRequestToken='string'
)
Name (string) – The name of the new resource.
LoRaWAN (dict) –
The service profile information to use to create the service profile.
AddGwMetadata (boolean) –
The AddGWMetaData value.
Tags (list) –
The tags to attach to the new service profile. Tags are metadata that can be used to manage a resource.
(dict) –
A simple label consisting of a customer-defined key-value pair
Key (string) – [REQUIRED]
The tag’s key value.
Value (string) – [REQUIRED]
The tag’s value.
ClientRequestToken (string) –
Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.
This field is autopopulated if not provided.
dict
Response Syntax
{
'Arn': 'string',
'Id': 'string'
}
Response Structure
(dict) –
Arn (string) –
The Amazon Resource Name of the new resource.
Id (string) –
The ID of the new service profile.
Exceptions
create_wireless_device
(**kwargs)¶Provisions a wireless device.
See also: AWS API Documentation
Request Syntax
response = client.create_wireless_device(
Type='Sidewalk'|'LoRaWAN',
Name='string',
Description='string',
DestinationName='string',
ClientRequestToken='string',
LoRaWAN={
'DevEui': 'string',
'DeviceProfileId': 'string',
'ServiceProfileId': 'string',
'OtaaV1_1': {
'AppKey': 'string',
'NwkKey': 'string',
'JoinEui': 'string'
},
'OtaaV1_0_x': {
'AppKey': 'string',
'AppEui': 'string'
},
'AbpV1_1': {
'DevAddr': 'string',
'SessionKeys': {
'FNwkSIntKey': 'string',
'SNwkSIntKey': 'string',
'NwkSEncKey': 'string',
'AppSKey': 'string'
}
},
'AbpV1_0_x': {
'DevAddr': 'string',
'SessionKeys': {
'NwkSKey': 'string',
'AppSKey': 'string'
}
}
}
)
Type (string) –
[REQUIRED]
The wireless device type.
Name (string) – The name of the new resource.
Description (string) – The description of the new resource.
DestinationName (string) –
[REQUIRED]
The name of the destination to assign to the new wireless device.
ClientRequestToken (string) –
Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.
This field is autopopulated if not provided.
LoRaWAN (dict) –
The device configuration information to use to create the wireless device.
DevEui (string) –
The DevEUI value.
DeviceProfileId (string) –
The ID of the device profile for the new wireless device.
ServiceProfileId (string) –
The ID of the service profile.
OtaaV1_1 (dict) –
OTAA device object for v1.1 for create APIs
AppKey (string) –
The AppKey value.
NwkKey (string) –
The NwkKey value.
JoinEui (string) –
The JoinEUI value.
OtaaV1_0_x (dict) –
OTAA device object for create APIs for v1.0.x
AppKey (string) –
The AppKey value.
AppEui (string) –
The AppEUI value.
AbpV1_1 (dict) –
ABP device object for create APIs for v1.1
DevAddr (string) –
The DevAddr value.
SessionKeys (dict) –
Session keys for ABP v1.1
FNwkSIntKey (string) –
The FNwkSIntKey value.
SNwkSIntKey (string) –
The SNwkSIntKey value.
NwkSEncKey (string) –
The NwkSEncKey value.
AppSKey (string) –
The AppSKey value.
AbpV1_0_x (dict) –
LoRaWAN object for create APIs
DevAddr (string) –
The DevAddr value.
SessionKeys (dict) –
Session keys for ABP v1.0.x
NwkSKey (string) –
The NwkSKey value.
AppSKey (string) –
The AppSKey value.
dict
Response Syntax
{
'Arn': 'string',
'Id': 'string'
}
Response Structure
(dict) –
Arn (string) –
The Amazon Resource Name of the new resource.
Id (string) –
The ID of the new wireless device.
Exceptions
create_wireless_gateway
(**kwargs)¶Provisions a wireless gateway.
See also: AWS API Documentation
Request Syntax
response = client.create_wireless_gateway(
Name='string',
Description='string',
LoRaWAN={
'GatewayEui': 'string',
'RfRegion': 'string'
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
ClientRequestToken='string'
)
Name (string) – The name of the new resource.
Description (string) – The description of the new resource.
LoRaWAN (dict) –
[REQUIRED]
The gateway configuration information to use to create the wireless gateway.
GatewayEui (string) –
The gateway’s EUI value.
RfRegion (string) –
The frequency band (RFRegion) value.
Tags (list) –
The tags to attach to the new wireless gateway. Tags are metadata that can be used to manage a resource.
(dict) –
A simple label consisting of a customer-defined key-value pair
Key (string) – [REQUIRED]
The tag’s key value.
Value (string) – [REQUIRED]
The tag’s value.
ClientRequestToken (string) –
Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.
This field is autopopulated if not provided.
dict
Response Syntax
{
'Arn': 'string',
'Id': 'string'
}
Response Structure
(dict) –
Arn (string) –
The Amazon Resource Name of the new resource.
Id (string) –
The ID of the new wireless gateway.
Exceptions
create_wireless_gateway_task
(**kwargs)¶Creates a task for a wireless gateway.
See also: AWS API Documentation
Request Syntax
response = client.create_wireless_gateway_task(
Id='string',
WirelessGatewayTaskDefinitionId='string'
)
Id (string) –
[REQUIRED]
The ID of the resource to update.
WirelessGatewayTaskDefinitionId (string) –
[REQUIRED]
The ID of the WirelessGatewayTaskDefinition.
dict
Response Syntax
{
'WirelessGatewayTaskDefinitionId': 'string',
'Status': 'PENDING'|'IN_PROGRESS'|'FIRST_RETRY'|'SECOND_RETRY'|'COMPLETED'|'FAILED'
}
Response Structure
(dict) –
WirelessGatewayTaskDefinitionId (string) –
The ID of the WirelessGatewayTaskDefinition.
Status (string) –
The status of the request.
Exceptions
create_wireless_gateway_task_definition
(**kwargs)¶Creates a gateway task definition.
See also: AWS API Documentation
Request Syntax
response = client.create_wireless_gateway_task_definition(
AutoCreateTasks=True|False,
Name='string',
Update={
'UpdateDataSource': 'string',
'UpdateDataRole': 'string',
'LoRaWAN': {
'UpdateSignature': 'string',
'SigKeyCrc': 123,
'CurrentVersion': {
'PackageVersion': 'string',
'Model': 'string',
'Station': 'string'
},
'UpdateVersion': {
'PackageVersion': 'string',
'Model': 'string',
'Station': 'string'
}
}
},
ClientRequestToken='string'
)
AutoCreateTasks (boolean) –
[REQUIRED]
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 (string) – The name of the new resource.
Update (dict) –
Information about the gateways to update.
UpdateDataSource (string) –
The link to the S3 bucket.
UpdateDataRole (string) –
The IAM role used to read data from the S3 bucket.
LoRaWAN (dict) –
The properties that relate to the LoRaWAN wireless gateway.
UpdateSignature (string) –
The signature used to verify the update firmware.
SigKeyCrc (integer) –
The CRC of the signature private key to check.
CurrentVersion (dict) –
The version of the gateways that should receive the update.
PackageVersion (string) –
The version of the wireless gateway firmware.
Model (string) –
The model number of the wireless gateway.
Station (string) –
The basic station version of the wireless gateway.
UpdateVersion (dict) –
The firmware version to update the gateway to.
PackageVersion (string) –
The version of the wireless gateway firmware.
Model (string) –
The model number of the wireless gateway.
Station (string) –
The basic station version of the wireless gateway.
ClientRequestToken (string) –
Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.
This field is autopopulated if not provided.
dict
Response Syntax
{
'Id': 'string'
}
Response Structure
(dict) –
Id (string) –
The ID of the new wireless gateway task definition.
Exceptions
delete_destination
(**kwargs)¶Deletes a destination.
See also: AWS API Documentation
Request Syntax
response = client.delete_destination(
Name='string'
)
Name (string) –
[REQUIRED]
The name of the resource to delete.
dict
Response Syntax
{}
Response Structure
(dict) –
Exceptions
delete_device_profile
(**kwargs)¶Deletes a device profile.
See also: AWS API Documentation
Request Syntax
response = client.delete_device_profile(
Id='string'
)
Id (string) –
[REQUIRED]
The ID of the resource to delete.
dict
Response Syntax
{}
Response Structure
(dict) –
Exceptions
delete_service_profile
(**kwargs)¶Deletes a service profile.
See also: AWS API Documentation
Request Syntax
response = client.delete_service_profile(
Id='string'
)
Id (string) –
[REQUIRED]
The ID of the resource to delete.
dict
Response Syntax
{}
Response Structure
(dict) –
Exceptions
delete_wireless_device
(**kwargs)¶Deletes a wireless device.
See also: AWS API Documentation
Request Syntax
response = client.delete_wireless_device(
Id='string'
)
Id (string) –
[REQUIRED]
The ID of the resource to delete.
dict
Response Syntax
{}
Response Structure
(dict) –
Exceptions
delete_wireless_gateway
(**kwargs)¶Deletes a wireless gateway.
See also: AWS API Documentation
Request Syntax
response = client.delete_wireless_gateway(
Id='string'
)
Id (string) –
[REQUIRED]
The ID of the resource to delete.
dict
Response Syntax
{}
Response Structure
(dict) –
Exceptions
delete_wireless_gateway_task
(**kwargs)¶Deletes a wireless gateway task.
See also: AWS API Documentation
Request Syntax
response = client.delete_wireless_gateway_task(
Id='string'
)
Id (string) –
[REQUIRED]
The ID of the resource to delete.
dict
Response Syntax
{}
Response Structure
(dict) –
Exceptions
delete_wireless_gateway_task_definition
(**kwargs)¶Deletes a wireless gateway task definition. Deleting this task definition does not affect tasks that are currently in progress.
See also: AWS API Documentation
Request Syntax
response = client.delete_wireless_gateway_task_definition(
Id='string'
)
Id (string) –
[REQUIRED]
The ID of the resource to delete.
dict
Response Syntax
{}
Response Structure
(dict) –
Exceptions
disassociate_aws_account_from_partner_account
(**kwargs)¶Disassociates your AWS account from a partner account. If PartnerAccountId
and PartnerType
are null
, disassociates your AWS account from all partner accounts.
See also: AWS API Documentation
Request Syntax
response = client.disassociate_aws_account_from_partner_account(
PartnerAccountId='string',
PartnerType='Sidewalk'
)
PartnerAccountId (string) –
[REQUIRED]
The partner account ID to disassociate from the AWS account.
PartnerType (string) –
[REQUIRED]
The partner type.
dict
Response Syntax
{}
Response Structure
(dict) –
Exceptions
disassociate_wireless_device_from_thing
(**kwargs)¶Disassociates a wireless device from its currently associated thing.
See also: AWS API Documentation
Request Syntax
response = client.disassociate_wireless_device_from_thing(
Id='string'
)
Id (string) –
[REQUIRED]
The ID of the resource to update.
dict
Response Syntax
{}
Response Structure
(dict) –
Exceptions
disassociate_wireless_gateway_from_certificate
(**kwargs)¶Disassociates a wireless gateway from its currently associated certificate.
See also: AWS API Documentation
Request Syntax
response = client.disassociate_wireless_gateway_from_certificate(
Id='string'
)
Id (string) –
[REQUIRED]
The ID of the resource to update.
dict
Response Syntax
{}
Response Structure
(dict) –
Exceptions
disassociate_wireless_gateway_from_thing
(**kwargs)¶Disassociates a wireless gateway from its currently associated thing.
See also: AWS API Documentation
Request Syntax
response = client.disassociate_wireless_gateway_from_thing(
Id='string'
)
Id (string) –
[REQUIRED]
The ID of the resource to update.
dict
Response Syntax
{}
Response Structure
(dict) –
Exceptions
generate_presigned_url
(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)¶Generate a presigned url given a client, its method, and arguments
ClientMethod (string) – The client method to presign for
Params (dict) – The parameters normally passed to
ClientMethod
.
ExpiresIn (int) – The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
HttpMethod (string) – The http method to use on the generated url. By default, the http method is whatever is used in the method’s model.
The presigned url
get_destination
(**kwargs)¶Gets information about a destination.
See also: AWS API Documentation
Request Syntax
response = client.get_destination(
Name='string'
)
Name (string) –
[REQUIRED]
The name of the resource to get.
dict
Response Syntax
{
'Arn': 'string',
'Name': 'string',
'Expression': 'string',
'ExpressionType': 'RuleName'|'MqttTopic',
'Description': 'string',
'RoleArn': 'string'
}
Response Structure
(dict) –
Arn (string) –
The Amazon Resource Name of the resource.
Name (string) –
The name of the resource.
Expression (string) –
The rule name or topic rule to send messages to.
ExpressionType (string) –
The type of value in Expression
.
Description (string) –
The description of the resource.
RoleArn (string) –
The ARN of the IAM Role that authorizes the destination.
Exceptions
get_device_profile
(**kwargs)¶Gets information about a device profile.
See also: AWS API Documentation
Request Syntax
response = client.get_device_profile(
Id='string'
)
Id (string) –
[REQUIRED]
The ID of the resource to get.
dict
Response Syntax
{
'Arn': 'string',
'Name': 'string',
'Id': 'string',
'LoRaWAN': {
'SupportsClassB': True|False,
'ClassBTimeout': 123,
'PingSlotPeriod': 123,
'PingSlotDr': 123,
'PingSlotFreq': 123,
'SupportsClassC': True|False,
'ClassCTimeout': 123,
'MacVersion': 'string',
'RegParamsRevision': 'string',
'RxDelay1': 123,
'RxDrOffset1': 123,
'RxDataRate2': 123,
'RxFreq2': 123,
'FactoryPresetFreqsList': [
123,
],
'MaxEirp': 123,
'MaxDutyCycle': 123,
'RfRegion': 'string',
'SupportsJoin': True|False,
'Supports32BitFCnt': True|False
}
}
Response Structure
(dict) –
Arn (string) –
The Amazon Resource Name of the resource.
Name (string) –
The name of the resource.
Id (string) –
The ID of the device profile.
LoRaWAN (dict) –
Information about the device profile.
SupportsClassB (boolean) –
The SupportsClassB value.
ClassBTimeout (integer) –
The ClassBTimeout value.
PingSlotPeriod (integer) –
The PingSlotPeriod value.
PingSlotDr (integer) –
The PingSlotDR value.
PingSlotFreq (integer) –
The PingSlotFreq value.
SupportsClassC (boolean) –
The SupportsClassC value.
ClassCTimeout (integer) –
The ClassCTimeout value.
MacVersion (string) –
The MAC version (such as OTAA 1.1 or OTAA 1.0.3) to use with this device profile.
RegParamsRevision (string) –
The version of regional parameters.
RxDelay1 (integer) –
The RXDelay1 value.
RxDrOffset1 (integer) –
The RXDROffset1 value.
RxDataRate2 (integer) –
The RXDataRate2 value.
RxFreq2 (integer) –
The RXFreq2 value.
FactoryPresetFreqsList (list) –
The list of values that make up the FactoryPresetFreqs value.
(integer) –
MaxEirp (integer) –
The MaxEIRP value.
MaxDutyCycle (integer) –
The MaxDutyCycle value.
RfRegion (string) –
The frequency band (RFRegion) value.
SupportsJoin (boolean) –
The SupportsJoin value.
Supports32BitFCnt (boolean) –
The Supports32BitFCnt value.
Exceptions
get_paginator
(operation_name)¶Create a paginator for an operation.
operation_name (string) – The operation name. This is the same name
as the method name on the client. For example, if the
method name is create_foo
, and you’d normally invoke the
operation as client.create_foo(**kwargs)
, if the
create_foo
operation can be paginated, you can use the
call client.get_paginator("create_foo")
.
OperationNotPageableError – Raised if the operation is not
pageable. You can use the client.can_paginate
method to
check if an operation is pageable.
L{botocore.paginate.Paginator}
A paginator object.
get_partner_account
(**kwargs)¶Gets information about a partner account. If PartnerAccountId
and PartnerType
are null
, returns all partner accounts.
See also: AWS API Documentation
Request Syntax
response = client.get_partner_account(
PartnerAccountId='string',
PartnerType='Sidewalk'
)
PartnerAccountId (string) –
[REQUIRED]
The partner account ID to disassociate from the AWS account.
PartnerType (string) –
[REQUIRED]
The partner type.
dict
Response Syntax
{
'Sidewalk': {
'AmazonId': 'string',
'Fingerprint': 'string'
},
'AccountLinked': True|False
}
Response Structure
(dict) –
Sidewalk (dict) –
The Sidewalk account credentials.
AmazonId (string) –
The Sidewalk Amazon ID.
Fingerprint (string) –
The fingerprint of the Sidewalk application server private key.
AccountLinked (boolean) –
Whether the partner account is linked to the AWS account.
Exceptions
get_service_endpoint
(**kwargs)¶Gets the account-specific endpoint for Configuration and Update Server (CUPS) protocol or LoRaWAN Network Server (LNS) connections.
See also: AWS API Documentation
Request Syntax
response = client.get_service_endpoint(
ServiceType='CUPS'|'LNS'
)
ServiceType (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.
dict
Response Syntax
{
'ServiceType': 'CUPS'|'LNS',
'ServiceEndpoint': 'string',
'ServerTrust': 'string'
}
Response Structure
(dict) –
ServiceType (string) –
The endpoint’s service type.
ServiceEndpoint (string) –
The service endpoint value.
ServerTrust (string) –
The Root CA of the server trust certificate.
Exceptions
get_service_profile
(**kwargs)¶Gets information about a service profile.
See also: AWS API Documentation
Request Syntax
response = client.get_service_profile(
Id='string'
)
Id (string) –
[REQUIRED]
The ID of the resource to get.
dict
Response Syntax
{
'Arn': 'string',
'Name': 'string',
'Id': 'string',
'LoRaWAN': {
'UlRate': 123,
'UlBucketSize': 123,
'UlRatePolicy': 'string',
'DlRate': 123,
'DlBucketSize': 123,
'DlRatePolicy': 'string',
'AddGwMetadata': True|False,
'DevStatusReqFreq': 123,
'ReportDevStatusBattery': True|False,
'ReportDevStatusMargin': True|False,
'DrMin': 123,
'DrMax': 123,
'ChannelMask': 'string',
'PrAllowed': True|False,
'HrAllowed': True|False,
'RaAllowed': True|False,
'NwkGeoLoc': True|False,
'TargetPer': 123,
'MinGwDiversity': 123
}
}
Response Structure
(dict) –
Arn (string) –
The Amazon Resource Name of the resource.
Name (string) –
The name of the resource.
Id (string) –
The ID of the service profile.
LoRaWAN (dict) –
Information about the service profile.
UlRate (integer) –
The ULRate value.
UlBucketSize (integer) –
The ULBucketSize value.
UlRatePolicy (string) –
The ULRatePolicy value.
DlRate (integer) –
The DLRate value.
DlBucketSize (integer) –
The DLBucketSize value.
DlRatePolicy (string) –
The DLRatePolicy value.
AddGwMetadata (boolean) –
The AddGWMetaData value.
DevStatusReqFreq (integer) –
The DevStatusReqFreq value.
ReportDevStatusBattery (boolean) –
The ReportDevStatusBattery value.
ReportDevStatusMargin (boolean) –
The ReportDevStatusMargin value.
DrMin (integer) –
The DRMin value.
DrMax (integer) –
The DRMax value.
ChannelMask (string) –
The ChannelMask value.
PrAllowed (boolean) –
The PRAllowed value that describes whether passive roaming is allowed.
HrAllowed (boolean) –
The HRAllowed value that describes whether handover roaming is allowed.
RaAllowed (boolean) –
The RAAllowed value that describes whether roaming activation is allowed.
NwkGeoLoc (boolean) –
The NwkGeoLoc value.
TargetPer (integer) –
The TargetPER value.
MinGwDiversity (integer) –
The MinGwDiversity value.
Exceptions
get_waiter
(waiter_name)¶Returns an object that can wait for some condition.
waiter_name (str) – The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
The specified waiter object.
botocore.waiter.Waiter
get_wireless_device
(**kwargs)¶Gets information about a wireless device.
See also: AWS API Documentation
Request Syntax
response = client.get_wireless_device(
Identifier='string',
IdentifierType='WirelessDeviceId'|'DevEui'|'ThingName'
)
Identifier (string) –
[REQUIRED]
The identifier of the wireless device to get.
IdentifierType (string) –
[REQUIRED]
The type of identifier used in identifier
.
dict
Response Syntax
{
'Type': 'Sidewalk'|'LoRaWAN',
'Name': 'string',
'Description': 'string',
'DestinationName': 'string',
'Id': 'string',
'Arn': 'string',
'ThingName': 'string',
'ThingArn': 'string',
'LoRaWAN': {
'DevEui': 'string',
'DeviceProfileId': 'string',
'ServiceProfileId': 'string',
'OtaaV1_1': {
'AppKey': 'string',
'NwkKey': 'string',
'JoinEui': 'string'
},
'OtaaV1_0_x': {
'AppKey': 'string',
'AppEui': 'string'
},
'AbpV1_1': {
'DevAddr': 'string',
'SessionKeys': {
'FNwkSIntKey': 'string',
'SNwkSIntKey': 'string',
'NwkSEncKey': 'string',
'AppSKey': 'string'
}
},
'AbpV1_0_x': {
'DevAddr': 'string',
'SessionKeys': {
'NwkSKey': 'string',
'AppSKey': 'string'
}
}
}
}
Response Structure
(dict) –
Type (string) –
The wireless device type.
Name (string) –
The name of the resource.
Description (string) –
The description of the resource.
DestinationName (string) –
The name of the destination to which the device is assigned.
Id (string) –
The ID of the wireless device.
Arn (string) –
The Amazon Resource Name of the resource.
ThingName (string) –
The name of the thing associated with the wireless device. The value is empty if a thing isn’t associated with the device.
ThingArn (string) –
The ARN of the thing associated with the wireless device.
LoRaWAN (dict) –
Information about the wireless device.
DevEui (string) –
The DevEUI value.
DeviceProfileId (string) –
The ID of the device profile for the new wireless device.
ServiceProfileId (string) –
The ID of the service profile.
OtaaV1_1 (dict) –
OTAA device object for v1.1 for create APIs
AppKey (string) –
The AppKey value.
NwkKey (string) –
The NwkKey value.
JoinEui (string) –
The JoinEUI value.
OtaaV1_0_x (dict) –
OTAA device object for create APIs for v1.0.x
AppKey (string) –
The AppKey value.
AppEui (string) –
The AppEUI value.
AbpV1_1 (dict) –
ABP device object for create APIs for v1.1
DevAddr (string) –
The DevAddr value.
SessionKeys (dict) –
Session keys for ABP v1.1
FNwkSIntKey (string) –
The FNwkSIntKey value.
SNwkSIntKey (string) –
The SNwkSIntKey value.
NwkSEncKey (string) –
The NwkSEncKey value.
AppSKey (string) –
The AppSKey value.
AbpV1_0_x (dict) –
LoRaWAN object for create APIs
DevAddr (string) –
The DevAddr value.
SessionKeys (dict) –
Session keys for ABP v1.0.x
NwkSKey (string) –
The NwkSKey value.
AppSKey (string) –
The AppSKey value.
Exceptions
get_wireless_device_statistics
(**kwargs)¶Gets operating information about a wireless device.
See also: AWS API Documentation
Request Syntax
response = client.get_wireless_device_statistics(
WirelessDeviceId='string'
)
WirelessDeviceId (string) –
[REQUIRED]
The ID of the wireless device for which to get the data.
dict
Response Syntax
{
'WirelessDeviceId': 'string',
'LastUplinkReceivedAt': 'string',
'LoRaWAN': {
'DevEui': 'string',
'FPort': 123,
'DataRate': 123,
'Frequency': 123,
'Timestamp': 'string',
'Gateways': [
{
'GatewayEui': 'string',
'Snr': 123.0,
'Rssi': 123.0
},
]
}
}
Response Structure
(dict) –
WirelessDeviceId (string) –
The ID of the wireless device.
LastUplinkReceivedAt (string) –
The date and time when the most recent uplink was received.
LoRaWAN (dict) –
Information about the wireless device’s operations.
DevEui (string) –
The DevEUI value.
FPort (integer) –
The FPort value.
DataRate (integer) –
The DataRate value.
Frequency (integer) –
The device’s channel frequency in Hz.
Timestamp (string) –
The date and time of the metadata.
Gateways (list) –
Information about the gateways accessed by the device.
(dict) –
LoRaWAN gateway metatdata.
GatewayEui (string) –
The gateway’s EUI value.
Snr (float) –
The SNR value.
Rssi (float) –
The RSSI value.
Exceptions
get_wireless_gateway
(**kwargs)¶Gets information about a wireless gateway.
See also: AWS API Documentation
Request Syntax
response = client.get_wireless_gateway(
Identifier='string',
IdentifierType='GatewayEui'|'WirelessGatewayId'|'ThingName'
)
Identifier (string) –
[REQUIRED]
The identifier of the wireless gateway to get.
IdentifierType (string) –
[REQUIRED]
The type of identifier used in identifier
.
dict
Response Syntax
{
'Name': 'string',
'Id': 'string',
'Description': 'string',
'LoRaWAN': {
'GatewayEui': 'string',
'RfRegion': 'string'
},
'Arn': 'string',
'ThingName': 'string',
'ThingArn': 'string'
}
Response Structure
(dict) –
Name (string) –
The name of the resource.
Id (string) –
The ID of the wireless gateway.
Description (string) –
The description of the resource.
LoRaWAN (dict) –
Information about the wireless gateway.
GatewayEui (string) –
The gateway’s EUI value.
RfRegion (string) –
The frequency band (RFRegion) value.
Arn (string) –
The Amazon Resource Name of the resource.
ThingName (string) –
The name of the thing associated with the wireless gateway. The value is empty if a thing isn’t associated with the gateway.
ThingArn (string) –
The ARN of the thing associated with the wireless gateway.
Exceptions
get_wireless_gateway_certificate
(**kwargs)¶Gets the ID of the certificate that is currently associated with a wireless gateway.
See also: AWS API Documentation
Request Syntax
response = client.get_wireless_gateway_certificate(
Id='string'
)
Id (string) –
[REQUIRED]
The ID of the resource to get.
dict
Response Syntax
{
'IotCertificateId': 'string',
'LoRaWANNetworkServerCertificateId': 'string'
}
Response Structure
(dict) –
IotCertificateId (string) –
The ID of the certificate associated with the wireless gateway.
LoRaWANNetworkServerCertificateId (string) –
The ID of the certificate associated with the wireless gateway and used for LoRaWANNetworkServer endpoint.
Exceptions
get_wireless_gateway_firmware_information
(**kwargs)¶Gets the firmware version and other information about a wireless gateway.
See also: AWS API Documentation
Request Syntax
response = client.get_wireless_gateway_firmware_information(
Id='string'
)
Id (string) –
[REQUIRED]
The ID of the resource to get.
dict
Response Syntax
{
'LoRaWAN': {
'CurrentVersion': {
'PackageVersion': 'string',
'Model': 'string',
'Station': 'string'
}
}
}
Response Structure
(dict) –
LoRaWAN (dict) –
Information about the wireless gateway’s firmware.
CurrentVersion (dict) –
The version of the gateways that should receive the update.
PackageVersion (string) –
The version of the wireless gateway firmware.
Model (string) –
The model number of the wireless gateway.
Station (string) –
The basic station version of the wireless gateway.
Exceptions
get_wireless_gateway_statistics
(**kwargs)¶Gets operating information about a wireless gateway.
See also: AWS API Documentation
Request Syntax
response = client.get_wireless_gateway_statistics(
WirelessGatewayId='string'
)
WirelessGatewayId (string) –
[REQUIRED]
The ID of the wireless gateway for which to get the data.
dict
Response Syntax
{
'WirelessGatewayId': 'string',
'LastUplinkReceivedAt': 'string'
}
Response Structure
(dict) –
WirelessGatewayId (string) –
The ID of the wireless gateway.
LastUplinkReceivedAt (string) –
The date and time when the most recent uplink was received.
Exceptions
get_wireless_gateway_task
(**kwargs)¶Gets information about a wireless gateway task.
See also: AWS API Documentation
Request Syntax
response = client.get_wireless_gateway_task(
Id='string'
)
Id (string) –
[REQUIRED]
The ID of the resource to get.
dict
Response Syntax
{
'WirelessGatewayId': 'string',
'WirelessGatewayTaskDefinitionId': 'string',
'LastUplinkReceivedAt': 'string',
'TaskCreatedAt': 'string',
'Status': 'PENDING'|'IN_PROGRESS'|'FIRST_RETRY'|'SECOND_RETRY'|'COMPLETED'|'FAILED'
}
Response Structure
(dict) –
WirelessGatewayId (string) –
The ID of the wireless gateway.
WirelessGatewayTaskDefinitionId (string) –
The ID of the WirelessGatewayTask.
LastUplinkReceivedAt (string) –
The date and time when the most recent uplink was received.
TaskCreatedAt (string) –
The date and time when the task was created.
Status (string) –
The status of the request.
Exceptions
get_wireless_gateway_task_definition
(**kwargs)¶Gets information about a wireless gateway task definition.
See also: AWS API Documentation
Request Syntax
response = client.get_wireless_gateway_task_definition(
Id='string'
)
Id (string) –
[REQUIRED]
The ID of the resource to get.
dict
Response Syntax
{
'AutoCreateTasks': True|False,
'Name': 'string',
'Update': {
'UpdateDataSource': 'string',
'UpdateDataRole': 'string',
'LoRaWAN': {
'UpdateSignature': 'string',
'SigKeyCrc': 123,
'CurrentVersion': {
'PackageVersion': 'string',
'Model': 'string',
'Station': 'string'
},
'UpdateVersion': {
'PackageVersion': 'string',
'Model': 'string',
'Station': 'string'
}
}
}
}
Response Structure
(dict) –
AutoCreateTasks (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 (string) –
The name of the resource.
Update (dict) –
Information about the gateways to update.
UpdateDataSource (string) –
The link to the S3 bucket.
UpdateDataRole (string) –
The IAM role used to read data from the S3 bucket.
LoRaWAN (dict) –
The properties that relate to the LoRaWAN wireless gateway.
UpdateSignature (string) –
The signature used to verify the update firmware.
SigKeyCrc (integer) –
The CRC of the signature private key to check.
CurrentVersion (dict) –
The version of the gateways that should receive the update.
PackageVersion (string) –
The version of the wireless gateway firmware.
Model (string) –
The model number of the wireless gateway.
Station (string) –
The basic station version of the wireless gateway.
UpdateVersion (dict) –
The firmware version to update the gateway to.
PackageVersion (string) –
The version of the wireless gateway firmware.
Model (string) –
The model number of the wireless gateway.
Station (string) –
The basic station version of the wireless gateway.
Exceptions
list_destinations
(**kwargs)¶Lists the destinations registered to your AWS account.
See also: AWS API Documentation
Request Syntax
response = client.list_destinations(
MaxResults=123,
NextToken='string'
)
MaxResults (integer) – The maximum number of results to return in this operation.
NextToken (string) – To retrieve the next set of results, the nextToken
value from a previous response; otherwise null to receive the first set of results.
dict
Response Syntax
{
'NextToken': 'string',
'DestinationList': [
{
'Arn': 'string',
'Name': 'string',
'ExpressionType': 'RuleName'|'MqttTopic',
'Expression': 'string',
'Description': 'string',
'RoleArn': 'string'
},
]
}
Response Structure
(dict) –
NextToken (string) –
The token to use to get the next set of results, or null if there are no additional results.
DestinationList (list) –
The list of destinations.
(dict) –
Describes a destination.
Arn (string) –
The Amazon Resource Name of the resource.
Name (string) –
The name of the resource.
ExpressionType (string) –
The type of value in Expression
.
Expression (string) –
The rule name or topic rule to send messages to.
Description (string) –
The description of the resource.
RoleArn (string) –
The ARN of the IAM Role that authorizes the destination.
Exceptions
list_device_profiles
(**kwargs)¶Lists the device profiles registered to your AWS account.
See also: AWS API Documentation
Request Syntax
response = client.list_device_profiles(
NextToken='string',
MaxResults=123
)
NextToken (string) – To retrieve the next set of results, the nextToken
value from a previous response; otherwise null to receive the first set of results.
MaxResults (integer) – The maximum number of results to return in this operation.
dict
Response Syntax
{
'NextToken': 'string',
'DeviceProfileList': [
{
'Arn': 'string',
'Name': 'string',
'Id': 'string'
},
]
}
Response Structure
(dict) –
NextToken (string) –
The token to use to get the next set of results, or null if there are no additional results.
DeviceProfileList (list) –
The list of device profiles.
(dict) –
Describes a device profile.
Arn (string) –
The Amazon Resource Name of the resource.
Name (string) –
The name of the resource.
Id (string) –
The ID of the device profile.
Exceptions
list_partner_accounts
(**kwargs)¶Lists the partner accounts associated with your AWS account.
See also: AWS API Documentation
Request Syntax
response = client.list_partner_accounts(
NextToken='string',
MaxResults=123
)
NextToken (string) – To retrieve the next set of results, the nextToken
value from a previous response; otherwise null to receive the first set of results.
MaxResults (integer) – The maximum number of results to return in this operation.
dict
Response Syntax
{
'NextToken': 'string',
'Sidewalk': [
{
'AmazonId': 'string',
'Fingerprint': 'string'
},
]
}
Response Structure
(dict) –
NextToken (string) –
The token to use to get the next set of results, or null if there are no additional results.
Sidewalk (list) –
The Sidewalk account credentials.
(dict) –
Information about a Sidewalk account.
AmazonId (string) –
The Sidewalk Amazon ID.
Fingerprint (string) –
The fingerprint of the Sidewalk application server private key.
Exceptions
list_service_profiles
(**kwargs)¶Lists the service profiles registered to your AWS account.
See also: AWS API Documentation
Request Syntax
response = client.list_service_profiles(
NextToken='string',
MaxResults=123
)
NextToken (string) – To retrieve the next set of results, the nextToken
value from a previous response; otherwise null to receive the first set of results.
MaxResults (integer) – The maximum number of results to return in this operation.
dict
Response Syntax
{
'NextToken': 'string',
'ServiceProfileList': [
{
'Arn': 'string',
'Name': 'string',
'Id': 'string'
},
]
}
Response Structure
(dict) –
NextToken (string) –
The token to use to get the next set of results, or null if there are no additional results.
ServiceProfileList (list) –
The list of service profiles.
(dict) –
Information about a service profile.
Arn (string) –
The Amazon Resource Name of the resource.
Name (string) –
The name of the resource.
Id (string) –
The ID of the service profile.
Exceptions
Lists the tags (metadata) you have assigned to the resource.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
ResourceArn='string'
)
ResourceArn (string) –
[REQUIRED]
The ARN of the resource for which to list tags.
dict
Response Syntax
{
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
(dict) –
Tags (list) –
The tags attached to the specified resource. Tags are metadata that can be used to manage a resource
(dict) –
A simple label consisting of a customer-defined key-value pair
Key (string) –
The tag’s key value.
Value (string) –
The tag’s value.
Exceptions
list_wireless_devices
(**kwargs)¶Lists the wireless devices registered to your AWS account.
See also: AWS API Documentation
Request Syntax
response = client.list_wireless_devices(
MaxResults=123,
NextToken='string',
DestinationName='string',
DeviceProfileId='string',
ServiceProfileId='string',
WirelessDeviceType='Sidewalk'|'LoRaWAN'
)
MaxResults (integer) – The maximum number of results to return in this operation.
NextToken (string) – To retrieve the next set of results, the nextToken
value from a previous response; otherwise null to receive the first set of results.
DestinationName (string) – A filter to list only the wireless devices that use this destination.
DeviceProfileId (string) – A filter to list only the wireless devices that use this device profile.
ServiceProfileId (string) – A filter to list only the wireless devices that use this service profile.
WirelessDeviceType (string) – A filter to list only the wireless devices that use this wireless device type.
dict
Response Syntax
{
'NextToken': 'string',
'WirelessDeviceList': [
{
'Arn': 'string',
'Id': 'string',
'Type': 'Sidewalk'|'LoRaWAN',
'Name': 'string',
'DestinationName': 'string',
'LastUplinkReceivedAt': 'string',
'LoRaWAN': {
'DevEui': 'string'
},
'Sidewalk': {
'AmazonId': 'string'
}
},
]
}
Response Structure
(dict) –
NextToken (string) –
The token to use to get the next set of results, or null if there are no additional results.
WirelessDeviceList (list) –
The ID of the wireless device.
(dict) –
Information about a wireless device’s operation.
Arn (string) –
The Amazon Resource Name of the resource.
Id (string) –
The ID of the wireless device reporting the data.
Type (string) –
The wireless device type.
Name (string) –
The name of the resource.
DestinationName (string) –
The name of the destination to which the device is assigned.
LastUplinkReceivedAt (string) –
The date and time when the most recent uplink was received.
LoRaWAN (dict) –
LoRaWAN device info.
DevEui (string) –
The DevEUI value.
Sidewalk (dict) –
The Sidewalk account credentials.
AmazonId (string) –
The Sidewalk Amazon ID.
Exceptions
list_wireless_gateway_task_definitions
(**kwargs)¶List the wireless gateway tasks definitions registered to your AWS account.
See also: AWS API Documentation
Request Syntax
response = client.list_wireless_gateway_task_definitions(
MaxResults=123,
NextToken='string',
TaskDefinitionType='UPDATE'
)
MaxResults (integer) – The maximum number of results to return in this operation.
NextToken (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 (string) – A filter to list only the wireless gateway task definitions that use this task definition type.
dict
Response Syntax
{
'NextToken': 'string',
'TaskDefinitions': [
{
'Id': 'string',
'LoRaWAN': {
'CurrentVersion': {
'PackageVersion': 'string',
'Model': 'string',
'Station': 'string'
},
'UpdateVersion': {
'PackageVersion': 'string',
'Model': 'string',
'Station': 'string'
}
}
},
]
}
Response Structure
(dict) –
NextToken (string) –
The token to use to get the next set of results, or null if there are no additional results.
TaskDefinitions (list) –
The list of task definitions.
(dict) –
UpdateWirelessGatewayTaskEntry object.
Id (string) –
The ID of the new wireless gateway task entry.
LoRaWAN (dict) –
The properties that relate to the LoRaWAN wireless gateway.
CurrentVersion (dict) –
The version of the gateways that should receive the update.
PackageVersion (string) –
The version of the wireless gateway firmware.
Model (string) –
The model number of the wireless gateway.
Station (string) –
The basic station version of the wireless gateway.
UpdateVersion (dict) –
The firmware version to update the gateway to.
PackageVersion (string) –
The version of the wireless gateway firmware.
Model (string) –
The model number of the wireless gateway.
Station (string) –
The basic station version of the wireless gateway.
Exceptions
list_wireless_gateways
(**kwargs)¶Lists the wireless gateways registered to your AWS account.
See also: AWS API Documentation
Request Syntax
response = client.list_wireless_gateways(
NextToken='string',
MaxResults=123
)
NextToken (string) – To retrieve the next set of results, the nextToken
value from a previous response; otherwise null to receive the first set of results.
MaxResults (integer) – The maximum number of results to return in this operation.
dict
Response Syntax
{
'NextToken': 'string',
'WirelessGatewayList': [
{
'Arn': 'string',
'Id': 'string',
'Name': 'string',
'Description': 'string',
'LoRaWAN': {
'GatewayEui': 'string',
'RfRegion': 'string'
},
'LastUplinkReceivedAt': 'string'
},
]
}
Response Structure
(dict) –
NextToken (string) –
The token to use to get the next set of results, or null if there are no additional results.
WirelessGatewayList (list) –
The ID of the wireless gateway.
(dict) –
Information about a wireless gateway’s operation.
Arn (string) –
The Amazon Resource Name of the resource.
Id (string) –
The ID of the wireless gateway reporting the data.
Name (string) –
The name of the resource.
Description (string) –
The description of the resource.
LoRaWAN (dict) –
LoRaWAN gateway info.
GatewayEui (string) –
The gateway’s EUI value.
RfRegion (string) –
The frequency band (RFRegion) value.
LastUplinkReceivedAt (string) –
The date and time when the most recent uplink was received.
Exceptions
send_data_to_wireless_device
(**kwargs)¶Sends a decrypted application data frame to a device.
See also: AWS API Documentation
Request Syntax
response = client.send_data_to_wireless_device(
Id='string',
TransmitMode=123,
PayloadData='string',
WirelessMetadata={
'LoRaWAN': {
'FPort': 123
},
'Sidewalk': {
'Seq': 123
}
}
)
Id (string) –
[REQUIRED]
The ID of the wireless device to receive the data.
TransmitMode (integer) –
[REQUIRED]
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).
PayloadData (string) –
[REQUIRED]
The message payload to send.
WirelessMetadata (dict) –
Metadata about the message request.
LoRaWAN (dict) –
LoRaWAN device info.
FPort (integer) –
The Fport value.
Sidewalk (dict) –
The Sidewalk account credentials.
Seq (integer) –
The sequence number.
dict
Response Syntax
{
'MessageId': 'string'
}
Response Structure
(dict) –
MessageId (string) –
The ID of the message sent to the wireless device.
Exceptions
tag_resource
(**kwargs)¶Adds a tag to a resource.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
ResourceArn='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
ResourceArn (string) –
[REQUIRED]
The ARN of the resource to add tags to.
Tags (list) –
[REQUIRED]
Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.
(dict) –
A simple label consisting of a customer-defined key-value pair
Key (string) – [REQUIRED]
The tag’s key value.
Value (string) – [REQUIRED]
The tag’s value.
dict
Response Syntax
{}
Response Structure
(dict) –
Exceptions
test_wireless_device
(**kwargs)¶Simulates a provisioned device by sending an uplink data payload of Hello
.
See also: AWS API Documentation
Request Syntax
response = client.test_wireless_device(
Id='string'
)
Id (string) –
[REQUIRED]
The ID of the wireless device to test.
dict
Response Syntax
{
'Result': 'string'
}
Response Structure
(dict) –
Result (string) –
The result returned by the test.
Exceptions
untag_resource
(**kwargs)¶Removes one or more tags from a resource.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
ResourceArn='string',
TagKeys=[
'string',
]
)
ResourceArn (string) –
[REQUIRED]
The ARN of the resource to remove tags from.
TagKeys (list) –
[REQUIRED]
A list of the keys of the tags to remove from the resource.
(string) –
dict
Response Syntax
{}
Response Structure
(dict) –
Exceptions
update_destination
(**kwargs)¶Updates properties of a destination.
See also: AWS API Documentation
Request Syntax
response = client.update_destination(
Name='string',
ExpressionType='RuleName'|'MqttTopic',
Expression='string',
Description='string',
RoleArn='string'
)
Name (string) –
[REQUIRED]
The new name of the resource.
ExpressionType (string) – The type of value in Expression
.
Expression (string) – The new rule name or topic rule to send messages to.
Description (string) – A new description of the resource.
RoleArn (string) – The ARN of the IAM Role that authorizes the destination.
dict
Response Syntax
{}
Response Structure
(dict) –
Exceptions
update_partner_account
(**kwargs)¶Updates properties of a partner account.
See also: AWS API Documentation
Request Syntax
response = client.update_partner_account(
Sidewalk={
'AppServerPrivateKey': 'string'
},
PartnerAccountId='string',
PartnerType='Sidewalk'
)
Sidewalk (dict) –
[REQUIRED]
The Sidewalk account credentials.
AppServerPrivateKey (string) –
The new Sidewalk application server private key.
PartnerAccountId (string) –
[REQUIRED]
The ID of the partner account to update.
PartnerType (string) –
[REQUIRED]
The partner type.
dict
Response Syntax
{}
Response Structure
(dict) –
Exceptions
update_wireless_device
(**kwargs)¶Updates properties of a wireless device.
See also: AWS API Documentation
Request Syntax
response = client.update_wireless_device(
Id='string',
DestinationName='string',
Name='string',
Description='string',
LoRaWAN={
'DeviceProfileId': 'string',
'ServiceProfileId': 'string'
}
)
Id (string) –
[REQUIRED]
The ID of the resource to update.
DestinationName (string) – The name of the new destination for the device.
Name (string) – The new name of the resource.
Description (string) – A new description of the resource.
LoRaWAN (dict) –
The updated wireless device’s configuration.
DeviceProfileId (string) –
The ID of the device profile for the wireless device.
ServiceProfileId (string) –
The ID of the service profile.
dict
Response Syntax
{}
Response Structure
(dict) –
Exceptions
update_wireless_gateway
(**kwargs)¶Updates properties of a wireless gateway.
See also: AWS API Documentation
Request Syntax
response = client.update_wireless_gateway(
Id='string',
Name='string',
Description='string'
)
Id (string) –
[REQUIRED]
The ID of the resource to update.
Name (string) – The new name of the resource.
Description (string) – A new description of the resource.
dict
Response Syntax
{}
Response Structure
(dict) –
Exceptions
Client exceptions are available on a client instance via the exceptions
property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.
The available client exceptions are:
IoTWireless.Client.exceptions.
AccessDeniedException
¶User does not have permission to perform this action.
Example
try:
...
except client.exceptions.AccessDeniedException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'Message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
User does not have permission to perform this action.
Message (string) –
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
IoTWireless.Client.exceptions.
ConflictException
¶Adding, updating, or deleting the resource can cause an inconsistent state.
Example
try:
...
except client.exceptions.ConflictException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'Message': 'string',
'ResourceId': 'string',
'ResourceType': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
Adding, updating, or deleting the resource can cause an inconsistent state.
Message (string) –
ResourceId (string) –
ResourceType (string) –
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
IoTWireless.Client.exceptions.
InternalServerException
¶An unexpected error occurred while processing a request.
Example
try:
...
except client.exceptions.InternalServerException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'Message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
An unexpected error occurred while processing a request.
Message (string) –
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
IoTWireless.Client.exceptions.
ResourceNotFoundException
¶Resource does not exist.
Example
try:
...
except client.exceptions.ResourceNotFoundException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'Message': 'string',
'ResourceId': 'string',
'ResourceType': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
Resource does not exist.
Message (string) –
ResourceId (string) –
ResourceType (string) –
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
IoTWireless.Client.exceptions.
ThrottlingException
¶The request was denied because it exceeded the allowed API request rate.
Example
try:
...
except client.exceptions.ThrottlingException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'Message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
The request was denied because it exceeded the allowed API request rate.
Message (string) –
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
IoTWireless.Client.exceptions.
TooManyTagsException
¶The request was denied because the resource can’t have any more tags.
Example
try:
...
except client.exceptions.TooManyTagsException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'Message': 'string',
'ResourceName': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
The request was denied because the resource can’t have any more tags.
Message (string) –
ResourceName (string) –
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
IoTWireless.Client.exceptions.
ValidationException
¶The input did not meet the specified constraints.
Example
try:
...
except client.exceptions.ValidationException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'Message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
The input did not meet the specified constraints.
Message (string) –
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The available paginators are: