本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
DescribedAgreement
描述協議的屬性。
目錄
- Arn
-
合約的唯一 Amazon Resource Name (ARN)。
類型:字串
長度限制︰長度下限為 20。長度上限為 1600。
模式:
arn:\S+
必要:是
- AccessRole
-
連接器用於使用 AS2或 SFTP通訊協定傳送檔案。針對存取角色,提供要使用 AWS Identity and Access Management 的角色的 Amazon Resource Name (ARN)。
對於AS2連接器
使用 AS2時,您可以呼叫
StartFileTransfer
並指定請求參數 中的檔案路徑來傳送檔案SendFilePaths
。我們使用檔案的父目錄 (例如--send-file-paths /bucket/dir/file.txt
,對於 ,父目錄為/bucket/dir/
) 來暫時存放已處理AS2的訊息檔案、MDN在我們從合作夥伴收到時存放 ,以及撰寫包含傳輸相關中繼資料的最終JSON檔案。因此,AccessRole
需要針對StartFileTransfer
請求中使用之檔案位置的父目錄提供讀寫權限。此外,還需要針對欲透過StartFileTransfer
傳送之檔案的父目錄提供讀寫權限。如果您為AS2連接器使用基本身分驗證,存取角色需要秘密的
secretsmanager:GetSecretValue
許可。如果秘密是使用客戶受管金鑰而非 Secrets Manager 中的 AWS 受管金鑰加密,則角色也需要該金鑰的kms:Decrypt
許可。對於SFTP連接器
請確定存取角色提供對
StartFileTransfer
請求中所用檔案位置之父目錄的讀取和寫入存取權。此外,請確定角色提供secretsmanager:GetSecretValue
許可 AWS Secrets Manager。類型:字串
長度限制︰長度下限為 20。長度上限為 2048。
模式:
arn:.*role/\S+
必要:否
- AgreementId
-
協議的唯一識別符。當您建立協議時,會傳回此識別碼。
類型:字串
長度限制條件:固定長度為 19。
模式:
a-([0-9a-f]{17})
必要:否
- BaseDirectory
-
使用AS2通訊協定傳輸之檔案的登陸目錄 (資料夾)。
類型:字串
長度限制:長度下限為 0。長度上限為 1024。
模式:
(|/.*)
必要:否
- Description
-
用於識別協議的名稱或簡短描述。
類型:字串
長度限制:長度下限為 1。長度上限為 200。
模式:
[\p{Graph}]+
必要:否
- LocalProfileId
-
AS2 本機設定檔的唯一識別符。
類型:字串
長度限制條件:固定長度為 19。
模式:
p-([0-9a-f]{17})
必要:否
- PartnerProfileId
-
協議中使用之合作夥伴設定檔的唯一識別碼。
類型:字串
長度限制條件:固定長度為 19。
模式:
p-([0-9a-f]{17})
必要:否
- ServerId
-
伺服器執行個體的系統指派唯一識別碼。此識別碼可指示協議使用的特定伺服器。
類型:字串
長度限制條件:固定長度為 19。
模式:
s-([0-9a-f]{17})
必要:否
- Status
-
協議的目前狀態,
ACTIVE
或INACTIVE
。類型:字串
有效值:
ACTIVE | INACTIVE
必要:否
- Tags
-
可用於進行協議分組和搜尋的金鑰/值對。
類型:Tag 物件陣列
陣列成員:項目數下限為 1。項目數上限為 50。
必要:否
另請參閱
如需在其中一種語言特定 API中使用此功能的詳細資訊 AWS SDKs,請參閱下列內容: