기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.
ListUsers
ServerId 파라미터를 전달하여 지정한 파일 전송 프로토콜 지원 서버의 사용자를 나열합니다.
구문 요청
{
"MaxResults": number,
"NextToken": "string",
"ServerId": "string"
}요청 파라미터
모든 작업에 공통되는 파라미터에 대한 내용은 공통 파라미터를 참조하십시오.
요청은 JSON 형식의 다음 데이터를 수락합니다.
- MaxResults
-
ListUsers요청에 대한 응답으로 반환할 사용자 수를 지정합니다.타입: 정수
유효한 범위: 최소값은 1입니다. 최대값은 1000입니다.
필수 여부: 아니요
- NextToken
-
ListUsers호출의 추가 결과가 있는 경우 출력에NextToken파라미터가 반환됩니다. 그런 다음NextToken을 후속ListUsers명령에 전달하여 추가 사용자를 계속 나열할 수 있습니다.타입: 문자열
길이 제약 조건: 최소 길이는 1입니다. 최대 길이는 6144입니다.
필수 여부: 아니요
- ServerId
-
사용자가 할당된 서버에 대해 시스템에서 할당한 고유 식별자.
타입: 문자열
길이 제약 조건: 고정 길이는 19입니다.
Pattern:
s-([0-9a-f]{17})필수 여부: 예
응답 구문
{
"NextToken": "string",
"ServerId": "string",
"Users": [
{
"Arn": "string",
"HomeDirectory": "string",
"HomeDirectoryType": "string",
"Role": "string",
"SshPublicKeyCount": number,
"UserName": "string"
}
]
}Response Elements
작업이 성공하면 서비스가 HTTP 200개의 응답을 다시 보냅니다.
다음 데이터는 서비스에서 JSON 형식으로 반환됩니다.
- NextToken
-
ListUsers호출에서 추가 결과를 얻을 수 있는 경우 출력에NextToken파라미터가 반환됩니다. 그런 다음 후속 명령에NextToken파라미터를 전달하여 추가 사용자를 계속 나열할 수 있습니다.타입: 문자열
길이 제약 조건: 최소 길이는 1입니다. 최대 길이는 6144입니다.
- ServerId
-
사용자가 할당된 서버에 대해 시스템에서 할당한 고유 식별자.
타입: 문자열
길이 제약 조건: 고정 길이는 19입니다.
패턴:
s-([0-9a-f]{17}) - Users
-
지정한
ServerId값에 대한 Transfer Family 사용자 및 해당 속성을 반환합니다.타입: ListedUser 객체 배열
Errors
모든 작업에 공통되는 오류에 대한 내용은 일반적인 오류 섹션을 참조하십시오.
- InternalServiceError
-
이 예외는 AWS Transfer Family 서비스에서 오류가 발생할 때 발생합니다.
HTTP 상태 코드: 500
- InvalidNextTokenException
-
전달된
NextToken파라미터가 유효하지 않습니다.HTTP 상태 코드: 400
- InvalidRequestException
-
이 예외는 클라이언트가 잘못된 형식의 요청을 제출할 때 던져집니다.
HTTP 상태 코드: 400
- ResourceNotFoundException
-
AWS Transfer Family 서비스에서 리소스를 찾을 수 없는 경우 이 예외가 발생합니다.
HTTP 상태 코드: 400
- ServiceUnavailableException
-
AWS Transfer Family 서비스를 사용할 수 없으므로 요청이 실패했습니다.
HTTP 상태 코드: 500
예시
예
ListUsers API 호출은 지정한 서버와 연결된 사용자 목록을 반환합니다.
샘플 요청
{
"MaxResults": 100,
"NextToken": "eyJNYXJrZXIiOiBudWxsLCAiYm90b1X0cnVuU2F0ZV9hbW91bnQiOiAyfQ==",
"ServerId": "s-01234567890abcdef"
}
예
이 API 통화의 샘플 응답입니다.
샘플 응답
{
"NextToken": "eyJNYXJrZXIiOiBudWxsLCAiYm90b1X0cnVuU2F0ZV9hbW91bnQiOiAyfQ==",
"ServerId": "s-01234567890abcdef",
"Users": [
{
"Arn": "arn:aws:transfer:us-east-1:176354371281:user/s-01234567890abcdef/charlie",
"HomeDirectory": "/tests/home/charlie",
"SshPublicKeyCount": 1,
"Role": "arn:aws:iam::176354371281:role/transfer-role1",
"Tags": [
{
"Key": "Name",
"Value": "user1"
}
],
"UserName": "my_user"
}
]
}참고
언어별 중 하나API에서 이 를 사용하는 방법에 대한 자세한 내용은 다음을 AWS SDKs참조하세요.
