DescribedAgreement - Amazon Transfer Family
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅 中国的 Amazon Web Services 服务入门 (PDF)

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

DescribedAgreement

描述协议属性。

内容

Arn

协议的唯一亚马逊资源名称 (ARN)。

类型:字符串

长度约束:最小长度为 20。长度上限为 1600。

模式:arn:\S+

必需:是

AccessRole

连接器用于使用AS2或SFTP协议发送文件。对于访问角色,请提供要使用的 Amazon 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 中的 Amazon 托管密钥对密钥进行加密,则该角色还需要该密钥的kms:Decrypt权限。

用于SFTP连接器

因此, 确保提供对 StartFileTransfer 请求中所使用文件位置父目录的读取和写入权限。此外,请确保该角色向提供secretsmanager:GetSecretValue权限 Amazon 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

协议的当前状态为 ACTIVEINACTIVE

类型:字符串

有效值:ACTIVE | INACTIVE

必需:否

Tags

可用于分组和搜索协议的键/值对。

类型:Tag 对象数组

数组成员:最少 1 个物品。最多 50 项。

必需:否

另请参阅

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