기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.
DescribeExecution
DescribeExecution
를 사용하여 지정된 워크플로의 실행 세부 정보를 확인할 수 있습니다.
참고
이 API 호출은 진행 중인 워크플로에 대한 세부 정보만 반환합니다.
진행 중이 아닌 실행의 ID를 제공하거나 실행이 지정된 워크플로 ID와 일치하지 않는 경우 ResourceNotFound
예외가 발생합니다.
구문 요청
{
"ExecutionId": "string
",
"WorkflowId": "string
"
}
요청 파라미터
모든 작업에 공통되는 파라미터에 대한 내용은 공통 파라미터를 참조하십시오.
요청은 JSON 형식의 다음 데이터를 수락합니다.
- ExecutionId
-
워크플로 실행의 고유 식별자입니다.
타입: 문자열
길이 제약 조건: 고정 길이는 36입니다.
Pattern:
[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}
필수 여부: 예
- WorkflowId
-
워크플로의 고유 식별자입니다.
타입: 문자열
길이 제약 조건: 고정 길이는 19입니다.
Pattern:
w-([a-z0-9]{17})
필수 여부: 예
응답 구문
{
"Execution": {
"ExecutionId": "string",
"ExecutionRole": "string",
"InitialFileLocation": {
"EfsFileLocation": {
"FileSystemId": "string",
"Path": "string"
},
"S3FileLocation": {
"Bucket": "string",
"Etag": "string",
"Key": "string",
"VersionId": "string"
}
},
"LoggingConfiguration": {
"LoggingRole": "string",
"LogGroupName": "string"
},
"PosixProfile": {
"Gid": number,
"SecondaryGids": [ number ],
"Uid": number
},
"Results": {
"OnExceptionSteps": [
{
"Error": {
"Message": "string",
"Type": "string"
},
"Outputs": "string",
"StepType": "string"
}
],
"Steps": [
{
"Error": {
"Message": "string",
"Type": "string"
},
"Outputs": "string",
"StepType": "string"
}
]
},
"ServiceMetadata": {
"UserDetails": {
"ServerId": "string",
"SessionId": "string",
"UserName": "string"
}
},
"Status": "string"
},
"WorkflowId": "string"
}
Response Elements
작업이 성공하면 서비스가 HTTP 200개의 응답을 다시 보냅니다.
다음 데이터는 서비스에서 JSON 형식으로 반환됩니다.
- Execution
-
워크플로 예외의 세부 정보를 포함하는 구조입니다.
타입: DescribedExecution 객체
- WorkflowId
-
워크플로의 고유 식별자입니다.
타입: 문자열
길이 제약 조건: 고정 길이는 19입니다.
패턴:
w-([a-z0-9]{17})
Errors
모든 작업에 공통되는 오류에 대한 내용은 일반적인 오류 섹션을 참조하십시오.
- InternalServiceError
-
이 예외는 AWS Transfer Family 서비스에서 오류가 발생할 때 발생합니다.
HTTP 상태 코드: 500
- InvalidRequestException
-
이 예외는 클라이언트가 잘못된 형식의 요청을 제출할 때 던져집니다.
HTTP 상태 코드: 400
- ResourceNotFoundException
-
AWS Transfer Family 서비스에서 리소스를 찾을 수 없는 경우 이 예외가 발생합니다.
HTTP 상태 코드: 400
- ServiceUnavailableException
-
AWS Transfer Family 서비스를 사용할 수 없으므로 요청이 실패했습니다.
HTTP 상태 코드: 500
참고
언어별 중 하나API에서 이 를 사용하는 방법에 대한 자세한 내용은 다음을 AWS SDKs참조하세요.