@aws-sdk/client-macie2 3.379.1 → 3.382.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -4,10 +4,12 @@ import { AdminAccount, AllowListCriteria, AutomatedDiscoveryStatus, Classificati
4
4
  */
5
5
  export interface ListInvitationsRequest {
6
6
  /**
7
+ * @public
7
8
  * <p>The maximum number of items to include in each page of a paginated response.</p>
8
9
  */
9
10
  maxResults?: number;
10
11
  /**
12
+ * @public
11
13
  * <p>The nextToken string that specifies which page of results to return in a paginated response.</p>
12
14
  */
13
15
  nextToken?: string;
@@ -17,10 +19,12 @@ export interface ListInvitationsRequest {
17
19
  */
18
20
  export interface ListInvitationsResponse {
19
21
  /**
22
+ * @public
20
23
  * <p>An array of objects, one for each invitation that was received by the account.</p>
21
24
  */
22
25
  invitations?: Invitation[];
23
26
  /**
27
+ * @public
24
28
  * <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>
25
29
  */
26
30
  nextToken?: string;
@@ -30,6 +34,7 @@ export interface ListInvitationsResponse {
30
34
  */
31
35
  export interface ListManagedDataIdentifiersRequest {
32
36
  /**
37
+ * @public
33
38
  * <p>The nextToken string that specifies which page of results to return in a paginated response.</p>
34
39
  */
35
40
  nextToken?: string;
@@ -39,10 +44,12 @@ export interface ListManagedDataIdentifiersRequest {
39
44
  */
40
45
  export interface ListManagedDataIdentifiersResponse {
41
46
  /**
47
+ * @public
42
48
  * <p>An array of objects, one for each managed data identifier.</p>
43
49
  */
44
50
  items?: ManagedDataIdentifierSummary[];
45
51
  /**
52
+ * @public
46
53
  * <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>
47
54
  */
48
55
  nextToken?: string;
@@ -52,14 +59,17 @@ export interface ListManagedDataIdentifiersResponse {
52
59
  */
53
60
  export interface ListMembersRequest {
54
61
  /**
62
+ * @public
55
63
  * <p>The maximum number of items to include in each page of a paginated response.</p>
56
64
  */
57
65
  maxResults?: number;
58
66
  /**
67
+ * @public
59
68
  * <p>The nextToken string that specifies which page of results to return in a paginated response.</p>
60
69
  */
61
70
  nextToken?: string;
62
71
  /**
72
+ * @public
63
73
  * <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>
64
74
  */
65
75
  onlyAssociated?: string;
@@ -69,10 +79,12 @@ export interface ListMembersRequest {
69
79
  */
70
80
  export interface ListMembersResponse {
71
81
  /**
82
+ * @public
72
83
  * <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>
73
84
  */
74
85
  members?: Member[];
75
86
  /**
87
+ * @public
76
88
  * <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>
77
89
  */
78
90
  nextToken?: string;
@@ -82,10 +94,12 @@ export interface ListMembersResponse {
82
94
  */
83
95
  export interface ListOrganizationAdminAccountsRequest {
84
96
  /**
97
+ * @public
85
98
  * <p>The maximum number of items to include in each page of a paginated response.</p>
86
99
  */
87
100
  maxResults?: number;
88
101
  /**
102
+ * @public
89
103
  * <p>The nextToken string that specifies which page of results to return in a paginated response.</p>
90
104
  */
91
105
  nextToken?: string;
@@ -95,10 +109,12 @@ export interface ListOrganizationAdminAccountsRequest {
95
109
  */
96
110
  export interface ListOrganizationAdminAccountsResponse {
97
111
  /**
112
+ * @public
98
113
  * <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>
99
114
  */
100
115
  adminAccounts?: AdminAccount[];
101
116
  /**
117
+ * @public
102
118
  * <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>
103
119
  */
104
120
  nextToken?: string;
@@ -108,10 +124,12 @@ export interface ListOrganizationAdminAccountsResponse {
108
124
  */
109
125
  export interface ListResourceProfileArtifactsRequest {
110
126
  /**
127
+ * @public
111
128
  * <p>The nextToken string that specifies which page of results to return in a paginated response.</p>
112
129
  */
113
130
  nextToken?: string;
114
131
  /**
132
+ * @public
115
133
  * <p>The Amazon Resource Name (ARN) of the S3 bucket that the request applies to.</p>
116
134
  */
117
135
  resourceArn: string | undefined;
@@ -121,10 +139,12 @@ export interface ListResourceProfileArtifactsRequest {
121
139
  */
122
140
  export interface ListResourceProfileArtifactsResponse {
123
141
  /**
142
+ * @public
124
143
  * <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>
125
144
  */
126
145
  artifacts?: ResourceProfileArtifact[];
127
146
  /**
147
+ * @public
128
148
  * <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>
129
149
  */
130
150
  nextToken?: string;
@@ -134,14 +154,17 @@ export interface ListResourceProfileArtifactsResponse {
134
154
  */
135
155
  export interface ListResourceProfileDetectionsRequest {
136
156
  /**
157
+ * @public
137
158
  * <p>The maximum number of items to include in each page of a paginated response.</p>
138
159
  */
139
160
  maxResults?: number;
140
161
  /**
162
+ * @public
141
163
  * <p>The nextToken string that specifies which page of results to return in a paginated response.</p>
142
164
  */
143
165
  nextToken?: string;
144
166
  /**
167
+ * @public
145
168
  * <p>The Amazon Resource Name (ARN) of the S3 bucket that the request applies to.</p>
146
169
  */
147
170
  resourceArn: string | undefined;
@@ -151,10 +174,12 @@ export interface ListResourceProfileDetectionsRequest {
151
174
  */
152
175
  export interface ListResourceProfileDetectionsResponse {
153
176
  /**
177
+ * @public
154
178
  * <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>
155
179
  */
156
180
  detections?: Detection[];
157
181
  /**
182
+ * @public
158
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>
159
184
  */
160
185
  nextToken?: string;
@@ -164,10 +189,12 @@ export interface ListResourceProfileDetectionsResponse {
164
189
  */
165
190
  export interface ListSensitivityInspectionTemplatesRequest {
166
191
  /**
192
+ * @public
167
193
  * <p>The maximum number of items to include in each page of a paginated response.</p>
168
194
  */
169
195
  maxResults?: number;
170
196
  /**
197
+ * @public
171
198
  * <p>The nextToken string that specifies which page of results to return in a paginated response.</p>
172
199
  */
173
200
  nextToken?: string;
@@ -177,10 +204,12 @@ export interface ListSensitivityInspectionTemplatesRequest {
177
204
  */
178
205
  export interface ListSensitivityInspectionTemplatesResponse {
179
206
  /**
207
+ * @public
180
208
  * <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>
181
209
  */
182
210
  nextToken?: string;
183
211
  /**
212
+ * @public
184
213
  * <p>An array that specifies the unique identifier and name of the sensitivity inspection template for the account.</p>
185
214
  */
186
215
  sensitivityInspectionTemplates?: SensitivityInspectionTemplatesEntry[];
@@ -190,6 +219,7 @@ export interface ListSensitivityInspectionTemplatesResponse {
190
219
  */
191
220
  export interface ListTagsForResourceRequest {
192
221
  /**
222
+ * @public
193
223
  * <p>The Amazon Resource Name (ARN) of the resource.</p>
194
224
  */
195
225
  resourceArn: string | undefined;
@@ -199,6 +229,7 @@ export interface ListTagsForResourceRequest {
199
229
  */
200
230
  export interface ListTagsForResourceResponse {
201
231
  /**
232
+ * @public
202
233
  * <p>A map of key-value pairs that specifies which tags (keys and values) are associated with the resource.</p>
203
234
  */
204
235
  tags?: Record<string, string>;
@@ -208,6 +239,7 @@ export interface ListTagsForResourceResponse {
208
239
  */
209
240
  export interface PutClassificationExportConfigurationRequest {
210
241
  /**
242
+ * @public
211
243
  * <p>The location to store data classification results in, and the encryption settings to use when storing results in that location.</p>
212
244
  */
213
245
  configuration: ClassificationExportConfiguration | undefined;
@@ -217,6 +249,7 @@ export interface PutClassificationExportConfigurationRequest {
217
249
  */
218
250
  export interface PutClassificationExportConfigurationResponse {
219
251
  /**
252
+ * @public
220
253
  * <p>The location where the data classification results are stored, and the encryption settings that are used when storing results in that location.</p>
221
254
  */
222
255
  configuration?: ClassificationExportConfiguration;
@@ -226,10 +259,12 @@ export interface PutClassificationExportConfigurationResponse {
226
259
  */
227
260
  export interface PutFindingsPublicationConfigurationRequest {
228
261
  /**
262
+ * @public
229
263
  * <p>A unique, case-sensitive token that you provide to ensure the idempotency of the request.</p>
230
264
  */
231
265
  clientToken?: string;
232
266
  /**
267
+ * @public
233
268
  * <p>The configuration settings that determine which findings to publish to Security Hub.</p>
234
269
  */
235
270
  securityHubConfiguration?: SecurityHubConfiguration;
@@ -245,6 +280,7 @@ export interface PutFindingsPublicationConfigurationResponse {
245
280
  */
246
281
  export interface SearchResourcesCriteriaBlock {
247
282
  /**
283
+ * @public
248
284
  * <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>
249
285
  */
250
286
  and?: SearchResourcesCriteria[];
@@ -255,10 +291,12 @@ export interface SearchResourcesCriteriaBlock {
255
291
  */
256
292
  export interface SearchResourcesBucketCriteria {
257
293
  /**
294
+ * @public
258
295
  * <p>The property- and tag-based conditions that determine which buckets to exclude from the results.</p>
259
296
  */
260
297
  excludes?: SearchResourcesCriteriaBlock;
261
298
  /**
299
+ * @public
262
300
  * <p>The property- and tag-based conditions that determine which buckets to include in the results.</p>
263
301
  */
264
302
  includes?: SearchResourcesCriteriaBlock;
@@ -283,10 +321,12 @@ export type SearchResourcesSortAttributeName = (typeof SearchResourcesSortAttrib
283
321
  */
284
322
  export interface SearchResourcesSortCriteria {
285
323
  /**
324
+ * @public
286
325
  * <p>The property to sort the results by.</p>
287
326
  */
288
327
  attributeName?: SearchResourcesSortAttributeName | string;
289
328
  /**
329
+ * @public
290
330
  * <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>
291
331
  */
292
332
  orderBy?: OrderBy | string;
@@ -296,18 +336,22 @@ export interface SearchResourcesSortCriteria {
296
336
  */
297
337
  export interface SearchResourcesRequest {
298
338
  /**
339
+ * @public
299
340
  * <p>The filter conditions that determine which S3 buckets to include or exclude from the query results.</p>
300
341
  */
301
342
  bucketCriteria?: SearchResourcesBucketCriteria;
302
343
  /**
344
+ * @public
303
345
  * <p>The maximum number of items to include in each page of the response. The default value is 50.</p>
304
346
  */
305
347
  maxResults?: number;
306
348
  /**
349
+ * @public
307
350
  * <p>The nextToken string that specifies which page of results to return in a paginated response.</p>
308
351
  */
309
352
  nextToken?: string;
310
353
  /**
354
+ * @public
311
355
  * <p>The criteria to use to sort the results.</p>
312
356
  */
313
357
  sortCriteria?: SearchResourcesSortCriteria;
@@ -317,10 +361,12 @@ export interface SearchResourcesRequest {
317
361
  */
318
362
  export interface SearchResourcesResponse {
319
363
  /**
364
+ * @public
320
365
  * <p>An array of objects, one for each resource that matches the filter criteria specified in the request.</p>
321
366
  */
322
367
  matchingResources?: MatchingResource[];
323
368
  /**
369
+ * @public
324
370
  * <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>
325
371
  */
326
372
  nextToken?: string;
@@ -330,10 +376,12 @@ export interface SearchResourcesResponse {
330
376
  */
331
377
  export interface TagResourceRequest {
332
378
  /**
379
+ * @public
333
380
  * <p>The Amazon Resource Name (ARN) of the resource.</p>
334
381
  */
335
382
  resourceArn: string | undefined;
336
383
  /**
384
+ * @public
337
385
  * <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>
338
386
  */
339
387
  tags: Record<string, string> | undefined;
@@ -348,22 +396,27 @@ export interface TagResourceResponse {
348
396
  */
349
397
  export interface TestCustomDataIdentifierRequest {
350
398
  /**
399
+ * @public
351
400
  * <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>
352
401
  */
353
402
  ignoreWords?: string[];
354
403
  /**
404
+ * @public
355
405
  * <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>
356
406
  */
357
407
  keywords?: string[];
358
408
  /**
409
+ * @public
359
410
  * <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>
360
411
  */
361
412
  maximumMatchDistance?: number;
362
413
  /**
414
+ * @public
363
415
  * <p>The regular expression (<i>regex</i>) that defines the pattern to match. The expression can contain as many as 512 characters.</p>
364
416
  */
365
417
  regex: string | undefined;
366
418
  /**
419
+ * @public
367
420
  * <p>The sample text to inspect by using the custom data identifier. The text can contain as many as 1,000 characters.</p>
368
421
  */
369
422
  sampleText: string | undefined;
@@ -373,6 +426,7 @@ export interface TestCustomDataIdentifierRequest {
373
426
  */
374
427
  export interface TestCustomDataIdentifierResponse {
375
428
  /**
429
+ * @public
376
430
  * <p>The number of occurrences of sample text that matched the criteria specified by the custom data identifier.</p>
377
431
  */
378
432
  matchCount?: number;
@@ -382,10 +436,12 @@ export interface TestCustomDataIdentifierResponse {
382
436
  */
383
437
  export interface UntagResourceRequest {
384
438
  /**
439
+ * @public
385
440
  * <p>The Amazon Resource Name (ARN) of the resource.</p>
386
441
  */
387
442
  resourceArn: string | undefined;
388
443
  /**
444
+ * @public
389
445
  * <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>
390
446
  */
391
447
  tagKeys: string[] | undefined;
@@ -400,18 +456,22 @@ export interface UntagResourceResponse {
400
456
  */
401
457
  export interface UpdateAllowListRequest {
402
458
  /**
459
+ * @public
403
460
  * <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>
404
461
  */
405
462
  criteria: AllowListCriteria | undefined;
406
463
  /**
464
+ * @public
407
465
  * <p>A custom description of the allow list. The description can contain as many as 512 characters.</p>
408
466
  */
409
467
  description?: string;
410
468
  /**
469
+ * @public
411
470
  * <p>The unique identifier for the Amazon Macie resource that the request applies to.</p>
412
471
  */
413
472
  id: string | undefined;
414
473
  /**
474
+ * @public
415
475
  * <p>A custom name for the allow list. The name can contain as many as 128 characters.</p>
416
476
  */
417
477
  name: string | undefined;
@@ -421,10 +481,12 @@ export interface UpdateAllowListRequest {
421
481
  */
422
482
  export interface UpdateAllowListResponse {
423
483
  /**
484
+ * @public
424
485
  * <p>The Amazon Resource Name (ARN) of the allow list.</p>
425
486
  */
426
487
  arn?: string;
427
488
  /**
489
+ * @public
428
490
  * <p>The unique identifier for the allow list.</p>
429
491
  */
430
492
  id?: string;
@@ -434,6 +496,7 @@ export interface UpdateAllowListResponse {
434
496
  */
435
497
  export interface UpdateAutomatedDiscoveryConfigurationRequest {
436
498
  /**
499
+ * @public
437
500
  * <p>The new status of automated sensitive data discovery for the account. Valid values are: ENABLED, start or resume automated sensitive data discovery activities for the account; and, DISABLED, stop performing automated sensitive data discovery activities for the account.</p> <p>When you enable automated sensitive data discovery for the first time, Amazon Macie uses default configuration settings to determine which data sources to analyze and which managed data identifiers to use. To change these settings, use the UpdateClassificationScope and UpdateSensitivityInspectionTemplate operations, respectively. If you change the settings and subsequently disable the configuration, Amazon Macie retains your changes.</p>
438
501
  */
439
502
  status: AutomatedDiscoveryStatus | string | undefined;
@@ -448,10 +511,12 @@ export interface UpdateAutomatedDiscoveryConfigurationResponse {
448
511
  */
449
512
  export interface UpdateClassificationJobRequest {
450
513
  /**
514
+ * @public
451
515
  * <p>The unique identifier for the classification job.</p>
452
516
  */
453
517
  jobId: string | undefined;
454
518
  /**
519
+ * @public
455
520
  * <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>
456
521
  */
457
522
  jobStatus: JobStatus | string | undefined;
@@ -467,10 +532,12 @@ export interface UpdateClassificationJobResponse {
467
532
  */
468
533
  export interface S3ClassificationScopeExclusionUpdate {
469
534
  /**
535
+ * @public
470
536
  * <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 S3 bucket. Values are case sensitive.</p>
471
537
  */
472
538
  bucketNames: string[] | undefined;
473
539
  /**
540
+ * @public
474
541
  * <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>
475
542
  */
476
543
  operation: ClassificationScopeUpdateOperation | string | undefined;
@@ -481,6 +548,7 @@ export interface S3ClassificationScopeExclusionUpdate {
481
548
  */
482
549
  export interface S3ClassificationScopeUpdate {
483
550
  /**
551
+ * @public
484
552
  * <p>The names of the S3 buckets to add or remove from the list.</p>
485
553
  */
486
554
  excludes: S3ClassificationScopeExclusionUpdate | undefined;
@@ -490,10 +558,12 @@ export interface S3ClassificationScopeUpdate {
490
558
  */
491
559
  export interface UpdateClassificationScopeRequest {
492
560
  /**
561
+ * @public
493
562
  * <p>The unique identifier for the Amazon Macie resource that the request applies to.</p>
494
563
  */
495
564
  id: string | undefined;
496
565
  /**
566
+ * @public
497
567
  * <p>The S3 buckets to add or remove from the exclusion list defined by the classification scope.</p>
498
568
  */
499
569
  s3?: S3ClassificationScopeUpdate;
@@ -508,30 +578,37 @@ export interface UpdateClassificationScopeResponse {
508
578
  */
509
579
  export interface UpdateFindingsFilterRequest {
510
580
  /**
581
+ * @public
511
582
  * <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>
512
583
  */
513
584
  action?: FindingsFilterAction | string;
514
585
  /**
586
+ * @public
515
587
  * <p>A unique, case-sensitive token that you provide to ensure the idempotency of the request.</p>
516
588
  */
517
589
  clientToken?: string;
518
590
  /**
591
+ * @public
519
592
  * <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>
520
593
  */
521
594
  description?: string;
522
595
  /**
596
+ * @public
523
597
  * <p>The criteria to use to filter findings.</p>
524
598
  */
525
599
  findingCriteria?: FindingCriteria;
526
600
  /**
601
+ * @public
527
602
  * <p>The unique identifier for the Amazon Macie resource that the request applies to.</p>
528
603
  */
529
604
  id: string | undefined;
530
605
  /**
606
+ * @public
531
607
  * <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>
532
608
  */
533
609
  name?: string;
534
610
  /**
611
+ * @public
535
612
  * <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>
536
613
  */
537
614
  position?: number;
@@ -541,10 +618,12 @@ export interface UpdateFindingsFilterRequest {
541
618
  */
542
619
  export interface UpdateFindingsFilterResponse {
543
620
  /**
621
+ * @public
544
622
  * <p>The Amazon Resource Name (ARN) of the filter that was updated.</p>
545
623
  */
546
624
  arn?: string;
547
625
  /**
626
+ * @public
548
627
  * <p>The unique identifier for the filter that was updated.</p>
549
628
  */
550
629
  id?: string;
@@ -554,10 +633,12 @@ export interface UpdateFindingsFilterResponse {
554
633
  */
555
634
  export interface UpdateMacieSessionRequest {
556
635
  /**
636
+ * @public
557
637
  * <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>
558
638
  */
559
639
  findingPublishingFrequency?: FindingPublishingFrequency | string;
560
640
  /**
641
+ * @public
561
642
  * <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>
562
643
  */
563
644
  status?: MacieStatus | string;
@@ -572,10 +653,12 @@ export interface UpdateMacieSessionResponse {
572
653
  */
573
654
  export interface UpdateMemberSessionRequest {
574
655
  /**
656
+ * @public
575
657
  * <p>The unique identifier for the Amazon Macie resource that the request applies to.</p>
576
658
  */
577
659
  id: string | undefined;
578
660
  /**
661
+ * @public
579
662
  * <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>
580
663
  */
581
664
  status: MacieStatus | string | undefined;
@@ -590,6 +673,7 @@ export interface UpdateMemberSessionResponse {
590
673
  */
591
674
  export interface UpdateOrganizationConfigurationRequest {
592
675
  /**
676
+ * @public
593
677
  * <p>Specifies whether to enable Amazon Macie automatically for an account when the account is added to the organization in Organizations.</p>
594
678
  */
595
679
  autoEnable: boolean | undefined;
@@ -604,10 +688,12 @@ export interface UpdateOrganizationConfigurationResponse {
604
688
  */
605
689
  export interface UpdateResourceProfileRequest {
606
690
  /**
691
+ * @public
607
692
  * <p>The Amazon Resource Name (ARN) of the S3 bucket that the request applies to.</p>
608
693
  */
609
694
  resourceArn: string | undefined;
610
695
  /**
696
+ * @public
611
697
  * <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>
612
698
  */
613
699
  sensitivityScoreOverride?: number;
@@ -622,10 +708,12 @@ export interface UpdateResourceProfileResponse {
622
708
  */
623
709
  export interface UpdateResourceProfileDetectionsRequest {
624
710
  /**
711
+ * @public
625
712
  * <p>The Amazon Resource Name (ARN) of the S3 bucket that the request applies to.</p>
626
713
  */
627
714
  resourceArn: string | undefined;
628
715
  /**
716
+ * @public
629
717
  * <p>An array of objects, one for each custom data identifier or managed data identifier that detected the type of sensitive data to start excluding or including in the bucket's score. To start including all sensitive data types in the score, don't specify any values for this array.</p>
630
718
  */
631
719
  suppressDataIdentifiers?: SuppressDataIdentifier[];
@@ -640,6 +728,7 @@ export interface UpdateResourceProfileDetectionsResponse {
640
728
  */
641
729
  export interface UpdateRevealConfigurationRequest {
642
730
  /**
731
+ * @public
643
732
  * <p>The new configuration settings and the status of the configuration for the account.</p>
644
733
  */
645
734
  configuration: RevealConfiguration | undefined;
@@ -649,6 +738,7 @@ export interface UpdateRevealConfigurationRequest {
649
738
  */
650
739
  export interface UpdateRevealConfigurationResponse {
651
740
  /**
741
+ * @public
652
742
  * <p>The new configuration settings and the status of the configuration for the account.</p>
653
743
  */
654
744
  configuration?: RevealConfiguration;
@@ -658,18 +748,22 @@ export interface UpdateRevealConfigurationResponse {
658
748
  */
659
749
  export interface UpdateSensitivityInspectionTemplateRequest {
660
750
  /**
751
+ * @public
661
752
  * <p>A custom description of the template. The description can contain as many as 200 characters.</p>
662
753
  */
663
754
  description?: string;
664
755
  /**
756
+ * @public
665
757
  * <p>The managed data identifiers to explicitly exclude (not use) when analyzing data.</p> <p>To exclude an allow list or custom data identifier that's currently included by the template, update the values for the SensitivityInspectionTemplateIncludes.allowListIds and SensitivityInspectionTemplateIncludes.customDataIdentifierIds properties, respectively.</p>
666
758
  */
667
759
  excludes?: SensitivityInspectionTemplateExcludes;
668
760
  /**
761
+ * @public
669
762
  * <p>The unique identifier for the Amazon Macie resource that the request applies to.</p>
670
763
  */
671
764
  id: string | undefined;
672
765
  /**
766
+ * @public
673
767
  * <p>The allow lists, custom data identifiers, and managed data identifiers to include (use) when analyzing data.</p>
674
768
  */
675
769
  includes?: SensitivityInspectionTemplateIncludes;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-macie2",
3
3
  "description": "AWS SDK for JavaScript Macie2 Client for Node.js, Browser and React Native",
4
- "version": "3.379.1",
4
+ "version": "3.382.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,15 +21,15 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "3.0.0",
23
23
  "@aws-crypto/sha256-js": "3.0.0",
24
- "@aws-sdk/client-sts": "3.379.1",
25
- "@aws-sdk/credential-provider-node": "3.379.1",
24
+ "@aws-sdk/client-sts": "3.382.0",
25
+ "@aws-sdk/credential-provider-node": "3.382.0",
26
26
  "@aws-sdk/middleware-host-header": "3.379.1",
27
27
  "@aws-sdk/middleware-logger": "3.378.0",
28
28
  "@aws-sdk/middleware-recursion-detection": "3.378.0",
29
29
  "@aws-sdk/middleware-signing": "3.379.1",
30
- "@aws-sdk/middleware-user-agent": "3.379.1",
30
+ "@aws-sdk/middleware-user-agent": "3.382.0",
31
31
  "@aws-sdk/types": "3.378.0",
32
- "@aws-sdk/util-endpoints": "3.378.0",
32
+ "@aws-sdk/util-endpoints": "3.382.0",
33
33
  "@aws-sdk/util-user-agent-browser": "3.378.0",
34
34
  "@aws-sdk/util-user-agent-node": "3.378.0",
35
35
  "@smithy/config-resolver": "^2.0.1",