CreateProfile - AWS Transfer Family
請求語法請求參數回應語法回應元素錯誤範例另請參閱

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

CreateProfile

建立要用於 AS2 傳輸的本機或合作夥伴設定檔。

請求語法

{
   "As2Id": "string",
   "CertificateIds": [ "string" ],
   "ProfileType": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}

請求參數

如需所有動作的一般參數資訊，請參閱《Common Parameters》。

請求接受採用 JSON 格式的下列資料。

As2Id

As2Id 是 AS2 名稱，如 RFC 4130 中所定義。若為對內傳輸，這是合作夥伴傳送的 AS2 訊息 AS2-From 標頭。若為對外連接器，這是使用 StartFileTransfer API 操作傳送給合作夥伴的 AS2 訊息 AS2-To 標頭。此 ID 不可包含空格。

類型：字串

長度限制：長度下限為 1。長度上限為 128。

模式：[\p{Print}\s]*

必要：是

CertificateIds

已匯入憑證的識別碼陣列。您可以使用此識別碼處理設定檔和合作夥伴設定檔。

類型：字串陣列

長度約束：固定長度為 22。

模式：cert-([0-9a-f]{17})

必要：否

ProfileType

決定要建立的設定檔類型：

  • 指定LOCAL此選項可建立本機設定檔。本機設定檔代表已啟用 AS2 的「Transfer Family」伺服器組織或對象。

  • 指定PARTNER以建立合作夥伴設定檔。合作夥伴設定檔代表「Transfer Family」外部的遠端組織。

類型：字串

有效值:LOCAL | PARTNER

必要：是

Tags

可用於分組和搜尋 AS2 設定檔的索引鍵值配對。

類型：Tag 物件陣列

陣列成員：項目數下限為 1。項目數上限為 50。

必要：否

回應語法

{
   "ProfileId": "string"
}

回應元素

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

ProfileId

AS2 設定檔的唯一識別碼，在 API 呼叫成功後傳回。

類型：字串

長度約束：固定長度為 19。

模式：p-([0-9a-f]{17})

錯誤

如需所有動作常見錯誤的資訊，請參閱常見錯誤。

InternalServiceError

當在 AWS Transfer Family 服務中發生錯誤時，拋出此異常。

HTTP 狀態碼：500

InvalidRequestException

當客戶端提交格式錯誤的請求時，拋出此異常。

HTTP 狀態碼：400

ResourceNotFoundException

當 AWS Transfer Family 服務找不到資源時，會擲回此例外狀況。

HTTP 狀態碼：400

ServiceUnavailableException

申請失敗，因為 AWS Transfer Family 服務不可用。

HTTP 狀態碼：500

ThrottlingException

由於請求調節，因此請求遭到拒絕。

HTTP 狀態碼：400

範例

範例

下列範例會建立描述檔，並傳回描述檔 ID。

憑證 ID 會在您執行時建立import-certificate，一個用於簽署憑證，另一個用於加密憑證。

aws transfer create-profile --as2-id MYCORP --certificate-ids c-abcdefg123456hijk
               c-987654aaaa321bbbb

回應範例

API 呼叫會傳回新設定檔的描述檔 ID。

{
    "ProfileId": "p-11112222333344444"
}

另請參閱

如需在其中一個特定語言 AWS SDK 中使用此 API 的詳細資訊，請參閱下列內容：