기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.
ListProfiles
시스템의 프로필 목록을 반환합니다. 결과를 특정 수로 제한하려면 MaxResults 파라미터 값을 제공하세요. 이전에 명령을 실행하여 NextToken에 대한 값을 받은 경우, 해당 값을 제공하여 중단한 부분부터 프로필을 계속 나열할 수 있습니다.
구문 요청
{
"MaxResults": number,
"NextToken": "string",
"ProfileType": "string"
}요청 파라미터
모든 작업에 공통되는 파라미터에 대한 내용은 공통 파라미터를 참조하십시오.
요청은 JSON 형식의 다음 데이터를 수락합니다.
- MaxResults
-
반환할 최대 프로필 수입니다.
타입: 정수
유효한 범위: 최소값은 1입니다. 최대값은 1000입니다.
필수 여부: 아니요
- NextToken
-
반환되지 않은 추가 결과가 있는 경우
NextToken파라미터가 반환됩니다. 이 값을ListProfiles에 대한 후속 호출에 사용하여 결과를 계속 나열할 수 있습니다.타입: 문자열
길이 제약 조건: 최소 길이는 1입니다. 최대 길이는 6144입니다.
필수 여부: 아니요
- ProfileType
-
LOCAL타입 프로필만 나열할지 아니면PARTNER타입 프로필만 나열할지를 나타냅니다. 요청에 입력되지 않은 경우 명령은 모든 타입의 프로필을 나열합니다.타입: 문자열
유효 값:
LOCAL | PARTNER필수 항목 여부: 아니요
응답 구문
{
"NextToken": "string",
"Profiles": [
{
"Arn": "string",
"As2Id": "string",
"ProfileId": "string",
"ProfileType": "string"
}
]
}Response Elements
작업이 성공하면 서비스가 HTTP 200개의 응답을 다시 보냅니다.
다음 데이터는 서비스에서 JSON 형식으로 반환됩니다.
- NextToken
-
다시
ListProfiles를 호출하여 추가 결과(있는 경우)를 수신하는 데 사용할 수 있는 토큰을 반환합니다.타입: 문자열
길이 제약 조건: 최소 길이는 1입니다. 최대 길이는 6144입니다.
- Profiles
-
각 항목에 프로필의 세부 정보가 포함된 배열을 반환합니다.
타입: ListedProfile 객체 배열
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
참고
언어별 중 하나API에서 이 를 사용하는 방법에 대한 자세한 내용은 다음을 AWS SDKs참조하세요.
