DescribeDiscoveryJob
Returns information about a DataSync discovery job.
Request Syntax
{
"DiscoveryJobArn": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- DiscoveryJobArn
-
Specifies the Amazon Resource Name (ARN) of the discovery job that you want information about.
Type: String
Length Constraints: Maximum length of 256.
Pattern:
^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:system/storage-system-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}/job/discovery-job-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$Required: Yes
Response Syntax
{
"CollectionDurationMinutes": number,
"DiscoveryJobArn": "string",
"JobEndTime": number,
"JobStartTime": number,
"Status": "string",
"StorageSystemArn": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- CollectionDurationMinutes
-
The number of minutes that the discovery job runs.
Type: Integer
Valid Range: Minimum value of 60. Maximum value of 44640.
- DiscoveryJobArn
-
The ARN of the discovery job.
Type: String
Length Constraints: Maximum length of 256.
Pattern:
^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:system/storage-system-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}/job/discovery-job-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ - JobEndTime
-
The time when the discovery job ended.
Type: Timestamp
- JobStartTime
-
The time when the discovery job started.
Type: Timestamp
- Status
-
Indicates the status of a discovery job. For more information, see Discovery job statuses.
Type: String
Valid Values:
RUNNING | WARNING | TERMINATED | FAILED | STOPPED | COMPLETED | COMPLETED_WITH_ISSUES - StorageSystemArn
-
The ARN of the on-premises storage system you're running the discovery job on.
Type: String
Length Constraints: Maximum length of 128.
Pattern:
^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:system/storage-system-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalException
-
This exception is thrown when an error occurs in the AWS DataSync service.
HTTP Status Code: 500
- InvalidRequestException
-
This exception is thrown when the client submits a malformed request.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
