@aws-sdk/client-securitylake 3.241.0 → 3.245.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/README.md +27 -11
- package/dist-cjs/endpoint/ruleset.js +3 -3
- package/dist-es/endpoint/ruleset.js +3 -3
- package/dist-types/SecurityLake.d.ts +138 -103
- package/dist-types/SecurityLakeClient.d.ts +27 -11
- package/dist-types/commands/CreateAwsLogSourceCommand.d.ts +12 -12
- package/dist-types/commands/CreateCustomLogSourceCommand.d.ts +6 -6
- package/dist-types/commands/CreateDatalakeAutoEnableCommand.d.ts +3 -2
- package/dist-types/commands/CreateDatalakeCommand.d.ts +15 -12
- package/dist-types/commands/CreateDatalakeDelegatedAdminCommand.d.ts +3 -3
- package/dist-types/commands/CreateDatalakeExceptionsSubscriptionCommand.d.ts +2 -2
- package/dist-types/commands/CreateSubscriberCommand.d.ts +2 -1
- package/dist-types/commands/CreateSubscriptionNotificationConfigurationCommand.d.ts +2 -2
- package/dist-types/commands/DeleteAwsLogSourceCommand.d.ts +11 -13
- package/dist-types/commands/DeleteCustomLogSourceCommand.d.ts +1 -1
- package/dist-types/commands/DeleteDatalakeAutoEnableCommand.d.ts +9 -6
- package/dist-types/commands/DeleteDatalakeCommand.d.ts +8 -7
- package/dist-types/commands/DeleteDatalakeDelegatedAdminCommand.d.ts +3 -1
- package/dist-types/commands/DeleteDatalakeExceptionsSubscriptionCommand.d.ts +2 -1
- package/dist-types/commands/DeleteSubscriberCommand.d.ts +3 -1
- package/dist-types/commands/DeleteSubscriptionNotificationConfigurationCommand.d.ts +2 -2
- package/dist-types/commands/GetDatalakeAutoEnableCommand.d.ts +3 -1
- package/dist-types/commands/GetDatalakeCommand.d.ts +2 -1
- package/dist-types/commands/GetDatalakeExceptionsExpiryCommand.d.ts +3 -2
- package/dist-types/commands/GetDatalakeStatusCommand.d.ts +2 -1
- package/dist-types/commands/GetSubscriberCommand.d.ts +2 -1
- package/dist-types/commands/ListDatalakeExceptionsCommand.d.ts +2 -1
- package/dist-types/commands/ListLogSourcesCommand.d.ts +1 -1
- package/dist-types/commands/ListSubscribersCommand.d.ts +2 -1
- package/dist-types/commands/UpdateDatalakeCommand.d.ts +2 -4
- package/dist-types/commands/UpdateDatalakeExceptionsExpiryCommand.d.ts +3 -4
- package/dist-types/commands/UpdateDatalakeExceptionsSubscriptionCommand.d.ts +2 -1
- package/dist-types/commands/UpdateSubscriberCommand.d.ts +2 -1
- package/dist-types/commands/UpdateSubscriptionNotificationConfigurationCommand.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +201 -157
- package/dist-types/ts3.4/models/models_0.d.ts +1 -1
- package/package.json +4 -4
|
@@ -19,7 +19,9 @@ export declare enum AccessType {
|
|
|
19
19
|
S3 = "S3"
|
|
20
20
|
}
|
|
21
21
|
/**
|
|
22
|
-
* <p>Amazon Security Lake
|
|
22
|
+
* <p>Amazon Security Lake cannot find an Amazon Web Services account with the accountID that you
|
|
23
|
+
* specified, or the account whose credentials you used to make this request isn't a member of
|
|
24
|
+
* an organization.</p>
|
|
23
25
|
*/
|
|
24
26
|
export declare class AccountNotFoundException extends __BaseException {
|
|
25
27
|
readonly name: "AccountNotFoundException";
|
|
@@ -70,7 +72,7 @@ export declare enum SourceStatus {
|
|
|
70
72
|
PENDING = "PENDING"
|
|
71
73
|
}
|
|
72
74
|
/**
|
|
73
|
-
* <p>
|
|
75
|
+
* <p>Retrieves the Logs status for the Amazon Security Lake account.</p>
|
|
74
76
|
*/
|
|
75
77
|
export interface LogsStatus {
|
|
76
78
|
/**
|
|
@@ -79,24 +81,26 @@ export interface LogsStatus {
|
|
|
79
81
|
*/
|
|
80
82
|
pathToLogs: string | undefined;
|
|
81
83
|
/**
|
|
82
|
-
* <p>
|
|
84
|
+
* <p>The health status of services, including error codes and patterns.</p>
|
|
83
85
|
*/
|
|
84
86
|
healthStatus: SourceStatus | string | undefined;
|
|
85
87
|
}
|
|
86
88
|
/**
|
|
87
|
-
* <p>Security Lake
|
|
89
|
+
* <p>Amazon Security Lake collects logs and events from supported Amazon Web Services and
|
|
90
|
+
* custom sources. For the list of supported Amazon Web Services, see the <a href="https://docs.aws.amazon.com/security-lake/latest/userguide/internal-sources.html">Amazon Security Lake User Guide</a>.</p>
|
|
88
91
|
*/
|
|
89
92
|
export interface AccountSources {
|
|
90
93
|
/**
|
|
91
|
-
* <p>
|
|
94
|
+
* <p>The ID of the Security Lake account for which logs are collected.</p>
|
|
92
95
|
*/
|
|
93
96
|
account: string | undefined;
|
|
94
97
|
/**
|
|
95
|
-
* <p>The supported Amazon Web Services
|
|
98
|
+
* <p>The supported Amazon Web Services from which logs and events are collected.
|
|
99
|
+
* Amazon Security Lake supports log and event collection for natively supported Amazon Web Services. </p>
|
|
96
100
|
*/
|
|
97
101
|
sourceType: string | undefined;
|
|
98
102
|
/**
|
|
99
|
-
* <p>
|
|
103
|
+
* <p>The log status for the Security Lake account.</p>
|
|
100
104
|
*/
|
|
101
105
|
logsStatus?: LogsStatus[];
|
|
102
106
|
/**
|
|
@@ -120,16 +124,16 @@ export declare enum AwsLogSourceType {
|
|
|
120
124
|
VPC_FLOW = "VPC_FLOW"
|
|
121
125
|
}
|
|
122
126
|
/**
|
|
123
|
-
* <p>Automatically enable new organization accounts as member accounts from
|
|
124
|
-
* account.</p>
|
|
127
|
+
* <p>Automatically enable new organization accounts as member accounts from an Amazon Security Lake
|
|
128
|
+
* administrator account.</p>
|
|
125
129
|
*/
|
|
126
130
|
export interface AutoEnableNewRegionConfiguration {
|
|
127
131
|
/**
|
|
128
|
-
* <p>The Regions where Security Lake is
|
|
132
|
+
* <p>The Amazon Web Services Regions where Security Lake is automatically enabled.</p>
|
|
129
133
|
*/
|
|
130
134
|
region: Region | string | undefined;
|
|
131
135
|
/**
|
|
132
|
-
* <p>The Amazon Web Services sources
|
|
136
|
+
* <p>The Amazon Web Services sources that are automatically enabled in Security Lake.</p>
|
|
133
137
|
*/
|
|
134
138
|
sources: (AwsLogSourceType | string)[] | undefined;
|
|
135
139
|
}
|
|
@@ -208,30 +212,35 @@ export declare enum Dimension {
|
|
|
208
212
|
}
|
|
209
213
|
export interface CreateAwsLogSourceRequest {
|
|
210
214
|
/**
|
|
211
|
-
* <p>Specifies the input order to enable dimensions in Security Lake, namely
|
|
212
|
-
*
|
|
215
|
+
* <p>Specifies the input order to enable dimensions in Security Lake, namely Region, source type,
|
|
216
|
+
* and member account.</p>
|
|
213
217
|
*/
|
|
214
218
|
inputOrder: (Dimension | string)[] | undefined;
|
|
215
219
|
/**
|
|
216
|
-
* <p>Enables specific sources in all
|
|
220
|
+
* <p>Enables data collection from specific Amazon Web Services sources in all specific
|
|
221
|
+
* accounts and specific Regions.</p>
|
|
217
222
|
*/
|
|
218
223
|
enableAllDimensions?: Record<string, Record<string, string[]>>;
|
|
219
224
|
/**
|
|
220
|
-
* <p>Enables specific
|
|
225
|
+
* <p>Enables data collection from specific Amazon Web Services sources in specific accounts or
|
|
226
|
+
* Regions.</p>
|
|
221
227
|
*/
|
|
222
228
|
enableTwoDimensions?: Record<string, string[]>;
|
|
223
229
|
/**
|
|
224
|
-
* <p>Enables all sources in specific accounts or
|
|
230
|
+
* <p>Enables data collection from all Amazon Web Services sources in specific accounts or
|
|
231
|
+
* Regions.</p>
|
|
225
232
|
*/
|
|
226
233
|
enableSingleDimension?: string[];
|
|
227
234
|
}
|
|
228
235
|
export interface CreateAwsLogSourceResponse {
|
|
229
236
|
/**
|
|
230
|
-
* <p>
|
|
237
|
+
* <p>Lists the accounts that are in the process of enabling a natively supported Amazon Web Service as a Security Lake source.</p>
|
|
231
238
|
*/
|
|
232
239
|
processing?: string[];
|
|
233
240
|
/**
|
|
234
|
-
* <p>
|
|
241
|
+
* <p>Lists all accounts in which enabling a natively supported Amazon Web Service as
|
|
242
|
+
* a Security Lake source failed. The failure occurred as these accounts are not part of an
|
|
243
|
+
* organization.</p>
|
|
235
244
|
*/
|
|
236
245
|
failed?: string[];
|
|
237
246
|
}
|
|
@@ -272,10 +281,10 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
272
281
|
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
273
282
|
}
|
|
274
283
|
/**
|
|
275
|
-
* <p>Provides an extension of the AmazonServiceException for errors reported by Amazon S3
|
|
276
|
-
*
|
|
277
|
-
*
|
|
278
|
-
*
|
|
284
|
+
* <p>Provides an extension of the AmazonServiceException for errors reported by Amazon S3 while processing a request. In particular, this class provides access to the
|
|
285
|
+
* Amazon S3 extended request ID. If Amazon S3 is incorrectly handling a
|
|
286
|
+
* request and you need to contact Amazon, this extended request ID may provide useful
|
|
287
|
+
* debugging information. </p>
|
|
279
288
|
*/
|
|
280
289
|
export declare class S3Exception extends __BaseException {
|
|
281
290
|
readonly name: "S3Exception";
|
|
@@ -286,7 +295,7 @@ export declare class S3Exception extends __BaseException {
|
|
|
286
295
|
constructor(opts: __ExceptionOptionType<S3Exception, __BaseException>);
|
|
287
296
|
}
|
|
288
297
|
/**
|
|
289
|
-
* <p>The input fails to meet the constraints specified in Amazon Security Lake </p>
|
|
298
|
+
* <p>The input fails to meet the constraints specified in Amazon Security Lake. </p>
|
|
290
299
|
*/
|
|
291
300
|
export interface ValidationExceptionField {
|
|
292
301
|
/**
|
|
@@ -325,34 +334,38 @@ export declare class ValidationException extends __BaseException {
|
|
|
325
334
|
}
|
|
326
335
|
export interface CreateCustomLogSourceRequest {
|
|
327
336
|
/**
|
|
328
|
-
* <p>The
|
|
337
|
+
* <p>The name for a third-party custom source. This must be a Regionally unique value.</p>
|
|
329
338
|
*/
|
|
330
339
|
customSourceName: string | undefined;
|
|
331
340
|
/**
|
|
332
|
-
* <p>The Open Cybersecurity Schema Framework (OCSF) event class
|
|
341
|
+
* <p>The Open Cybersecurity Schema Framework (OCSF) event class which describes the type of
|
|
342
|
+
* data that the custom source will send to Security Lake.</p>
|
|
333
343
|
*/
|
|
334
344
|
eventClass: OcsfEventClass | string | undefined;
|
|
335
345
|
/**
|
|
336
|
-
* <p>The
|
|
346
|
+
* <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role
|
|
347
|
+
* to be used by the Glue crawler. The recommended IAM policies
|
|
348
|
+
* are:</p>
|
|
337
349
|
* <ul>
|
|
338
350
|
* <li>
|
|
339
351
|
* <p>The managed policy <code>AWSGlueServiceRole</code>
|
|
340
352
|
* </p>
|
|
341
353
|
* </li>
|
|
342
354
|
* <li>
|
|
343
|
-
* <p>A custom policy granting access to your S3 Data Lake</p>
|
|
355
|
+
* <p>A custom policy granting access to your Amazon S3 Data Lake</p>
|
|
344
356
|
* </li>
|
|
345
357
|
* </ul>
|
|
346
358
|
*/
|
|
347
359
|
glueInvocationRoleArn: string | undefined;
|
|
348
360
|
/**
|
|
349
|
-
* <p>The
|
|
361
|
+
* <p>The Amazon Web Services account ID of the custom source that will write logs and events
|
|
362
|
+
* into the Amazon S3 Data Lake.</p>
|
|
350
363
|
*/
|
|
351
364
|
logProviderAccountId: string | undefined;
|
|
352
365
|
}
|
|
353
366
|
export interface CreateCustomLogSourceResponse {
|
|
354
367
|
/**
|
|
355
|
-
* <p>The location of the partition in the
|
|
368
|
+
* <p>The location of the partition in the Amazon S3 bucket for Security Lake.</p>
|
|
356
369
|
*/
|
|
357
370
|
customDataLocation: string | undefined;
|
|
358
371
|
/**
|
|
@@ -369,10 +382,11 @@ export interface CreateCustomLogSourceResponse {
|
|
|
369
382
|
*/
|
|
370
383
|
glueDatabaseName: string | undefined;
|
|
371
384
|
/**
|
|
372
|
-
* <p> IAM
|
|
373
|
-
* Security Lake will apply the correct access policies to this
|
|
374
|
-
*
|
|
375
|
-
* must
|
|
385
|
+
* <p>The ARN of the IAM role to be used by the entity putting logs into your
|
|
386
|
+
* custom source partition. Security Lake will apply the correct access policies to this role, but
|
|
387
|
+
* you must first manually create the trust policy for this role. The IAM role
|
|
388
|
+
* name must start with the text 'Security Lake'. The IAM role must trust the
|
|
389
|
+
* <code>logProviderAccountId</code> to assume the role.</p>
|
|
376
390
|
*/
|
|
377
391
|
logProviderAccessRoleArn: string | undefined;
|
|
378
392
|
}
|
|
@@ -386,7 +400,7 @@ export declare enum StorageClass {
|
|
|
386
400
|
STANDARD_IA = "STANDARD_IA"
|
|
387
401
|
}
|
|
388
402
|
/**
|
|
389
|
-
* <p>Retention settings for the destination Amazon S3 buckets in Security Lake. </p>
|
|
403
|
+
* <p>Retention settings for the destination Amazon S3 buckets in Amazon Security Lake. </p>
|
|
390
404
|
*/
|
|
391
405
|
export interface RetentionSetting {
|
|
392
406
|
/**
|
|
@@ -396,16 +410,16 @@ export interface RetentionSetting {
|
|
|
396
410
|
storageClass?: StorageClass | string;
|
|
397
411
|
/**
|
|
398
412
|
* <p>The retention period specifies a fixed period of time during which the Security Lake object
|
|
399
|
-
* remains locked. You can specify the retention period for one or more
|
|
413
|
+
* remains locked. You can specify the retention period in days for one or more sources. </p>
|
|
400
414
|
*/
|
|
401
415
|
retentionPeriod?: number;
|
|
402
416
|
}
|
|
403
417
|
/**
|
|
404
|
-
* <p>Provides details of
|
|
418
|
+
* <p>Provides details of Amazon Security Lake configuration object.</p>
|
|
405
419
|
*/
|
|
406
420
|
export interface LakeConfigurationRequest {
|
|
407
421
|
/**
|
|
408
|
-
* <p>The type of encryption key used by Security Lake to encrypt the
|
|
422
|
+
* <p>The type of encryption key used by Amazon Security Lake to encrypt the Security Lake configuration
|
|
409
423
|
* object.</p>
|
|
410
424
|
*/
|
|
411
425
|
encryptionKey?: string;
|
|
@@ -419,37 +433,40 @@ export interface LakeConfigurationRequest {
|
|
|
419
433
|
*/
|
|
420
434
|
tagsMap?: Record<string, string>;
|
|
421
435
|
/**
|
|
422
|
-
* <p>Replication enables automatic, asynchronous copying of objects across Amazon S3
|
|
423
|
-
* Amazon S3 buckets that are configured for object replication can be owned
|
|
424
|
-
* by different accounts. You can replicate objects
|
|
425
|
-
*
|
|
426
|
-
* within the same Region as the source
|
|
436
|
+
* <p>Replication enables automatic, asynchronous copying of objects across Amazon S3
|
|
437
|
+
* buckets. Amazon S3 buckets that are configured for object replication can be owned
|
|
438
|
+
* by the same Amazon Web Services account or by different accounts. You can replicate objects
|
|
439
|
+
* to a single destination bucket or to multiple destination buckets. The destination buckets
|
|
440
|
+
* can be in different Amazon Web Services Regions or within the same Region as the source
|
|
441
|
+
* bucket.</p>
|
|
427
442
|
* <p>Set up one or more rollup Regions by providing the Region or Regions that should
|
|
428
443
|
* contribute to the central rollup Region. </p>
|
|
429
444
|
*/
|
|
430
445
|
replicationDestinationRegions?: (Region | string)[];
|
|
431
446
|
/**
|
|
432
|
-
* <p>Replication settings for the Amazon S3 buckets. This parameter uses the IAM role
|
|
433
|
-
*
|
|
447
|
+
* <p>Replication settings for the Amazon S3 buckets. This parameter uses the Identity and Access Management (IAM) role you created that is managed by Security Lake, to
|
|
448
|
+
* ensure the replication setting is correct. </p>
|
|
434
449
|
*/
|
|
435
450
|
replicationRoleArn?: string;
|
|
436
451
|
}
|
|
437
452
|
export interface CreateDatalakeRequest {
|
|
438
453
|
/**
|
|
439
|
-
* <p>Enable Security Lake in the specified Regions
|
|
454
|
+
* <p>Enable Security Lake in the specified Regions. To enable Security Lake in specific Amazon Web Services Regions, such as us-east-1 or ap-northeast-3, provide the Region codes. For a
|
|
455
|
+
* list of Region codes, see <a href="https://docs.aws.amazon.com/general/latest/gr/securitylake.html">Amazon Security Lake endpoints</a> in the
|
|
456
|
+
* Amazon Web Services General Reference.</p>
|
|
440
457
|
*/
|
|
441
458
|
regions?: (Region | string)[];
|
|
442
459
|
/**
|
|
443
|
-
* <p>
|
|
444
|
-
* data. </p>
|
|
460
|
+
* <p>Specify the Region or Regions that will contribute data to the rollup region.</p>
|
|
445
461
|
*/
|
|
446
462
|
configurations?: Record<string, LakeConfigurationRequest>;
|
|
447
463
|
/**
|
|
448
|
-
* <p>Enable Security Lake in all Regions
|
|
464
|
+
* <p>Enable Security Lake in all Regions.</p>
|
|
449
465
|
*/
|
|
450
466
|
enableAll?: boolean;
|
|
451
467
|
/**
|
|
452
|
-
* <p>The
|
|
468
|
+
* <p>The Amazon Resource Name (ARN) used to create and update the Glue table.
|
|
469
|
+
* This table contains partitions generated by the ingestion and normalization of Amazon Web Services log sources and custom sources.</p>
|
|
453
470
|
*/
|
|
454
471
|
metaStoreManagerRoleArn?: string;
|
|
455
472
|
}
|
|
@@ -511,8 +528,8 @@ export declare class ThrottlingException extends __BaseException {
|
|
|
511
528
|
}
|
|
512
529
|
export interface CreateDatalakeAutoEnableRequest {
|
|
513
530
|
/**
|
|
514
|
-
* <p>Enable
|
|
515
|
-
* data for new accounts in
|
|
531
|
+
* <p>Enable Security Lake with the specified configuration settings to begin collecting security
|
|
532
|
+
* data for new accounts in your organization. </p>
|
|
516
533
|
*/
|
|
517
534
|
configurationForNewAccounts: AutoEnableNewRegionConfiguration[] | undefined;
|
|
518
535
|
}
|
|
@@ -520,7 +537,7 @@ export interface CreateDatalakeAutoEnableResponse {
|
|
|
520
537
|
}
|
|
521
538
|
export interface CreateDatalakeDelegatedAdminRequest {
|
|
522
539
|
/**
|
|
523
|
-
* <p>
|
|
540
|
+
* <p>The Amazon Web Services account ID of the Security Lake delegated administrator.</p>
|
|
524
541
|
*/
|
|
525
542
|
account: string | undefined;
|
|
526
543
|
}
|
|
@@ -539,23 +556,24 @@ export declare enum SubscriptionProtocolType {
|
|
|
539
556
|
}
|
|
540
557
|
export interface CreateDatalakeExceptionsSubscriptionRequest {
|
|
541
558
|
/**
|
|
542
|
-
* <p>The subscription protocol to which exception
|
|
559
|
+
* <p>The subscription protocol to which exception notifications are posted. </p>
|
|
543
560
|
*/
|
|
544
561
|
subscriptionProtocol: SubscriptionProtocolType | string | undefined;
|
|
545
562
|
/**
|
|
546
|
-
* <p>The account
|
|
563
|
+
* <p>The Amazon Web Services account where you want to receive exception notifications.</p>
|
|
547
564
|
*/
|
|
548
565
|
notificationEndpoint: string | undefined;
|
|
549
566
|
}
|
|
550
567
|
export interface CreateDatalakeExceptionsSubscriptionResponse {
|
|
551
568
|
}
|
|
552
569
|
/**
|
|
553
|
-
* <p>The supported source types from which logs and events are collected in Amazon Security Lake.
|
|
570
|
+
* <p>The supported source types from which logs and events are collected in Amazon Security Lake.
|
|
571
|
+
* For the list of supported Amazon Web Services, see the <a href="https://docs.aws.amazon.com/security-lake/latest/userguide/internal-sources.html">Amazon Security Lake User Guide</a>.</p>
|
|
554
572
|
*/
|
|
555
573
|
export declare type SourceType = SourceType.AwsSourceTypeMember | SourceType.CustomSourceTypeMember | SourceType.$UnknownMember;
|
|
556
574
|
export declare namespace SourceType {
|
|
557
575
|
/**
|
|
558
|
-
* <p>Amazon Security Lake supports
|
|
576
|
+
* <p>Amazon Security Lake supports log and event collection for natively supported Amazon Web Services. </p>
|
|
559
577
|
*/
|
|
560
578
|
interface AwsSourceTypeMember {
|
|
561
579
|
awsSourceType: AwsLogSourceType | string;
|
|
@@ -563,7 +581,8 @@ export declare namespace SourceType {
|
|
|
563
581
|
$unknown?: never;
|
|
564
582
|
}
|
|
565
583
|
/**
|
|
566
|
-
* <p>Amazon Security Lake supports custom source types. For
|
|
584
|
+
* <p>Amazon Security Lake supports custom source types. For a detailed list, see the Amazon Security Lake
|
|
585
|
+
* User Guide.</p>
|
|
567
586
|
*/
|
|
568
587
|
interface CustomSourceTypeMember {
|
|
569
588
|
awsSourceType?: never;
|
|
@@ -584,19 +603,18 @@ export declare namespace SourceType {
|
|
|
584
603
|
}
|
|
585
604
|
export interface CreateSubscriberRequest {
|
|
586
605
|
/**
|
|
587
|
-
* <p>The supported Amazon Web Services
|
|
588
|
-
* supports
|
|
589
|
-
* services.</p>
|
|
606
|
+
* <p>The supported Amazon Web Services from which logs and events are collected.
|
|
607
|
+
* Security Lake supports log and event collection for natively supported Amazon Web Services.</p>
|
|
590
608
|
*/
|
|
591
609
|
sourceTypes: SourceType[] | undefined;
|
|
592
610
|
/**
|
|
593
|
-
* <p>The
|
|
611
|
+
* <p>The Amazon Web Services account ID used to access your data.</p>
|
|
594
612
|
*/
|
|
595
613
|
accountId: string | undefined;
|
|
596
614
|
/**
|
|
597
|
-
* <p>The external ID of the subscriber.
|
|
598
|
-
*
|
|
599
|
-
*
|
|
615
|
+
* <p>The external ID of the subscriber. This lets the user that is assuming the role assert
|
|
616
|
+
* the circumstances in which they are operating. It also provides a way for the account owner
|
|
617
|
+
* to permit the role to be assumed only under specific circumstances.</p>
|
|
600
618
|
*/
|
|
601
619
|
externalId: string | undefined;
|
|
602
620
|
/**
|
|
@@ -604,37 +622,38 @@ export interface CreateSubscriberRequest {
|
|
|
604
622
|
*/
|
|
605
623
|
accessTypes?: (AccessType | string)[];
|
|
606
624
|
/**
|
|
607
|
-
* <p>The name of your
|
|
625
|
+
* <p>The name of your Security Lake subscriber account.</p>
|
|
608
626
|
*/
|
|
609
627
|
subscriberName: string | undefined;
|
|
610
628
|
/**
|
|
611
|
-
* <p>The
|
|
629
|
+
* <p>The description for your subscriber account in Security Lake. </p>
|
|
612
630
|
*/
|
|
613
631
|
subscriberDescription?: string;
|
|
614
632
|
}
|
|
615
633
|
export interface CreateSubscriberResponse {
|
|
616
634
|
/**
|
|
617
|
-
* <p>The <code>subscriptionId</code>
|
|
635
|
+
* <p>The <code>subscriptionId</code> created by the <code>CreateSubscriber</code> API
|
|
636
|
+
* call.</p>
|
|
618
637
|
*/
|
|
619
638
|
subscriptionId: string | undefined;
|
|
620
639
|
/**
|
|
621
|
-
* <p>The Amazon Resource Name (ARN) created by
|
|
622
|
-
*
|
|
623
|
-
*
|
|
640
|
+
* <p>The Amazon Resource Name (ARN) created by you to provide to the subscriber. For more
|
|
641
|
+
* information about ARNs and how to use them in policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html">IAM identifiers in
|
|
642
|
+
* the Identity and Access Management (IAM) User Guide</a>. .</p>
|
|
624
643
|
*/
|
|
625
644
|
roleArn?: string;
|
|
626
645
|
/**
|
|
627
|
-
* <p>The
|
|
646
|
+
* <p>The ARN for the Amazon Simple Notification Service.</p>
|
|
628
647
|
*/
|
|
629
648
|
snsArn?: string;
|
|
630
649
|
/**
|
|
631
|
-
* <p>The
|
|
650
|
+
* <p>The ARN for the Amazon S3 bucket. </p>
|
|
632
651
|
*/
|
|
633
652
|
s3BucketArn?: string;
|
|
634
653
|
}
|
|
635
654
|
/**
|
|
636
|
-
* <p>The request was rejected because
|
|
637
|
-
* input parameter. </p>
|
|
655
|
+
* <p>The request was rejected because a value that's not valid or is out of range was
|
|
656
|
+
* supplied for an input parameter. </p>
|
|
638
657
|
*/
|
|
639
658
|
export declare class InvalidInputException extends __BaseException {
|
|
640
659
|
readonly name: "InvalidInputException";
|
|
@@ -650,48 +669,52 @@ export declare enum HttpsMethod {
|
|
|
650
669
|
}
|
|
651
670
|
export interface CreateSubscriptionNotificationConfigurationRequest {
|
|
652
671
|
/**
|
|
653
|
-
* <p>The subscription ID for
|
|
672
|
+
* <p>The subscription ID for the notification subscription/</p>
|
|
654
673
|
*/
|
|
655
674
|
subscriptionId: string | undefined;
|
|
656
675
|
/**
|
|
657
|
-
* <p>The subscription endpoint in Security Lake
|
|
676
|
+
* <p>The subscription endpoint in Security Lake. If you prefer notification with an HTTPs
|
|
677
|
+
* endpoint, populate this field.</p>
|
|
658
678
|
*/
|
|
659
679
|
subscriptionEndpoint?: string;
|
|
660
680
|
/**
|
|
661
|
-
* <p>The key name for the subscription
|
|
681
|
+
* <p>The key name for the notification subscription.</p>
|
|
662
682
|
*/
|
|
663
683
|
httpsApiKeyName?: string;
|
|
664
684
|
/**
|
|
665
|
-
* <p>The key value for the subscription
|
|
685
|
+
* <p>The key value for the notification subscription.</p>
|
|
666
686
|
*/
|
|
667
687
|
httpsApiKeyValue?: string;
|
|
668
688
|
/**
|
|
669
|
-
* <p>The HTTPS method used for the subscription
|
|
689
|
+
* <p>The HTTPS method used for the notification subscription. </p>
|
|
670
690
|
*/
|
|
671
691
|
httpsMethod?: HttpsMethod | string;
|
|
672
692
|
/**
|
|
673
|
-
* <p>Create
|
|
693
|
+
* <p>Create an Amazon Simple Queue Service queue.</p>
|
|
674
694
|
*/
|
|
675
695
|
createSqs?: boolean;
|
|
676
696
|
/**
|
|
677
|
-
* <p>The Amazon Resource Name (ARN)
|
|
697
|
+
* <p>The Amazon Resource Name (ARN) of the EventBridge API destinations IAM role that you
|
|
698
|
+
* created.</p>
|
|
678
699
|
*/
|
|
679
700
|
roleArn?: string;
|
|
680
701
|
}
|
|
681
702
|
export interface CreateSubscriptionNotificationConfigurationResponse {
|
|
682
703
|
/**
|
|
683
|
-
* <p>Returns the Amazon
|
|
704
|
+
* <p>Returns the Amazon Resource Name (ARN) of the queue.</p>
|
|
684
705
|
*/
|
|
685
706
|
queueArn?: string;
|
|
686
707
|
}
|
|
687
708
|
export interface DeleteAwsLogSourceRequest {
|
|
688
709
|
/**
|
|
689
|
-
* <p>This is a mandatory input.
|
|
690
|
-
* namely Region, source type, and member
|
|
710
|
+
* <p>This is a mandatory input. Specify the input order to disable dimensions in Security Lake,
|
|
711
|
+
* namely Region (Amazon Web Services Region code, source type, and member (account ID of a
|
|
712
|
+
* specific Amazon Web Services account). </p>
|
|
691
713
|
*/
|
|
692
714
|
inputOrder: (Dimension | string)[] | undefined;
|
|
693
715
|
/**
|
|
694
|
-
* <p>Removes the specific Amazon Web Services sources from
|
|
716
|
+
* <p>Removes the specific Amazon Web Services sources from specific accounts and specific
|
|
717
|
+
* Regions.</p>
|
|
695
718
|
*/
|
|
696
719
|
disableAllDimensions?: Record<string, Record<string, string[]>>;
|
|
697
720
|
/**
|
|
@@ -705,7 +728,7 @@ export interface DeleteAwsLogSourceRequest {
|
|
|
705
728
|
}
|
|
706
729
|
export interface DeleteAwsLogSourceResponse {
|
|
707
730
|
/**
|
|
708
|
-
* <p>Deletion of the Amazon Web Services sources is in
|
|
731
|
+
* <p>Deletion of the Amazon Web Services sources is in progress.</p>
|
|
709
732
|
*/
|
|
710
733
|
processing?: string[];
|
|
711
734
|
/**
|
|
@@ -715,13 +738,13 @@ export interface DeleteAwsLogSourceResponse {
|
|
|
715
738
|
}
|
|
716
739
|
export interface DeleteCustomLogSourceRequest {
|
|
717
740
|
/**
|
|
718
|
-
* <p>The custom source name for the
|
|
741
|
+
* <p>The custom source name for the custom log source.</p>
|
|
719
742
|
*/
|
|
720
743
|
customSourceName: string | undefined;
|
|
721
744
|
}
|
|
722
745
|
export interface DeleteCustomLogSourceResponse {
|
|
723
746
|
/**
|
|
724
|
-
* <p>The location of the partition in the
|
|
747
|
+
* <p>The location of the partition in the Amazon S3 bucket for Security Lake.</p>
|
|
725
748
|
*/
|
|
726
749
|
customDataLocation: string | undefined;
|
|
727
750
|
}
|
|
@@ -731,7 +754,8 @@ export interface DeleteDatalakeResponse {
|
|
|
731
754
|
}
|
|
732
755
|
export interface DeleteDatalakeAutoEnableRequest {
|
|
733
756
|
/**
|
|
734
|
-
* <p>Delete Amazon Security Lake with the specified
|
|
757
|
+
* <p>Delete Amazon Security Lake with the specified configuration settings to stop ingesting
|
|
758
|
+
* security data for new accounts in Security Lake. </p>
|
|
735
759
|
*/
|
|
736
760
|
removeFromConfigurationForNewAccounts: AutoEnableNewRegionConfiguration[] | undefined;
|
|
737
761
|
}
|
|
@@ -739,7 +763,7 @@ export interface DeleteDatalakeAutoEnableResponse {
|
|
|
739
763
|
}
|
|
740
764
|
export interface DeleteDatalakeDelegatedAdminRequest {
|
|
741
765
|
/**
|
|
742
|
-
* <p>
|
|
766
|
+
* <p>The account ID the Security Lake delegated administrator.</p>
|
|
743
767
|
*/
|
|
744
768
|
account: string | undefined;
|
|
745
769
|
}
|
|
@@ -763,7 +787,7 @@ export interface DeleteSubscriberResponse {
|
|
|
763
787
|
}
|
|
764
788
|
export interface DeleteSubscriptionNotificationConfigurationRequest {
|
|
765
789
|
/**
|
|
766
|
-
* <p>The
|
|
790
|
+
* <p>The ID of the Security Lake subscriber account.</p>
|
|
767
791
|
*/
|
|
768
792
|
subscriptionId: string | undefined;
|
|
769
793
|
}
|
|
@@ -802,11 +826,12 @@ export interface Failures {
|
|
|
802
826
|
timestamp: Date | undefined;
|
|
803
827
|
}
|
|
804
828
|
/**
|
|
805
|
-
* <p>Response element for actions
|
|
829
|
+
* <p>Response element for actions that make changes, namely create, update, or delete
|
|
830
|
+
* actions. </p>
|
|
806
831
|
*/
|
|
807
832
|
export interface FailuresResponse {
|
|
808
833
|
/**
|
|
809
|
-
* <p>List of Regions where the failure occurred. </p>
|
|
834
|
+
* <p>List of Amazon Web Services Regions where the failure occurred. </p>
|
|
810
835
|
*/
|
|
811
836
|
region?: string;
|
|
812
837
|
/**
|
|
@@ -823,11 +848,11 @@ export declare enum SettingsStatus {
|
|
|
823
848
|
PENDING = "PENDING"
|
|
824
849
|
}
|
|
825
850
|
/**
|
|
826
|
-
* <p>Provides details of lake configuration object
|
|
851
|
+
* <p>Provides details of Amazon Security Lake lake configuration object.</p>
|
|
827
852
|
*/
|
|
828
853
|
export interface LakeConfigurationResponse {
|
|
829
854
|
/**
|
|
830
|
-
* <p>The type of encryption key used by Security Lake
|
|
855
|
+
* <p>The type of encryption key used by secure the Security Lake configuration object.</p>
|
|
831
856
|
*/
|
|
832
857
|
encryptionKey?: string;
|
|
833
858
|
/**
|
|
@@ -840,24 +865,24 @@ export interface LakeConfigurationResponse {
|
|
|
840
865
|
*/
|
|
841
866
|
tagsMap?: Record<string, string>;
|
|
842
867
|
/**
|
|
843
|
-
* <p>Replication enables automatic, asynchronous copying of objects across Amazon S3
|
|
844
|
-
* Amazon S3 buckets that are configured for object replication can be owned
|
|
845
|
-
* by different accounts. You can replicate objects
|
|
846
|
-
*
|
|
847
|
-
* within the same Region as the source
|
|
868
|
+
* <p>Replication enables automatic, asynchronous copying of objects across Amazon S3
|
|
869
|
+
* buckets. Amazon S3 buckets that are configured for object replication can be owned
|
|
870
|
+
* by the same Amazon Web Services account or by different accounts. You can replicate objects
|
|
871
|
+
* to a single destination bucket or to multiple destination buckets. The destination buckets
|
|
872
|
+
* can be in different Amazon Web Services Regions or within the same Region as the source
|
|
873
|
+
* bucket.</p>
|
|
848
874
|
* <p>Set up one or more rollup Regions by providing the Region or Regions that should
|
|
849
875
|
* contribute to the central rollup Region. </p>
|
|
850
876
|
*/
|
|
851
877
|
replicationDestinationRegions?: (Region | string)[];
|
|
852
878
|
/**
|
|
853
|
-
* <p>Replication settings for the Amazon S3 buckets. This parameter uses the IAM role
|
|
854
|
-
*
|
|
879
|
+
* <p>Replication settings for the Amazon S3 buckets. This parameter uses the IAM role you created that is managed by Security Lake, to ensure the replication
|
|
880
|
+
* setting is correct. </p>
|
|
855
881
|
*/
|
|
856
882
|
replicationRoleArn?: string;
|
|
857
883
|
/**
|
|
858
|
-
* <p>Amazon Resource Names (ARNs) uniquely identify Amazon Web Services resources. Security Lake
|
|
859
|
-
* when you need to specify a resource unambiguously across all of Amazon Web Services, such as in IAM
|
|
860
|
-
* policies, Amazon Relational Database Service (Amazon RDS) tags, and API calls. </p>
|
|
884
|
+
* <p>Amazon Resource Names (ARNs) uniquely identify Amazon Web Services resources. Security Lake
|
|
885
|
+
* requires an ARN when you need to specify a resource unambiguously across all of Amazon Web Services, such as in IAM policies, Amazon Relational Database Service (Amazon RDS) tags, and API calls. </p>
|
|
861
886
|
*/
|
|
862
887
|
s3BucketArn?: string;
|
|
863
888
|
/**
|
|
@@ -890,7 +915,8 @@ export interface GetDatalakeExceptionsExpiryResponse {
|
|
|
890
915
|
export interface GetDatalakeExceptionsSubscriptionRequest {
|
|
891
916
|
}
|
|
892
917
|
/**
|
|
893
|
-
* <p>
|
|
918
|
+
* <p>Protocol used in Amazon Security Lake that dictates how notifications are posted at the
|
|
919
|
+
* endpoint. </p>
|
|
894
920
|
*/
|
|
895
921
|
export interface ProtocolAndNotificationEndpoint {
|
|
896
922
|
/**
|
|
@@ -898,7 +924,7 @@ export interface ProtocolAndNotificationEndpoint {
|
|
|
898
924
|
*/
|
|
899
925
|
protocol?: string;
|
|
900
926
|
/**
|
|
901
|
-
* <p>The account
|
|
927
|
+
* <p>The account that is subscribed to receive exception notifications. </p>
|
|
902
928
|
*/
|
|
903
929
|
endpoint?: string;
|
|
904
930
|
}
|
|
@@ -910,16 +936,20 @@ export interface GetDatalakeExceptionsSubscriptionResponse {
|
|
|
910
936
|
}
|
|
911
937
|
export interface GetDatalakeStatusRequest {
|
|
912
938
|
/**
|
|
913
|
-
* <p>The account
|
|
914
|
-
* accounts and log sources is retrieved.</p>
|
|
939
|
+
* <p>The Amazon Web Services account ID for which a static snapshot of the current Amazon Web Services Region, including enabled accounts and log sources, is retrieved.</p>
|
|
915
940
|
*/
|
|
916
941
|
accountSet?: string[];
|
|
917
942
|
/**
|
|
918
|
-
* <p>The maximum limit of accounts for which the static snapshot of the current Region
|
|
943
|
+
* <p>The maximum limit of accounts for which the static snapshot of the current Region,
|
|
944
|
+
* including enabled accounts and log sources, is retrieved.</p>
|
|
919
945
|
*/
|
|
920
946
|
maxAccountResults?: number;
|
|
921
947
|
/**
|
|
922
|
-
* <p>
|
|
948
|
+
* <p>Lists if there are more results available. The value of nextToken is a unique pagination
|
|
949
|
+
* token for each page. Repeat the call using the returned token to retrieve the next page.
|
|
950
|
+
* Keep all other arguments unchanged. </p>
|
|
951
|
+
* <p>Each pagination token expires after 24 hours. Using an expired pagination token will
|
|
952
|
+
* return an HTTP 400 InvalidToken error.</p>
|
|
923
953
|
*/
|
|
924
954
|
nextToken?: string;
|
|
925
955
|
}
|
|
@@ -929,13 +959,18 @@ export interface GetDatalakeStatusResponse {
|
|
|
929
959
|
*/
|
|
930
960
|
accountSourcesList: AccountSources[] | undefined;
|
|
931
961
|
/**
|
|
932
|
-
* <p>
|
|
962
|
+
* <p>Lists if there are more results available. The value of nextToken is a unique pagination
|
|
963
|
+
* token for each page. Repeat the call using the returned token to retrieve the next page.
|
|
964
|
+
* Keep all other arguments unchanged. </p>
|
|
965
|
+
* <p>Each pagination token expires after 24 hours. Using an expired pagination token will
|
|
966
|
+
* return an HTTP 400 InvalidToken error.</p>
|
|
933
967
|
*/
|
|
934
968
|
nextToken?: string;
|
|
935
969
|
}
|
|
936
970
|
export interface GetSubscriberRequest {
|
|
937
971
|
/**
|
|
938
|
-
* <p>A value created by Security Lake that uniquely identifies your
|
|
972
|
+
* <p>A value created by Amazon Security Lake that uniquely identifies your
|
|
973
|
+
* <code>GetSubscriber</code> API request.</p>
|
|
939
974
|
*/
|
|
940
975
|
id: string | undefined;
|
|
941
976
|
}
|
|
@@ -946,8 +981,9 @@ export declare enum SubscriptionStatus {
|
|
|
946
981
|
READY = "READY"
|
|
947
982
|
}
|
|
948
983
|
/**
|
|
949
|
-
* <p>Provides details
|
|
950
|
-
* of new objects for a source as the data is written to your Amazon
|
|
984
|
+
* <p>Provides details about the Amazon Security Lake account subscription. Subscribers are notified
|
|
985
|
+
* of new objects for a source as the data is written to your Amazon S3 bucket for
|
|
986
|
+
* Security Lake. </p>
|
|
951
987
|
*/
|
|
952
988
|
export interface SubscriberResource {
|
|
953
989
|
/**
|
|
@@ -955,11 +991,11 @@ export interface SubscriberResource {
|
|
|
955
991
|
*/
|
|
956
992
|
subscriptionId: string | undefined;
|
|
957
993
|
/**
|
|
958
|
-
* <p>Amazon Security Lake supports
|
|
994
|
+
* <p>Amazon Security Lake supports log and event collection for natively supported Amazon Web Services. For more information, see the Amazon Security Lake User Guide.</p>
|
|
959
995
|
*/
|
|
960
996
|
sourceTypes: SourceType[] | undefined;
|
|
961
997
|
/**
|
|
962
|
-
* <p>The Amazon Web Services account ID
|
|
998
|
+
* <p>The Amazon Web Services account ID you are using to create your Amazon Security Lake
|
|
963
999
|
* account.</p>
|
|
964
1000
|
*/
|
|
965
1001
|
accountId: string | undefined;
|
|
@@ -974,7 +1010,7 @@ export interface SubscriberResource {
|
|
|
974
1010
|
*/
|
|
975
1011
|
subscriberDescription?: string;
|
|
976
1012
|
/**
|
|
977
|
-
* <p>
|
|
1013
|
+
* <p>The subscription status of the Amazon Security Lake subscriber account.</p>
|
|
978
1014
|
*/
|
|
979
1015
|
subscriptionStatus?: SubscriptionStatus | string;
|
|
980
1016
|
/**
|
|
@@ -982,18 +1018,20 @@ export interface SubscriberResource {
|
|
|
982
1018
|
*/
|
|
983
1019
|
roleArn?: string;
|
|
984
1020
|
/**
|
|
985
|
-
* <p>The
|
|
1021
|
+
* <p>The ARN for the Amazon Simple Notification Service.</p>
|
|
986
1022
|
*/
|
|
987
1023
|
snsArn?: string;
|
|
988
1024
|
/**
|
|
989
|
-
* <p>The
|
|
1025
|
+
* <p>The ARN for the Amazon S3 bucket. </p>
|
|
990
1026
|
*/
|
|
991
1027
|
s3BucketArn?: string;
|
|
992
1028
|
/**
|
|
993
|
-
* <p>You can choose to notify subscribers of new objects with an Amazon Simple Queue Service
|
|
1029
|
+
* <p>You can choose to notify subscribers of new objects with an Amazon Simple Queue Service
|
|
1030
|
+
* (Amazon SQS) queue or through messaging to an HTTPS endpoint provided by the
|
|
1031
|
+
* subscriber. </p>
|
|
994
1032
|
* <p> Subscribers can consume data by directly querying Lake Formation tables in your
|
|
995
|
-
*
|
|
996
|
-
* <code>LAKEFORMATION</code>. </p>
|
|
1033
|
+
* Amazon S3 bucket through services like Amazon Athena. This subscription
|
|
1034
|
+
* type is defined as <code>LAKEFORMATION</code>. </p>
|
|
997
1035
|
*/
|
|
998
1036
|
accessTypes?: (AccessType | string)[];
|
|
999
1037
|
/**
|
|
@@ -1005,8 +1043,8 @@ export interface SubscriberResource {
|
|
|
1005
1043
|
*/
|
|
1006
1044
|
subscriptionProtocol?: EndpointProtocol | string;
|
|
1007
1045
|
/**
|
|
1008
|
-
* <p>The external ID of the subscriber.
|
|
1009
|
-
*
|
|
1046
|
+
* <p>The external ID of the subscriber. The external ID lets the user that is assuming the
|
|
1047
|
+
* role assert the circumstances in which they are operating. It also provides a way for the
|
|
1010
1048
|
* account owner to permit the role to be assumed only under specific circumstances.</p>
|
|
1011
1049
|
*/
|
|
1012
1050
|
externalId?: string;
|
|
@@ -1021,13 +1059,13 @@ export interface SubscriberResource {
|
|
|
1021
1059
|
}
|
|
1022
1060
|
export interface GetSubscriberResponse {
|
|
1023
1061
|
/**
|
|
1024
|
-
* <p>
|
|
1062
|
+
* <p>The subscription information for the specified subscription ID.</p>
|
|
1025
1063
|
*/
|
|
1026
1064
|
subscriber?: SubscriberResource;
|
|
1027
1065
|
}
|
|
1028
1066
|
export interface ListDatalakeExceptionsRequest {
|
|
1029
1067
|
/**
|
|
1030
|
-
* <p>List the
|
|
1068
|
+
* <p>List the Amazon Web Services Regions from which exceptions are retrieved.</p>
|
|
1031
1069
|
*/
|
|
1032
1070
|
regionSet?: (Region | string)[];
|
|
1033
1071
|
/**
|
|
@@ -1035,19 +1073,25 @@ export interface ListDatalakeExceptionsRequest {
|
|
|
1035
1073
|
*/
|
|
1036
1074
|
maxFailures?: number;
|
|
1037
1075
|
/**
|
|
1038
|
-
* <p>List if there are more results available.
|
|
1039
|
-
* using the returned token to retrieve the next page
|
|
1076
|
+
* <p>List if there are more results available. The value of nextToken is a unique pagination
|
|
1077
|
+
* token for each page. Repeat the call using the returned token to retrieve the next page.
|
|
1078
|
+
* Keep all other arguments unchanged. </p>
|
|
1079
|
+
* <p>Each pagination token expires after 24 hours. Using an expired pagination token will
|
|
1080
|
+
* return an HTTP 400 InvalidToken error.</p>
|
|
1040
1081
|
*/
|
|
1041
1082
|
nextToken?: string;
|
|
1042
1083
|
}
|
|
1043
1084
|
export interface ListDatalakeExceptionsResponse {
|
|
1044
1085
|
/**
|
|
1045
|
-
* <p>Lists the
|
|
1086
|
+
* <p>Lists the failures that cannot be retried in the current Region.</p>
|
|
1046
1087
|
*/
|
|
1047
1088
|
nonRetryableFailures: FailuresResponse[] | undefined;
|
|
1048
1089
|
/**
|
|
1049
|
-
* <p>List if there are more results available.
|
|
1050
|
-
* using the returned token to retrieve the next page
|
|
1090
|
+
* <p>List if there are more results available. The value of nextToken is a unique pagination
|
|
1091
|
+
* token for each page. Repeat the call using the returned token to retrieve the next page.
|
|
1092
|
+
* Keep all other arguments unchanged. </p>
|
|
1093
|
+
* <p>Each pagination token expires after 24 hours. Using an expired pagination token will
|
|
1094
|
+
* return an HTTP 400 InvalidToken error.</p>
|
|
1051
1095
|
*/
|
|
1052
1096
|
nextToken?: string;
|
|
1053
1097
|
}
|
|
@@ -1058,42 +1102,42 @@ export interface ListLogSourcesRequest {
|
|
|
1058
1102
|
*/
|
|
1059
1103
|
inputOrder?: (Dimension | string)[];
|
|
1060
1104
|
/**
|
|
1061
|
-
* <p>List the view of log sources for enabled Security Lake accounts
|
|
1105
|
+
* <p>List the view of log sources for enabled Amazon Security Lake accounts for specific Amazon Web Services sources from specific accounts and specific Regions.</p>
|
|
1062
1106
|
*/
|
|
1063
1107
|
listAllDimensions?: Record<string, Record<string, string[]>>;
|
|
1064
1108
|
/**
|
|
1065
|
-
* <p>Lists the log sources for
|
|
1066
|
-
* accounts for the entire Region, for selected member accounts.</p>
|
|
1109
|
+
* <p>Lists the view of log sources for enabled Security Lake accounts for specific Amazon Web Services sources from specific accounts or specific Regions.</p>
|
|
1067
1110
|
*/
|
|
1068
1111
|
listTwoDimensions?: Record<string, string[]>;
|
|
1069
1112
|
/**
|
|
1070
|
-
* <p>List the view of log sources for enabled Security Lake accounts for
|
|
1113
|
+
* <p>List the view of log sources for enabled Security Lake accounts for all Amazon Web Services
|
|
1114
|
+
* sources from specific accounts or specific Regions.</p>
|
|
1071
1115
|
*/
|
|
1072
1116
|
listSingleDimension?: string[];
|
|
1073
1117
|
/**
|
|
1074
|
-
* <p>The maximum number of accounts for which the
|
|
1118
|
+
* <p>The maximum number of accounts for which the log sources are displayed.</p>
|
|
1075
1119
|
*/
|
|
1076
1120
|
maxResults?: number;
|
|
1077
1121
|
/**
|
|
1078
|
-
* <p>If nextToken is returned, there are more results available. You can
|
|
1122
|
+
* <p>If nextToken is returned, there are more results available. You can repeat the call
|
|
1079
1123
|
* using the returned token to retrieve the next page.</p>
|
|
1080
1124
|
*/
|
|
1081
1125
|
nextToken?: string;
|
|
1082
1126
|
}
|
|
1083
1127
|
export interface ListLogSourcesResponse {
|
|
1084
1128
|
/**
|
|
1085
|
-
* <p>Lists the log sources
|
|
1129
|
+
* <p>Lists the log sources by Regions for enabled Security Lake accounts.</p>
|
|
1086
1130
|
*/
|
|
1087
1131
|
regionSourceTypesAccountsList: Record<string, Record<string, string[]>>[] | undefined;
|
|
1088
1132
|
/**
|
|
1089
|
-
* <p>If nextToken is returned, there are more results available. You can
|
|
1090
|
-
*
|
|
1133
|
+
* <p>If nextToken is returned, there are more results available. You can repeat the call
|
|
1134
|
+
* using the returned token to retrieve the next page.</p>
|
|
1091
1135
|
*/
|
|
1092
1136
|
nextToken?: string;
|
|
1093
1137
|
}
|
|
1094
1138
|
export interface ListSubscribersRequest {
|
|
1095
1139
|
/**
|
|
1096
|
-
* <p>If nextToken is returned, there are more results available. You can
|
|
1140
|
+
* <p>If nextToken is returned, there are more results available. You can repeat the call
|
|
1097
1141
|
* using the returned token to retrieve the next page.</p>
|
|
1098
1142
|
*/
|
|
1099
1143
|
nextToken?: string;
|
|
@@ -1104,18 +1148,18 @@ export interface ListSubscribersRequest {
|
|
|
1104
1148
|
}
|
|
1105
1149
|
export interface ListSubscribersResponse {
|
|
1106
1150
|
/**
|
|
1107
|
-
* <p>The subscribers available
|
|
1151
|
+
* <p>The subscribers available for the specified Security Lake account ID.</p>
|
|
1108
1152
|
*/
|
|
1109
1153
|
subscribers: SubscriberResource[] | undefined;
|
|
1110
1154
|
/**
|
|
1111
|
-
* <p>If nextToken is returned, there are more results available. You can
|
|
1155
|
+
* <p>If nextToken is returned, there are more results available. You can repeat the call
|
|
1112
1156
|
* using the returned token to retrieve the next page.</p>
|
|
1113
1157
|
*/
|
|
1114
1158
|
nextToken?: string;
|
|
1115
1159
|
}
|
|
1116
1160
|
export interface UpdateDatalakeRequest {
|
|
1117
1161
|
/**
|
|
1118
|
-
* <p>
|
|
1162
|
+
* <p>Specify the Region or Regions that will contribute data to the rollup region.</p>
|
|
1119
1163
|
*/
|
|
1120
1164
|
configurations: Record<string, LakeConfigurationRequest> | undefined;
|
|
1121
1165
|
}
|
|
@@ -1135,7 +1179,7 @@ export interface UpdateDatalakeExceptionsSubscriptionRequest {
|
|
|
1135
1179
|
*/
|
|
1136
1180
|
subscriptionProtocol: SubscriptionProtocolType | string | undefined;
|
|
1137
1181
|
/**
|
|
1138
|
-
* <p>The account
|
|
1182
|
+
* <p>The account that is subscribed to receive exception notifications.</p>
|
|
1139
1183
|
*/
|
|
1140
1184
|
notificationEndpoint: string | undefined;
|
|
1141
1185
|
}
|
|
@@ -1143,31 +1187,30 @@ export interface UpdateDatalakeExceptionsSubscriptionResponse {
|
|
|
1143
1187
|
}
|
|
1144
1188
|
export interface UpdateSubscriberRequest {
|
|
1145
1189
|
/**
|
|
1146
|
-
* <p>A value created by Security Lake that uniquely identifies your
|
|
1190
|
+
* <p>A value created by Security Lake that uniquely identifies your subscription. </p>
|
|
1147
1191
|
*/
|
|
1148
1192
|
id: string | undefined;
|
|
1149
1193
|
/**
|
|
1150
|
-
* <p>The supported Amazon Web Services
|
|
1151
|
-
*
|
|
1152
|
-
* services. For more information, see the Amazon Security Lake User Guide.</p>
|
|
1194
|
+
* <p>The supported Amazon Web Services from which logs and events are collected. For
|
|
1195
|
+
* the list of supported Amazon Web Services, see the <a href="https://docs.aws.amazon.com/security-lake/latest/userguide/internal-sources.html">Amazon Security Lake User Guide</a>.</p>
|
|
1153
1196
|
*/
|
|
1154
|
-
sourceTypes
|
|
1197
|
+
sourceTypes: SourceType[] | undefined;
|
|
1155
1198
|
/**
|
|
1156
|
-
* <p>
|
|
1199
|
+
* <p>The external ID of the Security Lake account.</p>
|
|
1157
1200
|
*/
|
|
1158
1201
|
externalId?: string;
|
|
1159
1202
|
/**
|
|
1160
|
-
* <p>
|
|
1203
|
+
* <p>The name of the Security Lake account subscriber. </p>
|
|
1161
1204
|
*/
|
|
1162
1205
|
subscriberName?: string;
|
|
1163
1206
|
/**
|
|
1164
|
-
* <p>
|
|
1207
|
+
* <p>The description of the Security Lake account subscriber.</p>
|
|
1165
1208
|
*/
|
|
1166
1209
|
subscriberDescription?: string;
|
|
1167
1210
|
}
|
|
1168
1211
|
export interface UpdateSubscriberResponse {
|
|
1169
1212
|
/**
|
|
1170
|
-
* <p>The account
|
|
1213
|
+
* <p>The account of the subscriber.</p>
|
|
1171
1214
|
*/
|
|
1172
1215
|
subscriber?: SubscriberResource;
|
|
1173
1216
|
}
|
|
@@ -1193,7 +1236,8 @@ export interface UpdateSubscriptionNotificationConfigurationRequest {
|
|
|
1193
1236
|
*/
|
|
1194
1237
|
httpsMethod?: HttpsMethod | string;
|
|
1195
1238
|
/**
|
|
1196
|
-
* <p>Create a new subscription notification for the specified subscription ID in
|
|
1239
|
+
* <p>Create a new subscription notification for the specified subscription ID in
|
|
1240
|
+
* Amazon Security Lake.</p>
|
|
1197
1241
|
*/
|
|
1198
1242
|
createSqs?: boolean;
|
|
1199
1243
|
/**
|
|
@@ -1203,7 +1247,7 @@ export interface UpdateSubscriptionNotificationConfigurationRequest {
|
|
|
1203
1247
|
}
|
|
1204
1248
|
export interface UpdateSubscriptionNotificationConfigurationResponse {
|
|
1205
1249
|
/**
|
|
1206
|
-
* <p>Returns the
|
|
1250
|
+
* <p>Returns the ARN of the queue.</p>
|
|
1207
1251
|
*/
|
|
1208
1252
|
queueArn?: string;
|
|
1209
1253
|
}
|