Skip to content
AWS for Query.Farm

aws.macie2.describe_classification_job

Example SQL Queries

SELECT * FROM
aws.macie2.describe_classification_job
WHERE
"job_id" = 'VALUE';

Description

Retrieves the status and settings for a classification job.

Table Definition

Column NameColumn Data Type
job_id Required Input Column

The unique identifier for the job.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
allow_list_ids

An array of unique identifiers, one for each allow list that the job is configured to use when it analyzes data.

VARCHAR[]
Show child fields
allow_list_ids[]
client_token

The token that was provided to ensure the idempotency of the request to create the job.

VARCHAR
created_at

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

TIMESTAMP_S
custom_data_identifier_ids

An array of unique identifiers, one for each custom data identifier that the job is configured to use when it analyzes data. This value is null if the job is configured to use only managed data identifiers to analyze data.

VARCHAR[]
Show child fields
custom_data_identifier_ids[]
description

The custom description of the job.

VARCHAR
initial_run

For a recurring job, specifies whether you configured the job to analyze all existing, eligible objects immediately after the job was created (true). If you configured the job to analyze only those objects that were created or changed after the job was created and before the job's first scheduled run, this value is false. This value is also false for a one-time job.

BOOLEAN
job_arn

The Amazon Resource Name (ARN) of the job.

VARCHAR
job_status

The current status of the job. Possible values are:

  • CANCELLED - You cancelled the job or, if it's a one-time job, you paused the job and didn't resume it within 30 days.

  • COMPLETE - For a one-time job, Amazon Macie finished processing the data specified for the job. This value doesn't apply to recurring jobs.

  • IDLE - For a recurring job, the previous scheduled run is complete and the next scheduled run is pending. This value doesn't apply to one-time jobs.

  • PAUSED - Macie started running the job but additional processing would exceed the monthly sensitive data discovery quota for your account or one or more member accounts that the job analyzes data for.

  • RUNNING - For a one-time job, the job is in progress. For a recurring job, a scheduled run is in progress.

  • USER_PAUSED - You paused the job. If you paused the job while it had a status of RUNNING and you don't resume it within 30 days of pausing it, the job or job run will expire and be cancelled, depending on the job's type. To check the expiration date, refer to the UserPausedDetails.jobExpiresAt property.

VARCHAR
job_type

The schedule for running the job. Possible values are:

  • ONE_TIME - The job runs only once.

  • SCHEDULED - The job runs on a daily, weekly, or monthly basis. The scheduleFrequency property indicates the recurrence pattern for the job.

VARCHAR
last_run_error_status

Specifies whether any account- or bucket-level access errors occurred when the job ran. For a recurring job, this value indicates the error status of the job's most recent run.

STRUCT(
    "code" VARCHAR
)
Show child fields
last_run_error_status.code

Specifies whether any account- or bucket-level access errors occurred when the job ran. For a recurring job, this value indicates the error status of the job's most recent run. Possible values are:

  • ERROR - One or more errors occurred. Amazon Macie didn't process all the data specified for the job.

  • NONE - No errors occurred. Macie processed all the data specified for the job.

last_run_time

The date and time, in UTC and extended ISO 8601 format, when the job started. If the job is a recurring job, this value indicates when the most recent run started or, if the job hasn't run yet, when the job was created.

TIMESTAMP_S
managed_data_identifier_ids

An array of unique identifiers, one for each managed data identifier that the job is explicitly configured to include (use) or exclude (not use) when it analyzes data. Inclusion or exclusion depends on the managed data identifier selection type specified for the job (managedDataIdentifierSelector).

This value is null if the job's managed data identifier selection type is ALL, NONE, or RECOMMENDED.

VARCHAR[]
Show child fields
managed_data_identifier_ids[]
managed_data_identifier_selector

The selection type that determines which managed data identifiers the job uses when it analyzes data. Possible values are:

  • ALL - Use all managed data identifiers.

  • EXCLUDE - Use all managed data identifiers except the ones specified by the managedDataIdentifierIds property.

  • INCLUDE - Use only the managed data identifiers specified by the managedDataIdentifierIds property.

  • NONE - Don't use any managed data identifiers. Use only custom data identifiers (customDataIdentifierIds).

  • RECOMMENDED (default) - Use the recommended set of managed data identifiers.

If this value is null, the job uses the recommended set of managed data identifiers.

If the job is a recurring job and this value is ALL or EXCLUDE, each job run automatically uses new managed data identifiers that are released. If this value is null or RECOMMENDED for a recurring job, each job run uses all the managed data identifiers that are in the recommended set when the run starts.

To learn about individual managed data identifiers or determine which ones are in the recommended set, see Using managed data identifiers or Recommended managed data identifiers in the Amazon Macie User Guide.

VARCHAR
name

The custom name of the job.

VARCHAR
s3_job_definition

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

STRUCT(
    "bucket_criteria" STRUCT(
        "excludes" STRUCT(
            "and" STRUCT(
                "simple_criterion" STRUCT(
                    "comparator" VARCHAR,
                    "key" VARCHAR,
                    "values" VARCHAR[]
                ),
                "tag_criterion" STRUCT(
                    "comparator" VARCHAR,
                    "tag_values" STRUCT(
                        "key" VARCHAR,
                        "value" VARCHAR
                    )[]
                )
            )[]
        ),
        "includes" STRUCT(
            "and" STRUCT(
                "simple_criterion" STRUCT(
                    "comparator" VARCHAR,
                    "key" VARCHAR,
                    "values" VARCHAR[]
                ),
                "tag_criterion" STRUCT(
                    "comparator" VARCHAR,
                    "tag_values" STRUCT(
                        "key" VARCHAR,
                        "value" VARCHAR
                    )[]
                )
            )[]
        )
    ),
    "bucket_definitions" STRUCT(
        "account_id" VARCHAR,
        "buckets" VARCHAR[]
    )[],
    "scoping" STRUCT(
        "excludes" STRUCT(
            "and" STRUCT(
                "simple_scope_term" STRUCT(
                    "comparator" VARCHAR,
                    "key" VARCHAR,
                    "values" VARCHAR[]
                ),
                "tag_scope_term" STRUCT(
                    "comparator" VARCHAR,
                    "key" VARCHAR,
                    "tag_values" STRUCT(
                        "key" VARCHAR,
                        "value" VARCHAR
                    )[],
                    "target" VARCHAR
                )
            )[]
        ),
        "includes" STRUCT(
            "and" STRUCT(
                "simple_scope_term" STRUCT(
                    "comparator" VARCHAR,
                    "key" VARCHAR,
                    "values" VARCHAR[]
                ),
                "tag_scope_term" STRUCT(
                    "comparator" VARCHAR,
                    "key" VARCHAR,
                    "tag_values" STRUCT(
                        "key" VARCHAR,
                        "value" VARCHAR
                    )[],
                    "target" VARCHAR
                )
            )[]
        )
    )
)
Show child fields
s3_job_definition.bucket_criteria

The property- and tag-based conditions that determine which S3 buckets to include or exclude from the analysis. Each time the job runs, the job uses these criteria to determine which buckets contain objects to analyze. A job's definition can contain a bucketCriteria object or a bucketDefinitions array, not both.

Show child fields
s3_job_definition.bucket_criteria.excludes

The property- and tag-based conditions that determine which buckets to exclude from the job.

Show child fields
s3_job_definition.bucket_criteria.excludes.and[]
Show child fields
s3_job_definition.bucket_criteria.excludes.and[].simple_criterion

A property-based condition that defines a property, operator, and one or more values for including or excluding buckets from the job.

Show child fields
s3_job_definition.bucket_criteria.excludes.and[].simple_criterion.comparator

The operator to use in the condition. Valid values are EQ (equals) and NE (not equals).

s3_job_definition.bucket_criteria.excludes.and[].simple_criterion.key

The property to use in the condition.

s3_job_definition.bucket_criteria.excludes.and[].simple_criterion.values[]
s3_job_definition.bucket_criteria.excludes.and[].tag_criterion

A tag-based condition that defines an operator and tag keys, tag values, or tag key and value pairs for including or excluding buckets from the job.

Show child fields
s3_job_definition.bucket_criteria.excludes.and[].tag_criterion.comparator

The operator to use in the condition. Valid values are EQ (equals) and NE (not equals).

s3_job_definition.bucket_criteria.excludes.and[].tag_criterion.tag_values[]
Show child fields
s3_job_definition.bucket_criteria.excludes.and[].tag_criterion.tag_values[].key

The value for the tag key to use in the condition.

s3_job_definition.bucket_criteria.excludes.and[].tag_criterion.tag_values[].value

The tag value to use in the condition.

s3_job_definition.bucket_criteria.includes

The property- and tag-based conditions that determine which buckets to include in the job.

Show child fields
s3_job_definition.bucket_criteria.includes.and[]
Show child fields
s3_job_definition.bucket_criteria.includes.and[].simple_criterion

A property-based condition that defines a property, operator, and one or more values for including or excluding buckets from the job.

Show child fields
s3_job_definition.bucket_criteria.includes.and[].simple_criterion.comparator

The operator to use in the condition. Valid values are EQ (equals) and NE (not equals).

s3_job_definition.bucket_criteria.includes.and[].simple_criterion.key

The property to use in the condition.

s3_job_definition.bucket_criteria.includes.and[].simple_criterion.values[]
s3_job_definition.bucket_criteria.includes.and[].tag_criterion

A tag-based condition that defines an operator and tag keys, tag values, or tag key and value pairs for including or excluding buckets from the job.

Show child fields
s3_job_definition.bucket_criteria.includes.and[].tag_criterion.comparator

The operator to use in the condition. Valid values are EQ (equals) and NE (not equals).

s3_job_definition.bucket_criteria.includes.and[].tag_criterion.tag_values[]
Show child fields
s3_job_definition.bucket_criteria.includes.and[].tag_criterion.tag_values[].key

The value for the tag key to use in the condition.

s3_job_definition.bucket_criteria.includes.and[].tag_criterion.tag_values[].value

The tag value to use in the condition.

s3_job_definition.bucket_definitions[]
Show child fields
s3_job_definition.bucket_definitions[].account_id

The unique identifier for the Amazon Web Services account that owns the buckets.

s3_job_definition.bucket_definitions[].buckets[]
s3_job_definition.scoping

The property- and tag-based conditions that determine which S3 objects to include or exclude from the analysis. Each time the job runs, the job uses these criteria to determine which objects to analyze.

Show child fields
s3_job_definition.scoping.excludes

The property- and tag-based conditions that determine which objects to exclude from the analysis.

Show child fields
s3_job_definition.scoping.excludes.and[]
Show child fields
s3_job_definition.scoping.excludes.and[].simple_scope_term

A property-based condition that defines a property, operator, and one or more values for including or excluding objects from the job.

Show child fields
s3_job_definition.scoping.excludes.and[].simple_scope_term.comparator

The operator to use in the condition. Valid values for each supported property (key) are:

  • OBJECT_EXTENSION - EQ (equals) or NE (not equals)

  • OBJECT_KEY - STARTS_WITH

  • OBJECT_LAST_MODIFIED_DATE - EQ (equals), GT (greater than), GTE (greater than or equals), LT (less than), LTE (less than or equals), or NE (not equals)

  • OBJECT_SIZE - EQ (equals), GT (greater than), GTE (greater than or equals), LT (less than), LTE (less than or equals), or NE (not equals)

s3_job_definition.scoping.excludes.and[].simple_scope_term.key

The object property to use in the condition.

s3_job_definition.scoping.excludes.and[].simple_scope_term.values[]
s3_job_definition.scoping.excludes.and[].tag_scope_term

A tag-based condition that defines the operator and tag keys or tag key and value pairs for including or excluding objects from the job.

Show child fields
s3_job_definition.scoping.excludes.and[].tag_scope_term.comparator

The operator to use in the condition. Valid values are EQ (equals) or NE (not equals).

s3_job_definition.scoping.excludes.and[].tag_scope_term.key

The object property to use in the condition. The only valid value is TAG.

s3_job_definition.scoping.excludes.and[].tag_scope_term.tag_values[]
Show child fields
s3_job_definition.scoping.excludes.and[].tag_scope_term.tag_values[].key

The value for the tag key to use in the condition.

s3_job_definition.scoping.excludes.and[].tag_scope_term.tag_values[].value

The tag value, associated with the specified tag key (key), to use in the condition. To specify only a tag key for a condition, specify the tag key for the key property and set this value to an empty string.

s3_job_definition.scoping.excludes.and[].tag_scope_term.target

The type of object to apply the condition to.

s3_job_definition.scoping.includes

The property- and tag-based conditions that determine which objects to include in the analysis.

Show child fields
s3_job_definition.scoping.includes.and[]
Show child fields
s3_job_definition.scoping.includes.and[].simple_scope_term

A property-based condition that defines a property, operator, and one or more values for including or excluding objects from the job.

Show child fields
s3_job_definition.scoping.includes.and[].simple_scope_term.comparator

The operator to use in the condition. Valid values for each supported property (key) are:

  • OBJECT_EXTENSION - EQ (equals) or NE (not equals)

  • OBJECT_KEY - STARTS_WITH

  • OBJECT_LAST_MODIFIED_DATE - EQ (equals), GT (greater than), GTE (greater than or equals), LT (less than), LTE (less than or equals), or NE (not equals)

  • OBJECT_SIZE - EQ (equals), GT (greater than), GTE (greater than or equals), LT (less than), LTE (less than or equals), or NE (not equals)

s3_job_definition.scoping.includes.and[].simple_scope_term.key

The object property to use in the condition.

s3_job_definition.scoping.includes.and[].simple_scope_term.values[]
s3_job_definition.scoping.includes.and[].tag_scope_term

A tag-based condition that defines the operator and tag keys or tag key and value pairs for including or excluding objects from the job.

Show child fields
s3_job_definition.scoping.includes.and[].tag_scope_term.comparator

The operator to use in the condition. Valid values are EQ (equals) or NE (not equals).

s3_job_definition.scoping.includes.and[].tag_scope_term.key

The object property to use in the condition. The only valid value is TAG.

s3_job_definition.scoping.includes.and[].tag_scope_term.tag_values[]
Show child fields
s3_job_definition.scoping.includes.and[].tag_scope_term.tag_values[].key

The value for the tag key to use in the condition.

s3_job_definition.scoping.includes.and[].tag_scope_term.tag_values[].value

The tag value, associated with the specified tag key (key), to use in the condition. To specify only a tag key for a condition, specify the tag key for the key property and set this value to an empty string.

s3_job_definition.scoping.includes.and[].tag_scope_term.target

The type of object to apply the condition to.

sampling_percentage

The sampling depth, as a percentage, that determines the percentage of eligible objects that the job analyzes.

BIGINT
schedule_frequency

The recurrence pattern for running the job. This value is null if the job is configured to run only once.

STRUCT(
    "daily_schedule" BOOLEAN,
    "monthly_schedule" STRUCT(
        "day_of_month" BIGINT
    ),
    "weekly_schedule" STRUCT(
        "day_of_week" VARCHAR
    )
)
Show child fields
schedule_frequency.daily_schedule

Specifies a daily recurrence pattern for running the job.

schedule_frequency.monthly_schedule

Specifies a monthly recurrence pattern for running the job.

Show child fields
schedule_frequency.monthly_schedule.day_of_month

The numeric day of the month when Amazon Macie runs the job. This value can be an integer from 1 through 31.

If this value exceeds the number of days in a certain month, Macie doesn't run the job that month. Macie runs the job only during months that have the specified day. For example, if this value is 31 and a month has only 30 days, Macie doesn't run the job that month. To run the job every month, specify a value that's less than 29.

schedule_frequency.weekly_schedule

Specifies a weekly recurrence pattern for running the job.

Show child fields
schedule_frequency.weekly_schedule.day_of_week

The day of the week when Amazon Macie runs the job.

statistics

The number of times that the job has run and processing statistics for the job's current run.

STRUCT(
    "approximate_number_of_objects_to_process" DOUBLE,
    "number_of_runs" DOUBLE
)
Show child fields
statistics.approximate_number_of_objects_to_process

The approximate number of objects that the job has yet to process during its current run.

statistics.number_of_runs

The number of times that the job has run.

tags

A map of key-value pairs that specifies which tags (keys and values) are associated with the job.

MAP(VARCHAR, VARCHAR)
user_paused_details

If the current status of the job is USER_PAUSED, specifies when the job was paused and when the job or job run will expire and be cancelled if it isn't resumed. This value is present only if the value for jobStatus is USER_PAUSED.

STRUCT(
    "job_expires_at" TIMESTAMP_S,
    "job_imminent_expiration_health_event_arn" VARCHAR,
    "job_paused_at" TIMESTAMP_S
)
Show child fields
user_paused_details.job_expires_at

The date and time, in UTC and extended ISO 8601 format, when the job or job run will expire and be cancelled if you don't resume it first.

user_paused_details.job_imminent_expiration_health_event_arn

The Amazon Resource Name (ARN) of the Health event that Amazon Macie sent to notify you of the job or job run's pending expiration and cancellation. This value is null if a job has been paused for less than 23 days.

user_paused_details.job_paused_at

The date and time, in UTC and extended ISO 8601 format, when you paused the job.