翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
CreateAgent
ストレージ環境にデプロイする AWS DataSync エージェントをアクティブ化します。アクティベーションプロセスでは、エージェントを に関連付けます AWS アカウント。
エージェントをまだデプロイしていない場合は、「Do I need a DataSync agent?」を参照してください。
リクエストの構文
{
"ActivationKey": "string",
"AgentName": "string",
"SecurityGroupArns": [ "string" ],
"SubnetArns": [ "string" ],
"Tags": [
{
"Key": "string",
"Value": "string"
}
],
"VpcEndpointId": "string"
}リクエストパラメータ
すべてのアクションに共通のパラメータの詳細については、「共通パラメータ」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
- ActivationKey
-
DataSync エージェントのアクティベーションキーを指定します。アクティベーションキーがない場合は、「Activating your agent」を参照してください。
タイプ: 文字列
長さの制約: 最大長は 29 です。
パターン:
[A-Z0-9]{5}(-[A-Z0-9]{5}){4}必須: はい
- AgentName
-
エージェントの名前を指定します。覚えやすい名前を指定することをお勧めします。
タイプ: 文字列
長さの制約: 最小長は 0 です。最大長は 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 サービスエンドポイントがあるサブネットの 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}: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 エージェントをアクティブ化します。
{ "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 SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
