Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . macie2 ]

list-classification-jobs

Description

Retrieves information about the status and settings for one or more classification jobs.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  list-classification-jobs
[--filter-criteria <value>]
[--max-results <value>]
[--next-token <value>]
[--sort-criteria <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--filter-criteria (structure)

The criteria to use to filter the results.

JSON Syntax:

{
  "excludes": [
    {
      "comparator": "EQ"|"GT"|"GTE"|"LT"|"LTE"|"NE"|"CONTAINS",
      "key": "jobType"|"jobStatus"|"createdAt"|"name",
      "values": ["string", ...]
    }
    ...
  ],
  "includes": [
    {
      "comparator": "EQ"|"GT"|"GTE"|"LT"|"LTE"|"NE"|"CONTAINS",
      "key": "jobType"|"jobStatus"|"createdAt"|"name",
      "values": ["string", ...]
    }
    ...
  ]
}

--max-results (integer)

The maximum number of items to include in each page of the response.

--next-token (string)

The nextToken string that specifies which page of results to return in a paginated response.

--sort-criteria (structure)

The criteria to use to sort the results.

Shorthand Syntax:

attributeName=string,orderBy=string

JSON Syntax:

{
  "attributeName": "createdAt"|"jobStatus"|"name"|"jobType",
  "orderBy": "ASC"|"DESC"
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. 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

items -> (list)

An array of objects, one for each job that meets the filter criteria specified in the request.

(structure)

Provides information about a classification job, including the current status of the job.

bucketDefinitions -> (list)

The S3 buckets that the job is configured to analyze.

(structure)

Specifies which S3 buckets contain the objects that a classification job analyzes.

accountId -> (string)

The unique identifier for the AWS account that owns one or more of the buckets. If specified, the job analyzes objects in all the buckets that are owned by the account and meet other conditions specified for the job.

buckets -> (list)

An array that lists the names of the buckets.

(string)

createdAt -> (timestamp)

The date and time, in UTC and extended ISO 8601 format, when the job was created.

jobId -> (string)

The unique identifier for the job.

jobStatus -> (string)

The current status of the job. Possible value are:

  • CANCELLED - The job was cancelled by you or a user of the master account for your organization. A job might also be cancelled if ownership of an S3 bucket changed while the job was running, and that change affected the job's access to the bucket.
  • COMPLETE - Amazon Macie finished processing all the data specified for the job.
  • IDLE - For a recurring job, the previous scheduled run is complete and the next scheduled run is pending. This value doesn't apply to jobs that occur only once.
  • PAUSED - Amazon Macie started the job, but completion of the job would exceed one or more quotas for your account.
  • RUNNING - The job is in progress.

jobType -> (string)

The schedule for running the job. Possible value are:

  • ONE_TIME - The job ran or will run only once.
  • SCHEDULED - The job runs on a daily, weekly, or monthly basis.

name -> (string)

The custom name of the job.

nextToken -> (string)

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.