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 ]

create-classification-job

Description

Creates and defines the settings for a classification job.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  create-classification-job
[--client-token <value>]
[--custom-data-identifier-ids <value>]
[--description <value>]
[--initial-run | --no-initial-run]
--job-type <value>
--name <value>
--s3-job-definition <value>
[--sampling-percentage <value>]
[--schedule-frequency <value>]
[--tags <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--client-token (string)

A unique, case-sensitive token that you provide to ensure the idempotency of the request.

--custom-data-identifier-ids (list)

The custom data identifiers to use for data analysis and classification.

Syntax:

"string" "string" ...

--description (string)

A custom description of the job. The description can contain as many as 512 characters.

--initial-run | --no-initial-run (boolean)

Specifies whether to run the job immediately, after it's created.

--job-type (string)

The schedule for running the job. Valid values are:

  • ONE_TIME - Run the job only once. If you specify this value, don't specify a value for the scheduleFrequency property.
  • SCHEDULED - Run the job on a daily, weekly, or monthly basis. If you specify this value, use the scheduleFrequency property to define the recurrence pattern for the job.

Possible values:

  • ONE_TIME
  • SCHEDULED

--name (string)

A custom name for the job. The name must contain at least 3 characters and can contain as many as 64 characters.

--s3-job-definition (structure)

The S3 buckets that contain the objects to analyze, and the scope of that analysis.

JSON Syntax:

{
  "bucketDefinitions": [
    {
      "accountId": "string",
      "buckets": ["string", ...]
    }
    ...
  ],
  "scoping": {
    "excludes": {
      "and": [
        {
          "simpleScopeTerm": {
            "comparator": "EQ"|"GT"|"GTE"|"LT"|"LTE"|"NE"|"CONTAINS",
            "key": "BUCKET_CREATION_DATE"|"OBJECT_EXTENSION"|"OBJECT_LAST_MODIFIED_DATE"|"OBJECT_SIZE"|"TAG",
            "values": ["string", ...]
          },
          "tagScopeTerm": {
            "comparator": "EQ"|"GT"|"GTE"|"LT"|"LTE"|"NE"|"CONTAINS",
            "key": "string",
            "tagValues": [
              {
                "key": "string",
                "value": "string"
              }
              ...
            ],
            "target": "S3_OBJECT"
          }
        }
        ...
      ]
    },
    "includes": {
      "and": [
        {
          "simpleScopeTerm": {
            "comparator": "EQ"|"GT"|"GTE"|"LT"|"LTE"|"NE"|"CONTAINS",
            "key": "BUCKET_CREATION_DATE"|"OBJECT_EXTENSION"|"OBJECT_LAST_MODIFIED_DATE"|"OBJECT_SIZE"|"TAG",
            "values": ["string", ...]
          },
          "tagScopeTerm": {
            "comparator": "EQ"|"GT"|"GTE"|"LT"|"LTE"|"NE"|"CONTAINS",
            "key": "string",
            "tagValues": [
              {
                "key": "string",
                "value": "string"
              }
              ...
            ],
            "target": "S3_OBJECT"
          }
        }
        ...
      ]
    }
  }
}

--sampling-percentage (integer)

The sampling depth, as a percentage, to apply when processing objects. This value determines the percentage of eligible objects that the job analyzes. If the value is less than 100, Amazon Macie randomly selects the objects to analyze, up to the specified percentage.

--schedule-frequency (structure)

The recurrence pattern for running the job. To run the job only once, don't specify a value for this property and set the value of the jobType property to ONE_TIME.

Shorthand Syntax:

dailySchedule={},monthlySchedule={dayOfMonth=integer},weeklySchedule={dayOfWeek=string}

JSON Syntax:

{
  "dailySchedule": {

  },
  "monthlySchedule": {
    "dayOfMonth": integer
  },
  "weeklySchedule": {
    "dayOfWeek": "SUNDAY"|"MONDAY"|"TUESDAY"|"WEDNESDAY"|"THURSDAY"|"FRIDAY"|"SATURDAY"
  }
}

--tags (map)

A map of key-value pairs that specifies the tags to associate with the job.

A job can have a maximum of 50 tags. Each tag consists of a required tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

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

jobArn -> (string)

The Amazon Resource Name (ARN) of the job.

jobId -> (string)

The unique identifier for the job.