String administratorAccountId
The AWS account ID for the account that sent the invitation.
String invitationId
The unique identifier for the invitation to accept.
String masterAccount
(Deprecated) The AWS account ID for the account that sent the invitation. This property has been replaced by the administratorAccountId property and is retained only for backward compatibility.
Boolean allowsPublicReadAccess
Specifies whether the ACL grants the general public with read access permissions for the bucket.
Boolean allowsPublicWriteAccess
Specifies whether the ACL grants the general public with write access permissions for the bucket.
BlockPublicAccess blockPublicAccess
The block public access settings for the AWS account that owns the bucket.
String api
The name of the operation that was invoked most recently and produced the finding.
String apiServiceName
The URL of the AWS service that provides the operation, for example: s3.amazonaws.com.
Date firstSeen
The first date and time, in UTC and extended ISO 8601 format, when any operation was invoked and produced the finding.
Date lastSeen
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 accessKeyId
The AWS access key ID that identifies the credentials.
String accountId
The unique identifier for the AWS account that owns the entity that was used to get the credentials.
String arn
The Amazon Resource Name (ARN) of the entity that was used to get the credentials.
String principalId
The unique identifier for the entity that was used to get the credentials.
SessionContext sessionContext
The details of the session that was created for the credentials, including the entity that issued the session.
String invokedBy
The name of the AWS service that performed the action.
List<E> customDataIdentifiers
An array of objects, one for each custom data identifier that meets the criteria specified in the request.
List<E> notFoundIdentifierIds
An array of identifiers, one for each identifier that was specified in the request, but doesn't correlate to an existing custom data identifier.
String arn
The Amazon Resource Name (ARN) of the custom data identifier.
Date createdAt
The date and time, in UTC and extended ISO 8601 format, when the custom data identifier was created.
Boolean deleted
Specifies whether the custom data identifier was deleted. If you delete a custom data identifier, Amazon Macie doesn't delete it permanently. Instead, it soft deletes the identifier.
String description
The custom description of the custom data identifier.
String id
The unique identifier for the custom data identifier.
String name
The custom name of the custom data identifier.
Boolean blockPublicAcls
Specifies whether Amazon S3 blocks public access control lists (ACLs) for the bucket and objects in the bucket.
Boolean blockPublicPolicy
Specifies whether Amazon S3 blocks public bucket policies for the bucket.
Boolean ignorePublicAcls
Specifies whether Amazon S3 ignores public ACLs for the bucket and objects in the bucket.
Boolean restrictPublicBuckets
Specifies whether Amazon S3 restricts public bucket policies for the bucket.
Long publiclyAccessible
The total number of buckets that allow the general public to have read or write access to the bucket.
Long publiclyReadable
The total number of buckets that allow the general public to have read access to the bucket.
Long publiclyWritable
The total number of buckets that allow the general public to have write access to the bucket.
Long unknown
The total number of buckets that Amazon Macie wasn't able to evaluate permissions settings for. Macie can't determine whether these buckets are publicly accessible.
Long kmsManaged
The total number of buckets that use an AWS Key Management Service (AWS KMS) customer master key (CMK) to encrypt new objects by default. These buckets use AWS managed AWS KMS encryption (AWS-KMS) or customer managed AWS KMS encryption (SSE-KMS) by default.
Long s3Managed
The total number of buckets that use an Amazon S3 managed key to encrypt new objects by default. These buckets use Amazon S3 managed encryption (SSE-S3) by default.
Long unencrypted
The total number of buckets that don't encrypt new objects by default. Default encryption is disabled for these buckets.
Long unknown
The total number of buckets that Amazon Macie doesn't have current encryption metadata for. Macie can't provide current data about the default encryption settings for these buckets.
Long external
The total number of buckets that are shared with an AWS account that isn't part of the same Amazon Macie organization.
Long internal
The total number of buckets that are shared with an AWS account that's part of the same Amazon Macie organization.
Long notShared
The total number of buckets that aren't shared with other AWS accounts.
Long unknown
The total number of buckets that Amazon Macie wasn't able to evaluate shared access settings for. Macie can't determine whether these buckets are shared with other AWS accounts.
Long allowsUnencryptedObjectUploads
The total number of buckets that don't have a bucket policy or have a bucket policy that doesn't require server-side encryption of new objects. If a bucket policy exists, the policy doesn't require PutObject requests to include the x-amz-server-side-encryption header and it doesn't require the value for that header to be AES256 or aws:kms.
Long deniesUnencryptedObjectUploads
The total number of buckets whose bucket policies require server-side encryption of new objects. PutObject requests for these buckets must include the x-amz-server-side-encryption header and the value for that header must be AES256 or aws:kms.
Long unknown
The total number of buckets that Amazon Macie wasn't able to evaluate server-side encryption requirements for. Macie can't determine whether the bucket policies for these buckets require server-side encryption of new objects.
List<E> eq
The value for the property matches (equals) the specified value. If you specify multiple values, Macie uses OR logic to join the values.
Long gt
The value for the property is greater than the specified value.
Long gte
The value for the property is greater than or equal to the specified value.
Long lt
The value for the property is less than the specified value.
Long lte
The value for the property is less than or equal to the specified value.
List<E> neq
The value for the property doesn't match (doesn't equal) the specified value. If you specify multiple values, Amazon Macie uses OR logic to join the values.
String prefix
The name of the bucket begins with the specified value.
AccessControlList 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 blockPublicAccess
The block public access settings for the bucket.
BucketPolicy 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.
String accountId
The unique identifier for the AWS account that owns the bucket.
String allowsUnencryptedObjectUploads
Specifies whether the bucket policy for the bucket requires server-side encryption of objects when objects are uploaded to the bucket. Possible values are:
FALSE - The bucket policy requires server-side encryption of new objects. PutObject requests must include the x-amz-server-side-encryption header and the value for that header must be AES256 or aws:kms.
TRUE - The bucket doesn't have a bucket policy or it has a bucket policy that doesn't require server-side encryption of new objects. If a bucket policy exists, it doesn't require PutObject requests to include the x-amz-server-side-encryption header and it doesn't require the value for that header to be AES256 or aws:kms.
UNKNOWN - Amazon Macie can't determine whether the bucket policy requires server-side encryption of new objects.
String bucketArn
The Amazon Resource Name (ARN) of the bucket.
Date bucketCreatedAt
The date and time, in UTC and extended ISO 8601 format, when the bucket was created.
String bucketName
The name of the bucket.
Long classifiableObjectCount
The total number of objects that Amazon Macie can analyze in the bucket. These objects use a supported storage class and have a file name extension for a supported file or storage format.
Long classifiableSizeInBytes
The total storage size, in bytes, of the objects that Amazon Macie can analyze in the bucket. These objects use a supported storage class and have a file name extension for a supported file or storage format.
If versioning is enabled for the bucket, Macie calculates this value based on the size of the latest version of each applicable object in the bucket. This value doesn't reflect the storage size of all versions of each applicable object in the bucket.
JobDetails jobDetails
Specifies whether any one-time or recurring classification jobs are configured to analyze data in the bucket, and, if so, the details of the job that ran most recently.
Date lastUpdated
The date and time, in UTC and extended ISO 8601 format, when Amazon Macie most recently retrieved both bucket and object metadata from Amazon S3 for the bucket.
Long objectCount
The total number of objects in the bucket.
ObjectCountByEncryptionType objectCountByEncryptionType
The total number of objects that are in the bucket, grouped by server-side encryption type. This includes a grouping that reports the total number of objects that aren't encrypted or use client-side encryption.
BucketPublicAccess publicAccess
Specifies whether the bucket is publicly accessible due to the combination of permissions settings that apply to the bucket, and provides information about those settings.
String region
The AWS Region that hosts the bucket.
ReplicationDetails replicationDetails
Specifies whether the bucket is configured to replicate one or more objects to buckets for other AWS accounts and, if so, which accounts.
BucketServerSideEncryption serverSideEncryption
Specifies whether the bucket encrypts new objects by default and, if so, the type of server-side encryption that's used.
String sharedAccess
Specifies whether the bucket is shared with another AWS account. Possible values are:
EXTERNAL - The bucket is shared with an AWS account that isn't part of the same Amazon Macie organization.
INTERNAL - The bucket is shared with an AWS account that's part of the same Amazon Macie organization.
NOT_SHARED - The bucket isn't shared with other AWS accounts.
UNKNOWN - Amazon Macie wasn't able to evaluate the shared access settings for the bucket.
Long sizeInBytes
The total storage size, in bytes, of the bucket.
If versioning is enabled for the bucket, Amazon Macie calculates this value based on the size of the latest version of each object in the bucket. This value doesn't reflect the storage size of all versions of each object in the bucket.
Long sizeInBytesCompressed
The total compressed storage size, in bytes, of the bucket.
If versioning is enabled for the bucket, Macie calculates this value based on the size of the latest version of each object in the bucket. This value doesn't reflect the storage size of all versions of each object in the bucket.
List<E> tags
An array that specifies the tags (keys and values) that are associated with the bucket.
ObjectLevelStatistics unclassifiableObjectCount
The total number of objects that Amazon Macie can't analyze in the bucket. These objects don't use a supported storage class or don't have a file name extension for a supported file or storage format.
ObjectLevelStatistics unclassifiableObjectSizeInBytes
The total storage size, in bytes, of the objects that Amazon Macie can't analyze in the bucket. These objects don't use a supported storage class or don't have a file name extension for a supported file or storage format.
Boolean versioning
Specifies whether versioning is enabled for the bucket.
AccountLevelPermissions accountLevelPermissions
The account-level permissions settings that apply to the bucket.
BucketLevelPermissions bucketLevelPermissions
The bucket-level permissions settings for the bucket.
Boolean allowsPublicReadAccess
Specifies whether the bucket policy allows the general public to have read access to the bucket.
Boolean allowsPublicWriteAccess
Specifies whether the bucket policy allows the general public to have write access to the bucket.
String effectivePermission
Specifies whether the bucket is publicly accessible due to the combination of permissions settings that apply to the bucket. Possible values are:
NOT_PUBLIC - The bucket isn't publicly accessible.
PUBLIC - The bucket is publicly accessible.
UNKNOWN - Amazon Macie can't determine whether the bucket is publicly accessible.
BucketPermissionConfiguration permissionConfiguration
The account-level and bucket-level permissions settings for the bucket.
String kmsMasterKeyId
The Amazon Resource Name (ARN) or unique identifier (key ID) for the AWS Key Management Service (AWS KMS) customer master key (CMK) that's used by default to encrypt objects that are added to the bucket. This value is null if the bucket uses an Amazon S3 managed key to encrypt new objects or the bucket doesn't encrypt new objects by default.
String type
The type of server-side encryption that's used by default when storing new objects in the bucket. Possible values are:
AES256 - New objects are encrypted with an Amazon S3 managed key and use Amazon S3 managed encryption (SSE-S3).
aws:kms - New objects are encrypted with an AWS KMS CMK, specified by the kmsMasterKeyId property, and use AWS managed AWS KMS encryption (AWS-KMS) or customer managed AWS KMS encryption (SSE-KMS).
NONE - New objects aren't encrypted by default. Default encryption is disabled for the bucket.
String attributeName
The name of the bucket property to sort the results by. This value can be one of the following properties that Amazon Macie defines as bucket metadata: accountId, bucketName, classifiableObjectCount, classifiableSizeInBytes, objectCount, or sizeInBytes.
String orderBy
The sort order to apply to the results, based on the value specified by the attributeName property. Valid values are: ASC, sort the results in ascending order; and, DESC, sort the results in descending order.
String cellReference
The location of the cell, as an absolute cell reference, that contains the data. For example, Sheet2!C5 for cell C5 on Sheet2 in a Microsoft Excel workbook. This value is null for CSV and TSV files.
Long column
The column number of the column that contains the 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 columnName
The name of the column that contains the data, if available. This value is also null if Amazon Macie detects sensitive data in the name of any column in the file.
Long row
The row number of the row that contains the data.
String detailedResultsLocation
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 jobArn
The Amazon Resource Name (ARN) of the classification job that produced the finding.
String jobId
The unique identifier for the classification job that produced the finding.
ClassificationResult result
The status and other details for the finding.
S3Destination s3Destination
The S3 bucket to store data classification results in, and the encryption settings to use when storing results in that bucket.
Boolean additionalOccurrences
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 customDataIdentifiers
The custom data identifiers that detected the sensitive data and the number of occurrences of the data that they detected.
String mimeType
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.
List<E> sensitiveData
The category, types, and number of occurrences of the sensitive data that produced the finding.
Long sizeClassified
The total size, in bytes, of the data that the finding applies to.
ClassificationResultStatus status
The status of the finding.
String code
The status of the finding. Possible values are:
COMPLETE - Amazon Macie successfully completed its analysis of the object that the finding applies to.
PARTIAL - Macie analyzed only a subset of the data in the object that the finding applies to. For example, the object is an archive file that contains files in an unsupported format.
SKIPPED - Macie wasn't able to analyze the object that the finding applies to. For example, the object is a malformed file or a file that uses an unsupported format.
String reason
A brief description of the status of the finding. Amazon Macie uses this value to notify you of any errors, warnings, or considerations that might impact your analysis of the finding.
String clientToken
A unique, case-sensitive token that you provide to ensure the idempotency of the request.
List<E> customDataIdentifierIds
The custom data identifiers to use for data analysis and classification.
String description
A custom description of the job. The description can contain as many as 200 characters.
Boolean initialRun
Specifies whether to analyze all existing, eligible objects immediately after the job is created.
String jobType
The schedule for running the job. Valid values are:
ONE_TIME - Run the job only once. If you specify this value, don't specify a value for the scheduleFrequency property.
SCHEDULED - Run the job on a daily, weekly, or monthly basis. If you specify this value, use the scheduleFrequency property to define the recurrence pattern for the job.
String name
A custom name for the job. The name can contain as many as 500 characters.
S3JobDefinition s3JobDefinition
The S3 buckets that contain the objects to analyze, and the scope of that analysis.
Integer samplingPercentage
The sampling depth, as a percentage, 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.
JobScheduleFrequency scheduleFrequency
The recurrence pattern for running the job. To run the job only once, don't specify a value for this property and set the value for the jobType property to ONE_TIME.
Map<K,V> tags
A map of key-value pairs that specifies the tags to associate with the job.
A job can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.
String clientToken
A unique, case-sensitive token that you provide to ensure the idempotency of the request.
String description
A custom description of the custom data identifier. The description can contain as many as 512 characters.
We strongly recommend that you avoid including any sensitive data in the description of a custom data identifier. Other users of your account might be able to see the identifier's description, depending on the actions that they're allowed to perform in Amazon Macie.
List<E> ignoreWords
An array that lists specific character sequences (ignore words) to exclude from the results. If the text matched by the regular expression is the same as any string in this array, Amazon Macie ignores it. The array can contain as many as 10 ignore words. Each ignore word can contain 4 - 90 characters. Ignore words are case sensitive.
List<E> keywords
An array that lists specific character sequences (keywords), one of which must be within proximity (maximumMatchDistance) of the regular expression to match. The array can contain as many as 50 keywords. Each keyword can contain 3 - 90 characters. Keywords aren't case sensitive.
Integer maximumMatchDistance
The maximum number of characters that can exist between text that matches the regex pattern and the character sequences specified by the keywords array. Macie includes or excludes a result based on the proximity of a keyword to text that matches the regex pattern. The distance can be 1 - 300 characters. The default value is 50.
String name
A custom name for the custom data identifier. The name can contain as many as 128 characters.
We strongly recommend that you avoid including any sensitive data in the name of a custom data identifier. Other users of your account might be able to see the identifier's name, depending on the actions that they're allowed to perform in Amazon Macie.
String regex
The regular expression (regex) that defines the pattern to match. The expression can contain as many as 512 characters.
Map<K,V> tags
A map of key-value pairs that specifies the tags to associate with the custom data identifier.
A custom data identifier can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.
String customDataIdentifierId
The unique identifier for the custom data identifier that was created.
String action
The action to perform on findings that meet the filter criteria (findingCriteria). Valid values are: ARCHIVE, suppress (automatically archive) the findings; and, NOOP, don't perform any action on the findings.
String clientToken
A unique, case-sensitive token that you provide to ensure the idempotency of the request.
String description
A custom description of the filter. The description can contain as many as 512 characters.
We strongly recommend that you avoid including any sensitive data in the description of a filter. Other users of your account might be able to see the filter's description, depending on the actions that they're allowed to perform in Amazon Macie.
FindingCriteria findingCriteria
The criteria to use to filter findings.
String name
A custom name for the filter. The name must contain at least 3 characters and can contain as many as 64 characters.
We strongly recommend that you avoid including any sensitive data in the name of a filter. Other users of your account might be able to see the filter's name, depending on the actions that they're allowed to perform in Amazon Macie.
Integer position
The position of the filter in the list of saved filters on the Amazon Macie console. This value also determines the order in which the filter is applied to findings, relative to other filters that are also applied to the findings.
Map<K,V> tags
A map of key-value pairs that specifies the tags to associate with the filter.
A findings filter can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.
List<E> accountIds
An array that lists AWS account IDs, one for each account to send the invitation to.
Boolean disableEmailNotification
Specifies whether to send an email notification to the root user of each account that the invitation will be sent to. This notification is in addition to an alert that the root user receives in AWS Personal Health Dashboard. To send an email notification to the root user of each account, set this value to true.
String message
A custom message to include in the invitation. Amazon Macie adds this message to the standard content that it sends for an invitation.
AccountDetail account
The details for the account to associate with the administrator account.
Map<K,V> tags
A map of key-value pairs that specifies the tags to associate with the account in Amazon Macie.
An account can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.
String arn
The Amazon Resource Name (ARN) of the account that was associated with the administrator account.
List<E> eq
The value for the property matches (equals) the specified value. If you specify multiple values, Macie uses OR logic to join the values.
List<E> eqExactMatch
The value for the property exclusively matches (equals an exact match for) all the specified values. If you specify multiple values, Amazon Macie uses AND logic to join the values.
You can use this operator with the following properties: customDataIdentifiers.detections.arn, customDataIdentifiers.detections.name, resourcesAffected.s3Bucket.tags.key, resourcesAffected.s3Bucket.tags.value, resourcesAffected.s3Object.tags.key, resourcesAffected.s3Object.tags.value, sensitiveData.category, and sensitiveData.detections.type.
Long gt
The value for the property is greater than the specified value.
Long gte
The value for the property is greater than or equal to the specified value.
Long lt
The value for the property is less than the specified value.
Long lte
The value for the property is less than or equal to the specified value.
List<E> neq
The value for the property doesn't match (doesn't equal) the specified value. If you specify multiple values, Macie uses OR logic to join the values.
List<E> detections
The custom data identifiers that detected the data, and the number of occurrences of the data that each identifier detected.
Long totalCount
The total number of occurrences of the data that was detected by the custom data identifiers and produced the finding.
String arn
The Amazon Resource Name (ARN) of the custom data identifier.
Date createdAt
The date and time, in UTC and extended ISO 8601 format, when the custom data identifier was created.
String description
The custom description of the custom data identifier.
String id
The unique identifier for the custom data identifier.
String name
The custom name of the custom data identifier.
String arn
The Amazon Resource Name (ARN) of the custom data identifier.
Long count
The total number of occurrences of the sensitive data that the custom data identifier detected.
String name
The name of the custom data identifier.
Occurrences 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.
Long count
The total number of occurrences of the type of sensitive data that was detected.
Occurrences 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 type
The type of sensitive data that was detected. For example, AWS_CREDENTIALS, PHONE_NUMBER, or ADDRESS.
String id
The unique identifier for the Amazon Macie resource or account that the request applies to.
String id
The unique identifier for the Amazon Macie resource or account that the request applies to.
String id
The unique identifier for the Amazon Macie resource or account that the request applies to.
Map<K,V> criteria
The criteria to use to filter the query results.
Integer maxResults
The maximum number of items to include in each page of the response. The default value is 50.
String nextToken
The nextToken string that specifies which page of results to return in a paginated response.
BucketSortCriteria sortCriteria
The criteria to use to sort the query results.
List<E> buckets
An array of objects, one for each bucket that meets the filter criteria specified in the request.
String nextToken
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.
String jobId
The unique identifier for the classification job.
String clientToken
The token that was provided to ensure the idempotency of the request to create the job.
Date createdAt
The date and time, in UTC and extended ISO 8601 format, when the job was created.
List<E> customDataIdentifierIds
The custom data identifiers that the job uses to analyze data.
String description
The custom description of the job.
Boolean initialRun
Specifies whether the job is configured to analyze all existing, eligible objects immediately after it's created.
String jobArn
The Amazon Resource Name (ARN) of the job.
String jobId
The unique identifier for the job.
String jobStatus
The current status of the job. Possible values are:
CANCELLED - You cancelled the job or, if it's a one-time job, you paused the job and didn't resume it within 30 days.
COMPLETE - For a one-time job, Amazon Macie finished processing the data specified for the job. This value doesn't apply to recurring jobs.
IDLE - For a recurring job, the previous scheduled run is complete and the next scheduled run is pending. This value doesn't apply to one-time jobs.
PAUSED - Amazon Macie started running the job but additional processing would exceed the monthly sensitive data discovery quota for your account or one or more member accounts that the job analyzes data for.
RUNNING - For a one-time job, the job is in progress. For a recurring job, a scheduled run is in progress.
USER_PAUSED - You paused the job. If you paused the job while it had a status of RUNNING and you don't resume it within 30 days of pausing it, the job or job run will expire and be cancelled, depending on the job's type. To check the expiration date, refer to the UserPausedDetails.jobExpiresAt property.
String jobType
The schedule for running the job. Possible values are:
ONE_TIME - The job runs only once.
SCHEDULED - The job runs on a daily, weekly, or monthly basis. The scheduleFrequency property indicates the recurrence pattern for the job.
LastRunErrorStatus lastRunErrorStatus
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.
Date lastRunTime
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.
String name
The custom name of the job.
S3JobDefinition s3JobDefinition
The S3 buckets that the job is configured to analyze, and the scope of that analysis.
Integer samplingPercentage
The sampling depth, as a percentage, that determines the percentage of eligible objects that the job analyzes.
JobScheduleFrequency scheduleFrequency
The recurrence pattern for running the job. If the job is configured to run only once, this value is null.
Statistics statistics
The number of times that the job has run and processing statistics for the job's current run.
Map<K,V> tags
A map of key-value pairs that specifies which tags (keys and values) are associated with the classification job.
UserPausedDetails userPausedDetails
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.
String adminAccountId
The AWS account ID of the delegated Amazon Macie administrator account.
String id
The unique identifier for the Amazon Macie resource or account that the request applies to.
String domainName
The name of the domain.
String clientToken
A unique, case-sensitive token that you provide to ensure the idempotency of the request.
String findingPublishingFrequency
String status
Specifies the new status for the account. To enable Amazon Macie and start all Macie activities for the account, set this value to ENABLED.
String accessKeyId
The AWS access key ID that identifies the credentials.
String accountId
The unique identifier for the AWS account that owns the entity that was used to get the credentials.
String arn
The Amazon Resource Name (ARN) of the entity that was used to get the credentials.
String principalId
The unique identifier for the entity that was used to get the credentials.
SessionContext sessionContext
The details of the session that was created for the credentials, including the entity that issued the session.
String accountId
The unique identifier for the AWS account that the finding applies to. This is typically the account that owns the affected resource.
Boolean archived
Specifies whether the finding is archived.
String category
The category of the finding. Possible values are: CLASSIFICATION, for a sensitive data finding; and, POLICY, for a policy finding.
ClassificationDetails classificationDetails
The details of a sensitive data finding. This value is null for a policy finding.
Long count
The total number of occurrences of the finding. For sensitive data findings, this value is always 1. All sensitive data findings are considered new (unique) because they derive from individual classification jobs.
Date createdAt
The date and time, in UTC and extended ISO 8601 format, when the finding was created.
String description
The description of the finding.
String id
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 partition
The AWS partition that Amazon Macie created the finding in.
PolicyDetails policyDetails
The details of a policy finding. This value is null for a sensitive data finding.
String region
The AWS Region that Amazon Macie created the finding in.
ResourcesAffected resourcesAffected
The resources that the finding applies to.
Boolean sample
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 schemaVersion
The version of the schema that was used to define the data structures in the finding.
Severity severity
The severity level and score for the finding.
String title
The brief description of the finding.
String type
The type of the finding.
Date updatedAt
The date and time, in UTC and extended ISO 8601 format, when the finding was last updated. For sensitive data findings, this value is the same as the value for the createdAt property. All sensitive data findings are considered new (unique) because they derive from individual classification jobs.
String actionType
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 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 domainDetails
The domain name of the device that the entity used to perform the action on the affected resource.
IpAddressDetails ipAddressDetails
The IP address of the device that the entity used to perform the action on the affected resource. This object also provides information such as the owner and geographic location for the IP address.
UserIdentity userIdentity
The type and other characteristics of the entity that performed the action on the affected resource.
String action
The action that's performed on findings that meet the filter criteria. Possible values are: ARCHIVE, suppress (automatically archive) the findings; and, NOOP, don't perform any action on the findings.
String arn
The Amazon Resource Name (ARN) of the filter.
String id
The unique identifier for the filter.
String name
The custom name of the filter.
Map<K,V> tags
A map of key-value pairs that identifies the tags (keys and values) that are associated with the filter.
String attributeName
The grouping to sort the results by. Valid values are: count, sort the results by the number of findings in each group of results; and, groupKey, sort the results by the name of each group of results.
String orderBy
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.
Invitation administrator
The AWS account ID for the administrator account. If the accounts are associated by a Macie membership invitation, this object also provides details about the invitation that was sent to establish the relationship between the accounts.
String accountId
The unique identifier for the AWS account.
Long bucketCount
The total number of buckets.
BucketCountByEffectivePermission bucketCountByEffectivePermission
The total number of buckets that are publicly accessible based on a combination of permissions settings for each bucket.
BucketCountByEncryptionType bucketCountByEncryptionType
The total number of buckets that use certain types of server-side encryption to encrypt new objects by default. This object also reports the total number of buckets that don't encrypt new objects by default.
BucketCountPolicyAllowsUnencryptedObjectUploads bucketCountByObjectEncryptionRequirement
The total number of buckets whose bucket policies do and don't require server-side encryption of objects when objects are uploaded to the buckets.
BucketCountBySharedAccessType bucketCountBySharedAccessType
The total number of buckets that are and aren't shared with another AWS account.
Long classifiableObjectCount
The total number of objects that Amazon Macie can analyze in the buckets. These objects use a supported storage class and have a file name extension for a supported file or storage format.
Long classifiableSizeInBytes
The total storage size, in bytes, of all the objects that Amazon Macie can analyze in the buckets. These objects use a supported storage class and have a file name extension for a supported file or storage format.
If versioning is enabled for any of the buckets, Macie calculates this value based on the size of the latest version of each applicable object in those buckets. This value doesn't reflect the storage size of all versions of all applicable objects in the buckets.
Date lastUpdated
The date and time, in UTC and extended ISO 8601 format, when Amazon Macie most recently retrieved both bucket and object metadata from Amazon S3 for the buckets.
Long objectCount
The total number of objects in the buckets.
Long sizeInBytes
The total storage size, in bytes, of the buckets.
If versioning is enabled for any of the buckets, Macie calculates this value based on the size of the latest version of each object in those buckets. This value doesn't reflect the storage size of all versions of the objects in the buckets.
Long sizeInBytesCompressed
The total compressed storage size, in bytes, of the buckets.
If versioning is enabled for any of the buckets, Macie calculates this value based on the size of the latest version of each object in those buckets. This value doesn't reflect the storage size of all versions of the objects in the buckets.
ObjectLevelStatistics unclassifiableObjectCount
The total number of objects that Amazon Macie can't analyze in the buckets. These objects don't use a supported storage class or don't have a file name extension for a supported file or storage format.
ObjectLevelStatistics unclassifiableObjectSizeInBytes
The total storage size, in bytes, of the objects that Amazon Macie can't analyze in the buckets. These objects don't use a supported storage class or don't have a file name extension for a supported file or storage format.
ClassificationExportConfiguration configuration
The location where data classification results are stored, and the encryption settings that are used when storing results in that location.
String id
The unique identifier for the Amazon Macie resource or account that the request applies to.
String arn
The Amazon Resource Name (ARN) of the custom data identifier.
Date createdAt
The date and time, in UTC and extended ISO 8601 format, when the custom data identifier was created.
Boolean deleted
Specifies whether the custom data identifier was deleted. If you delete a custom data identifier, Amazon Macie doesn't delete it permanently. Instead, it soft deletes the identifier.
String description
The custom description of the custom data identifier.
String id
The unique identifier for the custom data identifier.
List<E> ignoreWords
An array that lists specific character sequences (ignore words) to exclude from the results. If the text matched by the regular expression is the same as any string in this array, Amazon Macie ignores it. Ignore words are case sensitive.
List<E> keywords
An array that lists specific character sequences (keywords), one of which must be within proximity (maximumMatchDistance) of the regular expression to match. Keywords aren't case sensitive.
Integer maximumMatchDistance
The maximum number of characters that can exist between text that matches the regex pattern and the character sequences specified by the keywords array. Macie includes or excludes a result based on the proximity of a keyword to text that matches the regex pattern.
String name
The custom name of the custom data identifier.
String regex
The regular expression (regex) that defines the pattern to match.
Map<K,V> tags
A map of key-value pairs that identifies the tags (keys and values) that are associated with the custom data identifier.
String id
The unique identifier for the Amazon Macie resource or account that the request applies to.
String action
The action that's performed on findings that meet the filter criteria (findingCriteria). Possible values are: ARCHIVE, suppress (automatically archive) the findings; and, NOOP, don't perform any action on the findings.
String arn
The Amazon Resource Name (ARN) of the filter.
String description
The custom description of the filter.
FindingCriteria findingCriteria
The criteria that's used to filter findings.
String id
The unique identifier for the filter.
String name
The custom name of the filter.
Integer position
The position of the filter in the list of saved filters on the Amazon Macie console. This value also determines the order in which the filter is applied to findings, relative to other filters that are also applied to the findings.
Map<K,V> tags
A map of key-value pairs that identifies the tags (keys and values) that are associated with the filter.
SecurityHubConfiguration securityHubConfiguration
The configuration settings that determine which findings are published to AWS Security Hub.
List<E> findingIds
An array of strings that lists the unique identifiers for the findings to retrieve.
SortCriteria sortCriteria
The criteria for sorting the results of the request.
FindingCriteria findingCriteria
The criteria to use to filter the query results.
String groupBy
The finding property to use to group the query results. Valid values are:
classificationDetails.jobId - The unique identifier for the classification job that produced the finding.
resourcesAffected.s3Bucket.name - The name of the S3 bucket that the finding applies to.
severity.description - The severity level of the finding, such as High or Medium.
type - The type of finding, such as Policy:IAMUser/S3BucketPublic and SensitiveData:S3Object/Personal.
Integer size
The maximum number of items to include in each page of the response.
FindingStatisticsSortCriteria sortCriteria
The criteria to use to sort the query results.
Long invitationsCount
The total number of invitations that were received by the account, not including the currently accepted invitation.
Date createdAt
The date and time, in UTC and extended ISO 8601 format, when the Amazon Macie account was created.
String findingPublishingFrequency
The frequency with which Macie publishes updates to policy findings for the account. This includes publishing updates to AWS Security Hub and Amazon EventBridge (formerly called Amazon CloudWatch Events).
String serviceRole
The Amazon Resource Name (ARN) of the service-linked role that allows Macie to monitor and analyze data in AWS resources for the account.
String status
The current status of the Macie account. Possible values are: PAUSED, the account is enabled but all Macie activities are suspended (paused) for the account; and, ENABLED, the account is enabled and all Macie activities are enabled for the account.
Date updatedAt
The date and time, in UTC and extended ISO 8601 format, of the most recent change to the status of the Macie account.
Invitation master
(Deprecated) The AWS account ID for the administrator account. If the accounts are associated by a Macie membership invitation, this object also provides details about the invitation that was sent to establish the relationship between the accounts.
String id
The unique identifier for the Amazon Macie resource or account that the request applies to.
String accountId
The AWS account ID for the account.
String administratorAccountId
The AWS account ID for the administrator account.
String arn
The Amazon Resource Name (ARN) of the account.
String email
The email address for the account.
Date invitedAt
The date and time, in UTC and extended ISO 8601 format, when an Amazon Macie membership invitation was last sent to the account. This value is null if a Macie invitation hasn't been sent to the account.
String masterAccountId
(Deprecated) The AWS account ID for the administrator account. This property has been replaced by the administratorAccountId property and is retained only for backward compatibility.
String relationshipStatus
The current status of the relationship between the account and the administrator account.
Map<K,V> tags
A map of key-value pairs that identifies the tags (keys and values) that are associated with the member account in Amazon Macie.
Date updatedAt
The date and time, in UTC and extended ISO 8601 format, of the most recent change to the status of the relationship between the account and the administrator account.
List<E> filterBy
An array of objects, one for each condition to use to filter the query results. If you specify more than one condition, Amazon Macie uses an AND operator to join the conditions.
Integer maxResults
The maximum number of items to include in each page of the response.
String nextToken
The nextToken string that specifies which page of results to return in a paginated response.
UsageStatisticsSortBy sortBy
The criteria to use to sort the query results.
String timeRange
The inclusive time period to query usage data for. Valid values are: MONTH_TO_DATE, for the current calendar month to date; and, PAST_30_DAYS, for the preceding 30 days. If you don't specify a value, Amazon Macie provides usage data for the preceding 30 days.
String nextToken
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.
List<E> records
An array of objects that contains the results of the query. Each object contains the data for an account that meets the filter criteria specified in the request.
String timeRange
The inclusive time period that the usage data applies to. Possible values are: MONTH_TO_DATE, for the current calendar month to date; and, PAST_30_DAYS, for the preceding 30 days.
String timeRange
The inclusive time period to retrieve the data for. Valid values are: MONTH_TO_DATE, for the current calendar month to date; and, PAST_30_DAYS, for the preceding 30 days. If you don't specify a value for this parameter, Amazon Macie provides aggregated usage data for the preceding 30 days.
String timeRange
The inclusive time period that the usage data applies to. Possible values are: MONTH_TO_DATE, for the current calendar month to date; and, PAST_30_DAYS, for the preceding 30 days.
List<E> usageTotals
An array of objects that contains the results of the query. Each object contains the data for a specific usage metric.
String accountId
The unique identifier for the AWS account that's associated with the IAM user who performed the action.
String arn
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 principalId
The unique identifier for the IAM user who performed the action.
String userName
The user name of the IAM user who performed the action.
String accountId
The AWS account ID for the account that sent the invitation.
String invitationId
The unique identifier for the invitation. Amazon Macie uses this identifier to validate the inviter account with the invitee account.
Date invitedAt
The date and time, in UTC and extended ISO 8601 format, when the invitation was sent.
String relationshipStatus
The status of the relationship between the account that sent the invitation (inviter account) and the account that received the invitation (invitee account).
String ipAddressV4
The Internet Protocol version 4 (IPv4) address of the device.
IpCity ipCity
The city that the IP address originated from.
IpCountry ipCountry
The country that the IP address originated from.
IpGeoLocation ipGeoLocation
The geographic coordinates of the location that the IP address originated from.
IpOwner ipOwner
The registered owner of the IP address.
String name
The name of the city.
String asn
The autonomous system number (ASN) for the autonomous system that included the IP address.
String asnOrg
The organization identifier that's associated with the autonomous system number (ASN) for the autonomous system that included the IP address.
String isp
The name of the internet service provider (ISP) that owned the IP address.
String org
The name of the organization that owned the IP address.
String isDefinedInJob
Specifies whether any one-time or recurring jobs are configured to analyze data in the bucket. Possible values are:
TRUE - One or more jobs is configured to analyze data in the bucket, and at least one of those jobs has a status other than CANCELLED.
FALSE - No jobs are configured to analyze data in the bucket, or all the jobs that are configured to analyze data in the bucket have a status of CANCELLED.
UNKNOWN - An exception occurred when Amazon Macie attempted to retrieve job data for the bucket.
String isMonitoredByJob
Specifies whether any recurring jobs are configured to analyze data in the bucket. Possible values are:
TRUE - One or more recurring jobs is configured to analyze data in the bucket, and at least one of those jobs has a status other than CANCELLED.
FALSE - No recurring jobs are configured to analyze data in the bucket, or all the recurring jobs that are configured to analyze data in the bucket have a status of CANCELLED.
UNKNOWN - An exception occurred when Amazon Macie attempted to retrieve job data for the bucket.
String lastJobId
The unique identifier for the job that ran most recently (either the latest run of a recurring job or the only run of a one-time job) and is configured to analyze data in the bucket.
This value is null if the value for the isDefinedInJob property is FALSE or UNKNOWN.
Date lastJobRunTime
The date and time, in UTC and extended ISO 8601 format, when the job (lastJobId) started. If the job is a recurring job, this value indicates when the most recent run started.
This value is null if the value for the isDefinedInJob property is FALSE or UNKNOWN.
DailySchedule dailySchedule
Specifies a daily recurrence pattern for running the job.
MonthlySchedule monthlySchedule
Specifies a monthly recurrence pattern for running the job.
WeeklySchedule weeklySchedule
Specifies a weekly recurrence pattern for running the job.
SimpleScopeTerm simpleScopeTerm
A property-based condition that defines a property, operator, and one or more values for including or excluding an object from the job.
TagScopeTerm tagScopeTerm
A tag-based condition that defines the operator and tag keys or tag key and value pairs for including or excluding an object from the job.
List<E> bucketDefinitions
The S3 buckets that the job is configured to analyze.
Date createdAt
The date and time, in UTC and extended ISO 8601 format, when the job was created.
String jobId
The unique identifier for the job.
String jobStatus
The current status of the job. Possible values are:
CANCELLED - You cancelled the job or, if it's a one-time job, you paused the job and didn't resume it within 30 days.
COMPLETE - For a one-time job, Amazon Macie finished processing the data specified for the job. This value doesn't apply to recurring jobs.
IDLE - For a recurring job, the previous scheduled run is complete and the next scheduled run is pending. This value doesn't apply to one-time jobs.
PAUSED - Amazon Macie started running the job but additional processing would exceed the monthly sensitive data discovery quota for your account or one or more member accounts that the job analyzes data for.
RUNNING - For a one-time job, the job is in progress. For a recurring job, a scheduled run is in progress.
USER_PAUSED - You paused the job. If you paused the job while it had a status of RUNNING and you don't resume it within 30 days of pausing it, the job or job run will expire and be cancelled, depending on the job's type. To check the expiration date, refer to the UserPausedDetails.jobExpiresAt property.
String jobType
The schedule for running the job. Possible values are:
ONE_TIME - The job runs only once.
SCHEDULED - The job runs on a daily, weekly, or monthly basis.
LastRunErrorStatus lastRunErrorStatus
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.
String name
The custom name of the job.
UserPausedDetails userPausedDetails
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.
String key
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 value
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.
String code
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:
ERROR - One or more errors occurred. Amazon Macie didn't process all the data specified for the job.
NONE - No errors occurred. Macie processed all the data specified for the job.
ListJobsFilterCriteria filterCriteria
The criteria to use to filter the results.
Integer maxResults
The maximum number of items to include in each page of the response.
String nextToken
The nextToken string that specifies which page of results to return in a paginated response.
ListJobsSortCriteria sortCriteria
The criteria to use to sort the results.
List<E> findingsFilterListItems
An array of objects, one for each filter that's associated with the account.
String nextToken
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.
FindingCriteria findingCriteria
The criteria to use to filter the results.
Integer maxResults
The maximum number of items to include in each page of the response.
String nextToken
The nextToken string that specifies which page of results to return in a paginated response.
SortCriteria sortCriteria
The criteria to use to sort the results.
List<E> findingIds
An array of strings, where each string is the unique identifier for a finding that meets the filter criteria specified in the request.
String nextToken
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.
String attributeName
The property to sort the results by.
String orderBy
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.
Integer maxResults
The maximum number of items to include in each page of a paginated response.
String nextToken
The nextToken string that specifies which page of results to return in a paginated response.
String onlyAssociated
Specifies which accounts to include in the response, based on the status of an account's relationship with the administrator account. By default, the response includes only current member accounts. To include all accounts, set this value to false.
List<E> members
An array of objects, one for each account that's associated with the administrator account and meets the criteria specified by the onlyAssociated request parameter.
String nextToken
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.
List<E> adminAccounts
An array of objects, one for each delegated Amazon Macie administrator account for the organization. Only one of these accounts can have a status of ENABLED.
String nextToken
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.
String resourceArn
The Amazon Resource Name (ARN) of the classification job, custom data identifier, findings filter, or member account.
String accountId
The AWS account ID for the account.
String administratorAccountId
The AWS account ID for the administrator account.
String arn
The Amazon Resource Name (ARN) of the account.
String email
The email address for the account.
Date invitedAt
The date and time, in UTC and extended ISO 8601 format, when an Amazon Macie membership invitation was last sent to the account. This value is null if a Macie invitation hasn't been sent to the account.
String masterAccountId
(Deprecated) The AWS account ID for the administrator account. This property has been replaced by the administratorAccountId property and is retained only for backward compatibility.
String relationshipStatus
The current status of the relationship between the account and the administrator account.
Map<K,V> tags
A map of key-value pairs that identifies the tags (keys and values) that are associated with the account in Amazon Macie.
Date updatedAt
The date and time, in UTC and extended ISO 8601 format, of the most recent change to the status of the relationship between the account and the administrator account.
Integer dayOfMonth
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.
Long customerManaged
The total number of objects that are encrypted using a customer-managed key. The objects use customer-provided server-side encryption (SSE-C).
Long kmsManaged
The total number of objects that are encrypted using an AWS Key Management Service (AWS KMS) customer master key (CMK). The objects use AWS managed AWS KMS encryption (AWS-KMS) or customer managed AWS KMS encryption (SSE-KMS).
Long s3Managed
The total number of objects that are encrypted using an Amazon S3 managed key. The objects use Amazon S3 managed encryption (SSE-S3).
Long unencrypted
The total number of objects that aren't encrypted or use client-side encryption.
Long unknown
The total number of objects that Amazon Macie doesn't have current encryption metadata for. Macie can't provide current data about the encryption settings for these objects.
Long fileType
The total storage size (in bytes) or number of objects that Amazon Macie can't analyze because the objects don't have a file name extension for a supported file or storage format.
Long storageClass
The total storage size (in bytes) or number of objects that Amazon Macie can't analyze because the objects use an unsupported storage class.
Long total
The total storage size (in bytes) or number of objects that Amazon Macie can't analyze because the objects use an unsupported storage class or don't have a file name extension for a supported file or storage format.
List<E> cells
An array of objects, one for each occurrence of sensitive data in a Microsoft Excel workbook, CSV file, or TSV file. Each object specifies the cell or field that contains the data. This value is null for all other types of files.
List<E> lineRanges
An array of objects, one for each occurrence of sensitive data in a Microsoft Word document or non-binary text file, such as an HTML, JSON, TXT, or XML file. Each object specifies the line that contains the data, and the position of the data on that line.
This value is often null for file types that are supported by Cell, Page, or Record objects. Exceptions are the locations of 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.
List<E> offsetRanges
An array of objects, one for each occurrence of sensitive data in a binary text file. Each object specifies the position of the data relative to the beginning of the file.
This value is typically null. For binary text files, Amazon Macie adds location data to a lineRanges.Range or Page object, depending on the file type.
List<E> pages
An array of objects, one for each occurrence of sensitive data in an Adobe Portable Document Format file. Each object specifies the page that contains the data, and the position of the data on that page. This value is null for all other types of files.
List<E> records
An array of objects, one for each occurrence of sensitive data in an Apache Avro object container or Apache Parquet file. Each object specifies the record index and the path to the field in the record that contains the data. This value is null for all other types of files.
FindingAction action
The action that produced the finding.
FindingActor actor
The entity that performed the action that produced the finding.
ClassificationExportConfiguration configuration
The location to store data classification results in, and the encryption settings to use when storing results in that location.
ClassificationExportConfiguration configuration
The location where the data classification results are stored, and the encryption settings that are used when storing results in that location.
String clientToken
A unique, case-sensitive token that you provide to ensure the idempotency of the request.
SecurityHubConfiguration securityHubConfiguration
The configuration settings that determine which findings to publish to AWS Security Hub.
Long end
Possible values are:
In an Occurrences.lineRanges array, the number of lines from the beginning of the file to the end of the sensitive data.
In an Occurrences.offsetRanges array, the number of characters from the beginning of the file to the end of the sensitive data.
In a Page object, the number of lines (lineRange) or characters (offsetRange) from the beginning of the page to the end of the sensitive data.
Long start
Possible values are:
In an Occurrences.lineRanges array, the number of lines from the beginning of the file to the beginning of the sensitive data.
In an Occurrences.offsetRanges array, the number of characters from the beginning of the file to the beginning of the sensitive data.
In a Page object, the number of lines (lineRange) or characters (offsetRange) from the beginning of the page to the beginning of the sensitive data.
Long startColumn
The column number for the column that contains the data, if the file contains structured data.
String jsonPath
The path, as a JSONPath expression, to the field in the record that 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 20 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.
Long recordIndex
The record index, starting from 0, for the record that contains the data.
Boolean replicated
Specifies whether the bucket is configured to replicate one or more objects to any destination.
Boolean replicatedExternally
Specifies whether the bucket is configured to replicate one or more objects to an AWS account that isn't part of the same Amazon Macie organization.
List<E> replicationAccounts
An array of AWS account IDs, one for each AWS account that the bucket is configured to replicate one or more objects to.
S3Bucket s3Bucket
An array of objects, one for each S3 bucket that the finding applies to. Each object provides a set of metadata about an affected S3 bucket.
S3Object s3Object
An array of objects, one for each S3 object that the finding applies to. Each object provides a set of metadata about an affected S3 object.
String allowsUnencryptedObjectUploads
Specifies whether the bucket policy for the bucket requires server-side encryption of objects when objects are uploaded to the bucket. Possible values are:
FALSE - The bucket policy requires server-side encryption of new objects. PutObject requests must include the x-amz-server-side-encryption header and the value for that header must be AES256 or aws:kms.
TRUE - The bucket doesn't have a bucket policy or it has a bucket policy that doesn't require server-side encryption of new objects. If a bucket policy exists, it doesn't require PutObject requests to include the x-amz-server-side-encryption header and it doesn't require the value for that header to be AES256 or aws:kms.
UNKNOWN - Amazon Macie can't determine whether the bucket policy requires server-side encryption of objects.
String arn
The Amazon Resource Name (ARN) of the bucket.
Date createdAt
The date and time, in UTC and extended ISO 8601 format, when the bucket was created.
ServerSideEncryption defaultServerSideEncryption
The type of server-side encryption that's used by default to encrypt objects in the bucket.
String name
The name of the bucket.
S3BucketOwner owner
The display name and AWS account ID for the user who owns the bucket.
BucketPublicAccess publicAccess
The permissions settings that determine whether the bucket is publicly accessible.
List<E> tags
The tags that are associated with the bucket.
String bucketName
The name of the bucket.
String keyPrefix
The path prefix to use in the path to the location in the bucket. This prefix specifies where to store classification results in the bucket.
String kmsKeyArn
The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for encryption of the results. This must be the ARN of an existing CMK that's in the same AWS Region as the bucket.
List<E> bucketDefinitions
An array of objects, one for each AWS account that owns buckets to analyze. Each object specifies the account ID for an account and one or more buckets to analyze for the account.
Scoping scoping
The property- and tag-based conditions that determine which objects to include or exclude from the analysis.
String bucketArn
The Amazon Resource Name (ARN) of the bucket that contains the object.
String eTag
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 extension
The file name extension of the object. If the object doesn't have a file name extension, this value is "".
String key
The full key (name) that's assigned to the object.
Date lastModified
The date and time, in UTC and extended ISO 8601 format, when the object was last modified.
String path
The path to the object, including the full key (name).
Boolean publicAccess
Specifies whether the object is publicly accessible due to the combination of permissions settings that apply to the object.
ServerSideEncryption serverSideEncryption
The type of server-side encryption that's used to encrypt the object.
Long size
The total storage size, in bytes, of the object.
String storageClass
The storage class of the object.
List<E> tags
The tags that are associated with the object.
String versionId
The identifier for the affected version of the object.
JobScopingBlock excludes
The property- or tag-based conditions that determine which objects to exclude from the analysis.
JobScopingBlock includes
The property- or tag-based conditions that determine which objects to include in the analysis.
Boolean publishClassificationFindings
Specifies whether to publish sensitive data findings to AWS Security Hub. If you set this value to true, Amazon Macie automatically publishes all sensitive data findings that weren't suppressed by a findings filter. The default value is false.
Boolean publishPolicyFindings
Specifies whether to publish policy findings to AWS Security Hub. If you set this value to true, Amazon Macie automatically publishes all new and updated policy findings that weren't suppressed by a findings filter. The default value is true.
String category
The category of sensitive data that was detected. For example: CREDENTIALS, for credentials data such as private keys or AWS secret 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 driver's license identification numbers.
List<E> detections
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.
Long totalCount
The total number of occurrences of the sensitive data that was detected.
String encryptionType
The server-side encryption algorithm that's used when storing data in the bucket or object. If default encryption is disabled for the bucket or the object isn't encrypted using server-side encryption, this value is NONE.
String kmsMasterKeyId
The Amazon Resource Name (ARN) or unique identifier (key ID) for the AWS Key Management Service (AWS KMS) customer master key (CMK) that's used to encrypt data in the bucket or the object. If an AWS KMS CMK isn't used, this value is null.
Boolean isServiceLimited
Specifies whether the account has met the quota that corresponds to the metric specified by the UsageByAccount.type field in the response.
String unit
The unit of measurement for the value specified by the value field.
Long value
The value for the metric specified by the UsageByAccount.type field in the response.
SessionContextAttributes attributes
The date and time when the credentials were issued, and whether the credentials were authenticated with a multi-factor authentication (MFA) device.
SessionIssuer sessionIssuer
The source and type of credentials that were issued to the entity.
String accountId
The unique identifier for the AWS account that owns the entity that was used to get the credentials.
String arn
The Amazon Resource Name (ARN) of the source account, IAM user, or role that was used to get the credentials.
String principalId
The unique identifier for the entity that was used to get the credentials.
String type
The source of the temporary security credentials, such as Root, IAMUser, or Role.
String userName
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.
String comparator
The operator to use in the condition. Valid operators for each supported property (key) are:
OBJECT_EXTENSION - EQ (equals) or NE (not equals)
OBJECT_KEY - STARTS_WITH
OBJECT_LAST_MODIFIED_DATE - Any operator except CONTAINS
OBJECT_SIZE - Any operator except CONTAINS
TAG - EQ (equals) or NE (not equals)
String key
The object property to use in the condition.
List<E> values
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 an OR operator to join the values. Otherwise, this array can specify only one value.
Valid values for each supported property (key) are:
OBJECT_EXTENSION - A string that represents the file name extension of an object. For example: docx or pdf
OBJECT_KEY - A string that represents the key prefix (folder name or path) of an object. For example: logs or awslogs/eventlogs. This value applies a condition to objects whose keys (names) begin with the specified value.
OBJECT_LAST_MODIFIED_DATE - The date and time (in UTC and extended ISO 8601 format) when an object was created or last changed, whichever is latest. For example: 2020-09-28T14:31:13Z
OBJECT_SIZE - An integer that represents the storage size (in bytes) of an object.
TAG - A string that represents a tag key for an object. For advanced options, use a TagScopeTerm object, instead of a SimpleScopeTerm object, to define a tag-based condition for the job.
Macie doesn't support use of wildcard characters in values. Also, string values are case sensitive.
String attributeName
The name of the property to sort the results by. This value can be the name of any property that Amazon Macie defines for a finding.
String orderBy
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 resourceArn
The Amazon Resource Name (ARN) of the classification job, custom data identifier, findings filter, or member account.
Map<K,V> tags
A map of key-value pairs that specifies the tags to associate with the resource.
A resource can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.
String comparator
The operator to use in the condition. Valid operators are EQ (equals) or NE (not equals).
String key
The tag key to use in the condition.
List<E> tagValues
The tag keys or tag key and value pairs to use in the condition.
String target
The type of object to apply the condition to.
List<E> ignoreWords
An array that lists specific character sequences (ignore words) to exclude from the results. If the text matched by the regular expression is the same as any string in this array, Amazon Macie ignores it. The array can contain as many as 10 ignore words. Each ignore word can contain 4 - 90 characters. Ignore words are case sensitive.
List<E> keywords
An array that lists specific character sequences (keywords), one of which must be within proximity (maximumMatchDistance) of the regular expression to match. The array can contain as many as 50 keywords. Each keyword can contain 3 - 90 characters. Keywords aren't case sensitive.
Integer maximumMatchDistance
The maximum number of characters that can exist between text that matches the regex pattern and the character sequences specified by the keywords array. Macie includes or excludes a result based on the proximity of a keyword to text that matches the regex pattern. The distance can be 1 - 300 characters. The default value is 50.
String regex
The regular expression (regex) that defines the pattern to match. The expression can contain as many as 512 characters.
String sampleText
The sample text to inspect by using the custom data identifier. The text can contain as many as 1,000 characters.
Integer matchCount
The number of instances of sample text that matched the detection criteria specified in the custom data identifier.
String resourceArn
The Amazon Resource Name (ARN) of the classification job, custom data identifier, findings filter, or member account.
List<E> tagKeys
The key of the tag to remove from the resource. To remove multiple tags, append the tagKeys parameter and argument for each additional tag to remove, separated by an ampersand (&).
String jobId
The unique identifier for the classification job.
String jobStatus
The new status for the job. Valid values are:
CANCELLED - Stops the job permanently and cancels it. This value is valid only if the job's current status is IDLE, PAUSED, RUNNING, or USER_PAUSED.
If you specify this value and the job's current status is RUNNING, Amazon Macie immediately begins to stop all processing tasks for the job. You can't resume or restart a job after you cancel it.
RUNNING - Resumes the job. This value is valid only if the job's current status is USER_PAUSED.
If you paused the job while it was actively running and you specify this value less than 30 days after you paused the job, Macie immediately resumes processing from the point where you paused the job. Otherwise, Macie resumes the job according to the schedule and other settings for the job.
USER_PAUSED - Pauses the job temporarily. This value is valid only if the job's current status is IDLE, PAUSED, or RUNNING. If you specify this value and the job's current status is RUNNING, Macie immediately begins to pause all processing tasks for the job.
If you pause a one-time job and you don't resume it within 30 days, the job expires and Macie cancels the job. If you pause a recurring job when its status is RUNNING and you don't resume it within 30 days, the job run expires and Macie cancels the run. To check the expiration date, refer to the UserPausedDetails.jobExpiresAt property.
String action
The action to perform on findings that meet the filter criteria (findingCriteria). Valid values are: ARCHIVE, suppress (automatically archive) the findings; and, NOOP, don't perform any action on the findings.
String description
A custom description of the filter. The description can contain as many as 512 characters.
We strongly recommend that you avoid including any sensitive data in the description of a filter. Other users might be able to see the filter's description, depending on the actions that they're allowed to perform in Amazon Macie.
FindingCriteria findingCriteria
The criteria to use to filter findings.
String id
The unique identifier for the Amazon Macie resource or account that the request applies to.
String name
A custom name for the filter. The name must contain at least 3 characters and can contain as many as 64 characters.
We strongly recommend that you avoid including any sensitive data in the name of a filter. Other users might be able to see the filter's name, depending on the actions that they're allowed to perform in Amazon Macie.
Integer position
The position of the filter in the list of saved filters on the Amazon Macie console. This value also determines the order in which the filter is applied to findings, relative to other filters that are also applied to the findings.
String findingPublishingFrequency
String status
Specifies a new status for the account. Valid values are: ENABLED, resume all Amazon Macie activities for the account; and, PAUSED, suspend all Macie activities for the account.
String id
The unique identifier for the Amazon Macie resource or account that the request applies to.
String status
Specifies the new status for the account. Valid values are: ENABLED, resume all Amazon Macie activities for the account; and, PAUSED, suspend all Macie activities for the account.
Boolean autoEnable
Specifies whether to enable Amazon Macie automatically for each account, when the account is added to the AWS organization.
String currency
The type of currency that the value for the metric (estimatedCost) is reported in.
String estimatedCost
The estimated value for the metric.
ServiceLimit serviceLimit
The current value for the quota that corresponds to the metric specified by the type field.
String type
The name of the metric. Possible values are: DATA_INVENTORY_EVALUATION, for monitoring S3 buckets; and, SENSITIVE_DATA_DISCOVERY, for analyzing S3 objects to detect sensitive data.
String accountId
The unique identifier for the AWS account that the data applies to.
Date freeTrialStartDate
The date and time, in UTC and extended ISO 8601 format, when the free trial started for the account.
List<E> usage
An array of objects that contains usage data and quotas for the account. Each object contains the data for a specific usage metric and the corresponding quota.
String comparator
The operator to use in the condition. If the value for the key property is accountId, this value must be CONTAINS. If the value for the key property is any other supported field, this value can be EQ, GT, GTE, LT, LTE, or NE.
String key
The field to use in the condition.
List<E> values
An array that lists values to use in the condition, based on the value for the field specified by the key property. If the value for the key property is accountId, this array can specify multiple values. Otherwise, this array can specify only one value.
Valid values for each supported field are:
accountId - The unique identifier for an AWS account.
freeTrialStartDate - The date and time, in UTC and extended ISO 8601 format, when the free trial started for an account.
serviceLimit - A Boolean (true or false) value that indicates whether an account has reached its monthly quota.
total - A string that represents the current estimated cost for an account.
String currency
The type of currency that the value for the metric (estimatedCost) is reported in.
String estimatedCost
The estimated value for the metric.
String type
The name of the metric. Possible values are: DATA_INVENTORY_EVALUATION, for monitoring S3 buckets; and, SENSITIVE_DATA_DISCOVERY, for analyzing S3 objects to detect sensitive data.
AssumedRole 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 awsAccount
If the action was performed using the credentials for another AWS account, the details of that account.
AwsService awsService
If the action was performed by an AWS account that belongs to an AWS service, the name of the service.
FederatedUser 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 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 root
If the action was performed using the credentials for your AWS account, the details of your account.
String type
The type of entity that performed the action.
String accountId
The unique identifier for the AWS account.
String arn
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 principalId
The unique identifier for the entity that performed the action.
Date jobExpiresAt
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.
String jobImminentExpirationHealthEventArn
The Amazon Resource Name (ARN) of the AWS 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.
Date jobPausedAt
The date and time, in UTC and extended ISO 8601 format, when you paused the job.
String dayOfWeek
The day of the week when Amazon Macie runs the job.
Copyright © 2021. All rights reserved.