Findings

The request succeeded.

The request failed because the input doesn't satisfy the constraints specified by the service.

The request failed because fulfilling the request would exceed one or more service quotas for your account.

The request was denied because you don't have sufficient access to the specified resource.

The request failed because the specified resource wasn't found.

The request failed because it conflicts with the current state of the specified resource.

The request failed because you sent too many requests during a certain amount of time.

The request failed due to an unknown internal server error, exception, or failure.

boolean

Specifies whether the ACL grants the general public with read access permissions for the bucket.

boolean

Specifies whether the ACL grants the general public with write access permissions for the bucket.

string

The explanation of the error that occurred.

BlockPublicAccess

The block public access settings for the AWS account that owns the bucket.

string

The name of the operation that was invoked most recently and produced the finding.

string

The URL of the AWS service that provides the operation, for example: s3.amazonaws.com.

string

Format: date-time

The first date and time, in UTC and extended ISO 8601 format, when any operation was invoked and produced the finding.

string

Format: date-time

The most recent date and time, in UTC and extended ISO 8601 format, when the specified operation (api) was invoked and produced the finding.

string

The AWS access key ID that identifies the credentials.

string

The unique identifier for the AWS account that owns the entity that was used to get the credentials.

string

The Amazon Resource Name (ARN) of the entity that was used to get the credentials.

string

The unique identifier for the entity that was used to get the credentials.

SessionContext

The details of the session that was created for the credentials, including the entity that issued the session.

string

The unique identifier for the AWS account.

string

The unique identifier for the entity that performed the action.

string

The name of the AWS service that performed the action.

boolean

Specifies whether Amazon S3 blocks public access control lists (ACLs) for the bucket and objects in the bucket.

boolean

Specifies whether Amazon S3 blocks public bucket policies for the bucket.

boolean

Specifies whether Amazon S3 ignores public ACLs for the bucket and objects in the bucket.

boolean

Specifies whether Amazon S3 restricts public bucket policies for the bucket.

AccessControlList

The permissions settings of the access control list (ACL) for the bucket. This value is null if an ACL hasn't been defined for the bucket.

BlockPublicAccess

The block public access settings for the bucket.

BucketPolicy

The permissions settings of the bucket policy for the bucket. This value is null if a bucket policy hasn't been defined for the bucket.

AccountLevelPermissions

The account-level permissions settings that apply to the bucket.

BucketLevelPermissions

The bucket-level permissions settings for the bucket.

boolean

Specifies whether the bucket policy allows the general public to have read access to the bucket.

boolean

Specifies whether the bucket policy allows the general public to have write access to the bucket.

string

Values: PUBLIC | NOT_PUBLIC | UNKNOWN

Specifies whether the bucket is publicly accessible due to the combination of permissions settings that apply to the bucket. Possible values are:

BucketPermissionConfiguration

The account-level and bucket-level permissions settings for the bucket.

string

The location of the cell, as an absolute cell reference, that contains the sensitive data, for example Sheet2!C5 for cell C5 on Sheet2 in a Microsoft Excel workbook. This value is null for CSV and TSV files.

integer

Format: int64

The column number of the column that contains the sensitive data. For a Microsoft Excel workbook, this value correlates to the alphabetical character(s) for a column identifier, for example: 1 for column A, 2 for column B, and so on.

string

The name of the column that contains the sensitive data, if available.

integer

Format: int64

The row number of the row that contains the sensitive data.

string

The path to the folder or file in Amazon S3 that contains the corresponding sensitive data discovery result for the finding. If a finding applies to a large archive or compressed file, this value is the path to a folder. Otherwise, this value is the path to a file.

string

The Amazon Resource Name (ARN) of the classification job that produced the finding. This value is null if the origin of the finding (originType) is AUTOMATED_SENSITIVE_DATA_DISCOVERY.

string

The unique identifier for the classification job that produced the finding. This value is null if the origin of the finding (originType) is AUTOMATED_SENSITIVE_DATA_DISCOVERY.

OriginType

Specifies how Amazon Macie found the sensitive data that produced the finding. Possible values are: SENSITIVE_DATA_DISCOVERY_JOB, for a classification job; and, AUTOMATED_SENSITIVE_DATA_DISCOVERY, for automated sensitive data discovery.

ClassificationResult

The status and other details of the finding.

boolean

Specifies whether Amazon Macie detected additional occurrences of sensitive data in the S3 object. A finding includes location data for a maximum of 15 occurrences of sensitive data.

This value can help you determine whether to investigate additional occurrences of sensitive data in an object. You can do this by referring to the corresponding sensitive data discovery result for the finding (classificationDetails.detailedResultsLocation).

CustomDataIdentifiers

The custom data identifiers that detected the sensitive data and the number of occurrences of the data that they detected.

string

The type of content, as a MIME type, that the finding applies to. For example, application/gzip, for a GNU Gzip compressed archive file, or application/pdf, for an Adobe Portable Document Format file.

Array of type SensitiveDataItem

The category, types, and number of occurrences of the sensitive data that produced the finding.

integer

Format: int64

The total size, in bytes, of the data that the finding applies to.

ClassificationResultStatus

The status of the finding.

string

The status of the finding. Possible values are:

string

A brief description of the status of the finding. This value is null if the status (code) of the finding is COMPLETE.

Amazon Macie uses this value to notify you of any errors, warnings, or considerations that might impact your analysis of the finding and the affected S3 object. Possible values are:

For information about quotas, supported storage classes, and supported file and storage formats, see Quotas and Supported storage classes and formats in the Amazon Macie User Guide.

string

The explanation of the error that occurred.

Array of type CustomDetection

The custom data identifiers that detected the data, and the number of occurrences of the data that each identifier detected.

integer

Format: int64

The total number of occurrences of the data that was detected by the custom data identifiers and produced the finding.

string

The unique identifier for the custom data identifier.

integer

Format: int64

The total number of occurrences of the sensitive data that the custom data identifier detected.

string

The name of the custom data identifier.

Occurrences

The location of 1-15 occurrences of the sensitive data that the custom data identifier detected. A finding includes location data for a maximum of 15 occurrences of sensitive data.

integer

Format: int64

The total number of occurrences of the type of sensitive data that was detected.

Occurrences

The location of 1-15 occurrences of the sensitive data that was detected. A finding includes location data for a maximum of 15 occurrences of sensitive data.

string

The type of sensitive data that was detected. For example, AWS_CREDENTIALS, PHONE_NUMBER, or ADDRESS.

string

The name of the domain.

string

The AWS access key ID that identifies the credentials.

string

The unique identifier for the AWS account that owns the entity that was used to get the credentials.

string

The Amazon Resource Name (ARN) of the entity that was used to get the credentials.

string

The unique identifier for the entity that was used to get the credentials.

SessionContext

The details of the session that was created for the credentials, including the entity that issued the session.

string

The unique identifier for the AWS account that the finding applies to. This is typically the account that owns the affected resource.

boolean

Specifies whether the finding is archived (suppressed).

FindingCategory

The category of the finding. Possible values are: CLASSIFICATION, for a sensitive data finding; and, POLICY, for a policy finding.

ClassificationDetails

The details of a sensitive data finding. This value is null for a policy finding.

integer

Format: int64

The total number of occurrences of the finding. For sensitive data findings, this value is always 1. All sensitive data findings are considered unique.

string

Format: date-time

The date and time, in UTC and extended ISO 8601 format, when Amazon Macie created the finding.

string

The description of the finding.

string

The unique identifier for the finding. This is a random string that Amazon Macie generates and assigns to a finding when it creates the finding.

string

The AWS partition that Amazon Macie created the finding in.

PolicyDetails

The details of a policy finding. This value is null for a sensitive data finding.

string

The AWS Region that Amazon Macie created the finding in.

ResourcesAffected

The resources that the finding applies to.

boolean

Specifies whether the finding is a sample finding. A sample finding is a finding that uses example data to demonstrate what a finding might contain.

string

The version of the schema that was used to define the data structures in the finding.

Severity

The severity level and score for the finding.

string

The brief description of the finding.

FindingType

The type of the finding.

string

Format: date-time

The date and time, in UTC and extended ISO 8601 format, when Amazon Macie last updated the finding. For sensitive data findings, this value is the same as the value for the createdAt property. All sensitive data findings are considered new.

FindingActionType

The type of action that occurred for the affected resource. This value is typically AWS_API_CALL, which indicates that an entity invoked an API operation for the resource.

ApiCallDetails

The invocation details of the API operation that an entity invoked for the affected resource, if the value for the actionType property is AWS_API_CALL.

DomainDetails

The domain name of the device that the entity used to perform the action on the affected resource.

IpAddressDetails

The IP address and related details about the device that the entity used to perform the action on the affected resource. The details can include information such as the owner and geographic location of the IP address.

UserIdentity

The type and other characteristics of the entity that performed the action on the affected resource. This value is null if the action was performed by an anonymous (unauthenticated) entity.

Array of type string

An array of strings that lists the unique identifiers for the findings to retrieve. You can specify as many as 50 unique identifiers in this array.

SortCriteria

The criteria for sorting the results of the request.

Array of type Finding

An array of objects, one for each finding that matches the criteria specified in the request.

string

The unique identifier for the AWS account that's associated with the IAM user who performed the action.

string

The Amazon Resource Name (ARN) of the principal that performed the action. The last section of the ARN contains the name of the user who performed the action.

string

The unique identifier for the IAM user who performed the action.

string

The username of the IAM user who performed the action.

string

The explanation of the error that occurred.

string

The Internet Protocol version 4 (IPv4) address of the device.

IpCity

The city that the IP address originated from.

IpCountry

The country that the IP address originated from.

IpGeoLocation

The geographic coordinates of the location that the IP address originated from.

IpOwner

The registered owner of the IP address.

string

The name of the city.

string

The two-character code, in ISO 3166-1 alpha-2 format, for the country that the IP address originated from. For example, US for the United States.

string

The name of the country that the IP address originated from.

number

The latitude coordinate of the location, rounded to four decimal places.

number

The longitude coordinate of the location, rounded to four decimal places.

string

The autonomous system number (ASN) for the autonomous system that included the IP address.

string

The organization identifier that's associated with the autonomous system number (ASN) for the autonomous system that included the IP address.

string

The name of the internet service provider (ISP) that owned the IP address.

string

The name of the organization that owned the IP address.

string

One part of a key-value pair that comprises a tag. A tag key is a general label that acts as a category for more specific tag values.

string

One part of a key-value pair that comprises a tag. A tag value acts as a descriptor for a tag key. A tag value can be an empty string.

Array of type Cell

An array of objects, one for each occurrence of sensitive data in a Microsoft Excel workbook, CSV file, or TSV file. This value is null for all other types of files.

Each Cell object specifies a cell or field that contains the sensitive data.

Array of type Range

An array of objects, one for each occurrence of sensitive data in an email message or a non-binary text file such as an HTML, TXT, or XML file. Each Range object specifies a line or inclusive range of lines that contains the sensitive data, and the position of the data on the specified line or lines.

This value is often null for file types that are supported by Cell, Page, or Record objects. Exceptions are the location of sensitive data in: unstructured sections of an otherwise structured file, such as a comment in a file; a malformed file that Amazon Macie analyzes as plain text; and, a CSV or TSV file that has any column names that contain sensitive data.

Array of type Range

Reserved for future use.

Array of type Page

An array of objects, one for each occurrence of sensitive data in an Adobe Portable Document Format file. This value is null for all other types of files.

Each Page object specifies a page that contains the sensitive data.

Array of type Record

An array of objects, one for each occurrence of sensitive data in an Apache Avro object container, Apache Parquet file, JSON file, or JSON Lines file. This value is null for all other types of files.

For an Avro object container or Parquet file, each Record object specifies a record index and the path to a field in a record that contains the sensitive data. For a JSON or JSON Lines file, each Record object specifies the path to a field or array that contains the sensitive data. For a JSON Lines file, it also specifies the index of the line that contains the data.

Range

Reserved for future use.

Range

Reserved for future use.

integer

Format: int64

The page number of the page that contains the sensitive data.

FindingAction

The action that produced the finding.

FindingActor

The entity that performed the action that produced the finding.

integer

Format: int64

The number of lines from the beginning of the file to the end of the sensitive data.

integer

Format: int64

The number of lines from the beginning of the file to the beginning of the sensitive data.

integer

Format: int64

The number of characters, with spaces and starting from 1, from the beginning of the first line that contains the sensitive data (start) to the beginning of the sensitive data.

string

The path, as a JSONPath expression, to the sensitive data. For an Avro object container or Parquet file, this is the path to the field in the record (recordIndex) that contains the data. For a JSON or JSON Lines file, this is the path to the field or array that contains the data. If the data is a value in an array, the path also indicates which value contains the data.

If Amazon Macie detects sensitive data in the name of any element in the path, Macie omits this field. If the name of an element exceeds 240 characters, Macie truncates the name by removing characters from the beginning of the name. If the resulting full path exceeds 250 characters, Macie also truncates the path, starting with the first element in the path, until the path contains 250 or fewer characters.

integer

Format: int64

For an Avro object container or Parquet file, the record index, starting from 0, for the record that contains the sensitive data. For a JSON Lines file, the line index, starting from 0, for the line that contains the sensitive data. This value is always 0 for JSON files.

string

The explanation of the error that occurred.

S3Bucket

The details of the S3 bucket that the finding applies to.

S3Object

The details of the S3 object that the finding applies to.

string

Values: TRUE | FALSE | UNKNOWN

Specifies whether the bucket policy for the bucket requires server-side encryption of objects when objects are added to the bucket. Possible values are:

Valid server-side encryption headers are: x-amz-server-side-encryption with a value of AES256 or aws:kms, and x-amz-server-side-encryption-customer-algorithm with a value of AES256.

string

The Amazon Resource Name (ARN) of the bucket.

string

Format: date-time

The date and time, in UTC and extended ISO 8601 format, when the bucket was created. This value can also indicate when changes such as edits to the bucket's policy were most recently made to the bucket, relative to when the finding was created or last updated.

ServerSideEncryption

The default server-side encryption settings for the bucket.

string

The name of the bucket.

S3BucketOwner

The display name and canonical user ID for the AWS account that owns the bucket.

BucketPublicAccess

The permissions settings that determine whether the bucket is publicly accessible.

Array of type KeyValuePair

The tags that are associated with the bucket.

string

The display name of the account that owns the bucket.

string

The canonical user ID for the account that owns the bucket.

string

The Amazon Resource Name (ARN) of the bucket that contains the object.

string

The entity tag (ETag) that identifies the affected version of the object. If the object was overwritten or changed after Amazon Macie produced the finding, this value might be different from the current ETag for the object.

string

The file name extension of the object. If the object doesn't have a file name extension, this value is "".

string

The full name (key) of the object, including the object's prefix if applicable.

string

Format: date-time

The date and time, in UTC and extended ISO 8601 format, when the object was last modified.

string

The full path to the affected object, including the name of the affected bucket and the object's name (key).

boolean

Specifies whether the object is publicly accessible due to the combination of permissions settings that apply to the object.

ServerSideEncryption

The type of server-side encryption that was used to encrypt the object.

integer

Format: int64

The total storage size, in bytes, of the object.

StorageClass

The storage class of the object.

Array of type KeyValuePair

The tags that are associated with the object.

string

The identifier for the affected version of the object.

SensitiveDataItemCategory

The category of sensitive data that was detected. For example: CREDENTIALS, for credentials data such as private keys or AWS secret access keys; FINANCIAL_INFORMATION, for financial data such as credit card numbers; or, PERSONAL_INFORMATION, for personal health information, such as health insurance identification numbers, or personally identifiable information, such as passport numbers.

Array of type DefaultDetection

An array of objects, one for each type of sensitive data that was detected. Each object reports the number of occurrences of a specific type of sensitive data that was detected, and the location of up to 15 of those occurrences.

integer

Format: int64

The total number of occurrences of the sensitive data that was detected.

EncryptionType

The server-side encryption algorithm that's used when storing data in the bucket or object. If default encryption settings aren't configured for the bucket or the object isn't encrypted using server-side encryption, this value is NONE.

string

The Amazon Resource Name (ARN) or unique identifier (key ID) for the AWS KMS key that's used to encrypt data in the bucket or the object. This value is null if an AWS KMS key isn't used to encrypt the data.

string

The explanation of the error that occurred.

SessionContextAttributes

The date and time when the credentials were issued, and whether the credentials were authenticated with a multi-factor authentication (MFA) device.

SessionIssuer

The source and type of credentials that were issued to the entity.

string

Format: date-time

The date and time, in UTC and ISO 8601 format, when the credentials were issued.

boolean

Specifies whether the credentials were authenticated with a multi-factor authentication (MFA) device.

string

The unique identifier for the AWS account that owns the entity that was used to get the credentials.

string

The Amazon Resource Name (ARN) of the source account, AWS Identity and Access Management (IAM) user, or role that was used to get the credentials.

string

The unique identifier for the entity that was used to get the credentials.

string

The source of the temporary security credentials, such as Root, IAMUser, or Role.

string

The name or alias of the user or role that issued the session. This value is null if the credentials were obtained from a root account that doesn't have an alias.

SeverityDescription

The qualitative representation of the finding's severity, ranging from Low (least severe) to High (most severe).

integer

Format: int64

The numerical representation of the finding's severity, ranging from 1 (least severe) to 3 (most severe).

string

The name of the property to sort the results by. Valid values are: count, createdAt, policyDetails.action.apiCallDetails.firstSeen, policyDetails.action.apiCallDetails.lastSeen, resourcesAffected, severity.score, type, and updatedAt.

string

Values: ASC | DESC

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.

string

The explanation of the error that occurred.

AssumedRole

If the action was performed with temporary security credentials that were obtained using the AssumeRole operation of the AWS Security Token Service (AWS STS) API, the identifiers, session context, and other details about the identity.

AwsAccount

If the action was performed using the credentials for another AWS account, the details of that account.

AwsService

If the action was performed by an AWS account that belongs to an AWS service, the name of the service.

FederatedUser

If the action was performed with temporary security credentials that were obtained using the GetFederationToken operation of the AWS Security Token Service (AWS STS) API, the identifiers, session context, and other details about the identity.

IamUser

If the action was performed using the credentials for an AWS Identity and Access Management (IAM) user, the name and other details about the user.

UserIdentityRoot

If the action was performed using the credentials for your AWS account, the details of your account.

UserIdentityType

The type of entity that performed the action.

string

The unique identifier for the AWS account.

string

The Amazon Resource Name (ARN) of the principal that performed the action. The last section of the ARN contains the name of the user or role that performed the action.

string

The unique identifier for the entity that performed the action.

string

The explanation of the error that occurred.