@aws-sdk/client-securitylake 3.533.0 → 3.535.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-types/SecurityLake.d.ts +12 -1
- package/dist-types/SecurityLakeClient.d.ts +1 -1
- package/dist-types/commands/CreateAwsLogSourceCommand.d.ts +2 -1
- package/dist-types/commands/CreateCustomLogSourceCommand.d.ts +2 -1
- package/dist-types/commands/CreateDataLakeCommand.d.ts +2 -1
- package/dist-types/commands/CreateDataLakeExceptionSubscriptionCommand.d.ts +2 -1
- package/dist-types/commands/CreateDataLakeOrganizationConfigurationCommand.d.ts +2 -1
- package/dist-types/commands/CreateSubscriberCommand.d.ts +2 -1
- package/dist-types/commands/CreateSubscriberNotificationCommand.d.ts +2 -1
- package/dist-types/commands/DeleteAwsLogSourceCommand.d.ts +2 -1
- package/dist-types/commands/DeleteCustomLogSourceCommand.d.ts +2 -1
- package/dist-types/commands/DeleteDataLakeCommand.d.ts +2 -1
- package/dist-types/commands/DeleteDataLakeExceptionSubscriptionCommand.d.ts +2 -1
- package/dist-types/commands/DeleteDataLakeOrganizationConfigurationCommand.d.ts +2 -1
- package/dist-types/commands/DeleteSubscriberCommand.d.ts +2 -1
- package/dist-types/commands/DeleteSubscriberNotificationCommand.d.ts +2 -1
- package/dist-types/commands/DeregisterDataLakeDelegatedAdministratorCommand.d.ts +2 -1
- package/dist-types/commands/GetDataLakeExceptionSubscriptionCommand.d.ts +2 -1
- package/dist-types/commands/GetDataLakeOrganizationConfigurationCommand.d.ts +2 -1
- package/dist-types/commands/GetDataLakeSourcesCommand.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/ListDataLakesCommand.d.ts +2 -1
- package/dist-types/commands/ListLogSourcesCommand.d.ts +2 -1
- package/dist-types/commands/ListSubscribersCommand.d.ts +2 -1
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -1
- package/dist-types/commands/RegisterDataLakeDelegatedAdministratorCommand.d.ts +2 -1
- package/dist-types/commands/TagResourceCommand.d.ts +2 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +2 -1
- package/dist-types/commands/UpdateDataLakeCommand.d.ts +2 -1
- package/dist-types/commands/UpdateDataLakeExceptionSubscriptionCommand.d.ts +2 -1
- package/dist-types/commands/UpdateSubscriberCommand.d.ts +2 -1
- package/dist-types/commands/UpdateSubscriberNotificationCommand.d.ts +2 -1
- package/dist-types/models/models_0.d.ts +213 -213
- package/dist-types/ts3.4/SecurityLake.d.ts +11 -0
- package/dist-types/ts3.4/commands/CreateAwsLogSourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateCustomLogSourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateDataLakeCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateDataLakeExceptionSubscriptionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateDataLakeOrganizationConfigurationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateSubscriberCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateSubscriberNotificationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteAwsLogSourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteCustomLogSourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteDataLakeCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteDataLakeExceptionSubscriptionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteDataLakeOrganizationConfigurationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteSubscriberCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteSubscriberNotificationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeregisterDataLakeDelegatedAdministratorCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetDataLakeExceptionSubscriptionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetDataLakeOrganizationConfigurationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetDataLakeSourcesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetSubscriberCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListDataLakeExceptionsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListDataLakesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListLogSourcesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListSubscribersCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/RegisterDataLakeDelegatedAdministratorCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateDataLakeCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateDataLakeExceptionSubscriptionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateSubscriberCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateSubscriberNotificationCommand.d.ts +9 -0
- package/package.json +40 -40
|
@@ -1,18 +1,18 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
2
|
import { SecurityLakeServiceException as __BaseException } from "./SecurityLakeServiceException";
|
|
3
3
|
/**
|
|
4
|
-
* @public
|
|
5
4
|
* <p>You do not have sufficient access to perform this action. Access denied errors appear when Amazon Security Lake explicitly or implicitly denies an authorization
|
|
6
5
|
* request. An explicit denial occurs when a policy contains a Deny statement for the specific
|
|
7
6
|
* Amazon Web Services action. An implicit denial occurs when there is no applicable Deny statement and also
|
|
8
7
|
* no applicable Allow statement.</p>
|
|
8
|
+
* @public
|
|
9
9
|
*/
|
|
10
10
|
export declare class AccessDeniedException extends __BaseException {
|
|
11
11
|
readonly name: "AccessDeniedException";
|
|
12
12
|
readonly $fault: "client";
|
|
13
13
|
/**
|
|
14
|
-
* @public
|
|
15
14
|
* <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
|
+
* @public
|
|
16
16
|
*/
|
|
17
17
|
errorCode?: string;
|
|
18
18
|
/**
|
|
@@ -33,18 +33,18 @@ export declare const AccessType: {
|
|
|
33
33
|
*/
|
|
34
34
|
export type AccessType = (typeof AccessType)[keyof typeof AccessType];
|
|
35
35
|
/**
|
|
36
|
-
* @public
|
|
37
36
|
* <p>The AWS identity.</p>
|
|
37
|
+
* @public
|
|
38
38
|
*/
|
|
39
39
|
export interface AwsIdentity {
|
|
40
40
|
/**
|
|
41
|
-
* @public
|
|
42
41
|
* <p>The AWS identity principal.</p>
|
|
42
|
+
* @public
|
|
43
43
|
*/
|
|
44
44
|
principal: string | undefined;
|
|
45
45
|
/**
|
|
46
|
-
* @public
|
|
47
46
|
* <p>The external ID used to estalish trust relationship with the AWS identity.</p>
|
|
47
|
+
* @public
|
|
48
48
|
*/
|
|
49
49
|
externalId: string | undefined;
|
|
50
50
|
}
|
|
@@ -67,50 +67,50 @@ export declare const AwsLogSourceName: {
|
|
|
67
67
|
*/
|
|
68
68
|
export type AwsLogSourceName = (typeof AwsLogSourceName)[keyof typeof AwsLogSourceName];
|
|
69
69
|
/**
|
|
70
|
-
* @public
|
|
71
70
|
* <p>The Security Lake logs source configuration file describes the information needed to generate Security Lake logs. </p>
|
|
71
|
+
* @public
|
|
72
72
|
*/
|
|
73
73
|
export interface AwsLogSourceConfiguration {
|
|
74
74
|
/**
|
|
75
|
-
* @public
|
|
76
75
|
* <p>Specify the Amazon Web Services account information where you want to enable Security Lake.</p>
|
|
76
|
+
* @public
|
|
77
77
|
*/
|
|
78
78
|
accounts?: string[];
|
|
79
79
|
/**
|
|
80
|
-
* @public
|
|
81
80
|
* <p>Specify the Regions where you want to enable Security Lake.</p>
|
|
81
|
+
* @public
|
|
82
82
|
*/
|
|
83
83
|
regions: string[] | undefined;
|
|
84
84
|
/**
|
|
85
|
-
* @public
|
|
86
85
|
* <p>The name for a Amazon Web Services source. This must be a Regionally unique value.</p>
|
|
86
|
+
* @public
|
|
87
87
|
*/
|
|
88
88
|
sourceName: AwsLogSourceName | undefined;
|
|
89
89
|
/**
|
|
90
|
-
* @public
|
|
91
90
|
* <p>The version for a Amazon Web Services source. This must be a Regionally unique value.</p>
|
|
91
|
+
* @public
|
|
92
92
|
*/
|
|
93
93
|
sourceVersion?: string;
|
|
94
94
|
}
|
|
95
95
|
/**
|
|
96
|
-
* @public
|
|
97
96
|
* <p>Amazon Security Lake can collect logs and events from natively-supported Amazon Web Services services.</p>
|
|
97
|
+
* @public
|
|
98
98
|
*/
|
|
99
99
|
export interface AwsLogSourceResource {
|
|
100
100
|
/**
|
|
101
|
-
* @public
|
|
102
101
|
* <p>The name for a Amazon Web Services source. This must be a Regionally unique value.</p>
|
|
102
|
+
* @public
|
|
103
103
|
*/
|
|
104
104
|
sourceName?: AwsLogSourceName;
|
|
105
105
|
/**
|
|
106
|
-
* @public
|
|
107
106
|
* <p>The version for a Amazon Web Services source. This must be a Regionally unique value.</p>
|
|
107
|
+
* @public
|
|
108
108
|
*/
|
|
109
109
|
sourceVersion?: string;
|
|
110
110
|
}
|
|
111
111
|
/**
|
|
112
|
-
* @public
|
|
113
112
|
* <p>The request is malformed or contains an error such as an invalid parameter value or a missing required parameter.</p>
|
|
113
|
+
* @public
|
|
114
114
|
*/
|
|
115
115
|
export declare class BadRequestException extends __BaseException {
|
|
116
116
|
readonly name: "BadRequestException";
|
|
@@ -121,23 +121,23 @@ export declare class BadRequestException extends __BaseException {
|
|
|
121
121
|
constructor(opts: __ExceptionOptionType<BadRequestException, __BaseException>);
|
|
122
122
|
}
|
|
123
123
|
/**
|
|
124
|
-
* @public
|
|
125
124
|
* <p>Occurs when a conflict with a previous successful write is detected. This generally
|
|
126
125
|
* occurs when the previous write did not have time to propagate to the host serving the
|
|
127
126
|
* current request. A retry (with appropriate backoff logic) is the recommended response to
|
|
128
127
|
* this exception.</p>
|
|
128
|
+
* @public
|
|
129
129
|
*/
|
|
130
130
|
export declare class ConflictException extends __BaseException {
|
|
131
131
|
readonly name: "ConflictException";
|
|
132
132
|
readonly $fault: "client";
|
|
133
133
|
/**
|
|
134
|
-
* @public
|
|
135
134
|
* <p>The resource name.</p>
|
|
135
|
+
* @public
|
|
136
136
|
*/
|
|
137
137
|
resourceName?: string;
|
|
138
138
|
/**
|
|
139
|
-
* @public
|
|
140
139
|
* <p>The resource type.</p>
|
|
140
|
+
* @public
|
|
141
141
|
*/
|
|
142
142
|
resourceType?: string;
|
|
143
143
|
/**
|
|
@@ -150,8 +150,8 @@ export declare class ConflictException extends __BaseException {
|
|
|
150
150
|
*/
|
|
151
151
|
export interface CreateAwsLogSourceRequest {
|
|
152
152
|
/**
|
|
153
|
-
* @public
|
|
154
153
|
* <p>Specify the natively-supported Amazon Web Services service to add as a source in Security Lake.</p>
|
|
154
|
+
* @public
|
|
155
155
|
*/
|
|
156
156
|
sources: AwsLogSourceConfiguration[] | undefined;
|
|
157
157
|
}
|
|
@@ -160,17 +160,17 @@ export interface CreateAwsLogSourceRequest {
|
|
|
160
160
|
*/
|
|
161
161
|
export interface CreateAwsLogSourceResponse {
|
|
162
162
|
/**
|
|
163
|
-
* @public
|
|
164
163
|
* <p>Lists all accounts in which enabling a natively supported Amazon Web Service as
|
|
165
164
|
* a Security Lake source failed. The failure occurred as these accounts are not part of an
|
|
166
165
|
* organization.</p>
|
|
166
|
+
* @public
|
|
167
167
|
*/
|
|
168
168
|
failed?: string[];
|
|
169
169
|
}
|
|
170
170
|
/**
|
|
171
|
-
* @public
|
|
172
171
|
* <p>Internal service exceptions are sometimes caused by transient issues. Before you start
|
|
173
172
|
* troubleshooting, perform the operation again.</p>
|
|
173
|
+
* @public
|
|
174
174
|
*/
|
|
175
175
|
export declare class InternalServerException extends __BaseException {
|
|
176
176
|
readonly name: "InternalServerException";
|
|
@@ -182,20 +182,20 @@ export declare class InternalServerException extends __BaseException {
|
|
|
182
182
|
constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
|
|
183
183
|
}
|
|
184
184
|
/**
|
|
185
|
-
* @public
|
|
186
185
|
* <p>The resource could not be found.</p>
|
|
186
|
+
* @public
|
|
187
187
|
*/
|
|
188
188
|
export declare class ResourceNotFoundException extends __BaseException {
|
|
189
189
|
readonly name: "ResourceNotFoundException";
|
|
190
190
|
readonly $fault: "client";
|
|
191
191
|
/**
|
|
192
|
-
* @public
|
|
193
192
|
* <p>The name of the resource that could not be found.</p>
|
|
193
|
+
* @public
|
|
194
194
|
*/
|
|
195
195
|
resourceName?: string;
|
|
196
196
|
/**
|
|
197
|
-
* @public
|
|
198
197
|
* <p>The type of the resource that could not be found.</p>
|
|
198
|
+
* @public
|
|
199
199
|
*/
|
|
200
200
|
resourceType?: string;
|
|
201
201
|
/**
|
|
@@ -204,8 +204,8 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
204
204
|
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
205
205
|
}
|
|
206
206
|
/**
|
|
207
|
-
* @public
|
|
208
207
|
* <p>The limit on the number of requests per second was exceeded.</p>
|
|
208
|
+
* @public
|
|
209
209
|
*/
|
|
210
210
|
export declare class ThrottlingException extends __BaseException {
|
|
211
211
|
readonly name: "ThrottlingException";
|
|
@@ -214,18 +214,18 @@ export declare class ThrottlingException extends __BaseException {
|
|
|
214
214
|
throttling: boolean;
|
|
215
215
|
};
|
|
216
216
|
/**
|
|
217
|
-
* @public
|
|
218
217
|
* <p>The code for the service in Service Quotas.</p>
|
|
218
|
+
* @public
|
|
219
219
|
*/
|
|
220
220
|
serviceCode?: string;
|
|
221
221
|
/**
|
|
222
|
-
* @public
|
|
223
222
|
* <p>That the rate of requests to Security Lake is exceeding the request quotas for your Amazon Web Services account.</p>
|
|
223
|
+
* @public
|
|
224
224
|
*/
|
|
225
225
|
quotaCode?: string;
|
|
226
226
|
/**
|
|
227
|
-
* @public
|
|
228
227
|
* <p>Retry the request after the specified time.</p>
|
|
228
|
+
* @public
|
|
229
229
|
*/
|
|
230
230
|
retryAfterSeconds?: number;
|
|
231
231
|
/**
|
|
@@ -234,12 +234,11 @@ export declare class ThrottlingException extends __BaseException {
|
|
|
234
234
|
constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
|
|
235
235
|
}
|
|
236
236
|
/**
|
|
237
|
-
* @public
|
|
238
237
|
* <p>The configuration for the Glue Crawler for the third-party custom source.</p>
|
|
238
|
+
* @public
|
|
239
239
|
*/
|
|
240
240
|
export interface CustomLogSourceCrawlerConfiguration {
|
|
241
241
|
/**
|
|
242
|
-
* @public
|
|
243
242
|
* <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role
|
|
244
243
|
* to be used by the Glue crawler. The recommended IAM policies
|
|
245
244
|
* are:</p>
|
|
@@ -252,22 +251,23 @@ export interface CustomLogSourceCrawlerConfiguration {
|
|
|
252
251
|
* <p>A custom policy granting access to your Amazon S3 Data Lake</p>
|
|
253
252
|
* </li>
|
|
254
253
|
* </ul>
|
|
254
|
+
* @public
|
|
255
255
|
*/
|
|
256
256
|
roleArn: string | undefined;
|
|
257
257
|
}
|
|
258
258
|
/**
|
|
259
|
-
* @public
|
|
260
259
|
* <p>The configuration for the third-party custom source.</p>
|
|
260
|
+
* @public
|
|
261
261
|
*/
|
|
262
262
|
export interface CustomLogSourceConfiguration {
|
|
263
263
|
/**
|
|
264
|
-
* @public
|
|
265
264
|
* <p>The configuration for the Glue Crawler for the third-party custom source.</p>
|
|
265
|
+
* @public
|
|
266
266
|
*/
|
|
267
267
|
crawlerConfiguration: CustomLogSourceCrawlerConfiguration | undefined;
|
|
268
268
|
/**
|
|
269
|
-
* @public
|
|
270
269
|
* <p>The identity of the log provider for the third-party custom source.</p>
|
|
270
|
+
* @public
|
|
271
271
|
*/
|
|
272
272
|
providerIdentity: AwsIdentity | undefined;
|
|
273
273
|
}
|
|
@@ -276,19 +276,18 @@ export interface CustomLogSourceConfiguration {
|
|
|
276
276
|
*/
|
|
277
277
|
export interface CreateCustomLogSourceRequest {
|
|
278
278
|
/**
|
|
279
|
-
* @public
|
|
280
279
|
* <p>Specify the name for a third-party custom source. This must be a Regionally unique
|
|
281
280
|
* value.</p>
|
|
281
|
+
* @public
|
|
282
282
|
*/
|
|
283
283
|
sourceName: string | undefined;
|
|
284
284
|
/**
|
|
285
|
-
* @public
|
|
286
285
|
* <p>Specify the source version for the third-party custom source, to limit log collection to
|
|
287
286
|
* a specific version of custom data source.</p>
|
|
287
|
+
* @public
|
|
288
288
|
*/
|
|
289
289
|
sourceVersion?: string;
|
|
290
290
|
/**
|
|
291
|
-
* @public
|
|
292
291
|
* <p>The Open Cybersecurity Schema Framework (OCSF) event classes which describes the type of
|
|
293
292
|
* data that the custom source will send to Security Lake. The supported event classes are:</p>
|
|
294
293
|
* <ul>
|
|
@@ -438,79 +437,80 @@ export interface CreateCustomLogSourceRequest {
|
|
|
438
437
|
* </p>
|
|
439
438
|
* </li>
|
|
440
439
|
* </ul>
|
|
440
|
+
* @public
|
|
441
441
|
*/
|
|
442
442
|
eventClasses?: string[];
|
|
443
443
|
/**
|
|
444
|
-
* @public
|
|
445
444
|
* <p>The configuration for the third-party custom source.</p>
|
|
445
|
+
* @public
|
|
446
446
|
*/
|
|
447
447
|
configuration: CustomLogSourceConfiguration | undefined;
|
|
448
448
|
}
|
|
449
449
|
/**
|
|
450
|
-
* @public
|
|
451
450
|
* <p>The attributes of a third-party custom source.</p>
|
|
451
|
+
* @public
|
|
452
452
|
*/
|
|
453
453
|
export interface CustomLogSourceAttributes {
|
|
454
454
|
/**
|
|
455
|
-
* @public
|
|
456
455
|
* <p>The ARN of the Glue crawler.</p>
|
|
456
|
+
* @public
|
|
457
457
|
*/
|
|
458
458
|
crawlerArn?: string;
|
|
459
459
|
/**
|
|
460
|
-
* @public
|
|
461
460
|
* <p>The ARN of the Glue database where results are written, such as:
|
|
462
461
|
* <code>arn:aws:daylight:us-east-1::database/sometable/*</code>.</p>
|
|
462
|
+
* @public
|
|
463
463
|
*/
|
|
464
464
|
databaseArn?: string;
|
|
465
465
|
/**
|
|
466
|
-
* @public
|
|
467
466
|
* <p>The ARN of the Glue table.</p>
|
|
467
|
+
* @public
|
|
468
468
|
*/
|
|
469
469
|
tableArn?: string;
|
|
470
470
|
}
|
|
471
471
|
/**
|
|
472
|
-
* @public
|
|
473
472
|
* <p>The details of the log provider for a third-party custom source.</p>
|
|
473
|
+
* @public
|
|
474
474
|
*/
|
|
475
475
|
export interface CustomLogSourceProvider {
|
|
476
476
|
/**
|
|
477
|
-
* @public
|
|
478
477
|
* <p>The ARN of the IAM role to be used by the entity putting logs into your
|
|
479
478
|
* custom source partition. Security Lake will apply the correct access policies to this role, but
|
|
480
479
|
* you must first manually create the trust policy for this role. The IAM role
|
|
481
480
|
* name must start with the text 'Security Lake'. The IAM role must trust the
|
|
482
481
|
* <code>logProviderAccountId</code> to assume the role.</p>
|
|
482
|
+
* @public
|
|
483
483
|
*/
|
|
484
484
|
roleArn?: string;
|
|
485
485
|
/**
|
|
486
|
-
* @public
|
|
487
486
|
* <p>The location of the partition in the Amazon S3 bucket for Security Lake.</p>
|
|
487
|
+
* @public
|
|
488
488
|
*/
|
|
489
489
|
location?: string;
|
|
490
490
|
}
|
|
491
491
|
/**
|
|
492
|
-
* @public
|
|
493
492
|
* <p>Amazon Security Lake can collect logs and events from third-party custom sources.</p>
|
|
493
|
+
* @public
|
|
494
494
|
*/
|
|
495
495
|
export interface CustomLogSourceResource {
|
|
496
496
|
/**
|
|
497
|
-
* @public
|
|
498
497
|
* <p>The name for a third-party custom source. This must be a Regionally unique value.</p>
|
|
498
|
+
* @public
|
|
499
499
|
*/
|
|
500
500
|
sourceName?: string;
|
|
501
501
|
/**
|
|
502
|
-
* @public
|
|
503
502
|
* <p>The version for a third-party custom source. This must be a Regionally unique value.</p>
|
|
503
|
+
* @public
|
|
504
504
|
*/
|
|
505
505
|
sourceVersion?: string;
|
|
506
506
|
/**
|
|
507
|
-
* @public
|
|
508
507
|
* <p>The details of the log provider for a third-party custom source.</p>
|
|
508
|
+
* @public
|
|
509
509
|
*/
|
|
510
510
|
provider?: CustomLogSourceProvider;
|
|
511
511
|
/**
|
|
512
|
-
* @public
|
|
513
512
|
* <p>The attributes of a third-party custom source.</p>
|
|
513
|
+
* @public
|
|
514
514
|
*/
|
|
515
515
|
attributes?: CustomLogSourceAttributes;
|
|
516
516
|
}
|
|
@@ -519,74 +519,73 @@ export interface CustomLogSourceResource {
|
|
|
519
519
|
*/
|
|
520
520
|
export interface CreateCustomLogSourceResponse {
|
|
521
521
|
/**
|
|
522
|
-
* @public
|
|
523
522
|
* <p>The created third-party custom source.</p>
|
|
523
|
+
* @public
|
|
524
524
|
*/
|
|
525
525
|
source?: CustomLogSourceResource;
|
|
526
526
|
}
|
|
527
527
|
/**
|
|
528
|
-
* @public
|
|
529
528
|
* <p>Provides encryption details of Amazon Security Lake object.</p>
|
|
529
|
+
* @public
|
|
530
530
|
*/
|
|
531
531
|
export interface DataLakeEncryptionConfiguration {
|
|
532
532
|
/**
|
|
533
|
-
* @public
|
|
534
533
|
* <p>The id of KMS encryption key used by Amazon Security Lake to encrypt the Security Lake
|
|
535
534
|
* object.</p>
|
|
535
|
+
* @public
|
|
536
536
|
*/
|
|
537
537
|
kmsKeyId?: string;
|
|
538
538
|
}
|
|
539
539
|
/**
|
|
540
|
-
* @public
|
|
541
540
|
* <p>Provide expiration lifecycle details of Amazon Security Lake object.</p>
|
|
541
|
+
* @public
|
|
542
542
|
*/
|
|
543
543
|
export interface DataLakeLifecycleExpiration {
|
|
544
544
|
/**
|
|
545
|
-
* @public
|
|
546
545
|
* <p>Number of days before data expires in the Amazon Security Lake object.</p>
|
|
546
|
+
* @public
|
|
547
547
|
*/
|
|
548
548
|
days?: number;
|
|
549
549
|
}
|
|
550
550
|
/**
|
|
551
|
-
* @public
|
|
552
551
|
* <p>Provide transition lifecycle details of Amazon Security Lake object.</p>
|
|
552
|
+
* @public
|
|
553
553
|
*/
|
|
554
554
|
export interface DataLakeLifecycleTransition {
|
|
555
555
|
/**
|
|
556
|
-
* @public
|
|
557
556
|
* <p>The range of storage classes that you can choose from based on the data access,
|
|
558
557
|
* resiliency, and cost requirements of your workloads.</p>
|
|
558
|
+
* @public
|
|
559
559
|
*/
|
|
560
560
|
storageClass?: string;
|
|
561
561
|
/**
|
|
562
|
-
* @public
|
|
563
562
|
* <p>Number of days before data transitions to a different S3 Storage Class in the Amazon Security Lake object.</p>
|
|
563
|
+
* @public
|
|
564
564
|
*/
|
|
565
565
|
days?: number;
|
|
566
566
|
}
|
|
567
567
|
/**
|
|
568
|
-
* @public
|
|
569
568
|
* <p>Provides lifecycle details of Amazon Security Lake object.</p>
|
|
569
|
+
* @public
|
|
570
570
|
*/
|
|
571
571
|
export interface DataLakeLifecycleConfiguration {
|
|
572
572
|
/**
|
|
573
|
-
* @public
|
|
574
573
|
* <p>Provides data expiration details of Amazon Security Lake object.</p>
|
|
574
|
+
* @public
|
|
575
575
|
*/
|
|
576
576
|
expiration?: DataLakeLifecycleExpiration;
|
|
577
577
|
/**
|
|
578
|
-
* @public
|
|
579
578
|
* <p>Provides data storage transition details of Amazon Security Lake object.</p>
|
|
579
|
+
* @public
|
|
580
580
|
*/
|
|
581
581
|
transitions?: DataLakeLifecycleTransition[];
|
|
582
582
|
}
|
|
583
583
|
/**
|
|
584
|
-
* @public
|
|
585
584
|
* <p>Provides replication details for objects stored in the Amazon Security Lake data lake.</p>
|
|
585
|
+
* @public
|
|
586
586
|
*/
|
|
587
587
|
export interface DataLakeReplicationConfiguration {
|
|
588
588
|
/**
|
|
589
|
-
* @public
|
|
590
589
|
* <p>Specifies one or more centralized rollup Regions. The Amazon Web Services Region specified in the <code>region</code>
|
|
591
590
|
* parameter of the <a href="https://docs.aws.amazon.com/security-lake/latest/APIReference/API_CreateDataLake.html">
|
|
592
591
|
* <code>CreateDataLake</code>
|
|
@@ -600,43 +599,43 @@ export interface DataLakeReplicationConfiguration {
|
|
|
600
599
|
* by the same Amazon Web Services account or by different accounts. You can replicate objects
|
|
601
600
|
* to a single destination bucket or to multiple destination buckets. The destination buckets
|
|
602
601
|
* can be in different Regions or within the same Region as the source bucket.</p>
|
|
602
|
+
* @public
|
|
603
603
|
*/
|
|
604
604
|
regions?: string[];
|
|
605
605
|
/**
|
|
606
|
-
* @public
|
|
607
606
|
* <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
|
|
608
607
|
* ensure the replication setting is correct.</p>
|
|
608
|
+
* @public
|
|
609
609
|
*/
|
|
610
610
|
roleArn?: string;
|
|
611
611
|
}
|
|
612
612
|
/**
|
|
613
|
-
* @public
|
|
614
613
|
* <p>Provides details of Amazon Security Lake object.</p>
|
|
614
|
+
* @public
|
|
615
615
|
*/
|
|
616
616
|
export interface DataLakeConfiguration {
|
|
617
617
|
/**
|
|
618
|
-
* @public
|
|
619
618
|
* <p>The Amazon Web Services Regions where Security Lake is automatically enabled.</p>
|
|
619
|
+
* @public
|
|
620
620
|
*/
|
|
621
621
|
region: string | undefined;
|
|
622
622
|
/**
|
|
623
|
-
* @public
|
|
624
623
|
* <p>Provides encryption details of Amazon Security Lake object.</p>
|
|
624
|
+
* @public
|
|
625
625
|
*/
|
|
626
626
|
encryptionConfiguration?: DataLakeEncryptionConfiguration;
|
|
627
627
|
/**
|
|
628
|
-
* @public
|
|
629
628
|
* <p>Provides lifecycle details of Amazon Security Lake object.</p>
|
|
629
|
+
* @public
|
|
630
630
|
*/
|
|
631
631
|
lifecycleConfiguration?: DataLakeLifecycleConfiguration;
|
|
632
632
|
/**
|
|
633
|
-
* @public
|
|
634
633
|
* <p>Provides replication details of Amazon Security Lake object.</p>
|
|
634
|
+
* @public
|
|
635
635
|
*/
|
|
636
636
|
replicationConfiguration?: DataLakeReplicationConfiguration;
|
|
637
637
|
}
|
|
638
638
|
/**
|
|
639
|
-
* @public
|
|
640
639
|
* <p>A <i>tag</i> is a label that you can define and associate with Amazon Web Services resources, including certain types of Amazon Security Lake resources.
|
|
641
640
|
* Tags can help you identify, categorize, and manage resources in different ways, such as by owner, environment, or other criteria. You can associate tags with
|
|
642
641
|
* the following types of Security Lake resources: subscribers, and the data lake configuration for your Amazon Web Services account in individual Amazon Web Services Regions.</p>
|
|
@@ -646,17 +645,18 @@ export interface DataLakeConfiguration {
|
|
|
646
645
|
* or the following symbols: _ . : / = + @ -</p>
|
|
647
646
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/security-lake/latest/userguide/tagging-resources.html">Tagging Amazon Security Lake resources</a> in
|
|
648
647
|
* the <i>Amazon Security Lake User Guide</i>.</p>
|
|
648
|
+
* @public
|
|
649
649
|
*/
|
|
650
650
|
export interface Tag {
|
|
651
651
|
/**
|
|
652
|
-
* @public
|
|
653
652
|
* <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>
|
|
653
|
+
* @public
|
|
654
654
|
*/
|
|
655
655
|
key: string | undefined;
|
|
656
656
|
/**
|
|
657
|
-
* @public
|
|
658
657
|
* <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
|
|
659
658
|
* null, but it can be an empty string.</p>
|
|
659
|
+
* @public
|
|
660
660
|
*/
|
|
661
661
|
value: string | undefined;
|
|
662
662
|
}
|
|
@@ -665,21 +665,21 @@ export interface Tag {
|
|
|
665
665
|
*/
|
|
666
666
|
export interface CreateDataLakeRequest {
|
|
667
667
|
/**
|
|
668
|
-
* @public
|
|
669
668
|
* <p>Specify the Region or Regions that will contribute data to the rollup region.</p>
|
|
669
|
+
* @public
|
|
670
670
|
*/
|
|
671
671
|
configurations: DataLakeConfiguration[] | undefined;
|
|
672
672
|
/**
|
|
673
|
-
* @public
|
|
674
673
|
* <p>The Amazon Resource Name (ARN) used to create and update the Glue table.
|
|
675
674
|
* This table contains partitions generated by the ingestion and normalization of
|
|
676
675
|
* Amazon Web Services log sources and custom sources.</p>
|
|
676
|
+
* @public
|
|
677
677
|
*/
|
|
678
678
|
metaStoreManagerRoleArn: string | undefined;
|
|
679
679
|
/**
|
|
680
|
-
* @public
|
|
681
680
|
* <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
|
|
682
681
|
* value cannot be null, but it can be an empty string.</p>
|
|
682
|
+
* @public
|
|
683
683
|
*/
|
|
684
684
|
tags?: Tag[];
|
|
685
685
|
}
|
|
@@ -698,94 +698,94 @@ export declare const DataLakeStatus: {
|
|
|
698
698
|
*/
|
|
699
699
|
export type DataLakeStatus = (typeof DataLakeStatus)[keyof typeof DataLakeStatus];
|
|
700
700
|
/**
|
|
701
|
-
* @public
|
|
702
701
|
* <p>The details of the last <code>UpdateDataLake</code> or <code>DeleteDataLake</code>
|
|
703
702
|
* API request which failed.</p>
|
|
703
|
+
* @public
|
|
704
704
|
*/
|
|
705
705
|
export interface DataLakeUpdateException {
|
|
706
706
|
/**
|
|
707
|
-
* @public
|
|
708
707
|
* <p>The reason for the exception of the last <code>UpdateDataLake</code>or
|
|
709
708
|
* <code>DeleteDataLake</code> API request.</p>
|
|
709
|
+
* @public
|
|
710
710
|
*/
|
|
711
711
|
reason?: string;
|
|
712
712
|
/**
|
|
713
|
-
* @public
|
|
714
713
|
* <p>The reason code for the exception of the last <code>UpdateDataLake</code> or
|
|
715
714
|
* <code>DeleteDataLake</code> API request.</p>
|
|
715
|
+
* @public
|
|
716
716
|
*/
|
|
717
717
|
code?: string;
|
|
718
718
|
}
|
|
719
719
|
/**
|
|
720
|
-
* @public
|
|
721
720
|
* <p>The status of the last <code>UpdateDataLake</code> or <code>DeleteDataLake</code> API
|
|
722
721
|
* request. This is set to Completed after the configuration is updated, or removed if
|
|
723
722
|
* deletion of the data lake is successful.</p>
|
|
723
|
+
* @public
|
|
724
724
|
*/
|
|
725
725
|
export interface DataLakeUpdateStatus {
|
|
726
726
|
/**
|
|
727
|
-
* @public
|
|
728
727
|
* <p>The unique ID for the last <code>UpdateDataLake</code> or <code>DeleteDataLake</code> API
|
|
729
728
|
* request.</p>
|
|
729
|
+
* @public
|
|
730
730
|
*/
|
|
731
731
|
requestId?: string;
|
|
732
732
|
/**
|
|
733
|
-
* @public
|
|
734
733
|
* <p>The status of the last <code>UpdateDataLake</code> or <code>DeleteDataLake</code> API
|
|
735
734
|
* request that was requested.</p>
|
|
735
|
+
* @public
|
|
736
736
|
*/
|
|
737
737
|
status?: DataLakeStatus;
|
|
738
738
|
/**
|
|
739
|
-
* @public
|
|
740
739
|
* <p>The details of the last <code>UpdateDataLake</code>or <code>DeleteDataLake</code> API
|
|
741
740
|
* request which failed.</p>
|
|
741
|
+
* @public
|
|
742
742
|
*/
|
|
743
743
|
exception?: DataLakeUpdateException;
|
|
744
744
|
}
|
|
745
745
|
/**
|
|
746
|
-
* @public
|
|
747
746
|
* <p>Provides details of Amazon Security Lake object.</p>
|
|
747
|
+
* @public
|
|
748
748
|
*/
|
|
749
749
|
export interface DataLakeResource {
|
|
750
750
|
/**
|
|
751
|
-
* @public
|
|
752
751
|
* <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>
|
|
752
|
+
* @public
|
|
753
753
|
*/
|
|
754
754
|
dataLakeArn: string | undefined;
|
|
755
755
|
/**
|
|
756
|
-
* @public
|
|
757
756
|
* <p>The Amazon Web Services Regions where Security Lake is enabled.</p>
|
|
757
|
+
* @public
|
|
758
758
|
*/
|
|
759
759
|
region: string | undefined;
|
|
760
760
|
/**
|
|
761
|
-
* @public
|
|
762
761
|
* <p>The ARN for the Amazon Security Lake Amazon S3 bucket.</p>
|
|
762
|
+
* @public
|
|
763
763
|
*/
|
|
764
764
|
s3BucketArn?: string;
|
|
765
765
|
/**
|
|
766
|
-
* @public
|
|
767
766
|
* <p>Provides encryption details of Amazon Security Lake object.</p>
|
|
767
|
+
* @public
|
|
768
768
|
*/
|
|
769
769
|
encryptionConfiguration?: DataLakeEncryptionConfiguration;
|
|
770
770
|
/**
|
|
771
|
-
* @public
|
|
772
771
|
* <p>Provides lifecycle details of Amazon Security Lake object.</p>
|
|
772
|
+
* @public
|
|
773
773
|
*/
|
|
774
774
|
lifecycleConfiguration?: DataLakeLifecycleConfiguration;
|
|
775
775
|
/**
|
|
776
|
-
* @public
|
|
777
776
|
* <p>Provides replication details of Amazon Security Lake object.</p>
|
|
777
|
+
* @public
|
|
778
778
|
*/
|
|
779
779
|
replicationConfiguration?: DataLakeReplicationConfiguration;
|
|
780
780
|
/**
|
|
781
|
-
* @public
|
|
782
781
|
* <p>Retrieves the status of the configuration operation for an account in Amazon Security Lake.</p>
|
|
782
|
+
* @public
|
|
783
783
|
*/
|
|
784
784
|
createStatus?: DataLakeStatus;
|
|
785
785
|
/**
|
|
786
|
-
* @public
|
|
787
786
|
* <p>The status of the last <code>UpdateDataLake </code>or <code>DeleteDataLake</code> API
|
|
788
787
|
* request.</p>
|
|
788
|
+
* @public
|
|
789
789
|
*/
|
|
790
790
|
updateStatus?: DataLakeUpdateStatus;
|
|
791
791
|
}
|
|
@@ -794,8 +794,8 @@ export interface DataLakeResource {
|
|
|
794
794
|
*/
|
|
795
795
|
export interface CreateDataLakeResponse {
|
|
796
796
|
/**
|
|
797
|
-
* @public
|
|
798
797
|
* <p>The created Security Lake configuration object.</p>
|
|
798
|
+
* @public
|
|
799
799
|
*/
|
|
800
800
|
dataLakes?: DataLakeResource[];
|
|
801
801
|
}
|
|
@@ -804,18 +804,18 @@ export interface CreateDataLakeResponse {
|
|
|
804
804
|
*/
|
|
805
805
|
export interface CreateDataLakeExceptionSubscriptionRequest {
|
|
806
806
|
/**
|
|
807
|
-
* @public
|
|
808
807
|
* <p>The subscription protocol to which exception notifications are posted.</p>
|
|
808
|
+
* @public
|
|
809
809
|
*/
|
|
810
810
|
subscriptionProtocol: string | undefined;
|
|
811
811
|
/**
|
|
812
|
-
* @public
|
|
813
812
|
* <p>The Amazon Web Services account where you want to receive exception notifications.</p>
|
|
813
|
+
* @public
|
|
814
814
|
*/
|
|
815
815
|
notificationEndpoint: string | undefined;
|
|
816
816
|
/**
|
|
817
|
-
* @public
|
|
818
817
|
* <p>The expiration period and time-to-live (TTL).</p>
|
|
818
|
+
* @public
|
|
819
819
|
*/
|
|
820
820
|
exceptionTimeToLive?: number;
|
|
821
821
|
}
|
|
@@ -825,19 +825,19 @@ export interface CreateDataLakeExceptionSubscriptionRequest {
|
|
|
825
825
|
export interface CreateDataLakeExceptionSubscriptionResponse {
|
|
826
826
|
}
|
|
827
827
|
/**
|
|
828
|
-
* @public
|
|
829
828
|
* <p>Automatically enable new organization accounts as member accounts from an Amazon Security Lake
|
|
830
829
|
* administrator account.</p>
|
|
830
|
+
* @public
|
|
831
831
|
*/
|
|
832
832
|
export interface DataLakeAutoEnableNewAccountConfiguration {
|
|
833
833
|
/**
|
|
834
|
-
* @public
|
|
835
834
|
* <p>The Amazon Web Services Regions where Security Lake is automatically enabled.</p>
|
|
835
|
+
* @public
|
|
836
836
|
*/
|
|
837
837
|
region: string | undefined;
|
|
838
838
|
/**
|
|
839
|
-
* @public
|
|
840
839
|
* <p>The Amazon Web Services sources that are automatically enabled in Security Lake.</p>
|
|
840
|
+
* @public
|
|
841
841
|
*/
|
|
842
842
|
sources: AwsLogSourceResource[] | undefined;
|
|
843
843
|
}
|
|
@@ -846,9 +846,9 @@ export interface DataLakeAutoEnableNewAccountConfiguration {
|
|
|
846
846
|
*/
|
|
847
847
|
export interface CreateDataLakeOrganizationConfigurationRequest {
|
|
848
848
|
/**
|
|
849
|
-
* @public
|
|
850
849
|
* <p>Enable Security Lake with the specified configuration settings, to begin collecting security
|
|
851
850
|
* data for new accounts in your organization.</p>
|
|
851
|
+
* @public
|
|
852
852
|
*/
|
|
853
853
|
autoEnableNewAccount?: DataLakeAutoEnableNewAccountConfiguration[];
|
|
854
854
|
}
|
|
@@ -858,9 +858,9 @@ export interface CreateDataLakeOrganizationConfigurationRequest {
|
|
|
858
858
|
export interface CreateDataLakeOrganizationConfigurationResponse {
|
|
859
859
|
}
|
|
860
860
|
/**
|
|
861
|
-
* @public
|
|
862
861
|
* <p>The supported source types from which logs and events are collected in Amazon Security Lake.
|
|
863
862
|
* For a 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>
|
|
863
|
+
* @public
|
|
864
864
|
*/
|
|
865
865
|
export type LogSourceResource = LogSourceResource.AwsLogSourceMember | LogSourceResource.CustomLogSourceMember | LogSourceResource.$UnknownMember;
|
|
866
866
|
/**
|
|
@@ -868,8 +868,8 @@ export type LogSourceResource = LogSourceResource.AwsLogSourceMember | LogSource
|
|
|
868
868
|
*/
|
|
869
869
|
export declare namespace LogSourceResource {
|
|
870
870
|
/**
|
|
871
|
-
* @public
|
|
872
871
|
* <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>
|
|
872
|
+
* @public
|
|
873
873
|
*/
|
|
874
874
|
interface AwsLogSourceMember {
|
|
875
875
|
awsLogSource: AwsLogSourceResource;
|
|
@@ -877,8 +877,8 @@ export declare namespace LogSourceResource {
|
|
|
877
877
|
$unknown?: never;
|
|
878
878
|
}
|
|
879
879
|
/**
|
|
880
|
-
* @public
|
|
881
880
|
* <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>
|
|
881
|
+
* @public
|
|
882
882
|
*/
|
|
883
883
|
interface CustomLogSourceMember {
|
|
884
884
|
awsLogSource?: never;
|
|
@@ -905,35 +905,35 @@ export declare namespace LogSourceResource {
|
|
|
905
905
|
*/
|
|
906
906
|
export interface CreateSubscriberRequest {
|
|
907
907
|
/**
|
|
908
|
-
* @public
|
|
909
908
|
* <p>The AWS identity used to access your data.</p>
|
|
909
|
+
* @public
|
|
910
910
|
*/
|
|
911
911
|
subscriberIdentity: AwsIdentity | undefined;
|
|
912
912
|
/**
|
|
913
|
-
* @public
|
|
914
913
|
* <p>The name of your Security Lake subscriber account.</p>
|
|
914
|
+
* @public
|
|
915
915
|
*/
|
|
916
916
|
subscriberName: string | undefined;
|
|
917
917
|
/**
|
|
918
|
-
* @public
|
|
919
918
|
* <p>The description for your subscriber account in Security Lake.</p>
|
|
919
|
+
* @public
|
|
920
920
|
*/
|
|
921
921
|
subscriberDescription?: string;
|
|
922
922
|
/**
|
|
923
|
-
* @public
|
|
924
923
|
* <p>The supported Amazon Web Services from which logs and events are collected.
|
|
925
924
|
* Security Lake supports log and event collection for natively supported Amazon Web Services.</p>
|
|
925
|
+
* @public
|
|
926
926
|
*/
|
|
927
927
|
sources: LogSourceResource[] | undefined;
|
|
928
928
|
/**
|
|
929
|
-
* @public
|
|
930
929
|
* <p>The Amazon S3 or Lake Formation access type.</p>
|
|
930
|
+
* @public
|
|
931
931
|
*/
|
|
932
932
|
accessTypes?: AccessType[];
|
|
933
933
|
/**
|
|
934
|
-
* @public
|
|
935
934
|
* <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
|
|
936
935
|
* value cannot be null, but it can be an empty string.</p>
|
|
936
|
+
* @public
|
|
937
937
|
*/
|
|
938
938
|
tags?: Tag[];
|
|
939
939
|
}
|
|
@@ -952,95 +952,95 @@ export declare const SubscriberStatus: {
|
|
|
952
952
|
*/
|
|
953
953
|
export type SubscriberStatus = (typeof SubscriberStatus)[keyof typeof SubscriberStatus];
|
|
954
954
|
/**
|
|
955
|
-
* @public
|
|
956
955
|
* <p>Provides details about the Amazon Security Lake account subscription. Subscribers are notified
|
|
957
956
|
* of new objects for a source as the data is written to your Amazon S3 bucket for
|
|
958
957
|
* Security Lake.</p>
|
|
958
|
+
* @public
|
|
959
959
|
*/
|
|
960
960
|
export interface SubscriberResource {
|
|
961
961
|
/**
|
|
962
|
-
* @public
|
|
963
962
|
* <p>The subscriber ID of the Amazon Security Lake subscriber account.</p>
|
|
963
|
+
* @public
|
|
964
964
|
*/
|
|
965
965
|
subscriberId: string | undefined;
|
|
966
966
|
/**
|
|
967
|
-
* @public
|
|
968
967
|
* <p>The subscriber ARN of the Amazon Security Lake subscriber account.</p>
|
|
968
|
+
* @public
|
|
969
969
|
*/
|
|
970
970
|
subscriberArn: string | undefined;
|
|
971
971
|
/**
|
|
972
|
-
* @public
|
|
973
972
|
* <p>The AWS identity used to access your data.</p>
|
|
973
|
+
* @public
|
|
974
974
|
*/
|
|
975
975
|
subscriberIdentity: AwsIdentity | undefined;
|
|
976
976
|
/**
|
|
977
|
-
* @public
|
|
978
977
|
* <p>The name of your Amazon Security Lake subscriber account.</p>
|
|
978
|
+
* @public
|
|
979
979
|
*/
|
|
980
980
|
subscriberName: string | undefined;
|
|
981
981
|
/**
|
|
982
|
-
* @public
|
|
983
982
|
* <p>The subscriber descriptions for a subscriber account. The description for a subscriber
|
|
984
983
|
* includes <code>subscriberName</code>, <code>accountID</code>, <code>externalID</code>, and
|
|
985
984
|
* <code>subscriberId</code>.</p>
|
|
985
|
+
* @public
|
|
986
986
|
*/
|
|
987
987
|
subscriberDescription?: string;
|
|
988
988
|
/**
|
|
989
|
-
* @public
|
|
990
989
|
* <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>
|
|
990
|
+
* @public
|
|
991
991
|
*/
|
|
992
992
|
sources: LogSourceResource[] | undefined;
|
|
993
993
|
/**
|
|
994
|
-
* @public
|
|
995
994
|
* <p>You can choose to notify subscribers of new objects with an Amazon Simple Queue Service
|
|
996
995
|
* (Amazon SQS) queue or through messaging to an HTTPS endpoint provided by the
|
|
997
996
|
* subscriber.</p>
|
|
998
997
|
* <p> Subscribers can consume data by directly querying Lake Formation tables in your
|
|
999
998
|
* Amazon S3 bucket through services like Amazon Athena. This subscription
|
|
1000
999
|
* type is defined as <code>LAKEFORMATION</code>.</p>
|
|
1000
|
+
* @public
|
|
1001
1001
|
*/
|
|
1002
1002
|
accessTypes?: AccessType[];
|
|
1003
1003
|
/**
|
|
1004
|
-
* @public
|
|
1005
1004
|
* <p>The Amazon Resource Name (ARN) specifying the role of the subscriber.</p>
|
|
1005
|
+
* @public
|
|
1006
1006
|
*/
|
|
1007
1007
|
roleArn?: string;
|
|
1008
1008
|
/**
|
|
1009
|
-
* @public
|
|
1010
1009
|
* <p>The ARN for the Amazon S3 bucket.</p>
|
|
1010
|
+
* @public
|
|
1011
1011
|
*/
|
|
1012
1012
|
s3BucketArn?: string;
|
|
1013
1013
|
/**
|
|
1014
|
-
* @public
|
|
1015
1014
|
* <p>The subscriber endpoint to which exception messages are posted.</p>
|
|
1015
|
+
* @public
|
|
1016
1016
|
*/
|
|
1017
1017
|
subscriberEndpoint?: string;
|
|
1018
1018
|
/**
|
|
1019
|
-
* @public
|
|
1020
1019
|
* <p>The subscriber status of the Amazon Security Lake subscriber account.</p>
|
|
1020
|
+
* @public
|
|
1021
1021
|
*/
|
|
1022
1022
|
subscriberStatus?: SubscriberStatus;
|
|
1023
1023
|
/**
|
|
1024
|
-
* @public
|
|
1025
1024
|
* <p>The Amazon Resource Name (ARN) which uniquely defines the AWS RAM resource share. Before
|
|
1026
1025
|
* accepting the RAM resource share invitation, you can view details related to the RAM
|
|
1027
1026
|
* resource share.</p>
|
|
1028
1027
|
* <p>This field is available only for Lake Formation subscribers created after March 8, 2023.</p>
|
|
1028
|
+
* @public
|
|
1029
1029
|
*/
|
|
1030
1030
|
resourceShareArn?: string;
|
|
1031
1031
|
/**
|
|
1032
|
-
* @public
|
|
1033
1032
|
* <p>The name of the resource share.</p>
|
|
1033
|
+
* @public
|
|
1034
1034
|
*/
|
|
1035
1035
|
resourceShareName?: string;
|
|
1036
1036
|
/**
|
|
1037
|
-
* @public
|
|
1038
1037
|
* <p>The date and time when the subscriber was created.</p>
|
|
1038
|
+
* @public
|
|
1039
1039
|
*/
|
|
1040
1040
|
createdAt?: Date;
|
|
1041
1041
|
/**
|
|
1042
|
-
* @public
|
|
1043
1042
|
* <p>The date and time when the subscriber was last updated.</p>
|
|
1043
|
+
* @public
|
|
1044
1044
|
*/
|
|
1045
1045
|
updatedAt?: Date;
|
|
1046
1046
|
}
|
|
@@ -1049,9 +1049,9 @@ export interface SubscriberResource {
|
|
|
1049
1049
|
*/
|
|
1050
1050
|
export interface CreateSubscriberResponse {
|
|
1051
1051
|
/**
|
|
1052
|
-
* @public
|
|
1053
1052
|
* <p>Retrieve information about the subscriber created using the
|
|
1054
1053
|
* <code>CreateSubscriber</code> API.</p>
|
|
1054
|
+
* @public
|
|
1055
1055
|
*/
|
|
1056
1056
|
subscriber?: SubscriberResource;
|
|
1057
1057
|
}
|
|
@@ -1068,50 +1068,50 @@ export declare const HttpMethod: {
|
|
|
1068
1068
|
*/
|
|
1069
1069
|
export type HttpMethod = (typeof HttpMethod)[keyof typeof HttpMethod];
|
|
1070
1070
|
/**
|
|
1071
|
-
* @public
|
|
1072
1071
|
* <p>The configurations for HTTPS subscriber notification.</p>
|
|
1072
|
+
* @public
|
|
1073
1073
|
*/
|
|
1074
1074
|
export interface HttpsNotificationConfiguration {
|
|
1075
1075
|
/**
|
|
1076
|
-
* @public
|
|
1077
1076
|
* <p>The subscription endpoint in Security Lake. If you prefer notification with an HTTPs
|
|
1078
1077
|
* endpoint, populate this field.</p>
|
|
1078
|
+
* @public
|
|
1079
1079
|
*/
|
|
1080
1080
|
endpoint: string | undefined;
|
|
1081
1081
|
/**
|
|
1082
|
-
* @public
|
|
1083
1082
|
* <p>The key name for the notification subscription.</p>
|
|
1083
|
+
* @public
|
|
1084
1084
|
*/
|
|
1085
1085
|
authorizationApiKeyName?: string;
|
|
1086
1086
|
/**
|
|
1087
|
-
* @public
|
|
1088
1087
|
* <p>The key value for the notification subscription.</p>
|
|
1088
|
+
* @public
|
|
1089
1089
|
*/
|
|
1090
1090
|
authorizationApiKeyValue?: string;
|
|
1091
1091
|
/**
|
|
1092
|
-
* @public
|
|
1093
1092
|
* <p>The HTTPS method used for the notification subscription.</p>
|
|
1093
|
+
* @public
|
|
1094
1094
|
*/
|
|
1095
1095
|
httpMethod?: HttpMethod;
|
|
1096
1096
|
/**
|
|
1097
|
-
* @public
|
|
1098
1097
|
* <p>The Amazon Resource Name (ARN) of the EventBridge API destinations IAM role that you
|
|
1099
1098
|
* 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
|
|
1100
1099
|
* Managed Policies</a> in the <i>Amazon Security Lake User Guide</i>.</p>
|
|
1100
|
+
* @public
|
|
1101
1101
|
*/
|
|
1102
1102
|
targetRoleArn: string | undefined;
|
|
1103
1103
|
}
|
|
1104
1104
|
/**
|
|
1105
|
-
* @public
|
|
1106
1105
|
* <p>The configurations for SQS subscriber notification.</p>
|
|
1106
|
+
* @public
|
|
1107
1107
|
*/
|
|
1108
1108
|
export interface SqsNotificationConfiguration {
|
|
1109
1109
|
}
|
|
1110
1110
|
/**
|
|
1111
|
-
* @public
|
|
1112
1111
|
* <p>Specify the configurations you want to use for subscriber notification to notify the
|
|
1113
1112
|
* subscriber when new data is written to the data lake for sources that the subscriber
|
|
1114
1113
|
* consumes in Security Lake. </p>
|
|
1114
|
+
* @public
|
|
1115
1115
|
*/
|
|
1116
1116
|
export type NotificationConfiguration = NotificationConfiguration.HttpsNotificationConfigurationMember | NotificationConfiguration.SqsNotificationConfigurationMember | NotificationConfiguration.$UnknownMember;
|
|
1117
1117
|
/**
|
|
@@ -1119,8 +1119,8 @@ export type NotificationConfiguration = NotificationConfiguration.HttpsNotificat
|
|
|
1119
1119
|
*/
|
|
1120
1120
|
export declare namespace NotificationConfiguration {
|
|
1121
1121
|
/**
|
|
1122
|
-
* @public
|
|
1123
1122
|
* <p>The configurations for SQS subscriber notification.</p>
|
|
1123
|
+
* @public
|
|
1124
1124
|
*/
|
|
1125
1125
|
interface SqsNotificationConfigurationMember {
|
|
1126
1126
|
sqsNotificationConfiguration: SqsNotificationConfiguration;
|
|
@@ -1128,8 +1128,8 @@ export declare namespace NotificationConfiguration {
|
|
|
1128
1128
|
$unknown?: never;
|
|
1129
1129
|
}
|
|
1130
1130
|
/**
|
|
1131
|
-
* @public
|
|
1132
1131
|
* <p>The configurations for HTTPS subscriber notification.</p>
|
|
1132
|
+
* @public
|
|
1133
1133
|
*/
|
|
1134
1134
|
interface HttpsNotificationConfigurationMember {
|
|
1135
1135
|
sqsNotificationConfiguration?: never;
|
|
@@ -1156,14 +1156,14 @@ export declare namespace NotificationConfiguration {
|
|
|
1156
1156
|
*/
|
|
1157
1157
|
export interface CreateSubscriberNotificationRequest {
|
|
1158
1158
|
/**
|
|
1159
|
-
* @public
|
|
1160
1159
|
* <p>The subscriber ID for the notification subscription.</p>
|
|
1160
|
+
* @public
|
|
1161
1161
|
*/
|
|
1162
1162
|
subscriberId: string | undefined;
|
|
1163
1163
|
/**
|
|
1164
|
-
* @public
|
|
1165
1164
|
* <p>Specify the configuration using which you want to create the subscriber
|
|
1166
1165
|
* notification.</p>
|
|
1166
|
+
* @public
|
|
1167
1167
|
*/
|
|
1168
1168
|
configuration: NotificationConfiguration | undefined;
|
|
1169
1169
|
}
|
|
@@ -1172,8 +1172,8 @@ export interface CreateSubscriberNotificationRequest {
|
|
|
1172
1172
|
*/
|
|
1173
1173
|
export interface CreateSubscriberNotificationResponse {
|
|
1174
1174
|
/**
|
|
1175
|
-
* @public
|
|
1176
1175
|
* <p>The subscriber endpoint to which exception messages are posted.</p>
|
|
1176
|
+
* @public
|
|
1177
1177
|
*/
|
|
1178
1178
|
subscriberEndpoint?: string;
|
|
1179
1179
|
}
|
|
@@ -1182,9 +1182,9 @@ export interface CreateSubscriberNotificationResponse {
|
|
|
1182
1182
|
*/
|
|
1183
1183
|
export interface DeleteAwsLogSourceRequest {
|
|
1184
1184
|
/**
|
|
1185
|
-
* @public
|
|
1186
1185
|
* <p>Specify the natively-supported Amazon Web Services service to remove as a source in
|
|
1187
1186
|
* Security Lake.</p>
|
|
1187
|
+
* @public
|
|
1188
1188
|
*/
|
|
1189
1189
|
sources: AwsLogSourceConfiguration[] | undefined;
|
|
1190
1190
|
}
|
|
@@ -1193,8 +1193,8 @@ export interface DeleteAwsLogSourceRequest {
|
|
|
1193
1193
|
*/
|
|
1194
1194
|
export interface DeleteAwsLogSourceResponse {
|
|
1195
1195
|
/**
|
|
1196
|
-
* @public
|
|
1197
1196
|
* <p>Deletion of the Amazon Web Services sources failed as the account is not a part of the organization.</p>
|
|
1197
|
+
* @public
|
|
1198
1198
|
*/
|
|
1199
1199
|
failed?: string[];
|
|
1200
1200
|
}
|
|
@@ -1203,14 +1203,14 @@ export interface DeleteAwsLogSourceResponse {
|
|
|
1203
1203
|
*/
|
|
1204
1204
|
export interface DeleteCustomLogSourceRequest {
|
|
1205
1205
|
/**
|
|
1206
|
-
* @public
|
|
1207
1206
|
* <p>The source name of custom log source that you want to delete.</p>
|
|
1207
|
+
* @public
|
|
1208
1208
|
*/
|
|
1209
1209
|
sourceName: string | undefined;
|
|
1210
1210
|
/**
|
|
1211
|
-
* @public
|
|
1212
1211
|
* <p>The source version for the third-party custom source. You can limit the custom source
|
|
1213
1212
|
* removal to the specified source version.</p>
|
|
1213
|
+
* @public
|
|
1214
1214
|
*/
|
|
1215
1215
|
sourceVersion?: string;
|
|
1216
1216
|
}
|
|
@@ -1224,8 +1224,8 @@ export interface DeleteCustomLogSourceResponse {
|
|
|
1224
1224
|
*/
|
|
1225
1225
|
export interface DeleteDataLakeRequest {
|
|
1226
1226
|
/**
|
|
1227
|
-
* @public
|
|
1228
1227
|
* <p>The list of Regions where Security Lake is enabled.</p>
|
|
1228
|
+
* @public
|
|
1229
1229
|
*/
|
|
1230
1230
|
regions: string[] | undefined;
|
|
1231
1231
|
}
|
|
@@ -1239,8 +1239,8 @@ export interface DeleteDataLakeResponse {
|
|
|
1239
1239
|
*/
|
|
1240
1240
|
export interface DeleteDataLakeOrganizationConfigurationRequest {
|
|
1241
1241
|
/**
|
|
1242
|
-
* @public
|
|
1243
1242
|
* <p>Turns off automatic enablement of Security Lake for member accounts that are added to an organization.</p>
|
|
1243
|
+
* @public
|
|
1244
1244
|
*/
|
|
1245
1245
|
autoEnableNewAccount?: DataLakeAutoEnableNewAccountConfiguration[];
|
|
1246
1246
|
}
|
|
@@ -1259,8 +1259,8 @@ export interface GetDataLakeOrganizationConfigurationRequest {
|
|
|
1259
1259
|
*/
|
|
1260
1260
|
export interface GetDataLakeOrganizationConfigurationResponse {
|
|
1261
1261
|
/**
|
|
1262
|
-
* @public
|
|
1263
1262
|
* <p>The configuration for new accounts.</p>
|
|
1263
|
+
* @public
|
|
1264
1264
|
*/
|
|
1265
1265
|
autoEnableNewAccount?: DataLakeAutoEnableNewAccountConfiguration[];
|
|
1266
1266
|
}
|
|
@@ -1269,23 +1269,23 @@ export interface GetDataLakeOrganizationConfigurationResponse {
|
|
|
1269
1269
|
*/
|
|
1270
1270
|
export interface GetDataLakeSourcesRequest {
|
|
1271
1271
|
/**
|
|
1272
|
-
* @public
|
|
1273
1272
|
* <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>
|
|
1273
|
+
* @public
|
|
1274
1274
|
*/
|
|
1275
1275
|
accounts?: string[];
|
|
1276
1276
|
/**
|
|
1277
|
-
* @public
|
|
1278
1277
|
* <p>The maximum limit of accounts for which the static snapshot of the current Region,
|
|
1279
1278
|
* including enabled accounts and log sources, is retrieved.</p>
|
|
1279
|
+
* @public
|
|
1280
1280
|
*/
|
|
1281
1281
|
maxResults?: number;
|
|
1282
1282
|
/**
|
|
1283
|
-
* @public
|
|
1284
1283
|
* <p>Lists if there are more results available. The value of nextToken is a unique pagination
|
|
1285
1284
|
* token for each page. Repeat the call using the returned token to retrieve the next page.
|
|
1286
1285
|
* Keep all other arguments unchanged.</p>
|
|
1287
1286
|
* <p>Each pagination token expires after 24 hours. Using an expired pagination token will
|
|
1288
1287
|
* return an HTTP 400 InvalidToken error.</p>
|
|
1288
|
+
* @public
|
|
1289
1289
|
*/
|
|
1290
1290
|
nextToken?: string;
|
|
1291
1291
|
}
|
|
@@ -1303,41 +1303,40 @@ export declare const SourceCollectionStatus: {
|
|
|
1303
1303
|
*/
|
|
1304
1304
|
export type SourceCollectionStatus = (typeof SourceCollectionStatus)[keyof typeof SourceCollectionStatus];
|
|
1305
1305
|
/**
|
|
1306
|
-
* @public
|
|
1307
1306
|
* <p>Retrieves the Logs status for the Amazon Security Lake account.</p>
|
|
1307
|
+
* @public
|
|
1308
1308
|
*/
|
|
1309
1309
|
export interface DataLakeSourceStatus {
|
|
1310
1310
|
/**
|
|
1311
|
-
* @public
|
|
1312
1311
|
* <p>Defines path the stored logs are available which has information on your systems,
|
|
1313
1312
|
* applications, and services.</p>
|
|
1313
|
+
* @public
|
|
1314
1314
|
*/
|
|
1315
1315
|
resource?: string;
|
|
1316
1316
|
/**
|
|
1317
|
-
* @public
|
|
1318
1317
|
* <p>The health status of services, including error codes and patterns.</p>
|
|
1318
|
+
* @public
|
|
1319
1319
|
*/
|
|
1320
1320
|
status?: SourceCollectionStatus;
|
|
1321
1321
|
}
|
|
1322
1322
|
/**
|
|
1323
|
-
* @public
|
|
1324
1323
|
* <p>Amazon Security Lake collects logs and events from supported Amazon Web Services and
|
|
1325
1324
|
* 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>
|
|
1325
|
+
* @public
|
|
1326
1326
|
*/
|
|
1327
1327
|
export interface DataLakeSource {
|
|
1328
1328
|
/**
|
|
1329
|
-
* @public
|
|
1330
1329
|
* <p>The ID of the Security Lake account for which logs are collected.</p>
|
|
1330
|
+
* @public
|
|
1331
1331
|
*/
|
|
1332
1332
|
account?: string;
|
|
1333
1333
|
/**
|
|
1334
|
-
* @public
|
|
1335
1334
|
* <p>The supported Amazon Web Services from which logs and events are collected.
|
|
1336
1335
|
* Amazon Security Lake supports log and event collection for natively supported Amazon Web Services.</p>
|
|
1336
|
+
* @public
|
|
1337
1337
|
*/
|
|
1338
1338
|
sourceName?: string;
|
|
1339
1339
|
/**
|
|
1340
|
-
* @public
|
|
1341
1340
|
* <p>The Open Cybersecurity Schema Framework (OCSF) event classes which describes the type of
|
|
1342
1341
|
* data that the custom source will send to Security Lake. The supported event classes are:</p>
|
|
1343
1342
|
* <ul>
|
|
@@ -1487,11 +1486,12 @@ export interface DataLakeSource {
|
|
|
1487
1486
|
* </p>
|
|
1488
1487
|
* </li>
|
|
1489
1488
|
* </ul>
|
|
1489
|
+
* @public
|
|
1490
1490
|
*/
|
|
1491
1491
|
eventClasses?: string[];
|
|
1492
1492
|
/**
|
|
1493
|
-
* @public
|
|
1494
1493
|
* <p>The log status for the Security Lake account.</p>
|
|
1494
|
+
* @public
|
|
1495
1495
|
*/
|
|
1496
1496
|
sourceStatuses?: DataLakeSourceStatus[];
|
|
1497
1497
|
}
|
|
@@ -1500,22 +1500,22 @@ export interface DataLakeSource {
|
|
|
1500
1500
|
*/
|
|
1501
1501
|
export interface GetDataLakeSourcesResponse {
|
|
1502
1502
|
/**
|
|
1503
|
-
* @public
|
|
1504
1503
|
* <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>
|
|
1504
|
+
* @public
|
|
1505
1505
|
*/
|
|
1506
1506
|
dataLakeArn?: string;
|
|
1507
1507
|
/**
|
|
1508
|
-
* @public
|
|
1509
1508
|
* <p>The list of enabled accounts and enabled sources.</p>
|
|
1509
|
+
* @public
|
|
1510
1510
|
*/
|
|
1511
1511
|
dataLakeSources?: DataLakeSource[];
|
|
1512
1512
|
/**
|
|
1513
|
-
* @public
|
|
1514
1513
|
* <p>Lists if there are more results available. The value of nextToken is a unique pagination
|
|
1515
1514
|
* token for each page. Repeat the call using the returned token to retrieve the next page.
|
|
1516
1515
|
* Keep all other arguments unchanged.</p>
|
|
1517
1516
|
* <p>Each pagination token expires after 24 hours. Using an expired pagination token will
|
|
1518
1517
|
* return an HTTP 400 InvalidToken error.</p>
|
|
1518
|
+
* @public
|
|
1519
1519
|
*/
|
|
1520
1520
|
nextToken?: string;
|
|
1521
1521
|
}
|
|
@@ -1524,8 +1524,8 @@ export interface GetDataLakeSourcesResponse {
|
|
|
1524
1524
|
*/
|
|
1525
1525
|
export interface ListDataLakesRequest {
|
|
1526
1526
|
/**
|
|
1527
|
-
* @public
|
|
1528
1527
|
* <p>The list of Regions where Security Lake is enabled.</p>
|
|
1528
|
+
* @public
|
|
1529
1529
|
*/
|
|
1530
1530
|
regions?: string[];
|
|
1531
1531
|
}
|
|
@@ -1534,8 +1534,8 @@ export interface ListDataLakesRequest {
|
|
|
1534
1534
|
*/
|
|
1535
1535
|
export interface ListDataLakesResponse {
|
|
1536
1536
|
/**
|
|
1537
|
-
* @public
|
|
1538
1537
|
* <p>Retrieves the Security Lake configuration object.</p>
|
|
1538
|
+
* @public
|
|
1539
1539
|
*/
|
|
1540
1540
|
dataLakes?: DataLakeResource[];
|
|
1541
1541
|
}
|
|
@@ -1544,50 +1544,50 @@ export interface ListDataLakesResponse {
|
|
|
1544
1544
|
*/
|
|
1545
1545
|
export interface ListLogSourcesRequest {
|
|
1546
1546
|
/**
|
|
1547
|
-
* @public
|
|
1548
1547
|
* <p>The list of Amazon Web Services accounts for which log sources are displayed.</p>
|
|
1548
|
+
* @public
|
|
1549
1549
|
*/
|
|
1550
1550
|
accounts?: string[];
|
|
1551
1551
|
/**
|
|
1552
|
-
* @public
|
|
1553
1552
|
* <p>The list of Regions for which log sources are displayed.</p>
|
|
1553
|
+
* @public
|
|
1554
1554
|
*/
|
|
1555
1555
|
regions?: string[];
|
|
1556
1556
|
/**
|
|
1557
|
-
* @public
|
|
1558
1557
|
* <p>The list of sources for which log sources are displayed.</p>
|
|
1558
|
+
* @public
|
|
1559
1559
|
*/
|
|
1560
1560
|
sources?: LogSourceResource[];
|
|
1561
1561
|
/**
|
|
1562
|
-
* @public
|
|
1563
1562
|
* <p>The maximum number of accounts for which the log sources are displayed.</p>
|
|
1563
|
+
* @public
|
|
1564
1564
|
*/
|
|
1565
1565
|
maxResults?: number;
|
|
1566
1566
|
/**
|
|
1567
|
-
* @public
|
|
1568
1567
|
* <p>If nextToken is returned, there are more results available. You can repeat the call
|
|
1569
1568
|
* using the returned token to retrieve the next page.</p>
|
|
1569
|
+
* @public
|
|
1570
1570
|
*/
|
|
1571
1571
|
nextToken?: string;
|
|
1572
1572
|
}
|
|
1573
1573
|
/**
|
|
1574
|
-
* @public
|
|
1575
1574
|
* <p>Amazon Security Lake can collect logs and events from natively-supported Amazon Web Services services and custom sources. </p>
|
|
1575
|
+
* @public
|
|
1576
1576
|
*/
|
|
1577
1577
|
export interface LogSource {
|
|
1578
1578
|
/**
|
|
1579
|
-
* @public
|
|
1580
1579
|
* <p>Specify the account from which you want to collect logs.</p>
|
|
1580
|
+
* @public
|
|
1581
1581
|
*/
|
|
1582
1582
|
account?: string;
|
|
1583
1583
|
/**
|
|
1584
|
-
* @public
|
|
1585
1584
|
* <p>Specify the Regions from which you want to collect logs.</p>
|
|
1585
|
+
* @public
|
|
1586
1586
|
*/
|
|
1587
1587
|
region?: string;
|
|
1588
1588
|
/**
|
|
1589
|
-
* @public
|
|
1590
1589
|
* <p>Specify the sources from which you want to collect logs.</p>
|
|
1590
|
+
* @public
|
|
1591
1591
|
*/
|
|
1592
1592
|
sources?: LogSourceResource[];
|
|
1593
1593
|
}
|
|
@@ -1596,14 +1596,14 @@ export interface LogSource {
|
|
|
1596
1596
|
*/
|
|
1597
1597
|
export interface ListLogSourcesResponse {
|
|
1598
1598
|
/**
|
|
1599
|
-
* @public
|
|
1600
1599
|
* <p>The list of log sources in your organization that send data to the data lake.</p>
|
|
1600
|
+
* @public
|
|
1601
1601
|
*/
|
|
1602
1602
|
sources?: LogSource[];
|
|
1603
1603
|
/**
|
|
1604
|
-
* @public
|
|
1605
1604
|
* <p>If nextToken is returned, there are more results available. You can repeat the call
|
|
1606
1605
|
* using the returned token to retrieve the next page.</p>
|
|
1606
|
+
* @public
|
|
1607
1607
|
*/
|
|
1608
1608
|
nextToken?: string;
|
|
1609
1609
|
}
|
|
@@ -1612,15 +1612,15 @@ export interface ListLogSourcesResponse {
|
|
|
1612
1612
|
*/
|
|
1613
1613
|
export interface UpdateDataLakeRequest {
|
|
1614
1614
|
/**
|
|
1615
|
-
* @public
|
|
1616
1615
|
* <p>Specify the Region or Regions that will contribute data to the rollup region.</p>
|
|
1616
|
+
* @public
|
|
1617
1617
|
*/
|
|
1618
1618
|
configurations: DataLakeConfiguration[] | undefined;
|
|
1619
1619
|
/**
|
|
1620
|
-
* @public
|
|
1621
1620
|
* <p>The Amazon Resource Name (ARN) used to create and update the Glue table.
|
|
1622
1621
|
* This table contains partitions generated by the ingestion and normalization of
|
|
1623
1622
|
* Amazon Web Services log sources and custom sources.</p>
|
|
1623
|
+
* @public
|
|
1624
1624
|
*/
|
|
1625
1625
|
metaStoreManagerRoleArn?: string;
|
|
1626
1626
|
}
|
|
@@ -1629,34 +1629,34 @@ export interface UpdateDataLakeRequest {
|
|
|
1629
1629
|
*/
|
|
1630
1630
|
export interface UpdateDataLakeResponse {
|
|
1631
1631
|
/**
|
|
1632
|
-
* @public
|
|
1633
1632
|
* <p>The created Security Lake configuration object.</p>
|
|
1633
|
+
* @public
|
|
1634
1634
|
*/
|
|
1635
1635
|
dataLakes?: DataLakeResource[];
|
|
1636
1636
|
}
|
|
1637
1637
|
/**
|
|
1638
|
-
* @public
|
|
1639
1638
|
* <p>The details for an Amazon Security Lake exception.</p>
|
|
1639
|
+
* @public
|
|
1640
1640
|
*/
|
|
1641
1641
|
export interface DataLakeException {
|
|
1642
1642
|
/**
|
|
1643
|
-
* @public
|
|
1644
1643
|
* <p>The Amazon Web Services Regions where the exception occurred.</p>
|
|
1644
|
+
* @public
|
|
1645
1645
|
*/
|
|
1646
1646
|
region?: string;
|
|
1647
1647
|
/**
|
|
1648
|
-
* @public
|
|
1649
1648
|
* <p>The underlying exception of a Security Lake exception.</p>
|
|
1649
|
+
* @public
|
|
1650
1650
|
*/
|
|
1651
1651
|
exception?: string;
|
|
1652
1652
|
/**
|
|
1653
|
-
* @public
|
|
1654
1653
|
* <p>List of all remediation steps for a Security Lake exception.</p>
|
|
1654
|
+
* @public
|
|
1655
1655
|
*/
|
|
1656
1656
|
remediation?: string;
|
|
1657
1657
|
/**
|
|
1658
|
-
* @public
|
|
1659
1658
|
* <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>
|
|
1659
|
+
* @public
|
|
1660
1660
|
*/
|
|
1661
1661
|
timestamp?: Date;
|
|
1662
1662
|
}
|
|
@@ -1675,8 +1675,8 @@ export interface DeleteDataLakeExceptionSubscriptionResponse {
|
|
|
1675
1675
|
*/
|
|
1676
1676
|
export interface DeleteSubscriberRequest {
|
|
1677
1677
|
/**
|
|
1678
|
-
* @public
|
|
1679
1678
|
* <p>A value created by Security Lake that uniquely identifies your <code>DeleteSubscriber</code> API request.</p>
|
|
1679
|
+
* @public
|
|
1680
1680
|
*/
|
|
1681
1681
|
subscriberId: string | undefined;
|
|
1682
1682
|
}
|
|
@@ -1690,8 +1690,8 @@ export interface DeleteSubscriberResponse {
|
|
|
1690
1690
|
*/
|
|
1691
1691
|
export interface DeleteSubscriberNotificationRequest {
|
|
1692
1692
|
/**
|
|
1693
|
-
* @public
|
|
1694
1693
|
* <p>The ID of the Security Lake subscriber account.</p>
|
|
1694
|
+
* @public
|
|
1695
1695
|
*/
|
|
1696
1696
|
subscriberId: string | undefined;
|
|
1697
1697
|
}
|
|
@@ -1720,18 +1720,18 @@ export interface GetDataLakeExceptionSubscriptionRequest {
|
|
|
1720
1720
|
*/
|
|
1721
1721
|
export interface GetDataLakeExceptionSubscriptionResponse {
|
|
1722
1722
|
/**
|
|
1723
|
-
* @public
|
|
1724
1723
|
* <p>The subscription protocol to which exception notifications are posted.</p>
|
|
1724
|
+
* @public
|
|
1725
1725
|
*/
|
|
1726
1726
|
subscriptionProtocol?: string;
|
|
1727
1727
|
/**
|
|
1728
|
-
* @public
|
|
1729
1728
|
* <p>The Amazon Web Services account where you receive exception notifications.</p>
|
|
1729
|
+
* @public
|
|
1730
1730
|
*/
|
|
1731
1731
|
notificationEndpoint?: string;
|
|
1732
1732
|
/**
|
|
1733
|
-
* @public
|
|
1734
1733
|
* <p>The expiration period and time-to-live (TTL).</p>
|
|
1734
|
+
* @public
|
|
1735
1735
|
*/
|
|
1736
1736
|
exceptionTimeToLive?: number;
|
|
1737
1737
|
}
|
|
@@ -1740,9 +1740,9 @@ export interface GetDataLakeExceptionSubscriptionResponse {
|
|
|
1740
1740
|
*/
|
|
1741
1741
|
export interface GetSubscriberRequest {
|
|
1742
1742
|
/**
|
|
1743
|
-
* @public
|
|
1744
1743
|
* <p>A value created by Amazon Security Lake that uniquely identifies your
|
|
1745
1744
|
* <code>GetSubscriber</code> API request.</p>
|
|
1745
|
+
* @public
|
|
1746
1746
|
*/
|
|
1747
1747
|
subscriberId: string | undefined;
|
|
1748
1748
|
}
|
|
@@ -1751,8 +1751,8 @@ export interface GetSubscriberRequest {
|
|
|
1751
1751
|
*/
|
|
1752
1752
|
export interface GetSubscriberResponse {
|
|
1753
1753
|
/**
|
|
1754
|
-
* @public
|
|
1755
1754
|
* <p>The subscriber information for the specified subscriber ID.</p>
|
|
1755
|
+
* @public
|
|
1756
1756
|
*/
|
|
1757
1757
|
subscriber?: SubscriberResource;
|
|
1758
1758
|
}
|
|
@@ -1761,22 +1761,22 @@ export interface GetSubscriberResponse {
|
|
|
1761
1761
|
*/
|
|
1762
1762
|
export interface ListDataLakeExceptionsRequest {
|
|
1763
1763
|
/**
|
|
1764
|
-
* @public
|
|
1765
1764
|
* <p>The Amazon Web Services Regions from which exceptions are retrieved.</p>
|
|
1765
|
+
* @public
|
|
1766
1766
|
*/
|
|
1767
1767
|
regions?: string[];
|
|
1768
1768
|
/**
|
|
1769
|
-
* @public
|
|
1770
1769
|
* <p>List the maximum number of failures in Security Lake.</p>
|
|
1770
|
+
* @public
|
|
1771
1771
|
*/
|
|
1772
1772
|
maxResults?: number;
|
|
1773
1773
|
/**
|
|
1774
|
-
* @public
|
|
1775
1774
|
* <p>List if there are more results available. The value of nextToken is a unique pagination
|
|
1776
1775
|
* token for each page. Repeat the call using the returned token to retrieve the next page.
|
|
1777
1776
|
* Keep all other arguments unchanged.</p>
|
|
1778
1777
|
* <p>Each pagination token expires after 24 hours. Using an expired pagination token will
|
|
1779
1778
|
* return an HTTP 400 InvalidToken error.</p>
|
|
1779
|
+
* @public
|
|
1780
1780
|
*/
|
|
1781
1781
|
nextToken?: string;
|
|
1782
1782
|
}
|
|
@@ -1785,17 +1785,17 @@ export interface ListDataLakeExceptionsRequest {
|
|
|
1785
1785
|
*/
|
|
1786
1786
|
export interface ListDataLakeExceptionsResponse {
|
|
1787
1787
|
/**
|
|
1788
|
-
* @public
|
|
1789
1788
|
* <p>Lists the failures that cannot be retried in the current Region.</p>
|
|
1789
|
+
* @public
|
|
1790
1790
|
*/
|
|
1791
1791
|
exceptions?: DataLakeException[];
|
|
1792
1792
|
/**
|
|
1793
|
-
* @public
|
|
1794
1793
|
* <p>List if there are more results available. The value of nextToken is a unique pagination
|
|
1795
1794
|
* token for each page. Repeat the call using the returned token to retrieve the next page.
|
|
1796
1795
|
* Keep all other arguments unchanged.</p>
|
|
1797
1796
|
* <p>Each pagination token expires after 24 hours. Using an expired pagination token will
|
|
1798
1797
|
* return an HTTP 400 InvalidToken error.</p>
|
|
1798
|
+
* @public
|
|
1799
1799
|
*/
|
|
1800
1800
|
nextToken?: string;
|
|
1801
1801
|
}
|
|
@@ -1804,14 +1804,14 @@ export interface ListDataLakeExceptionsResponse {
|
|
|
1804
1804
|
*/
|
|
1805
1805
|
export interface ListSubscribersRequest {
|
|
1806
1806
|
/**
|
|
1807
|
-
* @public
|
|
1808
1807
|
* <p>If nextToken is returned, there are more results available. You can repeat the call
|
|
1809
1808
|
* using the returned token to retrieve the next page.</p>
|
|
1809
|
+
* @public
|
|
1810
1810
|
*/
|
|
1811
1811
|
nextToken?: string;
|
|
1812
1812
|
/**
|
|
1813
|
-
* @public
|
|
1814
1813
|
* <p>The maximum number of accounts for which the configuration is displayed.</p>
|
|
1814
|
+
* @public
|
|
1815
1815
|
*/
|
|
1816
1816
|
maxResults?: number;
|
|
1817
1817
|
}
|
|
@@ -1820,14 +1820,14 @@ export interface ListSubscribersRequest {
|
|
|
1820
1820
|
*/
|
|
1821
1821
|
export interface ListSubscribersResponse {
|
|
1822
1822
|
/**
|
|
1823
|
-
* @public
|
|
1824
1823
|
* <p>The subscribers available for the specified Security Lake account ID.</p>
|
|
1824
|
+
* @public
|
|
1825
1825
|
*/
|
|
1826
1826
|
subscribers?: SubscriberResource[];
|
|
1827
1827
|
/**
|
|
1828
|
-
* @public
|
|
1829
1828
|
* <p>If nextToken is returned, there are more results available. You can repeat the call
|
|
1830
1829
|
* using the returned token to retrieve the next page.</p>
|
|
1830
|
+
* @public
|
|
1831
1831
|
*/
|
|
1832
1832
|
nextToken?: string;
|
|
1833
1833
|
}
|
|
@@ -1836,8 +1836,8 @@ export interface ListSubscribersResponse {
|
|
|
1836
1836
|
*/
|
|
1837
1837
|
export interface ListTagsForResourceRequest {
|
|
1838
1838
|
/**
|
|
1839
|
-
* @public
|
|
1840
1839
|
* <p>The Amazon Resource Name (ARN) of the Amazon Security Lake resource for which you want to retrieve the tags.</p>
|
|
1840
|
+
* @public
|
|
1841
1841
|
*/
|
|
1842
1842
|
resourceArn: string | undefined;
|
|
1843
1843
|
}
|
|
@@ -1846,8 +1846,8 @@ export interface ListTagsForResourceRequest {
|
|
|
1846
1846
|
*/
|
|
1847
1847
|
export interface ListTagsForResourceResponse {
|
|
1848
1848
|
/**
|
|
1849
|
-
* @public
|
|
1850
1849
|
* <p>An array of objects, one for each tag (key and value) that’s associated with the Amazon Security Lake resource.</p>
|
|
1850
|
+
* @public
|
|
1851
1851
|
*/
|
|
1852
1852
|
tags?: Tag[];
|
|
1853
1853
|
}
|
|
@@ -1856,8 +1856,8 @@ export interface ListTagsForResourceResponse {
|
|
|
1856
1856
|
*/
|
|
1857
1857
|
export interface RegisterDataLakeDelegatedAdministratorRequest {
|
|
1858
1858
|
/**
|
|
1859
|
-
* @public
|
|
1860
1859
|
* <p>The Amazon Web Services account ID of the Security Lake delegated administrator.</p>
|
|
1860
|
+
* @public
|
|
1861
1861
|
*/
|
|
1862
1862
|
accountId: string | undefined;
|
|
1863
1863
|
}
|
|
@@ -1871,29 +1871,29 @@ export interface RegisterDataLakeDelegatedAdministratorResponse {
|
|
|
1871
1871
|
*/
|
|
1872
1872
|
export interface UpdateSubscriberRequest {
|
|
1873
1873
|
/**
|
|
1874
|
-
* @public
|
|
1875
1874
|
* <p>A value created by Security Lake that uniquely identifies your subscription.</p>
|
|
1875
|
+
* @public
|
|
1876
1876
|
*/
|
|
1877
1877
|
subscriberId: string | undefined;
|
|
1878
1878
|
/**
|
|
1879
|
-
* @public
|
|
1880
1879
|
* <p>The AWS identity used to access your data.</p>
|
|
1880
|
+
* @public
|
|
1881
1881
|
*/
|
|
1882
1882
|
subscriberIdentity?: AwsIdentity;
|
|
1883
1883
|
/**
|
|
1884
|
-
* @public
|
|
1885
1884
|
* <p>The name of the Security Lake account subscriber.</p>
|
|
1885
|
+
* @public
|
|
1886
1886
|
*/
|
|
1887
1887
|
subscriberName?: string;
|
|
1888
1888
|
/**
|
|
1889
|
-
* @public
|
|
1890
1889
|
* <p>The description of the Security Lake account subscriber.</p>
|
|
1890
|
+
* @public
|
|
1891
1891
|
*/
|
|
1892
1892
|
subscriberDescription?: string;
|
|
1893
1893
|
/**
|
|
1894
|
-
* @public
|
|
1895
1894
|
* <p>The supported Amazon Web Services from which logs and events are collected. For
|
|
1896
1895
|
* 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>
|
|
1896
|
+
* @public
|
|
1897
1897
|
*/
|
|
1898
1898
|
sources?: LogSourceResource[];
|
|
1899
1899
|
}
|
|
@@ -1902,8 +1902,8 @@ export interface UpdateSubscriberRequest {
|
|
|
1902
1902
|
*/
|
|
1903
1903
|
export interface UpdateSubscriberResponse {
|
|
1904
1904
|
/**
|
|
1905
|
-
* @public
|
|
1906
1905
|
* <p>The updated subscriber information.</p>
|
|
1906
|
+
* @public
|
|
1907
1907
|
*/
|
|
1908
1908
|
subscriber?: SubscriberResource;
|
|
1909
1909
|
}
|
|
@@ -1912,13 +1912,13 @@ export interface UpdateSubscriberResponse {
|
|
|
1912
1912
|
*/
|
|
1913
1913
|
export interface UpdateSubscriberNotificationRequest {
|
|
1914
1914
|
/**
|
|
1915
|
-
* @public
|
|
1916
1915
|
* <p>The subscription ID for which the subscription notification is specified.</p>
|
|
1916
|
+
* @public
|
|
1917
1917
|
*/
|
|
1918
1918
|
subscriberId: string | undefined;
|
|
1919
1919
|
/**
|
|
1920
|
-
* @public
|
|
1921
1920
|
* <p>The configuration for subscriber notification.</p>
|
|
1921
|
+
* @public
|
|
1922
1922
|
*/
|
|
1923
1923
|
configuration: NotificationConfiguration | undefined;
|
|
1924
1924
|
}
|
|
@@ -1927,8 +1927,8 @@ export interface UpdateSubscriberNotificationRequest {
|
|
|
1927
1927
|
*/
|
|
1928
1928
|
export interface UpdateSubscriberNotificationResponse {
|
|
1929
1929
|
/**
|
|
1930
|
-
* @public
|
|
1931
1930
|
* <p>The subscriber endpoint to which exception messages are posted.</p>
|
|
1931
|
+
* @public
|
|
1932
1932
|
*/
|
|
1933
1933
|
subscriberEndpoint?: string;
|
|
1934
1934
|
}
|
|
@@ -1937,14 +1937,14 @@ export interface UpdateSubscriberNotificationResponse {
|
|
|
1937
1937
|
*/
|
|
1938
1938
|
export interface TagResourceRequest {
|
|
1939
1939
|
/**
|
|
1940
|
-
* @public
|
|
1941
1940
|
* <p>The Amazon Resource Name (ARN) of the Amazon Security Lake resource to add or update the tags for.</p>
|
|
1941
|
+
* @public
|
|
1942
1942
|
*/
|
|
1943
1943
|
resourceArn: string | undefined;
|
|
1944
1944
|
/**
|
|
1945
|
-
* @public
|
|
1946
1945
|
* <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
|
|
1947
1946
|
* specify both a tag key and a tag value. A tag value cannot be null, but it can be an empty string.</p>
|
|
1947
|
+
* @public
|
|
1948
1948
|
*/
|
|
1949
1949
|
tags: Tag[] | undefined;
|
|
1950
1950
|
}
|
|
@@ -1958,13 +1958,13 @@ export interface TagResourceResponse {
|
|
|
1958
1958
|
*/
|
|
1959
1959
|
export interface UntagResourceRequest {
|
|
1960
1960
|
/**
|
|
1961
|
-
* @public
|
|
1962
1961
|
* <p>The Amazon Resource Name (ARN) of the Amazon Security Lake resource to remove one or more tags from.</p>
|
|
1962
|
+
* @public
|
|
1963
1963
|
*/
|
|
1964
1964
|
resourceArn: string | undefined;
|
|
1965
1965
|
/**
|
|
1966
|
-
* @public
|
|
1967
1966
|
* <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>
|
|
1967
|
+
* @public
|
|
1968
1968
|
*/
|
|
1969
1969
|
tagKeys: string[] | undefined;
|
|
1970
1970
|
}
|
|
@@ -1978,18 +1978,18 @@ export interface UntagResourceResponse {
|
|
|
1978
1978
|
*/
|
|
1979
1979
|
export interface UpdateDataLakeExceptionSubscriptionRequest {
|
|
1980
1980
|
/**
|
|
1981
|
-
* @public
|
|
1982
1981
|
* <p>The subscription protocol to which exception messages are posted.</p>
|
|
1982
|
+
* @public
|
|
1983
1983
|
*/
|
|
1984
1984
|
subscriptionProtocol: string | undefined;
|
|
1985
1985
|
/**
|
|
1986
|
-
* @public
|
|
1987
1986
|
* <p>The account that is subscribed to receive exception notifications.</p>
|
|
1987
|
+
* @public
|
|
1988
1988
|
*/
|
|
1989
1989
|
notificationEndpoint: string | undefined;
|
|
1990
1990
|
/**
|
|
1991
|
-
* @public
|
|
1992
1991
|
* <p>The time-to-live (TTL) for the exception message to remain.</p>
|
|
1992
|
+
* @public
|
|
1993
1993
|
*/
|
|
1994
1994
|
exceptionTimeToLive?: number;
|
|
1995
1995
|
}
|