openapi: 3.0.0 info: version: 2020-01-01 x-release: v4 title: Amazon Macie 2 Admin#adminAccountId Jobs API description: Amazon Macie x-logo: url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png backgroundColor: '#FFFFFF' termsOfService: https://aws.amazon.com/service-terms/ contact: name: Mike Ralphson email: mike.ralphson@gmail.com url: https://github.com/mermade/aws2openapi x-twitter: PermittedSoc license: name: Apache 2.0 License url: http://www.apache.org/licenses/ x-providerName: amazonaws.com x-serviceName: macie2 x-aws-signingName: macie2 x-origin: - contentType: application/json url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/macie2-2020-01-01.normal.json converter: url: https://github.com/mermade/aws2openapi version: 1.0.0 x-apisguru-driver: external x-apiClientRegistration: url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct x-apisguru-categories: - cloud x-preferred: true servers: - url: http://macie2.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Amazon Macie 2 multi-region endpoint - url: https://macie2.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Amazon Macie 2 multi-region endpoint - url: http://macie2.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Amazon Macie 2 endpoint for China (Beijing) and China (Ningxia) - url: https://macie2.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Amazon Macie 2 endpoint for China (Beijing) and China (Ningxia) security: - hmac: [] tags: - name: Jobs paths: /jobs: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: CreateClassificationJob description: Creates and defines the settings for a classification job. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateClassificationJobResponse' '480': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '481': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' '482': description: ServiceQuotaExceededException content: application/json: schema: $ref: '#/components/schemas/ServiceQuotaExceededException' '483': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '484': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '485': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '486': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - clientToken - jobType - name - s3JobDefinition properties: allowListIds: description: An array of unique identifiers, one for each allow list for the job to use when it analyzes data. type: array items: $ref: '#/components/schemas/__string' clientToken: description: A unique, case-sensitive token that you provide to ensure the idempotency of the request. type: string customDataIdentifierIds: description: An array of unique identifiers, one for each custom data identifier for the job to use when it analyzes data. To use only managed data identifiers, don't specify a value for this property and specify a value other than NONE for the managedDataIdentifierSelector property. type: array items: $ref: '#/components/schemas/__string' description: description: A custom description of the job. The description can contain as many as 200 characters. type: string initialRun: description:

For a recurring job, specifies whether to analyze all existing, eligible objects immediately after the job is created (true). To analyze only those objects that are created or changed after you create the job and before the job's first scheduled run, set this value to false.

If you configure the job to run only once, don't specify a value for this property.

type: boolean jobType: description: 'The schedule for running a classification job. Valid values are:' type: string enum: - ONE_TIME - SCHEDULED managedDataIdentifierIds: description:

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

To retrieve a list of valid values for this property, use the ListManagedDataIdentifiers operation.

type: array items: $ref: '#/components/schemas/__string' managedDataIdentifierSelector: description: 'The selection type that determines which managed data identifiers a classification job uses to analyze data. Valid values are:' type: string enum: - ALL - EXCLUDE - INCLUDE - NONE name: description: A custom name for the job. The name can contain as many as 500 characters. type: string s3JobDefinition: description: Specifies which S3 buckets contain the objects that a classification job analyzes, and the scope of that analysis. The bucket specification can be static (bucketDefinitions) or dynamic (bucketCriteria). If it's static, the job analyzes objects in the same predefined set of buckets each time the job runs. If it's dynamic, the job analyzes objects in any buckets that match the specified criteria each time the job starts to run. type: object properties: bucketCriteria: allOf: - $ref: '#/components/schemas/S3BucketCriteriaForJob' - description: 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. bucketDefinitions: allOf: - $ref: '#/components/schemas/__listOfS3BucketDefinitionForJob' - description: An array of objects, one for each Amazon Web Services account that owns specific S3 buckets 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. scoping: allOf: - $ref: '#/components/schemas/Scoping' - description: 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. samplingPercentage: description: The sampling depth, as a percentage, for the job to apply when processing objects. This value determines the percentage of eligible objects that the job analyzes. If this value is less than 100, Amazon Macie selects the objects to analyze at random, up to the specified percentage, and analyzes all the data in those objects. type: integer scheduleFrequency: description: Specifies the recurrence pattern for running a classification job. type: object properties: dailySchedule: allOf: - $ref: '#/components/schemas/DailySchedule' - description: Specifies a daily recurrence pattern for running the job. monthlySchedule: allOf: - $ref: '#/components/schemas/MonthlySchedule' - description: Specifies a monthly recurrence pattern for running the job. weeklySchedule: allOf: - $ref: '#/components/schemas/WeeklySchedule' - description: Specifies a weekly recurrence pattern for running the job. tags: description: A string-to-string map of key-value pairs that specifies the tags (keys and values) for an Amazon Macie resource. type: object additionalProperties: $ref: '#/components/schemas/__string' summary: Amazon Macie Create Classification Job tags: - Jobs /jobs/{jobId}: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: operationId: DescribeClassificationJob description: Retrieves the status and settings for a classification job. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeClassificationJobResponse' '480': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '481': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' '482': description: ServiceQuotaExceededException content: application/json: schema: $ref: '#/components/schemas/ServiceQuotaExceededException' '483': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '484': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '485': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '486': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' parameters: - name: jobId in: path required: true description: The unique identifier for the classification job. schema: type: string summary: Amazon Macie Describe Classification Job tags: - Jobs patch: operationId: UpdateClassificationJob description: Changes the status of a classification job. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateClassificationJobResponse' '480': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '481': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' '482': description: ServiceQuotaExceededException content: application/json: schema: $ref: '#/components/schemas/ServiceQuotaExceededException' '483': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '484': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '485': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '486': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' parameters: - name: jobId in: path required: true description: The unique identifier for the classification job. schema: type: string requestBody: required: true content: application/json: schema: type: object required: - jobStatus properties: jobStatus: description: 'The status of a classification job. Possible values are:' type: string enum: - RUNNING - PAUSED - CANCELLED - COMPLETE - IDLE - USER_PAUSED summary: Amazon Macie Update Classification Job tags: - Jobs /jobs/list: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: ListClassificationJobs description: Retrieves a subset of information about one or more classification jobs. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListClassificationJobsResponse' '480': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '481': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' '482': description: ServiceQuotaExceededException content: application/json: schema: $ref: '#/components/schemas/ServiceQuotaExceededException' '483': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '484': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '485': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '486': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' parameters: - name: maxResults in: query schema: type: string description: Pagination limit required: false - name: nextToken in: query schema: type: string description: Pagination token required: false requestBody: required: true content: application/json: schema: type: object properties: filterCriteria: description: Specifies criteria for filtering the results of a request for information about classification jobs. type: object properties: excludes: allOf: - $ref: '#/components/schemas/__listOfListJobsFilterTerm' - description: An array of objects, one for each condition that determines which jobs to exclude from the results. includes: allOf: - $ref: '#/components/schemas/__listOfListJobsFilterTerm' - description: An array of objects, one for each condition that determines which jobs to include in the results. maxResults: description: The maximum number of items to include in each page of the response. type: integer nextToken: description: The nextToken string that specifies which page of results to return in a paginated response. type: string sortCriteria: description: Specifies criteria for sorting the results of a request for information about classification jobs. type: object properties: attributeName: allOf: - $ref: '#/components/schemas/ListJobsSortAttributeName' - description: The property to sort the results by. orderBy: allOf: - $ref: '#/components/schemas/OrderBy' - description: '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.' summary: Amazon Macie List Classification Jobs tags: - Jobs components: schemas: LastRunErrorStatus: type: object properties: code: allOf: - $ref: '#/components/schemas/LastRunErrorStatusCode' - description:

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:

description: Specifies whether any account- or bucket-level access errors occurred when a classification job ran. For information about using logging data to investigate these errors, see Monitoring sensitive data discovery jobs in the Amazon Macie User Guide. __listOfS3BucketDefinitionForJob: type: array items: $ref: '#/components/schemas/S3BucketDefinitionForJob' TagScopeTerm: type: object properties: comparator: allOf: - $ref: '#/components/schemas/JobComparator' - description: The operator to use in the condition. Valid values are EQ (equals) or NE (not equals). key: allOf: - $ref: '#/components/schemas/__string' - description: The object property to use in the condition. The only valid value is TAG. tagValues: allOf: - $ref: '#/components/schemas/__listOfTagValuePair' - description: The tag keys or tag key and value pairs to use in the condition. To specify only tag keys in a condition, specify the keys in this array and set the value for each associated tag value to an empty string. target: allOf: - $ref: '#/components/schemas/TagTarget' - description: The type of object to apply the condition to. description: Specifies a tag-based condition that determines whether an S3 object is included or excluded from a classification job. TagCriterionPairForJob: type: object properties: key: allOf: - $ref: '#/components/schemas/__string' - description: The value for the tag key to use in the condition. value: allOf: - $ref: '#/components/schemas/__string' - description: The tag value to use in the condition. description: '

Specifies a tag key, a tag value, or a tag key and value (as a pair) to use in a tag-based condition that determines whether an S3 bucket is included or excluded from a classification job. Tag keys and values are case sensitive. Also, Amazon Macie doesn''t support use of partial values or wildcard characters in tag-based conditions.

' S3JobDefinition: type: object properties: bucketCriteria: allOf: - $ref: '#/components/schemas/S3BucketCriteriaForJob' - description: 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. bucketDefinitions: allOf: - $ref: '#/components/schemas/__listOfS3BucketDefinitionForJob' - description: An array of objects, one for each Amazon Web Services account that owns specific S3 buckets 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. scoping: allOf: - $ref: '#/components/schemas/Scoping' - description: 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. description: Specifies which S3 buckets contain the objects that a classification job analyzes, and the scope of that analysis. The bucket specification can be static (bucketDefinitions) or dynamic (bucketCriteria). If it's static, the job analyzes objects in the same predefined set of buckets each time the job runs. If it's dynamic, the job analyzes objects in any buckets that match the specified criteria each time the job starts to run. UpdateClassificationJobResponse: type: object properties: {} TagCriterionForJob: type: object properties: comparator: allOf: - $ref: '#/components/schemas/JobComparator' - description: The operator to use in the condition. Valid values are EQ (equals) and NE (not equals). tagValues: allOf: - $ref: '#/components/schemas/__listOfTagCriterionPairForJob' - description: The tag keys, tag values, or tag key and value pairs to use in the condition. description: Specifies a tag-based condition that determines whether an S3 bucket is included or excluded from a classification job. __listOfTagValuePair: type: array items: $ref: '#/components/schemas/TagValuePair' JobType: type: string enum: - ONE_TIME - SCHEDULED description: 'The schedule for running a classification job. Valid values are:' __integer: type: integer ThrottlingException: {} InternalServerException: {} MonthlySchedule: type: object properties: dayOfMonth: allOf: - $ref: '#/components/schemas/__integer' - description:

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.

description: Specifies a monthly recurrence pattern for running a classification job. ListClassificationJobsResponse: type: object properties: items: allOf: - $ref: '#/components/schemas/__listOfJobSummary' - description: An array of objects, one for each job that matches the filter criteria specified in the request. nextToken: allOf: - $ref: '#/components/schemas/__string' - description: The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages. JobSummary: type: object properties: bucketCriteria: allOf: - $ref: '#/components/schemas/S3BucketCriteriaForJob' - description: 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. bucketDefinitions: allOf: - $ref: '#/components/schemas/__listOfS3BucketDefinitionForJob' - description: 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. createdAt: allOf: - $ref: '#/components/schemas/__timestampIso8601' - description: The date and time, in UTC and extended ISO 8601 format, when the job was created. jobId: allOf: - $ref: '#/components/schemas/__string' - description: The unique identifier for the job. jobStatus: allOf: - $ref: '#/components/schemas/JobStatus' - description:

The current status of the job. Possible values are:

jobType: allOf: - $ref: '#/components/schemas/JobType' - description:

The schedule for running the job. Possible values are:

lastRunErrorStatus: allOf: - $ref: '#/components/schemas/LastRunErrorStatus' - description: 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. name: allOf: - $ref: '#/components/schemas/__string' - description: The custom name of the job. userPausedDetails: allOf: - $ref: '#/components/schemas/UserPausedDetails' - description: 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. description: Provides information about a classification job, including the current status of the job. DescribeClassificationJobResponse: type: object properties: allowListIds: allOf: - $ref: '#/components/schemas/__listOf__string' - description: An array of unique identifiers, one for each allow list that the job uses when it analyzes data. clientToken: allOf: - $ref: '#/components/schemas/__string' - description: The token that was provided to ensure the idempotency of the request to create the job. createdAt: allOf: - $ref: '#/components/schemas/__timestampIso8601' - description: The date and time, in UTC and extended ISO 8601 format, when the job was created. customDataIdentifierIds: allOf: - $ref: '#/components/schemas/__listOf__string' - description: An array of unique identifiers, one for each custom data identifier that the job uses when it analyzes data. This value is null if the job uses only managed data identifiers to analyze data. description: allOf: - $ref: '#/components/schemas/__string' - description: The custom description of the job. initialRun: allOf: - $ref: '#/components/schemas/__boolean' - description: 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: allOf: - $ref: '#/components/schemas/__string' - description: The Amazon Resource Name (ARN) of the job. jobId: allOf: - $ref: '#/components/schemas/__string' - description: The unique identifier for the job. jobStatus: allOf: - $ref: '#/components/schemas/JobStatus' - description:

The current status of the job. Possible values are:

jobType: allOf: - $ref: '#/components/schemas/JobType' - description:

The schedule for running the job. Possible values are:

lastRunErrorStatus: allOf: - $ref: '#/components/schemas/LastRunErrorStatus' - description: 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: allOf: - $ref: '#/components/schemas/__timestampIso8601' - description: 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: allOf: - $ref: '#/components/schemas/__listOf__string' - description: 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 or the job uses only custom data identifiers (customDataIdentifierIds) to analyze data. managedDataIdentifierSelector: allOf: - $ref: '#/components/schemas/ManagedDataIdentifierSelector' - description:

The selection type that determines which managed data identifiers the job uses to analyze data. Possible values are:

If this value is null, the job uses all managed data identifiers. If this value is null, ALL, or EXCLUDE for a recurring job, the job also uses new managed data identifiers as they are released.

name: allOf: - $ref: '#/components/schemas/__string' - description: The custom name of the job. s3JobDefinition: allOf: - $ref: '#/components/schemas/S3JobDefinition' - description: The S3 buckets that contain the objects to analyze, and the scope of that analysis. samplingPercentage: allOf: - $ref: '#/components/schemas/__integer' - description: The sampling depth, as a percentage, that determines the percentage of eligible objects that the job analyzes. scheduleFrequency: allOf: - $ref: '#/components/schemas/JobScheduleFrequency' - description: The recurrence pattern for running the job. This value is null if the job is configured to run only once. statistics: allOf: - $ref: '#/components/schemas/Statistics' - description: The number of times that the job has run and processing statistics for the job's current run. tags: allOf: - $ref: '#/components/schemas/TagMap' - description: A map of key-value pairs that specifies which tags (keys and values) are associated with the classification job. userPausedDetails: allOf: - $ref: '#/components/schemas/UserPausedDetails' - description: 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. TagTarget: type: string enum: - S3_OBJECT description: 'The type of object to apply a tag-based condition to. Valid values are:' ConflictException: {} JobScheduleFrequency: type: object properties: dailySchedule: allOf: - $ref: '#/components/schemas/DailySchedule' - description: Specifies a daily recurrence pattern for running the job. monthlySchedule: allOf: - $ref: '#/components/schemas/MonthlySchedule' - description: Specifies a monthly recurrence pattern for running the job. weeklySchedule: allOf: - $ref: '#/components/schemas/WeeklySchedule' - description: Specifies a weekly recurrence pattern for running the job. description: Specifies the recurrence pattern for running a classification job. SimpleCriterionForJob: type: object properties: comparator: allOf: - $ref: '#/components/schemas/JobComparator' - description: The operator to use in the condition. Valid values are EQ (equals) and NE (not equals). key: allOf: - $ref: '#/components/schemas/SimpleCriterionKeyForJob' - description: The property to use in the condition. values: allOf: - $ref: '#/components/schemas/__listOf__string' - description:

An array that lists one or more values to use in the condition. If you specify multiple values, Amazon Macie uses OR logic to join the values. Valid values for each supported property (key) are:

Values are case sensitive. Also, Macie doesn't support use of partial values or wildcard characters in these values.

description: Specifies a property-based condition that determines whether an S3 bucket is included or excluded from a classification job. CreateClassificationJobResponse: type: object properties: jobArn: allOf: - $ref: '#/components/schemas/__string' - description: The Amazon Resource Name (ARN) of the job. jobId: allOf: - $ref: '#/components/schemas/__string' - description: The unique identifier for the job. __listOfJobScopeTerm: type: array items: $ref: '#/components/schemas/JobScopeTerm' UserPausedDetails: type: object properties: jobExpiresAt: allOf: - $ref: '#/components/schemas/__timestampIso8601' - description: 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. jobImminentExpirationHealthEventArn: allOf: - $ref: '#/components/schemas/__string' - description: 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. jobPausedAt: allOf: - $ref: '#/components/schemas/__timestampIso8601' - description: The date and time, in UTC and extended ISO 8601 format, when you paused the job. description: Provides information about when a classification job was paused. For a one-time job, this object also specifies when the job will expire and be cancelled if it isn't resumed. For a recurring job, this object also specifies when the paused job run will expire and be cancelled if it isn't resumed. This object is present only if a job's current status (jobStatus) is USER_PAUSED. The information in this object applies only to a job that was paused while it had a status of RUNNING. __string: type: string __listOf__string: type: array items: $ref: '#/components/schemas/__string' DailySchedule: type: object properties: {} description: Specifies that a classification job runs once a day, every day. This is an empty object. ServiceQuotaExceededException: {} ListJobsFilterKey: type: string enum: - jobType - jobStatus - createdAt - name description: 'The property to use to filter the results. Valid values are:' CriteriaForJob: type: object properties: simpleCriterion: allOf: - $ref: '#/components/schemas/SimpleCriterionForJob' - description: A property-based condition that defines a property, operator, and one or more values for including or excluding buckets from the job. tagCriterion: allOf: - $ref: '#/components/schemas/TagCriterionForJob' - description: 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. description: Specifies a property- or tag-based condition that defines criteria for including or excluding S3 buckets from a classification job. JobScopeTerm: type: object properties: simpleScopeTerm: allOf: - $ref: '#/components/schemas/SimpleScopeTerm' - description: A property-based condition that defines a property, operator, and one or more values for including or excluding objects from the job. tagScopeTerm: allOf: - $ref: '#/components/schemas/TagScopeTerm' - description: 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. description: Specifies a property- or tag-based condition that defines criteria for including or excluding S3 objects from a classification job. A JobScopeTerm object can contain only one simpleScopeTerm object or one tagScopeTerm object. __boolean: type: boolean OrderBy: type: string enum: - ASC - DESC Statistics: type: object properties: approximateNumberOfObjectsToProcess: allOf: - $ref: '#/components/schemas/__double' - description: The approximate number of objects that the job has yet to process during its current run. numberOfRuns: allOf: - $ref: '#/components/schemas/__double' - description: The number of times that the job has run. description: Provides processing statistics for a classification job. JobScopingBlock: type: object properties: and: allOf: - $ref: '#/components/schemas/__listOfJobScopeTerm' - description: An array of conditions, one for each property- or tag-based condition that determines which objects to include or exclude from the job. If you specify more than one condition, Amazon Macie uses AND logic to join the conditions. description: Specifies one or more property- and tag-based conditions that define criteria for including or excluding S3 objects from a classification job. TagValuePair: type: object properties: key: allOf: - $ref: '#/components/schemas/__string' - description: The value for the tag key to use in the condition. value: allOf: - $ref: '#/components/schemas/__string' - description: 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. description: Specifies a tag key or tag key and value pair to use in a tag-based condition that determines whether an S3 object is included or excluded from a classification job. Tag keys and values are case sensitive. Also, Amazon Macie doesn't support use of partial values or wildcard characters in tag-based conditions. S3BucketDefinitionForJob: type: object required: - accountId - buckets properties: accountId: allOf: - $ref: '#/components/schemas/__string' - description: The unique identifier for the Amazon Web Services account that owns the buckets. buckets: allOf: - $ref: '#/components/schemas/__listOf__string' - description: An array that lists the names of the buckets. description: Specifies an Amazon Web Services account that owns S3 buckets for a classification job to analyze, and one or more specific buckets to analyze for that account. __timestampIso8601: type: string format: date-time ListJobsSortAttributeName: type: string enum: - createdAt - jobStatus - name - jobType description: 'The property to sort the results by. Valid values are:' WeeklySchedule: type: object properties: dayOfWeek: allOf: - $ref: '#/components/schemas/DayOfWeek' - description: The day of the week when Amazon Macie runs the job. description: Specifies a weekly recurrence pattern for running a classification job. DayOfWeek: type: string enum: - SUNDAY - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY Scoping: type: object properties: excludes: allOf: - $ref: '#/components/schemas/JobScopingBlock' - description: The property- and tag-based conditions that determine which objects to exclude from the analysis. includes: allOf: - $ref: '#/components/schemas/JobScopingBlock' - description: The property- and tag-based conditions that determine which objects to include in the analysis. description: Specifies one or more property- and tag-based conditions that define criteria for including or excluding S3 objects from a classification job. Exclude conditions take precedence over include conditions. SimpleCriterionKeyForJob: type: string enum: - ACCOUNT_ID - S3_BUCKET_NAME - S3_BUCKET_EFFECTIVE_PERMISSION - S3_BUCKET_SHARED_ACCESS description: 'The property to use in a condition that determines whether an S3 bucket is included or excluded from a classification job. Valid values are:' ResourceNotFoundException: {} __listOfListJobsFilterTerm: type: array items: $ref: '#/components/schemas/ListJobsFilterTerm' AccessDeniedException: {} CriteriaBlockForJob: type: object properties: and: allOf: - $ref: '#/components/schemas/__listOfCriteriaForJob' - description: An array of conditions, one for each condition that determines which buckets to include or exclude from the job. If you specify more than one condition, Amazon Macie uses AND logic to join the conditions. description: Specifies one or more property- and tag-based conditions that define criteria for including or excluding S3 buckets from a classification job. JobStatus: type: string enum: - RUNNING - PAUSED - CANCELLED - COMPLETE - IDLE - USER_PAUSED description: 'The status of a classification job. Possible values are:' LastRunErrorStatusCode: type: string enum: - NONE - ERROR description: 'Specifies whether any account- or bucket-level access errors occurred during the run of a one-time classification job or the most recent run of a recurring classification job. Possible values are:' __listOfTagCriterionPairForJob: type: array items: $ref: '#/components/schemas/TagCriterionPairForJob' ListJobsFilterTerm: type: object properties: comparator: allOf: - $ref: '#/components/schemas/JobComparator' - description: The operator to use to filter the results. key: allOf: - $ref: '#/components/schemas/ListJobsFilterKey' - description: The property to use to filter the results. values: allOf: - $ref: '#/components/schemas/__listOf__string' - description: An array that lists one or more values to use to filter the results. description: Specifies a condition that filters the results of a request for information about classification jobs. Each condition consists of a property, an operator, and one or more values. ManagedDataIdentifierSelector: type: string enum: - ALL - EXCLUDE - INCLUDE - NONE description: 'The selection type that determines which managed data identifiers a classification job uses to analyze data. Valid values are:' __double: type: number format: double ValidationException: {} __listOfJobSummary: type: array items: $ref: '#/components/schemas/JobSummary' TagMap: type: object description: A string-to-string map of key-value pairs that specifies the tags (keys and values) for an Amazon Macie resource. additionalProperties: $ref: '#/components/schemas/__string' SimpleScopeTerm: type: object properties: comparator: allOf: - $ref: '#/components/schemas/JobComparator' - description:

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

key: allOf: - $ref: '#/components/schemas/ScopeFilterKey' - description: The object property to use in the condition. values: allOf: - $ref: '#/components/schemas/__listOf__string' - description: '

An array that lists the values to use in the condition. If the value for the key property is OBJECT_EXTENSION or OBJECT_KEY, this array can specify multiple values and Amazon Macie uses OR logic to join the values. Otherwise, this array can specify only one value.

Valid values for each supported property (key) are:

Macie doesn''t support use of wildcard characters in these values. Also, string values are case sensitive.

' description: Specifies a property-based condition that determines whether an S3 object is included or excluded from a classification job. S3BucketCriteriaForJob: type: object properties: excludes: allOf: - $ref: '#/components/schemas/CriteriaBlockForJob' - description: The property- and tag-based conditions that determine which buckets to exclude from the job. includes: allOf: - $ref: '#/components/schemas/CriteriaBlockForJob' - description: The property- and tag-based conditions that determine which buckets to include in the job. description: Specifies property- and tag-based conditions that define criteria for including or excluding S3 buckets from a classification job. Exclude conditions take precedence over include conditions. ScopeFilterKey: type: string enum: - OBJECT_EXTENSION - OBJECT_LAST_MODIFIED_DATE - OBJECT_SIZE - OBJECT_KEY description: 'The property to use in a condition that determines whether an S3 object is included or excluded from a classification job. Valid values are:' __listOfCriteriaForJob: type: array items: $ref: '#/components/schemas/CriteriaForJob' JobComparator: type: string enum: - EQ - GT - GTE - LT - LTE - NE - CONTAINS - STARTS_WITH description: 'The operator to use in a condition. Depending on the type of condition, possible values are:' parameters: X-Amz-Credential: name: X-Amz-Credential in: header schema: type: string required: false X-Amz-Algorithm: name: X-Amz-Algorithm in: header schema: type: string required: false X-Amz-Content-Sha256: name: X-Amz-Content-Sha256 in: header schema: type: string required: false X-Amz-Security-Token: name: X-Amz-Security-Token in: header schema: type: string required: false X-Amz-SignedHeaders: name: X-Amz-SignedHeaders in: header schema: type: string required: false X-Amz-Date: name: X-Amz-Date in: header schema: type: string required: false X-Amz-Signature: name: X-Amz-Signature in: header schema: type: string required: false securitySchemes: hmac: type: apiKey name: Authorization in: header description: Amazon Signature authorization v4 x-amazon-apigateway-authtype: awsSigv4 externalDocs: description: Amazon Web Services documentation url: https://docs.aws.amazon.com/macie2/ x-hasEquivalentPaths: true