List edge gateways

GET 
/organizations/:organizationId/edge-gateways

List edge gateways

Request

Path Parameters

organizationId stringrequired

The ID of organization.

Query Parameters

maxResults number

Possible values: >= 10 and <= 100

The maximum number of results to return.

nextToken string

To retrieve the next set of results.

Responses

200

application/json

Schema

Schema

data object[]required
Data of the edge gateway.
Array [
coreDeviceThingName stringrequired
status stringrequired
lastStatusUpdateTimestamp numberrequired
]

Example (from schema)

{
  "data": [
    {
      "coreDeviceThingName": "string",
      "status": "string",
      "lastStatusUpdateTimestamp": 0
    }
  ]
}

Example

{
  "data": [
    {
      "coreDeviceThingName": "EdgeGateway001",
      "status": "ACTIVE",
      "lastStatusUpdateTimestamp": 1700000000000
    }
  ]
}

401

The request has not permission.

application/json

Schema

Schema

error stringrequired

The request has not permission.

message stringrequired

The request has not permission message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "Unauthenticated",
  "message": "Authentication is required and has failed or has not yet been provided."
}

403

The request has not permission.

application/json

Schema

Schema

error stringrequired

The request has not permission.

message stringrequired

The request has not permission message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "Forbidden",
  "message": "Access to the requested resource is forbidden."
}

422

The input data has invalid.

application/json

Schema

Schema

error stringrequired

The input data has invalid.

message stringrequired

The input data has invalid message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "ValidationError",
  "message": "Input data validation failed."
}

Loading...