本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。
UpdateAgreement
更新現有協定的部分參數。提供您要ServerId更新之協定的AgreementId和，以及要更新之參數的新值。
請求語法
{
"AccessRole": "string",
"AgreementId": "string",
"BaseDirectory": "string",
"Description": "string",
"LocalProfileId": "string",
"PartnerProfileId": "string",
"ServerId": "string",
"Status": "string"
}請求參數
如需所有動作的一般參數相關資訊，請參閱《Common Parameters》。
請求接受採用 JSON 格式的下列資料。
- AccessRole
-
連接器可用來使用 AS2 或 SFTP 通訊協定來傳送檔案。對於存取角色，請提供要使用之AWS Identity and Access Management角色的 Amazon 資源名稱 (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
-
若要變更傳輸檔案的登陸目錄 (資料夾)，請提供您要使用的值區資料夾，例如
/DOC-EXAMPLE-BUCKET/home/mydirectory。類型：字串
長度限制：長度下限為 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必要：否
回應語法
{
"AgreementId": "string"
}回應元素
如果動作成功，則服務傳回 HTTP 200 回應。
服務會傳回下列 JSON 格式的資料。
- AgreementId
-
合約的唯一識別碼。建立協定時會傳回此識別元。
類型：字串
長度約束：固定長度為 19。
模式：
a-([0-9a-f]{17})
錯誤
如需所有動作常見錯誤的資訊，請參閱常見錯誤。
- InternalServiceError
-
當在AWS Transfer Family服務中發生錯誤時，拋出此異常。
HTTP 狀態碼：500
- InvalidRequestException
-
當客戶端提交格式錯誤的請求時，拋出此異常。
HTTP 狀態碼：400
- ResourceExistsException
-
請求的資源不存在，或存在於為命令指定的區域以外的區域中。
HTTP 狀態碼：400
- ResourceNotFoundException
-
當 AWS Transfer Family 服務找不到資源時，會擲回此例外狀況。
HTTP 狀態碼：400
- ServiceUnavailableException
-
申請失敗，因為 AWS Transfer Family 服務不可用。
HTTP 狀態碼：500
- ThrottlingException
-
由於請求調節，因此請求遭到拒絕。
HTTP 狀態碼：400
另請參閱
如需在語言特定的 AWS 開發套件之一中使用此 API 的詳細資訊，請參閱下列說明：
