本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。
啟用您在儲存環境中部署的 AWS DataSync 代理程式。啟用程序會將 代理程式與您的 建立關聯 AWS 帳戶。
如果您尚未部署代理程式，請參閱我需要 DataSync 代理程式嗎？
請求語法
{
"ActivationKey": "string",
"AgentName": "string",
"SecurityGroupArns": [ "string" ],
"SubnetArns": [ "string" ],
"Tags": [
{
"Key": "string",
"Value": "string"
}
],
"VpcEndpointId": "string"
}請求參數
如需所有動作的一般參數資訊，請參閱《Common Parameters》。
請求接受採用 JSON 格式的下列資料。
- ActivationKey
-
指定 DataSync 代理程式的啟用金鑰。如果您沒有啟用金鑰，請參閱啟用您的代理程式。
類型：字串
長度限制：長度上限為 29。
模式：
[A-Z0-9]{5}(-[A-Z0-9]{5}){4}必要：是
- AgentName
-
指定代理程式的名稱。建議您指定可記住的名稱。
類型：字串
長度限制：長度下限為 0。長度上限為 256。
模式：
^[a-zA-Z0-9\s+=._:@/-]+$必要：否
- SecurityGroupArns
-
指定安全群組的 Amazon Resource Name (ARN)，允許代理程式和 VPC 服務端點之間的流量。您只能指定一個 ARN。
類型：字串陣列
陣列成員：固定項目數為 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。
長度限制：長度上限為 128。
模式：
^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):ec2:[a-z\-0-9]*:[0-9]{12}:subnet/.*$必要：否
- Tags
-
指定可協助您分類、篩選和搜尋 AWS 資源的標籤。建議您為客服人員建立至少一個標籤。
類型：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 的詳細資訊，請參閱以下內容：
