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 | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <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.
(string)
Syntax:
"string" "string" ...
--description (string)
A custom description of the job. The description can contain as many as 200 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 can contain as many as 500 characters.
--s3-job-definition (structure)
The S3 buckets that contain the objects to analyze, and the scope of that analysis.
bucketDefinitions -> (list)
An array of objects, one for each bucket that contains objects 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)
scoping -> (structure)
The property- and tag-based conditions that determine which objects to include or exclude from the analysis.
excludes -> (structure)
The property- or tag-based conditions that determine which objects to exclude from the analysis.
and -> (list)
An array of conditions, one for each condition that determines which objects to include or exclude from the job.
(structure)
Specifies a property- or tag-based condition that defines criteria for including or excluding objects from a classification job.
simpleScopeTerm -> (structure)
A property-based condition that defines a property, operator, and one or more values for including or excluding an object from the job.
comparator -> (string)
The operator to use in the condition.
key -> (string)
The property to use in the condition.
values -> (list)
An array that lists one or more values to use in the condition.
(string)
tagScopeTerm -> (structure)
A tag-based condition that defines the operator and a tag key or tag keys and values for including or excluding an object from the job.
comparator -> (string)
The operator to use in the condition.
key -> (string)
The tag key to use in the condition.
tagValues -> (list)
The tag key and value pairs to use in the condition.
(structure)
Specifies a tag key and value, as a pair, to use in a tag-based condition for a classification job.
key -> (string)
The value for the tag key to use in the condition.
value -> (string)
The tag value, associated with the specified tag key, to use in the condition.
target -> (string)
The type of object to apply the condition to.
includes -> (structure)
The property- or tag-based conditions that determine which objects to include in the analysis.
and -> (list)
An array of conditions, one for each condition that determines which objects to include or exclude from the job.
(structure)
Specifies a property- or tag-based condition that defines criteria for including or excluding objects from a classification job.
simpleScopeTerm -> (structure)
A property-based condition that defines a property, operator, and one or more values for including or excluding an object from the job.
comparator -> (string)
The operator to use in the condition.
key -> (string)
The property to use in the condition.
values -> (list)
An array that lists one or more values to use in the condition.
(string)
tagScopeTerm -> (structure)
A tag-based condition that defines the operator and a tag key or tag keys and values for including or excluding an object from the job.
comparator -> (string)
The operator to use in the condition.
key -> (string)
The tag key to use in the condition.
tagValues -> (list)
The tag key and value pairs to use in the condition.
(structure)
Specifies a tag key and value, as a pair, to use in a tag-based condition for a classification job.
key -> (string)
The value for the tag key to use in the condition.
value -> (string)
The tag value, associated with the specified tag key, to use in the condition.
target -> (string)
The type of object to apply the condition to.
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.
dailySchedule -> (structure)
Specifies a daily recurrence pattern for running the job.
monthlySchedule -> (structure)
Specifies a monthly recurrence pattern for running the job.
dayOfMonth -> (integer)
The numeric day of the month when Amazon Macie runs the job. This value can be an integer from 1 through 30.
weeklySchedule -> (structure)
Specifies a weekly recurrence pattern for running the job.
dayOfWeek -> (string)
The day of the week when Amazon Macie runs the job.
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.
key -> (string)
value -> (string)
Shorthand Syntax:
KeyName1=string,KeyName2=string
JSON Syntax:
{"string": "string"
...}
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.
--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.
--cli-auto-prompt (boolean)
Automatically prompt for CLI input parameters.
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.