-
Notifications
You must be signed in to change notification settings - Fork 2.1k
/
docs-2.json
1769 lines (1769 loc) · 150 KB
/
docs-2.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"version" : "2.0",
"service" : "<p>Amazon Macie is a fully managed data security and data privacy service that uses machine learning and pattern matching to discover and protect your sensitive data in AWS. Macie automates the discovery of sensitive data, such as PII and intellectual property, to provide you with insight into the data that your organization stores in AWS. Macie also provides an inventory of your Amazon S3 buckets, which it continually monitors for you. If Macie detects sensitive data or potential data access issues, it generates detailed findings for you to review and act upon as necessary.</p>",
"operations" : {
"AcceptInvitation" : "<p>Accepts an Amazon Macie membership invitation that was received from a specific account.</p>",
"BatchGetCustomDataIdentifiers" : "<p>Retrieves information about one or more custom data identifiers.</p>",
"CreateClassificationJob" : " <p>Creates and defines the settings for a classification job.</p>",
"CreateCustomDataIdentifier" : "<p>Creates and defines the criteria and other settings for a custom data identifier.</p>",
"CreateFindingsFilter" : "<p>Creates and defines the criteria and other settings for a findings filter.</p>",
"CreateInvitations" : " <p>Sends an Amazon Macie membership invitation to one or more accounts.</p>",
"CreateMember" : " <p>Associates an account with an Amazon Macie master account.</p>",
"CreateSampleFindings" : " <p>Creates sample findings.</p>",
"DeclineInvitations" : "<p>Declines Amazon Macie membership invitations that were received from specific accounts.</p>",
"DeleteCustomDataIdentifier" : "<p>Soft deletes a custom data identifier.</p>",
"DeleteFindingsFilter" : "<p>Deletes a findings filter.</p>",
"DeleteInvitations" : "<p>Deletes Amazon Macie membership invitations that were received from specific accounts.</p>",
"DeleteMember" : "<p>Deletes the association between an Amazon Macie master account and an account.</p>",
"DescribeBuckets" : " <p>Retrieves (queries) statistical data and other information about one or more S3 buckets that Amazon Macie monitors and analyzes.</p>",
"DescribeClassificationJob" : "<p>Retrieves the status and settings for a classification job.</p>",
"DescribeOrganizationConfiguration" : "<p>Retrieves the Amazon Macie configuration settings for an AWS organization.</p>",
"DisableMacie" : "<p>Disables an Amazon Macie account and deletes Macie resources for the account.</p>",
"DisableOrganizationAdminAccount" : "<p>Disables an account as the delegated Amazon Macie administrator account for an AWS organization.</p>",
"DisassociateFromMasterAccount" : "<p>Disassociates a member account from its Amazon Macie master account.</p>",
"DisassociateMember" : "<p>Disassociates an Amazon Macie master account from a member account.</p>",
"EnableMacie" : "<p>Enables Amazon Macie and specifies the configuration settings for a Macie account.</p>",
"EnableOrganizationAdminAccount" : "<p>Designates an account as the delegated Amazon Macie administrator account for an AWS organization.</p>",
"GetBucketStatistics" : " <p>Retrieves (queries) aggregated statistical data for all the S3 buckets that Amazon Macie monitors and analyzes.</p>",
"GetClassificationExportConfiguration" : "<p>Retrieves the configuration settings for storing data classification results.</p>",
"GetCustomDataIdentifier" : "<p>Retrieves the criteria and other settings for a custom data identifier.</p>",
"GetFindingStatistics" : " <p>Retrieves (queries) aggregated statistical data about findings.</p>",
"GetFindings" : "<p>Retrieves the details of one or more findings.</p>",
"GetFindingsFilter" : "<p>Retrieves the criteria and other settings for a findings filter.</p>",
"GetInvitationsCount" : "<p>Retrieves the count of Amazon Macie membership invitations that were received by an account.</p>",
"GetMacieSession" : "<p>Retrieves the current status and configuration settings for an Amazon Macie account.</p>",
"GetMasterAccount" : "<p>Retrieves information about the Amazon Macie master account for an account.</p>",
"GetMember" : "<p>Retrieves information about a member account that's associated with an Amazon Macie master account.</p>",
"GetUsageStatistics" : "<p>Retrieves (queries) quotas and aggregated usage data for one or more accounts.</p>",
"GetUsageTotals" : "<p>Retrieves (queries) aggregated usage data for an account.</p>",
"ListClassificationJobs" : "<p>Retrieves a subset of information about one or more classification jobs.</p>",
"ListCustomDataIdentifiers" : "<p>Retrieves a subset of information about all the custom data identifiers for an account.</p>",
"ListFindings" : " <p>Retrieves a subset of information about one or more findings.</p>",
"ListFindingsFilters" : "<p>Retrieves a subset of information about all the findings filters for an account.</p>",
"ListInvitations" : "<p>Retrieves information about all the Amazon Macie membership invitations that were received by an account.</p>",
"ListMembers" : "<p>Retrieves information about the accounts that are associated with an Amazon Macie master account.</p>",
"ListOrganizationAdminAccounts" : "<p>Retrieves information about the delegated Amazon Macie administrator account for an AWS organization.</p>",
"ListTagsForResource" : "<p>Retrieves the tags (keys and values) that are associated with a classification job, custom data identifier, findings filter, or member account.</p>",
"PutClassificationExportConfiguration" : "<p>Creates or updates the configuration settings for storing data classification results.</p>",
"TagResource" : "<p>Adds or updates one or more tags (keys and values) that are associated with a classification job, custom data identifier, findings filter, or member account.</p>",
"TestCustomDataIdentifier" : "<p>Tests a custom data identifier.</p>",
"UntagResource" : "<p>Removes one or more tags (keys and values) from a classification job, custom data identifier, findings filter, or member account.</p>",
"UpdateClassificationJob" : "<p>Changes the status of a classification job.</p>",
"UpdateFindingsFilter" : "<p>Updates the criteria and other settings for a findings filter.</p>",
"UpdateMacieSession" : "<p>Suspends or re-enables an Amazon Macie account, or updates the configuration settings for a Macie account.</p>",
"UpdateMemberSession" : " <p>Enables an Amazon Macie master account to suspend or re-enable a member account.</p>",
"UpdateOrganizationConfiguration" : "<p>Updates the Amazon Macie configuration settings for an AWS organization.</p>"
},
"shapes" : {
"AcceptInvitationRequest" : {
"base" : "<p>Specifies an Amazon Macie membership invitation to accept.</p>",
"refs" : { }
},
"AccessControlList" : {
"base" : "<p>Provides information about the permissions settings of the bucket-level access control list (ACL) for an S3 bucket.</p>",
"refs" : {
"BucketLevelPermissions$AccessControlList" : "<p>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.</p>"
}
},
"AccessDeniedException" : {
"base" : "<p>Provides information about an error that occurred due to insufficient access to a specified resource.</p>",
"refs" : { }
},
"AccountDetail" : {
"base" : "<p>Specifies details for an account to associate with an Amazon Macie master account.</p>",
"refs" : {
"CreateMemberRequest$Account" : "<p>The details for the account to associate with the master account.</p>"
}
},
"AccountLevelPermissions" : {
"base" : "<p>Provides information about account-level permissions settings that apply to an S3 bucket.</p>",
"refs" : {
"BucketPermissionConfiguration$AccountLevelPermissions" : "<p>The account-level permissions settings that apply to the bucket.</p>"
}
},
"AdminAccount" : {
"base" : "<p>Provides information about the delegated Amazon Macie administrator account for an AWS organization.</p>",
"refs" : {
"__listOfAdminAccount$member" : null
}
},
"AdminStatus" : {
"base" : "<p>The current status of an account as the delegated Amazon Macie administrator account for an AWS organization.</p>",
"refs" : {
"AdminAccount$Status" : "<p>The current status of the account as a delegated administrator of Amazon Macie for the organization.</p>"
}
},
"ApiCallDetails" : {
"base" : "<p>Provides information about an API operation that an entity invoked for an affected resource.</p>",
"refs" : {
"FindingAction$ApiCallDetails" : "<p>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.</p>"
}
},
"AssumedRole" : {
"base" : "<p>Provides information about an identity that performed an action on an affected resource by using temporary security credentials. The credentials were obtained using the AssumeRole operation of the AWS Security Token Service (AWS STS) API.</p>",
"refs" : {
"UserIdentity$AssumedRole" : "<p>If the action was performed with temporary security credentials that were obtained using the AssumeRole operation of the AWS Security Token Service (AWS STS) API, the identifiers, session context, and other details about the identity.</p>"
}
},
"AwsAccount" : {
"base" : "<p>Provides information about an AWS account and entity that performed an action on an affected resource. The action was performed using the credentials for an AWS account other than your own account.</p>",
"refs" : {
"UserIdentity$AwsAccount" : "<p>If the action was performed using the credentials for another AWS account, the details of that account.</p>"
}
},
"AwsService" : {
"base" : "<p>Provides information about an AWS service that performed an action on an affected resource.</p>",
"refs" : {
"UserIdentity$AwsService" : "<p>If the action was performed by an AWS account that belongs to an AWS service, the name of the service.</p>"
}
},
"BatchGetCustomDataIdentifierSummary" : {
"base" : "<p>Provides information about a custom data identifier.</p>",
"refs" : {
"__listOfBatchGetCustomDataIdentifierSummary$member" : null
}
},
"BatchGetCustomDataIdentifiersRequest" : {
"base" : "<p>Specifies one or more custom data identifiers to retrieve information about.</p>",
"refs" : { }
},
"BatchGetCustomDataIdentifiersResponse" : {
"base" : "<p>Provides information about one or more custom data identifiers.</p>",
"refs" : { }
},
"BlockPublicAccess" : {
"base" : "<p>Provides information about the block public access settings for an S3 bucket. These settings can apply to a bucket at the account level or bucket level. For detailed information about each setting, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html\">Using Amazon S3 block public access</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p>",
"refs" : {
"AccountLevelPermissions$BlockPublicAccess" : "<p>The block public access settings for the bucket.</p>",
"BucketLevelPermissions$BlockPublicAccess" : "<p>The block public access settings for the bucket.</p>"
}
},
"BucketCountByEffectivePermission" : {
"base" : "<p>Provides information about the number of S3 buckets that are publicly accessible based on a combination of permissions settings for each bucket.</p>",
"refs" : {
"GetBucketStatisticsResponse$BucketCountByEffectivePermission" : "<p>The total number of buckets that are publicly accessible based on a combination of permissions settings for each bucket.</p>"
}
},
"BucketCountByEncryptionType" : {
"base" : "<p>Provides information about the number of S3 buckets that use certain types of server-side encryption or don't encrypt objects by default.</p>",
"refs" : {
"GetBucketStatisticsResponse$BucketCountByEncryptionType" : "<p>The total number of buckets, grouped by server-side encryption type. This object also reports the total number of buckets that don't encrypt objects by default.</p>"
}
},
"BucketCountBySharedAccessType" : {
"base" : "<p>Provides information about the number of S3 buckets that are shared with other AWS accounts.</p>",
"refs" : {
"GetBucketStatisticsResponse$BucketCountBySharedAccessType" : "<p>The total number of buckets that are shared with another AWS account.</p>"
}
},
"BucketCriteria" : {
"base" : "<p>Specifies, as a map, one or more property-based conditions that filter the results of a query for information about S3 buckets.</p>",
"refs" : {
"DescribeBucketsRequest$Criteria" : "<p>The criteria to use to filter the query results.</p>"
}
},
"BucketCriteriaAdditionalProperties" : {
"base" : "<p>Specifies the operator to use in a property-based condition that filters the results of a query for information about S3 buckets.</p>",
"refs" : {
"BucketCriteria$member" : null
}
},
"BucketLevelPermissions" : {
"base" : "<p>Provides information about the bucket-level permissions settings for an S3 bucket.</p>",
"refs" : {
"BucketPermissionConfiguration$BucketLevelPermissions" : "<p>The bucket-level permissions settings for the bucket.</p>"
}
},
"BucketMetadata" : {
"base" : "<p>Provides information about an S3 bucket that Amazon Macie monitors and analyzes.</p>",
"refs" : {
"__listOfBucketMetadata$member" : null
}
},
"BucketPermissionConfiguration" : {
"base" : "<p>Provides information about the account-level and bucket-level permissions settings for an S3 bucket.</p>",
"refs" : {
"BucketPublicAccess$PermissionConfiguration" : "<p>The account-level and bucket-level permissions for the bucket.</p>"
}
},
"BucketPolicy" : {
"base" : "<p>Provides information about the permissions settings of a bucket policy for an S3 bucket.</p>",
"refs" : {
"BucketLevelPermissions$BucketPolicy" : "<p>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.</p>"
}
},
"BucketPublicAccess" : {
"base" : "<p>Provides information about the permissions settings that determine whether an S3 bucket is publicly accessible.</p>",
"refs" : {
"BucketMetadata$PublicAccess" : "<p>Specifies whether the bucket is publicly accessible. If this value is true, an access control list (ACL), bucket policy, or block public access settings allow the bucket to be accessed by the general public.</p>",
"S3Bucket$PublicAccess" : "<p>The permissions settings that determine whether the bucket is publicly accessible.</p>"
}
},
"BucketSortCriteria" : {
"base" : "<p>Specifies criteria for sorting the results of a query for information about S3 buckets.</p>",
"refs" : {
"DescribeBucketsRequest$SortCriteria" : "<p>The criteria to use to sort the query results.</p>"
}
},
"Cell" : {
"base" : "<p>Specifies the location of an occurrence of sensitive data in a Microsoft Excel workbook, CSV file, or TSV file.</p>",
"refs" : {
"Cells$member" : null
}
},
"Cells" : {
"base" : "<p>Specifies the location of occurrences of sensitive data in a Microsoft Excel workbook, CSV file, or TSV file.</p>",
"refs" : {
"Occurrences$Cells" : "<p>An array of objects, one for each occurrence of sensitive data in a Microsoft Excel workbook, CSV file, or TSV file. Each object specifies the cell or field that contains the data. This value is null for all other types of files.</p>"
}
},
"ClassificationDetails" : {
"base" : "<p>Provides information about a sensitive data finding, including the classification job that produced the finding.</p>",
"refs" : {
"Finding$ClassificationDetails" : "<p>The details of a sensitive data finding. This value is null for a policy finding.</p>"
}
},
"ClassificationExportConfiguration" : {
"base" : "<p>Specifies where to store data classification results, and the encryption settings to use when storing results in that location. Currently, you can store classification results only in an S3 bucket.</p>",
"refs" : {
"GetClassificationExportConfigurationResponse$Configuration" : "<p>The location where data classification results are stored, and the encryption settings that are used when storing results in that location.</p>",
"PutClassificationExportConfigurationRequest$Configuration" : "<p>The location to store data classification results in, and the encryption settings to use when storing results in that location.</p>",
"PutClassificationExportConfigurationResponse$Configuration" : "<p>The location where the data classification results are stored, and the encryption settings that are used when storing results in that location.</p>"
}
},
"ClassificationResult" : {
"base" : "<p>Provides the details of a sensitive data finding, including the types, number of occurrences, and locations of the sensitive data that was detected.</p>",
"refs" : {
"ClassificationDetails$Result" : "<p>The status and other details for the finding.</p>"
}
},
"ClassificationResultStatus" : {
"base" : "<p>Provides information about the status of a sensitive data finding.</p>",
"refs" : {
"ClassificationResult$Status" : "<p>The status of the finding.</p>"
}
},
"ConflictException" : {
"base" : "<p>Provides information about an error that occurred due to a versioning conflict for a specified resource.</p>",
"refs" : { }
},
"CreateClassificationJobRequest" : {
"base" : "<p>Specifies the scope, schedule, and other settings for a classification job. You can't change any settings for a classification job after you create it. This helps ensure that you have an immutable history of sensitive data findings and discovery results for data privacy and protection audits or investigations.</p>",
"refs" : { }
},
"CreateClassificationJobResponse" : {
"base" : "<p>Provides information about a classification job that was created in response to a request.</p>",
"refs" : { }
},
"CreateCustomDataIdentifierRequest" : {
"base" : " <p>Specifies the criteria and other settings for a new custom data identifier. You can't change a custom data identifier after you create it. This helps ensure that you have an immutable history of sensitive data findings and discovery results for data privacy and protection audits or investigations.</p>",
"refs" : { }
},
"CreateCustomDataIdentifierResponse" : {
"base" : "<p>Provides information about a custom data identifier that was created in response to a request.</p>",
"refs" : { }
},
"CreateFindingsFilterRequest" : {
"base" : "<p>Specifies the criteria and other settings for a new findings filter.</p>",
"refs" : { }
},
"CreateFindingsFilterResponse" : {
"base" : "<p>Provides information about a findings filter that was created in response to a request.</p>",
"refs" : { }
},
"CreateInvitationsRequest" : {
"base" : "<p>Specifies the settings for an Amazon Macie membership invitation.</p>",
"refs" : { }
},
"CreateInvitationsResponse" : {
"base" : "<p>Provides information about an unprocessed request to send an Amazon Macie membership invitation to a specific account.</p>",
"refs" : { }
},
"CreateMemberRequest" : {
"base" : "<p>Specifies an account to associate with an Amazon Macie master account.</p>",
"refs" : { }
},
"CreateMemberResponse" : {
"base" : "<p>Provides information about a request to associate an account with an Amazon Macie master account.</p>",
"refs" : { }
},
"CreateSampleFindingsRequest" : {
"base" : "<p>Specifies the types of findings to include in a set of sample findings that Amazon Macie creates.</p>",
"refs" : { }
},
"Criterion" : {
"base" : "<p>Specifies a condition that defines a property, operator, and one or more values to filter the results of a query for findings. The number of values depends on the property and operator specified by the condition. For information about defining filter conditions, see <a href=\"https://docs.aws.amazon.com/macie/latest/user/findings-filter-basics.html\">Fundamentals of filtering findings</a> in the <i>Amazon Macie User Guide</i>.</p>",
"refs" : {
"FindingCriteria$Criterion" : "<p>A condition that specifies the property, operator, and one or more values to use to filter the results.</p>"
}
},
"CriterionAdditionalProperties" : {
"base" : "<p>Specifies the operator to use in a property-based condition that filters the results of a query for findings. For detailed information and examples of each operator, see <a href=\"https://docs.aws.amazon.com/macie/latest/user/findings-filter-basics.html\">Fundamentals of filtering findings</a> in the <i>Amazon Macie User Guide</i>.</p>",
"refs" : {
"Criterion$member" : null
}
},
"Currency" : {
"base" : "<p>The type of currency that data for a usage metric is reported in. Possible values are:</p>",
"refs" : {
"UsageByAccount$Currency" : "<p>The type of currency that the value for the metric (estimatedCost) is reported in.</p>",
"UsageTotal$Currency" : "<p>The type of currency that the value for the metric (estimatedCost) is reported in.</p>"
}
},
"CustomDataIdentifierSummary" : {
"base" : "<p>Provides information about a custom data identifier.</p>",
"refs" : {
"__listOfCustomDataIdentifierSummary$member" : null
}
},
"CustomDataIdentifiers" : {
"base" : "<p>Provides information about custom data identifiers that produced a sensitive data finding, and the number of occurrences of the data that they detected for the finding.</p>",
"refs" : {
"ClassificationResult$CustomDataIdentifiers" : "<p>The custom data identifiers that detected the sensitive data and the number of occurrences of the data that they detected.</p>"
}
},
"CustomDetection" : {
"base" : "<p>Provides information about a custom data identifier that produced a sensitive data finding, and the sensitive data that it detected for the finding.</p>",
"refs" : {
"CustomDetections$member" : null
}
},
"CustomDetections" : {
"base" : "<p>Provides information about custom data identifiers that produced a sensitive data finding, and the number of occurrences of the data that each identifier detected.</p>",
"refs" : {
"CustomDataIdentifiers$Detections" : "<p>The custom data identifiers that detected the data, and the number of occurrences of the data that each identifier detected.</p>"
}
},
"DailySchedule" : {
"base" : "<p>Specifies that a classification job runs once a day, every day. This is an empty object.</p>",
"refs" : {
"JobScheduleFrequency$DailySchedule" : "<p>Specifies a daily recurrence pattern for running the job.</p>"
}
},
"DayOfWeek" : {
"base" : null,
"refs" : {
"WeeklySchedule$DayOfWeek" : "<p>The day of the week when Amazon Macie runs the job.</p>"
}
},
"DeclineInvitationsRequest" : {
"base" : "<p>Specifies one or more accounts that sent Amazon Macie membership invitations to decline.</p>",
"refs" : { }
},
"DeclineInvitationsResponse" : {
"base" : "<p>Provides information about unprocessed requests to decline Amazon Macie membership invitations that were received from specific accounts.</p>",
"refs" : { }
},
"DefaultDetection" : {
"base" : "<p>Provides information about a type of sensitive data that was detected by managed data identifiers and produced a sensitive data finding.</p>",
"refs" : {
"DefaultDetections$member" : null
}
},
"DefaultDetections" : {
"base" : "<p>Provides information about sensitive data that was detected by managed data identifiers and produced a sensitive data finding, and the number of occurrences of each type of sensitive data that was detected.</p>",
"refs" : {
"SensitiveDataItem$Detections" : "<p>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.</p>"
}
},
"DeleteInvitationsRequest" : {
"base" : "<p>Specifies one or more accounts that sent Amazon Macie membership invitations to delete.</p>",
"refs" : { }
},
"DeleteInvitationsResponse" : {
"base" : "<p>Provides information about unprocessed requests to delete Amazon Macie membership invitations that were received from specific accounts.</p>",
"refs" : { }
},
"DescribeBucketsRequest" : {
"base" : "<p>Specifies criteria for filtering, sorting, and paginating the results of a query for information about S3 buckets.</p>",
"refs" : { }
},
"DescribeBucketsResponse" : {
"base" : "<p>Provides the results of a query that retrieved statistical data and other information about one or more S3 buckets that Amazon Macie monitors and analyzes.</p>",
"refs" : { }
},
"DescribeClassificationJobResponse" : {
"base" : "<p>Provides information about a classification job, including the current configuration settings and status of the job.</p>",
"refs" : { }
},
"DescribeOrganizationConfigurationResponse" : {
"base" : "<p>Provides information about the Amazon Macie configuration settings for an AWS organization.</p>",
"refs" : { }
},
"DomainDetails" : {
"base" : "<p>Provides information about the domain name of the device that an entity used to perform an action on an affected resource.</p>",
"refs" : {
"FindingActor$DomainDetails" : "<p>The domain name of the device that the entity used to perform the action on the affected resource.</p>"
}
},
"EffectivePermission" : {
"base" : null,
"refs" : {
"BucketPublicAccess$EffectivePermission" : " <p>Specifies whether the bucket is publicly accessible due to the combination of permissions settings that apply to the bucket. Possible values are:</p> <ul><li><p>NOT_PUBLIC - The bucket isn't publicly accessible.</p></li> <li><p>PUBLIC - The bucket is publicly accessible.</p></li> <li><p>UNKNOWN - Amazon Macie can't determine whether the bucket is publicly accessible.</p></li></ul>"
}
},
"Empty" : {
"base" : "<p>The request succeeded and there isn't any content to include in the body of the response (No Content).</p>",
"refs" : { }
},
"EnableMacieRequest" : {
"base" : "<p>Enables Amazon Macie and specifies the configuration settings for an Amazon Macie account.</p>",
"refs" : { }
},
"EnableOrganizationAdminAccountRequest" : {
"base" : "<p>Specifies an account to designate as a delegated Amazon Macie administrator account for an AWS organization. To submit this request, you must be a user of the management account for the AWS organization.</p>",
"refs" : { }
},
"EncryptionType" : {
"base" : "<p>The type of server-side encryption that's used to encrypt an S3 object or objects in an S3 bucket. Valid values are:</p>",
"refs" : {
"ServerSideEncryption$EncryptionType" : "<p>The server-side encryption algorithm that's used when storing data in the bucket or object. If encryption is disabled for the bucket or object, this value is NONE.</p>"
}
},
"ErrorCode" : {
"base" : "<p>The source of an error, issue, or delay. Possible values are:</p>",
"refs" : {
"UnprocessedAccount$ErrorCode" : "<p>The source of the issue or delay in processing the request.</p>"
}
},
"FederatedUser" : {
"base" : "<p>Provides information about an identity that performed an action on an affected resource by using temporary security credentials. The credentials were obtained using the GetFederationToken operation of the AWS Security Token Service (AWS STS) API.</p>",
"refs" : {
"UserIdentity$FederatedUser" : "<p>If the action was performed with temporary security credentials that were obtained using the GetFederationToken operation of the AWS Security Token Service (AWS STS) API, the identifiers, session context, and other details about the identity.</p>"
}
},
"Finding" : {
"base" : "<p>Provides the details of a finding.</p>",
"refs" : {
"__listOfFinding$member" : null
}
},
"FindingAction" : {
"base" : "<p>Provides information about an action that occurred for a resource and produced a policy finding.</p>",
"refs" : {
"PolicyDetails$Action" : "<p>The action that produced the finding.</p>"
}
},
"FindingActionType" : {
"base" : "<p>The type of action that occurred for the resource and produced the policy finding:</p>",
"refs" : {
"FindingAction$ActionType" : "<p>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.</p>"
}
},
"FindingActor" : {
"base" : "<p>Provides information about an entity that performed an action that produced a policy finding for a resource.</p>",
"refs" : {
"PolicyDetails$Actor" : "<p>The entity that performed the action that produced the finding.</p>"
}
},
"FindingCategory" : {
"base" : "<p>The category of the finding. Valid values are:</p>",
"refs" : {
"Finding$Category" : "<p>The category of the finding. Possible values are: CLASSIFICATION, for a sensitive data finding; and, POLICY, for a policy finding.</p>"
}
},
"FindingCriteria" : {
"base" : "<p>Specifies, as a map, one or more property-based conditions that filter the results of a query for findings.</p>",
"refs" : {
"CreateFindingsFilterRequest$FindingCriteria" : "<p>The criteria to use to filter findings.</p>",
"GetFindingStatisticsRequest$FindingCriteria" : "<p>The criteria to use to filter the query results.</p>",
"GetFindingsFilterResponse$FindingCriteria" : "<p>The criteria that's used to filter findings.</p>",
"ListFindingsRequest$FindingCriteria" : "<p>The criteria to use to filter the results.</p>",
"UpdateFindingsFilterRequest$FindingCriteria" : "<p>The criteria to use to filter findings.</p>"
}
},
"FindingPublishingFrequency" : {
"base" : "<p>The frequency with which Amazon Macie publishes updates to policy findings for an account. This includes publishing updates to AWS Security Hub and Amazon EventBridge (formerly called Amazon CloudWatch Events). Valid values are:</p>",
"refs" : {
"EnableMacieRequest$FindingPublishingFrequency" : "Specifies how often to publish updates to policy findings for the account. This includes publishing updates to AWS Security Hub and Amazon EventBridge (formerly called Amazon CloudWatch Events).",
"GetMacieSessionResponse$FindingPublishingFrequency" : "<p>The frequency with which Amazon Macie publishes updates to policy findings for the account. This includes publishing updates to AWS Security Hub and Amazon EventBridge (formerly called Amazon CloudWatch Events).</p>",
"UpdateMacieSessionRequest$FindingPublishingFrequency" : "Specifies how often to publish updates to policy findings for the account. This includes publishing updates to AWS Security Hub and Amazon EventBridge (formerly called Amazon CloudWatch Events)."
}
},
"FindingStatisticsSortAttributeName" : {
"base" : "<p>The grouping to sort the results by. Valid values are:</p>",
"refs" : {
"FindingStatisticsSortCriteria$AttributeName" : "<p>The grouping to sort the results by. Valid values are: count, sort the results by the number of findings in each group of results; and, groupKey, sort the results by the name of each group of results.</p>"
}
},
"FindingStatisticsSortCriteria" : {
"base" : "<p>Specifies criteria for sorting the results of a query that retrieves aggregated statistical data about findings.</p>",
"refs" : {
"GetFindingStatisticsRequest$SortCriteria" : "<p>The criteria to use to sort the query results.</p>"
}
},
"FindingType" : {
"base" : "<p>The type of finding. For details about each type, see <a href=\"https://docs.aws.amazon.com/macie/latest/user/findings-types.html\">Types of Amazon Macie findings</a> in the <i>Amazon Macie User Guide</i>. Valid values are:</p>",
"refs" : {
"Finding$Type" : "<p>The type of the finding.</p>",
"__listOfFindingType$member" : null
}
},
"FindingsFilterAction" : {
"base" : "<p>The action to perform on findings that meet the filter criteria. To suppress (automatically archive) findings that meet the criteria, set this value to ARCHIVE. Valid values are:</p>",
"refs" : {
"CreateFindingsFilterRequest$Action" : "<p>The action to perform on findings that meet the filter criteria (findingCriteria). Valid values are: ARCHIVE, suppress (automatically archive) the findings; and, NOOP, don't perform any action on the findings.</p>",
"FindingsFilterListItem$Action" : "<p>The action that's performed on findings that meet the filter criteria. Possible values are: ARCHIVE, suppress (automatically archive) the findings; and, NOOP, don't perform any action on the findings.</p>",
"GetFindingsFilterResponse$Action" : "<p>The action that's performed on findings that meet the filter criteria (findingCriteria). Possible values are: ARCHIVE, suppress (automatically archive) the findings; and, NOOP, don't perform any action on the findings.</p>",
"UpdateFindingsFilterRequest$Action" : "<p>The action to perform on findings that meet the filter criteria (findingCriteria). Valid values are: ARCHIVE, suppress (automatically archive) the findings; and, NOOP, don't perform any action on the findings.</p>"
}
},
"FindingsFilterListItem" : {
"base" : "<p>Provides information about a findings filter.</p>",
"refs" : {
"__listOfFindingsFilterListItem$member" : null
}
},
"GetBucketStatisticsRequest" : {
"base" : "<p>Specifies the account that owns the S3 buckets to retrieve aggregated statistical data for.</p>",
"refs" : { }
},
"GetBucketStatisticsResponse" : {
"base" : "<p>Provides the results of a query that retrieved aggregated statistical data for the S3 buckets that are owned by an account.</p>",
"refs" : { }
},
"GetClassificationExportConfigurationResponse" : {
"base" : "<p>Provides information about the current configuration settings for storing data classification results.</p>",
"refs" : { }
},
"GetCustomDataIdentifierResponse" : {
"base" : "<p>Provides information about the criteria and other settings for a custom data identifier.</p>",
"refs" : { }
},
"GetFindingStatisticsRequest" : {
"base" : "<p>Specifies criteria for filtering, grouping, sorting, and paginating the results of a query that retrieves aggregated statistical data about findings.</p>",
"refs" : { }
},
"GetFindingStatisticsResponse" : {
"base" : "<p>Provides the results of a query that retrieved aggregated statistical data about findings.</p>",
"refs" : { }
},
"GetFindingsFilterResponse" : {
"base" : "<p>Provides information about the criteria and other settings for a findings filter.</p>",
"refs" : { }
},
"GetFindingsRequest" : {
"base" : "<p>Specifies one or more findings to retrieve.</p>",
"refs" : { }
},
"GetFindingsResponse" : {
"base" : "<p>Provides the results of a request for one or more findings.</p>",
"refs" : { }
},
"GetInvitationsCountResponse" : {
"base" : "<p>Provides the count of all the Amazon Macie membership invitations that were received by an account, not including the currently accepted invitation.</p>",
"refs" : { }
},
"GetMacieSessionResponse" : {
"base" : "<p>Provides information about the current status and configuration settings for an Amazon Macie account.</p>",
"refs" : { }
},
"GetMasterAccountResponse" : {
"base" : "<p>Provides information about the Amazon Macie master account for an account. If the accounts are associated by a Macie membership invitation, the response also provides information about that invitation.</p>",
"refs" : { }
},
"GetMemberResponse" : {
"base" : "<p>Provides information about an account that's associated with an Amazon Macie master account.</p>",
"refs" : { }
},
"GetUsageStatisticsRequest" : {
"base" : "<p>Specifies criteria for filtering, sorting, and paginating the results of a query for quotas and aggregated usage data for one or more accounts.</p>",
"refs" : { }
},
"GetUsageStatisticsResponse" : {
"base" : "<p>Provides the results of a query that retrieved quotas and aggregated usage data for one or more accounts.</p>",
"refs" : { }
},
"GetUsageTotalsResponse" : {
"base" : "<p>Provides the results of a query that retrieved aggregated usage data for an account during the past 30 days.</p>",
"refs" : { }
},
"GroupBy" : {
"base" : null,
"refs" : {
"GetFindingStatisticsRequest$GroupBy" : "<p>The finding property to use to group the query results. Valid values are:</p> <ul><li><p>classificationDetails.jobId - The unique identifier for the classification job that produced the finding.</p></li> <li><p>resourcesAffected.s3Bucket.name - The name of the S3 bucket that the finding applies to.</p></li> <li><p>severity.description - The severity level of the finding, such as High or Medium.</p></li> <li><p>type - The type of finding, such as Policy:IAMUser/S3BucketPublic and SensitiveData:S3Object/Personal.</p></li></ul>"
}
},
"GroupCount" : {
"base" : "<p>Provides a group of results for a query that retrieved aggregated statistical data about findings.</p>",
"refs" : {
"__listOfGroupCount$member" : null
}
},
"IamUser" : {
"base" : "<p>Provides information about an AWS Identity and Access Management (IAM) user who performed an action on an affected resource.</p>",
"refs" : {
"UserIdentity$IamUser" : "<p>If the action was performed using the credentials for an AWS Identity and Access Management (IAM) user, the name and other details about the user.</p>"
}
},
"InternalServerException" : {
"base" : "<p>Provides information about an error that occurred due to an unknown internal server error, exception, or failure.</p>",
"refs" : { }
},
"Invitation" : {
"base" : "<p>Provides information about an Amazon Macie membership invitation that was received by an account.</p>",
"refs" : {
"GetMasterAccountResponse$Master" : "<p>The AWS account ID for the master account. If the accounts are associated by a Macie membership invitation, this object also provides details about the invitation that was sent and accepted to establish the relationship between the accounts.</p>",
"__listOfInvitation$member" : null
}
},
"IpAddressDetails" : {
"base" : "<p>Provides information about the IP address of the device that an entity used to perform an action on an affected resource.</p>",
"refs" : {
"FindingActor$IpAddressDetails" : "<p>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.</p>"
}
},
"IpCity" : {
"base" : "<p>Provides information about the city that an IP address originated from.</p>",
"refs" : {
"IpAddressDetails$IpCity" : "<p>The city that the IP address originated from.</p>"
}
},
"IpCountry" : {
"base" : "<p>Provides information about the country that an IP address originated from.</p>",
"refs" : {
"IpAddressDetails$IpCountry" : "<p>The country that the IP address originated from.</p>"
}
},
"IpGeoLocation" : {
"base" : "<p>Provides geographic coordinates that indicate where a specified IP address originated from.</p>",
"refs" : {
"IpAddressDetails$IpGeoLocation" : "<p>The geographic coordinates of the location that the IP address originated from.</p>"
}
},
"IpOwner" : {
"base" : "<p>Provides information about the registered owner of an IP address.</p>",
"refs" : {
"IpAddressDetails$IpOwner" : "<p>The registered owner of the IP address.</p>"
}
},
"IsDefinedInJob" : {
"base" : null,
"refs" : {
"JobDetails$IsDefinedInJob" : "<p>Specifies whether any one-time or recurring jobs are configured to analyze data in the bucket. Possible values are:</p> <ul><li><p>TRUE - One or more jobs is configured to analyze data in the bucket, and at least one of those jobs has a status other than CANCELLED.</p></li> <li><p>FALSE - No jobs are configured to analyze data in the bucket, or all the jobs that are configured to analyze data in the bucket have a status of CANCELLED.</p></li> <li><p>UNKNOWN - An exception occurred when Amazon Macie attempted to retrieve job data for the bucket.</p></li></ul> <p></p>"
}
},
"IsMonitoredByJob" : {
"base" : null,
"refs" : {
"JobDetails$IsMonitoredByJob" : "<p>Specifies whether any recurring jobs are configured to analyze data in the bucket. Possible values are:</p> <ul><li><p>TRUE - One or more recurring jobs is configured to analyze data in the bucket, and at least one of those jobs has a status other than CANCELLED.</p></li> <li><p>FALSE - No recurring jobs are configured to analyze data in the bucket, or all the recurring jobs that are configured to analyze data in the bucket have a status of CANCELLED.</p></li> <li><p>UNKNOWN - An exception occurred when Amazon Macie attempted to retrieve job data for the bucket.</p></li></ul>"
}
},
"JobComparator" : {
"base" : "<p>The operator to use in a condition. Valid values are:</p>",
"refs" : {
"ListJobsFilterTerm$Comparator" : "<p>The operator to use to filter the results.</p>",
"SimpleScopeTerm$Comparator" : "<p>The operator to use in the condition. Valid operators for each supported property (key) are:</p> <ul><li><p>OBJECT_EXTENSION - EQ (equals) or NE (not equals)</p></li> <li><p>OBJECT_LAST_MODIFIED_DATE - Any operator except CONTAINS</p></li> <li><p>OBJECT_SIZE - Any operator except CONTAINS</p></li> <li><p>TAG - EQ (equals) or NE (not equals)</p></li></ul>",
"TagScopeTerm$Comparator" : "<p>The operator to use in the condition. Valid operators are EQ (equals) or NE (not equals).</p>"
}
},
"JobDetails" : {
"base" : "<p>Specifies whether any one-time or recurring classification jobs are configured to analyze data in an S3 bucket, and, if so, the details of the job that ran most recently.</p>",
"refs" : {
"BucketMetadata$JobDetails" : "<p>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.</p>"
}
},
"JobScheduleFrequency" : {
"base" : "<p>Specifies the recurrence pattern for running a classification job.</p>",
"refs" : {
"CreateClassificationJobRequest$ScheduleFrequency" : "<p>The recurrence pattern for running the job. To run the job only once, don't specify a value for this property and set the value for the jobType property to ONE_TIME.</p>",
"DescribeClassificationJobResponse$ScheduleFrequency" : "<p>The recurrence pattern for running the job. If the job is configured to run only once, this value is null.</p>"
}
},
"JobScopeTerm" : {
"base" : "<p>Specifies a property- or tag-based condition that defines criteria for including or excluding objects from a classification job.</p>",
"refs" : {
"__listOfJobScopeTerm$member" : null
}
},
"JobScopingBlock" : {
"base" : "<p>Specifies one or more property- and tag-based conditions that define criteria for including or excluding objects from a classification job. If you specify more than one condition, Amazon Macie uses an AND operator to join the conditions.</p>",
"refs" : {
"Scoping$Excludes" : "<p>The property- or tag-based conditions that determine which objects to exclude from the analysis.</p>",
"Scoping$Includes" : "<p>The property- or tag-based conditions that determine which objects to include in the analysis.</p>"
}
},
"JobStatus" : {
"base" : "<p>The status of a classification job. Possible values are:</p>",
"refs" : {
"DescribeClassificationJobResponse$JobStatus" : "<p>The current status of the job. Possible values are:</p> <ul><li><p>CANCELLED - You cancelled the job or, if it's a one-time job, you paused the job and didn't resume it within 30 days.</p></li> <li><p>COMPLETE - For a one-time job, Amazon Macie finished processing the data specified for the job. This value doesn't apply to recurring jobs.</p></li> <li><p>IDLE - For a recurring job, the previous scheduled run is complete and the next scheduled run is pending. This value doesn't apply to one-time jobs.</p></li> <li><p>PAUSED - Amazon Macie started running the job but additional processing would exceed the monthly sensitive data discovery quota for your account or one or more member accounts that the job analyzes data for.</p></li> <li><p>RUNNING - For a one-time job, the job is in progress. For a recurring job, a scheduled run is in progress.</p></li> <li><p>USER_PAUSED - You paused the job. If you paused the job while it had a status of RUNNING and you don't resume it within 30 days of pausing it, the job or job run will expire and be cancelled, depending on the job's type. To check the expiration date, refer to the UserPausedDetails.jobExpiresAt property.</p></li></ul>",
"JobSummary$JobStatus" : "<p>The current status of the job. Possible values are:</p> <ul><li><p>CANCELLED - You cancelled the job or, if it's a one-time job, you paused the job and didn't resume it within 30 days.</p></li> <li><p>COMPLETE - For a one-time job, Amazon Macie finished processing the data specified for the job. This value doesn't apply to recurring jobs.</p></li> <li><p>IDLE - For a recurring job, the previous scheduled run is complete and the next scheduled run is pending. This value doesn't apply to one-time jobs.</p></li> <li><p>PAUSED - Amazon Macie started running the job but additional processing would exceed the monthly sensitive data discovery quota for your account or one or more member accounts that the job analyzes data for.</p></li> <li><p>RUNNING - For a one-time job, the job is in progress. For a recurring job, a scheduled run is in progress.</p></li> <li><p>USER_PAUSED - You paused the job. If you paused the job while it had a status of RUNNING and you don't resume it within 30 days of pausing it, the job or job run will expire and be cancelled, depending on the job's type. To check the expiration date, refer to the UserPausedDetails.jobExpiresAt property.</p></li></ul>",
"UpdateClassificationJobRequest$JobStatus" : "<p>The new status for the job. Valid values are:</p> <ul><li><p>CANCELLED - Stops the job permanently and cancels it. This value is valid only if the job's current status is IDLE, PAUSED, RUNNING, or USER_PAUSED.</p> <p>If you specify this value and the job's current status is RUNNING, Amazon Macie immediately begins to stop all processing tasks for the job. You can't resume or restart a job after you cancel it.</p></li> <li><p>RUNNING - Resumes the job. This value is valid only if the job's current status is USER_PAUSED.</p> <p>If you paused the job while it was actively running and you specify this value less than 30 days after you paused the job, Macie immediately resumes processing from the point where you paused the job. Otherwise, Macie resumes the job according to the schedule and other settings for the job.</p></li> <li><p>USER_PAUSED - Pauses the job temporarily. This value is valid only if the job's current status is IDLE or RUNNING. If you specify this value and the job's current status is RUNNING, Macie immediately begins to pause all processing tasks for the job.</p> <p>If you pause a one-time job and you don't resume it within 30 days, the job expires and Macie cancels the job. If you pause a recurring job when its status is RUNNING and you don't resume it within 30 days, the job run expires and Macie cancels the run. To check the expiration date, refer to the UserPausedDetails.jobExpiresAt property.</p></li></ul>"
}
},
"JobSummary" : {
"base" : "<p>Provides information about a classification job, including the current status of the job.</p>",
"refs" : {
"__listOfJobSummary$member" : null
}
},
"JobType" : {
"base" : "<p>The schedule for running a classification job. Valid values are:</p>",
"refs" : {
"CreateClassificationJobRequest$JobType" : "<p>The schedule for running the job. Valid values are:</p> <ul><li><p>ONE_TIME - Run the job only once. If you specify this value, don't specify a value for the scheduleFrequency property.</p></li> <li><p>SCHEDULED - Run the job on a daily, weekly, or monthly basis. If you specify this value, use the scheduleFrequency property to define the recurrence pattern for the job.</p></li></ul>",
"DescribeClassificationJobResponse$JobType" : "<p>The schedule for running the job. Possible values are:</p> <ul><li><p>ONE_TIME - The job runs only once.</p></li> <li><p>SCHEDULED - The job runs on a daily, weekly, or monthly basis. The scheduleFrequency property indicates the recurrence pattern for the job.</p></li></ul>",
"JobSummary$JobType" : "<p>The schedule for running the job. Possible values are:</p> <ul><li><p>ONE_TIME - The job runs only once.</p></li> <li><p>SCHEDULED - The job runs on a daily, weekly, or monthly basis.</p></li></ul>"
}
},
"KeyValuePair" : {
"base" : "<p>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.</p>",
"refs" : {
"KeyValuePairList$member" : null,
"__listOfKeyValuePair$member" : null
}
},
"KeyValuePairList" : {
"base" : "<p>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.</p>",
"refs" : {
"S3Bucket$Tags" : "<p>The tags that are associated with the bucket.</p>",
"S3Object$Tags" : "<p>The tags that are associated with the object.</p>"
}
},
"LastRunErrorStatus" : {
"base" : "<p>Specifies whether any account- or bucket-level access errors occurred when a classification job ran. For example, the job is configured to analyze data for a member account that was suspended, or the job is configured to analyze an S3 bucket that Amazon Macie isn't allowed to access.</p>",
"refs" : {
"DescribeClassificationJobResponse$LastRunErrorStatus" : "<p>Specifies whether any account- or bucket-level access errors occurred when the job ran. For a recurring job, this value indicates the error status of the job's most recent run.</p>",
"JobSummary$LastRunErrorStatus" : "<p>Specifies whether any account- or bucket-level access errors occurred when the job ran. For a recurring job, this value indicates the error status of the job's most recent run.</p>"
}
},
"LastRunErrorStatusCode" : {
"base" : "<p>Specifies whether any account- or bucket-level access errors occurred during the run of a one-time classification job or the most recent run of a recurring classification job. Possible values are:</p>",
"refs" : {
"LastRunErrorStatus$Code" : "<p>Specifies whether any account- or bucket-level access errors occurred when the job ran. For a recurring job, this value indicates the error status of the job's most recent run. Possible values are:</p> <ul><li><p>ERROR - One or more errors occurred. Amazon Macie didn't process all the data specified for the job.</p></li> <li><p>NONE - No errors occurred. Macie processed all the data specified for the job.</p></li></ul>"
}
},
"ListClassificationJobsRequest" : {
"base" : "<p>Specifies criteria for filtering, sorting, and paginating the results of a request for information about classification jobs.</p>",
"refs" : { }
},
"ListClassificationJobsResponse" : {
"base" : "<p>Provides the results of a request for information about one or more classification jobs.</p>",
"refs" : { }
},
"ListCustomDataIdentifiersRequest" : {
"base" : "<p>Specifies criteria for paginating the results of a request for information about custom data identifiers.</p>",
"refs" : { }
},
"ListCustomDataIdentifiersResponse" : {
"base" : "<p>Provides the results of a request for information about custom data identifiers.</p>",
"refs" : { }
},
"ListFindingsFiltersResponse" : {
"base" : "<p>Provides information about all the findings filters for an account.</p>",
"refs" : { }
},
"ListFindingsRequest" : {
"base" : "<p>Specifies criteria for filtering, sorting, and paginating the results of a request for information about findings.</p>",
"refs" : { }
},
"ListFindingsResponse" : {
"base" : "<p>Provides the results of a request for information about one or more findings.</p>",
"refs" : { }
},
"ListInvitationsResponse" : {
"base" : "<p>Provides information about all the Amazon Macie membership invitations that were received by an account.</p>",
"refs" : { }
},
"ListJobsFilterCriteria" : {
"base" : "<p>Specifies criteria for filtering the results of a request for information about classification jobs.</p>",
"refs" : {
"ListClassificationJobsRequest$FilterCriteria" : "<p>The criteria to use to filter the results.</p>"
}
},
"ListJobsFilterKey" : {
"base" : "<p>The property to use to filter the results. Valid values are:</p>",
"refs" : {
"ListJobsFilterTerm$Key" : "<p>The property to use to filter the results.</p>"
}
},
"ListJobsFilterTerm" : {
"base" : "<p>Specifies a condition that filters the results of a request for information about classification jobs. Each condition consists of a property, an operator, and one or more values.</p>",
"refs" : {
"__listOfListJobsFilterTerm$member" : null
}
},
"ListJobsSortAttributeName" : {
"base" : "<p>The property to sort the results by. Valid values are:</p>",
"refs" : {
"ListJobsSortCriteria$AttributeName" : "<p>The property to sort the results by.</p>"
}
},
"ListJobsSortCriteria" : {
"base" : "<p>Specifies criteria for sorting the results of a request for information about classification jobs.</p>",
"refs" : {
"ListClassificationJobsRequest$SortCriteria" : "<p>The criteria to use to sort the results.</p>"
}
},
"ListMembersResponse" : {
"base" : "<p>Provides information about the accounts that are associated with an Amazon Macie master account.</p>",
"refs" : { }
},
"ListOrganizationAdminAccountsResponse" : {
"base" : "<p>Provides information about the delegated Amazon Macie administrator accounts for an AWS organization.</p>",
"refs" : { }
},
"ListTagsForResourceResponse" : {
"base" : "<p>Provides information about the tags (keys and values) that are associated with a classification job, custom data identifier, findings filter, or member account.</p>",
"refs" : { }
},
"MacieStatus" : {
"base" : "<p>The status of an Amazon Macie account. Valid values are:</p>",
"refs" : {
"EnableMacieRequest$Status" : "<p>Specifies the status for the account. To enable Amazon Macie and start all Amazon Macie activities for the account, set this value to ENABLED.</p>",
"GetMacieSessionResponse$Status" : "<p>The current status of the Amazon Macie account. Possible values are: PAUSED, the account is enabled but all Amazon Macie activities are suspended (paused) for the account; and, ENABLED, the account is enabled and all Amazon Macie activities are enabled for the account.</p>",
"UpdateMacieSessionRequest$Status" : "<p>Specifies whether to change the status of the account. Valid values are: ENABLED, resume all Amazon Macie activities for the account; and, PAUSED, suspend all Macie activities for the account.</p>",
"UpdateMemberSessionRequest$Status" : "<p>Specifies the new status for the account. Valid values are: ENABLED, resume all Amazon Macie activities for the account; and, PAUSED, suspend all Macie activities for the account.</p>"
}
},
"Member" : {
"base" : "<p>Provides information about an account that's associated with an Amazon Macie master account.</p>",
"refs" : {
"__listOfMember$member" : null
}
},
"MonthlySchedule" : {
"base" : "<p>Specifies a monthly recurrence pattern for running a classification job.</p>",
"refs" : {
"JobScheduleFrequency$MonthlySchedule" : "<p>Specifies a monthly recurrence pattern for running the job.</p>"
}
},
"ObjectCountByEncryptionType" : {
"base" : "<p>Provides information about the number of objects that are in an S3 bucket and use certain types of server-side encryption, use client-side encryption, or aren't encrypted.</p>",
"refs" : {
"BucketMetadata$ObjectCountByEncryptionType" : "<p>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.</p>"
}
},
"ObjectLevelStatistics" : {
"base" : "<p>Provides information about the total storage size (in bytes) or number of objects that Amazon Macie can't analyze in one or more S3 buckets. In a BucketMetadata object, this data is for a specific bucket. In a GetBucketStatisticsResponse object, this data is aggregated for all the buckets in the query results.</p>",
"refs" : {
"BucketMetadata$UnclassifiableObjectCount" : "<p>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.</p>",
"BucketMetadata$UnclassifiableObjectSizeInBytes" : "<p>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.</p>",
"GetBucketStatisticsResponse$UnclassifiableObjectCount" : "<p>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.</p>",
"GetBucketStatisticsResponse$UnclassifiableObjectSizeInBytes" : "<p>The total storage size, in bytes, of all 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.</p>"
}
},
"Occurrences" : {
"base" : "<p>Provides the location of 1-15 occurrences of sensitive data that was detected by managed data identifiers or a custom data identifier and produced a sensitive data finding.</p>",
"refs" : {
"CustomDetection$Occurrences" : "<p>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.</p>",
"DefaultDetection$Occurrences" : "<p>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.</p>"
}
},
"OrderBy" : {
"base" : null,
"refs" : {
"BucketSortCriteria$OrderBy" : "<p>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.</p>",
"FindingStatisticsSortCriteria$OrderBy" : "<p>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.</p>",
"ListJobsSortCriteria$OrderBy" : "<p>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.</p>",
"SortCriteria$OrderBy" : "<p>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.</p>",
"UsageStatisticsSortBy$OrderBy" : "<p>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.</p>"
}
},
"Page" : {
"base" : "<p>Specifies the location of an occurrence of sensitive data in an Adobe Portable Document Format file.</p>",
"refs" : {
"Pages$member" : null
}
},
"Pages" : {
"base" : "<p>Specifies the location of occurrences of sensitive data in an Adobe Portable Document Format file.</p>",
"refs" : {
"Occurrences$Pages" : "<p>An array of objects, one for each occurrence of sensitive data in an Adobe Portable Document Format file. Each object specifies the page that contains the data, and the position of the data on that page. This value is null for all other types of files.</p>"
}
},
"PolicyDetails" : {
"base" : "<p>Provides the details of a policy finding.</p>",
"refs" : {
"Finding$PolicyDetails" : "<p>The details of a policy finding. This value is null for a sensitive data finding.</p>"
}
},
"PutClassificationExportConfigurationRequest" : {
"base" : "<p>Specifies where to store data classification results, and the encryption settings to use when storing results in that location. Currently, you can store classification results only in an S3 bucket.</p>",
"refs" : { }
},
"PutClassificationExportConfigurationResponse" : {
"base" : "<p>Provides information about updated settings for storing data classification results.</p>",
"refs" : { }
},
"Range" : {
"base" : "<p>Provides details about the location of an occurrence of sensitive data in an Adobe Portable Document Format file, Microsoft Word document, or non-binary text file.</p>",
"refs" : {
"Page$LineRange" : "<p>The line that contains the data, and the position of the data on that line.</p>",
"Page$OffsetRange" : "<p>The position of the data on the page, relative to the beginning of the page.</p>",
"Ranges$member" : null
}
},
"Ranges" : {
"base" : "<p>Provides details about the location of occurrences of sensitive data in an Adobe Portable Document Format file, Microsoft Word document, or non-binary text file.</p>",
"refs" : {
"Occurrences$LineRanges" : "<p>An array of objects, one for each occurrence of sensitive data in a Microsoft Word document or non-binary text file, such as an HTML, JSON, TXT, or XML file. Each object specifies the line that contains the data, and the position of the data on that line.</p> <p>This value is often null for file types that are supported by Cell, Page, or Record objects. Exceptions are the locations of: data in unstructured sections of an otherwise structured file, such as a comment in a file; and, data in a malformed file that Amazon Macie analyzes as plain text.</p>",
"Occurrences$OffsetRanges" : "<p>An array of objects, one for each occurrence of sensitive data in a binary text file. Each object specifies the position of the data relative to the beginning of the file.</p> <p>This value is typically null. For binary text files, Amazon Macie adds location data to a lineRanges.Range or Page object, depending on the file type.</p>"
}
},
"Record" : {
"base" : "<p>Specifies the location of an occurrence of sensitive data in an Apache Avro object container or Apache Parquet file.</p>",
"refs" : {
"Records$member" : null
}
},
"Records" : {
"base" : "<p>Specifies the location of occurrences of sensitive data in an Apache Parquet file.</p>",
"refs" : {
"Occurrences$Records" : "<p>An array of objects, one for each occurrence of sensitive data in an Apache Avro object container or Apache Parquet file. Each object specifies the record index and the path to the field in the record that contains the data. This value is null for all other types of files.</p>"
}
},
"RelationshipStatus" : {
"base" : "<p>The current status of the relationship between an account and an associated Amazon Macie master account (<i>inviter account</i>). Possible values are:</p>",
"refs" : {
"GetMemberResponse$RelationshipStatus" : "<p>The current status of the relationship between the account and the master account.</p>",
"Invitation$RelationshipStatus" : "<p>The status of the relationship between the account that sent the invitation (<i>inviter account</i>) and the account that received the invitation (<i>invitee account</i>).</p>",
"Member$RelationshipStatus" : "<p>The current status of the relationship between the account and the master account.</p>"
}
},
"ReplicationDetails" : {
"base" : "<p>Provides information about settings that define whether one or more objects in an S3 bucket are replicated to S3 buckets for other AWS accounts and, if so, which accounts.</p>",
"refs" : {
"BucketMetadata$ReplicationDetails" : "<p>Specifies whether the bucket is configured to replicate one or more objects to buckets for other AWS accounts and, if so, which accounts.</p>"
}
},
"ResourceNotFoundException" : {
"base" : "<p>Provides information about an error that occurred because a specified resource wasn't found.</p>",
"refs" : { }
},
"ResourcesAffected" : {
"base" : "<p>Provides information about the resources that a finding applies to.</p>",
"refs" : {
"Finding$ResourcesAffected" : "<p>The resources that the finding applies to.</p>"
}
},
"S3Bucket" : {
"base" : "<p>Provides information about an S3 bucket that a finding applies to.</p>",
"refs" : {
"ResourcesAffected$S3Bucket" : "<p>An array of objects, one for each S3 bucket that the finding applies to. Each object provides a set of metadata about an affected S3 bucket.</p>"
}
},
"S3BucketDefinitionForJob" : {
"base" : "<p>Specifies which AWS account owns the S3 buckets that a classification job analyzes, and the buckets to analyze for the account.</p>",
"refs" : {
"__listOfS3BucketDefinitionForJob$member" : null
}
},
"S3BucketOwner" : {
"base" : "<p>Provides information about the user who owns an S3 bucket.</p>",
"refs" : {
"S3Bucket$Owner" : "<p>The display name and account identifier for the user who owns the bucket.</p>"
}
},
"S3Destination" : {
"base" : "<p>Specifies an S3 bucket to store data classification results in, and the encryption settings to use when storing results in that bucket.</p>",
"refs" : {
"ClassificationExportConfiguration$S3Destination" : "<p>The S3 bucket to store data classification results in, and the encryption settings to use when storing results in that bucket.</p>"
}
},
"S3JobDefinition" : {
"base" : "<p>Specifies which S3 buckets contain the objects that a classification job analyzes, and the scope of that analysis.</p>",
"refs" : {
"CreateClassificationJobRequest$S3JobDefinition" : "<p>The S3 buckets that contain the objects to analyze, and the scope of that analysis.</p>",
"DescribeClassificationJobResponse$S3JobDefinition" : "<p>The S3 buckets that the job is configured to analyze, and the scope of that analysis.</p>"
}
},
"S3Object" : {
"base" : "<p>Provides information about an S3 object that a finding applies to.</p>",
"refs" : {
"ResourcesAffected$S3Object" : "<p>An array of objects, one for each S3 object that the finding applies to. Each object provides a set of metadata about an affected S3 object.</p>"
}
},
"ScopeFilterKey" : {
"base" : "<p>The property to use in a condition that determines which objects are analyzed by a classification job. Valid values are:</p>",
"refs" : {
"SimpleScopeTerm$Key" : "<p>The object property to use in the condition.</p>"
}
},
"Scoping" : {
"base" : "<p>Specifies one or more property- and tag-based conditions that refine the scope of a classification job. These conditions define criteria that determine which objects a job analyzes. Exclude conditions take precedence over include conditions.</p>",
"refs" : {
"S3JobDefinition$Scoping" : "<p>The property- and tag-based conditions that determine which objects to include or exclude from the analysis.</p>"
}
},
"SensitiveData" : {
"base" : "<p>Provides information about the category and number of occurrences of sensitive data that produced a finding.</p>",
"refs" : {
"ClassificationResult$SensitiveData" : "<p>The category, types, and number of occurrences of the sensitive data that produced the finding.</p>"
}
},
"SensitiveDataItem" : {
"base" : "<p>Provides information about the category, types, and occurrences of sensitive data that produced a sensitive data finding.</p>",
"refs" : {
"SensitiveData$member" : null
}
},
"SensitiveDataItemCategory" : {