CreateProfile - AWS Transfer Family

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

CreateProfile

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

請求語法

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

請求參數

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

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

As2Id

As2IdAS2-name ,如 RFC4130 中所定義。對於傳入傳輸,這是從合作夥伴AS2傳送訊息的AS2-From標頭。對於傳出連接器,這是使用 StartFileTransferAPI操作傳送給合作夥伴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" }

回應元素

如果動作成功,服務會傳回 200 HTTP 個回應。

服務會以 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。

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

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

回應範例

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

{ "ProfileId": "p-11112222333344444" }

另請參閱

如需在其中一種語言特定的 API中使用此功能的詳細資訊 AWS SDKs,請參閱下列內容: