Interface StartPiiEntitiesDetectionJobCommandOutput

The output of StartPiiEntitiesDetectionJobCommand.

interface StartPiiEntitiesDetectionJobCommandOutput {
    $metadata: ResponseMetadata;
    JobArn?: string;
    JobId?: string;
    JobStatus?: JobStatus;
}

Hierarchy (view full)

Properties

$metadata JobArn? JobId? JobStatus?

Properties

$metadata

$metadata: ResponseMetadata

Metadata pertaining to this request.

Optional JobArn

JobArn?: string

The Amazon Resource Name (ARN) of the PII entity detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:

arn::comprehend:::pii-entities-detection-job/

The following is an example job ARN:

arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/1234abcd12ab34cd56ef1234567890ab

Optional JobId

JobId?: string

The identifier generated for the job.

Optional JobStatus

JobStatus?: JobStatus

The status of the job.

Settings

Member Visibility

Theme

On This Page