2022/11/29 - Amazon Macie 2 - 13 new 6 updated api methods
Changes Added support for configuring Macie to continually sample objects from S3 buckets and inspect them for sensitive data. Results appear in statistics, findings, and other data that Macie provides.
Enables or disables automated sensitive data discovery for an account.
See also: AWS API Documentation
Request Syntax
client.update_automated_discovery_configuration(
status='ENABLED'|'DISABLED'
)
string
[REQUIRED]
The new status of automated sensitive data discovery for the account. Valid values are: ENABLED, start or resume automated sensitive data discovery activities for the account; and, DISABLED, stop performing automated sensitive data discovery activities for the account.
When you enable automated sensitive data discovery for the first time, Amazon Macie uses default configuration settings to determine which data sources to analyze and which managed data identifiers to use. To change these settings, use the UpdateClassificationScope and UpdateSensitivityInspectionTemplate operations, respectively. If you change the settings and subsequently disable the configuration, Amazon Macie retains your changes.
dict
Response Syntax
{}
Response Structure
(dict) --
The request succeeded. The status of the automated sensitive data discovery configuration for the account was updated and there isn't any content to include in the body of the response (No Content).
Retrieves information about the types and amount of sensitive data that Amazon Macie found in an S3 bucket.
See also: AWS API Documentation
Request Syntax
client.list_resource_profile_detections(
maxResults=123,
nextToken='string',
resourceArn='string'
)
integer
The maximum number of items to include in each page of a paginated response.
string
The nextToken string that specifies which page of results to return in a paginated response.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the S3 bucket that the request applies to.
dict
Response Syntax
{
'detections': [
{
'arn': 'string',
'count': 123,
'id': 'string',
'name': 'string',
'suppressed': True|False,
'type': 'CUSTOM'|'MANAGED'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
The request succeeded.
detections (list) --
An array of objects, one for each type of sensitive data that Amazon Macie found in the bucket. Each object reports the number of occurrences of the specified type and provides information about the custom data identifier or managed data identifier that detected the data.
(dict) --
Provides information about a type of sensitive data that Amazon Macie found in an S3 bucket while performing automated sensitive data discovery for the bucket. The information also specifies the custom data identifier or managed data identifier that detected the data. This information is available only if automated sensitive data discovery is currently enabled for your account.
arn (string) --
If the sensitive data was detected by a custom data identifier, the Amazon Resource Name (ARN) of the custom data identifier that detected the data. Otherwise, this value is null.
count (integer) --
The total number of occurrences of the sensitive data.
id (string) --
The unique identifier for the custom data identifier or managed data identifier that detected the sensitive data. For additional details about a specified managed data identifier, see Using managed data identifiers in the Amazon Macie User Guide .
name (string) --
The name of the custom data identifier or managed data identifier that detected the sensitive data. For a managed data identifier, this value is the same as the unique identifier (id).
suppressed (boolean) --
Specifies whether occurrences of this type of sensitive data are excluded (true) or included (false) in the bucket's sensitivity score.
type (string) --
The type of data identifier that detected the sensitive data. Possible values are: CUSTOM, for a custom data identifier; and, MANAGED, for a managed data identifier.
nextToken (string) --
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.
Retrieves (queries) sensitive data discovery statistics and the sensitivity score for an S3 bucket.
See also: AWS API Documentation
Request Syntax
client.get_resource_profile(
resourceArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the S3 bucket that the request applies to.
dict
Response Syntax
{
'profileUpdatedAt': datetime(2015, 1, 1),
'sensitivityScore': 123,
'sensitivityScoreOverridden': True|False,
'statistics': {
'totalBytesClassified': 123,
'totalDetections': 123,
'totalDetectionsSuppressed': 123,
'totalItemsClassified': 123,
'totalItemsSensitive': 123,
'totalItemsSkipped': 123,
'totalItemsSkippedInvalidEncryption': 123,
'totalItemsSkippedInvalidKms': 123,
'totalItemsSkippedPermissionDenied': 123
}
}
Response Structure
(dict) --
The request succeeded.
profileUpdatedAt (datetime) --
The date and time, in UTC and extended ISO 8601 format, when Amazon Macie most recently recalculated sensitive data discovery statistics and details for the bucket. If the bucket's sensitivity score is calculated automatically, this includes the score.
sensitivityScore (integer) --
The current sensitivity score for the bucket, ranging from -1 (no analysis due to an error) to 100 (sensitive). By default, this score is calculated automatically based on the amount of data that Amazon Macie has analyzed in the bucket and the amount of sensitive data that Macie has found in the bucket.
sensitivityScoreOverridden (boolean) --
Specifies whether the bucket's current sensitivity score was set manually. If this value is true, the score was manually changed to 100. If this value is false, the score was calculated automatically by Amazon Macie.
statistics (dict) --
The sensitive data discovery statistics for the bucket. The statistics capture the results of automated sensitive data discovery activities that Amazon Macie has performed for the bucket.
totalBytesClassified (integer) --
The total amount of data, in bytes, that Amazon Macie has analyzed in the bucket.
totalDetections (integer) --
The total number of occurrences of sensitive data that Amazon Macie has found in the bucket's objects. This includes occurrences that are currently suppressed by the sensitivity scoring settings for the bucket (totalDetectionsSuppressed).
totalDetectionsSuppressed (integer) --
The total number of occurrences of sensitive data that are currently suppressed by the sensitivity scoring settings for the bucket. These represent occurrences of sensitive data that Amazon Macie found in the bucket's objects, but the occurrences were manually suppressed. By default, suppressed occurrences are excluded from the bucket's sensitivity score.
totalItemsClassified (integer) --
The total number of objects that Amazon Macie has analyzed in the bucket.
totalItemsSensitive (integer) --
The total number of the bucket's objects that Amazon Macie has found sensitive data in.
totalItemsSkipped (integer) --
The total number of objects that Amazon Macie hasn't analyzed in the bucket due to an error or issue. For example, the object is a malformed file. This value includes objects that Macie hasn't analyzed for reasons reported by other statistics in the ResourceStatistics object.
totalItemsSkippedInvalidEncryption (integer) --
The total number of objects that Amazon Macie hasn't analyzed in the bucket because the objects are encrypted with a key that Macie isn't allowed to use.
totalItemsSkippedInvalidKms (integer) --
The total number of objects that Amazon Macie hasn't analyzed in the bucket because the objects are encrypted with an KMS key that was disabled or deleted.
totalItemsSkippedPermissionDenied (integer) --
The total number of objects that Amazon Macie hasn't analyzed in the bucket because Macie isn't allowed to access the objects.
Retrieves information about objects that were selected from an S3 bucket for automated sensitive data discovery.
See also: AWS API Documentation
Request Syntax
client.list_resource_profile_artifacts(
nextToken='string',
resourceArn='string'
)
string
The nextToken string that specifies which page of results to return in a paginated response.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the S3 bucket that the request applies to.
dict
Response Syntax
{
'artifacts': [
{
'arn': 'string',
'classificationResultStatus': 'string',
'sensitive': True|False
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
The request succeeded.
artifacts (list) --
An array of objects, one for each S3 object that Amazon Macie selected for analysis.
(dict) --
Provides information about an S3 object that Amazon Macie selected for analysis while performing automated sensitive data discovery for an S3 bucket, and the status and results of the analysis. This information is available only if automated sensitive data discovery is currently enabled for your account.
arn (string) --
The Amazon Resource Name (ARN) of the object.
classificationResultStatus (string) --
The status of the analysis. Possible values are:
COMPLETE - Amazon Macie successfully completed its analysis of the object.
PARTIAL - Macie analyzed only a subset of data in the object. For example, the object is an archive file that contains files in an unsupported format.
SKIPPED - Macie wasn't able to analyze the object. For example, the object is a malformed file.
sensitive (boolean) --
Specifies whether Amazon Macie found sensitive data in the object.
nextToken (string) --
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.
Retrieves the settings for the sensitivity inspection template for an account.
See also: AWS API Documentation
Request Syntax
client.get_sensitivity_inspection_template(
id='string'
)
string
[REQUIRED]
The unique identifier for the Amazon Macie resource that the request applies to.
dict
Response Syntax
{
'description': 'string',
'excludes': {
'managedDataIdentifierIds': [
'string',
]
},
'includes': {
'allowListIds': [
'string',
],
'customDataIdentifierIds': [
'string',
],
'managedDataIdentifierIds': [
'string',
]
},
'name': 'string',
'sensitivityInspectionTemplateId': 'string'
}
Response Structure
(dict) --
The request succeeded.
description (string) --
The custom description of the template.
excludes (dict) --
The managed data identifiers that are explicitly excluded (not used) when analyzing data.
managedDataIdentifierIds (list) --
An array of unique identifiers, one for each managed data identifier to exclude. To retrieve a list of valid values, use the ListManagedDataIdentifiers operation.
(string) --
includes (dict) --
The allow lists, custom data identifiers, and managed data identifiers that are included (used) when analyzing data.
allowListIds (list) --
An array of unique identifiers, one for each allow list to include.
(string) --
customDataIdentifierIds (list) --
An array of unique identifiers, one for each custom data identifier to include.
(string) --
managedDataIdentifierIds (list) --
An array of unique identifiers, one for each managed data identifier to include.
Amazon Macie uses these managed data identifiers in addition to managed data identifiers that are subsequently released and recommended for automated sensitive data discovery. To retrieve a list of valid values for the managed data identifiers that are currently available, use the ListManagedDataIdentifiers operation.
(string) --
name (string) --
The name of the template.
sensitivityInspectionTemplateId (string) --
The unique identifier for the template.
Retrieves the classification scope settings for an account.
See also: AWS API Documentation
Request Syntax
client.get_classification_scope(
id='string'
)
string
[REQUIRED]
The unique identifier for the Amazon Macie resource that the request applies to.
dict
Response Syntax
{
'id': 'string',
'name': 'string',
's3': {
'excludes': {
'bucketNames': [
'string',
]
}
}
}
Response Structure
(dict) --
The request succeeded.
id (string) --
The unique identifier for the classification scope.
name (string) --
The name of the classification scope.
s3 (dict) --
The S3 buckets that are excluded from automated sensitive data discovery.
excludes (dict) --
The S3 buckets that are excluded.
bucketNames (list) --
An array of strings, one for each S3 bucket that is excluded. Each string is the full name of an excluded bucket.
(string) --
The name of an S3 bucket.
Updates the sensitivity score for an S3 bucket.
See also: AWS API Documentation
Request Syntax
client.update_resource_profile(
resourceArn='string',
sensitivityScoreOverride=123
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the S3 bucket that the request applies to.
integer
The new sensitivity score for the bucket. Valid values are: 100, assign the maximum score and apply the Sensitive label to the bucket; and, null (empty), assign a score that Amazon Macie calculates automatically after you submit the request.
dict
Response Syntax
{}
Response Structure
(dict) --
The request succeeded. The S3 bucket's sensitivity score was updated and there isn't any content to include in the body of the response (No Content).
Updates the sensitivity scoring settings for an S3 bucket.
See also: AWS API Documentation
Request Syntax
client.update_resource_profile_detections(
resourceArn='string',
suppressDataIdentifiers=[
{
'id': 'string',
'type': 'CUSTOM'|'MANAGED'
},
]
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the S3 bucket that the request applies to.
list
An array of objects, one for each custom data identifier or managed data identifier that detected the type of sensitive data to start excluding or including in the bucket's score. To start including all sensitive data types in the score, don't specify any values for this array.
(dict) --
Specifies a custom data identifier or managed data identifier that detected a type of sensitive data to start excluding or including in an S3 bucket's sensitivity score.
id (string) --
The unique identifier for the custom data identifier or managed data identifier that detected the type of sensitive data to exclude or include in the score.
type (string) --
The type of data identifier that detected the sensitive data. Possible values are: CUSTOM, for a custom data identifier; and, MANAGED, for a managed data identifier.
dict
Response Syntax
{}
Response Structure
(dict) --
The request succeeded. The settings were updated and there isn't any content to include in the body of the response (No Content).
Retrieves the configuration settings and status of automated sensitive data discovery for an account.
See also: AWS API Documentation
Request Syntax
client.get_automated_discovery_configuration()
dict
Response Syntax
{
'classificationScopeId': 'string',
'disabledAt': datetime(2015, 1, 1),
'firstEnabledAt': datetime(2015, 1, 1),
'lastUpdatedAt': datetime(2015, 1, 1),
'sensitivityInspectionTemplateId': 'string',
'status': 'ENABLED'|'DISABLED'
}
Response Structure
(dict) --
The request succeeded.
classificationScopeId (string) --
The unique identifier for the classification scope that's used when performing automated sensitive data discovery for the account. The classification scope specifies S3 buckets to exclude from automated sensitive data discovery.
disabledAt (datetime) --
The date and time, in UTC and extended ISO 8601 format, when automated sensitive data discovery was most recently disabled for the account. This value is null if automated sensitive data discovery wasn't enabled and subsequently disabled for the account.
firstEnabledAt (datetime) --
The date and time, in UTC and extended ISO 8601 format, when automated sensitive data discovery was initially enabled for the account. This value is null if automated sensitive data discovery has never been enabled for the account.
lastUpdatedAt (datetime) --
The date and time, in UTC and extended ISO 8601 format, when automated sensitive data discovery was most recently enabled or disabled for the account.
sensitivityInspectionTemplateId (string) --
The unique identifier for the sensitivity inspection template that's used when performing automated sensitive data discovery for the account. The template specifies which allow lists, custom data identifiers, and managed data identifiers to use when analyzing data.
status (string) --
The current status of the automated sensitive data discovery configuration for the account. Possible values are: ENABLED, use the specified settings to perform automated sensitive data discovery activities for the account; and, DISABLED, don't perform automated sensitive data discovery activities for the account.
Retrieves a subset of information about the classification scope for an account.
See also: AWS API Documentation
Request Syntax
client.list_classification_scopes(
name='string',
nextToken='string'
)
string
The name of the classification scope to retrieve the unique identifier for.
string
The nextToken string that specifies which page of results to return in a paginated response.
dict
Response Syntax
{
'classificationScopes': [
{
'id': 'string',
'name': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
The request succeeded.
classificationScopes (list) --
An array that specifies the unique identifier and name of the classification scope for the account.
(dict) --
Provides information about the classification scope for an Amazon Macie account. Macie uses the scope's settings when it performs automated sensitive data discovery for the account.
id (string) --
The unique identifier for the classification scope.
name (string) --
The name of the classification scope.
nextToken (string) --
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.
Updates the settings for the sensitivity inspection template for an account.
See also: AWS API Documentation
Request Syntax
client.update_sensitivity_inspection_template(
description='string',
excludes={
'managedDataIdentifierIds': [
'string',
]
},
id='string',
includes={
'allowListIds': [
'string',
],
'customDataIdentifierIds': [
'string',
],
'managedDataIdentifierIds': [
'string',
]
}
)
string
A custom description of the template.
dict
The managed data identifiers to explicitly exclude (not use) when analyzing data.
To exclude an allow list or custom data identifier that's currently included by the template, update the values for the SensitivityInspectionTemplateIncludes.allowListIds and SensitivityInspectionTemplateIncludes.customDataIdentifierIds properties, respectively.
managedDataIdentifierIds (list) --
An array of unique identifiers, one for each managed data identifier to exclude. To retrieve a list of valid values, use the ListManagedDataIdentifiers operation.
(string) --
string
[REQUIRED]
The unique identifier for the Amazon Macie resource that the request applies to.
dict
The allow lists, custom data identifiers, and managed data identifiers to include (use) when analyzing data.
allowListIds (list) --
An array of unique identifiers, one for each allow list to include.
(string) --
customDataIdentifierIds (list) --
An array of unique identifiers, one for each custom data identifier to include.
(string) --
managedDataIdentifierIds (list) --
An array of unique identifiers, one for each managed data identifier to include.
Amazon Macie uses these managed data identifiers in addition to managed data identifiers that are subsequently released and recommended for automated sensitive data discovery. To retrieve a list of valid values for the managed data identifiers that are currently available, use the ListManagedDataIdentifiers operation.
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
The request succeeded. The template's settings were updated and there isn't any content to include in the body of the response (No Content).
Retrieves a subset of information about the sensitivity inspection template for an account.
See also: AWS API Documentation
Request Syntax
client.list_sensitivity_inspection_templates(
maxResults=123,
nextToken='string'
)
integer
The maximum number of items to include in each page of a paginated response.
string
The nextToken string that specifies which page of results to return in a paginated response.
dict
Response Syntax
{
'nextToken': 'string',
'sensitivityInspectionTemplates': [
{
'id': 'string',
'name': 'string'
},
]
}
Response Structure
(dict) --
The request succeeded.
nextToken (string) --
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.
sensitivityInspectionTemplates (list) --
An array that specifies the unique identifier and name of the sensitivity inspection template for the account.
(dict) --
Provides information about the sensitivity inspection template for an Amazon Macie account. Macie uses the template's settings when it performs automated sensitive data discovery for the account.
id (string) --
The unique identifier for the sensitivity inspection template for the account.
name (string) --
The name of the sensitivity inspection template for the account.
Updates the classification scope settings for an account.
See also: AWS API Documentation
Request Syntax
client.update_classification_scope(
id='string',
s3={
'excludes': {
'bucketNames': [
'string',
],
'operation': 'ADD'|'REPLACE'|'REMOVE'
}
}
)
string
[REQUIRED]
The unique identifier for the Amazon Macie resource that the request applies to.
dict
The S3 buckets to add or remove from the exclusion list defined by the classification scope.
excludes (dict) -- [REQUIRED]
The names of the S3 buckets to add or remove from the list.
bucketNames (list) -- [REQUIRED]
Depending on the value specified for the update operation (ClassificationScopeUpdateOperation), an array of strings that: lists the names of buckets to add or remove from the list, or specifies a new set of bucket names that overwrites all existing names in the list. Each string must be the full name of an S3 bucket. Values are case sensitive.
(string) --
The name of an S3 bucket.
operation (string) -- [REQUIRED]
Specifies how to apply the changes to the exclusion list. Valid values are:
ADD - Append the specified bucket names to the current list.
REMOVE - Remove the specified bucket names from the current list.
REPLACE - Overwrite the current list with the specified list of bucket names. If you specify this value, Amazon Macie removes all existing names from the list and adds all the specified names to the list.
dict
Response Syntax
{}
Response Structure
(dict) --
The request succeeded. The specified settings were updated and there isn't any content to include in the body of the response (No Content).
{'buckets': {'lastAutomatedDiscoveryTime': 'timestamp',
'sensitivityScore': 'integer'}}
Retrieves (queries) statistical data and other information about one or more S3 buckets that Amazon Macie monitors and analyzes for an account.
See also: AWS API Documentation
Request Syntax
client.describe_buckets(
criteria={
'string': {
'eq': [
'string',
],
'gt': 123,
'gte': 123,
'lt': 123,
'lte': 123,
'neq': [
'string',
],
'prefix': 'string'
}
},
maxResults=123,
nextToken='string',
sortCriteria={
'attributeName': 'string',
'orderBy': 'ASC'|'DESC'
}
)
dict
The criteria to use to filter the query results.
(string) --
(dict) --
Specifies the operator to use in a property-based condition that filters the results of a query for information about S3 buckets.
eq (list) --
The value for the property matches (equals) the specified value. If you specify multiple values, Amazon Macie uses OR logic to join the values.
(string) --
gt (integer) --
The value for the property is greater than the specified value.
gte (integer) --
The value for the property is greater than or equal to the specified value.
lt (integer) --
The value for the property is less than the specified value.
lte (integer) --
The value for the property is less than or equal to the specified value.
neq (list) --
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 (string) --
The name of the bucket begins with the specified value.
integer
The maximum number of items to include in each page of the response. The default value is 50.
string
The nextToken string that specifies which page of results to return in a paginated response.
dict
The criteria to use to sort the query results.
attributeName (string) --
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, sensitivityScore, or sizeInBytes.
orderBy (string) --
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.
dict
Response Syntax
{
'buckets': [
{
'accountId': 'string',
'allowsUnencryptedObjectUploads': 'TRUE'|'FALSE'|'UNKNOWN',
'bucketArn': 'string',
'bucketCreatedAt': datetime(2015, 1, 1),
'bucketName': 'string',
'classifiableObjectCount': 123,
'classifiableSizeInBytes': 123,
'errorCode': 'ACCESS_DENIED',
'errorMessage': 'string',
'jobDetails': {
'isDefinedInJob': 'TRUE'|'FALSE'|'UNKNOWN',
'isMonitoredByJob': 'TRUE'|'FALSE'|'UNKNOWN',
'lastJobId': 'string',
'lastJobRunTime': datetime(2015, 1, 1)
},
'lastAutomatedDiscoveryTime': datetime(2015, 1, 1),
'lastUpdated': datetime(2015, 1, 1),
'objectCount': 123,
'objectCountByEncryptionType': {
'customerManaged': 123,
'kmsManaged': 123,
's3Managed': 123,
'unencrypted': 123,
'unknown': 123
},
'publicAccess': {
'effectivePermission': 'PUBLIC'|'NOT_PUBLIC'|'UNKNOWN',
'permissionConfiguration': {
'accountLevelPermissions': {
'blockPublicAccess': {
'blockPublicAcls': True|False,
'blockPublicPolicy': True|False,
'ignorePublicAcls': True|False,
'restrictPublicBuckets': True|False
}
},
'bucketLevelPermissions': {
'accessControlList': {
'allowsPublicReadAccess': True|False,
'allowsPublicWriteAccess': True|False
},
'blockPublicAccess': {
'blockPublicAcls': True|False,
'blockPublicPolicy': True|False,
'ignorePublicAcls': True|False,
'restrictPublicBuckets': True|False
},
'bucketPolicy': {
'allowsPublicReadAccess': True|False,
'allowsPublicWriteAccess': True|False
}
}
}
},
'region': 'string',
'replicationDetails': {
'replicated': True|False,
'replicatedExternally': True|False,
'replicationAccounts': [
'string',
]
},
'sensitivityScore': 123,
'serverSideEncryption': {
'kmsMasterKeyId': 'string',
'type': 'NONE'|'AES256'|'aws:kms'
},
'sharedAccess': 'EXTERNAL'|'INTERNAL'|'NOT_SHARED'|'UNKNOWN',
'sizeInBytes': 123,
'sizeInBytesCompressed': 123,
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'unclassifiableObjectCount': {
'fileType': 123,
'storageClass': 123,
'total': 123
},
'unclassifiableObjectSizeInBytes': {
'fileType': 123,
'storageClass': 123,
'total': 123
},
'versioning': True|False
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
The request succeeded.
buckets (list) --
An array of objects, one for each bucket that matches the filter criteria specified in the request.
(dict) --
Provides statistical data and other information about an S3 bucket that Amazon Macie monitors and analyzes for your account. If an error occurs when Macie attempts to retrieve and process metadata from Amazon S3 for the bucket and the bucket's objects, the value for the versioning property is false and the value for most other properties is null. Key exceptions are accountId, bucketArn, bucketCreatedAt, bucketName, lastUpdated, and region. To identify the cause of the error, refer to the errorCode and errorMessage values.
accountId (string) --
The unique identifier for the Amazon Web Services account that owns the bucket.
allowsUnencryptedObjectUploads (string) --
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 a valid server-side encryption header.
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 a valid server-side encryption header.
UNKNOWN - Amazon Macie can't determine whether the bucket policy requires server-side encryption of new objects.
Valid server-side encryption headers are: x-amz-server-side-encryption with a value of AES256 or aws:kms, and x-amz-server-side-encryption-customer-algorithm with a value of AES256.
bucketArn (string) --
The Amazon Resource Name (ARN) of the bucket.
bucketCreatedAt (datetime) --
The date and time, in UTC and extended ISO 8601 format, when the bucket was created, or changes such as edits to the bucket's policy were most recently made to the bucket.
bucketName (string) --
The name of the bucket.
classifiableObjectCount (integer) --
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.
classifiableSizeInBytes (integer) --
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.
errorCode (string) --
Specifies the error code for an error that prevented Amazon Macie from retrieving and processing information about the bucket and the bucket's objects. If this value is ACCESS_DENIED, Macie doesn't have permission to retrieve the information. For example, the bucket has a restrictive bucket policy and Amazon S3 denied the request. If this value is null, Macie was able to retrieve and process the information.
errorMessage (string) --
A brief description of the error (errorCode) that prevented Amazon Macie from retrieving and processing information about the bucket and the bucket's objects. This value is null if Macie was able to retrieve and process the information.
jobDetails (dict) --
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.
isDefinedInJob (string) --
Specifies whether any one-time or recurring jobs are configured to analyze data in the bucket. Possible values are:
TRUE - The bucket is explicitly included in the bucket definition (S3BucketDefinitionForJob) for one or more jobs and at least one of those jobs has a status other than CANCELLED. Or the bucket matched the bucket criteria (S3BucketCriteriaForJob) for at least one job that previously ran.
FALSE - The bucket isn't explicitly included in the bucket definition (S3BucketDefinitionForJob) for any jobs, all the jobs that explicitly include the bucket in their bucket definitions have a status of CANCELLED, or the bucket didn't match the bucket criteria (S3BucketCriteriaForJob) for any jobs that previously ran.
UNKNOWN - An exception occurred when Amazon Macie attempted to retrieve job data for the bucket.
isMonitoredByJob (string) --
Specifies whether any recurring jobs are configured to analyze data in the bucket. Possible values are:
TRUE - The bucket is explicitly included in the bucket definition (S3BucketDefinitionForJob) for one or more recurring jobs or the bucket matches the bucket criteria (S3BucketCriteriaForJob) for one or more recurring jobs. At least one of those jobs has a status other than CANCELLED.
FALSE - The bucket isn't explicitly included in the bucket definition (S3BucketDefinitionForJob) for any recurring jobs, the bucket doesn't match the bucket criteria (S3BucketCriteriaForJob) for any recurring jobs, 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.
lastJobId (string) --
The unique identifier for the job that ran most recently and is configured to analyze data in the bucket, either the latest run of a recurring job or the only run of a one-time job.
This value is typically null if the value for the isDefinedInJob property is FALSE or UNKNOWN.
lastJobRunTime (datetime) --
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 typically null if the value for the isDefinedInJob property is FALSE or UNKNOWN.
lastAutomatedDiscoveryTime (datetime) --
The date and time, in UTC and extended ISO 8601 format, when Amazon Macie most recently performed automated sensitive data discovery for the bucket. This value is null if automated sensitive data discovery is currently disabled for your account.
lastUpdated (datetime) --
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.
objectCount (integer) --
The total number of objects in the bucket.
objectCountByEncryptionType (dict) --
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.
customerManaged (integer) --
The total number of objects that are encrypted with a customer-provided key. The objects use customer-provided server-side encryption (SSE-C).
kmsManaged (integer) --
The total number of objects that are encrypted with an KMS key, either an Amazon Web Services managed key or a customer managed key. The objects use KMS encryption (SSE-KMS).
s3Managed (integer) --
The total number of objects that are encrypted with an Amazon S3 managed key. The objects use Amazon S3 managed encryption (SSE-S3).
unencrypted (integer) --
The total number of objects that aren't encrypted or use client-side encryption.
unknown (integer) --
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.
publicAccess (dict) --
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.
effectivePermission (string) --
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.
permissionConfiguration (dict) --
The account-level and bucket-level permissions settings for the bucket.
accountLevelPermissions (dict) --
The account-level permissions settings that apply to the bucket.
blockPublicAccess (dict) --
The block public access settings for the Amazon Web Services account that owns the bucket.
blockPublicAcls (boolean) --
Specifies whether Amazon S3 blocks public access control lists (ACLs) for the bucket and objects in the bucket.
blockPublicPolicy (boolean) --
Specifies whether Amazon S3 blocks public bucket policies for the bucket.
ignorePublicAcls (boolean) --
Specifies whether Amazon S3 ignores public ACLs for the bucket and objects in the bucket.
restrictPublicBuckets (boolean) --
Specifies whether Amazon S3 restricts public bucket policies for the bucket.
bucketLevelPermissions (dict) --
The bucket-level permissions settings for the bucket.
accessControlList (dict) --
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.
allowsPublicReadAccess (boolean) --
Specifies whether the ACL grants the general public with read access permissions for the bucket.
allowsPublicWriteAccess (boolean) --
Specifies whether the ACL grants the general public with write access permissions for the bucket.
blockPublicAccess (dict) --
The block public access settings for the bucket.
blockPublicAcls (boolean) --
Specifies whether Amazon S3 blocks public access control lists (ACLs) for the bucket and objects in the bucket.
blockPublicPolicy (boolean) --
Specifies whether Amazon S3 blocks public bucket policies for the bucket.
ignorePublicAcls (boolean) --
Specifies whether Amazon S3 ignores public ACLs for the bucket and objects in the bucket.
restrictPublicBuckets (boolean) --
Specifies whether Amazon S3 restricts public bucket policies for the bucket.
bucketPolicy (dict) --
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.
allowsPublicReadAccess (boolean) --
Specifies whether the bucket policy allows the general public to have read access to the bucket.
allowsPublicWriteAccess (boolean) --
Specifies whether the bucket policy allows the general public to have write access to the bucket.
region (string) --
The Amazon Web Services Region that hosts the bucket.
replicationDetails (dict) --
Specifies whether the bucket is configured to replicate one or more objects to buckets for other Amazon Web Services accounts and, if so, which accounts.
replicated (boolean) --
Specifies whether the bucket is configured to replicate one or more objects to any destination.
replicatedExternally (boolean) --
Specifies whether the bucket is configured to replicate one or more objects to an Amazon Web Services account that isn't part of the same Amazon Macie organization.
replicationAccounts (list) --
An array of Amazon Web Services account IDs, one for each Amazon Web Services account that the bucket is configured to replicate one or more objects to.
(string) --
sensitivityScore (integer) --
The sensitivity score for the bucket, ranging from -1 (no analysis due to an error) to 100 (sensitive). This value is null if automated sensitive data discovery is currently disabled for your account.
serverSideEncryption (dict) --
Specifies whether the bucket encrypts new objects by default and, if so, the type of server-side encryption that's used.
kmsMasterKeyId (string) --
The Amazon Resource Name (ARN) or unique identifier (key ID) for the KMS key 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.
type (string) --
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. They use SSE-S3 encryption.
aws:kms - New objects are encrypted with an KMS key (kmsMasterKeyId), either an Amazon Web Services managed key or a customer managed key. They use SSE-KMS encryption.
NONE - New objects aren't encrypted by default. Default encryption is disabled for the bucket.
sharedAccess (string) --
Specifies whether the bucket is shared with another Amazon Web Services account. Possible values are:
EXTERNAL - The bucket is shared with an Amazon Web Services account that isn't part of the same Amazon Macie organization.
INTERNAL - The bucket is shared with an Amazon Web Services account that's part of the same Amazon Macie organization.
NOT_SHARED - The bucket isn't shared with other Amazon Web Services accounts.
UNKNOWN - Amazon Macie wasn't able to evaluate the shared access settings for the bucket.
sizeInBytes (integer) --
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.
sizeInBytesCompressed (integer) --
The total storage size, in bytes, of the objects that are compressed (.gz, .gzip, .zip) files in the bucket.
If versioning is enabled for the bucket, Amazon 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.
tags (list) --
An array that specifies the tags (keys and values) that are associated with the bucket.
(dict) --
Provides information about the tags that are associated with an S3 bucket or object. Each tag consists of a required tag key and an associated tag value.
key (string) --
One part of a key-value pair that comprises a tag. A tag key is a general label that acts as a category for more specific tag values.
value (string) --
One part of a key-value pair that comprises a tag. A tag value acts as a descriptor for a tag key. A tag value can be an empty string.
unclassifiableObjectCount (dict) --
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.
fileType (integer) --
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.
storageClass (integer) --
The total storage size (in bytes) or number of objects that Amazon Macie can't analyze because the objects use an unsupported storage class.
total (integer) --
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.
unclassifiableObjectSizeInBytes (dict) --
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.
fileType (integer) --
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.
storageClass (integer) --
The total storage size (in bytes) or number of objects that Amazon Macie can't analyze because the objects use an unsupported storage class.
total (integer) --
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.
versioning (boolean) --
Specifies whether versioning is enabled for the bucket.
nextToken (string) --
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.
{'bucketStatisticsBySensitivity': {'classificationError': {'classifiableSizeInBytes': 'long',
'publiclyAccessibleCount': 'long',
'totalCount': 'long',
'totalSizeInBytes': 'long'},
'notClassified': {'classifiableSizeInBytes': 'long',
'publiclyAccessibleCount': 'long',
'totalCount': 'long',
'totalSizeInBytes': 'long'},
'notSensitive': {'classifiableSizeInBytes': 'long',
'publiclyAccessibleCount': 'long',
'totalCount': 'long',
'totalSizeInBytes': 'long'},
'sensitive': {'classifiableSizeInBytes': 'long',
'publiclyAccessibleCount': 'long',
'totalCount': 'long',
'totalSizeInBytes': 'long'}}}
Retrieves (queries) aggregated statistical data about all the S3 buckets that Amazon Macie monitors and analyzes for an account.
See also: AWS API Documentation
Request Syntax
client.get_bucket_statistics(
accountId='string'
)
string
The unique identifier for the Amazon Web Services account.
dict
Response Syntax
{
'bucketCount': 123,
'bucketCountByEffectivePermission': {
'publiclyAccessible': 123,
'publiclyReadable': 123,
'publiclyWritable': 123,
'unknown': 123
},
'bucketCountByEncryptionType': {
'kmsManaged': 123,
's3Managed': 123,
'unencrypted': 123,
'unknown': 123
},
'bucketCountByObjectEncryptionRequirement': {
'allowsUnencryptedObjectUploads': 123,
'deniesUnencryptedObjectUploads': 123,
'unknown': 123
},
'bucketCountBySharedAccessType': {
'external': 123,
'internal': 123,
'notShared': 123,
'unknown': 123
},
'bucketStatisticsBySensitivity': {
'classificationError': {
'classifiableSizeInBytes': 123,
'publiclyAccessibleCount': 123,
'totalCount': 123,
'totalSizeInBytes': 123
},
'notClassified': {
'classifiableSizeInBytes': 123,
'publiclyAccessibleCount': 123,
'totalCount': 123,
'totalSizeInBytes': 123
},
'notSensitive': {
'classifiableSizeInBytes': 123,
'publiclyAccessibleCount': 123,
'totalCount': 123,
'totalSizeInBytes': 123
},
'sensitive': {
'classifiableSizeInBytes': 123,
'publiclyAccessibleCount': 123,
'totalCount': 123,
'totalSizeInBytes': 123
}
},
'classifiableObjectCount': 123,
'classifiableSizeInBytes': 123,
'lastUpdated': datetime(2015, 1, 1),
'objectCount': 123,
'sizeInBytes': 123,
'sizeInBytesCompressed': 123,
'unclassifiableObjectCount': {
'fileType': 123,
'storageClass': 123,
'total': 123
},
'unclassifiableObjectSizeInBytes': {
'fileType': 123,
'storageClass': 123,
'total': 123
}
}
Response Structure
(dict) --
The request succeeded.
bucketCount (integer) --
The total number of buckets.
bucketCountByEffectivePermission (dict) --
The total number of buckets that are publicly accessible based on a combination of permissions settings for each bucket.
publiclyAccessible (integer) --
The total number of buckets that allow the general public to have read or write access to the bucket.
publiclyReadable (integer) --
The total number of buckets that allow the general public to have read access to the bucket.
publiclyWritable (integer) --
The total number of buckets that allow the general public to have write access to the bucket.
unknown (integer) --
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.
bucketCountByEncryptionType (dict) --
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.
kmsManaged (integer) --
The total number of buckets that use an KMS key to encrypt new objects by default, either an Amazon Web Services managed key or a customer managed key. These buckets use KMS encryption (SSE-KMS) by default.
s3Managed (integer) --
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.
unencrypted (integer) --
The total number of buckets that don't encrypt new objects by default. Default encryption is disabled for these buckets.
unknown (integer) --
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.
bucketCountByObjectEncryptionRequirement (dict) --
The total number of buckets whose bucket policies do or don't require server-side encryption of objects when objects are uploaded to the buckets.
allowsUnencryptedObjectUploads (integer) --
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 a valid server-side encryption header: the x-amz-server-side-encryption header with a value of AES256 or aws:kms, or the x-amz-server-side-encryption-customer-algorithm header with a value of AES256.
deniesUnencryptedObjectUploads (integer) --
The total number of buckets whose bucket policies require server-side encryption of new objects. PutObject requests for these buckets must include a valid server-side encryption header: the x-amz-server-side-encryption header with a value of AES256 or aws:kms, or the x-amz-server-side-encryption-customer-algorithm header with a value of AES256.
unknown (integer) --
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.
bucketCountBySharedAccessType (dict) --
The total number of buckets that are or aren't shared with another Amazon Web Services account.
external (integer) --
The total number of buckets that are shared with an Amazon Web Services account that isn't part of the same Amazon Macie organization.
internal (integer) --
The total number of buckets that are shared with an Amazon Web Services account that's part of the same Amazon Macie organization.
notShared (integer) --
The total number of buckets that aren't shared with other Amazon Web Services accounts.
unknown (integer) --
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 Amazon Web Services accounts.
bucketStatisticsBySensitivity (dict) --
The aggregated sensitive data discovery statistics for the buckets. If automated sensitive data discovery is currently disabled for your account, the value for each statistic is 0.
classificationError (dict) --
The aggregated statistical data for all buckets that have a sensitivity score of -1.
classifiableSizeInBytes (integer) --
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, this value is based on the size of the latest version of each applicable object in the buckets. This value doesn't reflect the storage size of all versions of all applicable objects in the buckets.
publiclyAccessibleCount (integer) --
The total number of buckets that are publicly accessible based on a combination of permissions settings for each bucket.
totalCount (integer) --
The total number of buckets.
totalSizeInBytes (integer) --
The total storage size, in bytes, of the buckets.
If versioning is enabled for any of the buckets, this value is based on the size of the latest version of each object in the buckets. This value doesn't reflect the storage size of all versions of the objects in the buckets.
notClassified (dict) --
The aggregated statistical data for all buckets that have a sensitivity score of 50.
classifiableSizeInBytes (integer) --
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, this value is based on the size of the latest version of each applicable object in the buckets. This value doesn't reflect the storage size of all versions of all applicable objects in the buckets.
publiclyAccessibleCount (integer) --
The total number of buckets that are publicly accessible based on a combination of permissions settings for each bucket.
totalCount (integer) --
The total number of buckets.
totalSizeInBytes (integer) --
The total storage size, in bytes, of the buckets.
If versioning is enabled for any of the buckets, this value is based on the size of the latest version of each object in the buckets. This value doesn't reflect the storage size of all versions of the objects in the buckets.
notSensitive (dict) --
The aggregated statistical data for all buckets that have a sensitivity score of 0-49.
classifiableSizeInBytes (integer) --
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, this value is based on the size of the latest version of each applicable object in the buckets. This value doesn't reflect the storage size of all versions of all applicable objects in the buckets.
publiclyAccessibleCount (integer) --
The total number of buckets that are publicly accessible based on a combination of permissions settings for each bucket.
totalCount (integer) --
The total number of buckets.
totalSizeInBytes (integer) --
The total storage size, in bytes, of the buckets.
If versioning is enabled for any of the buckets, this value is based on the size of the latest version of each object in the buckets. This value doesn't reflect the storage size of all versions of the objects in the buckets.
sensitive (dict) --
The aggregated statistical data for all buckets that have a sensitivity score of 51-100.
classifiableSizeInBytes (integer) --
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, this value is based on the size of the latest version of each applicable object in the buckets. This value doesn't reflect the storage size of all versions of all applicable objects in the buckets.
publiclyAccessibleCount (integer) --
The total number of buckets that are publicly accessible based on a combination of permissions settings for each bucket.
totalCount (integer) --
The total number of buckets.
totalSizeInBytes (integer) --
The total storage size, in bytes, of the buckets.
If versioning is enabled for any of the buckets, this value is based on the size of the latest version of each object in the buckets. This value doesn't reflect the storage size of all versions of the objects in the buckets.
classifiableObjectCount (integer) --
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.
classifiableSizeInBytes (integer) --
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, this value is based on the size of the latest version of each applicable object in the buckets. This value doesn't reflect the storage size of all versions of all applicable objects in the buckets.
lastUpdated (datetime) --
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.
objectCount (integer) --
The total number of objects in the buckets.
sizeInBytes (integer) --
The total storage size, in bytes, of the buckets.
If versioning is enabled for any of the buckets, this value is based on the size of the latest version of each object in the buckets. This value doesn't reflect the storage size of all versions of the objects in the buckets.
sizeInBytesCompressed (integer) --
The total storage size, in bytes, of the objects that are compressed (.gz, .gzip, .zip) files in the buckets.
If versioning is enabled for any of the buckets, this value is based on the size of the latest version of each applicable object in the buckets. This value doesn't reflect the storage size of all versions of the applicable objects in the buckets.
unclassifiableObjectCount (dict) --
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.
fileType (integer) --
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.
storageClass (integer) --
The total storage size (in bytes) or number of objects that Amazon Macie can't analyze because the objects use an unsupported storage class.
total (integer) --
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.
unclassifiableObjectSizeInBytes (dict) --
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.
fileType (integer) --
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.
storageClass (integer) --
The total storage size (in bytes) or number of objects that Amazon Macie can't analyze because the objects use an unsupported storage class.
total (integer) --
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.
{'findings': {'classificationDetails': {'originType': {'AUTOMATED_SENSITIVE_DATA_DISCOVERY'}}}}
Retrieves the details of one or more findings.
See also: AWS API Documentation
Request Syntax
client.get_findings(
findingIds=[
'string',
],
sortCriteria={
'attributeName': 'string',
'orderBy': 'ASC'|'DESC'
}
)
list
[REQUIRED]
An array of strings that lists the unique identifiers for the findings to retrieve. You can specify as many as 50 unique identifiers in this array.
(string) --
dict
The criteria for sorting the results of the request.
attributeName (string) --
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.
orderBy (string) --
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.
dict
Response Syntax
{
'findings': [
{
'accountId': 'string',
'archived': True|False,
'category': 'CLASSIFICATION'|'POLICY',
'classificationDetails': {
'detailedResultsLocation': 'string',
'jobArn': 'string',
'jobId': 'string',
'originType': 'SENSITIVE_DATA_DISCOVERY_JOB'|'AUTOMATED_SENSITIVE_DATA_DISCOVERY',
'result': {
'additionalOccurrences': True|False,
'customDataIdentifiers': {
'detections': [
{
'arn': 'string',
'count': 123,
'name': 'string',
'occurrences': {
'cells': [
{
'cellReference': 'string',
'column': 123,
'columnName': 'string',
'row': 123
},
],
'lineRanges': [
{
'end': 123,
'start': 123,
'startColumn': 123
},
],
'offsetRanges': [
{
'end': 123,
'start': 123,
'startColumn': 123
},
],
'pages': [
{
'lineRange': {
'end': 123,
'start': 123,
'startColumn': 123
},
'offsetRange': {
'end': 123,
'start': 123,
'startColumn': 123
},
'pageNumber': 123
},
],
'records': [
{
'jsonPath': 'string',
'recordIndex': 123
},
]
}
},
],
'totalCount': 123
},
'mimeType': 'string',
'sensitiveData': [
{
'category': 'FINANCIAL_INFORMATION'|'PERSONAL_INFORMATION'|'CREDENTIALS'|'CUSTOM_IDENTIFIER',
'detections': [
{
'count': 123,
'occurrences': {
'cells': [
{
'cellReference': 'string',
'column': 123,
'columnName': 'string',
'row': 123
},
],
'lineRanges': [
{
'end': 123,
'start': 123,
'startColumn': 123
},
],
'offsetRanges': [
{
'end': 123,
'start': 123,
'startColumn': 123
},
],
'pages': [
{
'lineRange': {
'end': 123,
'start': 123,
'startColumn': 123
},
'offsetRange': {
'end': 123,
'start': 123,
'startColumn': 123
},
'pageNumber': 123
},
],
'records': [
{
'jsonPath': 'string',
'recordIndex': 123
},
]
},
'type': 'string'
},
],
'totalCount': 123
},
],
'sizeClassified': 123,
'status': {
'code': 'string',
'reason': 'string'
}
}
},
'count': 123,
'createdAt': datetime(2015, 1, 1),
'description': 'string',
'id': 'string',
'partition': 'string',
'policyDetails': {
'action': {
'actionType': 'AWS_API_CALL',
'apiCallDetails': {
'api': 'string',
'apiServiceName': 'string',
'firstSeen': datetime(2015, 1, 1),
'lastSeen': datetime(2015, 1, 1)
}
},
'actor': {
'domainDetails': {
'domainName': 'string'
},
'ipAddressDetails': {
'ipAddressV4': 'string',
'ipCity': {
'name': 'string'
},
'ipCountry': {
'code': 'string',
'name': 'string'
},
'ipGeoLocation': {
'lat': 123.0,
'lon': 123.0
},
'ipOwner': {
'asn': 'string',
'asnOrg': 'string',
'isp': 'string',
'org': 'string'
}
},
'userIdentity': {
'assumedRole': {
'accessKeyId': 'string',
'accountId': 'string',
'arn': 'string',
'principalId': 'string',
'sessionContext': {
'attributes': {
'creationDate': datetime(2015, 1, 1),
'mfaAuthenticated': True|False
},
'sessionIssuer': {
'accountId': 'string',
'arn': 'string',
'principalId': 'string',
'type': 'string',
'userName': 'string'
}
}
},
'awsAccount': {
'accountId': 'string',
'principalId': 'string'
},
'awsService': {
'invokedBy': 'string'
},
'federatedUser': {
'accessKeyId': 'string',
'accountId': 'string',
'arn': 'string',
'principalId': 'string',
'sessionContext': {
'attributes': {
'creationDate': datetime(2015, 1, 1),
'mfaAuthenticated': True|False
},
'sessionIssuer': {
'accountId': 'string',
'arn': 'string',
'principalId': 'string',
'type': 'string',
'userName': 'string'
}
}
},
'iamUser': {
'accountId': 'string',
'arn': 'string',
'principalId': 'string',
'userName': 'string'
},
'root': {
'accountId': 'string',
'arn': 'string',
'principalId': 'string'
},
'type': 'AssumedRole'|'IAMUser'|'FederatedUser'|'Root'|'AWSAccount'|'AWSService'
}
}
},
'region': 'string',
'resourcesAffected': {
's3Bucket': {
'allowsUnencryptedObjectUploads': 'TRUE'|'FALSE'|'UNKNOWN',
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'defaultServerSideEncryption': {
'encryptionType': 'NONE'|'AES256'|'aws:kms'|'UNKNOWN',
'kmsMasterKeyId': 'string'
},
'name': 'string',
'owner': {
'displayName': 'string',
'id': 'string'
},
'publicAccess': {
'effectivePermission': 'PUBLIC'|'NOT_PUBLIC'|'UNKNOWN',
'permissionConfiguration': {
'accountLevelPermissions': {
'blockPublicAccess': {
'blockPublicAcls': True|False,
'blockPublicPolicy': True|False,
'ignorePublicAcls': True|False,
'restrictPublicBuckets': True|False
}
},
'bucketLevelPermissions': {
'accessControlList': {
'allowsPublicReadAccess': True|False,
'allowsPublicWriteAccess': True|False
},
'blockPublicAccess': {
'blockPublicAcls': True|False,
'blockPublicPolicy': True|False,
'ignorePublicAcls': True|False,
'restrictPublicBuckets': True|False
},
'bucketPolicy': {
'allowsPublicReadAccess': True|False,
'allowsPublicWriteAccess': True|False
}
}
}
},
'tags': [
{
'key': 'string',
'value': 'string'
},
]
},
's3Object': {
'bucketArn': 'string',
'eTag': 'string',
'extension': 'string',
'key': 'string',
'lastModified': datetime(2015, 1, 1),
'path': 'string',
'publicAccess': True|False,
'serverSideEncryption': {
'encryptionType': 'NONE'|'AES256'|'aws:kms'|'UNKNOWN',
'kmsMasterKeyId': 'string'
},
'size': 123,
'storageClass': 'STANDARD'|'REDUCED_REDUNDANCY'|'STANDARD_IA'|'INTELLIGENT_TIERING'|'DEEP_ARCHIVE'|'ONEZONE_IA'|'GLACIER',
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'versionId': 'string'
}
},
'sample': True|False,
'schemaVersion': 'string',
'severity': {
'description': 'Low'|'Medium'|'High',
'score': 123
},
'title': 'string',
'type': 'SensitiveData:S3Object/Multiple'|'SensitiveData:S3Object/Financial'|'SensitiveData:S3Object/Personal'|'SensitiveData:S3Object/Credentials'|'SensitiveData:S3Object/CustomIdentifier'|'Policy:IAMUser/S3BucketPublic'|'Policy:IAMUser/S3BucketSharedExternally'|'Policy:IAMUser/S3BucketReplicatedExternally'|'Policy:IAMUser/S3BucketEncryptionDisabled'|'Policy:IAMUser/S3BlockPublicAccessDisabled',
'updatedAt': datetime(2015, 1, 1)
},
]
}
Response Structure
(dict) --
The request succeeded.
findings (list) --
An array of objects, one for each finding that matches the criteria specified in the request.
(dict) --
Provides the details of a finding.
accountId (string) --
The unique identifier for the Amazon Web Services account that the finding applies to. This is typically the account that owns the affected resource.
archived (boolean) --
Specifies whether the finding is archived (suppressed).
category (string) --
The category of the finding. Possible values are: CLASSIFICATION, for a sensitive data finding; and, POLICY, for a policy finding.
classificationDetails (dict) --
The details of a sensitive data finding. This value is null for a policy finding.
detailedResultsLocation (string) --
The path to the folder or file in Amazon S3 that contains the corresponding sensitive data discovery result for the finding. If a finding applies to a large archive or compressed file, this value is the path to a folder. Otherwise, this value is the path to a file.
jobArn (string) --
The Amazon Resource Name (ARN) of the classification job that produced the finding. This value is null if the origin of the finding (originType) is AUTOMATED_SENSITIVE_DATA_DISCOVERY.
jobId (string) --
The unique identifier for the classification job that produced the finding. This value is null if the origin of the finding (originType) is AUTOMATED_SENSITIVE_DATA_DISCOVERY.
originType (string) --
Specifies how Amazon Macie found the sensitive data that produced the finding. Possible values are: SENSITIVE_DATA_DISCOVERY_JOB, for a classification job; and, AUTOMATED_SENSITIVE_DATA_DISCOVERY, for automated sensitive data discovery.
result (dict) --
The status and other details of the finding.
additionalOccurrences (boolean) --
Specifies whether Amazon Macie detected additional occurrences of sensitive data in the S3 object. A finding includes location data for a maximum of 15 occurrences of sensitive data.
This value can help you determine whether to investigate additional occurrences of sensitive data in an object. You can do this by referring to the corresponding sensitive data discovery result for the finding (ClassificationDetails.detailedResultsLocation).
customDataIdentifiers (dict) --
The custom data identifiers that detected the sensitive data and the number of occurrences of the data that they detected.
detections (list) --
The custom data identifiers that detected the data, and the number of occurrences of the data that each identifier detected.
(dict) --
Provides information about a custom data identifier that produced a sensitive data finding, and the sensitive data that it detected for the finding.
arn (string) --
The Amazon Resource Name (ARN) of the custom data identifier.
count (integer) --
The total number of occurrences of the sensitive data that the custom data identifier detected.
name (string) --
The name of the custom data identifier.
occurrences (dict) --
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.
cells (list) --
An array of objects, one for each occurrence of sensitive data in a Microsoft Excel workbook, CSV file, or TSV file. This value is null for all other types of files.
Each Cell object specifies a cell or field that contains the sensitive data.
(dict) --
Specifies the location of an occurrence of sensitive data in a Microsoft Excel workbook, CSV file, or TSV file.
cellReference (string) --
The location of the cell, as an absolute cell reference, that contains the sensitive data, for example Sheet2!C5 for cell C5 on Sheet2 in a Microsoft Excel workbook. This value is null for CSV and TSV files.
column (integer) --
The column number of the column that contains the sensitive data. For a Microsoft Excel workbook, this value correlates to the alphabetical character(s) for a column identifier, for example: 1 for column A, 2 for column B, and so on.
columnName (string) --
The name of the column that contains the sensitive data, if available.
row (integer) --
The row number of the row that contains the sensitive data.
lineRanges (list) --
An array of objects, one for each occurrence of sensitive data in a non-binary text file, such as an HTML, TXT, or XML file. Each Range object specifies a line or inclusive range of lines that contains the sensitive data, and the position of the data on the specified line or lines.
This value is often null for file types that are supported by Cell, Page, or Record objects. Exceptions are the location of sensitive data in: unstructured sections of an otherwise structured file, such as a comment in a file; a malformed file that Amazon Macie analyzes as plain text; and, a CSV or TSV file that has any column names that contain sensitive data.
(dict) --
Specifies the location of an occurrence of sensitive data in a non-binary text file, such as an HTML, TXT, or XML file.
end (integer) --
The number of lines from the beginning of the file to the end of the sensitive data.
start (integer) --
The number of lines from the beginning of the file to the beginning of the sensitive data.
startColumn (integer) --
The number of characters, with spaces and starting from 1, from the beginning of the first line that contains the sensitive data (start) to the beginning of the sensitive data.
offsetRanges (list) --
Reserved for future use.
(dict) --
Specifies the location of an occurrence of sensitive data in a non-binary text file, such as an HTML, TXT, or XML file.
end (integer) --
The number of lines from the beginning of the file to the end of the sensitive data.
start (integer) --
The number of lines from the beginning of the file to the beginning of the sensitive data.
startColumn (integer) --
The number of characters, with spaces and starting from 1, from the beginning of the first line that contains the sensitive data (start) to the beginning of the sensitive data.
pages (list) --
An array of objects, one for each occurrence of sensitive data in an Adobe Portable Document Format file. This value is null for all other types of files.
Each Page object specifies a page that contains the sensitive data.
(dict) --
Specifies the location of an occurrence of sensitive data in an Adobe Portable Document Format file.
lineRange (dict) --
Reserved for future use.
end (integer) --
The number of lines from the beginning of the file to the end of the sensitive data.
start (integer) --
The number of lines from the beginning of the file to the beginning of the sensitive data.
startColumn (integer) --
The number of characters, with spaces and starting from 1, from the beginning of the first line that contains the sensitive data (start) to the beginning of the sensitive data.
offsetRange (dict) --
Reserved for future use.
end (integer) --
The number of lines from the beginning of the file to the end of the sensitive data.
start (integer) --
The number of lines from the beginning of the file to the beginning of the sensitive data.
startColumn (integer) --
The number of characters, with spaces and starting from 1, from the beginning of the first line that contains the sensitive data (start) to the beginning of the sensitive data.
pageNumber (integer) --
The page number of the page that contains the sensitive data.
records (list) --
An array of objects, one for each occurrence of sensitive data in an Apache Avro object container, Apache Parquet file, JSON file, or JSON Lines file. This value is null for all other types of files.
For an Avro object container or Parquet file, each Record object specifies a record index and the path to a field in a record that contains the sensitive data. For a JSON or JSON Lines file, each Record object specifies the path to a field or array that contains the sensitive data. For a JSON Lines file, it also specifies the index of the line that contains the data.
(dict) --
Specifies the location of an occurrence of sensitive data in an Apache Avro object container, Apache Parquet file, JSON file, or JSON Lines file.
jsonPath (string) --
The path, as a JSONPath expression, to the sensitive data. For an Avro object container or Parquet file, this is the path to the field in the record (recordIndex) that contains the data. For a JSON or JSON Lines file, this is the path to the field or array that contains the data. If the data is a value in an array, the path also indicates which value contains the data.
If Amazon Macie detects sensitive data in the name of any element in the path, Macie omits this field. If the name of an element exceeds 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.
recordIndex (integer) --
For an Avro object container or Parquet file, the record index, starting from 0, for the record that contains the sensitive data. For a JSON Lines file, the line index, starting from 0, for the line that contains the sensitive data. This value is always 0 for JSON files.
totalCount (integer) --
The total number of occurrences of the data that was detected by the custom data identifiers and produced the finding.
mimeType (string) --
The type of content, as a MIME type, that the finding applies to. For example, application/gzip, for a GNU Gzip compressed archive file, or application/pdf, for an Adobe Portable Document Format file.
sensitiveData (list) --
The category, types, and number of occurrences of the sensitive data that produced the finding.
(dict) --
Provides information about the category, types, and occurrences of sensitive data that produced a sensitive data finding.
category (string) --
The category of sensitive data that was detected. For example: CREDENTIALS, for credentials data such as private keys or Amazon Web Services secret access keys; FINANCIAL_INFORMATION, for financial data such as credit card numbers; or, PERSONAL_INFORMATION, for personal health information, such as health insurance identification numbers, or personally identifiable information, such as passport numbers.
detections (list) --
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.
(dict) --
Provides information about a type of sensitive data that was detected by a managed data identifier and produced a sensitive data finding.
count (integer) --
The total number of occurrences of the type of sensitive data that was detected.
occurrences (dict) --
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.
cells (list) --
An array of objects, one for each occurrence of sensitive data in a Microsoft Excel workbook, CSV file, or TSV file. This value is null for all other types of files.
Each Cell object specifies a cell or field that contains the sensitive data.
(dict) --
Specifies the location of an occurrence of sensitive data in a Microsoft Excel workbook, CSV file, or TSV file.
cellReference (string) --
The location of the cell, as an absolute cell reference, that contains the sensitive data, for example Sheet2!C5 for cell C5 on Sheet2 in a Microsoft Excel workbook. This value is null for CSV and TSV files.
column (integer) --
The column number of the column that contains the sensitive data. For a Microsoft Excel workbook, this value correlates to the alphabetical character(s) for a column identifier, for example: 1 for column A, 2 for column B, and so on.
columnName (string) --
The name of the column that contains the sensitive data, if available.
row (integer) --
The row number of the row that contains the sensitive data.
lineRanges (list) --
An array of objects, one for each occurrence of sensitive data in a non-binary text file, such as an HTML, TXT, or XML file. Each Range object specifies a line or inclusive range of lines that contains the sensitive data, and the position of the data on the specified line or lines.
This value is often null for file types that are supported by Cell, Page, or Record objects. Exceptions are the location of sensitive data in: unstructured sections of an otherwise structured file, such as a comment in a file; a malformed file that Amazon Macie analyzes as plain text; and, a CSV or TSV file that has any column names that contain sensitive data.
(dict) --
Specifies the location of an occurrence of sensitive data in a non-binary text file, such as an HTML, TXT, or XML file.
end (integer) --
The number of lines from the beginning of the file to the end of the sensitive data.
start (integer) --
The number of lines from the beginning of the file to the beginning of the sensitive data.
startColumn (integer) --
The number of characters, with spaces and starting from 1, from the beginning of the first line that contains the sensitive data (start) to the beginning of the sensitive data.
offsetRanges (list) --
Reserved for future use.
(dict) --
Specifies the location of an occurrence of sensitive data in a non-binary text file, such as an HTML, TXT, or XML file.
end (integer) --
The number of lines from the beginning of the file to the end of the sensitive data.
start (integer) --
The number of lines from the beginning of the file to the beginning of the sensitive data.
startColumn (integer) --
The number of characters, with spaces and starting from 1, from the beginning of the first line that contains the sensitive data (start) to the beginning of the sensitive data.
pages (list) --
An array of objects, one for each occurrence of sensitive data in an Adobe Portable Document Format file. This value is null for all other types of files.
Each Page object specifies a page that contains the sensitive data.
(dict) --
Specifies the location of an occurrence of sensitive data in an Adobe Portable Document Format file.
lineRange (dict) --
Reserved for future use.
end (integer) --
The number of lines from the beginning of the file to the end of the sensitive data.
start (integer) --
The number of lines from the beginning of the file to the beginning of the sensitive data.
startColumn (integer) --
The number of characters, with spaces and starting from 1, from the beginning of the first line that contains the sensitive data (start) to the beginning of the sensitive data.
offsetRange (dict) --
Reserved for future use.
end (integer) --
The number of lines from the beginning of the file to the end of the sensitive data.
start (integer) --
The number of lines from the beginning of the file to the beginning of the sensitive data.
startColumn (integer) --
The number of characters, with spaces and starting from 1, from the beginning of the first line that contains the sensitive data (start) to the beginning of the sensitive data.
pageNumber (integer) --
The page number of the page that contains the sensitive data.
records (list) --
An array of objects, one for each occurrence of sensitive data in an Apache Avro object container, Apache Parquet file, JSON file, or JSON Lines file. This value is null for all other types of files.
For an Avro object container or Parquet file, each Record object specifies a record index and the path to a field in a record that contains the sensitive data. For a JSON or JSON Lines file, each Record object specifies the path to a field or array that contains the sensitive data. For a JSON Lines file, it also specifies the index of the line that contains the data.
(dict) --
Specifies the location of an occurrence of sensitive data in an Apache Avro object container, Apache Parquet file, JSON file, or JSON Lines file.
jsonPath (string) --
The path, as a JSONPath expression, to the sensitive data. For an Avro object container or Parquet file, this is the path to the field in the record (recordIndex) that contains the data. For a JSON or JSON Lines file, this is the path to the field or array that contains the data. If the data is a value in an array, the path also indicates which value contains the data.
If Amazon Macie detects sensitive data in the name of any element in the path, Macie omits this field. If the name of an element exceeds 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.
recordIndex (integer) --
For an Avro object container or Parquet file, the record index, starting from 0, for the record that contains the sensitive data. For a JSON Lines file, the line index, starting from 0, for the line that contains the sensitive data. This value is always 0 for JSON files.
type (string) --
The type of sensitive data that was detected. For example, AWS_CREDENTIALS, PHONE_NUMBER, or ADDRESS.
totalCount (integer) --
The total number of occurrences of the sensitive data that was detected.
sizeClassified (integer) --
The total size, in bytes, of the data that the finding applies to.
status (dict) --
The status of the finding.
code (string) --
The status of the finding. Possible values are:
COMPLETE - Amazon Macie successfully completed its analysis of the S3 object that the finding applies to.
PARTIAL - Macie analyzed only a subset of the data in the S3 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 S3 object that the finding applies to. For example, the object is a file that uses an unsupported format.
reason (string) --
A brief description of the status of the finding. This value is null if the status (code) of the finding is COMPLETE.
Amazon Macie uses this value to notify you of any errors, warnings, or considerations that might impact your analysis of the finding and the affected S3 object. Possible values are:
ARCHIVE_CONTAINS_UNPROCESSED_FILES - The object is an archive file and Macie extracted and analyzed only some or none of the files in the archive. To determine which files Macie analyzed, if any, you can refer to the corresponding sensitive data discovery result for the finding (ClassificationDetails.detailedResultsLocation).
ARCHIVE_EXCEEDS_SIZE_LIMIT - The object is an archive file whose total storage size exceeds the size quota for this type of archive.
ARCHIVE_NESTING_LEVEL_OVER_LIMIT - The object is an archive file whose nested depth exceeds the quota for the maximum number of nested levels that Macie analyzes for this type of archive.
ARCHIVE_TOTAL_BYTES_EXTRACTED_OVER_LIMIT - The object is an archive file that exceeds the quota for the maximum amount of data that Macie extracts and analyzes for this type of archive.
ARCHIVE_TOTAL_DOCUMENTS_PROCESSED_OVER_LIMIT - The object is an archive file that contains more than the maximum number of files that Macie extracts and analyzes for this type of archive.
FILE_EXCEEDS_SIZE_LIMIT - The storage size of the object exceeds the size quota for this type of file.
INVALID_ENCRYPTION - The object is encrypted using server-side encryption but Macie isn’t allowed to use the key. Macie can’t decrypt and analyze the object.
INVALID_KMS_KEY - The object is encrypted with an KMS key that was disabled or is being deleted. Macie can’t decrypt and analyze the object.
INVALID_OBJECT_STATE - The object doesn’t use a supported Amazon S3 storage class. For more information, see Discovering sensitive data in the Amazon Macie User Guide .
JSON_NESTING_LEVEL_OVER_LIMIT - The object contains JSON data and the nested depth of the data exceeds the quota for the number of nested levels that Macie analyzes for this type of file.
MALFORMED_FILE - The object is a malformed or corrupted file. An error occurred when Macie attempted to detect the file’s type or extract data from the file.
OBJECT_VERSION_MISMATCH - The object was changed while Macie was analyzing it.
NO_SUCH_BUCKET_AVAILABLE - The object was in a bucket that was deleted shortly before or when Macie attempted to analyze the object.
MALFORMED_OR_FILE_SIZE_EXCEEDS_LIMIT - The object is a Microsoft Office file that is malformed or exceeds the size quota for this type of file. If the file is malformed, an error occurred when Macie attempted to extract data from the file.
OOXML_UNCOMPRESSED_SIZE_EXCEEDS_LIMIT - The object is an Office Open XML file that exceeds the size quota for this type of file.
OOXML_UNCOMPRESSED_RATIO_EXCEEDS_LIMIT - The object is an Office Open XML file whose compression ratio exceeds the compression quota for this type of file.
PERMISSION_DENIED - Macie isn’t allowed to access the object. The object’s permissions settings prevent Macie from analyzing the object.
SOURCE_OBJECT_NO_LONGER_AVAILABLE - The object was deleted shortly before or when Macie attempted to analyze it.
UNABLE_TO_PARSE_FILE - The object is a file that contains structured data and an error occurred when Macie attempted to parse the data.
UNSUPPORTED_FILE_TYPE_EXCEPTION - The object is a file that uses an unsupported file or storage format. For more information, see Supported file and storage formats in the Amazon Macie User Guide .
For information about sensitive data discovery quotas for files, see Amazon Macie quotas in the Amazon Macie User Guide .
count (integer) --
The total number of occurrences of the finding. For sensitive data findings, this value is always 1. All sensitive data findings are considered unique.
createdAt (datetime) --
The date and time, in UTC and extended ISO 8601 format, when Amazon Macie created the finding.
description (string) --
The description of the finding.
id (string) --
The unique identifier for the finding. This is a random string that Amazon Macie generates and assigns to a finding when it creates the finding.
partition (string) --
The Amazon Web Services partition that Amazon Macie created the finding in.
policyDetails (dict) --
The details of a policy finding. This value is null for a sensitive data finding.
action (dict) --
The action that produced the finding.
actionType (string) --
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 (dict) --
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.
api (string) --
The name of the operation that was invoked most recently and produced the finding.
apiServiceName (string) --
The URL of the Amazon Web Service that provides the operation, for example: s3.amazonaws.com.
firstSeen (datetime) --
The first date and time, in UTC and extended ISO 8601 format, when any operation was invoked and produced the finding.
lastSeen (datetime) --
The most recent date and time, in UTC and extended ISO 8601 format, when the specified operation (api) was invoked and produced the finding.
actor (dict) --
The entity that performed the action that produced the finding.
domainDetails (dict) --
The domain name of the device that the entity used to perform the action on the affected resource.
domainName (string) --
The name of the domain.
ipAddressDetails (dict) --
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.
ipAddressV4 (string) --
The Internet Protocol version 4 (IPv4) address of the device.
ipCity (dict) --
The city that the IP address originated from.
name (string) --
The name of the city.
ipCountry (dict) --
The country that the IP address originated from.
code (string) --
The two-character code, in ISO 3166-1 alpha-2 format, for the country that the IP address originated from. For example, US for the United States.
name (string) --
The name of the country that the IP address originated from.
ipGeoLocation (dict) --
The geographic coordinates of the location that the IP address originated from.
lat (float) --
The latitude coordinate of the location, rounded to four decimal places.
lon (float) --
The longitude coordinate of the location, rounded to four decimal places.
ipOwner (dict) --
The registered owner of the IP address.
asn (string) --
The autonomous system number (ASN) for the autonomous system that included the IP address.
asnOrg (string) --
The organization identifier that's associated with the autonomous system number (ASN) for the autonomous system that included the IP address.
isp (string) --
The name of the internet service provider (ISP) that owned the IP address.
org (string) --
The name of the organization that owned the IP address.
userIdentity (dict) --
The type and other characteristics of the entity that performed the action on the affected resource.
assumedRole (dict) --
If the action was performed with temporary security credentials that were obtained using the AssumeRole operation of the Security Token Service (STS) API, the identifiers, session context, and other details about the identity.
accessKeyId (string) --
The Amazon Web Services access key ID that identifies the credentials.
accountId (string) --
The unique identifier for the Amazon Web Services account that owns the entity that was used to get the credentials.
arn (string) --
The Amazon Resource Name (ARN) of the entity that was used to get the credentials.
principalId (string) --
The unique identifier for the entity that was used to get the credentials.
sessionContext (dict) --
The details of the session that was created for the credentials, including the entity that issued the session.
attributes (dict) --
The date and time when the credentials were issued, and whether the credentials were authenticated with a multi-factor authentication (MFA) device.
creationDate (datetime) --
The date and time, in UTC and ISO 8601 format, when the credentials were issued.
mfaAuthenticated (boolean) --
Specifies whether the credentials were authenticated with a multi-factor authentication (MFA) device.
sessionIssuer (dict) --
The source and type of credentials that were issued to the entity.
accountId (string) --
The unique identifier for the Amazon Web Services account that owns the entity that was used to get the credentials.
arn (string) --
The Amazon Resource Name (ARN) of the source account, IAM user, or role that was used to get the credentials.
principalId (string) --
The unique identifier for the entity that was used to get the credentials.
type (string) --
The source of the temporary security credentials, such as Root, IAMUser, or Role.
userName (string) --
The name or alias of the user or role that issued the session. This value is null if the credentials were obtained from a root account that doesn't have an alias.
awsAccount (dict) --
If the action was performed using the credentials for another Amazon Web Services account, the details of that account.
accountId (string) --
The unique identifier for the Amazon Web Services account.
principalId (string) --
The unique identifier for the entity that performed the action.
awsService (dict) --
If the action was performed by an Amazon Web Services account that belongs to an Amazon Web Service, the name of the service.
invokedBy (string) --
The name of the Amazon Web Service that performed the action.
federatedUser (dict) --
If the action was performed with temporary security credentials that were obtained using the GetFederationToken operation of the Security Token Service (STS) API, the identifiers, session context, and other details about the identity.
accessKeyId (string) --
The Amazon Web Services access key ID that identifies the credentials.
accountId (string) --
The unique identifier for the Amazon Web Services account that owns the entity that was used to get the credentials.
arn (string) --
The Amazon Resource Name (ARN) of the entity that was used to get the credentials.
principalId (string) --
The unique identifier for the entity that was used to get the credentials.
sessionContext (dict) --
The details of the session that was created for the credentials, including the entity that issued the session.
attributes (dict) --
The date and time when the credentials were issued, and whether the credentials were authenticated with a multi-factor authentication (MFA) device.
creationDate (datetime) --
The date and time, in UTC and ISO 8601 format, when the credentials were issued.
mfaAuthenticated (boolean) --
Specifies whether the credentials were authenticated with a multi-factor authentication (MFA) device.
sessionIssuer (dict) --
The source and type of credentials that were issued to the entity.
accountId (string) --
The unique identifier for the Amazon Web Services account that owns the entity that was used to get the credentials.
arn (string) --
The Amazon Resource Name (ARN) of the source account, IAM user, or role that was used to get the credentials.
principalId (string) --
The unique identifier for the entity that was used to get the credentials.
type (string) --
The source of the temporary security credentials, such as Root, IAMUser, or Role.
userName (string) --
The name or alias of the user or role that issued the session. This value is null if the credentials were obtained from a root account that doesn't have an alias.
iamUser (dict) --
If the action was performed using the credentials for an Identity and Access Management (IAM) user, the name and other details about the user.
accountId (string) --
The unique identifier for the Amazon Web Services account that's associated with the IAM user who performed the action.
arn (string) --
The Amazon Resource Name (ARN) of the principal that performed the action. The last section of the ARN contains the name of the user who performed the action.
principalId (string) --
The unique identifier for the IAM user who performed the action.
userName (string) --
The user name of the IAM user who performed the action.
root (dict) --
If the action was performed using the credentials for your Amazon Web Services account, the details of your account.
accountId (string) --
The unique identifier for the Amazon Web Services account.
arn (string) --
The Amazon Resource Name (ARN) of the principal that performed the action. The last section of the ARN contains the name of the user or role that performed the action.
principalId (string) --
The unique identifier for the entity that performed the action.
type (string) --
The type of entity that performed the action.
region (string) --
The Amazon Web Services Region that Amazon Macie created the finding in.
resourcesAffected (dict) --
The resources that the finding applies to.
s3Bucket (dict) --
The details of the S3 bucket that the finding applies to.
allowsUnencryptedObjectUploads (string) --
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 a valid server-side encryption header.
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 a valid server-side encryption header.
UNKNOWN - Amazon Macie can't determine whether the bucket policy requires server-side encryption of new objects.
Valid server-side encryption headers are: x-amz-server-side-encryption with a value of AES256 or aws:kms, and x-amz-server-side-encryption-customer-algorithm with a value of AES256.
arn (string) --
The Amazon Resource Name (ARN) of the bucket.
createdAt (datetime) --
The date and time, in UTC and extended ISO 8601 format, when the bucket was created.
defaultServerSideEncryption (dict) --
The type of server-side encryption that's used by default to encrypt objects in the bucket.
encryptionType (string) --
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.
kmsMasterKeyId (string) --
The Amazon Resource Name (ARN) or unique identifier (key ID) for the KMS key that's used to encrypt data in the bucket or the object. This value is null if an KMS key isn't used to encrypt the data.
name (string) --
The name of the bucket.
owner (dict) --
The display name and canonical user ID for the Amazon Web Services account that owns the bucket.
displayName (string) --
The display name of the account that owns the bucket.
id (string) --
The canonical user ID for the account that owns the bucket.
publicAccess (dict) --
The permissions settings that determine whether the bucket is publicly accessible.
effectivePermission (string) --
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.
permissionConfiguration (dict) --
The account-level and bucket-level permissions settings for the bucket.
accountLevelPermissions (dict) --
The account-level permissions settings that apply to the bucket.
blockPublicAccess (dict) --
The block public access settings for the Amazon Web Services account that owns the bucket.
blockPublicAcls (boolean) --
Specifies whether Amazon S3 blocks public access control lists (ACLs) for the bucket and objects in the bucket.
blockPublicPolicy (boolean) --
Specifies whether Amazon S3 blocks public bucket policies for the bucket.
ignorePublicAcls (boolean) --
Specifies whether Amazon S3 ignores public ACLs for the bucket and objects in the bucket.
restrictPublicBuckets (boolean) --
Specifies whether Amazon S3 restricts public bucket policies for the bucket.
bucketLevelPermissions (dict) --
The bucket-level permissions settings for the bucket.
accessControlList (dict) --
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.
allowsPublicReadAccess (boolean) --
Specifies whether the ACL grants the general public with read access permissions for the bucket.
allowsPublicWriteAccess (boolean) --
Specifies whether the ACL grants the general public with write access permissions for the bucket.
blockPublicAccess (dict) --
The block public access settings for the bucket.
blockPublicAcls (boolean) --
Specifies whether Amazon S3 blocks public access control lists (ACLs) for the bucket and objects in the bucket.
blockPublicPolicy (boolean) --
Specifies whether Amazon S3 blocks public bucket policies for the bucket.
ignorePublicAcls (boolean) --
Specifies whether Amazon S3 ignores public ACLs for the bucket and objects in the bucket.
restrictPublicBuckets (boolean) --
Specifies whether Amazon S3 restricts public bucket policies for the bucket.
bucketPolicy (dict) --
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.
allowsPublicReadAccess (boolean) --
Specifies whether the bucket policy allows the general public to have read access to the bucket.
allowsPublicWriteAccess (boolean) --
Specifies whether the bucket policy allows the general public to have write access to the bucket.
tags (list) --
The tags that are associated with the bucket.
(dict) --
Provides information about the tags that are associated with an S3 bucket or object. Each tag consists of a required tag key and an associated tag value.
key (string) --
One part of a key-value pair that comprises a tag. A tag key is a general label that acts as a category for more specific tag values.
value (string) --
One part of a key-value pair that comprises a tag. A tag value acts as a descriptor for a tag key. A tag value can be an empty string.
s3Object (dict) --
The details of the S3 object that the finding applies to.
bucketArn (string) --
The Amazon Resource Name (ARN) of the bucket that contains the object.
eTag (string) --
The entity tag (ETag) that identifies the affected version of the object. If the object was overwritten or changed after Amazon Macie produced the finding, this value might be different from the current ETag for the object.
extension (string) --
The file name extension of the object. If the object doesn't have a file name extension, this value is "".
key (string) --
The full key (name) that's assigned to the object.
lastModified (datetime) --
The date and time, in UTC and extended ISO 8601 format, when the object was last modified.
path (string) --
The path to the object, including the full key (name).
publicAccess (boolean) --
Specifies whether the object is publicly accessible due to the combination of permissions settings that apply to the object.
serverSideEncryption (dict) --
The type of server-side encryption that's used to encrypt the object.
encryptionType (string) --
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.
kmsMasterKeyId (string) --
The Amazon Resource Name (ARN) or unique identifier (key ID) for the KMS key that's used to encrypt data in the bucket or the object. This value is null if an KMS key isn't used to encrypt the data.
size (integer) --
The total storage size, in bytes, of the object.
storageClass (string) --
The storage class of the object.
tags (list) --
The tags that are associated with the object.
(dict) --
Provides information about the tags that are associated with an S3 bucket or object. Each tag consists of a required tag key and an associated tag value.
key (string) --
One part of a key-value pair that comprises a tag. A tag key is a general label that acts as a category for more specific tag values.
value (string) --
One part of a key-value pair that comprises a tag. A tag value acts as a descriptor for a tag key. A tag value can be an empty string.
versionId (string) --
The identifier for the affected version of the object.
sample (boolean) --
Specifies whether the finding is a sample finding. A sample finding is a finding that uses example data to demonstrate what a finding might contain.
schemaVersion (string) --
The version of the schema that was used to define the data structures in the finding.
severity (dict) --
The severity level and score for the finding.
description (string) --
The qualitative representation of the finding's severity, ranging from Low (least severe) to High (most severe).
score (integer) --
The numerical representation of the finding's severity, ranging from 1 (least severe) to 3 (most severe).
title (string) --
The brief description of the finding.
type (string) --
The type of the finding.
updatedAt (datetime) --
The date and time, in UTC and extended ISO 8601 format, when Amazon Macie last updated the finding. For sensitive data findings, this value is the same as the value for the createdAt property. All sensitive data findings are considered new.
{'records': {'automatedDiscoveryFreeTrialStartDate': 'timestamp',
'usage': {'type': {'AUTOMATED_OBJECT_MONITORING',
'AUTOMATED_SENSITIVE_DATA_DISCOVERY'}}}}
Retrieves (queries) quotas and aggregated usage data for one or more accounts.
See also: AWS API Documentation
Request Syntax
client.get_usage_statistics(
filterBy=[
{
'comparator': 'GT'|'GTE'|'LT'|'LTE'|'EQ'|'NE'|'CONTAINS',
'key': 'accountId'|'serviceLimit'|'freeTrialStartDate'|'total',
'values': [
'string',
]
},
],
maxResults=123,
nextToken='string',
sortBy={
'key': 'accountId'|'total'|'serviceLimitValue'|'freeTrialStartDate',
'orderBy': 'ASC'|'DESC'
},
timeRange='MONTH_TO_DATE'|'PAST_30_DAYS'
)
list
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.
(dict) --
Specifies a condition for filtering the results of a query for quota and usage data for one or more Amazon Macie accounts.
comparator (string) --
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.
key (string) --
The field to use in the condition.
values (list) --
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 Amazon Web Services account.
freeTrialStartDate - The date and time, in UTC and extended ISO 8601 format, when the Amazon Macie 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) --
integer
The maximum number of items to include in each page of the response.
string
The nextToken string that specifies which page of results to return in a paginated response.
dict
The criteria to use to sort the query results.
key (string) --
The field to sort the results by.
orderBy (string) --
The sort order to apply to the results, based on the value for the field specified by the key property. Valid values are: ASC, sort the results in ascending order; and, DESC, sort the results in descending order.
string
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.
dict
Response Syntax
{
'nextToken': 'string',
'records': [
{
'accountId': 'string',
'automatedDiscoveryFreeTrialStartDate': datetime(2015, 1, 1),
'freeTrialStartDate': datetime(2015, 1, 1),
'usage': [
{
'currency': 'USD',
'estimatedCost': 'string',
'serviceLimit': {
'isServiceLimited': True|False,
'unit': 'TERABYTES',
'value': 123
},
'type': 'DATA_INVENTORY_EVALUATION'|'SENSITIVE_DATA_DISCOVERY'|'AUTOMATED_SENSITIVE_DATA_DISCOVERY'|'AUTOMATED_OBJECT_MONITORING'
},
]
},
],
'timeRange': 'MONTH_TO_DATE'|'PAST_30_DAYS'
}
Response Structure
(dict) --
The request succeeded.
nextToken (string) --
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.
records (list) --
An array of objects that contains the results of the query. Each object contains the data for an account that matches the filter criteria specified in the request.
(dict) --
Provides quota and aggregated usage data for an Amazon Macie account.
accountId (string) --
The unique identifier for the Amazon Web Services account that the data applies to.
automatedDiscoveryFreeTrialStartDate (datetime) --
The date and time, in UTC and extended ISO 8601 format, when the free trial of automated sensitive data discovery started for the account. If the account is a member account in an organization, this value is the same as the value for the organization's Amazon Macie administrator account.
freeTrialStartDate (datetime) --
The date and time, in UTC and extended ISO 8601 format, when the Amazon Macie free trial started for the account.
usage (list) --
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.
(dict) --
Provides data for a specific usage metric and the corresponding quota for an Amazon Macie account.
currency (string) --
The type of currency that the value for the metric (estimatedCost) is reported in.
estimatedCost (string) --
The estimated value for the metric.
serviceLimit (dict) --
The current value for the quota that corresponds to the metric specified by the type field.
isServiceLimited (boolean) --
Specifies whether the account has met the quota that corresponds to the metric specified by the UsageByAccount.type field in the response.
unit (string) --
The unit of measurement for the value specified by the value field.
value (integer) --
The value for the metric specified by the UsageByAccount.type field in the response.
type (string) --
The name of the metric. Possible values are: AUTOMATED_OBJECT_MONITORING, to monitor S3 objects for automated sensitive data discovery; AUTOMATED_SENSITIVE_DATA_DISCOVERY, to analyze S3 objects for automated sensitive data discovery; DATA_INVENTORY_EVALUATION, to monitor S3 buckets; and, SENSITIVE_DATA_DISCOVERY, to run classification jobs.
timeRange (string) --
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.
{'usageTotals': {'type': {'AUTOMATED_OBJECT_MONITORING',
'AUTOMATED_SENSITIVE_DATA_DISCOVERY'}}}
Retrieves (queries) aggregated usage data for an account.
See also: AWS API Documentation
Request Syntax
client.get_usage_totals(
timeRange='string'
)
string
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.
dict
Response Syntax
{
'timeRange': 'MONTH_TO_DATE'|'PAST_30_DAYS',
'usageTotals': [
{
'currency': 'USD',
'estimatedCost': 'string',
'type': 'DATA_INVENTORY_EVALUATION'|'SENSITIVE_DATA_DISCOVERY'|'AUTOMATED_SENSITIVE_DATA_DISCOVERY'|'AUTOMATED_OBJECT_MONITORING'
},
]
}
Response Structure
(dict) --
The request succeeded.
timeRange (string) --
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.
usageTotals (list) --
An array of objects that contains the results of the query. Each object contains the data for a specific usage metric.
(dict) --
Provides aggregated data for an Amazon Macie usage metric. The value for the metric reports estimated usage data for an account for the preceding 30 days or the current calendar month to date, depending on the time period (timeRange) specified in the request.
currency (string) --
The type of currency that the value for the metric (estimatedCost) is reported in.
estimatedCost (string) --
The estimated value for the metric.
type (string) --
The name of the metric. Possible values are: AUTOMATED_OBJECT_MONITORING, to monitor S3 objects for automated sensitive data discovery; AUTOMATED_SENSITIVE_DATA_DISCOVERY, to analyze S3 objects for automated sensitive data discovery; DATA_INVENTORY_EVALUATION, to monitor S3 buckets; and, SENSITIVE_DATA_DISCOVERY, to run classification jobs.
{'matchingResources': {'matchingBucket': {'lastAutomatedDiscoveryTime': 'timestamp',
'sensitivityScore': 'integer'}}}
Retrieves (queries) statistical data and other information about Amazon Web Services resources that Amazon Macie monitors and analyzes.
See also: AWS API Documentation
Request Syntax
client.search_resources(
bucketCriteria={
'excludes': {
'and': [
{
'simpleCriterion': {
'comparator': 'EQ'|'NE',
'key': 'ACCOUNT_ID'|'S3_BUCKET_NAME'|'S3_BUCKET_EFFECTIVE_PERMISSION'|'S3_BUCKET_SHARED_ACCESS',
'values': [
'string',
]
},
'tagCriterion': {
'comparator': 'EQ'|'NE',
'tagValues': [
{
'key': 'string',
'value': 'string'
},
]
}
},
]
},
'includes': {
'and': [
{
'simpleCriterion': {
'comparator': 'EQ'|'NE',
'key': 'ACCOUNT_ID'|'S3_BUCKET_NAME'|'S3_BUCKET_EFFECTIVE_PERMISSION'|'S3_BUCKET_SHARED_ACCESS',
'values': [
'string',
]
},
'tagCriterion': {
'comparator': 'EQ'|'NE',
'tagValues': [
{
'key': 'string',
'value': 'string'
},
]
}
},
]
}
},
maxResults=123,
nextToken='string',
sortCriteria={
'attributeName': 'ACCOUNT_ID'|'RESOURCE_NAME'|'S3_CLASSIFIABLE_OBJECT_COUNT'|'S3_CLASSIFIABLE_SIZE_IN_BYTES',
'orderBy': 'ASC'|'DESC'
}
)
dict
The filter conditions that determine which S3 buckets to include or exclude from the query results.
excludes (dict) --
The property- and tag-based conditions that determine which buckets to exclude from the results.
and (list) --
An array of objects, one for each property- or tag-based condition that includes or excludes resources from the query results. If you specify more than one condition, Amazon Macie uses AND logic to join the conditions.
(dict) --
Specifies a property- or tag-based filter condition for including or excluding Amazon Web Services resources from the query results.
simpleCriterion (dict) --
A property-based condition that defines a property, operator, and one or more values for including or excluding resources from the results.
comparator (string) --
The operator to use in the condition. Valid values are EQ (equals) and NE (not equals).
key (string) --
The property to use in the condition.
values (list) --
An array that lists one or more values to use in the condition. If you specify multiple values, Amazon Macie uses OR logic to join the values. Valid values for each supported property (key) are:
ACCOUNT_ID - A string that represents the unique identifier for the Amazon Web Services account that owns the resource.
S3_BUCKET_EFFECTIVE_PERMISSION - A string that represents an enumerated value that Macie defines for the BucketPublicAccess.effectivePermission property of an S3 bucket.
S3_BUCKET_NAME - A string that represents the name of an S3 bucket.
S3_BUCKET_SHARED_ACCESS - A string that represents an enumerated value that Macie defines for the BucketMetadata.sharedAccess property of an S3 bucket.
Values are case sensitive. Also, Macie doesn't support use of partial values or wildcard characters in values.
(string) --
tagCriterion (dict) --
A tag-based condition that defines an operator and tag keys, tag values, or tag key and value pairs for including or excluding resources from the results.
comparator (string) --
The operator to use in the condition. Valid values are EQ (equals) and NE (not equals).
tagValues (list) --
The tag keys, tag values, or tag key and value pairs to use in the condition.
(dict) --
Specifies a tag key, a tag value, or a tag key and value (as a pair) to use in a tag-based filter condition for a query. Tag keys and values are case sensitive. Also, Amazon Macie doesn't support use of partial values or wildcard characters in tag-based filter conditions.
key (string) --
The value for the tag key to use in the condition.
value (string) --
The tag value to use in the condition.
includes (dict) --
The property- and tag-based conditions that determine which buckets to include in the results.
and (list) --
An array of objects, one for each property- or tag-based condition that includes or excludes resources from the query results. If you specify more than one condition, Amazon Macie uses AND logic to join the conditions.
(dict) --
Specifies a property- or tag-based filter condition for including or excluding Amazon Web Services resources from the query results.
simpleCriterion (dict) --
A property-based condition that defines a property, operator, and one or more values for including or excluding resources from the results.
comparator (string) --
The operator to use in the condition. Valid values are EQ (equals) and NE (not equals).
key (string) --
The property to use in the condition.
values (list) --
An array that lists one or more values to use in the condition. If you specify multiple values, Amazon Macie uses OR logic to join the values. Valid values for each supported property (key) are:
ACCOUNT_ID - A string that represents the unique identifier for the Amazon Web Services account that owns the resource.
S3_BUCKET_EFFECTIVE_PERMISSION - A string that represents an enumerated value that Macie defines for the BucketPublicAccess.effectivePermission property of an S3 bucket.
S3_BUCKET_NAME - A string that represents the name of an S3 bucket.
S3_BUCKET_SHARED_ACCESS - A string that represents an enumerated value that Macie defines for the BucketMetadata.sharedAccess property of an S3 bucket.
Values are case sensitive. Also, Macie doesn't support use of partial values or wildcard characters in values.
(string) --
tagCriterion (dict) --
A tag-based condition that defines an operator and tag keys, tag values, or tag key and value pairs for including or excluding resources from the results.
comparator (string) --
The operator to use in the condition. Valid values are EQ (equals) and NE (not equals).
tagValues (list) --
The tag keys, tag values, or tag key and value pairs to use in the condition.
(dict) --
Specifies a tag key, a tag value, or a tag key and value (as a pair) to use in a tag-based filter condition for a query. Tag keys and values are case sensitive. Also, Amazon Macie doesn't support use of partial values or wildcard characters in tag-based filter conditions.
key (string) --
The value for the tag key to use in the condition.
value (string) --
The tag value to use in the condition.
integer
The maximum number of items to include in each page of the response. The default value is 50.
string
The nextToken string that specifies which page of results to return in a paginated response.
dict
The criteria to use to sort the results.
attributeName (string) --
The property to sort the results by.
orderBy (string) --
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.
dict
Response Syntax
{
'matchingResources': [
{
'matchingBucket': {
'accountId': 'string',
'bucketName': 'string',
'classifiableObjectCount': 123,
'classifiableSizeInBytes': 123,
'errorCode': 'ACCESS_DENIED',
'errorMessage': 'string',
'jobDetails': {
'isDefinedInJob': 'TRUE'|'FALSE'|'UNKNOWN',
'isMonitoredByJob': 'TRUE'|'FALSE'|'UNKNOWN',
'lastJobId': 'string',
'lastJobRunTime': datetime(2015, 1, 1)
},
'lastAutomatedDiscoveryTime': datetime(2015, 1, 1),
'objectCount': 123,
'objectCountByEncryptionType': {
'customerManaged': 123,
'kmsManaged': 123,
's3Managed': 123,
'unencrypted': 123,
'unknown': 123
},
'sensitivityScore': 123,
'sizeInBytes': 123,
'sizeInBytesCompressed': 123,
'unclassifiableObjectCount': {
'fileType': 123,
'storageClass': 123,
'total': 123
},
'unclassifiableObjectSizeInBytes': {
'fileType': 123,
'storageClass': 123,
'total': 123
}
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
The request succeeded.
matchingResources (list) --
An array of objects, one for each resource that matches the filter criteria specified in the request.
(dict) --
Provides statistical data and other information about an Amazon Web Services resource that Amazon Macie monitors and analyzes for your account.
matchingBucket (dict) --
The details of an S3 bucket that Amazon Macie monitors and analyzes.
accountId (string) --
The unique identifier for the Amazon Web Services account that owns the bucket.
bucketName (string) --
The name of the bucket.
classifiableObjectCount (integer) --
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.
classifiableSizeInBytes (integer) --
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.
errorCode (string) --
Specifies the error code for an error that prevented Amazon Macie from retrieving and processing information about the bucket and the bucket's objects. If this value is ACCESS_DENIED, Macie doesn't have permission to retrieve the information. For example, the bucket has a restrictive bucket policy and Amazon S3 denied the request. If this value is null, Macie was able to retrieve and process the information.
errorMessage (string) --
A brief description of the error (errorCode) that prevented Amazon Macie from retrieving and processing information about the bucket and the bucket's objects. This value is null if Macie was able to retrieve and process the information.
jobDetails (dict) --
Specifies whether any one-time or recurring classification jobs are configured to analyze objects in the bucket, and, if so, the details of the job that ran most recently.
isDefinedInJob (string) --
Specifies whether any one-time or recurring jobs are configured to analyze data in the bucket. Possible values are:
TRUE - The bucket is explicitly included in the bucket definition (S3BucketDefinitionForJob) for one or more jobs and at least one of those jobs has a status other than CANCELLED. Or the bucket matched the bucket criteria (S3BucketCriteriaForJob) for at least one job that previously ran.
FALSE - The bucket isn't explicitly included in the bucket definition (S3BucketDefinitionForJob) for any jobs, all the jobs that explicitly include the bucket in their bucket definitions have a status of CANCELLED, or the bucket didn't match the bucket criteria (S3BucketCriteriaForJob) for any jobs that previously ran.
UNKNOWN - An exception occurred when Amazon Macie attempted to retrieve job data for the bucket.
isMonitoredByJob (string) --
Specifies whether any recurring jobs are configured to analyze data in the bucket. Possible values are:
TRUE - The bucket is explicitly included in the bucket definition (S3BucketDefinitionForJob) for one or more recurring jobs or the bucket matches the bucket criteria (S3BucketCriteriaForJob) for one or more recurring jobs. At least one of those jobs has a status other than CANCELLED.
FALSE - The bucket isn't explicitly included in the bucket definition (S3BucketDefinitionForJob) for any recurring jobs, the bucket doesn't match the bucket criteria (S3BucketCriteriaForJob) for any recurring jobs, 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.
lastJobId (string) --
The unique identifier for the job that ran most recently and is configured to analyze data in the bucket, either the latest run of a recurring job or the only run of a one-time job.
This value is typically null if the value for the isDefinedInJob property is FALSE or UNKNOWN.
lastJobRunTime (datetime) --
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 typically null if the value for the isDefinedInJob property is FALSE or UNKNOWN.
lastAutomatedDiscoveryTime (datetime) --
The date and time, in UTC and extended ISO 8601 format, when Amazon Macie most recently performed automated sensitive data discovery for the bucket. This value is null if automated sensitive data discovery is currently disabled for your account.
objectCount (integer) --
The total number of objects in the bucket.
objectCountByEncryptionType (dict) --
The total number of objects 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.
customerManaged (integer) --
The total number of objects that are encrypted with a customer-provided key. The objects use customer-provided server-side encryption (SSE-C).
kmsManaged (integer) --
The total number of objects that are encrypted with an KMS key, either an Amazon Web Services managed key or a customer managed key. The objects use KMS encryption (SSE-KMS).
s3Managed (integer) --
The total number of objects that are encrypted with an Amazon S3 managed key. The objects use Amazon S3 managed encryption (SSE-S3).
unencrypted (integer) --
The total number of objects that aren't encrypted or use client-side encryption.
unknown (integer) --
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.
sensitivityScore (integer) --
The current sensitivity score for the bucket, ranging from -1 (no analysis due to an error) to 100 (sensitive). This value is null if automated sensitive data discovery is currently disabled for your account.
sizeInBytes (integer) --
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.
sizeInBytesCompressed (integer) --
The total storage size, in bytes, of the objects that are compressed (.gz, .gzip, .zip) files in the bucket.
If versioning is enabled for the bucket, Amazon 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.
unclassifiableObjectCount (dict) --
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.
fileType (integer) --
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.
storageClass (integer) --
The total storage size (in bytes) or number of objects that Amazon Macie can't analyze because the objects use an unsupported storage class.
total (integer) --
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.
unclassifiableObjectSizeInBytes (dict) --
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.
fileType (integer) --
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.
storageClass (integer) --
The total storage size (in bytes) or number of objects that Amazon Macie can't analyze because the objects use an unsupported storage class.
total (integer) --
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.
nextToken (string) --
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.