UpdateConnector - AWS Transfer Family

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

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协议发送文件。对于访问角色,请提供要使用的 AWS Identity and Access Management 角色的 Amazon 资源名称 (ARN)。

用于AS2连接器

使用AS2,您可以通过调用请求参数StartFileTransfer并在请求参数中指定文件路径来发送文件SendFilePaths。我们使用该文件的父目录(例如,for--send-file-paths /bucket/dir/file.txt,父目录是/bucket/dir/)来临时存储已处理的AS2消息文件,存储我们从合作伙伴那里收到消息的时间,并写入包含传输相关元数据的最终JSON文件。MDN因此,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

() 角色的亚马逊资源名称 AWS Identity and Access Management (ARNIAM),允许连接器开启对 Amazon S3 事件的 CloudWatch 日志记录。设置后,您可以在 CloudWatch 日志中查看连接器活动。

类型:字符串

长度约束:最小长度为 20。最大长度为 2048。

模式:arn:.*role/\S+

必需:否

SftpConfig

一种包含SFTP连接器对象参数的结构。

类型:SftpConnectorConfig 对象

必需:否

Url

合作伙伴AS2或SFTP终端节点的。URL

类型:字符串

长度约束:最小长度为 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

当 Transfer Family 服务找不到资源时,就会 AWS引发此异常。

HTTP状态码:400

ServiceUnavailableException

请求失败,因为 Trans AWS fer Family 服务不可用。

HTTP状态码:500

ThrottlingException

由于请求限制而导致请求被拒绝。

HTTP状态码:400

另请参阅

有关在特定语言API中使用它的更多信息 AWS SDKs,请参阅以下内容: