기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.
ListExecutions
지정된 워크플로우에 대해 진행 중인 모든 실행을 나열합니다.
참고
지정된 워크플로우 ID를 찾을 수 없는 경우 ListExecutions은(는) ResourceNotFound 예외를 반환합니다.
구문 요청
{
"MaxResults": number,
"NextToken": "string",
"WorkflowId": "string"
}요청 파라미터
모든 작업에서 사용하는 파라미터에 대한 자세한 내용은 범용 파라미터를 참조하세요.
요청은 JSON 형식으로 다음 데이터를 받습니다.
- MaxResults
-
반환할 최대 집행 수를 지정합니다.
Type: 정수
유효 범위: 최소값 1. 최대값 1000.
필수 여부: 아니요
- NextToken
-
ListExecutions은(는) 출력에NextToken파라미터를 반환합니다. 그런 다음 후속 명령에NextToken파라미터를 전달하여 추가 실행을 계속 나열할 수 있습니다.예를 들어, 이는 페이지 매김에 유용합니다. 워크플로우 실행 횟수가 100개인 경우 처음 10개만 나열하는 것이 좋습니다. 그렇다면
max-results을 지정하여 API를 호출하십시오:aws transfer list-executions --max-results 10그러면 처음 10개 집행에 대한 세부 정보와 11번째 실행에 대한 포인터(
NextToken)가 반환됩니다. 이제 수신한NextToken값을 입력하여 API를 다시 호출할 수 있습니다:aws transfer list-executions --max-results 10 --next-token $somePointerReturnedFromPreviousListResult이 호출은 다음 10번의 집행(11번째부터 20번째)을 반환합니다. 그런 다음 100개 실행에 대한 세부 정보가 모두 반환될 때까지 호출을 반복할 수 있습니다.
유형: 문자열
길이 제약: 최소 길이 1자. 최대 길이는 6144입니다.
필수 여부: 아니요
- WorkflowId
-
워크플로우의 고유 식별자입니다.
타입: 문자열
길이 제약 조건: 고정 길이는 19입니다.
패턴:
w-([a-z0-9]{17})필수 항목 여부: 예
응답 구문
{
"Executions": [
{
"ExecutionId": "string",
"InitialFileLocation": {
"EfsFileLocation": {
"FileSystemId": "string",
"Path": "string"
},
"S3FileLocation": {
"Bucket": "string",
"Etag": "string",
"Key": "string",
"VersionId": "string"
}
},
"ServiceMetadata": {
"UserDetails": {
"ServerId": "string",
"SessionId": "string",
"UserName": "string"
}
},
"Status": "string"
}
],
"NextToken": "string",
"WorkflowId": "string"
}응답 요소
작업이 성공하면 서비스가 HTTP 200 응답을 반송합니다.
다음 데이터는 서비스에 의해 JSON 형식으로 반환됩니다.
- Executions
-
각 실행의 세부 정보를
ListedExecution배열로 반환합니다.유형: ListedExecution 객체 어레이
- NextToken
-
ListExecutions은(는) 출력에NextToken파라미터를 반환합니다. 그런 다음 후속 명령에NextToken파라미터를 전달하여 추가 실행을 계속 나열할 수 있습니다.유형: 문자열
길이 제약: 최소 길이 1자. 최대 길이는 6144입니다.
- WorkflowId
-
워크플로우의 고유 식별자입니다.
타입: 문자열
길이 제약 조건: 고정 길이는 19입니다.
패턴:
w-([a-z0-9]{17})
Errors
모든 작업에서 발생하는 흔한 오류에 대한 자세한 내용은 일반적인 오류 단원을 참조하십시오.
- InternalServiceError
-
AWS Transfer Family 서비스에 오류가 발생하면 이 예외가 발생합니다.
HTTP 상태 코드: 500
- InvalidNextTokenException
-
전달된
NextToken파라미터가 유효하지 않습니다.HTTP 상태 코드: 400
- InvalidRequestException
-
클라이언트가 잘못된 형식의 요청을 제출할 때 이 예외가 발생합니다.
HTTP 상태 코드: 400
- ResourceNotFoundException
-
AWSTransfer Family 서비스에서 리소스를 찾을 수 없는 경우 이 예외가 발생합니다.
HTTP 상태 코드: 400
- ServiceUnavailableException
-
AWSTransfer Family 서비스를 이용할 수 없어 요청이 실패했습니다.
HTTP 상태 코드: 500
참고
이 API를 언어별 AWS SDK 중 하나로 사용하는 방법에 대한 자세한 설명은 다음을 참조하세요.
