create_wireless_gateway

IoTWireless.Client.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',
        'JoinEuiFilters': [
            [
                'string',
            ],
        ],
        'NetIdFilters': [
            'string',
        ],
        'SubBands': [
            123,
        ],
        'Beaconing': {
            'DataRate': 123,
            'Frequencies': [
                123,
            ]
        }
    },
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    ClientRequestToken='string'
)
Parameters
  • 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.

    • 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) --
  • Tags (list) --

    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.

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

Return type

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.

Exceptions

  • IoTWireless.Client.exceptions.ValidationException
  • IoTWireless.Client.exceptions.AccessDeniedException
  • IoTWireless.Client.exceptions.ConflictException
  • IoTWireless.Client.exceptions.InternalServerException
  • IoTWireless.Client.exceptions.ThrottlingException