@aws-sdk/client-securitylake 3.312.0 → 3.316.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-cjs/SecurityLake.js +34 -420
- package/dist-cjs/protocols/Aws_restJson1.js +361 -820
- package/dist-es/SecurityLake.js +34 -420
- package/dist-es/protocols/Aws_restJson1.js +315 -774
- package/dist-types/SecurityLake.d.ts +67 -184
- package/dist-types/ts3.4/SecurityLake.d.ts +4 -1
- package/package.json +6 -6
|
@@ -30,338 +30,221 @@ import { UpdateDatalakeExceptionsSubscriptionCommandInput, UpdateDatalakeExcepti
|
|
|
30
30
|
import { UpdateSubscriberCommandInput, UpdateSubscriberCommandOutput } from "./commands/UpdateSubscriberCommand";
|
|
31
31
|
import { UpdateSubscriptionNotificationConfigurationCommandInput, UpdateSubscriptionNotificationConfigurationCommandOutput } from "./commands/UpdateSubscriptionNotificationConfigurationCommand";
|
|
32
32
|
import { SecurityLakeClient } from "./SecurityLakeClient";
|
|
33
|
-
|
|
34
|
-
* @public
|
|
35
|
-
* <note>
|
|
36
|
-
* <p>Amazon Security Lake is in preview release. Your use of the Security Lake preview is subject to
|
|
37
|
-
* Section 2 of the <a href="http://aws.amazon.com/service-terms/">Amazon Web Services Service
|
|
38
|
-
* Terms</a>("Betas and Previews").</p>
|
|
39
|
-
* </note>
|
|
40
|
-
* <p>Amazon Security Lake is a fully managed security data lake service. You can use Security Lake to
|
|
41
|
-
* automatically centralize security data from cloud, on-premises, and custom sources into a
|
|
42
|
-
* data lake that's stored in your Amazon Web Servicesaccount. Amazon Web Services Organizations
|
|
43
|
-
* is an account management service that lets you consolidate multiple Amazon Web Services
|
|
44
|
-
* accounts into an organization that you create and centrally manage. With Organizations, you
|
|
45
|
-
* can create member accounts and invite existing accounts to join your organization.
|
|
46
|
-
* Security Lake helps you analyze security data for a more complete understanding of your
|
|
47
|
-
* security posture across the entire organization. It can also help you improve the
|
|
48
|
-
* protection of your workloads, applications, and data.</p>
|
|
49
|
-
* <p>The data lake is backed by Amazon Simple Storage Service (Amazon S3) buckets, and you
|
|
50
|
-
* retain ownership over your data. </p>
|
|
51
|
-
* <p>Amazon Security Lake integrates with CloudTrail, a service that provides a record of
|
|
52
|
-
* actions taken by a user, role, or an Amazon Web Services service in Security Lake CloudTrail captures API calls for Security Lake as events. The calls captured include calls
|
|
53
|
-
* from the Security Lake console and code calls to the Security Lake API operations. If you create a
|
|
54
|
-
* trail, you can enable continuous delivery of CloudTrail events to an Amazon S3 bucket, including events for Security Lake. If you don't configure a trail, you can still
|
|
55
|
-
* view the most recent events in the CloudTrail console in Event history. Using the
|
|
56
|
-
* information collected by CloudTrail you can determine the request that was made to
|
|
57
|
-
* Security Lake, the IP address from which the request was made, who made the request, when it
|
|
58
|
-
* was made, and additional details. To learn more about Security Lake information in CloudTrail, see the <a href="https://docs.aws.amazon.com/security-lake/latest/userguide/securitylake-cloudtrail.html">Amazon Security Lake User Guide</a>.</p>
|
|
59
|
-
* <p>Security Lake automates the collection of security-related log and event data from
|
|
60
|
-
* integrated Amazon Web Services and third-party services. It also helps you manage
|
|
61
|
-
* the lifecycle of data with customizable retention and replication settings. Security Lake
|
|
62
|
-
* converts ingested data into Apache Parquet format and a standard open-source schema called
|
|
63
|
-
* the Open Cybersecurity Schema Framework (OCSF).</p>
|
|
64
|
-
* <p>Other Amazon Web Services and third-party services can subscribe to the data that's stored in Security Lake for
|
|
65
|
-
* incident response and security data analytics.</p>
|
|
66
|
-
*/
|
|
67
|
-
export declare class SecurityLake extends SecurityLakeClient {
|
|
33
|
+
export interface SecurityLake {
|
|
68
34
|
/**
|
|
69
|
-
* @
|
|
70
|
-
* <p>Adds a natively supported Amazon Web Service as an Amazon Security Lake source. Enables
|
|
71
|
-
* source types for member accounts in required Amazon Web Services Regions, based on the
|
|
72
|
-
* parameters you specify. You can choose any source type in any Region for either accounts
|
|
73
|
-
* that are part of a trusted organization or standalone accounts. At least one of the three
|
|
74
|
-
* dimensions is a mandatory input to this API. However, you can supply any combination of the
|
|
75
|
-
* three dimensions to this API. </p>
|
|
76
|
-
* <p>By default, a dimension refers to the entire set. When you don't provide a dimension,
|
|
77
|
-
* Security Lake assumes that the missing dimension refers to the entire set. This is overridden
|
|
78
|
-
* when you supply any one of the inputs. For instance, when you do not specify members, the
|
|
79
|
-
* API enables all Security Lake member accounts for all sources. Similarly, when you do not
|
|
80
|
-
* specify Regions, Security Lake is enabled for all the Regions where Security Lake is available as a
|
|
81
|
-
* service.</p>
|
|
82
|
-
* <p>You can use this API only to enable natively supported Amazon Web Services as a
|
|
83
|
-
* source. Use <code>CreateCustomLogSource</code> to enable data collection from a custom
|
|
84
|
-
* source. </p>
|
|
35
|
+
* @see {@link CreateAwsLogSourceCommand}
|
|
85
36
|
*/
|
|
86
37
|
createAwsLogSource(args: CreateAwsLogSourceCommandInput, options?: __HttpHandlerOptions): Promise<CreateAwsLogSourceCommandOutput>;
|
|
87
38
|
createAwsLogSource(args: CreateAwsLogSourceCommandInput, cb: (err: any, data?: CreateAwsLogSourceCommandOutput) => void): void;
|
|
88
39
|
createAwsLogSource(args: CreateAwsLogSourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAwsLogSourceCommandOutput) => void): void;
|
|
89
40
|
/**
|
|
90
|
-
* @
|
|
91
|
-
* <p>Adds a third-party custom source in Amazon Security Lake, from the Amazon Web Services Region
|
|
92
|
-
* where you want to create a custom source. Security Lake can collect logs and events from
|
|
93
|
-
* third-party custom sources. After creating the appropriate IAM role to
|
|
94
|
-
* invoke Glue crawler, use this API to add a custom source name in Security Lake. This
|
|
95
|
-
* operation creates a partition in the Amazon S3 bucket for Security Lake as the target
|
|
96
|
-
* location for log files from the custom source in addition to an associated Glue table and an Glue crawler.</p>
|
|
41
|
+
* @see {@link CreateCustomLogSourceCommand}
|
|
97
42
|
*/
|
|
98
43
|
createCustomLogSource(args: CreateCustomLogSourceCommandInput, options?: __HttpHandlerOptions): Promise<CreateCustomLogSourceCommandOutput>;
|
|
99
44
|
createCustomLogSource(args: CreateCustomLogSourceCommandInput, cb: (err: any, data?: CreateCustomLogSourceCommandOutput) => void): void;
|
|
100
45
|
createCustomLogSource(args: CreateCustomLogSourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCustomLogSourceCommandOutput) => void): void;
|
|
101
46
|
/**
|
|
102
|
-
* @
|
|
103
|
-
* <p>Initializes an Amazon Security Lake instance with the provided (or default) configuration. You
|
|
104
|
-
* can enable Security Lake in Amazon Web Services Regions with customized settings before enabling
|
|
105
|
-
* log collection in Regions. You can either use the <code>enableAll</code> parameter to
|
|
106
|
-
* specify all Regions or specify the Regions where you want to enable Security Lake. To specify
|
|
107
|
-
* particular Regions, use the <code>Regions</code> parameter and then configure these Regions
|
|
108
|
-
* using the <code>configurations</code> parameter. If you have already enabled Security Lake in a
|
|
109
|
-
* Region when you call this command, the command will update the Region if you provide new
|
|
110
|
-
* configuration parameters. If you have not already enabled Security Lake in the Region when you
|
|
111
|
-
* call this API, it will set up the data lake in the Region with the specified
|
|
112
|
-
* configurations.</p>
|
|
113
|
-
* <p>When you enable Security Lake, it starts ingesting security data after the
|
|
114
|
-
* <code>CreateAwsLogSource</code> call. This includes ingesting security data from
|
|
115
|
-
* sources, storing data, and making data accessible to subscribers. Security Lake also enables
|
|
116
|
-
* all the existing settings and resources that it stores or maintains for your Amazon Web Services account in the current Region, including security log and event data. For
|
|
117
|
-
* more information, see the <a href="https://docs.aws.amazon.com/security-lake/latest/userguide/what-is-security-lake.html">Amazon Security Lake User
|
|
118
|
-
* Guide</a>.</p>
|
|
47
|
+
* @see {@link CreateDatalakeCommand}
|
|
119
48
|
*/
|
|
120
49
|
createDatalake(args: CreateDatalakeCommandInput, options?: __HttpHandlerOptions): Promise<CreateDatalakeCommandOutput>;
|
|
121
50
|
createDatalake(args: CreateDatalakeCommandInput, cb: (err: any, data?: CreateDatalakeCommandOutput) => void): void;
|
|
122
51
|
createDatalake(args: CreateDatalakeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDatalakeCommandOutput) => void): void;
|
|
123
52
|
/**
|
|
124
|
-
* @
|
|
125
|
-
* <p>Automatically enables Amazon Security Lake for new member accounts in your organization.
|
|
126
|
-
* Security Lake is not automatically enabled for any existing member accounts in your
|
|
127
|
-
* organization.</p>
|
|
53
|
+
* @see {@link CreateDatalakeAutoEnableCommand}
|
|
128
54
|
*/
|
|
129
55
|
createDatalakeAutoEnable(args: CreateDatalakeAutoEnableCommandInput, options?: __HttpHandlerOptions): Promise<CreateDatalakeAutoEnableCommandOutput>;
|
|
130
56
|
createDatalakeAutoEnable(args: CreateDatalakeAutoEnableCommandInput, cb: (err: any, data?: CreateDatalakeAutoEnableCommandOutput) => void): void;
|
|
131
57
|
createDatalakeAutoEnable(args: CreateDatalakeAutoEnableCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDatalakeAutoEnableCommandOutput) => void): void;
|
|
132
58
|
/**
|
|
133
|
-
* @
|
|
134
|
-
* <p>Designates the Amazon Security Lake delegated administrator account for the organization. This
|
|
135
|
-
* API can only be called by the organization management account. The organization management
|
|
136
|
-
* account cannot be the delegated administrator account.</p>
|
|
59
|
+
* @see {@link CreateDatalakeDelegatedAdminCommand}
|
|
137
60
|
*/
|
|
138
61
|
createDatalakeDelegatedAdmin(args: CreateDatalakeDelegatedAdminCommandInput, options?: __HttpHandlerOptions): Promise<CreateDatalakeDelegatedAdminCommandOutput>;
|
|
139
62
|
createDatalakeDelegatedAdmin(args: CreateDatalakeDelegatedAdminCommandInput, cb: (err: any, data?: CreateDatalakeDelegatedAdminCommandOutput) => void): void;
|
|
140
63
|
createDatalakeDelegatedAdmin(args: CreateDatalakeDelegatedAdminCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDatalakeDelegatedAdminCommandOutput) => void): void;
|
|
141
64
|
/**
|
|
142
|
-
* @
|
|
143
|
-
* <p>Creates the specified notification subscription in Amazon Security Lake for the organization
|
|
144
|
-
* you specify.</p>
|
|
65
|
+
* @see {@link CreateDatalakeExceptionsSubscriptionCommand}
|
|
145
66
|
*/
|
|
146
67
|
createDatalakeExceptionsSubscription(args: CreateDatalakeExceptionsSubscriptionCommandInput, options?: __HttpHandlerOptions): Promise<CreateDatalakeExceptionsSubscriptionCommandOutput>;
|
|
147
68
|
createDatalakeExceptionsSubscription(args: CreateDatalakeExceptionsSubscriptionCommandInput, cb: (err: any, data?: CreateDatalakeExceptionsSubscriptionCommandOutput) => void): void;
|
|
148
69
|
createDatalakeExceptionsSubscription(args: CreateDatalakeExceptionsSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDatalakeExceptionsSubscriptionCommandOutput) => void): void;
|
|
149
70
|
/**
|
|
150
|
-
* @
|
|
151
|
-
* <p>Creates a subscription permission for accounts that are already enabled in
|
|
152
|
-
* Amazon Security Lake. You can create a subscriber with access to data in the current Amazon Web Services Region.</p>
|
|
71
|
+
* @see {@link CreateSubscriberCommand}
|
|
153
72
|
*/
|
|
154
73
|
createSubscriber(args: CreateSubscriberCommandInput, options?: __HttpHandlerOptions): Promise<CreateSubscriberCommandOutput>;
|
|
155
74
|
createSubscriber(args: CreateSubscriberCommandInput, cb: (err: any, data?: CreateSubscriberCommandOutput) => void): void;
|
|
156
75
|
createSubscriber(args: CreateSubscriberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSubscriberCommandOutput) => void): void;
|
|
157
76
|
/**
|
|
158
|
-
* @
|
|
159
|
-
* <p>Notifies the subscriber when new data is written to the data lake for the sources that
|
|
160
|
-
* the subscriber consumes in Security Lake. You can create only one subscriber notification per
|
|
161
|
-
* subscriber.</p>
|
|
77
|
+
* @see {@link CreateSubscriptionNotificationConfigurationCommand}
|
|
162
78
|
*/
|
|
163
79
|
createSubscriptionNotificationConfiguration(args: CreateSubscriptionNotificationConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<CreateSubscriptionNotificationConfigurationCommandOutput>;
|
|
164
80
|
createSubscriptionNotificationConfiguration(args: CreateSubscriptionNotificationConfigurationCommandInput, cb: (err: any, data?: CreateSubscriptionNotificationConfigurationCommandOutput) => void): void;
|
|
165
81
|
createSubscriptionNotificationConfiguration(args: CreateSubscriptionNotificationConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSubscriptionNotificationConfigurationCommandOutput) => void): void;
|
|
166
82
|
/**
|
|
167
|
-
* @
|
|
168
|
-
* <p>Removes a natively supported Amazon Web Service as an Amazon Security Lake source. When
|
|
169
|
-
* you remove the source, Security Lake stops collecting data from that source, and subscribers
|
|
170
|
-
* can no longer consume new data from the source. Subscribers can still consume data that
|
|
171
|
-
* Security Lake collected from the source before disablement.</p>
|
|
172
|
-
* <p>You can choose any source type in any Amazon Web Services Region for either accounts that
|
|
173
|
-
* are part of a trusted organization or standalone accounts. At least one of the three
|
|
174
|
-
* dimensions is a mandatory input to this API. However, you can supply any combination of the
|
|
175
|
-
* three dimensions to this API. </p>
|
|
176
|
-
* <p>By default, a dimension refers to the entire set. This is overridden when you supply any
|
|
177
|
-
* one of the inputs. For instance, when you do not specify members, the API disables all
|
|
178
|
-
* Security Lake member accounts for sources. Similarly, when you do not specify Regions,
|
|
179
|
-
* Security Lake is disabled for all the Regions where Security Lake is available as a service.</p>
|
|
180
|
-
* <p>When you don't provide a dimension, Security Lake assumes that the missing dimension refers
|
|
181
|
-
* to the entire set. For example, if you don't provide specific accounts, the API applies to
|
|
182
|
-
* the entire set of accounts in your organization.</p>
|
|
83
|
+
* @see {@link DeleteAwsLogSourceCommand}
|
|
183
84
|
*/
|
|
184
85
|
deleteAwsLogSource(args: DeleteAwsLogSourceCommandInput, options?: __HttpHandlerOptions): Promise<DeleteAwsLogSourceCommandOutput>;
|
|
185
86
|
deleteAwsLogSource(args: DeleteAwsLogSourceCommandInput, cb: (err: any, data?: DeleteAwsLogSourceCommandOutput) => void): void;
|
|
186
87
|
deleteAwsLogSource(args: DeleteAwsLogSourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAwsLogSourceCommandOutput) => void): void;
|
|
187
88
|
/**
|
|
188
|
-
* @
|
|
189
|
-
* <p>Removes a custom log source from Amazon Security Lake.</p>
|
|
89
|
+
* @see {@link DeleteCustomLogSourceCommand}
|
|
190
90
|
*/
|
|
191
91
|
deleteCustomLogSource(args: DeleteCustomLogSourceCommandInput, options?: __HttpHandlerOptions): Promise<DeleteCustomLogSourceCommandOutput>;
|
|
192
92
|
deleteCustomLogSource(args: DeleteCustomLogSourceCommandInput, cb: (err: any, data?: DeleteCustomLogSourceCommandOutput) => void): void;
|
|
193
93
|
deleteCustomLogSource(args: DeleteCustomLogSourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCustomLogSourceCommandOutput) => void): void;
|
|
194
94
|
/**
|
|
195
|
-
* @
|
|
196
|
-
* <p>When you delete Amazon Security Lake from your account, Security Lake is disabled in all Amazon Web Services Regions. Also, this API automatically takes steps to remove the account from
|
|
197
|
-
* Security Lake . </p>
|
|
198
|
-
* <p>This operation disables security data collection from sources, deletes data stored, and
|
|
199
|
-
* stops making data accessible to subscribers. Security Lake also deletes all the existing
|
|
200
|
-
* settings and resources that it stores or maintains for your Amazon Web Services account in
|
|
201
|
-
* the current Region, including security log and event data. The <code>DeleteDatalake</code>
|
|
202
|
-
* operation does not delete the Amazon S3 bucket, which is owned by your Amazon Web Services account. For more information, see the <a href="https://docs.aws.amazon.com/security-lake/latest/userguide/disable-security-lake.html">Amazon Security Lake User
|
|
203
|
-
* Guide</a>.</p>
|
|
95
|
+
* @see {@link DeleteDatalakeCommand}
|
|
204
96
|
*/
|
|
205
97
|
deleteDatalake(args: DeleteDatalakeCommandInput, options?: __HttpHandlerOptions): Promise<DeleteDatalakeCommandOutput>;
|
|
206
98
|
deleteDatalake(args: DeleteDatalakeCommandInput, cb: (err: any, data?: DeleteDatalakeCommandOutput) => void): void;
|
|
207
99
|
deleteDatalake(args: DeleteDatalakeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDatalakeCommandOutput) => void): void;
|
|
208
100
|
/**
|
|
209
|
-
* @
|
|
210
|
-
* <p>
|
|
211
|
-
* <code>DeleteDatalakeAutoEnable</code> removes automatic enablement of configuration
|
|
212
|
-
* settings for new member accounts (but keeps settings for the delegated administrator) from
|
|
213
|
-
* Amazon Security Lake. You must run this API using credentials of the delegated administrator.
|
|
214
|
-
* When you run this API, new member accounts that are added after the organization enables
|
|
215
|
-
* Security Lake won't contribute to the data lake.</p>
|
|
101
|
+
* @see {@link DeleteDatalakeAutoEnableCommand}
|
|
216
102
|
*/
|
|
217
103
|
deleteDatalakeAutoEnable(args: DeleteDatalakeAutoEnableCommandInput, options?: __HttpHandlerOptions): Promise<DeleteDatalakeAutoEnableCommandOutput>;
|
|
218
104
|
deleteDatalakeAutoEnable(args: DeleteDatalakeAutoEnableCommandInput, cb: (err: any, data?: DeleteDatalakeAutoEnableCommandOutput) => void): void;
|
|
219
105
|
deleteDatalakeAutoEnable(args: DeleteDatalakeAutoEnableCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDatalakeAutoEnableCommandOutput) => void): void;
|
|
220
106
|
/**
|
|
221
|
-
* @
|
|
222
|
-
* <p>Deletes the Amazon Security Lake delegated administrator account for the organization. This API
|
|
223
|
-
* can only be called by the organization management account. The organization management
|
|
224
|
-
* account cannot be the delegated administrator account.</p>
|
|
107
|
+
* @see {@link DeleteDatalakeDelegatedAdminCommand}
|
|
225
108
|
*/
|
|
226
109
|
deleteDatalakeDelegatedAdmin(args: DeleteDatalakeDelegatedAdminCommandInput, options?: __HttpHandlerOptions): Promise<DeleteDatalakeDelegatedAdminCommandOutput>;
|
|
227
110
|
deleteDatalakeDelegatedAdmin(args: DeleteDatalakeDelegatedAdminCommandInput, cb: (err: any, data?: DeleteDatalakeDelegatedAdminCommandOutput) => void): void;
|
|
228
111
|
deleteDatalakeDelegatedAdmin(args: DeleteDatalakeDelegatedAdminCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDatalakeDelegatedAdminCommandOutput) => void): void;
|
|
229
112
|
/**
|
|
230
|
-
* @
|
|
231
|
-
* <p>Deletes the specified notification subscription in Amazon Security Lake for the organization
|
|
232
|
-
* you specify.</p>
|
|
113
|
+
* @see {@link DeleteDatalakeExceptionsSubscriptionCommand}
|
|
233
114
|
*/
|
|
234
115
|
deleteDatalakeExceptionsSubscription(args: DeleteDatalakeExceptionsSubscriptionCommandInput, options?: __HttpHandlerOptions): Promise<DeleteDatalakeExceptionsSubscriptionCommandOutput>;
|
|
235
116
|
deleteDatalakeExceptionsSubscription(args: DeleteDatalakeExceptionsSubscriptionCommandInput, cb: (err: any, data?: DeleteDatalakeExceptionsSubscriptionCommandOutput) => void): void;
|
|
236
117
|
deleteDatalakeExceptionsSubscription(args: DeleteDatalakeExceptionsSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDatalakeExceptionsSubscriptionCommandOutput) => void): void;
|
|
237
118
|
/**
|
|
238
|
-
* @
|
|
239
|
-
* <p>Deletes the subscription permission for accounts that are already enabled in
|
|
240
|
-
* Amazon Security Lake. You can delete a subscriber and remove access to data in the current Amazon Web Services
|
|
241
|
-
* Region.</p>
|
|
119
|
+
* @see {@link DeleteSubscriberCommand}
|
|
242
120
|
*/
|
|
243
121
|
deleteSubscriber(args: DeleteSubscriberCommandInput, options?: __HttpHandlerOptions): Promise<DeleteSubscriberCommandOutput>;
|
|
244
122
|
deleteSubscriber(args: DeleteSubscriberCommandInput, cb: (err: any, data?: DeleteSubscriberCommandOutput) => void): void;
|
|
245
123
|
deleteSubscriber(args: DeleteSubscriberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSubscriberCommandOutput) => void): void;
|
|
246
124
|
/**
|
|
247
|
-
* @
|
|
248
|
-
* <p>Deletes the specified notification subscription in Amazon Security Lake for the organization
|
|
249
|
-
* you specify.</p>
|
|
125
|
+
* @see {@link DeleteSubscriptionNotificationConfigurationCommand}
|
|
250
126
|
*/
|
|
251
127
|
deleteSubscriptionNotificationConfiguration(args: DeleteSubscriptionNotificationConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<DeleteSubscriptionNotificationConfigurationCommandOutput>;
|
|
252
128
|
deleteSubscriptionNotificationConfiguration(args: DeleteSubscriptionNotificationConfigurationCommandInput, cb: (err: any, data?: DeleteSubscriptionNotificationConfigurationCommandOutput) => void): void;
|
|
253
129
|
deleteSubscriptionNotificationConfiguration(args: DeleteSubscriptionNotificationConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSubscriptionNotificationConfigurationCommandOutput) => void): void;
|
|
254
130
|
/**
|
|
255
|
-
* @
|
|
256
|
-
* <p>Retrieves the Amazon Security Lake configuration object for the specified Amazon Web Services account ID. You can use the <code>GetDatalake</code> API to know whether
|
|
257
|
-
* Security Lake is enabled for the current Region. This API does not take input parameters. </p>
|
|
131
|
+
* @see {@link GetDatalakeCommand}
|
|
258
132
|
*/
|
|
259
133
|
getDatalake(args: GetDatalakeCommandInput, options?: __HttpHandlerOptions): Promise<GetDatalakeCommandOutput>;
|
|
260
134
|
getDatalake(args: GetDatalakeCommandInput, cb: (err: any, data?: GetDatalakeCommandOutput) => void): void;
|
|
261
135
|
getDatalake(args: GetDatalakeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDatalakeCommandOutput) => void): void;
|
|
262
136
|
/**
|
|
263
|
-
* @
|
|
264
|
-
* <p>Retrieves the configuration that will be automatically set up for accounts added to the
|
|
265
|
-
* organization after the organization has onboarded to Amazon Security Lake. This API does not take
|
|
266
|
-
* input parameters.</p>
|
|
137
|
+
* @see {@link GetDatalakeAutoEnableCommand}
|
|
267
138
|
*/
|
|
268
139
|
getDatalakeAutoEnable(args: GetDatalakeAutoEnableCommandInput, options?: __HttpHandlerOptions): Promise<GetDatalakeAutoEnableCommandOutput>;
|
|
269
140
|
getDatalakeAutoEnable(args: GetDatalakeAutoEnableCommandInput, cb: (err: any, data?: GetDatalakeAutoEnableCommandOutput) => void): void;
|
|
270
141
|
getDatalakeAutoEnable(args: GetDatalakeAutoEnableCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDatalakeAutoEnableCommandOutput) => void): void;
|
|
271
142
|
/**
|
|
272
|
-
* @
|
|
273
|
-
* <p>Retrieves the expiration period and time-to-live (TTL) for which the exception message
|
|
274
|
-
* will remain. Exceptions are stored by default, for 2 weeks from when a record was created
|
|
275
|
-
* in Amazon Security Lake. This API does not take input parameters.</p>
|
|
143
|
+
* @see {@link GetDatalakeExceptionsExpiryCommand}
|
|
276
144
|
*/
|
|
277
145
|
getDatalakeExceptionsExpiry(args: GetDatalakeExceptionsExpiryCommandInput, options?: __HttpHandlerOptions): Promise<GetDatalakeExceptionsExpiryCommandOutput>;
|
|
278
146
|
getDatalakeExceptionsExpiry(args: GetDatalakeExceptionsExpiryCommandInput, cb: (err: any, data?: GetDatalakeExceptionsExpiryCommandOutput) => void): void;
|
|
279
147
|
getDatalakeExceptionsExpiry(args: GetDatalakeExceptionsExpiryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDatalakeExceptionsExpiryCommandOutput) => void): void;
|
|
280
148
|
/**
|
|
281
|
-
* @
|
|
282
|
-
* <p>Retrieves the details of exception notifications for the account in Amazon Security Lake.</p>
|
|
149
|
+
* @see {@link GetDatalakeExceptionsSubscriptionCommand}
|
|
283
150
|
*/
|
|
284
151
|
getDatalakeExceptionsSubscription(args: GetDatalakeExceptionsSubscriptionCommandInput, options?: __HttpHandlerOptions): Promise<GetDatalakeExceptionsSubscriptionCommandOutput>;
|
|
285
152
|
getDatalakeExceptionsSubscription(args: GetDatalakeExceptionsSubscriptionCommandInput, cb: (err: any, data?: GetDatalakeExceptionsSubscriptionCommandOutput) => void): void;
|
|
286
153
|
getDatalakeExceptionsSubscription(args: GetDatalakeExceptionsSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDatalakeExceptionsSubscriptionCommandOutput) => void): void;
|
|
287
154
|
/**
|
|
288
|
-
* @
|
|
289
|
-
* <p>Retrieves a snapshot of the current Region, including whether Amazon Security Lake is enabled
|
|
290
|
-
* for those accounts and which sources Security Lake is collecting data from. </p>
|
|
155
|
+
* @see {@link GetDatalakeStatusCommand}
|
|
291
156
|
*/
|
|
292
157
|
getDatalakeStatus(args: GetDatalakeStatusCommandInput, options?: __HttpHandlerOptions): Promise<GetDatalakeStatusCommandOutput>;
|
|
293
158
|
getDatalakeStatus(args: GetDatalakeStatusCommandInput, cb: (err: any, data?: GetDatalakeStatusCommandOutput) => void): void;
|
|
294
159
|
getDatalakeStatus(args: GetDatalakeStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDatalakeStatusCommandOutput) => void): void;
|
|
295
160
|
/**
|
|
296
|
-
* @
|
|
297
|
-
* <p>Retrieves the subscription information for the specified subscription ID. You can get
|
|
298
|
-
* information about a specific subscriber.</p>
|
|
161
|
+
* @see {@link GetSubscriberCommand}
|
|
299
162
|
*/
|
|
300
163
|
getSubscriber(args: GetSubscriberCommandInput, options?: __HttpHandlerOptions): Promise<GetSubscriberCommandOutput>;
|
|
301
164
|
getSubscriber(args: GetSubscriberCommandInput, cb: (err: any, data?: GetSubscriberCommandOutput) => void): void;
|
|
302
165
|
getSubscriber(args: GetSubscriberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSubscriberCommandOutput) => void): void;
|
|
303
166
|
/**
|
|
304
|
-
* @
|
|
305
|
-
* <p>Lists the Amazon Security Lake exceptions that you can use to find the source of problems and
|
|
306
|
-
* fix them.</p>
|
|
167
|
+
* @see {@link ListDatalakeExceptionsCommand}
|
|
307
168
|
*/
|
|
308
169
|
listDatalakeExceptions(args: ListDatalakeExceptionsCommandInput, options?: __HttpHandlerOptions): Promise<ListDatalakeExceptionsCommandOutput>;
|
|
309
170
|
listDatalakeExceptions(args: ListDatalakeExceptionsCommandInput, cb: (err: any, data?: ListDatalakeExceptionsCommandOutput) => void): void;
|
|
310
171
|
listDatalakeExceptions(args: ListDatalakeExceptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDatalakeExceptionsCommandOutput) => void): void;
|
|
311
172
|
/**
|
|
312
|
-
* @
|
|
313
|
-
* <p>Retrieves the log sources in the current Amazon Web Services Region. </p>
|
|
173
|
+
* @see {@link ListLogSourcesCommand}
|
|
314
174
|
*/
|
|
315
175
|
listLogSources(args: ListLogSourcesCommandInput, options?: __HttpHandlerOptions): Promise<ListLogSourcesCommandOutput>;
|
|
316
176
|
listLogSources(args: ListLogSourcesCommandInput, cb: (err: any, data?: ListLogSourcesCommandOutput) => void): void;
|
|
317
177
|
listLogSources(args: ListLogSourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListLogSourcesCommandOutput) => void): void;
|
|
318
178
|
/**
|
|
319
|
-
* @
|
|
320
|
-
* <p>List all subscribers for the specific Amazon Security Lake account ID. You can retrieve a list
|
|
321
|
-
* of subscriptions associated with a specific organization or Amazon Web Services account.</p>
|
|
179
|
+
* @see {@link ListSubscribersCommand}
|
|
322
180
|
*/
|
|
323
181
|
listSubscribers(args: ListSubscribersCommandInput, options?: __HttpHandlerOptions): Promise<ListSubscribersCommandOutput>;
|
|
324
182
|
listSubscribers(args: ListSubscribersCommandInput, cb: (err: any, data?: ListSubscribersCommandOutput) => void): void;
|
|
325
183
|
listSubscribers(args: ListSubscribersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSubscribersCommandOutput) => void): void;
|
|
326
184
|
/**
|
|
327
|
-
* @
|
|
328
|
-
* <p>Specifies where to store your security data and for how long. You can add a rollup
|
|
329
|
-
* Region to consolidate data from multiple Amazon Web Services Regions. </p>
|
|
185
|
+
* @see {@link UpdateDatalakeCommand}
|
|
330
186
|
*/
|
|
331
187
|
updateDatalake(args: UpdateDatalakeCommandInput, options?: __HttpHandlerOptions): Promise<UpdateDatalakeCommandOutput>;
|
|
332
188
|
updateDatalake(args: UpdateDatalakeCommandInput, cb: (err: any, data?: UpdateDatalakeCommandOutput) => void): void;
|
|
333
189
|
updateDatalake(args: UpdateDatalakeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDatalakeCommandOutput) => void): void;
|
|
334
190
|
/**
|
|
335
|
-
* @
|
|
336
|
-
* <p>Update the expiration period for the exception message to your preferred time, and
|
|
337
|
-
* control the time-to-live (TTL) for the exception message to remain. Exceptions are stored
|
|
338
|
-
* by default for 2 weeks from when a record was created in Amazon Security Lake. </p>
|
|
191
|
+
* @see {@link UpdateDatalakeExceptionsExpiryCommand}
|
|
339
192
|
*/
|
|
340
193
|
updateDatalakeExceptionsExpiry(args: UpdateDatalakeExceptionsExpiryCommandInput, options?: __HttpHandlerOptions): Promise<UpdateDatalakeExceptionsExpiryCommandOutput>;
|
|
341
194
|
updateDatalakeExceptionsExpiry(args: UpdateDatalakeExceptionsExpiryCommandInput, cb: (err: any, data?: UpdateDatalakeExceptionsExpiryCommandOutput) => void): void;
|
|
342
195
|
updateDatalakeExceptionsExpiry(args: UpdateDatalakeExceptionsExpiryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDatalakeExceptionsExpiryCommandOutput) => void): void;
|
|
343
196
|
/**
|
|
344
|
-
* @
|
|
345
|
-
* <p>Updates the specified notification subscription in Amazon Security Lake for the organization
|
|
346
|
-
* you specify.</p>
|
|
197
|
+
* @see {@link UpdateDatalakeExceptionsSubscriptionCommand}
|
|
347
198
|
*/
|
|
348
199
|
updateDatalakeExceptionsSubscription(args: UpdateDatalakeExceptionsSubscriptionCommandInput, options?: __HttpHandlerOptions): Promise<UpdateDatalakeExceptionsSubscriptionCommandOutput>;
|
|
349
200
|
updateDatalakeExceptionsSubscription(args: UpdateDatalakeExceptionsSubscriptionCommandInput, cb: (err: any, data?: UpdateDatalakeExceptionsSubscriptionCommandOutput) => void): void;
|
|
350
201
|
updateDatalakeExceptionsSubscription(args: UpdateDatalakeExceptionsSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDatalakeExceptionsSubscriptionCommandOutput) => void): void;
|
|
351
202
|
/**
|
|
352
|
-
* @
|
|
353
|
-
* <p>Updates an existing subscription for the given Amazon Security Lake account ID. You can update
|
|
354
|
-
* a subscriber by changing the sources that the subscriber consumes data from. </p>
|
|
203
|
+
* @see {@link UpdateSubscriberCommand}
|
|
355
204
|
*/
|
|
356
205
|
updateSubscriber(args: UpdateSubscriberCommandInput, options?: __HttpHandlerOptions): Promise<UpdateSubscriberCommandOutput>;
|
|
357
206
|
updateSubscriber(args: UpdateSubscriberCommandInput, cb: (err: any, data?: UpdateSubscriberCommandOutput) => void): void;
|
|
358
207
|
updateSubscriber(args: UpdateSubscriberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSubscriberCommandOutput) => void): void;
|
|
359
208
|
/**
|
|
360
|
-
* @
|
|
361
|
-
* <p>Updates an existing notification method for the subscription (SQS or HTTPs endpoint) or
|
|
362
|
-
* switches the notification subscription endpoint for a subscriber.</p>
|
|
209
|
+
* @see {@link UpdateSubscriptionNotificationConfigurationCommand}
|
|
363
210
|
*/
|
|
364
211
|
updateSubscriptionNotificationConfiguration(args: UpdateSubscriptionNotificationConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<UpdateSubscriptionNotificationConfigurationCommandOutput>;
|
|
365
212
|
updateSubscriptionNotificationConfiguration(args: UpdateSubscriptionNotificationConfigurationCommandInput, cb: (err: any, data?: UpdateSubscriptionNotificationConfigurationCommandOutput) => void): void;
|
|
366
213
|
updateSubscriptionNotificationConfiguration(args: UpdateSubscriptionNotificationConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSubscriptionNotificationConfigurationCommandOutput) => void): void;
|
|
367
214
|
}
|
|
215
|
+
/**
|
|
216
|
+
* @public
|
|
217
|
+
* <note>
|
|
218
|
+
* <p>Amazon Security Lake is in preview release. Your use of the Security Lake preview is subject to
|
|
219
|
+
* Section 2 of the <a href="http://aws.amazon.com/service-terms/">Amazon Web Services Service
|
|
220
|
+
* Terms</a>("Betas and Previews").</p>
|
|
221
|
+
* </note>
|
|
222
|
+
* <p>Amazon Security Lake is a fully managed security data lake service. You can use Security Lake to
|
|
223
|
+
* automatically centralize security data from cloud, on-premises, and custom sources into a
|
|
224
|
+
* data lake that's stored in your Amazon Web Servicesaccount. Amazon Web Services Organizations
|
|
225
|
+
* is an account management service that lets you consolidate multiple Amazon Web Services
|
|
226
|
+
* accounts into an organization that you create and centrally manage. With Organizations, you
|
|
227
|
+
* can create member accounts and invite existing accounts to join your organization.
|
|
228
|
+
* Security Lake helps you analyze security data for a more complete understanding of your
|
|
229
|
+
* security posture across the entire organization. It can also help you improve the
|
|
230
|
+
* protection of your workloads, applications, and data.</p>
|
|
231
|
+
* <p>The data lake is backed by Amazon Simple Storage Service (Amazon S3) buckets, and you
|
|
232
|
+
* retain ownership over your data. </p>
|
|
233
|
+
* <p>Amazon Security Lake integrates with CloudTrail, a service that provides a record of
|
|
234
|
+
* actions taken by a user, role, or an Amazon Web Services service in Security Lake CloudTrail captures API calls for Security Lake as events. The calls captured include calls
|
|
235
|
+
* from the Security Lake console and code calls to the Security Lake API operations. If you create a
|
|
236
|
+
* trail, you can enable continuous delivery of CloudTrail events to an Amazon S3 bucket, including events for Security Lake. If you don't configure a trail, you can still
|
|
237
|
+
* view the most recent events in the CloudTrail console in Event history. Using the
|
|
238
|
+
* information collected by CloudTrail you can determine the request that was made to
|
|
239
|
+
* Security Lake, the IP address from which the request was made, who made the request, when it
|
|
240
|
+
* was made, and additional details. To learn more about Security Lake information in CloudTrail, see the <a href="https://docs.aws.amazon.com/security-lake/latest/userguide/securitylake-cloudtrail.html">Amazon Security Lake User Guide</a>.</p>
|
|
241
|
+
* <p>Security Lake automates the collection of security-related log and event data from
|
|
242
|
+
* integrated Amazon Web Services and third-party services. It also helps you manage
|
|
243
|
+
* the lifecycle of data with customizable retention and replication settings. Security Lake
|
|
244
|
+
* converts ingested data into Apache Parquet format and a standard open-source schema called
|
|
245
|
+
* the Open Cybersecurity Schema Framework (OCSF).</p>
|
|
246
|
+
* <p>Other Amazon Web Services and third-party services can subscribe to the data that's stored in Security Lake for
|
|
247
|
+
* incident response and security data analytics.</p>
|
|
248
|
+
*/
|
|
249
|
+
export declare class SecurityLake extends SecurityLakeClient implements SecurityLake {
|
|
250
|
+
}
|
|
@@ -120,7 +120,7 @@ import {
|
|
|
120
120
|
UpdateSubscriptionNotificationConfigurationCommandOutput,
|
|
121
121
|
} from "./commands/UpdateSubscriptionNotificationConfigurationCommand";
|
|
122
122
|
import { SecurityLakeClient } from "./SecurityLakeClient";
|
|
123
|
-
export
|
|
123
|
+
export interface SecurityLake {
|
|
124
124
|
createAwsLogSource(
|
|
125
125
|
args: CreateAwsLogSourceCommandInput,
|
|
126
126
|
options?: __HttpHandlerOptions
|
|
@@ -554,3 +554,6 @@ export declare class SecurityLake extends SecurityLakeClient {
|
|
|
554
554
|
) => void
|
|
555
555
|
): void;
|
|
556
556
|
}
|
|
557
|
+
export declare class SecurityLake
|
|
558
|
+
extends SecurityLakeClient
|
|
559
|
+
implements SecurityLake {}
|
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.316.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,9 +21,9 @@
|
|
|
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.
|
|
24
|
+
"@aws-sdk/client-sts": "3.316.0",
|
|
25
25
|
"@aws-sdk/config-resolver": "3.310.0",
|
|
26
|
-
"@aws-sdk/credential-provider-node": "3.
|
|
26
|
+
"@aws-sdk/credential-provider-node": "3.316.0",
|
|
27
27
|
"@aws-sdk/fetch-http-handler": "3.310.0",
|
|
28
28
|
"@aws-sdk/hash-node": "3.310.0",
|
|
29
29
|
"@aws-sdk/invalid-dependency": "3.310.0",
|
|
@@ -40,14 +40,14 @@
|
|
|
40
40
|
"@aws-sdk/node-config-provider": "3.310.0",
|
|
41
41
|
"@aws-sdk/node-http-handler": "3.310.0",
|
|
42
42
|
"@aws-sdk/protocol-http": "3.310.0",
|
|
43
|
-
"@aws-sdk/smithy-client": "3.
|
|
43
|
+
"@aws-sdk/smithy-client": "3.316.0",
|
|
44
44
|
"@aws-sdk/types": "3.310.0",
|
|
45
45
|
"@aws-sdk/url-parser": "3.310.0",
|
|
46
46
|
"@aws-sdk/util-base64": "3.310.0",
|
|
47
47
|
"@aws-sdk/util-body-length-browser": "3.310.0",
|
|
48
48
|
"@aws-sdk/util-body-length-node": "3.310.0",
|
|
49
|
-
"@aws-sdk/util-defaults-mode-browser": "3.
|
|
50
|
-
"@aws-sdk/util-defaults-mode-node": "3.
|
|
49
|
+
"@aws-sdk/util-defaults-mode-browser": "3.316.0",
|
|
50
|
+
"@aws-sdk/util-defaults-mode-node": "3.316.0",
|
|
51
51
|
"@aws-sdk/util-endpoints": "3.310.0",
|
|
52
52
|
"@aws-sdk/util-retry": "3.310.0",
|
|
53
53
|
"@aws-sdk/util-user-agent-browser": "3.310.0",
|