@aws-sdk/client-securitylake 3.378.0 → 3.382.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -1,4 +1,7 @@
|
|
|
1
1
|
import { Endpoint, EndpointParameters as __EndpointParameters, EndpointV2, Provider } from "@smithy/types";
|
|
2
|
+
/**
|
|
3
|
+
* @public
|
|
4
|
+
*/
|
|
2
5
|
export interface ClientInputEndpointParameters {
|
|
3
6
|
region?: string | Provider<string>;
|
|
4
7
|
useDualstackEndpoint?: boolean | Provider<boolean>;
|
package/dist-types/index.d.ts
CHANGED
|
@@ -11,6 +11,7 @@ export declare class AccessDeniedException extends __BaseException {
|
|
|
11
11
|
readonly name: "AccessDeniedException";
|
|
12
12
|
readonly $fault: "client";
|
|
13
13
|
/**
|
|
14
|
+
* @public
|
|
14
15
|
* <p>A coded string to provide more information about the access denied exception. You can use the error code to check the exception type.</p>
|
|
15
16
|
*/
|
|
16
17
|
errorCode?: string;
|
|
@@ -37,10 +38,12 @@ export type AccessType = (typeof AccessType)[keyof typeof AccessType];
|
|
|
37
38
|
*/
|
|
38
39
|
export interface AwsIdentity {
|
|
39
40
|
/**
|
|
41
|
+
* @public
|
|
40
42
|
* <p>The AWS identity principal.</p>
|
|
41
43
|
*/
|
|
42
44
|
principal: string | undefined;
|
|
43
45
|
/**
|
|
46
|
+
* @public
|
|
44
47
|
* <p>The external ID used to estalish trust relationship with the AWS identity.</p>
|
|
45
48
|
*/
|
|
46
49
|
externalId: string | undefined;
|
|
@@ -67,18 +70,22 @@ export type AwsLogSourceName = (typeof AwsLogSourceName)[keyof typeof AwsLogSour
|
|
|
67
70
|
*/
|
|
68
71
|
export interface AwsLogSourceConfiguration {
|
|
69
72
|
/**
|
|
73
|
+
* @public
|
|
70
74
|
* <p>Specify the Amazon Web Services account information where you want to enable Security Lake.</p>
|
|
71
75
|
*/
|
|
72
76
|
accounts?: string[];
|
|
73
77
|
/**
|
|
78
|
+
* @public
|
|
74
79
|
* <p>Specify the Regions where you want to enable Security Lake.</p>
|
|
75
80
|
*/
|
|
76
81
|
regions: string[] | undefined;
|
|
77
82
|
/**
|
|
83
|
+
* @public
|
|
78
84
|
* <p>The name for a Amazon Web Services source. This must be a Regionally unique value.</p>
|
|
79
85
|
*/
|
|
80
86
|
sourceName: AwsLogSourceName | string | undefined;
|
|
81
87
|
/**
|
|
88
|
+
* @public
|
|
82
89
|
* <p>The version for a Amazon Web Services source. This must be a Regionally unique value.</p>
|
|
83
90
|
*/
|
|
84
91
|
sourceVersion?: string;
|
|
@@ -89,10 +96,12 @@ export interface AwsLogSourceConfiguration {
|
|
|
89
96
|
*/
|
|
90
97
|
export interface AwsLogSourceResource {
|
|
91
98
|
/**
|
|
99
|
+
* @public
|
|
92
100
|
* <p>The name for a Amazon Web Services source. This must be a Regionally unique value.</p>
|
|
93
101
|
*/
|
|
94
102
|
sourceName?: AwsLogSourceName | string;
|
|
95
103
|
/**
|
|
104
|
+
* @public
|
|
96
105
|
* <p>The version for a Amazon Web Services source. This must be a Regionally unique value.</p>
|
|
97
106
|
*/
|
|
98
107
|
sourceVersion?: string;
|
|
@@ -120,10 +129,12 @@ export declare class ConflictException extends __BaseException {
|
|
|
120
129
|
readonly name: "ConflictException";
|
|
121
130
|
readonly $fault: "client";
|
|
122
131
|
/**
|
|
132
|
+
* @public
|
|
123
133
|
* <p>The resource name.</p>
|
|
124
134
|
*/
|
|
125
135
|
resourceName?: string;
|
|
126
136
|
/**
|
|
137
|
+
* @public
|
|
127
138
|
* <p>The resource type.</p>
|
|
128
139
|
*/
|
|
129
140
|
resourceType?: string;
|
|
@@ -137,6 +148,7 @@ export declare class ConflictException extends __BaseException {
|
|
|
137
148
|
*/
|
|
138
149
|
export interface CreateAwsLogSourceRequest {
|
|
139
150
|
/**
|
|
151
|
+
* @public
|
|
140
152
|
* <p>Specify the natively-supported Amazon Web Services service to add as a source in Security Lake.</p>
|
|
141
153
|
*/
|
|
142
154
|
sources: AwsLogSourceConfiguration[] | undefined;
|
|
@@ -146,6 +158,7 @@ export interface CreateAwsLogSourceRequest {
|
|
|
146
158
|
*/
|
|
147
159
|
export interface CreateAwsLogSourceResponse {
|
|
148
160
|
/**
|
|
161
|
+
* @public
|
|
149
162
|
* <p>Lists all accounts in which enabling a natively supported Amazon Web Service as
|
|
150
163
|
* a Security Lake source failed. The failure occurred as these accounts are not part of an
|
|
151
164
|
* organization.</p>
|
|
@@ -174,10 +187,12 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
174
187
|
readonly name: "ResourceNotFoundException";
|
|
175
188
|
readonly $fault: "client";
|
|
176
189
|
/**
|
|
190
|
+
* @public
|
|
177
191
|
* <p>The name of the resource that could not be found.</p>
|
|
178
192
|
*/
|
|
179
193
|
resourceName?: string;
|
|
180
194
|
/**
|
|
195
|
+
* @public
|
|
181
196
|
* <p>The type of the resource that could not be found.</p>
|
|
182
197
|
*/
|
|
183
198
|
resourceType?: string;
|
|
@@ -197,14 +212,17 @@ export declare class ThrottlingException extends __BaseException {
|
|
|
197
212
|
throttling: boolean;
|
|
198
213
|
};
|
|
199
214
|
/**
|
|
215
|
+
* @public
|
|
200
216
|
* <p>The code for the service in Service Quotas.</p>
|
|
201
217
|
*/
|
|
202
218
|
serviceCode?: string;
|
|
203
219
|
/**
|
|
220
|
+
* @public
|
|
204
221
|
* <p>That the rate of requests to Security Lake is exceeding the request quotas for your Amazon Web Services account.</p>
|
|
205
222
|
*/
|
|
206
223
|
quotaCode?: string;
|
|
207
224
|
/**
|
|
225
|
+
* @public
|
|
208
226
|
* <p>Retry the request after the specified time.</p>
|
|
209
227
|
*/
|
|
210
228
|
retryAfterSeconds?: number;
|
|
@@ -219,6 +237,7 @@ export declare class ThrottlingException extends __BaseException {
|
|
|
219
237
|
*/
|
|
220
238
|
export interface CustomLogSourceCrawlerConfiguration {
|
|
221
239
|
/**
|
|
240
|
+
* @public
|
|
222
241
|
* <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role
|
|
223
242
|
* to be used by the Glue crawler. The recommended IAM policies
|
|
224
243
|
* are:</p>
|
|
@@ -240,10 +259,12 @@ export interface CustomLogSourceCrawlerConfiguration {
|
|
|
240
259
|
*/
|
|
241
260
|
export interface CustomLogSourceConfiguration {
|
|
242
261
|
/**
|
|
262
|
+
* @public
|
|
243
263
|
* <p>The configuration for the Glue Crawler for the third-party custom source.</p>
|
|
244
264
|
*/
|
|
245
265
|
crawlerConfiguration: CustomLogSourceCrawlerConfiguration | undefined;
|
|
246
266
|
/**
|
|
267
|
+
* @public
|
|
247
268
|
* <p>The identity of the log provider for the third-party custom source.</p>
|
|
248
269
|
*/
|
|
249
270
|
providerIdentity: AwsIdentity | undefined;
|
|
@@ -253,16 +274,19 @@ export interface CustomLogSourceConfiguration {
|
|
|
253
274
|
*/
|
|
254
275
|
export interface CreateCustomLogSourceRequest {
|
|
255
276
|
/**
|
|
277
|
+
* @public
|
|
256
278
|
* <p>Specify the name for a third-party custom source. This must be a Regionally unique
|
|
257
279
|
* value.</p>
|
|
258
280
|
*/
|
|
259
281
|
sourceName: string | undefined;
|
|
260
282
|
/**
|
|
283
|
+
* @public
|
|
261
284
|
* <p>Specify the source version for the third-party custom source, to limit log collection to
|
|
262
285
|
* a specific version of custom data source.</p>
|
|
263
286
|
*/
|
|
264
287
|
sourceVersion?: string;
|
|
265
288
|
/**
|
|
289
|
+
* @public
|
|
266
290
|
* <p>The Open Cybersecurity Schema Framework (OCSF) event classes which describes the type of
|
|
267
291
|
* data that the custom source will send to Security Lake. The supported event classes are:</p>
|
|
268
292
|
* <ul>
|
|
@@ -415,6 +439,7 @@ export interface CreateCustomLogSourceRequest {
|
|
|
415
439
|
*/
|
|
416
440
|
eventClasses?: string[];
|
|
417
441
|
/**
|
|
442
|
+
* @public
|
|
418
443
|
* <p>The configuration for the third-party custom source.</p>
|
|
419
444
|
*/
|
|
420
445
|
configuration?: CustomLogSourceConfiguration;
|
|
@@ -425,15 +450,18 @@ export interface CreateCustomLogSourceRequest {
|
|
|
425
450
|
*/
|
|
426
451
|
export interface CustomLogSourceAttributes {
|
|
427
452
|
/**
|
|
453
|
+
* @public
|
|
428
454
|
* <p>The ARN of the Glue crawler.</p>
|
|
429
455
|
*/
|
|
430
456
|
crawlerArn?: string;
|
|
431
457
|
/**
|
|
458
|
+
* @public
|
|
432
459
|
* <p>The ARN of the Glue database where results are written, such as:
|
|
433
460
|
* <code>arn:aws:daylight:us-east-1::database/sometable/*</code>.</p>
|
|
434
461
|
*/
|
|
435
462
|
databaseArn?: string;
|
|
436
463
|
/**
|
|
464
|
+
* @public
|
|
437
465
|
* <p>The ARN of the Glue table.</p>
|
|
438
466
|
*/
|
|
439
467
|
tableArn?: string;
|
|
@@ -444,6 +472,7 @@ export interface CustomLogSourceAttributes {
|
|
|
444
472
|
*/
|
|
445
473
|
export interface CustomLogSourceProvider {
|
|
446
474
|
/**
|
|
475
|
+
* @public
|
|
447
476
|
* <p>The ARN of the IAM role to be used by the entity putting logs into your
|
|
448
477
|
* custom source partition. Security Lake will apply the correct access policies to this role, but
|
|
449
478
|
* you must first manually create the trust policy for this role. The IAM role
|
|
@@ -452,6 +481,7 @@ export interface CustomLogSourceProvider {
|
|
|
452
481
|
*/
|
|
453
482
|
roleArn?: string;
|
|
454
483
|
/**
|
|
484
|
+
* @public
|
|
455
485
|
* <p>The location of the partition in the Amazon S3 bucket for Security Lake.</p>
|
|
456
486
|
*/
|
|
457
487
|
location?: string;
|
|
@@ -462,18 +492,22 @@ export interface CustomLogSourceProvider {
|
|
|
462
492
|
*/
|
|
463
493
|
export interface CustomLogSourceResource {
|
|
464
494
|
/**
|
|
495
|
+
* @public
|
|
465
496
|
* <p>The name for a third-party custom source. This must be a Regionally unique value.</p>
|
|
466
497
|
*/
|
|
467
498
|
sourceName?: string;
|
|
468
499
|
/**
|
|
500
|
+
* @public
|
|
469
501
|
* <p>The version for a third-party custom source. This must be a Regionally unique value.</p>
|
|
470
502
|
*/
|
|
471
503
|
sourceVersion?: string;
|
|
472
504
|
/**
|
|
505
|
+
* @public
|
|
473
506
|
* <p>The details of the log provider for a third-party custom source.</p>
|
|
474
507
|
*/
|
|
475
508
|
provider?: CustomLogSourceProvider;
|
|
476
509
|
/**
|
|
510
|
+
* @public
|
|
477
511
|
* <p>The attributes of a third-party custom source.</p>
|
|
478
512
|
*/
|
|
479
513
|
attributes?: CustomLogSourceAttributes;
|
|
@@ -483,6 +517,7 @@ export interface CustomLogSourceResource {
|
|
|
483
517
|
*/
|
|
484
518
|
export interface CreateCustomLogSourceResponse {
|
|
485
519
|
/**
|
|
520
|
+
* @public
|
|
486
521
|
* <p>The created third-party custom source.</p>
|
|
487
522
|
*/
|
|
488
523
|
source?: CustomLogSourceResource;
|
|
@@ -493,6 +528,7 @@ export interface CreateCustomLogSourceResponse {
|
|
|
493
528
|
*/
|
|
494
529
|
export interface DataLakeEncryptionConfiguration {
|
|
495
530
|
/**
|
|
531
|
+
* @public
|
|
496
532
|
* <p>The id of KMS encryption key used by Amazon Security Lake to encrypt the Security Lake
|
|
497
533
|
* object.</p>
|
|
498
534
|
*/
|
|
@@ -504,6 +540,7 @@ export interface DataLakeEncryptionConfiguration {
|
|
|
504
540
|
*/
|
|
505
541
|
export interface DataLakeLifecycleExpiration {
|
|
506
542
|
/**
|
|
543
|
+
* @public
|
|
507
544
|
* <p>Number of days before data expires in the Amazon Security Lake object.</p>
|
|
508
545
|
*/
|
|
509
546
|
days?: number;
|
|
@@ -514,11 +551,13 @@ export interface DataLakeLifecycleExpiration {
|
|
|
514
551
|
*/
|
|
515
552
|
export interface DataLakeLifecycleTransition {
|
|
516
553
|
/**
|
|
554
|
+
* @public
|
|
517
555
|
* <p>The range of storage classes that you can choose from based on the data access,
|
|
518
556
|
* resiliency, and cost requirements of your workloads.</p>
|
|
519
557
|
*/
|
|
520
558
|
storageClass?: string;
|
|
521
559
|
/**
|
|
560
|
+
* @public
|
|
522
561
|
* <p>Number of days before data transitions to a different S3 Storage Class in the Amazon Security Lake object.</p>
|
|
523
562
|
*/
|
|
524
563
|
days?: number;
|
|
@@ -529,10 +568,12 @@ export interface DataLakeLifecycleTransition {
|
|
|
529
568
|
*/
|
|
530
569
|
export interface DataLakeLifecycleConfiguration {
|
|
531
570
|
/**
|
|
571
|
+
* @public
|
|
532
572
|
* <p>Provides data expiration details of Amazon Security Lake object.</p>
|
|
533
573
|
*/
|
|
534
574
|
expiration?: DataLakeLifecycleExpiration;
|
|
535
575
|
/**
|
|
576
|
+
* @public
|
|
536
577
|
* <p>Provides data storage transition details of Amazon Security Lake object.</p>
|
|
537
578
|
*/
|
|
538
579
|
transitions?: DataLakeLifecycleTransition[];
|
|
@@ -543,6 +584,7 @@ export interface DataLakeLifecycleConfiguration {
|
|
|
543
584
|
*/
|
|
544
585
|
export interface DataLakeReplicationConfiguration {
|
|
545
586
|
/**
|
|
587
|
+
* @public
|
|
546
588
|
* <p>Replication enables automatic, asynchronous copying of objects across Amazon S3
|
|
547
589
|
* buckets. Amazon S3 buckets that are configured for object replication can be owned
|
|
548
590
|
* by the same Amazon Web Services account or by different accounts. You can replicate objects
|
|
@@ -554,6 +596,7 @@ export interface DataLakeReplicationConfiguration {
|
|
|
554
596
|
*/
|
|
555
597
|
regions?: string[];
|
|
556
598
|
/**
|
|
599
|
+
* @public
|
|
557
600
|
* <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
|
|
558
601
|
* ensure the replication setting is correct.</p>
|
|
559
602
|
*/
|
|
@@ -565,18 +608,22 @@ export interface DataLakeReplicationConfiguration {
|
|
|
565
608
|
*/
|
|
566
609
|
export interface DataLakeConfiguration {
|
|
567
610
|
/**
|
|
611
|
+
* @public
|
|
568
612
|
* <p>The Amazon Web Services Regions where Security Lake is automatically enabled.</p>
|
|
569
613
|
*/
|
|
570
614
|
region: string | undefined;
|
|
571
615
|
/**
|
|
616
|
+
* @public
|
|
572
617
|
* <p>Provides encryption details of Amazon Security Lake object.</p>
|
|
573
618
|
*/
|
|
574
619
|
encryptionConfiguration?: DataLakeEncryptionConfiguration;
|
|
575
620
|
/**
|
|
621
|
+
* @public
|
|
576
622
|
* <p>Provides lifecycle details of Amazon Security Lake object.</p>
|
|
577
623
|
*/
|
|
578
624
|
lifecycleConfiguration?: DataLakeLifecycleConfiguration;
|
|
579
625
|
/**
|
|
626
|
+
* @public
|
|
580
627
|
* <p>Provides replication details of Amazon Security Lake object.</p>
|
|
581
628
|
*/
|
|
582
629
|
replicationConfiguration?: DataLakeReplicationConfiguration;
|
|
@@ -595,10 +642,12 @@ export interface DataLakeConfiguration {
|
|
|
595
642
|
*/
|
|
596
643
|
export interface Tag {
|
|
597
644
|
/**
|
|
645
|
+
* @public
|
|
598
646
|
* <p>The name of the tag. This is a general label that acts as a category for a more specific tag value (<code>value</code>).</p>
|
|
599
647
|
*/
|
|
600
648
|
key: string | undefined;
|
|
601
649
|
/**
|
|
650
|
+
* @public
|
|
602
651
|
* <p>The value that’s associated with the specified tag key (<code>key</code>). This value acts as a descriptor for the tag key. A tag value cannot be
|
|
603
652
|
* null, but it can be an empty string.</p>
|
|
604
653
|
*/
|
|
@@ -609,16 +658,19 @@ export interface Tag {
|
|
|
609
658
|
*/
|
|
610
659
|
export interface CreateDataLakeRequest {
|
|
611
660
|
/**
|
|
661
|
+
* @public
|
|
612
662
|
* <p>Specify the Region or Regions that will contribute data to the rollup region.</p>
|
|
613
663
|
*/
|
|
614
664
|
configurations: DataLakeConfiguration[] | undefined;
|
|
615
665
|
/**
|
|
666
|
+
* @public
|
|
616
667
|
* <p>The Amazon Resource Name (ARN) used to create and update the Glue table.
|
|
617
668
|
* This table contains partitions generated by the ingestion and normalization of
|
|
618
669
|
* Amazon Web Services log sources and custom sources.</p>
|
|
619
670
|
*/
|
|
620
671
|
metaStoreManagerRoleArn: string | undefined;
|
|
621
672
|
/**
|
|
673
|
+
* @public
|
|
622
674
|
* <p>An array of objects, one for each tag to associate with the data lake configuration. For each tag, you must specify both a tag key and a tag value. A tag
|
|
623
675
|
* value cannot be null, but it can be an empty string.</p>
|
|
624
676
|
*/
|
|
@@ -645,11 +697,13 @@ export type DataLakeStatus = (typeof DataLakeStatus)[keyof typeof DataLakeStatus
|
|
|
645
697
|
*/
|
|
646
698
|
export interface DataLakeUpdateException {
|
|
647
699
|
/**
|
|
700
|
+
* @public
|
|
648
701
|
* <p>The reason for the exception of the last <code>UpdateDataLake</code>or
|
|
649
702
|
* <code>DeleteDataLake</code> API request.</p>
|
|
650
703
|
*/
|
|
651
704
|
reason?: string;
|
|
652
705
|
/**
|
|
706
|
+
* @public
|
|
653
707
|
* <p>The reason code for the exception of the last <code>UpdateDataLake</code> or
|
|
654
708
|
* <code>DeleteDataLake</code> API request.</p>
|
|
655
709
|
*/
|
|
@@ -663,16 +717,19 @@ export interface DataLakeUpdateException {
|
|
|
663
717
|
*/
|
|
664
718
|
export interface DataLakeUpdateStatus {
|
|
665
719
|
/**
|
|
720
|
+
* @public
|
|
666
721
|
* <p>The unique ID for the last <code>UpdateDataLake</code> or <code>DeleteDataLake</code> API
|
|
667
722
|
* request.</p>
|
|
668
723
|
*/
|
|
669
724
|
requestId?: string;
|
|
670
725
|
/**
|
|
726
|
+
* @public
|
|
671
727
|
* <p>The status of the last <code>UpdateDataLake</code> or <code>DeleteDataLake</code> API
|
|
672
728
|
* request that was requested.</p>
|
|
673
729
|
*/
|
|
674
730
|
status?: DataLakeStatus | string;
|
|
675
731
|
/**
|
|
732
|
+
* @public
|
|
676
733
|
* <p>The details of the last <code>UpdateDataLake</code>or <code>DeleteDataLake</code> API
|
|
677
734
|
* request which failed.</p>
|
|
678
735
|
*/
|
|
@@ -684,34 +741,42 @@ export interface DataLakeUpdateStatus {
|
|
|
684
741
|
*/
|
|
685
742
|
export interface DataLakeResource {
|
|
686
743
|
/**
|
|
744
|
+
* @public
|
|
687
745
|
* <p>The Amazon Resource Name (ARN) created by you to provide to the subscriber. For more information about ARNs and how to use them in policies, see the <a href="https://docs.aws.amazon.com/security-lake/latest/userguide/subscriber-management.html">Amazon Security Lake User Guide</a>.</p>
|
|
688
746
|
*/
|
|
689
747
|
dataLakeArn: string | undefined;
|
|
690
748
|
/**
|
|
749
|
+
* @public
|
|
691
750
|
* <p>The Amazon Web Services Regions where Security Lake is enabled.</p>
|
|
692
751
|
*/
|
|
693
752
|
region: string | undefined;
|
|
694
753
|
/**
|
|
754
|
+
* @public
|
|
695
755
|
* <p>The ARN for the Amazon Security Lake Amazon S3 bucket.</p>
|
|
696
756
|
*/
|
|
697
757
|
s3BucketArn?: string;
|
|
698
758
|
/**
|
|
759
|
+
* @public
|
|
699
760
|
* <p>Provides encryption details of Amazon Security Lake object.</p>
|
|
700
761
|
*/
|
|
701
762
|
encryptionConfiguration?: DataLakeEncryptionConfiguration;
|
|
702
763
|
/**
|
|
764
|
+
* @public
|
|
703
765
|
* <p>Provides lifecycle details of Amazon Security Lake object.</p>
|
|
704
766
|
*/
|
|
705
767
|
lifecycleConfiguration?: DataLakeLifecycleConfiguration;
|
|
706
768
|
/**
|
|
769
|
+
* @public
|
|
707
770
|
* <p>Provides replication details of Amazon Security Lake object.</p>
|
|
708
771
|
*/
|
|
709
772
|
replicationConfiguration?: DataLakeReplicationConfiguration;
|
|
710
773
|
/**
|
|
774
|
+
* @public
|
|
711
775
|
* <p>Retrieves the status of the configuration operation for an account in Amazon Security Lake.</p>
|
|
712
776
|
*/
|
|
713
777
|
createStatus?: DataLakeStatus | string;
|
|
714
778
|
/**
|
|
779
|
+
* @public
|
|
715
780
|
* <p>The status of the last <code>UpdateDataLake </code>or <code>DeleteDataLake</code> API
|
|
716
781
|
* request.</p>
|
|
717
782
|
*/
|
|
@@ -722,6 +787,7 @@ export interface DataLakeResource {
|
|
|
722
787
|
*/
|
|
723
788
|
export interface CreateDataLakeResponse {
|
|
724
789
|
/**
|
|
790
|
+
* @public
|
|
725
791
|
* <p>The created Security Lake configuration object.</p>
|
|
726
792
|
*/
|
|
727
793
|
dataLakes?: DataLakeResource[];
|
|
@@ -731,14 +797,17 @@ export interface CreateDataLakeResponse {
|
|
|
731
797
|
*/
|
|
732
798
|
export interface CreateDataLakeExceptionSubscriptionRequest {
|
|
733
799
|
/**
|
|
800
|
+
* @public
|
|
734
801
|
* <p>The subscription protocol to which exception notifications are posted.</p>
|
|
735
802
|
*/
|
|
736
803
|
subscriptionProtocol: string | undefined;
|
|
737
804
|
/**
|
|
805
|
+
* @public
|
|
738
806
|
* <p>The Amazon Web Services account where you want to receive exception notifications.</p>
|
|
739
807
|
*/
|
|
740
808
|
notificationEndpoint: string | undefined;
|
|
741
809
|
/**
|
|
810
|
+
* @public
|
|
742
811
|
* <p>The expiration period and time-to-live (TTL).</p>
|
|
743
812
|
*/
|
|
744
813
|
exceptionTimeToLive?: number;
|
|
@@ -755,10 +824,12 @@ export interface CreateDataLakeExceptionSubscriptionResponse {
|
|
|
755
824
|
*/
|
|
756
825
|
export interface DataLakeAutoEnableNewAccountConfiguration {
|
|
757
826
|
/**
|
|
827
|
+
* @public
|
|
758
828
|
* <p>The Amazon Web Services Regions where Security Lake is automatically enabled.</p>
|
|
759
829
|
*/
|
|
760
830
|
region: string | undefined;
|
|
761
831
|
/**
|
|
832
|
+
* @public
|
|
762
833
|
* <p>The Amazon Web Services sources that are automatically enabled in Security Lake.</p>
|
|
763
834
|
*/
|
|
764
835
|
sources: AwsLogSourceResource[] | undefined;
|
|
@@ -768,6 +839,7 @@ export interface DataLakeAutoEnableNewAccountConfiguration {
|
|
|
768
839
|
*/
|
|
769
840
|
export interface CreateDataLakeOrganizationConfigurationRequest {
|
|
770
841
|
/**
|
|
842
|
+
* @public
|
|
771
843
|
* <p>Enable Security Lake with the specified configuration settings, to begin collecting security
|
|
772
844
|
* data for new accounts in your organization.</p>
|
|
773
845
|
*/
|
|
@@ -789,6 +861,7 @@ export type LogSourceResource = LogSourceResource.AwsLogSourceMember | LogSource
|
|
|
789
861
|
*/
|
|
790
862
|
export declare namespace LogSourceResource {
|
|
791
863
|
/**
|
|
864
|
+
* @public
|
|
792
865
|
* <p>Amazon Security Lake supports log and event collection for natively supported Amazon Web Services. For more information, see the <a href="https://docs.aws.amazon.com/security-lake/latest/userguide/internal-sources.html">Amazon Security Lake User Guide</a>.</p>
|
|
793
866
|
*/
|
|
794
867
|
interface AwsLogSourceMember {
|
|
@@ -797,6 +870,7 @@ export declare namespace LogSourceResource {
|
|
|
797
870
|
$unknown?: never;
|
|
798
871
|
}
|
|
799
872
|
/**
|
|
873
|
+
* @public
|
|
800
874
|
* <p>Amazon Security Lake supports custom source types. For more information, see the <a href="https://docs.aws.amazon.com/security-lake/latest/userguide/custom-sources.html">Amazon Security Lake User Guide</a>.</p>
|
|
801
875
|
*/
|
|
802
876
|
interface CustomLogSourceMember {
|
|
@@ -804,6 +878,9 @@ export declare namespace LogSourceResource {
|
|
|
804
878
|
customLogSource: CustomLogSourceResource;
|
|
805
879
|
$unknown?: never;
|
|
806
880
|
}
|
|
881
|
+
/**
|
|
882
|
+
* @public
|
|
883
|
+
*/
|
|
807
884
|
interface $UnknownMember {
|
|
808
885
|
awsLogSource?: never;
|
|
809
886
|
customLogSource?: never;
|
|
@@ -821,27 +898,33 @@ export declare namespace LogSourceResource {
|
|
|
821
898
|
*/
|
|
822
899
|
export interface CreateSubscriberRequest {
|
|
823
900
|
/**
|
|
901
|
+
* @public
|
|
824
902
|
* <p>The AWS identity used to access your data.</p>
|
|
825
903
|
*/
|
|
826
904
|
subscriberIdentity: AwsIdentity | undefined;
|
|
827
905
|
/**
|
|
906
|
+
* @public
|
|
828
907
|
* <p>The name of your Security Lake subscriber account.</p>
|
|
829
908
|
*/
|
|
830
909
|
subscriberName: string | undefined;
|
|
831
910
|
/**
|
|
911
|
+
* @public
|
|
832
912
|
* <p>The description for your subscriber account in Security Lake.</p>
|
|
833
913
|
*/
|
|
834
914
|
subscriberDescription?: string;
|
|
835
915
|
/**
|
|
916
|
+
* @public
|
|
836
917
|
* <p>The supported Amazon Web Services from which logs and events are collected.
|
|
837
918
|
* Security Lake supports log and event collection for natively supported Amazon Web Services.</p>
|
|
838
919
|
*/
|
|
839
920
|
sources: LogSourceResource[] | undefined;
|
|
840
921
|
/**
|
|
922
|
+
* @public
|
|
841
923
|
* <p>The Amazon S3 or Lake Formation access type.</p>
|
|
842
924
|
*/
|
|
843
925
|
accessTypes?: (AccessType | string)[];
|
|
844
926
|
/**
|
|
927
|
+
* @public
|
|
845
928
|
* <p>An array of objects, one for each tag to associate with the subscriber. For each tag, you must specify both a tag key and a tag value. A tag
|
|
846
929
|
* value cannot be null, but it can be an empty string.</p>
|
|
847
930
|
*/
|
|
@@ -869,32 +952,39 @@ export type SubscriberStatus = (typeof SubscriberStatus)[keyof typeof Subscriber
|
|
|
869
952
|
*/
|
|
870
953
|
export interface SubscriberResource {
|
|
871
954
|
/**
|
|
955
|
+
* @public
|
|
872
956
|
* <p>The subscriber ID of the Amazon Security Lake subscriber account.</p>
|
|
873
957
|
*/
|
|
874
958
|
subscriberId: string | undefined;
|
|
875
959
|
/**
|
|
960
|
+
* @public
|
|
876
961
|
* <p>The subscriber ARN of the Amazon Security Lake subscriber account.</p>
|
|
877
962
|
*/
|
|
878
963
|
subscriberArn: string | undefined;
|
|
879
964
|
/**
|
|
965
|
+
* @public
|
|
880
966
|
* <p>The AWS identity used to access your data.</p>
|
|
881
967
|
*/
|
|
882
968
|
subscriberIdentity: AwsIdentity | undefined;
|
|
883
969
|
/**
|
|
970
|
+
* @public
|
|
884
971
|
* <p>The name of your Amazon Security Lake subscriber account.</p>
|
|
885
972
|
*/
|
|
886
973
|
subscriberName: string | undefined;
|
|
887
974
|
/**
|
|
975
|
+
* @public
|
|
888
976
|
* <p>The subscriber descriptions for a subscriber account. The description for a subscriber
|
|
889
977
|
* includes <code>subscriberName</code>, <code>accountID</code>, <code>externalID</code>, and
|
|
890
978
|
* <code>subscriberId</code>.</p>
|
|
891
979
|
*/
|
|
892
980
|
subscriberDescription?: string;
|
|
893
981
|
/**
|
|
982
|
+
* @public
|
|
894
983
|
* <p>Amazon Security Lake supports log and event collection for natively supported Amazon Web Services. For more information, see the <a href="https://docs.aws.amazon.com/security-lake/latest/userguide/source-management.html">Amazon Security Lake User Guide</a>.</p>
|
|
895
984
|
*/
|
|
896
985
|
sources: LogSourceResource[] | undefined;
|
|
897
986
|
/**
|
|
987
|
+
* @public
|
|
898
988
|
* <p>You can choose to notify subscribers of new objects with an Amazon Simple Queue Service
|
|
899
989
|
* (Amazon SQS) queue or through messaging to an HTTPS endpoint provided by the
|
|
900
990
|
* subscriber.</p>
|
|
@@ -904,22 +994,27 @@ export interface SubscriberResource {
|
|
|
904
994
|
*/
|
|
905
995
|
accessTypes?: (AccessType | string)[];
|
|
906
996
|
/**
|
|
997
|
+
* @public
|
|
907
998
|
* <p>The Amazon Resource Name (ARN) specifying the role of the subscriber.</p>
|
|
908
999
|
*/
|
|
909
1000
|
roleArn?: string;
|
|
910
1001
|
/**
|
|
1002
|
+
* @public
|
|
911
1003
|
* <p>The ARN for the Amazon S3 bucket.</p>
|
|
912
1004
|
*/
|
|
913
1005
|
s3BucketArn?: string;
|
|
914
1006
|
/**
|
|
1007
|
+
* @public
|
|
915
1008
|
* <p>The subscriber endpoint to which exception messages are posted.</p>
|
|
916
1009
|
*/
|
|
917
1010
|
subscriberEndpoint?: string;
|
|
918
1011
|
/**
|
|
1012
|
+
* @public
|
|
919
1013
|
* <p>The subscriber status of the Amazon Security Lake subscriber account.</p>
|
|
920
1014
|
*/
|
|
921
1015
|
subscriberStatus?: SubscriberStatus | string;
|
|
922
1016
|
/**
|
|
1017
|
+
* @public
|
|
923
1018
|
* <p>The Amazon Resource Name (ARN) which uniquely defines the AWS RAM resource share. Before
|
|
924
1019
|
* accepting the RAM resource share invitation, you can view details related to the RAM
|
|
925
1020
|
* resource share.</p>
|
|
@@ -927,14 +1022,17 @@ export interface SubscriberResource {
|
|
|
927
1022
|
*/
|
|
928
1023
|
resourceShareArn?: string;
|
|
929
1024
|
/**
|
|
1025
|
+
* @public
|
|
930
1026
|
* <p>The name of the resource share.</p>
|
|
931
1027
|
*/
|
|
932
1028
|
resourceShareName?: string;
|
|
933
1029
|
/**
|
|
1030
|
+
* @public
|
|
934
1031
|
* <p>The date and time when the subscriber was created.</p>
|
|
935
1032
|
*/
|
|
936
1033
|
createdAt?: Date;
|
|
937
1034
|
/**
|
|
1035
|
+
* @public
|
|
938
1036
|
* <p>The date and time when the subscriber was last updated.</p>
|
|
939
1037
|
*/
|
|
940
1038
|
updatedAt?: Date;
|
|
@@ -944,6 +1042,7 @@ export interface SubscriberResource {
|
|
|
944
1042
|
*/
|
|
945
1043
|
export interface CreateSubscriberResponse {
|
|
946
1044
|
/**
|
|
1045
|
+
* @public
|
|
947
1046
|
* <p>Retrieve information about the subscriber created using the
|
|
948
1047
|
* <code>CreateSubscriber</code> API.</p>
|
|
949
1048
|
*/
|
|
@@ -967,23 +1066,28 @@ export type HttpMethod = (typeof HttpMethod)[keyof typeof HttpMethod];
|
|
|
967
1066
|
*/
|
|
968
1067
|
export interface HttpsNotificationConfiguration {
|
|
969
1068
|
/**
|
|
1069
|
+
* @public
|
|
970
1070
|
* <p>The subscription endpoint in Security Lake. If you prefer notification with an HTTPs
|
|
971
1071
|
* endpoint, populate this field.</p>
|
|
972
1072
|
*/
|
|
973
1073
|
endpoint: string | undefined;
|
|
974
1074
|
/**
|
|
1075
|
+
* @public
|
|
975
1076
|
* <p>The key name for the notification subscription.</p>
|
|
976
1077
|
*/
|
|
977
1078
|
authorizationApiKeyName?: string;
|
|
978
1079
|
/**
|
|
1080
|
+
* @public
|
|
979
1081
|
* <p>The key value for the notification subscription.</p>
|
|
980
1082
|
*/
|
|
981
1083
|
authorizationApiKeyValue?: string;
|
|
982
1084
|
/**
|
|
1085
|
+
* @public
|
|
983
1086
|
* <p>The HTTPS method used for the notification subscription.</p>
|
|
984
1087
|
*/
|
|
985
1088
|
httpMethod?: HttpMethod | string;
|
|
986
1089
|
/**
|
|
1090
|
+
* @public
|
|
987
1091
|
* <p>The Amazon Resource Name (ARN) of the EventBridge API destinations IAM role that you
|
|
988
1092
|
* created. For more information about ARNs and how to use them in policies, see <a href="https://docs.aws.amazon.com//security-lake/latest/userguide/subscriber-data-access.html">Managing data access</a> and <a href="https://docs.aws.amazon.com/security-lake/latest/userguide/security-iam-awsmanpol.html">Amazon Web Services
|
|
989
1093
|
* Managed Policies</a> in the <i>Amazon Security Lake User Guide</i>.</p>
|
|
@@ -1008,6 +1112,7 @@ export type NotificationConfiguration = NotificationConfiguration.HttpsNotificat
|
|
|
1008
1112
|
*/
|
|
1009
1113
|
export declare namespace NotificationConfiguration {
|
|
1010
1114
|
/**
|
|
1115
|
+
* @public
|
|
1011
1116
|
* <p>The configurations for SQS subscriber notification.</p>
|
|
1012
1117
|
*/
|
|
1013
1118
|
interface SqsNotificationConfigurationMember {
|
|
@@ -1016,6 +1121,7 @@ export declare namespace NotificationConfiguration {
|
|
|
1016
1121
|
$unknown?: never;
|
|
1017
1122
|
}
|
|
1018
1123
|
/**
|
|
1124
|
+
* @public
|
|
1019
1125
|
* <p>The configurations for HTTPS subscriber notification.</p>
|
|
1020
1126
|
*/
|
|
1021
1127
|
interface HttpsNotificationConfigurationMember {
|
|
@@ -1023,6 +1129,9 @@ export declare namespace NotificationConfiguration {
|
|
|
1023
1129
|
httpsNotificationConfiguration: HttpsNotificationConfiguration;
|
|
1024
1130
|
$unknown?: never;
|
|
1025
1131
|
}
|
|
1132
|
+
/**
|
|
1133
|
+
* @public
|
|
1134
|
+
*/
|
|
1026
1135
|
interface $UnknownMember {
|
|
1027
1136
|
sqsNotificationConfiguration?: never;
|
|
1028
1137
|
httpsNotificationConfiguration?: never;
|
|
@@ -1040,10 +1149,12 @@ export declare namespace NotificationConfiguration {
|
|
|
1040
1149
|
*/
|
|
1041
1150
|
export interface CreateSubscriberNotificationRequest {
|
|
1042
1151
|
/**
|
|
1152
|
+
* @public
|
|
1043
1153
|
* <p>The subscriber ID for the notification subscription.</p>
|
|
1044
1154
|
*/
|
|
1045
1155
|
subscriberId: string | undefined;
|
|
1046
1156
|
/**
|
|
1157
|
+
* @public
|
|
1047
1158
|
* <p>Specify the configuration using which you want to create the subscriber
|
|
1048
1159
|
* notification.</p>
|
|
1049
1160
|
*/
|
|
@@ -1054,6 +1165,7 @@ export interface CreateSubscriberNotificationRequest {
|
|
|
1054
1165
|
*/
|
|
1055
1166
|
export interface CreateSubscriberNotificationResponse {
|
|
1056
1167
|
/**
|
|
1168
|
+
* @public
|
|
1057
1169
|
* <p>The subscriber endpoint to which exception messages are posted.</p>
|
|
1058
1170
|
*/
|
|
1059
1171
|
subscriberEndpoint?: string;
|
|
@@ -1063,6 +1175,7 @@ export interface CreateSubscriberNotificationResponse {
|
|
|
1063
1175
|
*/
|
|
1064
1176
|
export interface DeleteAwsLogSourceRequest {
|
|
1065
1177
|
/**
|
|
1178
|
+
* @public
|
|
1066
1179
|
* <p>Specify the natively-supported Amazon Web Services service to remove as a source in
|
|
1067
1180
|
* Security Lake.</p>
|
|
1068
1181
|
*/
|
|
@@ -1073,6 +1186,7 @@ export interface DeleteAwsLogSourceRequest {
|
|
|
1073
1186
|
*/
|
|
1074
1187
|
export interface DeleteAwsLogSourceResponse {
|
|
1075
1188
|
/**
|
|
1189
|
+
* @public
|
|
1076
1190
|
* <p>Deletion of the Amazon Web Services sources failed as the account is not a part of the organization.</p>
|
|
1077
1191
|
*/
|
|
1078
1192
|
failed?: string[];
|
|
@@ -1082,10 +1196,12 @@ export interface DeleteAwsLogSourceResponse {
|
|
|
1082
1196
|
*/
|
|
1083
1197
|
export interface DeleteCustomLogSourceRequest {
|
|
1084
1198
|
/**
|
|
1199
|
+
* @public
|
|
1085
1200
|
* <p>The source name of custom log source that you want to delete.</p>
|
|
1086
1201
|
*/
|
|
1087
1202
|
sourceName: string | undefined;
|
|
1088
1203
|
/**
|
|
1204
|
+
* @public
|
|
1089
1205
|
* <p>The source version for the third-party custom source. You can limit the custom source
|
|
1090
1206
|
* removal to the specified source version.</p>
|
|
1091
1207
|
*/
|
|
@@ -1101,6 +1217,7 @@ export interface DeleteCustomLogSourceResponse {
|
|
|
1101
1217
|
*/
|
|
1102
1218
|
export interface DeleteDataLakeRequest {
|
|
1103
1219
|
/**
|
|
1220
|
+
* @public
|
|
1104
1221
|
* <p>The list of Regions where Security Lake is enabled.</p>
|
|
1105
1222
|
*/
|
|
1106
1223
|
regions: string[] | undefined;
|
|
@@ -1115,6 +1232,7 @@ export interface DeleteDataLakeResponse {
|
|
|
1115
1232
|
*/
|
|
1116
1233
|
export interface DeleteDataLakeOrganizationConfigurationRequest {
|
|
1117
1234
|
/**
|
|
1235
|
+
* @public
|
|
1118
1236
|
* <p>Turns off automatic enablement of Security Lake for member accounts that are added to an organization.</p>
|
|
1119
1237
|
*/
|
|
1120
1238
|
autoEnableNewAccount: DataLakeAutoEnableNewAccountConfiguration[] | undefined;
|
|
@@ -1134,6 +1252,7 @@ export interface GetDataLakeOrganizationConfigurationRequest {
|
|
|
1134
1252
|
*/
|
|
1135
1253
|
export interface GetDataLakeOrganizationConfigurationResponse {
|
|
1136
1254
|
/**
|
|
1255
|
+
* @public
|
|
1137
1256
|
* <p>The configuration for new accounts.</p>
|
|
1138
1257
|
*/
|
|
1139
1258
|
autoEnableNewAccount?: DataLakeAutoEnableNewAccountConfiguration[];
|
|
@@ -1143,15 +1262,18 @@ export interface GetDataLakeOrganizationConfigurationResponse {
|
|
|
1143
1262
|
*/
|
|
1144
1263
|
export interface GetDataLakeSourcesRequest {
|
|
1145
1264
|
/**
|
|
1265
|
+
* @public
|
|
1146
1266
|
* <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>
|
|
1147
1267
|
*/
|
|
1148
1268
|
accounts?: string[];
|
|
1149
1269
|
/**
|
|
1270
|
+
* @public
|
|
1150
1271
|
* <p>The maximum limit of accounts for which the static snapshot of the current Region,
|
|
1151
1272
|
* including enabled accounts and log sources, is retrieved.</p>
|
|
1152
1273
|
*/
|
|
1153
1274
|
maxResults?: number;
|
|
1154
1275
|
/**
|
|
1276
|
+
* @public
|
|
1155
1277
|
* <p>Lists if there are more results available. The value of nextToken is a unique pagination
|
|
1156
1278
|
* token for each page. Repeat the call using the returned token to retrieve the next page.
|
|
1157
1279
|
* Keep all other arguments unchanged.</p>
|
|
@@ -1179,11 +1301,13 @@ export type SourceCollectionStatus = (typeof SourceCollectionStatus)[keyof typeo
|
|
|
1179
1301
|
*/
|
|
1180
1302
|
export interface DataLakeSourceStatus {
|
|
1181
1303
|
/**
|
|
1304
|
+
* @public
|
|
1182
1305
|
* <p>Defines path the stored logs are available which has information on your systems,
|
|
1183
1306
|
* applications, and services.</p>
|
|
1184
1307
|
*/
|
|
1185
1308
|
resource?: string;
|
|
1186
1309
|
/**
|
|
1310
|
+
* @public
|
|
1187
1311
|
* <p>The health status of services, including error codes and patterns.</p>
|
|
1188
1312
|
*/
|
|
1189
1313
|
status?: SourceCollectionStatus | string;
|
|
@@ -1195,15 +1319,18 @@ export interface DataLakeSourceStatus {
|
|
|
1195
1319
|
*/
|
|
1196
1320
|
export interface DataLakeSource {
|
|
1197
1321
|
/**
|
|
1322
|
+
* @public
|
|
1198
1323
|
* <p>The ID of the Security Lake account for which logs are collected.</p>
|
|
1199
1324
|
*/
|
|
1200
1325
|
account?: string;
|
|
1201
1326
|
/**
|
|
1327
|
+
* @public
|
|
1202
1328
|
* <p>The supported Amazon Web Services from which logs and events are collected.
|
|
1203
1329
|
* Amazon Security Lake supports log and event collection for natively supported Amazon Web Services.</p>
|
|
1204
1330
|
*/
|
|
1205
1331
|
sourceName?: string;
|
|
1206
1332
|
/**
|
|
1333
|
+
* @public
|
|
1207
1334
|
* <p>The Open Cybersecurity Schema Framework (OCSF) event classes which describes the type of
|
|
1208
1335
|
* data that the custom source will send to Security Lake. The supported event classes are:</p>
|
|
1209
1336
|
* <ul>
|
|
@@ -1356,6 +1483,7 @@ export interface DataLakeSource {
|
|
|
1356
1483
|
*/
|
|
1357
1484
|
eventClasses?: string[];
|
|
1358
1485
|
/**
|
|
1486
|
+
* @public
|
|
1359
1487
|
* <p>The log status for the Security Lake account.</p>
|
|
1360
1488
|
*/
|
|
1361
1489
|
sourceStatuses?: DataLakeSourceStatus[];
|
|
@@ -1365,14 +1493,17 @@ export interface DataLakeSource {
|
|
|
1365
1493
|
*/
|
|
1366
1494
|
export interface GetDataLakeSourcesResponse {
|
|
1367
1495
|
/**
|
|
1496
|
+
* @public
|
|
1368
1497
|
* <p>The Amazon Resource Name (ARN) created by you to provide to the subscriber. For more information about ARNs and how to use them in policies, see the <a href="https://docs.aws.amazon.com/security-lake/latest/userguide/subscriber-management.html">Amazon Security Lake User Guide</a>.</p>
|
|
1369
1498
|
*/
|
|
1370
1499
|
dataLakeArn?: string;
|
|
1371
1500
|
/**
|
|
1501
|
+
* @public
|
|
1372
1502
|
* <p>The list of enabled accounts and enabled sources.</p>
|
|
1373
1503
|
*/
|
|
1374
1504
|
dataLakeSources?: DataLakeSource[];
|
|
1375
1505
|
/**
|
|
1506
|
+
* @public
|
|
1376
1507
|
* <p>Lists if there are more results available. The value of nextToken is a unique pagination
|
|
1377
1508
|
* token for each page. Repeat the call using the returned token to retrieve the next page.
|
|
1378
1509
|
* Keep all other arguments unchanged.</p>
|
|
@@ -1386,6 +1517,7 @@ export interface GetDataLakeSourcesResponse {
|
|
|
1386
1517
|
*/
|
|
1387
1518
|
export interface ListDataLakesRequest {
|
|
1388
1519
|
/**
|
|
1520
|
+
* @public
|
|
1389
1521
|
* <p>The list of regions where Security Lake is enabled.</p>
|
|
1390
1522
|
*/
|
|
1391
1523
|
regions?: string[];
|
|
@@ -1395,6 +1527,7 @@ export interface ListDataLakesRequest {
|
|
|
1395
1527
|
*/
|
|
1396
1528
|
export interface ListDataLakesResponse {
|
|
1397
1529
|
/**
|
|
1530
|
+
* @public
|
|
1398
1531
|
* <p>Retrieves the Security Lake configuration object.</p>
|
|
1399
1532
|
*/
|
|
1400
1533
|
dataLakes?: DataLakeResource[];
|
|
@@ -1404,22 +1537,27 @@ export interface ListDataLakesResponse {
|
|
|
1404
1537
|
*/
|
|
1405
1538
|
export interface ListLogSourcesRequest {
|
|
1406
1539
|
/**
|
|
1540
|
+
* @public
|
|
1407
1541
|
* <p>The list of Amazon Web Services accounts for which log sources are displayed.</p>
|
|
1408
1542
|
*/
|
|
1409
1543
|
accounts?: string[];
|
|
1410
1544
|
/**
|
|
1545
|
+
* @public
|
|
1411
1546
|
* <p>The list of regions for which log sources are displayed.</p>
|
|
1412
1547
|
*/
|
|
1413
1548
|
regions?: string[];
|
|
1414
1549
|
/**
|
|
1550
|
+
* @public
|
|
1415
1551
|
* <p>The list of sources for which log sources are displayed.</p>
|
|
1416
1552
|
*/
|
|
1417
1553
|
sources?: LogSourceResource[];
|
|
1418
1554
|
/**
|
|
1555
|
+
* @public
|
|
1419
1556
|
* <p>The maximum number of accounts for which the log sources are displayed.</p>
|
|
1420
1557
|
*/
|
|
1421
1558
|
maxResults?: number;
|
|
1422
1559
|
/**
|
|
1560
|
+
* @public
|
|
1423
1561
|
* <p>If nextToken is returned, there are more results available. You can repeat the call
|
|
1424
1562
|
* using the returned token to retrieve the next page.</p>
|
|
1425
1563
|
*/
|
|
@@ -1431,14 +1569,17 @@ export interface ListLogSourcesRequest {
|
|
|
1431
1569
|
*/
|
|
1432
1570
|
export interface LogSource {
|
|
1433
1571
|
/**
|
|
1572
|
+
* @public
|
|
1434
1573
|
* <p>Specify the account from which you want to collect logs.</p>
|
|
1435
1574
|
*/
|
|
1436
1575
|
account?: string;
|
|
1437
1576
|
/**
|
|
1577
|
+
* @public
|
|
1438
1578
|
* <p>Specify the Regions from which you want to collect logs.</p>
|
|
1439
1579
|
*/
|
|
1440
1580
|
region?: string;
|
|
1441
1581
|
/**
|
|
1582
|
+
* @public
|
|
1442
1583
|
* <p>Specify the sources from which you want to collect logs.</p>
|
|
1443
1584
|
*/
|
|
1444
1585
|
sources?: LogSourceResource[];
|
|
@@ -1448,10 +1589,12 @@ export interface LogSource {
|
|
|
1448
1589
|
*/
|
|
1449
1590
|
export interface ListLogSourcesResponse {
|
|
1450
1591
|
/**
|
|
1592
|
+
* @public
|
|
1451
1593
|
* <p>The list of log sources in your organization that send data to the data lake.</p>
|
|
1452
1594
|
*/
|
|
1453
1595
|
sources?: LogSource[];
|
|
1454
1596
|
/**
|
|
1597
|
+
* @public
|
|
1455
1598
|
* <p>If nextToken is returned, there are more results available. You can repeat the call
|
|
1456
1599
|
* using the returned token to retrieve the next page.</p>
|
|
1457
1600
|
*/
|
|
@@ -1462,6 +1605,7 @@ export interface ListLogSourcesResponse {
|
|
|
1462
1605
|
*/
|
|
1463
1606
|
export interface UpdateDataLakeRequest {
|
|
1464
1607
|
/**
|
|
1608
|
+
* @public
|
|
1465
1609
|
* <p>Specify the Region or Regions that will contribute data to the rollup region.</p>
|
|
1466
1610
|
*/
|
|
1467
1611
|
configurations: DataLakeConfiguration[] | undefined;
|
|
@@ -1471,6 +1615,7 @@ export interface UpdateDataLakeRequest {
|
|
|
1471
1615
|
*/
|
|
1472
1616
|
export interface UpdateDataLakeResponse {
|
|
1473
1617
|
/**
|
|
1618
|
+
* @public
|
|
1474
1619
|
* <p>The created Security Lake configuration object.</p>
|
|
1475
1620
|
*/
|
|
1476
1621
|
dataLakes?: DataLakeResource[];
|
|
@@ -1481,18 +1626,22 @@ export interface UpdateDataLakeResponse {
|
|
|
1481
1626
|
*/
|
|
1482
1627
|
export interface DataLakeException {
|
|
1483
1628
|
/**
|
|
1629
|
+
* @public
|
|
1484
1630
|
* <p>The Amazon Web Services Regions where the exception occurred.</p>
|
|
1485
1631
|
*/
|
|
1486
1632
|
region?: string;
|
|
1487
1633
|
/**
|
|
1634
|
+
* @public
|
|
1488
1635
|
* <p>The underlying exception of a Security Lake exception.</p>
|
|
1489
1636
|
*/
|
|
1490
1637
|
exception?: string;
|
|
1491
1638
|
/**
|
|
1639
|
+
* @public
|
|
1492
1640
|
* <p>List of all remediation steps for a Security Lake exception.</p>
|
|
1493
1641
|
*/
|
|
1494
1642
|
remediation?: string;
|
|
1495
1643
|
/**
|
|
1644
|
+
* @public
|
|
1496
1645
|
* <p>This error can occur if you configure the wrong timestamp format, or if the subset of entries used for validation had errors or missing values.</p>
|
|
1497
1646
|
*/
|
|
1498
1647
|
timestamp?: Date;
|
|
@@ -1512,6 +1661,7 @@ export interface DeleteDataLakeExceptionSubscriptionResponse {
|
|
|
1512
1661
|
*/
|
|
1513
1662
|
export interface DeleteSubscriberRequest {
|
|
1514
1663
|
/**
|
|
1664
|
+
* @public
|
|
1515
1665
|
* <p>A value created by Security Lake that uniquely identifies your <code>DeleteSubscriber</code> API request.</p>
|
|
1516
1666
|
*/
|
|
1517
1667
|
subscriberId: string | undefined;
|
|
@@ -1526,6 +1676,7 @@ export interface DeleteSubscriberResponse {
|
|
|
1526
1676
|
*/
|
|
1527
1677
|
export interface DeleteSubscriberNotificationRequest {
|
|
1528
1678
|
/**
|
|
1679
|
+
* @public
|
|
1529
1680
|
* <p>The ID of the Security Lake subscriber account.</p>
|
|
1530
1681
|
*/
|
|
1531
1682
|
subscriberId: string | undefined;
|
|
@@ -1555,14 +1706,17 @@ export interface GetDataLakeExceptionSubscriptionRequest {
|
|
|
1555
1706
|
*/
|
|
1556
1707
|
export interface GetDataLakeExceptionSubscriptionResponse {
|
|
1557
1708
|
/**
|
|
1709
|
+
* @public
|
|
1558
1710
|
* <p>The subscription protocol to which exception notifications are posted.</p>
|
|
1559
1711
|
*/
|
|
1560
1712
|
subscriptionProtocol?: string;
|
|
1561
1713
|
/**
|
|
1714
|
+
* @public
|
|
1562
1715
|
* <p>The Amazon Web Services account where you receive exception notifications.</p>
|
|
1563
1716
|
*/
|
|
1564
1717
|
notificationEndpoint?: string;
|
|
1565
1718
|
/**
|
|
1719
|
+
* @public
|
|
1566
1720
|
* <p>The expiration period and time-to-live (TTL).</p>
|
|
1567
1721
|
*/
|
|
1568
1722
|
exceptionTimeToLive?: number;
|
|
@@ -1572,6 +1726,7 @@ export interface GetDataLakeExceptionSubscriptionResponse {
|
|
|
1572
1726
|
*/
|
|
1573
1727
|
export interface GetSubscriberRequest {
|
|
1574
1728
|
/**
|
|
1729
|
+
* @public
|
|
1575
1730
|
* <p>A value created by Amazon Security Lake that uniquely identifies your
|
|
1576
1731
|
* <code>GetSubscriber</code> API request.</p>
|
|
1577
1732
|
*/
|
|
@@ -1582,6 +1737,7 @@ export interface GetSubscriberRequest {
|
|
|
1582
1737
|
*/
|
|
1583
1738
|
export interface GetSubscriberResponse {
|
|
1584
1739
|
/**
|
|
1740
|
+
* @public
|
|
1585
1741
|
* <p>The subscriber information for the specified subscriber ID.</p>
|
|
1586
1742
|
*/
|
|
1587
1743
|
subscriber?: SubscriberResource;
|
|
@@ -1591,14 +1747,17 @@ export interface GetSubscriberResponse {
|
|
|
1591
1747
|
*/
|
|
1592
1748
|
export interface ListDataLakeExceptionsRequest {
|
|
1593
1749
|
/**
|
|
1750
|
+
* @public
|
|
1594
1751
|
* <p>List the Amazon Web Services Regions from which exceptions are retrieved.</p>
|
|
1595
1752
|
*/
|
|
1596
1753
|
regions?: string[];
|
|
1597
1754
|
/**
|
|
1755
|
+
* @public
|
|
1598
1756
|
* <p>List the maximum number of failures in Security Lake.</p>
|
|
1599
1757
|
*/
|
|
1600
1758
|
maxResults?: number;
|
|
1601
1759
|
/**
|
|
1760
|
+
* @public
|
|
1602
1761
|
* <p>List if there are more results available. The value of nextToken is a unique pagination
|
|
1603
1762
|
* token for each page. Repeat the call using the returned token to retrieve the next page.
|
|
1604
1763
|
* Keep all other arguments unchanged.</p>
|
|
@@ -1612,10 +1771,12 @@ export interface ListDataLakeExceptionsRequest {
|
|
|
1612
1771
|
*/
|
|
1613
1772
|
export interface ListDataLakeExceptionsResponse {
|
|
1614
1773
|
/**
|
|
1774
|
+
* @public
|
|
1615
1775
|
* <p>Lists the failures that cannot be retried in the current Region.</p>
|
|
1616
1776
|
*/
|
|
1617
1777
|
exceptions?: DataLakeException[];
|
|
1618
1778
|
/**
|
|
1779
|
+
* @public
|
|
1619
1780
|
* <p>List if there are more results available. The value of nextToken is a unique pagination
|
|
1620
1781
|
* token for each page. Repeat the call using the returned token to retrieve the next page.
|
|
1621
1782
|
* Keep all other arguments unchanged.</p>
|
|
@@ -1629,11 +1790,13 @@ export interface ListDataLakeExceptionsResponse {
|
|
|
1629
1790
|
*/
|
|
1630
1791
|
export interface ListSubscribersRequest {
|
|
1631
1792
|
/**
|
|
1793
|
+
* @public
|
|
1632
1794
|
* <p>If nextToken is returned, there are more results available. You can repeat the call
|
|
1633
1795
|
* using the returned token to retrieve the next page.</p>
|
|
1634
1796
|
*/
|
|
1635
1797
|
nextToken?: string;
|
|
1636
1798
|
/**
|
|
1799
|
+
* @public
|
|
1637
1800
|
* <p>The maximum number of accounts for which the configuration is displayed.</p>
|
|
1638
1801
|
*/
|
|
1639
1802
|
maxResults?: number;
|
|
@@ -1643,10 +1806,12 @@ export interface ListSubscribersRequest {
|
|
|
1643
1806
|
*/
|
|
1644
1807
|
export interface ListSubscribersResponse {
|
|
1645
1808
|
/**
|
|
1809
|
+
* @public
|
|
1646
1810
|
* <p>The subscribers available for the specified Security Lake account ID.</p>
|
|
1647
1811
|
*/
|
|
1648
1812
|
subscribers?: SubscriberResource[];
|
|
1649
1813
|
/**
|
|
1814
|
+
* @public
|
|
1650
1815
|
* <p>If nextToken is returned, there are more results available. You can repeat the call
|
|
1651
1816
|
* using the returned token to retrieve the next page.</p>
|
|
1652
1817
|
*/
|
|
@@ -1657,6 +1822,7 @@ export interface ListSubscribersResponse {
|
|
|
1657
1822
|
*/
|
|
1658
1823
|
export interface ListTagsForResourceRequest {
|
|
1659
1824
|
/**
|
|
1825
|
+
* @public
|
|
1660
1826
|
* <p>The Amazon Resource Name (ARN) of the Amazon Security Lake resource to retrieve the tags for.</p>
|
|
1661
1827
|
*/
|
|
1662
1828
|
resourceArn: string | undefined;
|
|
@@ -1666,6 +1832,7 @@ export interface ListTagsForResourceRequest {
|
|
|
1666
1832
|
*/
|
|
1667
1833
|
export interface ListTagsForResourceResponse {
|
|
1668
1834
|
/**
|
|
1835
|
+
* @public
|
|
1669
1836
|
* <p>An array of objects, one for each tag (key and value) that’s associated with the Amazon Security Lake resource.</p>
|
|
1670
1837
|
*/
|
|
1671
1838
|
tags?: Tag[];
|
|
@@ -1675,6 +1842,7 @@ export interface ListTagsForResourceResponse {
|
|
|
1675
1842
|
*/
|
|
1676
1843
|
export interface RegisterDataLakeDelegatedAdministratorRequest {
|
|
1677
1844
|
/**
|
|
1845
|
+
* @public
|
|
1678
1846
|
* <p>The Amazon Web Services account ID of the Security Lake delegated administrator.</p>
|
|
1679
1847
|
*/
|
|
1680
1848
|
accountId: string | undefined;
|
|
@@ -1689,22 +1857,27 @@ export interface RegisterDataLakeDelegatedAdministratorResponse {
|
|
|
1689
1857
|
*/
|
|
1690
1858
|
export interface UpdateSubscriberRequest {
|
|
1691
1859
|
/**
|
|
1860
|
+
* @public
|
|
1692
1861
|
* <p>A value created by Security Lake that uniquely identifies your subscription.</p>
|
|
1693
1862
|
*/
|
|
1694
1863
|
subscriberId: string | undefined;
|
|
1695
1864
|
/**
|
|
1865
|
+
* @public
|
|
1696
1866
|
* <p>The AWS identity used to access your data.</p>
|
|
1697
1867
|
*/
|
|
1698
1868
|
subscriberIdentity?: AwsIdentity;
|
|
1699
1869
|
/**
|
|
1870
|
+
* @public
|
|
1700
1871
|
* <p>The name of the Security Lake account subscriber.</p>
|
|
1701
1872
|
*/
|
|
1702
1873
|
subscriberName?: string;
|
|
1703
1874
|
/**
|
|
1875
|
+
* @public
|
|
1704
1876
|
* <p>The description of the Security Lake account subscriber.</p>
|
|
1705
1877
|
*/
|
|
1706
1878
|
subscriberDescription?: string;
|
|
1707
1879
|
/**
|
|
1880
|
+
* @public
|
|
1708
1881
|
* <p>The supported Amazon Web Services from which logs and events are collected. For
|
|
1709
1882
|
* 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>
|
|
1710
1883
|
*/
|
|
@@ -1715,6 +1888,7 @@ export interface UpdateSubscriberRequest {
|
|
|
1715
1888
|
*/
|
|
1716
1889
|
export interface UpdateSubscriberResponse {
|
|
1717
1890
|
/**
|
|
1891
|
+
* @public
|
|
1718
1892
|
* <p>The updated subscriber information.</p>
|
|
1719
1893
|
*/
|
|
1720
1894
|
subscriber?: SubscriberResource;
|
|
@@ -1724,10 +1898,12 @@ export interface UpdateSubscriberResponse {
|
|
|
1724
1898
|
*/
|
|
1725
1899
|
export interface UpdateSubscriberNotificationRequest {
|
|
1726
1900
|
/**
|
|
1901
|
+
* @public
|
|
1727
1902
|
* <p>The subscription ID for which the subscription notification is specified.</p>
|
|
1728
1903
|
*/
|
|
1729
1904
|
subscriberId: string | undefined;
|
|
1730
1905
|
/**
|
|
1906
|
+
* @public
|
|
1731
1907
|
* <p>The configuration for subscriber notification.</p>
|
|
1732
1908
|
*/
|
|
1733
1909
|
configuration: NotificationConfiguration | undefined;
|
|
@@ -1737,6 +1913,7 @@ export interface UpdateSubscriberNotificationRequest {
|
|
|
1737
1913
|
*/
|
|
1738
1914
|
export interface UpdateSubscriberNotificationResponse {
|
|
1739
1915
|
/**
|
|
1916
|
+
* @public
|
|
1740
1917
|
* <p>The subscriber endpoint to which exception messages are posted.</p>
|
|
1741
1918
|
*/
|
|
1742
1919
|
subscriberEndpoint?: string;
|
|
@@ -1746,10 +1923,12 @@ export interface UpdateSubscriberNotificationResponse {
|
|
|
1746
1923
|
*/
|
|
1747
1924
|
export interface TagResourceRequest {
|
|
1748
1925
|
/**
|
|
1926
|
+
* @public
|
|
1749
1927
|
* <p>The Amazon Resource Name (ARN) of the Amazon Security Lake resource to add or update the tags for.</p>
|
|
1750
1928
|
*/
|
|
1751
1929
|
resourceArn: string | undefined;
|
|
1752
1930
|
/**
|
|
1931
|
+
* @public
|
|
1753
1932
|
* <p>An array of objects, one for each tag (key and value) to associate with the Amazon Security Lake resource. For each tag, you must
|
|
1754
1933
|
* specify both a tag key and a tag value. A tag value cannot be null, but it can be an empty string.</p>
|
|
1755
1934
|
*/
|
|
@@ -1765,10 +1944,12 @@ export interface TagResourceResponse {
|
|
|
1765
1944
|
*/
|
|
1766
1945
|
export interface UntagResourceRequest {
|
|
1767
1946
|
/**
|
|
1947
|
+
* @public
|
|
1768
1948
|
* <p>The Amazon Resource Name (ARN) of the Amazon Security Lake resource to remove one or more tags from.</p>
|
|
1769
1949
|
*/
|
|
1770
1950
|
resourceArn: string | undefined;
|
|
1771
1951
|
/**
|
|
1952
|
+
* @public
|
|
1772
1953
|
* <p>A list of one or more tag keys. For each value in the list, specify the tag key for a tag to remove from the Amazon Security Lake resource.</p>
|
|
1773
1954
|
*/
|
|
1774
1955
|
tagKeys: string[] | undefined;
|
|
@@ -1783,14 +1964,17 @@ export interface UntagResourceResponse {
|
|
|
1783
1964
|
*/
|
|
1784
1965
|
export interface UpdateDataLakeExceptionSubscriptionRequest {
|
|
1785
1966
|
/**
|
|
1967
|
+
* @public
|
|
1786
1968
|
* <p>The subscription protocol to which exception messages are posted.</p>
|
|
1787
1969
|
*/
|
|
1788
1970
|
subscriptionProtocol: string | undefined;
|
|
1789
1971
|
/**
|
|
1972
|
+
* @public
|
|
1790
1973
|
* <p>The account that is subscribed to receive exception notifications.</p>
|
|
1791
1974
|
*/
|
|
1792
1975
|
notificationEndpoint: string | undefined;
|
|
1793
1976
|
/**
|
|
1977
|
+
* @public
|
|
1794
1978
|
* <p>The time-to-live (TTL) for the exception message to remain.</p>
|
|
1795
1979
|
*/
|
|
1796
1980
|
exceptionTimeToLive?: number;
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-securitylake",
|
|
3
3
|
"description": "AWS SDK for JavaScript Securitylake Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
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.
|
|
25
|
-
"@aws-sdk/credential-provider-node": "3.
|
|
26
|
-
"@aws-sdk/middleware-host-header": "3.
|
|
24
|
+
"@aws-sdk/client-sts": "3.382.0",
|
|
25
|
+
"@aws-sdk/credential-provider-node": "3.382.0",
|
|
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
|
-
"@aws-sdk/middleware-signing": "3.
|
|
30
|
-
"@aws-sdk/middleware-user-agent": "3.
|
|
29
|
+
"@aws-sdk/middleware-signing": "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.
|
|
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",
|