@aws-sdk/client-macie2 3.378.0 → 3.382.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.
@@ -18,10 +18,12 @@ export type AdminStatus = (typeof AdminStatus)[keyof typeof AdminStatus];
18
18
  */
19
19
  export interface AdminAccount {
20
20
  /**
21
+ * @public
21
22
  * <p>The Amazon Web Services account ID for the account.</p>
22
23
  */
23
24
  accountId?: string;
24
25
  /**
26
+ * @public
25
27
  * <p>The current status of the account as the delegated Amazon Macie administrator account for the organization.</p>
26
28
  */
27
29
  status?: AdminStatus | string;
@@ -32,26 +34,32 @@ export interface AdminAccount {
32
34
  */
33
35
  export interface AllowListSummary {
34
36
  /**
37
+ * @public
35
38
  * <p>The Amazon Resource Name (ARN) of the allow list.</p>
36
39
  */
37
40
  arn?: string;
38
41
  /**
42
+ * @public
39
43
  * <p>The date and time, in UTC and extended ISO 8601 format, when the allow list was created in Amazon Macie.</p>
40
44
  */
41
45
  createdAt?: Date;
42
46
  /**
47
+ * @public
43
48
  * <p>The custom description of the allow list.</p>
44
49
  */
45
50
  description?: string;
46
51
  /**
52
+ * @public
47
53
  * <p>The unique identifier for the allow list.</p>
48
54
  */
49
55
  id?: string;
50
56
  /**
57
+ * @public
51
58
  * <p>The custom name of the allow list.</p>
52
59
  */
53
60
  name?: string;
54
61
  /**
62
+ * @public
55
63
  * <p>The date and time, in UTC and extended ISO 8601 format, when the allow list's settings were most recently changed in Amazon Macie.</p>
56
64
  */
57
65
  updatedAt?: Date;
@@ -62,26 +70,32 @@ export interface AllowListSummary {
62
70
  */
63
71
  export interface BatchGetCustomDataIdentifierSummary {
64
72
  /**
73
+ * @public
65
74
  * <p>The Amazon Resource Name (ARN) of the custom data identifier.</p>
66
75
  */
67
76
  arn?: string;
68
77
  /**
78
+ * @public
69
79
  * <p>The date and time, in UTC and extended ISO 8601 format, when the custom data identifier was created.</p>
70
80
  */
71
81
  createdAt?: Date;
72
82
  /**
83
+ * @public
73
84
  * <p>Specifies whether the custom data identifier was deleted. If you delete a custom data identifier, Amazon Macie doesn't delete it permanently. Instead, it soft deletes the identifier.</p>
74
85
  */
75
86
  deleted?: boolean;
76
87
  /**
88
+ * @public
77
89
  * <p>The custom description of the custom data identifier.</p>
78
90
  */
79
91
  description?: string;
80
92
  /**
93
+ * @public
81
94
  * <p>The unique identifier for the custom data identifier.</p>
82
95
  */
83
96
  id?: string;
84
97
  /**
98
+ * @public
85
99
  * <p>The custom name of the custom data identifier.</p>
86
100
  */
87
101
  name?: string;
@@ -142,18 +156,22 @@ export type IsMonitoredByJob = (typeof IsMonitoredByJob)[keyof typeof IsMonitore
142
156
  */
143
157
  export interface JobDetails {
144
158
  /**
159
+ * @public
145
160
  * <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 - The bucket is explicitly included in the bucket definition (S3BucketDefinitionForJob) for one or more jobs and at least one of those jobs has a status other than CANCELLED. Or the bucket matched the bucket criteria (S3BucketCriteriaForJob) for at least one job that previously ran.</p></li> <li><p>FALSE - The bucket isn't explicitly included in the bucket definition (S3BucketDefinitionForJob) for any jobs, all the jobs that explicitly include the bucket in their bucket definitions have a status of CANCELLED, or the bucket didn't match the bucket criteria (S3BucketCriteriaForJob) for any jobs that previously ran.</p></li> <li><p>UNKNOWN - An exception occurred when Amazon Macie attempted to retrieve job data for the bucket.</p></li></ul>
146
161
  */
147
162
  isDefinedInJob?: IsDefinedInJob | string;
148
163
  /**
164
+ * @public
149
165
  * <p>Specifies whether any recurring jobs are configured to analyze data in the bucket. Possible values are:</p> <ul><li><p>TRUE - The bucket is explicitly included in the bucket definition (S3BucketDefinitionForJob) for one or more recurring jobs or the bucket matches the bucket criteria (S3BucketCriteriaForJob) for one or more recurring jobs. At least one of those jobs has a status other than CANCELLED.</p></li> <li><p>FALSE - The bucket isn't explicitly included in the bucket definition (S3BucketDefinitionForJob) for any recurring jobs, the bucket doesn't match the bucket criteria (S3BucketCriteriaForJob) for any recurring jobs, or all the recurring jobs that are configured to analyze data in the bucket have a status of CANCELLED.</p></li> <li><p>UNKNOWN - An exception occurred when Amazon Macie attempted to retrieve job data for the bucket.</p></li></ul>
150
166
  */
151
167
  isMonitoredByJob?: IsMonitoredByJob | string;
152
168
  /**
169
+ * @public
153
170
  * <p>The unique identifier for the job that ran most recently and is configured to analyze data in the bucket, either the latest run of a recurring job or the only run of a one-time job.</p> <p>This value is typically null if the value for the isDefinedInJob property is FALSE or UNKNOWN.</p>
154
171
  */
155
172
  lastJobId?: string;
156
173
  /**
174
+ * @public
157
175
  * <p>The date and time, in UTC and extended ISO 8601 format, when the job (lastJobId) started. If the job is a recurring job, this value indicates when the most recent run started.</p> <p>This value is typically null if the value for the isDefinedInJob property is FALSE or UNKNOWN.</p>
158
176
  */
159
177
  lastJobRunTime?: Date;
@@ -164,22 +182,27 @@ export interface JobDetails {
164
182
  */
165
183
  export interface ObjectCountByEncryptionType {
166
184
  /**
185
+ * @public
167
186
  * <p>The total number of objects that are encrypted with a customer-provided key. The objects use customer-provided server-side encryption (SSE-C).</p>
168
187
  */
169
188
  customerManaged?: number;
170
189
  /**
190
+ * @public
171
191
  * <p>The total number of objects that are encrypted with an KMS key, either an Amazon Web Services managed key or a customer managed key. The objects use KMS encryption (SSE-KMS).</p>
172
192
  */
173
193
  kmsManaged?: number;
174
194
  /**
195
+ * @public
175
196
  * <p>The total number of objects that are encrypted with an Amazon S3 managed key. The objects use Amazon S3 managed encryption (SSE-S3).</p>
176
197
  */
177
198
  s3Managed?: number;
178
199
  /**
200
+ * @public
179
201
  * <p>The total number of objects that use client-side encryption or aren't encrypted.</p>
180
202
  */
181
203
  unencrypted?: number;
182
204
  /**
205
+ * @public
183
206
  * <p>The total number of objects that Amazon Macie doesn't have current encryption metadata for. Macie can't provide current data about the encryption settings for these objects.</p>
184
207
  */
185
208
  unknown?: number;
@@ -203,18 +226,22 @@ export type EffectivePermission = (typeof EffectivePermission)[keyof typeof Effe
203
226
  */
204
227
  export interface BlockPublicAccess {
205
228
  /**
229
+ * @public
206
230
  * <p>Specifies whether Amazon S3 blocks public access control lists (ACLs) for the bucket and objects in the bucket.</p>
207
231
  */
208
232
  blockPublicAcls?: boolean;
209
233
  /**
234
+ * @public
210
235
  * <p>Specifies whether Amazon S3 blocks public bucket policies for the bucket.</p>
211
236
  */
212
237
  blockPublicPolicy?: boolean;
213
238
  /**
239
+ * @public
214
240
  * <p>Specifies whether Amazon S3 ignores public ACLs for the bucket and objects in the bucket.</p>
215
241
  */
216
242
  ignorePublicAcls?: boolean;
217
243
  /**
244
+ * @public
218
245
  * <p>Specifies whether Amazon S3 restricts public bucket policies for the bucket.</p>
219
246
  */
220
247
  restrictPublicBuckets?: boolean;
@@ -225,6 +252,7 @@ export interface BlockPublicAccess {
225
252
  */
226
253
  export interface AccountLevelPermissions {
227
254
  /**
255
+ * @public
228
256
  * <p>The block public access settings for the Amazon Web Services account that owns the bucket.</p>
229
257
  */
230
258
  blockPublicAccess?: BlockPublicAccess;
@@ -235,10 +263,12 @@ export interface AccountLevelPermissions {
235
263
  */
236
264
  export interface AccessControlList {
237
265
  /**
266
+ * @public
238
267
  * <p>Specifies whether the ACL grants the general public with read access permissions for the bucket.</p>
239
268
  */
240
269
  allowsPublicReadAccess?: boolean;
241
270
  /**
271
+ * @public
242
272
  * <p>Specifies whether the ACL grants the general public with write access permissions for the bucket.</p>
243
273
  */
244
274
  allowsPublicWriteAccess?: boolean;
@@ -249,10 +279,12 @@ export interface AccessControlList {
249
279
  */
250
280
  export interface BucketPolicy {
251
281
  /**
282
+ * @public
252
283
  * <p>Specifies whether the bucket policy allows the general public to have read access to the bucket.</p>
253
284
  */
254
285
  allowsPublicReadAccess?: boolean;
255
286
  /**
287
+ * @public
256
288
  * <p>Specifies whether the bucket policy allows the general public to have write access to the bucket.</p>
257
289
  */
258
290
  allowsPublicWriteAccess?: boolean;
@@ -263,14 +295,17 @@ export interface BucketPolicy {
263
295
  */
264
296
  export interface BucketLevelPermissions {
265
297
  /**
298
+ * @public
266
299
  * <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>
267
300
  */
268
301
  accessControlList?: AccessControlList;
269
302
  /**
303
+ * @public
270
304
  * <p>The block public access settings for the bucket.</p>
271
305
  */
272
306
  blockPublicAccess?: BlockPublicAccess;
273
307
  /**
308
+ * @public
274
309
  * <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>
275
310
  */
276
311
  bucketPolicy?: BucketPolicy;
@@ -281,10 +316,12 @@ export interface BucketLevelPermissions {
281
316
  */
282
317
  export interface BucketPermissionConfiguration {
283
318
  /**
319
+ * @public
284
320
  * <p>The account-level permissions settings that apply to the bucket.</p>
285
321
  */
286
322
  accountLevelPermissions?: AccountLevelPermissions;
287
323
  /**
324
+ * @public
288
325
  * <p>The bucket-level permissions settings for the bucket.</p>
289
326
  */
290
327
  bucketLevelPermissions?: BucketLevelPermissions;
@@ -295,10 +332,12 @@ export interface BucketPermissionConfiguration {
295
332
  */
296
333
  export interface BucketPublicAccess {
297
334
  /**
335
+ * @public
298
336
  * <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>
299
337
  */
300
338
  effectivePermission?: EffectivePermission | string;
301
339
  /**
340
+ * @public
302
341
  * <p>The account-level and bucket-level permissions settings for the bucket.</p>
303
342
  */
304
343
  permissionConfiguration?: BucketPermissionConfiguration;
@@ -309,14 +348,17 @@ export interface BucketPublicAccess {
309
348
  */
310
349
  export interface ReplicationDetails {
311
350
  /**
351
+ * @public
312
352
  * <p>Specifies whether the bucket is configured to replicate one or more objects to any destination.</p>
313
353
  */
314
354
  replicated?: boolean;
315
355
  /**
356
+ * @public
316
357
  * <p>Specifies whether the bucket is configured to replicate one or more objects to a bucket for an Amazon Web Services account that isn't part of your Amazon Macie organization. An <i>Amazon Macie organization</i> is a set of Macie accounts that are centrally managed as a group of related accounts through Organizations or by Macie invitation.</p>
317
358
  */
318
359
  replicatedExternally?: boolean;
319
360
  /**
361
+ * @public
320
362
  * <p>An array of Amazon Web Services account IDs, one for each Amazon Web Services account that owns a bucket that the bucket is configured to replicate one or more objects to.</p>
321
363
  */
322
364
  replicationAccounts?: string[];
@@ -340,10 +382,12 @@ export type Type = (typeof Type)[keyof typeof Type];
340
382
  */
341
383
  export interface BucketServerSideEncryption {
342
384
  /**
385
+ * @public
343
386
  * <p>The Amazon Resource Name (ARN) or unique identifier (key ID) for the KMS key that's used by default to encrypt objects that are added to the bucket. This value is null if the bucket is configured to use an Amazon S3 managed key to encrypt new objects.</p>
344
387
  */
345
388
  kmsMasterKeyId?: string;
346
389
  /**
390
+ * @public
347
391
  * <p>The server-side encryption algorithm that's used by default to encrypt objects that are added to the bucket. Possible values are:</p> <ul><li><p>AES256 - New objects are encrypted with an Amazon S3 managed key. They use SSE-S3 encryption.</p></li> <li><p>aws:kms - New objects are encrypted with an KMS key (kmsMasterKeyId), either an Amazon Web Services managed key or a customer managed key. They use SSE-KMS encryption.</p></li> <li><p>NONE - The bucket's default encryption settings don't specify server-side encryption behavior for new objects.</p></li></ul>
348
392
  */
349
393
  type?: Type | string;
@@ -368,10 +412,12 @@ export type SharedAccess = (typeof SharedAccess)[keyof typeof SharedAccess];
368
412
  */
369
413
  export interface KeyValuePair {
370
414
  /**
415
+ * @public
371
416
  * <p>One part of a key-value pair that comprises a tag. A tag key is a general label that acts as a category for more specific tag values.</p>
372
417
  */
373
418
  key?: string;
374
419
  /**
420
+ * @public
375
421
  * <p>One part of a key-value pair that comprises a tag. A tag value acts as a descriptor for a tag key. A tag value can be an empty string.</p>
376
422
  */
377
423
  value?: string;
@@ -382,14 +428,17 @@ export interface KeyValuePair {
382
428
  */
383
429
  export interface ObjectLevelStatistics {
384
430
  /**
431
+ * @public
385
432
  * <p>The total storage size (in bytes) or number of objects that Amazon Macie can't analyze because the objects don't have a file name extension for a supported file or storage format.</p>
386
433
  */
387
434
  fileType?: number;
388
435
  /**
436
+ * @public
389
437
  * <p>The total storage size (in bytes) or number of objects that Amazon Macie can't analyze because the objects use an unsupported storage class.</p>
390
438
  */
391
439
  storageClass?: number;
392
440
  /**
441
+ * @public
393
442
  * <p>The total storage size (in bytes) or number of objects that Amazon Macie can't analyze because the objects use an unsupported storage class or don't have a file name extension for a supported file or storage format.</p>
394
443
  */
395
444
  total?: number;
@@ -400,106 +449,132 @@ export interface ObjectLevelStatistics {
400
449
  */
401
450
  export interface BucketMetadata {
402
451
  /**
452
+ * @public
403
453
  * <p>The unique identifier for the Amazon Web Services account that owns the bucket.</p>
404
454
  */
405
455
  accountId?: string;
406
456
  /**
457
+ * @public
407
458
  * <p>Specifies whether the bucket policy for the bucket requires server-side encryption of objects when objects are added to the bucket. Possible values are:</p> <ul><li><p>FALSE - The bucket policy requires server-side encryption of new objects. PutObject requests must include a valid server-side encryption header.</p></li> <li><p>TRUE - The bucket doesn't have a bucket policy or it has a bucket policy that doesn't require server-side encryption of new objects. If a bucket policy exists, it doesn't require PutObject requests to include a valid server-side encryption header.</p></li> <li><p>UNKNOWN - Amazon Macie can't determine whether the bucket policy requires server-side encryption of new objects.</p></li></ul> <p>Valid server-side encryption headers are: x-amz-server-side-encryption with a value of AES256 or aws:kms, and x-amz-server-side-encryption-customer-algorithm with a value of AES256.</p>
408
459
  */
409
460
  allowsUnencryptedObjectUploads?: AllowsUnencryptedObjectUploads | string;
410
461
  /**
462
+ * @public
411
463
  * <p>The Amazon Resource Name (ARN) of the bucket.</p>
412
464
  */
413
465
  bucketArn?: string;
414
466
  /**
467
+ * @public
415
468
  * <p>The date and time, in UTC and extended ISO 8601 format, when the bucket was created. This value can also indicate when changes such as edits to the bucket's policy were most recently made to the bucket.</p>
416
469
  */
417
470
  bucketCreatedAt?: Date;
418
471
  /**
472
+ * @public
419
473
  * <p>The name of the bucket.</p>
420
474
  */
421
475
  bucketName?: string;
422
476
  /**
477
+ * @public
423
478
  * <p>The total number of objects that Amazon Macie can analyze in the bucket. These objects use a supported storage class and have a file name extension for a supported file or storage format.</p>
424
479
  */
425
480
  classifiableObjectCount?: number;
426
481
  /**
482
+ * @public
427
483
  * <p>The total storage size, in bytes, of the objects that Amazon Macie can analyze in the bucket. These objects use a supported storage class and have a file name extension for a supported file or storage format.</p> <p>If versioning is enabled for the bucket, Macie calculates this value based on the size of the latest version of each applicable object in the bucket. This value doesn't reflect the storage size of all versions of each applicable object in the bucket.</p>
428
484
  */
429
485
  classifiableSizeInBytes?: number;
430
486
  /**
487
+ * @public
431
488
  * <p>The error code for an error that prevented Amazon Macie from retrieving and processing information about the bucket and the bucket's objects. If this value is ACCESS_DENIED, Macie doesn't have permission to retrieve the information. For example, the bucket has a restrictive bucket policy and Amazon S3 denied the request. If this value is null, Macie was able to retrieve and process the information.</p>
432
489
  */
433
490
  errorCode?: BucketMetadataErrorCode | string;
434
491
  /**
492
+ * @public
435
493
  * <p>A brief description of the error (errorCode) that prevented Amazon Macie from retrieving and processing information about the bucket and the bucket's objects. This value is null if Macie was able to retrieve and process the information.</p>
436
494
  */
437
495
  errorMessage?: string;
438
496
  /**
497
+ * @public
439
498
  * <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>
440
499
  */
441
500
  jobDetails?: JobDetails;
442
501
  /**
502
+ * @public
443
503
  * <p>The date and time, in UTC and extended ISO 8601 format, when Amazon Macie most recently analyzed data in the bucket while performing automated sensitive data discovery for your account. This value is null if automated sensitive data discovery is currently disabled for your account.</p>
444
504
  */
445
505
  lastAutomatedDiscoveryTime?: Date;
446
506
  /**
507
+ * @public
447
508
  * <p>The date and time, in UTC and extended ISO 8601 format, when Amazon Macie most recently retrieved bucket or object metadata from Amazon S3 for the bucket.</p>
448
509
  */
449
510
  lastUpdated?: Date;
450
511
  /**
512
+ * @public
451
513
  * <p>The total number of objects in the bucket.</p>
452
514
  */
453
515
  objectCount?: number;
454
516
  /**
517
+ * @public
455
518
  * <p>The total number of objects in the bucket, grouped by server-side encryption type. This includes a grouping that reports the total number of objects that aren't encrypted or use client-side encryption.</p>
456
519
  */
457
520
  objectCountByEncryptionType?: ObjectCountByEncryptionType;
458
521
  /**
522
+ * @public
459
523
  * <p>Specifies whether the bucket is publicly accessible due to the combination of permissions settings that apply to the bucket, and provides information about those settings.</p>
460
524
  */
461
525
  publicAccess?: BucketPublicAccess;
462
526
  /**
527
+ * @public
463
528
  * <p>The Amazon Web Services Region that hosts the bucket.</p>
464
529
  */
465
530
  region?: string;
466
531
  /**
532
+ * @public
467
533
  * <p>Specifies whether the bucket is configured to replicate one or more objects to buckets for other Amazon Web Services accounts and, if so, which accounts.</p>
468
534
  */
469
535
  replicationDetails?: ReplicationDetails;
470
536
  /**
537
+ * @public
471
538
  * <p>The sensitivity score for the bucket, ranging from -1 (classification error) to 100 (sensitive). This value is null if automated sensitive data discovery is currently disabled for your account.</p>
472
539
  */
473
540
  sensitivityScore?: number;
474
541
  /**
542
+ * @public
475
543
  * <p>The default server-side encryption settings for the bucket.</p>
476
544
  */
477
545
  serverSideEncryption?: BucketServerSideEncryption;
478
546
  /**
547
+ * @public
479
548
  * <p>Specifies whether the bucket is shared with another Amazon Web Services account, an Amazon CloudFront origin access identity (OAI), or a CloudFront origin access control (OAC). Possible values are:</p> <ul><li><p>EXTERNAL - The bucket is shared with one or more of the following or any combination of the following: a CloudFront OAI, a CloudFront OAC, or an Amazon Web Services account that isn't part of your Amazon Macie organization.</p></li> <li><p>INTERNAL - The bucket is shared with one or more Amazon Web Services accounts that are part of your Amazon Macie organization. It isn't shared with a CloudFront OAI or OAC.</p></li> <li><p>NOT_SHARED - The bucket isn't shared with another Amazon Web Services account, a CloudFront OAI, or a CloudFront OAC.</p></li> <li><p>UNKNOWN - Amazon Macie wasn't able to evaluate the shared access settings for the bucket.</p></li></ul> <p>An <i>Amazon Macie organization</i> is a set of Macie accounts that are centrally managed as a group of related accounts through Organizations or by Macie invitation.</p>
480
549
  */
481
550
  sharedAccess?: SharedAccess | string;
482
551
  /**
552
+ * @public
483
553
  * <p>The total storage size, in bytes, of the bucket.</p> <p>If versioning is enabled for the bucket, Amazon Macie calculates this value based on the size of the latest version of each object in the bucket. This value doesn't reflect the storage size of all versions of each object in the bucket.</p>
484
554
  */
485
555
  sizeInBytes?: number;
486
556
  /**
557
+ * @public
487
558
  * <p>The total storage size, in bytes, of the objects that are compressed (.gz, .gzip, .zip) files in the bucket.</p> <p>If versioning is enabled for the bucket, Amazon Macie calculates this value based on the size of the latest version of each applicable object in the bucket. This value doesn't reflect the storage size of all versions of each applicable object in the bucket.</p>
488
559
  */
489
560
  sizeInBytesCompressed?: number;
490
561
  /**
562
+ * @public
491
563
  * <p>An array that specifies the tags (keys and values) that are associated with the bucket.</p>
492
564
  */
493
565
  tags?: KeyValuePair[];
494
566
  /**
567
+ * @public
495
568
  * <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>
496
569
  */
497
570
  unclassifiableObjectCount?: ObjectLevelStatistics;
498
571
  /**
572
+ * @public
499
573
  * <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>
500
574
  */
501
575
  unclassifiableObjectSizeInBytes?: ObjectLevelStatistics;
502
576
  /**
577
+ * @public
503
578
  * <p>Specifies whether versioning is enabled for the bucket.</p>
504
579
  */
505
580
  versioning?: boolean;
@@ -510,10 +585,12 @@ export interface BucketMetadata {
510
585
  */
511
586
  export interface ClassificationScopeSummary {
512
587
  /**
588
+ * @public
513
589
  * <p>The unique identifier for the classification scope.</p>
514
590
  */
515
591
  id?: string;
516
592
  /**
593
+ * @public
517
594
  * <p>The name of the classification scope: automated-sensitive-data-discovery.</p>
518
595
  */
519
596
  name?: string;
@@ -556,14 +633,17 @@ export type SimpleCriterionKeyForJob = (typeof SimpleCriterionKeyForJob)[keyof t
556
633
  */
557
634
  export interface SimpleCriterionForJob {
558
635
  /**
636
+ * @public
559
637
  * <p>The operator to use in the condition. Valid values are EQ (equals) and NE (not equals).</p>
560
638
  */
561
639
  comparator?: JobComparator | string;
562
640
  /**
641
+ * @public
563
642
  * <p>The property to use in the condition.</p>
564
643
  */
565
644
  key?: SimpleCriterionKeyForJob | string;
566
645
  /**
646
+ * @public
567
647
  * <p>An array that lists one or more values to use in the condition. If you specify multiple values, Amazon Macie uses OR logic to join the values. Valid values for each supported property (key) are:</p> <ul><li><p>ACCOUNT_ID - A string that represents the unique identifier for the Amazon Web Services account that owns the bucket.</p></li> <li><p>S3_BUCKET_EFFECTIVE_PERMISSION - A string that represents an enumerated value that Macie defines for the <a href="https://docs.aws.amazon.com/macie/latest/APIReference/datasources-s3.html#datasources-s3-prop-bucketpublicaccess-effectivepermission">BucketPublicAccess.effectivePermission</a> property of a bucket.</p></li> <li><p>S3_BUCKET_NAME - A string that represents the name of a bucket.</p></li> <li><p>S3_BUCKET_SHARED_ACCESS - A string that represents an enumerated value that Macie defines for the <a href="https://docs.aws.amazon.com/macie/latest/APIReference/datasources-s3.html#datasources-s3-prop-bucketmetadata-sharedaccess">BucketMetadata.sharedAccess</a> property of a bucket.</p></li></ul> <p>Values are case sensitive. Also, Macie doesn't support use of partial values or wildcard characters in these values.</p>
568
648
  */
569
649
  values?: string[];
@@ -574,10 +654,12 @@ export interface SimpleCriterionForJob {
574
654
  */
575
655
  export interface TagCriterionPairForJob {
576
656
  /**
657
+ * @public
577
658
  * <p>The value for the tag key to use in the condition.</p>
578
659
  */
579
660
  key?: string;
580
661
  /**
662
+ * @public
581
663
  * <p>The tag value to use in the condition.</p>
582
664
  */
583
665
  value?: string;
@@ -588,10 +670,12 @@ export interface TagCriterionPairForJob {
588
670
  */
589
671
  export interface TagCriterionForJob {
590
672
  /**
673
+ * @public
591
674
  * <p>The operator to use in the condition. Valid values are EQ (equals) and NE (not equals).</p>
592
675
  */
593
676
  comparator?: JobComparator | string;
594
677
  /**
678
+ * @public
595
679
  * <p>The tag keys, tag values, or tag key and value pairs to use in the condition.</p>
596
680
  */
597
681
  tagValues?: TagCriterionPairForJob[];
@@ -602,10 +686,12 @@ export interface TagCriterionForJob {
602
686
  */
603
687
  export interface CriteriaForJob {
604
688
  /**
689
+ * @public
605
690
  * <p>A property-based condition that defines a property, operator, and one or more values for including or excluding buckets from the job.</p>
606
691
  */
607
692
  simpleCriterion?: SimpleCriterionForJob;
608
693
  /**
694
+ * @public
609
695
  * <p>A tag-based condition that defines an operator and tag keys, tag values, or tag key and value pairs for including or excluding buckets from the job.</p>
610
696
  */
611
697
  tagCriterion?: TagCriterionForJob;
@@ -616,22 +702,27 @@ export interface CriteriaForJob {
616
702
  */
617
703
  export interface CustomDataIdentifierSummary {
618
704
  /**
705
+ * @public
619
706
  * <p>The Amazon Resource Name (ARN) of the custom data identifier.</p>
620
707
  */
621
708
  arn?: string;
622
709
  /**
710
+ * @public
623
711
  * <p>The date and time, in UTC and extended ISO 8601 format, when the custom data identifier was created.</p>
624
712
  */
625
713
  createdAt?: Date;
626
714
  /**
715
+ * @public
627
716
  * <p>The custom description of the custom data identifier.</p>
628
717
  */
629
718
  description?: string;
630
719
  /**
720
+ * @public
631
721
  * <p>The unique identifier for the custom data identifier.</p>
632
722
  */
633
723
  id?: string;
634
724
  /**
725
+ * @public
635
726
  * <p>The custom name of the custom data identifier.</p>
636
727
  */
637
728
  name?: string;
@@ -642,6 +733,7 @@ export interface CustomDataIdentifierSummary {
642
733
  */
643
734
  export interface DetectedDataDetails {
644
735
  /**
736
+ * @public
645
737
  * <p>An occurrence of the specified type of sensitive data. Each occurrence can contain 1-128 characters.</p>
646
738
  */
647
739
  value: string | undefined;
@@ -664,26 +756,32 @@ export type DataIdentifierType = (typeof DataIdentifierType)[keyof typeof DataId
664
756
  */
665
757
  export interface Detection {
666
758
  /**
759
+ * @public
667
760
  * <p>If the sensitive data was detected by a custom data identifier, the Amazon Resource Name (ARN) of the custom data identifier that detected the data. Otherwise, this value is null.</p>
668
761
  */
669
762
  arn?: string;
670
763
  /**
764
+ * @public
671
765
  * <p>The total number of occurrences of the sensitive data.</p>
672
766
  */
673
767
  count?: number;
674
768
  /**
769
+ * @public
675
770
  * <p>The unique identifier for the custom data identifier or managed data identifier that detected the sensitive data. For additional details about a specified managed data identifier, see <a href="https://docs.aws.amazon.com/macie/latest/user/managed-data-identifiers.html">Using managed data identifiers</a> in the <i>Amazon Macie User Guide</i>.</p>
676
771
  */
677
772
  id?: string;
678
773
  /**
774
+ * @public
679
775
  * <p>The name of the custom data identifier or managed data identifier that detected the sensitive data. For a managed data identifier, this value is the same as the unique identifier (id).</p>
680
776
  */
681
777
  name?: string;
682
778
  /**
779
+ * @public
683
780
  * <p>Specifies whether occurrences of this type of sensitive data are excluded (true) or included (false) in the bucket's sensitivity score.</p>
684
781
  */
685
782
  suppressed?: boolean;
686
783
  /**
784
+ * @public
687
785
  * <p>The type of data identifier that detected the sensitive data. Possible values are: CUSTOM, for a custom data identifier; and, MANAGED, for a managed data identifier.</p>
688
786
  */
689
787
  type?: DataIdentifierType | string;
@@ -718,18 +816,22 @@ export type OriginType = (typeof OriginType)[keyof typeof OriginType];
718
816
  */
719
817
  export interface Cell {
720
818
  /**
819
+ * @public
721
820
  * <p>The location of the cell, as an absolute cell reference, that contains the sensitive data, for example Sheet2!C5 for cell C5 on Sheet2 in a Microsoft Excel workbook. This value is null for CSV and TSV files.</p>
722
821
  */
723
822
  cellReference?: string;
724
823
  /**
824
+ * @public
725
825
  * <p>The column number of the column that contains the sensitive data. For a Microsoft Excel workbook, this value correlates to the alphabetical character(s) for a column identifier, for example: 1 for column A, 2 for column B, and so on.</p>
726
826
  */
727
827
  column?: number;
728
828
  /**
829
+ * @public
729
830
  * <p>The name of the column that contains the sensitive data, if available.</p>
730
831
  */
731
832
  columnName?: string;
732
833
  /**
834
+ * @public
733
835
  * <p>The row number of the row that contains the sensitive data.</p>
734
836
  */
735
837
  row?: number;
@@ -740,14 +842,17 @@ export interface Cell {
740
842
  */
741
843
  export interface Range {
742
844
  /**
845
+ * @public
743
846
  * <p>The number of lines from the beginning of the file to the end of the sensitive data.</p>
744
847
  */
745
848
  end?: number;
746
849
  /**
850
+ * @public
747
851
  * <p>The number of lines from the beginning of the file to the beginning of the sensitive data.</p>
748
852
  */
749
853
  start?: number;
750
854
  /**
855
+ * @public
751
856
  * <p>The number of characters, with spaces and starting from 1, from the beginning of the first line that contains the sensitive data (start) to the beginning of the sensitive data.</p>
752
857
  */
753
858
  startColumn?: number;
@@ -758,14 +863,17 @@ export interface Range {
758
863
  */
759
864
  export interface Page {
760
865
  /**
866
+ * @public
761
867
  * <p>Reserved for future use.</p>
762
868
  */
763
869
  lineRange?: Range;
764
870
  /**
871
+ * @public
765
872
  * <p>Reserved for future use.</p>
766
873
  */
767
874
  offsetRange?: Range;
768
875
  /**
876
+ * @public
769
877
  * <p>The page number of the page that contains the sensitive data.</p>
770
878
  */
771
879
  pageNumber?: number;
@@ -776,10 +884,12 @@ export interface Page {
776
884
  */
777
885
  export interface _Record {
778
886
  /**
887
+ * @public
779
888
  * <p>The path, as a JSONPath expression, to the sensitive data. For an Avro object container or Parquet file, this is the path to the field in the record (recordIndex) that contains the data. For a JSON or JSON Lines file, this is the path to the field or array that contains the data. If the data is a value in an array, the path also indicates which value contains the data.</p> <p>If Amazon Macie detects sensitive data in the name of any element in the path, Macie omits this field. If the name of an element exceeds 20 characters, Macie truncates the name by removing characters from the beginning of the name. If the resulting full path exceeds 250 characters, Macie also truncates the path, starting with the first element in the path, until the path contains 250 or fewer characters.</p>
780
889
  */
781
890
  jsonPath?: string;
782
891
  /**
892
+ * @public
783
893
  * <p>For an Avro object container or Parquet file, the record index, starting from 0, for the record that contains the sensitive data. For a JSON Lines file, the line index, starting from 0, for the line that contains the sensitive data. This value is always 0 for JSON files.</p>
784
894
  */
785
895
  recordIndex?: number;
@@ -790,22 +900,27 @@ export interface _Record {
790
900
  */
791
901
  export interface Occurrences {
792
902
  /**
903
+ * @public
793
904
  * <p>An array of objects, one for each occurrence of sensitive data in a Microsoft Excel workbook, CSV file, or TSV file. This value is null for all other types of files.</p> <p>Each Cell object specifies a cell or field that contains the sensitive data.</p>
794
905
  */
795
906
  cells?: Cell[];
796
907
  /**
908
+ * @public
797
909
  * <p>An array of objects, one for each occurrence of sensitive data in an email message or a non-binary text file such as an HTML, TXT, or XML file. Each Range object specifies a line or inclusive range of lines that contains the sensitive data, and the position of the data on the specified line or lines.</p> <p>This value is often null for file types that are supported by Cell, Page, or Record objects. Exceptions are the location of sensitive data in: unstructured sections of an otherwise structured file, such as a comment in a file; a malformed file that Amazon Macie analyzes as plain text; and, a CSV or TSV file that has any column names that contain sensitive data.</p>
798
910
  */
799
911
  lineRanges?: Range[];
800
912
  /**
913
+ * @public
801
914
  * <p>Reserved for future use.</p>
802
915
  */
803
916
  offsetRanges?: Range[];
804
917
  /**
918
+ * @public
805
919
  * <p>An array of objects, one for each occurrence of sensitive data in an Adobe Portable Document Format file. This value is null for all other types of files.</p> <p>Each Page object specifies a page that contains the sensitive data.</p>
806
920
  */
807
921
  pages?: Page[];
808
922
  /**
923
+ * @public
809
924
  * <p>An array of objects, one for each occurrence of sensitive data in an Apache Avro object container, Apache Parquet file, JSON file, or JSON Lines file. This value is null for all other types of files.</p> <p>For an Avro object container or Parquet file, each Record object specifies a record index and the path to a field in a record that contains the sensitive data. For a JSON or JSON Lines file, each Record object specifies the path to a field or array that contains the sensitive data. For a JSON Lines file, it also specifies the index of the line that contains the data.</p>
810
925
  */
811
926
  records?: _Record[];
@@ -816,18 +931,22 @@ export interface Occurrences {
816
931
  */
817
932
  export interface CustomDetection {
818
933
  /**
934
+ * @public
819
935
  * <p>The unique identifier for the custom data identifier.</p>
820
936
  */
821
937
  arn?: string;
822
938
  /**
939
+ * @public
823
940
  * <p>The total number of occurrences of the sensitive data that the custom data identifier detected.</p>
824
941
  */
825
942
  count?: number;
826
943
  /**
944
+ * @public
827
945
  * <p>The name of the custom data identifier.</p>
828
946
  */
829
947
  name?: string;
830
948
  /**
949
+ * @public
831
950
  * <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>
832
951
  */
833
952
  occurrences?: Occurrences;
@@ -838,10 +957,12 @@ export interface CustomDetection {
838
957
  */
839
958
  export interface CustomDataIdentifiers {
840
959
  /**
960
+ * @public
841
961
  * <p>The custom data identifiers that detected the data, and the number of occurrences of the data that each identifier detected.</p>
842
962
  */
843
963
  detections?: CustomDetection[];
844
964
  /**
965
+ * @public
845
966
  * <p>The total number of occurrences of the data that was detected by the custom data identifiers and produced the finding.</p>
846
967
  */
847
968
  totalCount?: number;
@@ -866,14 +987,17 @@ export type SensitiveDataItemCategory = (typeof SensitiveDataItemCategory)[keyof
866
987
  */
867
988
  export interface DefaultDetection {
868
989
  /**
990
+ * @public
869
991
  * <p>The total number of occurrences of the type of sensitive data that was detected.</p>
870
992
  */
871
993
  count?: number;
872
994
  /**
995
+ * @public
873
996
  * <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>
874
997
  */
875
998
  occurrences?: Occurrences;
876
999
  /**
1000
+ * @public
877
1001
  * <p>The type of sensitive data that was detected. For example, AWS_CREDENTIALS, PHONE_NUMBER, or ADDRESS.</p>
878
1002
  */
879
1003
  type?: string;
@@ -884,14 +1008,17 @@ export interface DefaultDetection {
884
1008
  */
885
1009
  export interface SensitiveDataItem {
886
1010
  /**
1011
+ * @public
887
1012
  * <p>The category of sensitive data that was detected. For example: CREDENTIALS, for credentials data such as private keys or Amazon Web Services secret access keys; FINANCIAL_INFORMATION, for financial data such as credit card numbers; or, PERSONAL_INFORMATION, for personal health information, such as health insurance identification numbers, or personally identifiable information, such as passport numbers.</p>
888
1013
  */
889
1014
  category?: SensitiveDataItemCategory | string;
890
1015
  /**
1016
+ * @public
891
1017
  * <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>
892
1018
  */
893
1019
  detections?: DefaultDetection[];
894
1020
  /**
1021
+ * @public
895
1022
  * <p>The total number of occurrences of the sensitive data that was detected.</p>
896
1023
  */
897
1024
  totalCount?: number;
@@ -902,10 +1029,12 @@ export interface SensitiveDataItem {
902
1029
  */
903
1030
  export interface ClassificationResultStatus {
904
1031
  /**
1032
+ * @public
905
1033
  * <p>The status of the finding. Possible values are:</p> <ul><li><p>COMPLETE - Amazon Macie successfully completed its analysis of the S3 object that the finding applies to.</p></li> <li><p>PARTIAL - Macie analyzed only a subset of the data in the S3 object that the finding applies to. For example, the object is an archive file that contains files in an unsupported format.</p></li> <li><p>SKIPPED - Macie wasn't able to analyze the S3 object that the finding applies to. For example, the object is a file that uses an unsupported format.</p></li></ul>
906
1034
  */
907
1035
  code?: string;
908
1036
  /**
1037
+ * @public
909
1038
  * <p>A brief description of the status of the finding. This value is null if the status (code) of the finding is COMPLETE.</p> <p>Amazon Macie uses this value to notify you of any errors, warnings, or considerations that might impact your analysis of the finding and the affected S3 object. Possible values are:</p> <ul><li><p>ARCHIVE_CONTAINS_UNPROCESSED_FILES - The object is an archive file and Macie extracted and analyzed only some or none of the files in the archive. To determine which files Macie analyzed, if any, refer to the corresponding sensitive data discovery result for the finding (classificationDetails.detailedResultsLocation).</p></li> <li><p>ARCHIVE_EXCEEDS_SIZE_LIMIT - The object is an archive file whose total storage size exceeds the size quota for this type of archive.</p></li> <li><p>ARCHIVE_NESTING_LEVEL_OVER_LIMIT - The object is an archive file whose nested depth exceeds the quota for the maximum number of nested levels that Macie analyzes for this type of archive.</p></li> <li><p>ARCHIVE_TOTAL_BYTES_EXTRACTED_OVER_LIMIT - The object is an archive file that exceeds the quota for the maximum amount of data that Macie extracts and analyzes for this type of archive.</p></li> <li><p>ARCHIVE_TOTAL_DOCUMENTS_PROCESSED_OVER_LIMIT - The object is an archive file that contains more than the maximum number of files that Macie extracts and analyzes for this type of archive.</p></li> <li><p>FILE_EXCEEDS_SIZE_LIMIT - The storage size of the object exceeds the size quota for this type of file.</p></li> <li><p>INVALID_ENCRYPTION - The object is encrypted using server-side encryption but Macie isn't allowed to use the key. Macie can't decrypt and analyze the object.</p></li> <li><p>INVALID_KMS_KEY - The object is encrypted with an KMS key that was disabled or is being deleted. Macie can't decrypt and analyze the object.</p></li> <li><p>INVALID_OBJECT_STATE - The object doesn't use a supported Amazon S3 storage class.</p></li> <li><p>JSON_NESTING_LEVEL_OVER_LIMIT - The object contains JSON data and the nested depth of the data exceeds the quota for the number of nested levels that Macie analyzes for this type of file.</p></li> <li><p>MALFORMED_FILE - The object is a malformed or corrupted file. An error occurred when Macie attempted to detect the file's type or extract data from the file.</p></li> <li><p>MALFORMED_OR_FILE_SIZE_EXCEEDS_LIMIT - The object is a Microsoft Office file that is malformed or exceeds the size quota for this type of file. If the file is malformed, an error occurred when Macie attempted to extract data from the file.</p></li> <li><p>NO_SUCH_BUCKET_AVAILABLE - The object was in a bucket that was deleted shortly before or when Macie attempted to analyze the object.</p></li> <li><p>OBJECT_VERSION_MISMATCH - The object was changed while Macie was analyzing it.</p></li> <li><p>OOXML_UNCOMPRESSED_RATIO_EXCEEDS_LIMIT - The object is an Office Open XML file whose compression ratio exceeds the compression quota for this type of file.</p></li> <li><p>OOXML_UNCOMPRESSED_SIZE_EXCEEDS_LIMIT - The object is an Office Open XML file that exceeds the size quota for this type of file.</p></li> <li><p>PERMISSION_DENIED - Macie isn't allowed to access the object. The object's permissions settings prevent Macie from analyzing the object.</p></li> <li><p>SOURCE_OBJECT_NO_LONGER_AVAILABLE - The object was deleted shortly before or when Macie attempted to analyze it.</p></li> <li><p>TIME_CUT_OFF_REACHED - Macie started analyzing the object but additional analysis would exceed the time quota for analyzing an object.</p></li> <li><p>UNABLE_TO_PARSE_FILE - The object is a file that contains structured data and an error occurred when Macie attempted to parse the data.</p></li> <li><p>UNSUPPORTED_FILE_TYPE_EXCEPTION - The object is a file that uses an unsupported file or storage format.</p></li></ul> <p>For information about quotas, supported storage classes, and supported file and storage formats, see <a href="https://docs.aws.amazon.com/macie/latest/user/macie-quotas.html">Quotas</a> and <a href="https://docs.aws.amazon.com/macie/latest/user/discovery-supported-storage.html">Supported storage classes and formats</a> in the <i>Amazon Macie User Guide</i>.</p>
910
1039
  */
911
1040
  reason?: string;
@@ -916,26 +1045,32 @@ export interface ClassificationResultStatus {
916
1045
  */
917
1046
  export interface ClassificationResult {
918
1047
  /**
1048
+ * @public
919
1049
  * <p>Specifies whether Amazon Macie detected additional occurrences of sensitive data in the S3 object. A finding includes location data for a maximum of 15 occurrences of sensitive data.</p> <p>This value can help you determine whether to investigate additional occurrences of sensitive data in an object. You can do this by referring to the corresponding sensitive data discovery result for the finding (classificationDetails.detailedResultsLocation).</p>
920
1050
  */
921
1051
  additionalOccurrences?: boolean;
922
1052
  /**
1053
+ * @public
923
1054
  * <p>The custom data identifiers that detected the sensitive data and the number of occurrences of the data that they detected.</p>
924
1055
  */
925
1056
  customDataIdentifiers?: CustomDataIdentifiers;
926
1057
  /**
1058
+ * @public
927
1059
  * <p>The type of content, as a MIME type, that the finding applies to. For example, application/gzip, for a GNU Gzip compressed archive file, or application/pdf, for an Adobe Portable Document Format file.</p>
928
1060
  */
929
1061
  mimeType?: string;
930
1062
  /**
1063
+ * @public
931
1064
  * <p>The category, types, and number of occurrences of the sensitive data that produced the finding.</p>
932
1065
  */
933
1066
  sensitiveData?: SensitiveDataItem[];
934
1067
  /**
1068
+ * @public
935
1069
  * <p>The total size, in bytes, of the data that the finding applies to.</p>
936
1070
  */
937
1071
  sizeClassified?: number;
938
1072
  /**
1073
+ * @public
939
1074
  * <p>The status of the finding.</p>
940
1075
  */
941
1076
  status?: ClassificationResultStatus;
@@ -946,22 +1081,27 @@ export interface ClassificationResult {
946
1081
  */
947
1082
  export interface ClassificationDetails {
948
1083
  /**
1084
+ * @public
949
1085
  * <p>The path to the folder or file in Amazon S3 that contains the corresponding sensitive data discovery result for the finding. If a finding applies to a large archive or compressed file, this value is the path to a folder. Otherwise, this value is the path to a file.</p>
950
1086
  */
951
1087
  detailedResultsLocation?: string;
952
1088
  /**
1089
+ * @public
953
1090
  * <p>The Amazon Resource Name (ARN) of the classification job that produced the finding. This value is null if the origin of the finding (originType) is AUTOMATED_SENSITIVE_DATA_DISCOVERY.</p>
954
1091
  */
955
1092
  jobArn?: string;
956
1093
  /**
1094
+ * @public
957
1095
  * <p>The unique identifier for the classification job that produced the finding. This value is null if the origin of the finding (originType) is AUTOMATED_SENSITIVE_DATA_DISCOVERY.</p>
958
1096
  */
959
1097
  jobId?: string;
960
1098
  /**
1099
+ * @public
961
1100
  * <p>Specifies how Amazon Macie found the sensitive data that produced the finding. Possible values are: SENSITIVE_DATA_DISCOVERY_JOB, for a classification job; and, AUTOMATED_SENSITIVE_DATA_DISCOVERY, for automated sensitive data discovery.</p>
962
1101
  */
963
1102
  originType?: OriginType | string;
964
1103
  /**
1104
+ * @public
965
1105
  * <p>The status and other details of the finding.</p>
966
1106
  */
967
1107
  result?: ClassificationResult;
@@ -983,18 +1123,22 @@ export type FindingActionType = (typeof FindingActionType)[keyof typeof FindingA
983
1123
  */
984
1124
  export interface ApiCallDetails {
985
1125
  /**
1126
+ * @public
986
1127
  * <p>The name of the operation that was invoked most recently and produced the finding.</p>
987
1128
  */
988
1129
  api?: string;
989
1130
  /**
1131
+ * @public
990
1132
  * <p>The URL of the Amazon Web Service that provides the operation, for example: s3.amazonaws.com.</p>
991
1133
  */
992
1134
  apiServiceName?: string;
993
1135
  /**
1136
+ * @public
994
1137
  * <p>The first date and time, in UTC and extended ISO 8601 format, when any operation was invoked and produced the finding.</p>
995
1138
  */
996
1139
  firstSeen?: Date;
997
1140
  /**
1141
+ * @public
998
1142
  * <p>The most recent date and time, in UTC and extended ISO 8601 format, when the specified operation (api) was invoked and produced the finding.</p>
999
1143
  */
1000
1144
  lastSeen?: Date;
@@ -1005,10 +1149,12 @@ export interface ApiCallDetails {
1005
1149
  */
1006
1150
  export interface FindingAction {
1007
1151
  /**
1152
+ * @public
1008
1153
  * <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>
1009
1154
  */
1010
1155
  actionType?: FindingActionType | string;
1011
1156
  /**
1157
+ * @public
1012
1158
  * <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>
1013
1159
  */
1014
1160
  apiCallDetails?: ApiCallDetails;
@@ -1019,6 +1165,7 @@ export interface FindingAction {
1019
1165
  */
1020
1166
  export interface DomainDetails {
1021
1167
  /**
1168
+ * @public
1022
1169
  * <p>The name of the domain.</p>
1023
1170
  */
1024
1171
  domainName?: string;
@@ -1029,6 +1176,7 @@ export interface DomainDetails {
1029
1176
  */
1030
1177
  export interface IpCity {
1031
1178
  /**
1179
+ * @public
1032
1180
  * <p>The name of the city.</p>
1033
1181
  */
1034
1182
  name?: string;
@@ -1039,10 +1187,12 @@ export interface IpCity {
1039
1187
  */
1040
1188
  export interface IpCountry {
1041
1189
  /**
1190
+ * @public
1042
1191
  * <p>The two-character code, in ISO 3166-1 alpha-2 format, for the country that the IP address originated from. For example, US for the United States.</p>
1043
1192
  */
1044
1193
  code?: string;
1045
1194
  /**
1195
+ * @public
1046
1196
  * <p>The name of the country that the IP address originated from.</p>
1047
1197
  */
1048
1198
  name?: string;
@@ -1053,10 +1203,12 @@ export interface IpCountry {
1053
1203
  */
1054
1204
  export interface IpGeoLocation {
1055
1205
  /**
1206
+ * @public
1056
1207
  * <p>The latitude coordinate of the location, rounded to four decimal places.</p>
1057
1208
  */
1058
1209
  lat?: number;
1059
1210
  /**
1211
+ * @public
1060
1212
  * <p>The longitude coordinate of the location, rounded to four decimal places.</p>
1061
1213
  */
1062
1214
  lon?: number;
@@ -1067,18 +1219,22 @@ export interface IpGeoLocation {
1067
1219
  */
1068
1220
  export interface IpOwner {
1069
1221
  /**
1222
+ * @public
1070
1223
  * <p>The autonomous system number (ASN) for the autonomous system that included the IP address.</p>
1071
1224
  */
1072
1225
  asn?: string;
1073
1226
  /**
1227
+ * @public
1074
1228
  * <p>The organization identifier that's associated with the autonomous system number (ASN) for the autonomous system that included the IP address.</p>
1075
1229
  */
1076
1230
  asnOrg?: string;
1077
1231
  /**
1232
+ * @public
1078
1233
  * <p>The name of the internet service provider (ISP) that owned the IP address.</p>
1079
1234
  */
1080
1235
  isp?: string;
1081
1236
  /**
1237
+ * @public
1082
1238
  * <p>The name of the organization that owned the IP address.</p>
1083
1239
  */
1084
1240
  org?: string;
@@ -1089,22 +1245,27 @@ export interface IpOwner {
1089
1245
  */
1090
1246
  export interface IpAddressDetails {
1091
1247
  /**
1248
+ * @public
1092
1249
  * <p>The Internet Protocol version 4 (IPv4) address of the device.</p>
1093
1250
  */
1094
1251
  ipAddressV4?: string;
1095
1252
  /**
1253
+ * @public
1096
1254
  * <p>The city that the IP address originated from.</p>
1097
1255
  */
1098
1256
  ipCity?: IpCity;
1099
1257
  /**
1258
+ * @public
1100
1259
  * <p>The country that the IP address originated from.</p>
1101
1260
  */
1102
1261
  ipCountry?: IpCountry;
1103
1262
  /**
1263
+ * @public
1104
1264
  * <p>The geographic coordinates of the location that the IP address originated from.</p>
1105
1265
  */
1106
1266
  ipGeoLocation?: IpGeoLocation;
1107
1267
  /**
1268
+ * @public
1108
1269
  * <p>The registered owner of the IP address.</p>
1109
1270
  */
1110
1271
  ipOwner?: IpOwner;
@@ -1115,10 +1276,12 @@ export interface IpAddressDetails {
1115
1276
  */
1116
1277
  export interface SessionContextAttributes {
1117
1278
  /**
1279
+ * @public
1118
1280
  * <p>The date and time, in UTC and ISO 8601 format, when the credentials were issued.</p>
1119
1281
  */
1120
1282
  creationDate?: Date;
1121
1283
  /**
1284
+ * @public
1122
1285
  * <p>Specifies whether the credentials were authenticated with a multi-factor authentication (MFA) device.</p>
1123
1286
  */
1124
1287
  mfaAuthenticated?: boolean;
@@ -1129,22 +1292,27 @@ export interface SessionContextAttributes {
1129
1292
  */
1130
1293
  export interface SessionIssuer {
1131
1294
  /**
1295
+ * @public
1132
1296
  * <p>The unique identifier for the Amazon Web Services account that owns the entity that was used to get the credentials.</p>
1133
1297
  */
1134
1298
  accountId?: string;
1135
1299
  /**
1300
+ * @public
1136
1301
  * <p>The Amazon Resource Name (ARN) of the source account, Identity and Access Management (IAM) user, or role that was used to get the credentials.</p>
1137
1302
  */
1138
1303
  arn?: string;
1139
1304
  /**
1305
+ * @public
1140
1306
  * <p>The unique identifier for the entity that was used to get the credentials.</p>
1141
1307
  */
1142
1308
  principalId?: string;
1143
1309
  /**
1310
+ * @public
1144
1311
  * <p>The source of the temporary security credentials, such as Root, IAMUser, or Role.</p>
1145
1312
  */
1146
1313
  type?: string;
1147
1314
  /**
1315
+ * @public
1148
1316
  * <p>The name or alias of the user or role that issued the session. This value is null if the credentials were obtained from a root account that doesn't have an alias.</p>
1149
1317
  */
1150
1318
  userName?: string;
@@ -1155,10 +1323,12 @@ export interface SessionIssuer {
1155
1323
  */
1156
1324
  export interface SessionContext {
1157
1325
  /**
1326
+ * @public
1158
1327
  * <p>The date and time when the credentials were issued, and whether the credentials were authenticated with a multi-factor authentication (MFA) device.</p>
1159
1328
  */
1160
1329
  attributes?: SessionContextAttributes;
1161
1330
  /**
1331
+ * @public
1162
1332
  * <p>The source and type of credentials that were issued to the entity.</p>
1163
1333
  */
1164
1334
  sessionIssuer?: SessionIssuer;
@@ -1169,22 +1339,27 @@ export interface SessionContext {
1169
1339
  */
1170
1340
  export interface AssumedRole {
1171
1341
  /**
1342
+ * @public
1172
1343
  * <p>The Amazon Web Services access key ID that identifies the credentials.</p>
1173
1344
  */
1174
1345
  accessKeyId?: string;
1175
1346
  /**
1347
+ * @public
1176
1348
  * <p>The unique identifier for the Amazon Web Services account that owns the entity that was used to get the credentials.</p>
1177
1349
  */
1178
1350
  accountId?: string;
1179
1351
  /**
1352
+ * @public
1180
1353
  * <p>The Amazon Resource Name (ARN) of the entity that was used to get the credentials.</p>
1181
1354
  */
1182
1355
  arn?: string;
1183
1356
  /**
1357
+ * @public
1184
1358
  * <p>The unique identifier for the entity that was used to get the credentials.</p>
1185
1359
  */
1186
1360
  principalId?: string;
1187
1361
  /**
1362
+ * @public
1188
1363
  * <p>The details of the session that was created for the credentials, including the entity that issued the session.</p>
1189
1364
  */
1190
1365
  sessionContext?: SessionContext;
@@ -1195,10 +1370,12 @@ export interface AssumedRole {
1195
1370
  */
1196
1371
  export interface AwsAccount {
1197
1372
  /**
1373
+ * @public
1198
1374
  * <p>The unique identifier for the Amazon Web Services account.</p>
1199
1375
  */
1200
1376
  accountId?: string;
1201
1377
  /**
1378
+ * @public
1202
1379
  * <p>The unique identifier for the entity that performed the action.</p>
1203
1380
  */
1204
1381
  principalId?: string;
@@ -1209,6 +1386,7 @@ export interface AwsAccount {
1209
1386
  */
1210
1387
  export interface AwsService {
1211
1388
  /**
1389
+ * @public
1212
1390
  * <p>The name of the Amazon Web Service that performed the action.</p>
1213
1391
  */
1214
1392
  invokedBy?: string;
@@ -1219,22 +1397,27 @@ export interface AwsService {
1219
1397
  */
1220
1398
  export interface FederatedUser {
1221
1399
  /**
1400
+ * @public
1222
1401
  * <p>The Amazon Web Services access key ID that identifies the credentials.</p>
1223
1402
  */
1224
1403
  accessKeyId?: string;
1225
1404
  /**
1405
+ * @public
1226
1406
  * <p>The unique identifier for the Amazon Web Services account that owns the entity that was used to get the credentials.</p>
1227
1407
  */
1228
1408
  accountId?: string;
1229
1409
  /**
1410
+ * @public
1230
1411
  * <p>The Amazon Resource Name (ARN) of the entity that was used to get the credentials.</p>
1231
1412
  */
1232
1413
  arn?: string;
1233
1414
  /**
1415
+ * @public
1234
1416
  * <p>The unique identifier for the entity that was used to get the credentials.</p>
1235
1417
  */
1236
1418
  principalId?: string;
1237
1419
  /**
1420
+ * @public
1238
1421
  * <p>The details of the session that was created for the credentials, including the entity that issued the session.</p>
1239
1422
  */
1240
1423
  sessionContext?: SessionContext;
@@ -1245,18 +1428,22 @@ export interface FederatedUser {
1245
1428
  */
1246
1429
  export interface IamUser {
1247
1430
  /**
1431
+ * @public
1248
1432
  * <p>The unique identifier for the Amazon Web Services account that's associated with the IAM user who performed the action.</p>
1249
1433
  */
1250
1434
  accountId?: string;
1251
1435
  /**
1436
+ * @public
1252
1437
  * <p>The Amazon Resource Name (ARN) of the principal that performed the action. The last section of the ARN contains the name of the user who performed the action.</p>
1253
1438
  */
1254
1439
  arn?: string;
1255
1440
  /**
1441
+ * @public
1256
1442
  * <p>The unique identifier for the IAM user who performed the action.</p>
1257
1443
  */
1258
1444
  principalId?: string;
1259
1445
  /**
1446
+ * @public
1260
1447
  * <p>The username of the IAM user who performed the action.</p>
1261
1448
  */
1262
1449
  userName?: string;
@@ -1267,14 +1454,17 @@ export interface IamUser {
1267
1454
  */
1268
1455
  export interface UserIdentityRoot {
1269
1456
  /**
1457
+ * @public
1270
1458
  * <p>The unique identifier for the Amazon Web Services account.</p>
1271
1459
  */
1272
1460
  accountId?: string;
1273
1461
  /**
1462
+ * @public
1274
1463
  * <p>The Amazon Resource Name (ARN) of the principal that performed the action. The last section of the ARN contains the name of the user or role that performed the action.</p>
1275
1464
  */
1276
1465
  arn?: string;
1277
1466
  /**
1467
+ * @public
1278
1468
  * <p>The unique identifier for the entity that performed the action.</p>
1279
1469
  */
1280
1470
  principalId?: string;
@@ -1301,30 +1491,37 @@ export type UserIdentityType = (typeof UserIdentityType)[keyof typeof UserIdenti
1301
1491
  */
1302
1492
  export interface UserIdentity {
1303
1493
  /**
1494
+ * @public
1304
1495
  * <p>If the action was performed with temporary security credentials that were obtained using the AssumeRole operation of the Security Token Service (STS) API, the identifiers, session context, and other details about the identity.</p>
1305
1496
  */
1306
1497
  assumedRole?: AssumedRole;
1307
1498
  /**
1499
+ * @public
1308
1500
  * <p>If the action was performed using the credentials for another Amazon Web Services account, the details of that account.</p>
1309
1501
  */
1310
1502
  awsAccount?: AwsAccount;
1311
1503
  /**
1504
+ * @public
1312
1505
  * <p>If the action was performed by an Amazon Web Services account that belongs to an Amazon Web Service, the name of the service.</p>
1313
1506
  */
1314
1507
  awsService?: AwsService;
1315
1508
  /**
1509
+ * @public
1316
1510
  * <p>If the action was performed with temporary security credentials that were obtained using the GetFederationToken operation of the Security Token Service (STS) API, the identifiers, session context, and other details about the identity.</p>
1317
1511
  */
1318
1512
  federatedUser?: FederatedUser;
1319
1513
  /**
1514
+ * @public
1320
1515
  * <p>If the action was performed using the credentials for an Identity and Access Management (IAM) user, the name and other details about the user.</p>
1321
1516
  */
1322
1517
  iamUser?: IamUser;
1323
1518
  /**
1519
+ * @public
1324
1520
  * <p>If the action was performed using the credentials for your Amazon Web Services account, the details of your account.</p>
1325
1521
  */
1326
1522
  root?: UserIdentityRoot;
1327
1523
  /**
1524
+ * @public
1328
1525
  * <p>The type of entity that performed the action.</p>
1329
1526
  */
1330
1527
  type?: UserIdentityType | string;
@@ -1335,14 +1532,17 @@ export interface UserIdentity {
1335
1532
  */
1336
1533
  export interface FindingActor {
1337
1534
  /**
1535
+ * @public
1338
1536
  * <p>The domain name of the device that the entity used to perform the action on the affected resource.</p>
1339
1537
  */
1340
1538
  domainDetails?: DomainDetails;
1341
1539
  /**
1540
+ * @public
1342
1541
  * <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>
1343
1542
  */
1344
1543
  ipAddressDetails?: IpAddressDetails;
1345
1544
  /**
1545
+ * @public
1346
1546
  * <p>The type and other characteristics of the entity that performed the action on the affected resource.</p>
1347
1547
  */
1348
1548
  userIdentity?: UserIdentity;
@@ -1353,10 +1553,12 @@ export interface FindingActor {
1353
1553
  */
1354
1554
  export interface PolicyDetails {
1355
1555
  /**
1556
+ * @public
1356
1557
  * <p>The action that produced the finding.</p>
1357
1558
  */
1358
1559
  action?: FindingAction;
1359
1560
  /**
1561
+ * @public
1360
1562
  * <p>The entity that performed the action that produced the finding.</p>
1361
1563
  */
1362
1564
  actor?: FindingActor;
@@ -1381,10 +1583,12 @@ export type EncryptionType = (typeof EncryptionType)[keyof typeof EncryptionType
1381
1583
  */
1382
1584
  export interface ServerSideEncryption {
1383
1585
  /**
1586
+ * @public
1384
1587
  * <p>The server-side encryption algorithm that's used when storing data in the bucket or object. If default encryption settings aren't configured for the bucket or the object isn't encrypted using server-side encryption, this value is NONE.</p>
1385
1588
  */
1386
1589
  encryptionType?: EncryptionType | string;
1387
1590
  /**
1591
+ * @public
1388
1592
  * <p>The Amazon Resource Name (ARN) or unique identifier (key ID) for the KMS key that's used to encrypt data in the bucket or the object. This value is null if an KMS key isn't used to encrypt the data.</p>
1389
1593
  */
1390
1594
  kmsMasterKeyId?: string;
@@ -1395,10 +1599,12 @@ export interface ServerSideEncryption {
1395
1599
  */
1396
1600
  export interface S3BucketOwner {
1397
1601
  /**
1602
+ * @public
1398
1603
  * <p>The display name of the account that owns the bucket.</p>
1399
1604
  */
1400
1605
  displayName?: string;
1401
1606
  /**
1607
+ * @public
1402
1608
  * <p>The canonical user ID for the account that owns the bucket.</p>
1403
1609
  */
1404
1610
  id?: string;
@@ -1409,34 +1615,42 @@ export interface S3BucketOwner {
1409
1615
  */
1410
1616
  export interface S3Bucket {
1411
1617
  /**
1618
+ * @public
1412
1619
  * <p>Specifies whether the bucket policy for the bucket requires server-side encryption of objects when objects are added to the bucket. Possible values are:</p> <ul><li><p>FALSE - The bucket policy requires server-side encryption of new objects. PutObject requests must include a valid server-side encryption header.</p></li> <li><p>TRUE - The bucket doesn't have a bucket policy or it has a bucket policy that doesn't require server-side encryption of new objects. If a bucket policy exists, it doesn't require PutObject requests to include a valid server-side encryption header.</p></li> <li><p>UNKNOWN - Amazon Macie can't determine whether the bucket policy requires server-side encryption of new objects.</p></li></ul> <p>Valid server-side encryption headers are: x-amz-server-side-encryption with a value of AES256 or aws:kms, and x-amz-server-side-encryption-customer-algorithm with a value of AES256.</p>
1413
1620
  */
1414
1621
  allowsUnencryptedObjectUploads?: AllowsUnencryptedObjectUploads | string;
1415
1622
  /**
1623
+ * @public
1416
1624
  * <p>The Amazon Resource Name (ARN) of the bucket.</p>
1417
1625
  */
1418
1626
  arn?: string;
1419
1627
  /**
1628
+ * @public
1420
1629
  * <p>The date and time, in UTC and extended ISO 8601 format, when the bucket was created. This value can also indicate when changes such as edits to the bucket's policy were most recently made to the bucket, relative to when the finding was created or last updated.</p>
1421
1630
  */
1422
1631
  createdAt?: Date;
1423
1632
  /**
1633
+ * @public
1424
1634
  * <p>The default server-side encryption settings for the bucket.</p>
1425
1635
  */
1426
1636
  defaultServerSideEncryption?: ServerSideEncryption;
1427
1637
  /**
1638
+ * @public
1428
1639
  * <p>The name of the bucket.</p>
1429
1640
  */
1430
1641
  name?: string;
1431
1642
  /**
1643
+ * @public
1432
1644
  * <p>The display name and canonical user ID for the Amazon Web Services account that owns the bucket.</p>
1433
1645
  */
1434
1646
  owner?: S3BucketOwner;
1435
1647
  /**
1648
+ * @public
1436
1649
  * <p>The permissions settings that determine whether the bucket is publicly accessible.</p>
1437
1650
  */
1438
1651
  publicAccess?: BucketPublicAccess;
1439
1652
  /**
1653
+ * @public
1440
1654
  * <p>The tags that are associated with the bucket.</p>
1441
1655
  */
1442
1656
  tags?: KeyValuePair[];
@@ -1466,50 +1680,62 @@ export type StorageClass = (typeof StorageClass)[keyof typeof StorageClass];
1466
1680
  */
1467
1681
  export interface S3Object {
1468
1682
  /**
1683
+ * @public
1469
1684
  * <p>The Amazon Resource Name (ARN) of the bucket that contains the object.</p>
1470
1685
  */
1471
1686
  bucketArn?: string;
1472
1687
  /**
1688
+ * @public
1473
1689
  * <p>The entity tag (ETag) that identifies the affected version of the object. If the object was overwritten or changed after Amazon Macie produced the finding, this value might be different from the current ETag for the object.</p>
1474
1690
  */
1475
1691
  eTag?: string;
1476
1692
  /**
1693
+ * @public
1477
1694
  * <p>The file name extension of the object. If the object doesn't have a file name extension, this value is "".</p>
1478
1695
  */
1479
1696
  extension?: string;
1480
1697
  /**
1698
+ * @public
1481
1699
  * <p>The full name (<i>key</i>) of the object, including the object's prefix if applicable.</p>
1482
1700
  */
1483
1701
  key?: string;
1484
1702
  /**
1703
+ * @public
1485
1704
  * <p>The date and time, in UTC and extended ISO 8601 format, when the object was last modified.</p>
1486
1705
  */
1487
1706
  lastModified?: Date;
1488
1707
  /**
1708
+ * @public
1489
1709
  * <p>The full path to the affected object, including the name of the affected bucket and the object's name (key).</p>
1490
1710
  */
1491
1711
  path?: string;
1492
1712
  /**
1713
+ * @public
1493
1714
  * <p>Specifies whether the object is publicly accessible due to the combination of permissions settings that apply to the object.</p>
1494
1715
  */
1495
1716
  publicAccess?: boolean;
1496
1717
  /**
1718
+ * @public
1497
1719
  * <p>The type of server-side encryption that was used to encrypt the object.</p>
1498
1720
  */
1499
1721
  serverSideEncryption?: ServerSideEncryption;
1500
1722
  /**
1723
+ * @public
1501
1724
  * <p>The total storage size, in bytes, of the object.</p>
1502
1725
  */
1503
1726
  size?: number;
1504
1727
  /**
1728
+ * @public
1505
1729
  * <p>The storage class of the object.</p>
1506
1730
  */
1507
1731
  storageClass?: StorageClass | string;
1508
1732
  /**
1733
+ * @public
1509
1734
  * <p>The tags that are associated with the object.</p>
1510
1735
  */
1511
1736
  tags?: KeyValuePair[];
1512
1737
  /**
1738
+ * @public
1513
1739
  * <p>The identifier for the affected version of the object.</p>
1514
1740
  */
1515
1741
  versionId?: string;
@@ -1520,10 +1746,12 @@ export interface S3Object {
1520
1746
  */
1521
1747
  export interface ResourcesAffected {
1522
1748
  /**
1749
+ * @public
1523
1750
  * <p>The details of the S3 bucket that the finding applies to.</p>
1524
1751
  */
1525
1752
  s3Bucket?: S3Bucket;
1526
1753
  /**
1754
+ * @public
1527
1755
  * <p>The details of the S3 object that the finding applies to.</p>
1528
1756
  */
1529
1757
  s3Object?: S3Object;
@@ -1547,10 +1775,12 @@ export type SeverityDescription = (typeof SeverityDescription)[keyof typeof Seve
1547
1775
  */
1548
1776
  export interface Severity {
1549
1777
  /**
1778
+ * @public
1550
1779
  * <p>The qualitative representation of the finding's severity, ranging from Low (least severe) to High (most severe).</p>
1551
1780
  */
1552
1781
  description?: SeverityDescription | string;
1553
1782
  /**
1783
+ * @public
1554
1784
  * <p>The numerical representation of the finding's severity, ranging from 1 (least severe) to 3 (most severe).</p>
1555
1785
  */
1556
1786
  score?: number;
@@ -1582,74 +1812,92 @@ export type FindingType = (typeof FindingType)[keyof typeof FindingType];
1582
1812
  */
1583
1813
  export interface Finding {
1584
1814
  /**
1815
+ * @public
1585
1816
  * <p>The unique identifier for the Amazon Web Services account that the finding applies to. This is typically the account that owns the affected resource.</p>
1586
1817
  */
1587
1818
  accountId?: string;
1588
1819
  /**
1820
+ * @public
1589
1821
  * <p>Specifies whether the finding is archived (suppressed).</p>
1590
1822
  */
1591
1823
  archived?: boolean;
1592
1824
  /**
1825
+ * @public
1593
1826
  * <p>The category of the finding. Possible values are: CLASSIFICATION, for a sensitive data finding; and, POLICY, for a policy finding.</p>
1594
1827
  */
1595
1828
  category?: FindingCategory | string;
1596
1829
  /**
1830
+ * @public
1597
1831
  * <p>The details of a sensitive data finding. This value is null for a policy finding.</p>
1598
1832
  */
1599
1833
  classificationDetails?: ClassificationDetails;
1600
1834
  /**
1835
+ * @public
1601
1836
  * <p>The total number of occurrences of the finding. For sensitive data findings, this value is always 1. All sensitive data findings are considered unique.</p>
1602
1837
  */
1603
1838
  count?: number;
1604
1839
  /**
1840
+ * @public
1605
1841
  * <p>The date and time, in UTC and extended ISO 8601 format, when Amazon Macie created the finding.</p>
1606
1842
  */
1607
1843
  createdAt?: Date;
1608
1844
  /**
1845
+ * @public
1609
1846
  * <p>The description of the finding.</p>
1610
1847
  */
1611
1848
  description?: string;
1612
1849
  /**
1850
+ * @public
1613
1851
  * <p>The unique identifier for the finding. This is a random string that Amazon Macie generates and assigns to a finding when it creates the finding.</p>
1614
1852
  */
1615
1853
  id?: string;
1616
1854
  /**
1855
+ * @public
1617
1856
  * <p>The Amazon Web Services partition that Amazon Macie created the finding in.</p>
1618
1857
  */
1619
1858
  partition?: string;
1620
1859
  /**
1860
+ * @public
1621
1861
  * <p>The details of a policy finding. This value is null for a sensitive data finding.</p>
1622
1862
  */
1623
1863
  policyDetails?: PolicyDetails;
1624
1864
  /**
1865
+ * @public
1625
1866
  * <p>The Amazon Web Services Region that Amazon Macie created the finding in.</p>
1626
1867
  */
1627
1868
  region?: string;
1628
1869
  /**
1870
+ * @public
1629
1871
  * <p>The resources that the finding applies to.</p>
1630
1872
  */
1631
1873
  resourcesAffected?: ResourcesAffected;
1632
1874
  /**
1875
+ * @public
1633
1876
  * <p>Specifies whether the finding is a sample finding. A <i>sample finding</i> is a finding that uses example data to demonstrate what a finding might contain.</p>
1634
1877
  */
1635
1878
  sample?: boolean;
1636
1879
  /**
1880
+ * @public
1637
1881
  * <p>The version of the schema that was used to define the data structures in the finding.</p>
1638
1882
  */
1639
1883
  schemaVersion?: string;
1640
1884
  /**
1885
+ * @public
1641
1886
  * <p>The severity level and score for the finding.</p>
1642
1887
  */
1643
1888
  severity?: Severity;
1644
1889
  /**
1890
+ * @public
1645
1891
  * <p>The brief description of the finding.</p>
1646
1892
  */
1647
1893
  title?: string;
1648
1894
  /**
1895
+ * @public
1649
1896
  * <p>The type of the finding.</p>
1650
1897
  */
1651
1898
  type?: FindingType | string;
1652
1899
  /**
1900
+ * @public
1653
1901
  * <p>The date and time, in UTC and extended ISO 8601 format, when Amazon Macie last updated the finding. For sensitive data findings, this value is the same as the value for the createdAt property. All sensitive data findings are considered new.</p>
1654
1902
  */
1655
1903
  updatedAt?: Date;
@@ -1672,22 +1920,27 @@ export type FindingsFilterAction = (typeof FindingsFilterAction)[keyof typeof Fi
1672
1920
  */
1673
1921
  export interface FindingsFilterListItem {
1674
1922
  /**
1923
+ * @public
1675
1924
  * <p>The action that's performed on findings that match the filter criteria. Possible values are: ARCHIVE, suppress (automatically archive) the findings; and, NOOP, don't perform any action on the findings.</p>
1676
1925
  */
1677
1926
  action?: FindingsFilterAction | string;
1678
1927
  /**
1928
+ * @public
1679
1929
  * <p>The Amazon Resource Name (ARN) of the filter.</p>
1680
1930
  */
1681
1931
  arn?: string;
1682
1932
  /**
1933
+ * @public
1683
1934
  * <p>The unique identifier for the filter.</p>
1684
1935
  */
1685
1936
  id?: string;
1686
1937
  /**
1938
+ * @public
1687
1939
  * <p>The custom name of the filter.</p>
1688
1940
  */
1689
1941
  name?: string;
1690
1942
  /**
1943
+ * @public
1691
1944
  * <p>A map of key-value pairs that specifies which tags (keys and values) are associated with the filter.</p>
1692
1945
  */
1693
1946
  tags?: Record<string, string>;
@@ -1698,10 +1951,12 @@ export interface FindingsFilterListItem {
1698
1951
  */
1699
1952
  export interface GroupCount {
1700
1953
  /**
1954
+ * @public
1701
1955
  * <p>The total number of findings in the group of query results.</p>
1702
1956
  */
1703
1957
  count?: number;
1704
1958
  /**
1959
+ * @public
1705
1960
  * <p>The name of the property that defines the group in the query results, as specified by the groupBy property in the query request.</p>
1706
1961
  */
1707
1962
  groupKey?: string;
@@ -1732,18 +1987,22 @@ export type RelationshipStatus = (typeof RelationshipStatus)[keyof typeof Relati
1732
1987
  */
1733
1988
  export interface Invitation {
1734
1989
  /**
1990
+ * @public
1735
1991
  * <p>The Amazon Web Services account ID for the account that sent the invitation.</p>
1736
1992
  */
1737
1993
  accountId?: string;
1738
1994
  /**
1995
+ * @public
1739
1996
  * <p>The unique identifier for the invitation.</p>
1740
1997
  */
1741
1998
  invitationId?: string;
1742
1999
  /**
2000
+ * @public
1743
2001
  * <p>The date and time, in UTC and extended ISO 8601 format, when the invitation was sent.</p>
1744
2002
  */
1745
2003
  invitedAt?: Date;
1746
2004
  /**
2005
+ * @public
1747
2006
  * <p>The status of the relationship between the account that sent the invitation and the account that received the invitation.</p>
1748
2007
  */
1749
2008
  relationshipStatus?: RelationshipStatus | string;
@@ -1768,14 +2027,17 @@ export type ScopeFilterKey = (typeof ScopeFilterKey)[keyof typeof ScopeFilterKey
1768
2027
  */
1769
2028
  export interface SimpleScopeTerm {
1770
2029
  /**
2030
+ * @public
1771
2031
  * <p>The operator to use in the condition. Valid values for each supported property (key) are:</p> <ul><li><p>OBJECT_EXTENSION - EQ (equals) or NE (not equals)</p></li> <li><p>OBJECT_KEY - STARTS_WITH</p></li> <li><p>OBJECT_LAST_MODIFIED_DATE - Any operator except CONTAINS</p></li> <li><p>OBJECT_SIZE - Any operator except CONTAINS</p></li></ul>
1772
2032
  */
1773
2033
  comparator?: JobComparator | string;
1774
2034
  /**
2035
+ * @public
1775
2036
  * <p>The object property to use in the condition.</p>
1776
2037
  */
1777
2038
  key?: ScopeFilterKey | string;
1778
2039
  /**
2040
+ * @public
1779
2041
  * <p>An array that lists the values to use in the condition. If the value for the key property is OBJECT_EXTENSION or OBJECT_KEY, this array can specify multiple values and Amazon Macie uses OR logic to join the values. Otherwise, this array can specify only one value.</p> <p>Valid values for each supported property (key) are:</p> <ul><li><p>OBJECT_EXTENSION - A string that represents the file name extension of an object. For example: docx or pdf</p></li> <li><p>OBJECT_KEY - A string that represents the key prefix (folder name or path) of an object. For example: logs or awslogs/eventlogs. This value applies a condition to objects whose keys (names) begin with the specified value.</p></li> <li><p>OBJECT_LAST_MODIFIED_DATE - The date and time (in UTC and extended ISO 8601 format) when an object was created or last changed, whichever is latest. For example: 2020-09-28T14:31:13Z</p></li> <li><p>OBJECT_SIZE - An integer that represents the storage size (in bytes) of an object.</p></li></ul> <p>Macie doesn't support use of wildcard characters in these values. Also, string values are case sensitive.</p>
1780
2042
  */
1781
2043
  values?: string[];
@@ -1786,10 +2048,12 @@ export interface SimpleScopeTerm {
1786
2048
  */
1787
2049
  export interface TagValuePair {
1788
2050
  /**
2051
+ * @public
1789
2052
  * <p>The value for the tag key to use in the condition.</p>
1790
2053
  */
1791
2054
  key?: string;
1792
2055
  /**
2056
+ * @public
1793
2057
  * <p>The tag value, associated with the specified tag key (key), to use in the condition. To specify only a tag key for a condition, specify the tag key for the key property and set this value to an empty string.</p>
1794
2058
  */
1795
2059
  value?: string;
@@ -1811,18 +2075,22 @@ export type TagTarget = (typeof TagTarget)[keyof typeof TagTarget];
1811
2075
  */
1812
2076
  export interface TagScopeTerm {
1813
2077
  /**
2078
+ * @public
1814
2079
  * <p>The operator to use in the condition. Valid values are EQ (equals) or NE (not equals).</p>
1815
2080
  */
1816
2081
  comparator?: JobComparator | string;
1817
2082
  /**
2083
+ * @public
1818
2084
  * <p>The object property to use in the condition. The only valid value is TAG.</p>
1819
2085
  */
1820
2086
  key?: string;
1821
2087
  /**
2088
+ * @public
1822
2089
  * <p>The tag keys or tag key and value pairs to use in the condition. To specify only tag keys in a condition, specify the keys in this array and set the value for each associated tag value to an empty string.</p>
1823
2090
  */
1824
2091
  tagValues?: TagValuePair[];
1825
2092
  /**
2093
+ * @public
1826
2094
  * <p>The type of object to apply the condition to.</p>
1827
2095
  */
1828
2096
  target?: TagTarget | string;
@@ -1833,10 +2101,12 @@ export interface TagScopeTerm {
1833
2101
  */
1834
2102
  export interface JobScopeTerm {
1835
2103
  /**
2104
+ * @public
1836
2105
  * <p>A property-based condition that defines a property, operator, and one or more values for including or excluding objects from the job.</p>
1837
2106
  */
1838
2107
  simpleScopeTerm?: SimpleScopeTerm;
1839
2108
  /**
2109
+ * @public
1840
2110
  * <p>A tag-based condition that defines the operator and tag keys or tag key and value pairs for including or excluding objects from the job.</p>
1841
2111
  */
1842
2112
  tagScopeTerm?: TagScopeTerm;
@@ -1847,6 +2117,7 @@ export interface JobScopeTerm {
1847
2117
  */
1848
2118
  export interface CriteriaBlockForJob {
1849
2119
  /**
2120
+ * @public
1850
2121
  * <p>An array of conditions, one for each condition that determines which buckets to include or exclude from the job. If you specify more than one condition, Amazon Macie uses AND logic to join the conditions.</p>
1851
2122
  */
1852
2123
  and?: CriteriaForJob[];
@@ -1857,10 +2128,12 @@ export interface CriteriaBlockForJob {
1857
2128
  */
1858
2129
  export interface S3BucketCriteriaForJob {
1859
2130
  /**
2131
+ * @public
1860
2132
  * <p>The property- and tag-based conditions that determine which buckets to exclude from the job.</p>
1861
2133
  */
1862
2134
  excludes?: CriteriaBlockForJob;
1863
2135
  /**
2136
+ * @public
1864
2137
  * <p>The property- and tag-based conditions that determine which buckets to include in the job.</p>
1865
2138
  */
1866
2139
  includes?: CriteriaBlockForJob;
@@ -1871,10 +2144,12 @@ export interface S3BucketCriteriaForJob {
1871
2144
  */
1872
2145
  export interface S3BucketDefinitionForJob {
1873
2146
  /**
2147
+ * @public
1874
2148
  * <p>The unique identifier for the Amazon Web Services account that owns the buckets.</p>
1875
2149
  */
1876
2150
  accountId: string | undefined;
1877
2151
  /**
2152
+ * @public
1878
2153
  * <p>An array that lists the names of the buckets.</p>
1879
2154
  */
1880
2155
  buckets: string[] | undefined;
@@ -1925,6 +2200,7 @@ export type LastRunErrorStatusCode = (typeof LastRunErrorStatusCode)[keyof typeo
1925
2200
  */
1926
2201
  export interface LastRunErrorStatus {
1927
2202
  /**
2203
+ * @public
1928
2204
  * <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>
1929
2205
  */
1930
2206
  code?: LastRunErrorStatusCode | string;
@@ -1935,14 +2211,17 @@ export interface LastRunErrorStatus {
1935
2211
  */
1936
2212
  export interface UserPausedDetails {
1937
2213
  /**
2214
+ * @public
1938
2215
  * <p>The date and time, in UTC and extended ISO 8601 format, when the job or job run will expire and be cancelled if you don't resume it first.</p>
1939
2216
  */
1940
2217
  jobExpiresAt?: Date;
1941
2218
  /**
2219
+ * @public
1942
2220
  * <p>The Amazon Resource Name (ARN) of the Health event that Amazon Macie sent to notify you of the job or job run's pending expiration and cancellation. This value is null if a job has been paused for less than 23 days.</p>
1943
2221
  */
1944
2222
  jobImminentExpirationHealthEventArn?: string;
1945
2223
  /**
2224
+ * @public
1946
2225
  * <p>The date and time, in UTC and extended ISO 8601 format, when you paused the job.</p>
1947
2226
  */
1948
2227
  jobPausedAt?: Date;
@@ -1953,38 +2232,47 @@ export interface UserPausedDetails {
1953
2232
  */
1954
2233
  export interface JobSummary {
1955
2234
  /**
2235
+ * @public
1956
2236
  * <p>The property- and tag-based conditions that determine which S3 buckets are included or excluded from the job's analysis. Each time the job runs, the job uses these criteria to determine which buckets to analyze. A job's definition can contain a bucketCriteria object or a bucketDefinitions array, not both.</p>
1957
2237
  */
1958
2238
  bucketCriteria?: S3BucketCriteriaForJob;
1959
2239
  /**
2240
+ * @public
1960
2241
  * <p>An array of objects, one for each Amazon Web Services account that owns specific S3 buckets for the job to analyze. Each object specifies the account ID for an account and one or more buckets to analyze for that account. A job's definition can contain a bucketDefinitions array or a bucketCriteria object, not both.</p>
1961
2242
  */
1962
2243
  bucketDefinitions?: S3BucketDefinitionForJob[];
1963
2244
  /**
2245
+ * @public
1964
2246
  * <p>The date and time, in UTC and extended ISO 8601 format, when the job was created.</p>
1965
2247
  */
1966
2248
  createdAt?: Date;
1967
2249
  /**
2250
+ * @public
1968
2251
  * <p>The unique identifier for the job.</p>
1969
2252
  */
1970
2253
  jobId?: string;
1971
2254
  /**
2255
+ * @public
1972
2256
  * <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 - 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>
1973
2257
  */
1974
2258
  jobStatus?: JobStatus | string;
1975
2259
  /**
2260
+ * @public
1976
2261
  * <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>
1977
2262
  */
1978
2263
  jobType?: JobType | string;
1979
2264
  /**
2265
+ * @public
1980
2266
  * <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>
1981
2267
  */
1982
2268
  lastRunErrorStatus?: LastRunErrorStatus;
1983
2269
  /**
2270
+ * @public
1984
2271
  * <p>The custom name of the job.</p>
1985
2272
  */
1986
2273
  name?: string;
1987
2274
  /**
2275
+ * @public
1988
2276
  * <p>If the current status of the job is USER_PAUSED, specifies when the job was paused and when the job or job run will expire and be cancelled if it isn't resumed. This value is present only if the value for jobStatus is USER_PAUSED.</p>
1989
2277
  */
1990
2278
  userPausedDetails?: UserPausedDetails;
@@ -2009,14 +2297,17 @@ export type ListJobsFilterKey = (typeof ListJobsFilterKey)[keyof typeof ListJobs
2009
2297
  */
2010
2298
  export interface ListJobsFilterTerm {
2011
2299
  /**
2300
+ * @public
2012
2301
  * <p>The operator to use to filter the results.</p>
2013
2302
  */
2014
2303
  comparator?: JobComparator | string;
2015
2304
  /**
2305
+ * @public
2016
2306
  * <p>The property to use to filter the results.</p>
2017
2307
  */
2018
2308
  key?: ListJobsFilterKey | string;
2019
2309
  /**
2310
+ * @public
2020
2311
  * <p>An array that lists one or more values to use to filter the results.</p>
2021
2312
  */
2022
2313
  values?: string[];
@@ -2027,10 +2318,12 @@ export interface ListJobsFilterTerm {
2027
2318
  */
2028
2319
  export interface ManagedDataIdentifierSummary {
2029
2320
  /**
2321
+ * @public
2030
2322
  * <p>The category of sensitive data that the managed data identifier detects: CREDENTIALS, for credentials data such as private keys or Amazon Web Services secret access keys; FINANCIAL_INFORMATION, for financial data such as credit card numbers; or, PERSONAL_INFORMATION, for personal health information, such as health insurance identification numbers, or personally identifiable information, such as passport numbers.</p>
2031
2323
  */
2032
2324
  category?: SensitiveDataItemCategory | string;
2033
2325
  /**
2326
+ * @public
2034
2327
  * <p>The unique identifier for the managed data identifier. This is a string that describes the type of sensitive data that the managed data identifier detects. For example: OPENSSH_PRIVATE_KEY for OpenSSH private keys, CREDIT_CARD_NUMBER for credit card numbers, or USA_PASSPORT_NUMBER for US passport numbers.</p>
2035
2328
  */
2036
2329
  id?: string;
@@ -2041,62 +2334,77 @@ export interface ManagedDataIdentifierSummary {
2041
2334
  */
2042
2335
  export interface MatchingBucket {
2043
2336
  /**
2337
+ * @public
2044
2338
  * <p>The unique identifier for the Amazon Web Services account that owns the bucket.</p>
2045
2339
  */
2046
2340
  accountId?: string;
2047
2341
  /**
2342
+ * @public
2048
2343
  * <p>The name of the bucket.</p>
2049
2344
  */
2050
2345
  bucketName?: string;
2051
2346
  /**
2347
+ * @public
2052
2348
  * <p>The total number of objects that Amazon Macie can analyze in the bucket. These objects use a supported storage class and have a file name extension for a supported file or storage format.</p>
2053
2349
  */
2054
2350
  classifiableObjectCount?: number;
2055
2351
  /**
2352
+ * @public
2056
2353
  * <p>The total storage size, in bytes, of the objects that Amazon Macie can analyze in the bucket. These objects use a supported storage class and have a file name extension for a supported file or storage format.</p> <p>If versioning is enabled for the bucket, Macie calculates this value based on the size of the latest version of each applicable object in the bucket. This value doesn't reflect the storage size of all versions of each applicable object in the bucket.</p>
2057
2354
  */
2058
2355
  classifiableSizeInBytes?: number;
2059
2356
  /**
2357
+ * @public
2060
2358
  * <p>The error code for an error that prevented Amazon Macie from retrieving and processing information about the bucket and the bucket's objects. If this value is ACCESS_DENIED, Macie doesn't have permission to retrieve the information. For example, the bucket has a restrictive bucket policy and Amazon S3 denied the request. If this value is null, Macie was able to retrieve and process the information.</p>
2061
2359
  */
2062
2360
  errorCode?: BucketMetadataErrorCode | string;
2063
2361
  /**
2362
+ * @public
2064
2363
  * <p>A brief description of the error (errorCode) that prevented Amazon Macie from retrieving and processing information about the bucket and the bucket's objects. This value is null if Macie was able to retrieve and process the information.</p>
2065
2364
  */
2066
2365
  errorMessage?: string;
2067
2366
  /**
2367
+ * @public
2068
2368
  * <p>Specifies whether any one-time or recurring classification jobs are configured to analyze objects in the bucket, and, if so, the details of the job that ran most recently.</p>
2069
2369
  */
2070
2370
  jobDetails?: JobDetails;
2071
2371
  /**
2372
+ * @public
2072
2373
  * <p>The date and time, in UTC and extended ISO 8601 format, when Amazon Macie most recently analyzed data in the bucket while performing automated sensitive data discovery for your account. This value is null if automated sensitive data discovery is currently disabled for your account.</p>
2073
2374
  */
2074
2375
  lastAutomatedDiscoveryTime?: Date;
2075
2376
  /**
2377
+ * @public
2076
2378
  * <p>The total number of objects in the bucket.</p>
2077
2379
  */
2078
2380
  objectCount?: number;
2079
2381
  /**
2382
+ * @public
2080
2383
  * <p>The total number of objects in the bucket, grouped by server-side encryption type. This includes a grouping that reports the total number of objects that aren't encrypted or use client-side encryption.</p>
2081
2384
  */
2082
2385
  objectCountByEncryptionType?: ObjectCountByEncryptionType;
2083
2386
  /**
2387
+ * @public
2084
2388
  * <p>The current sensitivity score for the bucket, ranging from -1 (classification error) to 100 (sensitive). This value is null if automated sensitive data discovery is currently disabled for your account.</p>
2085
2389
  */
2086
2390
  sensitivityScore?: number;
2087
2391
  /**
2392
+ * @public
2088
2393
  * <p>The total storage size, in bytes, of the bucket.</p> <p>If versioning is enabled for the bucket, Amazon Macie calculates this value based on the size of the latest version of each object in the bucket. This value doesn't reflect the storage size of all versions of each object in the bucket.</p>
2089
2394
  */
2090
2395
  sizeInBytes?: number;
2091
2396
  /**
2397
+ * @public
2092
2398
  * <p>The total storage size, in bytes, of the objects that are compressed (.gz, .gzip, .zip) files in the bucket.</p> <p>If versioning is enabled for the bucket, Amazon Macie calculates this value based on the size of the latest version of each applicable object in the bucket. This value doesn't reflect the storage size of all versions of each applicable object in the bucket.</p>
2093
2399
  */
2094
2400
  sizeInBytesCompressed?: number;
2095
2401
  /**
2402
+ * @public
2096
2403
  * <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>
2097
2404
  */
2098
2405
  unclassifiableObjectCount?: ObjectLevelStatistics;
2099
2406
  /**
2407
+ * @public
2100
2408
  * <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>
2101
2409
  */
2102
2410
  unclassifiableObjectSizeInBytes?: ObjectLevelStatistics;
@@ -2107,6 +2415,7 @@ export interface MatchingBucket {
2107
2415
  */
2108
2416
  export interface MatchingResource {
2109
2417
  /**
2418
+ * @public
2110
2419
  * <p>The details of an S3 bucket that Amazon Macie monitors and analyzes.</p>
2111
2420
  */
2112
2421
  matchingBucket?: MatchingBucket;
@@ -2117,38 +2426,47 @@ export interface MatchingResource {
2117
2426
  */
2118
2427
  export interface Member {
2119
2428
  /**
2429
+ * @public
2120
2430
  * <p>The Amazon Web Services account ID for the account.</p>
2121
2431
  */
2122
2432
  accountId?: string;
2123
2433
  /**
2434
+ * @public
2124
2435
  * <p>The Amazon Web Services account ID for the administrator account.</p>
2125
2436
  */
2126
2437
  administratorAccountId?: string;
2127
2438
  /**
2439
+ * @public
2128
2440
  * <p>The Amazon Resource Name (ARN) of the account.</p>
2129
2441
  */
2130
2442
  arn?: string;
2131
2443
  /**
2444
+ * @public
2132
2445
  * <p>The email address for the account. This value is null if the account is associated with the administrator account through Organizations.</p>
2133
2446
  */
2134
2447
  email?: string;
2135
2448
  /**
2449
+ * @public
2136
2450
  * <p>The date and time, in UTC and extended ISO 8601 format, when an Amazon Macie membership invitation was last sent to the account. This value is null if a Macie membership invitation hasn't been sent to the account.</p>
2137
2451
  */
2138
2452
  invitedAt?: Date;
2139
2453
  /**
2454
+ * @public
2140
2455
  * <p>(Deprecated) The Amazon Web Services account ID for the administrator account. This property has been replaced by the administratorAccountId property and is retained only for backward compatibility.</p>
2141
2456
  */
2142
2457
  masterAccountId?: string;
2143
2458
  /**
2459
+ * @public
2144
2460
  * <p>The current status of the relationship between the account and the administrator account.</p>
2145
2461
  */
2146
2462
  relationshipStatus?: RelationshipStatus | string;
2147
2463
  /**
2464
+ * @public
2148
2465
  * <p>A map of key-value pairs that specifies which tags (keys and values) are associated with the account in Amazon Macie.</p>
2149
2466
  */
2150
2467
  tags?: Record<string, string>;
2151
2468
  /**
2469
+ * @public
2152
2470
  * <p>The date and time, in UTC and extended ISO 8601 format, of the most recent change to the status of the relationship between the account and the administrator account.</p>
2153
2471
  */
2154
2472
  updatedAt?: Date;
@@ -2159,14 +2477,17 @@ export interface Member {
2159
2477
  */
2160
2478
  export interface ResourceProfileArtifact {
2161
2479
  /**
2480
+ * @public
2162
2481
  * <p>The Amazon Resource Name (ARN) of the object.</p>
2163
2482
  */
2164
2483
  arn: string | undefined;
2165
2484
  /**
2485
+ * @public
2166
2486
  * <p>The status of the analysis. Possible values are:</p> <ul><li><p>COMPLETE - Amazon Macie successfully completed its analysis of the object.</p></li> <li><p>PARTIAL - Macie analyzed only a subset of data in the object. For example, the object is an archive file that contains files in an unsupported format.</p></li> <li><p>SKIPPED - Macie wasn't able to analyze the object. For example, the object is a malformed file.</p></li></ul>
2167
2487
  */
2168
2488
  classificationResultStatus: string | undefined;
2169
2489
  /**
2490
+ * @public
2170
2491
  * <p>Specifies whether Amazon Macie found sensitive data in the object.</p>
2171
2492
  */
2172
2493
  sensitive?: boolean;
@@ -2203,14 +2524,17 @@ export type SearchResourcesSimpleCriterionKey = (typeof SearchResourcesSimpleCri
2203
2524
  */
2204
2525
  export interface SearchResourcesSimpleCriterion {
2205
2526
  /**
2527
+ * @public
2206
2528
  * <p>The operator to use in the condition. Valid values are EQ (equals) and NE (not equals).</p>
2207
2529
  */
2208
2530
  comparator?: SearchResourcesComparator | string;
2209
2531
  /**
2532
+ * @public
2210
2533
  * <p>The property to use in the condition.</p>
2211
2534
  */
2212
2535
  key?: SearchResourcesSimpleCriterionKey | string;
2213
2536
  /**
2537
+ * @public
2214
2538
  * <p>An array that lists one or more values to use in the condition. If you specify multiple values, Amazon Macie uses OR logic to join the values. Valid values for each supported property (key) are:</p> <ul><li><p>ACCOUNT_ID - A string that represents the unique identifier for the Amazon Web Services account that owns the resource.</p></li> <li><p>S3_BUCKET_EFFECTIVE_PERMISSION - A string that represents an enumerated value that Macie defines for the <a href="https://docs.aws.amazon.com/macie/latest/APIReference/datasources-s3.html#datasources-s3-prop-bucketpublicaccess-effectivepermission">BucketPublicAccess.effectivePermission</a> property of an S3 bucket.</p></li> <li><p>S3_BUCKET_NAME - A string that represents the name of an S3 bucket.</p></li> <li><p>S3_BUCKET_SHARED_ACCESS - A string that represents an enumerated value that Macie defines for the <a href="https://docs.aws.amazon.com/macie/latest/APIReference/datasources-s3.html#datasources-s3-prop-bucketmetadata-sharedaccess">BucketMetadata.sharedAccess</a> property of an S3 bucket.</p></li></ul> <p>Values are case sensitive. Also, Macie doesn't support use of partial values or wildcard characters in values.</p>
2215
2539
  */
2216
2540
  values?: string[];
@@ -2221,10 +2545,12 @@ export interface SearchResourcesSimpleCriterion {
2221
2545
  */
2222
2546
  export interface SearchResourcesTagCriterionPair {
2223
2547
  /**
2548
+ * @public
2224
2549
  * <p>The value for the tag key to use in the condition.</p>
2225
2550
  */
2226
2551
  key?: string;
2227
2552
  /**
2553
+ * @public
2228
2554
  * <p>The tag value to use in the condition.</p>
2229
2555
  */
2230
2556
  value?: string;
@@ -2235,10 +2561,12 @@ export interface SearchResourcesTagCriterionPair {
2235
2561
  */
2236
2562
  export interface SearchResourcesTagCriterion {
2237
2563
  /**
2564
+ * @public
2238
2565
  * <p>The operator to use in the condition. Valid values are EQ (equals) and NE (not equals).</p>
2239
2566
  */
2240
2567
  comparator?: SearchResourcesComparator | string;
2241
2568
  /**
2569
+ * @public
2242
2570
  * <p>The tag keys, tag values, or tag key and value pairs to use in the condition.</p>
2243
2571
  */
2244
2572
  tagValues?: SearchResourcesTagCriterionPair[];
@@ -2249,10 +2577,12 @@ export interface SearchResourcesTagCriterion {
2249
2577
  */
2250
2578
  export interface SearchResourcesCriteria {
2251
2579
  /**
2580
+ * @public
2252
2581
  * <p>A property-based condition that defines a property, operator, and one or more values for including or excluding resources from the results.</p>
2253
2582
  */
2254
2583
  simpleCriterion?: SearchResourcesSimpleCriterion;
2255
2584
  /**
2585
+ * @public
2256
2586
  * <p>A tag-based condition that defines an operator and tag keys, tag values, or tag key and value pairs for including or excluding resources from the results.</p>
2257
2587
  */
2258
2588
  tagCriterion?: SearchResourcesTagCriterion;
@@ -2263,10 +2593,12 @@ export interface SearchResourcesCriteria {
2263
2593
  */
2264
2594
  export interface SensitivityInspectionTemplatesEntry {
2265
2595
  /**
2596
+ * @public
2266
2597
  * <p>The unique identifier for the sensitivity inspection template.</p>
2267
2598
  */
2268
2599
  id?: string;
2269
2600
  /**
2601
+ * @public
2270
2602
  * <p>The name of the sensitivity inspection template: automated-sensitive-data-discovery.</p>
2271
2603
  */
2272
2604
  name?: string;
@@ -2277,10 +2609,12 @@ export interface SensitivityInspectionTemplatesEntry {
2277
2609
  */
2278
2610
  export interface SuppressDataIdentifier {
2279
2611
  /**
2612
+ * @public
2280
2613
  * <p>The unique identifier for the custom data identifier or managed data identifier that detected the type of sensitive data to exclude or include in the score.</p>
2281
2614
  */
2282
2615
  id?: string;
2283
2616
  /**
2617
+ * @public
2284
2618
  * <p>The type of data identifier that detected the sensitive data. Possible values are: CUSTOM, for a custom data identifier; and, MANAGED, for a managed data identifier.</p>
2285
2619
  */
2286
2620
  type?: DataIdentifierType | string;
@@ -2318,14 +2652,17 @@ export type ErrorCode = (typeof ErrorCode)[keyof typeof ErrorCode];
2318
2652
  */
2319
2653
  export interface UnprocessedAccount {
2320
2654
  /**
2655
+ * @public
2321
2656
  * <p>The Amazon Web Services account ID for the account that the request applies to.</p>
2322
2657
  */
2323
2658
  accountId?: string;
2324
2659
  /**
2660
+ * @public
2325
2661
  * <p>The source of the issue or delay in processing the request.</p>
2326
2662
  */
2327
2663
  errorCode?: ErrorCode | string;
2328
2664
  /**
2665
+ * @public
2329
2666
  * <p>The reason why the request hasn't been processed.</p>
2330
2667
  */
2331
2668
  errorMessage?: string;
@@ -2358,14 +2695,17 @@ export type Unit = (typeof Unit)[keyof typeof Unit];
2358
2695
  */
2359
2696
  export interface ServiceLimit {
2360
2697
  /**
2698
+ * @public
2361
2699
  * <p>Specifies whether the account has met the quota that corresponds to the metric specified by the UsageByAccount.type field in the response.</p>
2362
2700
  */
2363
2701
  isServiceLimited?: boolean;
2364
2702
  /**
2703
+ * @public
2365
2704
  * <p>The unit of measurement for the value specified by the value field.</p>
2366
2705
  */
2367
2706
  unit?: Unit | string;
2368
2707
  /**
2708
+ * @public
2369
2709
  * <p>The value for the metric specified by the UsageByAccount.type field in the response.</p>
2370
2710
  */
2371
2711
  value?: number;
@@ -2390,18 +2730,22 @@ export type UsageType = (typeof UsageType)[keyof typeof UsageType];
2390
2730
  */
2391
2731
  export interface UsageByAccount {
2392
2732
  /**
2733
+ * @public
2393
2734
  * <p>The type of currency that the value for the metric (estimatedCost) is reported in.</p>
2394
2735
  */
2395
2736
  currency?: Currency | string;
2396
2737
  /**
2738
+ * @public
2397
2739
  * <p>The estimated value for the metric.</p>
2398
2740
  */
2399
2741
  estimatedCost?: string;
2400
2742
  /**
2743
+ * @public
2401
2744
  * <p>The current value for the quota that corresponds to the metric specified by the type field.</p>
2402
2745
  */
2403
2746
  serviceLimit?: ServiceLimit;
2404
2747
  /**
2748
+ * @public
2405
2749
  * <p>The name of the metric. Possible values are: AUTOMATED_OBJECT_MONITORING, to monitor S3 objects for automated sensitive data discovery; AUTOMATED_SENSITIVE_DATA_DISCOVERY, to analyze S3 objects for automated sensitive data discovery; DATA_INVENTORY_EVALUATION, to monitor S3 buckets; and, SENSITIVE_DATA_DISCOVERY, to run classification jobs.</p>
2406
2750
  */
2407
2751
  type?: UsageType | string;
@@ -2412,18 +2756,22 @@ export interface UsageByAccount {
2412
2756
  */
2413
2757
  export interface UsageRecord {
2414
2758
  /**
2759
+ * @public
2415
2760
  * <p>The unique identifier for the Amazon Web Services account that the data applies to.</p>
2416
2761
  */
2417
2762
  accountId?: string;
2418
2763
  /**
2764
+ * @public
2419
2765
  * <p>The date and time, in UTC and extended ISO 8601 format, when the free trial of automated sensitive data discovery started for the account. If the account is a member account in an organization, this value is the same as the value for the organization's Amazon Macie administrator account.</p>
2420
2766
  */
2421
2767
  automatedDiscoveryFreeTrialStartDate?: Date;
2422
2768
  /**
2769
+ * @public
2423
2770
  * <p>The date and time, in UTC and extended ISO 8601 format, when the Amazon Macie free trial started for the account.</p>
2424
2771
  */
2425
2772
  freeTrialStartDate?: Date;
2426
2773
  /**
2774
+ * @public
2427
2775
  * <p>An array of objects that contains usage data and quotas for the account. Each object contains the data for a specific usage metric and the corresponding quota.</p>
2428
2776
  */
2429
2777
  usage?: UsageByAccount[];
@@ -2465,14 +2813,17 @@ export type UsageStatisticsFilterKey = (typeof UsageStatisticsFilterKey)[keyof t
2465
2813
  */
2466
2814
  export interface UsageStatisticsFilter {
2467
2815
  /**
2816
+ * @public
2468
2817
  * <p>The operator to use in the condition. If the value for the key property is accountId, this value must be CONTAINS. If the value for the key property is any other supported field, this value can be EQ, GT, GTE, LT, LTE, or NE.</p>
2469
2818
  */
2470
2819
  comparator?: UsageStatisticsFilterComparator | string;
2471
2820
  /**
2821
+ * @public
2472
2822
  * <p>The field to use in the condition.</p>
2473
2823
  */
2474
2824
  key?: UsageStatisticsFilterKey | string;
2475
2825
  /**
2826
+ * @public
2476
2827
  * <p>An array that lists values to use in the condition, based on the value for the field specified by the key property. If the value for the key property is accountId, this array can specify multiple values. Otherwise, this array can specify only one value.</p> <p>Valid values for each supported field are:</p> <ul><li><p>accountId - The unique identifier for an Amazon Web Services account.</p></li> <li><p>freeTrialStartDate - The date and time, in UTC and extended ISO 8601 format, when the Amazon Macie free trial started for an account.</p></li> <li><p>serviceLimit - A Boolean (true or false) value that indicates whether an account has reached its monthly quota.</p></li> <li><p>total - A string that represents the current estimated cost for an account.</p></li></ul>
2477
2828
  */
2478
2829
  values?: string[];
@@ -2483,14 +2834,17 @@ export interface UsageStatisticsFilter {
2483
2834
  */
2484
2835
  export interface UsageTotal {
2485
2836
  /**
2837
+ * @public
2486
2838
  * <p>The type of currency that the value for the metric (estimatedCost) is reported in.</p>
2487
2839
  */
2488
2840
  currency?: Currency | string;
2489
2841
  /**
2842
+ * @public
2490
2843
  * <p>The estimated value for the metric.</p>
2491
2844
  */
2492
2845
  estimatedCost?: string;
2493
2846
  /**
2847
+ * @public
2494
2848
  * <p>The name of the metric. Possible values are: AUTOMATED_OBJECT_MONITORING, to monitor S3 objects for automated sensitive data discovery; AUTOMATED_SENSITIVE_DATA_DISCOVERY, to analyze S3 objects for automated sensitive data discovery; DATA_INVENTORY_EVALUATION, to monitor S3 buckets; and, SENSITIVE_DATA_DISCOVERY, to run classification jobs.</p>
2495
2849
  */
2496
2850
  type?: UsageType | string;
@@ -2500,14 +2854,17 @@ export interface UsageTotal {
2500
2854
  */
2501
2855
  export interface AcceptInvitationRequest {
2502
2856
  /**
2857
+ * @public
2503
2858
  * <p>The Amazon Web Services account ID for the account that sent the invitation.</p>
2504
2859
  */
2505
2860
  administratorAccountId?: string;
2506
2861
  /**
2862
+ * @public
2507
2863
  * <p>The unique identifier for the invitation to accept.</p>
2508
2864
  */
2509
2865
  invitationId: string | undefined;
2510
2866
  /**
2867
+ * @public
2511
2868
  * <p>(Deprecated) The Amazon Web Services account ID for the account that sent the invitation. This property has been replaced by the administratorAccountId property and is retained only for backward compatibility.</p>
2512
2869
  */
2513
2870
  masterAccount?: string;
@@ -2607,10 +2964,12 @@ export declare class ValidationException extends __BaseException {
2607
2964
  */
2608
2965
  export interface AccountDetail {
2609
2966
  /**
2967
+ * @public
2610
2968
  * <p>The Amazon Web Services account ID for the account.</p>
2611
2969
  */
2612
2970
  accountId: string | undefined;
2613
2971
  /**
2972
+ * @public
2614
2973
  * <p>The email address for the account.</p>
2615
2974
  */
2616
2975
  email: string | undefined;
@@ -2621,10 +2980,12 @@ export interface AccountDetail {
2621
2980
  */
2622
2981
  export interface S3WordsList {
2623
2982
  /**
2983
+ * @public
2624
2984
  * <p>The full name of the S3 bucket that contains the object.</p>
2625
2985
  */
2626
2986
  bucketName: string | undefined;
2627
2987
  /**
2988
+ * @public
2628
2989
  * <p>The full name (key) of the object.</p>
2629
2990
  */
2630
2991
  objectKey: string | undefined;
@@ -2635,10 +2996,12 @@ export interface S3WordsList {
2635
2996
  */
2636
2997
  export interface AllowListCriteria {
2637
2998
  /**
2999
+ * @public
2638
3000
  * <p>The regular expression (<i>regex</i>) that defines the text pattern to ignore. The expression can contain as many as 512 characters.</p>
2639
3001
  */
2640
3002
  regex?: string;
2641
3003
  /**
3004
+ * @public
2642
3005
  * <p>The location and name of the S3 object that lists specific text to ignore.</p>
2643
3006
  */
2644
3007
  s3WordsList?: S3WordsList;
@@ -2667,10 +3030,12 @@ export type AllowListStatusCode = (typeof AllowListStatusCode)[keyof typeof Allo
2667
3030
  */
2668
3031
  export interface AllowListStatus {
2669
3032
  /**
3033
+ * @public
2670
3034
  * <p>The current status of the allow list. If the list's criteria specify a regular expression (regex), this value is typically OK. Amazon Macie can compile the expression.</p> <p>If the list's criteria specify an S3 object, possible values are:</p> <ul><li><p>OK - Macie can retrieve and parse the contents of the object.</p></li> <li><p>S3_OBJECT_ACCESS_DENIED - Macie isn't allowed to access the object or the object is encrypted with a customer managed KMS key that Macie isn't allowed to use. Check the bucket policy and other permissions settings for the bucket and the object. If the object is encrypted, also ensure that it's encrypted with a key that Macie is allowed to use.</p></li> <li><p>S3_OBJECT_EMPTY - Macie can retrieve the object but the object doesn't contain any content. Ensure that the object contains the correct entries. Also ensure that the list's criteria specify the correct bucket and object names.</p></li> <li><p>S3_OBJECT_NOT_FOUND - The object doesn't exist in Amazon S3. Ensure that the list's criteria specify the correct bucket and object names.</p></li> <li><p>S3_OBJECT_OVERSIZE - Macie can retrieve the object. However, the object contains too many entries or its storage size exceeds the quota for an allow list. Try breaking the list into multiple files and ensure that each file doesn't exceed any quotas. Then configure list settings in Macie for each file.</p></li> <li><p>S3_THROTTLED - Amazon S3 throttled the request to retrieve the object. Wait a few minutes and then try again.</p></li> <li><p>S3_USER_ACCESS_DENIED - Amazon S3 denied the request to retrieve the object. If the specified object exists, you're not allowed to access it or it's encrypted with an KMS key that you're not allowed to use. Work with your Amazon Web Services administrator to ensure that the list's criteria specify the correct bucket and object names, and you have read access to the bucket and the object. If the object is encrypted, also ensure that it's encrypted with a key that you're allowed to use.</p></li> <li><p>UNKNOWN_ERROR - A transient or internal error occurred when Macie attempted to retrieve or parse the object. Wait a few minutes and then try again. A list can also have this status if it's encrypted with a key that Amazon S3 and Macie can't access or use.</p></li></ul>
2671
3035
  */
2672
3036
  code: AllowListStatusCode | string | undefined;
2673
3037
  /**
3038
+ * @public
2674
3039
  * <p>A brief description of the status of the allow list. Amazon Macie uses this value to provide additional information about an error that occurred when Macie tried to access and use the list's criteria.</p>
2675
3040
  */
2676
3041
  description?: string;
@@ -2704,6 +3069,7 @@ export type AvailabilityCode = (typeof AvailabilityCode)[keyof typeof Availabili
2704
3069
  */
2705
3070
  export interface BatchGetCustomDataIdentifiersRequest {
2706
3071
  /**
3072
+ * @public
2707
3073
  * <p>An array of custom data identifier IDs, one for each custom data identifier to retrieve information about.</p>
2708
3074
  */
2709
3075
  ids?: string[];
@@ -2713,10 +3079,12 @@ export interface BatchGetCustomDataIdentifiersRequest {
2713
3079
  */
2714
3080
  export interface BatchGetCustomDataIdentifiersResponse {
2715
3081
  /**
3082
+ * @public
2716
3083
  * <p>An array of objects, one for each custom data identifier that matches the criteria specified in the request.</p>
2717
3084
  */
2718
3085
  customDataIdentifiers?: BatchGetCustomDataIdentifierSummary[];
2719
3086
  /**
3087
+ * @public
2720
3088
  * <p>An array of custom data identifier IDs, one for each custom data identifier that was specified in the request but doesn't correlate to an existing custom data identifier.</p>
2721
3089
  */
2722
3090
  notFoundIdentifierIds?: string[];
@@ -2727,18 +3095,22 @@ export interface BatchGetCustomDataIdentifiersResponse {
2727
3095
  */
2728
3096
  export interface BucketCountByEffectivePermission {
2729
3097
  /**
3098
+ * @public
2730
3099
  * <p>The total number of buckets that allow the general public to have read or write access to the bucket.</p>
2731
3100
  */
2732
3101
  publiclyAccessible?: number;
2733
3102
  /**
3103
+ * @public
2734
3104
  * <p>The total number of buckets that allow the general public to have read access to the bucket.</p>
2735
3105
  */
2736
3106
  publiclyReadable?: number;
2737
3107
  /**
3108
+ * @public
2738
3109
  * <p>The total number of buckets that allow the general public to have write access to the bucket.</p>
2739
3110
  */
2740
3111
  publiclyWritable?: number;
2741
3112
  /**
3113
+ * @public
2742
3114
  * <p>The total number of buckets that Amazon Macie wasn't able to evaluate permissions settings for. Macie can't determine whether these buckets are publicly accessible.</p>
2743
3115
  */
2744
3116
  unknown?: number;
@@ -2749,18 +3121,22 @@ export interface BucketCountByEffectivePermission {
2749
3121
  */
2750
3122
  export interface BucketCountByEncryptionType {
2751
3123
  /**
3124
+ * @public
2752
3125
  * <p>The total number of buckets whose default encryption settings are configured to encrypt new objects with an Amazon Web Services managed KMS key or a customer managed KMS key. By default, these buckets encrypt new objects automatically using SSE-KMS encryption.</p>
2753
3126
  */
2754
3127
  kmsManaged?: number;
2755
3128
  /**
3129
+ * @public
2756
3130
  * <p>The total number of buckets whose default encryption settings are configured to encrypt new objects with an Amazon S3 managed key. By default, these buckets encrypt new objects automatically using SSE-S3 encryption.</p>
2757
3131
  */
2758
3132
  s3Managed?: number;
2759
3133
  /**
3134
+ * @public
2760
3135
  * <p>The total number of buckets that don't specify default server-side encryption behavior for new objects. Default encryption settings aren't configured for these buckets.</p>
2761
3136
  */
2762
3137
  unencrypted?: number;
2763
3138
  /**
3139
+ * @public
2764
3140
  * <p>The total number of buckets that Amazon Macie doesn't have current encryption metadata for. Macie can't provide current data about the default encryption settings for these buckets.</p>
2765
3141
  */
2766
3142
  unknown?: number;
@@ -2771,18 +3147,22 @@ export interface BucketCountByEncryptionType {
2771
3147
  */
2772
3148
  export interface BucketCountBySharedAccessType {
2773
3149
  /**
3150
+ * @public
2774
3151
  * <p>The total number of buckets that are shared with one or more of the following or any combination of the following: an Amazon CloudFront OAI, a CloudFront OAC, or an Amazon Web Services account that isn't in the same Amazon Macie organization.</p>
2775
3152
  */
2776
3153
  external?: number;
2777
3154
  /**
3155
+ * @public
2778
3156
  * <p>The total number of buckets that are shared with one or more Amazon Web Services accounts in the same Amazon Macie organization. These buckets aren't shared with Amazon CloudFront OAIs or OACs.</p>
2779
3157
  */
2780
3158
  internal?: number;
2781
3159
  /**
3160
+ * @public
2782
3161
  * <p>The total number of buckets that aren't shared with other Amazon Web Services accounts, Amazon CloudFront OAIs, or CloudFront OACs.</p>
2783
3162
  */
2784
3163
  notShared?: number;
2785
3164
  /**
3165
+ * @public
2786
3166
  * <p>The total number of buckets that Amazon Macie wasn't able to evaluate shared access settings for. Macie can't determine whether these buckets are shared with other Amazon Web Services accounts, Amazon CloudFront OAIs, or CloudFront OACs.</p>
2787
3167
  */
2788
3168
  unknown?: number;
@@ -2793,14 +3173,17 @@ export interface BucketCountBySharedAccessType {
2793
3173
  */
2794
3174
  export interface BucketCountPolicyAllowsUnencryptedObjectUploads {
2795
3175
  /**
3176
+ * @public
2796
3177
  * <p>The total number of buckets that don't have a bucket policy or have a bucket policy that doesn't require server-side encryption of new objects. If a bucket policy exists, the policy doesn't require PutObject requests to include a valid server-side encryption header: the x-amz-server-side-encryption header with a value of AES256 or aws:kms, or the x-amz-server-side-encryption-customer-algorithm header with a value of AES256.</p>
2797
3178
  */
2798
3179
  allowsUnencryptedObjectUploads?: number;
2799
3180
  /**
3181
+ * @public
2800
3182
  * <p>The total number of buckets whose bucket policies require server-side encryption of new objects. PutObject requests for these buckets must include a valid server-side encryption header: the x-amz-server-side-encryption header with a value of AES256 or aws:kms, or the x-amz-server-side-encryption-customer-algorithm header with a value of AES256.</p>
2801
3183
  */
2802
3184
  deniesUnencryptedObjectUploads?: number;
2803
3185
  /**
3186
+ * @public
2804
3187
  * <p>The total number of buckets that Amazon Macie wasn't able to evaluate server-side encryption requirements for. Macie can't determine whether the bucket policies for these buckets require server-side encryption of new objects.</p>
2805
3188
  */
2806
3189
  unknown?: number;
@@ -2811,30 +3194,37 @@ export interface BucketCountPolicyAllowsUnencryptedObjectUploads {
2811
3194
  */
2812
3195
  export interface BucketCriteriaAdditionalProperties {
2813
3196
  /**
3197
+ * @public
2814
3198
  * <p>The value for the property matches (equals) the specified value. If you specify multiple values, Amazon Macie uses OR logic to join the values.</p>
2815
3199
  */
2816
3200
  eq?: string[];
2817
3201
  /**
3202
+ * @public
2818
3203
  * <p>The value for the property is greater than the specified value.</p>
2819
3204
  */
2820
3205
  gt?: number;
2821
3206
  /**
3207
+ * @public
2822
3208
  * <p>The value for the property is greater than or equal to the specified value.</p>
2823
3209
  */
2824
3210
  gte?: number;
2825
3211
  /**
3212
+ * @public
2826
3213
  * <p>The value for the property is less than the specified value.</p>
2827
3214
  */
2828
3215
  lt?: number;
2829
3216
  /**
3217
+ * @public
2830
3218
  * <p>The value for the property is less than or equal to the specified value.</p>
2831
3219
  */
2832
3220
  lte?: number;
2833
3221
  /**
3222
+ * @public
2834
3223
  * <p>The value for the property doesn't match (doesn't equal) the specified value. If you specify multiple values, Amazon Macie uses OR logic to join the values.</p>
2835
3224
  */
2836
3225
  neq?: string[];
2837
3226
  /**
3227
+ * @public
2838
3228
  * <p>The name of the bucket begins with the specified value.</p>
2839
3229
  */
2840
3230
  prefix?: string;
@@ -2857,10 +3247,12 @@ export type OrderBy = (typeof OrderBy)[keyof typeof OrderBy];
2857
3247
  */
2858
3248
  export interface BucketSortCriteria {
2859
3249
  /**
3250
+ * @public
2860
3251
  * <p>The name of the bucket property to sort the results by. This value can be one of the following properties that Amazon Macie defines as bucket metadata: accountId, bucketName, classifiableObjectCount, classifiableSizeInBytes, objectCount, sensitivityScore, or sizeInBytes.</p>
2861
3252
  */
2862
3253
  attributeName?: string;
2863
3254
  /**
3255
+ * @public
2864
3256
  * <p>The sort order to apply to the results, based on the value specified by the attributeName property. Valid values are: ASC, sort the results in ascending order; and, DESC, sort the results in descending order.</p>
2865
3257
  */
2866
3258
  orderBy?: OrderBy | string;
@@ -2871,18 +3263,22 @@ export interface BucketSortCriteria {
2871
3263
  */
2872
3264
  export interface SensitivityAggregations {
2873
3265
  /**
3266
+ * @public
2874
3267
  * <p>The total storage size, in bytes, of all the objects that Amazon Macie can analyze in the buckets. These objects use a supported storage class and have a file name extension for a supported file or storage format.</p> <p>If versioning is enabled for any of the buckets, this value is based on the size of the latest version of each applicable object in the buckets. This value doesn't reflect the storage size of all versions of all applicable objects in the buckets.</p>
2875
3268
  */
2876
3269
  classifiableSizeInBytes?: number;
2877
3270
  /**
3271
+ * @public
2878
3272
  * <p>The total number of buckets that are publicly accessible due to a combination of permissions settings for each bucket.</p>
2879
3273
  */
2880
3274
  publiclyAccessibleCount?: number;
2881
3275
  /**
3276
+ * @public
2882
3277
  * <p>The total number of buckets.</p>
2883
3278
  */
2884
3279
  totalCount?: number;
2885
3280
  /**
3281
+ * @public
2886
3282
  * <p>The total storage size, in bytes, of the buckets.</p> <p>If versioning is enabled for any of the buckets, this value is based on the size of the latest version of each object in the buckets. This value doesn't reflect the storage size of all versions of the objects in the buckets.</p>
2887
3283
  */
2888
3284
  totalSizeInBytes?: number;
@@ -2893,18 +3289,22 @@ export interface SensitivityAggregations {
2893
3289
  */
2894
3290
  export interface BucketStatisticsBySensitivity {
2895
3291
  /**
3292
+ * @public
2896
3293
  * <p>The aggregated statistical data for all buckets that have a sensitivity score of -1.</p>
2897
3294
  */
2898
3295
  classificationError?: SensitivityAggregations;
2899
3296
  /**
3297
+ * @public
2900
3298
  * <p>The aggregated statistical data for all buckets that have a sensitivity score of 50.</p>
2901
3299
  */
2902
3300
  notClassified?: SensitivityAggregations;
2903
3301
  /**
3302
+ * @public
2904
3303
  * <p>The aggregated statistical data for all buckets that have a sensitivity score of 1-49.</p>
2905
3304
  */
2906
3305
  notSensitive?: SensitivityAggregations;
2907
3306
  /**
3307
+ * @public
2908
3308
  * <p>The aggregated statistical data for all buckets that have a sensitivity score of 51-100.</p>
2909
3309
  */
2910
3310
  sensitive?: SensitivityAggregations;
@@ -2915,14 +3315,17 @@ export interface BucketStatisticsBySensitivity {
2915
3315
  */
2916
3316
  export interface S3Destination {
2917
3317
  /**
3318
+ * @public
2918
3319
  * <p>The name of the bucket.</p>
2919
3320
  */
2920
3321
  bucketName: string | undefined;
2921
3322
  /**
3323
+ * @public
2922
3324
  * <p>The path prefix to use in the path to the location in the bucket. This prefix specifies where to store classification results in the bucket.</p>
2923
3325
  */
2924
3326
  keyPrefix?: string;
2925
3327
  /**
3328
+ * @public
2926
3329
  * <p>The Amazon Resource Name (ARN) of the customer managed KMS key to use for encryption of the results. This must be the ARN of an existing, symmetric encryption KMS key that's in the same Amazon Web Services Region as the bucket.</p>
2927
3330
  */
2928
3331
  kmsKeyArn: string | undefined;
@@ -2933,6 +3336,7 @@ export interface S3Destination {
2933
3336
  */
2934
3337
  export interface ClassificationExportConfiguration {
2935
3338
  /**
3339
+ * @public
2936
3340
  * <p>The S3 bucket to store data classification results in, and the encryption settings to use when storing results in that bucket.</p>
2937
3341
  */
2938
3342
  s3Destination?: S3Destination;
@@ -2955,22 +3359,27 @@ export type ClassificationScopeUpdateOperation = (typeof ClassificationScopeUpda
2955
3359
  */
2956
3360
  export interface CreateAllowListRequest {
2957
3361
  /**
3362
+ * @public
2958
3363
  * <p>A unique, case-sensitive token that you provide to ensure the idempotency of the request.</p>
2959
3364
  */
2960
3365
  clientToken?: string;
2961
3366
  /**
3367
+ * @public
2962
3368
  * <p>The criteria that specify the text or text pattern to ignore. The criteria can be the location and name of an S3 object that lists specific text to ignore (s3WordsList), or a regular expression (regex) that defines a text pattern to ignore.</p>
2963
3369
  */
2964
3370
  criteria: AllowListCriteria | undefined;
2965
3371
  /**
3372
+ * @public
2966
3373
  * <p>A custom description of the allow list. The description can contain as many as 512 characters.</p>
2967
3374
  */
2968
3375
  description?: string;
2969
3376
  /**
3377
+ * @public
2970
3378
  * <p>A custom name for the allow list. The name can contain as many as 128 characters.</p>
2971
3379
  */
2972
3380
  name: string | undefined;
2973
3381
  /**
3382
+ * @public
2974
3383
  * <p>A map of key-value pairs that specifies the tags to associate with the allow list.</p> <p>An allow list can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.</p>
2975
3384
  */
2976
3385
  tags?: Record<string, string>;
@@ -2980,10 +3389,12 @@ export interface CreateAllowListRequest {
2980
3389
  */
2981
3390
  export interface CreateAllowListResponse {
2982
3391
  /**
3392
+ * @public
2983
3393
  * <p>The Amazon Resource Name (ARN) of the allow list.</p>
2984
3394
  */
2985
3395
  arn?: string;
2986
3396
  /**
3397
+ * @public
2987
3398
  * <p>The unique identifier for the allow list.</p>
2988
3399
  */
2989
3400
  id?: string;
@@ -3009,6 +3420,7 @@ export type ManagedDataIdentifierSelector = (typeof ManagedDataIdentifierSelecto
3009
3420
  */
3010
3421
  export interface JobScopingBlock {
3011
3422
  /**
3423
+ * @public
3012
3424
  * <p>An array of conditions, one for each property- or tag-based condition that determines which objects to include or exclude from the job. If you specify more than one condition, Amazon Macie uses AND logic to join the conditions.</p>
3013
3425
  */
3014
3426
  and?: JobScopeTerm[];
@@ -3019,10 +3431,12 @@ export interface JobScopingBlock {
3019
3431
  */
3020
3432
  export interface Scoping {
3021
3433
  /**
3434
+ * @public
3022
3435
  * <p>The property- and tag-based conditions that determine which objects to exclude from the analysis.</p>
3023
3436
  */
3024
3437
  excludes?: JobScopingBlock;
3025
3438
  /**
3439
+ * @public
3026
3440
  * <p>The property- and tag-based conditions that determine which objects to include in the analysis.</p>
3027
3441
  */
3028
3442
  includes?: JobScopingBlock;
@@ -3033,14 +3447,17 @@ export interface Scoping {
3033
3447
  */
3034
3448
  export interface S3JobDefinition {
3035
3449
  /**
3450
+ * @public
3036
3451
  * <p>The property- and tag-based conditions that determine which S3 buckets to include or exclude from the analysis. Each time the job runs, the job uses these criteria to determine which buckets contain objects to analyze. A job's definition can contain a bucketCriteria object or a bucketDefinitions array, not both.</p>
3037
3452
  */
3038
3453
  bucketCriteria?: S3BucketCriteriaForJob;
3039
3454
  /**
3455
+ * @public
3040
3456
  * <p>An array of objects, one for each Amazon Web Services account that owns specific S3 buckets to analyze. Each object specifies the account ID for an account and one or more buckets to analyze for that account. A job's definition can contain a bucketDefinitions array or a bucketCriteria object, not both.</p>
3041
3457
  */
3042
3458
  bucketDefinitions?: S3BucketDefinitionForJob[];
3043
3459
  /**
3460
+ * @public
3044
3461
  * <p>The property- and tag-based conditions that determine which S3 objects to include or exclude from the analysis. Each time the job runs, the job uses these criteria to determine which objects to analyze.</p>
3045
3462
  */
3046
3463
  scoping?: Scoping;
@@ -3057,6 +3474,7 @@ export interface DailySchedule {
3057
3474
  */
3058
3475
  export interface MonthlySchedule {
3059
3476
  /**
3477
+ * @public
3060
3478
  * <p>The numeric day of the month when Amazon Macie runs the job. This value can be an integer from 1 through 31.</p> <p>If this value exceeds the number of days in a certain month, Macie doesn't run the job that month. Macie runs the job only during months that have the specified day. For example, if this value is 31 and a month has only 30 days, Macie doesn't run the job that month. To run the job every month, specify a value that's less than 29.</p>
3061
3479
  */
3062
3480
  dayOfMonth?: number;
@@ -3084,6 +3502,7 @@ export type DayOfWeek = (typeof DayOfWeek)[keyof typeof DayOfWeek];
3084
3502
  */
3085
3503
  export interface WeeklySchedule {
3086
3504
  /**
3505
+ * @public
3087
3506
  * <p>The day of the week when Amazon Macie runs the job.</p>
3088
3507
  */
3089
3508
  dayOfWeek?: DayOfWeek | string;
@@ -3094,14 +3513,17 @@ export interface WeeklySchedule {
3094
3513
  */
3095
3514
  export interface JobScheduleFrequency {
3096
3515
  /**
3516
+ * @public
3097
3517
  * <p>Specifies a daily recurrence pattern for running the job.</p>
3098
3518
  */
3099
3519
  dailySchedule?: DailySchedule;
3100
3520
  /**
3521
+ * @public
3101
3522
  * <p>Specifies a monthly recurrence pattern for running the job.</p>
3102
3523
  */
3103
3524
  monthlySchedule?: MonthlySchedule;
3104
3525
  /**
3526
+ * @public
3105
3527
  * <p>Specifies a weekly recurrence pattern for running the job.</p>
3106
3528
  */
3107
3529
  weeklySchedule?: WeeklySchedule;
@@ -3111,54 +3533,67 @@ export interface JobScheduleFrequency {
3111
3533
  */
3112
3534
  export interface CreateClassificationJobRequest {
3113
3535
  /**
3536
+ * @public
3114
3537
  * <p>An array of unique identifiers, one for each allow list for the job to use when it analyzes data.</p>
3115
3538
  */
3116
3539
  allowListIds?: string[];
3117
3540
  /**
3541
+ * @public
3118
3542
  * <p>A unique, case-sensitive token that you provide to ensure the idempotency of the request.</p>
3119
3543
  */
3120
3544
  clientToken?: string;
3121
3545
  /**
3546
+ * @public
3122
3547
  * <p>An array of unique identifiers, one for each custom data identifier for the job to use when it analyzes data. To use only managed data identifiers, don't specify a value for this property and specify a value other than NONE for the managedDataIdentifierSelector property.</p>
3123
3548
  */
3124
3549
  customDataIdentifierIds?: string[];
3125
3550
  /**
3551
+ * @public
3126
3552
  * <p>A custom description of the job. The description can contain as many as 200 characters.</p>
3127
3553
  */
3128
3554
  description?: string;
3129
3555
  /**
3556
+ * @public
3130
3557
  * <p>For a recurring job, specifies whether to analyze all existing, eligible objects immediately after the job is created (true). To analyze only those objects that are created or changed after you create the job and before the job's first scheduled run, set this value to false.</p> <p>If you configure the job to run only once, don't specify a value for this property.</p>
3131
3558
  */
3132
3559
  initialRun?: boolean;
3133
3560
  /**
3561
+ * @public
3134
3562
  * <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>
3135
3563
  */
3136
3564
  jobType: JobType | string | undefined;
3137
3565
  /**
3566
+ * @public
3138
3567
  * <p>An array of unique identifiers, one for each managed data identifier for the job to include (use) or exclude (not use) when it analyzes data. Inclusion or exclusion depends on the managed data identifier selection type that you specify for the job (managedDataIdentifierSelector).</p> <p>To retrieve a list of valid values for this property, use the ListManagedDataIdentifiers operation.</p>
3139
3568
  */
3140
3569
  managedDataIdentifierIds?: string[];
3141
3570
  /**
3571
+ * @public
3142
3572
  * <p>The selection type to apply when determining which managed data identifiers the job uses to analyze data. Valid values are:</p> <ul><li><p>ALL (default) - Use all managed data identifiers. If you specify this value, don't specify any values for the managedDataIdentifierIds property.</p></li> <li><p>EXCLUDE - Use all managed data identifiers except the ones specified by the managedDataIdentifierIds property.</p></li> <li><p>INCLUDE - Use only the managed data identifiers specified by the managedDataIdentifierIds property.</p></li> <li><p>NONE - Don't use any managed data identifiers. If you specify this value, specify at least one custom data identifier for the job (customDataIdentifierIds) and don't specify any values for the managedDataIdentifierIds property.</p></li> <li><p>RECOMMENDED - Use only the set of managed data identifiers that Amazon Web Services recommends for jobs. If you specify this value, don't specify any values for the managedDataIdentifierIds property.</p></li></ul> <p>If you don't specify a value for this property, the job uses all managed data identifiers.</p> <p>If the job is a recurring job and you don't specify a value for this property or you specify ALL or EXCLUDE, each job run automatically uses new managed data identifiers that are released. If you specify RECOMMENDED for a recurring job, each job run automatically uses all the managed data identifiers that are in the recommended set when the job starts to run.</p> <p>For information about individual managed data identifiers or to determine which ones are in the recommended set, see <a href="https://docs.aws.amazon.com/macie/latest/user/managed-data-identifiers.html">Using managed data identifiers</a> and <a href="https://docs.aws.amazon.com/macie/latest/user/discovery-jobs-mdis-recommended.html">Recommended managed data identifiers</a> in the <i>Amazon Macie User Guide</i>.</p>
3143
3573
  */
3144
3574
  managedDataIdentifierSelector?: ManagedDataIdentifierSelector | string;
3145
3575
  /**
3576
+ * @public
3146
3577
  * <p>A custom name for the job. The name can contain as many as 500 characters.</p>
3147
3578
  */
3148
3579
  name: string | undefined;
3149
3580
  /**
3581
+ * @public
3150
3582
  * <p>The S3 buckets that contain the objects to analyze, and the scope of that analysis.</p>
3151
3583
  */
3152
3584
  s3JobDefinition: S3JobDefinition | undefined;
3153
3585
  /**
3586
+ * @public
3154
3587
  * <p>The sampling depth, as a percentage, for the job to apply when processing objects. This value determines the percentage of eligible objects that the job analyzes. If this value is less than 100, Amazon Macie selects the objects to analyze at random, up to the specified percentage, and analyzes all the data in those objects.</p>
3155
3588
  */
3156
3589
  samplingPercentage?: number;
3157
3590
  /**
3591
+ * @public
3158
3592
  * <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>
3159
3593
  */
3160
3594
  scheduleFrequency?: JobScheduleFrequency;
3161
3595
  /**
3596
+ * @public
3162
3597
  * <p>A map of key-value pairs that specifies the tags to associate with the job.</p> <p>A job can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.</p>
3163
3598
  */
3164
3599
  tags?: Record<string, string>;
@@ -3168,10 +3603,12 @@ export interface CreateClassificationJobRequest {
3168
3603
  */
3169
3604
  export interface CreateClassificationJobResponse {
3170
3605
  /**
3606
+ * @public
3171
3607
  * <p>The Amazon Resource Name (ARN) of the job.</p>
3172
3608
  */
3173
3609
  jobArn?: string;
3174
3610
  /**
3611
+ * @public
3175
3612
  * <p>The unique identifier for the job.</p>
3176
3613
  */
3177
3614
  jobId?: string;
@@ -3195,10 +3632,12 @@ export type DataIdentifierSeverity = (typeof DataIdentifierSeverity)[keyof typeo
3195
3632
  */
3196
3633
  export interface SeverityLevel {
3197
3634
  /**
3635
+ * @public
3198
3636
  * <p>The minimum number of occurrences of text that must match the custom data identifier's detection criteria in order to produce a finding with the specified severity (severity).</p>
3199
3637
  */
3200
3638
  occurrencesThreshold: number | undefined;
3201
3639
  /**
3640
+ * @public
3202
3641
  * <p>The severity to assign to a finding: if the number of occurrences is greater than or equal to the specified threshold (occurrencesThreshold); and, if applicable, the number of occurrences is less than the threshold for the next consecutive severity level for the custom data identifier, moving from LOW to HIGH.</p>
3203
3642
  */
3204
3643
  severity: DataIdentifierSeverity | string | undefined;
@@ -3208,38 +3647,47 @@ export interface SeverityLevel {
3208
3647
  */
3209
3648
  export interface CreateCustomDataIdentifierRequest {
3210
3649
  /**
3650
+ * @public
3211
3651
  * <p>A unique, case-sensitive token that you provide to ensure the idempotency of the request.</p>
3212
3652
  */
3213
3653
  clientToken?: string;
3214
3654
  /**
3655
+ * @public
3215
3656
  * <p>A custom description of the custom data identifier. The description can contain as many as 512 characters.</p> <p>We strongly recommend that you avoid including any sensitive data in the description of a custom data identifier. Other users of your account might be able to see this description, depending on the actions that they're allowed to perform in Amazon Macie.</p>
3216
3657
  */
3217
3658
  description?: string;
3218
3659
  /**
3660
+ * @public
3219
3661
  * <p>An array that lists specific character sequences (<i>ignore words</i>) to exclude from the results. If the text matched by the regular expression contains any string in this array, Amazon Macie ignores it. The array can contain as many as 10 ignore words. Each ignore word can contain 4-90 UTF-8 characters. Ignore words are case sensitive.</p>
3220
3662
  */
3221
3663
  ignoreWords?: string[];
3222
3664
  /**
3665
+ * @public
3223
3666
  * <p>An array that lists specific character sequences (<i>keywords</i>), one of which must precede and be within proximity (maximumMatchDistance) of the regular expression to match. The array can contain as many as 50 keywords. Each keyword can contain 3-90 UTF-8 characters. Keywords aren't case sensitive.</p>
3224
3667
  */
3225
3668
  keywords?: string[];
3226
3669
  /**
3670
+ * @public
3227
3671
  * <p>The maximum number of characters that can exist between the end of at least one complete character sequence specified by the keywords array and the end of the text that matches the regex pattern. If a complete keyword precedes all the text that matches the pattern and the keyword is within the specified distance, Amazon Macie includes the result. The distance can be 1-300 characters. The default value is 50.</p>
3228
3672
  */
3229
3673
  maximumMatchDistance?: number;
3230
3674
  /**
3675
+ * @public
3231
3676
  * <p>A custom name for the custom data identifier. The name can contain as many as 128 characters.</p> <p>We strongly recommend that you avoid including any sensitive data in the name of a custom data identifier. Other users of your account might be able to see this name, depending on the actions that they're allowed to perform in Amazon Macie.</p>
3232
3677
  */
3233
3678
  name: string | undefined;
3234
3679
  /**
3680
+ * @public
3235
3681
  * <p>The regular expression (<i>regex</i>) that defines the pattern to match. The expression can contain as many as 512 characters.</p>
3236
3682
  */
3237
3683
  regex: string | undefined;
3238
3684
  /**
3685
+ * @public
3239
3686
  * <p>The severity to assign to findings that the custom data identifier produces, based on the number of occurrences of text that match the custom data identifier's detection criteria. You can specify as many as three SeverityLevel objects in this array, one for each severity: LOW, MEDIUM, or HIGH. If you specify more than one, the occurrences thresholds must be in ascending order by severity, moving from LOW to HIGH. For example, 1 for LOW, 50 for MEDIUM, and 100 for HIGH. If an S3 object contains fewer occurrences than the lowest specified threshold, Amazon Macie doesn't create a finding.</p> <p>If you don't specify any values for this array, Macie creates findings for S3 objects that contain at least one occurrence of text that matches the detection criteria, and Macie assigns the MEDIUM severity to those findings.</p>
3240
3687
  */
3241
3688
  severityLevels?: SeverityLevel[];
3242
3689
  /**
3690
+ * @public
3243
3691
  * <p>A map of key-value pairs that specifies the tags to associate with the custom data identifier.</p> <p>A custom data identifier can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.</p>
3244
3692
  */
3245
3693
  tags?: Record<string, string>;
@@ -3249,6 +3697,7 @@ export interface CreateCustomDataIdentifierRequest {
3249
3697
  */
3250
3698
  export interface CreateCustomDataIdentifierResponse {
3251
3699
  /**
3700
+ * @public
3252
3701
  * <p>The unique identifier for the custom data identifier that was created.</p>
3253
3702
  */
3254
3703
  customDataIdentifierId?: string;
@@ -3259,30 +3708,37 @@ export interface CreateCustomDataIdentifierResponse {
3259
3708
  */
3260
3709
  export interface CriterionAdditionalProperties {
3261
3710
  /**
3711
+ * @public
3262
3712
  * <p>The value for the property matches (equals) the specified value. If you specify multiple values, Macie uses OR logic to join the values.</p>
3263
3713
  */
3264
3714
  eq?: string[];
3265
3715
  /**
3716
+ * @public
3266
3717
  * <p>The value for the property exclusively matches (equals an exact match for) all the specified values. If you specify multiple values, Amazon Macie uses AND logic to join the values.</p> <p>You can use this operator with the following properties: customDataIdentifiers.detections.arn, customDataIdentifiers.detections.name, resourcesAffected.s3Bucket.tags.key, resourcesAffected.s3Bucket.tags.value, resourcesAffected.s3Object.tags.key, resourcesAffected.s3Object.tags.value, sensitiveData.category, and sensitiveData.detections.type.</p>
3267
3718
  */
3268
3719
  eqExactMatch?: string[];
3269
3720
  /**
3721
+ * @public
3270
3722
  * <p>The value for the property is greater than the specified value.</p>
3271
3723
  */
3272
3724
  gt?: number;
3273
3725
  /**
3726
+ * @public
3274
3727
  * <p>The value for the property is greater than or equal to the specified value.</p>
3275
3728
  */
3276
3729
  gte?: number;
3277
3730
  /**
3731
+ * @public
3278
3732
  * <p>The value for the property is less than the specified value.</p>
3279
3733
  */
3280
3734
  lt?: number;
3281
3735
  /**
3736
+ * @public
3282
3737
  * <p>The value for the property is less than or equal to the specified value.</p>
3283
3738
  */
3284
3739
  lte?: number;
3285
3740
  /**
3741
+ * @public
3286
3742
  * <p>The value for the property doesn't match (doesn't equal) the specified value. If you specify multiple values, Macie uses OR logic to join the values.</p>
3287
3743
  */
3288
3744
  neq?: string[];
@@ -3293,6 +3749,7 @@ export interface CriterionAdditionalProperties {
3293
3749
  */
3294
3750
  export interface FindingCriteria {
3295
3751
  /**
3752
+ * @public
3296
3753
  * <p>A condition that specifies the property, operator, and one or more values to use to filter the results.</p>
3297
3754
  */
3298
3755
  criterion?: Record<string, CriterionAdditionalProperties>;
@@ -3302,30 +3759,37 @@ export interface FindingCriteria {
3302
3759
  */
3303
3760
  export interface CreateFindingsFilterRequest {
3304
3761
  /**
3762
+ * @public
3305
3763
  * <p>The action to perform on findings that match the filter criteria (findingCriteria). Valid values are: ARCHIVE, suppress (automatically archive) the findings; and, NOOP, don't perform any action on the findings.</p>
3306
3764
  */
3307
3765
  action: FindingsFilterAction | string | undefined;
3308
3766
  /**
3767
+ * @public
3309
3768
  * <p>A unique, case-sensitive token that you provide to ensure the idempotency of the request.</p>
3310
3769
  */
3311
3770
  clientToken?: string;
3312
3771
  /**
3772
+ * @public
3313
3773
  * <p>A custom description of the filter. The description can contain as many as 512 characters.</p> <p>We strongly recommend that you avoid including any sensitive data in the description of a filter. Other users of your account might be able to see this description, depending on the actions that they're allowed to perform in Amazon Macie.</p>
3314
3774
  */
3315
3775
  description?: string;
3316
3776
  /**
3777
+ * @public
3317
3778
  * <p>The criteria to use to filter findings.</p>
3318
3779
  */
3319
3780
  findingCriteria: FindingCriteria | undefined;
3320
3781
  /**
3782
+ * @public
3321
3783
  * <p>A custom name for the filter. The name must contain at least 3 characters and can contain as many as 64 characters.</p> <p>We strongly recommend that you avoid including any sensitive data in the name of a filter. Other users of your account might be able to see this name, depending on the actions that they're allowed to perform in Amazon Macie.</p>
3322
3784
  */
3323
3785
  name: string | undefined;
3324
3786
  /**
3787
+ * @public
3325
3788
  * <p>The position of the filter in the list of saved filters on the Amazon Macie console. This value also determines the order in which the filter is applied to findings, relative to other filters that are also applied to the findings.</p>
3326
3789
  */
3327
3790
  position?: number;
3328
3791
  /**
3792
+ * @public
3329
3793
  * <p>A map of key-value pairs that specifies the tags to associate with the filter.</p> <p>A findings filter can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.</p>
3330
3794
  */
3331
3795
  tags?: Record<string, string>;
@@ -3335,10 +3799,12 @@ export interface CreateFindingsFilterRequest {
3335
3799
  */
3336
3800
  export interface CreateFindingsFilterResponse {
3337
3801
  /**
3802
+ * @public
3338
3803
  * <p>The Amazon Resource Name (ARN) of the filter that was created.</p>
3339
3804
  */
3340
3805
  arn?: string;
3341
3806
  /**
3807
+ * @public
3342
3808
  * <p>The unique identifier for the filter that was created.</p>
3343
3809
  */
3344
3810
  id?: string;
@@ -3348,14 +3814,17 @@ export interface CreateFindingsFilterResponse {
3348
3814
  */
3349
3815
  export interface CreateInvitationsRequest {
3350
3816
  /**
3817
+ * @public
3351
3818
  * <p>An array that lists Amazon Web Services account IDs, one for each account to send the invitation to.</p>
3352
3819
  */
3353
3820
  accountIds: string[] | undefined;
3354
3821
  /**
3822
+ * @public
3355
3823
  * <p>Specifies whether to send the invitation as an email message. If this value is false, Amazon Macie sends the invitation (as an email message) to the email address that you specified for the recipient's account when you associated the account with your account. The default value is false.</p>
3356
3824
  */
3357
3825
  disableEmailNotification?: boolean;
3358
3826
  /**
3827
+ * @public
3359
3828
  * <p>Custom text to include in the email message that contains the invitation. The text can contain as many as 80 alphanumeric characters.</p>
3360
3829
  */
3361
3830
  message?: string;
@@ -3365,6 +3834,7 @@ export interface CreateInvitationsRequest {
3365
3834
  */
3366
3835
  export interface CreateInvitationsResponse {
3367
3836
  /**
3837
+ * @public
3368
3838
  * <p>An array of objects, one for each account whose invitation hasn't been processed. Each object identifies the account and explains why the invitation hasn't been processed for the account.</p>
3369
3839
  */
3370
3840
  unprocessedAccounts?: UnprocessedAccount[];
@@ -3374,10 +3844,12 @@ export interface CreateInvitationsResponse {
3374
3844
  */
3375
3845
  export interface CreateMemberRequest {
3376
3846
  /**
3847
+ * @public
3377
3848
  * <p>The details of the account to associate with the administrator account.</p>
3378
3849
  */
3379
3850
  account: AccountDetail | undefined;
3380
3851
  /**
3852
+ * @public
3381
3853
  * <p>A map of key-value pairs that specifies the tags to associate with the account in Amazon Macie.</p> <p>An account can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.</p>
3382
3854
  */
3383
3855
  tags?: Record<string, string>;
@@ -3387,6 +3859,7 @@ export interface CreateMemberRequest {
3387
3859
  */
3388
3860
  export interface CreateMemberResponse {
3389
3861
  /**
3862
+ * @public
3390
3863
  * <p>The Amazon Resource Name (ARN) of the account that was associated with the administrator account.</p>
3391
3864
  */
3392
3865
  arn?: string;
@@ -3396,6 +3869,7 @@ export interface CreateMemberResponse {
3396
3869
  */
3397
3870
  export interface CreateSampleFindingsRequest {
3398
3871
  /**
3872
+ * @public
3399
3873
  * <p>An array of finding types, one for each type of sample finding to create. To create a sample of every type of finding that Amazon Macie supports, don't include this array in your request.</p>
3400
3874
  */
3401
3875
  findingTypes?: (FindingType | string)[];
@@ -3410,6 +3884,7 @@ export interface CreateSampleFindingsResponse {
3410
3884
  */
3411
3885
  export interface DeclineInvitationsRequest {
3412
3886
  /**
3887
+ * @public
3413
3888
  * <p>An array that lists Amazon Web Services account IDs, one for each account that sent an invitation to decline.</p>
3414
3889
  */
3415
3890
  accountIds: string[] | undefined;
@@ -3419,6 +3894,7 @@ export interface DeclineInvitationsRequest {
3419
3894
  */
3420
3895
  export interface DeclineInvitationsResponse {
3421
3896
  /**
3897
+ * @public
3422
3898
  * <p>An array of objects, one for each account whose invitation hasn't been declined. Each object identifies the account and explains why the request hasn't been processed for that account.</p>
3423
3899
  */
3424
3900
  unprocessedAccounts?: UnprocessedAccount[];
@@ -3428,10 +3904,12 @@ export interface DeclineInvitationsResponse {
3428
3904
  */
3429
3905
  export interface DeleteAllowListRequest {
3430
3906
  /**
3907
+ * @public
3431
3908
  * <p>The unique identifier for the Amazon Macie resource that the request applies to.</p>
3432
3909
  */
3433
3910
  id: string | undefined;
3434
3911
  /**
3912
+ * @public
3435
3913
  * <p>Specifies whether to force deletion of the allow list, even if active classification jobs are configured to use the list.</p> <p>When you try to delete an allow list, Amazon Macie checks for classification jobs that use the list and have a status other than COMPLETE or CANCELLED. By default, Macie rejects your request if any jobs meet these criteria. To skip these checks and delete the list, set this value to true. To delete the list only if no active jobs are configured to use it, set this value to false.</p>
3436
3914
  */
3437
3915
  ignoreJobChecks?: string;
@@ -3446,6 +3924,7 @@ export interface DeleteAllowListResponse {
3446
3924
  */
3447
3925
  export interface DeleteCustomDataIdentifierRequest {
3448
3926
  /**
3927
+ * @public
3449
3928
  * <p>The unique identifier for the Amazon Macie resource that the request applies to.</p>
3450
3929
  */
3451
3930
  id: string | undefined;
@@ -3460,6 +3939,7 @@ export interface DeleteCustomDataIdentifierResponse {
3460
3939
  */
3461
3940
  export interface DeleteFindingsFilterRequest {
3462
3941
  /**
3942
+ * @public
3463
3943
  * <p>The unique identifier for the Amazon Macie resource that the request applies to.</p>
3464
3944
  */
3465
3945
  id: string | undefined;
@@ -3474,6 +3954,7 @@ export interface DeleteFindingsFilterResponse {
3474
3954
  */
3475
3955
  export interface DeleteInvitationsRequest {
3476
3956
  /**
3957
+ * @public
3477
3958
  * <p>An array that lists Amazon Web Services account IDs, one for each account that sent an invitation to delete.</p>
3478
3959
  */
3479
3960
  accountIds: string[] | undefined;
@@ -3483,6 +3964,7 @@ export interface DeleteInvitationsRequest {
3483
3964
  */
3484
3965
  export interface DeleteInvitationsResponse {
3485
3966
  /**
3967
+ * @public
3486
3968
  * <p>An array of objects, one for each account whose invitation hasn't been deleted. Each object identifies the account and explains why the request hasn't been processed for that account.</p>
3487
3969
  */
3488
3970
  unprocessedAccounts?: UnprocessedAccount[];
@@ -3492,6 +3974,7 @@ export interface DeleteInvitationsResponse {
3492
3974
  */
3493
3975
  export interface DeleteMemberRequest {
3494
3976
  /**
3977
+ * @public
3495
3978
  * <p>The unique identifier for the Amazon Macie resource that the request applies to.</p>
3496
3979
  */
3497
3980
  id: string | undefined;
@@ -3506,18 +3989,22 @@ export interface DeleteMemberResponse {
3506
3989
  */
3507
3990
  export interface DescribeBucketsRequest {
3508
3991
  /**
3992
+ * @public
3509
3993
  * <p>The criteria to use to filter the query results.</p>
3510
3994
  */
3511
3995
  criteria?: Record<string, BucketCriteriaAdditionalProperties>;
3512
3996
  /**
3997
+ * @public
3513
3998
  * <p>The maximum number of items to include in each page of the response. The default value is 50.</p>
3514
3999
  */
3515
4000
  maxResults?: number;
3516
4001
  /**
4002
+ * @public
3517
4003
  * <p>The nextToken string that specifies which page of results to return in a paginated response.</p>
3518
4004
  */
3519
4005
  nextToken?: string;
3520
4006
  /**
4007
+ * @public
3521
4008
  * <p>The criteria to use to sort the query results.</p>
3522
4009
  */
3523
4010
  sortCriteria?: BucketSortCriteria;
@@ -3527,10 +4014,12 @@ export interface DescribeBucketsRequest {
3527
4014
  */
3528
4015
  export interface DescribeBucketsResponse {
3529
4016
  /**
4017
+ * @public
3530
4018
  * <p>An array of objects, one for each bucket that matches the filter criteria specified in the request.</p>
3531
4019
  */
3532
4020
  buckets?: BucketMetadata[];
3533
4021
  /**
4022
+ * @public
3534
4023
  * <p>The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.</p>
3535
4024
  */
3536
4025
  nextToken?: string;
@@ -3540,6 +4029,7 @@ export interface DescribeBucketsResponse {
3540
4029
  */
3541
4030
  export interface DescribeClassificationJobRequest {
3542
4031
  /**
4032
+ * @public
3543
4033
  * <p>The unique identifier for the classification job.</p>
3544
4034
  */
3545
4035
  jobId: string | undefined;
@@ -3550,10 +4040,12 @@ export interface DescribeClassificationJobRequest {
3550
4040
  */
3551
4041
  export interface Statistics {
3552
4042
  /**
4043
+ * @public
3553
4044
  * <p>The approximate number of objects that the job has yet to process during its current run.</p>
3554
4045
  */
3555
4046
  approximateNumberOfObjectsToProcess?: number;
3556
4047
  /**
4048
+ * @public
3557
4049
  * <p>The number of times that the job has run.</p>
3558
4050
  */
3559
4051
  numberOfRuns?: number;
@@ -3563,86 +4055,107 @@ export interface Statistics {
3563
4055
  */
3564
4056
  export interface DescribeClassificationJobResponse {
3565
4057
  /**
4058
+ * @public
3566
4059
  * <p>An array of unique identifiers, one for each allow list that the job uses when it analyzes data.</p>
3567
4060
  */
3568
4061
  allowListIds?: string[];
3569
4062
  /**
4063
+ * @public
3570
4064
  * <p>The token that was provided to ensure the idempotency of the request to create the job.</p>
3571
4065
  */
3572
4066
  clientToken?: string;
3573
4067
  /**
4068
+ * @public
3574
4069
  * <p>The date and time, in UTC and extended ISO 8601 format, when the job was created.</p>
3575
4070
  */
3576
4071
  createdAt?: Date;
3577
4072
  /**
4073
+ * @public
3578
4074
  * <p>An array of unique identifiers, one for each custom data identifier that the job uses when it analyzes data. This value is null if the job uses only managed data identifiers to analyze data.</p>
3579
4075
  */
3580
4076
  customDataIdentifierIds?: string[];
3581
4077
  /**
4078
+ * @public
3582
4079
  * <p>The custom description of the job.</p>
3583
4080
  */
3584
4081
  description?: string;
3585
4082
  /**
4083
+ * @public
3586
4084
  * <p>For a recurring job, specifies whether you configured the job to analyze all existing, eligible objects immediately after the job was created (true). If you configured the job to analyze only those objects that were created or changed after the job was created and before the job's first scheduled run, this value is false. This value is also false for a one-time job.</p>
3587
4085
  */
3588
4086
  initialRun?: boolean;
3589
4087
  /**
4088
+ * @public
3590
4089
  * <p>The Amazon Resource Name (ARN) of the job.</p>
3591
4090
  */
3592
4091
  jobArn?: string;
3593
4092
  /**
4093
+ * @public
3594
4094
  * <p>The unique identifier for the job.</p>
3595
4095
  */
3596
4096
  jobId?: string;
3597
4097
  /**
4098
+ * @public
3598
4099
  * <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 - 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>
3599
4100
  */
3600
4101
  jobStatus?: JobStatus | string;
3601
4102
  /**
4103
+ * @public
3602
4104
  * <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>
3603
4105
  */
3604
4106
  jobType?: JobType | string;
3605
4107
  /**
4108
+ * @public
3606
4109
  * <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>
3607
4110
  */
3608
4111
  lastRunErrorStatus?: LastRunErrorStatus;
3609
4112
  /**
4113
+ * @public
3610
4114
  * <p>The date and time, in UTC and extended ISO 8601 format, when the job started. If the job is a recurring job, this value indicates when the most recent run started or, if the job hasn't run yet, when the job was created.</p>
3611
4115
  */
3612
4116
  lastRunTime?: Date;
3613
4117
  /**
4118
+ * @public
3614
4119
  * <p>An array of unique identifiers, one for each managed data identifier that the job is explicitly configured to include (use) or exclude (not use) when it analyzes data. Inclusion or exclusion depends on the managed data identifier selection type specified for the job (managedDataIdentifierSelector).</p><p>This value is null if the job's managed data identifier selection type is ALL, NONE, or RECOMMENDED.</p>
3615
4120
  */
3616
4121
  managedDataIdentifierIds?: string[];
3617
4122
  /**
4123
+ * @public
3618
4124
  * <p>The selection type that determines which managed data identifiers the job uses when it analyzes data. Possible values are:</p> <ul><li><p>ALL (default) - Use all managed data identifiers.</p></li> <li><p>EXCLUDE - Use all managed data identifiers except the ones specified by the managedDataIdentifierIds property.</p></li> <li><p>INCLUDE - Use only the managed data identifiers specified by the managedDataIdentifierIds property.</p></li> <li><p>NONE - Don't use any managed data identifiers. Use only custom data identifiers (customDataIdentifierIds).</p></li> <li><p>RECOMMENDED - Use only the set of managed data identifiers that Amazon Web Services recommends for jobs.</p></li></ul> <p>If this value is null, the job uses all managed data identifiers.</p> <p>If the job is a recurring job and this value is null, ALL, or EXCLUDE, each job run automatically uses new managed data identifiers that are released after the job was created or the preceding run ended. If this value is RECOMMENDED for a recurring job, each job run uses all the managed data identifiers that are in the recommended set when the run starts.</p> <p>For information about individual managed data identifiers or to determine which ones are in the recommended set, see <a href="https://docs.aws.amazon.com/macie/latest/user/managed-data-identifiers.html">Using managed data identifiers</a> and <a href="https://docs.aws.amazon.com/macie/latest/user/discovery-jobs-mdis-recommended.html">Recommended managed data identifiers</a> in the <i>Amazon Macie User Guide</i>.</p>
3619
4125
  */
3620
4126
  managedDataIdentifierSelector?: ManagedDataIdentifierSelector | string;
3621
4127
  /**
4128
+ * @public
3622
4129
  * <p>The custom name of the job.</p>
3623
4130
  */
3624
4131
  name?: string;
3625
4132
  /**
4133
+ * @public
3626
4134
  * <p>The S3 buckets that contain the objects to analyze, and the scope of that analysis.</p>
3627
4135
  */
3628
4136
  s3JobDefinition?: S3JobDefinition;
3629
4137
  /**
4138
+ * @public
3630
4139
  * <p>The sampling depth, as a percentage, that determines the percentage of eligible objects that the job analyzes.</p>
3631
4140
  */
3632
4141
  samplingPercentage?: number;
3633
4142
  /**
4143
+ * @public
3634
4144
  * <p>The recurrence pattern for running the job. This value is null if the job is configured to run only once.</p>
3635
4145
  */
3636
4146
  scheduleFrequency?: JobScheduleFrequency;
3637
4147
  /**
4148
+ * @public
3638
4149
  * <p>The number of times that the job has run and processing statistics for the job's current run.</p>
3639
4150
  */
3640
4151
  statistics?: Statistics;
3641
4152
  /**
4153
+ * @public
3642
4154
  * <p>A map of key-value pairs that specifies which tags (keys and values) are associated with the classification job.</p>
3643
4155
  */
3644
4156
  tags?: Record<string, string>;
3645
4157
  /**
4158
+ * @public
3646
4159
  * <p>If the current status of the job is USER_PAUSED, specifies when the job was paused and when the job or job run will expire and be cancelled if it isn't resumed. This value is present only if the value for jobStatus is USER_PAUSED.</p>
3647
4160
  */
3648
4161
  userPausedDetails?: UserPausedDetails;
@@ -3657,10 +4170,12 @@ export interface DescribeOrganizationConfigurationRequest {
3657
4170
  */
3658
4171
  export interface DescribeOrganizationConfigurationResponse {
3659
4172
  /**
4173
+ * @public
3660
4174
  * <p>Specifies whether Amazon Macie is enabled automatically for accounts that are added to the organization.</p>
3661
4175
  */
3662
4176
  autoEnable?: boolean;
3663
4177
  /**
4178
+ * @public
3664
4179
  * <p>Specifies whether the maximum number of Amazon Macie member accounts are part of the organization.</p>
3665
4180
  */
3666
4181
  maxAccountLimitReached?: boolean;
@@ -3680,6 +4195,7 @@ export interface DisableMacieResponse {
3680
4195
  */
3681
4196
  export interface DisableOrganizationAdminAccountRequest {
3682
4197
  /**
4198
+ * @public
3683
4199
  * <p>The Amazon Web Services account ID of the delegated Amazon Macie administrator account.</p>
3684
4200
  */
3685
4201
  adminAccountId: string | undefined;
@@ -3714,6 +4230,7 @@ export interface DisassociateFromMasterAccountResponse {
3714
4230
  */
3715
4231
  export interface DisassociateMemberRequest {
3716
4232
  /**
4233
+ * @public
3717
4234
  * <p>The unique identifier for the Amazon Macie resource that the request applies to.</p>
3718
4235
  */
3719
4236
  id: string | undefined;
@@ -3753,14 +4270,17 @@ export type MacieStatus = (typeof MacieStatus)[keyof typeof MacieStatus];
3753
4270
  */
3754
4271
  export interface EnableMacieRequest {
3755
4272
  /**
4273
+ * @public
3756
4274
  * <p>A unique, case-sensitive token that you provide to ensure the idempotency of the request.</p>
3757
4275
  */
3758
4276
  clientToken?: string;
3759
4277
  /**
4278
+ * @public
3760
4279
  * <p>Specifies how often to publish updates to policy findings for the account. This includes publishing updates to Security Hub and Amazon EventBridge (formerly Amazon CloudWatch Events).</p>
3761
4280
  */
3762
4281
  findingPublishingFrequency?: FindingPublishingFrequency | string;
3763
4282
  /**
4283
+ * @public
3764
4284
  * <p>Specifies the new status for the account. To enable Amazon Macie and start all Macie activities for the account, set this value to ENABLED.</p>
3765
4285
  */
3766
4286
  status?: MacieStatus | string;
@@ -3775,10 +4295,12 @@ export interface EnableMacieResponse {
3775
4295
  */
3776
4296
  export interface EnableOrganizationAdminAccountRequest {
3777
4297
  /**
4298
+ * @public
3778
4299
  * <p>The Amazon Web Services account ID for the account to designate as the delegated Amazon Macie administrator account for the organization.</p>
3779
4300
  */
3780
4301
  adminAccountId: string | undefined;
3781
4302
  /**
4303
+ * @public
3782
4304
  * <p>A unique, case-sensitive token that you provide to ensure the idempotency of the request.</p>
3783
4305
  */
3784
4306
  clientToken?: string;
@@ -3806,10 +4328,12 @@ export type FindingStatisticsSortAttributeName = (typeof FindingStatisticsSortAt
3806
4328
  */
3807
4329
  export interface FindingStatisticsSortCriteria {
3808
4330
  /**
4331
+ * @public
3809
4332
  * <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>
3810
4333
  */
3811
4334
  attributeName?: FindingStatisticsSortAttributeName | string;
3812
4335
  /**
4336
+ * @public
3813
4337
  * <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>
3814
4338
  */
3815
4339
  orderBy?: OrderBy | string;
@@ -3824,6 +4348,7 @@ export interface GetAdministratorAccountRequest {
3824
4348
  */
3825
4349
  export interface GetAdministratorAccountResponse {
3826
4350
  /**
4351
+ * @public
3827
4352
  * <p>The Amazon Web Services account ID for the administrator account. If the accounts are associated by an Amazon Macie membership invitation, this object also provides details about the invitation that was sent to establish the relationship between the accounts.</p>
3828
4353
  */
3829
4354
  administrator?: Invitation;
@@ -3833,6 +4358,7 @@ export interface GetAdministratorAccountResponse {
3833
4358
  */
3834
4359
  export interface GetAllowListRequest {
3835
4360
  /**
4361
+ * @public
3836
4362
  * <p>The unique identifier for the Amazon Macie resource that the request applies to.</p>
3837
4363
  */
3838
4364
  id: string | undefined;
@@ -3842,38 +4368,47 @@ export interface GetAllowListRequest {
3842
4368
  */
3843
4369
  export interface GetAllowListResponse {
3844
4370
  /**
4371
+ * @public
3845
4372
  * <p>The Amazon Resource Name (ARN) of the allow list.</p>
3846
4373
  */
3847
4374
  arn?: string;
3848
4375
  /**
4376
+ * @public
3849
4377
  * <p>The date and time, in UTC and extended ISO 8601 format, when the allow list was created in Amazon Macie.</p>
3850
4378
  */
3851
4379
  createdAt?: Date;
3852
4380
  /**
4381
+ * @public
3853
4382
  * <p>The criteria that specify the text or text pattern to ignore. The criteria can be the location and name of an S3 object that lists specific text to ignore (s3WordsList), or a regular expression (regex) that defines a text pattern to ignore.</p>
3854
4383
  */
3855
4384
  criteria?: AllowListCriteria;
3856
4385
  /**
4386
+ * @public
3857
4387
  * <p>The custom description of the allow list.</p>
3858
4388
  */
3859
4389
  description?: string;
3860
4390
  /**
4391
+ * @public
3861
4392
  * <p>The unique identifier for the allow list.</p>
3862
4393
  */
3863
4394
  id?: string;
3864
4395
  /**
4396
+ * @public
3865
4397
  * <p>The custom name of the allow list.</p>
3866
4398
  */
3867
4399
  name?: string;
3868
4400
  /**
4401
+ * @public
3869
4402
  * <p>The current status of the allow list, which indicates whether Amazon Macie can access and use the list's criteria.</p>
3870
4403
  */
3871
4404
  status?: AllowListStatus;
3872
4405
  /**
4406
+ * @public
3873
4407
  * <p>A map of key-value pairs that specifies which tags (keys and values) are associated with the allow list.</p>
3874
4408
  */
3875
4409
  tags?: Record<string, string>;
3876
4410
  /**
4411
+ * @public
3877
4412
  * <p>The date and time, in UTC and extended ISO 8601 format, when the allow list's settings were most recently changed in Amazon Macie.</p>
3878
4413
  */
3879
4414
  updatedAt?: Date;
@@ -3888,26 +4423,32 @@ export interface GetAutomatedDiscoveryConfigurationRequest {
3888
4423
  */
3889
4424
  export interface GetAutomatedDiscoveryConfigurationResponse {
3890
4425
  /**
4426
+ * @public
3891
4427
  * <p>The unique identifier for the classification scope that's used when performing automated sensitive data discovery for the account. The classification scope specifies S3 buckets to exclude from automated sensitive data discovery.</p>
3892
4428
  */
3893
4429
  classificationScopeId?: string;
3894
4430
  /**
4431
+ * @public
3895
4432
  * <p>The date and time, in UTC and extended ISO 8601 format, when automated sensitive data discovery was most recently disabled for the account. This value is null if automated sensitive data discovery wasn't enabled and subsequently disabled for the account.</p>
3896
4433
  */
3897
4434
  disabledAt?: Date;
3898
4435
  /**
4436
+ * @public
3899
4437
  * <p>The date and time, in UTC and extended ISO 8601 format, when automated sensitive data discovery was initially enabled for the account. This value is null if automated sensitive data discovery has never been enabled for the account.</p>
3900
4438
  */
3901
4439
  firstEnabledAt?: Date;
3902
4440
  /**
4441
+ * @public
3903
4442
  * <p>The date and time, in UTC and extended ISO 8601 format, when automated sensitive data discovery was most recently enabled or disabled for the account.</p>
3904
4443
  */
3905
4444
  lastUpdatedAt?: Date;
3906
4445
  /**
4446
+ * @public
3907
4447
  * <p>The unique identifier for the sensitivity inspection template that's used when performing automated sensitive data discovery for the account. The template specifies which allow lists, custom data identifiers, and managed data identifiers to use when analyzing data.</p>
3908
4448
  */
3909
4449
  sensitivityInspectionTemplateId?: string;
3910
4450
  /**
4451
+ * @public
3911
4452
  * <p>The current status of the automated sensitive data discovery configuration for the account. Possible values are: ENABLED, use the specified settings to perform automated sensitive data discovery activities for the account; and, DISABLED, don't perform automated sensitive data discovery activities for the account.</p>
3912
4453
  */
3913
4454
  status?: AutomatedDiscoveryStatus | string;
@@ -3917,6 +4458,7 @@ export interface GetAutomatedDiscoveryConfigurationResponse {
3917
4458
  */
3918
4459
  export interface GetBucketStatisticsRequest {
3919
4460
  /**
4461
+ * @public
3920
4462
  * <p>The unique identifier for the Amazon Web Services account.</p>
3921
4463
  */
3922
4464
  accountId?: string;
@@ -3926,58 +4468,72 @@ export interface GetBucketStatisticsRequest {
3926
4468
  */
3927
4469
  export interface GetBucketStatisticsResponse {
3928
4470
  /**
4471
+ * @public
3929
4472
  * <p>The total number of buckets.</p>
3930
4473
  */
3931
4474
  bucketCount?: number;
3932
4475
  /**
4476
+ * @public
3933
4477
  * <p>The total number of buckets that are publicly accessible due to a combination of permissions settings for each bucket.</p>
3934
4478
  */
3935
4479
  bucketCountByEffectivePermission?: BucketCountByEffectivePermission;
3936
4480
  /**
4481
+ * @public
3937
4482
  * <p>The total number of buckets whose settings do or don't specify default server-side encryption behavior for objects that are added to the buckets.</p>
3938
4483
  */
3939
4484
  bucketCountByEncryptionType?: BucketCountByEncryptionType;
3940
4485
  /**
4486
+ * @public
3941
4487
  * <p>The total number of buckets whose bucket policies do or don't require server-side encryption of objects when objects are added to the buckets.</p>
3942
4488
  */
3943
4489
  bucketCountByObjectEncryptionRequirement?: BucketCountPolicyAllowsUnencryptedObjectUploads;
3944
4490
  /**
4491
+ * @public
3945
4492
  * <p>The total number of buckets that are or aren't shared with other Amazon Web Services accounts, Amazon CloudFront origin access identities (OAIs), or CloudFront origin access controls (OACs).</p>
3946
4493
  */
3947
4494
  bucketCountBySharedAccessType?: BucketCountBySharedAccessType;
3948
4495
  /**
4496
+ * @public
3949
4497
  * <p>The aggregated sensitive data discovery statistics for the buckets. If automated sensitive data discovery is currently disabled for your account, the value for each statistic is 0.</p>
3950
4498
  */
3951
4499
  bucketStatisticsBySensitivity?: BucketStatisticsBySensitivity;
3952
4500
  /**
4501
+ * @public
3953
4502
  * <p>The total number of objects that Amazon Macie can analyze in the buckets. These objects use a supported storage class and have a file name extension for a supported file or storage format.</p>
3954
4503
  */
3955
4504
  classifiableObjectCount?: number;
3956
4505
  /**
4506
+ * @public
3957
4507
  * <p>The total storage size, in bytes, of all the objects that Amazon Macie can analyze in the buckets. These objects use a supported storage class and have a file name extension for a supported file or storage format.</p> <p>If versioning is enabled for any of the buckets, this value is based on the size of the latest version of each applicable object in the buckets. This value doesn't reflect the storage size of all versions of all applicable objects in the buckets.</p>
3958
4508
  */
3959
4509
  classifiableSizeInBytes?: number;
3960
4510
  /**
4511
+ * @public
3961
4512
  * <p>The date and time, in UTC and extended ISO 8601 format, when Amazon Macie most recently retrieved bucket or object metadata from Amazon S3 for the buckets.</p>
3962
4513
  */
3963
4514
  lastUpdated?: Date;
3964
4515
  /**
4516
+ * @public
3965
4517
  * <p>The total number of objects in the buckets.</p>
3966
4518
  */
3967
4519
  objectCount?: number;
3968
4520
  /**
4521
+ * @public
3969
4522
  * <p>The total storage size, in bytes, of the buckets.</p> <p>If versioning is enabled for any of the buckets, this value is based on the size of the latest version of each object in the buckets. This value doesn't reflect the storage size of all versions of the objects in the buckets.</p>
3970
4523
  */
3971
4524
  sizeInBytes?: number;
3972
4525
  /**
4526
+ * @public
3973
4527
  * <p>The total storage size, in bytes, of the objects that are compressed (.gz, .gzip, .zip) files in the buckets.</p> <p>If versioning is enabled for any of the buckets, this value is based on the size of the latest version of each applicable object in the buckets. This value doesn't reflect the storage size of all versions of the applicable objects in the buckets.</p>
3974
4528
  */
3975
4529
  sizeInBytesCompressed?: number;
3976
4530
  /**
4531
+ * @public
3977
4532
  * <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>
3978
4533
  */
3979
4534
  unclassifiableObjectCount?: ObjectLevelStatistics;
3980
4535
  /**
4536
+ * @public
3981
4537
  * <p>The total storage size, in bytes, of the objects that Amazon Macie can't analyze in the buckets. These objects don't use a supported storage class or don't have a file name extension for a supported file or storage format.</p>
3982
4538
  */
3983
4539
  unclassifiableObjectSizeInBytes?: ObjectLevelStatistics;
@@ -3992,6 +4548,7 @@ export interface GetClassificationExportConfigurationRequest {
3992
4548
  */
3993
4549
  export interface GetClassificationExportConfigurationResponse {
3994
4550
  /**
4551
+ * @public
3995
4552
  * <p>The location where data classification results are stored, and the encryption settings that are used when storing results in that location.</p>
3996
4553
  */
3997
4554
  configuration?: ClassificationExportConfiguration;
@@ -4001,6 +4558,7 @@ export interface GetClassificationExportConfigurationResponse {
4001
4558
  */
4002
4559
  export interface GetClassificationScopeRequest {
4003
4560
  /**
4561
+ * @public
4004
4562
  * <p>The unique identifier for the Amazon Macie resource that the request applies to.</p>
4005
4563
  */
4006
4564
  id: string | undefined;
@@ -4011,6 +4569,7 @@ export interface GetClassificationScopeRequest {
4011
4569
  */
4012
4570
  export interface S3ClassificationScopeExclusion {
4013
4571
  /**
4572
+ * @public
4014
4573
  * <p>An array of strings, one for each S3 bucket that is excluded. Each string is the full name of an excluded bucket.</p>
4015
4574
  */
4016
4575
  bucketNames: string[] | undefined;
@@ -4021,6 +4580,7 @@ export interface S3ClassificationScopeExclusion {
4021
4580
  */
4022
4581
  export interface S3ClassificationScope {
4023
4582
  /**
4583
+ * @public
4024
4584
  * <p>The S3 buckets that are excluded.</p>
4025
4585
  */
4026
4586
  excludes: S3ClassificationScopeExclusion | undefined;
@@ -4030,14 +4590,17 @@ export interface S3ClassificationScope {
4030
4590
  */
4031
4591
  export interface GetClassificationScopeResponse {
4032
4592
  /**
4593
+ * @public
4033
4594
  * <p>The unique identifier for the classification scope.</p>
4034
4595
  */
4035
4596
  id?: string;
4036
4597
  /**
4598
+ * @public
4037
4599
  * <p>The name of the classification scope: automated-sensitive-data-discovery.</p>
4038
4600
  */
4039
4601
  name?: string;
4040
4602
  /**
4603
+ * @public
4041
4604
  * <p>The S3 buckets that are excluded from automated sensitive data discovery.</p>
4042
4605
  */
4043
4606
  s3?: S3ClassificationScope;
@@ -4047,6 +4610,7 @@ export interface GetClassificationScopeResponse {
4047
4610
  */
4048
4611
  export interface GetCustomDataIdentifierRequest {
4049
4612
  /**
4613
+ * @public
4050
4614
  * <p>The unique identifier for the Amazon Macie resource that the request applies to.</p>
4051
4615
  */
4052
4616
  id: string | undefined;
@@ -4056,50 +4620,62 @@ export interface GetCustomDataIdentifierRequest {
4056
4620
  */
4057
4621
  export interface GetCustomDataIdentifierResponse {
4058
4622
  /**
4623
+ * @public
4059
4624
  * <p>The Amazon Resource Name (ARN) of the custom data identifier.</p>
4060
4625
  */
4061
4626
  arn?: string;
4062
4627
  /**
4628
+ * @public
4063
4629
  * <p>The date and time, in UTC and extended ISO 8601 format, when the custom data identifier was created.</p>
4064
4630
  */
4065
4631
  createdAt?: Date;
4066
4632
  /**
4633
+ * @public
4067
4634
  * <p>Specifies whether the custom data identifier was deleted. If you delete a custom data identifier, Amazon Macie doesn't delete it permanently. Instead, it soft deletes the identifier.</p>
4068
4635
  */
4069
4636
  deleted?: boolean;
4070
4637
  /**
4638
+ * @public
4071
4639
  * <p>The custom description of the custom data identifier.</p>
4072
4640
  */
4073
4641
  description?: string;
4074
4642
  /**
4643
+ * @public
4075
4644
  * <p>The unique identifier for the custom data identifier.</p>
4076
4645
  */
4077
4646
  id?: string;
4078
4647
  /**
4648
+ * @public
4079
4649
  * <p>An array that lists specific character sequences (<i>ignore words</i>) to exclude from the results. If the text matched by the regular expression contains any string in this array, Amazon Macie ignores it. Ignore words are case sensitive.</p>
4080
4650
  */
4081
4651
  ignoreWords?: string[];
4082
4652
  /**
4653
+ * @public
4083
4654
  * <p>An array that lists specific character sequences (<i>keywords</i>), one of which must precede and be within proximity (maximumMatchDistance) of the regular expression to match. Keywords aren't case sensitive.</p>
4084
4655
  */
4085
4656
  keywords?: string[];
4086
4657
  /**
4658
+ * @public
4087
4659
  * <p>The maximum number of characters that can exist between the end of at least one complete character sequence specified by the keywords array and the end of the text that matches the regex pattern. If a complete keyword precedes all the text that matches the pattern and the keyword is within the specified distance, Amazon Macie includes the result. Otherwise, Macie excludes the result.</p>
4088
4660
  */
4089
4661
  maximumMatchDistance?: number;
4090
4662
  /**
4663
+ * @public
4091
4664
  * <p>The custom name of the custom data identifier.</p>
4092
4665
  */
4093
4666
  name?: string;
4094
4667
  /**
4668
+ * @public
4095
4669
  * <p>The regular expression (<i>regex</i>) that defines the pattern to match.</p>
4096
4670
  */
4097
4671
  regex?: string;
4098
4672
  /**
4673
+ * @public
4099
4674
  * <p>Specifies the severity that's assigned to findings that the custom data identifier produces, based on the number of occurrences of text that match the custom data identifier's detection criteria. By default, Amazon Macie creates findings for S3 objects that contain at least one occurrence of text that matches the detection criteria, and Macie assigns the MEDIUM severity to those findings.</p>
4100
4675
  */
4101
4676
  severityLevels?: SeverityLevel[];
4102
4677
  /**
4678
+ * @public
4103
4679
  * <p>A map of key-value pairs that identifies the tags (keys and values) that are associated with the custom data identifier.</p>
4104
4680
  */
4105
4681
  tags?: Record<string, string>;
@@ -4110,10 +4686,12 @@ export interface GetCustomDataIdentifierResponse {
4110
4686
  */
4111
4687
  export interface SortCriteria {
4112
4688
  /**
4689
+ * @public
4113
4690
  * <p>The name of the property to sort the results by. Valid values are: count, createdAt, policyDetails.action.apiCallDetails.firstSeen, policyDetails.action.apiCallDetails.lastSeen, resourcesAffected, severity.score, type, and updatedAt.</p>
4114
4691
  */
4115
4692
  attributeName?: string;
4116
4693
  /**
4694
+ * @public
4117
4695
  * <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>
4118
4696
  */
4119
4697
  orderBy?: OrderBy | string;
@@ -4123,10 +4701,12 @@ export interface SortCriteria {
4123
4701
  */
4124
4702
  export interface GetFindingsRequest {
4125
4703
  /**
4704
+ * @public
4126
4705
  * <p>An array of strings that lists the unique identifiers for the findings to retrieve. You can specify as many as 50 unique identifiers in this array.</p>
4127
4706
  */
4128
4707
  findingIds: string[] | undefined;
4129
4708
  /**
4709
+ * @public
4130
4710
  * <p>The criteria for sorting the results of the request.</p>
4131
4711
  */
4132
4712
  sortCriteria?: SortCriteria;
@@ -4136,6 +4716,7 @@ export interface GetFindingsRequest {
4136
4716
  */
4137
4717
  export interface GetFindingsResponse {
4138
4718
  /**
4719
+ * @public
4139
4720
  * <p>An array of objects, one for each finding that matches the criteria specified in the request.</p>
4140
4721
  */
4141
4722
  findings?: Finding[];
@@ -4145,6 +4726,7 @@ export interface GetFindingsResponse {
4145
4726
  */
4146
4727
  export interface GetFindingsFilterRequest {
4147
4728
  /**
4729
+ * @public
4148
4730
  * <p>The unique identifier for the Amazon Macie resource that the request applies to.</p>
4149
4731
  */
4150
4732
  id: string | undefined;
@@ -4154,34 +4736,42 @@ export interface GetFindingsFilterRequest {
4154
4736
  */
4155
4737
  export interface GetFindingsFilterResponse {
4156
4738
  /**
4739
+ * @public
4157
4740
  * <p>The action that's performed on findings that match the filter criteria (findingCriteria). Possible values are: ARCHIVE, suppress (automatically archive) the findings; and, NOOP, don't perform any action on the findings.</p>
4158
4741
  */
4159
4742
  action?: FindingsFilterAction | string;
4160
4743
  /**
4744
+ * @public
4161
4745
  * <p>The Amazon Resource Name (ARN) of the filter.</p>
4162
4746
  */
4163
4747
  arn?: string;
4164
4748
  /**
4749
+ * @public
4165
4750
  * <p>The custom description of the filter.</p>
4166
4751
  */
4167
4752
  description?: string;
4168
4753
  /**
4754
+ * @public
4169
4755
  * <p>The criteria that's used to filter findings.</p>
4170
4756
  */
4171
4757
  findingCriteria?: FindingCriteria;
4172
4758
  /**
4759
+ * @public
4173
4760
  * <p>The unique identifier for the filter.</p>
4174
4761
  */
4175
4762
  id?: string;
4176
4763
  /**
4764
+ * @public
4177
4765
  * <p>The custom name of the filter.</p>
4178
4766
  */
4179
4767
  name?: string;
4180
4768
  /**
4769
+ * @public
4181
4770
  * <p>The position of the filter in the list of saved filters on the Amazon Macie console. This value also determines the order in which the filter is applied to findings, relative to other filters that are also applied to the findings.</p>
4182
4771
  */
4183
4772
  position?: number;
4184
4773
  /**
4774
+ * @public
4185
4775
  * <p>A map of key-value pairs that specifies which tags (keys and values) are associated with the filter.</p>
4186
4776
  */
4187
4777
  tags?: Record<string, string>;
@@ -4197,10 +4787,12 @@ export interface GetFindingsPublicationConfigurationRequest {
4197
4787
  */
4198
4788
  export interface SecurityHubConfiguration {
4199
4789
  /**
4790
+ * @public
4200
4791
  * <p>Specifies whether to publish sensitive data findings to Security Hub. If you set this value to true, Amazon Macie automatically publishes all sensitive data findings that weren't suppressed by a findings filter. The default value is false.</p>
4201
4792
  */
4202
4793
  publishClassificationFindings: boolean | undefined;
4203
4794
  /**
4795
+ * @public
4204
4796
  * <p>Specifies whether to publish policy findings to Security Hub. If you set this value to true, Amazon Macie automatically publishes all new and updated policy findings that weren't suppressed by a findings filter. The default value is true.</p>
4205
4797
  */
4206
4798
  publishPolicyFindings: boolean | undefined;
@@ -4210,6 +4802,7 @@ export interface SecurityHubConfiguration {
4210
4802
  */
4211
4803
  export interface GetFindingsPublicationConfigurationResponse {
4212
4804
  /**
4805
+ * @public
4213
4806
  * <p>The configuration settings that determine which findings are published to Security Hub.</p>
4214
4807
  */
4215
4808
  securityHubConfiguration?: SecurityHubConfiguration;
@@ -4233,18 +4826,22 @@ export type GroupBy = (typeof GroupBy)[keyof typeof GroupBy];
4233
4826
  */
4234
4827
  export interface GetFindingStatisticsRequest {
4235
4828
  /**
4829
+ * @public
4236
4830
  * <p>The criteria to use to filter the query results.</p>
4237
4831
  */
4238
4832
  findingCriteria?: FindingCriteria;
4239
4833
  /**
4834
+ * @public
4240
4835
  * <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>
4241
4836
  */
4242
4837
  groupBy: GroupBy | string | undefined;
4243
4838
  /**
4839
+ * @public
4244
4840
  * <p>The maximum number of items to include in each page of the response.</p>
4245
4841
  */
4246
4842
  size?: number;
4247
4843
  /**
4844
+ * @public
4248
4845
  * <p>The criteria to use to sort the query results.</p>
4249
4846
  */
4250
4847
  sortCriteria?: FindingStatisticsSortCriteria;
@@ -4254,6 +4851,7 @@ export interface GetFindingStatisticsRequest {
4254
4851
  */
4255
4852
  export interface GetFindingStatisticsResponse {
4256
4853
  /**
4854
+ * @public
4257
4855
  * <p>An array of objects, one for each group of findings that matches the filter criteria specified in the request.</p>
4258
4856
  */
4259
4857
  countsByGroup?: GroupCount[];
@@ -4268,6 +4866,7 @@ export interface GetInvitationsCountRequest {
4268
4866
  */
4269
4867
  export interface GetInvitationsCountResponse {
4270
4868
  /**
4869
+ * @public
4271
4870
  * <p>The total number of invitations that were received by the account, not including the currently accepted invitation.</p>
4272
4871
  */
4273
4872
  invitationsCount?: number;
@@ -4282,22 +4881,27 @@ export interface GetMacieSessionRequest {
4282
4881
  */
4283
4882
  export interface GetMacieSessionResponse {
4284
4883
  /**
4884
+ * @public
4285
4885
  * <p>The date and time, in UTC and extended ISO 8601 format, when the Amazon Macie account was created.</p>
4286
4886
  */
4287
4887
  createdAt?: Date;
4288
4888
  /**
4889
+ * @public
4289
4890
  * <p>The frequency with which Amazon Macie publishes updates to policy findings for the account. This includes publishing updates to Security Hub and Amazon EventBridge (formerly Amazon CloudWatch Events).</p>
4290
4891
  */
4291
4892
  findingPublishingFrequency?: FindingPublishingFrequency | string;
4292
4893
  /**
4894
+ * @public
4293
4895
  * <p>The Amazon Resource Name (ARN) of the service-linked role that allows Amazon Macie to monitor and analyze data in Amazon Web Services resources for the account.</p>
4294
4896
  */
4295
4897
  serviceRole?: string;
4296
4898
  /**
4899
+ * @public
4297
4900
  * <p>The current status of the Amazon Macie account. Possible values are: PAUSED, the account is enabled but all Macie activities are suspended (paused) for the account; and, ENABLED, the account is enabled and all Macie activities are enabled for the account.</p>
4298
4901
  */
4299
4902
  status?: MacieStatus | string;
4300
4903
  /**
4904
+ * @public
4301
4905
  * <p>The date and time, in UTC and extended ISO 8601 format, of the most recent change to the status of the Amazon Macie account.</p>
4302
4906
  */
4303
4907
  updatedAt?: Date;
@@ -4312,6 +4916,7 @@ export interface GetMasterAccountRequest {
4312
4916
  */
4313
4917
  export interface GetMasterAccountResponse {
4314
4918
  /**
4919
+ * @public
4315
4920
  * <p>(Deprecated) The Amazon Web Services account ID for the administrator account. If the accounts are associated by a Macie membership invitation, this object also provides details about the invitation that was sent to establish the relationship between the accounts.</p>
4316
4921
  */
4317
4922
  master?: Invitation;
@@ -4321,6 +4926,7 @@ export interface GetMasterAccountResponse {
4321
4926
  */
4322
4927
  export interface GetMemberRequest {
4323
4928
  /**
4929
+ * @public
4324
4930
  * <p>The unique identifier for the Amazon Macie resource that the request applies to.</p>
4325
4931
  */
4326
4932
  id: string | undefined;
@@ -4330,38 +4936,47 @@ export interface GetMemberRequest {
4330
4936
  */
4331
4937
  export interface GetMemberResponse {
4332
4938
  /**
4939
+ * @public
4333
4940
  * <p>The Amazon Web Services account ID for the account.</p>
4334
4941
  */
4335
4942
  accountId?: string;
4336
4943
  /**
4944
+ * @public
4337
4945
  * <p>The Amazon Web Services account ID for the administrator account.</p>
4338
4946
  */
4339
4947
  administratorAccountId?: string;
4340
4948
  /**
4949
+ * @public
4341
4950
  * <p>The Amazon Resource Name (ARN) of the account.</p>
4342
4951
  */
4343
4952
  arn?: string;
4344
4953
  /**
4954
+ * @public
4345
4955
  * <p>The email address for the account. This value is null if the account is associated with the administrator account through Organizations.</p>
4346
4956
  */
4347
4957
  email?: string;
4348
4958
  /**
4959
+ * @public
4349
4960
  * <p>The date and time, in UTC and extended ISO 8601 format, when an Amazon Macie membership invitation was last sent to the account. This value is null if a Macie membership invitation hasn't been sent to the account.</p>
4350
4961
  */
4351
4962
  invitedAt?: Date;
4352
4963
  /**
4964
+ * @public
4353
4965
  * <p>(Deprecated) The Amazon Web Services account ID for the administrator account. This property has been replaced by the administratorAccountId property and is retained only for backward compatibility.</p>
4354
4966
  */
4355
4967
  masterAccountId?: string;
4356
4968
  /**
4969
+ * @public
4357
4970
  * <p>The current status of the relationship between the account and the administrator account.</p>
4358
4971
  */
4359
4972
  relationshipStatus?: RelationshipStatus | string;
4360
4973
  /**
4974
+ * @public
4361
4975
  * <p>A map of key-value pairs that specifies which tags (keys and values) are associated with the account in Amazon Macie.</p>
4362
4976
  */
4363
4977
  tags?: Record<string, string>;
4364
4978
  /**
4979
+ * @public
4365
4980
  * <p>The date and time, in UTC and extended ISO 8601 format, of the most recent change to the status of the relationship between the account and the administrator account.</p>
4366
4981
  */
4367
4982
  updatedAt?: Date;
@@ -4371,6 +4986,7 @@ export interface GetMemberResponse {
4371
4986
  */
4372
4987
  export interface GetResourceProfileRequest {
4373
4988
  /**
4989
+ * @public
4374
4990
  * <p>The Amazon Resource Name (ARN) of the S3 bucket that the request applies to.</p>
4375
4991
  */
4376
4992
  resourceArn: string | undefined;
@@ -4381,38 +4997,47 @@ export interface GetResourceProfileRequest {
4381
4997
  */
4382
4998
  export interface ResourceStatistics {
4383
4999
  /**
5000
+ * @public
4384
5001
  * <p>The total amount of data, in bytes, that Amazon Macie has analyzed in the bucket.</p>
4385
5002
  */
4386
5003
  totalBytesClassified?: number;
4387
5004
  /**
5005
+ * @public
4388
5006
  * <p>The total number of occurrences of sensitive data that Amazon Macie has found in the bucket's objects. This includes occurrences that are currently suppressed by the sensitivity scoring settings for the bucket (totalDetectionsSuppressed).</p>
4389
5007
  */
4390
5008
  totalDetections?: number;
4391
5009
  /**
5010
+ * @public
4392
5011
  * <p>The total number of occurrences of sensitive data that are currently suppressed by the sensitivity scoring settings for the bucket. These represent occurrences of sensitive data that Amazon Macie found in the bucket's objects, but the occurrences were manually suppressed. By default, suppressed occurrences are excluded from the bucket's sensitivity score.</p>
4393
5012
  */
4394
5013
  totalDetectionsSuppressed?: number;
4395
5014
  /**
5015
+ * @public
4396
5016
  * <p>The total number of objects that Amazon Macie has analyzed in the bucket.</p>
4397
5017
  */
4398
5018
  totalItemsClassified?: number;
4399
5019
  /**
5020
+ * @public
4400
5021
  * <p>The total number of the bucket's objects that Amazon Macie has found sensitive data in.</p>
4401
5022
  */
4402
5023
  totalItemsSensitive?: number;
4403
5024
  /**
5025
+ * @public
4404
5026
  * <p>The total number of objects that Amazon Macie wasn't able to analyze in the bucket due to an object-level issue or error. For example, the object is a malformed file. This value includes objects that Macie wasn't able to analyze for reasons reported by other statistics in the ResourceStatistics object.</p>
4405
5027
  */
4406
5028
  totalItemsSkipped?: number;
4407
5029
  /**
5030
+ * @public
4408
5031
  * <p>The total number of objects that Amazon Macie wasn't able to analyze in the bucket because the objects are encrypted with a key that Macie can't access. The objects use server-side encryption with customer-provided keys (SSE-C).</p>
4409
5032
  */
4410
5033
  totalItemsSkippedInvalidEncryption?: number;
4411
5034
  /**
5035
+ * @public
4412
5036
  * <p>The total number of objects that Amazon Macie wasn't able to analyze in the bucket because the objects are encrypted with KMS keys that were disabled, are scheduled for deletion, or were deleted.</p>
4413
5037
  */
4414
5038
  totalItemsSkippedInvalidKms?: number;
4415
5039
  /**
5040
+ * @public
4416
5041
  * <p>The total number of objects that Amazon Macie wasn't able to analyze in the bucket due to the permissions settings for the objects or the permissions settings for the keys that were used to encrypt the objects.</p>
4417
5042
  */
4418
5043
  totalItemsSkippedPermissionDenied?: number;
@@ -4422,18 +5047,22 @@ export interface ResourceStatistics {
4422
5047
  */
4423
5048
  export interface GetResourceProfileResponse {
4424
5049
  /**
5050
+ * @public
4425
5051
  * <p>The date and time, in UTC and extended ISO 8601 format, when Amazon Macie most recently recalculated sensitive data discovery statistics and details for the bucket. If the bucket's sensitivity score is calculated automatically, this includes the score.</p>
4426
5052
  */
4427
5053
  profileUpdatedAt?: Date;
4428
5054
  /**
5055
+ * @public
4429
5056
  * <p>The current sensitivity score for the bucket, ranging from -1 (classification error) to 100 (sensitive). By default, this score is calculated automatically based on the amount of data that Amazon Macie has analyzed in the bucket and the amount of sensitive data that Macie has found in the bucket.</p>
4430
5057
  */
4431
5058
  sensitivityScore?: number;
4432
5059
  /**
5060
+ * @public
4433
5061
  * <p>Specifies whether the bucket's current sensitivity score was set manually. If this value is true, the score was manually changed to 100. If this value is false, the score was calculated automatically by Amazon Macie.</p>
4434
5062
  */
4435
5063
  sensitivityScoreOverridden?: boolean;
4436
5064
  /**
5065
+ * @public
4437
5066
  * <p>The sensitive data discovery statistics for the bucket. The statistics capture the results of automated sensitive data discovery activities that Amazon Macie has performed for the bucket.</p>
4438
5067
  */
4439
5068
  statistics?: ResourceStatistics;
@@ -4461,10 +5090,12 @@ export type RevealStatus = (typeof RevealStatus)[keyof typeof RevealStatus];
4461
5090
  */
4462
5091
  export interface RevealConfiguration {
4463
5092
  /**
5093
+ * @public
4464
5094
  * <p>The Amazon Resource Name (ARN), ID, or alias of the KMS key to use to encrypt sensitive data that's retrieved. The key must be an existing, customer managed, symmetric encryption key that's in the same Amazon Web Services Region as the Amazon Macie account.</p> <p>If this value specifies an alias, it must include the following prefix: alias/. If this value specifies a key that's owned by another Amazon Web Services account, it must specify the ARN of the key or the ARN of the key's alias.</p>
4465
5095
  */
4466
5096
  kmsKeyId?: string;
4467
5097
  /**
5098
+ * @public
4468
5099
  * <p>The status of the configuration for the Amazon Macie account. In a request, valid values are: ENABLED, enable the configuration for the account; and, DISABLED, disable the configuration for the account. In a response, possible values are: ENABLED, the configuration is currently enabled for the account; and, DISABLED, the configuration is currently disabled for the account.</p>
4469
5100
  */
4470
5101
  status: RevealStatus | string | undefined;
@@ -4474,6 +5105,7 @@ export interface RevealConfiguration {
4474
5105
  */
4475
5106
  export interface GetRevealConfigurationResponse {
4476
5107
  /**
5108
+ * @public
4477
5109
  * <p>The current configuration settings and the status of the configuration for the account.</p>
4478
5110
  */
4479
5111
  configuration?: RevealConfiguration;
@@ -4483,6 +5115,7 @@ export interface GetRevealConfigurationResponse {
4483
5115
  */
4484
5116
  export interface GetSensitiveDataOccurrencesRequest {
4485
5117
  /**
5118
+ * @public
4486
5119
  * <p>The unique identifier for the finding.</p>
4487
5120
  */
4488
5121
  findingId: string | undefined;
@@ -4505,14 +5138,17 @@ export type RevealRequestStatus = (typeof RevealRequestStatus)[keyof typeof Reve
4505
5138
  */
4506
5139
  export interface GetSensitiveDataOccurrencesResponse {
4507
5140
  /**
5141
+ * @public
4508
5142
  * <p>If an error occurred when Amazon Macie attempted to retrieve occurrences of sensitive data reported by the finding, a description of the error that occurred. This value is null if the status (status) of the request is PROCESSING or SUCCESS.</p>
4509
5143
  */
4510
5144
  error?: string;
4511
5145
  /**
5146
+ * @public
4512
5147
  * <p>A map that specifies 1-100 types of sensitive data reported by the finding and, for each type, 1-10 occurrences of sensitive data.</p>
4513
5148
  */
4514
5149
  sensitiveDataOccurrences?: Record<string, DetectedDataDetails[]>;
4515
5150
  /**
5151
+ * @public
4516
5152
  * <p>The status of the request to retrieve occurrences of sensitive data reported by the finding. Possible values are:</p> <ul><li><p>ERROR - An error occurred when Amazon Macie attempted to locate, retrieve, or encrypt the sensitive data. The error value indicates the nature of the error that occurred.</p></li> <li><p>PROCESSING - Macie is processing the request.</p></li> <li><p>SUCCESS - Macie successfully located, retrieved, and encrypted the sensitive data.</p></li></ul>
4517
5153
  */
4518
5154
  status?: RevealRequestStatus | string;
@@ -4534,6 +5170,7 @@ export declare class UnprocessableEntityException extends __BaseException {
4534
5170
  */
4535
5171
  export interface GetSensitiveDataOccurrencesAvailabilityRequest {
4536
5172
  /**
5173
+ * @public
4537
5174
  * <p>The unique identifier for the finding.</p>
4538
5175
  */
4539
5176
  findingId: string | undefined;
@@ -4543,10 +5180,12 @@ export interface GetSensitiveDataOccurrencesAvailabilityRequest {
4543
5180
  */
4544
5181
  export interface GetSensitiveDataOccurrencesAvailabilityResponse {
4545
5182
  /**
5183
+ * @public
4546
5184
  * <p>Specifies whether occurrences of sensitive data can be retrieved for the finding. Possible values are: AVAILABLE, the sensitive data can be retrieved; and, UNAVAILABLE, the sensitive data can't be retrieved. If this value is UNAVAILABLE, the reasons array indicates why the data can't be retrieved.</p>
4547
5185
  */
4548
5186
  code?: AvailabilityCode | string;
4549
5187
  /**
5188
+ * @public
4550
5189
  * <p>Specifies why occurrences of sensitive data can't be retrieved for the finding. Possible values are:</p> <ul><li><p>INVALID_CLASSIFICATION_RESULT - Amazon Macie can't verify the location of the sensitive data to retrieve. There isn't a corresponding sensitive data discovery result for the finding. Or the sensitive data discovery result specified by the classificationDetails.detailedResultsLocation field of the finding isn't available, is malformed or corrupted, or uses an unsupported storage format.</p></li> <li><p>OBJECT_EXCEEDS_SIZE_QUOTA - The storage size of the affected S3 object exceeds the size quota for retrieving occurrences of sensitive data.</p></li> <li><p>OBJECT_UNAVAILABLE - The affected S3 object isn't available. The object might have been renamed, moved, or deleted. Or the object was changed after Macie created the finding.</p></li> <li><p>UNSUPPORTED_FINDING_TYPE - The specified finding isn't a sensitive data finding.</p></li> <li><p>UNSUPPORTED_OBJECT_TYPE - The affected S3 object uses a file or storage format that Macie doesn't support for retrieving occurrences of sensitive data.</p></li></ul> <p>This value is null if sensitive data can be retrieved for the finding.</p>
4551
5190
  */
4552
5191
  reasons?: (UnavailabilityReasonCode | string)[];
@@ -4556,6 +5195,7 @@ export interface GetSensitiveDataOccurrencesAvailabilityResponse {
4556
5195
  */
4557
5196
  export interface GetSensitivityInspectionTemplateRequest {
4558
5197
  /**
5198
+ * @public
4559
5199
  * <p>The unique identifier for the Amazon Macie resource that the request applies to.</p>
4560
5200
  */
4561
5201
  id: string | undefined;
@@ -4566,6 +5206,7 @@ export interface GetSensitivityInspectionTemplateRequest {
4566
5206
  */
4567
5207
  export interface SensitivityInspectionTemplateExcludes {
4568
5208
  /**
5209
+ * @public
4569
5210
  * <p>An array of unique identifiers, one for each managed data identifier to exclude. To retrieve a list of valid values, use the ListManagedDataIdentifiers operation.</p>
4570
5211
  */
4571
5212
  managedDataIdentifierIds?: string[];
@@ -4576,14 +5217,17 @@ export interface SensitivityInspectionTemplateExcludes {
4576
5217
  */
4577
5218
  export interface SensitivityInspectionTemplateIncludes {
4578
5219
  /**
5220
+ * @public
4579
5221
  * <p>An array of unique identifiers, one for each allow list to include.</p>
4580
5222
  */
4581
5223
  allowListIds?: string[];
4582
5224
  /**
5225
+ * @public
4583
5226
  * <p>An array of unique identifiers, one for each custom data identifier to include.</p>
4584
5227
  */
4585
5228
  customDataIdentifierIds?: string[];
4586
5229
  /**
5230
+ * @public
4587
5231
  * <p>An array of unique identifiers, one for each managed data identifier to include.</p> <p>Amazon Macie uses these managed data identifiers in addition to managed data identifiers that are subsequently released and recommended for automated sensitive data discovery. To retrieve a list of valid values for the managed data identifiers that are currently available, use the ListManagedDataIdentifiers operation.</p> <para/>
4588
5232
  */
4589
5233
  managedDataIdentifierIds?: string[];
@@ -4593,22 +5237,27 @@ export interface SensitivityInspectionTemplateIncludes {
4593
5237
  */
4594
5238
  export interface GetSensitivityInspectionTemplateResponse {
4595
5239
  /**
5240
+ * @public
4596
5241
  * <p>The custom description of the template.</p>
4597
5242
  */
4598
5243
  description?: string;
4599
5244
  /**
5245
+ * @public
4600
5246
  * <p>The managed data identifiers that are explicitly excluded (not used) when analyzing data.</p>
4601
5247
  */
4602
5248
  excludes?: SensitivityInspectionTemplateExcludes;
4603
5249
  /**
5250
+ * @public
4604
5251
  * <p>The allow lists, custom data identifiers, and managed data identifiers that are included (used) when analyzing data.</p>
4605
5252
  */
4606
5253
  includes?: SensitivityInspectionTemplateIncludes;
4607
5254
  /**
5255
+ * @public
4608
5256
  * <p>The name of the template: automated-sensitive-data-discovery.</p>
4609
5257
  */
4610
5258
  name?: string;
4611
5259
  /**
5260
+ * @public
4612
5261
  * <p>The unique identifier for the template.</p>
4613
5262
  */
4614
5263
  sensitivityInspectionTemplateId?: string;
@@ -4633,10 +5282,12 @@ export type UsageStatisticsSortKey = (typeof UsageStatisticsSortKey)[keyof typeo
4633
5282
  */
4634
5283
  export interface UsageStatisticsSortBy {
4635
5284
  /**
5285
+ * @public
4636
5286
  * <p>The field to sort the results by.</p>
4637
5287
  */
4638
5288
  key?: UsageStatisticsSortKey | string;
4639
5289
  /**
5290
+ * @public
4640
5291
  * <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>
4641
5292
  */
4642
5293
  orderBy?: OrderBy | string;
@@ -4658,22 +5309,27 @@ export type TimeRange = (typeof TimeRange)[keyof typeof TimeRange];
4658
5309
  */
4659
5310
  export interface GetUsageStatisticsRequest {
4660
5311
  /**
5312
+ * @public
4661
5313
  * <p>An array of objects, one for each condition to use to filter the query results. If you specify more than one condition, Amazon Macie uses an AND operator to join the conditions.</p>
4662
5314
  */
4663
5315
  filterBy?: UsageStatisticsFilter[];
4664
5316
  /**
5317
+ * @public
4665
5318
  * <p>The maximum number of items to include in each page of the response.</p>
4666
5319
  */
4667
5320
  maxResults?: number;
4668
5321
  /**
5322
+ * @public
4669
5323
  * <p>The nextToken string that specifies which page of results to return in a paginated response.</p>
4670
5324
  */
4671
5325
  nextToken?: string;
4672
5326
  /**
5327
+ * @public
4673
5328
  * <p>The criteria to use to sort the query results.</p>
4674
5329
  */
4675
5330
  sortBy?: UsageStatisticsSortBy;
4676
5331
  /**
5332
+ * @public
4677
5333
  * <p>The inclusive time period to query usage data for. Valid values are: MONTH_TO_DATE, for the current calendar month to date; and, PAST_30_DAYS, for the preceding 30 days. If you don't specify a value, Amazon Macie provides usage data for the preceding 30 days.</p>
4678
5334
  */
4679
5335
  timeRange?: TimeRange | string;
@@ -4683,14 +5339,17 @@ export interface GetUsageStatisticsRequest {
4683
5339
  */
4684
5340
  export interface GetUsageStatisticsResponse {
4685
5341
  /**
5342
+ * @public
4686
5343
  * <p>The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.</p>
4687
5344
  */
4688
5345
  nextToken?: string;
4689
5346
  /**
5347
+ * @public
4690
5348
  * <p>An array of objects that contains the results of the query. Each object contains the data for an account that matches the filter criteria specified in the request.</p>
4691
5349
  */
4692
5350
  records?: UsageRecord[];
4693
5351
  /**
5352
+ * @public
4694
5353
  * <p>The inclusive time period that the usage data applies to. Possible values are: MONTH_TO_DATE, for the current calendar month to date; and, PAST_30_DAYS, for the preceding 30 days.</p>
4695
5354
  */
4696
5355
  timeRange?: TimeRange | string;
@@ -4700,6 +5359,7 @@ export interface GetUsageStatisticsResponse {
4700
5359
  */
4701
5360
  export interface GetUsageTotalsRequest {
4702
5361
  /**
5362
+ * @public
4703
5363
  * <p>The inclusive time period to retrieve the data for. Valid values are: MONTH_TO_DATE, for the current calendar month to date; and, PAST_30_DAYS, for the preceding 30 days. If you don't specify a value for this parameter, Amazon Macie provides aggregated usage data for the preceding 30 days.</p>
4704
5364
  */
4705
5365
  timeRange?: string;
@@ -4709,10 +5369,12 @@ export interface GetUsageTotalsRequest {
4709
5369
  */
4710
5370
  export interface GetUsageTotalsResponse {
4711
5371
  /**
5372
+ * @public
4712
5373
  * <p>The inclusive time period that the usage data applies to. Possible values are: MONTH_TO_DATE, for the current calendar month to date; and, PAST_30_DAYS, for the preceding 30 days.</p>
4713
5374
  */
4714
5375
  timeRange?: TimeRange | string;
4715
5376
  /**
5377
+ * @public
4716
5378
  * <p>An array of objects that contains the results of the query. Each object contains the data for a specific usage metric.</p>
4717
5379
  */
4718
5380
  usageTotals?: UsageTotal[];
@@ -4722,10 +5384,12 @@ export interface GetUsageTotalsResponse {
4722
5384
  */
4723
5385
  export interface ListAllowListsRequest {
4724
5386
  /**
5387
+ * @public
4725
5388
  * <p>The maximum number of items to include in each page of a paginated response.</p>
4726
5389
  */
4727
5390
  maxResults?: number;
4728
5391
  /**
5392
+ * @public
4729
5393
  * <p>The nextToken string that specifies which page of results to return in a paginated response.</p>
4730
5394
  */
4731
5395
  nextToken?: string;
@@ -4735,10 +5399,12 @@ export interface ListAllowListsRequest {
4735
5399
  */
4736
5400
  export interface ListAllowListsResponse {
4737
5401
  /**
5402
+ * @public
4738
5403
  * <p>An array of objects, one for each allow list.</p>
4739
5404
  */
4740
5405
  allowLists?: AllowListSummary[];
4741
5406
  /**
5407
+ * @public
4742
5408
  * <p>The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.</p>
4743
5409
  */
4744
5410
  nextToken?: string;
@@ -4749,10 +5415,12 @@ export interface ListAllowListsResponse {
4749
5415
  */
4750
5416
  export interface ListJobsFilterCriteria {
4751
5417
  /**
5418
+ * @public
4752
5419
  * <p>An array of objects, one for each condition that determines which jobs to exclude from the results.</p>
4753
5420
  */
4754
5421
  excludes?: ListJobsFilterTerm[];
4755
5422
  /**
5423
+ * @public
4756
5424
  * <p>An array of objects, one for each condition that determines which jobs to include in the results.</p>
4757
5425
  */
4758
5426
  includes?: ListJobsFilterTerm[];
@@ -4777,10 +5445,12 @@ export type ListJobsSortAttributeName = (typeof ListJobsSortAttributeName)[keyof
4777
5445
  */
4778
5446
  export interface ListJobsSortCriteria {
4779
5447
  /**
5448
+ * @public
4780
5449
  * <p>The property to sort the results by.</p>
4781
5450
  */
4782
5451
  attributeName?: ListJobsSortAttributeName | string;
4783
5452
  /**
5453
+ * @public
4784
5454
  * <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>
4785
5455
  */
4786
5456
  orderBy?: OrderBy | string;
@@ -4790,18 +5460,22 @@ export interface ListJobsSortCriteria {
4790
5460
  */
4791
5461
  export interface ListClassificationJobsRequest {
4792
5462
  /**
5463
+ * @public
4793
5464
  * <p>The criteria to use to filter the results.</p>
4794
5465
  */
4795
5466
  filterCriteria?: ListJobsFilterCriteria;
4796
5467
  /**
5468
+ * @public
4797
5469
  * <p>The maximum number of items to include in each page of the response.</p>
4798
5470
  */
4799
5471
  maxResults?: number;
4800
5472
  /**
5473
+ * @public
4801
5474
  * <p>The nextToken string that specifies which page of results to return in a paginated response.</p>
4802
5475
  */
4803
5476
  nextToken?: string;
4804
5477
  /**
5478
+ * @public
4805
5479
  * <p>The criteria to use to sort the results.</p>
4806
5480
  */
4807
5481
  sortCriteria?: ListJobsSortCriteria;
@@ -4811,10 +5485,12 @@ export interface ListClassificationJobsRequest {
4811
5485
  */
4812
5486
  export interface ListClassificationJobsResponse {
4813
5487
  /**
5488
+ * @public
4814
5489
  * <p>An array of objects, one for each job that matches the filter criteria specified in the request.</p>
4815
5490
  */
4816
5491
  items?: JobSummary[];
4817
5492
  /**
5493
+ * @public
4818
5494
  * <p>The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.</p>
4819
5495
  */
4820
5496
  nextToken?: string;
@@ -4824,10 +5500,12 @@ export interface ListClassificationJobsResponse {
4824
5500
  */
4825
5501
  export interface ListClassificationScopesRequest {
4826
5502
  /**
5503
+ * @public
4827
5504
  * <p>The name of the classification scope to retrieve the unique identifier for.</p>
4828
5505
  */
4829
5506
  name?: string;
4830
5507
  /**
5508
+ * @public
4831
5509
  * <p>The nextToken string that specifies which page of results to return in a paginated response.</p>
4832
5510
  */
4833
5511
  nextToken?: string;
@@ -4837,10 +5515,12 @@ export interface ListClassificationScopesRequest {
4837
5515
  */
4838
5516
  export interface ListClassificationScopesResponse {
4839
5517
  /**
5518
+ * @public
4840
5519
  * <p>An array that specifies the unique identifier and name of the classification scope for the account.</p>
4841
5520
  */
4842
5521
  classificationScopes?: ClassificationScopeSummary[];
4843
5522
  /**
5523
+ * @public
4844
5524
  * <p>The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.</p>
4845
5525
  */
4846
5526
  nextToken?: string;
@@ -4850,10 +5530,12 @@ export interface ListClassificationScopesResponse {
4850
5530
  */
4851
5531
  export interface ListCustomDataIdentifiersRequest {
4852
5532
  /**
5533
+ * @public
4853
5534
  * <p>The maximum number of items to include in each page of the response.</p>
4854
5535
  */
4855
5536
  maxResults?: number;
4856
5537
  /**
5538
+ * @public
4857
5539
  * <p>The nextToken string that specifies which page of results to return in a paginated response.</p>
4858
5540
  */
4859
5541
  nextToken?: string;
@@ -4863,10 +5545,12 @@ export interface ListCustomDataIdentifiersRequest {
4863
5545
  */
4864
5546
  export interface ListCustomDataIdentifiersResponse {
4865
5547
  /**
5548
+ * @public
4866
5549
  * <p>An array of objects, one for each custom data identifier.</p>
4867
5550
  */
4868
5551
  items?: CustomDataIdentifierSummary[];
4869
5552
  /**
5553
+ * @public
4870
5554
  * <p>The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.</p>
4871
5555
  */
4872
5556
  nextToken?: string;
@@ -4876,18 +5560,22 @@ export interface ListCustomDataIdentifiersResponse {
4876
5560
  */
4877
5561
  export interface ListFindingsRequest {
4878
5562
  /**
5563
+ * @public
4879
5564
  * <p>The criteria to use to filter the results.</p>
4880
5565
  */
4881
5566
  findingCriteria?: FindingCriteria;
4882
5567
  /**
5568
+ * @public
4883
5569
  * <p>The maximum number of items to include in each page of the response.</p>
4884
5570
  */
4885
5571
  maxResults?: number;
4886
5572
  /**
5573
+ * @public
4887
5574
  * <p>The nextToken string that specifies which page of results to return in a paginated response.</p>
4888
5575
  */
4889
5576
  nextToken?: string;
4890
5577
  /**
5578
+ * @public
4891
5579
  * <p>The criteria to use to sort the results.</p>
4892
5580
  */
4893
5581
  sortCriteria?: SortCriteria;
@@ -4897,10 +5585,12 @@ export interface ListFindingsRequest {
4897
5585
  */
4898
5586
  export interface ListFindingsResponse {
4899
5587
  /**
5588
+ * @public
4900
5589
  * <p>An array of strings, where each string is the unique identifier for a finding that matches the filter criteria specified in the request.</p>
4901
5590
  */
4902
5591
  findingIds?: string[];
4903
5592
  /**
5593
+ * @public
4904
5594
  * <p>The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.</p>
4905
5595
  */
4906
5596
  nextToken?: string;
@@ -4910,10 +5600,12 @@ export interface ListFindingsResponse {
4910
5600
  */
4911
5601
  export interface ListFindingsFiltersRequest {
4912
5602
  /**
5603
+ * @public
4913
5604
  * <p>The maximum number of items to include in each page of a paginated response.</p>
4914
5605
  */
4915
5606
  maxResults?: number;
4916
5607
  /**
5608
+ * @public
4917
5609
  * <p>The nextToken string that specifies which page of results to return in a paginated response.</p>
4918
5610
  */
4919
5611
  nextToken?: string;
@@ -4923,10 +5615,12 @@ export interface ListFindingsFiltersRequest {
4923
5615
  */
4924
5616
  export interface ListFindingsFiltersResponse {
4925
5617
  /**
5618
+ * @public
4926
5619
  * <p>An array of objects, one for each filter that's associated with the account.</p>
4927
5620
  */
4928
5621
  findingsFilterListItems?: FindingsFilterListItem[];
4929
5622
  /**
5623
+ * @public
4930
5624
  * <p>The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.</p>
4931
5625
  */
4932
5626
  nextToken?: string;