Class: Aws::Comprehend::Types::PiiEntitiesDetectionJobFilter

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb

Overview

Note:

When making an API call, you may pass PiiEntitiesDetectionJobFilter data as a hash:

{
  job_name: "JobName",
  job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
  submit_time_before: Time.now,
  submit_time_after: Time.now,
}

Provides information for filtering a list of PII entity detection jobs.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#job_nameString

Filters on the name of the job.

Returns:

  • (String)


4816
4817
4818
4819
4820
4821
4822
4823
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 4816

class PiiEntitiesDetectionJobFilter < Struct.new(
  :job_name,
  :job_status,
  :submit_time_before,
  :submit_time_after)
  SENSITIVE = []
  include Aws::Structure
end

#job_statusString

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

Returns:

  • (String)


4816
4817
4818
4819
4820
4821
4822
4823
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 4816

class PiiEntitiesDetectionJobFilter < Struct.new(
  :job_name,
  :job_status,
  :submit_time_before,
  :submit_time_after)
  SENSITIVE = []
  include Aws::Structure
end

#submit_time_afterTime

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.

Returns:

  • (Time)


4816
4817
4818
4819
4820
4821
4822
4823
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 4816

class PiiEntitiesDetectionJobFilter < Struct.new(
  :job_name,
  :job_status,
  :submit_time_before,
  :submit_time_after)
  SENSITIVE = []
  include Aws::Structure
end

#submit_time_beforeTime

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.

Returns:

  • (Time)


4816
4817
4818
4819
4820
4821
4822
4823
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 4816

class PiiEntitiesDetectionJobFilter < Struct.new(
  :job_name,
  :job_status,
  :submit_time_before,
  :submit_time_after)
  SENSITIVE = []
  include Aws::Structure
end