IoTWireless / Client / list_wireless_gateways

list_wireless_gateways

IoTWireless.Client.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
)

Parameters:

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

Return type:

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,
                ],
                'Beaconing': {
                    'DataRate': 123,
                    'Frequencies': [
                        123,
                    ]
                },
                'MaxEirp': ...
            },
            '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.

        • Beaconing (dict) –

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

          • DataRate (integer) –

            The data rate for gateways that are sending the beacons.

          • Frequencies (list) –

            The frequency list for the gateways to send the beacons.

            • (integer) –

        • MaxEirp (float) –

          The MaxEIRP value.

      • LastUplinkReceivedAt (string) –

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

        Note

        This value is only valid for 3 months.

Exceptions

• IoTWireless.Client.exceptions.ValidationException

• IoTWireless.Client.exceptions.InternalServerException

• IoTWireless.Client.exceptions.ThrottlingException

• IoTWireless.Client.exceptions.AccessDeniedException