DescribeTaskExecution - AWS DataSync

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

DescribeTaskExecution

AWS DataSync 작업 실행에 대한 정보를 제공합니다. 이 작업을 사용하여 진행 중인 데이터 전송의 진행 상황을 모니터링하거나 전송 결과를 확인할 수 있습니다.

참고

일부 DescribeTaskExecution 응답 요소는 특정 작업 모드에만 관련이 있습니다. 자세한 내용은 작업 모드 차이 이해데이터 전송 성능 카운터 이해를 참조하세요.

구문 요청

{ "TaskExecutionArn": "string" }

요청 파라미터

모든 작업에 공통되는 파라미터에 대한 자세한 설명은 공통 파라미터를 참조하세요.

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

TaskExecutionArn

정보를 원하는 작업 진행의 Amazon 리소스 이름(ARN)을 지정합니다.

유형: 문자열

길이 제약: 최대 길이는 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}$

필수 여부: 예

응답 구문

{ "BytesCompressed": number, "BytesTransferred": number, "BytesWritten": number, "EndTime": number, "EstimatedBytesToTransfer": number, "EstimatedFilesToDelete": number, "EstimatedFilesToTransfer": number, "Excludes": [ { "FilterType": "string", "Value": "string" } ], "FilesDeleted": number, "FilesFailed": { "Delete": number, "Prepare": number, "Transfer": number, "Verify": number }, "FilesListed": { "AtDestinationForDelete": number, "AtSource": number }, "FilesPrepared": number, "FilesSkipped": number, "FilesTransferred": number, "FilesVerified": number, "Includes": [ { "FilterType": "string", "Value": "string" } ], "LaunchTime": number, "ManifestConfig": { "Action": "string", "Format": "string", "Source": { "S3": { "BucketAccessRoleArn": "string", "ManifestObjectPath": "string", "ManifestObjectVersionId": "string", "S3BucketArn": "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" }, "ReportResult": { "ErrorCode": "string", "ErrorDetail": "string", "Status": "string" }, "Result": { "ErrorCode": "string", "ErrorDetail": "string", "PrepareDuration": number, "PrepareStatus": "string", "TotalDuration": number, "TransferDuration": number, "TransferStatus": "string", "VerifyDuration": number, "VerifyStatus": "string" }, "StartTime": number, "Status": "string", "TaskExecutionArn": "string", "TaskMode": "string", "TaskReportConfig": { "Destination": { "S3": { "BucketAccessRoleArn": "string", "S3BucketArn": "string", "Subdirectory": "string" } }, "ObjectVersionIds": "string", "OutputType": "string", "Overrides": { "Deleted": { "ReportLevel": "string" }, "Skipped": { "ReportLevel": "string" }, "Transferred": { "ReportLevel": "string" }, "Verified": { "ReportLevel": "string" } }, "ReportLevel": "string" } }

응답 요소

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

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

BytesCompressed

DataSync가 압축 후 네트워크를 통해 전송하는 물리적 바이트 수입니다(압축이 가능한 경우). 데이터를 압축할 수 없는 경우가 아니면이 수는 일반적으로 BytesTransferred보다 적습니다.

타입: Long

BytesTransferred

DataSync가 압축 전에 네트워크에 전송하는 바이트 수입니다(압축이 가능한 경우). 네트워크를 통해 전송된 바이트 수는 BytesCompressed 섹션을 참조하세요.

타입: Long

BytesWritten

DataSync가 실제로 대상 위치에 기록한 논리적 바이트 수입니다.

타입: Long

EndTime

전송 작업이 종료되는 시간입니다.

유형: 타임스탬프

EstimatedBytesToTransfer

DataSync가 대상 위치에 기록할 것으로 예상되는 논리적 바이트 수입니다.

타입: Long

EstimatedFilesToDelete

DataSync가 대상 위치에서 삭제할 것으로 예상되는 파일, 객체, 디렉터리 수입니다. 소스에 없는 대상의 데이터를 삭제하도록 작업을 구성하지 않는 경우 값은 항상 0입니다.

타입: Long

EstimatedFilesToTransfer

네트워크를 통해 DataSync가 전송할 것으로 예상되는 파일, 객체, 디렉터리 수입니다. 이 값은 DataSync가 전송을 준비하는 동안 계산됩니다.

계산 방법은 주로 작업의 전송 모드 구성에 따라 달라집니다.

  • TranserModeCHANGED로 설정된 경우 - 계산은 소스와 대상의 위치 콘텐츠를 비교하고 이를 바탕으로 전송해야 하는 차이를 결정합니다. 차이점은 다음과 같습니다.

    • 소스 위치에 추가되거나 수정된 모든 항목입니다.

    • 두 위치 모두에 있고 초기 전송 후 대상에서 수정된 모든 항목(OverwriteModeNEVER로 설정된 경우 제외)입니다.

    • (기본 작업 모드만 해당) DataSync가 삭제할 것으로 예상되는 항목 수입니다(PreserveDeletedFiles가 로 설정된 경우REMOVE).

  • TranserModeALL로 설정된 경우 - 계산은 DataSync가 소스 위치에서 찾는 항목만 기반으로 합니다.

타입: Long

Excludes

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

유형: FilterRule객체 배열

배열 구성원: 최소수는 0개입니다. 최대 항목 수는 1개입니다.

FilesDeleted

DataSync가 실제로 대상 위치에서 삭제한 파일, 객체, 디렉터리 수입니다. 소스에 없는 대상의 데이터를 삭제하도록 작업을 구성하지 않는 경우 값은 항상 0입니다.

타입: Long

FilesFailed

DataSync가 작업 실행 중에 준비, 전송, 확인 및 삭제하지 못하는 객체 수입니다.

참고

Enhanced 모드 태스크에만 적용됩니다.

유형: TaskExecutionFilesFailedDetail객체

FilesListed

DataSync가 사용자 위치에서 찾는 객체 수입니다.

참고

Enhanced 모드 태스크에만 적용됩니다.

유형: TaskExecutionFilesListedDetail객체

FilesPrepared

소스 위치와 대상 위치를 비교한 후 DataSync가 전송을 시도할 객체 수입니다.

참고

Enhanced 모드 태스크에만 적용됩니다.

모든 데이터를 전송하도록 작업을 구성하는 경우이 카운터를 적용할 수 없습니다. 이 시나리오에서 DataSync는 위치 간의 차이를 비교하지 않고 소스에서 대상으로 모든 것을 복사합니다.

타입: Long

FilesSkipped

전송 중에 DataSync가 건너뛰는 파일, 객체 및 디렉터리의 수입니다.

타입: Long

FilesTransferred

DataSync가 네트워크를 통해 실제로 전송한 파일, 객체, 디렉터리 수입니다. 이 값은 소스에서 무언가를 읽고 네트워크를 통해 전송할 때 작업 실행 중에 주기적으로 업데이트됩니다.

DataSync가 무언가를 전송하지 못하면 이 값은 EstimatedFilesToTransfer보다 작을 수 있습니다. 경우에 따라 이 값은 EstimatedFilesToTransfer보다 클 수도 있습니다. 이 요소는 일부 위치 유형에 대해 구현별로 다르므로 전송 대상을 정확하게 표시하거나 작업 실행을 모니터링하는 데 사용하지 마세요.

타입: Long

FilesVerified

DataSync가 전송 중에 확인하는 파일, 객체 및 디렉터리의 수입니다.

참고

전송된 데이터만 확인하도록 작업을 구성하면 DataSync는 전송에 실패한 일부 상황이나 파일에서 디렉터리를 확인하지 않습니다.

타입: Long

Includes

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

유형: FilterRule객체 배열

배열 구성원: 최소수는 0개입니다. 최대 항목 수는 1개입니다.

LaunchTime

작업 실행이 실제로 시작되는 시간입니다. 대기열에 추가되지 않은 작업의 경우 LaunchTimeStartTime는 일반적으로 동일합니다. 대기 중인 작업의 경우 LaunchTime는 일반적으로 이전 대기 중인 작업의 실행이 완료되어야 새 작업이 시작되기 StartTime 때문에 보다 늦습니다.

유형: 타임스탬프

ManifestConfig

전송할 파일 또는 객체를 나열하는 매니페스트의 구성입니다. 자세한 내용은 Specifying what DataSync transfers by using a manifest 섹션을 참조하세요.

유형: ManifestConfig객체

Options

전송 작업이 구성된 방식을 나타냅니다. 이러한 옵션에는 DataSync가 전송 중에 파일, 객체 및 관련 메타데이터 처리 방법이 포함됩니다. 또한 다른 옵션 중에서 데이터 무결성을 확인하고, 작업에 대한 대역폭 제한 설정 방법을 지정할 수 있습니다.

각 옵션에는 기본값이 있습니다. 필요한 경우가 아니라면 StartTaskExecution을 호출하기 전에 이러한 옵션을 구성하지 않아도 됩니다.

각 작업 실행에 대해 작업 옵션을 재정의할 수도 있습니다. 예를 들어 개별 실행에 대해 LogLevel을 조정할 수 있습니다.

유형: Options객체

ReportResult

DataSync가 전송에 대한 전체 작업 보고서를 생성했는지 여부를 나타냅니다.

유형: ReportResult객체

Result

작업 실행 결과입니다.

유형: TaskExecutionResultDetail객체

StartTime

DataSync가 작업 실행을 시작하기 위해 요청을 보내는 시간입니다. 대기열에 추가되지 않은 작업의 경우 LaunchTimeStartTime는 일반적으로 동일합니다. 대기 중인 작업의 경우 LaunchTime는 일반적으로 이전 대기 중인 작업의 실행이 완료되어야 새 작업이 시작되기 StartTime 때문에 보다 늦습니다.

유형: 타임스탬프

Status

작업 실행 상태입니다.

작업 실행 상태에 대한 자세한 내용은 작업 실행 상태를 참조하세요.

타입: 문자열

유효 값: QUEUED | CANCELLING | LAUNCHING | PREPARING | TRANSFERRING | VERIFYING | SUCCESS | ERROR

TaskExecutionArn

정보를 원했던 작업 실행의 ARN입니다. TaskExecutionArn은 계층적이며 실행된 작업의 TaskArn를 포함합니다.

예를 들어, ARN arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2/execution/exec-08ef1e88ec491019b이 있는 TaskExecution값은 ARN으로 작업 arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2을 실행했습니다.

유형: 문자열

길이 제약: 최대 길이는 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}$

TaskMode

사용 중인 작업 모드입니다. 자세한 내용은 데이터 전송을 위한 작업 모드 선택을 참조하세요.

타입: 문자열

유효 값: BASIC | ENHANCED

TaskReportConfig

DataSync 전송에 대한 세부 정보를 제공하는 작업 보고서 구성입니다. 자세한 내용은 작업 보고서 생성을 참조하십시오.

타입: TaskReportConfig 객체

오류

모든 작업에서 공통적으로 발생하는 오류에 대한 자세한 설명은 일반적인 오류섹션을 참조하세요.

InternalException

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

HTTP 상태 코드: 500

InvalidRequestException

이 예외는 클라이언트가 잘못된 형식의 요청을 제출할 때 던져집니다.

HTTP 상태 코드: 400

예 요청

이 예제는 DescribeTaskExecution요청을 보여줍니다.

{ "TaskExecutionArn": "arn:aws:datasync:us-east-1:111222333444:task/task-aaaabbbbccccddddf/execution/exec-1234abcd1234abcd1" }

향상된 모드 작업 실행을 위한 샘플 응답 1

다음 예제에서는 향상된 모드를 사용하는 DataSync 작업 실행을 설명합니다. 또한 실행은 제외 및 포함 필터를 사용하여 특정 데이터를 전송합니다.

{ "TaskExecutionArn": "arn:aws:datasync:us-east-1:111222333444:task/task-aaaabbbbccccddddf/execution/exec-1234abcd1234abcd1", "Status": "SUCCESS", "Options": { "VerifyMode": "ONLY_FILES_TRANSFERRED", "OverwriteMode": "ALWAYS", "Atime": "BEST_EFFORT", "Mtime": "PRESERVE", "Uid": "NONE", "Gid": "NONE", "PreserveDeletedFiles": "PRESERVE", "PreserveDevices": "NONE", "PosixPermissions": "NONE", "BytesPerSecond": -1, "TaskQueueing": "ENABLED", "LogLevel": "BASIC", "TransferMode": "CHANGED", "SecurityDescriptorCopyFlags": "NONE", "ObjectTags": "PRESERVE" }, "Excludes": [{ "FilterType": "SIMPLE_PATTERN", "Value": "/archive-files" }], "Includes": [{ "FilterType": "SIMPLE_PATTERN", "Value": "/files" }], "StartTime": "2024-10-16T11:19:56.844000-04:00", "EstimatedFilesToTransfer": 7, "EstimatedBytesToTransfer": 30, "FilesTransferred": 7, "BytesWritten": 30, "BytesTransferred": 30, "BytesCompressed": 30, "Result": { "PrepareDuration": 0, "PrepareStatus": "SUCCESS", "TotalDuration": 3310, "TransferDuration": 0, "TransferStatus": "SUCCESS", "VerifyDuration": 0, "VerifyStatus": "SUCCESS" }, "FilesDeleted": 0, "FilesSkipped": 0, "FilesVerified": 7, "EstimatedFilesToDelete": 0, "TaskMode": "ENHANCED", "FilesPrepared": 7, "FilesListed": { "AtSource": 7, "AtDestinationForDelete": 0 }, "FilesFailed": { "Prepare": 0, "Transfer": 0, "Verify": 0, "Delete": 0 } }

향상된 모드 작업 실행을 위한 샘플 응답 2

다음 예제에서는 Enhanced 모드를 사용하는 다른 DataSync 작업 실행을 설명합니다. 이 경우 실행은 필터 대신 매니페스트를 사용하여 특정 데이터를 전송합니다.

{ "TaskExecutionArn": "arn:aws:datasync:us-east-1:111222333444:task/task-aaaabbbbccccddddf/execution/exec-1234abcd1234abcd1", "Status": "SUCCESS", "Options": { "VerifyMode": "ONLY_FILES_TRANSFERRED", "OverwriteMode": "ALWAYS", "Atime": "BEST_EFFORT", "Mtime": "PRESERVE", "Uid": "NONE", "Gid": "NONE", "PreserveDeletedFiles": "PRESERVE", "PreserveDevices": "NONE", "PosixPermissions": "NONE", "BytesPerSecond": -1, "TaskQueueing": "ENABLED", "LogLevel": "TRANSFER", "TransferMode": "CHANGED", "SecurityDescriptorCopyFlags": "NONE", "ObjectTags": "PRESERVE" }, "Excludes": [], "Includes": [], "ManifestConfig": { "Action": "TRANSFER", "Format": "CSV", "S3AccessRoleArn": "arn:aws:iam::111222333444:role/service-role/DataSyncS3ManifestAccess", "S3Bucket": "arn:aws:s3:::manifests-datasync", "VersionId": "Ixs7NQzEOj8BkL9r4ywX2FtDh_cPf3mG", "Source": { "S3": { "ManifestObjectPath": "manifest-folder/manifest-versioned-files", "BucketAccessRoleArn": "arn:aws:iam::111222333444:role/my-manifest-role/DataSyncS3ManifestAccess", "S3BucketArn": "arn:aws:s3:::manifests-datasync", "ManifestObjectVersionId": "Ixs7NQzEOj8BkL9r4ywX2FtDh_cPf3mG" } } }, "StartTime": "2024-10-16T09:29:56.757000-04:00", "EstimatedFilesToTransfer": 1, "EstimatedBytesToTransfer": 6, "FilesTransferred": 1, "BytesWritten": 6, "BytesTransferred": 6, "BytesCompressed": 6, "Result": { "PrepareDuration": 0, "PrepareStatus": "SUCCESS", "TotalDuration": 3089, "TransferDuration": 0, "TransferStatus": "SUCCESS", "VerifyDuration": 0, "VerifyStatus": "SUCCESS" }, "TaskReportConfig": { "Destination": { "S3": { "Subdirectory": "reports/", "S3BucketArn": "arn:aws:s3:::my-task-report", "BucketAccessRoleArn": "arn:aws:iam::111222333444:role/my-task-report-role/DataSyncTaskReportS3BucketAccess" } }, "OutputType": "STANDARD", "ReportLevel": "SUCCESSES_AND_ERRORS", "ObjectVersionIds": "INCLUDE" }, "FilesDeleted": 0, "FilesSkipped": 0, "FilesVerified": 1, "ReportResult": { "Status": "SUCCESS" }, "EstimatedFilesToDelete": 0, "TaskMode": "ENHANCED", "FilesPrepared": 1, "FilesListed": { "AtSource": 1, "AtDestinationForDelete": 0 }, "FilesFailed": { "Prepare": 0, "Transfer": 0, "Verify": 0, "Delete": 0 } }

기본 모드 작업 실행에 대한 샘플 응답

다음 예제에서는 기본 모드를 사용하는 DataSync 작업 실행을 설명합니다.

{ "TaskExecutionArn": "arn:aws:datasync:us-east-1:111222333444:task/task-aaaabbbbccccddddf/execution/exec-1234abcd1234abcd1", "BytesCompressed": 3500, "BytesTransferred": 5000, "BytesWritten": 5000, "EstimatedBytesToTransfer": 5000, "EstimatedFilesToDelete": 10, "EstimatedFilesToTransfer": 100, "FilesDeleted": 10, "FilesSkipped": 0, "FilesTransferred": 100, "FilesVerified": 100, "Result": { "PrepareDuration": 100, "PrepareStatus": "SUCCESS", "TransferDuration": 60, "TransferStatus": "SUCCESS", "VerifyDuration": 30, "VerifyStatus": "SUCCESS" }, "StartTime": "2024-10-16T11:19:56.844000-04:00", "Status": "SUCCESS", "OverrideOptions": { "Atime": "BEST_EFFORT", "BytesPerSecond": "1000", "Gid": "NONE", "Mtime": "PRESERVE", "PosixPermissions": "PRESERVE", "PreserveDeletedFiles": "PRESERVE", "Uid": "NONE", "VerifyMode": "POINT_IN_TIME_CONSISTENT" }, "TaskReportConfig": { "Destination": { "S3": { "BucketAccessRoleArn": "arn:aws:iam::111222333444:role/my-datasync-role", "S3BucketArn": "arn:aws:s3:::my-task-reports-bucket/*", "Subdirectory": "reports" } }, "ObjectVersionIds": "INCLUDE", "OutputType": "STANDARD", "Overrides": { "Deleted": { "ReportLevel": "ERRORS_ONLY" }, "Skipped": { "ReportLevel": "SUCCESSES_AND_ERRORS" }, "Transferred": { "ReportLevel": "ERRORS_ONLY" }, "Verified": { "ReportLevel": "ERRORS_ONLY" } }, "ReportLevel": "ERRORS_ONLY" } }

참고

언어별 AWS SDKs