CreateAccess

管理员使用它来选择目录中的哪些组应该有权使用启用的协议上传和下载文件Amazon Transfer Family。例如，Microsoft Active Directory 可能包含 50,000 个用户，但可能只有一小部分用户需要能够将文件传输到服务器。管理员可以使用CreateAccess将访问权限限制为需要此功能的正确用户组。

请求语法


{
   "ExternalId": "string",
   "HomeDirectory": "string",
   "HomeDirectoryMappings": [ 
      { 
         "Entry": "string",
         "Target": "string"
      }
   ],
   "HomeDirectoryType": "string",
   "Policy": "string",
   "PosixProfile": { 
      "Gid": number,
      "SecondaryGids": [ number ],
      "Uid": number
   },
   "Role": "string",
   "ServerId": "string"
}

请求参数

有关所有操作的公用参数的信息，请参阅常用参数。

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

ExternalId

标识目录中特定群组所需的唯一标识符。您关联的群组的用户可以通过启用的协议使用访问您的 Amazon S3 或 Amazon EFS 资源Amazon Transfer Family。如果您知道组名，则可以使用 Windows 运行以下命令来查看 SID 值 PowerShell。

Get-ADGroup -Filter {samAccountName -like "YourGroupName*"} -Properties * | Select SamAccountName,ObjectSid

在该命令中，YourGroupName用你的 Active Directory 组的名称替换。

用于验证此参数的正则表达式为由大小写字母数字字符组成的字符串（不包含空格）。此外，还可以包含下划线或以下任何字符：=, . @: /-

类型：字符串

长度限制：最小长度为 1。长度上限为 256。

模式：^S-1-[\d-]+$

必需：是

HomeDirectory

用户使用客户端登录服务器时的登录目录（文件夹）。

HomeDirectory 示例为 /bucket_name/home/mydirectory。

类型：字符串

长度约束：最大长度为 1024。

模式：^$|/.*

必需：否

HomeDirectoryMappings

逻辑目录映射指定哪些 Amazon S3 或 Amazon EFS 路径和密钥应对您的用户可见，以及使其对用户可见的方式。您必须指定Entry和Target对，其中Entry显示如何使路径可见，是实际的 Amazon S3 或 Amazon EFS 路径。Target如果您只指定一个目标，则将按原样显示。您还必须确保您的Amazon Identity and Access Management (IAM) 角色提供对中路径的访问权限Target。只有在设置为 LOGHomeDirectoryType IAL 时才能设置此值。

以下是Entry和Target对示例。

[ { "Entry": "/directory1", "Target": "/bucket_name/home/mydirectory" } ]

在大多数情况下，您可以使用此值而不是会话策略将您的用户锁定到指定的主目录（”chroot “）。为此，您可以设置Entry为参数值/并Target将其设置为HomeDirectory参数值。

以下是的Entry和Target对示例chroot。

[ { "Entry": "/", "Target": "/bucket_name/home/mydirectory" } ]

类型：HomeDirectoryMapEntry 对象数组

数组成员：最少 1 项。最多 50 项。

必需：否

HomeDirectoryType

您希望用户在登录服务器时，用户主目录的登录目录（文件夹）的类型。如果您将其设置为 PATH，则用户将在其文件传输协议客户端中原样看到 Amazon S3 桶或 EFS 的绝对路径。如果您将其设置为 LOGICAL，则需要针对您希望如何使 Amazon S3 或 Amazon EFS 路径对用户可见，在 HomeDirectoryMappings 中提供映射。

类型：字符串

有效值: PATH | LOGICAL

必需：否

Policy

适用于您的用户的会话策略，可让您跨多个用户使用相同的Amazon Identity and Access Management (IAM) 角色。此策略将用户的访问范围缩小至 Amazon S3 存储桶的一部分。可在此策略中使用的变量包括 ${Transfer:UserName}、${Transfer:HomeDirectory} 和 ${Transfer:HomeBucket}。

注意

此政策仅在的域ServerId为 Amazon S3 时适用。Amazon EFS 不使用会话策略。

对于会话测量，Amazon Transfer Family 将策略存储为 JSON blob，而不是策略的 Amazon 资源名称（ARN）。您将策略保存为 JSON blob 并将其传递给 Policy 参数。

有关会话策略的示例，请参阅示例会话策略。

有关更多信息，请参阅 Amazon Security Token ServiceAPI 参考AssumeRole中的。

类型：字符串

长度限制：最大长度为 2048。

必需：否

PosixProfile

完整的 POSIX 身份，包括用户 ID (Uid)、组 ID (Gid) 和任何辅助组 ID (SecondaryGids)，用于控制用户对 Amazon EFS 文件系统的访问。POSIX 权限针对文件系统中的文件和目录设置，用于确定用户在将文件传入和传出 Amazon EFS 文件系统时获得的访问权限级别。

类型：PosixProfile 对象

必需：否

Role

控制用户对 Amazon S3 桶或 Amazon EFS 文件系统访问权限的 Amazon Identity and Access Management（IAM）角色的 Amazon 资源名称（ARN）。附加到此角色的策略确定在将文件传入和传出 Amazon S3 桶或 Amazon EFS 文件系统时要为用户提供的访问权限级别。IAM 角色还应包含一个信任关系，从而允许服务器在为用户的传输请求提供服务时访问您的资源。

类型：字符串

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

模式：arn:.*role/.*

必需：是

ServerId

服务器实例的系统分配的唯一标识符。这是将您的用户添加到的特定服务器。

类型：字符串

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

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

必需：是

响应语法


{
   "ExternalId": "string",
   "ServerId": "string"
}

响应元素

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

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

ExternalId

群组的外部标识符，该群组的用户可以通过启用的协议访问您的 Amazon S3 或 Amazon EFS 资源Amazon Transfer Family。

类型：字符串

长度限制：最小长度为 1。长度上限为 256。

模式：^S-1-[\d-]+$

ServerId

用户连接到的服务器的标识符。

类型：字符串

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

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

错误

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

InternalServiceError

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

HTTP 状态代码：500

InvalidRequestException

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

HTTP 状态代码：400

ResourceExistsException

请求的资源不存在。

HTTP 状态代码：400

ResourceNotFoundException

当 Transfer Family 服务找不到资源时，会Amazon引发此异常。

HTTP 状态代码：400

ServiceUnavailableException

由于 Transfer FamAmazon ily 服务不可用，请求失败。

HTTP 状态代码：500

另请参阅

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

Javascript 在您的浏览器中被禁用或不可用。

要使用 Amazon Web Services 文档，必须启用 Javascript。请参阅浏览器的帮助页面以了解相关说明。

操作

CreateAgreement