Skip to content

aws.macie2.list_classification_jobs

Example SQL Queries

SELECT * FROM
aws.macie2.list_classification_jobs;

Description

Retrieves a subset of information about one or more classification jobs.

Table Definition

Column NameColumn Data Type
filter_criteria Input Column

The criteria to use to filter the results.

STRUCT(
"excludes" STRUCT(
"comparator" VARCHAR,
"key" VARCHAR,
"values" VARCHAR[]
)[],
"includes" STRUCT(
"comparator" VARCHAR,
"key" VARCHAR,
"values" VARCHAR[]
)[]
)
Show child fields
filter_criteria.excludes[]
Show child fields
filter_criteria.excludes[].comparator

The operator to use to filter the results.

filter_criteria.excludes[].key

The property to use to filter the results.

filter_criteria.excludes[].values[]
filter_criteria.includes[]
Show child fields
filter_criteria.includes[].comparator

The operator to use to filter the results.

filter_criteria.includes[].key

The property to use to filter the results.

filter_criteria.includes[].values[]
sort_criteria Input Column

The criteria to use to sort the results.

STRUCT(
"attribute_name" VARCHAR,
"order_by" VARCHAR
)
Show child fields
sort_criteria.attribute_name

The property to sort the results by.

sort_criteria.order_by

The sort order to apply to the results, based on the value for the property specified by the attributeName property. Valid values are: ASC, sort the results in ascending order; and, DESC, sort the results in descending order.

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

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

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
)[]
)
)[]
)
)
Show child fields
bucket_criteria.excludes

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

Show child fields
bucket_criteria.excludes.and[]
Show child fields
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
bucket_criteria.excludes.and[].simple_criterion.comparator

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

bucket_criteria.excludes.and[].simple_criterion.key

The property to use in the condition.

bucket_criteria.excludes.and[].simple_criterion.values[]
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
bucket_criteria.excludes.and[].tag_criterion.comparator

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

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

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

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

The tag value to use in the condition.

bucket_criteria.includes

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

Show child fields
bucket_criteria.includes.and[]
Show child fields
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
bucket_criteria.includes.and[].simple_criterion.comparator

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

bucket_criteria.includes.and[].simple_criterion.key

The property to use in the condition.

bucket_criteria.includes.and[].simple_criterion.values[]
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
bucket_criteria.includes.and[].tag_criterion.comparator

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

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

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

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

The tag value to use in the condition.

bucket_definitions

An array of objects, one for each Amazon Web Services account that owns specific S3 buckets for the job to analyze. Each object specifies the account ID for an account and one or more buckets to analyze for that account. A job's definition can contain a bucketDefinitions array or a bucketCriteria object, not both.

STRUCT(
"account_id" VARCHAR,
"buckets" VARCHAR[]
)[]
Show child fields
bucket_definitions[]
Show child fields
bucket_definitions[].account_id

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

bucket_definitions[].buckets[]
created_at

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

TIMESTAMP_S
job_id

The unique identifier for 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.

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.

name

The custom name of the job.

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.