ListExecutions - AWS Transfer Family
구문 요청요청 파라미터응답 구문Response ElementsErrors참고

기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.

ListExecutions

지정된 워크플로에 대해 진행 중인 모든 실행을 나열합니다.

참고

지정된 워크플로 ID를 찾을 수 없는 경우 ListExecutions은(는) ResourceNotFound 예외를 반환합니다.

구문 요청

{
   "MaxResults": number,
   "NextToken": "string",
   "WorkflowId": "string"
}

요청 파라미터

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

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

MaxResults

반환할 최대 집행 수를 지정합니다.

타입: 정수

유효한 범위: 최소값은 1입니다. 최대값은 1000입니다.

필수 여부: 아니요

NextToken

ListExecutions은(는) 출력에 NextToken 파라미터를 반환합니다. 그런 다음 후속 명령에 NextToken 파라미터를 전달하여 추가 실행을 계속 나열할 수 있습니다.

예를 들어, 이는 페이지 매김에 유용합니다. 워크플로 실행 횟수가 100개인 경우 처음 10개만 나열하는 것이 좋습니다. 그렇다면 를 지정API하여 를 호출합니다max-results.

aws transfer list-executions --max-results 10

그러면 처음 10개 집행에 대한 세부 정보와 11번째 실행에 대한 포인터(NextToken)가 반환됩니다. 이제 를 API 다시 호출하여 받은 NextToken 값을 제공할 수 있습니다.

aws transfer list-executions --max-results 10 --next-token $somePointerReturnedFromPreviousListResult

이 호출은 다음 10번의 집행(11번째부터 20번째)을 반환합니다. 그런 다음 100개 실행에 대한 세부 정보가 모두 반환될 때까지 호출을 반복할 수 있습니다.

타입: 문자열

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

필수 여부: 아니요

WorkflowId

워크플로의 고유 식별자입니다.

타입: 문자열

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

Pattern: 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"
}

Response Elements

작업이 성공하면 서비스가 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

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

HTTP 상태 코드: 400

ServiceUnavailableException

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

HTTP 상태 코드: 500

참고

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