本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
UpdateConnector
更新現有連接器的某些參數。提供您要更新的ConnectorId
連接器的 ,以及要更新參數的新值。
請求語法
{
"AccessRole": "string
",
"As2Config": {
"BasicAuthSecretId": "string
",
"Compression": "string
",
"EncryptionAlgorithm": "string
",
"LocalProfileId": "string
",
"MdnResponse": "string
",
"MdnSigningAlgorithm": "string
",
"MessageSubject": "string
",
"PartnerProfileId": "string
",
"SigningAlgorithm": "string
"
},
"ConnectorId": "string
",
"LoggingRole": "string
",
"SftpConfig": {
"TrustedHostKeys": [ "string
" ],
"UserSecretId": "string
"
},
"Url": "string
"
}
請求參數
如需所有動作的一般參數資訊,請參閱《Common Parameters》。
請求接受下列JSON格式的資料。
- 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+
必要:否
- As2Config
-
包含AS2連接器物件參數的結構。
類型:As2ConnectorConfig 物件
必要:否
- ConnectorId
-
連接器的唯一識別符。
類型:字串
長度限制條件:固定長度為 19。
模式:
c-([0-9a-f]{17})
必要:是
- LoggingRole
-
(ARN) 角色的 Amazon Resource Name AWS Identity and Access Management (IAM),允許連接器開啟 Amazon S3 事件 CloudWatch 的記錄。設定時,您可以在 CloudWatch 日誌中檢視連接器活動。
類型:字串
長度限制︰長度下限為 20。長度上限為 2048。
模式:
arn:.*role/\S+
必要:否
- SftpConfig
-
包含SFTP連接器物件參數的結構。
類型:SftpConnectorConfig 物件
必要:否
- Url
-
URL 合作夥伴AS2或SFTP端點的 。
類型:字串
長度限制:長度下限為 0。長度上限為 255。
必要:否
回應語法
{
"ConnectorId": "string"
}
回應元素
如果動作成功,服務會傳回 HTTP 200 個回應。
服務會以 JSON 格式傳回下列資料。
- ConnectorId
-
傳回您要更新之連接器物件的識別碼。
類型:字串
長度限制條件:固定長度為 19。
模式:
c-([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
另請參閱
如需在其中一種語言特定 API中使用此功能的詳細資訊 AWS SDKs,請參閱下列內容: