2023 年 12 月 7 日より、バージョン 1 DataSync のエージェントは廃止されます。 DataSync コンソールの [エージェント] ページをチェックして、影響を受けるエージェントがいないか確認してください。その場合は、データ転送やストレージ検出の中断を避けるため、その前にそれらのエージェントを交換してください。さらにサポートが必要な場合は、お問い合わせくださいAWS Support
翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
ListAgents
AWS DataSyncAWS アカウントAWS リージョンリクエストで指定された内のに属するエージェントのリストを返します。
ページネーションを使用すると、レスポンスで返されるエージェントの数を減らすことができます。レスポンスで省略されたエージェントのリストが返された場合、レスポンスにはマーカーが含まれます。このマーカーは、次のリクエストで指定して、エージェントの次のページを取得できます。
ListAgents最終的には一貫性があります。つまり、操作を実行した結果には、エージェントを作成または削除したばかりであることが反映されない場合があります。たとえば、CreateAgentを使用してエージェントを作成し、すぐに実行した場合ListAgents、そのエージェントはすぐにはリストに表示されない場合があります。このような状況では、を使用してエージェントが作成 (または削除) されたかどうかをいつでも確認できますDescribeAgent。
リクエストの構文
{
"MaxResults": number,
"NextToken": "string"
}リクエストパラメータ
すべてのアクションに共通のパラメータの詳細については、「共通パラメータ」を参照してください。
リクエストは以下の JSON 形式のデータを受け入れます。
- MaxResults
-
DataSync レスポンスに表示するエージェントの最大数を指定します。デフォルトでは、レスポンスには最大 100 人のエージェントが表示されます。
型: 整数
有効な範囲: 最小値 は 0 です。最大値は 100 です。
必須: いいえ
- NextToken
-
レスポンス内の次の結果リストの開始位置を示す不透明な文字列を指定します。
型: 文字列
長さの制限: 最大長は 65,535 です。
パターン:
[a-zA-Z0-9=_-]+必須: いいえ
レスポンスの構文
{
"Agents": [
{
"AgentArn": "string",
"Name": "string",
"Platform": {
"Version": "string"
},
"Status": "string"
}
],
"NextToken": "string"
}レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
- Agents
-
DataSync AWS アカウントAWS リージョンリクエストで指定されたユーザー内のエージェントのリスト。このリストは、エージェントの Amazon リソースネーム (ARN) の順に並べられています。
型: AgentListEntry オブジェクトの配列
- NextToken
-
レスポンス内の次の結果リストの開始位置を示す不透明な文字列。
型: 文字列
長さの制限: 最大長は 65,535 です。
パターン:
[a-zA-Z0-9=_-]+
エラー
すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。
- InternalException
-
この例外は、AWS DataSync サービスでエラーが発生した場合にスローされます。
HTTP ステータスコード: 500
- InvalidRequestException
-
この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。
HTTP ステータスコード: 400
以下の資料も参照してください。
言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
