구문 요청 요청 파라미터 응답 구문 Response Elements Errors 참고

CreateAccess

관리자가 디렉터리에서 를 사용하여 활성화된 프로토콜을 통해 파일을 업로드하고 다운로드할 수 있는 액세스 권한을 가질 그룹을 선택하는 데 사용됩니다 AWS Transfer Family. 예를 들어, Microsoft Active Directory에는 50,000명의 사용자가 있을 수 있지만 서버에 파일을 전송할 수 있는 기능은 극히 일부만 필요할 수 있습니다. 관리자는 CreateAccess를 필요로 하는 올바른 사용자 집합으로 액세스를 제한하는 데 사용할 수 있습니다.

구문 요청


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

요청 파라미터

모든 작업에 공통되는 파라미터에 대한 내용은 공통 파라미터를 참조하십시오.

요청은 JSON 형식의 다음 데이터를 수락합니다.

ExternalId

디렉터리 내의 특정 그룹을 식별하는 데 필요한 고유 식별자입니다. 연결하는 그룹의 사용자는 를 사용하여 활성화된 프로토콜을 통해 Amazon S3 또는 Amazon EFS 리소스에 액세스할 수 있습니다 AWS Transfer Family. 그룹 이름을 알고 있는 경우 Windows 를 사용하여 다음 명령을 실행하여 SID 값을 볼 수 있습니다 PowerShell.

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

이 명령에서 YourGroupName 를 Active Directory 그룹의 이름으로 바꿉니다.

이 파라미터를 확인하는 데 사용되는 정규 표현식은 공백 없이 대문자 및 소문자 영숫자로 구성된 문자의 문자열입니다. 밑줄이나 또한 =,.@:/- 문자도 포함할 수 있습니다.

타입: 문자열

길이 제약 조건: 최소 길이는 1입니다. 최대 길이는 256입니다.

Pattern: S-1-[\d-]+

필수 여부: 예

HomeDirectory

사용자가 클라이언트를 사용하여 서버에 로그인하는 경우 사용자를 위한 랜딩 디렉터리(폴더).

HomeDirectory의 예: /bucket_name/home/mydirectory

참고

HomeDirectory 파라미터는 HomeDirectoryType이(가) PATH(으)로 설정된 경우에만 사용합니다.

타입: 문자열

길이 제약 조건: 최소 길이는 0입니다. 최대 길이는 1024입니다.

패턴: (|/.*)

Required: No

HomeDirectoryMappings

사용자에게 표시해야 하는 Amazon S3 또는 Amazon EFS 경로와 키를 지정하는 논리적 디렉터리 매핑과 이를 표시할 방법을 지정합니다. Entry 및 Target 페어를 지정해야 합니다. 여기서 는 경로가 어떻게 표시되는Entry지, 는 실제 Amazon S3 또는 Amazon EFS 경로Target입니다. 대상만 지정하는 경우, 그대로 표시됩니다. 또한 AWS Identity and Access Management (IAM) 역할이 의 경로에 대한 액세스를 제공하는지 확인해야 합니다Target. 이 값은 이 로 설정된 경우에만 HomeDirectoryType 설정할 수 있습니다LOGICAL.

다음은 Entry 및 Target 쌍의 예입니다.

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

대부분의 경우 세션 정책 대신 이 값을 사용하여 사용자를 지정된 홈 디렉터리("chroot")로 제한할 수 있습니다. 이렇게 하려면 Entry을 /로 설정하고, Target을 HomeDirectory 파라미터 값으로 설정하면 됩니다.

다음은 chroot에 대한 Entry 및 Target 쌍의 예입니다.

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

타입: HomeDirectoryMapEntry 객체 배열

어레이 멤버: 최소 항목 수 1개. 최대 항목 수는 50,000개입니다.

필수 여부: 아니요

HomeDirectoryType

사용자가 서버에 로그인하는 경우 홈 디렉터리가 될 랜딩 디렉터리(폴더) 타입입니다. 로 설정하면 PATH파일 전송 프로토콜 클라이언트에서와 같이 절대 Amazon S3 버킷 또는 Amazon EFS 경로가 표시됩니다. 로 설정한 경우 Amazon S3 또는 Amazon EFS 경로를 사용자에게 표시하는 방법에 HomeDirectoryMappings 대한 매핑을 에 LOGICAL제공해야 합니다.

참고

HomeDirectoryType이 LOGICAL인 경우, HomeDirectoryMappings 파라미터를 사용하여 매핑을 제공해야 합니다. 반면에 HomeDirectoryType이 PATH인 경우, HomeDirectory 파라미터를 사용하여 절대 경로를 제공하세요. 템플릿에 HomeDirectory 및 HomeDirectoryMappings를 모두 포함할 수는 없습니다.

타입: 문자열

유효 값: PATH | LOGICAL

필수 여부: 아니요

Policy

여러 사용자 간에 동일한 AWS Identity and Access Management (IAM) 역할을 사용할 수 있도록 하는 사용자에 대한 세션 정책입니다. 이 정책은 Amazon S3 버킷의 부분에 대한 사용자의 액세스 범위를 축소합니다. 이 정책 내에서 사용할 수 있는 변수는 ${Transfer:UserName}, ${Transfer:HomeDirectory} 및 ${Transfer:HomeBucket}입니다.

참고

이 정책은 ServerId의 도메인이 Amazon S3인 경우에만 적용됩니다. AmazonEFS은 세션 정책을 사용하지 않습니다.

세션 정책의 경우 는 정책의 Amazon 리소스 이름(ARN) 대신 정책을 JSON 블롭으로 AWS Transfer Family 저장합니다. 정책을 JSON blob으로 저장하고 Policy 인수에 전달합니다.

세션 정책의 예는 세션 정책 예를 참조하세요.

자세한 내용은 참조AssumeRole의 섹션을 참조하세요. AWS Security Token Service API

유형: 문자열

길이 제약 조건: 최소 길이는 0입니다. 최대 길이는 2048입니다.

필수 여부: 아니요

PosixProfile

Amazon EFS 파일 시스템에 대한 사용자의 액세스를 제어하는 사용자 ID(Uid), 그룹 ID(Gid) 및 보조 그룹IDs(SecondaryGids)을 포함한 전체 POSIX 자격 증명입니다. 파일 시스템의 파일 및 디렉터리에 설정된 POSIX 권한에 따라 Amazon EFS 파일 시스템으로 파일을 전송하거나 전송할 때 사용자가 받는 액세스 수준이 결정됩니다.

유형: PosixProfile 객체

필수 여부: 아니요

Role

Amazon S3 버킷 또는 Amazon EFS 파일 시스템에 대한 사용자의 액세스를 제어하는 (ARN) 역할의 Amazon 리소스 이름 AWS Identity and Access Management (IAM)입니다. 이 역할에 연결된 정책은 Amazon S3 버킷 또는 Amazon EFS 파일 시스템으로 파일을 전송하거나 전송할 때 사용자에게 제공할 액세스 수준을 결정합니다. IAM 또한 역할에는 사용자의 전송 요청을 처리할 때 서버가 리소스에 액세스할 수 있는 신뢰 관계가 포함되어야 합니다.

유형: 문자열

길이 제약: 최소 길이는 20. 최대 길이는 2,048.

Pattern: arn:.*role/\S+

필수 여부: 예

ServerId

서버 인스턴스에 대해 시스템에서 할당한 고유 식별자입니다. 이 항목은 사용자를 추가한 특정 서버입니다.

타입: 문자열

길이 제약 조건: 고정 길이는 19입니다.

Pattern: s-([0-9a-f]{17})

필수 여부: 예

응답 구문


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

Response Elements

작업이 성공하면 서비스가 HTTP 200개의 응답을 다시 보냅니다.

다음 데이터는 서비스에서 JSON 형식으로 반환됩니다.

ExternalId

를 사용하여 활성화된 프로토콜을 통해 사용자가 Amazon S3 또는 Amazon EFS 리소스에 액세스할 수 있는 그룹의 외부 식별자입니다 AWS Transfer Family.

유형: 문자열

길이 제약 조건: 최소 길이는 1입니다. 최대 길이는 256입니다.

Pattern: S-1-[\d-]+

ServerId

사용자가 연결된 서버의 식별자입니다.

타입: 문자열

길이 제약 조건: 고정 길이는 19입니다.

패턴: s-([0-9a-f]{17})

Errors

모든 작업에 공통되는 오류에 대한 내용은 일반적인 오류 섹션을 참조하십시오.

InternalServiceError

이 예외는 AWS Transfer Family 서비스에서 오류가 발생할 때 발생합니다.

HTTP 상태 코드: 500

InvalidRequestException

이 예외는 클라이언트가 잘못된 형식의 요청을 제출할 때 던져집니다.

HTTP 상태 코드: 400

ResourceExistsException

요청된 리소스가 존재하지 않거나 명령에 지정된 리전이 아닌 다른 리전에 있습니다.

HTTP 상태 코드: 400

ResourceNotFoundException

AWS Transfer Family 서비스에서 리소스를 찾을 수 없는 경우 이 예외가 발생합니다.

HTTP 상태 코드: 400

ServiceUnavailableException

AWS Transfer Family 서비스를 사용할 수 없으므로 요청이 실패했습니다.

HTTP 상태 코드: 500

참고

언어별 중 하나API에서 이 를 사용하는 방법에 대한 자세한 내용은 다음을 AWS SDKs참조하세요.

javascript가 브라우저에서 비활성화되거나 사용이 불가합니다.

AWS 설명서를 사용하려면 Javascript가 활성화되어야 합니다. 지침을 보려면 브라우저의 도움말 페이지를 참조하십시오.

문서 규칙

작업

CreateAgreement