@aws-sdk/client-macie2 3.687.0 → 3.692.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.
- package/dist-types/models/models_0.d.ts +632 -632
- package/dist-types/models/models_1.d.ts +98 -98
- package/dist-types/ts3.4/models/models_0.d.ts +640 -632
- package/dist-types/ts3.4/models/models_1.d.ts +100 -98
- package/package.json +36 -36
|
@@ -21,12 +21,12 @@ export interface AdminAccount {
|
|
|
21
21
|
* <p>The Amazon Web Services account ID for the account.</p>
|
|
22
22
|
* @public
|
|
23
23
|
*/
|
|
24
|
-
accountId?: string;
|
|
24
|
+
accountId?: string | undefined;
|
|
25
25
|
/**
|
|
26
26
|
* <p>The current status of the account as the delegated Amazon Macie administrator account for the organization.</p>
|
|
27
27
|
* @public
|
|
28
28
|
*/
|
|
29
|
-
status?: AdminStatus;
|
|
29
|
+
status?: AdminStatus | undefined;
|
|
30
30
|
}
|
|
31
31
|
/**
|
|
32
32
|
* <p>Provides a subset of information about an allow list.</p>
|
|
@@ -37,32 +37,32 @@ export interface AllowListSummary {
|
|
|
37
37
|
* <p>The Amazon Resource Name (ARN) of the allow list.</p>
|
|
38
38
|
* @public
|
|
39
39
|
*/
|
|
40
|
-
arn?: string;
|
|
40
|
+
arn?: string | undefined;
|
|
41
41
|
/**
|
|
42
42
|
* <p>The date and time, in UTC and extended ISO 8601 format, when the allow list was created in Amazon Macie.</p>
|
|
43
43
|
* @public
|
|
44
44
|
*/
|
|
45
|
-
createdAt?: Date;
|
|
45
|
+
createdAt?: Date | undefined;
|
|
46
46
|
/**
|
|
47
47
|
* <p>The custom description of the allow list.</p>
|
|
48
48
|
* @public
|
|
49
49
|
*/
|
|
50
|
-
description?: string;
|
|
50
|
+
description?: string | undefined;
|
|
51
51
|
/**
|
|
52
52
|
* <p>The unique identifier for the allow list.</p>
|
|
53
53
|
* @public
|
|
54
54
|
*/
|
|
55
|
-
id?: string;
|
|
55
|
+
id?: string | undefined;
|
|
56
56
|
/**
|
|
57
57
|
* <p>The custom name of the allow list.</p>
|
|
58
58
|
* @public
|
|
59
59
|
*/
|
|
60
|
-
name?: string;
|
|
60
|
+
name?: string | undefined;
|
|
61
61
|
/**
|
|
62
62
|
* <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>
|
|
63
63
|
* @public
|
|
64
64
|
*/
|
|
65
|
-
updatedAt?: Date;
|
|
65
|
+
updatedAt?: Date | undefined;
|
|
66
66
|
}
|
|
67
67
|
/**
|
|
68
68
|
* @public
|
|
@@ -85,12 +85,12 @@ export interface AutomatedDiscoveryAccount {
|
|
|
85
85
|
* <p>The Amazon Web Services account ID for the account.</p>
|
|
86
86
|
* @public
|
|
87
87
|
*/
|
|
88
|
-
accountId?: string;
|
|
88
|
+
accountId?: string | undefined;
|
|
89
89
|
/**
|
|
90
90
|
* <p>The current status of automated sensitive data discovery for the account. Possible values are: ENABLED, perform automated sensitive data discovery activities for the account; and, DISABLED, don't perform automated sensitive data discovery activities for the account.</p>
|
|
91
91
|
* @public
|
|
92
92
|
*/
|
|
93
|
-
status?: AutomatedDiscoveryAccountStatus;
|
|
93
|
+
status?: AutomatedDiscoveryAccountStatus | undefined;
|
|
94
94
|
}
|
|
95
95
|
/**
|
|
96
96
|
* <p>Changes the status of automated sensitive data discovery for an Amazon Macie account.</p>
|
|
@@ -101,12 +101,12 @@ export interface AutomatedDiscoveryAccountUpdate {
|
|
|
101
101
|
* <p>The Amazon Web Services account ID for the account.</p>
|
|
102
102
|
* @public
|
|
103
103
|
*/
|
|
104
|
-
accountId?: string;
|
|
104
|
+
accountId?: string | undefined;
|
|
105
105
|
/**
|
|
106
106
|
* <p>The new status of automated sensitive data discovery for the account. Valid values are: ENABLED, perform automated sensitive data discovery activities for the account; and, DISABLED, don't perform automated sensitive data discovery activities for the account.</p>
|
|
107
107
|
* @public
|
|
108
108
|
*/
|
|
109
|
-
status?: AutomatedDiscoveryAccountStatus;
|
|
109
|
+
status?: AutomatedDiscoveryAccountStatus | undefined;
|
|
110
110
|
}
|
|
111
111
|
/**
|
|
112
112
|
* @public
|
|
@@ -129,12 +129,12 @@ export interface AutomatedDiscoveryAccountUpdateError {
|
|
|
129
129
|
* <p>The Amazon Web Services account ID for the account that the request applied to.</p>
|
|
130
130
|
* @public
|
|
131
131
|
*/
|
|
132
|
-
accountId?: string;
|
|
132
|
+
accountId?: string | undefined;
|
|
133
133
|
/**
|
|
134
134
|
* <p>The error code for the error that caused the request to fail for the account (accountId). Possible values are: ACCOUNT_NOT_FOUND, the account doesn’t exist or you're not the Amazon Macie administrator for the account; and, ACCOUNT_PAUSED, Macie isn’t enabled for the account in the current Amazon Web Services Region.</p>
|
|
135
135
|
* @public
|
|
136
136
|
*/
|
|
137
|
-
errorCode?: AutomatedDiscoveryAccountUpdateErrorCode;
|
|
137
|
+
errorCode?: AutomatedDiscoveryAccountUpdateErrorCode | undefined;
|
|
138
138
|
}
|
|
139
139
|
/**
|
|
140
140
|
* <p>Provides information about a custom data identifier.</p>
|
|
@@ -145,32 +145,32 @@ export interface BatchGetCustomDataIdentifierSummary {
|
|
|
145
145
|
* <p>The Amazon Resource Name (ARN) of the custom data identifier.</p>
|
|
146
146
|
* @public
|
|
147
147
|
*/
|
|
148
|
-
arn?: string;
|
|
148
|
+
arn?: string | undefined;
|
|
149
149
|
/**
|
|
150
150
|
* <p>The date and time, in UTC and extended ISO 8601 format, when the custom data identifier was created.</p>
|
|
151
151
|
* @public
|
|
152
152
|
*/
|
|
153
|
-
createdAt?: Date;
|
|
153
|
+
createdAt?: Date | undefined;
|
|
154
154
|
/**
|
|
155
155
|
* <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>
|
|
156
156
|
* @public
|
|
157
157
|
*/
|
|
158
|
-
deleted?: boolean;
|
|
158
|
+
deleted?: boolean | undefined;
|
|
159
159
|
/**
|
|
160
160
|
* <p>The custom description of the custom data identifier.</p>
|
|
161
161
|
* @public
|
|
162
162
|
*/
|
|
163
|
-
description?: string;
|
|
163
|
+
description?: string | undefined;
|
|
164
164
|
/**
|
|
165
165
|
* <p>The unique identifier for the custom data identifier.</p>
|
|
166
166
|
* @public
|
|
167
167
|
*/
|
|
168
|
-
id?: string;
|
|
168
|
+
id?: string | undefined;
|
|
169
169
|
/**
|
|
170
170
|
* <p>The custom name of the custom data identifier.</p>
|
|
171
171
|
* @public
|
|
172
172
|
*/
|
|
173
|
-
name?: string;
|
|
173
|
+
name?: string | undefined;
|
|
174
174
|
}
|
|
175
175
|
/**
|
|
176
176
|
* @public
|
|
@@ -243,22 +243,22 @@ export interface JobDetails {
|
|
|
243
243
|
* <p>Specifies whether any one-time or recurring jobs are configured to analyze objects 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>
|
|
244
244
|
* @public
|
|
245
245
|
*/
|
|
246
|
-
isDefinedInJob?: IsDefinedInJob;
|
|
246
|
+
isDefinedInJob?: IsDefinedInJob | undefined;
|
|
247
247
|
/**
|
|
248
248
|
* <p>Specifies whether any recurring jobs are configured to analyze objects 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>
|
|
249
249
|
* @public
|
|
250
250
|
*/
|
|
251
|
-
isMonitoredByJob?: IsMonitoredByJob;
|
|
251
|
+
isMonitoredByJob?: IsMonitoredByJob | undefined;
|
|
252
252
|
/**
|
|
253
253
|
* <p>The unique identifier for the job that ran most recently and is configured to analyze objects 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>
|
|
254
254
|
* @public
|
|
255
255
|
*/
|
|
256
|
-
lastJobId?: string;
|
|
256
|
+
lastJobId?: string | undefined;
|
|
257
257
|
/**
|
|
258
258
|
* <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>
|
|
259
259
|
* @public
|
|
260
260
|
*/
|
|
261
|
-
lastJobRunTime?: Date;
|
|
261
|
+
lastJobRunTime?: Date | undefined;
|
|
262
262
|
}
|
|
263
263
|
/**
|
|
264
264
|
* <p>Provides information about the number of objects that are in an S3 bucket and use certain types of server-side encryption, use client-side encryption, or aren't encrypted.</p>
|
|
@@ -269,27 +269,27 @@ export interface ObjectCountByEncryptionType {
|
|
|
269
269
|
* <p>The total number of objects that are encrypted with customer-provided keys. The objects use server-side encryption with customer-provided keys (SSE-C).</p>
|
|
270
270
|
* @public
|
|
271
271
|
*/
|
|
272
|
-
customerManaged?: number;
|
|
272
|
+
customerManaged?: number | undefined;
|
|
273
273
|
/**
|
|
274
274
|
* <p>The total number of objects that are encrypted with KMS keys, either Amazon Web Services managed keys or customer managed keys. The objects use dual-layer server-side encryption or server-side encryption with KMS keys (DSSE-KMS or SSE-KMS).</p>
|
|
275
275
|
* @public
|
|
276
276
|
*/
|
|
277
|
-
kmsManaged?: number;
|
|
277
|
+
kmsManaged?: number | undefined;
|
|
278
278
|
/**
|
|
279
279
|
* <p>The total number of objects that are encrypted with Amazon S3 managed keys. The objects use server-side encryption with Amazon S3 managed keys (SSE-S3).</p>
|
|
280
280
|
* @public
|
|
281
281
|
*/
|
|
282
|
-
s3Managed?: number;
|
|
282
|
+
s3Managed?: number | undefined;
|
|
283
283
|
/**
|
|
284
284
|
* <p>The total number of objects that use client-side encryption or aren't encrypted.</p>
|
|
285
285
|
* @public
|
|
286
286
|
*/
|
|
287
|
-
unencrypted?: number;
|
|
287
|
+
unencrypted?: number | undefined;
|
|
288
288
|
/**
|
|
289
289
|
* <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>
|
|
290
290
|
* @public
|
|
291
291
|
*/
|
|
292
|
-
unknown?: number;
|
|
292
|
+
unknown?: number | undefined;
|
|
293
293
|
}
|
|
294
294
|
/**
|
|
295
295
|
* @public
|
|
@@ -313,22 +313,22 @@ export interface BlockPublicAccess {
|
|
|
313
313
|
* <p>Specifies whether Amazon S3 blocks public access control lists (ACLs) for the bucket and objects in the bucket.</p>
|
|
314
314
|
* @public
|
|
315
315
|
*/
|
|
316
|
-
blockPublicAcls?: boolean;
|
|
316
|
+
blockPublicAcls?: boolean | undefined;
|
|
317
317
|
/**
|
|
318
318
|
* <p>Specifies whether Amazon S3 blocks public bucket policies for the bucket.</p>
|
|
319
319
|
* @public
|
|
320
320
|
*/
|
|
321
|
-
blockPublicPolicy?: boolean;
|
|
321
|
+
blockPublicPolicy?: boolean | undefined;
|
|
322
322
|
/**
|
|
323
323
|
* <p>Specifies whether Amazon S3 ignores public ACLs for the bucket and objects in the bucket.</p>
|
|
324
324
|
* @public
|
|
325
325
|
*/
|
|
326
|
-
ignorePublicAcls?: boolean;
|
|
326
|
+
ignorePublicAcls?: boolean | undefined;
|
|
327
327
|
/**
|
|
328
328
|
* <p>Specifies whether Amazon S3 restricts public bucket policies for the bucket.</p>
|
|
329
329
|
* @public
|
|
330
330
|
*/
|
|
331
|
-
restrictPublicBuckets?: boolean;
|
|
331
|
+
restrictPublicBuckets?: boolean | undefined;
|
|
332
332
|
}
|
|
333
333
|
/**
|
|
334
334
|
* <p>Provides information about the account-level permissions settings that apply to an S3 bucket.</p>
|
|
@@ -339,7 +339,7 @@ export interface AccountLevelPermissions {
|
|
|
339
339
|
* <p>The block public access settings for the Amazon Web Services account that owns the bucket.</p>
|
|
340
340
|
* @public
|
|
341
341
|
*/
|
|
342
|
-
blockPublicAccess?: BlockPublicAccess;
|
|
342
|
+
blockPublicAccess?: BlockPublicAccess | undefined;
|
|
343
343
|
}
|
|
344
344
|
/**
|
|
345
345
|
* <p>Provides information about the permissions settings of the bucket-level access control list (ACL) for an S3 bucket.</p>
|
|
@@ -350,12 +350,12 @@ export interface AccessControlList {
|
|
|
350
350
|
* <p>Specifies whether the ACL grants the general public with read access permissions for the bucket.</p>
|
|
351
351
|
* @public
|
|
352
352
|
*/
|
|
353
|
-
allowsPublicReadAccess?: boolean;
|
|
353
|
+
allowsPublicReadAccess?: boolean | undefined;
|
|
354
354
|
/**
|
|
355
355
|
* <p>Specifies whether the ACL grants the general public with write access permissions for the bucket.</p>
|
|
356
356
|
* @public
|
|
357
357
|
*/
|
|
358
|
-
allowsPublicWriteAccess?: boolean;
|
|
358
|
+
allowsPublicWriteAccess?: boolean | undefined;
|
|
359
359
|
}
|
|
360
360
|
/**
|
|
361
361
|
* <p>Provides information about the permissions settings of the bucket policy for an S3 bucket.</p>
|
|
@@ -366,12 +366,12 @@ export interface BucketPolicy {
|
|
|
366
366
|
* <p>Specifies whether the bucket policy allows the general public to have read access to the bucket.</p>
|
|
367
367
|
* @public
|
|
368
368
|
*/
|
|
369
|
-
allowsPublicReadAccess?: boolean;
|
|
369
|
+
allowsPublicReadAccess?: boolean | undefined;
|
|
370
370
|
/**
|
|
371
371
|
* <p>Specifies whether the bucket policy allows the general public to have write access to the bucket.</p>
|
|
372
372
|
* @public
|
|
373
373
|
*/
|
|
374
|
-
allowsPublicWriteAccess?: boolean;
|
|
374
|
+
allowsPublicWriteAccess?: boolean | undefined;
|
|
375
375
|
}
|
|
376
376
|
/**
|
|
377
377
|
* <p>Provides information about the bucket-level permissions settings for an S3 bucket.</p>
|
|
@@ -382,17 +382,17 @@ export interface BucketLevelPermissions {
|
|
|
382
382
|
* <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>
|
|
383
383
|
* @public
|
|
384
384
|
*/
|
|
385
|
-
accessControlList?: AccessControlList;
|
|
385
|
+
accessControlList?: AccessControlList | undefined;
|
|
386
386
|
/**
|
|
387
387
|
* <p>The block public access settings for the bucket.</p>
|
|
388
388
|
* @public
|
|
389
389
|
*/
|
|
390
|
-
blockPublicAccess?: BlockPublicAccess;
|
|
390
|
+
blockPublicAccess?: BlockPublicAccess | undefined;
|
|
391
391
|
/**
|
|
392
392
|
* <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>
|
|
393
393
|
* @public
|
|
394
394
|
*/
|
|
395
|
-
bucketPolicy?: BucketPolicy;
|
|
395
|
+
bucketPolicy?: BucketPolicy | undefined;
|
|
396
396
|
}
|
|
397
397
|
/**
|
|
398
398
|
* <p>Provides information about the account-level and bucket-level permissions settings for an S3 bucket.</p>
|
|
@@ -403,12 +403,12 @@ export interface BucketPermissionConfiguration {
|
|
|
403
403
|
* <p>The account-level permissions settings that apply to the bucket.</p>
|
|
404
404
|
* @public
|
|
405
405
|
*/
|
|
406
|
-
accountLevelPermissions?: AccountLevelPermissions;
|
|
406
|
+
accountLevelPermissions?: AccountLevelPermissions | undefined;
|
|
407
407
|
/**
|
|
408
408
|
* <p>The bucket-level permissions settings for the bucket.</p>
|
|
409
409
|
* @public
|
|
410
410
|
*/
|
|
411
|
-
bucketLevelPermissions?: BucketLevelPermissions;
|
|
411
|
+
bucketLevelPermissions?: BucketLevelPermissions | undefined;
|
|
412
412
|
}
|
|
413
413
|
/**
|
|
414
414
|
* <p>Provides information about the permissions settings that determine whether an S3 bucket is publicly accessible.</p>
|
|
@@ -419,12 +419,12 @@ export interface BucketPublicAccess {
|
|
|
419
419
|
* <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>
|
|
420
420
|
* @public
|
|
421
421
|
*/
|
|
422
|
-
effectivePermission?: EffectivePermission;
|
|
422
|
+
effectivePermission?: EffectivePermission | undefined;
|
|
423
423
|
/**
|
|
424
424
|
* <p>The account-level and bucket-level permissions settings for the bucket.</p>
|
|
425
425
|
* @public
|
|
426
426
|
*/
|
|
427
|
-
permissionConfiguration?: BucketPermissionConfiguration;
|
|
427
|
+
permissionConfiguration?: BucketPermissionConfiguration | undefined;
|
|
428
428
|
}
|
|
429
429
|
/**
|
|
430
430
|
* <p>Provides information about settings that define whether one or more objects in an S3 bucket are replicated to S3 buckets for other Amazon Web Services accounts and, if so, which accounts.</p>
|
|
@@ -435,17 +435,17 @@ export interface ReplicationDetails {
|
|
|
435
435
|
* <p>Specifies whether the bucket is configured to replicate one or more objects to any destination.</p>
|
|
436
436
|
* @public
|
|
437
437
|
*/
|
|
438
|
-
replicated?: boolean;
|
|
438
|
+
replicated?: boolean | undefined;
|
|
439
439
|
/**
|
|
440
440
|
* <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>
|
|
441
441
|
* @public
|
|
442
442
|
*/
|
|
443
|
-
replicatedExternally?: boolean;
|
|
443
|
+
replicatedExternally?: boolean | undefined;
|
|
444
444
|
/**
|
|
445
445
|
* <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>
|
|
446
446
|
* @public
|
|
447
447
|
*/
|
|
448
|
-
replicationAccounts?: string[];
|
|
448
|
+
replicationAccounts?: string[] | undefined;
|
|
449
449
|
}
|
|
450
450
|
/**
|
|
451
451
|
* @public
|
|
@@ -470,12 +470,12 @@ export interface BucketServerSideEncryption {
|
|
|
470
470
|
* <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>
|
|
471
471
|
* @public
|
|
472
472
|
*/
|
|
473
|
-
kmsMasterKeyId?: string;
|
|
473
|
+
kmsMasterKeyId?: string | undefined;
|
|
474
474
|
/**
|
|
475
475
|
* <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 use SSE-S3 encryption. They're encrypted with an Amazon S3 managed key.</p></li> <li><p>aws:kms - New objects use SSE-KMS encryption. They're encrypted with an KMS key (kmsMasterKeyId), either an Amazon Web Services managed key or a customer managed key.</p></li> <li><p>aws:kms:dsse - New objects use DSSE-KMS encryption. They're encrypted with an KMS key (kmsMasterKeyId), either an Amazon Web Services managed key or a customer managed key.</p></li> <li><p>NONE - The bucket's default encryption settings don't specify server-side encryption behavior for new objects.</p></li></ul>
|
|
476
476
|
* @public
|
|
477
477
|
*/
|
|
478
|
-
type?: Type;
|
|
478
|
+
type?: Type | undefined;
|
|
479
479
|
}
|
|
480
480
|
/**
|
|
481
481
|
* @public
|
|
@@ -500,12 +500,12 @@ export interface KeyValuePair {
|
|
|
500
500
|
* <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>
|
|
501
501
|
* @public
|
|
502
502
|
*/
|
|
503
|
-
key?: string;
|
|
503
|
+
key?: string | undefined;
|
|
504
504
|
/**
|
|
505
505
|
* <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>
|
|
506
506
|
* @public
|
|
507
507
|
*/
|
|
508
|
-
value?: string;
|
|
508
|
+
value?: string | undefined;
|
|
509
509
|
}
|
|
510
510
|
/**
|
|
511
511
|
* <p>Provides information about the total storage size (in bytes) or number of objects that Amazon Macie can't analyze in one or more S3 buckets. In a BucketMetadata or MatchingBucket object, this data is for a specific bucket. In a GetBucketStatisticsResponse object, this data is aggregated for all the buckets in the query results. If versioning is enabled for a bucket, storage size values are based on the size of the latest version of each applicable object in the bucket.</p>
|
|
@@ -516,17 +516,17 @@ export interface ObjectLevelStatistics {
|
|
|
516
516
|
* <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>
|
|
517
517
|
* @public
|
|
518
518
|
*/
|
|
519
|
-
fileType?: number;
|
|
519
|
+
fileType?: number | undefined;
|
|
520
520
|
/**
|
|
521
521
|
* <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>
|
|
522
522
|
* @public
|
|
523
523
|
*/
|
|
524
|
-
storageClass?: number;
|
|
524
|
+
storageClass?: number | undefined;
|
|
525
525
|
/**
|
|
526
526
|
* <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>
|
|
527
527
|
* @public
|
|
528
528
|
*/
|
|
529
|
-
total?: number;
|
|
529
|
+
total?: number | undefined;
|
|
530
530
|
}
|
|
531
531
|
/**
|
|
532
532
|
* <p>Provides statistical data and other information about an S3 bucket that Amazon Macie monitors and analyzes for your account. By default, object count and storage size values include data for object parts that are the result of incomplete multipart uploads. For more information, see <a href="https://docs.aws.amazon.com/macie/latest/user/monitoring-s3-how-it-works.html">How Macie monitors Amazon S3 data security</a> in the <i>Amazon Macie User Guide</i>.</p> <p>If an error occurs when Macie attempts to retrieve and process metadata from Amazon S3 for the bucket or the bucket's objects, the value for the versioning property is false and the value for most other properties is null. Key exceptions are accountId, bucketArn, bucketCreatedAt, bucketName, lastUpdated, and region. To identify the cause of the error, refer to the errorCode and errorMessage values.</p>
|
|
@@ -537,137 +537,137 @@ export interface BucketMetadata {
|
|
|
537
537
|
* <p>The unique identifier for the Amazon Web Services account that owns the bucket.</p>
|
|
538
538
|
* @public
|
|
539
539
|
*/
|
|
540
|
-
accountId?: string;
|
|
540
|
+
accountId?: string | undefined;
|
|
541
541
|
/**
|
|
542
542
|
* <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>
|
|
543
543
|
* @public
|
|
544
544
|
*/
|
|
545
|
-
allowsUnencryptedObjectUploads?: AllowsUnencryptedObjectUploads;
|
|
545
|
+
allowsUnencryptedObjectUploads?: AllowsUnencryptedObjectUploads | undefined;
|
|
546
546
|
/**
|
|
547
547
|
* <p>Specifies whether automated sensitive data discovery is currently configured to analyze objects in the bucket. Possible values are: MONITORED, the bucket is included in analyses; and, NOT_MONITORED, the bucket is excluded from analyses. If automated sensitive data discovery is disabled for your account, this value is NOT_MONITORED.</p>
|
|
548
548
|
* @public
|
|
549
549
|
*/
|
|
550
|
-
automatedDiscoveryMonitoringStatus?: AutomatedDiscoveryMonitoringStatus;
|
|
550
|
+
automatedDiscoveryMonitoringStatus?: AutomatedDiscoveryMonitoringStatus | undefined;
|
|
551
551
|
/**
|
|
552
552
|
* <p>The Amazon Resource Name (ARN) of the bucket.</p>
|
|
553
553
|
* @public
|
|
554
554
|
*/
|
|
555
|
-
bucketArn?: string;
|
|
555
|
+
bucketArn?: string | undefined;
|
|
556
556
|
/**
|
|
557
557
|
* <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>
|
|
558
558
|
* @public
|
|
559
559
|
*/
|
|
560
|
-
bucketCreatedAt?: Date;
|
|
560
|
+
bucketCreatedAt?: Date | undefined;
|
|
561
561
|
/**
|
|
562
562
|
* <p>The name of the bucket.</p>
|
|
563
563
|
* @public
|
|
564
564
|
*/
|
|
565
|
-
bucketName?: string;
|
|
565
|
+
bucketName?: string | undefined;
|
|
566
566
|
/**
|
|
567
567
|
* <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>
|
|
568
568
|
* @public
|
|
569
569
|
*/
|
|
570
|
-
classifiableObjectCount?: number;
|
|
570
|
+
classifiableObjectCount?: number | undefined;
|
|
571
571
|
/**
|
|
572
572
|
* <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>
|
|
573
573
|
* @public
|
|
574
574
|
*/
|
|
575
|
-
classifiableSizeInBytes?: number;
|
|
575
|
+
classifiableSizeInBytes?: number | undefined;
|
|
576
576
|
/**
|
|
577
577
|
* <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>
|
|
578
578
|
* @public
|
|
579
579
|
*/
|
|
580
|
-
errorCode?: BucketMetadataErrorCode;
|
|
580
|
+
errorCode?: BucketMetadataErrorCode | undefined;
|
|
581
581
|
/**
|
|
582
582
|
* <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>
|
|
583
583
|
* @public
|
|
584
584
|
*/
|
|
585
|
-
errorMessage?: string;
|
|
585
|
+
errorMessage?: string | undefined;
|
|
586
586
|
/**
|
|
587
587
|
* <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>
|
|
588
588
|
* @public
|
|
589
589
|
*/
|
|
590
|
-
jobDetails?: JobDetails;
|
|
590
|
+
jobDetails?: JobDetails | undefined;
|
|
591
591
|
/**
|
|
592
592
|
* <p>The date and time, in UTC and extended ISO 8601 format, when Amazon Macie most recently analyzed objects in the bucket while performing automated sensitive data discovery. This value is null if automated sensitive data discovery is disabled for your account.</p>
|
|
593
593
|
* @public
|
|
594
594
|
*/
|
|
595
|
-
lastAutomatedDiscoveryTime?: Date;
|
|
595
|
+
lastAutomatedDiscoveryTime?: Date | undefined;
|
|
596
596
|
/**
|
|
597
597
|
* <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>
|
|
598
598
|
* @public
|
|
599
599
|
*/
|
|
600
|
-
lastUpdated?: Date;
|
|
600
|
+
lastUpdated?: Date | undefined;
|
|
601
601
|
/**
|
|
602
602
|
* <p>The total number of objects in the bucket.</p>
|
|
603
603
|
* @public
|
|
604
604
|
*/
|
|
605
|
-
objectCount?: number;
|
|
605
|
+
objectCount?: number | undefined;
|
|
606
606
|
/**
|
|
607
607
|
* <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>
|
|
608
608
|
* @public
|
|
609
609
|
*/
|
|
610
|
-
objectCountByEncryptionType?: ObjectCountByEncryptionType;
|
|
610
|
+
objectCountByEncryptionType?: ObjectCountByEncryptionType | undefined;
|
|
611
611
|
/**
|
|
612
612
|
* <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>
|
|
613
613
|
* @public
|
|
614
614
|
*/
|
|
615
|
-
publicAccess?: BucketPublicAccess;
|
|
615
|
+
publicAccess?: BucketPublicAccess | undefined;
|
|
616
616
|
/**
|
|
617
617
|
* <p>The Amazon Web Services Region that hosts the bucket.</p>
|
|
618
618
|
* @public
|
|
619
619
|
*/
|
|
620
|
-
region?: string;
|
|
620
|
+
region?: string | undefined;
|
|
621
621
|
/**
|
|
622
622
|
* <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>
|
|
623
623
|
* @public
|
|
624
624
|
*/
|
|
625
|
-
replicationDetails?: ReplicationDetails;
|
|
625
|
+
replicationDetails?: ReplicationDetails | undefined;
|
|
626
626
|
/**
|
|
627
627
|
* <p>The sensitivity score for the bucket, ranging from -1 (classification error) to 100 (sensitive).</p><p>If automated sensitive data discovery has never been enabled for your account or it’s been disabled for your organization or your standalone account for more than 30 days, possible values are: 1, the bucket is empty; or, 50, the bucket stores objects but it’s been excluded from recent analyses.</p>
|
|
628
628
|
* @public
|
|
629
629
|
*/
|
|
630
|
-
sensitivityScore?: number;
|
|
630
|
+
sensitivityScore?: number | undefined;
|
|
631
631
|
/**
|
|
632
632
|
* <p>The default server-side encryption settings for the bucket.</p>
|
|
633
633
|
* @public
|
|
634
634
|
*/
|
|
635
|
-
serverSideEncryption?: BucketServerSideEncryption;
|
|
635
|
+
serverSideEncryption?: BucketServerSideEncryption | undefined;
|
|
636
636
|
/**
|
|
637
637
|
* <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>
|
|
638
638
|
* @public
|
|
639
639
|
*/
|
|
640
|
-
sharedAccess?: SharedAccess;
|
|
640
|
+
sharedAccess?: SharedAccess | undefined;
|
|
641
641
|
/**
|
|
642
642
|
* <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>
|
|
643
643
|
* @public
|
|
644
644
|
*/
|
|
645
|
-
sizeInBytes?: number;
|
|
645
|
+
sizeInBytes?: number | undefined;
|
|
646
646
|
/**
|
|
647
647
|
* <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>
|
|
648
648
|
* @public
|
|
649
649
|
*/
|
|
650
|
-
sizeInBytesCompressed?: number;
|
|
650
|
+
sizeInBytesCompressed?: number | undefined;
|
|
651
651
|
/**
|
|
652
652
|
* <p>An array that specifies the tags (keys and values) that are associated with the bucket.</p>
|
|
653
653
|
* @public
|
|
654
654
|
*/
|
|
655
|
-
tags?: KeyValuePair[];
|
|
655
|
+
tags?: KeyValuePair[] | undefined;
|
|
656
656
|
/**
|
|
657
657
|
* <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>
|
|
658
658
|
* @public
|
|
659
659
|
*/
|
|
660
|
-
unclassifiableObjectCount?: ObjectLevelStatistics;
|
|
660
|
+
unclassifiableObjectCount?: ObjectLevelStatistics | undefined;
|
|
661
661
|
/**
|
|
662
662
|
* <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>
|
|
663
663
|
* @public
|
|
664
664
|
*/
|
|
665
|
-
unclassifiableObjectSizeInBytes?: ObjectLevelStatistics;
|
|
665
|
+
unclassifiableObjectSizeInBytes?: ObjectLevelStatistics | undefined;
|
|
666
666
|
/**
|
|
667
667
|
* <p>Specifies whether versioning is enabled for the bucket.</p>
|
|
668
668
|
* @public
|
|
669
669
|
*/
|
|
670
|
-
versioning?: boolean;
|
|
670
|
+
versioning?: boolean | undefined;
|
|
671
671
|
}
|
|
672
672
|
/**
|
|
673
673
|
* <p>Provides information about the classification scope for an Amazon Macie account. Macie uses the scope's settings when it performs automated sensitive data discovery for the account.</p>
|
|
@@ -678,12 +678,12 @@ export interface ClassificationScopeSummary {
|
|
|
678
678
|
* <p>The unique identifier for the classification scope.</p>
|
|
679
679
|
* @public
|
|
680
680
|
*/
|
|
681
|
-
id?: string;
|
|
681
|
+
id?: string | undefined;
|
|
682
682
|
/**
|
|
683
683
|
* <p>The name of the classification scope: automated-sensitive-data-discovery.</p>
|
|
684
684
|
* @public
|
|
685
685
|
*/
|
|
686
|
-
name?: string;
|
|
686
|
+
name?: string | undefined;
|
|
687
687
|
}
|
|
688
688
|
/**
|
|
689
689
|
* @public
|
|
@@ -726,17 +726,17 @@ export interface SimpleCriterionForJob {
|
|
|
726
726
|
* <p>The operator to use in the condition. Valid values are EQ (equals) and NE (not equals).</p>
|
|
727
727
|
* @public
|
|
728
728
|
*/
|
|
729
|
-
comparator?: JobComparator;
|
|
729
|
+
comparator?: JobComparator | undefined;
|
|
730
730
|
/**
|
|
731
731
|
* <p>The property to use in the condition.</p>
|
|
732
732
|
* @public
|
|
733
733
|
*/
|
|
734
|
-
key?: SimpleCriterionKeyForJob;
|
|
734
|
+
key?: SimpleCriterionKeyForJob | undefined;
|
|
735
735
|
/**
|
|
736
736
|
* <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>
|
|
737
737
|
* @public
|
|
738
738
|
*/
|
|
739
|
-
values?: string[];
|
|
739
|
+
values?: string[] | undefined;
|
|
740
740
|
}
|
|
741
741
|
/**
|
|
742
742
|
* <p>Specifies a tag key, a tag value, or a tag key and value (as a pair) to use in a tag-based condition that determines whether an S3 bucket is included or excluded from a classification job. Tag keys and values are case sensitive. Also, Amazon Macie doesn't support use of partial values or wildcard characters in tag-based conditions.</p>
|
|
@@ -747,12 +747,12 @@ export interface TagCriterionPairForJob {
|
|
|
747
747
|
* <p>The value for the tag key to use in the condition.</p>
|
|
748
748
|
* @public
|
|
749
749
|
*/
|
|
750
|
-
key?: string;
|
|
750
|
+
key?: string | undefined;
|
|
751
751
|
/**
|
|
752
752
|
* <p>The tag value to use in the condition.</p>
|
|
753
753
|
* @public
|
|
754
754
|
*/
|
|
755
|
-
value?: string;
|
|
755
|
+
value?: string | undefined;
|
|
756
756
|
}
|
|
757
757
|
/**
|
|
758
758
|
* <p>Specifies a tag-based condition that determines whether an S3 bucket is included or excluded from a classification job.</p>
|
|
@@ -763,12 +763,12 @@ export interface TagCriterionForJob {
|
|
|
763
763
|
* <p>The operator to use in the condition. Valid values are EQ (equals) and NE (not equals).</p>
|
|
764
764
|
* @public
|
|
765
765
|
*/
|
|
766
|
-
comparator?: JobComparator;
|
|
766
|
+
comparator?: JobComparator | undefined;
|
|
767
767
|
/**
|
|
768
768
|
* <p>The tag keys, tag values, or tag key and value pairs to use in the condition.</p>
|
|
769
769
|
* @public
|
|
770
770
|
*/
|
|
771
|
-
tagValues?: TagCriterionPairForJob[];
|
|
771
|
+
tagValues?: TagCriterionPairForJob[] | undefined;
|
|
772
772
|
}
|
|
773
773
|
/**
|
|
774
774
|
* <p>Specifies a property- or tag-based condition that defines criteria for including or excluding S3 buckets from a classification job.</p>
|
|
@@ -779,12 +779,12 @@ export interface CriteriaForJob {
|
|
|
779
779
|
* <p>A property-based condition that defines a property, operator, and one or more values for including or excluding buckets from the job.</p>
|
|
780
780
|
* @public
|
|
781
781
|
*/
|
|
782
|
-
simpleCriterion?: SimpleCriterionForJob;
|
|
782
|
+
simpleCriterion?: SimpleCriterionForJob | undefined;
|
|
783
783
|
/**
|
|
784
784
|
* <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>
|
|
785
785
|
* @public
|
|
786
786
|
*/
|
|
787
|
-
tagCriterion?: TagCriterionForJob;
|
|
787
|
+
tagCriterion?: TagCriterionForJob | undefined;
|
|
788
788
|
}
|
|
789
789
|
/**
|
|
790
790
|
* <p>Provides information about a custom data identifier.</p>
|
|
@@ -795,27 +795,27 @@ export interface CustomDataIdentifierSummary {
|
|
|
795
795
|
* <p>The Amazon Resource Name (ARN) of the custom data identifier.</p>
|
|
796
796
|
* @public
|
|
797
797
|
*/
|
|
798
|
-
arn?: string;
|
|
798
|
+
arn?: string | undefined;
|
|
799
799
|
/**
|
|
800
800
|
* <p>The date and time, in UTC and extended ISO 8601 format, when the custom data identifier was created.</p>
|
|
801
801
|
* @public
|
|
802
802
|
*/
|
|
803
|
-
createdAt?: Date;
|
|
803
|
+
createdAt?: Date | undefined;
|
|
804
804
|
/**
|
|
805
805
|
* <p>The custom description of the custom data identifier.</p>
|
|
806
806
|
* @public
|
|
807
807
|
*/
|
|
808
|
-
description?: string;
|
|
808
|
+
description?: string | undefined;
|
|
809
809
|
/**
|
|
810
810
|
* <p>The unique identifier for the custom data identifier.</p>
|
|
811
811
|
* @public
|
|
812
812
|
*/
|
|
813
|
-
id?: string;
|
|
813
|
+
id?: string | undefined;
|
|
814
814
|
/**
|
|
815
815
|
* <p>The custom name of the custom data identifier.</p>
|
|
816
816
|
* @public
|
|
817
817
|
*/
|
|
818
|
-
name?: string;
|
|
818
|
+
name?: string | undefined;
|
|
819
819
|
}
|
|
820
820
|
/**
|
|
821
821
|
* <p>Specifies 1-10 occurrences of a specific type of sensitive data reported by a finding.</p>
|
|
@@ -849,32 +849,32 @@ export interface Detection {
|
|
|
849
849
|
* <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>
|
|
850
850
|
* @public
|
|
851
851
|
*/
|
|
852
|
-
arn?: string;
|
|
852
|
+
arn?: string | undefined;
|
|
853
853
|
/**
|
|
854
854
|
* <p>The total number of occurrences of the sensitive data.</p>
|
|
855
855
|
* @public
|
|
856
856
|
*/
|
|
857
|
-
count?: number;
|
|
857
|
+
count?: number | undefined;
|
|
858
858
|
/**
|
|
859
859
|
* <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>
|
|
860
860
|
* @public
|
|
861
861
|
*/
|
|
862
|
-
id?: string;
|
|
862
|
+
id?: string | undefined;
|
|
863
863
|
/**
|
|
864
864
|
* <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>
|
|
865
865
|
* @public
|
|
866
866
|
*/
|
|
867
|
-
name?: string;
|
|
867
|
+
name?: string | undefined;
|
|
868
868
|
/**
|
|
869
869
|
* <p>Specifies whether occurrences of this type of sensitive data are excluded (true) or included (false) in the bucket's sensitivity score.</p>
|
|
870
870
|
* @public
|
|
871
871
|
*/
|
|
872
|
-
suppressed?: boolean;
|
|
872
|
+
suppressed?: boolean | undefined;
|
|
873
873
|
/**
|
|
874
874
|
* <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>
|
|
875
875
|
* @public
|
|
876
876
|
*/
|
|
877
|
-
type?: DataIdentifierType;
|
|
877
|
+
type?: DataIdentifierType | undefined;
|
|
878
878
|
}
|
|
879
879
|
/**
|
|
880
880
|
* @public
|
|
@@ -909,22 +909,22 @@ export interface Cell {
|
|
|
909
909
|
* <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>
|
|
910
910
|
* @public
|
|
911
911
|
*/
|
|
912
|
-
cellReference?: string;
|
|
912
|
+
cellReference?: string | undefined;
|
|
913
913
|
/**
|
|
914
914
|
* <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>
|
|
915
915
|
* @public
|
|
916
916
|
*/
|
|
917
|
-
column?: number;
|
|
917
|
+
column?: number | undefined;
|
|
918
918
|
/**
|
|
919
919
|
* <p>The name of the column that contains the sensitive data, if available.</p>
|
|
920
920
|
* @public
|
|
921
921
|
*/
|
|
922
|
-
columnName?: string;
|
|
922
|
+
columnName?: string | undefined;
|
|
923
923
|
/**
|
|
924
924
|
* <p>The row number of the row that contains the sensitive data.</p>
|
|
925
925
|
* @public
|
|
926
926
|
*/
|
|
927
|
-
row?: number;
|
|
927
|
+
row?: number | undefined;
|
|
928
928
|
}
|
|
929
929
|
/**
|
|
930
930
|
* <p>Specifies the location of an occurrence of sensitive data in an email message or a non-binary text file such as an HTML, TXT, or XML file.</p>
|
|
@@ -935,17 +935,17 @@ export interface Range {
|
|
|
935
935
|
* <p>The number of lines from the beginning of the file to the end of the sensitive data.</p>
|
|
936
936
|
* @public
|
|
937
937
|
*/
|
|
938
|
-
end?: number;
|
|
938
|
+
end?: number | undefined;
|
|
939
939
|
/**
|
|
940
940
|
* <p>The number of lines from the beginning of the file to the beginning of the sensitive data.</p>
|
|
941
941
|
* @public
|
|
942
942
|
*/
|
|
943
|
-
start?: number;
|
|
943
|
+
start?: number | undefined;
|
|
944
944
|
/**
|
|
945
945
|
* <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>
|
|
946
946
|
* @public
|
|
947
947
|
*/
|
|
948
|
-
startColumn?: number;
|
|
948
|
+
startColumn?: number | undefined;
|
|
949
949
|
}
|
|
950
950
|
/**
|
|
951
951
|
* <p>Specifies the location of an occurrence of sensitive data in an Adobe Portable Document Format file.</p>
|
|
@@ -956,17 +956,17 @@ export interface Page {
|
|
|
956
956
|
* <p>Reserved for future use.</p>
|
|
957
957
|
* @public
|
|
958
958
|
*/
|
|
959
|
-
lineRange?: Range;
|
|
959
|
+
lineRange?: Range | undefined;
|
|
960
960
|
/**
|
|
961
961
|
* <p>Reserved for future use.</p>
|
|
962
962
|
* @public
|
|
963
963
|
*/
|
|
964
|
-
offsetRange?: Range;
|
|
964
|
+
offsetRange?: Range | undefined;
|
|
965
965
|
/**
|
|
966
966
|
* <p>The page number of the page that contains the sensitive data.</p>
|
|
967
967
|
* @public
|
|
968
968
|
*/
|
|
969
|
-
pageNumber?: number;
|
|
969
|
+
pageNumber?: number | undefined;
|
|
970
970
|
}
|
|
971
971
|
/**
|
|
972
972
|
* <p>Specifies the location of an occurrence of sensitive data in an Apache Avro object container, Apache Parquet file, JSON file, or JSON Lines file.</p>
|
|
@@ -977,12 +977,12 @@ export interface _Record {
|
|
|
977
977
|
* <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 240 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>
|
|
978
978
|
* @public
|
|
979
979
|
*/
|
|
980
|
-
jsonPath?: string;
|
|
980
|
+
jsonPath?: string | undefined;
|
|
981
981
|
/**
|
|
982
982
|
* <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>
|
|
983
983
|
* @public
|
|
984
984
|
*/
|
|
985
|
-
recordIndex?: number;
|
|
985
|
+
recordIndex?: number | undefined;
|
|
986
986
|
}
|
|
987
987
|
/**
|
|
988
988
|
* <p>Specifies the location of 1-15 occurrences of sensitive data that was detected by a managed data identifier or a custom data identifier and produced a sensitive data finding.</p>
|
|
@@ -993,27 +993,27 @@ export interface Occurrences {
|
|
|
993
993
|
* <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>
|
|
994
994
|
* @public
|
|
995
995
|
*/
|
|
996
|
-
cells?: Cell[];
|
|
996
|
+
cells?: Cell[] | undefined;
|
|
997
997
|
/**
|
|
998
998
|
* <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>
|
|
999
999
|
* @public
|
|
1000
1000
|
*/
|
|
1001
|
-
lineRanges?: Range[];
|
|
1001
|
+
lineRanges?: Range[] | undefined;
|
|
1002
1002
|
/**
|
|
1003
1003
|
* <p>Reserved for future use.</p>
|
|
1004
1004
|
* @public
|
|
1005
1005
|
*/
|
|
1006
|
-
offsetRanges?: Range[];
|
|
1006
|
+
offsetRanges?: Range[] | undefined;
|
|
1007
1007
|
/**
|
|
1008
1008
|
* <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>
|
|
1009
1009
|
* @public
|
|
1010
1010
|
*/
|
|
1011
|
-
pages?: Page[];
|
|
1011
|
+
pages?: Page[] | undefined;
|
|
1012
1012
|
/**
|
|
1013
1013
|
* <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>
|
|
1014
1014
|
* @public
|
|
1015
1015
|
*/
|
|
1016
|
-
records?: _Record[];
|
|
1016
|
+
records?: _Record[] | undefined;
|
|
1017
1017
|
}
|
|
1018
1018
|
/**
|
|
1019
1019
|
* <p>Provides information about a custom data identifier that produced a sensitive data finding, and the sensitive data that it detected for the finding.</p>
|
|
@@ -1024,22 +1024,22 @@ export interface CustomDetection {
|
|
|
1024
1024
|
* <p>The unique identifier for the custom data identifier.</p>
|
|
1025
1025
|
* @public
|
|
1026
1026
|
*/
|
|
1027
|
-
arn?: string;
|
|
1027
|
+
arn?: string | undefined;
|
|
1028
1028
|
/**
|
|
1029
1029
|
* <p>The total number of occurrences of the sensitive data that the custom data identifier detected.</p>
|
|
1030
1030
|
* @public
|
|
1031
1031
|
*/
|
|
1032
|
-
count?: number;
|
|
1032
|
+
count?: number | undefined;
|
|
1033
1033
|
/**
|
|
1034
1034
|
* <p>The name of the custom data identifier.</p>
|
|
1035
1035
|
* @public
|
|
1036
1036
|
*/
|
|
1037
|
-
name?: string;
|
|
1037
|
+
name?: string | undefined;
|
|
1038
1038
|
/**
|
|
1039
1039
|
* <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>
|
|
1040
1040
|
* @public
|
|
1041
1041
|
*/
|
|
1042
|
-
occurrences?: Occurrences;
|
|
1042
|
+
occurrences?: Occurrences | undefined;
|
|
1043
1043
|
}
|
|
1044
1044
|
/**
|
|
1045
1045
|
* <p>Provides information about custom data identifiers that produced a sensitive data finding, and the number of occurrences of the data that they detected for the finding.</p>
|
|
@@ -1050,12 +1050,12 @@ export interface CustomDataIdentifiers {
|
|
|
1050
1050
|
* <p>The custom data identifiers that detected the data, and the number of occurrences of the data that each identifier detected.</p>
|
|
1051
1051
|
* @public
|
|
1052
1052
|
*/
|
|
1053
|
-
detections?: CustomDetection[];
|
|
1053
|
+
detections?: CustomDetection[] | undefined;
|
|
1054
1054
|
/**
|
|
1055
1055
|
* <p>The total number of occurrences of the data that was detected by the custom data identifiers and produced the finding.</p>
|
|
1056
1056
|
* @public
|
|
1057
1057
|
*/
|
|
1058
|
-
totalCount?: number;
|
|
1058
|
+
totalCount?: number | undefined;
|
|
1059
1059
|
}
|
|
1060
1060
|
/**
|
|
1061
1061
|
* @public
|
|
@@ -1080,17 +1080,17 @@ export interface DefaultDetection {
|
|
|
1080
1080
|
* <p>The total number of occurrences of the type of sensitive data that was detected.</p>
|
|
1081
1081
|
* @public
|
|
1082
1082
|
*/
|
|
1083
|
-
count?: number;
|
|
1083
|
+
count?: number | undefined;
|
|
1084
1084
|
/**
|
|
1085
1085
|
* <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>
|
|
1086
1086
|
* @public
|
|
1087
1087
|
*/
|
|
1088
|
-
occurrences?: Occurrences;
|
|
1088
|
+
occurrences?: Occurrences | undefined;
|
|
1089
1089
|
/**
|
|
1090
1090
|
* <p>The type of sensitive data that was detected. For example, AWS_CREDENTIALS, PHONE_NUMBER, or ADDRESS.</p>
|
|
1091
1091
|
* @public
|
|
1092
1092
|
*/
|
|
1093
|
-
type?: string;
|
|
1093
|
+
type?: string | undefined;
|
|
1094
1094
|
}
|
|
1095
1095
|
/**
|
|
1096
1096
|
* <p>Provides information about the category, types, and occurrences of sensitive data that produced a sensitive data finding.</p>
|
|
@@ -1101,17 +1101,17 @@ export interface SensitiveDataItem {
|
|
|
1101
1101
|
* <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>
|
|
1102
1102
|
* @public
|
|
1103
1103
|
*/
|
|
1104
|
-
category?: SensitiveDataItemCategory;
|
|
1104
|
+
category?: SensitiveDataItemCategory | undefined;
|
|
1105
1105
|
/**
|
|
1106
1106
|
* <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>
|
|
1107
1107
|
* @public
|
|
1108
1108
|
*/
|
|
1109
|
-
detections?: DefaultDetection[];
|
|
1109
|
+
detections?: DefaultDetection[] | undefined;
|
|
1110
1110
|
/**
|
|
1111
1111
|
* <p>The total number of occurrences of the sensitive data that was detected.</p>
|
|
1112
1112
|
* @public
|
|
1113
1113
|
*/
|
|
1114
|
-
totalCount?: number;
|
|
1114
|
+
totalCount?: number | undefined;
|
|
1115
1115
|
}
|
|
1116
1116
|
/**
|
|
1117
1117
|
* <p>Provides information about the status of a sensitive data finding.</p>
|
|
@@ -1122,12 +1122,12 @@ export interface ClassificationResultStatus {
|
|
|
1122
1122
|
* <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>
|
|
1123
1123
|
* @public
|
|
1124
1124
|
*/
|
|
1125
|
-
code?: string;
|
|
1125
|
+
code?: string | undefined;
|
|
1126
1126
|
/**
|
|
1127
1127
|
* <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>
|
|
1128
1128
|
* @public
|
|
1129
1129
|
*/
|
|
1130
|
-
reason?: string;
|
|
1130
|
+
reason?: string | undefined;
|
|
1131
1131
|
}
|
|
1132
1132
|
/**
|
|
1133
1133
|
* <p>Provides the details of a sensitive data finding, including the types, number of occurrences, and locations of the sensitive data that was detected.</p>
|
|
@@ -1138,32 +1138,32 @@ export interface ClassificationResult {
|
|
|
1138
1138
|
* <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>
|
|
1139
1139
|
* @public
|
|
1140
1140
|
*/
|
|
1141
|
-
additionalOccurrences?: boolean;
|
|
1141
|
+
additionalOccurrences?: boolean | undefined;
|
|
1142
1142
|
/**
|
|
1143
1143
|
* <p>The custom data identifiers that detected the sensitive data and the number of occurrences of the data that they detected.</p>
|
|
1144
1144
|
* @public
|
|
1145
1145
|
*/
|
|
1146
|
-
customDataIdentifiers?: CustomDataIdentifiers;
|
|
1146
|
+
customDataIdentifiers?: CustomDataIdentifiers | undefined;
|
|
1147
1147
|
/**
|
|
1148
1148
|
* <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>
|
|
1149
1149
|
* @public
|
|
1150
1150
|
*/
|
|
1151
|
-
mimeType?: string;
|
|
1151
|
+
mimeType?: string | undefined;
|
|
1152
1152
|
/**
|
|
1153
1153
|
* <p>The category, types, and number of occurrences of the sensitive data that produced the finding.</p>
|
|
1154
1154
|
* @public
|
|
1155
1155
|
*/
|
|
1156
|
-
sensitiveData?: SensitiveDataItem[];
|
|
1156
|
+
sensitiveData?: SensitiveDataItem[] | undefined;
|
|
1157
1157
|
/**
|
|
1158
1158
|
* <p>The total size, in bytes, of the data that the finding applies to.</p>
|
|
1159
1159
|
* @public
|
|
1160
1160
|
*/
|
|
1161
|
-
sizeClassified?: number;
|
|
1161
|
+
sizeClassified?: number | undefined;
|
|
1162
1162
|
/**
|
|
1163
1163
|
* <p>The status of the finding.</p>
|
|
1164
1164
|
* @public
|
|
1165
1165
|
*/
|
|
1166
|
-
status?: ClassificationResultStatus;
|
|
1166
|
+
status?: ClassificationResultStatus | undefined;
|
|
1167
1167
|
}
|
|
1168
1168
|
/**
|
|
1169
1169
|
* <p>Provides information about a sensitive data finding and the details of the finding.</p>
|
|
@@ -1174,27 +1174,27 @@ export interface ClassificationDetails {
|
|
|
1174
1174
|
* <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>
|
|
1175
1175
|
* @public
|
|
1176
1176
|
*/
|
|
1177
|
-
detailedResultsLocation?: string;
|
|
1177
|
+
detailedResultsLocation?: string | undefined;
|
|
1178
1178
|
/**
|
|
1179
1179
|
* <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>
|
|
1180
1180
|
* @public
|
|
1181
1181
|
*/
|
|
1182
|
-
jobArn?: string;
|
|
1182
|
+
jobArn?: string | undefined;
|
|
1183
1183
|
/**
|
|
1184
1184
|
* <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>
|
|
1185
1185
|
* @public
|
|
1186
1186
|
*/
|
|
1187
|
-
jobId?: string;
|
|
1187
|
+
jobId?: string | undefined;
|
|
1188
1188
|
/**
|
|
1189
1189
|
* <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>
|
|
1190
1190
|
* @public
|
|
1191
1191
|
*/
|
|
1192
|
-
originType?: OriginType;
|
|
1192
|
+
originType?: OriginType | undefined;
|
|
1193
1193
|
/**
|
|
1194
1194
|
* <p>The status and other details of the finding.</p>
|
|
1195
1195
|
* @public
|
|
1196
1196
|
*/
|
|
1197
|
-
result?: ClassificationResult;
|
|
1197
|
+
result?: ClassificationResult | undefined;
|
|
1198
1198
|
}
|
|
1199
1199
|
/**
|
|
1200
1200
|
* @public
|
|
@@ -1216,22 +1216,22 @@ export interface ApiCallDetails {
|
|
|
1216
1216
|
* <p>The name of the operation that was invoked most recently and produced the finding.</p>
|
|
1217
1217
|
* @public
|
|
1218
1218
|
*/
|
|
1219
|
-
api?: string;
|
|
1219
|
+
api?: string | undefined;
|
|
1220
1220
|
/**
|
|
1221
1221
|
* <p>The URL of the Amazon Web Service that provides the operation, for example: s3.amazonaws.com.</p>
|
|
1222
1222
|
* @public
|
|
1223
1223
|
*/
|
|
1224
|
-
apiServiceName?: string;
|
|
1224
|
+
apiServiceName?: string | undefined;
|
|
1225
1225
|
/**
|
|
1226
1226
|
* <p>The first date and time, in UTC and extended ISO 8601 format, when any operation was invoked and produced the finding.</p>
|
|
1227
1227
|
* @public
|
|
1228
1228
|
*/
|
|
1229
|
-
firstSeen?: Date;
|
|
1229
|
+
firstSeen?: Date | undefined;
|
|
1230
1230
|
/**
|
|
1231
1231
|
* <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>
|
|
1232
1232
|
* @public
|
|
1233
1233
|
*/
|
|
1234
|
-
lastSeen?: Date;
|
|
1234
|
+
lastSeen?: Date | undefined;
|
|
1235
1235
|
}
|
|
1236
1236
|
/**
|
|
1237
1237
|
* <p>Provides information about an action that occurred for a resource and produced a policy finding.</p>
|
|
@@ -1242,12 +1242,12 @@ export interface FindingAction {
|
|
|
1242
1242
|
* <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>
|
|
1243
1243
|
* @public
|
|
1244
1244
|
*/
|
|
1245
|
-
actionType?: FindingActionType;
|
|
1245
|
+
actionType?: FindingActionType | undefined;
|
|
1246
1246
|
/**
|
|
1247
1247
|
* <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>
|
|
1248
1248
|
* @public
|
|
1249
1249
|
*/
|
|
1250
|
-
apiCallDetails?: ApiCallDetails;
|
|
1250
|
+
apiCallDetails?: ApiCallDetails | undefined;
|
|
1251
1251
|
}
|
|
1252
1252
|
/**
|
|
1253
1253
|
* <p>Provides information about the domain name of the device that an entity used to perform an action on an affected resource.</p>
|
|
@@ -1258,7 +1258,7 @@ export interface DomainDetails {
|
|
|
1258
1258
|
* <p>The name of the domain.</p>
|
|
1259
1259
|
* @public
|
|
1260
1260
|
*/
|
|
1261
|
-
domainName?: string;
|
|
1261
|
+
domainName?: string | undefined;
|
|
1262
1262
|
}
|
|
1263
1263
|
/**
|
|
1264
1264
|
* <p>Provides information about the city that an IP address originated from.</p>
|
|
@@ -1269,7 +1269,7 @@ export interface IpCity {
|
|
|
1269
1269
|
* <p>The name of the city.</p>
|
|
1270
1270
|
* @public
|
|
1271
1271
|
*/
|
|
1272
|
-
name?: string;
|
|
1272
|
+
name?: string | undefined;
|
|
1273
1273
|
}
|
|
1274
1274
|
/**
|
|
1275
1275
|
* <p>Provides information about the country that an IP address originated from.</p>
|
|
@@ -1280,12 +1280,12 @@ export interface IpCountry {
|
|
|
1280
1280
|
* <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>
|
|
1281
1281
|
* @public
|
|
1282
1282
|
*/
|
|
1283
|
-
code?: string;
|
|
1283
|
+
code?: string | undefined;
|
|
1284
1284
|
/**
|
|
1285
1285
|
* <p>The name of the country that the IP address originated from.</p>
|
|
1286
1286
|
* @public
|
|
1287
1287
|
*/
|
|
1288
|
-
name?: string;
|
|
1288
|
+
name?: string | undefined;
|
|
1289
1289
|
}
|
|
1290
1290
|
/**
|
|
1291
1291
|
* <p>Provides geographic coordinates that indicate where a specified IP address originated from.</p>
|
|
@@ -1296,12 +1296,12 @@ export interface IpGeoLocation {
|
|
|
1296
1296
|
* <p>The latitude coordinate of the location, rounded to four decimal places.</p>
|
|
1297
1297
|
* @public
|
|
1298
1298
|
*/
|
|
1299
|
-
lat?: number;
|
|
1299
|
+
lat?: number | undefined;
|
|
1300
1300
|
/**
|
|
1301
1301
|
* <p>The longitude coordinate of the location, rounded to four decimal places.</p>
|
|
1302
1302
|
* @public
|
|
1303
1303
|
*/
|
|
1304
|
-
lon?: number;
|
|
1304
|
+
lon?: number | undefined;
|
|
1305
1305
|
}
|
|
1306
1306
|
/**
|
|
1307
1307
|
* <p>Provides information about the registered owner of an IP address.</p>
|
|
@@ -1312,22 +1312,22 @@ export interface IpOwner {
|
|
|
1312
1312
|
* <p>The autonomous system number (ASN) for the autonomous system that included the IP address.</p>
|
|
1313
1313
|
* @public
|
|
1314
1314
|
*/
|
|
1315
|
-
asn?: string;
|
|
1315
|
+
asn?: string | undefined;
|
|
1316
1316
|
/**
|
|
1317
1317
|
* <p>The organization identifier that's associated with the autonomous system number (ASN) for the autonomous system that included the IP address.</p>
|
|
1318
1318
|
* @public
|
|
1319
1319
|
*/
|
|
1320
|
-
asnOrg?: string;
|
|
1320
|
+
asnOrg?: string | undefined;
|
|
1321
1321
|
/**
|
|
1322
1322
|
* <p>The name of the internet service provider (ISP) that owned the IP address.</p>
|
|
1323
1323
|
* @public
|
|
1324
1324
|
*/
|
|
1325
|
-
isp?: string;
|
|
1325
|
+
isp?: string | undefined;
|
|
1326
1326
|
/**
|
|
1327
1327
|
* <p>The name of the organization that owned the IP address.</p>
|
|
1328
1328
|
* @public
|
|
1329
1329
|
*/
|
|
1330
|
-
org?: string;
|
|
1330
|
+
org?: string | undefined;
|
|
1331
1331
|
}
|
|
1332
1332
|
/**
|
|
1333
1333
|
* <p>Provides information about the IP address of the device that an entity used to perform an action on an affected resource.</p>
|
|
@@ -1338,27 +1338,27 @@ export interface IpAddressDetails {
|
|
|
1338
1338
|
* <p>The Internet Protocol version 4 (IPv4) address of the device.</p>
|
|
1339
1339
|
* @public
|
|
1340
1340
|
*/
|
|
1341
|
-
ipAddressV4?: string;
|
|
1341
|
+
ipAddressV4?: string | undefined;
|
|
1342
1342
|
/**
|
|
1343
1343
|
* <p>The city that the IP address originated from.</p>
|
|
1344
1344
|
* @public
|
|
1345
1345
|
*/
|
|
1346
|
-
ipCity?: IpCity;
|
|
1346
|
+
ipCity?: IpCity | undefined;
|
|
1347
1347
|
/**
|
|
1348
1348
|
* <p>The country that the IP address originated from.</p>
|
|
1349
1349
|
* @public
|
|
1350
1350
|
*/
|
|
1351
|
-
ipCountry?: IpCountry;
|
|
1351
|
+
ipCountry?: IpCountry | undefined;
|
|
1352
1352
|
/**
|
|
1353
1353
|
* <p>The geographic coordinates of the location that the IP address originated from.</p>
|
|
1354
1354
|
* @public
|
|
1355
1355
|
*/
|
|
1356
|
-
ipGeoLocation?: IpGeoLocation;
|
|
1356
|
+
ipGeoLocation?: IpGeoLocation | undefined;
|
|
1357
1357
|
/**
|
|
1358
1358
|
* <p>The registered owner of the IP address.</p>
|
|
1359
1359
|
* @public
|
|
1360
1360
|
*/
|
|
1361
|
-
ipOwner?: IpOwner;
|
|
1361
|
+
ipOwner?: IpOwner | undefined;
|
|
1362
1362
|
}
|
|
1363
1363
|
/**
|
|
1364
1364
|
* <p>Provides information about the context in which temporary security credentials were issued to an entity.</p>
|
|
@@ -1369,12 +1369,12 @@ export interface SessionContextAttributes {
|
|
|
1369
1369
|
* <p>The date and time, in UTC and ISO 8601 format, when the credentials were issued.</p>
|
|
1370
1370
|
* @public
|
|
1371
1371
|
*/
|
|
1372
|
-
creationDate?: Date;
|
|
1372
|
+
creationDate?: Date | undefined;
|
|
1373
1373
|
/**
|
|
1374
1374
|
* <p>Specifies whether the credentials were authenticated with a multi-factor authentication (MFA) device.</p>
|
|
1375
1375
|
* @public
|
|
1376
1376
|
*/
|
|
1377
|
-
mfaAuthenticated?: boolean;
|
|
1377
|
+
mfaAuthenticated?: boolean | undefined;
|
|
1378
1378
|
}
|
|
1379
1379
|
/**
|
|
1380
1380
|
* <p>Provides information about the source and type of temporary security credentials that were issued to an entity.</p>
|
|
@@ -1385,27 +1385,27 @@ export interface SessionIssuer {
|
|
|
1385
1385
|
* <p>The unique identifier for the Amazon Web Services account that owns the entity that was used to get the credentials.</p>
|
|
1386
1386
|
* @public
|
|
1387
1387
|
*/
|
|
1388
|
-
accountId?: string;
|
|
1388
|
+
accountId?: string | undefined;
|
|
1389
1389
|
/**
|
|
1390
1390
|
* <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>
|
|
1391
1391
|
* @public
|
|
1392
1392
|
*/
|
|
1393
|
-
arn?: string;
|
|
1393
|
+
arn?: string | undefined;
|
|
1394
1394
|
/**
|
|
1395
1395
|
* <p>The unique identifier for the entity that was used to get the credentials.</p>
|
|
1396
1396
|
* @public
|
|
1397
1397
|
*/
|
|
1398
|
-
principalId?: string;
|
|
1398
|
+
principalId?: string | undefined;
|
|
1399
1399
|
/**
|
|
1400
1400
|
* <p>The source of the temporary security credentials, such as Root, IAMUser, or Role.</p>
|
|
1401
1401
|
* @public
|
|
1402
1402
|
*/
|
|
1403
|
-
type?: string;
|
|
1403
|
+
type?: string | undefined;
|
|
1404
1404
|
/**
|
|
1405
1405
|
* <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>
|
|
1406
1406
|
* @public
|
|
1407
1407
|
*/
|
|
1408
|
-
userName?: string;
|
|
1408
|
+
userName?: string | undefined;
|
|
1409
1409
|
}
|
|
1410
1410
|
/**
|
|
1411
1411
|
* <p>Provides information about a session that was created for an entity that performed an action by using temporary security credentials.</p>
|
|
@@ -1416,12 +1416,12 @@ export interface SessionContext {
|
|
|
1416
1416
|
* <p>The date and time when the credentials were issued, and whether the credentials were authenticated with a multi-factor authentication (MFA) device.</p>
|
|
1417
1417
|
* @public
|
|
1418
1418
|
*/
|
|
1419
|
-
attributes?: SessionContextAttributes;
|
|
1419
|
+
attributes?: SessionContextAttributes | undefined;
|
|
1420
1420
|
/**
|
|
1421
1421
|
* <p>The source and type of credentials that were issued to the entity.</p>
|
|
1422
1422
|
* @public
|
|
1423
1423
|
*/
|
|
1424
|
-
sessionIssuer?: SessionIssuer;
|
|
1424
|
+
sessionIssuer?: SessionIssuer | undefined;
|
|
1425
1425
|
}
|
|
1426
1426
|
/**
|
|
1427
1427
|
* <p>Provides information about an identity that performed an action on an affected resource by using temporary security credentials. The credentials were obtained using the AssumeRole operation of the Security Token Service (STS) API.</p>
|
|
@@ -1432,27 +1432,27 @@ export interface AssumedRole {
|
|
|
1432
1432
|
* <p>The Amazon Web Services access key ID that identifies the credentials.</p>
|
|
1433
1433
|
* @public
|
|
1434
1434
|
*/
|
|
1435
|
-
accessKeyId?: string;
|
|
1435
|
+
accessKeyId?: string | undefined;
|
|
1436
1436
|
/**
|
|
1437
1437
|
* <p>The unique identifier for the Amazon Web Services account that owns the entity that was used to get the credentials.</p>
|
|
1438
1438
|
* @public
|
|
1439
1439
|
*/
|
|
1440
|
-
accountId?: string;
|
|
1440
|
+
accountId?: string | undefined;
|
|
1441
1441
|
/**
|
|
1442
1442
|
* <p>The Amazon Resource Name (ARN) of the entity that was used to get the credentials.</p>
|
|
1443
1443
|
* @public
|
|
1444
1444
|
*/
|
|
1445
|
-
arn?: string;
|
|
1445
|
+
arn?: string | undefined;
|
|
1446
1446
|
/**
|
|
1447
1447
|
* <p>The unique identifier for the entity that was used to get the credentials.</p>
|
|
1448
1448
|
* @public
|
|
1449
1449
|
*/
|
|
1450
|
-
principalId?: string;
|
|
1450
|
+
principalId?: string | undefined;
|
|
1451
1451
|
/**
|
|
1452
1452
|
* <p>The details of the session that was created for the credentials, including the entity that issued the session.</p>
|
|
1453
1453
|
* @public
|
|
1454
1454
|
*/
|
|
1455
|
-
sessionContext?: SessionContext;
|
|
1455
|
+
sessionContext?: SessionContext | undefined;
|
|
1456
1456
|
}
|
|
1457
1457
|
/**
|
|
1458
1458
|
* <p>Provides information about an Amazon Web Services account and entity that performed an action on an affected resource. The action was performed using the credentials for an Amazon Web Services account other than your own account.</p>
|
|
@@ -1463,12 +1463,12 @@ export interface AwsAccount {
|
|
|
1463
1463
|
* <p>The unique identifier for the Amazon Web Services account.</p>
|
|
1464
1464
|
* @public
|
|
1465
1465
|
*/
|
|
1466
|
-
accountId?: string;
|
|
1466
|
+
accountId?: string | undefined;
|
|
1467
1467
|
/**
|
|
1468
1468
|
* <p>The unique identifier for the entity that performed the action.</p>
|
|
1469
1469
|
* @public
|
|
1470
1470
|
*/
|
|
1471
|
-
principalId?: string;
|
|
1471
|
+
principalId?: string | undefined;
|
|
1472
1472
|
}
|
|
1473
1473
|
/**
|
|
1474
1474
|
* <p>Provides information about an Amazon Web Service that performed an action on an affected resource.</p>
|
|
@@ -1479,7 +1479,7 @@ export interface AwsService {
|
|
|
1479
1479
|
* <p>The name of the Amazon Web Service that performed the action.</p>
|
|
1480
1480
|
* @public
|
|
1481
1481
|
*/
|
|
1482
|
-
invokedBy?: string;
|
|
1482
|
+
invokedBy?: string | undefined;
|
|
1483
1483
|
}
|
|
1484
1484
|
/**
|
|
1485
1485
|
* <p>Provides information about an identity that performed an action on an affected resource by using temporary security credentials. The credentials were obtained using the GetFederationToken operation of the Security Token Service (STS) API.</p>
|
|
@@ -1490,27 +1490,27 @@ export interface FederatedUser {
|
|
|
1490
1490
|
* <p>The Amazon Web Services access key ID that identifies the credentials.</p>
|
|
1491
1491
|
* @public
|
|
1492
1492
|
*/
|
|
1493
|
-
accessKeyId?: string;
|
|
1493
|
+
accessKeyId?: string | undefined;
|
|
1494
1494
|
/**
|
|
1495
1495
|
* <p>The unique identifier for the Amazon Web Services account that owns the entity that was used to get the credentials.</p>
|
|
1496
1496
|
* @public
|
|
1497
1497
|
*/
|
|
1498
|
-
accountId?: string;
|
|
1498
|
+
accountId?: string | undefined;
|
|
1499
1499
|
/**
|
|
1500
1500
|
* <p>The Amazon Resource Name (ARN) of the entity that was used to get the credentials.</p>
|
|
1501
1501
|
* @public
|
|
1502
1502
|
*/
|
|
1503
|
-
arn?: string;
|
|
1503
|
+
arn?: string | undefined;
|
|
1504
1504
|
/**
|
|
1505
1505
|
* <p>The unique identifier for the entity that was used to get the credentials.</p>
|
|
1506
1506
|
* @public
|
|
1507
1507
|
*/
|
|
1508
|
-
principalId?: string;
|
|
1508
|
+
principalId?: string | undefined;
|
|
1509
1509
|
/**
|
|
1510
1510
|
* <p>The details of the session that was created for the credentials, including the entity that issued the session.</p>
|
|
1511
1511
|
* @public
|
|
1512
1512
|
*/
|
|
1513
|
-
sessionContext?: SessionContext;
|
|
1513
|
+
sessionContext?: SessionContext | undefined;
|
|
1514
1514
|
}
|
|
1515
1515
|
/**
|
|
1516
1516
|
* <p>Provides information about an Identity and Access Management (IAM) user who performed an action on an affected resource.</p>
|
|
@@ -1521,22 +1521,22 @@ export interface IamUser {
|
|
|
1521
1521
|
* <p>The unique identifier for the Amazon Web Services account that's associated with the IAM user who performed the action.</p>
|
|
1522
1522
|
* @public
|
|
1523
1523
|
*/
|
|
1524
|
-
accountId?: string;
|
|
1524
|
+
accountId?: string | undefined;
|
|
1525
1525
|
/**
|
|
1526
1526
|
* <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>
|
|
1527
1527
|
* @public
|
|
1528
1528
|
*/
|
|
1529
|
-
arn?: string;
|
|
1529
|
+
arn?: string | undefined;
|
|
1530
1530
|
/**
|
|
1531
1531
|
* <p>The unique identifier for the IAM user who performed the action.</p>
|
|
1532
1532
|
* @public
|
|
1533
1533
|
*/
|
|
1534
|
-
principalId?: string;
|
|
1534
|
+
principalId?: string | undefined;
|
|
1535
1535
|
/**
|
|
1536
1536
|
* <p>The username of the IAM user who performed the action.</p>
|
|
1537
1537
|
* @public
|
|
1538
1538
|
*/
|
|
1539
|
-
userName?: string;
|
|
1539
|
+
userName?: string | undefined;
|
|
1540
1540
|
}
|
|
1541
1541
|
/**
|
|
1542
1542
|
* <p>Provides information about an Amazon Web Services account and entity that performed an action on an affected resource. The action was performed using the credentials for your Amazon Web Services account.</p>
|
|
@@ -1547,17 +1547,17 @@ export interface UserIdentityRoot {
|
|
|
1547
1547
|
* <p>The unique identifier for the Amazon Web Services account.</p>
|
|
1548
1548
|
* @public
|
|
1549
1549
|
*/
|
|
1550
|
-
accountId?: string;
|
|
1550
|
+
accountId?: string | undefined;
|
|
1551
1551
|
/**
|
|
1552
1552
|
* <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>
|
|
1553
1553
|
* @public
|
|
1554
1554
|
*/
|
|
1555
|
-
arn?: string;
|
|
1555
|
+
arn?: string | undefined;
|
|
1556
1556
|
/**
|
|
1557
1557
|
* <p>The unique identifier for the entity that performed the action.</p>
|
|
1558
1558
|
* @public
|
|
1559
1559
|
*/
|
|
1560
|
-
principalId?: string;
|
|
1560
|
+
principalId?: string | undefined;
|
|
1561
1561
|
}
|
|
1562
1562
|
/**
|
|
1563
1563
|
* @public
|
|
@@ -1584,37 +1584,37 @@ export interface UserIdentity {
|
|
|
1584
1584
|
* <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>
|
|
1585
1585
|
* @public
|
|
1586
1586
|
*/
|
|
1587
|
-
assumedRole?: AssumedRole;
|
|
1587
|
+
assumedRole?: AssumedRole | undefined;
|
|
1588
1588
|
/**
|
|
1589
1589
|
* <p>If the action was performed using the credentials for another Amazon Web Services account, the details of that account.</p>
|
|
1590
1590
|
* @public
|
|
1591
1591
|
*/
|
|
1592
|
-
awsAccount?: AwsAccount;
|
|
1592
|
+
awsAccount?: AwsAccount | undefined;
|
|
1593
1593
|
/**
|
|
1594
1594
|
* <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>
|
|
1595
1595
|
* @public
|
|
1596
1596
|
*/
|
|
1597
|
-
awsService?: AwsService;
|
|
1597
|
+
awsService?: AwsService | undefined;
|
|
1598
1598
|
/**
|
|
1599
1599
|
* <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>
|
|
1600
1600
|
* @public
|
|
1601
1601
|
*/
|
|
1602
|
-
federatedUser?: FederatedUser;
|
|
1602
|
+
federatedUser?: FederatedUser | undefined;
|
|
1603
1603
|
/**
|
|
1604
1604
|
* <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>
|
|
1605
1605
|
* @public
|
|
1606
1606
|
*/
|
|
1607
|
-
iamUser?: IamUser;
|
|
1607
|
+
iamUser?: IamUser | undefined;
|
|
1608
1608
|
/**
|
|
1609
1609
|
* <p>If the action was performed using the credentials for your Amazon Web Services account, the details of your account.</p>
|
|
1610
1610
|
* @public
|
|
1611
1611
|
*/
|
|
1612
|
-
root?: UserIdentityRoot;
|
|
1612
|
+
root?: UserIdentityRoot | undefined;
|
|
1613
1613
|
/**
|
|
1614
1614
|
* <p>The type of entity that performed the action.</p>
|
|
1615
1615
|
* @public
|
|
1616
1616
|
*/
|
|
1617
|
-
type?: UserIdentityType;
|
|
1617
|
+
type?: UserIdentityType | undefined;
|
|
1618
1618
|
}
|
|
1619
1619
|
/**
|
|
1620
1620
|
* <p>Provides information about an entity that performed an action that produced a policy finding for a resource.</p>
|
|
@@ -1625,17 +1625,17 @@ export interface FindingActor {
|
|
|
1625
1625
|
* <p>The domain name of the device that the entity used to perform the action on the affected resource.</p>
|
|
1626
1626
|
* @public
|
|
1627
1627
|
*/
|
|
1628
|
-
domainDetails?: DomainDetails;
|
|
1628
|
+
domainDetails?: DomainDetails | undefined;
|
|
1629
1629
|
/**
|
|
1630
1630
|
* <p>The IP address and related details about the device that the entity used to perform the action on the affected resource. The details can include information such as the owner and geographic location of the IP address.</p>
|
|
1631
1631
|
* @public
|
|
1632
1632
|
*/
|
|
1633
|
-
ipAddressDetails?: IpAddressDetails;
|
|
1633
|
+
ipAddressDetails?: IpAddressDetails | undefined;
|
|
1634
1634
|
/**
|
|
1635
1635
|
* <p>The type and other characteristics of the entity that performed the action on the affected resource. This value is null if the action was performed by an anonymous (unauthenticated) entity.</p>
|
|
1636
1636
|
* @public
|
|
1637
1637
|
*/
|
|
1638
|
-
userIdentity?: UserIdentity;
|
|
1638
|
+
userIdentity?: UserIdentity | undefined;
|
|
1639
1639
|
}
|
|
1640
1640
|
/**
|
|
1641
1641
|
* <p>Provides the details of a policy finding.</p>
|
|
@@ -1646,12 +1646,12 @@ export interface PolicyDetails {
|
|
|
1646
1646
|
* <p>The action that produced the finding.</p>
|
|
1647
1647
|
* @public
|
|
1648
1648
|
*/
|
|
1649
|
-
action?: FindingAction;
|
|
1649
|
+
action?: FindingAction | undefined;
|
|
1650
1650
|
/**
|
|
1651
1651
|
* <p>The entity that performed the action that produced the finding.</p>
|
|
1652
1652
|
* @public
|
|
1653
1653
|
*/
|
|
1654
|
-
actor?: FindingActor;
|
|
1654
|
+
actor?: FindingActor | undefined;
|
|
1655
1655
|
}
|
|
1656
1656
|
/**
|
|
1657
1657
|
* @public
|
|
@@ -1677,12 +1677,12 @@ export interface ServerSideEncryption {
|
|
|
1677
1677
|
* <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>
|
|
1678
1678
|
* @public
|
|
1679
1679
|
*/
|
|
1680
|
-
encryptionType?: EncryptionType;
|
|
1680
|
+
encryptionType?: EncryptionType | undefined;
|
|
1681
1681
|
/**
|
|
1682
1682
|
* <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>
|
|
1683
1683
|
* @public
|
|
1684
1684
|
*/
|
|
1685
|
-
kmsMasterKeyId?: string;
|
|
1685
|
+
kmsMasterKeyId?: string | undefined;
|
|
1686
1686
|
}
|
|
1687
1687
|
/**
|
|
1688
1688
|
* <p>Provides information about the Amazon Web Services account that owns an S3 bucket.</p>
|
|
@@ -1693,12 +1693,12 @@ export interface S3BucketOwner {
|
|
|
1693
1693
|
* <p>The display name of the account that owns the bucket.</p>
|
|
1694
1694
|
* @public
|
|
1695
1695
|
*/
|
|
1696
|
-
displayName?: string;
|
|
1696
|
+
displayName?: string | undefined;
|
|
1697
1697
|
/**
|
|
1698
1698
|
* <p>The canonical user ID for the account that owns the bucket.</p>
|
|
1699
1699
|
* @public
|
|
1700
1700
|
*/
|
|
1701
|
-
id?: string;
|
|
1701
|
+
id?: string | undefined;
|
|
1702
1702
|
}
|
|
1703
1703
|
/**
|
|
1704
1704
|
* <p>Provides information about the S3 bucket that a finding applies to.</p>
|
|
@@ -1709,42 +1709,42 @@ export interface S3Bucket {
|
|
|
1709
1709
|
* <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>
|
|
1710
1710
|
* @public
|
|
1711
1711
|
*/
|
|
1712
|
-
allowsUnencryptedObjectUploads?: AllowsUnencryptedObjectUploads;
|
|
1712
|
+
allowsUnencryptedObjectUploads?: AllowsUnencryptedObjectUploads | undefined;
|
|
1713
1713
|
/**
|
|
1714
1714
|
* <p>The Amazon Resource Name (ARN) of the bucket.</p>
|
|
1715
1715
|
* @public
|
|
1716
1716
|
*/
|
|
1717
|
-
arn?: string;
|
|
1717
|
+
arn?: string | undefined;
|
|
1718
1718
|
/**
|
|
1719
1719
|
* <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>
|
|
1720
1720
|
* @public
|
|
1721
1721
|
*/
|
|
1722
|
-
createdAt?: Date;
|
|
1722
|
+
createdAt?: Date | undefined;
|
|
1723
1723
|
/**
|
|
1724
1724
|
* <p>The default server-side encryption settings for the bucket.</p>
|
|
1725
1725
|
* @public
|
|
1726
1726
|
*/
|
|
1727
|
-
defaultServerSideEncryption?: ServerSideEncryption;
|
|
1727
|
+
defaultServerSideEncryption?: ServerSideEncryption | undefined;
|
|
1728
1728
|
/**
|
|
1729
1729
|
* <p>The name of the bucket.</p>
|
|
1730
1730
|
* @public
|
|
1731
1731
|
*/
|
|
1732
|
-
name?: string;
|
|
1732
|
+
name?: string | undefined;
|
|
1733
1733
|
/**
|
|
1734
1734
|
* <p>The display name and canonical user ID for the Amazon Web Services account that owns the bucket.</p>
|
|
1735
1735
|
* @public
|
|
1736
1736
|
*/
|
|
1737
|
-
owner?: S3BucketOwner;
|
|
1737
|
+
owner?: S3BucketOwner | undefined;
|
|
1738
1738
|
/**
|
|
1739
1739
|
* <p>The permissions settings that determine whether the bucket is publicly accessible.</p>
|
|
1740
1740
|
* @public
|
|
1741
1741
|
*/
|
|
1742
|
-
publicAccess?: BucketPublicAccess;
|
|
1742
|
+
publicAccess?: BucketPublicAccess | undefined;
|
|
1743
1743
|
/**
|
|
1744
1744
|
* <p>The tags that are associated with the bucket.</p>
|
|
1745
1745
|
* @public
|
|
1746
1746
|
*/
|
|
1747
|
-
tags?: KeyValuePair[];
|
|
1747
|
+
tags?: KeyValuePair[] | undefined;
|
|
1748
1748
|
}
|
|
1749
1749
|
/**
|
|
1750
1750
|
* @public
|
|
@@ -1774,62 +1774,62 @@ export interface S3Object {
|
|
|
1774
1774
|
* <p>The Amazon Resource Name (ARN) of the bucket that contains the object.</p>
|
|
1775
1775
|
* @public
|
|
1776
1776
|
*/
|
|
1777
|
-
bucketArn?: string;
|
|
1777
|
+
bucketArn?: string | undefined;
|
|
1778
1778
|
/**
|
|
1779
1779
|
* <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>
|
|
1780
1780
|
* @public
|
|
1781
1781
|
*/
|
|
1782
|
-
eTag?: string;
|
|
1782
|
+
eTag?: string | undefined;
|
|
1783
1783
|
/**
|
|
1784
1784
|
* <p>The file name extension of the object. If the object doesn't have a file name extension, this value is "".</p>
|
|
1785
1785
|
* @public
|
|
1786
1786
|
*/
|
|
1787
|
-
extension?: string;
|
|
1787
|
+
extension?: string | undefined;
|
|
1788
1788
|
/**
|
|
1789
1789
|
* <p>The full name (<i>key</i>) of the object, including the object's prefix if applicable.</p>
|
|
1790
1790
|
* @public
|
|
1791
1791
|
*/
|
|
1792
|
-
key?: string;
|
|
1792
|
+
key?: string | undefined;
|
|
1793
1793
|
/**
|
|
1794
1794
|
* <p>The date and time, in UTC and extended ISO 8601 format, when the object was last modified.</p>
|
|
1795
1795
|
* @public
|
|
1796
1796
|
*/
|
|
1797
|
-
lastModified?: Date;
|
|
1797
|
+
lastModified?: Date | undefined;
|
|
1798
1798
|
/**
|
|
1799
1799
|
* <p>The full path to the affected object, including the name of the affected bucket and the object's name (key).</p>
|
|
1800
1800
|
* @public
|
|
1801
1801
|
*/
|
|
1802
|
-
path?: string;
|
|
1802
|
+
path?: string | undefined;
|
|
1803
1803
|
/**
|
|
1804
1804
|
* <p>Specifies whether the object is publicly accessible due to the combination of permissions settings that apply to the object.</p>
|
|
1805
1805
|
* @public
|
|
1806
1806
|
*/
|
|
1807
|
-
publicAccess?: boolean;
|
|
1807
|
+
publicAccess?: boolean | undefined;
|
|
1808
1808
|
/**
|
|
1809
1809
|
* <p>The type of server-side encryption that was used to encrypt the object.</p>
|
|
1810
1810
|
* @public
|
|
1811
1811
|
*/
|
|
1812
|
-
serverSideEncryption?: ServerSideEncryption;
|
|
1812
|
+
serverSideEncryption?: ServerSideEncryption | undefined;
|
|
1813
1813
|
/**
|
|
1814
1814
|
* <p>The total storage size, in bytes, of the object.</p>
|
|
1815
1815
|
* @public
|
|
1816
1816
|
*/
|
|
1817
|
-
size?: number;
|
|
1817
|
+
size?: number | undefined;
|
|
1818
1818
|
/**
|
|
1819
1819
|
* <p>The storage class of the object.</p>
|
|
1820
1820
|
* @public
|
|
1821
1821
|
*/
|
|
1822
|
-
storageClass?: StorageClass;
|
|
1822
|
+
storageClass?: StorageClass | undefined;
|
|
1823
1823
|
/**
|
|
1824
1824
|
* <p>The tags that are associated with the object.</p>
|
|
1825
1825
|
* @public
|
|
1826
1826
|
*/
|
|
1827
|
-
tags?: KeyValuePair[];
|
|
1827
|
+
tags?: KeyValuePair[] | undefined;
|
|
1828
1828
|
/**
|
|
1829
1829
|
* <p>The identifier for the affected version of the object.</p>
|
|
1830
1830
|
* @public
|
|
1831
1831
|
*/
|
|
1832
|
-
versionId?: string;
|
|
1832
|
+
versionId?: string | undefined;
|
|
1833
1833
|
}
|
|
1834
1834
|
/**
|
|
1835
1835
|
* <p>Provides information about the resources that a finding applies to.</p>
|
|
@@ -1840,12 +1840,12 @@ export interface ResourcesAffected {
|
|
|
1840
1840
|
* <p>The details of the S3 bucket that the finding applies to.</p>
|
|
1841
1841
|
* @public
|
|
1842
1842
|
*/
|
|
1843
|
-
s3Bucket?: S3Bucket;
|
|
1843
|
+
s3Bucket?: S3Bucket | undefined;
|
|
1844
1844
|
/**
|
|
1845
1845
|
* <p>The details of the S3 object that the finding applies to.</p>
|
|
1846
1846
|
* @public
|
|
1847
1847
|
*/
|
|
1848
|
-
s3Object?: S3Object;
|
|
1848
|
+
s3Object?: S3Object | undefined;
|
|
1849
1849
|
}
|
|
1850
1850
|
/**
|
|
1851
1851
|
* @public
|
|
@@ -1869,12 +1869,12 @@ export interface Severity {
|
|
|
1869
1869
|
* <p>The qualitative representation of the finding's severity, ranging from Low (least severe) to High (most severe).</p>
|
|
1870
1870
|
* @public
|
|
1871
1871
|
*/
|
|
1872
|
-
description?: SeverityDescription;
|
|
1872
|
+
description?: SeverityDescription | undefined;
|
|
1873
1873
|
/**
|
|
1874
1874
|
* <p>The numerical representation of the finding's severity, ranging from 1 (least severe) to 3 (most severe).</p>
|
|
1875
1875
|
* @public
|
|
1876
1876
|
*/
|
|
1877
|
-
score?: number;
|
|
1877
|
+
score?: number | undefined;
|
|
1878
1878
|
}
|
|
1879
1879
|
/**
|
|
1880
1880
|
* @public
|
|
@@ -1906,92 +1906,92 @@ export interface Finding {
|
|
|
1906
1906
|
* <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>
|
|
1907
1907
|
* @public
|
|
1908
1908
|
*/
|
|
1909
|
-
accountId?: string;
|
|
1909
|
+
accountId?: string | undefined;
|
|
1910
1910
|
/**
|
|
1911
1911
|
* <p>Specifies whether the finding is archived (suppressed).</p>
|
|
1912
1912
|
* @public
|
|
1913
1913
|
*/
|
|
1914
|
-
archived?: boolean;
|
|
1914
|
+
archived?: boolean | undefined;
|
|
1915
1915
|
/**
|
|
1916
1916
|
* <p>The category of the finding. Possible values are: CLASSIFICATION, for a sensitive data finding; and, POLICY, for a policy finding.</p>
|
|
1917
1917
|
* @public
|
|
1918
1918
|
*/
|
|
1919
|
-
category?: FindingCategory;
|
|
1919
|
+
category?: FindingCategory | undefined;
|
|
1920
1920
|
/**
|
|
1921
1921
|
* <p>The details of a sensitive data finding. This value is null for a policy finding.</p>
|
|
1922
1922
|
* @public
|
|
1923
1923
|
*/
|
|
1924
|
-
classificationDetails?: ClassificationDetails;
|
|
1924
|
+
classificationDetails?: ClassificationDetails | undefined;
|
|
1925
1925
|
/**
|
|
1926
1926
|
* <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>
|
|
1927
1927
|
* @public
|
|
1928
1928
|
*/
|
|
1929
|
-
count?: number;
|
|
1929
|
+
count?: number | undefined;
|
|
1930
1930
|
/**
|
|
1931
1931
|
* <p>The date and time, in UTC and extended ISO 8601 format, when Amazon Macie created the finding.</p>
|
|
1932
1932
|
* @public
|
|
1933
1933
|
*/
|
|
1934
|
-
createdAt?: Date;
|
|
1934
|
+
createdAt?: Date | undefined;
|
|
1935
1935
|
/**
|
|
1936
1936
|
* <p>The description of the finding.</p>
|
|
1937
1937
|
* @public
|
|
1938
1938
|
*/
|
|
1939
|
-
description?: string;
|
|
1939
|
+
description?: string | undefined;
|
|
1940
1940
|
/**
|
|
1941
1941
|
* <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>
|
|
1942
1942
|
* @public
|
|
1943
1943
|
*/
|
|
1944
|
-
id?: string;
|
|
1944
|
+
id?: string | undefined;
|
|
1945
1945
|
/**
|
|
1946
1946
|
* <p>The Amazon Web Services partition that Amazon Macie created the finding in.</p>
|
|
1947
1947
|
* @public
|
|
1948
1948
|
*/
|
|
1949
|
-
partition?: string;
|
|
1949
|
+
partition?: string | undefined;
|
|
1950
1950
|
/**
|
|
1951
1951
|
* <p>The details of a policy finding. This value is null for a sensitive data finding.</p>
|
|
1952
1952
|
* @public
|
|
1953
1953
|
*/
|
|
1954
|
-
policyDetails?: PolicyDetails;
|
|
1954
|
+
policyDetails?: PolicyDetails | undefined;
|
|
1955
1955
|
/**
|
|
1956
1956
|
* <p>The Amazon Web Services Region that Amazon Macie created the finding in.</p>
|
|
1957
1957
|
* @public
|
|
1958
1958
|
*/
|
|
1959
|
-
region?: string;
|
|
1959
|
+
region?: string | undefined;
|
|
1960
1960
|
/**
|
|
1961
1961
|
* <p>The resources that the finding applies to.</p>
|
|
1962
1962
|
* @public
|
|
1963
1963
|
*/
|
|
1964
|
-
resourcesAffected?: ResourcesAffected;
|
|
1964
|
+
resourcesAffected?: ResourcesAffected | undefined;
|
|
1965
1965
|
/**
|
|
1966
1966
|
* <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>
|
|
1967
1967
|
* @public
|
|
1968
1968
|
*/
|
|
1969
|
-
sample?: boolean;
|
|
1969
|
+
sample?: boolean | undefined;
|
|
1970
1970
|
/**
|
|
1971
1971
|
* <p>The version of the schema that was used to define the data structures in the finding.</p>
|
|
1972
1972
|
* @public
|
|
1973
1973
|
*/
|
|
1974
|
-
schemaVersion?: string;
|
|
1974
|
+
schemaVersion?: string | undefined;
|
|
1975
1975
|
/**
|
|
1976
1976
|
* <p>The severity level and score for the finding.</p>
|
|
1977
1977
|
* @public
|
|
1978
1978
|
*/
|
|
1979
|
-
severity?: Severity;
|
|
1979
|
+
severity?: Severity | undefined;
|
|
1980
1980
|
/**
|
|
1981
1981
|
* <p>The brief description of the finding.</p>
|
|
1982
1982
|
* @public
|
|
1983
1983
|
*/
|
|
1984
|
-
title?: string;
|
|
1984
|
+
title?: string | undefined;
|
|
1985
1985
|
/**
|
|
1986
1986
|
* <p>The type of the finding.</p>
|
|
1987
1987
|
* @public
|
|
1988
1988
|
*/
|
|
1989
|
-
type?: FindingType;
|
|
1989
|
+
type?: FindingType | undefined;
|
|
1990
1990
|
/**
|
|
1991
1991
|
* <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>
|
|
1992
1992
|
* @public
|
|
1993
1993
|
*/
|
|
1994
|
-
updatedAt?: Date;
|
|
1994
|
+
updatedAt?: Date | undefined;
|
|
1995
1995
|
}
|
|
1996
1996
|
/**
|
|
1997
1997
|
* @public
|
|
@@ -2014,27 +2014,27 @@ export interface FindingsFilterListItem {
|
|
|
2014
2014
|
* <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>
|
|
2015
2015
|
* @public
|
|
2016
2016
|
*/
|
|
2017
|
-
action?: FindingsFilterAction;
|
|
2017
|
+
action?: FindingsFilterAction | undefined;
|
|
2018
2018
|
/**
|
|
2019
2019
|
* <p>The Amazon Resource Name (ARN) of the filter.</p>
|
|
2020
2020
|
* @public
|
|
2021
2021
|
*/
|
|
2022
|
-
arn?: string;
|
|
2022
|
+
arn?: string | undefined;
|
|
2023
2023
|
/**
|
|
2024
2024
|
* <p>The unique identifier for the filter.</p>
|
|
2025
2025
|
* @public
|
|
2026
2026
|
*/
|
|
2027
|
-
id?: string;
|
|
2027
|
+
id?: string | undefined;
|
|
2028
2028
|
/**
|
|
2029
2029
|
* <p>The custom name of the filter.</p>
|
|
2030
2030
|
* @public
|
|
2031
2031
|
*/
|
|
2032
|
-
name?: string;
|
|
2032
|
+
name?: string | undefined;
|
|
2033
2033
|
/**
|
|
2034
2034
|
* <p>A map of key-value pairs that specifies which tags (keys and values) are associated with the filter.</p>
|
|
2035
2035
|
* @public
|
|
2036
2036
|
*/
|
|
2037
|
-
tags?: Record<string, string
|
|
2037
|
+
tags?: Record<string, string> | undefined;
|
|
2038
2038
|
}
|
|
2039
2039
|
/**
|
|
2040
2040
|
* <p>Provides a group of results for a query that retrieved aggregated statistical data about findings.</p>
|
|
@@ -2045,12 +2045,12 @@ export interface GroupCount {
|
|
|
2045
2045
|
* <p>The total number of findings in the group of query results.</p>
|
|
2046
2046
|
* @public
|
|
2047
2047
|
*/
|
|
2048
|
-
count?: number;
|
|
2048
|
+
count?: number | undefined;
|
|
2049
2049
|
/**
|
|
2050
2050
|
* <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>
|
|
2051
2051
|
* @public
|
|
2052
2052
|
*/
|
|
2053
|
-
groupKey?: string;
|
|
2053
|
+
groupKey?: string | undefined;
|
|
2054
2054
|
}
|
|
2055
2055
|
/**
|
|
2056
2056
|
* @public
|
|
@@ -2081,22 +2081,22 @@ export interface Invitation {
|
|
|
2081
2081
|
* <p>The Amazon Web Services account ID for the account that sent the invitation.</p>
|
|
2082
2082
|
* @public
|
|
2083
2083
|
*/
|
|
2084
|
-
accountId?: string;
|
|
2084
|
+
accountId?: string | undefined;
|
|
2085
2085
|
/**
|
|
2086
2086
|
* <p>The unique identifier for the invitation.</p>
|
|
2087
2087
|
* @public
|
|
2088
2088
|
*/
|
|
2089
|
-
invitationId?: string;
|
|
2089
|
+
invitationId?: string | undefined;
|
|
2090
2090
|
/**
|
|
2091
2091
|
* <p>The date and time, in UTC and extended ISO 8601 format, when the invitation was sent.</p>
|
|
2092
2092
|
* @public
|
|
2093
2093
|
*/
|
|
2094
|
-
invitedAt?: Date;
|
|
2094
|
+
invitedAt?: Date | undefined;
|
|
2095
2095
|
/**
|
|
2096
2096
|
* <p>The status of the relationship between the account that sent the invitation and the account that received the invitation.</p>
|
|
2097
2097
|
* @public
|
|
2098
2098
|
*/
|
|
2099
|
-
relationshipStatus?: RelationshipStatus;
|
|
2099
|
+
relationshipStatus?: RelationshipStatus | undefined;
|
|
2100
2100
|
}
|
|
2101
2101
|
/**
|
|
2102
2102
|
* @public
|
|
@@ -2121,17 +2121,17 @@ export interface SimpleScopeTerm {
|
|
|
2121
2121
|
* <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 - EQ (equals), GT (greater than), GTE (greater than or equals), LT (less than), LTE (less than or equals), or NE (not equals)</p></li> <li><p>OBJECT_SIZE - EQ (equals), GT (greater than), GTE (greater than or equals), LT (less than), LTE (less than or equals), or NE (not equals)</p></li></ul>
|
|
2122
2122
|
* @public
|
|
2123
2123
|
*/
|
|
2124
|
-
comparator?: JobComparator;
|
|
2124
|
+
comparator?: JobComparator | undefined;
|
|
2125
2125
|
/**
|
|
2126
2126
|
* <p>The object property to use in the condition.</p>
|
|
2127
2127
|
* @public
|
|
2128
2128
|
*/
|
|
2129
|
-
key?: ScopeFilterKey;
|
|
2129
|
+
key?: ScopeFilterKey | undefined;
|
|
2130
2130
|
/**
|
|
2131
2131
|
* <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: 2023-09-24T14: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>
|
|
2132
2132
|
* @public
|
|
2133
2133
|
*/
|
|
2134
|
-
values?: string[];
|
|
2134
|
+
values?: string[] | undefined;
|
|
2135
2135
|
}
|
|
2136
2136
|
/**
|
|
2137
2137
|
* <p>Specifies a tag key or tag key and value pair to use in a tag-based condition that determines whether an S3 object is included or excluded from a classification job. Tag keys and values are case sensitive. Also, Amazon Macie doesn't support use of partial values or wildcard characters in tag-based conditions.</p>
|
|
@@ -2142,12 +2142,12 @@ export interface TagValuePair {
|
|
|
2142
2142
|
* <p>The value for the tag key to use in the condition.</p>
|
|
2143
2143
|
* @public
|
|
2144
2144
|
*/
|
|
2145
|
-
key?: string;
|
|
2145
|
+
key?: string | undefined;
|
|
2146
2146
|
/**
|
|
2147
2147
|
* <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>
|
|
2148
2148
|
* @public
|
|
2149
2149
|
*/
|
|
2150
|
-
value?: string;
|
|
2150
|
+
value?: string | undefined;
|
|
2151
2151
|
}
|
|
2152
2152
|
/**
|
|
2153
2153
|
* @public
|
|
@@ -2169,22 +2169,22 @@ export interface TagScopeTerm {
|
|
|
2169
2169
|
* <p>The operator to use in the condition. Valid values are EQ (equals) or NE (not equals).</p>
|
|
2170
2170
|
* @public
|
|
2171
2171
|
*/
|
|
2172
|
-
comparator?: JobComparator;
|
|
2172
|
+
comparator?: JobComparator | undefined;
|
|
2173
2173
|
/**
|
|
2174
2174
|
* <p>The object property to use in the condition. The only valid value is TAG.</p>
|
|
2175
2175
|
* @public
|
|
2176
2176
|
*/
|
|
2177
|
-
key?: string;
|
|
2177
|
+
key?: string | undefined;
|
|
2178
2178
|
/**
|
|
2179
2179
|
* <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>
|
|
2180
2180
|
* @public
|
|
2181
2181
|
*/
|
|
2182
|
-
tagValues?: TagValuePair[];
|
|
2182
|
+
tagValues?: TagValuePair[] | undefined;
|
|
2183
2183
|
/**
|
|
2184
2184
|
* <p>The type of object to apply the condition to.</p>
|
|
2185
2185
|
* @public
|
|
2186
2186
|
*/
|
|
2187
|
-
target?: TagTarget;
|
|
2187
|
+
target?: TagTarget | undefined;
|
|
2188
2188
|
}
|
|
2189
2189
|
/**
|
|
2190
2190
|
* <p>Specifies a property- or tag-based condition that defines criteria for including or excluding S3 objects from a classification job. A JobScopeTerm object can contain only one simpleScopeTerm object or one tagScopeTerm object.</p>
|
|
@@ -2195,12 +2195,12 @@ export interface JobScopeTerm {
|
|
|
2195
2195
|
* <p>A property-based condition that defines a property, operator, and one or more values for including or excluding objects from the job.</p>
|
|
2196
2196
|
* @public
|
|
2197
2197
|
*/
|
|
2198
|
-
simpleScopeTerm?: SimpleScopeTerm;
|
|
2198
|
+
simpleScopeTerm?: SimpleScopeTerm | undefined;
|
|
2199
2199
|
/**
|
|
2200
2200
|
* <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>
|
|
2201
2201
|
* @public
|
|
2202
2202
|
*/
|
|
2203
|
-
tagScopeTerm?: TagScopeTerm;
|
|
2203
|
+
tagScopeTerm?: TagScopeTerm | undefined;
|
|
2204
2204
|
}
|
|
2205
2205
|
/**
|
|
2206
2206
|
* <p>Specifies one or more property- and tag-based conditions that define criteria for including or excluding S3 buckets from a classification job.</p>
|
|
@@ -2211,7 +2211,7 @@ export interface CriteriaBlockForJob {
|
|
|
2211
2211
|
* <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>
|
|
2212
2212
|
* @public
|
|
2213
2213
|
*/
|
|
2214
|
-
and?: CriteriaForJob[];
|
|
2214
|
+
and?: CriteriaForJob[] | undefined;
|
|
2215
2215
|
}
|
|
2216
2216
|
/**
|
|
2217
2217
|
* <p>Specifies property- and tag-based conditions that define criteria for including or excluding S3 buckets from a classification job. Exclude conditions take precedence over include conditions.</p>
|
|
@@ -2222,12 +2222,12 @@ export interface S3BucketCriteriaForJob {
|
|
|
2222
2222
|
* <p>The property- and tag-based conditions that determine which buckets to exclude from the job.</p>
|
|
2223
2223
|
* @public
|
|
2224
2224
|
*/
|
|
2225
|
-
excludes?: CriteriaBlockForJob;
|
|
2225
|
+
excludes?: CriteriaBlockForJob | undefined;
|
|
2226
2226
|
/**
|
|
2227
2227
|
* <p>The property- and tag-based conditions that determine which buckets to include in the job.</p>
|
|
2228
2228
|
* @public
|
|
2229
2229
|
*/
|
|
2230
|
-
includes?: CriteriaBlockForJob;
|
|
2230
|
+
includes?: CriteriaBlockForJob | undefined;
|
|
2231
2231
|
}
|
|
2232
2232
|
/**
|
|
2233
2233
|
* <p>Specifies an Amazon Web Services account that owns S3 buckets for a classification job to analyze, and one or more specific buckets to analyze for that account.</p>
|
|
@@ -2294,7 +2294,7 @@ export interface LastRunErrorStatus {
|
|
|
2294
2294
|
* <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>
|
|
2295
2295
|
* @public
|
|
2296
2296
|
*/
|
|
2297
|
-
code?: LastRunErrorStatusCode;
|
|
2297
|
+
code?: LastRunErrorStatusCode | undefined;
|
|
2298
2298
|
}
|
|
2299
2299
|
/**
|
|
2300
2300
|
* <p>Provides information about when a classification job was paused. For a one-time job, this object also specifies when the job will expire and be cancelled if it isn't resumed. For a recurring job, this object also specifies when the paused job run will expire and be cancelled if it isn't resumed. This object is present only if a job's current status (jobStatus) is USER_PAUSED. The information in this object applies only to a job that was paused while it had a status of RUNNING.</p>
|
|
@@ -2305,17 +2305,17 @@ export interface UserPausedDetails {
|
|
|
2305
2305
|
* <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>
|
|
2306
2306
|
* @public
|
|
2307
2307
|
*/
|
|
2308
|
-
jobExpiresAt?: Date;
|
|
2308
|
+
jobExpiresAt?: Date | undefined;
|
|
2309
2309
|
/**
|
|
2310
2310
|
* <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>
|
|
2311
2311
|
* @public
|
|
2312
2312
|
*/
|
|
2313
|
-
jobImminentExpirationHealthEventArn?: string;
|
|
2313
|
+
jobImminentExpirationHealthEventArn?: string | undefined;
|
|
2314
2314
|
/**
|
|
2315
2315
|
* <p>The date and time, in UTC and extended ISO 8601 format, when you paused the job.</p>
|
|
2316
2316
|
* @public
|
|
2317
2317
|
*/
|
|
2318
|
-
jobPausedAt?: Date;
|
|
2318
|
+
jobPausedAt?: Date | undefined;
|
|
2319
2319
|
}
|
|
2320
2320
|
/**
|
|
2321
2321
|
* <p>Provides information about a classification job, including the current status of the job.</p>
|
|
@@ -2326,47 +2326,47 @@ export interface JobSummary {
|
|
|
2326
2326
|
* <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>
|
|
2327
2327
|
* @public
|
|
2328
2328
|
*/
|
|
2329
|
-
bucketCriteria?: S3BucketCriteriaForJob;
|
|
2329
|
+
bucketCriteria?: S3BucketCriteriaForJob | undefined;
|
|
2330
2330
|
/**
|
|
2331
2331
|
* <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>
|
|
2332
2332
|
* @public
|
|
2333
2333
|
*/
|
|
2334
|
-
bucketDefinitions?: S3BucketDefinitionForJob[];
|
|
2334
|
+
bucketDefinitions?: S3BucketDefinitionForJob[] | undefined;
|
|
2335
2335
|
/**
|
|
2336
2336
|
* <p>The date and time, in UTC and extended ISO 8601 format, when the job was created.</p>
|
|
2337
2337
|
* @public
|
|
2338
2338
|
*/
|
|
2339
|
-
createdAt?: Date;
|
|
2339
|
+
createdAt?: Date | undefined;
|
|
2340
2340
|
/**
|
|
2341
2341
|
* <p>The unique identifier for the job.</p>
|
|
2342
2342
|
* @public
|
|
2343
2343
|
*/
|
|
2344
|
-
jobId?: string;
|
|
2344
|
+
jobId?: string | undefined;
|
|
2345
2345
|
/**
|
|
2346
2346
|
* <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>
|
|
2347
2347
|
* @public
|
|
2348
2348
|
*/
|
|
2349
|
-
jobStatus?: JobStatus;
|
|
2349
|
+
jobStatus?: JobStatus | undefined;
|
|
2350
2350
|
/**
|
|
2351
2351
|
* <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>
|
|
2352
2352
|
* @public
|
|
2353
2353
|
*/
|
|
2354
|
-
jobType?: JobType;
|
|
2354
|
+
jobType?: JobType | undefined;
|
|
2355
2355
|
/**
|
|
2356
2356
|
* <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>
|
|
2357
2357
|
* @public
|
|
2358
2358
|
*/
|
|
2359
|
-
lastRunErrorStatus?: LastRunErrorStatus;
|
|
2359
|
+
lastRunErrorStatus?: LastRunErrorStatus | undefined;
|
|
2360
2360
|
/**
|
|
2361
2361
|
* <p>The custom name of the job.</p>
|
|
2362
2362
|
* @public
|
|
2363
2363
|
*/
|
|
2364
|
-
name?: string;
|
|
2364
|
+
name?: string | undefined;
|
|
2365
2365
|
/**
|
|
2366
2366
|
* <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>
|
|
2367
2367
|
* @public
|
|
2368
2368
|
*/
|
|
2369
|
-
userPausedDetails?: UserPausedDetails;
|
|
2369
|
+
userPausedDetails?: UserPausedDetails | undefined;
|
|
2370
2370
|
}
|
|
2371
2371
|
/**
|
|
2372
2372
|
* @public
|
|
@@ -2391,17 +2391,17 @@ export interface ListJobsFilterTerm {
|
|
|
2391
2391
|
* <p>The operator to use to filter the results.</p>
|
|
2392
2392
|
* @public
|
|
2393
2393
|
*/
|
|
2394
|
-
comparator?: JobComparator;
|
|
2394
|
+
comparator?: JobComparator | undefined;
|
|
2395
2395
|
/**
|
|
2396
2396
|
* <p>The property to use to filter the results.</p>
|
|
2397
2397
|
* @public
|
|
2398
2398
|
*/
|
|
2399
|
-
key?: ListJobsFilterKey;
|
|
2399
|
+
key?: ListJobsFilterKey | undefined;
|
|
2400
2400
|
/**
|
|
2401
2401
|
* <p>An array that lists one or more values to use to filter the results.</p>
|
|
2402
2402
|
* @public
|
|
2403
2403
|
*/
|
|
2404
|
-
values?: string[];
|
|
2404
|
+
values?: string[] | undefined;
|
|
2405
2405
|
}
|
|
2406
2406
|
/**
|
|
2407
2407
|
* <p>Provides information about a managed data identifier. For additional information, 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>
|
|
@@ -2412,12 +2412,12 @@ export interface ManagedDataIdentifierSummary {
|
|
|
2412
2412
|
* <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>
|
|
2413
2413
|
* @public
|
|
2414
2414
|
*/
|
|
2415
|
-
category?: SensitiveDataItemCategory;
|
|
2415
|
+
category?: SensitiveDataItemCategory | undefined;
|
|
2416
2416
|
/**
|
|
2417
2417
|
* <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>
|
|
2418
2418
|
* @public
|
|
2419
2419
|
*/
|
|
2420
|
-
id?: string;
|
|
2420
|
+
id?: string | undefined;
|
|
2421
2421
|
}
|
|
2422
2422
|
/**
|
|
2423
2423
|
* <p>Provides statistical data and other information about an S3 bucket that Amazon Macie monitors and analyzes for your account. By default, object count and storage size values include data for object parts that are the result of incomplete multipart uploads. For more information, see <a href="https://docs.aws.amazon.com/macie/latest/user/monitoring-s3-how-it-works.html">How Macie monitors Amazon S3 data security</a> in the <i>Amazon Macie User Guide</i>.</p> <p>If an error occurs when Macie attempts to retrieve and process information about the bucket or the bucket's objects, the value for most of these properties is null. Key exceptions are accountId and bucketName. To identify the cause of the error, refer to the errorCode and errorMessage values.</p>
|
|
@@ -2428,82 +2428,82 @@ export interface MatchingBucket {
|
|
|
2428
2428
|
* <p>The unique identifier for the Amazon Web Services account that owns the bucket.</p>
|
|
2429
2429
|
* @public
|
|
2430
2430
|
*/
|
|
2431
|
-
accountId?: string;
|
|
2431
|
+
accountId?: string | undefined;
|
|
2432
2432
|
/**
|
|
2433
2433
|
* <p>Specifies whether automated sensitive data discovery is currently configured to analyze objects in the bucket. Possible values are: MONITORED, the bucket is included in analyses; and, NOT_MONITORED, the bucket is excluded from analyses. If automated sensitive data discovery is disabled for your account, this value is NOT_MONITORED.</p>
|
|
2434
2434
|
* @public
|
|
2435
2435
|
*/
|
|
2436
|
-
automatedDiscoveryMonitoringStatus?: AutomatedDiscoveryMonitoringStatus;
|
|
2436
|
+
automatedDiscoveryMonitoringStatus?: AutomatedDiscoveryMonitoringStatus | undefined;
|
|
2437
2437
|
/**
|
|
2438
2438
|
* <p>The name of the bucket.</p>
|
|
2439
2439
|
* @public
|
|
2440
2440
|
*/
|
|
2441
|
-
bucketName?: string;
|
|
2441
|
+
bucketName?: string | undefined;
|
|
2442
2442
|
/**
|
|
2443
2443
|
* <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>
|
|
2444
2444
|
* @public
|
|
2445
2445
|
*/
|
|
2446
|
-
classifiableObjectCount?: number;
|
|
2446
|
+
classifiableObjectCount?: number | undefined;
|
|
2447
2447
|
/**
|
|
2448
2448
|
* <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>
|
|
2449
2449
|
* @public
|
|
2450
2450
|
*/
|
|
2451
|
-
classifiableSizeInBytes?: number;
|
|
2451
|
+
classifiableSizeInBytes?: number | undefined;
|
|
2452
2452
|
/**
|
|
2453
2453
|
* <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>
|
|
2454
2454
|
* @public
|
|
2455
2455
|
*/
|
|
2456
|
-
errorCode?: BucketMetadataErrorCode;
|
|
2456
|
+
errorCode?: BucketMetadataErrorCode | undefined;
|
|
2457
2457
|
/**
|
|
2458
2458
|
* <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>
|
|
2459
2459
|
* @public
|
|
2460
2460
|
*/
|
|
2461
|
-
errorMessage?: string;
|
|
2461
|
+
errorMessage?: string | undefined;
|
|
2462
2462
|
/**
|
|
2463
2463
|
* <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>
|
|
2464
2464
|
* @public
|
|
2465
2465
|
*/
|
|
2466
|
-
jobDetails?: JobDetails;
|
|
2466
|
+
jobDetails?: JobDetails | undefined;
|
|
2467
2467
|
/**
|
|
2468
2468
|
* <p>The date and time, in UTC and extended ISO 8601 format, when Amazon Macie most recently analyzed objects in the bucket while performing automated sensitive data discovery. This value is null if automated sensitive data discovery is disabled for your account.</p>
|
|
2469
2469
|
* @public
|
|
2470
2470
|
*/
|
|
2471
|
-
lastAutomatedDiscoveryTime?: Date;
|
|
2471
|
+
lastAutomatedDiscoveryTime?: Date | undefined;
|
|
2472
2472
|
/**
|
|
2473
2473
|
* <p>The total number of objects in the bucket.</p>
|
|
2474
2474
|
* @public
|
|
2475
2475
|
*/
|
|
2476
|
-
objectCount?: number;
|
|
2476
|
+
objectCount?: number | undefined;
|
|
2477
2477
|
/**
|
|
2478
2478
|
* <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>
|
|
2479
2479
|
* @public
|
|
2480
2480
|
*/
|
|
2481
|
-
objectCountByEncryptionType?: ObjectCountByEncryptionType;
|
|
2481
|
+
objectCountByEncryptionType?: ObjectCountByEncryptionType | undefined;
|
|
2482
2482
|
/**
|
|
2483
2483
|
* <p>The sensitivity score for the bucket, ranging from -1 (classification error) to 100 (sensitive).</p><p>If automated sensitive data discovery has never been enabled for your account or it’s been disabled for your organization or your standalone account for more than 30 days, possible values are: 1, the bucket is empty; or, 50, the bucket stores objects but it’s been excluded from recent analyses.</p>
|
|
2484
2484
|
* @public
|
|
2485
2485
|
*/
|
|
2486
|
-
sensitivityScore?: number;
|
|
2486
|
+
sensitivityScore?: number | undefined;
|
|
2487
2487
|
/**
|
|
2488
2488
|
* <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>
|
|
2489
2489
|
* @public
|
|
2490
2490
|
*/
|
|
2491
|
-
sizeInBytes?: number;
|
|
2491
|
+
sizeInBytes?: number | undefined;
|
|
2492
2492
|
/**
|
|
2493
2493
|
* <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>
|
|
2494
2494
|
* @public
|
|
2495
2495
|
*/
|
|
2496
|
-
sizeInBytesCompressed?: number;
|
|
2496
|
+
sizeInBytesCompressed?: number | undefined;
|
|
2497
2497
|
/**
|
|
2498
2498
|
* <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>
|
|
2499
2499
|
* @public
|
|
2500
2500
|
*/
|
|
2501
|
-
unclassifiableObjectCount?: ObjectLevelStatistics;
|
|
2501
|
+
unclassifiableObjectCount?: ObjectLevelStatistics | undefined;
|
|
2502
2502
|
/**
|
|
2503
2503
|
* <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>
|
|
2504
2504
|
* @public
|
|
2505
2505
|
*/
|
|
2506
|
-
unclassifiableObjectSizeInBytes?: ObjectLevelStatistics;
|
|
2506
|
+
unclassifiableObjectSizeInBytes?: ObjectLevelStatistics | undefined;
|
|
2507
2507
|
}
|
|
2508
2508
|
/**
|
|
2509
2509
|
* <p>Provides statistical data and other information about an Amazon Web Services resource that Amazon Macie monitors and analyzes for your account.</p>
|
|
@@ -2514,7 +2514,7 @@ export interface MatchingResource {
|
|
|
2514
2514
|
* <p>The details of an S3 bucket that Amazon Macie monitors and analyzes.</p>
|
|
2515
2515
|
* @public
|
|
2516
2516
|
*/
|
|
2517
|
-
matchingBucket?: MatchingBucket;
|
|
2517
|
+
matchingBucket?: MatchingBucket | undefined;
|
|
2518
2518
|
}
|
|
2519
2519
|
/**
|
|
2520
2520
|
* <p>Provides information about an account that's associated with an Amazon Macie administrator account.</p>
|
|
@@ -2525,47 +2525,47 @@ export interface Member {
|
|
|
2525
2525
|
* <p>The Amazon Web Services account ID for the account.</p>
|
|
2526
2526
|
* @public
|
|
2527
2527
|
*/
|
|
2528
|
-
accountId?: string;
|
|
2528
|
+
accountId?: string | undefined;
|
|
2529
2529
|
/**
|
|
2530
2530
|
* <p>The Amazon Web Services account ID for the administrator account.</p>
|
|
2531
2531
|
* @public
|
|
2532
2532
|
*/
|
|
2533
|
-
administratorAccountId?: string;
|
|
2533
|
+
administratorAccountId?: string | undefined;
|
|
2534
2534
|
/**
|
|
2535
2535
|
* <p>The Amazon Resource Name (ARN) of the account.</p>
|
|
2536
2536
|
* @public
|
|
2537
2537
|
*/
|
|
2538
|
-
arn?: string;
|
|
2538
|
+
arn?: string | undefined;
|
|
2539
2539
|
/**
|
|
2540
2540
|
* <p>The email address for the account. This value is null if the account is associated with the administrator account through Organizations.</p>
|
|
2541
2541
|
* @public
|
|
2542
2542
|
*/
|
|
2543
|
-
email?: string;
|
|
2543
|
+
email?: string | undefined;
|
|
2544
2544
|
/**
|
|
2545
2545
|
* <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>
|
|
2546
2546
|
* @public
|
|
2547
2547
|
*/
|
|
2548
|
-
invitedAt?: Date;
|
|
2548
|
+
invitedAt?: Date | undefined;
|
|
2549
2549
|
/**
|
|
2550
2550
|
* <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>
|
|
2551
2551
|
* @public
|
|
2552
2552
|
*/
|
|
2553
|
-
masterAccountId?: string;
|
|
2553
|
+
masterAccountId?: string | undefined;
|
|
2554
2554
|
/**
|
|
2555
2555
|
* <p>The current status of the relationship between the account and the administrator account.</p>
|
|
2556
2556
|
* @public
|
|
2557
2557
|
*/
|
|
2558
|
-
relationshipStatus?: RelationshipStatus;
|
|
2558
|
+
relationshipStatus?: RelationshipStatus | undefined;
|
|
2559
2559
|
/**
|
|
2560
2560
|
* <p>A map of key-value pairs that specifies which tags (keys and values) are associated with the account in Amazon Macie.</p>
|
|
2561
2561
|
* @public
|
|
2562
2562
|
*/
|
|
2563
|
-
tags?: Record<string, string
|
|
2563
|
+
tags?: Record<string, string> | undefined;
|
|
2564
2564
|
/**
|
|
2565
2565
|
* <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>
|
|
2566
2566
|
* @public
|
|
2567
2567
|
*/
|
|
2568
|
-
updatedAt?: Date;
|
|
2568
|
+
updatedAt?: Date | undefined;
|
|
2569
2569
|
}
|
|
2570
2570
|
/**
|
|
2571
2571
|
* <p>Provides information about an S3 object that Amazon Macie selected for analysis while performing automated sensitive data discovery for an account, and the status and results of the analysis. This information is available only if automated sensitive data discovery has been enabled for the account.</p>
|
|
@@ -2586,7 +2586,7 @@ export interface ResourceProfileArtifact {
|
|
|
2586
2586
|
* <p>Specifies whether Amazon Macie found sensitive data in the object.</p>
|
|
2587
2587
|
* @public
|
|
2588
2588
|
*/
|
|
2589
|
-
sensitive?: boolean;
|
|
2589
|
+
sensitive?: boolean | undefined;
|
|
2590
2590
|
}
|
|
2591
2591
|
/**
|
|
2592
2592
|
* @public
|
|
@@ -2624,17 +2624,17 @@ export interface SearchResourcesSimpleCriterion {
|
|
|
2624
2624
|
* <p>The operator to use in the condition. Valid values are EQ (equals) and NE (not equals).</p>
|
|
2625
2625
|
* @public
|
|
2626
2626
|
*/
|
|
2627
|
-
comparator?: SearchResourcesComparator;
|
|
2627
|
+
comparator?: SearchResourcesComparator | undefined;
|
|
2628
2628
|
/**
|
|
2629
2629
|
* <p>The property to use in the condition.</p>
|
|
2630
2630
|
* @public
|
|
2631
2631
|
*/
|
|
2632
|
-
key?: SearchResourcesSimpleCriterionKey;
|
|
2632
|
+
key?: SearchResourcesSimpleCriterionKey | undefined;
|
|
2633
2633
|
/**
|
|
2634
2634
|
* <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>AUTOMATED_DISCOVERY_MONITORING_STATUS - 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-automateddiscoverymonitoringstatus">BucketMetadata.automatedDiscoveryMonitoringStatus</a> property of an S3 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 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>
|
|
2635
2635
|
* @public
|
|
2636
2636
|
*/
|
|
2637
|
-
values?: string[];
|
|
2637
|
+
values?: string[] | undefined;
|
|
2638
2638
|
}
|
|
2639
2639
|
/**
|
|
2640
2640
|
* <p>Specifies a tag key, a tag value, or a tag key and value (as a pair) to use in a tag-based filter condition for a query. Tag keys and values are case sensitive. Also, Amazon Macie doesn't support use of partial values or wildcard characters in tag-based filter conditions.</p>
|
|
@@ -2645,12 +2645,12 @@ export interface SearchResourcesTagCriterionPair {
|
|
|
2645
2645
|
* <p>The value for the tag key to use in the condition.</p>
|
|
2646
2646
|
* @public
|
|
2647
2647
|
*/
|
|
2648
|
-
key?: string;
|
|
2648
|
+
key?: string | undefined;
|
|
2649
2649
|
/**
|
|
2650
2650
|
* <p>The tag value to use in the condition.</p>
|
|
2651
2651
|
* @public
|
|
2652
2652
|
*/
|
|
2653
|
-
value?: string;
|
|
2653
|
+
value?: string | undefined;
|
|
2654
2654
|
}
|
|
2655
2655
|
/**
|
|
2656
2656
|
* <p>Specifies a tag-based filter condition that determines which Amazon Web Services resources are included or excluded from the query results.</p>
|
|
@@ -2661,12 +2661,12 @@ export interface SearchResourcesTagCriterion {
|
|
|
2661
2661
|
* <p>The operator to use in the condition. Valid values are EQ (equals) and NE (not equals).</p>
|
|
2662
2662
|
* @public
|
|
2663
2663
|
*/
|
|
2664
|
-
comparator?: SearchResourcesComparator;
|
|
2664
|
+
comparator?: SearchResourcesComparator | undefined;
|
|
2665
2665
|
/**
|
|
2666
2666
|
* <p>The tag keys, tag values, or tag key and value pairs to use in the condition.</p>
|
|
2667
2667
|
* @public
|
|
2668
2668
|
*/
|
|
2669
|
-
tagValues?: SearchResourcesTagCriterionPair[];
|
|
2669
|
+
tagValues?: SearchResourcesTagCriterionPair[] | undefined;
|
|
2670
2670
|
}
|
|
2671
2671
|
/**
|
|
2672
2672
|
* <p>Specifies a property- or tag-based filter condition for including or excluding Amazon Web Services resources from the query results.</p>
|
|
@@ -2677,12 +2677,12 @@ export interface SearchResourcesCriteria {
|
|
|
2677
2677
|
* <p>A property-based condition that defines a property, operator, and one or more values for including or excluding resources from the results.</p>
|
|
2678
2678
|
* @public
|
|
2679
2679
|
*/
|
|
2680
|
-
simpleCriterion?: SearchResourcesSimpleCriterion;
|
|
2680
|
+
simpleCriterion?: SearchResourcesSimpleCriterion | undefined;
|
|
2681
2681
|
/**
|
|
2682
2682
|
* <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>
|
|
2683
2683
|
* @public
|
|
2684
2684
|
*/
|
|
2685
|
-
tagCriterion?: SearchResourcesTagCriterion;
|
|
2685
|
+
tagCriterion?: SearchResourcesTagCriterion | undefined;
|
|
2686
2686
|
}
|
|
2687
2687
|
/**
|
|
2688
2688
|
* <p>Provides information about the sensitivity inspection template for an Amazon Macie account.</p>
|
|
@@ -2693,12 +2693,12 @@ export interface SensitivityInspectionTemplatesEntry {
|
|
|
2693
2693
|
* <p>The unique identifier for the sensitivity inspection template.</p>
|
|
2694
2694
|
* @public
|
|
2695
2695
|
*/
|
|
2696
|
-
id?: string;
|
|
2696
|
+
id?: string | undefined;
|
|
2697
2697
|
/**
|
|
2698
2698
|
* <p>The name of the sensitivity inspection template: automated-sensitive-data-discovery.</p>
|
|
2699
2699
|
* @public
|
|
2700
2700
|
*/
|
|
2701
|
-
name?: string;
|
|
2701
|
+
name?: string | undefined;
|
|
2702
2702
|
}
|
|
2703
2703
|
/**
|
|
2704
2704
|
* <p>Specifies a custom data identifier or managed data identifier that detected a type of sensitive data to start excluding or including in an S3 bucket's sensitivity score.</p>
|
|
@@ -2709,12 +2709,12 @@ export interface SuppressDataIdentifier {
|
|
|
2709
2709
|
* <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>
|
|
2710
2710
|
* @public
|
|
2711
2711
|
*/
|
|
2712
|
-
id?: string;
|
|
2712
|
+
id?: string | undefined;
|
|
2713
2713
|
/**
|
|
2714
2714
|
* <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>
|
|
2715
2715
|
* @public
|
|
2716
2716
|
*/
|
|
2717
|
-
type?: DataIdentifierType;
|
|
2717
|
+
type?: DataIdentifierType | undefined;
|
|
2718
2718
|
}
|
|
2719
2719
|
/**
|
|
2720
2720
|
* @public
|
|
@@ -2758,17 +2758,17 @@ export interface UnprocessedAccount {
|
|
|
2758
2758
|
* <p>The Amazon Web Services account ID for the account that the request applies to.</p>
|
|
2759
2759
|
* @public
|
|
2760
2760
|
*/
|
|
2761
|
-
accountId?: string;
|
|
2761
|
+
accountId?: string | undefined;
|
|
2762
2762
|
/**
|
|
2763
2763
|
* <p>The source of the issue or delay in processing the request.</p>
|
|
2764
2764
|
* @public
|
|
2765
2765
|
*/
|
|
2766
|
-
errorCode?: ErrorCode;
|
|
2766
|
+
errorCode?: ErrorCode | undefined;
|
|
2767
2767
|
/**
|
|
2768
2768
|
* <p>The reason why the request hasn't been processed.</p>
|
|
2769
2769
|
* @public
|
|
2770
2770
|
*/
|
|
2771
|
-
errorMessage?: string;
|
|
2771
|
+
errorMessage?: string | undefined;
|
|
2772
2772
|
}
|
|
2773
2773
|
/**
|
|
2774
2774
|
* @public
|
|
@@ -2801,17 +2801,17 @@ export interface ServiceLimit {
|
|
|
2801
2801
|
* <p>Specifies whether the account has met the quota that corresponds to the metric specified by the UsageByAccount.type field in the response.</p>
|
|
2802
2802
|
* @public
|
|
2803
2803
|
*/
|
|
2804
|
-
isServiceLimited?: boolean;
|
|
2804
|
+
isServiceLimited?: boolean | undefined;
|
|
2805
2805
|
/**
|
|
2806
2806
|
* <p>The unit of measurement for the value specified by the value field.</p>
|
|
2807
2807
|
* @public
|
|
2808
2808
|
*/
|
|
2809
|
-
unit?: Unit;
|
|
2809
|
+
unit?: Unit | undefined;
|
|
2810
2810
|
/**
|
|
2811
2811
|
* <p>The value for the metric specified by the UsageByAccount.type field in the response.</p>
|
|
2812
2812
|
* @public
|
|
2813
2813
|
*/
|
|
2814
|
-
value?: number;
|
|
2814
|
+
value?: number | undefined;
|
|
2815
2815
|
}
|
|
2816
2816
|
/**
|
|
2817
2817
|
* @public
|
|
@@ -2836,22 +2836,22 @@ export interface UsageByAccount {
|
|
|
2836
2836
|
* <p>The type of currency that the value for the metric (estimatedCost) is reported in.</p>
|
|
2837
2837
|
* @public
|
|
2838
2838
|
*/
|
|
2839
|
-
currency?: Currency;
|
|
2839
|
+
currency?: Currency | undefined;
|
|
2840
2840
|
/**
|
|
2841
2841
|
* <p>The estimated value for the metric.</p>
|
|
2842
2842
|
* @public
|
|
2843
2843
|
*/
|
|
2844
|
-
estimatedCost?: string;
|
|
2844
|
+
estimatedCost?: string | undefined;
|
|
2845
2845
|
/**
|
|
2846
2846
|
* <p>The current value for the quota that corresponds to the metric specified by the type field.</p>
|
|
2847
2847
|
* @public
|
|
2848
2848
|
*/
|
|
2849
|
-
serviceLimit?: ServiceLimit;
|
|
2849
|
+
serviceLimit?: ServiceLimit | undefined;
|
|
2850
2850
|
/**
|
|
2851
2851
|
* <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>
|
|
2852
2852
|
* @public
|
|
2853
2853
|
*/
|
|
2854
|
-
type?: UsageType;
|
|
2854
|
+
type?: UsageType | undefined;
|
|
2855
2855
|
}
|
|
2856
2856
|
/**
|
|
2857
2857
|
* <p>Provides quota and aggregated usage data for an Amazon Macie account.</p>
|
|
@@ -2862,22 +2862,22 @@ export interface UsageRecord {
|
|
|
2862
2862
|
* <p>The unique identifier for the Amazon Web Services account that the data applies to.</p>
|
|
2863
2863
|
* @public
|
|
2864
2864
|
*/
|
|
2865
|
-
accountId?: string;
|
|
2865
|
+
accountId?: string | undefined;
|
|
2866
2866
|
/**
|
|
2867
2867
|
* <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. This value is null if automated sensitive data discovery hasn't been enabled for the account.</p>
|
|
2868
2868
|
* @public
|
|
2869
2869
|
*/
|
|
2870
|
-
automatedDiscoveryFreeTrialStartDate?: Date;
|
|
2870
|
+
automatedDiscoveryFreeTrialStartDate?: Date | undefined;
|
|
2871
2871
|
/**
|
|
2872
2872
|
* <p>The date and time, in UTC and extended ISO 8601 format, when the Amazon Macie free trial started for the account.</p>
|
|
2873
2873
|
* @public
|
|
2874
2874
|
*/
|
|
2875
|
-
freeTrialStartDate?: Date;
|
|
2875
|
+
freeTrialStartDate?: Date | undefined;
|
|
2876
2876
|
/**
|
|
2877
2877
|
* <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>
|
|
2878
2878
|
* @public
|
|
2879
2879
|
*/
|
|
2880
|
-
usage?: UsageByAccount[];
|
|
2880
|
+
usage?: UsageByAccount[] | undefined;
|
|
2881
2881
|
}
|
|
2882
2882
|
/**
|
|
2883
2883
|
* @public
|
|
@@ -2919,17 +2919,17 @@ export interface UsageStatisticsFilter {
|
|
|
2919
2919
|
* <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>
|
|
2920
2920
|
* @public
|
|
2921
2921
|
*/
|
|
2922
|
-
comparator?: UsageStatisticsFilterComparator;
|
|
2922
|
+
comparator?: UsageStatisticsFilterComparator | undefined;
|
|
2923
2923
|
/**
|
|
2924
2924
|
* <p>The field to use in the condition.</p>
|
|
2925
2925
|
* @public
|
|
2926
2926
|
*/
|
|
2927
|
-
key?: UsageStatisticsFilterKey;
|
|
2927
|
+
key?: UsageStatisticsFilterKey | undefined;
|
|
2928
2928
|
/**
|
|
2929
2929
|
* <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>
|
|
2930
2930
|
* @public
|
|
2931
2931
|
*/
|
|
2932
|
-
values?: string[];
|
|
2932
|
+
values?: string[] | undefined;
|
|
2933
2933
|
}
|
|
2934
2934
|
/**
|
|
2935
2935
|
* <p>Provides aggregated data for an Amazon Macie usage metric. The value for the metric reports estimated usage data for an account for the preceding 30 days or the current calendar month to date, depending on the time period (timeRange) specified in the request.</p>
|
|
@@ -2940,17 +2940,17 @@ export interface UsageTotal {
|
|
|
2940
2940
|
* <p>The type of currency that the value for the metric (estimatedCost) is reported in.</p>
|
|
2941
2941
|
* @public
|
|
2942
2942
|
*/
|
|
2943
|
-
currency?: Currency;
|
|
2943
|
+
currency?: Currency | undefined;
|
|
2944
2944
|
/**
|
|
2945
2945
|
* <p>The estimated value for the metric.</p>
|
|
2946
2946
|
* @public
|
|
2947
2947
|
*/
|
|
2948
|
-
estimatedCost?: string;
|
|
2948
|
+
estimatedCost?: string | undefined;
|
|
2949
2949
|
/**
|
|
2950
2950
|
* <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>
|
|
2951
2951
|
* @public
|
|
2952
2952
|
*/
|
|
2953
|
-
type?: UsageType;
|
|
2953
|
+
type?: UsageType | undefined;
|
|
2954
2954
|
}
|
|
2955
2955
|
/**
|
|
2956
2956
|
* @public
|
|
@@ -2960,7 +2960,7 @@ export interface AcceptInvitationRequest {
|
|
|
2960
2960
|
* <p>The Amazon Web Services account ID for the account that sent the invitation.</p>
|
|
2961
2961
|
* @public
|
|
2962
2962
|
*/
|
|
2963
|
-
administratorAccountId?: string;
|
|
2963
|
+
administratorAccountId?: string | undefined;
|
|
2964
2964
|
/**
|
|
2965
2965
|
* <p>The unique identifier for the invitation to accept.</p>
|
|
2966
2966
|
* @public
|
|
@@ -2970,7 +2970,7 @@ export interface AcceptInvitationRequest {
|
|
|
2970
2970
|
* <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>
|
|
2971
2971
|
* @public
|
|
2972
2972
|
*/
|
|
2973
|
-
masterAccount?: string;
|
|
2973
|
+
masterAccount?: string | undefined;
|
|
2974
2974
|
}
|
|
2975
2975
|
/**
|
|
2976
2976
|
* @public
|
|
@@ -3102,12 +3102,12 @@ export interface AllowListCriteria {
|
|
|
3102
3102
|
* <p>The regular expression (<i>regex</i>) that defines the text pattern to ignore. The expression can contain as many as 512 characters.</p>
|
|
3103
3103
|
* @public
|
|
3104
3104
|
*/
|
|
3105
|
-
regex?: string;
|
|
3105
|
+
regex?: string | undefined;
|
|
3106
3106
|
/**
|
|
3107
3107
|
* <p>The location and name of the S3 object that lists specific text to ignore.</p>
|
|
3108
3108
|
* @public
|
|
3109
3109
|
*/
|
|
3110
|
-
s3WordsList?: S3WordsList;
|
|
3110
|
+
s3WordsList?: S3WordsList | undefined;
|
|
3111
3111
|
}
|
|
3112
3112
|
/**
|
|
3113
3113
|
* @public
|
|
@@ -3141,7 +3141,7 @@ export interface AllowListStatus {
|
|
|
3141
3141
|
* <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>
|
|
3142
3142
|
* @public
|
|
3143
3143
|
*/
|
|
3144
|
-
description?: string;
|
|
3144
|
+
description?: string | undefined;
|
|
3145
3145
|
}
|
|
3146
3146
|
/**
|
|
3147
3147
|
* @public
|
|
@@ -3188,7 +3188,7 @@ export interface BatchGetCustomDataIdentifiersRequest {
|
|
|
3188
3188
|
* <p>An array of custom data identifier IDs, one for each custom data identifier to retrieve information about.</p>
|
|
3189
3189
|
* @public
|
|
3190
3190
|
*/
|
|
3191
|
-
ids?: string[];
|
|
3191
|
+
ids?: string[] | undefined;
|
|
3192
3192
|
}
|
|
3193
3193
|
/**
|
|
3194
3194
|
* @public
|
|
@@ -3198,12 +3198,12 @@ export interface BatchGetCustomDataIdentifiersResponse {
|
|
|
3198
3198
|
* <p>An array of objects, one for each custom data identifier that matches the criteria specified in the request.</p>
|
|
3199
3199
|
* @public
|
|
3200
3200
|
*/
|
|
3201
|
-
customDataIdentifiers?: BatchGetCustomDataIdentifierSummary[];
|
|
3201
|
+
customDataIdentifiers?: BatchGetCustomDataIdentifierSummary[] | undefined;
|
|
3202
3202
|
/**
|
|
3203
3203
|
* <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>
|
|
3204
3204
|
* @public
|
|
3205
3205
|
*/
|
|
3206
|
-
notFoundIdentifierIds?: string[];
|
|
3206
|
+
notFoundIdentifierIds?: string[] | undefined;
|
|
3207
3207
|
}
|
|
3208
3208
|
/**
|
|
3209
3209
|
* @public
|
|
@@ -3213,7 +3213,7 @@ export interface BatchUpdateAutomatedDiscoveryAccountsRequest {
|
|
|
3213
3213
|
* <p>An array of objects, one for each account to change the status of automated sensitive data discovery for. Each object specifies the Amazon Web Services account ID for an account and a new status for that account.</p>
|
|
3214
3214
|
* @public
|
|
3215
3215
|
*/
|
|
3216
|
-
accounts?: AutomatedDiscoveryAccountUpdate[];
|
|
3216
|
+
accounts?: AutomatedDiscoveryAccountUpdate[] | undefined;
|
|
3217
3217
|
}
|
|
3218
3218
|
/**
|
|
3219
3219
|
* @public
|
|
@@ -3223,7 +3223,7 @@ export interface BatchUpdateAutomatedDiscoveryAccountsResponse {
|
|
|
3223
3223
|
* <p>An array of objects, one for each account whose status wasn’t changed. Each object identifies the account and explains why the status of automated sensitive data discovery wasn’t changed for the account. This value is null if the request succeeded for all specified accounts.</p>
|
|
3224
3224
|
* @public
|
|
3225
3225
|
*/
|
|
3226
|
-
errors?: AutomatedDiscoveryAccountUpdateError[];
|
|
3226
|
+
errors?: AutomatedDiscoveryAccountUpdateError[] | undefined;
|
|
3227
3227
|
}
|
|
3228
3228
|
/**
|
|
3229
3229
|
* <p>Provides information about the number of S3 buckets that are publicly accessible due to a combination of permissions settings for each bucket.</p>
|
|
@@ -3234,22 +3234,22 @@ export interface BucketCountByEffectivePermission {
|
|
|
3234
3234
|
* <p>The total number of buckets that allow the general public to have read or write access to the bucket.</p>
|
|
3235
3235
|
* @public
|
|
3236
3236
|
*/
|
|
3237
|
-
publiclyAccessible?: number;
|
|
3237
|
+
publiclyAccessible?: number | undefined;
|
|
3238
3238
|
/**
|
|
3239
3239
|
* <p>The total number of buckets that allow the general public to have read access to the bucket.</p>
|
|
3240
3240
|
* @public
|
|
3241
3241
|
*/
|
|
3242
|
-
publiclyReadable?: number;
|
|
3242
|
+
publiclyReadable?: number | undefined;
|
|
3243
3243
|
/**
|
|
3244
3244
|
* <p>The total number of buckets that allow the general public to have write access to the bucket.</p>
|
|
3245
3245
|
* @public
|
|
3246
3246
|
*/
|
|
3247
|
-
publiclyWritable?: number;
|
|
3247
|
+
publiclyWritable?: number | undefined;
|
|
3248
3248
|
/**
|
|
3249
3249
|
* <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>
|
|
3250
3250
|
* @public
|
|
3251
3251
|
*/
|
|
3252
|
-
unknown?: number;
|
|
3252
|
+
unknown?: number | undefined;
|
|
3253
3253
|
}
|
|
3254
3254
|
/**
|
|
3255
3255
|
* <p>Provides information about the number of S3 buckets whose settings do or don't specify default server-side encryption behavior for objects that are added to the buckets. For detailed information about these settings, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucket-encryption.html">Setting default server-side encryption behavior for Amazon S3 buckets</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p>
|
|
@@ -3260,22 +3260,22 @@ export interface BucketCountByEncryptionType {
|
|
|
3260
3260
|
* <p>The total number of buckets whose default encryption settings are configured to encrypt new objects with an KMS key, either an Amazon Web Services managed key or a customer managed key. By default, these buckets encrypt new objects automatically using DSSE-KMS or SSE-KMS encryption.</p>
|
|
3261
3261
|
* @public
|
|
3262
3262
|
*/
|
|
3263
|
-
kmsManaged?: number;
|
|
3263
|
+
kmsManaged?: number | undefined;
|
|
3264
3264
|
/**
|
|
3265
3265
|
* <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>
|
|
3266
3266
|
* @public
|
|
3267
3267
|
*/
|
|
3268
|
-
s3Managed?: number;
|
|
3268
|
+
s3Managed?: number | undefined;
|
|
3269
3269
|
/**
|
|
3270
3270
|
* <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>
|
|
3271
3271
|
* @public
|
|
3272
3272
|
*/
|
|
3273
|
-
unencrypted?: number;
|
|
3273
|
+
unencrypted?: number | undefined;
|
|
3274
3274
|
/**
|
|
3275
3275
|
* <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>
|
|
3276
3276
|
* @public
|
|
3277
3277
|
*/
|
|
3278
|
-
unknown?: number;
|
|
3278
|
+
unknown?: number | undefined;
|
|
3279
3279
|
}
|
|
3280
3280
|
/**
|
|
3281
3281
|
* <p>Provides information about the number of S3 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). In this data, an <i>Amazon Macie organization</i> is defined as a set of Macie accounts that are centrally managed as a group of related accounts through Organizations or by Macie invitation.</p>
|
|
@@ -3286,22 +3286,22 @@ export interface BucketCountBySharedAccessType {
|
|
|
3286
3286
|
* <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>
|
|
3287
3287
|
* @public
|
|
3288
3288
|
*/
|
|
3289
|
-
external?: number;
|
|
3289
|
+
external?: number | undefined;
|
|
3290
3290
|
/**
|
|
3291
3291
|
* <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>
|
|
3292
3292
|
* @public
|
|
3293
3293
|
*/
|
|
3294
|
-
internal?: number;
|
|
3294
|
+
internal?: number | undefined;
|
|
3295
3295
|
/**
|
|
3296
3296
|
* <p>The total number of buckets that aren't shared with other Amazon Web Services accounts, Amazon CloudFront OAIs, or CloudFront OACs.</p>
|
|
3297
3297
|
* @public
|
|
3298
3298
|
*/
|
|
3299
|
-
notShared?: number;
|
|
3299
|
+
notShared?: number | undefined;
|
|
3300
3300
|
/**
|
|
3301
3301
|
* <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>
|
|
3302
3302
|
* @public
|
|
3303
3303
|
*/
|
|
3304
|
-
unknown?: number;
|
|
3304
|
+
unknown?: number | undefined;
|
|
3305
3305
|
}
|
|
3306
3306
|
/**
|
|
3307
3307
|
* <p>Provides information about the number of S3 buckets whose bucket policies do or don't require server-side encryption of objects when objects are added to the buckets.</p>
|
|
@@ -3312,17 +3312,17 @@ export interface BucketCountPolicyAllowsUnencryptedObjectUploads {
|
|
|
3312
3312
|
* <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>
|
|
3313
3313
|
* @public
|
|
3314
3314
|
*/
|
|
3315
|
-
allowsUnencryptedObjectUploads?: number;
|
|
3315
|
+
allowsUnencryptedObjectUploads?: number | undefined;
|
|
3316
3316
|
/**
|
|
3317
3317
|
* <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>
|
|
3318
3318
|
* @public
|
|
3319
3319
|
*/
|
|
3320
|
-
deniesUnencryptedObjectUploads?: number;
|
|
3320
|
+
deniesUnencryptedObjectUploads?: number | undefined;
|
|
3321
3321
|
/**
|
|
3322
3322
|
* <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>
|
|
3323
3323
|
* @public
|
|
3324
3324
|
*/
|
|
3325
|
-
unknown?: number;
|
|
3325
|
+
unknown?: number | undefined;
|
|
3326
3326
|
}
|
|
3327
3327
|
/**
|
|
3328
3328
|
* <p>Specifies the operator to use in a property-based condition that filters the results of a query for information about S3 buckets.</p>
|
|
@@ -3333,37 +3333,37 @@ export interface BucketCriteriaAdditionalProperties {
|
|
|
3333
3333
|
* <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>
|
|
3334
3334
|
* @public
|
|
3335
3335
|
*/
|
|
3336
|
-
eq?: string[];
|
|
3336
|
+
eq?: string[] | undefined;
|
|
3337
3337
|
/**
|
|
3338
3338
|
* <p>The value for the property is greater than the specified value.</p>
|
|
3339
3339
|
* @public
|
|
3340
3340
|
*/
|
|
3341
|
-
gt?: number;
|
|
3341
|
+
gt?: number | undefined;
|
|
3342
3342
|
/**
|
|
3343
3343
|
* <p>The value for the property is greater than or equal to the specified value.</p>
|
|
3344
3344
|
* @public
|
|
3345
3345
|
*/
|
|
3346
|
-
gte?: number;
|
|
3346
|
+
gte?: number | undefined;
|
|
3347
3347
|
/**
|
|
3348
3348
|
* <p>The value for the property is less than the specified value.</p>
|
|
3349
3349
|
* @public
|
|
3350
3350
|
*/
|
|
3351
|
-
lt?: number;
|
|
3351
|
+
lt?: number | undefined;
|
|
3352
3352
|
/**
|
|
3353
3353
|
* <p>The value for the property is less than or equal to the specified value.</p>
|
|
3354
3354
|
* @public
|
|
3355
3355
|
*/
|
|
3356
|
-
lte?: number;
|
|
3356
|
+
lte?: number | undefined;
|
|
3357
3357
|
/**
|
|
3358
3358
|
* <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>
|
|
3359
3359
|
* @public
|
|
3360
3360
|
*/
|
|
3361
|
-
neq?: string[];
|
|
3361
|
+
neq?: string[] | undefined;
|
|
3362
3362
|
/**
|
|
3363
3363
|
* <p>The name of the bucket begins with the specified value.</p>
|
|
3364
3364
|
* @public
|
|
3365
3365
|
*/
|
|
3366
|
-
prefix?: string;
|
|
3366
|
+
prefix?: string | undefined;
|
|
3367
3367
|
}
|
|
3368
3368
|
/**
|
|
3369
3369
|
* @public
|
|
@@ -3386,12 +3386,12 @@ export interface BucketSortCriteria {
|
|
|
3386
3386
|
* <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>
|
|
3387
3387
|
* @public
|
|
3388
3388
|
*/
|
|
3389
|
-
attributeName?: string;
|
|
3389
|
+
attributeName?: string | undefined;
|
|
3390
3390
|
/**
|
|
3391
3391
|
* <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>
|
|
3392
3392
|
* @public
|
|
3393
3393
|
*/
|
|
3394
|
-
orderBy?: OrderBy;
|
|
3394
|
+
orderBy?: OrderBy | undefined;
|
|
3395
3395
|
}
|
|
3396
3396
|
/**
|
|
3397
3397
|
* <p>Provides aggregated statistical data for sensitive data discovery metrics that apply to S3 buckets. Each field contains aggregated data for all the buckets that have a sensitivity score (sensitivityScore) of a specified value or within a specified range (BucketStatisticsBySensitivity). If automated sensitive data discovery is currently disabled for your account, the value for each field is 0.</p>
|
|
@@ -3402,22 +3402,22 @@ export interface SensitivityAggregations {
|
|
|
3402
3402
|
* <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>
|
|
3403
3403
|
* @public
|
|
3404
3404
|
*/
|
|
3405
|
-
classifiableSizeInBytes?: number;
|
|
3405
|
+
classifiableSizeInBytes?: number | undefined;
|
|
3406
3406
|
/**
|
|
3407
3407
|
* <p>The total number of buckets that are publicly accessible due to a combination of permissions settings for each bucket.</p>
|
|
3408
3408
|
* @public
|
|
3409
3409
|
*/
|
|
3410
|
-
publiclyAccessibleCount?: number;
|
|
3410
|
+
publiclyAccessibleCount?: number | undefined;
|
|
3411
3411
|
/**
|
|
3412
3412
|
* <p>The total number of buckets.</p>
|
|
3413
3413
|
* @public
|
|
3414
3414
|
*/
|
|
3415
|
-
totalCount?: number;
|
|
3415
|
+
totalCount?: number | undefined;
|
|
3416
3416
|
/**
|
|
3417
3417
|
* <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>
|
|
3418
3418
|
* @public
|
|
3419
3419
|
*/
|
|
3420
|
-
totalSizeInBytes?: number;
|
|
3420
|
+
totalSizeInBytes?: number | undefined;
|
|
3421
3421
|
}
|
|
3422
3422
|
/**
|
|
3423
3423
|
* <p>Provides aggregated statistical data for sensitive data discovery metrics that apply to S3 buckets, grouped by bucket sensitivity score (sensitivityScore). If automated sensitive data discovery is currently disabled for your account, the value for each metric is 0.</p>
|
|
@@ -3428,22 +3428,22 @@ export interface BucketStatisticsBySensitivity {
|
|
|
3428
3428
|
* <p>The aggregated statistical data for all buckets that have a sensitivity score of -1.</p>
|
|
3429
3429
|
* @public
|
|
3430
3430
|
*/
|
|
3431
|
-
classificationError?: SensitivityAggregations;
|
|
3431
|
+
classificationError?: SensitivityAggregations | undefined;
|
|
3432
3432
|
/**
|
|
3433
3433
|
* <p>The aggregated statistical data for all buckets that have a sensitivity score of 50.</p>
|
|
3434
3434
|
* @public
|
|
3435
3435
|
*/
|
|
3436
|
-
notClassified?: SensitivityAggregations;
|
|
3436
|
+
notClassified?: SensitivityAggregations | undefined;
|
|
3437
3437
|
/**
|
|
3438
3438
|
* <p>The aggregated statistical data for all buckets that have a sensitivity score of 1-49.</p>
|
|
3439
3439
|
* @public
|
|
3440
3440
|
*/
|
|
3441
|
-
notSensitive?: SensitivityAggregations;
|
|
3441
|
+
notSensitive?: SensitivityAggregations | undefined;
|
|
3442
3442
|
/**
|
|
3443
3443
|
* <p>The aggregated statistical data for all buckets that have a sensitivity score of 51-100.</p>
|
|
3444
3444
|
* @public
|
|
3445
3445
|
*/
|
|
3446
|
-
sensitive?: SensitivityAggregations;
|
|
3446
|
+
sensitive?: SensitivityAggregations | undefined;
|
|
3447
3447
|
}
|
|
3448
3448
|
/**
|
|
3449
3449
|
* <p>Specifies an S3 bucket to store data classification results in, and the encryption settings to use when storing results in that bucket.</p>
|
|
@@ -3459,7 +3459,7 @@ export interface S3Destination {
|
|
|
3459
3459
|
* <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>
|
|
3460
3460
|
* @public
|
|
3461
3461
|
*/
|
|
3462
|
-
keyPrefix?: string;
|
|
3462
|
+
keyPrefix?: string | undefined;
|
|
3463
3463
|
/**
|
|
3464
3464
|
* <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 enabled in the same Amazon Web Services Region as the bucket.</p>
|
|
3465
3465
|
* @public
|
|
@@ -3475,7 +3475,7 @@ export interface ClassificationExportConfiguration {
|
|
|
3475
3475
|
* <p>The S3 bucket to store data classification results in, and the encryption settings to use when storing results in that bucket.</p>
|
|
3476
3476
|
* @public
|
|
3477
3477
|
*/
|
|
3478
|
-
s3Destination?: S3Destination;
|
|
3478
|
+
s3Destination?: S3Destination | undefined;
|
|
3479
3479
|
}
|
|
3480
3480
|
/**
|
|
3481
3481
|
* @public
|
|
@@ -3498,7 +3498,7 @@ export interface CreateAllowListRequest {
|
|
|
3498
3498
|
* <p>A unique, case-sensitive token that you provide to ensure the idempotency of the request.</p>
|
|
3499
3499
|
* @public
|
|
3500
3500
|
*/
|
|
3501
|
-
clientToken?: string;
|
|
3501
|
+
clientToken?: string | undefined;
|
|
3502
3502
|
/**
|
|
3503
3503
|
* <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>
|
|
3504
3504
|
* @public
|
|
@@ -3508,7 +3508,7 @@ export interface CreateAllowListRequest {
|
|
|
3508
3508
|
* <p>A custom description of the allow list. The description can contain as many as 512 characters.</p>
|
|
3509
3509
|
* @public
|
|
3510
3510
|
*/
|
|
3511
|
-
description?: string;
|
|
3511
|
+
description?: string | undefined;
|
|
3512
3512
|
/**
|
|
3513
3513
|
* <p>A custom name for the allow list. The name can contain as many as 128 characters.</p>
|
|
3514
3514
|
* @public
|
|
@@ -3518,7 +3518,7 @@ export interface CreateAllowListRequest {
|
|
|
3518
3518
|
* <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>
|
|
3519
3519
|
* @public
|
|
3520
3520
|
*/
|
|
3521
|
-
tags?: Record<string, string
|
|
3521
|
+
tags?: Record<string, string> | undefined;
|
|
3522
3522
|
}
|
|
3523
3523
|
/**
|
|
3524
3524
|
* @public
|
|
@@ -3528,12 +3528,12 @@ export interface CreateAllowListResponse {
|
|
|
3528
3528
|
* <p>The Amazon Resource Name (ARN) of the allow list.</p>
|
|
3529
3529
|
* @public
|
|
3530
3530
|
*/
|
|
3531
|
-
arn?: string;
|
|
3531
|
+
arn?: string | undefined;
|
|
3532
3532
|
/**
|
|
3533
3533
|
* <p>The unique identifier for the allow list.</p>
|
|
3534
3534
|
* @public
|
|
3535
3535
|
*/
|
|
3536
|
-
id?: string;
|
|
3536
|
+
id?: string | undefined;
|
|
3537
3537
|
}
|
|
3538
3538
|
/**
|
|
3539
3539
|
* @public
|
|
@@ -3559,7 +3559,7 @@ export interface JobScopingBlock {
|
|
|
3559
3559
|
* <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>
|
|
3560
3560
|
* @public
|
|
3561
3561
|
*/
|
|
3562
|
-
and?: JobScopeTerm[];
|
|
3562
|
+
and?: JobScopeTerm[] | undefined;
|
|
3563
3563
|
}
|
|
3564
3564
|
/**
|
|
3565
3565
|
* <p>Specifies one or more property- and tag-based conditions that define criteria for including or excluding S3 objects from a classification job. Exclude conditions take precedence over include conditions.</p>
|
|
@@ -3570,12 +3570,12 @@ export interface Scoping {
|
|
|
3570
3570
|
* <p>The property- and tag-based conditions that determine which objects to exclude from the analysis.</p>
|
|
3571
3571
|
* @public
|
|
3572
3572
|
*/
|
|
3573
|
-
excludes?: JobScopingBlock;
|
|
3573
|
+
excludes?: JobScopingBlock | undefined;
|
|
3574
3574
|
/**
|
|
3575
3575
|
* <p>The property- and tag-based conditions that determine which objects to include in the analysis.</p>
|
|
3576
3576
|
* @public
|
|
3577
3577
|
*/
|
|
3578
|
-
includes?: JobScopingBlock;
|
|
3578
|
+
includes?: JobScopingBlock | undefined;
|
|
3579
3579
|
}
|
|
3580
3580
|
/**
|
|
3581
3581
|
* <p>Specifies which S3 buckets contain the objects that a classification job analyzes, and the scope of that analysis. The bucket specification can be static (bucketDefinitions) or dynamic (bucketCriteria). If it's static, the job analyzes objects in the same predefined set of buckets each time the job runs. If it's dynamic, the job analyzes objects in any buckets that match the specified criteria each time the job starts to run.</p>
|
|
@@ -3586,17 +3586,17 @@ export interface S3JobDefinition {
|
|
|
3586
3586
|
* <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>
|
|
3587
3587
|
* @public
|
|
3588
3588
|
*/
|
|
3589
|
-
bucketCriteria?: S3BucketCriteriaForJob;
|
|
3589
|
+
bucketCriteria?: S3BucketCriteriaForJob | undefined;
|
|
3590
3590
|
/**
|
|
3591
3591
|
* <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>
|
|
3592
3592
|
* @public
|
|
3593
3593
|
*/
|
|
3594
|
-
bucketDefinitions?: S3BucketDefinitionForJob[];
|
|
3594
|
+
bucketDefinitions?: S3BucketDefinitionForJob[] | undefined;
|
|
3595
3595
|
/**
|
|
3596
3596
|
* <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>
|
|
3597
3597
|
* @public
|
|
3598
3598
|
*/
|
|
3599
|
-
scoping?: Scoping;
|
|
3599
|
+
scoping?: Scoping | undefined;
|
|
3600
3600
|
}
|
|
3601
3601
|
/**
|
|
3602
3602
|
* <p>Specifies that a classification job runs once a day, every day. This is an empty object.</p>
|
|
@@ -3613,7 +3613,7 @@ export interface MonthlySchedule {
|
|
|
3613
3613
|
* <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>
|
|
3614
3614
|
* @public
|
|
3615
3615
|
*/
|
|
3616
|
-
dayOfMonth?: number;
|
|
3616
|
+
dayOfMonth?: number | undefined;
|
|
3617
3617
|
}
|
|
3618
3618
|
/**
|
|
3619
3619
|
* @public
|
|
@@ -3641,7 +3641,7 @@ export interface WeeklySchedule {
|
|
|
3641
3641
|
* <p>The day of the week when Amazon Macie runs the job.</p>
|
|
3642
3642
|
* @public
|
|
3643
3643
|
*/
|
|
3644
|
-
dayOfWeek?: DayOfWeek;
|
|
3644
|
+
dayOfWeek?: DayOfWeek | undefined;
|
|
3645
3645
|
}
|
|
3646
3646
|
/**
|
|
3647
3647
|
* <p>Specifies the recurrence pattern for running a classification job.</p>
|
|
@@ -3652,17 +3652,17 @@ export interface JobScheduleFrequency {
|
|
|
3652
3652
|
* <p>Specifies a daily recurrence pattern for running the job.</p>
|
|
3653
3653
|
* @public
|
|
3654
3654
|
*/
|
|
3655
|
-
dailySchedule?: DailySchedule;
|
|
3655
|
+
dailySchedule?: DailySchedule | undefined;
|
|
3656
3656
|
/**
|
|
3657
3657
|
* <p>Specifies a monthly recurrence pattern for running the job.</p>
|
|
3658
3658
|
* @public
|
|
3659
3659
|
*/
|
|
3660
|
-
monthlySchedule?: MonthlySchedule;
|
|
3660
|
+
monthlySchedule?: MonthlySchedule | undefined;
|
|
3661
3661
|
/**
|
|
3662
3662
|
* <p>Specifies a weekly recurrence pattern for running the job.</p>
|
|
3663
3663
|
* @public
|
|
3664
3664
|
*/
|
|
3665
|
-
weeklySchedule?: WeeklySchedule;
|
|
3665
|
+
weeklySchedule?: WeeklySchedule | undefined;
|
|
3666
3666
|
}
|
|
3667
3667
|
/**
|
|
3668
3668
|
* @public
|
|
@@ -3672,27 +3672,27 @@ export interface CreateClassificationJobRequest {
|
|
|
3672
3672
|
* <p>An array of unique identifiers, one for each allow list for the job to use when it analyzes data.</p>
|
|
3673
3673
|
* @public
|
|
3674
3674
|
*/
|
|
3675
|
-
allowListIds?: string[];
|
|
3675
|
+
allowListIds?: string[] | undefined;
|
|
3676
3676
|
/**
|
|
3677
3677
|
* <p>A unique, case-sensitive token that you provide to ensure the idempotency of the request.</p>
|
|
3678
3678
|
* @public
|
|
3679
3679
|
*/
|
|
3680
|
-
clientToken?: string;
|
|
3680
|
+
clientToken?: string | undefined;
|
|
3681
3681
|
/**
|
|
3682
3682
|
* <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>
|
|
3683
3683
|
* @public
|
|
3684
3684
|
*/
|
|
3685
|
-
customDataIdentifierIds?: string[];
|
|
3685
|
+
customDataIdentifierIds?: string[] | undefined;
|
|
3686
3686
|
/**
|
|
3687
3687
|
* <p>A custom description of the job. The description can contain as many as 200 characters.</p>
|
|
3688
3688
|
* @public
|
|
3689
3689
|
*/
|
|
3690
|
-
description?: string;
|
|
3690
|
+
description?: string | undefined;
|
|
3691
3691
|
/**
|
|
3692
3692
|
* <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>
|
|
3693
3693
|
* @public
|
|
3694
3694
|
*/
|
|
3695
|
-
initialRun?: boolean;
|
|
3695
|
+
initialRun?: boolean | undefined;
|
|
3696
3696
|
/**
|
|
3697
3697
|
* <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 specify the recurrence pattern for the job.</p></li></ul>
|
|
3698
3698
|
* @public
|
|
@@ -3702,12 +3702,12 @@ export interface CreateClassificationJobRequest {
|
|
|
3702
3702
|
* <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>
|
|
3703
3703
|
* @public
|
|
3704
3704
|
*/
|
|
3705
|
-
managedDataIdentifierIds?: string[];
|
|
3705
|
+
managedDataIdentifierIds?: string[] | undefined;
|
|
3706
3706
|
/**
|
|
3707
3707
|
* <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 - 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 value for the customDataIdentifierIds property and don't specify any values for the managedDataIdentifierIds property.</p></li> <li><p>RECOMMENDED (default) - Use the recommended set of managed data identifiers. 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 the recommended set of managed data identifiers.</p> <p>If the job is a recurring job and you specify ALL or EXCLUDE, each job run automatically uses new managed data identifiers that are released. If you don't specify a value for this property or 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 run starts.</p> <p>To learn about individual managed data identifiers or 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> or <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>
|
|
3708
3708
|
* @public
|
|
3709
3709
|
*/
|
|
3710
|
-
managedDataIdentifierSelector?: ManagedDataIdentifierSelector;
|
|
3710
|
+
managedDataIdentifierSelector?: ManagedDataIdentifierSelector | undefined;
|
|
3711
3711
|
/**
|
|
3712
3712
|
* <p>A custom name for the job. The name can contain as many as 500 characters.</p>
|
|
3713
3713
|
* @public
|
|
@@ -3722,17 +3722,17 @@ export interface CreateClassificationJobRequest {
|
|
|
3722
3722
|
* <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>
|
|
3723
3723
|
* @public
|
|
3724
3724
|
*/
|
|
3725
|
-
samplingPercentage?: number;
|
|
3725
|
+
samplingPercentage?: number | undefined;
|
|
3726
3726
|
/**
|
|
3727
3727
|
* <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>
|
|
3728
3728
|
* @public
|
|
3729
3729
|
*/
|
|
3730
|
-
scheduleFrequency?: JobScheduleFrequency;
|
|
3730
|
+
scheduleFrequency?: JobScheduleFrequency | undefined;
|
|
3731
3731
|
/**
|
|
3732
3732
|
* <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>
|
|
3733
3733
|
* @public
|
|
3734
3734
|
*/
|
|
3735
|
-
tags?: Record<string, string
|
|
3735
|
+
tags?: Record<string, string> | undefined;
|
|
3736
3736
|
}
|
|
3737
3737
|
/**
|
|
3738
3738
|
* @public
|
|
@@ -3742,12 +3742,12 @@ export interface CreateClassificationJobResponse {
|
|
|
3742
3742
|
* <p>The Amazon Resource Name (ARN) of the job.</p>
|
|
3743
3743
|
* @public
|
|
3744
3744
|
*/
|
|
3745
|
-
jobArn?: string;
|
|
3745
|
+
jobArn?: string | undefined;
|
|
3746
3746
|
/**
|
|
3747
3747
|
* <p>The unique identifier for the job.</p>
|
|
3748
3748
|
* @public
|
|
3749
3749
|
*/
|
|
3750
|
-
jobId?: string;
|
|
3750
|
+
jobId?: string | undefined;
|
|
3751
3751
|
}
|
|
3752
3752
|
/**
|
|
3753
3753
|
* @public
|
|
@@ -3786,27 +3786,27 @@ export interface CreateCustomDataIdentifierRequest {
|
|
|
3786
3786
|
* <p>A unique, case-sensitive token that you provide to ensure the idempotency of the request.</p>
|
|
3787
3787
|
* @public
|
|
3788
3788
|
*/
|
|
3789
|
-
clientToken?: string;
|
|
3789
|
+
clientToken?: string | undefined;
|
|
3790
3790
|
/**
|
|
3791
3791
|
* <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>
|
|
3792
3792
|
* @public
|
|
3793
3793
|
*/
|
|
3794
|
-
description?: string;
|
|
3794
|
+
description?: string | undefined;
|
|
3795
3795
|
/**
|
|
3796
3796
|
* <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>
|
|
3797
3797
|
* @public
|
|
3798
3798
|
*/
|
|
3799
|
-
ignoreWords?: string[];
|
|
3799
|
+
ignoreWords?: string[] | undefined;
|
|
3800
3800
|
/**
|
|
3801
3801
|
* <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>
|
|
3802
3802
|
* @public
|
|
3803
3803
|
*/
|
|
3804
|
-
keywords?: string[];
|
|
3804
|
+
keywords?: string[] | undefined;
|
|
3805
3805
|
/**
|
|
3806
3806
|
* <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>
|
|
3807
3807
|
* @public
|
|
3808
3808
|
*/
|
|
3809
|
-
maximumMatchDistance?: number;
|
|
3809
|
+
maximumMatchDistance?: number | undefined;
|
|
3810
3810
|
/**
|
|
3811
3811
|
* <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>
|
|
3812
3812
|
* @public
|
|
@@ -3821,12 +3821,12 @@ export interface CreateCustomDataIdentifierRequest {
|
|
|
3821
3821
|
* <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>
|
|
3822
3822
|
* @public
|
|
3823
3823
|
*/
|
|
3824
|
-
severityLevels?: SeverityLevel[];
|
|
3824
|
+
severityLevels?: SeverityLevel[] | undefined;
|
|
3825
3825
|
/**
|
|
3826
3826
|
* <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>
|
|
3827
3827
|
* @public
|
|
3828
3828
|
*/
|
|
3829
|
-
tags?: Record<string, string
|
|
3829
|
+
tags?: Record<string, string> | undefined;
|
|
3830
3830
|
}
|
|
3831
3831
|
/**
|
|
3832
3832
|
* @public
|
|
@@ -3836,7 +3836,7 @@ export interface CreateCustomDataIdentifierResponse {
|
|
|
3836
3836
|
* <p>The unique identifier for the custom data identifier that was created.</p>
|
|
3837
3837
|
* @public
|
|
3838
3838
|
*/
|
|
3839
|
-
customDataIdentifierId?: string;
|
|
3839
|
+
customDataIdentifierId?: string | undefined;
|
|
3840
3840
|
}
|
|
3841
3841
|
/**
|
|
3842
3842
|
* <p>Specifies the operator to use in a property-based condition that filters the results of a query for findings. For detailed information and examples of each operator, see <a href="https://docs.aws.amazon.com/macie/latest/user/findings-filter-basics.html">Fundamentals of filtering findings</a> in the <i>Amazon Macie User Guide</i>.</p>
|
|
@@ -3847,37 +3847,37 @@ export interface CriterionAdditionalProperties {
|
|
|
3847
3847
|
* <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>
|
|
3848
3848
|
* @public
|
|
3849
3849
|
*/
|
|
3850
|
-
eq?: string[];
|
|
3850
|
+
eq?: string[] | undefined;
|
|
3851
3851
|
/**
|
|
3852
3852
|
* <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>
|
|
3853
3853
|
* @public
|
|
3854
3854
|
*/
|
|
3855
|
-
eqExactMatch?: string[];
|
|
3855
|
+
eqExactMatch?: string[] | undefined;
|
|
3856
3856
|
/**
|
|
3857
3857
|
* <p>The value for the property is greater than the specified value.</p>
|
|
3858
3858
|
* @public
|
|
3859
3859
|
*/
|
|
3860
|
-
gt?: number;
|
|
3860
|
+
gt?: number | undefined;
|
|
3861
3861
|
/**
|
|
3862
3862
|
* <p>The value for the property is greater than or equal to the specified value.</p>
|
|
3863
3863
|
* @public
|
|
3864
3864
|
*/
|
|
3865
|
-
gte?: number;
|
|
3865
|
+
gte?: number | undefined;
|
|
3866
3866
|
/**
|
|
3867
3867
|
* <p>The value for the property is less than the specified value.</p>
|
|
3868
3868
|
* @public
|
|
3869
3869
|
*/
|
|
3870
|
-
lt?: number;
|
|
3870
|
+
lt?: number | undefined;
|
|
3871
3871
|
/**
|
|
3872
3872
|
* <p>The value for the property is less than or equal to the specified value.</p>
|
|
3873
3873
|
* @public
|
|
3874
3874
|
*/
|
|
3875
|
-
lte?: number;
|
|
3875
|
+
lte?: number | undefined;
|
|
3876
3876
|
/**
|
|
3877
3877
|
* <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>
|
|
3878
3878
|
* @public
|
|
3879
3879
|
*/
|
|
3880
|
-
neq?: string[];
|
|
3880
|
+
neq?: string[] | undefined;
|
|
3881
3881
|
}
|
|
3882
3882
|
/**
|
|
3883
3883
|
* <p>Specifies, as a map, one or more property-based conditions that filter the results of a query for findings.</p>
|
|
@@ -3888,7 +3888,7 @@ export interface FindingCriteria {
|
|
|
3888
3888
|
* <p>A condition that specifies the property, operator, and one or more values to use to filter the results.</p>
|
|
3889
3889
|
* @public
|
|
3890
3890
|
*/
|
|
3891
|
-
criterion?: Record<string, CriterionAdditionalProperties
|
|
3891
|
+
criterion?: Record<string, CriterionAdditionalProperties> | undefined;
|
|
3892
3892
|
}
|
|
3893
3893
|
/**
|
|
3894
3894
|
* @public
|
|
@@ -3903,12 +3903,12 @@ export interface CreateFindingsFilterRequest {
|
|
|
3903
3903
|
* <p>A unique, case-sensitive token that you provide to ensure the idempotency of the request.</p>
|
|
3904
3904
|
* @public
|
|
3905
3905
|
*/
|
|
3906
|
-
clientToken?: string;
|
|
3906
|
+
clientToken?: string | undefined;
|
|
3907
3907
|
/**
|
|
3908
3908
|
* <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>
|
|
3909
3909
|
* @public
|
|
3910
3910
|
*/
|
|
3911
|
-
description?: string;
|
|
3911
|
+
description?: string | undefined;
|
|
3912
3912
|
/**
|
|
3913
3913
|
* <p>The criteria to use to filter findings.</p>
|
|
3914
3914
|
* @public
|
|
@@ -3923,12 +3923,12 @@ export interface CreateFindingsFilterRequest {
|
|
|
3923
3923
|
* <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>
|
|
3924
3924
|
* @public
|
|
3925
3925
|
*/
|
|
3926
|
-
position?: number;
|
|
3926
|
+
position?: number | undefined;
|
|
3927
3927
|
/**
|
|
3928
3928
|
* <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>
|
|
3929
3929
|
* @public
|
|
3930
3930
|
*/
|
|
3931
|
-
tags?: Record<string, string
|
|
3931
|
+
tags?: Record<string, string> | undefined;
|
|
3932
3932
|
}
|
|
3933
3933
|
/**
|
|
3934
3934
|
* @public
|
|
@@ -3938,12 +3938,12 @@ export interface CreateFindingsFilterResponse {
|
|
|
3938
3938
|
* <p>The Amazon Resource Name (ARN) of the filter that was created.</p>
|
|
3939
3939
|
* @public
|
|
3940
3940
|
*/
|
|
3941
|
-
arn?: string;
|
|
3941
|
+
arn?: string | undefined;
|
|
3942
3942
|
/**
|
|
3943
3943
|
* <p>The unique identifier for the filter that was created.</p>
|
|
3944
3944
|
* @public
|
|
3945
3945
|
*/
|
|
3946
|
-
id?: string;
|
|
3946
|
+
id?: string | undefined;
|
|
3947
3947
|
}
|
|
3948
3948
|
/**
|
|
3949
3949
|
* @public
|
|
@@ -3958,12 +3958,12 @@ export interface CreateInvitationsRequest {
|
|
|
3958
3958
|
* <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>
|
|
3959
3959
|
* @public
|
|
3960
3960
|
*/
|
|
3961
|
-
disableEmailNotification?: boolean;
|
|
3961
|
+
disableEmailNotification?: boolean | undefined;
|
|
3962
3962
|
/**
|
|
3963
3963
|
* <p>Custom text to include in the email message that contains the invitation. The text can contain as many as 80 alphanumeric characters.</p>
|
|
3964
3964
|
* @public
|
|
3965
3965
|
*/
|
|
3966
|
-
message?: string;
|
|
3966
|
+
message?: string | undefined;
|
|
3967
3967
|
}
|
|
3968
3968
|
/**
|
|
3969
3969
|
* @public
|
|
@@ -3973,7 +3973,7 @@ export interface CreateInvitationsResponse {
|
|
|
3973
3973
|
* <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>
|
|
3974
3974
|
* @public
|
|
3975
3975
|
*/
|
|
3976
|
-
unprocessedAccounts?: UnprocessedAccount[];
|
|
3976
|
+
unprocessedAccounts?: UnprocessedAccount[] | undefined;
|
|
3977
3977
|
}
|
|
3978
3978
|
/**
|
|
3979
3979
|
* @public
|
|
@@ -3988,7 +3988,7 @@ export interface CreateMemberRequest {
|
|
|
3988
3988
|
* <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>
|
|
3989
3989
|
* @public
|
|
3990
3990
|
*/
|
|
3991
|
-
tags?: Record<string, string
|
|
3991
|
+
tags?: Record<string, string> | undefined;
|
|
3992
3992
|
}
|
|
3993
3993
|
/**
|
|
3994
3994
|
* @public
|
|
@@ -3998,7 +3998,7 @@ export interface CreateMemberResponse {
|
|
|
3998
3998
|
* <p>The Amazon Resource Name (ARN) of the account that was associated with the administrator account.</p>
|
|
3999
3999
|
* @public
|
|
4000
4000
|
*/
|
|
4001
|
-
arn?: string;
|
|
4001
|
+
arn?: string | undefined;
|
|
4002
4002
|
}
|
|
4003
4003
|
/**
|
|
4004
4004
|
* @public
|
|
@@ -4008,7 +4008,7 @@ export interface CreateSampleFindingsRequest {
|
|
|
4008
4008
|
* <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>
|
|
4009
4009
|
* @public
|
|
4010
4010
|
*/
|
|
4011
|
-
findingTypes?: FindingType[];
|
|
4011
|
+
findingTypes?: FindingType[] | undefined;
|
|
4012
4012
|
}
|
|
4013
4013
|
/**
|
|
4014
4014
|
* @public
|
|
@@ -4033,7 +4033,7 @@ export interface DeclineInvitationsResponse {
|
|
|
4033
4033
|
* <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>
|
|
4034
4034
|
* @public
|
|
4035
4035
|
*/
|
|
4036
|
-
unprocessedAccounts?: UnprocessedAccount[];
|
|
4036
|
+
unprocessedAccounts?: UnprocessedAccount[] | undefined;
|
|
4037
4037
|
}
|
|
4038
4038
|
/**
|
|
4039
4039
|
* @public
|
|
@@ -4048,7 +4048,7 @@ export interface DeleteAllowListRequest {
|
|
|
4048
4048
|
* <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>
|
|
4049
4049
|
* @public
|
|
4050
4050
|
*/
|
|
4051
|
-
ignoreJobChecks?: string;
|
|
4051
|
+
ignoreJobChecks?: string | undefined;
|
|
4052
4052
|
}
|
|
4053
4053
|
/**
|
|
4054
4054
|
* @public
|
|
@@ -4103,7 +4103,7 @@ export interface DeleteInvitationsResponse {
|
|
|
4103
4103
|
* <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>
|
|
4104
4104
|
* @public
|
|
4105
4105
|
*/
|
|
4106
|
-
unprocessedAccounts?: UnprocessedAccount[];
|
|
4106
|
+
unprocessedAccounts?: UnprocessedAccount[] | undefined;
|
|
4107
4107
|
}
|
|
4108
4108
|
/**
|
|
4109
4109
|
* @public
|
|
@@ -4128,22 +4128,22 @@ export interface DescribeBucketsRequest {
|
|
|
4128
4128
|
* <p>The criteria to use to filter the query results.</p>
|
|
4129
4129
|
* @public
|
|
4130
4130
|
*/
|
|
4131
|
-
criteria?: Record<string, BucketCriteriaAdditionalProperties
|
|
4131
|
+
criteria?: Record<string, BucketCriteriaAdditionalProperties> | undefined;
|
|
4132
4132
|
/**
|
|
4133
4133
|
* <p>The maximum number of items to include in each page of the response. The default value is 50.</p>
|
|
4134
4134
|
* @public
|
|
4135
4135
|
*/
|
|
4136
|
-
maxResults?: number;
|
|
4136
|
+
maxResults?: number | undefined;
|
|
4137
4137
|
/**
|
|
4138
4138
|
* <p>The nextToken string that specifies which page of results to return in a paginated response.</p>
|
|
4139
4139
|
* @public
|
|
4140
4140
|
*/
|
|
4141
|
-
nextToken?: string;
|
|
4141
|
+
nextToken?: string | undefined;
|
|
4142
4142
|
/**
|
|
4143
4143
|
* <p>The criteria to use to sort the query results.</p>
|
|
4144
4144
|
* @public
|
|
4145
4145
|
*/
|
|
4146
|
-
sortCriteria?: BucketSortCriteria;
|
|
4146
|
+
sortCriteria?: BucketSortCriteria | undefined;
|
|
4147
4147
|
}
|
|
4148
4148
|
/**
|
|
4149
4149
|
* @public
|
|
@@ -4153,12 +4153,12 @@ export interface DescribeBucketsResponse {
|
|
|
4153
4153
|
* <p>An array of objects, one for each bucket that matches the filter criteria specified in the request.</p>
|
|
4154
4154
|
* @public
|
|
4155
4155
|
*/
|
|
4156
|
-
buckets?: BucketMetadata[];
|
|
4156
|
+
buckets?: BucketMetadata[] | undefined;
|
|
4157
4157
|
/**
|
|
4158
4158
|
* <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>
|
|
4159
4159
|
* @public
|
|
4160
4160
|
*/
|
|
4161
|
-
nextToken?: string;
|
|
4161
|
+
nextToken?: string | undefined;
|
|
4162
4162
|
}
|
|
4163
4163
|
/**
|
|
4164
4164
|
* @public
|
|
@@ -4179,12 +4179,12 @@ export interface Statistics {
|
|
|
4179
4179
|
* <p>The approximate number of objects that the job has yet to process during its current run.</p>
|
|
4180
4180
|
* @public
|
|
4181
4181
|
*/
|
|
4182
|
-
approximateNumberOfObjectsToProcess?: number;
|
|
4182
|
+
approximateNumberOfObjectsToProcess?: number | undefined;
|
|
4183
4183
|
/**
|
|
4184
4184
|
* <p>The number of times that the job has run.</p>
|
|
4185
4185
|
* @public
|
|
4186
4186
|
*/
|
|
4187
|
-
numberOfRuns?: number;
|
|
4187
|
+
numberOfRuns?: number | undefined;
|
|
4188
4188
|
}
|
|
4189
4189
|
/**
|
|
4190
4190
|
* @public
|
|
@@ -4194,107 +4194,107 @@ export interface DescribeClassificationJobResponse {
|
|
|
4194
4194
|
* <p>An array of unique identifiers, one for each allow list that the job is configured to use when it analyzes data.</p>
|
|
4195
4195
|
* @public
|
|
4196
4196
|
*/
|
|
4197
|
-
allowListIds?: string[];
|
|
4197
|
+
allowListIds?: string[] | undefined;
|
|
4198
4198
|
/**
|
|
4199
4199
|
* <p>The token that was provided to ensure the idempotency of the request to create the job.</p>
|
|
4200
4200
|
* @public
|
|
4201
4201
|
*/
|
|
4202
|
-
clientToken?: string;
|
|
4202
|
+
clientToken?: string | undefined;
|
|
4203
4203
|
/**
|
|
4204
4204
|
* <p>The date and time, in UTC and extended ISO 8601 format, when the job was created.</p>
|
|
4205
4205
|
* @public
|
|
4206
4206
|
*/
|
|
4207
|
-
createdAt?: Date;
|
|
4207
|
+
createdAt?: Date | undefined;
|
|
4208
4208
|
/**
|
|
4209
4209
|
* <p>An array of unique identifiers, one for each custom data identifier that the job is configured to use when it analyzes data. This value is null if the job is configured to use only managed data identifiers to analyze data.</p>
|
|
4210
4210
|
* @public
|
|
4211
4211
|
*/
|
|
4212
|
-
customDataIdentifierIds?: string[];
|
|
4212
|
+
customDataIdentifierIds?: string[] | undefined;
|
|
4213
4213
|
/**
|
|
4214
4214
|
* <p>The custom description of the job.</p>
|
|
4215
4215
|
* @public
|
|
4216
4216
|
*/
|
|
4217
|
-
description?: string;
|
|
4217
|
+
description?: string | undefined;
|
|
4218
4218
|
/**
|
|
4219
4219
|
* <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>
|
|
4220
4220
|
* @public
|
|
4221
4221
|
*/
|
|
4222
|
-
initialRun?: boolean;
|
|
4222
|
+
initialRun?: boolean | undefined;
|
|
4223
4223
|
/**
|
|
4224
4224
|
* <p>The Amazon Resource Name (ARN) of the job.</p>
|
|
4225
4225
|
* @public
|
|
4226
4226
|
*/
|
|
4227
|
-
jobArn?: string;
|
|
4227
|
+
jobArn?: string | undefined;
|
|
4228
4228
|
/**
|
|
4229
4229
|
* <p>The unique identifier for the job.</p>
|
|
4230
4230
|
* @public
|
|
4231
4231
|
*/
|
|
4232
|
-
jobId?: string;
|
|
4232
|
+
jobId?: string | undefined;
|
|
4233
4233
|
/**
|
|
4234
4234
|
* <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>
|
|
4235
4235
|
* @public
|
|
4236
4236
|
*/
|
|
4237
|
-
jobStatus?: JobStatus;
|
|
4237
|
+
jobStatus?: JobStatus | undefined;
|
|
4238
4238
|
/**
|
|
4239
4239
|
* <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>
|
|
4240
4240
|
* @public
|
|
4241
4241
|
*/
|
|
4242
|
-
jobType?: JobType;
|
|
4242
|
+
jobType?: JobType | undefined;
|
|
4243
4243
|
/**
|
|
4244
4244
|
* <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>
|
|
4245
4245
|
* @public
|
|
4246
4246
|
*/
|
|
4247
|
-
lastRunErrorStatus?: LastRunErrorStatus;
|
|
4247
|
+
lastRunErrorStatus?: LastRunErrorStatus | undefined;
|
|
4248
4248
|
/**
|
|
4249
4249
|
* <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>
|
|
4250
4250
|
* @public
|
|
4251
4251
|
*/
|
|
4252
|
-
lastRunTime?: Date;
|
|
4252
|
+
lastRunTime?: Date | undefined;
|
|
4253
4253
|
/**
|
|
4254
4254
|
* <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>
|
|
4255
4255
|
* @public
|
|
4256
4256
|
*/
|
|
4257
|
-
managedDataIdentifierIds?: string[];
|
|
4257
|
+
managedDataIdentifierIds?: string[] | undefined;
|
|
4258
4258
|
/**
|
|
4259
4259
|
* <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 - 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 (default) - Use the recommended set of managed data identifiers.</p></li></ul> <p>If this value is null, the job uses the recommended set of managed data identifiers.</p> <p>If the job is a recurring job and this value is ALL or EXCLUDE, each job run automatically uses new managed data identifiers that are released. If this value is null or 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>To learn about individual managed data identifiers or 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> or <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>
|
|
4260
4260
|
* @public
|
|
4261
4261
|
*/
|
|
4262
|
-
managedDataIdentifierSelector?: ManagedDataIdentifierSelector;
|
|
4262
|
+
managedDataIdentifierSelector?: ManagedDataIdentifierSelector | undefined;
|
|
4263
4263
|
/**
|
|
4264
4264
|
* <p>The custom name of the job.</p>
|
|
4265
4265
|
* @public
|
|
4266
4266
|
*/
|
|
4267
|
-
name?: string;
|
|
4267
|
+
name?: string | undefined;
|
|
4268
4268
|
/**
|
|
4269
4269
|
* <p>The S3 buckets that contain the objects to analyze, and the scope of that analysis.</p>
|
|
4270
4270
|
* @public
|
|
4271
4271
|
*/
|
|
4272
|
-
s3JobDefinition?: S3JobDefinition;
|
|
4272
|
+
s3JobDefinition?: S3JobDefinition | undefined;
|
|
4273
4273
|
/**
|
|
4274
4274
|
* <p>The sampling depth, as a percentage, that determines the percentage of eligible objects that the job analyzes.</p>
|
|
4275
4275
|
* @public
|
|
4276
4276
|
*/
|
|
4277
|
-
samplingPercentage?: number;
|
|
4277
|
+
samplingPercentage?: number | undefined;
|
|
4278
4278
|
/**
|
|
4279
4279
|
* <p>The recurrence pattern for running the job. This value is null if the job is configured to run only once.</p>
|
|
4280
4280
|
* @public
|
|
4281
4281
|
*/
|
|
4282
|
-
scheduleFrequency?: JobScheduleFrequency;
|
|
4282
|
+
scheduleFrequency?: JobScheduleFrequency | undefined;
|
|
4283
4283
|
/**
|
|
4284
4284
|
* <p>The number of times that the job has run and processing statistics for the job's current run.</p>
|
|
4285
4285
|
* @public
|
|
4286
4286
|
*/
|
|
4287
|
-
statistics?: Statistics;
|
|
4287
|
+
statistics?: Statistics | undefined;
|
|
4288
4288
|
/**
|
|
4289
4289
|
* <p>A map of key-value pairs that specifies which tags (keys and values) are associated with the job.</p>
|
|
4290
4290
|
* @public
|
|
4291
4291
|
*/
|
|
4292
|
-
tags?: Record<string, string
|
|
4292
|
+
tags?: Record<string, string> | undefined;
|
|
4293
4293
|
/**
|
|
4294
4294
|
* <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>
|
|
4295
4295
|
* @public
|
|
4296
4296
|
*/
|
|
4297
|
-
userPausedDetails?: UserPausedDetails;
|
|
4297
|
+
userPausedDetails?: UserPausedDetails | undefined;
|
|
4298
4298
|
}
|
|
4299
4299
|
/**
|
|
4300
4300
|
* @public
|
|
@@ -4309,12 +4309,12 @@ export interface DescribeOrganizationConfigurationResponse {
|
|
|
4309
4309
|
* <p>Specifies whether Amazon Macie is enabled automatically for accounts that are added to the organization.</p>
|
|
4310
4310
|
* @public
|
|
4311
4311
|
*/
|
|
4312
|
-
autoEnable?: boolean;
|
|
4312
|
+
autoEnable?: boolean | undefined;
|
|
4313
4313
|
/**
|
|
4314
4314
|
* <p>Specifies whether the maximum number of Amazon Macie member accounts are part of the organization.</p>
|
|
4315
4315
|
* @public
|
|
4316
4316
|
*/
|
|
4317
|
-
maxAccountLimitReached?: boolean;
|
|
4317
|
+
maxAccountLimitReached?: boolean | undefined;
|
|
4318
4318
|
}
|
|
4319
4319
|
/**
|
|
4320
4320
|
* @public
|
|
@@ -4409,17 +4409,17 @@ export interface EnableMacieRequest {
|
|
|
4409
4409
|
* <p>A unique, case-sensitive token that you provide to ensure the idempotency of the request.</p>
|
|
4410
4410
|
* @public
|
|
4411
4411
|
*/
|
|
4412
|
-
clientToken?: string;
|
|
4412
|
+
clientToken?: string | undefined;
|
|
4413
4413
|
/**
|
|
4414
4414
|
* <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>
|
|
4415
4415
|
* @public
|
|
4416
4416
|
*/
|
|
4417
|
-
findingPublishingFrequency?: FindingPublishingFrequency;
|
|
4417
|
+
findingPublishingFrequency?: FindingPublishingFrequency | undefined;
|
|
4418
4418
|
/**
|
|
4419
4419
|
* <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>
|
|
4420
4420
|
* @public
|
|
4421
4421
|
*/
|
|
4422
|
-
status?: MacieStatus;
|
|
4422
|
+
status?: MacieStatus | undefined;
|
|
4423
4423
|
}
|
|
4424
4424
|
/**
|
|
4425
4425
|
* @public
|
|
@@ -4439,7 +4439,7 @@ export interface EnableOrganizationAdminAccountRequest {
|
|
|
4439
4439
|
* <p>A unique, case-sensitive token that you provide to ensure the idempotency of the request.</p>
|
|
4440
4440
|
* @public
|
|
4441
4441
|
*/
|
|
4442
|
-
clientToken?: string;
|
|
4442
|
+
clientToken?: string | undefined;
|
|
4443
4443
|
}
|
|
4444
4444
|
/**
|
|
4445
4445
|
* @public
|
|
@@ -4467,12 +4467,12 @@ export interface FindingStatisticsSortCriteria {
|
|
|
4467
4467
|
* <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>
|
|
4468
4468
|
* @public
|
|
4469
4469
|
*/
|
|
4470
|
-
attributeName?: FindingStatisticsSortAttributeName;
|
|
4470
|
+
attributeName?: FindingStatisticsSortAttributeName | undefined;
|
|
4471
4471
|
/**
|
|
4472
4472
|
* <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>
|
|
4473
4473
|
* @public
|
|
4474
4474
|
*/
|
|
4475
|
-
orderBy?: OrderBy;
|
|
4475
|
+
orderBy?: OrderBy | undefined;
|
|
4476
4476
|
}
|
|
4477
4477
|
/**
|
|
4478
4478
|
* @public
|
|
@@ -4487,7 +4487,7 @@ export interface GetAdministratorAccountResponse {
|
|
|
4487
4487
|
* <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>
|
|
4488
4488
|
* @public
|
|
4489
4489
|
*/
|
|
4490
|
-
administrator?: Invitation;
|
|
4490
|
+
administrator?: Invitation | undefined;
|
|
4491
4491
|
}
|
|
4492
4492
|
/**
|
|
4493
4493
|
* @public
|
|
@@ -4507,47 +4507,47 @@ export interface GetAllowListResponse {
|
|
|
4507
4507
|
* <p>The Amazon Resource Name (ARN) of the allow list.</p>
|
|
4508
4508
|
* @public
|
|
4509
4509
|
*/
|
|
4510
|
-
arn?: string;
|
|
4510
|
+
arn?: string | undefined;
|
|
4511
4511
|
/**
|
|
4512
4512
|
* <p>The date and time, in UTC and extended ISO 8601 format, when the allow list was created in Amazon Macie.</p>
|
|
4513
4513
|
* @public
|
|
4514
4514
|
*/
|
|
4515
|
-
createdAt?: Date;
|
|
4515
|
+
createdAt?: Date | undefined;
|
|
4516
4516
|
/**
|
|
4517
4517
|
* <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>
|
|
4518
4518
|
* @public
|
|
4519
4519
|
*/
|
|
4520
|
-
criteria?: AllowListCriteria;
|
|
4520
|
+
criteria?: AllowListCriteria | undefined;
|
|
4521
4521
|
/**
|
|
4522
4522
|
* <p>The custom description of the allow list.</p>
|
|
4523
4523
|
* @public
|
|
4524
4524
|
*/
|
|
4525
|
-
description?: string;
|
|
4525
|
+
description?: string | undefined;
|
|
4526
4526
|
/**
|
|
4527
4527
|
* <p>The unique identifier for the allow list.</p>
|
|
4528
4528
|
* @public
|
|
4529
4529
|
*/
|
|
4530
|
-
id?: string;
|
|
4530
|
+
id?: string | undefined;
|
|
4531
4531
|
/**
|
|
4532
4532
|
* <p>The custom name of the allow list.</p>
|
|
4533
4533
|
* @public
|
|
4534
4534
|
*/
|
|
4535
|
-
name?: string;
|
|
4535
|
+
name?: string | undefined;
|
|
4536
4536
|
/**
|
|
4537
4537
|
* <p>The current status of the allow list, which indicates whether Amazon Macie can access and use the list's criteria.</p>
|
|
4538
4538
|
* @public
|
|
4539
4539
|
*/
|
|
4540
|
-
status?: AllowListStatus;
|
|
4540
|
+
status?: AllowListStatus | undefined;
|
|
4541
4541
|
/**
|
|
4542
4542
|
* <p>A map of key-value pairs that specifies which tags (keys and values) are associated with the allow list.</p>
|
|
4543
4543
|
* @public
|
|
4544
4544
|
*/
|
|
4545
|
-
tags?: Record<string, string
|
|
4545
|
+
tags?: Record<string, string> | undefined;
|
|
4546
4546
|
/**
|
|
4547
4547
|
* <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>
|
|
4548
4548
|
* @public
|
|
4549
4549
|
*/
|
|
4550
|
-
updatedAt?: Date;
|
|
4550
|
+
updatedAt?: Date | undefined;
|
|
4551
4551
|
}
|
|
4552
4552
|
/**
|
|
4553
4553
|
* @public
|
|
@@ -4562,37 +4562,37 @@ export interface GetAutomatedDiscoveryConfigurationResponse {
|
|
|
4562
4562
|
* <p>Specifies whether automated sensitive data discovery is enabled automatically for accounts in the organization. Possible values are: ALL, enable it for all existing accounts and new member accounts; NEW, enable it only for new member accounts; and, NONE, don't enable it for any accounts.</p>
|
|
4563
4563
|
* @public
|
|
4564
4564
|
*/
|
|
4565
|
-
autoEnableOrganizationMembers?: AutoEnableMode;
|
|
4565
|
+
autoEnableOrganizationMembers?: AutoEnableMode | undefined;
|
|
4566
4566
|
/**
|
|
4567
4567
|
* <p>The unique identifier for the classification scope that's used when performing automated sensitive data discovery. The classification scope specifies S3 buckets to exclude from analyses.</p>
|
|
4568
4568
|
* @public
|
|
4569
4569
|
*/
|
|
4570
|
-
classificationScopeId?: string;
|
|
4570
|
+
classificationScopeId?: string | undefined;
|
|
4571
4571
|
/**
|
|
4572
4572
|
* <p>The date and time, in UTC and extended ISO 8601 format, when automated sensitive data discovery was most recently disabled. This value is null if automated sensitive data discovery is currently enabled.</p>
|
|
4573
4573
|
* @public
|
|
4574
4574
|
*/
|
|
4575
|
-
disabledAt?: Date;
|
|
4575
|
+
disabledAt?: Date | undefined;
|
|
4576
4576
|
/**
|
|
4577
4577
|
* <p>The date and time, in UTC and extended ISO 8601 format, when automated sensitive data discovery was initially enabled. This value is null if automated sensitive data discovery has never been enabled.</p>
|
|
4578
4578
|
* @public
|
|
4579
4579
|
*/
|
|
4580
|
-
firstEnabledAt?: Date;
|
|
4580
|
+
firstEnabledAt?: Date | undefined;
|
|
4581
4581
|
/**
|
|
4582
4582
|
* <p>The date and time, in UTC and extended ISO 8601 format, when the configuration settings or status of automated sensitive data discovery was most recently changed.</p>
|
|
4583
4583
|
* @public
|
|
4584
4584
|
*/
|
|
4585
|
-
lastUpdatedAt?: Date;
|
|
4585
|
+
lastUpdatedAt?: Date | undefined;
|
|
4586
4586
|
/**
|
|
4587
4587
|
* <p>The unique identifier for the sensitivity inspection template that's used when performing automated sensitive data discovery. The template specifies which allow lists, custom data identifiers, and managed data identifiers to use when analyzing data.</p>
|
|
4588
4588
|
* @public
|
|
4589
4589
|
*/
|
|
4590
|
-
sensitivityInspectionTemplateId?: string;
|
|
4590
|
+
sensitivityInspectionTemplateId?: string | undefined;
|
|
4591
4591
|
/**
|
|
4592
4592
|
* <p>The current status of automated sensitive data discovery for the organization or account. Possible values are: ENABLED, use the specified settings to perform automated sensitive data discovery activities; and, DISABLED, don't perform automated sensitive data discovery activities.</p>
|
|
4593
4593
|
* @public
|
|
4594
4594
|
*/
|
|
4595
|
-
status?: AutomatedDiscoveryStatus;
|
|
4595
|
+
status?: AutomatedDiscoveryStatus | undefined;
|
|
4596
4596
|
}
|
|
4597
4597
|
/**
|
|
4598
4598
|
* @public
|
|
@@ -4602,7 +4602,7 @@ export interface GetBucketStatisticsRequest {
|
|
|
4602
4602
|
* <p>The unique identifier for the Amazon Web Services account.</p>
|
|
4603
4603
|
* @public
|
|
4604
4604
|
*/
|
|
4605
|
-
accountId?: string;
|
|
4605
|
+
accountId?: string | undefined;
|
|
4606
4606
|
}
|
|
4607
4607
|
/**
|
|
4608
4608
|
* @public
|
|
@@ -4612,72 +4612,72 @@ export interface GetBucketStatisticsResponse {
|
|
|
4612
4612
|
* <p>The total number of buckets.</p>
|
|
4613
4613
|
* @public
|
|
4614
4614
|
*/
|
|
4615
|
-
bucketCount?: number;
|
|
4615
|
+
bucketCount?: number | undefined;
|
|
4616
4616
|
/**
|
|
4617
4617
|
* <p>The total number of buckets that are publicly accessible due to a combination of permissions settings for each bucket.</p>
|
|
4618
4618
|
* @public
|
|
4619
4619
|
*/
|
|
4620
|
-
bucketCountByEffectivePermission?: BucketCountByEffectivePermission;
|
|
4620
|
+
bucketCountByEffectivePermission?: BucketCountByEffectivePermission | undefined;
|
|
4621
4621
|
/**
|
|
4622
4622
|
* <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>
|
|
4623
4623
|
* @public
|
|
4624
4624
|
*/
|
|
4625
|
-
bucketCountByEncryptionType?: BucketCountByEncryptionType;
|
|
4625
|
+
bucketCountByEncryptionType?: BucketCountByEncryptionType | undefined;
|
|
4626
4626
|
/**
|
|
4627
4627
|
* <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>
|
|
4628
4628
|
* @public
|
|
4629
4629
|
*/
|
|
4630
|
-
bucketCountByObjectEncryptionRequirement?: BucketCountPolicyAllowsUnencryptedObjectUploads;
|
|
4630
|
+
bucketCountByObjectEncryptionRequirement?: BucketCountPolicyAllowsUnencryptedObjectUploads | undefined;
|
|
4631
4631
|
/**
|
|
4632
4632
|
* <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>
|
|
4633
4633
|
* @public
|
|
4634
4634
|
*/
|
|
4635
|
-
bucketCountBySharedAccessType?: BucketCountBySharedAccessType;
|
|
4635
|
+
bucketCountBySharedAccessType?: BucketCountBySharedAccessType | undefined;
|
|
4636
4636
|
/**
|
|
4637
4637
|
* <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>
|
|
4638
4638
|
* @public
|
|
4639
4639
|
*/
|
|
4640
|
-
bucketStatisticsBySensitivity?: BucketStatisticsBySensitivity;
|
|
4640
|
+
bucketStatisticsBySensitivity?: BucketStatisticsBySensitivity | undefined;
|
|
4641
4641
|
/**
|
|
4642
4642
|
* <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>
|
|
4643
4643
|
* @public
|
|
4644
4644
|
*/
|
|
4645
|
-
classifiableObjectCount?: number;
|
|
4645
|
+
classifiableObjectCount?: number | undefined;
|
|
4646
4646
|
/**
|
|
4647
4647
|
* <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>
|
|
4648
4648
|
* @public
|
|
4649
4649
|
*/
|
|
4650
|
-
classifiableSizeInBytes?: number;
|
|
4650
|
+
classifiableSizeInBytes?: number | undefined;
|
|
4651
4651
|
/**
|
|
4652
4652
|
* <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>
|
|
4653
4653
|
* @public
|
|
4654
4654
|
*/
|
|
4655
|
-
lastUpdated?: Date;
|
|
4655
|
+
lastUpdated?: Date | undefined;
|
|
4656
4656
|
/**
|
|
4657
4657
|
* <p>The total number of objects in the buckets.</p>
|
|
4658
4658
|
* @public
|
|
4659
4659
|
*/
|
|
4660
|
-
objectCount?: number;
|
|
4660
|
+
objectCount?: number | undefined;
|
|
4661
4661
|
/**
|
|
4662
4662
|
* <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>
|
|
4663
4663
|
* @public
|
|
4664
4664
|
*/
|
|
4665
|
-
sizeInBytes?: number;
|
|
4665
|
+
sizeInBytes?: number | undefined;
|
|
4666
4666
|
/**
|
|
4667
4667
|
* <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>
|
|
4668
4668
|
* @public
|
|
4669
4669
|
*/
|
|
4670
|
-
sizeInBytesCompressed?: number;
|
|
4670
|
+
sizeInBytesCompressed?: number | undefined;
|
|
4671
4671
|
/**
|
|
4672
4672
|
* <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>
|
|
4673
4673
|
* @public
|
|
4674
4674
|
*/
|
|
4675
|
-
unclassifiableObjectCount?: ObjectLevelStatistics;
|
|
4675
|
+
unclassifiableObjectCount?: ObjectLevelStatistics | undefined;
|
|
4676
4676
|
/**
|
|
4677
4677
|
* <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>
|
|
4678
4678
|
* @public
|
|
4679
4679
|
*/
|
|
4680
|
-
unclassifiableObjectSizeInBytes?: ObjectLevelStatistics;
|
|
4680
|
+
unclassifiableObjectSizeInBytes?: ObjectLevelStatistics | undefined;
|
|
4681
4681
|
}
|
|
4682
4682
|
/**
|
|
4683
4683
|
* @public
|
|
@@ -4692,7 +4692,7 @@ export interface GetClassificationExportConfigurationResponse {
|
|
|
4692
4692
|
* <p>The location where data classification results are stored, and the encryption settings that are used when storing results in that location.</p>
|
|
4693
4693
|
* @public
|
|
4694
4694
|
*/
|
|
4695
|
-
configuration?: ClassificationExportConfiguration;
|
|
4695
|
+
configuration?: ClassificationExportConfiguration | undefined;
|
|
4696
4696
|
}
|
|
4697
4697
|
/**
|
|
4698
4698
|
* @public
|
|
@@ -4734,17 +4734,17 @@ export interface GetClassificationScopeResponse {
|
|
|
4734
4734
|
* <p>The unique identifier for the classification scope.</p>
|
|
4735
4735
|
* @public
|
|
4736
4736
|
*/
|
|
4737
|
-
id?: string;
|
|
4737
|
+
id?: string | undefined;
|
|
4738
4738
|
/**
|
|
4739
4739
|
* <p>The name of the classification scope: automated-sensitive-data-discovery.</p>
|
|
4740
4740
|
* @public
|
|
4741
4741
|
*/
|
|
4742
|
-
name?: string;
|
|
4742
|
+
name?: string | undefined;
|
|
4743
4743
|
/**
|
|
4744
4744
|
* <p>The S3 buckets that are excluded from automated sensitive data discovery.</p>
|
|
4745
4745
|
* @public
|
|
4746
4746
|
*/
|
|
4747
|
-
s3?: S3ClassificationScope;
|
|
4747
|
+
s3?: S3ClassificationScope | undefined;
|
|
4748
4748
|
}
|
|
4749
4749
|
/**
|
|
4750
4750
|
* @public
|
|
@@ -4764,62 +4764,62 @@ export interface GetCustomDataIdentifierResponse {
|
|
|
4764
4764
|
* <p>The Amazon Resource Name (ARN) of the custom data identifier.</p>
|
|
4765
4765
|
* @public
|
|
4766
4766
|
*/
|
|
4767
|
-
arn?: string;
|
|
4767
|
+
arn?: string | undefined;
|
|
4768
4768
|
/**
|
|
4769
4769
|
* <p>The date and time, in UTC and extended ISO 8601 format, when the custom data identifier was created.</p>
|
|
4770
4770
|
* @public
|
|
4771
4771
|
*/
|
|
4772
|
-
createdAt?: Date;
|
|
4772
|
+
createdAt?: Date | undefined;
|
|
4773
4773
|
/**
|
|
4774
4774
|
* <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>
|
|
4775
4775
|
* @public
|
|
4776
4776
|
*/
|
|
4777
|
-
deleted?: boolean;
|
|
4777
|
+
deleted?: boolean | undefined;
|
|
4778
4778
|
/**
|
|
4779
4779
|
* <p>The custom description of the custom data identifier.</p>
|
|
4780
4780
|
* @public
|
|
4781
4781
|
*/
|
|
4782
|
-
description?: string;
|
|
4782
|
+
description?: string | undefined;
|
|
4783
4783
|
/**
|
|
4784
4784
|
* <p>The unique identifier for the custom data identifier.</p>
|
|
4785
4785
|
* @public
|
|
4786
4786
|
*/
|
|
4787
|
-
id?: string;
|
|
4787
|
+
id?: string | undefined;
|
|
4788
4788
|
/**
|
|
4789
4789
|
* <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>
|
|
4790
4790
|
* @public
|
|
4791
4791
|
*/
|
|
4792
|
-
ignoreWords?: string[];
|
|
4792
|
+
ignoreWords?: string[] | undefined;
|
|
4793
4793
|
/**
|
|
4794
4794
|
* <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>
|
|
4795
4795
|
* @public
|
|
4796
4796
|
*/
|
|
4797
|
-
keywords?: string[];
|
|
4797
|
+
keywords?: string[] | undefined;
|
|
4798
4798
|
/**
|
|
4799
4799
|
* <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>
|
|
4800
4800
|
* @public
|
|
4801
4801
|
*/
|
|
4802
|
-
maximumMatchDistance?: number;
|
|
4802
|
+
maximumMatchDistance?: number | undefined;
|
|
4803
4803
|
/**
|
|
4804
4804
|
* <p>The custom name of the custom data identifier.</p>
|
|
4805
4805
|
* @public
|
|
4806
4806
|
*/
|
|
4807
|
-
name?: string;
|
|
4807
|
+
name?: string | undefined;
|
|
4808
4808
|
/**
|
|
4809
4809
|
* <p>The regular expression (<i>regex</i>) that defines the pattern to match.</p>
|
|
4810
4810
|
* @public
|
|
4811
4811
|
*/
|
|
4812
|
-
regex?: string;
|
|
4812
|
+
regex?: string | undefined;
|
|
4813
4813
|
/**
|
|
4814
4814
|
* <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>
|
|
4815
4815
|
* @public
|
|
4816
4816
|
*/
|
|
4817
|
-
severityLevels?: SeverityLevel[];
|
|
4817
|
+
severityLevels?: SeverityLevel[] | undefined;
|
|
4818
4818
|
/**
|
|
4819
4819
|
* <p>A map of key-value pairs that identifies the tags (keys and values) that are associated with the custom data identifier.</p>
|
|
4820
4820
|
* @public
|
|
4821
4821
|
*/
|
|
4822
|
-
tags?: Record<string, string
|
|
4822
|
+
tags?: Record<string, string> | undefined;
|
|
4823
4823
|
}
|
|
4824
4824
|
/**
|
|
4825
4825
|
* <p>Specifies criteria for sorting the results of a request for findings.</p>
|
|
@@ -4830,12 +4830,12 @@ export interface SortCriteria {
|
|
|
4830
4830
|
* <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>
|
|
4831
4831
|
* @public
|
|
4832
4832
|
*/
|
|
4833
|
-
attributeName?: string;
|
|
4833
|
+
attributeName?: string | undefined;
|
|
4834
4834
|
/**
|
|
4835
4835
|
* <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>
|
|
4836
4836
|
* @public
|
|
4837
4837
|
*/
|
|
4838
|
-
orderBy?: OrderBy;
|
|
4838
|
+
orderBy?: OrderBy | undefined;
|
|
4839
4839
|
}
|
|
4840
4840
|
/**
|
|
4841
4841
|
* @public
|
|
@@ -4850,7 +4850,7 @@ export interface GetFindingsRequest {
|
|
|
4850
4850
|
* <p>The criteria for sorting the results of the request.</p>
|
|
4851
4851
|
* @public
|
|
4852
4852
|
*/
|
|
4853
|
-
sortCriteria?: SortCriteria;
|
|
4853
|
+
sortCriteria?: SortCriteria | undefined;
|
|
4854
4854
|
}
|
|
4855
4855
|
/**
|
|
4856
4856
|
* @public
|
|
@@ -4860,7 +4860,7 @@ export interface GetFindingsResponse {
|
|
|
4860
4860
|
* <p>An array of objects, one for each finding that matches the criteria specified in the request.</p>
|
|
4861
4861
|
* @public
|
|
4862
4862
|
*/
|
|
4863
|
-
findings?: Finding[];
|
|
4863
|
+
findings?: Finding[] | undefined;
|
|
4864
4864
|
}
|
|
4865
4865
|
/**
|
|
4866
4866
|
* @public
|
|
@@ -4880,42 +4880,42 @@ export interface GetFindingsFilterResponse {
|
|
|
4880
4880
|
* <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>
|
|
4881
4881
|
* @public
|
|
4882
4882
|
*/
|
|
4883
|
-
action?: FindingsFilterAction;
|
|
4883
|
+
action?: FindingsFilterAction | undefined;
|
|
4884
4884
|
/**
|
|
4885
4885
|
* <p>The Amazon Resource Name (ARN) of the filter.</p>
|
|
4886
4886
|
* @public
|
|
4887
4887
|
*/
|
|
4888
|
-
arn?: string;
|
|
4888
|
+
arn?: string | undefined;
|
|
4889
4889
|
/**
|
|
4890
4890
|
* <p>The custom description of the filter.</p>
|
|
4891
4891
|
* @public
|
|
4892
4892
|
*/
|
|
4893
|
-
description?: string;
|
|
4893
|
+
description?: string | undefined;
|
|
4894
4894
|
/**
|
|
4895
4895
|
* <p>The criteria that's used to filter findings.</p>
|
|
4896
4896
|
* @public
|
|
4897
4897
|
*/
|
|
4898
|
-
findingCriteria?: FindingCriteria;
|
|
4898
|
+
findingCriteria?: FindingCriteria | undefined;
|
|
4899
4899
|
/**
|
|
4900
4900
|
* <p>The unique identifier for the filter.</p>
|
|
4901
4901
|
* @public
|
|
4902
4902
|
*/
|
|
4903
|
-
id?: string;
|
|
4903
|
+
id?: string | undefined;
|
|
4904
4904
|
/**
|
|
4905
4905
|
* <p>The custom name of the filter.</p>
|
|
4906
4906
|
* @public
|
|
4907
4907
|
*/
|
|
4908
|
-
name?: string;
|
|
4908
|
+
name?: string | undefined;
|
|
4909
4909
|
/**
|
|
4910
4910
|
* <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>
|
|
4911
4911
|
* @public
|
|
4912
4912
|
*/
|
|
4913
|
-
position?: number;
|
|
4913
|
+
position?: number | undefined;
|
|
4914
4914
|
/**
|
|
4915
4915
|
* <p>A map of key-value pairs that specifies which tags (keys and values) are associated with the filter.</p>
|
|
4916
4916
|
* @public
|
|
4917
4917
|
*/
|
|
4918
|
-
tags?: Record<string, string
|
|
4918
|
+
tags?: Record<string, string> | undefined;
|
|
4919
4919
|
}
|
|
4920
4920
|
/**
|
|
4921
4921
|
* @public
|
|
@@ -4946,7 +4946,7 @@ export interface GetFindingsPublicationConfigurationResponse {
|
|
|
4946
4946
|
* <p>The configuration settings that determine which findings are published to Security Hub.</p>
|
|
4947
4947
|
* @public
|
|
4948
4948
|
*/
|
|
4949
|
-
securityHubConfiguration?: SecurityHubConfiguration;
|
|
4949
|
+
securityHubConfiguration?: SecurityHubConfiguration | undefined;
|
|
4950
4950
|
}
|
|
4951
4951
|
/**
|
|
4952
4952
|
* @public
|
|
@@ -4970,7 +4970,7 @@ export interface GetFindingStatisticsRequest {
|
|
|
4970
4970
|
* <p>The criteria to use to filter the query results.</p>
|
|
4971
4971
|
* @public
|
|
4972
4972
|
*/
|
|
4973
|
-
findingCriteria?: FindingCriteria;
|
|
4973
|
+
findingCriteria?: FindingCriteria | undefined;
|
|
4974
4974
|
/**
|
|
4975
4975
|
* <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>
|
|
4976
4976
|
* @public
|
|
@@ -4980,12 +4980,12 @@ export interface GetFindingStatisticsRequest {
|
|
|
4980
4980
|
* <p>The maximum number of items to include in each page of the response.</p>
|
|
4981
4981
|
* @public
|
|
4982
4982
|
*/
|
|
4983
|
-
size?: number;
|
|
4983
|
+
size?: number | undefined;
|
|
4984
4984
|
/**
|
|
4985
4985
|
* <p>The criteria to use to sort the query results.</p>
|
|
4986
4986
|
* @public
|
|
4987
4987
|
*/
|
|
4988
|
-
sortCriteria?: FindingStatisticsSortCriteria;
|
|
4988
|
+
sortCriteria?: FindingStatisticsSortCriteria | undefined;
|
|
4989
4989
|
}
|
|
4990
4990
|
/**
|
|
4991
4991
|
* @public
|
|
@@ -4995,7 +4995,7 @@ export interface GetFindingStatisticsResponse {
|
|
|
4995
4995
|
* <p>An array of objects, one for each group of findings that matches the filter criteria specified in the request.</p>
|
|
4996
4996
|
* @public
|
|
4997
4997
|
*/
|
|
4998
|
-
countsByGroup?: GroupCount[];
|
|
4998
|
+
countsByGroup?: GroupCount[] | undefined;
|
|
4999
4999
|
}
|
|
5000
5000
|
/**
|
|
5001
5001
|
* @public
|
|
@@ -5010,7 +5010,7 @@ export interface GetInvitationsCountResponse {
|
|
|
5010
5010
|
* <p>The total number of invitations that were received by the account, not including the currently accepted invitation.</p>
|
|
5011
5011
|
* @public
|
|
5012
5012
|
*/
|
|
5013
|
-
invitationsCount?: number;
|
|
5013
|
+
invitationsCount?: number | undefined;
|
|
5014
5014
|
}
|
|
5015
5015
|
/**
|
|
5016
5016
|
* @public
|
|
@@ -5025,27 +5025,27 @@ export interface GetMacieSessionResponse {
|
|
|
5025
5025
|
* <p>The date and time, in UTC and extended ISO 8601 format, when the Amazon Macie account was created.</p>
|
|
5026
5026
|
* @public
|
|
5027
5027
|
*/
|
|
5028
|
-
createdAt?: Date;
|
|
5028
|
+
createdAt?: Date | undefined;
|
|
5029
5029
|
/**
|
|
5030
5030
|
* <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>
|
|
5031
5031
|
* @public
|
|
5032
5032
|
*/
|
|
5033
|
-
findingPublishingFrequency?: FindingPublishingFrequency;
|
|
5033
|
+
findingPublishingFrequency?: FindingPublishingFrequency | undefined;
|
|
5034
5034
|
/**
|
|
5035
5035
|
* <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>
|
|
5036
5036
|
* @public
|
|
5037
5037
|
*/
|
|
5038
|
-
serviceRole?: string;
|
|
5038
|
+
serviceRole?: string | undefined;
|
|
5039
5039
|
/**
|
|
5040
5040
|
* <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>
|
|
5041
5041
|
* @public
|
|
5042
5042
|
*/
|
|
5043
|
-
status?: MacieStatus;
|
|
5043
|
+
status?: MacieStatus | undefined;
|
|
5044
5044
|
/**
|
|
5045
5045
|
* <p>The date and time, in UTC and extended ISO 8601 format, of the most recent change to the status or configuration settings for the Amazon Macie account.</p>
|
|
5046
5046
|
* @public
|
|
5047
5047
|
*/
|
|
5048
|
-
updatedAt?: Date;
|
|
5048
|
+
updatedAt?: Date | undefined;
|
|
5049
5049
|
}
|
|
5050
5050
|
/**
|
|
5051
5051
|
* @public
|
|
@@ -5060,7 +5060,7 @@ export interface GetMasterAccountResponse {
|
|
|
5060
5060
|
* <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>
|
|
5061
5061
|
* @public
|
|
5062
5062
|
*/
|
|
5063
|
-
master?: Invitation;
|
|
5063
|
+
master?: Invitation | undefined;
|
|
5064
5064
|
}
|
|
5065
5065
|
/**
|
|
5066
5066
|
* @public
|
|
@@ -5080,47 +5080,47 @@ export interface GetMemberResponse {
|
|
|
5080
5080
|
* <p>The Amazon Web Services account ID for the account.</p>
|
|
5081
5081
|
* @public
|
|
5082
5082
|
*/
|
|
5083
|
-
accountId?: string;
|
|
5083
|
+
accountId?: string | undefined;
|
|
5084
5084
|
/**
|
|
5085
5085
|
* <p>The Amazon Web Services account ID for the administrator account.</p>
|
|
5086
5086
|
* @public
|
|
5087
5087
|
*/
|
|
5088
|
-
administratorAccountId?: string;
|
|
5088
|
+
administratorAccountId?: string | undefined;
|
|
5089
5089
|
/**
|
|
5090
5090
|
* <p>The Amazon Resource Name (ARN) of the account.</p>
|
|
5091
5091
|
* @public
|
|
5092
5092
|
*/
|
|
5093
|
-
arn?: string;
|
|
5093
|
+
arn?: string | undefined;
|
|
5094
5094
|
/**
|
|
5095
5095
|
* <p>The email address for the account. This value is null if the account is associated with the administrator account through Organizations.</p>
|
|
5096
5096
|
* @public
|
|
5097
5097
|
*/
|
|
5098
|
-
email?: string;
|
|
5098
|
+
email?: string | undefined;
|
|
5099
5099
|
/**
|
|
5100
5100
|
* <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>
|
|
5101
5101
|
* @public
|
|
5102
5102
|
*/
|
|
5103
|
-
invitedAt?: Date;
|
|
5103
|
+
invitedAt?: Date | undefined;
|
|
5104
5104
|
/**
|
|
5105
5105
|
* <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>
|
|
5106
5106
|
* @public
|
|
5107
5107
|
*/
|
|
5108
|
-
masterAccountId?: string;
|
|
5108
|
+
masterAccountId?: string | undefined;
|
|
5109
5109
|
/**
|
|
5110
5110
|
* <p>The current status of the relationship between the account and the administrator account.</p>
|
|
5111
5111
|
* @public
|
|
5112
5112
|
*/
|
|
5113
|
-
relationshipStatus?: RelationshipStatus;
|
|
5113
|
+
relationshipStatus?: RelationshipStatus | undefined;
|
|
5114
5114
|
/**
|
|
5115
5115
|
* <p>A map of key-value pairs that specifies which tags (keys and values) are associated with the account in Amazon Macie.</p>
|
|
5116
5116
|
* @public
|
|
5117
5117
|
*/
|
|
5118
|
-
tags?: Record<string, string
|
|
5118
|
+
tags?: Record<string, string> | undefined;
|
|
5119
5119
|
/**
|
|
5120
5120
|
* <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>
|
|
5121
5121
|
* @public
|
|
5122
5122
|
*/
|
|
5123
|
-
updatedAt?: Date;
|
|
5123
|
+
updatedAt?: Date | undefined;
|
|
5124
5124
|
}
|
|
5125
5125
|
/**
|
|
5126
5126
|
* @public
|
|
@@ -5141,47 +5141,47 @@ export interface ResourceStatistics {
|
|
|
5141
5141
|
* <p>The total amount of data, in bytes, that Amazon Macie has analyzed in the bucket.</p>
|
|
5142
5142
|
* @public
|
|
5143
5143
|
*/
|
|
5144
|
-
totalBytesClassified?: number;
|
|
5144
|
+
totalBytesClassified?: number | undefined;
|
|
5145
5145
|
/**
|
|
5146
5146
|
* <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>
|
|
5147
5147
|
* @public
|
|
5148
5148
|
*/
|
|
5149
|
-
totalDetections?: number;
|
|
5149
|
+
totalDetections?: number | undefined;
|
|
5150
5150
|
/**
|
|
5151
5151
|
* <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>
|
|
5152
5152
|
* @public
|
|
5153
5153
|
*/
|
|
5154
|
-
totalDetectionsSuppressed?: number;
|
|
5154
|
+
totalDetectionsSuppressed?: number | undefined;
|
|
5155
5155
|
/**
|
|
5156
5156
|
* <p>The total number of objects that Amazon Macie has analyzed in the bucket.</p>
|
|
5157
5157
|
* @public
|
|
5158
5158
|
*/
|
|
5159
|
-
totalItemsClassified?: number;
|
|
5159
|
+
totalItemsClassified?: number | undefined;
|
|
5160
5160
|
/**
|
|
5161
5161
|
* <p>The total number of the bucket's objects that Amazon Macie has found sensitive data in.</p>
|
|
5162
5162
|
* @public
|
|
5163
5163
|
*/
|
|
5164
|
-
totalItemsSensitive?: number;
|
|
5164
|
+
totalItemsSensitive?: number | undefined;
|
|
5165
5165
|
/**
|
|
5166
5166
|
* <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, an 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>
|
|
5167
5167
|
* @public
|
|
5168
5168
|
*/
|
|
5169
|
-
totalItemsSkipped?: number;
|
|
5169
|
+
totalItemsSkipped?: number | undefined;
|
|
5170
5170
|
/**
|
|
5171
5171
|
* <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>
|
|
5172
5172
|
* @public
|
|
5173
5173
|
*/
|
|
5174
|
-
totalItemsSkippedInvalidEncryption?: number;
|
|
5174
|
+
totalItemsSkippedInvalidEncryption?: number | undefined;
|
|
5175
5175
|
/**
|
|
5176
5176
|
* <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>
|
|
5177
5177
|
* @public
|
|
5178
5178
|
*/
|
|
5179
|
-
totalItemsSkippedInvalidKms?: number;
|
|
5179
|
+
totalItemsSkippedInvalidKms?: number | undefined;
|
|
5180
5180
|
/**
|
|
5181
5181
|
* <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>
|
|
5182
5182
|
* @public
|
|
5183
5183
|
*/
|
|
5184
|
-
totalItemsSkippedPermissionDenied?: number;
|
|
5184
|
+
totalItemsSkippedPermissionDenied?: number | undefined;
|
|
5185
5185
|
}
|
|
5186
5186
|
/**
|
|
5187
5187
|
* @public
|
|
@@ -5191,22 +5191,22 @@ export interface GetResourceProfileResponse {
|
|
|
5191
5191
|
* <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>
|
|
5192
5192
|
* @public
|
|
5193
5193
|
*/
|
|
5194
|
-
profileUpdatedAt?: Date;
|
|
5194
|
+
profileUpdatedAt?: Date | undefined;
|
|
5195
5195
|
/**
|
|
5196
5196
|
* <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>
|
|
5197
5197
|
* @public
|
|
5198
5198
|
*/
|
|
5199
|
-
sensitivityScore?: number;
|
|
5199
|
+
sensitivityScore?: number | undefined;
|
|
5200
5200
|
/**
|
|
5201
5201
|
* <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>
|
|
5202
5202
|
* @public
|
|
5203
5203
|
*/
|
|
5204
|
-
sensitivityScoreOverridden?: boolean;
|
|
5204
|
+
sensitivityScoreOverridden?: boolean | undefined;
|
|
5205
5205
|
/**
|
|
5206
5206
|
* <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>
|
|
5207
5207
|
* @public
|
|
5208
5208
|
*/
|
|
5209
|
-
statistics?: ResourceStatistics;
|
|
5209
|
+
statistics?: ResourceStatistics | undefined;
|
|
5210
5210
|
}
|
|
5211
5211
|
/**
|
|
5212
5212
|
* @public
|
|
@@ -5234,7 +5234,7 @@ export interface RevealConfiguration {
|
|
|
5234
5234
|
* <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 enabled 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>
|
|
5235
5235
|
* @public
|
|
5236
5236
|
*/
|
|
5237
|
-
kmsKeyId?: string;
|
|
5237
|
+
kmsKeyId?: string | undefined;
|
|
5238
5238
|
/**
|
|
5239
5239
|
* <p>The status of the configuration for the Amazon Macie 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. In a request, valid values are: ENABLED, enable the configuration for the account; and, DISABLED, disable the configuration for the account.</p> <important><p>If you disable the configuration, you also permanently delete current settings that specify how to access affected S3 objects. If your current access method is ASSUME_ROLE, Macie also deletes the external ID and role name currently specified for the configuration. These settings can't be recovered after they're deleted.</p></important>
|
|
5240
5240
|
* @public
|
|
@@ -5262,7 +5262,7 @@ export interface RetrievalConfiguration {
|
|
|
5262
5262
|
* <p>The external ID to specify in the trust policy for the IAM role to assume when retrieving sensitive data from affected S3 objects (roleName). This value is null if the value for retrievalMode is CALLER_CREDENTIALS.</p> <p>This ID is a unique alphanumeric string that Amazon Macie generates automatically after you configure it to assume an IAM role. For a Macie administrator to retrieve sensitive data from an affected S3 object for a member account, the trust policy for the role in the member account must include an sts:ExternalId condition that requires this ID.</p>
|
|
5263
5263
|
* @public
|
|
5264
5264
|
*/
|
|
5265
|
-
externalId?: string;
|
|
5265
|
+
externalId?: string | undefined;
|
|
5266
5266
|
/**
|
|
5267
5267
|
* <p>The access method that's used to retrieve sensitive data from affected S3 objects. Valid values are: ASSUME_ROLE, assume an IAM role that is in the affected Amazon Web Services account and delegates access to Amazon Macie (roleName); and, CALLER_CREDENTIALS, use the credentials of the IAM user who requests the sensitive data.</p>
|
|
5268
5268
|
* @public
|
|
@@ -5272,7 +5272,7 @@ export interface RetrievalConfiguration {
|
|
|
5272
5272
|
* <p>The name of the IAM role that is in the affected Amazon Web Services account and Amazon Macie is allowed to assume when retrieving sensitive data from affected S3 objects for the account. This value is null if the value for retrievalMode is CALLER_CREDENTIALS.</p>
|
|
5273
5273
|
* @public
|
|
5274
5274
|
*/
|
|
5275
|
-
roleName?: string;
|
|
5275
|
+
roleName?: string | undefined;
|
|
5276
5276
|
}
|
|
5277
5277
|
/**
|
|
5278
5278
|
* @public
|
|
@@ -5282,12 +5282,12 @@ export interface GetRevealConfigurationResponse {
|
|
|
5282
5282
|
* <p>The KMS key that's used to encrypt the sensitive data, and the status of the configuration for the Amazon Macie account.</p>
|
|
5283
5283
|
* @public
|
|
5284
5284
|
*/
|
|
5285
|
-
configuration?: RevealConfiguration;
|
|
5285
|
+
configuration?: RevealConfiguration | undefined;
|
|
5286
5286
|
/**
|
|
5287
5287
|
* <p>The access method and settings that are used to retrieve the sensitive data.</p>
|
|
5288
5288
|
* @public
|
|
5289
5289
|
*/
|
|
5290
|
-
retrievalConfiguration?: RetrievalConfiguration;
|
|
5290
|
+
retrievalConfiguration?: RetrievalConfiguration | undefined;
|
|
5291
5291
|
}
|
|
5292
5292
|
/**
|
|
5293
5293
|
* @public
|
|
@@ -5320,17 +5320,17 @@ export interface GetSensitiveDataOccurrencesResponse {
|
|
|
5320
5320
|
* <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>
|
|
5321
5321
|
* @public
|
|
5322
5322
|
*/
|
|
5323
|
-
error?: string;
|
|
5323
|
+
error?: string | undefined;
|
|
5324
5324
|
/**
|
|
5325
5325
|
* <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>
|
|
5326
5326
|
* @public
|
|
5327
5327
|
*/
|
|
5328
|
-
sensitiveDataOccurrences?: Record<string, DetectedDataDetails[]
|
|
5328
|
+
sensitiveDataOccurrences?: Record<string, DetectedDataDetails[]> | undefined;
|
|
5329
5329
|
/**
|
|
5330
5330
|
* <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>
|
|
5331
5331
|
* @public
|
|
5332
5332
|
*/
|
|
5333
|
-
status?: RevealRequestStatus;
|
|
5333
|
+
status?: RevealRequestStatus | undefined;
|
|
5334
5334
|
}
|
|
5335
5335
|
/**
|
|
5336
5336
|
* <p>Provides information about an error that occurred due to an unprocessable entity.</p>
|
|
@@ -5362,12 +5362,12 @@ export interface GetSensitiveDataOccurrencesAvailabilityResponse {
|
|
|
5362
5362
|
* <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>
|
|
5363
5363
|
* @public
|
|
5364
5364
|
*/
|
|
5365
|
-
code?: AvailabilityCode;
|
|
5365
|
+
code?: AvailabilityCode | undefined;
|
|
5366
5366
|
/**
|
|
5367
5367
|
* <p>Specifies why occurrences of sensitive data can't be retrieved for the finding. Possible values are:</p> <ul><li><p>ACCOUNT_NOT_IN_ORGANIZATION - The affected account isn't currently part of your organization. Or the account is part of your organization but Macie isn't currently enabled for the account. You're not allowed to access the affected S3 object by using Macie.</p></li> <li><p>INVALID_CLASSIFICATION_RESULT - There isn't a corresponding sensitive data discovery result for the finding. Or the corresponding sensitive data discovery result isn't available in the current Amazon Web Services Region, is malformed or corrupted, or uses an unsupported storage format. Macie can't verify the location of the sensitive data to retrieve.</p></li> <li><p>INVALID_RESULT_SIGNATURE - The corresponding sensitive data discovery result is stored in an S3 object that wasn't signed by Macie. Macie can't verify the integrity and authenticity of the sensitive data discovery result. Therefore, Macie can't verify the location of the sensitive data to retrieve.</p></li> <li><p>MEMBER_ROLE_TOO_PERMISSIVE - The trust or permissions policy for the IAM role in the affected member account doesn't meet Macie requirements for restricting access to the role. Or the role's trust policy doesn't specify the correct external ID for your organization. Macie can't assume the role to retrieve the sensitive data.</p></li> <li><p>MISSING_GET_MEMBER_PERMISSION - You're not allowed to retrieve information about the association between your account and the affected account. Macie can't determine whether you’re allowed to access the affected S3 object as the delegated Macie administrator for the affected account.</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 from this type of file.</p></li> <li><p>OBJECT_UNAVAILABLE - The affected S3 object isn't available. The object was renamed, moved, deleted, or changed after Macie created the finding. Or the object is encrypted with an KMS key that's currently disabled.</p></li> <li><p>RESULT_NOT_SIGNED - The corresponding sensitive data discovery result is stored in an S3 object that hasn't been signed. Macie can't verify the integrity and authenticity of the sensitive data discovery result. Therefore, Macie can't verify the location of the sensitive data to retrieve.</p></li> <li><p>ROLE_TOO_PERMISSIVE - Your account is configured to retrieve occurrences of sensitive data by using an IAM role whose trust or permissions policy doesn't meet Macie requirements for restricting access to the role. Macie can’t assume the role to retrieve the sensitive data.</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>
|
|
5368
5368
|
* @public
|
|
5369
5369
|
*/
|
|
5370
|
-
reasons?: UnavailabilityReasonCode[];
|
|
5370
|
+
reasons?: UnavailabilityReasonCode[] | undefined;
|
|
5371
5371
|
}
|
|
5372
5372
|
/**
|
|
5373
5373
|
* @public
|
|
@@ -5388,7 +5388,7 @@ export interface SensitivityInspectionTemplateExcludes {
|
|
|
5388
5388
|
* <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>
|
|
5389
5389
|
* @public
|
|
5390
5390
|
*/
|
|
5391
|
-
managedDataIdentifierIds?: string[];
|
|
5391
|
+
managedDataIdentifierIds?: string[] | undefined;
|
|
5392
5392
|
}
|
|
5393
5393
|
/**
|
|
5394
5394
|
* <p>Specifies the allow lists, custom data identifiers, and managed data identifiers to include (use) when performing automated sensitive data discovery. The configuration must specify at least one custom data identifier or managed data identifier. For information about the managed data identifiers that Amazon Macie currently provides, 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>
|
|
@@ -5399,17 +5399,17 @@ export interface SensitivityInspectionTemplateIncludes {
|
|
|
5399
5399
|
* <p>An array of unique identifiers, one for each allow list to include.</p>
|
|
5400
5400
|
* @public
|
|
5401
5401
|
*/
|
|
5402
|
-
allowListIds?: string[];
|
|
5402
|
+
allowListIds?: string[] | undefined;
|
|
5403
5403
|
/**
|
|
5404
5404
|
* <p>An array of unique identifiers, one for each custom data identifier to include.</p>
|
|
5405
5405
|
* @public
|
|
5406
5406
|
*/
|
|
5407
|
-
customDataIdentifierIds?: string[];
|
|
5407
|
+
customDataIdentifierIds?: string[] | undefined;
|
|
5408
5408
|
/**
|
|
5409
5409
|
* <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/>
|
|
5410
5410
|
* @public
|
|
5411
5411
|
*/
|
|
5412
|
-
managedDataIdentifierIds?: string[];
|
|
5412
|
+
managedDataIdentifierIds?: string[] | undefined;
|
|
5413
5413
|
}
|
|
5414
5414
|
/**
|
|
5415
5415
|
* @public
|
|
@@ -5419,27 +5419,27 @@ export interface GetSensitivityInspectionTemplateResponse {
|
|
|
5419
5419
|
* <p>The custom description of the template.</p>
|
|
5420
5420
|
* @public
|
|
5421
5421
|
*/
|
|
5422
|
-
description?: string;
|
|
5422
|
+
description?: string | undefined;
|
|
5423
5423
|
/**
|
|
5424
5424
|
* <p>The managed data identifiers that are explicitly excluded (not used) when performing automated sensitive data discovery.</p>
|
|
5425
5425
|
* @public
|
|
5426
5426
|
*/
|
|
5427
|
-
excludes?: SensitivityInspectionTemplateExcludes;
|
|
5427
|
+
excludes?: SensitivityInspectionTemplateExcludes | undefined;
|
|
5428
5428
|
/**
|
|
5429
5429
|
* <p>The allow lists, custom data identifiers, and managed data identifiers that are explicitly included (used) when performing automated sensitive data discovery.</p>
|
|
5430
5430
|
* @public
|
|
5431
5431
|
*/
|
|
5432
|
-
includes?: SensitivityInspectionTemplateIncludes;
|
|
5432
|
+
includes?: SensitivityInspectionTemplateIncludes | undefined;
|
|
5433
5433
|
/**
|
|
5434
5434
|
* <p>The name of the template: automated-sensitive-data-discovery.</p>
|
|
5435
5435
|
* @public
|
|
5436
5436
|
*/
|
|
5437
|
-
name?: string;
|
|
5437
|
+
name?: string | undefined;
|
|
5438
5438
|
/**
|
|
5439
5439
|
* <p>The unique identifier for the template.</p>
|
|
5440
5440
|
* @public
|
|
5441
5441
|
*/
|
|
5442
|
-
sensitivityInspectionTemplateId?: string;
|
|
5442
|
+
sensitivityInspectionTemplateId?: string | undefined;
|
|
5443
5443
|
}
|
|
5444
5444
|
/**
|
|
5445
5445
|
* @public
|
|
@@ -5464,12 +5464,12 @@ export interface UsageStatisticsSortBy {
|
|
|
5464
5464
|
* <p>The field to sort the results by.</p>
|
|
5465
5465
|
* @public
|
|
5466
5466
|
*/
|
|
5467
|
-
key?: UsageStatisticsSortKey;
|
|
5467
|
+
key?: UsageStatisticsSortKey | undefined;
|
|
5468
5468
|
/**
|
|
5469
5469
|
* <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>
|
|
5470
5470
|
* @public
|
|
5471
5471
|
*/
|
|
5472
|
-
orderBy?: OrderBy;
|
|
5472
|
+
orderBy?: OrderBy | undefined;
|
|
5473
5473
|
}
|
|
5474
5474
|
/**
|
|
5475
5475
|
* @public
|
|
@@ -5491,27 +5491,27 @@ export interface GetUsageStatisticsRequest {
|
|
|
5491
5491
|
* <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>
|
|
5492
5492
|
* @public
|
|
5493
5493
|
*/
|
|
5494
|
-
filterBy?: UsageStatisticsFilter[];
|
|
5494
|
+
filterBy?: UsageStatisticsFilter[] | undefined;
|
|
5495
5495
|
/**
|
|
5496
5496
|
* <p>The maximum number of items to include in each page of the response.</p>
|
|
5497
5497
|
* @public
|
|
5498
5498
|
*/
|
|
5499
|
-
maxResults?: number;
|
|
5499
|
+
maxResults?: number | undefined;
|
|
5500
5500
|
/**
|
|
5501
5501
|
* <p>The nextToken string that specifies which page of results to return in a paginated response.</p>
|
|
5502
5502
|
* @public
|
|
5503
5503
|
*/
|
|
5504
|
-
nextToken?: string;
|
|
5504
|
+
nextToken?: string | undefined;
|
|
5505
5505
|
/**
|
|
5506
5506
|
* <p>The criteria to use to sort the query results.</p>
|
|
5507
5507
|
* @public
|
|
5508
5508
|
*/
|
|
5509
|
-
sortBy?: UsageStatisticsSortBy;
|
|
5509
|
+
sortBy?: UsageStatisticsSortBy | undefined;
|
|
5510
5510
|
/**
|
|
5511
5511
|
* <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>
|
|
5512
5512
|
* @public
|
|
5513
5513
|
*/
|
|
5514
|
-
timeRange?: TimeRange;
|
|
5514
|
+
timeRange?: TimeRange | undefined;
|
|
5515
5515
|
}
|
|
5516
5516
|
/**
|
|
5517
5517
|
* @public
|
|
@@ -5521,17 +5521,17 @@ export interface GetUsageStatisticsResponse {
|
|
|
5521
5521
|
* <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>
|
|
5522
5522
|
* @public
|
|
5523
5523
|
*/
|
|
5524
|
-
nextToken?: string;
|
|
5524
|
+
nextToken?: string | undefined;
|
|
5525
5525
|
/**
|
|
5526
5526
|
* <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>
|
|
5527
5527
|
* @public
|
|
5528
5528
|
*/
|
|
5529
|
-
records?: UsageRecord[];
|
|
5529
|
+
records?: UsageRecord[] | undefined;
|
|
5530
5530
|
/**
|
|
5531
5531
|
* <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>
|
|
5532
5532
|
* @public
|
|
5533
5533
|
*/
|
|
5534
|
-
timeRange?: TimeRange;
|
|
5534
|
+
timeRange?: TimeRange | undefined;
|
|
5535
5535
|
}
|
|
5536
5536
|
/**
|
|
5537
5537
|
* @public
|
|
@@ -5541,7 +5541,7 @@ export interface GetUsageTotalsRequest {
|
|
|
5541
5541
|
* <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>
|
|
5542
5542
|
* @public
|
|
5543
5543
|
*/
|
|
5544
|
-
timeRange?: string;
|
|
5544
|
+
timeRange?: string | undefined;
|
|
5545
5545
|
}
|
|
5546
5546
|
/**
|
|
5547
5547
|
* @public
|
|
@@ -5551,12 +5551,12 @@ export interface GetUsageTotalsResponse {
|
|
|
5551
5551
|
* <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>
|
|
5552
5552
|
* @public
|
|
5553
5553
|
*/
|
|
5554
|
-
timeRange?: TimeRange;
|
|
5554
|
+
timeRange?: TimeRange | undefined;
|
|
5555
5555
|
/**
|
|
5556
5556
|
* <p>An array of objects that contains the results of the query. Each object contains the data for a specific usage metric.</p>
|
|
5557
5557
|
* @public
|
|
5558
5558
|
*/
|
|
5559
|
-
usageTotals?: UsageTotal[];
|
|
5559
|
+
usageTotals?: UsageTotal[] | undefined;
|
|
5560
5560
|
}
|
|
5561
5561
|
/**
|
|
5562
5562
|
* @public
|
|
@@ -5566,12 +5566,12 @@ export interface ListAllowListsRequest {
|
|
|
5566
5566
|
* <p>The maximum number of items to include in each page of a paginated response.</p>
|
|
5567
5567
|
* @public
|
|
5568
5568
|
*/
|
|
5569
|
-
maxResults?: number;
|
|
5569
|
+
maxResults?: number | undefined;
|
|
5570
5570
|
/**
|
|
5571
5571
|
* <p>The nextToken string that specifies which page of results to return in a paginated response.</p>
|
|
5572
5572
|
* @public
|
|
5573
5573
|
*/
|
|
5574
|
-
nextToken?: string;
|
|
5574
|
+
nextToken?: string | undefined;
|
|
5575
5575
|
}
|
|
5576
5576
|
/**
|
|
5577
5577
|
* @public
|
|
@@ -5581,12 +5581,12 @@ export interface ListAllowListsResponse {
|
|
|
5581
5581
|
* <p>An array of objects, one for each allow list.</p>
|
|
5582
5582
|
* @public
|
|
5583
5583
|
*/
|
|
5584
|
-
allowLists?: AllowListSummary[];
|
|
5584
|
+
allowLists?: AllowListSummary[] | undefined;
|
|
5585
5585
|
/**
|
|
5586
5586
|
* <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>
|
|
5587
5587
|
* @public
|
|
5588
5588
|
*/
|
|
5589
|
-
nextToken?: string;
|
|
5589
|
+
nextToken?: string | undefined;
|
|
5590
5590
|
}
|
|
5591
5591
|
/**
|
|
5592
5592
|
* @public
|
|
@@ -5596,17 +5596,17 @@ export interface ListAutomatedDiscoveryAccountsRequest {
|
|
|
5596
5596
|
* <p>The Amazon Web Services account ID for each account, for as many as 50 accounts. To retrieve the status for multiple accounts, append the accountIds parameter and argument for each account, separated by an ampersand (&). To retrieve the status for all the accounts in an organization, omit this parameter.</p>
|
|
5597
5597
|
* @public
|
|
5598
5598
|
*/
|
|
5599
|
-
accountIds?: string[];
|
|
5599
|
+
accountIds?: string[] | undefined;
|
|
5600
5600
|
/**
|
|
5601
5601
|
* <p>The maximum number of items to include in each page of a paginated response.</p>
|
|
5602
5602
|
* @public
|
|
5603
5603
|
*/
|
|
5604
|
-
maxResults?: number;
|
|
5604
|
+
maxResults?: number | undefined;
|
|
5605
5605
|
/**
|
|
5606
5606
|
* <p>The nextToken string that specifies which page of results to return in a paginated response.</p>
|
|
5607
5607
|
* @public
|
|
5608
5608
|
*/
|
|
5609
|
-
nextToken?: string;
|
|
5609
|
+
nextToken?: string | undefined;
|
|
5610
5610
|
}
|
|
5611
5611
|
/**
|
|
5612
5612
|
* @public
|
|
@@ -5616,10 +5616,10 @@ export interface ListAutomatedDiscoveryAccountsResponse {
|
|
|
5616
5616
|
* <p>An array of objects, one for each account specified in the request. Each object specifies the Amazon Web Services account ID for an account and the current status of automated sensitive data discovery for that account.</p>
|
|
5617
5617
|
* @public
|
|
5618
5618
|
*/
|
|
5619
|
-
items?: AutomatedDiscoveryAccount[];
|
|
5619
|
+
items?: AutomatedDiscoveryAccount[] | undefined;
|
|
5620
5620
|
/**
|
|
5621
5621
|
* <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>
|
|
5622
5622
|
* @public
|
|
5623
5623
|
*/
|
|
5624
|
-
nextToken?: string;
|
|
5624
|
+
nextToken?: string | undefined;
|
|
5625
5625
|
}
|