GetDevices - AWS Network Manager

GetDevices

Gets information about one or more of your devices in a global network.

Request Syntax

GET /global-networks/globalNetworkId/devices?deviceIds=DeviceIds&maxResults=MaxResults&nextToken=NextToken&siteId=SiteId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

DeviceIds

One or more device IDs. The maximum is 10.

globalNetworkId

The ID of the global network.

Required: Yes

MaxResults

The maximum number of results to return.

Valid Range: Minimum value of 1. Maximum value of 500.

NextToken

The token for the next page of results.

SiteId

The ID of the site.

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "Devices": [ { "CreatedAt": number, "Description": "string", "DeviceArn": "string", "DeviceId": "string", "GlobalNetworkId": "string", "Location": { "Address": "string", "Latitude": "string", "Longitude": "string" }, "Model": "string", "SerialNumber": "string", "SiteId": "string", "State": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "Type": "string", "Vendor": "string" } ], "NextToken": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Devices

The devices.

Type: Array of Device objects

NextToken

The token for the next page of results.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

The request has failed due to an internal error.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource could not be found.

HTTP Status Code: 404

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: