Amazon Macie Findings API
The Findings API from Amazon Macie — 6 operation(s) for findings.
Amazon Macie Findings 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 Findings. 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 6 operations across 6 paths, and defines 101 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.
6 operations
6 paths
101 schemas
2 GET4 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Amazon Macie Findings API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as Authorization (hmac).
By default, every request must be authenticated.
hmac— Amazon Signature authorization v4
Paths & Operations 6
Across 6 paths, the API surfaces 6 operations — 2 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.
Findings 6
POST
/findings/sample
Amazon Macie Create Sample Findings
POST
/findings/statistics
Amazon Macie Get Finding Statistics
POST
/findings/describe
Amazon Macie Get Findings
GET
/findings/{findingId}/reveal
Amazon Macie Get Sensitive Data Occurrences
GET
/findings/{findingId}/reveal/availability
Amazon Macie Get Sensitive Data Occurrences Availability
POST
/findings
Amazon Macie List Findings
Schemas 101
The contract defines 101 schemas that model the data the API accepts and returns. The most detailed are Finding (18 properties), S3Object (12 properties), S3Bucket (8 properties), CriterionAdditionalProperties (7 properties). Each schema is shown below with its type and property counts.
Range
object
Specifies the location of an occurrence of sensitive data in an email message or a non-binary text file such as an HTML, TXT, or XML file.
3 properties
S3Object
object
Provides information about the S3 object that a finding applies to.
12 properties
__timestampIso8601
string
AccessDeniedException
CustomDataIdentifiers
object
Provides information about custom data identifiers that produced a sensitive data finding, and the number of occurrences of the data that they detected for the…
2 properties
__listOfDetectedDataDetails
array
AccessControlList
object
Provides information about the permissions settings of the bucket-level access control list (ACL) for an S3 bucket.
2 properties
Cells
array
Specifies the location of occurrences of sensitive data in a Microsoft Excel workbook, CSV file, or TSV file.
Records
array
Specifies the locations of occurrences of sensitive data in an Apache Avro object container or a structured data file.
KeyValuePair
object
Provides information about the tags that are associated with an S3 bucket or object. Each tag consists of a required tag key and an associated tag value.
2 properties
EffectivePermission
string
__listOfFinding
array
Record
object
Specifies the location of an occurrence of sensitive data in an Apache Avro object container, Apache Parquet file, JSON file, or JSON Lines file.
2 properties
__listOfUnavailabilityReasonCode
array
IpCity
object
Provides information about the city that an IP address originated from.
1 property
AwsService
object
Provides information about an Amazon Web Service that performed an action on an affected resource.
1 property
SensitiveDataOccurrences
object
Specifies a type of sensitive data reported by a finding and provides occurrences of the specified type of sensitive data.
EncryptionType
string
The server-side encryption algorithm that was used to encrypt an S3 object or is used by default to encrypt objects that are added to an S3 bucket. Possible va…
CriterionAdditionalProperties
object
Specifies the operator to use in a property-based condition that filters the results of a query for findings. For detailed information and examples of each ope…
7 properties
PolicyDetails
object
Provides the details of a policy finding.
2 properties
FindingAction
object
Provides information about an action that occurred for a resource and produced a policy finding.
2 properties
GetSensitiveDataOccurrencesAvailabilityResponse
object
2 properties
SeverityDescription
string
The qualitative representation of the finding's severity. Possible values are:
CustomDetections
array
Provides information about custom data identifiers that produced a sensitive data finding, and the number of occurrences of the data that each identifier detec…
IpGeoLocation
object
Provides geographic coordinates that indicate where a specified IP address originated from.
2 properties
__double
number
__listOfGroupCount
array
DefaultDetections
array
Provides information about sensitive data that was detected by managed data identifiers and produced a sensitive data finding, and the number of occurrences of…
AvailabilityCode
string
Specifies whether occurrences of sensitive data can be retrieved for a finding. Possible values are:
FindingActionType
string
The type of action that occurred for the resource and produced the policy finding:
BucketLevelPermissions
object
Provides information about the bucket-level permissions settings for an S3 bucket.
3 properties
Occurrences
object
Specifies the location of 1-15 occurrences of sensitive data that was detected by a managed data identifier or a custom data identifier and produced a sensitiv…
5 properties
BlockPublicAccess
object
Provides information about the block public access settings for an S3 bucket. These settings can apply to a bucket at the account or bucket level. For detailed…
4 properties
Pages
array
Specifies the location of occurrences of sensitive data in an Adobe Portable Document Format file.
Page
object
Specifies the location of an occurrence of sensitive data in an Adobe Portable Document Format file.
3 properties
InternalServerException
Finding
object
Provides the details of a finding.
18 properties
ClassificationResult
object
Provides the details of a sensitive data finding, including the types, number of occurrences, and locations of the sensitive data that was detected.
6 properties
SensitiveDataItem
object
Provides information about the category, types, and occurrences of sensitive data that produced a sensitive data finding.
3 properties
IpAddressDetails
object
Provides information about the IP address of the device that an entity used to perform an action on an affected resource.
5 properties
UserIdentityType
string
The type of entity that performed the action on the affected resource. Possible values are:
IpCountry
object
Provides information about the country that an IP address originated from.
2 properties
SessionContext
object
Provides information about a session that was created for an entity that performed an action by using temporary security credentials.
2 properties
OriginType
string
Specifies how Amazon Macie found the sensitive data that produced a finding. Possible values are:
Cell
object
Specifies the location of an occurrence of sensitive data in a Microsoft Excel workbook, CSV file, or TSV file.
4 properties
__listOf__string
array
DomainDetails
object
Provides information about the domain name of the device that an entity used to perform an action on an affected resource.
1 property
ServerSideEncryption
object
Provides information about the default server-side encryption settings for an S3 bucket or the encryption settings for an S3 object.
2 properties
RevealRequestStatus
string
The status of a request to retrieve occurrences of sensitive data reported by a finding. Possible values are:
ThrottlingException
OrderBy
string
AccountLevelPermissions
object
Provides information about the account-level permissions settings that apply to an S3 bucket.
1 property
ResourceNotFoundException
Criterion
object
Specifies a condition that defines a property, operator, and one or more values to filter the results of a query for findings. The number of values depends on…
BucketPublicAccess
object
Provides information about the permissions settings that determine whether an S3 bucket is publicly accessible.
2 properties
CreateSampleFindingsResponse
object
SessionContextAttributes
object
Provides information about the context in which temporary security credentials were issued to an entity.
2 properties
FindingStatisticsSortAttributeName
string
The grouping to sort the results by. Valid values are:
UserIdentity
object
Provides information about the type and other characteristics of an entity that performed an action on an affected resource.
7 properties
GetFindingsResponse
object
1 property
SessionIssuer
object
Provides information about the source and type of temporary security credentials that were issued to an entity.
5 properties
__stringMin1Max128
string
ClassificationResultStatus
object
Provides information about the status of a sensitive data finding.
2 properties
AssumedRole
object
Provides information about an identity that performed an action on an affected resource by using temporary security credentials. The credentials were obtained…
5 properties
UnprocessableEntityException
SensitiveDataItemCategory
string
For a finding, the category of sensitive data that was detected and produced the finding. For a managed data identifier, the category of sensitive data that th…
BucketPolicy
object
Provides information about the permissions settings of the bucket policy for an S3 bucket.
2 properties
IamUser
object
Provides information about an Identity and Access Management (IAM) user who performed an action on an affected resource.
4 properties
ClassificationDetails
object
Provides information about a sensitive data finding and the details of the finding.
5 properties
__long
integer
ServiceQuotaExceededException
ListFindingsResponse
object
2 properties
GroupCount
object
Provides a group of results for a query that retrieved aggregated statistical data about findings.
2 properties
StorageClass
string
The storage class of the S3 object. Possible values are:
FindingType
string
The type of finding. For details about each type, see Types of Amazon Macie findings in the Amazon Macie User Guide . Possible values are:
GetSensitiveDataOccurrencesResponse
object
3 properties
UserIdentityRoot
object
Provides information about an Amazon Web Services account and entity that performed an action on an affected resource. The action was performed using the crede…
3 properties
ConflictException
CustomDetection
object
Provides information about a custom data identifier that produced a sensitive data finding, and the sensitive data that it detected for the finding.
4 properties
FederatedUser
object
Provides information about an identity that performed an action on an affected resource by using temporary security credentials. The credentials were obtained…
5 properties
ApiCallDetails
object
Provides information about an API operation that an entity invoked for an affected resource.
4 properties
ValidationException
S3BucketOwner
object
Provides information about the Amazon Web Services account that owns an S3 bucket.
2 properties
GetFindingStatisticsResponse
object
1 property
Ranges
array
Specifies the locations of occurrences of sensitive data in a non-binary text file.
__boolean
boolean
KeyValuePairList
array
Provides information about the tags that are associated with an S3 bucket or object. Each tag consists of a required tag key and an associated tag value.
IpOwner
object
Provides information about the registered owner of an IP address.
4 properties
FindingCategory
string
The category of the finding. Possible values are:
FindingActor
object
Provides information about an entity that performed an action that produced a policy finding for a resource.
3 properties
BucketPermissionConfiguration
object
Provides information about the account-level and bucket-level permissions settings for an S3 bucket.
2 properties
AwsAccount
object
Provides information about an Amazon Web Services account and entity that performed an action on an affected resource. The action was performed using the crede…
2 properties
AllowsUnencryptedObjectUploads
string
UnavailabilityReasonCode
string
Specifies why occurrences of sensitive data can't be retrieved for a finding. Possible values are:
SensitiveData
array
Provides information about the category and number of occurrences of sensitive data that produced a finding.
Severity
object
Provides the numerical and qualitative representations of a finding's severity.
2 properties
DetectedDataDetails
object
Specifies 1-10 occurrences of a specific type of sensitive data reported by a finding.
1 property
1 required
DefaultDetection
object
Provides information about a type of sensitive data that was detected by a managed data identifier and produced a sensitive data finding.
3 properties
ResourcesAffected
object
Provides information about the resources that a finding applies to.
2 properties
S3Bucket
object
Provides information about the S3 bucket that a finding applies to.
8 properties
__string
string
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Amazon Macie 12
Other APIs Amazon Macie publishes across the network.
Amazon Macie Admin#adminAccountId API
Amazon Macie Admin API
Amazon Macie Administrator API
Amazon Macie Allow Lists API
Amazon Macie Automated Discovery API
Amazon Macie Classification Export Configuration API
Amazon Macie Classification Scopes API
Amazon Macie Custom Data Identifiers API
Amazon Macie Datasources API
Amazon Macie Findings Publication Configuration API
Amazon Macie Findingsfilters API
Amazon Macie Invitations API
#Findings
Where this information came from
This is an independent, third-party profile of Amazon Macie Findings API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.