ListProfiles - AWS Transfer Family

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

ListProfiles

返回系统配置文件列表。如果要将结果限制为某个数值,请为 MaxResults 参数提供一个值。如果您之前运行过该命令并收到了的 NextToken 值,则可以提供该值,以继续从上次中断的地方列出配置文件。

请求语法

{ "MaxResults": number, "NextToken": "string", "ProfileType": "string" }

请求参数

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

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

MaxResults

要返回的配置文件的最大数量。

类型:整数

有效范围:最小值为 1。最大值为 1000。

必需:否

NextToken

如果未返回其他结果,则返回 NextToken 参数。您可以将该值用于后续调用 ListProfiles,以继续列出结果。

类型:字符串

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

必需:否

ProfileType

指示是否仅列出 LOCAL 类型配置文件或仅列出 PARTNER 类型配置文件。如果请求中未提供,则该命令会列出所有类型的配置文件。

类型:字符串

有效值:LOCAL | PARTNER

必需:否

响应语法

{ "NextToken": "string", "Profiles": [ { "Arn": "string", "As2Id": "string", "ProfileId": "string", "ProfileType": "string" } ] }

响应元素

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

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

NextToken

返回一令牌,您可以使用此令牌再次调用 ListProfiles,并接收其他结果(如有)。

类型:字符串

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

Profiles

返回数组,其中的每个项目都包含配置文件的详细信息。

类型:ListedProfile 对象数组

错误

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

InternalServiceError

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

HTTP状态码:500

InvalidNextTokenException

传递的 NextToken 参数无效。

HTTP状态码:400

InvalidRequestException

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

HTTP状态码:400

ResourceNotFoundException

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

HTTP状态码:400

ServiceUnavailableException

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

HTTP状态码:500

另请参阅

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