AWS API Changes

2020/12/15 - AWS IoT Wireless - 51 new api methods

Changes Update iotwireless client to latest version

DisassociateWirelessDeviceFromThing (new)

Link ¶

Disassociates a wireless device from its currently associated thing.

Request Syntax

client.disassociate_wireless_device_from_thing(
    Id='string'
)

type Id:

string

param Id:

[REQUIRED]

The ID of the resource to update.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

(dict) --

CreateServiceProfile (new)

Link ¶

Creates a new service profile.

See also: AWS API Documentation

Request Syntax

client.create_service_profile(
    Name='string',
    LoRaWAN={
        'AddGwMetadata': True|False
    },
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    ClientRequestToken='string'
)

type Name:

string

param Name:

The name of the new resource.

type LoRaWAN:

dict

param LoRaWAN:

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

AddGwMetadata (boolean) --

The AddGWMetaData value.

type Tags:

list

param Tags:

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.

type ClientRequestToken:

string

param ClientRequestToken:

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.

rtype:

dict

returns:

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.

ListWirelessDevices (new)

Link ¶

Lists the wireless devices registered to your AWS account.

See also: AWS API Documentation

Request Syntax

client.list_wireless_devices(
    MaxResults=123,
    NextToken='string',
    DestinationName='string',
    DeviceProfileId='string',
    ServiceProfileId='string',
    WirelessDeviceType='Sidewalk'|'LoRaWAN'
)

type MaxResults:

integer

param MaxResults:

The maximum number of results to return in this operation.

type NextToken:

string

param NextToken:

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

type DestinationName:

string

param DestinationName:

A filter to list only the wireless devices that use this destination.

type DeviceProfileId:

string

param DeviceProfileId:

A filter to list only the wireless devices that use this device profile.

type ServiceProfileId:

string

param ServiceProfileId:

A filter to list only the wireless devices that use this service profile.

type WirelessDeviceType:

string

param WirelessDeviceType:

A filter to list only the wireless devices that use this wireless device type.

rtype:

dict

returns:

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.

UpdateDestination (new)

Link ¶

Updates properties of a destination.

See also: AWS API Documentation

Request Syntax

client.update_destination(
    Name='string',
    ExpressionType='RuleName',
    Expression='string',
    Description='string',
    RoleArn='string'
)

type Name:

string

param Name:

[REQUIRED]

The new name of the resource.

type ExpressionType:

string

param ExpressionType:

The type of value in Expression.

type Expression:

string

param Expression:

The new rule name or topic rule to send messages to.

type Description:

string

param Description:

A new description of the resource.

type RoleArn:

string

param RoleArn:

The ARN of the IAM Role that authorizes the destination.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

(dict) --

UpdateWirelessDevice (new)

Link ¶

Updates properties of a wireless device.

See also: AWS API Documentation

Request Syntax

client.update_wireless_device(
    Id='string',
    DestinationName='string',
    Name='string',
    Description='string',
    LoRaWAN={
        'DeviceProfileId': 'string',
        'ServiceProfileId': 'string'
    }
)

type Id:

string

param Id:

[REQUIRED]

The ID of the resource to update.

type DestinationName:

string

param DestinationName:

The name of the new destination for the device.

type Name:

string

param Name:

The new name of the resource.

type Description:

string

param Description:

A new description of the resource.

type LoRaWAN:

dict

param LoRaWAN:

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.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

(dict) --

GetDestination (new)

Link ¶

Gets information about a destination.

See also: AWS API Documentation

Request Syntax

client.get_destination(
    Name='string'
)

type Name:

string

param Name:

[REQUIRED]

The name of the resource to get.

rtype:

dict

returns:

Response Syntax

{
    'Arn': 'string',
    'Name': 'string',
    'Expression': 'string',
    'ExpressionType': 'RuleName',
    '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.

GetWirelessGatewayFirmwareInformation (new)

Link ¶

Gets the firmware version and other information about a wireless gateway.

See also: AWS API Documentation

Request Syntax

client.get_wireless_gateway_firmware_information(
    Id='string'
)

type Id:

string

param Id:

[REQUIRED]

The ID of the resource to get.

rtype:

dict

returns:

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.

DeleteDestination (new)

Link ¶

Deletes a destination.

See also: AWS API Documentation

Request Syntax

client.delete_destination(
    Name='string'
)

type Name:

string

param Name:

[REQUIRED]

The name of the resource to delete.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

(dict) --

SendDataToWirelessDevice (new)

Link ¶

Sends a decrypted application data frame to a device.

See also: AWS API Documentation

Request Syntax

client.send_data_to_wireless_device(
    Id='string',
    TransmitMode=123,
    PayloadData='string',
    WirelessMetadata={
        'LoRaWAN': {
            'FPort': 123
        },
        'Sidewalk': {
            'Seq': 123
        }
    }
)

type Id:

string

param Id:

[REQUIRED]

The ID of the wireless device to receive the data.

type TransmitMode:

integer

param TransmitMode:

[REQUIRED]

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

type PayloadData:

string

param PayloadData:

[REQUIRED]

The message payload to send.

type WirelessMetadata:

dict

param WirelessMetadata:

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.

rtype:

dict

returns:

Response Syntax

{
    'MessageId': 'string'
}

Response Structure

(dict) --
- MessageId (string) --
  
  The ID of the message sent to the wireless device.

TestWirelessDevice (new)

Link ¶

Simulates a provisioned device by sending an uplink data payload of Hello.

See also: AWS API Documentation

Request Syntax

client.test_wireless_device(
    Id='string'
)

type Id:

string

param Id:

[REQUIRED]

The ID of the wireless device to test.

rtype:

dict

returns:

Response Syntax

{
    'Result': 'string'
}

Response Structure

(dict) --
- Result (string) --
  
  The result returned by the test.

AssociateWirelessDeviceWithThing (new)

Link ¶

Associates a wireless device with a thing.

See also: AWS API Documentation

Request Syntax

client.associate_wireless_device_with_thing(
    Id='string',
    ThingArn='string'
)

type Id:

string

param Id:

[REQUIRED]

The ID of the resource to update.

type ThingArn:

string

param ThingArn:

[REQUIRED]

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

rtype:

dict

returns:

Response Syntax

{}

Response Structure

(dict) --

CreateWirelessGateway (new)

Link ¶

Provisions a wireless gateway.

See also: AWS API Documentation

Request Syntax

client.create_wireless_gateway(
    Name='string',
    Description='string',
    LoRaWAN={
        'GatewayEui': 'string',
        'RfRegion': 'string'
    },
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    ClientRequestToken='string'
)

type Name:

string

param Name:

The name of the new resource.

type Description:

string

param Description:

The description of the new resource.

type LoRaWAN:

dict

param LoRaWAN:

[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.

type Tags:

list

param Tags:

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.

type ClientRequestToken:

string

param ClientRequestToken:

This field is autopopulated if not provided.

rtype:

dict

returns:

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.

AssociateWirelessGatewayWithCertificate (new)

Link ¶

Associates a wireless gateway with a certificate.

See also: AWS API Documentation

Request Syntax

client.associate_wireless_gateway_with_certificate(
    Id='string',
    IotCertificateId='string'
)

type Id:

string

param Id:

[REQUIRED]

The ID of the resource to update.

type IotCertificateId:

string

param IotCertificateId:

[REQUIRED]

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

rtype:

dict

returns:

Response Syntax

{
    'IotCertificateId': 'string'
}

Response Structure

(dict) --
- IotCertificateId (string) --
  
  The ID of the certificate associated with the wireless gateway.

GetWirelessGatewayTask (new)

Link ¶

Gets information about a wireless gateway task.

See also: AWS API Documentation

Request Syntax

client.get_wireless_gateway_task(
    Id='string'
)

type Id:

string

param Id:

[REQUIRED]

The ID of the resource to get.

rtype:

dict

returns:

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.

CreateWirelessGatewayTask (new)

Link ¶

Creates a task for a wireless gateway.

See also: AWS API Documentation

Request Syntax

client.create_wireless_gateway_task(
    Id='string',
    WirelessGatewayTaskDefinitionId='string'
)

type Id:

string

param Id:

[REQUIRED]

The ID of the resource to update.

type WirelessGatewayTaskDefinitionId:

string

param WirelessGatewayTaskDefinitionId:

[REQUIRED]

The ID of the WirelessGatewayTaskDefinition.

rtype:

dict

returns:

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.

ListServiceProfiles (new)

Link ¶

Lists the service profiles registered to your AWS account.

See also: AWS API Documentation

Request Syntax

client.list_service_profiles(
    NextToken='string',
    MaxResults=123
)

type NextToken:

string

param NextToken:

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

type MaxResults:

integer

param MaxResults:

The maximum number of results to return in this operation.

rtype:

dict

returns:

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.

GetServiceEndpoint (new)

Link ¶

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

client.get_service_endpoint(
    ServiceType='CUPS'|'LNS'
)

type ServiceType:

string

param ServiceType:

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.

rtype:

dict

returns:

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.

DisassociateAwsAccountFromPartnerAccount (new)

Link ¶

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

client.disassociate_aws_account_from_partner_account(
    PartnerAccountId='string',
    PartnerType='Sidewalk'
)

type PartnerAccountId:

string

param PartnerAccountId:

[REQUIRED]

The partner account ID to disassociate from the AWS account.

type PartnerType:

string

param PartnerType:

[REQUIRED]

The partner type.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

(dict) --

UpdatePartnerAccount (new)

Link ¶

Updates properties of a partner account.

See also: AWS API Documentation

Request Syntax

client.update_partner_account(
    Sidewalk={
        'AppServerPrivateKey': 'string'
    },
    PartnerAccountId='string',
    PartnerType='Sidewalk'
)

type Sidewalk:

dict

param Sidewalk:

[REQUIRED]

The Sidewalk account credentials.

AppServerPrivateKey (string) --

The new Sidewalk application server private key.

type PartnerAccountId:

string

param PartnerAccountId:

[REQUIRED]

The ID of the partner account to update.

type PartnerType:

string

param PartnerType:

[REQUIRED]

The partner type.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

(dict) --

DeleteDeviceProfile (new)

Link ¶

Deletes a device profile.

See also: AWS API Documentation

Request Syntax

client.delete_device_profile(
    Id='string'
)

type Id:

string

param Id:

[REQUIRED]

The ID of the resource to delete.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

(dict) --

DeleteWirelessDevice (new)

Link ¶

Deletes a wireless device.

See also: AWS API Documentation

Request Syntax

client.delete_wireless_device(
    Id='string'
)

type Id:

string

param Id:

[REQUIRED]

The ID of the resource to delete.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

(dict) --

GetWirelessGatewayTaskDefinition (new)

Link ¶

Gets information about a wireless gateway task definition.

See also: AWS API Documentation

Request Syntax

client.get_wireless_gateway_task_definition(
    Id='string'
)

type Id:

string

param Id:

[REQUIRED]

The ID of the resource to get.

rtype:

dict

returns:

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.

GetWirelessGateway (new)

Link ¶

Gets information about a wireless gateway.

See also: AWS API Documentation

Request Syntax

client.get_wireless_gateway(
    Identifier='string',
    IdentifierType='GatewayEui'|'WirelessGatewayId'|'ThingName'
)

type Identifier:

string

param Identifier:

[REQUIRED]

The identifier of the wireless gateway to get.

type IdentifierType:

string

param IdentifierType:

[REQUIRED]

The type of identifier used in identifier.

rtype:

dict

returns:

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.
- ThingArn (string) --
  
  The ARN of the thing associated with the wireless gateway.

UpdateWirelessGateway (new)

Link ¶

Updates properties of a wireless gateway.

See also: AWS API Documentation

Request Syntax

client.update_wireless_gateway(
    Id='string',
    Name='string',
    Description='string'
)

type Id:

string

param Id:

[REQUIRED]

The ID of the resource to update.

type Name:

string

param Name:

The new name of the resource.

type Description:

string

param Description:

A new description of the resource.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

(dict) --

ListPartnerAccounts (new)

Link ¶

Lists the partner accounts associated with your AWS account.

See also: AWS API Documentation

Request Syntax

client.list_partner_accounts(
    NextToken='string',
    MaxResults=123
)

type NextToken:

string

param NextToken:

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

type MaxResults:

integer

param MaxResults:

The maximum number of results to return in this operation.

rtype:

dict

returns:

Response Syntax

{
    'NextToken': 'string',
    'Sidewalk': [
        {
            'AmazonId': 'string',
            'AppServerPrivateKey': '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.
  
  The AppServerPrivateKey value is empty to protect its security.
  - (dict) --
    
    Information about a Sidewalk account.
    - AmazonId (string) --
      
      The Sidewalk Amazon ID.
    - AppServerPrivateKey (string) --
      
      The Sidewalk application server private key.

DeleteWirelessGatewayTask (new)

Link ¶

Deletes a wireless gateway task.

See also: AWS API Documentation

Request Syntax

client.delete_wireless_gateway_task(
    Id='string'
)

type Id:

string

param Id:

[REQUIRED]

The ID of the resource to delete.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

(dict) --

GetWirelessGatewayStatistics (new)

Link ¶

Gets operating information about a wireless gateway.

See also: AWS API Documentation

Request Syntax

client.get_wireless_gateway_statistics(
    WirelessGatewayId='string'
)

type WirelessGatewayId:

string

param WirelessGatewayId:

[REQUIRED]

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

rtype:

dict

returns:

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.

DeleteServiceProfile (new)

Link ¶

Deletes a service profile.

See also: AWS API Documentation

Request Syntax

client.delete_service_profile(
    Id='string'
)

type Id:

string

param Id:

[REQUIRED]

The ID of the resource to delete.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

(dict) --

CreateDestination (new)

Link ¶

Creates a new destination that maps a device message to an AWS IoT rule.

See also: AWS API Documentation

Request Syntax

client.create_destination(
    Name='string',
    ExpressionType='RuleName',
    Expression='string',
    Description='string',
    RoleArn='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    ClientRequestToken='string'
)

type Name:

string

param Name:

[REQUIRED]

The name of the new resource.

type ExpressionType:

string

param ExpressionType:

[REQUIRED]

The type of value in Expression.

type Expression:

string

param Expression:

[REQUIRED]

The rule name or topic rule to send messages to.

type Description:

string

param Description:

The description of the new resource.

type RoleArn:

string

param RoleArn:

[REQUIRED]

The ARN of the IAM Role that authorizes the destination.

type Tags:

list

param Tags:

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.

type ClientRequestToken:

string

param ClientRequestToken:

This field is autopopulated if not provided.

rtype:

dict

returns:

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.

DeleteWirelessGatewayTaskDefinition (new)

Link ¶

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

client.delete_wireless_gateway_task_definition(
    Id='string'
)

type Id:

string

param Id:

[REQUIRED]

The ID of the resource to delete.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

(dict) --

CreateWirelessGatewayTaskDefinition (new)

Link ¶

Creates a gateway task definition.

See also: AWS API Documentation

Request Syntax

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'
)

type AutoCreateTasks:

boolean

param AutoCreateTasks:

[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.

type Name:

string

param Name:

The name of the new resource.

type Update:

dict

param Update:

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.

type ClientRequestToken:

string

param ClientRequestToken:

This field is autopopulated if not provided.

rtype:

dict

returns:

Response Syntax

{
    'Id': 'string'
}

Response Structure

(dict) --
- Id (string) --
  
  The ID of the new wireless gateway task definition.

AssociateWirelessGatewayWithThing (new)

Link ¶

Associates a wireless gateway with a thing.

See also: AWS API Documentation

Request Syntax

client.associate_wireless_gateway_with_thing(
    Id='string',
    ThingArn='string'
)

type Id:

string

param Id:

[REQUIRED]

The ID of the resource to update.

type ThingArn:

string

param ThingArn:

[REQUIRED]

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

rtype:

dict

returns:

Response Syntax

{}

Response Structure

(dict) --

AssociateAwsAccountWithPartnerAccount (new)

Link ¶

Associates a partner account with your AWS account.

See also: AWS API Documentation

Request Syntax

client.associate_aws_account_with_partner_account(
    Sidewalk={
        'AmazonId': 'string',
        'AppServerPrivateKey': 'string'
    },
    ClientRequestToken='string'
)

type Sidewalk:

dict

param Sidewalk:

[REQUIRED]

The Sidewalk account credentials.

AmazonId (string) --

The Sidewalk Amazon ID.
AppServerPrivateKey (string) --

The Sidewalk application server private key.

type ClientRequestToken:

string

param ClientRequestToken:

This field is autopopulated if not provided.

rtype:

dict

returns:

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.

GetServiceProfile (new)

Link ¶

Gets information about a service profile.

See also: AWS API Documentation

Request Syntax

client.get_service_profile(
    Id='string'
)

type Id:

string

param Id:

[REQUIRED]

The ID of the resource to get.

rtype:

dict

returns:

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.

TagResource (new)

Link ¶

Adds a tag to a resource.

See also: AWS API Documentation

Request Syntax

client.tag_resource(
    ResourceArn='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

type ResourceArn:

string

param ResourceArn:

[REQUIRED]

The ARN of the resource to add tags to.

type Tags:

list

param Tags:

[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.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

(dict) --

ListWirelessGateways (new)

Link ¶

Lists the wireless gateways registered to your AWS account.

See also: AWS API Documentation

Request Syntax

client.list_wireless_gateways(
    NextToken='string',
    MaxResults=123
)

type NextToken:

string

param NextToken:

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

type MaxResults:

integer

param MaxResults:

The maximum number of results to return in this operation.

rtype:

dict

returns:

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.

ListTagsForResource (new)

Link ¶

Lists the tags (metadata) you have assigned to the resource.

See also: AWS API Documentation

Request Syntax

client.list_tags_for_resource(
    ResourceArn='string'
)

type ResourceArn:

string

param ResourceArn:

[REQUIRED]

The ARN of the resource for which to list tags.

rtype:

dict

returns:

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.

GetWirelessDevice (new)

Link ¶

Gets information about a wireless device.

See also: AWS API Documentation

Request Syntax

client.get_wireless_device(
    Identifier='string',
    IdentifierType='WirelessDeviceId'|'DevEui'|'ThingName'
)

type Identifier:

string

param Identifier:

[REQUIRED]

The identifier of the wireless device to get.

type IdentifierType:

string

param IdentifierType:

[REQUIRED]

The type of identifier used in identifier.

rtype:

dict

returns:

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.
- 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) --
    
    LoRa 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.

GetDeviceProfile (new)

Link ¶

Gets information about a device profile.

See also: AWS API Documentation

Request Syntax

client.get_device_profile(
    Id='string'
)

type Id:

string

param Id:

[REQUIRED]

The ID of the resource to get.

rtype:

dict

returns:

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 OTA 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.

DisassociateWirelessGatewayFromCertificate (new)

Link ¶

Disassociates a wireless gateway from its currently associated certificate.

See also: AWS API Documentation

Request Syntax

client.disassociate_wireless_gateway_from_certificate(
    Id='string'
)

type Id:

string

param Id:

[REQUIRED]

The ID of the resource to update.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

(dict) --

GetPartnerAccount (new)

Link ¶

Gets information about a partner account. If PartnerAccountId and PartnerType are null, returns all partner accounts.

See also: AWS API Documentation

Request Syntax

client.get_partner_account(
    PartnerAccountId='string',
    PartnerType='Sidewalk'
)

type PartnerAccountId:

string

param PartnerAccountId:

[REQUIRED]

The partner account ID to disassociate from the AWS account.

type PartnerType:

string

param PartnerType:

[REQUIRED]

The partner type.

rtype:

dict

returns:

Response Syntax

{
    'Sidewalk': {
        'AmazonId': 'string',
        'AppServerPrivateKey': 'string'
    },
    'AccountLinked': True|False
}

Response Structure

(dict) --
- Sidewalk (dict) --
  
  The Sidewalk account credentials.
  
  The AppServerPrivateKey value is empty to protect its security.
  - AmazonId (string) --
    
    The Sidewalk Amazon ID.
  - AppServerPrivateKey (string) --
    
    The Sidewalk application server private key.
- AccountLinked (boolean) --
  
  Whether the partner account is linked to the AWS account.

ListDestinations (new)

Link ¶

Lists the destinations registered to your AWS account.

See also: AWS API Documentation

Request Syntax

client.list_destinations(
    MaxResults=123,
    NextToken='string'
)

type MaxResults:

integer

param MaxResults:

The maximum number of results to return in this operation.

type NextToken:

string

param NextToken:

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

rtype:

dict

returns:

Response Syntax

{
    'NextToken': 'string',
    'DestinationList': [
        {
            'Arn': 'string',
            'Name': 'string',
            'ExpressionType': 'RuleName',
            '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.

DeleteWirelessGateway (new)

Link ¶

Deletes a wireless gateway.

See also: AWS API Documentation

Request Syntax

client.delete_wireless_gateway(
    Id='string'
)

type Id:

string

param Id:

[REQUIRED]

The ID of the resource to delete.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

(dict) --

DisassociateWirelessGatewayFromThing (new)

Link ¶

Disassociates a wireless gateway from its currently associated thing.

See also: AWS API Documentation

Request Syntax

client.disassociate_wireless_gateway_from_thing(
    Id='string'
)

type Id:

string

param Id:

[REQUIRED]

The ID of the resource to update.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

(dict) --

GetWirelessDeviceStatistics (new)

Link ¶

Gets operating information about a wireless device.

See also: AWS API Documentation

Request Syntax

client.get_wireless_device_statistics(
    WirelessDeviceId='string'
)

type WirelessDeviceId:

string

param WirelessDeviceId:

[REQUIRED]

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

rtype:

dict

returns:

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.

ListWirelessGatewayTaskDefinitions (new)

Link ¶

List the wireless gateway tasks definitions registered to your AWS account.

See also: AWS API Documentation

Request Syntax

client.list_wireless_gateway_task_definitions(
    MaxResults=123,
    NextToken='string',
    TaskDefinitionType='UPDATE'
)

type MaxResults:

integer

param MaxResults:

The maximum number of results to return in this operation.

type NextToken:

string

param NextToken:

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

type TaskDefinitionType:

string

param TaskDefinitionType:

A filter to list only the wireless gateway task definitions that use this task definition type.

rtype:

dict

returns:

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.

UntagResource (new)

Link ¶

Removes one or more tags from a resource.

See also: AWS API Documentation

Request Syntax

client.untag_resource(
    ResourceArn='string',
    TagKeys=[
        'string',
    ]
)

type ResourceArn:

string

param ResourceArn:

[REQUIRED]

The ARN of the resource to remove tags from.

type TagKeys:

list

param TagKeys:

[REQUIRED]

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

(string) --

rtype:

dict

returns:

Response Syntax

{}

Response Structure

(dict) --

CreateDeviceProfile (new)

Link ¶

Creates a new device profile.

See also: AWS API Documentation

Request Syntax

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'
)

type Name:

string

param Name:

The name of the new resource.

type LoRaWAN:

dict

param LoRaWAN:

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 OTA 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.

type Tags:

list

param Tags:

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.

type ClientRequestToken:

string

param ClientRequestToken:

This field is autopopulated if not provided.

rtype:

dict

returns:

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.

CreateWirelessDevice (new)

Link ¶

Provisions a wireless device.

See also: AWS API Documentation

Request Syntax

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 Type:

string

param Type:

[REQUIRED]

The wireless device type.

type Name:

string

param Name:

The name of the new resource.

type Description:

string

param Description:

The description of the new resource.

type DestinationName:

string

param DestinationName:

[REQUIRED]

The name of the destination to assign to the new wireless device.

type ClientRequestToken:

string

param ClientRequestToken:

This field is autopopulated if not provided.

type LoRaWAN:

dict

param LoRaWAN:

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) --

LoRa 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.

rtype:

dict

returns:

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.

ListDeviceProfiles (new)

Link ¶

Lists the device profiles registered to your AWS account.

See also: AWS API Documentation

Request Syntax

client.list_device_profiles(
    NextToken='string',
    MaxResults=123
)

type NextToken:

string

param NextToken:

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

type MaxResults:

integer

param MaxResults:

The maximum number of results to return in this operation.

rtype:

dict

returns:

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.

GetWirelessGatewayCertificate (new)

Link ¶

Gets the ID of the certificate that is currently associated with a wireless gateway.

See also: AWS API Documentation

Request Syntax

client.get_wireless_gateway_certificate(
    Id='string'
)

type Id:

string

param Id:

[REQUIRED]

The ID of the resource to get.

rtype:

dict

returns:

Response Syntax

{
    'IotCertificateId': 'string'
}

Response Structure

(dict) --
- IotCertificateId (string) --
  
  The ID of the certificate associated with the wireless gateway.