ListDevices
コマンドが実行されるAWS リージョン でAWS Snow Device Management を有効にしているすべてのデバイスのリストをAWS アカウント に返します。
リクエストの構文
GET /managed-devices?jobId=jobId&maxResults=maxResults&nextToken=nextToken HTTP/1.1
URI リクエストパラメータ
リクエストでは、次の URI パラメータを使用します。
- jobId
-
デバイスを注文するために使用するジョブの ID。
長さの制限：最小長は 1 です。最大長は 64 文字です。
- maxResults
-
1 ページあたりにリストするデバイスの最大数。
有効範囲: 最小値 は 1 です。最大値は 100 です。
- nextToken
-
結果の次ページに進むページ割りトークン。
長さの制限：最小長は 1 です。最大長は 1,024 です。
パターン:
[a-zA-Z0-9+/=]*
リクエストボディ
リクエストにリクエスト本文がありません。
レスポンスの構文
HTTP/1.1 200
Content-type: application/json
{
"devices": [
{
"associatedWithJob": "string",
"managedDeviceArn": "string",
"managedDeviceId": "string",
"tags": {
"string" : "string"
}
}
],
"nextToken": "string"
}レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
- devices
-
デバイスに関する情報を含むデバイス構造のリスト。
型: DeviceSummary オブジェクトの配列
- nextToken
-
デバイスの次ページに進むページ割りトークン。
型: 文字列
長さの制限: 最小長は 1 です。最大長は 1,024 です。
パターン:
[a-zA-Z0-9+/=]*
エラー
すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。
- AccessDeniedException
-
このアクションを実行する十分なアクセス権限がありません。
HTTP ステータスコード: 403
- InternalServerException
-
リクエストの処理中に予期しないエラーが発生しました。
HTTP ステータスコード：500
- ThrottlingException
-
リクエストのスロットリングにより、リクエストが拒否されました。
HTTP ステータスコード: 429
- ValidationException
-
入力が、AWS サービスで指定された制約を満たしていません。
HTTP ステータスコード：400
以下の資料も参照してください。
言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
