DescribeTask

작업에 대한 메타데이터를 반환합니다.

요청 구문


{
   "TaskArn": "string"
}

요청 파라미터

모든 작업에 공통적인 파라미터에 대한 자세한 내용은 범용 파라미터를 참조하십시오.

요청은 JSON 형식의 다음 데이터를 받습니다.

TaskArn

설명할 태스크의 Amazon 리소스 이름 (ARN) 입니다.

유형: String

길이 제약: 최대 길이는 128입니다.

패턴: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]*:[0-9]{12}:task/task-[0-9a-f]{17}$

Required: Yes

응답 구문


{
   "CloudWatchLogGroupArn": "string",
   "CreationTime": number,
   "CurrentTaskExecutionArn": "string",
   "DestinationLocationArn": "string",
   "DestinationNetworkInterfaceArns": [ "string" ],
   "ErrorCode": "string",
   "ErrorDetail": "string",
   "Excludes": [ 
      { 
         "FilterType": "string",
         "Value": "string"
      }
   ],
   "Includes": [ 
      { 
         "FilterType": "string",
         "Value": "string"
      }
   ],
   "Name": "string",
   "Options": { 
      "Atime": "string",
      "BytesPerSecond": number,
      "Gid": "string",
      "LogLevel": "string",
      "Mtime": "string",
      "ObjectTags": "string",
      "OverwriteMode": "string",
      "PosixPermissions": "string",
      "PreserveDeletedFiles": "string",
      "PreserveDevices": "string",
      "SecurityDescriptorCopyFlags": "string",
      "TaskQueueing": "string",
      "TransferMode": "string",
      "Uid": "string",
      "VerifyMode": "string"
   },
   "Schedule": { 
      "ScheduleExpression": "string"
   },
   "SourceLocationArn": "string",
   "SourceNetworkInterfaceArns": [ "string" ],
   "Status": "string",
   "TaskArn": "string"
}

응답 요소

작업이 성공하면 서비스가 HTTP 200 응답을 다시 전송합니다.

다음 데이터는 서비스에 의해 JSON 형식으로 반환됩니다.

CloudWatchLogGroupArn

태스크의 이벤트를 모니터링하고 로깅하는 데 사용된 Amazon CloudWatch 로그 그룹의 Amazon 리소스 이름 (ARN) 입니다.

이 그룹에 대한 자세한 내용은 Amazon CloudWatch 사용 설명서 에서 로그 그룹 및 로그 스트림 작업 을 참조하세요.

유형: String

길이 제약: 최대 길이는 562입니다.

패턴: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):logs:[a-z\-0-9]+:[0-9]{12}:log-group:([^:\*]*)(:\*)?$

CreationTime

작업을 생성한 시간입니다.

유형: Timestamp

CurrentTaskExecutionArn

파일을 전송 중인 태스크의 Amazon 리소스 이름 (ARN) 입니다.

유형: String

길이 제약: 최대 길이는 128입니다.

패턴: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]*:[0-9]{12}:task/task-[0-9a-f]{17}/execution/exec-[0-9a-f]{17}$

DestinationLocationArn

AWS스토리지 리소스 위치의 Amazon 리소스 이름 (ARN) 입니다.

유형: String

길이 제약: 최대 길이는 128입니다.

패턴: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$

DestinationNetworkInterfaceArns

대상 위치에 대해 생성된 네트워크 인터페이스의 Amazon 리소스 이름 (ARN) 입니다. 자세한 내용은 네트워크 인터페이스 요구 사항을 참조하십시오.

유형: 문자열 배열

길이 제약: 최대 길이는 128입니다.

패턴: ^arn:aws[\-a-z]{0,}:ec2:[a-z\-0-9]*:[0-9]{12}:network-interface/eni-[0-9a-f]+$

ErrorCode

태스크를 실행하는 동안 AWS DataSync 발생한 오류입니다. 이 오류 코드를 사용하여 문제를 해결할 수 있습니다.

유형: String

ErrorDetail

태스크를 실행하는 동안 발생한 오류에 대한 자세한 설명입니다. 이 정보를 사용하여 문제를 해결할 수 있습니다.

유형: String

Excludes

전송 중 특정 데이터를 제외하는 필터 규칙의 목록입니다. 자세한 내용과 예제는 전송 데이터 필터링 을 참조하세요DataSync.

유형: FilterRule 객체 배열

배열 멤버: 최소 항목 수는 0개입니다. 최대 항목 수는 1개입니다.

Includes

전송 중 특정 데이터를 포함하는 필터 규칙의 목록입니다. 자세한 내용과 예제는 전송 데이터 필터링 을 참조하세요DataSync.

유형: FilterRule 객체 배열

배열 멤버: 최소 항목 수는 0개입니다. 최대 항목 수는 1개입니다.

Name

설명된 태스크의 이름입니다.

유형: String

길이 제약: 최소 길이는 1입니다. 최대 길이 256.

Pattern: ^[a-zA-Z0-9\s+=._:@/-]+$

Options

StartTaskExecution작업 동작을 제어하는 구성 옵션. 일부 옵션에는 파일 또는 객체 메타데이터 보존과 데이터 무결성 확인이 포함됩니다.

각 작업 실행에 대해 이러한 옵션을 재정의할 수 있습니다. 자세한 정보는 섹션을 참조하세요 StartTaskExecution.

유형: Options 객체

Schedule

소스에서 대상 위치로 파일을 주기적으로 전송하는 데 사용되는 일정입니다.

유형: TaskSchedule 객체

SourceLocationArn

소스 파일 시스템 위치의 Amazon 리소스 이름 (ARN) 입니다.

유형: String

길이 제약: 최대 길이는 128입니다.

패턴: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$

SourceNetworkInterfaceArns

소스 위치에 대해 생성된 네트워크 인터페이스의 Amazon 리소스 이름 (ARN) 입니다. 자세한 내용은 네트워크 인터페이스 요구 사항을 참조하십시오.

유형: 문자열 배열

길이 제약: 최대 길이는 128입니다.

패턴: ^arn:aws[\-a-z]{0,}:ec2:[a-z\-0-9]*:[0-9]{12}:network-interface/eni-[0-9a-f]+$

Status

설명된 태스크의 상태입니다.

작업 실행 상태에 대한 자세한 내용은 사용 AWS DataSync설명서의 작업 상태 이해를 참조하십시오.

유형: String

유효한 값: AVAILABLE | CREATING | QUEUED | RUNNING | UNAVAILABLE

TaskArn

설명된 태스크의 Amazon 리소스 이름 (ARN) 입니다.

유형: String

길이 제약: 최대 길이는 128입니다.

패턴: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]*:[0-9]{12}:task/task-[0-9a-f]{17}$

오류

모든 작업에 공통적으로 나타나는 오류에 대한 자세한 내용은 을 참조하십시오일반적인 오류.

InternalException

이 예외는 AWS DataSync 서비스에 오류가 발생할 때 발생합니다.

HTTP 상태 코드: 500

InvalidRequestException

클라이언트가 잘못된 형식의 요청을 제출하면 이 예외가 발생합니다.

HTTP 상태 코드: 400

예시

예

다음 예는 샘플 요청에 지정된 작업에 대한 정보를 반환합니다.

예제 요청


{
  "TaskArn": "arn:aws:datasync:us-east-2:111222333444:task/task-08de6e6697796f026"
}

예

이 예제에서는 한 가지 사용법을 보여줍니다DescribeTask.

샘플 응답


{
   "CloudWatchLogGroupArn": "arn:aws:logs:us-east-2:111222333444:log-group"
   "CreationTime": 1532660733.39,
   "CurrentTaskExecutionArn": "arn:aws:datasync:us-east-2:111222333444:task/task-08de6e6697796f026/execution/exec-04ce9d516d69bd52f",
   "Options": { 
      "Atime": "BEST_EFFORT",
      "BytesPerSecond": 1000,
      "Gid": "NONE",
      "Mtime": "PRESERVE",
      "PosixPermissions": "PRESERVE",
      "PreserveDevices": "NONE",
      "PreserveDeletedFiles": "PRESERVE",
      "Uid": "NONE",
      "VerifyMode": "POINT_IN_TIME_CONSISTENT"
   },
   "DestinationLocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-07db7abfc326c50fb",
   "ErrorCode": "???????",
   "ErrorDetail": "??????",
   "Name": "MyTask",
   "SourceLocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-07db7abfc326c50aa",
   "Status": "CREATING",
   "TaskArn": "arn:aws:datasync:us-east-2:111222333444:task/task-08de6e6697796f026"
}

참고 항목

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

javascript가 브라우저에서 비활성화되거나 사용이 불가합니다.

AWS 설명서를 사용하려면 Javascript가 활성화되어야 합니다. 지침을 보려면 브라우저의 도움말 페이지를 참조하십시오.

문서 규칙

DescribeStorageSystemResources

DescribeTaskExecution