DescribeDiscoveryJobCommand

Suggest an Edit

Returns information about a DataSync discovery job.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { DataSyncClient, DescribeDiscoveryJobCommand } from "@aws-sdk/client-datasync"; // ES Modules import
// const { DataSyncClient, DescribeDiscoveryJobCommand } = require("@aws-sdk/client-datasync"); // CommonJS import
const client = new DataSyncClient(config);
const input = { // DescribeDiscoveryJobRequest
  DiscoveryJobArn: "STRING_VALUE", // required
};
const command = new DescribeDiscoveryJobCommand(input);
const response = await client.send(command);
// { // DescribeDiscoveryJobResponse
//   StorageSystemArn: "STRING_VALUE",
//   DiscoveryJobArn: "STRING_VALUE",
//   CollectionDurationMinutes: Number("int"),
//   Status: "RUNNING" || "WARNING" || "TERMINATED" || "FAILED" || "STOPPED" || "COMPLETED" || "COMPLETED_WITH_ISSUES",
//   JobStartTime: new Date("TIMESTAMP"),
//   JobEndTime: new Date("TIMESTAMP"),
// };

DescribeDiscoveryJobCommand Input

See DescribeDiscoveryJobCommandInput for more details

Parameter
Type
Description
DiscoveryJobArn
Required
string | undefined

Specifies the Amazon Resource Name (ARN) of the discovery job that you want information about.

DescribeDiscoveryJobCommand Output

See DescribeDiscoveryJobCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
CollectionDurationMinutes
number | undefined

The number of minutes that the discovery job runs.

DiscoveryJobArn
string | undefined

The ARN of the discovery job.

JobEndTime
Date | undefined

The time when the discovery job ended.

JobStartTime
Date | undefined

The time when the discovery job started.

Status
DiscoveryJobStatus | undefined

Indicates the status of a discovery job. For more information, see Discovery job statuses .

StorageSystemArn
string | undefined

The ARN of the on-premises storage system you're running the discovery job on.

Throws

Name
Fault
Details
InternalException
server

This exception is thrown when an error occurs in the DataSync service.

InvalidRequestException
client

This exception is thrown when the client submits a malformed request.

DataSyncServiceException
Base exception class for all service exceptions from DataSync service.