DescribeClassificationJobCommand

Suggest an Edit

Retrieves the status and settings for a classification job.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { Macie2Client, DescribeClassificationJobCommand } from "@aws-sdk/client-macie2"; // ES Modules import
// const { Macie2Client, DescribeClassificationJobCommand } = require("@aws-sdk/client-macie2"); // CommonJS import
const client = new Macie2Client(config);
const input = { // DescribeClassificationJobRequest
  jobId: "STRING_VALUE", // required
};
const command = new DescribeClassificationJobCommand(input);
const response = await client.send(command);
// { // DescribeClassificationJobResponse
//   allowListIds: [ // __listOf__string
//     "STRING_VALUE",
//   ],
//   clientToken: "STRING_VALUE",
//   createdAt: new Date("TIMESTAMP"),
//   customDataIdentifierIds: [
//     "STRING_VALUE",
//   ],
//   description: "STRING_VALUE",
//   initialRun: true || false,
//   jobArn: "STRING_VALUE",
//   jobId: "STRING_VALUE",
//   jobStatus: "RUNNING" || "PAUSED" || "CANCELLED" || "COMPLETE" || "IDLE" || "USER_PAUSED",
//   jobType: "ONE_TIME" || "SCHEDULED",
//   lastRunErrorStatus: { // LastRunErrorStatus
//     code: "NONE" || "ERROR",
//   },
//   lastRunTime: new Date("TIMESTAMP"),
//   managedDataIdentifierIds: [
//     "STRING_VALUE",
//   ],
//   managedDataIdentifierSelector: "ALL" || "EXCLUDE" || "INCLUDE" || "NONE" || "RECOMMENDED",
//   name: "STRING_VALUE",
//   s3JobDefinition: { // S3JobDefinition
//     bucketCriteria: { // S3BucketCriteriaForJob
//       excludes: { // CriteriaBlockForJob
//         and: [ // __listOfCriteriaForJob
//           { // CriteriaForJob
//             simpleCriterion: { // SimpleCriterionForJob
//               comparator: "EQ" || "GT" || "GTE" || "LT" || "LTE" || "NE" || "CONTAINS" || "STARTS_WITH",
//               key: "ACCOUNT_ID" || "S3_BUCKET_NAME" || "S3_BUCKET_EFFECTIVE_PERMISSION" || "S3_BUCKET_SHARED_ACCESS",
//               values: [
//                 "STRING_VALUE",
//               ],
//             },
//             tagCriterion: { // TagCriterionForJob
//               comparator: "EQ" || "GT" || "GTE" || "LT" || "LTE" || "NE" || "CONTAINS" || "STARTS_WITH",
//               tagValues: [ // __listOfTagCriterionPairForJob
//                 { // TagCriterionPairForJob
//                   key: "STRING_VALUE",
//                   value: "STRING_VALUE",
//                 },
//               ],
//             },
//           },
//         ],
//       },
//       includes: {
//         and: [
//           {
//             simpleCriterion: {
//               comparator: "EQ" || "GT" || "GTE" || "LT" || "LTE" || "NE" || "CONTAINS" || "STARTS_WITH",
//               key: "ACCOUNT_ID" || "S3_BUCKET_NAME" || "S3_BUCKET_EFFECTIVE_PERMISSION" || "S3_BUCKET_SHARED_ACCESS",
//               values: [
//                 "STRING_VALUE",
//               ],
//             },
//             tagCriterion: {
//               comparator: "EQ" || "GT" || "GTE" || "LT" || "LTE" || "NE" || "CONTAINS" || "STARTS_WITH",
//               tagValues: [
//                 {
//                   key: "STRING_VALUE",
//                   value: "STRING_VALUE",
//                 },
//               ],
//             },
//           },
//         ],
//       },
//     },
//     bucketDefinitions: [ // __listOfS3BucketDefinitionForJob
//       { // S3BucketDefinitionForJob
//         accountId: "STRING_VALUE", // required
//         buckets: "<__listOf__string>", // required
//       },
//     ],
//     scoping: { // Scoping
//       excludes: { // JobScopingBlock
//         and: [ // __listOfJobScopeTerm
//           { // JobScopeTerm
//             simpleScopeTerm: { // SimpleScopeTerm
//               comparator: "EQ" || "GT" || "GTE" || "LT" || "LTE" || "NE" || "CONTAINS" || "STARTS_WITH",
//               key: "OBJECT_EXTENSION" || "OBJECT_LAST_MODIFIED_DATE" || "OBJECT_SIZE" || "OBJECT_KEY",
//               values: "<__listOf__string>",
//             },
//             tagScopeTerm: { // TagScopeTerm
//               comparator: "EQ" || "GT" || "GTE" || "LT" || "LTE" || "NE" || "CONTAINS" || "STARTS_WITH",
//               key: "STRING_VALUE",
//               tagValues: [ // __listOfTagValuePair
//                 { // TagValuePair
//                   key: "STRING_VALUE",
//                   value: "STRING_VALUE",
//                 },
//               ],
//               target: "S3_OBJECT",
//             },
//           },
//         ],
//       },
//       includes: {
//         and: [
//           {
//             simpleScopeTerm: {
//               comparator: "EQ" || "GT" || "GTE" || "LT" || "LTE" || "NE" || "CONTAINS" || "STARTS_WITH",
//               key: "OBJECT_EXTENSION" || "OBJECT_LAST_MODIFIED_DATE" || "OBJECT_SIZE" || "OBJECT_KEY",
//               values: "<__listOf__string>",
//             },
//             tagScopeTerm: {
//               comparator: "EQ" || "GT" || "GTE" || "LT" || "LTE" || "NE" || "CONTAINS" || "STARTS_WITH",
//               key: "STRING_VALUE",
//               tagValues: [
//                 {
//                   key: "STRING_VALUE",
//                   value: "STRING_VALUE",
//                 },
//               ],
//               target: "S3_OBJECT",
//             },
//           },
//         ],
//       },
//     },
//   },
//   samplingPercentage: Number("int"),
//   scheduleFrequency: { // JobScheduleFrequency
//     dailySchedule: {},
//     monthlySchedule: { // MonthlySchedule
//       dayOfMonth: Number("int"),
//     },
//     weeklySchedule: { // WeeklySchedule
//       dayOfWeek: "SUNDAY" || "MONDAY" || "TUESDAY" || "WEDNESDAY" || "THURSDAY" || "FRIDAY" || "SATURDAY",
//     },
//   },
//   statistics: { // Statistics
//     approximateNumberOfObjectsToProcess: Number("double"),
//     numberOfRuns: Number("double"),
//   },
//   tags: { // TagMap
//     "<keys>": "STRING_VALUE",
//   },
//   userPausedDetails: { // UserPausedDetails
//     jobExpiresAt: new Date("TIMESTAMP"),
//     jobImminentExpirationHealthEventArn: "STRING_VALUE",
//     jobPausedAt: new Date("TIMESTAMP"),
//   },
// };

DescribeClassificationJobCommand Input

See DescribeClassificationJobCommandInput for more details

Parameter
Type
Description
jobId
Required
string | undefined

The unique identifier for the classification job.

DescribeClassificationJobCommand Output

See DescribeClassificationJobCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
allowListIds
string[] | undefined

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

clientToken
string | undefined

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

createdAt
Date | undefined

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

customDataIdentifierIds
string[] | undefined

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.

description
string | undefined

The custom description of the job.

initialRun
boolean | undefined

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.

jobArn
string | undefined

The Amazon Resource Name (ARN) of the job.

jobId
string | undefined

The unique identifier for the job.

jobStatus
JobStatus | undefined

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.

jobType
JobType | undefined

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.

lastRunErrorStatus
LastRunErrorStatus | undefined

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.

lastRunTime
Date | undefined

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.

managedDataIdentifierIds
string[] | undefined

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.

managedDataIdentifierSelector
ManagedDataIdentifierSelector | undefined

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.

name
string | undefined

The custom name of the job.

s3JobDefinition
S3JobDefinition | undefined

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

samplingPercentage
number | undefined

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

scheduleFrequency
JobScheduleFrequency | undefined

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

statistics
Statistics | undefined

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

tags
Record<string, string> | undefined

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

userPausedDetails
UserPausedDetails | undefined

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.

Throws

Name
Fault
Details
AccessDeniedException
client

Provides information about an error that occurred due to insufficient access to a specified resource.

ConflictException
client

Provides information about an error that occurred due to a versioning conflict for a specified resource.

InternalServerException
server

Provides information about an error that occurred due to an unknown internal server error, exception, or failure.

ResourceNotFoundException
client

Provides information about an error that occurred because a specified resource wasn't found.

ServiceQuotaExceededException
client

Provides information about an error that occurred due to one or more service quotas for an account.

ThrottlingException
client

Provides information about an error that occurred because too many requests were sent during a certain amount of time.

ValidationException
client

Provides information about an error that occurred due to a syntax error in a request.

Macie2ServiceException
Base exception class for all service exceptions from Macie2 service.