IoTWireless / Client / get_wireless_gateway

get_wireless_gateway

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

Parameters:

• Identifier (string) –

  [REQUIRED]

  The identifier of the wireless gateway to get.

• IdentifierType (string) –

  [REQUIRED]

  The type of identifier used in identifier.

Return type:

dict

Returns:

Response Syntax

{
    'Name': 'string',
    'Id': 'string',
    'Description': 'string',
    'LoRaWAN': {
        'GatewayEui': 'string',
        'RfRegion': 'string',
        'JoinEuiFilters': [
            [
                'string',
            ],
        ],
        'NetIdFilters': [
            'string',
        ],
        'SubBands': [
            123,
        ],
        'Beaconing': {
            'DataRate': 123,
            'Frequencies': [
                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.

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

  • 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

• IoTWireless.Client.exceptions.ValidationException

• IoTWireless.Client.exceptions.ResourceNotFoundException

• IoTWireless.Client.exceptions.AccessDeniedException

• IoTWireless.Client.exceptions.InternalServerException

• IoTWireless.Client.exceptions.ThrottlingException