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

# DescribeAgent
<a name="API_DescribeAgent"></a>

エージェントの名前、サービスエンドポイントタイプ、ステータスなど、 AWS DataSync エージェントに関する情報を返します。

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

```
{
   "AgentArn": "string"
}
```

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

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

リクエストは以下のデータを JSON 形式で受け入れます。

 ** [AgentArn](#API_DescribeAgent_RequestSyntax) **   <a name="DataSync-DescribeAgent-request-AgentArn"></a>
情報を取得する DataSync エージェントの Amazon リソースネーム (ARN) を指定します。  
タイプ: 文字列  
長さの制約: 最大長は 128 です。  
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$`   
必須: はい

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

```
{
   "AgentArn": "string",
   "CreationTime": number,
   "EndpointType": "string",
   "LastConnectionTime": number,
   "Name": "string",
   "Platform": { 
      "Version": "string"
   },
   "PrivateLinkConfig": { 
      "PrivateLinkEndpoint": "string",
      "SecurityGroupArns": [ "string" ],
      "SubnetArns": [ "string" ],
      "VpcEndpointId": "string"
   },
   "Status": "string"
}
```

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

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

サービスから以下のデータが JSON 形式で返されます。

 ** [AgentArn](#API_DescribeAgent_ResponseSyntax) **   <a name="DataSync-DescribeAgent-response-AgentArn"></a>
エージェントの ARN。  
タイプ: 文字列  
長さの制約: 最大長は 128 です。  
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$` 

 ** [CreationTime](#API_DescribeAgent_ResponseSyntax) **   <a name="DataSync-DescribeAgent-response-CreationTime"></a>
エージェントが[アクティブ化](https://docs.aws.amazon.com/datasync/latest/userguide/activate-agent.html)された時刻。  
タイプ: タイムスタンプ

 ** [EndpointType](#API_DescribeAgent_ResponseSyntax) **   <a name="DataSync-DescribeAgent-response-EndpointType"></a>
エージェントが接続されている[サービスエンドポイント](https://docs.aws.amazon.com/datasync/latest/userguide/choose-service-endpoint.html)のタイプ。  
タイプ: 文字列  
有効な値：`PUBLIC | PRIVATE_LINK | FIPS | FIPS_PRIVATE_LINK`

 ** [LastConnectionTime](#API_DescribeAgent_ResponseSyntax) **   <a name="DataSync-DescribeAgent-response-LastConnectionTime"></a>
エージェントが最後に DataSync サービスと通信した時刻。  
タイプ: タイムスタンプ

 ** [Name](#API_DescribeAgent_ResponseSyntax) **   <a name="DataSync-DescribeAgent-response-Name"></a>
エージェントの名前。  
タイプ: 文字列  
長さの制約: 最小長は 0 です。最大長は 256 です。  
パターン: `^[a-zA-Z0-9\s+=._:@/-]+$` 

 ** [Platform](#API_DescribeAgent_ResponseSyntax) **   <a name="DataSync-DescribeAgent-response-Platform"></a>
バージョン番号など、エージェントに関するプラットフォーム関連の詳細。  
タイプ: [Platform](API_Platform.md) オブジェクト

 ** [PrivateLinkConfig](#API_DescribeAgent_ResponseSyntax) **   <a name="DataSync-DescribeAgent-response-PrivateLinkConfig"></a>
[VPC サービスエンドポイント](https://docs.aws.amazon.com/datasync/latest/userguide/choose-service-endpoint.html#choose-service-endpoint-vpc)に接続するときにエージェントが使用するネットワーク設定。  
タイプ: [PrivateLinkConfig](API_PrivateLinkConfig.md) オブジェクト

 ** [Status](#API_DescribeAgent_ResponseSyntax) **   <a name="DataSync-DescribeAgent-response-Status"></a>
エージェントのステータス。  
+ ステータスが `ONLINE` の場合、エージェントは適切に構成されており、使用可能です。
+ ステータスが `OFFLINE` の場合、エージェントは DataSync と 5 分以上通信していません。これは、いくつかの理由で発生する可能性があります。詳細については、「[エージェントがオフラインの場合の対処方法](https://docs.aws.amazon.com/datasync/latest/userguide/troubleshooting-datasync-agents.html#troubleshoot-agent-offline)」を参照してください。
タイプ: 文字列  
有効な値：`ONLINE | OFFLINE`

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

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

 ** InternalException **   
この例外は、 AWS DataSync サービスでエラーが発生した場合にスローされます。  
HTTP ステータスコード: 500

 ** InvalidRequestException **   
この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。  
HTTP ステータスコード: 400

## 例
<a name="API_DescribeAgent_Examples"></a>

### リクエスト例
<a name="API_DescribeAgent_Example_1"></a>

次の例では、リクエストで指定されたエージェントに関する情報を返します。

```
{
  "AgentArn": "arn:aws:datasync:us-east-2:111122223333:agent/agent-1234567890abcdef0"
}
```

### レスポンス例
<a name="API_DescribeAgent_Example_2"></a>

次のレスポンス例は、パブリックサービスエンドポイントを使用するエージェントについて説明しています。

```
{
    "AgentArn": "arn:aws:datasync:us-east-2:111122223333:agent/agent-1234567890abcdef0",
    "Name": "Data center migration agent",
    "Status": "ONLINE",
    "LastConnectionTime": "2022-10-17T17:21:35.540000+00:00",
    "CreationTime": "2022-10-05T20:52:29.499000+00:00",
    "EndpointType": "PUBLIC",
    "Platform": {
        "Version": "2"
    }
}
```

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

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