aws-sdk-macie2 1.9.0 → 1.14.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -120,15 +120,15 @@ module Aws::Macie2
120
120
  include Aws::Structure
121
121
  end
122
122
 
123
- # Provides information about an account that's designated as a
124
- # delegated administrator of Amazon Macie for an AWS organization.
123
+ # Provides information about the delegated Amazon Macie administrator
124
+ # account for an AWS organization.
125
125
  #
126
126
  # @!attribute [rw] account_id
127
127
  # @return [String]
128
128
  #
129
129
  # @!attribute [rw] status
130
- # The current status of an account as a delegated administrator of
131
- # Amazon Macie for an AWS organization.
130
+ # The current status of an account as the delegated Amazon Macie
131
+ # administrator account for an AWS organization.
132
132
  # @return [String]
133
133
  #
134
134
  # @see http://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01/AdminAccount AWS API Documentation
@@ -350,12 +350,16 @@ module Aws::Macie2
350
350
  # @!attribute [rw] publicly_writable
351
351
  # @return [Integer]
352
352
  #
353
+ # @!attribute [rw] unknown
354
+ # @return [Integer]
355
+ #
353
356
  # @see http://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01/BucketCountByEffectivePermission AWS API Documentation
354
357
  #
355
358
  class BucketCountByEffectivePermission < Struct.new(
356
359
  :publicly_accessible,
357
360
  :publicly_readable,
358
- :publicly_writable)
361
+ :publicly_writable,
362
+ :unknown)
359
363
  SENSITIVE = []
360
364
  include Aws::Structure
361
365
  end
@@ -394,12 +398,16 @@ module Aws::Macie2
394
398
  # @!attribute [rw] not_shared
395
399
  # @return [Integer]
396
400
  #
401
+ # @!attribute [rw] unknown
402
+ # @return [Integer]
403
+ #
397
404
  # @see http://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01/BucketCountBySharedAccessType AWS API Documentation
398
405
  #
399
406
  class BucketCountBySharedAccessType < Struct.new(
400
407
  :external,
401
408
  :internal,
402
- :not_shared)
409
+ :not_shared,
410
+ :unknown)
403
411
  SENSITIVE = []
404
412
  include Aws::Structure
405
413
  end
@@ -455,8 +463,8 @@ module Aws::Macie2
455
463
  include Aws::Structure
456
464
  end
457
465
 
458
- # Provides information about bucket-level permissions settings for an S3
459
- # bucket.
466
+ # Provides information about the bucket-level permissions settings for
467
+ # an S3 bucket.
460
468
  #
461
469
  # @!attribute [rw] access_control_list
462
470
  # Provides information about the permissions settings of the
@@ -508,6 +516,9 @@ module Aws::Macie2
508
516
  # @!attribute [rw] classifiable_object_count
509
517
  # @return [Integer]
510
518
  #
519
+ # @!attribute [rw] classifiable_size_in_bytes
520
+ # @return [Integer]
521
+ #
511
522
  # @!attribute [rw] last_updated
512
523
  # @return [Time]
513
524
  #
@@ -521,7 +532,7 @@ module Aws::Macie2
521
532
  # @return [Types::ObjectCountByEncryptionType]
522
533
  #
523
534
  # @!attribute [rw] public_access
524
- # Provides information about permissions settings that determine
535
+ # Provides information about the permissions settings that determine
525
536
  # whether an S3 bucket is publicly accessible.
526
537
  # @return [Types::BucketPublicAccess]
527
538
  #
@@ -546,6 +557,22 @@ module Aws::Macie2
546
557
  # @!attribute [rw] tags
547
558
  # @return [Array<Types::KeyValuePair>]
548
559
  #
560
+ # @!attribute [rw] unclassifiable_object_count
561
+ # Provides information about the total storage size (in bytes) or
562
+ # number of objects that Amazon Macie can't analyze in one or more S3
563
+ # buckets. In a BucketMetadata object, this data is for a specific
564
+ # bucket. In a GetBucketStatisticsResponse object, this data is
565
+ # aggregated for all the buckets in the query results.
566
+ # @return [Types::ObjectLevelStatistics]
567
+ #
568
+ # @!attribute [rw] unclassifiable_object_size_in_bytes
569
+ # Provides information about the total storage size (in bytes) or
570
+ # number of objects that Amazon Macie can't analyze in one or more S3
571
+ # buckets. In a BucketMetadata object, this data is for a specific
572
+ # bucket. In a GetBucketStatisticsResponse object, this data is
573
+ # aggregated for all the buckets in the query results.
574
+ # @return [Types::ObjectLevelStatistics]
575
+ #
549
576
  # @!attribute [rw] versioning
550
577
  # @return [Boolean]
551
578
  #
@@ -557,6 +584,7 @@ module Aws::Macie2
557
584
  :bucket_created_at,
558
585
  :bucket_name,
559
586
  :classifiable_object_count,
587
+ :classifiable_size_in_bytes,
560
588
  :last_updated,
561
589
  :object_count,
562
590
  :object_count_by_encryption_type,
@@ -567,13 +595,15 @@ module Aws::Macie2
567
595
  :size_in_bytes,
568
596
  :size_in_bytes_compressed,
569
597
  :tags,
598
+ :unclassifiable_object_count,
599
+ :unclassifiable_object_size_in_bytes,
570
600
  :versioning)
571
601
  SENSITIVE = []
572
602
  include Aws::Structure
573
603
  end
574
604
 
575
- # The account-level and bucket-level permissions settings for an S3
576
- # bucket.
605
+ # Provides information about the account-level and bucket-level
606
+ # permissions settings for an S3 bucket.
577
607
  #
578
608
  # @!attribute [rw] account_level_permissions
579
609
  # Provides information about account-level permissions settings that
@@ -581,8 +611,8 @@ module Aws::Macie2
581
611
  # @return [Types::AccountLevelPermissions]
582
612
  #
583
613
  # @!attribute [rw] bucket_level_permissions
584
- # Provides information about bucket-level permissions settings for an
585
- # S3 bucket.
614
+ # Provides information about the bucket-level permissions settings for
615
+ # an S3 bucket.
586
616
  # @return [Types::BucketLevelPermissions]
587
617
  #
588
618
  # @see http://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01/BucketPermissionConfiguration AWS API Documentation
@@ -612,15 +642,15 @@ module Aws::Macie2
612
642
  include Aws::Structure
613
643
  end
614
644
 
615
- # Provides information about permissions settings that determine whether
616
- # an S3 bucket is publicly accessible.
645
+ # Provides information about the permissions settings that determine
646
+ # whether an S3 bucket is publicly accessible.
617
647
  #
618
648
  # @!attribute [rw] effective_permission
619
649
  # @return [String]
620
650
  #
621
651
  # @!attribute [rw] permission_configuration
622
- # The account-level and bucket-level permissions settings for an S3
623
- # bucket.
652
+ # Provides information about the account-level and bucket-level
653
+ # permissions settings for an S3 bucket.
624
654
  # @return [Types::BucketPermissionConfiguration]
625
655
  #
626
656
  # @see http://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01/BucketPublicAccess AWS API Documentation
@@ -658,6 +688,32 @@ module Aws::Macie2
658
688
  include Aws::Structure
659
689
  end
660
690
 
691
+ # Specifies the location of an occurrence of sensitive data in a
692
+ # Microsoft Excel workbook, CSV file, or TSV file.
693
+ #
694
+ # @!attribute [rw] cell_reference
695
+ # @return [String]
696
+ #
697
+ # @!attribute [rw] column
698
+ # @return [Integer]
699
+ #
700
+ # @!attribute [rw] column_name
701
+ # @return [String]
702
+ #
703
+ # @!attribute [rw] row
704
+ # @return [Integer]
705
+ #
706
+ # @see http://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01/Cell AWS API Documentation
707
+ #
708
+ class Cell < Struct.new(
709
+ :cell_reference,
710
+ :column,
711
+ :column_name,
712
+ :row)
713
+ SENSITIVE = []
714
+ include Aws::Structure
715
+ end
716
+
661
717
  # Provides information about a sensitive data finding, including the
662
718
  # classification job that produced the finding.
663
719
  #
@@ -671,9 +727,9 @@ module Aws::Macie2
671
727
  # @return [String]
672
728
  #
673
729
  # @!attribute [rw] result
674
- # Provides detailed information about a sensitive data finding,
675
- # including the types and number of occurrences of the sensitive data
676
- # that was found.
730
+ # Provides the details of a sensitive data finding, including the
731
+ # types, number of occurrences, and locations of the sensitive data
732
+ # that was detected.
677
733
  # @return [Types::ClassificationResult]
678
734
  #
679
735
  # @see http://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01/ClassificationDetails AWS API Documentation
@@ -715,14 +771,17 @@ module Aws::Macie2
715
771
  include Aws::Structure
716
772
  end
717
773
 
718
- # Provides detailed information about a sensitive data finding,
719
- # including the types and number of occurrences of the sensitive data
720
- # that was found.
774
+ # Provides the details of a sensitive data finding, including the types,
775
+ # number of occurrences, and locations of the sensitive data that was
776
+ # detected.
777
+ #
778
+ # @!attribute [rw] additional_occurrences
779
+ # @return [Boolean]
721
780
  #
722
781
  # @!attribute [rw] custom_data_identifiers
723
- # Provides information about the number of occurrences of the data
724
- # that produced a sensitive data finding, and the custom data
725
- # identifiers that detected the data for the finding.
782
+ # Provides information about custom data identifiers that produced a
783
+ # sensitive data finding, and the number of occurrences of the data
784
+ # that they detected for the finding.
726
785
  # @return [Types::CustomDataIdentifiers]
727
786
  #
728
787
  # @!attribute [rw] mime_type
@@ -743,6 +802,7 @@ module Aws::Macie2
743
802
  # @see http://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01/ClassificationResult AWS API Documentation
744
803
  #
745
804
  class ClassificationResult < Struct.new(
805
+ :additional_occurrences,
746
806
  :custom_data_identifiers,
747
807
  :mime_type,
748
808
  :sensitive_data,
@@ -784,10 +844,10 @@ module Aws::Macie2
784
844
  end
785
845
 
786
846
  # Specifies the scope, schedule, and other settings for a classification
787
- # job. You can't delete or change the settings for a classification job
788
- # after you create it. In Amazon Macie, classification jobs are
789
- # immutable. This ensures accurate data classification results for
790
- # audits or investigations.
847
+ # job. You can't change any settings for a classification job after you
848
+ # create it. This helps ensure that you have an immutable history of
849
+ # sensitive data findings and discovery results for data privacy and
850
+ # protection audits or investigations.
791
851
  #
792
852
  # @note When making an API call, you may pass CreateClassificationJobRequest
793
853
  # data as a hash:
@@ -945,9 +1005,9 @@ module Aws::Macie2
945
1005
 
946
1006
  # Specifies the criteria and other settings for a new custom data
947
1007
  # identifier. You can't change a custom data identifier after you
948
- # create it. In Amazon Macie, custom data identifiers are immutable.
949
- # This ensures accurate data classification results for audits or
950
- # investigations.
1008
+ # create it. This helps ensure that you have an immutable history of
1009
+ # sensitive data findings and discovery results for data privacy and
1010
+ # protection audits or investigations.
951
1011
  #
952
1012
  # @note When making an API call, you may pass CreateCustomDataIdentifierRequest
953
1013
  # data as a hash:
@@ -1307,9 +1367,9 @@ module Aws::Macie2
1307
1367
  include Aws::Structure
1308
1368
  end
1309
1369
 
1310
- # Provides information about the number of occurrences of the data that
1311
- # produced a sensitive data finding, and the custom data identifiers
1312
- # that detected the data for the finding.
1370
+ # Provides information about custom data identifiers that produced a
1371
+ # sensitive data finding, and the number of occurrences of the data that
1372
+ # they detected for the finding.
1313
1373
  #
1314
1374
  # @!attribute [rw] detections
1315
1375
  # Provides information about custom data identifiers that produced a
@@ -1330,8 +1390,8 @@ module Aws::Macie2
1330
1390
  end
1331
1391
 
1332
1392
  # Provides information about a custom data identifier that produced a
1333
- # sensitive data finding, and the number of occurrences of the data that
1334
- # it detected for the finding.
1393
+ # sensitive data finding, and the sensitive data that it detected for
1394
+ # the finding.
1335
1395
  #
1336
1396
  # @!attribute [rw] arn
1337
1397
  # @return [String]
@@ -1342,12 +1402,19 @@ module Aws::Macie2
1342
1402
  # @!attribute [rw] name
1343
1403
  # @return [String]
1344
1404
  #
1405
+ # @!attribute [rw] occurrences
1406
+ # Provides the location of 1-15 occurrences of sensitive data that was
1407
+ # detected by managed data identifiers or a custom data identifier and
1408
+ # produced a sensitive data finding.
1409
+ # @return [Types::Occurrences]
1410
+ #
1345
1411
  # @see http://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01/CustomDetection AWS API Documentation
1346
1412
  #
1347
1413
  class CustomDetection < Struct.new(
1348
1414
  :arn,
1349
1415
  :count,
1350
- :name)
1416
+ :name,
1417
+ :occurrences)
1351
1418
  SENSITIVE = []
1352
1419
  include Aws::Structure
1353
1420
  end
@@ -1397,12 +1464,18 @@ module Aws::Macie2
1397
1464
  include Aws::Structure
1398
1465
  end
1399
1466
 
1400
- # Provides information about sensitive data that was detected by managed
1401
- # data identifiers and produced a sensitive data finding.
1467
+ # Provides information about a type of sensitive data that was detected
1468
+ # by managed data identifiers and produced a sensitive data finding.
1402
1469
  #
1403
1470
  # @!attribute [rw] count
1404
1471
  # @return [Integer]
1405
1472
  #
1473
+ # @!attribute [rw] occurrences
1474
+ # Provides the location of 1-15 occurrences of sensitive data that was
1475
+ # detected by managed data identifiers or a custom data identifier and
1476
+ # produced a sensitive data finding.
1477
+ # @return [Types::Occurrences]
1478
+ #
1406
1479
  # @!attribute [rw] type
1407
1480
  # @return [String]
1408
1481
  #
@@ -1410,6 +1483,7 @@ module Aws::Macie2
1410
1483
  #
1411
1484
  class DefaultDetection < Struct.new(
1412
1485
  :count,
1486
+ :occurrences,
1413
1487
  :type)
1414
1488
  SENSITIVE = []
1415
1489
  include Aws::Structure
@@ -1633,7 +1707,7 @@ module Aws::Macie2
1633
1707
  # @return [String]
1634
1708
  #
1635
1709
  # @!attribute [rw] job_status
1636
- # The current status of a classification job. Possible values are:
1710
+ # The status of a classification job. Possible values are:
1637
1711
  # @return [String]
1638
1712
  #
1639
1713
  # @!attribute [rw] job_type
@@ -1668,6 +1742,13 @@ module Aws::Macie2
1668
1742
  # findings filter, or member account.
1669
1743
  # @return [Hash<String,String>]
1670
1744
  #
1745
+ # @!attribute [rw] user_paused_details
1746
+ # Provides information about when a classification job was paused and
1747
+ # when it will expire and be cancelled if it isn’t resumed. This
1748
+ # object is present only if a job’s current status (jobStatus) is
1749
+ # USER\_PAUSED.
1750
+ # @return [Types::UserPausedDetails]
1751
+ #
1671
1752
  # @see http://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01/DescribeClassificationJobResponse AWS API Documentation
1672
1753
  #
1673
1754
  class DescribeClassificationJobResponse < Struct.new(
@@ -1686,7 +1767,8 @@ module Aws::Macie2
1686
1767
  :sampling_percentage,
1687
1768
  :schedule_frequency,
1688
1769
  :statistics,
1689
- :tags)
1770
+ :tags,
1771
+ :user_paused_details)
1690
1772
  SENSITIVE = []
1691
1773
  include Aws::Structure
1692
1774
  end
@@ -1842,9 +1924,9 @@ module Aws::Macie2
1842
1924
  #
1843
1925
  class EnableMacieResponse < Aws::EmptyStructure; end
1844
1926
 
1845
- # Specifies an account to designate as a delegated administrator of
1846
- # Amazon Macie for an AWS organization. To submit this request, you must
1847
- # be a user of the master account for the AWS organization.
1927
+ # Specifies an account to designate as a delegated Amazon Macie
1928
+ # administrator account for an AWS organization. To submit this request,
1929
+ # you must be a user of the management account for the AWS organization.
1848
1930
  #
1849
1931
  # @note When making an API call, you may pass EnableOrganizationAdminAccountRequest
1850
1932
  # data as a hash:
@@ -1909,7 +1991,7 @@ module Aws::Macie2
1909
1991
  include Aws::Structure
1910
1992
  end
1911
1993
 
1912
- # Provides information about a finding.
1994
+ # Provides the details of a finding.
1913
1995
  #
1914
1996
  # @!attribute [rw] account_id
1915
1997
  # @return [String]
@@ -1959,15 +2041,21 @@ module Aws::Macie2
1959
2041
  # @return [String]
1960
2042
  #
1961
2043
  # @!attribute [rw] severity
1962
- # Provides the numeric score and textual representation of a severity
1963
- # value.
2044
+ # Provides the numerical and qualitative representations of a
2045
+ # finding's severity.
1964
2046
  # @return [Types::Severity]
1965
2047
  #
1966
2048
  # @!attribute [rw] title
1967
2049
  # @return [String]
1968
2050
  #
1969
2051
  # @!attribute [rw] type
1970
- # The type of finding. Valid values are:
2052
+ # The type of finding. For details about each type, see [Types of
2053
+ # Amazon Macie findings][1] in the *Amazon Macie User Guide*. Valid
2054
+ # values are:
2055
+ #
2056
+ #
2057
+ #
2058
+ # [1]: https://docs.aws.amazon.com/macie/latest/user/findings-types.html
1971
2059
  # @return [String]
1972
2060
  #
1973
2061
  # @!attribute [rw] updated_at
@@ -2142,8 +2230,8 @@ module Aws::Macie2
2142
2230
  include Aws::Structure
2143
2231
  end
2144
2232
 
2145
- # Specifies an account that's associated with the S3 buckets to
2146
- # retrieve aggregated statistical data for.
2233
+ # Specifies the account that owns the S3 buckets to retrieve aggregated
2234
+ # statistical data for.
2147
2235
  #
2148
2236
  # @note When making an API call, you may pass GetBucketStatisticsRequest
2149
2237
  # data as a hash:
@@ -2164,8 +2252,7 @@ module Aws::Macie2
2164
2252
  end
2165
2253
 
2166
2254
  # Provides the results of a query that retrieved aggregated statistical
2167
- # data for all the S3 buckets that Amazon Macie monitors and analyzes
2168
- # for an account.
2255
+ # data for the S3 buckets that are owned by an account.
2169
2256
  #
2170
2257
  # @!attribute [rw] bucket_count
2171
2258
  # @return [Integer]
@@ -2190,6 +2277,9 @@ module Aws::Macie2
2190
2277
  # @!attribute [rw] classifiable_object_count
2191
2278
  # @return [Integer]
2192
2279
  #
2280
+ # @!attribute [rw] classifiable_size_in_bytes
2281
+ # @return [Integer]
2282
+ #
2193
2283
  # @!attribute [rw] last_updated
2194
2284
  # @return [Time]
2195
2285
  #
@@ -2202,6 +2292,22 @@ module Aws::Macie2
2202
2292
  # @!attribute [rw] size_in_bytes_compressed
2203
2293
  # @return [Integer]
2204
2294
  #
2295
+ # @!attribute [rw] unclassifiable_object_count
2296
+ # Provides information about the total storage size (in bytes) or
2297
+ # number of objects that Amazon Macie can't analyze in one or more S3
2298
+ # buckets. In a BucketMetadata object, this data is for a specific
2299
+ # bucket. In a GetBucketStatisticsResponse object, this data is
2300
+ # aggregated for all the buckets in the query results.
2301
+ # @return [Types::ObjectLevelStatistics]
2302
+ #
2303
+ # @!attribute [rw] unclassifiable_object_size_in_bytes
2304
+ # Provides information about the total storage size (in bytes) or
2305
+ # number of objects that Amazon Macie can't analyze in one or more S3
2306
+ # buckets. In a BucketMetadata object, this data is for a specific
2307
+ # bucket. In a GetBucketStatisticsResponse object, this data is
2308
+ # aggregated for all the buckets in the query results.
2309
+ # @return [Types::ObjectLevelStatistics]
2310
+ #
2205
2311
  # @see http://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01/GetBucketStatisticsResponse AWS API Documentation
2206
2312
  #
2207
2313
  class GetBucketStatisticsResponse < Struct.new(
@@ -2210,10 +2316,13 @@ module Aws::Macie2
2210
2316
  :bucket_count_by_encryption_type,
2211
2317
  :bucket_count_by_shared_access_type,
2212
2318
  :classifiable_object_count,
2319
+ :classifiable_size_in_bytes,
2213
2320
  :last_updated,
2214
2321
  :object_count,
2215
2322
  :size_in_bytes,
2216
- :size_in_bytes_compressed)
2323
+ :size_in_bytes_compressed,
2324
+ :unclassifiable_object_count,
2325
+ :unclassifiable_object_size_in_bytes)
2217
2326
  SENSITIVE = []
2218
2327
  include Aws::Structure
2219
2328
  end
@@ -2454,7 +2563,7 @@ module Aws::Macie2
2454
2563
  include Aws::Structure
2455
2564
  end
2456
2565
 
2457
- # Specifies one or more findings to retrieve information about.
2566
+ # Specifies one or more findings to retrieve.
2458
2567
  #
2459
2568
  # @note When making an API call, you may pass GetFindingsRequest
2460
2569
  # data as a hash:
@@ -2472,7 +2581,7 @@ module Aws::Macie2
2472
2581
  #
2473
2582
  # @!attribute [rw] sort_criteria
2474
2583
  # Specifies criteria for sorting the results of a request for
2475
- # information about findings.
2584
+ # findings.
2476
2585
  # @return [Types::SortCriteria]
2477
2586
  #
2478
2587
  # @see http://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01/GetFindingsRequest AWS API Documentation
@@ -2484,8 +2593,7 @@ module Aws::Macie2
2484
2593
  include Aws::Structure
2485
2594
  end
2486
2595
 
2487
- # Provides the results of a request for information about one or more
2488
- # findings.
2596
+ # Provides the results of a request for one or more findings.
2489
2597
  #
2490
2598
  # @!attribute [rw] findings
2491
2599
  # @return [Array<Types::Finding>]
@@ -3022,6 +3130,8 @@ module Aws::Macie2
3022
3130
 
3023
3131
  # Specifies one or more property- and tag-based conditions that define
3024
3132
  # criteria for including or excluding objects from a classification job.
3133
+ # If you specify more than one condition, Amazon Macie uses an AND
3134
+ # operator to join the conditions.
3025
3135
  #
3026
3136
  # @note When making an API call, you may pass JobScopingBlock
3027
3137
  # data as a hash:
@@ -3073,7 +3183,7 @@ module Aws::Macie2
3073
3183
  # @return [String]
3074
3184
  #
3075
3185
  # @!attribute [rw] job_status
3076
- # The current status of a classification job. Possible values are:
3186
+ # The status of a classification job. Possible values are:
3077
3187
  # @return [String]
3078
3188
  #
3079
3189
  # @!attribute [rw] job_type
@@ -3083,6 +3193,13 @@ module Aws::Macie2
3083
3193
  # @!attribute [rw] name
3084
3194
  # @return [String]
3085
3195
  #
3196
+ # @!attribute [rw] user_paused_details
3197
+ # Provides information about when a classification job was paused and
3198
+ # when it will expire and be cancelled if it isn’t resumed. This
3199
+ # object is present only if a job’s current status (jobStatus) is
3200
+ # USER\_PAUSED.
3201
+ # @return [Types::UserPausedDetails]
3202
+ #
3086
3203
  # @see http://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01/JobSummary AWS API Documentation
3087
3204
  #
3088
3205
  class JobSummary < Struct.new(
@@ -3091,7 +3208,8 @@ module Aws::Macie2
3091
3208
  :job_id,
3092
3209
  :job_status,
3093
3210
  :job_type,
3094
- :name)
3211
+ :name,
3212
+ :user_paused_details)
3095
3213
  SENSITIVE = []
3096
3214
  include Aws::Structure
3097
3215
  end
@@ -3315,7 +3433,7 @@ module Aws::Macie2
3315
3433
  #
3316
3434
  # @!attribute [rw] sort_criteria
3317
3435
  # Specifies criteria for sorting the results of a request for
3318
- # information about findings.
3436
+ # findings.
3319
3437
  # @return [Types::SortCriteria]
3320
3438
  #
3321
3439
  # @see http://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01/ListFindingsRequest AWS API Documentation
@@ -3556,8 +3674,8 @@ module Aws::Macie2
3556
3674
  include Aws::Structure
3557
3675
  end
3558
3676
 
3559
- # Provides information about the accounts that are designated as
3560
- # delegated administrators of Amazon Macie for an AWS organization.
3677
+ # Provides information about the delegated Amazon Macie administrator
3678
+ # accounts for an AWS organization.
3561
3679
  #
3562
3680
  # @!attribute [rw] admin_accounts
3563
3681
  # @return [Array<Types::AdminAccount>]
@@ -3706,6 +3824,102 @@ module Aws::Macie2
3706
3824
  include Aws::Structure
3707
3825
  end
3708
3826
 
3827
+ # Provides information about the total storage size (in bytes) or number
3828
+ # of objects that Amazon Macie can't analyze in one or more S3 buckets.
3829
+ # In a BucketMetadata object, this data is for a specific bucket. In a
3830
+ # GetBucketStatisticsResponse object, this data is aggregated for all
3831
+ # the buckets in the query results.
3832
+ #
3833
+ # @!attribute [rw] file_type
3834
+ # @return [Integer]
3835
+ #
3836
+ # @!attribute [rw] storage_class
3837
+ # @return [Integer]
3838
+ #
3839
+ # @!attribute [rw] total
3840
+ # @return [Integer]
3841
+ #
3842
+ # @see http://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01/ObjectLevelStatistics AWS API Documentation
3843
+ #
3844
+ class ObjectLevelStatistics < Struct.new(
3845
+ :file_type,
3846
+ :storage_class,
3847
+ :total)
3848
+ SENSITIVE = []
3849
+ include Aws::Structure
3850
+ end
3851
+
3852
+ # Provides the location of 1-15 occurrences of sensitive data that was
3853
+ # detected by managed data identifiers or a custom data identifier and
3854
+ # produced a sensitive data finding.
3855
+ #
3856
+ # @!attribute [rw] cells
3857
+ # Specifies the location of occurrences of sensitive data in a
3858
+ # Microsoft Excel workbook, CSV file, or TSV file.
3859
+ # @return [Array<Types::Cell>]
3860
+ #
3861
+ # @!attribute [rw] line_ranges
3862
+ # Provides details about the location of occurrences of sensitive data
3863
+ # in an Adobe Portable Document Format file, Apache Avro object
3864
+ # container, Microsoft Word document, or non-binary text file.
3865
+ # @return [Array<Types::Range>]
3866
+ #
3867
+ # @!attribute [rw] offset_ranges
3868
+ # Provides details about the location of occurrences of sensitive data
3869
+ # in an Adobe Portable Document Format file, Apache Avro object
3870
+ # container, Microsoft Word document, or non-binary text file.
3871
+ # @return [Array<Types::Range>]
3872
+ #
3873
+ # @!attribute [rw] pages
3874
+ # Specifies the location of occurrences of sensitive data in an Adobe
3875
+ # Portable Document Format file.
3876
+ # @return [Array<Types::Page>]
3877
+ #
3878
+ # @!attribute [rw] records
3879
+ # Specifies the location of occurrences of sensitive data in an Apache
3880
+ # Parquet file.
3881
+ # @return [Array<Types::Record>]
3882
+ #
3883
+ # @see http://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01/Occurrences AWS API Documentation
3884
+ #
3885
+ class Occurrences < Struct.new(
3886
+ :cells,
3887
+ :line_ranges,
3888
+ :offset_ranges,
3889
+ :pages,
3890
+ :records)
3891
+ SENSITIVE = []
3892
+ include Aws::Structure
3893
+ end
3894
+
3895
+ # Specifies the location of an occurrence of sensitive data in an Adobe
3896
+ # Portable Document Format file.
3897
+ #
3898
+ # @!attribute [rw] line_range
3899
+ # Provides details about the location of an occurrence of sensitive
3900
+ # data in an Adobe Portable Document Format file, Apache Avro object
3901
+ # container, Microsoft Word document, or non-binary text file.
3902
+ # @return [Types::Range]
3903
+ #
3904
+ # @!attribute [rw] offset_range
3905
+ # Provides details about the location of an occurrence of sensitive
3906
+ # data in an Adobe Portable Document Format file, Apache Avro object
3907
+ # container, Microsoft Word document, or non-binary text file.
3908
+ # @return [Types::Range]
3909
+ #
3910
+ # @!attribute [rw] page_number
3911
+ # @return [Integer]
3912
+ #
3913
+ # @see http://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01/Page AWS API Documentation
3914
+ #
3915
+ class Page < Struct.new(
3916
+ :line_range,
3917
+ :offset_range,
3918
+ :page_number)
3919
+ SENSITIVE = []
3920
+ include Aws::Structure
3921
+ end
3922
+
3709
3923
  # Provides the details of a policy finding.
3710
3924
  #
3711
3925
  # @!attribute [rw] action
@@ -3777,6 +3991,43 @@ module Aws::Macie2
3777
3991
  include Aws::Structure
3778
3992
  end
3779
3993
 
3994
+ # Provides details about the location of an occurrence of sensitive data
3995
+ # in an Adobe Portable Document Format file, Apache Avro object
3996
+ # container, Microsoft Word document, or non-binary text file.
3997
+ #
3998
+ # @!attribute [rw] end
3999
+ # @return [Integer]
4000
+ #
4001
+ # @!attribute [rw] start
4002
+ # @return [Integer]
4003
+ #
4004
+ # @!attribute [rw] start_column
4005
+ # @return [Integer]
4006
+ #
4007
+ # @see http://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01/Range AWS API Documentation
4008
+ #
4009
+ class Range < Struct.new(
4010
+ :end,
4011
+ :start,
4012
+ :start_column)
4013
+ SENSITIVE = []
4014
+ include Aws::Structure
4015
+ end
4016
+
4017
+ # Specifies the location of an occurrence of sensitive data in an Apache
4018
+ # Parquet file.
4019
+ #
4020
+ # @!attribute [rw] record_index
4021
+ # @return [Integer]
4022
+ #
4023
+ # @see http://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01/Record AWS API Documentation
4024
+ #
4025
+ class Record < Struct.new(
4026
+ :record_index)
4027
+ SENSITIVE = []
4028
+ include Aws::Structure
4029
+ end
4030
+
3780
4031
  # Provides information about settings that define whether one or more
3781
4032
  # objects in an S3 bucket are replicated to S3 buckets for other AWS
3782
4033
  # accounts and, if so, which accounts.
@@ -3843,7 +4094,7 @@ module Aws::Macie2
3843
4094
  #
3844
4095
  # @!attribute [rw] default_server_side_encryption
3845
4096
  # Provides information about the server-side encryption settings for
3846
- # an S3 bucket or object.
4097
+ # an S3 bucket or S3 object.
3847
4098
  # @return [Types::ServerSideEncryption]
3848
4099
  #
3849
4100
  # @!attribute [rw] name
@@ -3854,7 +4105,7 @@ module Aws::Macie2
3854
4105
  # @return [Types::S3BucketOwner]
3855
4106
  #
3856
4107
  # @!attribute [rw] public_access
3857
- # Provides information about permissions settings that determine
4108
+ # Provides information about the permissions settings that determine
3858
4109
  # whether an S3 bucket is publicly accessible.
3859
4110
  # @return [Types::BucketPublicAccess]
3860
4111
  #
@@ -4019,7 +4270,8 @@ module Aws::Macie2
4019
4270
  # @!attribute [rw] scoping
4020
4271
  # Specifies one or more property- and tag-based conditions that refine
4021
4272
  # the scope of a classification job. These conditions define criteria
4022
- # that determine which objects a job analyzes.
4273
+ # that determine which objects a job analyzes. Exclude conditions take
4274
+ # precedence over include conditions.
4023
4275
  # @return [Types::Scoping]
4024
4276
  #
4025
4277
  # @see http://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01/S3JobDefinition AWS API Documentation
@@ -4056,14 +4308,14 @@ module Aws::Macie2
4056
4308
  #
4057
4309
  # @!attribute [rw] server_side_encryption
4058
4310
  # Provides information about the server-side encryption settings for
4059
- # an S3 bucket or object.
4311
+ # an S3 bucket or S3 object.
4060
4312
  # @return [Types::ServerSideEncryption]
4061
4313
  #
4062
4314
  # @!attribute [rw] size
4063
4315
  # @return [Integer]
4064
4316
  #
4065
4317
  # @!attribute [rw] storage_class
4066
- # The storage class of the S3 bucket or object. Possible values are:
4318
+ # The storage class of the S3 object. Possible values are:
4067
4319
  # @return [String]
4068
4320
  #
4069
4321
  # @!attribute [rw] tags
@@ -4096,7 +4348,8 @@ module Aws::Macie2
4096
4348
 
4097
4349
  # Specifies one or more property- and tag-based conditions that refine
4098
4350
  # the scope of a classification job. These conditions define criteria
4099
- # that determine which objects a job analyzes.
4351
+ # that determine which objects a job analyzes. Exclude conditions take
4352
+ # precedence over include conditions.
4100
4353
  #
4101
4354
  # @note When making an API call, you may pass Scoping
4102
4355
  # data as a hash:
@@ -4151,13 +4404,15 @@ module Aws::Macie2
4151
4404
  # @!attribute [rw] excludes
4152
4405
  # Specifies one or more property- and tag-based conditions that define
4153
4406
  # criteria for including or excluding objects from a classification
4154
- # job.
4407
+ # job. If you specify more than one condition, Amazon Macie uses an
4408
+ # AND operator to join the conditions.
4155
4409
  # @return [Types::JobScopingBlock]
4156
4410
  #
4157
4411
  # @!attribute [rw] includes
4158
4412
  # Specifies one or more property- and tag-based conditions that define
4159
4413
  # criteria for including or excluding objects from a classification
4160
- # job.
4414
+ # job. If you specify more than one condition, Amazon Macie uses an
4415
+ # AND operator to join the conditions.
4161
4416
  # @return [Types::JobScopingBlock]
4162
4417
  #
4163
4418
  # @see http://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01/Scoping AWS API Documentation
@@ -4169,8 +4424,8 @@ module Aws::Macie2
4169
4424
  include Aws::Structure
4170
4425
  end
4171
4426
 
4172
- # Provides information about the category, type, and number of
4173
- # occurrences of sensitive data that produced a finding.
4427
+ # Provides information about the category, types, and occurrences of
4428
+ # sensitive data that produced a sensitive data finding.
4174
4429
  #
4175
4430
  # @!attribute [rw] category
4176
4431
  # The category of sensitive data that was detected and produced the
@@ -4198,11 +4453,11 @@ module Aws::Macie2
4198
4453
  end
4199
4454
 
4200
4455
  # Provides information about the server-side encryption settings for an
4201
- # S3 bucket or object.
4456
+ # S3 bucket or S3 object.
4202
4457
  #
4203
4458
  # @!attribute [rw] encryption_type
4204
- # The type of server-side encryption that's used to encrypt objects
4205
- # in the S3 bucket. Valid values are:
4459
+ # The type of server-side encryption that's used to encrypt an S3
4460
+ # object or objects in an S3 bucket. Valid values are:
4206
4461
  # @return [String]
4207
4462
  #
4208
4463
  # @!attribute [rw] kms_master_key_id
@@ -4322,11 +4577,11 @@ module Aws::Macie2
4322
4577
  include Aws::Structure
4323
4578
  end
4324
4579
 
4325
- # Provides the numeric score and textual representation of a severity
4326
- # value.
4580
+ # Provides the numerical and qualitative representations of a finding's
4581
+ # severity.
4327
4582
  #
4328
4583
  # @!attribute [rw] description
4329
- # The textual representation of the finding's severity. Possible
4584
+ # The qualitative representation of the finding's severity. Possible
4330
4585
  # values are:
4331
4586
  # @return [String]
4332
4587
  #
@@ -4376,8 +4631,7 @@ module Aws::Macie2
4376
4631
  include Aws::Structure
4377
4632
  end
4378
4633
 
4379
- # Specifies criteria for sorting the results of a request for
4380
- # information about findings.
4634
+ # Specifies criteria for sorting the results of a request for findings.
4381
4635
  #
4382
4636
  # @note When making an API call, you may pass SortCriteria
4383
4637
  # data as a hash:
@@ -4501,7 +4755,7 @@ module Aws::Macie2
4501
4755
  include Aws::Structure
4502
4756
  end
4503
4757
 
4504
- # Specifies a tag key and value, as a pair, to use in a tag-based
4758
+ # Specifies a tag key or tag key and value pair to use in a tag-based
4505
4759
  # condition for a classification job.
4506
4760
  #
4507
4761
  # @note When making an API call, you may pass TagValuePair
@@ -4647,21 +4901,21 @@ module Aws::Macie2
4647
4901
  #
4648
4902
  class UntagResourceResponse < Aws::EmptyStructure; end
4649
4903
 
4650
- # Cancels a classification job.
4904
+ # Changes the status of a classification job.
4651
4905
  #
4652
4906
  # @note When making an API call, you may pass UpdateClassificationJobRequest
4653
4907
  # data as a hash:
4654
4908
  #
4655
4909
  # {
4656
4910
  # job_id: "__string", # required
4657
- # job_status: "RUNNING", # required, accepts RUNNING, PAUSED, CANCELLED, COMPLETE, IDLE
4911
+ # job_status: "RUNNING", # required, accepts RUNNING, PAUSED, CANCELLED, COMPLETE, IDLE, USER_PAUSED
4658
4912
  # }
4659
4913
  #
4660
4914
  # @!attribute [rw] job_id
4661
4915
  # @return [String]
4662
4916
  #
4663
4917
  # @!attribute [rw] job_status
4664
- # The current status of a classification job. Possible values are:
4918
+ # The status of a classification job. Possible values are:
4665
4919
  # @return [String]
4666
4920
  #
4667
4921
  # @see http://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01/UpdateClassificationJobRequest AWS API Documentation
@@ -5067,6 +5321,29 @@ module Aws::Macie2
5067
5321
  include Aws::Structure
5068
5322
  end
5069
5323
 
5324
+ # Provides information about when a classification job was paused and
5325
+ # when it will expire and be cancelled if it isn’t resumed. This object
5326
+ # is present only if a job’s current status (jobStatus) is USER\_PAUSED.
5327
+ #
5328
+ # @!attribute [rw] job_expires_at
5329
+ # @return [Time]
5330
+ #
5331
+ # @!attribute [rw] job_imminent_expiration_health_event_arn
5332
+ # @return [String]
5333
+ #
5334
+ # @!attribute [rw] job_paused_at
5335
+ # @return [Time]
5336
+ #
5337
+ # @see http://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01/UserPausedDetails AWS API Documentation
5338
+ #
5339
+ class UserPausedDetails < Struct.new(
5340
+ :job_expires_at,
5341
+ :job_imminent_expiration_health_event_arn,
5342
+ :job_paused_at)
5343
+ SENSITIVE = []
5344
+ include Aws::Structure
5345
+ end
5346
+
5070
5347
  # Provides information about an error that occurred due to a syntax
5071
5348
  # error in a request.
5072
5349
  #