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

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

ListedServer

返回指定的启用文件传输协议的服务器的属性。

Contents

Arn

指定要列出的服务器的唯一 Amazon 资源名称 (ARN)。

类型: 字符串

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

模式:arn:.*

:必需 是

Domain

指定用于文件传输的存储系统的域。

类型: 字符串

有效值: S3 | EFS

:必需 否

EndpointType

指定服务器连接到的 VPC 终端节点的类型。如果您的服务器连接到 VPC 终端节点,则无法通过公共 Internet 访问您的服务器。

类型: 字符串

有效值: PUBLIC | VPC | VPC_ENDPOINT

:必需 否

IdentityProviderType

指定服务器的身份验证模式。默认值是 。SERVICE_MANAGED,这允许您在AmazonTransfer Family 服务。

使用AWS_DIRECTORY_SERVICE以提供对活动目录组的访问权限Amazon托管活动目录或 Microsoft 活动目录在内部部署环境中或Amazon使用 AD 连接器。此选项还要求您使用IdentityProviderDetails参数。

使用 API_GATEWAY 值以与您选择的身份提供商集成。API_GATEWAY 设置要求您提供 API Gateway 终端节点 URL 以使用 IdentityProviderDetails 参数调用身份验证。

类型: 字符串

有效值: SERVICE_MANAGED | API_GATEWAY | AWS_DIRECTORY_SERVICE

:必需 否

LoggingRole

指定AmazonIdentity and Access Management (IAM) 角色允许服务器为 Amazon S3 或 Amazon EFS 事件打开 Amazon CloudWatch 日志记录。设置后,可以在您的 CloudWatch 日志中查看用户活动。

类型: 字符串

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

模式:arn:.*role/.*

:必需 否

ServerId

指定为列出的服务器分配的唯一系统标识符。

类型: 字符串

长度约束:固定长度为 19。

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

:必需 否

State

指定所描述的服务器的服务器的条件。值是ONLINE表示服务器可以接受作业和传输文件。AState对于是必需的OFFLINE意味着服务器无法执行文件传输操作。

状态STARTINGSTOPPING表示服务器处于中间状态,要么无法完全响应,要么不完全脱机。对于是必需的START_FAILED或者STOP_FAILED可以指示错误情形。

类型: 字符串

有效值: OFFLINE | ONLINE | STARTING | STOPPING | START_FAILED | STOP_FAILED

:必需 否

UserCount

指定分配给使用ServerId.

类型: 整数

:必需 否

另请参阅

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