2023 年 12 月 7 日より、バージョン 1 DataSync のエージェントは廃止されます。 DataSync コンソールの [エージェント] ページをチェックして、影響を受けるエージェントがいないか確認してください。その場合は、データ転送やストレージ検出の中断を避けるため、その前にそれらのエージェントを交換してください。さらにサポートが必要な場合は、お問い合わせくださいAWS サポート
翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
CreateAgent
AWS DataSyncストレージ環境にデプロイしたエージェントをアクティブ化します。アクティベーションプロセスにより、エージェントがユーザーに関連付けられます。AWS アカウント
まだエージェントをデプロイしていない場合は、以下のトピックで詳細を確認してください。
注記
AWSストレージサービス間で移動する場合は、 DataSync エージェントは必要ありません。
リクエストの構文
{
"ActivationKey": "string",
"AgentName": "string",
"SecurityGroupArns": [ "string" ],
"SubnetArns": [ "string" ],
"Tags": [
{
"Key": "string",
"Value": "string"
}
],
"VpcEndpointId": "string"
}リクエストパラメータ
すべてのアクションに共通のパラメータの詳細については、「共通パラメータ」を参照してください。
リクエストは以下の JSON 形式のデータを受け入れます。
- ActivationKey
-
DataSync エージェントのアクティベーションキーを指定します。アクティベーションキーがない場合は、「エージェントをアクティベートする」を参照してください。
型: 文字列
長さの制限: 最大長は 29 です。
パターン:
[A-Z0-9]{5}(-[A-Z0-9]{5}){4}必須: はい
- AgentName
-
エージェントの名前を指定します。 DataSyncこの名前はコンソールで確認できます。
型: 文字列
長さの制限: 最小長は 1 です。最大長は 256 です。
パターン:
^[a-zA-Z0-9\s+=._:@/-]+$必須: いいえ
- SecurityGroupArns
-
仮想プライベートクラウド (VPC) エンドポイントを使用するときにタスクのネットワークインターフェイスを保護するセキュリティグループの Amazon リソースネーム (ARN) を指定します。指定できる ARN は 1 つだけです。
型: 文字列の配列
配列メンバー: 定数は 1 項目です。
長さの制限: 最大長は 128 です。
パターン:
^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):ec2:[a-z\-0-9]*:[0-9]{12}:security-group/sg-[a-f0-9]+$必須: いいえ
- SubnetArns
-
VPC DataSync エンドポイントを使用するときにタスクを実行するサブネットの ARN を指定します。 DataSync これは転送用のネットワークインターフェースを作成および管理するサブネットです。指定できる ARN は 1 つだけです。
型: 文字列の配列
配列メンバー: 定数は 1 項目です。
長さの制限: 最大長は 128 です。
パターン:
^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):ec2:[a-z\-0-9]*:[0-9]{12}:subnet/.*$必須: いいえ
- Tags
-
AWS リソースの分類、フィルタリング、および検索に役立つラベルを指定します。エージェントには少なくとも 1 つのタグを作成することをおすすめします。
型: TagListEntry オブジェクトの配列
配列メンバー: 最小数は 0 項目です。最大数は 50 項目です。
必須: いいえ
- VpcEndpointId
-
エージェントが接続する VPC エンドポイントの ID を指定します。たとえば、VPC エンドポイント ID は次のようになります
vpce-01234d5aff67890e1。重要
使用する VPC エンドポイントには、 DataSync サービス名 (例:
com.amazonaws.us-east-2.datasync) を含める必要があります。型: 文字列
パターン:
^vpce-[0-9a-f]{17}$必須: いいえ
レスポンスの構文
{
"AgentArn": "string"
}レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
- AgentArn
-
アクティベートしたばかりのエージェントの ARN。ListAgentsオペレーションを使用して、AWS アカウントAWS リージョンおよび内のエージェントのリストを返します。
型: 文字列
長さの制限: 最大長は 128 です。
パターン:
^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$
エラー
すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。
- InternalException
-
この例外は、AWS DataSync サービスでエラーが発生した場合にスローされます。
HTTP ステータスコード: 500
- InvalidRequestException
-
この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。
HTTP ステータスコード: 400
例
リクエスト例
次の例では、 DataSync エージェントをアクティベートし、と関連付けます。AWS アカウント
{ "ActivationKey": "AAAAA-1AAAA-BB1CC-33333-EEEEE", "AgentName": "MyAgent", "Tags": [{ "Key": "Job", "Value": "TransferJob-1" }] }
レスポンス例
レスポンスは、アクティブ化されたエージェントの ARN を返します。
{ "AgentArn": "arn:aws:datasync:us-east-2:111222333444:agent/agent-0b0addbeef44baca3" }
以下の資料も参照してください。
言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
