/wireless-gateways/{Identifier}

The AWS IoT Wireless multi-region endpoint

https://api.iotwireless.{region}.amazonaws.com

GET

Gets information about a wireless gateway.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'https://api.iotwireless.{region}.amazonaws.com/wireless-gateways/?identifierType='

Response Example

200 - Example 1

{
    "Name": "string",
    "Id": "string",
    "Description": "string",
    "LoRaWAN": {
        "GatewayEui": "string",
        "RfRegion": "string",
        "JoinEuiFilters": [
            [
                "string",
                "string"
            ]
        ],
        "NetIdFilters": [
            "string"
        ],
        "SubBands": [
            1
        ]
    },
    "Arn": "string",
    "ThingName": "string",
    "ThingArn": "string"
}

Request

Path Params

Identifier

string

required

The identifier of the wireless gateway to get.

Query Params

identifierType

string

required

The type of identifier used in identifier.

Responses

🟢200Success

application/json

Body

Name

string

optional

The name of the resource.

<= 256 characters

string

optional

The ID of the wireless gateway.

<= 256 characters

Description

string

optional

The description of the resource.

<= 2048 characters

LoRaWAN

object

optional

Information about the wireless gateway.

GatewayEui

string

optional

The gateway's EUI value.

Match pattern:

^(([0-9A-Fa-f]{2}-){7}|([0-9A-Fa-f]{2}:){7}|([0-9A-Fa-f]{2}\s){7}|([0-9A-Fa-f]{2}){7})([0-9A-Fa-f]{2})$

RfRegion

string

optional

The frequency band (RFRegion) value.

<= 64 characters

JoinEuiFilters

array[array (JoinEuiRange) {1}]

JoinEuiFilters

optional

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

>= 0 items<= 3 items

NetIdFilters

array[string]

NetIdFilters

optional

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

>= 0 items<= 10 items

SubBands

array[integer]

SubBands

optional

A list of integer indicating which sub bands are supported by LoRa gateway.

>= 0 items<= 8 items

Arn

string

optional

The Amazon Resource Name of the resource.

ThingName

string

optional

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

optional

The ARN of the thing associated with the wireless gateway.

🟠480ValidationException

🟠481ResourceNotFoundException

🟠482AccessDeniedException

🟠483InternalServerException

🟠484ThrottlingException

Modified at 2022-09-10 19:46:41

/fleet-metric/{metricName}