本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
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
"
}
请求参数
有关所有操作的通用参数的信息,请参见常用参数。
请求接受采用 JSON 格式的以下数据。
- AccessRole
-
连接器用于使用 AS2 或 SFTP 协议发送文件。对于访问角色,请提供的 Amazon 资源名称 (ARN)Amazon Identity and Access Management要使用的角色。
适用于 AS2 连接器
借助 AS2,您可以通过调用
StartFileTransfer
并在请求参数中指定文件路径SendFilePaths
来发送文件。我们使用文件的父目录(例如--send-file-paths /bucket/dir/file.txt
,父目录是/bucket/dir/
)来临时存储经过处理的 AS2 消息文件,存储 MDN(当从合作伙伴那里收到时),以及写入包含传输相关元数据的最终 JSON 文件。因此,AccessRole
需要提供对StartFileTransfer
请求中所使用文件位置父目录的读取和写入权限。此外,您还需要提供对您想要使用StartFileTransfer
发送的文件父目录的读取和写入权限。如果您对 AS2 连接器使用基本身份验证,则访问角色需要
secretsmanager:GetSecretValue
对机密的许可。如果密钥是使用客户管理的密钥而不是使用客户管理的密钥加密的Amazon密钥管理器中的托管密钥,则该角色还需要kms:Decrypt
该密钥的权限。用于 SFTP 连接器
确保访问角色提供对中使用的文件位置的父目录的读取和写入权限
StartFileTransfer
请求。此外,请确保该角色提供secretsmanager:GetSecretValue
许可Amazon Secrets Manager。类型:字符串
长度限制:最小长度为 20。最大长度为 2048。
模式:
arn:.*role/.*
必需:否
- As2Config
-
包含 AS2 连接器对象参数的结构。
类型:As2ConnectorConfig 对象
必需:否
- ConnectorId
-
连接器的唯一标识符。
类型:字符串
长度限制:固定长度为 19。
模式:
^c-([0-9a-f]{17})$
必需:是
- LoggingRole
-
的亚马逊资源名称 (ARN)Amazon Identity and Access Management允许连接器打开的 (IAM) 角色CloudWatch记录亚马逊 S3 事件。设置后,您可以在您的中查看连接器活动CloudWatch日志。
类型:字符串
长度限制:最小长度为 20。最大长度为 2048。
模式:
arn:.*role/.*
必需:否
- SftpConfig
-
包含 SFTP 连接器对象参数的结构。
类型:SftpConnectorConfig 对象
必需:否
- Url
-
合作伙伴的 AS2 或 SFTP 终端节点的 URL。
类型:字符串
长度限制:最大长度为 255。
必需:否
响应语法
{
"ConnectorId": "string"
}
响应元素
如果此操作成功,则该服务将会发送回 HTTP 200 响应。
服务以 JSON 格式返回的以下数据。
- ConnectorId
-
返回您正在更新的连接器对象的标识符。
类型:字符串
长度限制:固定长度为 19。
模式:
^c-([0-9a-f]{17})$
错误
有关所有操作常见错误的信息,请参见常见错误。
- InternalServiceError
-
当中发生错误时会引发此异常Amazon Transfer Family服务。
HTTP 状态代码:500
- InvalidRequestException
-
当客户端提交格式错误的请求时,会引发此异常。
HTTP 状态代码:400
- ResourceExistsException
-
请求的资源不存在,或者存在于为命令指定的区域以外的区域。
HTTP 状态代码:400
- ResourceNotFoundException
-
当找不到资源时,会引发此异常Amazon接送家庭服务。
HTTP 状态代码:400
- ServiceUnavailableException
-
请求失败了,因为Amazon不提供家庭接送服务。
HTTP 状态代码:500
- ThrottlingException
-
由于请求限制而导致请求被拒绝。
HTTP 状态代码:400
另请参阅
有关在特定语言的 Amazon 软件开发工具包中使用此 API 的更多信息,请参阅以下内容: