CreateProfile - AWS Transfer Family

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

CreateProfile

创建用于AS2转账的本地或合作伙伴档案。

请求语法

{ "As2Id": "string", "CertificateIds": [ "string" ], "ProfileType": "string", "Tags": [ { "Key": "string", "Value": "string" } ] }

请求参数

有关所有操作的通用参数的信息,请参阅通用参数

该请求接受以下JSON格式的数据。

As2Id

As2IdAS2-name,如 RFC4 130 中所定义的那样。对于入站传输,这是合作伙伴发送的AS2消息的AS2-From标题。对于出站连接器,这是使用StartFileTransferAPI操作发送给合作伙伴的AS2消息的AS2-To标题。此 ID 不能包含空格。

类型:字符串

长度限制:长度下限为 1。长度上限为 128。

模式:[\p{Print}\s]*

必需:是

CertificateIds

已导入证书的标识符数组。您可以使用此标识符来处理配置文件和合作伙伴配置文件。

类型:字符串数组

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

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

必需:否

ProfileType

确定要创建的配置文件类型:

  • 指定 LOCAL 以创建本地配置文件。本地配置文件表示AS2启用的 Transfer Family 服务器组织或群体。

  • 指定 PARTNER 以创建合作伙伴配置文件。合作伙伴配置文件表示 Transfer Family 外部的远程组织。

类型:字符串

有效值:LOCAL | PARTNER

必需:是

Tags

可用于对个人资料进行分组和搜索的键值对。AS2

类型:Tag 对象数组

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

必需:否

响应语法

{ "ProfileId": "string" }

响应元素

如果操作成功,服务将发回 HTTP 200 响应。

以下数据由服务以JSON格式返回。

ProfileId

AS2配置文件的唯一标识符,在API调用成功后返回。

类型:字符串

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

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

错误

有关所有操作的常见错误的信息,请参阅常见错误

InternalServiceError

当 AWS Transfer Family 服务中发生错误时,会引发此异常。

HTTP状态码:500

InvalidRequestException

当客户端提交格式错误的请求时,会引发此异常。

HTTP状态码:400

ResourceNotFoundException

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

HTTP状态码:400

ServiceUnavailableException

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

HTTP状态码:500

ThrottlingException

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

HTTP状态码:400

示例

示例

以下示例创建配置文件,并返回配置文件 ID。

证书IDs是在您运行时创建的import-certificate,一个用于签名证书,一个用于加密证书。

aws transfer create-profile --as2-id MYCORP --certificate-ids c-abcdefg123456hijk c-987654aaaa321bbbb

示例响应

该API调用返回新配置文件的配置文件 ID。

{ "ProfileId": "p-11112222333344444" }

另请参阅

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