describe-classification-job¶
Description¶
Retrieves information about the status and settings for a classification job.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
describe-classification-job
--job-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]
Options¶
--job-id (string)
The unique identifier for the classification job.
--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¶
clientToken -> (string)
The token that was provided to ensure the idempotency of the request to create the job.
createdAt -> (timestamp)
The date and time, in UTC and extended ISO 8601 format, when the job was created.
customDataIdentifierIds -> (list)
The custom data identifiers that the job uses to analyze data.
(string)
description -> (string)
The custom description of the job.
initialRun -> (boolean)
Specifies whether the job has run for the first time.
jobArn -> (string)
The Amazon Resource Name (ARN) of the job.
jobId -> (string)
The unique identifier for the job.
jobStatus -> (string)
The current status of the job. Possible values 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 values are:
ONE_TIME - The job ran or will run only once.
SCHEDULED - The job runs on a daily, weekly, or monthly basis. The scheduleFrequency property indicates the recurrence pattern for the job.
lastRunTime -> (timestamp)
The date and time, in UTC and extended ISO 8601 format, when the job last ran.
name -> (string)
The custom name of the job.
s3JobDefinition -> (structure)
The S3 buckets that the job is configured 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.
samplingPercentage -> (integer)
The sampling depth, as a percentage, that the job applies when it processes objects.
scheduleFrequency -> (structure)
The recurrence pattern for running the job. If the job is configured to run only once, this value is null.
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.
statistics -> (structure)
The number of times that the job has run and processing statistics for the job’s most recent run.
approximateNumberOfObjectsToProcess -> (double)
The approximate number of objects that the job has yet to process during its current run.
numberOfRuns -> (double)
The number of times that the job has run.
tags -> (map)
A map of key-value pairs that identifies the tags (keys and values) that are associated with the classification job.
key -> (string)
value -> (string)