Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.
All 92 tools →
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/amazon-macie-jobs-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
version: 2020-01-01
x-release: v4
title: Amazon Macie 2 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: <p>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.</p> <p>If you configure the job to run only once, don't specify a value for this property.</p>
type: boolean
jobType:
description: 'The schedule for running a classification job. Valid values are:'
type: string
enum:
- ONE_TIME
- SCHEDULED
managedDataIdentifierIds:
description: <p>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).</p> <p>To retrieve a list of valid values for this property, use the ListManagedDataIdentifiers operation.</p>
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:
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.
ConflictException: {}
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:'
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.
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.
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:'
__integer:
type: integer
__listOfTagCriterionPairForJob:
type: array
items:
$ref: '#/components/schemas/TagCriterionPairForJob'
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.
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.
JobStatus:
type: string
enum:
- RUNNING
- PAUSED
- CANCELLED
- COMPLETE
- IDLE
- USER_PAUSED
description: 'The status of a classification job. Possible values are:'
ValidationException: {}
__listOfTagValuePair:
type: array
items:
$ref: '#/components/schemas/TagValuePair'
__timestampIso8601:
type: string
format: date-time
__boolean:
type: boolean
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.
OrderBy:
type: string
enum:
- ASC
- DESC
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: ' <p>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.</p>'
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.
__double:
type: number
format: double
UpdateClassificationJobResponse:
type: object
properties: {}
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:'
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.
AccessDeniedException: {}
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:'
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'
DailySchedule:
type: object
properties: {}
description: Specifies that a classification job runs once a day, every day. This is an empty object.
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 o
# --- truncated at 32 KB (56 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amazon-macie/refs/heads/main/openapi/amazon-macie-jobs-api-openapi.yml