AWS API Changes

2021/05/10 - AWS IoT Wireless - 4 updated api methods

Changes Add three new optional fields to support filtering and configurable sub-band in WirelessGateway APIs. The filtering is for all the RF region supported. The sub-band configuration is only applicable to LoRa gateways of US915 or AU915 RF region.

CreateWirelessGateway (updated)

Link ¶
Changes (request)

{'LoRaWAN': {'JoinEuiFilters': [['string']],
             'NetIdFilters': ['string'],
             'SubBands': ['integer']}}

Provisions a wireless gateway.

See also: AWS API Documentation

Request Syntax

client.create_wireless_gateway(
    Name='string',
    Description='string',
    LoRaWAN={
        'GatewayEui': 'string',
        'RfRegion': 'string',
        'JoinEuiFilters': [
            [
                'string',
            ],
        ],
        'NetIdFilters': [
            'string',
        ],
        'SubBands': [
            123,
        ]
    },
    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.
JoinEuiFilters (list) --

A list of JoinEuiRange used by LoRa gateways to filter LoRa frames.
- (list) --
  
  A pair of join EUI describing a range [BegEui, EndEui], both ends are inclusive.
  - (string) --
NetIdFilters (list) --

A list of NetId values that are used by LoRa gateways to filter the uplink frames.
- (string) --
  
  LoRaWAN network ID.
SubBands (list) --

A list of integer indicating which sub bands are supported by LoRa gateway.
- (integer) --
  
  A subset of supported frequency channels in a certain RFRegion.

type Tags

list

param Tags

The tags to attach to the new wireless gateway. Tags are metadata that you can use 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 wireless gateway.

GetWirelessGateway (updated)

Link ¶
Changes (response)

{'LoRaWAN': {'JoinEuiFilters': [['string']],
             'NetIdFilters': ['string'],
             'SubBands': ['integer']}}

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',
        'JoinEuiFilters': [
            [
                'string',
            ],
        ],
        'NetIdFilters': [
            'string',
        ],
        'SubBands': [
            123,
        ]
    },
    '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.
  - JoinEuiFilters (list) --
    
    A list of JoinEuiRange used by LoRa gateways to filter LoRa frames.
    - (list) --
      
      A pair of join EUI describing a range [BegEui, EndEui], both ends are inclusive.
      - (string) --
  - NetIdFilters (list) --
    
    A list of NetId values that are used by LoRa gateways to filter the uplink frames.
    - (string) --
      
      LoRaWAN network ID.
  - SubBands (list) --
    
    A list of integer indicating which sub bands are supported by LoRa gateway.
    - (integer) --
      
      A subset of supported frequency channels in a certain RFRegion.
- 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.

ListWirelessGateways (updated)

Link ¶
Changes (response)

{'WirelessGatewayList': {'LoRaWAN': {'JoinEuiFilters': [['string']],
                                     'NetIdFilters': ['string'],
                                     'SubBands': ['integer']}}}

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',
                'JoinEuiFilters': [
                    [
                        'string',
                    ],
                ],
                'NetIdFilters': [
                    'string',
                ],
                'SubBands': [
                    123,
                ]
            },
            '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.
      - JoinEuiFilters (list) --
        
        A list of JoinEuiRange used by LoRa gateways to filter LoRa frames.
        
        (list) --
        
        A pair of join EUI describing a range [BegEui, EndEui], both ends are inclusive.
        
        (string) --
      - NetIdFilters (list) --
        
        A list of NetId values that are used by LoRa gateways to filter the uplink frames.
        
        (string) --
        
        LoRaWAN network ID.
      - SubBands (list) --
        
        A list of integer indicating which sub bands are supported by LoRa gateway.
        
        (integer) --
        
        A subset of supported frequency channels in a certain RFRegion.
    - LastUplinkReceivedAt (string) --
      
      The date and time when the most recent uplink was received.

UpdateWirelessGateway (updated)

Link ¶
Changes (request)

{'JoinEuiFilters': [['string']], 'NetIdFilters': ['string']}

Updates properties of a wireless gateway.

See also: AWS API Documentation

Request Syntax

client.update_wireless_gateway(
    Id='string',
    Name='string',
    Description='string',
    JoinEuiFilters=[
        [
            'string',
        ],
    ],
    NetIdFilters=[
        '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.

type JoinEuiFilters

list

param JoinEuiFilters

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

(list) --

A pair of join EUI describing a range [BegEui, EndEui], both ends are inclusive.
- (string) --

type NetIdFilters

list

param NetIdFilters

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

(string) --

LoRaWAN network ID.

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --