@aws-sdk/client-macie2 3.934.0 → 3.935.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.
Files changed (79) hide show
  1. package/dist-cjs/index.js +354 -354
  2. package/dist-es/index.js +2 -1
  3. package/dist-es/models/enums.js +342 -0
  4. package/dist-es/models/errors.js +97 -0
  5. package/dist-es/models/models_0.js +1 -427
  6. package/dist-es/models/models_1.js +1 -12
  7. package/dist-es/schemas/schemas_0.js +1 -1
  8. package/dist-types/commands/ListClassificationJobsCommand.d.ts +1 -1
  9. package/dist-types/commands/ListClassificationScopesCommand.d.ts +1 -1
  10. package/dist-types/commands/ListCustomDataIdentifiersCommand.d.ts +1 -1
  11. package/dist-types/commands/ListFindingsCommand.d.ts +1 -1
  12. package/dist-types/commands/ListFindingsFiltersCommand.d.ts +1 -1
  13. package/dist-types/commands/ListInvitationsCommand.d.ts +1 -1
  14. package/dist-types/commands/ListManagedDataIdentifiersCommand.d.ts +1 -1
  15. package/dist-types/commands/ListMembersCommand.d.ts +1 -1
  16. package/dist-types/commands/ListOrganizationAdminAccountsCommand.d.ts +1 -1
  17. package/dist-types/commands/ListResourceProfileArtifactsCommand.d.ts +1 -1
  18. package/dist-types/commands/ListResourceProfileDetectionsCommand.d.ts +1 -1
  19. package/dist-types/commands/ListSensitivityInspectionTemplatesCommand.d.ts +1 -1
  20. package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -1
  21. package/dist-types/commands/PutClassificationExportConfigurationCommand.d.ts +1 -1
  22. package/dist-types/commands/PutFindingsPublicationConfigurationCommand.d.ts +1 -1
  23. package/dist-types/commands/SearchResourcesCommand.d.ts +1 -1
  24. package/dist-types/commands/TagResourceCommand.d.ts +1 -1
  25. package/dist-types/commands/TestCustomDataIdentifierCommand.d.ts +1 -1
  26. package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
  27. package/dist-types/commands/UpdateAllowListCommand.d.ts +1 -1
  28. package/dist-types/commands/UpdateAutomatedDiscoveryConfigurationCommand.d.ts +1 -1
  29. package/dist-types/commands/UpdateClassificationJobCommand.d.ts +1 -1
  30. package/dist-types/commands/UpdateClassificationScopeCommand.d.ts +1 -1
  31. package/dist-types/commands/UpdateFindingsFilterCommand.d.ts +1 -1
  32. package/dist-types/commands/UpdateMacieSessionCommand.d.ts +1 -1
  33. package/dist-types/commands/UpdateMemberSessionCommand.d.ts +1 -1
  34. package/dist-types/commands/UpdateOrganizationConfigurationCommand.d.ts +1 -1
  35. package/dist-types/commands/UpdateResourceProfileCommand.d.ts +1 -1
  36. package/dist-types/commands/UpdateResourceProfileDetectionsCommand.d.ts +1 -1
  37. package/dist-types/index.d.ts +4 -1
  38. package/dist-types/models/enums.d.ts +822 -0
  39. package/dist-types/models/errors.d.ts +98 -0
  40. package/dist-types/models/models_0.d.ts +946 -904
  41. package/dist-types/models/models_1.d.ts +1 -962
  42. package/dist-types/ts3.4/commands/ListClassificationJobsCommand.d.ts +1 -1
  43. package/dist-types/ts3.4/commands/ListClassificationScopesCommand.d.ts +1 -1
  44. package/dist-types/ts3.4/commands/ListCustomDataIdentifiersCommand.d.ts +1 -1
  45. package/dist-types/ts3.4/commands/ListFindingsCommand.d.ts +1 -1
  46. package/dist-types/ts3.4/commands/ListFindingsFiltersCommand.d.ts +1 -1
  47. package/dist-types/ts3.4/commands/ListInvitationsCommand.d.ts +1 -1
  48. package/dist-types/ts3.4/commands/ListManagedDataIdentifiersCommand.d.ts +1 -1
  49. package/dist-types/ts3.4/commands/ListMembersCommand.d.ts +1 -1
  50. package/dist-types/ts3.4/commands/ListOrganizationAdminAccountsCommand.d.ts +1 -1
  51. package/dist-types/ts3.4/commands/ListResourceProfileArtifactsCommand.d.ts +1 -1
  52. package/dist-types/ts3.4/commands/ListResourceProfileDetectionsCommand.d.ts +1 -1
  53. package/dist-types/ts3.4/commands/ListSensitivityInspectionTemplatesCommand.d.ts +1 -1
  54. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +1 -1
  55. package/dist-types/ts3.4/commands/PutClassificationExportConfigurationCommand.d.ts +1 -1
  56. package/dist-types/ts3.4/commands/PutFindingsPublicationConfigurationCommand.d.ts +1 -1
  57. package/dist-types/ts3.4/commands/SearchResourcesCommand.d.ts +1 -1
  58. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +1 -1
  59. package/dist-types/ts3.4/commands/TestCustomDataIdentifierCommand.d.ts +1 -1
  60. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +1 -1
  61. package/dist-types/ts3.4/commands/UpdateAllowListCommand.d.ts +1 -1
  62. package/dist-types/ts3.4/commands/UpdateAutomatedDiscoveryConfigurationCommand.d.ts +1 -1
  63. package/dist-types/ts3.4/commands/UpdateClassificationJobCommand.d.ts +1 -1
  64. package/dist-types/ts3.4/commands/UpdateClassificationScopeCommand.d.ts +1 -1
  65. package/dist-types/ts3.4/commands/UpdateFindingsFilterCommand.d.ts +1 -1
  66. package/dist-types/ts3.4/commands/UpdateMacieSessionCommand.d.ts +1 -1
  67. package/dist-types/ts3.4/commands/UpdateMemberSessionCommand.d.ts +1 -1
  68. package/dist-types/ts3.4/commands/UpdateOrganizationConfigurationCommand.d.ts +1 -1
  69. package/dist-types/ts3.4/commands/UpdateResourceProfileCommand.d.ts +1 -1
  70. package/dist-types/ts3.4/commands/UpdateResourceProfileDetectionsCommand.d.ts +1 -1
  71. package/dist-types/ts3.4/index.d.ts +4 -1
  72. package/dist-types/ts3.4/models/enums.d.ts +441 -0
  73. package/dist-types/ts3.4/models/errors.d.ts +56 -0
  74. package/dist-types/ts3.4/models/models_0.d.ts +304 -481
  75. package/dist-types/ts3.4/models/models_1.d.ts +1 -287
  76. package/package.json +12 -12
  77. package/dist-es/models/index.js +0 -2
  78. package/dist-types/models/index.d.ts +0 -2
  79. package/dist-types/ts3.4/models/index.d.ts +0 -2
@@ -1,965 +1,4 @@
1
- import { AdminAccount, AllowListCriteria, AutoEnableMode, AutomatedDiscoveryStatus, ClassificationExportConfiguration, ClassificationScopeSummary, ClassificationScopeUpdateOperation, CustomDataIdentifierSummary, Detection, FindingCriteria, FindingPublishingFrequency, FindingsFilterAction, FindingsFilterListItem, Invitation, JobStatus, JobSummary, ListJobsFilterTerm, MacieStatus, ManagedDataIdentifierSummary, MatchingResource, Member, OrderBy, ResourceProfileArtifact, RetrievalConfiguration, RetrievalMode, RevealConfiguration, SearchResourcesCriteria, SecurityHubConfiguration, SensitivityInspectionTemplateExcludes, SensitivityInspectionTemplateIncludes, SensitivityInspectionTemplatesEntry, SortCriteria, SuppressDataIdentifier } from "./models_0";
2
- /**
3
- * <p>Specifies criteria for filtering the results of a request for information about classification jobs.</p>
4
- * @public
5
- */
6
- export interface ListJobsFilterCriteria {
7
- /**
8
- * <p>An array of objects, one for each condition that determines which jobs to exclude from the results.</p>
9
- * @public
10
- */
11
- excludes?: ListJobsFilterTerm[] | undefined;
12
- /**
13
- * <p>An array of objects, one for each condition that determines which jobs to include in the results.</p>
14
- * @public
15
- */
16
- includes?: ListJobsFilterTerm[] | undefined;
17
- }
18
- /**
19
- * @public
20
- * @enum
21
- */
22
- export declare const ListJobsSortAttributeName: {
23
- readonly createdAt: "createdAt";
24
- readonly jobStatus: "jobStatus";
25
- readonly jobType: "jobType";
26
- readonly name: "name";
27
- };
28
- /**
29
- * @public
30
- */
31
- export type ListJobsSortAttributeName = (typeof ListJobsSortAttributeName)[keyof typeof ListJobsSortAttributeName];
32
- /**
33
- * <p>Specifies criteria for sorting the results of a request for information about classification jobs.</p>
34
- * @public
35
- */
36
- export interface ListJobsSortCriteria {
37
- /**
38
- * <p>The property to sort the results by.</p>
39
- * @public
40
- */
41
- attributeName?: ListJobsSortAttributeName | undefined;
42
- /**
43
- * <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>
44
- * @public
45
- */
46
- orderBy?: OrderBy | undefined;
47
- }
48
- /**
49
- * @public
50
- */
51
- export interface ListClassificationJobsRequest {
52
- /**
53
- * <p>The criteria to use to filter the results.</p>
54
- * @public
55
- */
56
- filterCriteria?: ListJobsFilterCriteria | undefined;
57
- /**
58
- * <p>The maximum number of items to include in each page of the response.</p>
59
- * @public
60
- */
61
- maxResults?: number | undefined;
62
- /**
63
- * <p>The nextToken string that specifies which page of results to return in a paginated response.</p>
64
- * @public
65
- */
66
- nextToken?: string | undefined;
67
- /**
68
- * <p>The criteria to use to sort the results.</p>
69
- * @public
70
- */
71
- sortCriteria?: ListJobsSortCriteria | undefined;
72
- }
73
- /**
74
- * @public
75
- */
76
- export interface ListClassificationJobsResponse {
77
- /**
78
- * <p>An array of objects, one for each job that matches the filter criteria specified in the request.</p>
79
- * @public
80
- */
81
- items?: JobSummary[] | undefined;
82
- /**
83
- * <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>
84
- * @public
85
- */
86
- nextToken?: string | undefined;
87
- }
88
- /**
89
- * @public
90
- */
91
- export interface ListClassificationScopesRequest {
92
- /**
93
- * <p>The name of the classification scope to retrieve the unique identifier for.</p>
94
- * @public
95
- */
96
- name?: string | undefined;
97
- /**
98
- * <p>The nextToken string that specifies which page of results to return in a paginated response.</p>
99
- * @public
100
- */
101
- nextToken?: string | undefined;
102
- }
103
- /**
104
- * @public
105
- */
106
- export interface ListClassificationScopesResponse {
107
- /**
108
- * <p>An array that specifies the unique identifier and name of the classification scope for the account.</p>
109
- * @public
110
- */
111
- classificationScopes?: ClassificationScopeSummary[] | undefined;
112
- /**
113
- * <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>
114
- * @public
115
- */
116
- nextToken?: string | undefined;
117
- }
118
- /**
119
- * @public
120
- */
121
- export interface ListCustomDataIdentifiersRequest {
122
- /**
123
- * <p>The maximum number of items to include in each page of the response.</p>
124
- * @public
125
- */
126
- maxResults?: number | undefined;
127
- /**
128
- * <p>The nextToken string that specifies which page of results to return in a paginated response.</p>
129
- * @public
130
- */
131
- nextToken?: string | undefined;
132
- }
133
- /**
134
- * @public
135
- */
136
- export interface ListCustomDataIdentifiersResponse {
137
- /**
138
- * <p>An array of objects, one for each custom data identifier.</p>
139
- * @public
140
- */
141
- items?: CustomDataIdentifierSummary[] | undefined;
142
- /**
143
- * <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>
144
- * @public
145
- */
146
- nextToken?: string | undefined;
147
- }
148
- /**
149
- * @public
150
- */
151
- export interface ListFindingsRequest {
152
- /**
153
- * <p>The criteria to use to filter the results.</p>
154
- * @public
155
- */
156
- findingCriteria?: FindingCriteria | undefined;
157
- /**
158
- * <p>The maximum number of items to include in each page of the response.</p>
159
- * @public
160
- */
161
- maxResults?: number | undefined;
162
- /**
163
- * <p>The nextToken string that specifies which page of results to return in a paginated response.</p>
164
- * @public
165
- */
166
- nextToken?: string | undefined;
167
- /**
168
- * <p>The criteria to use to sort the results.</p>
169
- * @public
170
- */
171
- sortCriteria?: SortCriteria | undefined;
172
- }
173
- /**
174
- * @public
175
- */
176
- export interface ListFindingsResponse {
177
- /**
178
- * <p>An array of strings, where each string is the unique identifier for a finding that matches the filter criteria specified in the request.</p>
179
- * @public
180
- */
181
- findingIds?: string[] | undefined;
182
- /**
183
- * <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>
184
- * @public
185
- */
186
- nextToken?: string | undefined;
187
- }
188
- /**
189
- * @public
190
- */
191
- export interface ListFindingsFiltersRequest {
192
- /**
193
- * <p>The maximum number of items to include in each page of a paginated response.</p>
194
- * @public
195
- */
196
- maxResults?: number | undefined;
197
- /**
198
- * <p>The nextToken string that specifies which page of results to return in a paginated response.</p>
199
- * @public
200
- */
201
- nextToken?: string | undefined;
202
- }
203
- /**
204
- * @public
205
- */
206
- export interface ListFindingsFiltersResponse {
207
- /**
208
- * <p>An array of objects, one for each filter that's associated with the account.</p>
209
- * @public
210
- */
211
- findingsFilterListItems?: FindingsFilterListItem[] | undefined;
212
- /**
213
- * <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>
214
- * @public
215
- */
216
- nextToken?: string | undefined;
217
- }
218
- /**
219
- * @public
220
- */
221
- export interface ListInvitationsRequest {
222
- /**
223
- * <p>The maximum number of items to include in each page of a paginated response.</p>
224
- * @public
225
- */
226
- maxResults?: number | undefined;
227
- /**
228
- * <p>The nextToken string that specifies which page of results to return in a paginated response.</p>
229
- * @public
230
- */
231
- nextToken?: string | undefined;
232
- }
233
- /**
234
- * @public
235
- */
236
- export interface ListInvitationsResponse {
237
- /**
238
- * <p>An array of objects, one for each invitation that was received by the account.</p>
239
- * @public
240
- */
241
- invitations?: Invitation[] | undefined;
242
- /**
243
- * <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>
244
- * @public
245
- */
246
- nextToken?: string | undefined;
247
- }
248
- /**
249
- * @public
250
- */
251
- export interface ListManagedDataIdentifiersRequest {
252
- /**
253
- * <p>The nextToken string that specifies which page of results to return in a paginated response.</p>
254
- * @public
255
- */
256
- nextToken?: string | undefined;
257
- }
258
- /**
259
- * @public
260
- */
261
- export interface ListManagedDataIdentifiersResponse {
262
- /**
263
- * <p>An array of objects, one for each managed data identifier.</p>
264
- * @public
265
- */
266
- items?: ManagedDataIdentifierSummary[] | undefined;
267
- /**
268
- * <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>
269
- * @public
270
- */
271
- nextToken?: string | undefined;
272
- }
273
- /**
274
- * @public
275
- */
276
- export interface ListMembersRequest {
277
- /**
278
- * <p>The maximum number of items to include in each page of a paginated response.</p>
279
- * @public
280
- */
281
- maxResults?: number | undefined;
282
- /**
283
- * <p>The nextToken string that specifies which page of results to return in a paginated response.</p>
284
- * @public
285
- */
286
- nextToken?: string | undefined;
287
- /**
288
- * <p>Specifies which accounts to include in the response, based on the status of an account's relationship with the administrator account. By default, the response includes only current member accounts. To include all accounts, set this value to false.</p>
289
- * @public
290
- */
291
- onlyAssociated?: string | undefined;
292
- }
293
- /**
294
- * @public
295
- */
296
- export interface ListMembersResponse {
297
- /**
298
- * <p>An array of objects, one for each account that's associated with the administrator account and matches the criteria specified in the request.</p>
299
- * @public
300
- */
301
- members?: Member[] | undefined;
302
- /**
303
- * <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>
304
- * @public
305
- */
306
- nextToken?: string | undefined;
307
- }
308
- /**
309
- * @public
310
- */
311
- export interface ListOrganizationAdminAccountsRequest {
312
- /**
313
- * <p>The maximum number of items to include in each page of a paginated response.</p>
314
- * @public
315
- */
316
- maxResults?: number | undefined;
317
- /**
318
- * <p>The nextToken string that specifies which page of results to return in a paginated response.</p>
319
- * @public
320
- */
321
- nextToken?: string | undefined;
322
- }
323
- /**
324
- * @public
325
- */
326
- export interface ListOrganizationAdminAccountsResponse {
327
- /**
328
- * <p>An array of objects, one for each delegated Amazon Macie administrator account for the organization. Only one of these accounts can have a status of ENABLED.</p>
329
- * @public
330
- */
331
- adminAccounts?: AdminAccount[] | undefined;
332
- /**
333
- * <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>
334
- * @public
335
- */
336
- nextToken?: string | undefined;
337
- }
338
- /**
339
- * @public
340
- */
341
- export interface ListResourceProfileArtifactsRequest {
342
- /**
343
- * <p>The nextToken string that specifies which page of results to return in a paginated response.</p>
344
- * @public
345
- */
346
- nextToken?: string | undefined;
347
- /**
348
- * <p>The Amazon Resource Name (ARN) of the S3 bucket that the request applies to.</p>
349
- * @public
350
- */
351
- resourceArn: string | undefined;
352
- }
353
- /**
354
- * @public
355
- */
356
- export interface ListResourceProfileArtifactsResponse {
357
- /**
358
- * <p>An array of objects, one for each of 1-100 S3 objects that Amazon Macie selected for analysis.</p> <p>If Macie has analyzed more than 100 objects in the bucket, Macie populates the array based on the value for the ResourceProfileArtifact.sensitive field for an object: true (sensitive), followed by false (not sensitive). Macie then populates any remaining items in the array with information about objects where the value for the ResourceProfileArtifact.classificationResultStatus field is SKIPPED.</p>
359
- * @public
360
- */
361
- artifacts?: ResourceProfileArtifact[] | undefined;
362
- /**
363
- * <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>
364
- * @public
365
- */
366
- nextToken?: string | undefined;
367
- }
368
- /**
369
- * @public
370
- */
371
- export interface ListResourceProfileDetectionsRequest {
372
- /**
373
- * <p>The maximum number of items to include in each page of a paginated response.</p>
374
- * @public
375
- */
376
- maxResults?: number | undefined;
377
- /**
378
- * <p>The nextToken string that specifies which page of results to return in a paginated response.</p>
379
- * @public
380
- */
381
- nextToken?: string | undefined;
382
- /**
383
- * <p>The Amazon Resource Name (ARN) of the S3 bucket that the request applies to.</p>
384
- * @public
385
- */
386
- resourceArn: string | undefined;
387
- }
388
- /**
389
- * @public
390
- */
391
- export interface ListResourceProfileDetectionsResponse {
392
- /**
393
- * <p>An array of objects, one for each type of sensitive data that Amazon Macie found in the bucket. Each object reports the number of occurrences of the specified type and provides information about the custom data identifier or managed data identifier that detected the data.</p>
394
- * @public
395
- */
396
- detections?: Detection[] | undefined;
397
- /**
398
- * <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>
399
- * @public
400
- */
401
- nextToken?: string | undefined;
402
- }
403
- /**
404
- * @public
405
- */
406
- export interface ListSensitivityInspectionTemplatesRequest {
407
- /**
408
- * <p>The maximum number of items to include in each page of a paginated response.</p>
409
- * @public
410
- */
411
- maxResults?: number | undefined;
412
- /**
413
- * <p>The nextToken string that specifies which page of results to return in a paginated response.</p>
414
- * @public
415
- */
416
- nextToken?: string | undefined;
417
- }
418
- /**
419
- * @public
420
- */
421
- export interface ListSensitivityInspectionTemplatesResponse {
422
- /**
423
- * <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>
424
- * @public
425
- */
426
- nextToken?: string | undefined;
427
- /**
428
- * <p>An array that specifies the unique identifier and name of the sensitivity inspection template for the account.</p>
429
- * @public
430
- */
431
- sensitivityInspectionTemplates?: SensitivityInspectionTemplatesEntry[] | undefined;
432
- }
433
- /**
434
- * @public
435
- */
436
- export interface ListTagsForResourceRequest {
437
- /**
438
- * <p>The Amazon Resource Name (ARN) of the resource.</p>
439
- * @public
440
- */
441
- resourceArn: string | undefined;
442
- }
443
- /**
444
- * @public
445
- */
446
- export interface ListTagsForResourceResponse {
447
- /**
448
- * <p>A map of key-value pairs that specifies which tags (keys and values) are associated with the resource.</p>
449
- * @public
450
- */
451
- tags?: Record<string, string> | undefined;
452
- }
453
- /**
454
- * @public
455
- */
456
- export interface PutClassificationExportConfigurationRequest {
457
- /**
458
- * <p>The location to store data classification results in, and the encryption settings to use when storing results in that location.</p>
459
- * @public
460
- */
461
- configuration: ClassificationExportConfiguration | undefined;
462
- }
463
- /**
464
- * @public
465
- */
466
- export interface PutClassificationExportConfigurationResponse {
467
- /**
468
- * <p>The location where the data classification results are stored, and the encryption settings that are used when storing results in that location.</p>
469
- * @public
470
- */
471
- configuration?: ClassificationExportConfiguration | undefined;
472
- }
473
- /**
474
- * @public
475
- */
476
- export interface PutFindingsPublicationConfigurationRequest {
477
- /**
478
- * <p>A unique, case-sensitive token that you provide to ensure the idempotency of the request.</p>
479
- * @public
480
- */
481
- clientToken?: string | undefined;
482
- /**
483
- * <p>The configuration settings that determine which findings to publish to Security Hub.</p>
484
- * @public
485
- */
486
- securityHubConfiguration?: SecurityHubConfiguration | undefined;
487
- }
488
- /**
489
- * @public
490
- */
491
- export interface PutFindingsPublicationConfigurationResponse {
492
- }
493
- /**
494
- * <p>Specifies property- and tag-based conditions that define filter criteria for including or excluding Amazon Web Services resources from the query results.</p>
495
- * @public
496
- */
497
- export interface SearchResourcesCriteriaBlock {
498
- /**
499
- * <p>An array of objects, one for each property- or tag-based condition that includes or excludes resources from the query results. If you specify more than one condition, Amazon Macie uses AND logic to join the conditions.</p>
500
- * @public
501
- */
502
- and?: SearchResourcesCriteria[] | undefined;
503
- }
504
- /**
505
- * <p>Specifies property- and tag-based conditions that define filter criteria for including or excluding S3 buckets from the query results. Exclude conditions take precedence over include conditions.</p>
506
- * @public
507
- */
508
- export interface SearchResourcesBucketCriteria {
509
- /**
510
- * <p>The property- and tag-based conditions that determine which buckets to exclude from the results.</p>
511
- * @public
512
- */
513
- excludes?: SearchResourcesCriteriaBlock | undefined;
514
- /**
515
- * <p>The property- and tag-based conditions that determine which buckets to include in the results.</p>
516
- * @public
517
- */
518
- includes?: SearchResourcesCriteriaBlock | undefined;
519
- }
520
- /**
521
- * @public
522
- * @enum
523
- */
524
- export declare const SearchResourcesSortAttributeName: {
525
- readonly ACCOUNT_ID: "ACCOUNT_ID";
526
- readonly RESOURCE_NAME: "RESOURCE_NAME";
527
- readonly S3_CLASSIFIABLE_OBJECT_COUNT: "S3_CLASSIFIABLE_OBJECT_COUNT";
528
- readonly S3_CLASSIFIABLE_SIZE_IN_BYTES: "S3_CLASSIFIABLE_SIZE_IN_BYTES";
529
- };
530
- /**
531
- * @public
532
- */
533
- export type SearchResourcesSortAttributeName = (typeof SearchResourcesSortAttributeName)[keyof typeof SearchResourcesSortAttributeName];
534
- /**
535
- * <p>Specifies criteria for sorting the results of a query for information about Amazon Web Services resources that Amazon Macie monitors and analyzes.</p>
536
- * @public
537
- */
538
- export interface SearchResourcesSortCriteria {
539
- /**
540
- * <p>The property to sort the results by.</p>
541
- * @public
542
- */
543
- attributeName?: SearchResourcesSortAttributeName | undefined;
544
- /**
545
- * <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>
546
- * @public
547
- */
548
- orderBy?: OrderBy | undefined;
549
- }
550
- /**
551
- * @public
552
- */
553
- export interface SearchResourcesRequest {
554
- /**
555
- * <p>The filter conditions that determine which S3 buckets to include or exclude from the query results.</p>
556
- * @public
557
- */
558
- bucketCriteria?: SearchResourcesBucketCriteria | undefined;
559
- /**
560
- * <p>The maximum number of items to include in each page of the response. The default value is 50.</p>
561
- * @public
562
- */
563
- maxResults?: number | undefined;
564
- /**
565
- * <p>The nextToken string that specifies which page of results to return in a paginated response.</p>
566
- * @public
567
- */
568
- nextToken?: string | undefined;
569
- /**
570
- * <p>The criteria to use to sort the results.</p>
571
- * @public
572
- */
573
- sortCriteria?: SearchResourcesSortCriteria | undefined;
574
- }
575
- /**
576
- * @public
577
- */
578
- export interface SearchResourcesResponse {
579
- /**
580
- * <p>An array of objects, one for each resource that matches the filter criteria specified in the request.</p>
581
- * @public
582
- */
583
- matchingResources?: MatchingResource[] | undefined;
584
- /**
585
- * <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>
586
- * @public
587
- */
588
- nextToken?: string | undefined;
589
- }
590
- /**
591
- * @public
592
- */
593
- export interface TagResourceRequest {
594
- /**
595
- * <p>The Amazon Resource Name (ARN) of the resource.</p>
596
- * @public
597
- */
598
- resourceArn: string | undefined;
599
- /**
600
- * <p>A map of key-value pairs that specifies the tags to associate with the resource.</p> <p>A resource 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>
601
- * @public
602
- */
603
- tags: Record<string, string> | undefined;
604
- }
605
- /**
606
- * @public
607
- */
608
- export interface TagResourceResponse {
609
- }
610
- /**
611
- * @public
612
- */
613
- export interface TestCustomDataIdentifierRequest {
614
- /**
615
- * <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>
616
- * @public
617
- */
618
- ignoreWords?: string[] | undefined;
619
- /**
620
- * <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>
621
- * @public
622
- */
623
- keywords?: string[] | undefined;
624
- /**
625
- * <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>
626
- * @public
627
- */
628
- maximumMatchDistance?: number | undefined;
629
- /**
630
- * <p>The regular expression (<i>regex</i>) that defines the pattern to match. The expression can contain as many as 512 characters.</p>
631
- * @public
632
- */
633
- regex: string | undefined;
634
- /**
635
- * <p>The sample text to inspect by using the custom data identifier. The text can contain as many as 1,000 characters.</p>
636
- * @public
637
- */
638
- sampleText: string | undefined;
639
- }
640
- /**
641
- * @public
642
- */
643
- export interface TestCustomDataIdentifierResponse {
644
- /**
645
- * <p>The number of occurrences of sample text that matched the criteria specified by the custom data identifier.</p>
646
- * @public
647
- */
648
- matchCount?: number | undefined;
649
- }
650
- /**
651
- * @public
652
- */
653
- export interface UntagResourceRequest {
654
- /**
655
- * <p>The Amazon Resource Name (ARN) of the resource.</p>
656
- * @public
657
- */
658
- resourceArn: string | undefined;
659
- /**
660
- * <p>One or more tags (keys) to remove from the resource. In an HTTP request to remove multiple tags, append the tagKeys parameter and argument for each tag to remove, separated by an ampersand (&amp;).</p>
661
- * @public
662
- */
663
- tagKeys: string[] | undefined;
664
- }
665
- /**
666
- * @public
667
- */
668
- export interface UntagResourceResponse {
669
- }
670
- /**
671
- * @public
672
- */
673
- export interface UpdateAllowListRequest {
674
- /**
675
- * <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 that defines a text pattern to ignore (regex).</p> <p>You can change a list's underlying criteria, such as the name of the S3 object or the regular expression to use. However, you can't change the type from s3WordsList to regex or the other way around.</p>
676
- * @public
677
- */
678
- criteria: AllowListCriteria | undefined;
679
- /**
680
- * <p>A custom description of the allow list. The description can contain as many as 512 characters.</p>
681
- * @public
682
- */
683
- description?: string | undefined;
684
- /**
685
- * <p>The unique identifier for the Amazon Macie resource that the request applies to.</p>
686
- * @public
687
- */
688
- id: string | undefined;
689
- /**
690
- * <p>A custom name for the allow list. The name can contain as many as 128 characters.</p>
691
- * @public
692
- */
693
- name: string | undefined;
694
- }
695
- /**
696
- * @public
697
- */
698
- export interface UpdateAllowListResponse {
699
- /**
700
- * <p>The Amazon Resource Name (ARN) of the allow list.</p>
701
- * @public
702
- */
703
- arn?: string | undefined;
704
- /**
705
- * <p>The unique identifier for the allow list.</p>
706
- * @public
707
- */
708
- id?: string | undefined;
709
- }
710
- /**
711
- * @public
712
- */
713
- export interface UpdateAutomatedDiscoveryConfigurationRequest {
714
- /**
715
- * <p>Specifies whether to automatically enable automated sensitive data discovery for accounts in the organization. Valid values are: ALL (default), 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> <p>If you specify NEW or NONE, automated sensitive data discovery continues to be enabled for any existing accounts that it's currently enabled for. To enable or disable it for individual member accounts, specify NEW or NONE, and then enable or disable it for each account by using the BatchUpdateAutomatedDiscoveryAccounts operation.</p>
716
- * @public
717
- */
718
- autoEnableOrganizationMembers?: AutoEnableMode | undefined;
719
- /**
720
- * <p>The new status of automated sensitive data discovery for the organization or account. Valid values are: ENABLED, start or resume all automated sensitive data discovery activities; and, DISABLED, stop performing all automated sensitive data discovery activities.</p> <p>If you specify DISABLED for an administrator account, you also disable automated sensitive data discovery for all member accounts in the organization.</p>
721
- * @public
722
- */
723
- status: AutomatedDiscoveryStatus | undefined;
724
- }
725
- /**
726
- * @public
727
- */
728
- export interface UpdateAutomatedDiscoveryConfigurationResponse {
729
- }
730
- /**
731
- * @public
732
- */
733
- export interface UpdateClassificationJobRequest {
734
- /**
735
- * <p>The unique identifier for the classification job.</p>
736
- * @public
737
- */
738
- jobId: string | undefined;
739
- /**
740
- * <p>The new status for the job. Valid values are:</p> <ul><li><p>CANCELLED - Stops the job permanently and cancels it. This value is valid only if the job's current status is IDLE, PAUSED, RUNNING, or USER_PAUSED.</p> <p>If you specify this value and the job's current status is RUNNING, Amazon Macie immediately begins to stop all processing tasks for the job. You can't resume or restart a job after you cancel it.</p></li> <li><p>RUNNING - Resumes the job. This value is valid only if the job's current status is USER_PAUSED.</p> <p>If you paused the job while it was actively running and you specify this value less than 30 days after you paused the job, Macie immediately resumes processing from the point where you paused the job. Otherwise, Macie resumes the job according to the schedule and other settings for the job.</p></li> <li><p>USER_PAUSED - Pauses the job temporarily. This value is valid only if the job's current status is IDLE, PAUSED, or RUNNING. If you specify this value and the job's current status is RUNNING, Macie immediately begins to pause all processing tasks for the job.</p> <p>If you pause a one-time job and you don't resume it within 30 days, the job expires and Macie cancels the job. If you pause a recurring job when its status is RUNNING and you don't resume it within 30 days, the job run expires and Macie cancels the run. To check the expiration date, refer to the UserPausedDetails.jobExpiresAt property.</p></li></ul>
741
- * @public
742
- */
743
- jobStatus: JobStatus | undefined;
744
- }
745
- /**
746
- * @public
747
- */
748
- export interface UpdateClassificationJobResponse {
749
- }
750
- /**
751
- * <p>Specifies S3 buckets to add or remove from the exclusion list defined by the classification scope for an Amazon Macie account.</p>
752
- * @public
753
- */
754
- export interface S3ClassificationScopeExclusionUpdate {
755
- /**
756
- * <p>Depending on the value specified for the update operation (ClassificationScopeUpdateOperation), an array of strings that: lists the names of buckets to add or remove from the list, or specifies a new set of bucket names that overwrites all existing names in the list. Each string must be the full name of an existing S3 bucket. Values are case sensitive.</p>
757
- * @public
758
- */
759
- bucketNames: string[] | undefined;
760
- /**
761
- * <p>Specifies how to apply the changes to the exclusion list. Valid values are:</p> <ul><li><p>ADD - Append the specified bucket names to the current list.</p></li> <li><p>REMOVE - Remove the specified bucket names from the current list.</p></li> <li><p>REPLACE - Overwrite the current list with the specified list of bucket names. If you specify this value, Amazon Macie removes all existing names from the list and adds all the specified names to the list.</p></li></ul>
762
- * @public
763
- */
764
- operation: ClassificationScopeUpdateOperation | undefined;
765
- }
766
- /**
767
- * <p>Specifies changes to the list of S3 buckets that are excluded from automated sensitive data discovery for an Amazon Macie account.</p>
768
- * @public
769
- */
770
- export interface S3ClassificationScopeUpdate {
771
- /**
772
- * <p>The names of the S3 buckets to add or remove from the list.</p>
773
- * @public
774
- */
775
- excludes: S3ClassificationScopeExclusionUpdate | undefined;
776
- }
777
- /**
778
- * @public
779
- */
780
- export interface UpdateClassificationScopeRequest {
781
- /**
782
- * <p>The unique identifier for the Amazon Macie resource that the request applies to.</p>
783
- * @public
784
- */
785
- id: string | undefined;
786
- /**
787
- * <p>The S3 buckets to add or remove from the exclusion list defined by the classification scope.</p>
788
- * @public
789
- */
790
- s3?: S3ClassificationScopeUpdate | undefined;
791
- }
792
- /**
793
- * @public
794
- */
795
- export interface UpdateClassificationScopeResponse {
796
- }
797
- /**
798
- * @public
799
- */
800
- export interface UpdateFindingsFilterRequest {
801
- /**
802
- * <p>The action to perform on findings that match the filter criteria (findingCriteria). Valid values are: ARCHIVE, suppress (automatically archive) the findings; and, NOOP, don't perform any action on the findings.</p>
803
- * @public
804
- */
805
- action?: FindingsFilterAction | undefined;
806
- /**
807
- * <p>A unique, case-sensitive token that you provide to ensure the idempotency of the request.</p>
808
- * @public
809
- */
810
- clientToken?: string | undefined;
811
- /**
812
- * <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>
813
- * @public
814
- */
815
- description?: string | undefined;
816
- /**
817
- * <p>The criteria to use to filter findings.</p>
818
- * @public
819
- */
820
- findingCriteria?: FindingCriteria | undefined;
821
- /**
822
- * <p>The unique identifier for the Amazon Macie resource that the request applies to.</p>
823
- * @public
824
- */
825
- id: string | undefined;
826
- /**
827
- * <p>A custom name for the filter. The name must contain at least 3 characters and can contain as many as 64 characters.</p> <p>We strongly recommend that you avoid including any sensitive data in the name of a filter. Other users of your account might be able to see this name, depending on the actions that they're allowed to perform in Amazon Macie.</p>
828
- * @public
829
- */
830
- name?: string | undefined;
831
- /**
832
- * <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>
833
- * @public
834
- */
835
- position?: number | undefined;
836
- }
837
- /**
838
- * @public
839
- */
840
- export interface UpdateFindingsFilterResponse {
841
- /**
842
- * <p>The Amazon Resource Name (ARN) of the filter that was updated.</p>
843
- * @public
844
- */
845
- arn?: string | undefined;
846
- /**
847
- * <p>The unique identifier for the filter that was updated.</p>
848
- * @public
849
- */
850
- id?: string | undefined;
851
- }
852
- /**
853
- * @public
854
- */
855
- export interface UpdateMacieSessionRequest {
856
- /**
857
- * <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>
858
- * @public
859
- */
860
- findingPublishingFrequency?: FindingPublishingFrequency | undefined;
861
- /**
862
- * <p>Specifies a new status for the account. Valid values are: ENABLED, resume all Amazon Macie activities for the account; and, PAUSED, suspend all Macie activities for the account.</p>
863
- * @public
864
- */
865
- status?: MacieStatus | undefined;
866
- }
867
- /**
868
- * @public
869
- */
870
- export interface UpdateMacieSessionResponse {
871
- }
872
- /**
873
- * @public
874
- */
875
- export interface UpdateMemberSessionRequest {
876
- /**
877
- * <p>The unique identifier for the Amazon Macie resource that the request applies to.</p>
878
- * @public
879
- */
880
- id: string | undefined;
881
- /**
882
- * <p>Specifies the new status for the account. Valid values are: ENABLED, resume all Amazon Macie activities for the account; and, PAUSED, suspend all Macie activities for the account.</p>
883
- * @public
884
- */
885
- status: MacieStatus | undefined;
886
- }
887
- /**
888
- * @public
889
- */
890
- export interface UpdateMemberSessionResponse {
891
- }
892
- /**
893
- * @public
894
- */
895
- export interface UpdateOrganizationConfigurationRequest {
896
- /**
897
- * <p>Specifies whether to enable Amazon Macie automatically for accounts that are added to the organization in Organizations.</p>
898
- * @public
899
- */
900
- autoEnable: boolean | undefined;
901
- }
902
- /**
903
- * @public
904
- */
905
- export interface UpdateOrganizationConfigurationResponse {
906
- }
907
- /**
908
- * @public
909
- */
910
- export interface UpdateResourceProfileRequest {
911
- /**
912
- * <p>The Amazon Resource Name (ARN) of the S3 bucket that the request applies to.</p>
913
- * @public
914
- */
915
- resourceArn: string | undefined;
916
- /**
917
- * <p>The new sensitivity score for the bucket. Valid values are: 100, assign the maximum score and apply the <i>Sensitive</i> label to the bucket; and, null (empty), assign a score that Amazon Macie calculates automatically after you submit the request.</p>
918
- * @public
919
- */
920
- sensitivityScoreOverride?: number | undefined;
921
- }
922
- /**
923
- * @public
924
- */
925
- export interface UpdateResourceProfileResponse {
926
- }
927
- /**
928
- * @public
929
- */
930
- export interface UpdateResourceProfileDetectionsRequest {
931
- /**
932
- * <p>The Amazon Resource Name (ARN) of the S3 bucket that the request applies to.</p>
933
- * @public
934
- */
935
- resourceArn: string | undefined;
936
- /**
937
- * <p>An array of objects, one for each custom data identifier or managed data identifier that detected a type of sensitive data to exclude from the bucket's score. To include all sensitive data types in the score, don't specify any values for this array.</p>
938
- * @public
939
- */
940
- suppressDataIdentifiers?: SuppressDataIdentifier[] | undefined;
941
- }
942
- /**
943
- * @public
944
- */
945
- export interface UpdateResourceProfileDetectionsResponse {
946
- }
947
- /**
948
- * <p>Specifies the access method and settings to use when retrieving occurrences of sensitive data reported by findings. If your request specifies an Identity and Access Management (IAM) role to assume, Amazon Macie verifies that the role exists and the attached policies are configured correctly. If there's an issue, Macie returns an error. For information about addressing the issue, see <a href="https://docs.aws.amazon.com/macie/latest/user/findings-retrieve-sd-options.html">Configuration options for retrieving sensitive data samples</a> in the <i>Amazon Macie User Guide</i>.</p>
949
- * @public
950
- */
951
- export interface UpdateRetrievalConfiguration {
952
- /**
953
- * <p>The access method to use when retrieving 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; and, CALLER_CREDENTIALS, use the credentials of the IAM user who requests the sensitive data. If you specify ASSUME_ROLE, also specify the name of an existing IAM role for Macie to assume (roleName).</p> <important><p>If you change this value from ASSUME_ROLE to CALLER_CREDENTIALS for an existing configuration, Macie permanently deletes the external ID and role name currently specified for the configuration. These settings can't be recovered after they're deleted.</p></important>
954
- * @public
955
- */
956
- retrievalMode: RetrievalMode | undefined;
957
- /**
958
- * <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. The trust and permissions policies for the role must meet all requirements for Macie to assume the role.</p>
959
- * @public
960
- */
961
- roleName?: string | undefined;
962
- }
1
+ import { RetrievalConfiguration, RevealConfiguration, SensitivityInspectionTemplateExcludes, SensitivityInspectionTemplateIncludes, UpdateRetrievalConfiguration } from "./models_0";
963
2
  /**
964
3
  * @public
965
4
  */