Amazon Macie Jobs API is one of 24 APIs that Amazon Macie publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 2 JSON Schema definitions.
Tagged areas include Job. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, pricing, a JSON-LD context, and 2 JSON Schemas.
This API exposes
4 operations
across 3 paths,
and defines 60 schemas.
It is described by OpenAPI 3.2.0, at version 2020-01-01.
Requests are made against 4 base URLs: http://macie2.{region}.amazonaws.com, https://macie2.{region}.amazonaws.com, http://macie2.{region}.amazonaws.com.cn, https://macie2.{region}.amazonaws.com.cn.
The identity and technical contract details declared by the specification.
TagScopeTerm
object
Specifies a tag-based condition that determines whether an S3 object is included or excluded from a classification job.
4 properties
ScopeFilterKey
string
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
object
Specifies which S3 buckets contain the objects that a classification job analyzes, and the scope of that analysis. The bucket specification can be static (buck…
3 properties
TagValuePair
object
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 classificatio…
2 properties
SimpleCriterionKeyForJob
string
The property to use in a condition that determines whether an S3 bucket is included or excluded from a classification job. Valid values are:
__listOfTagCriterionPairForJob
array
CriteriaBlockForJob
object
Specifies one or more property- and tag-based conditions that define criteria for including or excluding S3 buckets from a classification job.
1 property
JobScheduleFrequency
object
Specifies the recurrence pattern for running a classification job.
3 properties
JobStatus
string
The status of a classification job. Possible values are:
__listOfTagValuePair
array
__timestampIso8601
string
TagCriterionForJob
object
Specifies a tag-based condition that determines whether an S3 bucket is included or excluded from a classification job.
2 properties
TagCriterionPairForJob
object
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 exclud…
2 properties
ListClassificationJobsResponse
object
2 properties
UpdateClassificationJobResponse
object
ManagedDataIdentifierSelector
string
The selection type that determines which managed data identifiers a classification job uses to analyze data. Valid values are:
JobScopingBlock
object
Specifies one or more property- and tag-based conditions that define criteria for including or excluding S3 objects from a classification job.
1 property
LastRunErrorStatusCode
string
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 cla…
TagMap
object
A string-to-string map of key-value pairs that specifies the tags (keys and values) for an Amazon Macie resource.
DailySchedule
object
Specifies that a classification job runs once a day, every day. This is an empty object.
DescribeClassificationJobResponse
object
21 properties
LastRunErrorStatus
object
Specifies whether any account- or bucket-level access errors occurred when a classification job ran. For information about using logging data to investigate th…
1 property
__listOfS3BucketDefinitionForJob
array
ListJobsFilterTerm
object
Specifies a condition that filters the results of a request for information about classification jobs. Each condition consists of a property, an operator, and…
3 properties
__listOfCriteriaForJob
array
ListJobsSortAttributeName
string
The property to sort the results by. Valid values are:
__listOfJobScopeTerm
array
JobComparator
string
The operator to use in a condition. Depending on the type of condition, possible values are:
__listOfListJobsFilterTerm
array
JobScopeTerm
object
Specifies a property- or tag-based condition that defines criteria for including or excluding S3 objects from a classification job. A JobScopeTerm object can c…
2 properties
MonthlySchedule
object
Specifies a monthly recurrence pattern for running a classification job.
1 property
SimpleCriterionForJob
object
Specifies a property-based condition that determines whether an S3 bucket is included or excluded from a classification job.
3 properties
UserPausedDetails
object
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…
3 properties
JobSummary
object
Provides information about a classification job, including the current status of the job.
9 properties
JobType
string
The schedule for running a classification job. Valid values are:
S3BucketDefinitionForJob
object
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.
2 properties
2 required
ServiceQuotaExceededException
ListJobsFilterKey
string
The property to use to filter the results. Valid values are:
S3BucketCriteriaForJob
object
Specifies property- and tag-based conditions that define criteria for including or excluding S3 buckets from a classification job. Exclude conditions take prec…
2 properties
ResourceNotFoundException
WeeklySchedule
object
Specifies a weekly recurrence pattern for running a classification job.
1 property
CriteriaForJob
object
Specifies a property- or tag-based condition that defines criteria for including or excluding S3 buckets from a classification job.
2 properties
TagTarget
string
The type of object to apply a tag-based condition to. Valid values are:
Scoping
object
Specifies one or more property- and tag-based conditions that define criteria for including or excluding S3 objects from a classification job. Exclude conditio…
2 properties
CreateClassificationJobResponse
object
2 properties
Statistics
object
Provides processing statistics for a classification job.
2 properties
SimpleScopeTerm
object
Specifies a property-based condition that determines whether an S3 object is included or excluded from a classification job.
3 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Amazon Macie publishes across the network.
