[ aws . comprehend ]

list-pii-entities-detection-jobs

Description

Gets a list of the PII entity detection jobs that you have submitted.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  list-pii-entities-detection-jobs
[--filter <value>]
[--next-token <value>]
[--max-results <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--filter (structure)

Filters the jobs that are returned. You can filter jobs on their name, status, or the date and time that they were submitted. You can only set one filter at a time.

JobName -> (string)

Filters on the name of the job.

JobStatus -> (string)

Filters the list of jobs based on job status. Returns only jobs with the specified status.

SubmitTimeBefore -> (timestamp)

Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted before the specified time. Jobs are returned in ascending order, oldest to newest.

SubmitTimeAfter -> (timestamp)

Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in descending order, newest to oldest.

Shorthand Syntax:

JobName=string,JobStatus=string,SubmitTimeBefore=timestamp,SubmitTimeAfter=timestamp

JSON Syntax:

{
  "JobName": "string",
  "JobStatus": "SUBMITTED"|"IN_PROGRESS"|"COMPLETED"|"FAILED"|"STOP_REQUESTED"|"STOPPED",
  "SubmitTimeBefore": timestamp,
  "SubmitTimeAfter": timestamp
}

--next-token (string)

Identifies the next page of results to return.

--max-results (integer)

The maximum number of results to return in each page.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

PiiEntitiesDetectionJobPropertiesList -> (list)

A list containing the properties of each job that is returned.

(structure)

Provides information about a PII entities detection job.

JobId -> (string)

The identifier assigned to the PII entities detection job.

JobName -> (string)

The name that you assigned the PII entities detection job.

JobStatus -> (string)

The current status of the PII entities detection job. If the status is FAILED , the Message field shows the reason for the failure.

Message -> (string)

A description of the status of a job.

SubmitTime -> (timestamp)

The time that the PII entities detection job was submitted for processing.

EndTime -> (timestamp)

The time that the PII entities detection job completed.

InputDataConfig -> (structure)

The input properties for a PII entities detection job.

S3Uri -> (string)

The Amazon S3 URI for the input data. The URI must be in same region as the API endpoint that you are calling. The URI can point to a single input file or it can provide the prefix for a collection of data files.

For example, if you use the URI S3://bucketName/prefix , if the prefix is a single file, Amazon Comprehend uses that file as input. If more than one file begins with the prefix, Amazon Comprehend uses all of them as input.

InputFormat -> (string)

Specifies how the text in an input file should be processed:

• ONE_DOC_PER_FILE - Each file is considered a separate document. Use this option when you are processing large documents, such as newspaper articles or scientific papers.

• ONE_DOC_PER_LINE - Each line in a file is considered a separate document. Use this option when you are processing many short documents, such as text messages.

OutputDataConfig -> (structure)

The output data configuration that you supplied when you created the PII entities detection job.

S3Uri -> (string)

When you use the PiiOutputDataConfig object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data.

KmsKeyId -> (string)

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job.

RedactionConfig -> (structure)

Provides configuration parameters for PII entity redaction.

This parameter is required if you set the Mode parameter to ONLY_REDACTION . In that case, you must provide a RedactionConfig definition that includes the PiiEntityTypes parameter.

PiiEntityTypes -> (list)

An array of the types of PII entities that Amazon Comprehend detects in the input text for your request.

(string)

MaskMode -> (string)

Specifies whether the PII entity is redacted with the mask character or the entity type.

MaskCharacter -> (string)

A character that replaces each character in the redacted PII entity.

LanguageCode -> (string)

The language code of the input documents

DataAccessRoleArn -> (string)

The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.

Mode -> (string)

Specifies whether the output provides the locations (offsets) of PII entities or a file in which PII entities are redacted.

NextToken -> (string)

Identifies the next page of results to return.