Skip to content

List Phi Detection Jobs

comprehendmedical_list_phi_detection_jobs R Documentation

Gets a list of protected health information (PHI) detection jobs you have submitted

Description

Gets a list of protected health information (PHI) detection jobs you have submitted.

Usage

comprehendmedical_list_phi_detection_jobs(Filter, NextToken, MaxResults)

Arguments

Filter

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

NextToken

Identifies the next page of results to return.

MaxResults

The maximum number of results to return in each page. The default is 100.

Value

A list with the following syntax:

list(
  ComprehendMedicalAsyncJobPropertiesList = list(
    list(
      JobId = "string",
      JobName = "string",
      JobStatus = "SUBMITTED"|"IN_PROGRESS"|"COMPLETED"|"PARTIAL_SUCCESS"|"FAILED"|"STOP_REQUESTED"|"STOPPED",
      Message = "string",
      SubmitTime = as.POSIXct(
        "2015-01-01"
      ),
      EndTime = as.POSIXct(
        "2015-01-01"
      ),
      ExpirationTime = as.POSIXct(
        "2015-01-01"
      ),
      InputDataConfig = list(
        S3Bucket = "string",
        S3Key = "string"
      ),
      OutputDataConfig = list(
        S3Bucket = "string",
        S3Key = "string"
      ),
      LanguageCode = "en",
      DataAccessRoleArn = "string",
      ManifestFilePath = "string",
      KMSKey = "string",
      ModelVersion = "string"
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_phi_detection_jobs(
  Filter = list(
    JobName = "string",
    JobStatus = "SUBMITTED"|"IN_PROGRESS"|"COMPLETED"|"PARTIAL_SUCCESS"|"FAILED"|"STOP_REQUESTED"|"STOPPED",
    SubmitTimeBefore = as.POSIXct(
      "2015-01-01"
    ),
    SubmitTimeAfter = as.POSIXct(
      "2015-01-01"
    )
  ),
  NextToken = "string",
  MaxResults = 123
)