本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
ListedServer
返回指定的启用文件传输协议的服务器的属性。
内容
- Arn
-
为要列出的服务器指定唯一 Amazon 资源名称 (ARN)。
类型:字符串
长度约束:最小长度为 20。长度上限为 1600。
模式:
arn:\S+
必需:是
- Domain
-
指定用于文件传输的存储系统的域。
类型:字符串
有效值:
S3 | EFS
必需:否
- EndpointType
-
指定服务器连接到的 VPC 端点类型。如果您的服务器连接到 VPC 端点,则无法通过公共互联网访问您的服务器。
类型:字符串
有效值:
PUBLIC | VPC | VPC_ENDPOINT
必需:否
- IdentityProviderType
-
服务器的身份验证模式。默认值为
SERVICE_MANAGED
,这允许您在 Amazon Transfer Family 服务中存储和访问用户凭证。使用
AWS_DIRECTORY_SERVICE
可以访问 Active Directory 组,这些组位于本地环境中或使用 AD Connector 的 Amazon Directory Service for Microsoft Active Directory 的 Amazon 或 Microsoft Active Directory 中。此选项还要求您使用IdentityProviderDetails
参数提供 Directory ID。使用
API_GATEWAY
值以与您选择的身份提供者集成。API_GATEWAY
设置要求您提供 Amazon API Gateway 端点 URL 以使用IdentityProviderDetails
参数调用身份验证。使用
AWS_LAMBDA
值直接将 Amazon Lambda 函数用作身份提供者。如果选择该值,则必须在Function
数据类型的IdentityProviderDetails
参数中指定 Lambda 函数的 ARN。类型:字符串
有效值:
SERVICE_MANAGED | API_GATEWAY | AWS_DIRECTORY_SERVICE | AWS_LAMBDA
必需:否
- LoggingRole
-
(IAM) 角色的亚马逊资源名称 (ARN),它允许服务器为亚马逊 S3 或 Amazon efSevents 开启亚马逊 CloudWatch 日志记录。Amazon Identity and Access Management设置后,您可以在 CloudWatch 日志中查看用户活动。
类型:字符串
长度约束:最小长度为 20。最大长度为 2048。
模式:
arn:.*role/\S+
必需:否
- ServerId
-
为列出的服务器指定系统分配的唯一标识符。
类型:字符串
长度限制:固定长度为 19。
模式:
s-([0-9a-f]{17})
必需:否
- State
-
所描述的服务器的状况。值为
ONLINE
表示服务器可以接受作业和传输文件。State
值为OFFLINE
表示服务器无法执行文件传输操作。状态
STARTING
和STOPPING
表示服务器处于中间状态,要么无法完全响应,要么未完全脱机。值START_FAILED
或STOP_FAILED
可以表示错误情况。类型:字符串
有效值:
OFFLINE | ONLINE | STARTING | STOPPING | START_FAILED | STOP_FAILED
必需:否
- UserCount
-
指定分配给您在
ServerId
中指定的服务器的用户数。类型:整数
必需:否
另请参阅
有关在特定语言的 Amazon SDK 中使用此 API 的更多信息,请参阅以下内容: