You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Comprehend::Types::DocumentClassificationJobFilter

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing DocumentClassificationJobFilter as input to an Aws::Client method, you can use a vanilla 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 document classification jobs. For more information, see the operation. You can provide only one filter parameter in each request.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#job_nameString

Filters on the name of the job.

Returns:

  • (String)

    Filters on the name of the job.

#job_statusString

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

Possible values:

  • SUBMITTED
  • IN_PROGRESS
  • COMPLETED
  • FAILED
  • STOP_REQUESTED
  • STOPPED

Returns:

  • (String)

    Filters the list based on job status.

#submit_time_afterTime

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 descending order, newest to oldest.

Returns:

  • (Time)

    Filters the list of jobs based on the time that the job was submitted for processing.

#submit_time_beforeTime

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 ascending order, oldest to newest.

Returns:

  • (Time)

    Filters the list of jobs based on the time that the job was submitted for processing.