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

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

DescribedAgreement

描述协议的属性。

目录

AccessRole

借助 AS2,您可以通过调用 StartFileTransfer 并在请求参数中指定文件路径 SendFilePaths 来发送文件。我们使用文件的父目录(例如 --send-file-paths /bucket/dir/file.txt,父目录是 /bucket/dir/)来临时存储经过处理的 AS2 消息文件,存储 MDN(当从合作伙伴那里收到时),以及写入包含传输相关元数据的最终 JSON 文件。因此,AccessRole 需要提供对 StartFileTransfer 请求中所使用文件位置父目录的读取和写入权限。此外,您还需要提供对您想要使用 StartFileTransfer 发送的文件父目录的读取和写入权限。

类型:字符串

长度限制:最小长度为 20。最大长度为 2048。

模式:arn:.*role/.*

必需:否

AgreementId

协议的唯一标识符。创建协议时会返回此标识符。

类型:字符串

长度限制:固定长度为 19。

模式:^a-([0-9a-f]{17})$

必需:否

Arn

协议的唯一 Amazon 资源名称(ARN)。

类型:字符串

长度限制:最小长度为 20。长度上限为 1600。

模式:arn:.*

必需:是

BaseDirectory

使用 AS2 协议传输的文件的登录目录(文件夹)。

类型:字符串

长度约束:最大长度为 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 项。

必需:否

另请参阅

有关在特定语言的 Amazon 软件开发工具包中使用此 API 的更多信息,请参阅以下内容: