@aws-sdk/client-securitylake 3.341.0 → 3.342.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +39 -60
- package/dist-cjs/SecurityLake.js +36 -40
- package/dist-cjs/commands/{UpdateDatalakeCommand.js → CreateDataLakeCommand.js} +7 -7
- package/dist-cjs/commands/CreateDataLakeExceptionSubscriptionCommand.js +46 -0
- package/dist-cjs/commands/CreateDataLakeOrganizationConfigurationCommand.js +46 -0
- package/dist-cjs/commands/{DeleteDatalakeDelegatedAdminCommand.js → CreateSubscriberNotificationCommand.js} +7 -7
- package/dist-cjs/commands/{CreateDatalakeCommand.js → DeleteDataLakeCommand.js} +7 -7
- package/dist-cjs/commands/DeleteDataLakeExceptionSubscriptionCommand.js +46 -0
- package/dist-cjs/commands/DeleteDataLakeOrganizationConfigurationCommand.js +46 -0
- package/dist-cjs/commands/{CreateDatalakeDelegatedAdminCommand.js → DeleteSubscriberNotificationCommand.js} +7 -7
- package/dist-cjs/commands/DeregisterDataLakeDelegatedAdministratorCommand.js +46 -0
- package/dist-cjs/commands/{CreateDatalakeAutoEnableCommand.js → GetDataLakeExceptionSubscriptionCommand.js} +7 -7
- package/dist-cjs/commands/{DeleteDatalakeExceptionsSubscriptionCommand.js → GetDataLakeOrganizationConfigurationCommand.js} +7 -7
- package/dist-cjs/commands/{GetDatalakeStatusCommand.js → GetDataLakeSourcesCommand.js} +7 -7
- package/dist-cjs/commands/{ListDatalakeExceptionsCommand.js → ListDataLakeExceptionsCommand.js} +7 -7
- package/dist-cjs/commands/{GetDatalakeCommand.js → ListDataLakesCommand.js} +7 -7
- package/dist-cjs/commands/{CreateDatalakeExceptionsSubscriptionCommand.js → RegisterDataLakeDelegatedAdministratorCommand.js} +7 -7
- package/dist-cjs/commands/{DeleteDatalakeCommand.js → UpdateDataLakeCommand.js} +7 -7
- package/dist-cjs/commands/UpdateDataLakeExceptionSubscriptionCommand.js +46 -0
- package/dist-cjs/commands/{DeleteDatalakeAutoEnableCommand.js → UpdateSubscriberNotificationCommand.js} +7 -7
- package/dist-cjs/commands/index.js +18 -20
- package/dist-cjs/models/models_0.js +43 -235
- package/dist-cjs/pagination/{GetDatalakeStatusPaginator.js → GetDataLakeSourcesPaginator.js} +6 -6
- package/dist-cjs/pagination/{ListDatalakeExceptionsPaginator.js → ListDataLakeExceptionsPaginator.js} +6 -6
- package/dist-cjs/pagination/index.js +2 -2
- package/dist-cjs/protocols/Aws_restJson1.js +531 -769
- package/dist-es/SecurityLake.js +36 -40
- package/dist-es/commands/{UpdateDatalakeCommand.js → CreateDataLakeCommand.js} +6 -6
- package/dist-es/commands/{UpdateDatalakeExceptionsSubscriptionCommand.js → CreateDataLakeExceptionSubscriptionCommand.js} +6 -6
- package/dist-es/commands/CreateDataLakeOrganizationConfigurationCommand.js +42 -0
- package/dist-es/commands/{DeleteDatalakeDelegatedAdminCommand.js → CreateSubscriberNotificationCommand.js} +6 -6
- package/dist-es/commands/{CreateDatalakeCommand.js → DeleteDataLakeCommand.js} +6 -6
- package/dist-es/commands/{CreateDatalakeExceptionsSubscriptionCommand.js → DeleteDataLakeExceptionSubscriptionCommand.js} +6 -6
- package/dist-es/commands/DeleteDataLakeOrganizationConfigurationCommand.js +42 -0
- package/dist-es/commands/{CreateDatalakeDelegatedAdminCommand.js → DeleteSubscriberNotificationCommand.js} +6 -6
- package/dist-es/commands/DeregisterDataLakeDelegatedAdministratorCommand.js +42 -0
- package/dist-es/commands/{GetDatalakeExceptionsSubscriptionCommand.js → GetDataLakeExceptionSubscriptionCommand.js} +6 -6
- package/dist-es/commands/{DeleteDatalakeExceptionsSubscriptionCommand.js → GetDataLakeOrganizationConfigurationCommand.js} +6 -6
- package/dist-es/commands/{GetDatalakeStatusCommand.js → GetDataLakeSourcesCommand.js} +6 -6
- package/dist-es/commands/{ListDatalakeExceptionsCommand.js → ListDataLakeExceptionsCommand.js} +6 -6
- package/dist-es/commands/{GetDatalakeCommand.js → ListDataLakesCommand.js} +6 -6
- package/dist-es/commands/RegisterDataLakeDelegatedAdministratorCommand.js +42 -0
- package/dist-es/commands/{DeleteDatalakeCommand.js → UpdateDataLakeCommand.js} +6 -6
- package/dist-es/commands/{CreateDatalakeAutoEnableCommand.js → UpdateDataLakeExceptionSubscriptionCommand.js} +6 -6
- package/dist-es/commands/{GetDatalakeExceptionsExpiryCommand.js → UpdateSubscriberNotificationCommand.js} +6 -6
- package/dist-es/commands/index.js +18 -20
- package/dist-es/models/models_0.js +41 -224
- package/dist-es/pagination/{GetDatalakeStatusPaginator.js → GetDataLakeSourcesPaginator.js} +4 -4
- package/dist-es/pagination/{ListDatalakeExceptionsPaginator.js → ListDataLakeExceptionsPaginator.js} +4 -4
- package/dist-es/pagination/index.js +2 -2
- package/dist-es/protocols/Aws_restJson1.js +491 -725
- package/dist-types/SecurityLake.d.ts +96 -115
- package/dist-types/SecurityLakeClient.d.ts +24 -31
- package/dist-types/commands/CreateAwsLogSourceCommand.d.ts +22 -41
- package/dist-types/commands/CreateCustomLogSourceCommand.d.ts +39 -23
- package/dist-types/commands/CreateDataLakeCommand.d.ts +172 -0
- package/dist-types/commands/CreateDataLakeExceptionSubscriptionCommand.d.ts +99 -0
- package/dist-types/commands/CreateDataLakeOrganizationConfigurationCommand.d.ts +108 -0
- package/dist-types/commands/CreateSubscriberCommand.d.ts +78 -32
- package/dist-types/commands/CreateSubscriberNotificationCommand.d.ts +110 -0
- package/dist-types/commands/DeleteAwsLogSourceCommand.d.ts +29 -39
- package/dist-types/commands/DeleteCustomLogSourceCommand.d.ts +15 -18
- package/dist-types/commands/{DeleteDatalakeCommand.d.ts → DeleteDataLakeCommand.d.ts} +33 -33
- package/dist-types/commands/DeleteDataLakeExceptionSubscriptionCommand.d.ts +95 -0
- package/dist-types/commands/DeleteDataLakeOrganizationConfigurationCommand.d.ts +110 -0
- package/dist-types/commands/DeleteSubscriberCommand.d.ts +15 -21
- package/dist-types/commands/DeleteSubscriberNotificationCommand.d.ts +97 -0
- package/dist-types/commands/DeregisterDataLakeDelegatedAdministratorCommand.d.ts +96 -0
- package/dist-types/commands/GetDataLakeExceptionSubscriptionCommand.d.ts +98 -0
- package/dist-types/commands/GetDataLakeOrganizationConfigurationCommand.d.ts +108 -0
- package/dist-types/commands/GetDataLakeSourcesCommand.d.ts +119 -0
- package/dist-types/commands/GetSubscriberCommand.d.ts +47 -28
- package/dist-types/commands/{ListDatalakeExceptionsCommand.d.ts → ListDataLakeExceptionsCommand.d.ts} +39 -36
- package/dist-types/commands/ListDataLakesCommand.d.ts +136 -0
- package/dist-types/commands/ListLogSourcesCommand.d.ts +60 -29
- package/dist-types/commands/ListSubscribersCommand.d.ts +46 -30
- package/dist-types/commands/RegisterDataLakeDelegatedAdministratorCommand.d.ts +98 -0
- package/dist-types/commands/UpdateDataLakeCommand.d.ts +158 -0
- package/dist-types/commands/UpdateDataLakeExceptionSubscriptionCommand.d.ts +99 -0
- package/dist-types/commands/UpdateSubscriberCommand.d.ts +73 -42
- package/dist-types/commands/UpdateSubscriberNotificationCommand.d.ts +109 -0
- package/dist-types/commands/index.d.ts +18 -20
- package/dist-types/index.d.ts +4 -9
- package/dist-types/models/models_0.d.ts +985 -906
- package/dist-types/pagination/GetDataLakeSourcesPaginator.d.ts +7 -0
- package/dist-types/pagination/ListDataLakeExceptionsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +2 -2
- package/dist-types/protocols/Aws_restJson1.d.ts +94 -112
- package/dist-types/ts3.4/SecurityLake.d.ts +243 -271
- package/dist-types/ts3.4/SecurityLakeClient.d.ts +91 -103
- package/dist-types/ts3.4/commands/{CreateDatalakeCommand.d.ts → CreateDataLakeCommand.d.ts} +11 -11
- package/dist-types/ts3.4/commands/{GetDatalakeExceptionsSubscriptionCommand.d.ts → CreateDataLakeExceptionSubscriptionCommand.d.ts} +13 -13
- package/dist-types/ts3.4/commands/{CreateDatalakeExceptionsSubscriptionCommand.d.ts → CreateDataLakeOrganizationConfigurationCommand.d.ts} +13 -13
- package/dist-types/ts3.4/commands/{DeleteDatalakeDelegatedAdminCommand.d.ts → CreateSubscriberNotificationCommand.d.ts} +13 -13
- package/dist-types/ts3.4/commands/{DeleteDatalakeCommand.d.ts → DeleteDataLakeCommand.d.ts} +11 -11
- package/dist-types/ts3.4/commands/DeleteDataLakeExceptionSubscriptionCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/DeleteDataLakeOrganizationConfigurationCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/{CreateDatalakeDelegatedAdminCommand.d.ts → DeleteSubscriberNotificationCommand.d.ts} +13 -13
- package/dist-types/ts3.4/commands/DeregisterDataLakeDelegatedAdministratorCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/{DeleteDatalakeAutoEnableCommand.d.ts → GetDataLakeExceptionSubscriptionCommand.d.ts} +13 -13
- package/dist-types/ts3.4/commands/{DeleteDatalakeExceptionsSubscriptionCommand.d.ts → GetDataLakeOrganizationConfigurationCommand.d.ts} +13 -13
- package/dist-types/ts3.4/commands/GetDataLakeSourcesCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/{ListDatalakeExceptionsCommand.d.ts → ListDataLakeExceptionsCommand.d.ts} +13 -13
- package/dist-types/ts3.4/commands/{GetDatalakeStatusCommand.d.ts → ListDataLakesCommand.d.ts} +11 -12
- package/dist-types/ts3.4/commands/RegisterDataLakeDelegatedAdministratorCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/{UpdateDatalakeCommand.d.ts → UpdateDataLakeCommand.d.ts} +11 -11
- package/dist-types/ts3.4/commands/UpdateDataLakeExceptionSubscriptionCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/{CreateDatalakeAutoEnableCommand.d.ts → UpdateSubscriberNotificationCommand.d.ts} +13 -13
- package/dist-types/ts3.4/commands/index.d.ts +18 -20
- package/dist-types/ts3.4/models/models_0.d.ts +315 -431
- package/dist-types/ts3.4/pagination/GetDataLakeSourcesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListDataLakeExceptionsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +2 -2
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +131 -155
- package/package.json +28 -28
- package/dist-cjs/commands/CreateSubscriptionNotificationConfigurationCommand.js +0 -46
- package/dist-cjs/commands/DeleteSubscriptionNotificationConfigurationCommand.js +0 -46
- package/dist-cjs/commands/GetDatalakeAutoEnableCommand.js +0 -46
- package/dist-cjs/commands/GetDatalakeExceptionsExpiryCommand.js +0 -46
- package/dist-cjs/commands/GetDatalakeExceptionsSubscriptionCommand.js +0 -46
- package/dist-cjs/commands/UpdateDatalakeExceptionsExpiryCommand.js +0 -46
- package/dist-cjs/commands/UpdateDatalakeExceptionsSubscriptionCommand.js +0 -46
- package/dist-cjs/commands/UpdateSubscriptionNotificationConfigurationCommand.js +0 -46
- package/dist-es/commands/CreateSubscriptionNotificationConfigurationCommand.js +0 -42
- package/dist-es/commands/DeleteDatalakeAutoEnableCommand.js +0 -42
- package/dist-es/commands/DeleteSubscriptionNotificationConfigurationCommand.js +0 -42
- package/dist-es/commands/GetDatalakeAutoEnableCommand.js +0 -42
- package/dist-es/commands/UpdateDatalakeExceptionsExpiryCommand.js +0 -42
- package/dist-es/commands/UpdateSubscriptionNotificationConfigurationCommand.js +0 -42
- package/dist-types/commands/CreateDatalakeAutoEnableCommand.d.ts +0 -98
- package/dist-types/commands/CreateDatalakeCommand.d.ts +0 -137
- package/dist-types/commands/CreateDatalakeDelegatedAdminCommand.d.ts +0 -89
- package/dist-types/commands/CreateDatalakeExceptionsSubscriptionCommand.d.ts +0 -91
- package/dist-types/commands/CreateSubscriptionNotificationConfigurationCommand.d.ts +0 -109
- package/dist-types/commands/DeleteDatalakeAutoEnableCommand.d.ts +0 -101
- package/dist-types/commands/DeleteDatalakeDelegatedAdminCommand.d.ts +0 -89
- package/dist-types/commands/DeleteDatalakeExceptionsSubscriptionCommand.d.ts +0 -90
- package/dist-types/commands/DeleteSubscriptionNotificationConfigurationCommand.d.ts +0 -100
- package/dist-types/commands/GetDatalakeAutoEnableCommand.d.ts +0 -98
- package/dist-types/commands/GetDatalakeCommand.d.ts +0 -120
- package/dist-types/commands/GetDatalakeExceptionsExpiryCommand.d.ts +0 -91
- package/dist-types/commands/GetDatalakeExceptionsSubscriptionCommand.d.ts +0 -92
- package/dist-types/commands/GetDatalakeStatusCommand.d.ts +0 -109
- package/dist-types/commands/UpdateDatalakeCommand.d.ts +0 -108
- package/dist-types/commands/UpdateDatalakeExceptionsExpiryCommand.d.ts +0 -91
- package/dist-types/commands/UpdateDatalakeExceptionsSubscriptionCommand.d.ts +0 -91
- package/dist-types/commands/UpdateSubscriptionNotificationConfigurationCommand.d.ts +0 -108
- package/dist-types/pagination/GetDatalakeStatusPaginator.d.ts +0 -7
- package/dist-types/pagination/ListDatalakeExceptionsPaginator.d.ts +0 -7
- package/dist-types/ts3.4/commands/CreateSubscriptionNotificationConfigurationCommand.d.ts +0 -42
- package/dist-types/ts3.4/commands/DeleteSubscriptionNotificationConfigurationCommand.d.ts +0 -42
- package/dist-types/ts3.4/commands/GetDatalakeAutoEnableCommand.d.ts +0 -42
- package/dist-types/ts3.4/commands/GetDatalakeCommand.d.ts +0 -35
- package/dist-types/ts3.4/commands/GetDatalakeExceptionsExpiryCommand.d.ts +0 -42
- package/dist-types/ts3.4/commands/UpdateDatalakeExceptionsExpiryCommand.d.ts +0 -42
- package/dist-types/ts3.4/commands/UpdateDatalakeExceptionsSubscriptionCommand.d.ts +0 -42
- package/dist-types/ts3.4/commands/UpdateSubscriptionNotificationConfigurationCommand.d.ts +0 -42
- package/dist-types/ts3.4/pagination/GetDatalakeStatusPaginator.d.ts +0 -11
- package/dist-types/ts3.4/pagination/ListDatalakeExceptionsPaginator.d.ts +0 -11
|
@@ -33,184 +33,81 @@ export declare const AccessType: {
|
|
|
33
33
|
export type AccessType = (typeof AccessType)[keyof typeof AccessType];
|
|
34
34
|
/**
|
|
35
35
|
* @public
|
|
36
|
-
* <p>
|
|
37
|
-
* specified, or the account whose credentials you used to make this request isn't a member of
|
|
38
|
-
* an organization.</p>
|
|
36
|
+
* <p>The AWS identity.</p>
|
|
39
37
|
*/
|
|
40
|
-
export
|
|
41
|
-
readonly name: "AccountNotFoundException";
|
|
42
|
-
readonly $fault: "client";
|
|
38
|
+
export interface AwsIdentity {
|
|
43
39
|
/**
|
|
44
|
-
*
|
|
40
|
+
* <p>The AWS identity principal.</p>
|
|
41
|
+
*/
|
|
42
|
+
principal: string | undefined;
|
|
43
|
+
/**
|
|
44
|
+
* <p>The external ID used to estalish trust relationship with the AWS identity.</p>
|
|
45
45
|
*/
|
|
46
|
-
|
|
46
|
+
externalId: string | undefined;
|
|
47
47
|
}
|
|
48
48
|
/**
|
|
49
49
|
* @public
|
|
50
50
|
* @enum
|
|
51
51
|
*/
|
|
52
|
-
export declare const
|
|
53
|
-
readonly
|
|
54
|
-
readonly
|
|
55
|
-
readonly
|
|
56
|
-
readonly
|
|
57
|
-
readonly
|
|
58
|
-
readonly
|
|
59
|
-
readonly CONFIG_STATE: "CONFIG_STATE";
|
|
60
|
-
readonly CONTAINER_LIFECYCLE: "CONTAINER_LIFECYCLE";
|
|
61
|
-
readonly DATABASE_LIFECYCLE: "DATABASE_LIFECYCLE";
|
|
62
|
-
readonly DHCP_ACTIVITY: "DHCP_ACTIVITY";
|
|
63
|
-
readonly DNS_ACTIVITY: "DNS_ACTIVITY";
|
|
64
|
-
readonly ENTITY_MANAGEMENT_AUDIT: "ENTITY_MANAGEMENT_AUDIT";
|
|
65
|
-
readonly FILE_ACTIVITY: "FILE_ACTIVITY";
|
|
66
|
-
readonly FTP_ACTIVITY: "FTP_ACTIVITY";
|
|
67
|
-
readonly HTTP_ACTIVITY: "HTTP_ACTIVITY";
|
|
68
|
-
readonly INVENTORY_INFO: "INVENTORY_INFO";
|
|
69
|
-
readonly KERNEL_ACTIVITY: "KERNEL_ACTIVITY";
|
|
70
|
-
readonly KERNEL_EXTENSION: "KERNEL_EXTENSION";
|
|
71
|
-
readonly MEMORY_ACTIVITY: "MEMORY_ACTIVITY";
|
|
72
|
-
readonly MODULE_ACTIVITY: "MODULE_ACTIVITY";
|
|
73
|
-
readonly NETWORK_ACTIVITY: "NETWORK_ACTIVITY";
|
|
74
|
-
readonly PROCESS_ACTIVITY: "PROCESS_ACTIVITY";
|
|
75
|
-
readonly RDP_ACTIVITY: "RDP_ACTIVITY";
|
|
76
|
-
readonly REGISTRY_KEY_ACTIVITY: "REGISTRY_KEY_ACTIVITY";
|
|
77
|
-
readonly REGISTRY_VALUE_ACTIVITY: "REGISTRY_VALUE_ACTIVITY";
|
|
78
|
-
readonly RESOURCE_ACTIVITY: "RESOURCE_ACTIVITY";
|
|
79
|
-
readonly RFB_ACTIVITY: "RFB_ACTIVITY";
|
|
80
|
-
readonly SCHEDULED_JOB_ACTIVITY: "SCHEDULED_JOB_ACTIVITY";
|
|
81
|
-
readonly SECURITY_FINDING: "SECURITY_FINDING";
|
|
82
|
-
readonly SMB_ACTIVITY: "SMB_ACTIVITY";
|
|
83
|
-
readonly SMTP_ACTIVITY: "SMTP_ACTIVITY";
|
|
84
|
-
readonly SSH_ACTIVITY: "SSH_ACTIVITY";
|
|
85
|
-
readonly VIRTUAL_MACHINE_ACTIVITY: "VIRTUAL_MACHINE_ACTIVITY";
|
|
86
|
-
};
|
|
87
|
-
/**
|
|
88
|
-
* @public
|
|
89
|
-
*/
|
|
90
|
-
export type OcsfEventClass = (typeof OcsfEventClass)[keyof typeof OcsfEventClass];
|
|
91
|
-
/**
|
|
92
|
-
* @public
|
|
93
|
-
* @enum
|
|
94
|
-
*/
|
|
95
|
-
export declare const SourceStatus: {
|
|
96
|
-
readonly ACTIVE: "ACTIVE";
|
|
97
|
-
readonly DEACTIVATED: "DEACTIVATED";
|
|
98
|
-
readonly PENDING: "PENDING";
|
|
52
|
+
export declare const AwsLogSourceName: {
|
|
53
|
+
readonly CLOUD_TRAIL_MGMT: "CLOUD_TRAIL_MGMT";
|
|
54
|
+
readonly LAMBDA_EXECUTION: "LAMBDA_EXECUTION";
|
|
55
|
+
readonly ROUTE53: "ROUTE53";
|
|
56
|
+
readonly S3_DATA: "S3_DATA";
|
|
57
|
+
readonly SH_FINDINGS: "SH_FINDINGS";
|
|
58
|
+
readonly VPC_FLOW: "VPC_FLOW";
|
|
99
59
|
};
|
|
100
60
|
/**
|
|
101
61
|
* @public
|
|
102
62
|
*/
|
|
103
|
-
export type
|
|
104
|
-
/**
|
|
105
|
-
* @public
|
|
106
|
-
* <p>Retrieves the Logs status for the Amazon Security Lake account.</p>
|
|
107
|
-
*/
|
|
108
|
-
export interface LogsStatus {
|
|
109
|
-
/**
|
|
110
|
-
* <p>Defines path the stored logs are available which has information on your systems,
|
|
111
|
-
* applications, and services. </p>
|
|
112
|
-
*/
|
|
113
|
-
pathToLogs: string | undefined;
|
|
114
|
-
/**
|
|
115
|
-
* <p>The health status of services, including error codes and patterns.</p>
|
|
116
|
-
*/
|
|
117
|
-
healthStatus: SourceStatus | string | undefined;
|
|
118
|
-
}
|
|
63
|
+
export type AwsLogSourceName = (typeof AwsLogSourceName)[keyof typeof AwsLogSourceName];
|
|
119
64
|
/**
|
|
120
65
|
* @public
|
|
121
|
-
* <p>
|
|
122
|
-
* 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>
|
|
66
|
+
* <p>The Security Lake logs source configuration file describes the information needed to generate Security Lake logs. </p>
|
|
123
67
|
*/
|
|
124
|
-
export interface
|
|
68
|
+
export interface AwsLogSourceConfiguration {
|
|
125
69
|
/**
|
|
126
|
-
* <p>
|
|
70
|
+
* <p>Specify the Amazon Web Services account information where you want to enable Security Lake.</p>
|
|
127
71
|
*/
|
|
128
|
-
|
|
72
|
+
accounts?: string[];
|
|
129
73
|
/**
|
|
130
|
-
* <p>
|
|
131
|
-
* Amazon Security Lake supports log and event collection for natively supported Amazon Web Services. </p>
|
|
74
|
+
* <p>Specify the Regions where you want to enable Security Lake.</p>
|
|
132
75
|
*/
|
|
133
|
-
|
|
76
|
+
regions: string[] | undefined;
|
|
134
77
|
/**
|
|
135
|
-
* <p>The
|
|
78
|
+
* <p>The name for a Amazon Web Services source. This must be a Regionally unique value.</p>
|
|
136
79
|
*/
|
|
137
|
-
|
|
80
|
+
sourceName: AwsLogSourceName | string | undefined;
|
|
138
81
|
/**
|
|
139
|
-
* <p>
|
|
82
|
+
* <p>The version for a Amazon Web Services source. This must be a Regionally unique value.</p>
|
|
140
83
|
*/
|
|
141
|
-
|
|
84
|
+
sourceVersion?: string;
|
|
142
85
|
}
|
|
143
86
|
/**
|
|
144
87
|
* @public
|
|
145
|
-
*
|
|
88
|
+
* <p>Amazon Security Lake can collect logs and events from natively-supported Amazon Web Services services.</p>
|
|
146
89
|
*/
|
|
147
|
-
export
|
|
148
|
-
readonly AP_NORTHEAST_1: "ap-northeast-1";
|
|
149
|
-
readonly AP_SOUTHEAST_2: "ap-southeast-2";
|
|
150
|
-
readonly EU_CENTRAL_1: "eu-central-1";
|
|
151
|
-
readonly EU_WEST_1: "eu-west-1";
|
|
152
|
-
readonly US_EAST_1: "us-east-1";
|
|
153
|
-
readonly US_EAST_2: "us-east-2";
|
|
154
|
-
readonly US_WEST_2: "us-west-2";
|
|
155
|
-
};
|
|
156
|
-
/**
|
|
157
|
-
* @public
|
|
158
|
-
*/
|
|
159
|
-
export type Region = (typeof Region)[keyof typeof Region];
|
|
160
|
-
/**
|
|
161
|
-
* @public
|
|
162
|
-
* @enum
|
|
163
|
-
*/
|
|
164
|
-
export declare const AwsLogSourceType: {
|
|
165
|
-
readonly CLOUD_TRAIL: "CLOUD_TRAIL";
|
|
166
|
-
readonly ROUTE53: "ROUTE53";
|
|
167
|
-
readonly SH_FINDINGS: "SH_FINDINGS";
|
|
168
|
-
readonly VPC_FLOW: "VPC_FLOW";
|
|
169
|
-
};
|
|
170
|
-
/**
|
|
171
|
-
* @public
|
|
172
|
-
*/
|
|
173
|
-
export type AwsLogSourceType = (typeof AwsLogSourceType)[keyof typeof AwsLogSourceType];
|
|
174
|
-
/**
|
|
175
|
-
* @public
|
|
176
|
-
* <p>Automatically enable new organization accounts as member accounts from an Amazon Security Lake
|
|
177
|
-
* administrator account.</p>
|
|
178
|
-
*/
|
|
179
|
-
export interface AutoEnableNewRegionConfiguration {
|
|
90
|
+
export interface AwsLogSourceResource {
|
|
180
91
|
/**
|
|
181
|
-
* <p>The Amazon Web Services
|
|
92
|
+
* <p>The name for a Amazon Web Services source. This must be a Regionally unique value.</p>
|
|
182
93
|
*/
|
|
183
|
-
|
|
94
|
+
sourceName?: AwsLogSourceName | string;
|
|
184
95
|
/**
|
|
185
|
-
* <p>The Amazon Web Services
|
|
96
|
+
* <p>The version for a Amazon Web Services source. This must be a Regionally unique value.</p>
|
|
186
97
|
*/
|
|
187
|
-
|
|
98
|
+
sourceVersion?: string;
|
|
188
99
|
}
|
|
189
100
|
/**
|
|
190
101
|
* @public
|
|
191
|
-
* <p>
|
|
192
|
-
* bucket.</p>
|
|
102
|
+
* <p>The request is malformed or contains an error such as an invalid parameter value or a missing required parameter.</p>
|
|
193
103
|
*/
|
|
194
|
-
export declare class
|
|
195
|
-
readonly name: "
|
|
104
|
+
export declare class BadRequestException extends __BaseException {
|
|
105
|
+
readonly name: "BadRequestException";
|
|
196
106
|
readonly $fault: "client";
|
|
197
107
|
/**
|
|
198
108
|
* @internal
|
|
199
109
|
*/
|
|
200
|
-
constructor(opts: __ExceptionOptionType<
|
|
201
|
-
}
|
|
202
|
-
/**
|
|
203
|
-
* @public
|
|
204
|
-
* <p>More than one process tried to modify a resource at the same time. </p>
|
|
205
|
-
*/
|
|
206
|
-
export declare class ConcurrentModificationException extends __BaseException {
|
|
207
|
-
readonly name: "ConcurrentModificationException";
|
|
208
|
-
readonly $fault: "client";
|
|
209
|
-
$retryable: {};
|
|
210
|
-
/**
|
|
211
|
-
* @internal
|
|
212
|
-
*/
|
|
213
|
-
constructor(opts: __ExceptionOptionType<ConcurrentModificationException, __BaseException>);
|
|
110
|
+
constructor(opts: __ExceptionOptionType<BadRequestException, __BaseException>);
|
|
214
111
|
}
|
|
215
112
|
/**
|
|
216
113
|
* @public
|
|
@@ -223,88 +120,31 @@ export declare class ConflictException extends __BaseException {
|
|
|
223
120
|
readonly name: "ConflictException";
|
|
224
121
|
readonly $fault: "client";
|
|
225
122
|
/**
|
|
226
|
-
* <p>
|
|
123
|
+
* <p>The resource name.</p>
|
|
227
124
|
*/
|
|
228
|
-
|
|
125
|
+
resourceName?: string;
|
|
229
126
|
/**
|
|
230
|
-
* <p>The resource type
|
|
127
|
+
* <p>The resource type.</p>
|
|
231
128
|
*/
|
|
232
|
-
resourceType
|
|
129
|
+
resourceType?: string;
|
|
233
130
|
/**
|
|
234
131
|
* @internal
|
|
235
132
|
*/
|
|
236
133
|
constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
|
|
237
134
|
}
|
|
238
|
-
/**
|
|
239
|
-
* @public
|
|
240
|
-
* <p>There was a conflict when you attempted to modify a Security Lake source name. </p>
|
|
241
|
-
*/
|
|
242
|
-
export declare class ConflictSourceNamesException extends __BaseException {
|
|
243
|
-
readonly name: "ConflictSourceNamesException";
|
|
244
|
-
readonly $fault: "client";
|
|
245
|
-
/**
|
|
246
|
-
* @internal
|
|
247
|
-
*/
|
|
248
|
-
constructor(opts: __ExceptionOptionType<ConflictSourceNamesException, __BaseException>);
|
|
249
|
-
}
|
|
250
|
-
/**
|
|
251
|
-
* @public
|
|
252
|
-
* <p>A conflicting subscription exception operation is in progress. </p>
|
|
253
|
-
*/
|
|
254
|
-
export declare class ConflictSubscriptionException extends __BaseException {
|
|
255
|
-
readonly name: "ConflictSubscriptionException";
|
|
256
|
-
readonly $fault: "client";
|
|
257
|
-
/**
|
|
258
|
-
* @internal
|
|
259
|
-
*/
|
|
260
|
-
constructor(opts: __ExceptionOptionType<ConflictSubscriptionException, __BaseException>);
|
|
261
|
-
}
|
|
262
|
-
/**
|
|
263
|
-
* @public
|
|
264
|
-
* @enum
|
|
265
|
-
*/
|
|
266
|
-
export declare const Dimension: {
|
|
267
|
-
readonly MEMBER: "MEMBER";
|
|
268
|
-
readonly REGION: "REGION";
|
|
269
|
-
readonly SOURCE_TYPE: "SOURCE_TYPE";
|
|
270
|
-
};
|
|
271
|
-
/**
|
|
272
|
-
* @public
|
|
273
|
-
*/
|
|
274
|
-
export type Dimension = (typeof Dimension)[keyof typeof Dimension];
|
|
275
135
|
/**
|
|
276
136
|
* @public
|
|
277
137
|
*/
|
|
278
138
|
export interface CreateAwsLogSourceRequest {
|
|
279
139
|
/**
|
|
280
|
-
* <p>
|
|
281
|
-
* and member account.</p>
|
|
282
|
-
*/
|
|
283
|
-
inputOrder: (Dimension | string)[] | undefined;
|
|
284
|
-
/**
|
|
285
|
-
* <p>Enables data collection from specific Amazon Web Services sources in all specific
|
|
286
|
-
* accounts and specific Regions.</p>
|
|
140
|
+
* <p>Specify the natively-supported Amazon Web Services service to add as a source in Security Lake.</p>
|
|
287
141
|
*/
|
|
288
|
-
|
|
289
|
-
/**
|
|
290
|
-
* <p>Enables data collection from specific Amazon Web Services sources in specific accounts or
|
|
291
|
-
* Regions.</p>
|
|
292
|
-
*/
|
|
293
|
-
enableTwoDimensions?: Record<string, string[]>;
|
|
294
|
-
/**
|
|
295
|
-
* <p>Enables data collection from all Amazon Web Services sources in specific accounts or
|
|
296
|
-
* Regions.</p>
|
|
297
|
-
*/
|
|
298
|
-
enableSingleDimension?: string[];
|
|
142
|
+
sources: AwsLogSourceConfiguration[] | undefined;
|
|
299
143
|
}
|
|
300
144
|
/**
|
|
301
145
|
* @public
|
|
302
146
|
*/
|
|
303
147
|
export interface CreateAwsLogSourceResponse {
|
|
304
|
-
/**
|
|
305
|
-
* <p>Lists the accounts that are in the process of enabling a natively supported Amazon Web Service as a Security Lake source.</p>
|
|
306
|
-
*/
|
|
307
|
-
processing?: string[];
|
|
308
148
|
/**
|
|
309
149
|
* <p>Lists all accounts in which enabling a natively supported Amazon Web Service as
|
|
310
150
|
* a Security Lake source failed. The failure occurred as these accounts are not part of an
|
|
@@ -315,16 +155,12 @@ export interface CreateAwsLogSourceResponse {
|
|
|
315
155
|
/**
|
|
316
156
|
* @public
|
|
317
157
|
* <p>Internal service exceptions are sometimes caused by transient issues. Before you start
|
|
318
|
-
* troubleshooting, perform the operation again
|
|
158
|
+
* troubleshooting, perform the operation again.</p>
|
|
319
159
|
*/
|
|
320
160
|
export declare class InternalServerException extends __BaseException {
|
|
321
161
|
readonly name: "InternalServerException";
|
|
322
162
|
readonly $fault: "server";
|
|
323
163
|
$retryable: {};
|
|
324
|
-
/**
|
|
325
|
-
* <p>Retry the request after the specified time. </p>
|
|
326
|
-
*/
|
|
327
|
-
retryAfterSeconds?: number;
|
|
328
164
|
/**
|
|
329
165
|
* @internal
|
|
330
166
|
*/
|
|
@@ -338,13 +174,13 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
338
174
|
readonly name: "ResourceNotFoundException";
|
|
339
175
|
readonly $fault: "client";
|
|
340
176
|
/**
|
|
341
|
-
* <p>The
|
|
177
|
+
* <p>The name of the resource that could not be found.</p>
|
|
342
178
|
*/
|
|
343
|
-
|
|
179
|
+
resourceName?: string;
|
|
344
180
|
/**
|
|
345
181
|
* <p>The type of the resource that could not be found.</p>
|
|
346
182
|
*/
|
|
347
|
-
resourceType
|
|
183
|
+
resourceType?: string;
|
|
348
184
|
/**
|
|
349
185
|
* @internal
|
|
350
186
|
*/
|
|
@@ -352,183 +188,360 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
352
188
|
}
|
|
353
189
|
/**
|
|
354
190
|
* @public
|
|
355
|
-
* <p>
|
|
356
|
-
* Amazon S3 extended request ID. If Amazon S3 is incorrectly handling a
|
|
357
|
-
* request and you need to contact Amazon, this extended request ID may provide useful
|
|
358
|
-
* debugging information. </p>
|
|
191
|
+
* <p>The limit on the number of requests per second was exceeded.</p>
|
|
359
192
|
*/
|
|
360
|
-
export declare class
|
|
361
|
-
readonly name: "
|
|
193
|
+
export declare class ThrottlingException extends __BaseException {
|
|
194
|
+
readonly name: "ThrottlingException";
|
|
362
195
|
readonly $fault: "client";
|
|
196
|
+
$retryable: {
|
|
197
|
+
throttling: boolean;
|
|
198
|
+
};
|
|
363
199
|
/**
|
|
364
|
-
*
|
|
200
|
+
* <p>The code for the service in Service Quotas.</p>
|
|
365
201
|
*/
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
*/
|
|
372
|
-
export interface ValidationExceptionField {
|
|
202
|
+
serviceCode?: string;
|
|
203
|
+
/**
|
|
204
|
+
* <p>That the rate of requests to Security Lake is exceeding the request quotas for your Amazon Web Services account.</p>
|
|
205
|
+
*/
|
|
206
|
+
quotaCode?: string;
|
|
373
207
|
/**
|
|
374
|
-
* <p>
|
|
208
|
+
* <p>Retry the request after the specified time.</p>
|
|
375
209
|
*/
|
|
376
|
-
|
|
210
|
+
retryAfterSeconds?: number;
|
|
377
211
|
/**
|
|
378
|
-
*
|
|
212
|
+
* @internal
|
|
379
213
|
*/
|
|
380
|
-
|
|
214
|
+
constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
|
|
381
215
|
}
|
|
382
216
|
/**
|
|
383
217
|
* @public
|
|
384
|
-
*
|
|
385
|
-
*/
|
|
386
|
-
export declare const ValidationExceptionReason: {
|
|
387
|
-
readonly CANNOT_PARSE: "cannotParse";
|
|
388
|
-
readonly FIELD_VALIDATION_FAILED: "fieldValidationFailed";
|
|
389
|
-
readonly OTHER: "other";
|
|
390
|
-
readonly UNKNOWN_OPERATION: "unknownOperation";
|
|
391
|
-
};
|
|
392
|
-
/**
|
|
393
|
-
* @public
|
|
218
|
+
* <p>The configuration for the Glue Crawler for the third-party custom source.</p>
|
|
394
219
|
*/
|
|
395
|
-
export
|
|
220
|
+
export interface CustomLogSourceCrawlerConfiguration {
|
|
221
|
+
/**
|
|
222
|
+
* <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role
|
|
223
|
+
* to be used by the Glue crawler. The recommended IAM policies
|
|
224
|
+
* are:</p>
|
|
225
|
+
* <ul>
|
|
226
|
+
* <li>
|
|
227
|
+
* <p>The managed policy <code>AWSGlueServiceRole</code>
|
|
228
|
+
* </p>
|
|
229
|
+
* </li>
|
|
230
|
+
* <li>
|
|
231
|
+
* <p>A custom policy granting access to your Amazon S3 Data Lake</p>
|
|
232
|
+
* </li>
|
|
233
|
+
* </ul>
|
|
234
|
+
*/
|
|
235
|
+
roleArn: string | undefined;
|
|
236
|
+
}
|
|
396
237
|
/**
|
|
397
238
|
* @public
|
|
398
|
-
* <p>
|
|
239
|
+
* <p>The configuration for the third-party custom source.</p>
|
|
399
240
|
*/
|
|
400
|
-
export
|
|
401
|
-
readonly name: "ValidationException";
|
|
402
|
-
readonly $fault: "client";
|
|
403
|
-
/**
|
|
404
|
-
* <p>The reason for the validation exception. </p>
|
|
405
|
-
*/
|
|
406
|
-
reason: ValidationExceptionReason | string | undefined;
|
|
241
|
+
export interface CustomLogSourceConfiguration {
|
|
407
242
|
/**
|
|
408
|
-
* <p>The
|
|
243
|
+
* <p>The configuration for the Glue Crawler for the third-party custom source.</p>
|
|
409
244
|
*/
|
|
410
|
-
|
|
245
|
+
crawlerConfiguration: CustomLogSourceCrawlerConfiguration | undefined;
|
|
411
246
|
/**
|
|
412
|
-
*
|
|
247
|
+
* <p>The identity of the log provider for the third-party custom source.</p>
|
|
413
248
|
*/
|
|
414
|
-
|
|
249
|
+
providerIdentity: AwsIdentity | undefined;
|
|
415
250
|
}
|
|
416
251
|
/**
|
|
417
252
|
* @public
|
|
418
253
|
*/
|
|
419
254
|
export interface CreateCustomLogSourceRequest {
|
|
420
255
|
/**
|
|
421
|
-
* <p>
|
|
256
|
+
* <p>Specify the name for a third-party custom source. This must be a Regionally unique
|
|
257
|
+
* value.</p>
|
|
422
258
|
*/
|
|
423
|
-
|
|
259
|
+
sourceName: string | undefined;
|
|
424
260
|
/**
|
|
425
|
-
* <p>
|
|
426
|
-
*
|
|
261
|
+
* <p>Specify the source version for the third-party custom source, to limit log collection to
|
|
262
|
+
* a specific version of custom data source.</p>
|
|
427
263
|
*/
|
|
428
|
-
|
|
264
|
+
sourceVersion?: string;
|
|
429
265
|
/**
|
|
430
|
-
* <p>The
|
|
431
|
-
*
|
|
432
|
-
* are:</p>
|
|
266
|
+
* <p>The Open Cybersecurity Schema Framework (OCSF) event classes which describes the type of
|
|
267
|
+
* data that the custom source will send to Security Lake. The supported event classes are:</p>
|
|
433
268
|
* <ul>
|
|
434
269
|
* <li>
|
|
435
|
-
* <p>
|
|
270
|
+
* <p>
|
|
271
|
+
* <code>ACCESS_ACTIVITY</code>
|
|
436
272
|
* </p>
|
|
437
273
|
* </li>
|
|
438
274
|
* <li>
|
|
439
|
-
* <p>
|
|
275
|
+
* <p>
|
|
276
|
+
* <code>FILE_ACTIVITY</code>
|
|
277
|
+
* </p>
|
|
278
|
+
* </li>
|
|
279
|
+
* <li>
|
|
280
|
+
* <p>
|
|
281
|
+
* <code>KERNEL_ACTIVITY</code>
|
|
282
|
+
* </p>
|
|
283
|
+
* </li>
|
|
284
|
+
* <li>
|
|
285
|
+
* <p>
|
|
286
|
+
* <code>KERNEL_EXTENSION</code>
|
|
287
|
+
* </p>
|
|
288
|
+
* </li>
|
|
289
|
+
* <li>
|
|
290
|
+
* <p>
|
|
291
|
+
* <code>MEMORY_ACTIVITY</code>
|
|
292
|
+
* </p>
|
|
293
|
+
* </li>
|
|
294
|
+
* <li>
|
|
295
|
+
* <p>
|
|
296
|
+
* <code>MODULE_ACTIVITY</code>
|
|
297
|
+
* </p>
|
|
298
|
+
* </li>
|
|
299
|
+
* <li>
|
|
300
|
+
* <p>
|
|
301
|
+
* <code>PROCESS_ACTIVITY</code>
|
|
302
|
+
* </p>
|
|
303
|
+
* </li>
|
|
304
|
+
* <li>
|
|
305
|
+
* <p>
|
|
306
|
+
* <code>REGISTRY_KEY_ACTIVITY</code>
|
|
307
|
+
* </p>
|
|
308
|
+
* </li>
|
|
309
|
+
* <li>
|
|
310
|
+
* <p>
|
|
311
|
+
* <code>REGISTRY_VALUE_ACTIVITY</code>
|
|
312
|
+
* </p>
|
|
313
|
+
* </li>
|
|
314
|
+
* <li>
|
|
315
|
+
* <p>
|
|
316
|
+
* <code>RESOURCE_ACTIVITY</code>
|
|
317
|
+
* </p>
|
|
318
|
+
* </li>
|
|
319
|
+
* <li>
|
|
320
|
+
* <p>
|
|
321
|
+
* <code>SCHEDULED_JOB_ACTIVITY</code>
|
|
322
|
+
* </p>
|
|
323
|
+
* </li>
|
|
324
|
+
* <li>
|
|
325
|
+
* <p>
|
|
326
|
+
* <code>SECURITY_FINDING</code>
|
|
327
|
+
* </p>
|
|
328
|
+
* </li>
|
|
329
|
+
* <li>
|
|
330
|
+
* <p>
|
|
331
|
+
* <code>ACCOUNT_CHANGE</code>
|
|
332
|
+
* </p>
|
|
333
|
+
* </li>
|
|
334
|
+
* <li>
|
|
335
|
+
* <p>
|
|
336
|
+
* <code>AUTHENTICATION</code>
|
|
337
|
+
* </p>
|
|
338
|
+
* </li>
|
|
339
|
+
* <li>
|
|
340
|
+
* <p>
|
|
341
|
+
* <code>AUTHORIZATION</code>
|
|
342
|
+
* </p>
|
|
343
|
+
* </li>
|
|
344
|
+
* <li>
|
|
345
|
+
* <p>
|
|
346
|
+
* <code>ENTITY_MANAGEMENT_AUDIT</code>
|
|
347
|
+
* </p>
|
|
348
|
+
* </li>
|
|
349
|
+
* <li>
|
|
350
|
+
* <p>
|
|
351
|
+
* <code>DHCP_ACTIVITY</code>
|
|
352
|
+
* </p>
|
|
353
|
+
* </li>
|
|
354
|
+
* <li>
|
|
355
|
+
* <p>
|
|
356
|
+
* <code>NETWORK_ACTIVITY</code>
|
|
357
|
+
* </p>
|
|
358
|
+
* </li>
|
|
359
|
+
* <li>
|
|
360
|
+
* <p>
|
|
361
|
+
* <code>DNS_ACTIVITY</code>
|
|
362
|
+
* </p>
|
|
363
|
+
* </li>
|
|
364
|
+
* <li>
|
|
365
|
+
* <p>
|
|
366
|
+
* <code>FTP_ACTIVITY</code>
|
|
367
|
+
* </p>
|
|
368
|
+
* </li>
|
|
369
|
+
* <li>
|
|
370
|
+
* <p>
|
|
371
|
+
* <code>HTTP_ACTIVITY</code>
|
|
372
|
+
* </p>
|
|
373
|
+
* </li>
|
|
374
|
+
* <li>
|
|
375
|
+
* <p>
|
|
376
|
+
* <code>RDP_ACTIVITY</code>
|
|
377
|
+
* </p>
|
|
378
|
+
* </li>
|
|
379
|
+
* <li>
|
|
380
|
+
* <p>
|
|
381
|
+
* <code>SMB_ACTIVITY</code>
|
|
382
|
+
* </p>
|
|
383
|
+
* </li>
|
|
384
|
+
* <li>
|
|
385
|
+
* <p>
|
|
386
|
+
* <code>SSH_ACTIVITY</code>
|
|
387
|
+
* </p>
|
|
388
|
+
* </li>
|
|
389
|
+
* <li>
|
|
390
|
+
* <p>
|
|
391
|
+
* <code>CONFIG_STATE</code>
|
|
392
|
+
* </p>
|
|
393
|
+
* </li>
|
|
394
|
+
* <li>
|
|
395
|
+
* <p>
|
|
396
|
+
* <code>INVENTORY_INFO</code>
|
|
397
|
+
* </p>
|
|
398
|
+
* </li>
|
|
399
|
+
* <li>
|
|
400
|
+
* <p>
|
|
401
|
+
* <code>EMAIL_ACTIVITY</code>
|
|
402
|
+
* </p>
|
|
403
|
+
* </li>
|
|
404
|
+
* <li>
|
|
405
|
+
* <p>
|
|
406
|
+
* <code>API_ACTIVITY</code>
|
|
407
|
+
* </p>
|
|
408
|
+
* </li>
|
|
409
|
+
* <li>
|
|
410
|
+
* <p>
|
|
411
|
+
* <code>CLOUD_API</code>
|
|
412
|
+
* </p>
|
|
440
413
|
* </li>
|
|
441
414
|
* </ul>
|
|
442
415
|
*/
|
|
443
|
-
|
|
416
|
+
eventClasses?: string[];
|
|
444
417
|
/**
|
|
445
|
-
* <p>The
|
|
446
|
-
* into the Amazon S3 Data Lake.</p>
|
|
418
|
+
* <p>The configuration for the third-party custom source.</p>
|
|
447
419
|
*/
|
|
448
|
-
|
|
420
|
+
configuration?: CustomLogSourceConfiguration;
|
|
449
421
|
}
|
|
450
422
|
/**
|
|
451
423
|
* @public
|
|
424
|
+
* <p>The attributes of a third-party custom source.</p>
|
|
452
425
|
*/
|
|
453
|
-
export interface
|
|
426
|
+
export interface CustomLogSourceAttributes {
|
|
454
427
|
/**
|
|
455
|
-
* <p>The
|
|
428
|
+
* <p>The ARN of the Glue crawler.</p>
|
|
456
429
|
*/
|
|
457
|
-
|
|
430
|
+
crawlerArn?: string;
|
|
458
431
|
/**
|
|
459
|
-
* <p>The
|
|
432
|
+
* <p>The ARN of the Glue database where results are written, such as:
|
|
433
|
+
* <code>arn:aws:daylight:us-east-1::database/sometable/*</code>.</p>
|
|
460
434
|
*/
|
|
461
|
-
|
|
435
|
+
databaseArn?: string;
|
|
462
436
|
/**
|
|
463
|
-
* <p>The
|
|
437
|
+
* <p>The ARN of the Glue table.</p>
|
|
464
438
|
*/
|
|
465
|
-
|
|
466
|
-
|
|
467
|
-
|
|
468
|
-
|
|
469
|
-
|
|
470
|
-
|
|
439
|
+
tableArn?: string;
|
|
440
|
+
}
|
|
441
|
+
/**
|
|
442
|
+
* @public
|
|
443
|
+
* <p>The details of the log provider for a third-party custom source.</p>
|
|
444
|
+
*/
|
|
445
|
+
export interface CustomLogSourceProvider {
|
|
471
446
|
/**
|
|
472
447
|
* <p>The ARN of the IAM role to be used by the entity putting logs into your
|
|
473
448
|
* custom source partition. Security Lake will apply the correct access policies to this role, but
|
|
474
449
|
* you must first manually create the trust policy for this role. The IAM role
|
|
475
450
|
* name must start with the text 'Security Lake'. The IAM role must trust the
|
|
476
|
-
*
|
|
451
|
+
* <code>logProviderAccountId</code> to assume the role.</p>
|
|
452
|
+
*/
|
|
453
|
+
roleArn?: string;
|
|
454
|
+
/**
|
|
455
|
+
* <p>The location of the partition in the Amazon S3 bucket for Security Lake.</p>
|
|
477
456
|
*/
|
|
478
|
-
|
|
457
|
+
location?: string;
|
|
479
458
|
}
|
|
480
459
|
/**
|
|
481
460
|
* @public
|
|
482
|
-
*
|
|
461
|
+
* <p>Amazon Security Lake can collect logs and events from third-party custom sources.</p>
|
|
483
462
|
*/
|
|
484
|
-
export
|
|
485
|
-
|
|
486
|
-
|
|
487
|
-
|
|
488
|
-
|
|
489
|
-
|
|
490
|
-
|
|
491
|
-
|
|
492
|
-
|
|
463
|
+
export interface CustomLogSourceResource {
|
|
464
|
+
/**
|
|
465
|
+
* <p>The name for a third-party custom source. This must be a Regionally unique value.</p>
|
|
466
|
+
*/
|
|
467
|
+
sourceName?: string;
|
|
468
|
+
/**
|
|
469
|
+
* <p>The version for a third-party custom source. This must be a Regionally unique value.</p>
|
|
470
|
+
*/
|
|
471
|
+
sourceVersion?: string;
|
|
472
|
+
/**
|
|
473
|
+
* <p>The details of the log provider for a third-party custom source.</p>
|
|
474
|
+
*/
|
|
475
|
+
provider?: CustomLogSourceProvider;
|
|
476
|
+
/**
|
|
477
|
+
* <p>The attributes of a third-party custom source.</p>
|
|
478
|
+
*/
|
|
479
|
+
attributes?: CustomLogSourceAttributes;
|
|
480
|
+
}
|
|
493
481
|
/**
|
|
494
482
|
* @public
|
|
495
483
|
*/
|
|
496
|
-
export
|
|
484
|
+
export interface CreateCustomLogSourceResponse {
|
|
485
|
+
/**
|
|
486
|
+
* <p>The created third-party custom source.</p>
|
|
487
|
+
*/
|
|
488
|
+
source?: CustomLogSourceResource;
|
|
489
|
+
}
|
|
497
490
|
/**
|
|
498
491
|
* @public
|
|
499
|
-
* <p>
|
|
492
|
+
* <p>Provides encryption details of Amazon Security Lake object.</p>
|
|
500
493
|
*/
|
|
501
|
-
export interface
|
|
494
|
+
export interface DataLakeEncryptionConfiguration {
|
|
502
495
|
/**
|
|
503
|
-
* <p>The
|
|
504
|
-
*
|
|
496
|
+
* <p>The id of KMS encryption key used by Amazon Security Lake to encrypt the Security Lake
|
|
497
|
+
* object.</p>
|
|
505
498
|
*/
|
|
506
|
-
|
|
499
|
+
kmsKeyId?: string;
|
|
500
|
+
}
|
|
501
|
+
/**
|
|
502
|
+
* @public
|
|
503
|
+
* <p>Provide expiration lifecycle details of Amazon Security Lake object.</p>
|
|
504
|
+
*/
|
|
505
|
+
export interface DataLakeLifecycleExpiration {
|
|
507
506
|
/**
|
|
508
|
-
* <p>
|
|
509
|
-
* remains locked. You can specify the retention period in days for one or more sources. </p>
|
|
507
|
+
* <p>Number of days before data expires in the Amazon Security Lake object.</p>
|
|
510
508
|
*/
|
|
511
|
-
|
|
509
|
+
days?: number;
|
|
512
510
|
}
|
|
513
511
|
/**
|
|
514
512
|
* @public
|
|
515
|
-
* <p>
|
|
513
|
+
* <p>Provide transition lifecycle details of Amazon Security Lake object.</p>
|
|
516
514
|
*/
|
|
517
|
-
export interface
|
|
515
|
+
export interface DataLakeLifecycleTransition {
|
|
518
516
|
/**
|
|
519
|
-
* <p>The
|
|
520
|
-
*
|
|
517
|
+
* <p>The range of storage classes that you can choose from based on the data access,
|
|
518
|
+
* resiliency, and cost requirements of your workloads.</p>
|
|
521
519
|
*/
|
|
522
|
-
|
|
520
|
+
storageClass?: string;
|
|
523
521
|
/**
|
|
524
|
-
* <p>
|
|
522
|
+
* <p>Number of days before data transitions to a different S3 Storage Class in the Amazon Security Lake object.</p>
|
|
525
523
|
*/
|
|
526
|
-
|
|
524
|
+
days?: number;
|
|
525
|
+
}
|
|
526
|
+
/**
|
|
527
|
+
* @public
|
|
528
|
+
* <p>Provides lifecycle details of Amazon Security Lake object.</p>
|
|
529
|
+
*/
|
|
530
|
+
export interface DataLakeLifecycleConfiguration {
|
|
531
|
+
/**
|
|
532
|
+
* <p>Provides data expiration details of Amazon Security Lake object.</p>
|
|
533
|
+
*/
|
|
534
|
+
expiration?: DataLakeLifecycleExpiration;
|
|
527
535
|
/**
|
|
528
|
-
* <p>
|
|
529
|
-
* optional value, both of which you define.</p>
|
|
536
|
+
* <p>Provides data storage transition details of Amazon Security Lake object.</p>
|
|
530
537
|
*/
|
|
531
|
-
|
|
538
|
+
transitions?: DataLakeLifecycleTransition[];
|
|
539
|
+
}
|
|
540
|
+
/**
|
|
541
|
+
* @public
|
|
542
|
+
* <p>Provides replication details of Amazon Security Lake object.</p>
|
|
543
|
+
*/
|
|
544
|
+
export interface DataLakeReplicationConfiguration {
|
|
532
545
|
/**
|
|
533
546
|
* <p>Replication enables automatic, asynchronous copying of objects across Amazon S3
|
|
534
547
|
* buckets. Amazon S3 buckets that are configured for object replication can be owned
|
|
@@ -537,883 +550,1027 @@ export interface LakeConfigurationRequest {
|
|
|
537
550
|
* can be in different Amazon Web Services Regions or within the same Region as the source
|
|
538
551
|
* bucket.</p>
|
|
539
552
|
* <p>Set up one or more rollup Regions by providing the Region or Regions that should
|
|
540
|
-
* contribute to the central rollup Region
|
|
553
|
+
* contribute to the central rollup Region.</p>
|
|
541
554
|
*/
|
|
542
|
-
|
|
555
|
+
regions?: string[];
|
|
543
556
|
/**
|
|
544
557
|
* <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
|
|
545
|
-
* ensure the replication setting is correct
|
|
558
|
+
* ensure the replication setting is correct.</p>
|
|
546
559
|
*/
|
|
547
|
-
|
|
560
|
+
roleArn?: string;
|
|
548
561
|
}
|
|
549
562
|
/**
|
|
550
563
|
* @public
|
|
564
|
+
* <p>Provides details of Amazon Security Lake object.</p>
|
|
551
565
|
*/
|
|
552
|
-
export interface
|
|
566
|
+
export interface DataLakeConfiguration {
|
|
553
567
|
/**
|
|
554
|
-
* <p>
|
|
555
|
-
* list of Region codes, see <a href="https://docs.aws.amazon.com/general/latest/gr/securitylake.html">Amazon Security Lake endpoints</a> in the
|
|
556
|
-
* Amazon Web Services General Reference.</p>
|
|
568
|
+
* <p>The Amazon Web Services Regions where Security Lake is automatically enabled.</p>
|
|
557
569
|
*/
|
|
558
|
-
|
|
570
|
+
region: string | undefined;
|
|
559
571
|
/**
|
|
560
|
-
* <p>
|
|
572
|
+
* <p>Provides encryption details of Amazon Security Lake object.</p>
|
|
561
573
|
*/
|
|
562
|
-
|
|
574
|
+
encryptionConfiguration?: DataLakeEncryptionConfiguration;
|
|
563
575
|
/**
|
|
564
|
-
* <p>
|
|
576
|
+
* <p>Provides lifecycle details of Amazon Security Lake object.</p>
|
|
565
577
|
*/
|
|
566
|
-
|
|
578
|
+
lifecycleConfiguration?: DataLakeLifecycleConfiguration;
|
|
567
579
|
/**
|
|
568
|
-
* <p>
|
|
569
|
-
* This table contains partitions generated by the ingestion and normalization of Amazon Web Services log sources and custom sources.</p>
|
|
580
|
+
* <p>Provides replication details of Amazon Security Lake object.</p>
|
|
570
581
|
*/
|
|
571
|
-
|
|
582
|
+
replicationConfiguration?: DataLakeReplicationConfiguration;
|
|
572
583
|
}
|
|
573
584
|
/**
|
|
574
585
|
* @public
|
|
575
586
|
*/
|
|
576
|
-
export interface
|
|
587
|
+
export interface CreateDataLakeRequest {
|
|
588
|
+
/**
|
|
589
|
+
* <p>Specify the Region or Regions that will contribute data to the rollup region.</p>
|
|
590
|
+
*/
|
|
591
|
+
configurations: DataLakeConfiguration[] | undefined;
|
|
592
|
+
/**
|
|
593
|
+
* <p>The Amazon Resource Name (ARN) used to create and update the Glue table.
|
|
594
|
+
* This table contains partitions generated by the ingestion and normalization of
|
|
595
|
+
* Amazon Web Services log sources and custom sources.</p>
|
|
596
|
+
*/
|
|
597
|
+
metaStoreManagerRoleArn: string | undefined;
|
|
577
598
|
}
|
|
578
599
|
/**
|
|
579
600
|
* @public
|
|
580
|
-
*
|
|
581
|
-
* the relevant resources, or use Service Quotas to request a service quota increase. </p>
|
|
601
|
+
* @enum
|
|
582
602
|
*/
|
|
583
|
-
export declare
|
|
584
|
-
readonly
|
|
585
|
-
readonly
|
|
603
|
+
export declare const DataLakeStatus: {
|
|
604
|
+
readonly COMPLETED: "COMPLETED";
|
|
605
|
+
readonly FAILED: "FAILED";
|
|
606
|
+
readonly INITIALIZED: "INITIALIZED";
|
|
607
|
+
readonly PENDING: "PENDING";
|
|
608
|
+
};
|
|
609
|
+
/**
|
|
610
|
+
* @public
|
|
611
|
+
*/
|
|
612
|
+
export type DataLakeStatus = (typeof DataLakeStatus)[keyof typeof DataLakeStatus];
|
|
613
|
+
/**
|
|
614
|
+
* @public
|
|
615
|
+
* <p>The details of the last <code>UpdateDataLake</code> or <code>DeleteDataLake</code>
|
|
616
|
+
* API request which failed.</p>
|
|
617
|
+
*/
|
|
618
|
+
export interface DataLakeUpdateException {
|
|
586
619
|
/**
|
|
587
|
-
* <p>The
|
|
620
|
+
* <p>The reason for the exception of the last <code>UpdateDataLake</code>or
|
|
621
|
+
* <code>DeleteDataLake</code> API request.</p>
|
|
588
622
|
*/
|
|
589
|
-
|
|
623
|
+
reason?: string;
|
|
590
624
|
/**
|
|
591
|
-
* <p>The
|
|
625
|
+
* <p>The reason code for the exception of the last <code>UpdateDataLake</code> or
|
|
626
|
+
* <code>DeleteDataLake</code> API request.</p>
|
|
592
627
|
*/
|
|
593
|
-
|
|
628
|
+
code?: string;
|
|
629
|
+
}
|
|
630
|
+
/**
|
|
631
|
+
* @public
|
|
632
|
+
* <p>The status of the last <code>UpdateDataLake</code> or <code>DeleteDataLake</code> API
|
|
633
|
+
* request. This is set to Completed after the configuration is updated, or removed if
|
|
634
|
+
* deletion of the data lake is successful.</p>
|
|
635
|
+
*/
|
|
636
|
+
export interface DataLakeUpdateStatus {
|
|
594
637
|
/**
|
|
595
|
-
* <p>The
|
|
638
|
+
* <p>The unique ID for the last <code>UpdateDataLake</code> or <code>DeleteDataLake</code> API
|
|
639
|
+
* request.</p>
|
|
596
640
|
*/
|
|
597
|
-
|
|
641
|
+
requestId?: string;
|
|
598
642
|
/**
|
|
599
|
-
* <p>
|
|
643
|
+
* <p>The status of the last <code>UpdateDataLake</code> or <code>DeleteDataLake</code> API
|
|
644
|
+
* request that was requested.</p>
|
|
600
645
|
*/
|
|
601
|
-
|
|
646
|
+
status?: DataLakeStatus | string;
|
|
602
647
|
/**
|
|
603
|
-
*
|
|
648
|
+
* <p>The details of the last <code>UpdateDataLake</code>or <code>DeleteDataLake</code> API
|
|
649
|
+
* request which failed.</p>
|
|
604
650
|
*/
|
|
605
|
-
|
|
651
|
+
exception?: DataLakeUpdateException;
|
|
606
652
|
}
|
|
607
653
|
/**
|
|
608
654
|
* @public
|
|
609
|
-
* <p>
|
|
655
|
+
* <p>Provides details of Amazon Security Lake object.</p>
|
|
610
656
|
*/
|
|
611
|
-
export
|
|
612
|
-
readonly name: "ThrottlingException";
|
|
613
|
-
readonly $fault: "client";
|
|
614
|
-
$retryable: {
|
|
615
|
-
throttling: boolean;
|
|
616
|
-
};
|
|
657
|
+
export interface DataLakeResource {
|
|
617
658
|
/**
|
|
618
|
-
* <p>The
|
|
659
|
+
* <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>
|
|
619
660
|
*/
|
|
620
|
-
|
|
661
|
+
dataLakeArn: string | undefined;
|
|
621
662
|
/**
|
|
622
|
-
* <p>
|
|
663
|
+
* <p>The Amazon Web Services Regions where Security Lake is enabled.</p>
|
|
623
664
|
*/
|
|
624
|
-
|
|
665
|
+
region: string | undefined;
|
|
625
666
|
/**
|
|
626
|
-
* <p>
|
|
667
|
+
* <p>The ARN for the Amazon Security Lake Amazon S3 bucket.</p>
|
|
627
668
|
*/
|
|
628
|
-
|
|
669
|
+
s3BucketArn?: string;
|
|
629
670
|
/**
|
|
630
|
-
*
|
|
671
|
+
* <p>Provides encryption details of Amazon Security Lake object.</p>
|
|
631
672
|
*/
|
|
632
|
-
|
|
633
|
-
|
|
634
|
-
|
|
635
|
-
|
|
636
|
-
|
|
637
|
-
|
|
673
|
+
encryptionConfiguration?: DataLakeEncryptionConfiguration;
|
|
674
|
+
/**
|
|
675
|
+
* <p>Provides lifecycle details of Amazon Security Lake object.</p>
|
|
676
|
+
*/
|
|
677
|
+
lifecycleConfiguration?: DataLakeLifecycleConfiguration;
|
|
678
|
+
/**
|
|
679
|
+
* <p>Provides replication details of Amazon Security Lake object.</p>
|
|
680
|
+
*/
|
|
681
|
+
replicationConfiguration?: DataLakeReplicationConfiguration;
|
|
682
|
+
/**
|
|
683
|
+
* <p>Retrieves the status of the configuration operation for an account in Amazon Security Lake.</p>
|
|
684
|
+
*/
|
|
685
|
+
createStatus?: DataLakeStatus | string;
|
|
638
686
|
/**
|
|
639
|
-
* <p>
|
|
640
|
-
*
|
|
687
|
+
* <p>The status of the last <code>UpdateDataLake </code>or <code>DeleteDataLake</code> API
|
|
688
|
+
* request.</p>
|
|
641
689
|
*/
|
|
642
|
-
|
|
690
|
+
updateStatus?: DataLakeUpdateStatus;
|
|
643
691
|
}
|
|
644
692
|
/**
|
|
645
693
|
* @public
|
|
646
694
|
*/
|
|
647
|
-
export interface
|
|
695
|
+
export interface CreateDataLakeResponse {
|
|
696
|
+
/**
|
|
697
|
+
* <p>The created Security Lake configuration object.</p>
|
|
698
|
+
*/
|
|
699
|
+
dataLakes?: DataLakeResource[];
|
|
648
700
|
}
|
|
649
701
|
/**
|
|
650
702
|
* @public
|
|
651
703
|
*/
|
|
652
|
-
export interface
|
|
704
|
+
export interface CreateDataLakeExceptionSubscriptionRequest {
|
|
653
705
|
/**
|
|
654
|
-
* <p>The
|
|
706
|
+
* <p>The subscription protocol to which exception notifications are posted.</p>
|
|
707
|
+
*/
|
|
708
|
+
subscriptionProtocol: string | undefined;
|
|
709
|
+
/**
|
|
710
|
+
* <p>The Amazon Web Services account where you want to receive exception notifications.</p>
|
|
655
711
|
*/
|
|
656
|
-
|
|
712
|
+
notificationEndpoint: string | undefined;
|
|
713
|
+
/**
|
|
714
|
+
* <p>The expiration period and time-to-live (TTL).</p>
|
|
715
|
+
*/
|
|
716
|
+
exceptionTimeToLive?: number;
|
|
657
717
|
}
|
|
658
718
|
/**
|
|
659
719
|
* @public
|
|
660
720
|
*/
|
|
661
|
-
export interface
|
|
721
|
+
export interface CreateDataLakeExceptionSubscriptionResponse {
|
|
662
722
|
}
|
|
663
723
|
/**
|
|
664
724
|
* @public
|
|
665
|
-
*
|
|
666
|
-
|
|
667
|
-
export declare const SubscriptionProtocolType: {
|
|
668
|
-
readonly APP: "APP";
|
|
669
|
-
readonly EMAIL: "EMAIL";
|
|
670
|
-
readonly EMAIL_JSON: "EMAIL_JSON";
|
|
671
|
-
readonly FIREHOSE: "FIREHOSE";
|
|
672
|
-
readonly HTTP: "HTTP";
|
|
673
|
-
readonly HTTPS: "HTTPS";
|
|
674
|
-
readonly LAMBDA: "LAMBDA";
|
|
675
|
-
readonly SMS: "SMS";
|
|
676
|
-
readonly SQS: "SQS";
|
|
677
|
-
};
|
|
678
|
-
/**
|
|
679
|
-
* @public
|
|
725
|
+
* <p>Automatically enable new organization accounts as member accounts from an Amazon Security Lake
|
|
726
|
+
* administrator account.</p>
|
|
680
727
|
*/
|
|
681
|
-
export
|
|
728
|
+
export interface DataLakeAutoEnableNewAccountConfiguration {
|
|
729
|
+
/**
|
|
730
|
+
* <p>The Amazon Web Services Regions where Security Lake is automatically enabled.</p>
|
|
731
|
+
*/
|
|
732
|
+
region: string | undefined;
|
|
733
|
+
/**
|
|
734
|
+
* <p>The Amazon Web Services sources that are automatically enabled in Security Lake.</p>
|
|
735
|
+
*/
|
|
736
|
+
sources: AwsLogSourceResource[] | undefined;
|
|
737
|
+
}
|
|
682
738
|
/**
|
|
683
739
|
* @public
|
|
684
740
|
*/
|
|
685
|
-
export interface
|
|
741
|
+
export interface CreateDataLakeOrganizationConfigurationRequest {
|
|
686
742
|
/**
|
|
687
|
-
* <p>
|
|
688
|
-
|
|
689
|
-
subscriptionProtocol: SubscriptionProtocolType | string | undefined;
|
|
690
|
-
/**
|
|
691
|
-
* <p>The Amazon Web Services account where you want to receive exception notifications.</p>
|
|
743
|
+
* <p>Enable Security Lake with the specified configuration settings, to begin collecting security
|
|
744
|
+
* data for new accounts in your organization.</p>
|
|
692
745
|
*/
|
|
693
|
-
|
|
746
|
+
autoEnableNewAccount: DataLakeAutoEnableNewAccountConfiguration[] | undefined;
|
|
694
747
|
}
|
|
695
748
|
/**
|
|
696
749
|
* @public
|
|
697
750
|
*/
|
|
698
|
-
export interface
|
|
751
|
+
export interface CreateDataLakeOrganizationConfigurationResponse {
|
|
699
752
|
}
|
|
700
753
|
/**
|
|
701
754
|
* @public
|
|
702
755
|
* <p>The supported source types from which logs and events are collected in Amazon Security Lake.
|
|
703
756
|
* 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>
|
|
704
757
|
*/
|
|
705
|
-
export type
|
|
758
|
+
export type LogSourceResource = LogSourceResource.AwsLogSourceMember | LogSourceResource.CustomLogSourceMember | LogSourceResource.$UnknownMember;
|
|
706
759
|
/**
|
|
707
760
|
* @public
|
|
708
761
|
*/
|
|
709
|
-
export declare namespace
|
|
762
|
+
export declare namespace LogSourceResource {
|
|
710
763
|
/**
|
|
711
|
-
* <p>Amazon Security Lake supports log and event collection for natively supported Amazon Web Services
|
|
764
|
+
* <p>Amazon Security Lake supports log and event collection for natively supported Amazon Web Services.</p>
|
|
712
765
|
*/
|
|
713
|
-
interface
|
|
714
|
-
|
|
715
|
-
|
|
766
|
+
interface AwsLogSourceMember {
|
|
767
|
+
awsLogSource: AwsLogSourceResource;
|
|
768
|
+
customLogSource?: never;
|
|
716
769
|
$unknown?: never;
|
|
717
770
|
}
|
|
718
771
|
/**
|
|
719
772
|
* <p>Amazon Security Lake supports custom source types. For a detailed list, see the Amazon Security Lake
|
|
720
773
|
* User Guide.</p>
|
|
721
774
|
*/
|
|
722
|
-
interface
|
|
723
|
-
|
|
724
|
-
|
|
775
|
+
interface CustomLogSourceMember {
|
|
776
|
+
awsLogSource?: never;
|
|
777
|
+
customLogSource: CustomLogSourceResource;
|
|
725
778
|
$unknown?: never;
|
|
726
779
|
}
|
|
727
780
|
interface $UnknownMember {
|
|
728
|
-
|
|
729
|
-
|
|
781
|
+
awsLogSource?: never;
|
|
782
|
+
customLogSource?: never;
|
|
730
783
|
$unknown: [string, any];
|
|
731
784
|
}
|
|
732
785
|
interface Visitor<T> {
|
|
733
|
-
|
|
734
|
-
|
|
786
|
+
awsLogSource: (value: AwsLogSourceResource) => T;
|
|
787
|
+
customLogSource: (value: CustomLogSourceResource) => T;
|
|
735
788
|
_: (name: string, value: any) => T;
|
|
736
789
|
}
|
|
737
|
-
const visit: <T>(value:
|
|
790
|
+
const visit: <T>(value: LogSourceResource, visitor: Visitor<T>) => T;
|
|
791
|
+
}
|
|
792
|
+
/**
|
|
793
|
+
* @public
|
|
794
|
+
*/
|
|
795
|
+
export interface CreateSubscriberRequest {
|
|
796
|
+
/**
|
|
797
|
+
* <p>The AWS identity used to access your data.</p>
|
|
798
|
+
*/
|
|
799
|
+
subscriberIdentity: AwsIdentity | undefined;
|
|
800
|
+
/**
|
|
801
|
+
* <p>The name of your Security Lake subscriber account.</p>
|
|
802
|
+
*/
|
|
803
|
+
subscriberName: string | undefined;
|
|
804
|
+
/**
|
|
805
|
+
* <p>The description for your subscriber account in Security Lake.</p>
|
|
806
|
+
*/
|
|
807
|
+
subscriberDescription?: string;
|
|
808
|
+
/**
|
|
809
|
+
* <p>The supported Amazon Web Services from which logs and events are collected.
|
|
810
|
+
* Security Lake supports log and event collection for natively supported Amazon Web Services.</p>
|
|
811
|
+
*/
|
|
812
|
+
sources: LogSourceResource[] | undefined;
|
|
813
|
+
/**
|
|
814
|
+
* <p>The Amazon S3 or Lake Formation access type.</p>
|
|
815
|
+
*/
|
|
816
|
+
accessTypes?: (AccessType | string)[];
|
|
738
817
|
}
|
|
818
|
+
/**
|
|
819
|
+
* @public
|
|
820
|
+
* @enum
|
|
821
|
+
*/
|
|
822
|
+
export declare const SubscriberStatus: {
|
|
823
|
+
readonly ACTIVE: "ACTIVE";
|
|
824
|
+
readonly DEACTIVATED: "DEACTIVATED";
|
|
825
|
+
readonly PENDING: "PENDING";
|
|
826
|
+
readonly READY: "READY";
|
|
827
|
+
};
|
|
739
828
|
/**
|
|
740
829
|
* @public
|
|
741
830
|
*/
|
|
742
|
-
export
|
|
743
|
-
|
|
744
|
-
|
|
745
|
-
|
|
746
|
-
|
|
747
|
-
|
|
831
|
+
export type SubscriberStatus = (typeof SubscriberStatus)[keyof typeof SubscriberStatus];
|
|
832
|
+
/**
|
|
833
|
+
* @public
|
|
834
|
+
* <p>Provides details about the Amazon Security Lake account subscription. Subscribers are notified
|
|
835
|
+
* of new objects for a source as the data is written to your Amazon S3 bucket for
|
|
836
|
+
* Security Lake.</p>
|
|
837
|
+
*/
|
|
838
|
+
export interface SubscriberResource {
|
|
748
839
|
/**
|
|
749
|
-
* <p>The
|
|
840
|
+
* <p>The subscriber ID of the Amazon Security Lake subscriber account.</p>
|
|
750
841
|
*/
|
|
751
|
-
|
|
842
|
+
subscriberId: string | undefined;
|
|
752
843
|
/**
|
|
753
|
-
* <p>The
|
|
754
|
-
* the circumstances in which they are operating. It also provides a way for the account owner
|
|
755
|
-
* to permit the role to be assumed only under specific circumstances.</p>
|
|
844
|
+
* <p>The subscriber ARN of the Amazon Security Lake subscriber account.</p>
|
|
756
845
|
*/
|
|
757
|
-
|
|
846
|
+
subscriberArn: string | undefined;
|
|
758
847
|
/**
|
|
759
|
-
* <p>The
|
|
848
|
+
* <p>The AWS identity used to access your data.</p>
|
|
760
849
|
*/
|
|
761
|
-
|
|
850
|
+
subscriberIdentity: AwsIdentity | undefined;
|
|
762
851
|
/**
|
|
763
|
-
* <p>The name of your Security Lake subscriber account.</p>
|
|
852
|
+
* <p>The name of your Amazon Security Lake subscriber account.</p>
|
|
764
853
|
*/
|
|
765
854
|
subscriberName: string | undefined;
|
|
766
855
|
/**
|
|
767
|
-
* <p>The
|
|
856
|
+
* <p>The subscriber descriptions for a subscriber account. The description for a subscriber
|
|
857
|
+
* includes <code>subscriberName</code>, <code>accountID</code>, <code>externalID</code>, and
|
|
858
|
+
* <code>subscriberId</code>.</p>
|
|
768
859
|
*/
|
|
769
860
|
subscriberDescription?: string;
|
|
770
|
-
}
|
|
771
|
-
/**
|
|
772
|
-
* @public
|
|
773
|
-
*/
|
|
774
|
-
export interface CreateSubscriberResponse {
|
|
775
861
|
/**
|
|
776
|
-
* <p>
|
|
777
|
-
* call.</p>
|
|
862
|
+
* <p>Amazon Security Lake supports log and event collection for natively supported Amazon Web Services. For more information, see the Amazon Security Lake User Guide.</p>
|
|
778
863
|
*/
|
|
779
|
-
|
|
864
|
+
sources: LogSourceResource[] | undefined;
|
|
780
865
|
/**
|
|
781
|
-
* <p>
|
|
782
|
-
*
|
|
783
|
-
*
|
|
866
|
+
* <p>You can choose to notify subscribers of new objects with an Amazon Simple Queue Service
|
|
867
|
+
* (Amazon SQS) queue or through messaging to an HTTPS endpoint provided by the
|
|
868
|
+
* subscriber.</p>
|
|
869
|
+
* <p> Subscribers can consume data by directly querying Lake Formation tables in your
|
|
870
|
+
* Amazon S3 bucket through services like Amazon Athena. This subscription
|
|
871
|
+
* type is defined as <code>LAKEFORMATION</code>.</p>
|
|
784
872
|
*/
|
|
785
|
-
|
|
873
|
+
accessTypes?: (AccessType | string)[];
|
|
786
874
|
/**
|
|
787
|
-
* <p>The ARN
|
|
875
|
+
* <p>The Amazon Resource Name (ARN) specifying the role of the subscriber.</p>
|
|
788
876
|
*/
|
|
789
|
-
|
|
877
|
+
roleArn?: string;
|
|
790
878
|
/**
|
|
791
|
-
* <p>The ARN for the Amazon S3 bucket
|
|
879
|
+
* <p>The ARN for the Amazon S3 bucket.</p>
|
|
792
880
|
*/
|
|
793
881
|
s3BucketArn?: string;
|
|
794
882
|
/**
|
|
795
|
-
* <p>The
|
|
883
|
+
* <p>The subscriber endpoint to which exception messages are posted.</p>
|
|
884
|
+
*/
|
|
885
|
+
subscriberEndpoint?: string;
|
|
886
|
+
/**
|
|
887
|
+
* <p>The subscriber status of the Amazon Security Lake subscriber account.</p>
|
|
888
|
+
*/
|
|
889
|
+
subscriberStatus?: SubscriberStatus | string;
|
|
890
|
+
/**
|
|
891
|
+
* <p>The Amazon Resource Name (ARN) which uniquely defines the AWS RAM resource share. Before
|
|
892
|
+
* accepting the RAM resource share invitation, you can view details related to the RAM
|
|
893
|
+
* resource share.</p>
|
|
894
|
+
* <p>This field is available only for Lake Formation subscribers created after March 8, 2023.</p>
|
|
796
895
|
*/
|
|
797
896
|
resourceShareArn?: string;
|
|
798
897
|
/**
|
|
799
898
|
* <p>The name of the resource share.</p>
|
|
800
899
|
*/
|
|
801
900
|
resourceShareName?: string;
|
|
901
|
+
/**
|
|
902
|
+
* <p>The date and time when the subscriber was created.</p>
|
|
903
|
+
*/
|
|
904
|
+
createdAt?: Date;
|
|
905
|
+
/**
|
|
906
|
+
* <p>The date and time when the subscriber was last updated.</p>
|
|
907
|
+
*/
|
|
908
|
+
updatedAt?: Date;
|
|
802
909
|
}
|
|
803
910
|
/**
|
|
804
911
|
* @public
|
|
805
|
-
* <p>The request was rejected because a value that's not valid or is out of range was
|
|
806
|
-
* supplied for an input parameter. </p>
|
|
807
912
|
*/
|
|
808
|
-
export
|
|
809
|
-
readonly name: "InvalidInputException";
|
|
810
|
-
readonly $fault: "client";
|
|
913
|
+
export interface CreateSubscriberResponse {
|
|
811
914
|
/**
|
|
812
|
-
*
|
|
915
|
+
* <p>Retrieve information about the subscriber created using the
|
|
916
|
+
* <code>CreateSubscriber</code> API.</p>
|
|
813
917
|
*/
|
|
814
|
-
|
|
918
|
+
subscriber?: SubscriberResource;
|
|
815
919
|
}
|
|
816
920
|
/**
|
|
817
921
|
* @public
|
|
818
922
|
* @enum
|
|
819
923
|
*/
|
|
820
|
-
export declare const
|
|
924
|
+
export declare const HttpMethod: {
|
|
821
925
|
readonly POST: "POST";
|
|
822
926
|
readonly PUT: "PUT";
|
|
823
927
|
};
|
|
824
928
|
/**
|
|
825
929
|
* @public
|
|
826
930
|
*/
|
|
827
|
-
export type
|
|
931
|
+
export type HttpMethod = (typeof HttpMethod)[keyof typeof HttpMethod];
|
|
828
932
|
/**
|
|
829
933
|
* @public
|
|
934
|
+
* <p>The configurations for HTTPS subscriber notification.</p>
|
|
830
935
|
*/
|
|
831
|
-
export interface
|
|
832
|
-
/**
|
|
833
|
-
* <p>The subscription ID for the notification subscription.</p>
|
|
834
|
-
*/
|
|
835
|
-
subscriptionId: string | undefined;
|
|
936
|
+
export interface HttpsNotificationConfiguration {
|
|
836
937
|
/**
|
|
837
938
|
* <p>The subscription endpoint in Security Lake. If you prefer notification with an HTTPs
|
|
838
939
|
* endpoint, populate this field.</p>
|
|
839
940
|
*/
|
|
840
|
-
|
|
941
|
+
endpoint: string | undefined;
|
|
841
942
|
/**
|
|
842
943
|
* <p>The key name for the notification subscription.</p>
|
|
843
944
|
*/
|
|
844
|
-
|
|
945
|
+
authorizationApiKeyName?: string;
|
|
845
946
|
/**
|
|
846
947
|
* <p>The key value for the notification subscription.</p>
|
|
847
948
|
*/
|
|
848
|
-
|
|
849
|
-
/**
|
|
850
|
-
* <p>The HTTPS method used for the notification subscription. </p>
|
|
851
|
-
*/
|
|
852
|
-
httpsMethod?: HttpsMethod | string;
|
|
949
|
+
authorizationApiKeyValue?: string;
|
|
853
950
|
/**
|
|
854
|
-
* <p>
|
|
951
|
+
* <p>The HTTPS method used for the notification subscription.</p>
|
|
855
952
|
*/
|
|
856
|
-
|
|
953
|
+
httpMethod?: HttpMethod | string;
|
|
857
954
|
/**
|
|
858
955
|
* <p>The Amazon Resource Name (ARN) of the EventBridge API destinations IAM role that you
|
|
859
956
|
* 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
|
|
860
957
|
* Managed Policies</a> in the Amazon Security Lake User Guide.</p>
|
|
861
958
|
*/
|
|
862
|
-
|
|
959
|
+
targetRoleArn: string | undefined;
|
|
863
960
|
}
|
|
864
961
|
/**
|
|
865
962
|
* @public
|
|
963
|
+
* <p>The configurations for SQS subscriber notification.</p>
|
|
866
964
|
*/
|
|
867
|
-
export interface
|
|
868
|
-
/**
|
|
869
|
-
* <p>Returns the Amazon Resource Name (ARN) of the queue.</p>
|
|
870
|
-
*/
|
|
871
|
-
queueArn?: string;
|
|
965
|
+
export interface SqsNotificationConfiguration {
|
|
872
966
|
}
|
|
873
967
|
/**
|
|
874
968
|
* @public
|
|
969
|
+
* <p>Specify the configurations you want to use for subscriber notification to notify the
|
|
970
|
+
* subscriber when new data is written to the data lake for sources that the subscriber
|
|
971
|
+
* consumes in Security Lake. </p>
|
|
875
972
|
*/
|
|
876
|
-
export
|
|
877
|
-
|
|
878
|
-
|
|
879
|
-
|
|
880
|
-
|
|
881
|
-
*/
|
|
882
|
-
inputOrder: (Dimension | string)[] | undefined;
|
|
883
|
-
/**
|
|
884
|
-
* <p>Removes the specific Amazon Web Services sources from specific accounts and specific
|
|
885
|
-
* Regions.</p>
|
|
886
|
-
*/
|
|
887
|
-
disableAllDimensions?: Record<string, Record<string, string[]>>;
|
|
973
|
+
export type NotificationConfiguration = NotificationConfiguration.HttpsNotificationConfigurationMember | NotificationConfiguration.SqsNotificationConfigurationMember | NotificationConfiguration.$UnknownMember;
|
|
974
|
+
/**
|
|
975
|
+
* @public
|
|
976
|
+
*/
|
|
977
|
+
export declare namespace NotificationConfiguration {
|
|
888
978
|
/**
|
|
889
|
-
* <p>
|
|
979
|
+
* <p>The configurations for SQS subscriber notification.</p>
|
|
890
980
|
*/
|
|
891
|
-
|
|
981
|
+
interface SqsNotificationConfigurationMember {
|
|
982
|
+
sqsNotificationConfiguration: SqsNotificationConfiguration;
|
|
983
|
+
httpsNotificationConfiguration?: never;
|
|
984
|
+
$unknown?: never;
|
|
985
|
+
}
|
|
892
986
|
/**
|
|
893
|
-
* <p>
|
|
987
|
+
* <p>The configurations for HTTPS subscriber notification.</p>
|
|
894
988
|
*/
|
|
895
|
-
|
|
989
|
+
interface HttpsNotificationConfigurationMember {
|
|
990
|
+
sqsNotificationConfiguration?: never;
|
|
991
|
+
httpsNotificationConfiguration: HttpsNotificationConfiguration;
|
|
992
|
+
$unknown?: never;
|
|
993
|
+
}
|
|
994
|
+
interface $UnknownMember {
|
|
995
|
+
sqsNotificationConfiguration?: never;
|
|
996
|
+
httpsNotificationConfiguration?: never;
|
|
997
|
+
$unknown: [string, any];
|
|
998
|
+
}
|
|
999
|
+
interface Visitor<T> {
|
|
1000
|
+
sqsNotificationConfiguration: (value: SqsNotificationConfiguration) => T;
|
|
1001
|
+
httpsNotificationConfiguration: (value: HttpsNotificationConfiguration) => T;
|
|
1002
|
+
_: (name: string, value: any) => T;
|
|
1003
|
+
}
|
|
1004
|
+
const visit: <T>(value: NotificationConfiguration, visitor: Visitor<T>) => T;
|
|
896
1005
|
}
|
|
897
1006
|
/**
|
|
898
1007
|
* @public
|
|
899
1008
|
*/
|
|
900
|
-
export interface
|
|
1009
|
+
export interface CreateSubscriberNotificationRequest {
|
|
901
1010
|
/**
|
|
902
|
-
* <p>
|
|
1011
|
+
* <p>The subscriber ID for the notification subscription.</p>
|
|
903
1012
|
*/
|
|
904
|
-
|
|
1013
|
+
subscriberId: string | undefined;
|
|
905
1014
|
/**
|
|
906
|
-
* <p>
|
|
1015
|
+
* <p>Specify the configuration using which you want to create the subscriber
|
|
1016
|
+
* notification.</p>
|
|
907
1017
|
*/
|
|
908
|
-
|
|
1018
|
+
configuration: NotificationConfiguration | undefined;
|
|
909
1019
|
}
|
|
910
1020
|
/**
|
|
911
1021
|
* @public
|
|
912
1022
|
*/
|
|
913
|
-
export interface
|
|
1023
|
+
export interface CreateSubscriberNotificationResponse {
|
|
914
1024
|
/**
|
|
915
|
-
* <p>The
|
|
1025
|
+
* <p>The subscriber endpoint to which exception messages are posted.</p>
|
|
916
1026
|
*/
|
|
917
|
-
|
|
1027
|
+
subscriberEndpoint?: string;
|
|
918
1028
|
}
|
|
919
1029
|
/**
|
|
920
1030
|
* @public
|
|
921
1031
|
*/
|
|
922
|
-
export interface
|
|
1032
|
+
export interface DeleteAwsLogSourceRequest {
|
|
923
1033
|
/**
|
|
924
|
-
* <p>
|
|
1034
|
+
* <p>Specify the natively-supported Amazon Web Services service to remove as a source in
|
|
1035
|
+
* Security Lake.</p>
|
|
925
1036
|
*/
|
|
926
|
-
|
|
927
|
-
}
|
|
928
|
-
/**
|
|
929
|
-
* @public
|
|
930
|
-
*/
|
|
931
|
-
export interface DeleteDatalakeRequest {
|
|
1037
|
+
sources: AwsLogSourceConfiguration[] | undefined;
|
|
932
1038
|
}
|
|
933
1039
|
/**
|
|
934
1040
|
* @public
|
|
935
1041
|
*/
|
|
936
|
-
export interface
|
|
1042
|
+
export interface DeleteAwsLogSourceResponse {
|
|
1043
|
+
/**
|
|
1044
|
+
* <p>Deletion of the Amazon Web Services sources failed as the account is not a part of the organization.</p>
|
|
1045
|
+
*/
|
|
1046
|
+
failed?: string[];
|
|
937
1047
|
}
|
|
938
1048
|
/**
|
|
939
1049
|
* @public
|
|
940
1050
|
*/
|
|
941
|
-
export interface
|
|
1051
|
+
export interface DeleteCustomLogSourceRequest {
|
|
1052
|
+
/**
|
|
1053
|
+
* <p>The source name of custom log source that you want to delete.</p>
|
|
1054
|
+
*/
|
|
1055
|
+
sourceName: string | undefined;
|
|
942
1056
|
/**
|
|
943
|
-
* <p>
|
|
944
|
-
*
|
|
1057
|
+
* <p>The source version for the third-party custom source. You can limit the custom source
|
|
1058
|
+
* removal to the specified source version.</p>
|
|
945
1059
|
*/
|
|
946
|
-
|
|
1060
|
+
sourceVersion?: string;
|
|
947
1061
|
}
|
|
948
1062
|
/**
|
|
949
1063
|
* @public
|
|
950
1064
|
*/
|
|
951
|
-
export interface
|
|
1065
|
+
export interface DeleteCustomLogSourceResponse {
|
|
952
1066
|
}
|
|
953
1067
|
/**
|
|
954
1068
|
* @public
|
|
955
1069
|
*/
|
|
956
|
-
export interface
|
|
1070
|
+
export interface DeleteDataLakeRequest {
|
|
957
1071
|
/**
|
|
958
|
-
* <p>The
|
|
1072
|
+
* <p>The list of Regions where Security Lake is enabled.</p>
|
|
959
1073
|
*/
|
|
960
|
-
|
|
1074
|
+
regions: string[] | undefined;
|
|
961
1075
|
}
|
|
962
1076
|
/**
|
|
963
1077
|
* @public
|
|
964
1078
|
*/
|
|
965
|
-
export interface
|
|
1079
|
+
export interface DeleteDataLakeResponse {
|
|
966
1080
|
}
|
|
967
1081
|
/**
|
|
968
1082
|
* @public
|
|
969
1083
|
*/
|
|
970
|
-
export interface
|
|
971
|
-
}
|
|
972
|
-
/**
|
|
973
|
-
* @public
|
|
974
|
-
*/
|
|
975
|
-
export interface DeleteDatalakeExceptionsSubscriptionResponse {
|
|
1084
|
+
export interface DeleteDataLakeOrganizationConfigurationRequest {
|
|
976
1085
|
/**
|
|
977
|
-
* <p>
|
|
1086
|
+
* <p>Removes the automatic enablement of configuration settings for new member accounts in
|
|
1087
|
+
* Security Lake.</p>
|
|
978
1088
|
*/
|
|
979
|
-
|
|
1089
|
+
autoEnableNewAccount: DataLakeAutoEnableNewAccountConfiguration[] | undefined;
|
|
980
1090
|
}
|
|
981
1091
|
/**
|
|
982
1092
|
* @public
|
|
983
1093
|
*/
|
|
984
|
-
export interface
|
|
985
|
-
/**
|
|
986
|
-
* <p>A value created by Security Lake that uniquely identifies your <code>DeleteSubscriber</code> API request. </p>
|
|
987
|
-
*/
|
|
988
|
-
id: string | undefined;
|
|
1094
|
+
export interface DeleteDataLakeOrganizationConfigurationResponse {
|
|
989
1095
|
}
|
|
990
1096
|
/**
|
|
991
1097
|
* @public
|
|
992
1098
|
*/
|
|
993
|
-
export interface
|
|
1099
|
+
export interface GetDataLakeOrganizationConfigurationRequest {
|
|
994
1100
|
}
|
|
995
1101
|
/**
|
|
996
1102
|
* @public
|
|
997
1103
|
*/
|
|
998
|
-
export interface
|
|
1104
|
+
export interface GetDataLakeOrganizationConfigurationResponse {
|
|
999
1105
|
/**
|
|
1000
|
-
* <p>The
|
|
1106
|
+
* <p>The configuration for new accounts.</p>
|
|
1001
1107
|
*/
|
|
1002
|
-
|
|
1108
|
+
autoEnableNewAccount?: DataLakeAutoEnableNewAccountConfiguration[];
|
|
1003
1109
|
}
|
|
1004
1110
|
/**
|
|
1005
1111
|
* @public
|
|
1006
1112
|
*/
|
|
1007
|
-
export interface
|
|
1113
|
+
export interface GetDataLakeSourcesRequest {
|
|
1114
|
+
/**
|
|
1115
|
+
* <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>
|
|
1116
|
+
*/
|
|
1117
|
+
accounts?: string[];
|
|
1118
|
+
/**
|
|
1119
|
+
* <p>The maximum limit of accounts for which the static snapshot of the current Region,
|
|
1120
|
+
* including enabled accounts and log sources, is retrieved.</p>
|
|
1121
|
+
*/
|
|
1122
|
+
maxResults?: number;
|
|
1123
|
+
/**
|
|
1124
|
+
* <p>Lists if there are more results available. The value of nextToken is a unique pagination
|
|
1125
|
+
* token for each page. Repeat the call using the returned token to retrieve the next page.
|
|
1126
|
+
* Keep all other arguments unchanged.</p>
|
|
1127
|
+
* <p>Each pagination token expires after 24 hours. Using an expired pagination token will
|
|
1128
|
+
* return an HTTP 400 InvalidToken error.</p>
|
|
1129
|
+
*/
|
|
1130
|
+
nextToken?: string;
|
|
1008
1131
|
}
|
|
1009
1132
|
/**
|
|
1010
1133
|
* @public
|
|
1011
1134
|
* @enum
|
|
1012
1135
|
*/
|
|
1013
|
-
export declare const
|
|
1014
|
-
readonly
|
|
1015
|
-
readonly
|
|
1136
|
+
export declare const SourceCollectionStatus: {
|
|
1137
|
+
readonly COLLECTING: "COLLECTING";
|
|
1138
|
+
readonly MISCONFIGURED: "MISCONFIGURED";
|
|
1139
|
+
readonly NOT_COLLECTING: "NOT_COLLECTING";
|
|
1016
1140
|
};
|
|
1017
1141
|
/**
|
|
1018
1142
|
* @public
|
|
1019
1143
|
*/
|
|
1020
|
-
export type
|
|
1144
|
+
export type SourceCollectionStatus = (typeof SourceCollectionStatus)[keyof typeof SourceCollectionStatus];
|
|
1021
1145
|
/**
|
|
1022
1146
|
* @public
|
|
1023
|
-
* <p>
|
|
1147
|
+
* <p>Retrieves the Logs status for the Amazon Security Lake account.</p>
|
|
1024
1148
|
*/
|
|
1025
|
-
export
|
|
1026
|
-
readonly name: "EventBridgeException";
|
|
1027
|
-
readonly $fault: "client";
|
|
1149
|
+
export interface DataLakeSourceStatus {
|
|
1028
1150
|
/**
|
|
1029
|
-
*
|
|
1151
|
+
* <p>Defines path the stored logs are available which has information on your systems,
|
|
1152
|
+
* applications, and services.</p>
|
|
1153
|
+
*/
|
|
1154
|
+
resource?: string;
|
|
1155
|
+
/**
|
|
1156
|
+
* <p>The health status of services, including error codes and patterns.</p>
|
|
1030
1157
|
*/
|
|
1031
|
-
|
|
1158
|
+
status?: SourceCollectionStatus | string;
|
|
1032
1159
|
}
|
|
1033
1160
|
/**
|
|
1034
1161
|
* @public
|
|
1035
|
-
* <p>
|
|
1162
|
+
* <p>Amazon Security Lake collects logs and events from supported Amazon Web Services and
|
|
1163
|
+
* 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>
|
|
1036
1164
|
*/
|
|
1037
|
-
export interface
|
|
1038
|
-
/**
|
|
1039
|
-
* <p>List of all exception messages.</p>
|
|
1040
|
-
*/
|
|
1041
|
-
exceptionMessage: string | undefined;
|
|
1165
|
+
export interface DataLakeSource {
|
|
1042
1166
|
/**
|
|
1043
|
-
* <p>
|
|
1167
|
+
* <p>The ID of the Security Lake account for which logs are collected.</p>
|
|
1044
1168
|
*/
|
|
1045
|
-
|
|
1169
|
+
account?: string;
|
|
1046
1170
|
/**
|
|
1047
|
-
* <p>
|
|
1171
|
+
* <p>The supported Amazon Web Services from which logs and events are collected.
|
|
1172
|
+
* Amazon Security Lake supports log and event collection for natively supported Amazon Web Services.</p>
|
|
1048
1173
|
*/
|
|
1049
|
-
|
|
1050
|
-
}
|
|
1051
|
-
/**
|
|
1052
|
-
* @public
|
|
1053
|
-
* <p>Response element for actions that make changes, namely create, update, or delete
|
|
1054
|
-
* actions. </p>
|
|
1055
|
-
*/
|
|
1056
|
-
export interface FailuresResponse {
|
|
1174
|
+
sourceName?: string;
|
|
1057
1175
|
/**
|
|
1058
|
-
* <p>
|
|
1176
|
+
* <p>The Open Cybersecurity Schema Framework (OCSF) event classes which describes the type of
|
|
1177
|
+
* data that the custom source will send to Security Lake. The supported event classes are:</p>
|
|
1178
|
+
* <ul>
|
|
1179
|
+
* <li>
|
|
1180
|
+
* <p>
|
|
1181
|
+
* <code>ACCESS_ACTIVITY</code>
|
|
1182
|
+
* </p>
|
|
1183
|
+
* </li>
|
|
1184
|
+
* <li>
|
|
1185
|
+
* <p>
|
|
1186
|
+
* <code>FILE_ACTIVITY</code>
|
|
1187
|
+
* </p>
|
|
1188
|
+
* </li>
|
|
1189
|
+
* <li>
|
|
1190
|
+
* <p>
|
|
1191
|
+
* <code>KERNEL_ACTIVITY</code>
|
|
1192
|
+
* </p>
|
|
1193
|
+
* </li>
|
|
1194
|
+
* <li>
|
|
1195
|
+
* <p>
|
|
1196
|
+
* <code>KERNEL_EXTENSION</code>
|
|
1197
|
+
* </p>
|
|
1198
|
+
* </li>
|
|
1199
|
+
* <li>
|
|
1200
|
+
* <p>
|
|
1201
|
+
* <code>MEMORY_ACTIVITY</code>
|
|
1202
|
+
* </p>
|
|
1203
|
+
* </li>
|
|
1204
|
+
* <li>
|
|
1205
|
+
* <p>
|
|
1206
|
+
* <code>MODULE_ACTIVITY</code>
|
|
1207
|
+
* </p>
|
|
1208
|
+
* </li>
|
|
1209
|
+
* <li>
|
|
1210
|
+
* <p>
|
|
1211
|
+
* <code>PROCESS_ACTIVITY</code>
|
|
1212
|
+
* </p>
|
|
1213
|
+
* </li>
|
|
1214
|
+
* <li>
|
|
1215
|
+
* <p>
|
|
1216
|
+
* <code>REGISTRY_KEY_ACTIVITY</code>
|
|
1217
|
+
* </p>
|
|
1218
|
+
* </li>
|
|
1219
|
+
* <li>
|
|
1220
|
+
* <p>
|
|
1221
|
+
* <code>REGISTRY_VALUE_ACTIVITY</code>
|
|
1222
|
+
* </p>
|
|
1223
|
+
* </li>
|
|
1224
|
+
* <li>
|
|
1225
|
+
* <p>
|
|
1226
|
+
* <code>RESOURCE_ACTIVITY</code>
|
|
1227
|
+
* </p>
|
|
1228
|
+
* </li>
|
|
1229
|
+
* <li>
|
|
1230
|
+
* <p>
|
|
1231
|
+
* <code>SCHEDULED_JOB_ACTIVITY</code>
|
|
1232
|
+
* </p>
|
|
1233
|
+
* </li>
|
|
1234
|
+
* <li>
|
|
1235
|
+
* <p>
|
|
1236
|
+
* <code>SECURITY_FINDING</code>
|
|
1237
|
+
* </p>
|
|
1238
|
+
* </li>
|
|
1239
|
+
* <li>
|
|
1240
|
+
* <p>
|
|
1241
|
+
* <code>ACCOUNT_CHANGE</code>
|
|
1242
|
+
* </p>
|
|
1243
|
+
* </li>
|
|
1244
|
+
* <li>
|
|
1245
|
+
* <p>
|
|
1246
|
+
* <code>AUTHENTICATION</code>
|
|
1247
|
+
* </p>
|
|
1248
|
+
* </li>
|
|
1249
|
+
* <li>
|
|
1250
|
+
* <p>
|
|
1251
|
+
* <code>AUTHORIZATION</code>
|
|
1252
|
+
* </p>
|
|
1253
|
+
* </li>
|
|
1254
|
+
* <li>
|
|
1255
|
+
* <p>
|
|
1256
|
+
* <code>ENTITY_MANAGEMENT_AUDIT</code>
|
|
1257
|
+
* </p>
|
|
1258
|
+
* </li>
|
|
1259
|
+
* <li>
|
|
1260
|
+
* <p>
|
|
1261
|
+
* <code>DHCP_ACTIVITY</code>
|
|
1262
|
+
* </p>
|
|
1263
|
+
* </li>
|
|
1264
|
+
* <li>
|
|
1265
|
+
* <p>
|
|
1266
|
+
* <code>NETWORK_ACTIVITY</code>
|
|
1267
|
+
* </p>
|
|
1268
|
+
* </li>
|
|
1269
|
+
* <li>
|
|
1270
|
+
* <p>
|
|
1271
|
+
* <code>DNS_ACTIVITY</code>
|
|
1272
|
+
* </p>
|
|
1273
|
+
* </li>
|
|
1274
|
+
* <li>
|
|
1275
|
+
* <p>
|
|
1276
|
+
* <code>FTP_ACTIVITY</code>
|
|
1277
|
+
* </p>
|
|
1278
|
+
* </li>
|
|
1279
|
+
* <li>
|
|
1280
|
+
* <p>
|
|
1281
|
+
* <code>HTTP_ACTIVITY</code>
|
|
1282
|
+
* </p>
|
|
1283
|
+
* </li>
|
|
1284
|
+
* <li>
|
|
1285
|
+
* <p>
|
|
1286
|
+
* <code>RDP_ACTIVITY</code>
|
|
1287
|
+
* </p>
|
|
1288
|
+
* </li>
|
|
1289
|
+
* <li>
|
|
1290
|
+
* <p>
|
|
1291
|
+
* <code>SMB_ACTIVITY</code>
|
|
1292
|
+
* </p>
|
|
1293
|
+
* </li>
|
|
1294
|
+
* <li>
|
|
1295
|
+
* <p>
|
|
1296
|
+
* <code>SSH_ACTIVITY</code>
|
|
1297
|
+
* </p>
|
|
1298
|
+
* </li>
|
|
1299
|
+
* <li>
|
|
1300
|
+
* <p>
|
|
1301
|
+
* <code>CONFIG_STATE</code>
|
|
1302
|
+
* </p>
|
|
1303
|
+
* </li>
|
|
1304
|
+
* <li>
|
|
1305
|
+
* <p>
|
|
1306
|
+
* <code>INVENTORY_INFO</code>
|
|
1307
|
+
* </p>
|
|
1308
|
+
* </li>
|
|
1309
|
+
* <li>
|
|
1310
|
+
* <p>
|
|
1311
|
+
* <code>EMAIL_ACTIVITY</code>
|
|
1312
|
+
* </p>
|
|
1313
|
+
* </li>
|
|
1314
|
+
* <li>
|
|
1315
|
+
* <p>
|
|
1316
|
+
* <code>API_ACTIVITY</code>
|
|
1317
|
+
* </p>
|
|
1318
|
+
* </li>
|
|
1319
|
+
* <li>
|
|
1320
|
+
* <p>
|
|
1321
|
+
* <code>CLOUD_API</code>
|
|
1322
|
+
* </p>
|
|
1323
|
+
* </li>
|
|
1324
|
+
* </ul>
|
|
1059
1325
|
*/
|
|
1060
|
-
|
|
1326
|
+
eventClasses?: string[];
|
|
1061
1327
|
/**
|
|
1062
|
-
* <p>
|
|
1063
|
-
*/
|
|
1064
|
-
|
|
1065
|
-
}
|
|
1066
|
-
/**
|
|
1067
|
-
* @public
|
|
1068
|
-
*/
|
|
1069
|
-
export interface GetDatalakeRequest {
|
|
1070
|
-
}
|
|
1071
|
-
/**
|
|
1072
|
-
* @public
|
|
1073
|
-
* @enum
|
|
1074
|
-
*/
|
|
1075
|
-
export declare const SettingsStatus: {
|
|
1076
|
-
readonly COMPLETED: "COMPLETED";
|
|
1077
|
-
readonly FAILED: "FAILED";
|
|
1078
|
-
readonly INITIALIZED: "INITIALIZED";
|
|
1079
|
-
readonly PENDING: "PENDING";
|
|
1080
|
-
};
|
|
1081
|
-
/**
|
|
1082
|
-
* @public
|
|
1083
|
-
*/
|
|
1084
|
-
export type SettingsStatus = (typeof SettingsStatus)[keyof typeof SettingsStatus];
|
|
1328
|
+
* <p>The log status for the Security Lake account.</p>
|
|
1329
|
+
*/
|
|
1330
|
+
sourceStatuses?: DataLakeSourceStatus[];
|
|
1331
|
+
}
|
|
1085
1332
|
/**
|
|
1086
1333
|
* @public
|
|
1087
|
-
* <p>The details of the last <code>UpdateDatalake</code> or <code>DeleteDatalake</code>
|
|
1088
|
-
* API request which failed.</p>
|
|
1089
1334
|
*/
|
|
1090
|
-
export interface
|
|
1335
|
+
export interface GetDataLakeSourcesResponse {
|
|
1091
1336
|
/**
|
|
1092
|
-
* <p>The
|
|
1093
|
-
* <code>DeleteDatalake</code> API request.</p>
|
|
1337
|
+
* <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>
|
|
1094
1338
|
*/
|
|
1095
|
-
|
|
1339
|
+
dataLakeArn?: string;
|
|
1096
1340
|
/**
|
|
1097
|
-
* <p>The
|
|
1098
|
-
* <code>DeleteDatalake</code> API request.</p>
|
|
1341
|
+
* <p>The list of enabled accounts and enabled sources.</p>
|
|
1099
1342
|
*/
|
|
1100
|
-
|
|
1343
|
+
dataLakeSources?: DataLakeSource[];
|
|
1344
|
+
/**
|
|
1345
|
+
* <p>Lists if there are more results available. The value of nextToken is a unique pagination
|
|
1346
|
+
* token for each page. Repeat the call using the returned token to retrieve the next page.
|
|
1347
|
+
* Keep all other arguments unchanged.</p>
|
|
1348
|
+
* <p>Each pagination token expires after 24 hours. Using an expired pagination token will
|
|
1349
|
+
* return an HTTP 400 InvalidToken error.</p>
|
|
1350
|
+
*/
|
|
1351
|
+
nextToken?: string;
|
|
1101
1352
|
}
|
|
1102
1353
|
/**
|
|
1103
1354
|
* @public
|
|
1104
|
-
* <p>The status of the last <code>UpdateDatalake</code> or <code>DeleteDatalake</code> API
|
|
1105
|
-
* request. This is set to Completed after the configuration is updated, or removed if
|
|
1106
|
-
* deletion of the data lake is successful.</p>
|
|
1107
1355
|
*/
|
|
1108
|
-
export interface
|
|
1109
|
-
/**
|
|
1110
|
-
* <p>The unique ID for the <code>UpdateDatalake</code> or <code>DeleteDatalake</code> API
|
|
1111
|
-
* request.</p>
|
|
1112
|
-
*/
|
|
1113
|
-
lastUpdateRequestId?: string;
|
|
1356
|
+
export interface ListDataLakesRequest {
|
|
1114
1357
|
/**
|
|
1115
|
-
* <p>The
|
|
1116
|
-
* request that was requested.</p>
|
|
1358
|
+
* <p>The list of regions where Security Lake is enabled.</p>
|
|
1117
1359
|
*/
|
|
1118
|
-
|
|
1360
|
+
regions?: string[];
|
|
1361
|
+
}
|
|
1362
|
+
/**
|
|
1363
|
+
* @public
|
|
1364
|
+
*/
|
|
1365
|
+
export interface ListDataLakesResponse {
|
|
1119
1366
|
/**
|
|
1120
|
-
* <p>
|
|
1121
|
-
* request which failed.</p>
|
|
1367
|
+
* <p>Retrieves the Security Lake configuration object.</p>
|
|
1122
1368
|
*/
|
|
1123
|
-
|
|
1369
|
+
dataLakes?: DataLakeResource[];
|
|
1124
1370
|
}
|
|
1125
1371
|
/**
|
|
1126
1372
|
* @public
|
|
1127
|
-
* <p>Provides details of Amazon Security Lake lake configuration object.</p>
|
|
1128
1373
|
*/
|
|
1129
|
-
export interface
|
|
1374
|
+
export interface ListLogSourcesRequest {
|
|
1130
1375
|
/**
|
|
1131
|
-
* <p>The
|
|
1376
|
+
* <p>The list of Amazon Web Services accounts for which log sources are displayed.</p>
|
|
1132
1377
|
*/
|
|
1133
|
-
|
|
1378
|
+
accounts?: string[];
|
|
1134
1379
|
/**
|
|
1135
|
-
* <p>
|
|
1380
|
+
* <p>The list of regions for which log sources are displayed.</p>
|
|
1136
1381
|
*/
|
|
1137
|
-
|
|
1382
|
+
regions?: string[];
|
|
1138
1383
|
/**
|
|
1139
|
-
* <p>
|
|
1140
|
-
* optional value, both of which you define.</p>
|
|
1384
|
+
* <p>The list of sources for which log sources are displayed.</p>
|
|
1141
1385
|
*/
|
|
1142
|
-
|
|
1386
|
+
sources?: LogSourceResource[];
|
|
1143
1387
|
/**
|
|
1144
|
-
* <p>
|
|
1145
|
-
* buckets. Amazon S3 buckets that are configured for object replication can be owned
|
|
1146
|
-
* by the same Amazon Web Services account or by different accounts. You can replicate objects
|
|
1147
|
-
* to a single destination bucket or to multiple destination buckets. The destination buckets
|
|
1148
|
-
* can be in different Amazon Web Services Regions or within the same Region as the source
|
|
1149
|
-
* bucket.</p>
|
|
1150
|
-
* <p>Set up one or more rollup Regions by providing the Region or Regions that should
|
|
1151
|
-
* contribute to the central rollup Region. </p>
|
|
1388
|
+
* <p>The maximum number of accounts for which the log sources are displayed.</p>
|
|
1152
1389
|
*/
|
|
1153
|
-
|
|
1390
|
+
maxResults?: number;
|
|
1154
1391
|
/**
|
|
1155
|
-
* <p>
|
|
1156
|
-
*
|
|
1392
|
+
* <p>If nextToken is returned, there are more results available. You can repeat the call
|
|
1393
|
+
* using the returned token to retrieve the next page.</p>
|
|
1157
1394
|
*/
|
|
1158
|
-
|
|
1395
|
+
nextToken?: string;
|
|
1396
|
+
}
|
|
1397
|
+
/**
|
|
1398
|
+
* @public
|
|
1399
|
+
* <p>Amazon Security Lake can collect logs and events from natively-supported Amazon Web Services services and custom sources. </p>
|
|
1400
|
+
*/
|
|
1401
|
+
export interface LogSource {
|
|
1159
1402
|
/**
|
|
1160
|
-
* <p>
|
|
1161
|
-
* requires an ARN when you need to specify a resource unambiguously across all of Amazon Web Services, such as in IAM policies, Amazon Relational Database Service (Amazon RDS) tags, and API calls. </p>
|
|
1403
|
+
* <p>Specify the account from which you want to collect logs.</p>
|
|
1162
1404
|
*/
|
|
1163
|
-
|
|
1405
|
+
account?: string;
|
|
1164
1406
|
/**
|
|
1165
|
-
* <p>
|
|
1407
|
+
* <p>Specify the Regions from which you want to collect logs.</p>
|
|
1166
1408
|
*/
|
|
1167
|
-
|
|
1409
|
+
region?: string;
|
|
1168
1410
|
/**
|
|
1169
|
-
* <p>
|
|
1170
|
-
* request. </p>
|
|
1411
|
+
* <p>Specify the sources from which you want to collect logs.</p>
|
|
1171
1412
|
*/
|
|
1172
|
-
|
|
1413
|
+
sources?: LogSourceResource[];
|
|
1173
1414
|
}
|
|
1174
1415
|
/**
|
|
1175
1416
|
* @public
|
|
1176
1417
|
*/
|
|
1177
|
-
export interface
|
|
1418
|
+
export interface ListLogSourcesResponse {
|
|
1178
1419
|
/**
|
|
1179
|
-
* <p>
|
|
1420
|
+
* <p>The list of log sources in your organization that send data to the data lake.</p>
|
|
1421
|
+
*/
|
|
1422
|
+
sources?: LogSource[];
|
|
1423
|
+
/**
|
|
1424
|
+
* <p>If nextToken is returned, there are more results available. You can repeat the call
|
|
1425
|
+
* using the returned token to retrieve the next page.</p>
|
|
1180
1426
|
*/
|
|
1181
|
-
|
|
1427
|
+
nextToken?: string;
|
|
1182
1428
|
}
|
|
1183
1429
|
/**
|
|
1184
1430
|
* @public
|
|
1185
1431
|
*/
|
|
1186
|
-
export interface
|
|
1432
|
+
export interface UpdateDataLakeRequest {
|
|
1433
|
+
/**
|
|
1434
|
+
* <p>Specify the Region or Regions that will contribute data to the rollup region.</p>
|
|
1435
|
+
*/
|
|
1436
|
+
configurations: DataLakeConfiguration[] | undefined;
|
|
1187
1437
|
}
|
|
1188
1438
|
/**
|
|
1189
1439
|
* @public
|
|
1190
1440
|
*/
|
|
1191
|
-
export interface
|
|
1441
|
+
export interface UpdateDataLakeResponse {
|
|
1192
1442
|
/**
|
|
1193
|
-
* <p>The
|
|
1443
|
+
* <p>The created Security Lake configuration object.</p>
|
|
1194
1444
|
*/
|
|
1195
|
-
|
|
1445
|
+
dataLakes?: DataLakeResource[];
|
|
1196
1446
|
}
|
|
1197
1447
|
/**
|
|
1198
1448
|
* @public
|
|
1449
|
+
* <p>The details for a Security Lake exception</p>
|
|
1199
1450
|
*/
|
|
1200
|
-
export interface
|
|
1451
|
+
export interface DataLakeException {
|
|
1452
|
+
/**
|
|
1453
|
+
* <p>The Amazon Web Services Regions where the exception occurred.</p>
|
|
1454
|
+
*/
|
|
1455
|
+
region?: string;
|
|
1456
|
+
/**
|
|
1457
|
+
* <p>The underlying exception of a Security Lake exception.</p>
|
|
1458
|
+
*/
|
|
1459
|
+
exception?: string;
|
|
1460
|
+
/**
|
|
1461
|
+
* <p>List of all remediation steps for a Security Lake exception.</p>
|
|
1462
|
+
*/
|
|
1463
|
+
remediation?: string;
|
|
1464
|
+
/**
|
|
1465
|
+
* <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>
|
|
1466
|
+
*/
|
|
1467
|
+
timestamp?: Date;
|
|
1201
1468
|
}
|
|
1202
1469
|
/**
|
|
1203
1470
|
* @public
|
|
1204
1471
|
*/
|
|
1205
|
-
export interface
|
|
1206
|
-
/**
|
|
1207
|
-
* <p>The expiration period and time-to-live (TTL).</p>
|
|
1208
|
-
*/
|
|
1209
|
-
exceptionMessageExpiry: number | undefined;
|
|
1472
|
+
export interface DeleteDataLakeExceptionSubscriptionRequest {
|
|
1210
1473
|
}
|
|
1211
1474
|
/**
|
|
1212
1475
|
* @public
|
|
1213
1476
|
*/
|
|
1214
|
-
export interface
|
|
1477
|
+
export interface DeleteDataLakeExceptionSubscriptionResponse {
|
|
1215
1478
|
}
|
|
1216
1479
|
/**
|
|
1217
1480
|
* @public
|
|
1218
|
-
* <p>Protocol used in Amazon Security Lake that dictates how notifications are posted at the
|
|
1219
|
-
* endpoint. </p>
|
|
1220
1481
|
*/
|
|
1221
|
-
export interface
|
|
1222
|
-
/**
|
|
1223
|
-
* <p>The protocol to which notification messages are posted. </p>
|
|
1224
|
-
*/
|
|
1225
|
-
protocol?: string;
|
|
1482
|
+
export interface DeleteSubscriberRequest {
|
|
1226
1483
|
/**
|
|
1227
|
-
* <p>
|
|
1484
|
+
* <p>A value created by Security Lake that uniquely identifies your <code>DeleteSubscriber</code> API request.</p>
|
|
1228
1485
|
*/
|
|
1229
|
-
|
|
1486
|
+
subscriberId: string | undefined;
|
|
1230
1487
|
}
|
|
1231
1488
|
/**
|
|
1232
1489
|
* @public
|
|
1233
1490
|
*/
|
|
1234
|
-
export interface
|
|
1235
|
-
/**
|
|
1236
|
-
* <p>Retrieves the exception notification subscription information.</p>
|
|
1237
|
-
*/
|
|
1238
|
-
protocolAndNotificationEndpoint: ProtocolAndNotificationEndpoint | undefined;
|
|
1491
|
+
export interface DeleteSubscriberResponse {
|
|
1239
1492
|
}
|
|
1240
1493
|
/**
|
|
1241
1494
|
* @public
|
|
1242
1495
|
*/
|
|
1243
|
-
export interface
|
|
1496
|
+
export interface DeleteSubscriberNotificationRequest {
|
|
1244
1497
|
/**
|
|
1245
|
-
* <p>The
|
|
1246
|
-
*/
|
|
1247
|
-
accountSet?: string[];
|
|
1248
|
-
/**
|
|
1249
|
-
* <p>The maximum limit of accounts for which the static snapshot of the current Region,
|
|
1250
|
-
* including enabled accounts and log sources, is retrieved.</p>
|
|
1251
|
-
*/
|
|
1252
|
-
maxAccountResults?: number;
|
|
1253
|
-
/**
|
|
1254
|
-
* <p>Lists if there are more results available. The value of nextToken is a unique pagination
|
|
1255
|
-
* token for each page. Repeat the call using the returned token to retrieve the next page.
|
|
1256
|
-
* Keep all other arguments unchanged. </p>
|
|
1257
|
-
* <p>Each pagination token expires after 24 hours. Using an expired pagination token will
|
|
1258
|
-
* return an HTTP 400 InvalidToken error.</p>
|
|
1498
|
+
* <p>The ID of the Security Lake subscriber account.</p>
|
|
1259
1499
|
*/
|
|
1260
|
-
|
|
1500
|
+
subscriberId: string | undefined;
|
|
1261
1501
|
}
|
|
1262
1502
|
/**
|
|
1263
1503
|
* @public
|
|
1264
1504
|
*/
|
|
1265
|
-
export interface
|
|
1266
|
-
/**
|
|
1267
|
-
* <p>The list of enabled accounts and enabled sources.</p>
|
|
1268
|
-
*/
|
|
1269
|
-
accountSourcesList: AccountSources[] | undefined;
|
|
1270
|
-
/**
|
|
1271
|
-
* <p>Lists if there are more results available. The value of nextToken is a unique pagination
|
|
1272
|
-
* token for each page. Repeat the call using the returned token to retrieve the next page.
|
|
1273
|
-
* Keep all other arguments unchanged. </p>
|
|
1274
|
-
* <p>Each pagination token expires after 24 hours. Using an expired pagination token will
|
|
1275
|
-
* return an HTTP 400 InvalidToken error.</p>
|
|
1276
|
-
*/
|
|
1277
|
-
nextToken?: string;
|
|
1505
|
+
export interface DeleteSubscriberNotificationResponse {
|
|
1278
1506
|
}
|
|
1279
1507
|
/**
|
|
1280
1508
|
* @public
|
|
1281
1509
|
*/
|
|
1282
|
-
export interface
|
|
1283
|
-
/**
|
|
1284
|
-
* <p>A value created by Amazon Security Lake that uniquely identifies your
|
|
1285
|
-
* <code>GetSubscriber</code> API request.</p>
|
|
1286
|
-
*/
|
|
1287
|
-
id: string | undefined;
|
|
1510
|
+
export interface DeregisterDataLakeDelegatedAdministratorRequest {
|
|
1288
1511
|
}
|
|
1289
1512
|
/**
|
|
1290
1513
|
* @public
|
|
1291
|
-
* @enum
|
|
1292
1514
|
*/
|
|
1293
|
-
export
|
|
1294
|
-
|
|
1295
|
-
readonly DEACTIVATED: "DEACTIVATED";
|
|
1296
|
-
readonly PENDING: "PENDING";
|
|
1297
|
-
readonly READY: "READY";
|
|
1298
|
-
};
|
|
1515
|
+
export interface DeregisterDataLakeDelegatedAdministratorResponse {
|
|
1516
|
+
}
|
|
1299
1517
|
/**
|
|
1300
1518
|
* @public
|
|
1301
1519
|
*/
|
|
1302
|
-
export
|
|
1520
|
+
export interface GetDataLakeExceptionSubscriptionRequest {
|
|
1521
|
+
}
|
|
1303
1522
|
/**
|
|
1304
1523
|
* @public
|
|
1305
|
-
* <p>Provides details about the Amazon Security Lake account subscription. Subscribers are notified
|
|
1306
|
-
* of new objects for a source as the data is written to your Amazon S3 bucket for
|
|
1307
|
-
* Security Lake. </p>
|
|
1308
1524
|
*/
|
|
1309
|
-
export interface
|
|
1310
|
-
/**
|
|
1311
|
-
* <p>The subscription ID of the Amazon Security Lake subscriber account.</p>
|
|
1312
|
-
*/
|
|
1313
|
-
subscriptionId: string | undefined;
|
|
1314
|
-
/**
|
|
1315
|
-
* <p>Amazon Security Lake supports log and event collection for natively supported Amazon Web Services. For more information, see the Amazon Security Lake User Guide.</p>
|
|
1316
|
-
*/
|
|
1317
|
-
sourceTypes: SourceType[] | undefined;
|
|
1318
|
-
/**
|
|
1319
|
-
* <p>The Amazon Web Services account ID you are using to create your Amazon Security Lake
|
|
1320
|
-
* account.</p>
|
|
1321
|
-
*/
|
|
1322
|
-
accountId: string | undefined;
|
|
1323
|
-
/**
|
|
1324
|
-
* <p>The name of your Amazon Security Lake subscriber account.</p>
|
|
1325
|
-
*/
|
|
1326
|
-
subscriberName?: string;
|
|
1327
|
-
/**
|
|
1328
|
-
* <p>The subscriber descriptions for a subscriber account. The description for a subscriber
|
|
1329
|
-
* includes <code>subscriberName</code>, <code>accountID</code>, <code>externalID</code>, and
|
|
1330
|
-
* <code>subscriptionId</code>.</p>
|
|
1331
|
-
*/
|
|
1332
|
-
subscriberDescription?: string;
|
|
1525
|
+
export interface GetDataLakeExceptionSubscriptionResponse {
|
|
1333
1526
|
/**
|
|
1334
|
-
* <p>The subscription
|
|
1527
|
+
* <p>The subscription protocol to which exception notifications are posted.</p>
|
|
1335
1528
|
*/
|
|
1336
|
-
|
|
1529
|
+
subscriptionProtocol?: string;
|
|
1337
1530
|
/**
|
|
1338
|
-
* <p>The Amazon
|
|
1339
|
-
*/
|
|
1340
|
-
roleArn?: string;
|
|
1341
|
-
/**
|
|
1342
|
-
* <p>The ARN for the Amazon Simple Notification Service.</p>
|
|
1343
|
-
*/
|
|
1344
|
-
snsArn?: string;
|
|
1345
|
-
/**
|
|
1346
|
-
* <p>The ARN for the Amazon S3 bucket. </p>
|
|
1347
|
-
*/
|
|
1348
|
-
s3BucketArn?: string;
|
|
1349
|
-
/**
|
|
1350
|
-
* <p>You can choose to notify subscribers of new objects with an Amazon Simple Queue Service
|
|
1351
|
-
* (Amazon SQS) queue or through messaging to an HTTPS endpoint provided by the
|
|
1352
|
-
* subscriber. </p>
|
|
1353
|
-
* <p> Subscribers can consume data by directly querying Lake Formation tables in your
|
|
1354
|
-
* Amazon S3 bucket through services like Amazon Athena. This subscription
|
|
1355
|
-
* type is defined as <code>LAKEFORMATION</code>. </p>
|
|
1356
|
-
*/
|
|
1357
|
-
accessTypes?: (AccessType | string)[];
|
|
1358
|
-
/**
|
|
1359
|
-
* <p>The subscription endpoint to which exception messages are posted. </p>
|
|
1531
|
+
* <p>The Amazon Web Services account where you receive exception notifications.</p>
|
|
1360
1532
|
*/
|
|
1361
|
-
|
|
1533
|
+
notificationEndpoint?: string;
|
|
1362
1534
|
/**
|
|
1363
|
-
* <p>The
|
|
1364
|
-
*/
|
|
1365
|
-
subscriptionProtocol?: EndpointProtocol | string;
|
|
1366
|
-
/**
|
|
1367
|
-
* <p>The external ID of the subscriber. The external ID lets the user that is assuming the
|
|
1368
|
-
* role assert the circumstances in which they are operating. It also provides a way for the
|
|
1369
|
-
* account owner to permit the role to be assumed only under specific circumstances.</p>
|
|
1370
|
-
*/
|
|
1371
|
-
externalId?: string;
|
|
1372
|
-
/**
|
|
1373
|
-
* <p>The date and time when the subscription was created. </p>
|
|
1374
|
-
*/
|
|
1375
|
-
createdAt?: Date;
|
|
1376
|
-
/**
|
|
1377
|
-
* <p>The date and time when the subscription was created. </p>
|
|
1378
|
-
*/
|
|
1379
|
-
updatedAt?: Date;
|
|
1380
|
-
/**
|
|
1381
|
-
* <p>The Amazon Resource Name (ARN) which uniquely defines the AWS RAM resource share. Before
|
|
1382
|
-
* accepting the RAM resource share invitation, you can view details related to the RAM
|
|
1383
|
-
* resource share.</p>
|
|
1384
|
-
* <p>This field is available only for Lake Formation subscribers created after March 8, 2023.</p>
|
|
1535
|
+
* <p>The expiration period and time-to-live (TTL).</p>
|
|
1385
1536
|
*/
|
|
1386
|
-
|
|
1537
|
+
exceptionTimeToLive?: number;
|
|
1538
|
+
}
|
|
1539
|
+
/**
|
|
1540
|
+
* @public
|
|
1541
|
+
*/
|
|
1542
|
+
export interface GetSubscriberRequest {
|
|
1387
1543
|
/**
|
|
1388
|
-
* <p>
|
|
1544
|
+
* <p>A value created by Amazon Security Lake that uniquely identifies your
|
|
1545
|
+
* <code>GetSubscriber</code> API request.</p>
|
|
1389
1546
|
*/
|
|
1390
|
-
|
|
1547
|
+
subscriberId: string | undefined;
|
|
1391
1548
|
}
|
|
1392
1549
|
/**
|
|
1393
1550
|
* @public
|
|
1394
1551
|
*/
|
|
1395
1552
|
export interface GetSubscriberResponse {
|
|
1396
1553
|
/**
|
|
1397
|
-
* <p>The
|
|
1554
|
+
* <p>The subscriber information for the specified subscriber ID.</p>
|
|
1398
1555
|
*/
|
|
1399
1556
|
subscriber?: SubscriberResource;
|
|
1400
1557
|
}
|
|
1401
1558
|
/**
|
|
1402
1559
|
* @public
|
|
1403
1560
|
*/
|
|
1404
|
-
export interface
|
|
1561
|
+
export interface ListDataLakeExceptionsRequest {
|
|
1405
1562
|
/**
|
|
1406
1563
|
* <p>List the Amazon Web Services Regions from which exceptions are retrieved.</p>
|
|
1407
1564
|
*/
|
|
1408
|
-
|
|
1565
|
+
regions?: string[];
|
|
1409
1566
|
/**
|
|
1410
1567
|
* <p>List the maximum number of failures in Security Lake.</p>
|
|
1411
1568
|
*/
|
|
1412
|
-
|
|
1569
|
+
maxResults?: number;
|
|
1413
1570
|
/**
|
|
1414
1571
|
* <p>List if there are more results available. The value of nextToken is a unique pagination
|
|
1415
1572
|
* token for each page. Repeat the call using the returned token to retrieve the next page.
|
|
1416
|
-
* Keep all other arguments unchanged
|
|
1573
|
+
* Keep all other arguments unchanged.</p>
|
|
1417
1574
|
* <p>Each pagination token expires after 24 hours. Using an expired pagination token will
|
|
1418
1575
|
* return an HTTP 400 InvalidToken error.</p>
|
|
1419
1576
|
*/
|
|
@@ -1422,66 +1579,20 @@ export interface ListDatalakeExceptionsRequest {
|
|
|
1422
1579
|
/**
|
|
1423
1580
|
* @public
|
|
1424
1581
|
*/
|
|
1425
|
-
export interface
|
|
1582
|
+
export interface ListDataLakeExceptionsResponse {
|
|
1426
1583
|
/**
|
|
1427
1584
|
* <p>Lists the failures that cannot be retried in the current Region.</p>
|
|
1428
1585
|
*/
|
|
1429
|
-
|
|
1586
|
+
exceptions?: DataLakeException[];
|
|
1430
1587
|
/**
|
|
1431
1588
|
* <p>List if there are more results available. The value of nextToken is a unique pagination
|
|
1432
1589
|
* token for each page. Repeat the call using the returned token to retrieve the next page.
|
|
1433
|
-
* Keep all other arguments unchanged
|
|
1590
|
+
* Keep all other arguments unchanged.</p>
|
|
1434
1591
|
* <p>Each pagination token expires after 24 hours. Using an expired pagination token will
|
|
1435
1592
|
* return an HTTP 400 InvalidToken error.</p>
|
|
1436
1593
|
*/
|
|
1437
1594
|
nextToken?: string;
|
|
1438
1595
|
}
|
|
1439
|
-
/**
|
|
1440
|
-
* @public
|
|
1441
|
-
*/
|
|
1442
|
-
export interface ListLogSourcesRequest {
|
|
1443
|
-
/**
|
|
1444
|
-
* <p>Lists the log sources in input order, namely Region, source
|
|
1445
|
-
* type, and member account.</p>
|
|
1446
|
-
*/
|
|
1447
|
-
inputOrder?: (Dimension | string)[];
|
|
1448
|
-
/**
|
|
1449
|
-
* <p>List the view of log sources for enabled Amazon Security Lake accounts for specific Amazon Web Services sources from specific accounts and specific Regions.</p>
|
|
1450
|
-
*/
|
|
1451
|
-
listAllDimensions?: Record<string, Record<string, string[]>>;
|
|
1452
|
-
/**
|
|
1453
|
-
* <p>Lists the view of log sources for enabled Security Lake accounts for specific Amazon Web Services sources from specific accounts or specific Regions.</p>
|
|
1454
|
-
*/
|
|
1455
|
-
listTwoDimensions?: Record<string, string[]>;
|
|
1456
|
-
/**
|
|
1457
|
-
* <p>List the view of log sources for enabled Security Lake accounts for all Amazon Web Services
|
|
1458
|
-
* sources from specific accounts or specific Regions.</p>
|
|
1459
|
-
*/
|
|
1460
|
-
listSingleDimension?: string[];
|
|
1461
|
-
/**
|
|
1462
|
-
* <p>The maximum number of accounts for which the log sources are displayed.</p>
|
|
1463
|
-
*/
|
|
1464
|
-
maxResults?: number;
|
|
1465
|
-
/**
|
|
1466
|
-
* <p>If nextToken is returned, there are more results available. You can repeat the call
|
|
1467
|
-
* using the returned token to retrieve the next page.</p>
|
|
1468
|
-
*/
|
|
1469
|
-
nextToken?: string;
|
|
1470
|
-
}
|
|
1471
|
-
/**
|
|
1472
|
-
* @public
|
|
1473
|
-
*/
|
|
1474
|
-
export interface ListLogSourcesResponse {
|
|
1475
|
-
/**
|
|
1476
|
-
* <p>Lists the log sources by Regions for enabled Security Lake accounts.</p>
|
|
1477
|
-
*/
|
|
1478
|
-
regionSourceTypesAccountsList: Record<string, Record<string, string[]>>[] | undefined;
|
|
1479
|
-
/**
|
|
1480
|
-
* <p>If nextToken is returned, there are more results available. You can repeat the call
|
|
1481
|
-
* using the returned token to retrieve the next page.</p>
|
|
1482
|
-
*/
|
|
1483
|
-
nextToken?: string;
|
|
1484
|
-
}
|
|
1485
1596
|
/**
|
|
1486
1597
|
* @public
|
|
1487
1598
|
*/
|
|
@@ -1503,7 +1614,7 @@ export interface ListSubscribersResponse {
|
|
|
1503
1614
|
/**
|
|
1504
1615
|
* <p>The subscribers available for the specified Security Lake account ID.</p>
|
|
1505
1616
|
*/
|
|
1506
|
-
subscribers
|
|
1617
|
+
subscribers?: SubscriberResource[];
|
|
1507
1618
|
/**
|
|
1508
1619
|
* <p>If nextToken is returned, there are more results available. You can repeat the call
|
|
1509
1620
|
* using the returned token to retrieve the next page.</p>
|
|
@@ -1513,125 +1624,93 @@ export interface ListSubscribersResponse {
|
|
|
1513
1624
|
/**
|
|
1514
1625
|
* @public
|
|
1515
1626
|
*/
|
|
1516
|
-
export interface
|
|
1517
|
-
/**
|
|
1518
|
-
* <p>Specify the Region or Regions that will contribute data to the rollup region.</p>
|
|
1519
|
-
*/
|
|
1520
|
-
configurations: Record<string, LakeConfigurationRequest> | undefined;
|
|
1521
|
-
}
|
|
1522
|
-
/**
|
|
1523
|
-
* @public
|
|
1524
|
-
*/
|
|
1525
|
-
export interface UpdateDatalakeResponse {
|
|
1526
|
-
}
|
|
1527
|
-
/**
|
|
1528
|
-
* @public
|
|
1529
|
-
*/
|
|
1530
|
-
export interface UpdateDatalakeExceptionsExpiryRequest {
|
|
1531
|
-
/**
|
|
1532
|
-
* <p>The time-to-live (TTL) for the exception message to remain.</p>
|
|
1533
|
-
*/
|
|
1534
|
-
exceptionMessageExpiry: number | undefined;
|
|
1535
|
-
}
|
|
1536
|
-
/**
|
|
1537
|
-
* @public
|
|
1538
|
-
*/
|
|
1539
|
-
export interface UpdateDatalakeExceptionsExpiryResponse {
|
|
1540
|
-
}
|
|
1541
|
-
/**
|
|
1542
|
-
* @public
|
|
1543
|
-
*/
|
|
1544
|
-
export interface UpdateDatalakeExceptionsSubscriptionRequest {
|
|
1545
|
-
/**
|
|
1546
|
-
* <p>The subscription protocol to which exception messages are posted. </p>
|
|
1547
|
-
*/
|
|
1548
|
-
subscriptionProtocol: SubscriptionProtocolType | string | undefined;
|
|
1627
|
+
export interface RegisterDataLakeDelegatedAdministratorRequest {
|
|
1549
1628
|
/**
|
|
1550
|
-
* <p>The account
|
|
1629
|
+
* <p>The Amazon Web Services account ID of the Security Lake delegated administrator.</p>
|
|
1551
1630
|
*/
|
|
1552
|
-
|
|
1631
|
+
accountId: string | undefined;
|
|
1553
1632
|
}
|
|
1554
1633
|
/**
|
|
1555
1634
|
* @public
|
|
1556
1635
|
*/
|
|
1557
|
-
export interface
|
|
1636
|
+
export interface RegisterDataLakeDelegatedAdministratorResponse {
|
|
1558
1637
|
}
|
|
1559
1638
|
/**
|
|
1560
1639
|
* @public
|
|
1561
1640
|
*/
|
|
1562
1641
|
export interface UpdateSubscriberRequest {
|
|
1563
1642
|
/**
|
|
1564
|
-
* <p>A value created by Security Lake that uniquely identifies your subscription
|
|
1643
|
+
* <p>A value created by Security Lake that uniquely identifies your subscription.</p>
|
|
1565
1644
|
*/
|
|
1566
|
-
|
|
1645
|
+
subscriberId: string | undefined;
|
|
1567
1646
|
/**
|
|
1568
|
-
* <p>The
|
|
1569
|
-
* 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>
|
|
1570
|
-
*/
|
|
1571
|
-
sourceTypes: SourceType[] | undefined;
|
|
1572
|
-
/**
|
|
1573
|
-
* <p>The external ID of the Security Lake account.</p>
|
|
1647
|
+
* <p>The AWS identity used to access your data.</p>
|
|
1574
1648
|
*/
|
|
1575
|
-
|
|
1649
|
+
subscriberIdentity?: AwsIdentity;
|
|
1576
1650
|
/**
|
|
1577
|
-
* <p>The name of the Security Lake account subscriber
|
|
1651
|
+
* <p>The name of the Security Lake account subscriber.</p>
|
|
1578
1652
|
*/
|
|
1579
1653
|
subscriberName?: string;
|
|
1580
1654
|
/**
|
|
1581
1655
|
* <p>The description of the Security Lake account subscriber.</p>
|
|
1582
1656
|
*/
|
|
1583
1657
|
subscriberDescription?: string;
|
|
1658
|
+
/**
|
|
1659
|
+
* <p>The supported Amazon Web Services from which logs and events are collected. For
|
|
1660
|
+
* 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>
|
|
1661
|
+
*/
|
|
1662
|
+
sources?: LogSourceResource[];
|
|
1584
1663
|
}
|
|
1585
1664
|
/**
|
|
1586
1665
|
* @public
|
|
1587
1666
|
*/
|
|
1588
1667
|
export interface UpdateSubscriberResponse {
|
|
1589
1668
|
/**
|
|
1590
|
-
* <p>The
|
|
1669
|
+
* <p>The updated subscriber information.</p>
|
|
1591
1670
|
*/
|
|
1592
1671
|
subscriber?: SubscriberResource;
|
|
1593
1672
|
}
|
|
1594
1673
|
/**
|
|
1595
1674
|
* @public
|
|
1596
1675
|
*/
|
|
1597
|
-
export interface
|
|
1676
|
+
export interface UpdateSubscriberNotificationRequest {
|
|
1598
1677
|
/**
|
|
1599
|
-
* <p>The subscription ID for which the subscription notification is specified
|
|
1678
|
+
* <p>The subscription ID for which the subscription notification is specified.</p>
|
|
1600
1679
|
*/
|
|
1601
|
-
|
|
1680
|
+
subscriberId: string | undefined;
|
|
1602
1681
|
/**
|
|
1603
|
-
* <p>The
|
|
1682
|
+
* <p>The configuration for subscriber notification.</p>
|
|
1604
1683
|
*/
|
|
1605
|
-
|
|
1606
|
-
|
|
1607
|
-
|
|
1608
|
-
|
|
1609
|
-
|
|
1684
|
+
configuration: NotificationConfiguration | undefined;
|
|
1685
|
+
}
|
|
1686
|
+
/**
|
|
1687
|
+
* @public
|
|
1688
|
+
*/
|
|
1689
|
+
export interface UpdateSubscriberNotificationResponse {
|
|
1610
1690
|
/**
|
|
1611
|
-
* <p>The
|
|
1691
|
+
* <p>The subscriber endpoint to which exception messages are posted.</p>
|
|
1612
1692
|
*/
|
|
1613
|
-
|
|
1693
|
+
subscriberEndpoint?: string;
|
|
1694
|
+
}
|
|
1695
|
+
/**
|
|
1696
|
+
* @public
|
|
1697
|
+
*/
|
|
1698
|
+
export interface UpdateDataLakeExceptionSubscriptionRequest {
|
|
1614
1699
|
/**
|
|
1615
|
-
* <p>The
|
|
1700
|
+
* <p>The subscription protocol to which exception messages are posted.</p>
|
|
1616
1701
|
*/
|
|
1617
|
-
|
|
1702
|
+
subscriptionProtocol: string | undefined;
|
|
1618
1703
|
/**
|
|
1619
|
-
* <p>
|
|
1620
|
-
* Amazon Security Lake.</p>
|
|
1704
|
+
* <p>The account that is subscribed to receive exception notifications.</p>
|
|
1621
1705
|
*/
|
|
1622
|
-
|
|
1706
|
+
notificationEndpoint: string | undefined;
|
|
1623
1707
|
/**
|
|
1624
|
-
* <p>The
|
|
1625
|
-
* Guide.</p>
|
|
1708
|
+
* <p>The time-to-live (TTL) for the exception message to remain.</p>
|
|
1626
1709
|
*/
|
|
1627
|
-
|
|
1710
|
+
exceptionTimeToLive?: number;
|
|
1628
1711
|
}
|
|
1629
1712
|
/**
|
|
1630
1713
|
* @public
|
|
1631
1714
|
*/
|
|
1632
|
-
export interface
|
|
1633
|
-
/**
|
|
1634
|
-
* <p>Returns the ARN of the queue.</p>
|
|
1635
|
-
*/
|
|
1636
|
-
queueArn?: string;
|
|
1715
|
+
export interface UpdateDataLakeExceptionSubscriptionResponse {
|
|
1637
1716
|
}
|