

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

# DescribeDevice
<a name="API_devicemanagement_DescribeDevice"></a>

デバイスタイプ、ソフトウェアバージョン、IP アドレス、およびロックステータスなど、デバイス固有の情報をチェックします。

## リクエストの構文
<a name="API_devicemanagement_DescribeDevice_RequestSyntax"></a>

```
POST /managed-device/managedDeviceId/describe HTTP/1.1
```

## URI リクエストパラメータ
<a name="API_devicemanagement_DescribeDevice_RequestParameters"></a>

リクエストは、次のURIパラメータを使用します。

 ** [managedDeviceId](#API_devicemanagement_DescribeDevice_RequestSyntax) **   <a name="Snowball-devicemanagement_DescribeDevice-request-uri-managedDeviceId"></a>
情報をチェックしているデバイスの ID。  
長さの制限：最小長は 1 です。最大長は 64 文字です。  
必須：はい

## リクエストボディ
<a name="API_devicemanagement_DescribeDevice_RequestBody"></a>

リクエストにリクエスト本文がありません。

## レスポンスの構文
<a name="API_devicemanagement_DescribeDevice_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "associatedWithJob": "string",
   "deviceCapacities": [ 
      { 
         "available": number,
         "name": "string",
         "total": number,
         "unit": "string",
         "used": number
      }
   ],
   "deviceState": "string",
   "deviceType": "string",
   "lastReachedOutAt": number,
   "lastUpdatedAt": number,
   "managedDeviceArn": "string",
   "managedDeviceId": "string",
   "physicalNetworkInterfaces": [ 
      { 
         "defaultGateway": "string",
         "ipAddress": "string",
         "ipAddressAssignment": "string",
         "macAddress": "string",
         "netmask": "string",
         "physicalConnectorType": "string",
         "physicalNetworkInterfaceId": "string"
      }
   ],
   "software": { 
      "installedVersion": "string",
      "installingVersion": "string",
      "installState": "string"
   },
   "tags": { 
      "string" : "string" 
   }
}
```

## レスポンス要素
<a name="API_devicemanagement_DescribeDevice_ResponseElements"></a>

アクションが成功すると、サービスは 200 HTTP レスポンスを送り返します。

次のデータは、 サービスによって JSON 形式で返されます。

 ** [associatedWithJob](#API_devicemanagement_DescribeDevice_ResponseSyntax) **   <a name="Snowball-devicemanagement_DescribeDevice-response-associatedWithJob"></a>
デバイスの注文時に使用されるジョブの ID。  
型: 文字列

 ** [deviceCapacities](#API_devicemanagement_DescribeDevice_ResponseSyntax) **   <a name="Snowball-devicemanagement_DescribeDevice-response-deviceCapacities"></a>
デバイスのハードウェア仕様。  
型: [Capacity](API_devicemanagement_Capacity.md) オブジェクトの配列  
配列メンバー: 最小数は 0 項目です。最大数は 100 項目です。

 ** [deviceState](#API_devicemanagement_DescribeDevice_ResponseSyntax) **   <a name="Snowball-devicemanagement_DescribeDevice-response-deviceState"></a>
デバイスの現在の状態。  
型: 文字列  
有効な値: `UNLOCKED | LOCKED | UNLOCKING` 

 ** [deviceType](#API_devicemanagement_DescribeDevice_ResponseSyntax) **   <a name="Snowball-devicemanagement_DescribeDevice-response-deviceType"></a>
 AWS Snow Family デバイスのタイプ。  
型: 文字列

 ** [lastReachedOutAt](#API_devicemanagement_DescribeDevice_ResponseSyntax) **   <a name="Snowball-devicemanagement_DescribeDevice-response-lastReachedOutAt"></a>
デバイスが最後に AWS クラウドに連絡した日時。デバイスがオンラインであることを示します。  
型: タイムスタンプ

 ** [lastUpdatedAt](#API_devicemanagement_DescribeDevice_ResponseSyntax) **   <a name="Snowball-devicemanagement_DescribeDevice-response-lastUpdatedAt"></a>
デバイスが最後にアップデートを AWS クラウドにプッシュした日時。デバイスキャッシュがいつ更新されたかを示します。  
型: タイムスタンプ

 ** [managedDeviceArn](#API_devicemanagement_DescribeDevice_ResponseSyntax) **   <a name="Snowball-devicemanagement_DescribeDevice-response-managedDeviceArn"></a>
デバイスの Amazon リソースネーム (ARN）。  
型: 文字列

 ** [managedDeviceId](#API_devicemanagement_DescribeDevice_ResponseSyntax) **   <a name="Snowball-devicemanagement_DescribeDevice-response-managedDeviceId"></a>
情報をチェックしたデバイスの ID。  
型: 文字列  
長さの制限：最小長は 1 です。最大長は 64 文字です。

 ** [physicalNetworkInterfaces](#API_devicemanagement_DescribeDevice_ResponseSyntax) **   <a name="Snowball-devicemanagement_DescribeDevice-response-physicalNetworkInterfaces"></a>
デバイスで使用可能なネットワークインターフェイス。  
型: [PhysicalNetworkInterface](API_devicemanagement_PhysicalNetworkInterface.md) オブジェクトの配列

 ** [software](#API_devicemanagement_DescribeDevice_ResponseSyntax) **   <a name="Snowball-devicemanagement_DescribeDevice-response-software"></a>
デバイスにインストールされているソフトウェア。  
型: [SoftwareInformation](API_devicemanagement_SoftwareInformation.md) オブジェクト

 ** [tags](#API_devicemanagement_DescribeDevice_ResponseSyntax) **   <a name="Snowball-devicemanagement_DescribeDevice-response-tags"></a>
リソースに割り当てるオプションのメタデータ。タグを使用し、目的、所有者、環境などのさまざまな方法でリソースを分類できます。  
型: 文字列間のマッピング

## エラー
<a name="API_devicemanagement_DescribeDevice_Errors"></a>

すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。

 ** AccessDeniedException **   
このアクションを実行する十分なアクセス権限がありません。  
HTTP ステータスコード: 403

 ** InternalServerException **   
リクエストの処理中に予期しないエラーが発生しました。  
HTTP ステータスコード: 500

 ** ResourceNotFoundException **   
リクエストは、存在しないリソースを参照しています。  
HTTP ステータスコード: 404

 ** ThrottlingException **   
リクエストのスロットリングにより、リクエストが拒否されました。  
HTTP ステータスコード: 429

 ** ValidationException **   
入力が AWS サービスで指定された制約を満たさない。  
HTTP ステータスコード: 400

## 以下の資料も参照してください。
<a name="API_devicemanagement_DescribeDevice_SeeAlso"></a>

言語固有の のいずれかAPIでこれを使用する方法の詳細については AWS SDKs、以下を参照してください。
+  [AWS コマンドラインインターフェイス](https://docs.aws.amazon.com/goto/aws-cli/snow-device-management-2021-08-04/DescribeDevice) 
+  [AWS SDK の 。NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/snow-device-management-2021-08-04/DescribeDevice)
+  [AWS SDK C\$1\$1 用](https://docs.aws.amazon.com/goto/SdkForCpp/snow-device-management-2021-08-04/DescribeDevice) 
+  [AWS SDK Go v2 の場合](https://docs.aws.amazon.com/goto/SdkForGoV2/snow-device-management-2021-08-04/DescribeDevice) 
+  [AWS SDK Java V2 用](https://docs.aws.amazon.com/goto/SdkForJavaV2/snow-device-management-2021-08-04/DescribeDevice) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/snow-device-management-2021-08-04/DescribeDevice) 
+  [AWS SDK PHP V3 用](https://docs.aws.amazon.com/goto/SdkForPHPV3/snow-device-management-2021-08-04/DescribeDevice) 
+  [AWS SDK Python 用](https://docs.aws.amazon.com/goto/boto3/snow-device-management-2021-08-04/DescribeDevice) 
+  [AWS SDK Ruby V3 用](https://docs.aws.amazon.com/goto/SdkForRubyV3/snow-device-management-2021-08-04/DescribeDevice) 