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 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 kmsManaged
The total number of buckets that use an AWS Key Management Service (AWS KMS) customer master key (CMK) to encrypt objects. These buckets use AWS KMS AWS-managed (AWS-KMS) encryption or AWS KMS customer-managed (SSE-KMS) encryption.
Long s3Managed
The total number of buckets that use an Amazon S3-managed key to encrypt objects. These buckets use Amazon S3-managed (SSE-S3) encryption.
Long unencrypted
The total number of buckets that don't encrypt objects by default. Default encryption is disabled 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 any other AWS accounts.
List<E> eq
An equal to condition to apply to a specified attribute value for buckets.
Long gt
A greater than condition to apply to a specified attribute value for buckets.
Long gte
A greater than or equal to condition to apply to a specified attribute value for buckets.
Long lt
A less than condition to apply to a specified attribute value for buckets.
Long lte
A less than or equal to condition to apply to a specified attribute value for buckets.
List<E> neq
A not equal to condition to apply to a specified attribute value for buckets.
String prefix
The prefix of the buckets to include in the results.
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's associated with the bucket.
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 file format, file extension, or content type that Amazon Macie supports.
Date lastUpdated
The date and time, in UTC and extended ISO 8601 format, when Amazon Macie last analyzed 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. If this value is true, an access control list (ACL), bucket policy, or block public access settings allow the bucket to be accessed by the general public.
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.
String sharedAccess
Specifies whether the bucket is shared with another AWS account. Valid 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.
Long sizeInBytes
The total storage size, in bytes, of the bucket.
Long sizeInBytesCompressed
The total compressed storage size, in bytes, of the bucket.
List<E> tags
An array that specifies the tags (keys and values) that are associated with the bucket.
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: PUBLIC, the bucket is publicly accessible; and, NOT_PUBLIC, the bucket isn't publicly accessible.
BucketPermissionConfiguration permissionConfiguration
The account-level and bucket-level permissions for the bucket.
String attributeName
The name of the attribute to sort the results by. This value can be the name of any property that Amazon Macie defines as bucket metadata, such as bucketName, accountId, or lastUpdated.
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 detailedResultsLocation
The Amazon Resource Name (ARN) of the file that contains the detailed record, including offsets, for the finding.
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 detailed results of 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.
CustomDataIdentifiers customDataIdentifiers
The number of occurrences of the data that produced the finding, and the custom data identifiers that detected the data.
String mimeType
The type of content, expressed 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 PDF file.
List<E> sensitiveData
The category 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 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 run the job immediately, after it's 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 the value is less than 100, Amazon Macie randomly selects the objects to analyze, up to the specified percentage.
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 of 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 required 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.
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 4 - 90 characters.
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 required 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 required 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 master 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 required 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 master account.
List<E> eq
An equal to condition to apply to a specified property value for findings.
Long gt
A greater than condition to apply to a specified property value for findings.
Long gte
A greater than or equal to condition to apply to a specified property value for findings.
Long lt
A less than condition to apply to a specified property value for findings.
Long lte
A less than or equal to condition to apply to a specified property value for findings.
List<E> neq
A not equal to condition to apply to a specified property value for findings.
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 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 has run for the first time.
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 - The job was cancelled by you or a user of the master account for your organization. A job might also be cancelled if ownership of an S3 bucket changed while the job was running, and that change affected the job's access to the bucket.
COMPLETE - Amazon Macie finished processing all the data specified for the job.
IDLE - For a recurring job, the previous scheduled run is complete and the next scheduled run is pending. This value doesn't apply to jobs that occur only once.
PAUSED - Amazon Macie started the job, but completion of the job would exceed one or more quotas for your account.
RUNNING - The job is in progress.
String jobType
The schedule for running the job. Possible values are:
ONE_TIME - The job ran or will run only once.
SCHEDULED - The job runs on a daily, weekly, or monthly basis. The scheduleFrequency property indicates the recurrence pattern for the job.
Date lastRunTime
The date and time, in UTC and extended ISO 8601 format, when the job last ran.
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 the job applies when it processes objects.
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 most recent run.
Map<K,V> tags
A map of key-value pairs that identifies the tags (keys and values) that are associated with the classification job.
Boolean autoEnable
Specifies whether Amazon Macie is enabled automatically for accounts that are added to the AWS organization.
Boolean maxAccountLimitReached
Specifies whether the maximum number of Amazon Macie member accounts are already associated with the AWS organization.
String adminAccountId
The AWS account ID of the delegated 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 status for the account. To enable Amazon Macie and start all Amazon 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 this finding.
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 of 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. Sensitive data findings aren't updated.
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.
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, grouped by server-side encryption type. This object also reports the total number of buckets that aren't encrypted.
BucketCountBySharedAccessType bucketCountBySharedAccessType
The total number of buckets that are shared with another AWS account.
Long classifiableObjectCount
The total number of objects that Amazon Macie can analyze in all the buckets. These objects use a file format, file extension, or content type that Amazon Macie supports.
Date lastUpdated
The date and time, in UTC and extended ISO 8601 format, when Amazon Macie last analyzed the buckets.
Long objectCount
The total number of objects in all the buckets.
Long sizeInBytes
The total storage size, in bytes, of all the buckets.
Long sizeInBytesCompressed
The total compressed storage size, in bytes, of all the buckets.
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.
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.
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.
List<E> findingIds
An array of strings that lists the unique identifiers for the findings to retrieve information about.
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 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 Amazon 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 Amazon Macie to monitor and analyze data in AWS resources for the account.
String status
The current status of the Amazon Macie account. Possible values are: PAUSED, the account is enabled but all Amazon Macie activities are suspended (paused) for the account; and, ENABLED, the account is enabled and all Amazon 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 Amazon Macie account.
Invitation master
The AWS account ID for the master account. If the accounts are associated by a Macie membership invitation, this object also provides details about the invitation that was sent and accepted 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 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
The AWS account ID for the master account.
String relationshipStatus
The current status of the relationship between the account and the master 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 master account.
List<E> filterBy
An array of objects, one for each condition to use to filter the query results. If the array contains more than one object, Amazon Macie uses an AND operator to join the conditions specified by the objects.
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 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 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.
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 a tag key or tag keys and values 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 - The job was cancelled by you or a user of the master account for your organization. A job might also be cancelled if ownership of an S3 bucket changed while the job was running, and that change affected the job's access to the bucket.
COMPLETE - Amazon Macie finished processing all the data specified for the job.
IDLE - For a recurring job, the previous scheduled run is complete and the next scheduled run is pending. This value doesn't apply to jobs that occur only once.
PAUSED - Amazon Macie started the job, but completion of the job would exceed one or more quotas for your account.
RUNNING - The job is in progress.
String jobType
The schedule for running the job. Possible values are:
ONE_TIME - The job ran or will run only once.
SCHEDULED - The job runs on a daily, weekly, or monthly basis.
String name
The custom name of the job.
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 empty or null.
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 master account. By default, the response includes only current member accounts. To include all accounts, set the value for this parameter to false.
List<E> members
An array of objects, one for each account that's associated with the master 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 account that's designated as a delegated administrator of Amazon Macie for the AWS organization. Of those accounts, only one 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 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
The AWS account ID for the master account.
String relationshipStatus
The current status of the relationship between the account and the master 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 master account.
Integer dayOfMonth
The numeric day of the month when Amazon Macie runs the job. This value can be an integer from 1 through 30.
Long customerManaged
The total number of objects that are encrypted using a customer-managed key. The objects use customer-provided server-side (SSE-C) encryption.
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 KMS AWS-managed (AWS-KMS) encryption or AWS KMS customer-managed (SSE-KMS) encryption.
Long s3Managed
The total number of objects that are encrypted using an Amazon S3-managed key. The objects use Amazon S3-managed (SSE-S3) encryption.
Long unencrypted
The total number of objects that aren't encrypted or use client-side encryption.
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.
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 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 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 server-side encryption settings for the bucket.
String name
The name of the bucket.
S3BucketOwner owner
The display name and account identifier 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 accountId
The unique identifier for the AWS account that owns one or more of the buckets. If specified, the job analyzes objects in all the buckets that are owned by the account and meet other conditions specified for the job.
List<E> buckets
An array that lists the names of the buckets.
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.
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 extension of the object. If the object doesn't have a file 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 server-side encryption settings for 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.
String category
The category of sensitive data that was detected. For example: FINANCIAL_INFORMATION, for financial information such as credit card numbers; PERSONAL_INFORMATION, for personally identifiable information such as full names and mailing addresses; or, CUSTOM_IDENTIFIER, for data that was detected by a custom data identifier.
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.
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 encryption is disabled for the bucket or object, this value is NONE.
String kmsMasterKeyId
The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS) master key that's used to encrypt the bucket or object. This value is null if KMS isn't used to encrypt the bucket or object.
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 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 required 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> 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.
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 4 - 90 characters.
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 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 whether to change the status of 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 Amazon Macie is enabled 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 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 month-to-date 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 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.
String dayOfWeek
The day of the week when Amazon Macie runs the job.
Copyright © 2020. All rights reserved.