기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.
DescribeUser
ServerId 속성으로 식별되는 특정 File Transfer 프로토콜 지원 서버에 할당된 사용자를 설명합니다.
이 직접적인 호출의 응답은 지정된 ServerId 값과 관련된 사용자의 속성을 반환합니다.
구문 요청
{
"ServerId": "string",
"UserName": "string"
}요청 파라미터
모든 작업에 공통되는 파라미터에 대한 내용은 공통 파라미터를 참조하십시오.
요청은 JSON 형식의 다음 데이터를 수락합니다.
- ServerId
-
이 사용자가 할당한 서버에 대해 시스템에서 할당한 고유 식별자입니다.
타입: 문자열
길이 제약 조건: 고정 길이는 19입니다.
Pattern:
s-([0-9a-f]{17})필수 여부: 예
- UserName
-
하나 이상의 서버에 할당된 사용자 이름. 사용자 이름은 AWS Transfer Family 서비스를 사용하고 파일 전송 작업을 수행하기 위한 로그인 보안 인증의 일부입니다.
유형: 문자열
길이 제약 조건: 최소 길이는 3입니다. 최대 길이는 100입니다.
Pattern:
[\w][\w@.-]{2,99}필수 여부: 예
응답 구문
{
"ServerId": "string",
"User": {
"Arn": "string",
"HomeDirectory": "string",
"HomeDirectoryMappings": [
{
"Entry": "string",
"Target": "string",
"Type": "string"
}
],
"HomeDirectoryType": "string",
"Policy": "string",
"PosixProfile": {
"Gid": number,
"SecondaryGids": [ number ],
"Uid": number
},
"Role": "string",
"SshPublicKeys": [
{
"DateImported": number,
"SshPublicKeyBody": "string",
"SshPublicKeyId": "string"
}
],
"Tags": [
{
"Key": "string",
"Value": "string"
}
],
"UserName": "string"
}
}Response Elements
작업이 성공하면 서비스가 HTTP 200개의 응답을 다시 보냅니다.
다음 데이터는 서비스에서 JSON 형식으로 반환됩니다.
- ServerId
-
이 사용자가 할당한 서버에 대해 시스템에서 할당한 고유 식별자입니다.
타입: 문자열
길이 제약 조건: 고정 길이는 19입니다.
패턴:
s-([0-9a-f]{17}) - User
-
지정한
ServerID값에 대한 Transfer Family 사용자의 속성이 들어 있는 배열입니다.타입: DescribedUser 객체
Errors
모든 작업에 공통되는 오류에 대한 내용은 일반적인 오류 섹션을 참조하십시오.
- InternalServiceError
-
이 예외는 AWS Transfer Family 서비스에서 오류가 발생할 때 발생합니다.
HTTP 상태 코드: 500
- InvalidRequestException
-
이 예외는 클라이언트가 잘못된 형식의 요청을 제출할 때 던져집니다.
HTTP 상태 코드: 400
- ResourceNotFoundException
-
AWS Transfer Family 서비스에서 리소스를 찾을 수 없는 경우 이 예외가 발생합니다.
HTTP 상태 코드: 400
- ServiceUnavailableException
-
AWS Transfer Family 서비스를 사용할 수 없으므로 요청이 실패했습니다.
HTTP 상태 코드: 500
예시
예
다음 예에서는 기존 사용자의 세부 정보를 보여줍니다.
샘플 요청
aws transfer describe-user --server-id s-1111aaaa2222bbbb3 --user-name bob-test샘플 응답
{
"ServerId": "s-1111aaaa2222bbbb3",
"User": {
"Arn": "arn:aws:transfer:us-east-1:111122223333:user/s-1111aaaa2222bbbb3/bob-test",
"HomeDirectory": "/DOC-EXAMPLE-BUCKET",
"HomeDirectoryType": "PATH",
"Role": "arn:aws:iam::111122223333:role/bob-role",
"SshPublicKeys": [
{
"DateImported": "2022-03-31T12:27:52.614000-04:00",
"SshPublicKeyBody": "ssh-rsa AAAAB3NzaC1yc..... bobusa@mycomputer.us-east-1.amaazon.com",
"SshPublicKeyId": "key-abcde12345fghik67"
}
],
"Tags": [],
"UserName": "bob-test"
}
}참고
언어별 중 하나API에서 이 를 사용하는 방법에 대한 자세한 내용은 다음을 AWS SDKs참조하세요.
