aws-sdk-securitylake 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/CHANGELOG.md +8 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-securitylake/client.rb +1681 -0
- data/lib/aws-sdk-securitylake/client_api.rb +1005 -0
- data/lib/aws-sdk-securitylake/customizations.rb +0 -0
- data/lib/aws-sdk-securitylake/endpoint_parameters.rb +69 -0
- data/lib/aws-sdk-securitylake/endpoint_provider.rb +111 -0
- data/lib/aws-sdk-securitylake/endpoints.rb +435 -0
- data/lib/aws-sdk-securitylake/errors.rb +364 -0
- data/lib/aws-sdk-securitylake/plugins/endpoints.rb +128 -0
- data/lib/aws-sdk-securitylake/resource.rb +26 -0
- data/lib/aws-sdk-securitylake/types.rb +2023 -0
- data/lib/aws-sdk-securitylake.rb +57 -0
- metadata +94 -0
@@ -0,0 +1,2023 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# WARNING ABOUT GENERATED CODE
|
4
|
+
#
|
5
|
+
# This file is generated. See the contributing guide for more information:
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
|
+
#
|
8
|
+
# WARNING ABOUT GENERATED CODE
|
9
|
+
|
10
|
+
module Aws::SecurityLake
|
11
|
+
module Types
|
12
|
+
|
13
|
+
# You do not have sufficient access to perform this action. Access
|
14
|
+
# denied errors appear when Amazon Security Lake explicitly or
|
15
|
+
# implicitly denies an authorization request. An explicit denial occurs
|
16
|
+
# when a policy contains a Deny statement for the specific Amazon Web
|
17
|
+
# Services action. An implicit denial occurs when there is no applicable
|
18
|
+
# Deny statement and also no applicable Allow statement.
|
19
|
+
#
|
20
|
+
# @!attribute [rw] message
|
21
|
+
# @return [String]
|
22
|
+
#
|
23
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/AccessDeniedException AWS API Documentation
|
24
|
+
#
|
25
|
+
class AccessDeniedException < Struct.new(
|
26
|
+
:message)
|
27
|
+
SENSITIVE = []
|
28
|
+
include Aws::Structure
|
29
|
+
end
|
30
|
+
|
31
|
+
# Amazon Security Lake can't find an Amazon Web Services account with
|
32
|
+
# the accountID that you specified, or the account whose credentials you
|
33
|
+
# used to make this request isn't a member of an organization.
|
34
|
+
#
|
35
|
+
# @!attribute [rw] message
|
36
|
+
# @return [String]
|
37
|
+
#
|
38
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/AccountNotFoundException AWS API Documentation
|
39
|
+
#
|
40
|
+
class AccountNotFoundException < Struct.new(
|
41
|
+
:message)
|
42
|
+
SENSITIVE = []
|
43
|
+
include Aws::Structure
|
44
|
+
end
|
45
|
+
|
46
|
+
# Security Lake can collect logs and events from supported Amazon Web
|
47
|
+
# Services services and custom sources.
|
48
|
+
#
|
49
|
+
# @!attribute [rw] account
|
50
|
+
# Account ID of the Security Lake account for which logs are
|
51
|
+
# collected.
|
52
|
+
# @return [String]
|
53
|
+
#
|
54
|
+
# @!attribute [rw] event_class
|
55
|
+
# Initializes a new instance of the Event class.
|
56
|
+
# @return [String]
|
57
|
+
#
|
58
|
+
# @!attribute [rw] logs_status
|
59
|
+
# Log status for the Security Lake account.
|
60
|
+
# @return [Array<Types::LogsStatus>]
|
61
|
+
#
|
62
|
+
# @!attribute [rw] source_type
|
63
|
+
# The supported Amazon Web Services services from which logs and
|
64
|
+
# events are collected. Amazon Security Lake supports logs and events
|
65
|
+
# collection for natively-supported Amazon Web Services services. For
|
66
|
+
# more information, see the Amazon Security Lake User Guide.
|
67
|
+
# @return [String]
|
68
|
+
#
|
69
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/AccountSources AWS API Documentation
|
70
|
+
#
|
71
|
+
class AccountSources < Struct.new(
|
72
|
+
:account,
|
73
|
+
:event_class,
|
74
|
+
:logs_status,
|
75
|
+
:source_type)
|
76
|
+
SENSITIVE = []
|
77
|
+
include Aws::Structure
|
78
|
+
end
|
79
|
+
|
80
|
+
# Automatically enable new organization accounts as member accounts from
|
81
|
+
# a Security Lake administrator account.
|
82
|
+
#
|
83
|
+
# @note When making an API call, you may pass AutoEnableNewRegionConfiguration
|
84
|
+
# data as a hash:
|
85
|
+
#
|
86
|
+
# {
|
87
|
+
# region: "us-east-1", # required, accepts us-east-1, us-west-2, eu-central-1, us-east-2, eu-west-1, ap-northeast-1, ap-southeast-2
|
88
|
+
# sources: ["ROUTE53"], # required, accepts ROUTE53, VPC_FLOW, CLOUD_TRAIL, SH_FINDINGS
|
89
|
+
# }
|
90
|
+
#
|
91
|
+
# @!attribute [rw] region
|
92
|
+
# The Regions where Security Lake is auto enabled
|
93
|
+
# @return [String]
|
94
|
+
#
|
95
|
+
# @!attribute [rw] sources
|
96
|
+
# The Amazon Web Services sources which are auto enabled in Security
|
97
|
+
# Lake.
|
98
|
+
# @return [Array<String>]
|
99
|
+
#
|
100
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/AutoEnableNewRegionConfiguration AWS API Documentation
|
101
|
+
#
|
102
|
+
class AutoEnableNewRegionConfiguration < Struct.new(
|
103
|
+
:region,
|
104
|
+
:sources)
|
105
|
+
SENSITIVE = []
|
106
|
+
include Aws::Structure
|
107
|
+
end
|
108
|
+
|
109
|
+
# Amazon Security Lake generally returns 404 errors if the requested
|
110
|
+
# object is missing from the bucket.
|
111
|
+
#
|
112
|
+
# @!attribute [rw] message
|
113
|
+
# @return [String]
|
114
|
+
#
|
115
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/BucketNotFoundException AWS API Documentation
|
116
|
+
#
|
117
|
+
class BucketNotFoundException < Struct.new(
|
118
|
+
:message)
|
119
|
+
SENSITIVE = []
|
120
|
+
include Aws::Structure
|
121
|
+
end
|
122
|
+
|
123
|
+
# More than one process tried to modify a resource at the same time.
|
124
|
+
#
|
125
|
+
# @!attribute [rw] message
|
126
|
+
# @return [String]
|
127
|
+
#
|
128
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/ConcurrentModificationException AWS API Documentation
|
129
|
+
#
|
130
|
+
class ConcurrentModificationException < Struct.new(
|
131
|
+
:message)
|
132
|
+
SENSITIVE = []
|
133
|
+
include Aws::Structure
|
134
|
+
end
|
135
|
+
|
136
|
+
# Occurs when a conflict with a previous successful write is detected.
|
137
|
+
# This generally occurs when the previous write did not have time to
|
138
|
+
# propagate to the host serving the current request. A retry (with
|
139
|
+
# appropriate backoff logic) is the recommended response to this
|
140
|
+
# exception.
|
141
|
+
#
|
142
|
+
# @!attribute [rw] message
|
143
|
+
# @return [String]
|
144
|
+
#
|
145
|
+
# @!attribute [rw] resource_id
|
146
|
+
# A conflict occurred when prompting for the Resource ID.
|
147
|
+
# @return [String]
|
148
|
+
#
|
149
|
+
# @!attribute [rw] resource_type
|
150
|
+
# The resource type.
|
151
|
+
# @return [String]
|
152
|
+
#
|
153
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/ConflictException AWS API Documentation
|
154
|
+
#
|
155
|
+
class ConflictException < Struct.new(
|
156
|
+
:message,
|
157
|
+
:resource_id,
|
158
|
+
:resource_type)
|
159
|
+
SENSITIVE = []
|
160
|
+
include Aws::Structure
|
161
|
+
end
|
162
|
+
|
163
|
+
# There was a conflict when you attempted to modify a Security Lake
|
164
|
+
# source name.
|
165
|
+
#
|
166
|
+
# @!attribute [rw] message
|
167
|
+
# @return [String]
|
168
|
+
#
|
169
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/ConflictSourceNamesException AWS API Documentation
|
170
|
+
#
|
171
|
+
class ConflictSourceNamesException < Struct.new(
|
172
|
+
:message)
|
173
|
+
SENSITIVE = []
|
174
|
+
include Aws::Structure
|
175
|
+
end
|
176
|
+
|
177
|
+
# A conflicting subscription exception operation is in progress.
|
178
|
+
#
|
179
|
+
# @!attribute [rw] message
|
180
|
+
# @return [String]
|
181
|
+
#
|
182
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/ConflictSubscriptionException AWS API Documentation
|
183
|
+
#
|
184
|
+
class ConflictSubscriptionException < Struct.new(
|
185
|
+
:message)
|
186
|
+
SENSITIVE = []
|
187
|
+
include Aws::Structure
|
188
|
+
end
|
189
|
+
|
190
|
+
# @note When making an API call, you may pass CreateAwsLogSourceRequest
|
191
|
+
# data as a hash:
|
192
|
+
#
|
193
|
+
# {
|
194
|
+
# enable_all_dimensions: {
|
195
|
+
# "String" => {
|
196
|
+
# "String" => ["String"],
|
197
|
+
# },
|
198
|
+
# },
|
199
|
+
# enable_single_dimension: ["SafeString"],
|
200
|
+
# enable_two_dimensions: {
|
201
|
+
# "String" => ["String"],
|
202
|
+
# },
|
203
|
+
# input_order: ["REGION"], # required, accepts REGION, SOURCE_TYPE, MEMBER
|
204
|
+
# }
|
205
|
+
#
|
206
|
+
# @!attribute [rw] enable_all_dimensions
|
207
|
+
# Enables specific sources in all Regions and source types.
|
208
|
+
# @return [Hash<String,Hash<String,Array<String>>>]
|
209
|
+
#
|
210
|
+
# @!attribute [rw] enable_single_dimension
|
211
|
+
# Enables all sources in specific accounts or Regions.
|
212
|
+
# @return [Array<String>]
|
213
|
+
#
|
214
|
+
# @!attribute [rw] enable_two_dimensions
|
215
|
+
# Enables specific service sources in specific accounts or Regions.
|
216
|
+
# @return [Hash<String,Array<String>>]
|
217
|
+
#
|
218
|
+
# @!attribute [rw] input_order
|
219
|
+
# Specifies the input order to enable dimensions in Security Lake,
|
220
|
+
# namely region, source type, and member account.
|
221
|
+
# @return [Array<String>]
|
222
|
+
#
|
223
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/CreateAwsLogSourceRequest AWS API Documentation
|
224
|
+
#
|
225
|
+
class CreateAwsLogSourceRequest < Struct.new(
|
226
|
+
:enable_all_dimensions,
|
227
|
+
:enable_single_dimension,
|
228
|
+
:enable_two_dimensions,
|
229
|
+
:input_order)
|
230
|
+
SENSITIVE = []
|
231
|
+
include Aws::Structure
|
232
|
+
end
|
233
|
+
|
234
|
+
# @!attribute [rw] failed
|
235
|
+
# List of all accounts in which enabling a natively-supported Amazon
|
236
|
+
# Web Services service as a Security Lake failed. The failure occurred
|
237
|
+
# as these accounts are not part of an organization.
|
238
|
+
# @return [Array<String>]
|
239
|
+
#
|
240
|
+
# @!attribute [rw] processing
|
241
|
+
# List of all accounts which are in the process of enabling a
|
242
|
+
# natively-supported Amazon Web Services service as a Security Lake.
|
243
|
+
# @return [Array<String>]
|
244
|
+
#
|
245
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/CreateAwsLogSourceResponse AWS API Documentation
|
246
|
+
#
|
247
|
+
class CreateAwsLogSourceResponse < Struct.new(
|
248
|
+
:failed,
|
249
|
+
:processing)
|
250
|
+
SENSITIVE = []
|
251
|
+
include Aws::Structure
|
252
|
+
end
|
253
|
+
|
254
|
+
# @note When making an API call, you may pass CreateCustomLogSourceRequest
|
255
|
+
# data as a hash:
|
256
|
+
#
|
257
|
+
# {
|
258
|
+
# custom_source_name: "CustomSourceType", # required
|
259
|
+
# event_class: "ACCESS_ACTIVITY", # required, accepts ACCESS_ACTIVITY, FILE_ACTIVITY, KERNEL_ACTIVITY, KERNEL_EXTENSION, MEMORY_ACTIVITY, MODULE_ACTIVITY, PROCESS_ACTIVITY, REGISTRY_KEY_ACTIVITY, REGISTRY_VALUE_ACTIVITY, RESOURCE_ACTIVITY, SCHEDULED_JOB_ACTIVITY, SECURITY_FINDING, ACCOUNT_CHANGE, AUTHENTICATION, AUTHORIZATION, ENTITY_MANAGEMENT_AUDIT, DHCP_ACTIVITY, NETWORK_ACTIVITY, DNS_ACTIVITY, FTP_ACTIVITY, HTTP_ACTIVITY, RDP_ACTIVITY, SMB_ACTIVITY, SSH_ACTIVITY, CLOUD_API, CONTAINER_LIFECYCLE, DATABASE_LIFECYCLE, CONFIG_STATE, CLOUD_STORAGE, INVENTORY_INFO, RFB_ACTIVITY, SMTP_ACTIVITY, VIRTUAL_MACHINE_ACTIVITY
|
260
|
+
# glue_invocation_role_arn: "RoleArn", # required
|
261
|
+
# log_provider_account_id: "AwsAccountId", # required
|
262
|
+
# }
|
263
|
+
#
|
264
|
+
# @!attribute [rw] custom_source_name
|
265
|
+
# The custom source name for a third-party custom source.
|
266
|
+
# @return [String]
|
267
|
+
#
|
268
|
+
# @!attribute [rw] event_class
|
269
|
+
# The Open Cybersecurity Schema Framework (OCSF) event class.
|
270
|
+
# @return [String]
|
271
|
+
#
|
272
|
+
# @!attribute [rw] glue_invocation_role_arn
|
273
|
+
# The IAM Role ARN to be used by the Glue Crawler. The recommended IAM
|
274
|
+
# policies are:
|
275
|
+
#
|
276
|
+
# * The managed policy `AWSGlueServiceRole`
|
277
|
+
#
|
278
|
+
# * A custom policy granting access to your S3 Data Lake
|
279
|
+
# @return [String]
|
280
|
+
#
|
281
|
+
# @!attribute [rw] log_provider_account_id
|
282
|
+
# The Account ID that will assume the above Role to put logs into the
|
283
|
+
# Data Lake.
|
284
|
+
# @return [String]
|
285
|
+
#
|
286
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/CreateCustomLogSourceRequest AWS API Documentation
|
287
|
+
#
|
288
|
+
class CreateCustomLogSourceRequest < Struct.new(
|
289
|
+
:custom_source_name,
|
290
|
+
:event_class,
|
291
|
+
:glue_invocation_role_arn,
|
292
|
+
:log_provider_account_id)
|
293
|
+
SENSITIVE = []
|
294
|
+
include Aws::Structure
|
295
|
+
end
|
296
|
+
|
297
|
+
# @!attribute [rw] custom_data_location
|
298
|
+
# The location of the partition in the Security Lake S3 bucket.
|
299
|
+
# @return [String]
|
300
|
+
#
|
301
|
+
# @!attribute [rw] glue_crawler_name
|
302
|
+
# The name of the Glue crawler.
|
303
|
+
# @return [String]
|
304
|
+
#
|
305
|
+
# @!attribute [rw] glue_database_name
|
306
|
+
# The Glue database where results are written, such as:
|
307
|
+
# `arn:aws:daylight:us-east-1::database/sometable/*`.
|
308
|
+
# @return [String]
|
309
|
+
#
|
310
|
+
# @!attribute [rw] glue_table_name
|
311
|
+
# The table name of the Glue crawler.
|
312
|
+
# @return [String]
|
313
|
+
#
|
314
|
+
# @!attribute [rw] log_provider_access_role_arn
|
315
|
+
# IAM Role ARN to be used by the entity putting logs into your Custom
|
316
|
+
# Source partition. Security Lake will apply the correct access
|
317
|
+
# policies to this Role, but this Role must have the trust policy
|
318
|
+
# created manually. This Role's name must start with the text
|
319
|
+
# 'Security Lake'. It must trust the `logProviderAccountId` to
|
320
|
+
# assume it.
|
321
|
+
# @return [String]
|
322
|
+
#
|
323
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/CreateCustomLogSourceResponse AWS API Documentation
|
324
|
+
#
|
325
|
+
class CreateCustomLogSourceResponse < Struct.new(
|
326
|
+
:custom_data_location,
|
327
|
+
:glue_crawler_name,
|
328
|
+
:glue_database_name,
|
329
|
+
:glue_table_name,
|
330
|
+
:log_provider_access_role_arn)
|
331
|
+
SENSITIVE = []
|
332
|
+
include Aws::Structure
|
333
|
+
end
|
334
|
+
|
335
|
+
# @note When making an API call, you may pass CreateDatalakeAutoEnableRequest
|
336
|
+
# data as a hash:
|
337
|
+
#
|
338
|
+
# {
|
339
|
+
# configuration_for_new_accounts: [ # required
|
340
|
+
# {
|
341
|
+
# region: "us-east-1", # required, accepts us-east-1, us-west-2, eu-central-1, us-east-2, eu-west-1, ap-northeast-1, ap-southeast-2
|
342
|
+
# sources: ["ROUTE53"], # required, accepts ROUTE53, VPC_FLOW, CLOUD_TRAIL, SH_FINDINGS
|
343
|
+
# },
|
344
|
+
# ],
|
345
|
+
# }
|
346
|
+
#
|
347
|
+
# @!attribute [rw] configuration_for_new_accounts
|
348
|
+
# Enable Amazon Security Lake with the specified configurations
|
349
|
+
# settings to begin ingesting security data for new accounts in
|
350
|
+
# Security Lake.
|
351
|
+
# @return [Array<Types::AutoEnableNewRegionConfiguration>]
|
352
|
+
#
|
353
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/CreateDatalakeAutoEnableRequest AWS API Documentation
|
354
|
+
#
|
355
|
+
class CreateDatalakeAutoEnableRequest < Struct.new(
|
356
|
+
:configuration_for_new_accounts)
|
357
|
+
SENSITIVE = []
|
358
|
+
include Aws::Structure
|
359
|
+
end
|
360
|
+
|
361
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/CreateDatalakeAutoEnableResponse AWS API Documentation
|
362
|
+
#
|
363
|
+
class CreateDatalakeAutoEnableResponse < Aws::EmptyStructure; end
|
364
|
+
|
365
|
+
# @note When making an API call, you may pass CreateDatalakeDelegatedAdminRequest
|
366
|
+
# data as a hash:
|
367
|
+
#
|
368
|
+
# {
|
369
|
+
# account: "SafeString", # required
|
370
|
+
# }
|
371
|
+
#
|
372
|
+
# @!attribute [rw] account
|
373
|
+
# Account ID of the Security Lake delegated administrator.
|
374
|
+
# @return [String]
|
375
|
+
#
|
376
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/CreateDatalakeDelegatedAdminRequest AWS API Documentation
|
377
|
+
#
|
378
|
+
class CreateDatalakeDelegatedAdminRequest < Struct.new(
|
379
|
+
:account)
|
380
|
+
SENSITIVE = []
|
381
|
+
include Aws::Structure
|
382
|
+
end
|
383
|
+
|
384
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/CreateDatalakeDelegatedAdminResponse AWS API Documentation
|
385
|
+
#
|
386
|
+
class CreateDatalakeDelegatedAdminResponse < Aws::EmptyStructure; end
|
387
|
+
|
388
|
+
# @note When making an API call, you may pass CreateDatalakeExceptionsSubscriptionRequest
|
389
|
+
# data as a hash:
|
390
|
+
#
|
391
|
+
# {
|
392
|
+
# notification_endpoint: "SafeString", # required
|
393
|
+
# subscription_protocol: "HTTP", # required, accepts HTTP, HTTPS, EMAIL, EMAIL_JSON, SMS, SQS, LAMBDA, APP, FIREHOSE
|
394
|
+
# }
|
395
|
+
#
|
396
|
+
# @!attribute [rw] notification_endpoint
|
397
|
+
# The account in which the exception notifications subscription is
|
398
|
+
# created.
|
399
|
+
# @return [String]
|
400
|
+
#
|
401
|
+
# @!attribute [rw] subscription_protocol
|
402
|
+
# The subscription protocol to which exception messages are posted.
|
403
|
+
# @return [String]
|
404
|
+
#
|
405
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/CreateDatalakeExceptionsSubscriptionRequest AWS API Documentation
|
406
|
+
#
|
407
|
+
class CreateDatalakeExceptionsSubscriptionRequest < Struct.new(
|
408
|
+
:notification_endpoint,
|
409
|
+
:subscription_protocol)
|
410
|
+
SENSITIVE = []
|
411
|
+
include Aws::Structure
|
412
|
+
end
|
413
|
+
|
414
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/CreateDatalakeExceptionsSubscriptionResponse AWS API Documentation
|
415
|
+
#
|
416
|
+
class CreateDatalakeExceptionsSubscriptionResponse < Aws::EmptyStructure; end
|
417
|
+
|
418
|
+
# @note When making an API call, you may pass CreateDatalakeRequest
|
419
|
+
# data as a hash:
|
420
|
+
#
|
421
|
+
# {
|
422
|
+
# configurations: {
|
423
|
+
# "us-east-1" => {
|
424
|
+
# encryption_key: "String",
|
425
|
+
# replication_destination_regions: ["us-east-1"], # accepts us-east-1, us-west-2, eu-central-1, us-east-2, eu-west-1, ap-northeast-1, ap-southeast-2
|
426
|
+
# replication_role_arn: "RoleArn",
|
427
|
+
# retention_settings: [
|
428
|
+
# {
|
429
|
+
# retention_period: 1,
|
430
|
+
# storage_class: "STANDARD_IA", # accepts STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER_IR, GLACIER, DEEP_ARCHIVE, EXPIRE
|
431
|
+
# },
|
432
|
+
# ],
|
433
|
+
# tags_map: {
|
434
|
+
# "String" => "String",
|
435
|
+
# },
|
436
|
+
# },
|
437
|
+
# },
|
438
|
+
# enable_all: false,
|
439
|
+
# meta_store_manager_role_arn: "RoleArn",
|
440
|
+
# regions: ["us-east-1"], # accepts us-east-1, us-west-2, eu-central-1, us-east-2, eu-west-1, ap-northeast-1, ap-southeast-2
|
441
|
+
# }
|
442
|
+
#
|
443
|
+
# @!attribute [rw] configurations
|
444
|
+
# Enable Security Lake with the specified configurations settings to
|
445
|
+
# begin ingesting security data.
|
446
|
+
# @return [Hash<String,Types::LakeConfigurationRequest>]
|
447
|
+
#
|
448
|
+
# @!attribute [rw] enable_all
|
449
|
+
# Enable Security Lake in all Regions to begin ingesting security
|
450
|
+
# data.
|
451
|
+
# @return [Boolean]
|
452
|
+
#
|
453
|
+
# @!attribute [rw] meta_store_manager_role_arn
|
454
|
+
# The Role ARN used to create and update the Glue table with
|
455
|
+
# partitions generated by ingestion and normalization of Amazon Web
|
456
|
+
# Services log sources and custom sources.
|
457
|
+
# @return [String]
|
458
|
+
#
|
459
|
+
# @!attribute [rw] regions
|
460
|
+
# Enable Security Lake in the specified Regions to begin ingesting
|
461
|
+
# security data. To enable Security Lake in specific Amazon Web
|
462
|
+
# Services Regions, such as us-east-1 or ap-northeast-3, provide the
|
463
|
+
# Region codes. For a list of Region codes, see [Region codes][1] in
|
464
|
+
# the Amazon Web Services General Reference.
|
465
|
+
#
|
466
|
+
#
|
467
|
+
#
|
468
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints
|
469
|
+
# @return [Array<String>]
|
470
|
+
#
|
471
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/CreateDatalakeRequest AWS API Documentation
|
472
|
+
#
|
473
|
+
class CreateDatalakeRequest < Struct.new(
|
474
|
+
:configurations,
|
475
|
+
:enable_all,
|
476
|
+
:meta_store_manager_role_arn,
|
477
|
+
:regions)
|
478
|
+
SENSITIVE = []
|
479
|
+
include Aws::Structure
|
480
|
+
end
|
481
|
+
|
482
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/CreateDatalakeResponse AWS API Documentation
|
483
|
+
#
|
484
|
+
class CreateDatalakeResponse < Aws::EmptyStructure; end
|
485
|
+
|
486
|
+
# @note When making an API call, you may pass CreateSubscriberRequest
|
487
|
+
# data as a hash:
|
488
|
+
#
|
489
|
+
# {
|
490
|
+
# access_types: ["LAKEFORMATION"], # accepts LAKEFORMATION, S3
|
491
|
+
# account_id: "AwsAccountId", # required
|
492
|
+
# external_id: "SafeString", # required
|
493
|
+
# source_types: [ # required
|
494
|
+
# {
|
495
|
+
# aws_source_type: "ROUTE53", # accepts ROUTE53, VPC_FLOW, CLOUD_TRAIL, SH_FINDINGS
|
496
|
+
# custom_source_type: "CustomSourceType",
|
497
|
+
# },
|
498
|
+
# ],
|
499
|
+
# subscriber_description: "SafeString",
|
500
|
+
# subscriber_name: "CreateSubscriberRequestSubscriberNameString", # required
|
501
|
+
# }
|
502
|
+
#
|
503
|
+
# @!attribute [rw] access_types
|
504
|
+
# The Amazon S3 or Lake Formation access type.
|
505
|
+
# @return [Array<String>]
|
506
|
+
#
|
507
|
+
# @!attribute [rw] account_id
|
508
|
+
# The third party Amazon Web Services account ID used to access your
|
509
|
+
# data.
|
510
|
+
# @return [String]
|
511
|
+
#
|
512
|
+
# @!attribute [rw] external_id
|
513
|
+
# The external ID of the subscriber. External ID allows the user that
|
514
|
+
# is assuming the role to assert the circumstances in which they are
|
515
|
+
# operating. It also provides a way for the account owner to permit
|
516
|
+
# the role to be assumed only under specific circumstances.
|
517
|
+
# @return [String]
|
518
|
+
#
|
519
|
+
# @!attribute [rw] source_types
|
520
|
+
# The supported Amazon Web Services services from which logs and
|
521
|
+
# events are collected. Amazon Security Lake supports logs and events
|
522
|
+
# collection for natively-supported Amazon Web Services services.
|
523
|
+
# @return [Array<Types::SourceType>]
|
524
|
+
#
|
525
|
+
# @!attribute [rw] subscriber_description
|
526
|
+
# The subscriber descriptions for the subscriber account in Amazon
|
527
|
+
# Security Lake.
|
528
|
+
# @return [String]
|
529
|
+
#
|
530
|
+
# @!attribute [rw] subscriber_name
|
531
|
+
# The name of your Amazon Security Lake subscriber account.
|
532
|
+
# @return [String]
|
533
|
+
#
|
534
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/CreateSubscriberRequest AWS API Documentation
|
535
|
+
#
|
536
|
+
class CreateSubscriberRequest < Struct.new(
|
537
|
+
:access_types,
|
538
|
+
:account_id,
|
539
|
+
:external_id,
|
540
|
+
:source_types,
|
541
|
+
:subscriber_description,
|
542
|
+
:subscriber_name)
|
543
|
+
SENSITIVE = []
|
544
|
+
include Aws::Structure
|
545
|
+
end
|
546
|
+
|
547
|
+
# @!attribute [rw] role_arn
|
548
|
+
# The Amazon Resource Name (ARN) created by the user to provide to the
|
549
|
+
# subscriber. For more information about ARNs and how to use them in
|
550
|
+
# policies, see IAM identifiers in the IAM User Guide.
|
551
|
+
# @return [String]
|
552
|
+
#
|
553
|
+
# @!attribute [rw] s3_bucket_arn
|
554
|
+
# The Amazon Resource Name (ARN) for the Amazon S3 bucket.
|
555
|
+
# @return [String]
|
556
|
+
#
|
557
|
+
# @!attribute [rw] sns_arn
|
558
|
+
# The Amazon Resource Name (ARN) for the Amazon Simple Notification
|
559
|
+
# Service.
|
560
|
+
# @return [String]
|
561
|
+
#
|
562
|
+
# @!attribute [rw] subscription_id
|
563
|
+
# The `subscriptionId` that was created by the `CreateSubscriber` API
|
564
|
+
# call.
|
565
|
+
# @return [String]
|
566
|
+
#
|
567
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/CreateSubscriberResponse AWS API Documentation
|
568
|
+
#
|
569
|
+
class CreateSubscriberResponse < Struct.new(
|
570
|
+
:role_arn,
|
571
|
+
:s3_bucket_arn,
|
572
|
+
:sns_arn,
|
573
|
+
:subscription_id)
|
574
|
+
SENSITIVE = []
|
575
|
+
include Aws::Structure
|
576
|
+
end
|
577
|
+
|
578
|
+
# @note When making an API call, you may pass CreateSubscriptionNotificationConfigurationRequest
|
579
|
+
# data as a hash:
|
580
|
+
#
|
581
|
+
# {
|
582
|
+
# create_sqs: false,
|
583
|
+
# https_api_key_name: "String",
|
584
|
+
# https_api_key_value: "String",
|
585
|
+
# https_method: "POST", # accepts POST, PUT
|
586
|
+
# role_arn: "RoleArn",
|
587
|
+
# subscription_endpoint: "CreateSubscriptionNotificationConfigurationRequestSubscriptionEndpointString",
|
588
|
+
# subscription_id: "UUID", # required
|
589
|
+
# }
|
590
|
+
#
|
591
|
+
# @!attribute [rw] create_sqs
|
592
|
+
# Create a new subscription notification for the specified
|
593
|
+
# subscription ID in Security Lake.
|
594
|
+
# @return [Boolean]
|
595
|
+
#
|
596
|
+
# @!attribute [rw] https_api_key_name
|
597
|
+
# The key name for the subscription notification.
|
598
|
+
# @return [String]
|
599
|
+
#
|
600
|
+
# @!attribute [rw] https_api_key_value
|
601
|
+
# The key value for the subscription notification.
|
602
|
+
# @return [String]
|
603
|
+
#
|
604
|
+
# @!attribute [rw] https_method
|
605
|
+
# The HTTPS method used for the subscription notification.
|
606
|
+
# @return [String]
|
607
|
+
#
|
608
|
+
# @!attribute [rw] role_arn
|
609
|
+
# The Amazon Resource Name (ARN) specifying the role of the
|
610
|
+
# subscriber.
|
611
|
+
# @return [String]
|
612
|
+
#
|
613
|
+
# @!attribute [rw] subscription_endpoint
|
614
|
+
# The subscription endpoint in Security Lake.
|
615
|
+
# @return [String]
|
616
|
+
#
|
617
|
+
# @!attribute [rw] subscription_id
|
618
|
+
# The subscription ID for which the subscription notification is
|
619
|
+
# specified.
|
620
|
+
# @return [String]
|
621
|
+
#
|
622
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/CreateSubscriptionNotificationConfigurationRequest AWS API Documentation
|
623
|
+
#
|
624
|
+
class CreateSubscriptionNotificationConfigurationRequest < Struct.new(
|
625
|
+
:create_sqs,
|
626
|
+
:https_api_key_name,
|
627
|
+
:https_api_key_value,
|
628
|
+
:https_method,
|
629
|
+
:role_arn,
|
630
|
+
:subscription_endpoint,
|
631
|
+
:subscription_id)
|
632
|
+
SENSITIVE = []
|
633
|
+
include Aws::Structure
|
634
|
+
end
|
635
|
+
|
636
|
+
# @!attribute [rw] queue_arn
|
637
|
+
# Returns the Amazon resource name (ARN) of the queue.
|
638
|
+
# @return [String]
|
639
|
+
#
|
640
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/CreateSubscriptionNotificationConfigurationResponse AWS API Documentation
|
641
|
+
#
|
642
|
+
class CreateSubscriptionNotificationConfigurationResponse < Struct.new(
|
643
|
+
:queue_arn)
|
644
|
+
SENSITIVE = []
|
645
|
+
include Aws::Structure
|
646
|
+
end
|
647
|
+
|
648
|
+
# @note When making an API call, you may pass DeleteAwsLogSourceRequest
|
649
|
+
# data as a hash:
|
650
|
+
#
|
651
|
+
# {
|
652
|
+
# disable_all_dimensions: {
|
653
|
+
# "String" => {
|
654
|
+
# "String" => ["String"],
|
655
|
+
# },
|
656
|
+
# },
|
657
|
+
# disable_single_dimension: ["SafeString"],
|
658
|
+
# disable_two_dimensions: {
|
659
|
+
# "String" => ["String"],
|
660
|
+
# },
|
661
|
+
# input_order: ["REGION"], # required, accepts REGION, SOURCE_TYPE, MEMBER
|
662
|
+
# }
|
663
|
+
#
|
664
|
+
# @!attribute [rw] disable_all_dimensions
|
665
|
+
# Removes the specific Amazon Web Services sources from all Regions
|
666
|
+
# and source types.
|
667
|
+
# @return [Hash<String,Hash<String,Array<String>>>]
|
668
|
+
#
|
669
|
+
# @!attribute [rw] disable_single_dimension
|
670
|
+
# Removes all Amazon Web Services sources from specific accounts or
|
671
|
+
# Regions.
|
672
|
+
# @return [Array<String>]
|
673
|
+
#
|
674
|
+
# @!attribute [rw] disable_two_dimensions
|
675
|
+
# Remove a specific Amazon Web Services source from specific accounts
|
676
|
+
# or Regions.
|
677
|
+
# @return [Hash<String,Array<String>>]
|
678
|
+
#
|
679
|
+
# @!attribute [rw] input_order
|
680
|
+
# This is a mandatory input. Specifies the input order to disable
|
681
|
+
# dimensions in Security Lake, namely Region, source type, and member.
|
682
|
+
# @return [Array<String>]
|
683
|
+
#
|
684
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/DeleteAwsLogSourceRequest AWS API Documentation
|
685
|
+
#
|
686
|
+
class DeleteAwsLogSourceRequest < Struct.new(
|
687
|
+
:disable_all_dimensions,
|
688
|
+
:disable_single_dimension,
|
689
|
+
:disable_two_dimensions,
|
690
|
+
:input_order)
|
691
|
+
SENSITIVE = []
|
692
|
+
include Aws::Structure
|
693
|
+
end
|
694
|
+
|
695
|
+
# @!attribute [rw] failed
|
696
|
+
# Deletion of the Amazon Web Services sources failed as the account is
|
697
|
+
# not a part of the organization.
|
698
|
+
# @return [Array<String>]
|
699
|
+
#
|
700
|
+
# @!attribute [rw] processing
|
701
|
+
# Deletion of the Amazon Web Services sources is in-progress.
|
702
|
+
# @return [Array<String>]
|
703
|
+
#
|
704
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/DeleteAwsLogSourceResponse AWS API Documentation
|
705
|
+
#
|
706
|
+
class DeleteAwsLogSourceResponse < Struct.new(
|
707
|
+
:failed,
|
708
|
+
:processing)
|
709
|
+
SENSITIVE = []
|
710
|
+
include Aws::Structure
|
711
|
+
end
|
712
|
+
|
713
|
+
# @note When making an API call, you may pass DeleteCustomLogSourceRequest
|
714
|
+
# data as a hash:
|
715
|
+
#
|
716
|
+
# {
|
717
|
+
# custom_source_name: "String", # required
|
718
|
+
# }
|
719
|
+
#
|
720
|
+
# @!attribute [rw] custom_source_name
|
721
|
+
# The custom source name for the custome log source.
|
722
|
+
# @return [String]
|
723
|
+
#
|
724
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/DeleteCustomLogSourceRequest AWS API Documentation
|
725
|
+
#
|
726
|
+
class DeleteCustomLogSourceRequest < Struct.new(
|
727
|
+
:custom_source_name)
|
728
|
+
SENSITIVE = []
|
729
|
+
include Aws::Structure
|
730
|
+
end
|
731
|
+
|
732
|
+
# @!attribute [rw] custom_data_location
|
733
|
+
# The location of the partition in the Security Lake S3 bucket.
|
734
|
+
# @return [String]
|
735
|
+
#
|
736
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/DeleteCustomLogSourceResponse AWS API Documentation
|
737
|
+
#
|
738
|
+
class DeleteCustomLogSourceResponse < Struct.new(
|
739
|
+
:custom_data_location)
|
740
|
+
SENSITIVE = []
|
741
|
+
include Aws::Structure
|
742
|
+
end
|
743
|
+
|
744
|
+
# @note When making an API call, you may pass DeleteDatalakeAutoEnableRequest
|
745
|
+
# data as a hash:
|
746
|
+
#
|
747
|
+
# {
|
748
|
+
# remove_from_configuration_for_new_accounts: [ # required
|
749
|
+
# {
|
750
|
+
# region: "us-east-1", # required, accepts us-east-1, us-west-2, eu-central-1, us-east-2, eu-west-1, ap-northeast-1, ap-southeast-2
|
751
|
+
# sources: ["ROUTE53"], # required, accepts ROUTE53, VPC_FLOW, CLOUD_TRAIL, SH_FINDINGS
|
752
|
+
# },
|
753
|
+
# ],
|
754
|
+
# }
|
755
|
+
#
|
756
|
+
# @!attribute [rw] remove_from_configuration_for_new_accounts
|
757
|
+
# Delete Amazon Security Lake with the specified configurations
|
758
|
+
# settings to stop ingesting security data for new accounts in
|
759
|
+
# Security Lake.
|
760
|
+
# @return [Array<Types::AutoEnableNewRegionConfiguration>]
|
761
|
+
#
|
762
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/DeleteDatalakeAutoEnableRequest AWS API Documentation
|
763
|
+
#
|
764
|
+
class DeleteDatalakeAutoEnableRequest < Struct.new(
|
765
|
+
:remove_from_configuration_for_new_accounts)
|
766
|
+
SENSITIVE = []
|
767
|
+
include Aws::Structure
|
768
|
+
end
|
769
|
+
|
770
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/DeleteDatalakeAutoEnableResponse AWS API Documentation
|
771
|
+
#
|
772
|
+
class DeleteDatalakeAutoEnableResponse < Aws::EmptyStructure; end
|
773
|
+
|
774
|
+
# @note When making an API call, you may pass DeleteDatalakeDelegatedAdminRequest
|
775
|
+
# data as a hash:
|
776
|
+
#
|
777
|
+
# {
|
778
|
+
# account: "SafeString", # required
|
779
|
+
# }
|
780
|
+
#
|
781
|
+
# @!attribute [rw] account
|
782
|
+
# Account ID the Security Lake delegated administrator.
|
783
|
+
# @return [String]
|
784
|
+
#
|
785
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/DeleteDatalakeDelegatedAdminRequest AWS API Documentation
|
786
|
+
#
|
787
|
+
class DeleteDatalakeDelegatedAdminRequest < Struct.new(
|
788
|
+
:account)
|
789
|
+
SENSITIVE = []
|
790
|
+
include Aws::Structure
|
791
|
+
end
|
792
|
+
|
793
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/DeleteDatalakeDelegatedAdminResponse AWS API Documentation
|
794
|
+
#
|
795
|
+
class DeleteDatalakeDelegatedAdminResponse < Aws::EmptyStructure; end
|
796
|
+
|
797
|
+
# @api private
|
798
|
+
#
|
799
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/DeleteDatalakeExceptionsSubscriptionRequest AWS API Documentation
|
800
|
+
#
|
801
|
+
class DeleteDatalakeExceptionsSubscriptionRequest < Aws::EmptyStructure; end
|
802
|
+
|
803
|
+
# @!attribute [rw] status
|
804
|
+
# Retrieves the status of the delete Security Lake operation for an
|
805
|
+
# account.
|
806
|
+
# @return [String]
|
807
|
+
#
|
808
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/DeleteDatalakeExceptionsSubscriptionResponse AWS API Documentation
|
809
|
+
#
|
810
|
+
class DeleteDatalakeExceptionsSubscriptionResponse < Struct.new(
|
811
|
+
:status)
|
812
|
+
SENSITIVE = []
|
813
|
+
include Aws::Structure
|
814
|
+
end
|
815
|
+
|
816
|
+
# @api private
|
817
|
+
#
|
818
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/DeleteDatalakeRequest AWS API Documentation
|
819
|
+
#
|
820
|
+
class DeleteDatalakeRequest < Aws::EmptyStructure; end
|
821
|
+
|
822
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/DeleteDatalakeResponse AWS API Documentation
|
823
|
+
#
|
824
|
+
class DeleteDatalakeResponse < Aws::EmptyStructure; end
|
825
|
+
|
826
|
+
# @note When making an API call, you may pass DeleteSubscriberRequest
|
827
|
+
# data as a hash:
|
828
|
+
#
|
829
|
+
# {
|
830
|
+
# id: "String", # required
|
831
|
+
# }
|
832
|
+
#
|
833
|
+
# @!attribute [rw] id
|
834
|
+
# A value created by Security Lake that uniquely identifies your
|
835
|
+
# `DeleteSubscriber` API request.
|
836
|
+
# @return [String]
|
837
|
+
#
|
838
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/DeleteSubscriberRequest AWS API Documentation
|
839
|
+
#
|
840
|
+
class DeleteSubscriberRequest < Struct.new(
|
841
|
+
:id)
|
842
|
+
SENSITIVE = []
|
843
|
+
include Aws::Structure
|
844
|
+
end
|
845
|
+
|
846
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/DeleteSubscriberResponse AWS API Documentation
|
847
|
+
#
|
848
|
+
class DeleteSubscriberResponse < Aws::EmptyStructure; end
|
849
|
+
|
850
|
+
# @note When making an API call, you may pass DeleteSubscriptionNotificationConfigurationRequest
|
851
|
+
# data as a hash:
|
852
|
+
#
|
853
|
+
# {
|
854
|
+
# subscription_id: "UUID", # required
|
855
|
+
# }
|
856
|
+
#
|
857
|
+
# @!attribute [rw] subscription_id
|
858
|
+
# The subscription ID of the Amazon Security Lake subscriber account.
|
859
|
+
# @return [String]
|
860
|
+
#
|
861
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/DeleteSubscriptionNotificationConfigurationRequest AWS API Documentation
|
862
|
+
#
|
863
|
+
class DeleteSubscriptionNotificationConfigurationRequest < Struct.new(
|
864
|
+
:subscription_id)
|
865
|
+
SENSITIVE = []
|
866
|
+
include Aws::Structure
|
867
|
+
end
|
868
|
+
|
869
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/DeleteSubscriptionNotificationConfigurationResponse AWS API Documentation
|
870
|
+
#
|
871
|
+
class DeleteSubscriptionNotificationConfigurationResponse < Aws::EmptyStructure; end
|
872
|
+
|
873
|
+
# Represents an error interacting with the Amazon EventBridge service.
|
874
|
+
#
|
875
|
+
# @!attribute [rw] message
|
876
|
+
# @return [String]
|
877
|
+
#
|
878
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/EventBridgeException AWS API Documentation
|
879
|
+
#
|
880
|
+
class EventBridgeException < Struct.new(
|
881
|
+
:message)
|
882
|
+
SENSITIVE = []
|
883
|
+
include Aws::Structure
|
884
|
+
end
|
885
|
+
|
886
|
+
# List of all failures.
|
887
|
+
#
|
888
|
+
# @!attribute [rw] exception_message
|
889
|
+
# List of all exception messages.
|
890
|
+
# @return [String]
|
891
|
+
#
|
892
|
+
# @!attribute [rw] remediation
|
893
|
+
# List of all remediation steps for failures.
|
894
|
+
# @return [String]
|
895
|
+
#
|
896
|
+
# @!attribute [rw] timestamp
|
897
|
+
# This error can occur if you configure the wrong timestamp format, or
|
898
|
+
# if the subset of entries used for validation had errors or missing
|
899
|
+
# values.
|
900
|
+
# @return [Time]
|
901
|
+
#
|
902
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/Failures AWS API Documentation
|
903
|
+
#
|
904
|
+
class Failures < Struct.new(
|
905
|
+
:exception_message,
|
906
|
+
:remediation,
|
907
|
+
:timestamp)
|
908
|
+
SENSITIVE = []
|
909
|
+
include Aws::Structure
|
910
|
+
end
|
911
|
+
|
912
|
+
# Response element for actions which make changes namely create, update,
|
913
|
+
# or delete actions.
|
914
|
+
#
|
915
|
+
# @!attribute [rw] failures
|
916
|
+
# List of all failures.
|
917
|
+
# @return [Array<Types::Failures>]
|
918
|
+
#
|
919
|
+
# @!attribute [rw] region
|
920
|
+
# List of Regions where the failure occurred.
|
921
|
+
# @return [String]
|
922
|
+
#
|
923
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/FailuresResponse AWS API Documentation
|
924
|
+
#
|
925
|
+
class FailuresResponse < Struct.new(
|
926
|
+
:failures,
|
927
|
+
:region)
|
928
|
+
SENSITIVE = []
|
929
|
+
include Aws::Structure
|
930
|
+
end
|
931
|
+
|
932
|
+
# @api private
|
933
|
+
#
|
934
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/GetDatalakeAutoEnableRequest AWS API Documentation
|
935
|
+
#
|
936
|
+
class GetDatalakeAutoEnableRequest < Aws::EmptyStructure; end
|
937
|
+
|
938
|
+
# @!attribute [rw] auto_enable_new_accounts
|
939
|
+
# The configuration for new accounts.
|
940
|
+
# @return [Array<Types::AutoEnableNewRegionConfiguration>]
|
941
|
+
#
|
942
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/GetDatalakeAutoEnableResponse AWS API Documentation
|
943
|
+
#
|
944
|
+
class GetDatalakeAutoEnableResponse < Struct.new(
|
945
|
+
:auto_enable_new_accounts)
|
946
|
+
SENSITIVE = []
|
947
|
+
include Aws::Structure
|
948
|
+
end
|
949
|
+
|
950
|
+
# @api private
|
951
|
+
#
|
952
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/GetDatalakeExceptionsExpiryRequest AWS API Documentation
|
953
|
+
#
|
954
|
+
class GetDatalakeExceptionsExpiryRequest < Aws::EmptyStructure; end
|
955
|
+
|
956
|
+
# @!attribute [rw] exception_message_expiry
|
957
|
+
# The expiration period and time-to-live (TTL).
|
958
|
+
# @return [Integer]
|
959
|
+
#
|
960
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/GetDatalakeExceptionsExpiryResponse AWS API Documentation
|
961
|
+
#
|
962
|
+
class GetDatalakeExceptionsExpiryResponse < Struct.new(
|
963
|
+
:exception_message_expiry)
|
964
|
+
SENSITIVE = []
|
965
|
+
include Aws::Structure
|
966
|
+
end
|
967
|
+
|
968
|
+
# @api private
|
969
|
+
#
|
970
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/GetDatalakeExceptionsSubscriptionRequest AWS API Documentation
|
971
|
+
#
|
972
|
+
class GetDatalakeExceptionsSubscriptionRequest < Aws::EmptyStructure; end
|
973
|
+
|
974
|
+
# @!attribute [rw] protocol_and_notification_endpoint
|
975
|
+
# Retrieves the exception notification subscription information.
|
976
|
+
# @return [Types::ProtocolAndNotificationEndpoint]
|
977
|
+
#
|
978
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/GetDatalakeExceptionsSubscriptionResponse AWS API Documentation
|
979
|
+
#
|
980
|
+
class GetDatalakeExceptionsSubscriptionResponse < Struct.new(
|
981
|
+
:protocol_and_notification_endpoint)
|
982
|
+
SENSITIVE = []
|
983
|
+
include Aws::Structure
|
984
|
+
end
|
985
|
+
|
986
|
+
# @api private
|
987
|
+
#
|
988
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/GetDatalakeRequest AWS API Documentation
|
989
|
+
#
|
990
|
+
class GetDatalakeRequest < Aws::EmptyStructure; end
|
991
|
+
|
992
|
+
# @!attribute [rw] configurations
|
993
|
+
# Retrieves the Security Lake configuration object.
|
994
|
+
# @return [Hash<String,Types::LakeConfigurationResponse>]
|
995
|
+
#
|
996
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/GetDatalakeResponse AWS API Documentation
|
997
|
+
#
|
998
|
+
class GetDatalakeResponse < Struct.new(
|
999
|
+
:configurations)
|
1000
|
+
SENSITIVE = []
|
1001
|
+
include Aws::Structure
|
1002
|
+
end
|
1003
|
+
|
1004
|
+
# @note When making an API call, you may pass GetDatalakeStatusRequest
|
1005
|
+
# data as a hash:
|
1006
|
+
#
|
1007
|
+
# {
|
1008
|
+
# account_set: ["SafeString"],
|
1009
|
+
# max_account_results: 1,
|
1010
|
+
# next_token: "SafeString",
|
1011
|
+
# }
|
1012
|
+
#
|
1013
|
+
# @!attribute [rw] account_set
|
1014
|
+
# The account IDs for which a static snapshot of the current Region,
|
1015
|
+
# including enabled accounts and log sources is retrieved.
|
1016
|
+
# @return [Array<String>]
|
1017
|
+
#
|
1018
|
+
# @!attribute [rw] max_account_results
|
1019
|
+
# The maximum limit of accounts for which the static snapshot of the
|
1020
|
+
# current Region including enabled accounts and log sources is
|
1021
|
+
# retrieved.
|
1022
|
+
# @return [Integer]
|
1023
|
+
#
|
1024
|
+
# @!attribute [rw] next_token
|
1025
|
+
# If nextToken is returned, there are more results available. The
|
1026
|
+
# value of nextToken is a unique pagination token for each page. Make
|
1027
|
+
# the call again using the returned token to retrieve the next page.
|
1028
|
+
# Keep all other arguments unchanged. Each pagination token expires
|
1029
|
+
# after 24 hours. Using an expired pagination token will return an
|
1030
|
+
# HTTP 400 InvalidToken error.
|
1031
|
+
# @return [String]
|
1032
|
+
#
|
1033
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/GetDatalakeStatusRequest AWS API Documentation
|
1034
|
+
#
|
1035
|
+
class GetDatalakeStatusRequest < Struct.new(
|
1036
|
+
:account_set,
|
1037
|
+
:max_account_results,
|
1038
|
+
:next_token)
|
1039
|
+
SENSITIVE = []
|
1040
|
+
include Aws::Structure
|
1041
|
+
end
|
1042
|
+
|
1043
|
+
# @!attribute [rw] account_sources_list
|
1044
|
+
# The list of enabled accounts and enabled sources.
|
1045
|
+
# @return [Array<Types::AccountSources>]
|
1046
|
+
#
|
1047
|
+
# @!attribute [rw] next_token
|
1048
|
+
# If nextToken is returned, there are more results available. The
|
1049
|
+
# value of nextToken is a unique pagination token for each page. Make
|
1050
|
+
# the call again using the returned token to retrieve the next page.
|
1051
|
+
# Keep all other arguments unchanged. Each pagination token expires
|
1052
|
+
# after 24 hours. Using an expired pagination token will return an
|
1053
|
+
# HTTP 400 InvalidToken error.
|
1054
|
+
# @return [String]
|
1055
|
+
#
|
1056
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/GetDatalakeStatusResponse AWS API Documentation
|
1057
|
+
#
|
1058
|
+
class GetDatalakeStatusResponse < Struct.new(
|
1059
|
+
:account_sources_list,
|
1060
|
+
:next_token)
|
1061
|
+
SENSITIVE = []
|
1062
|
+
include Aws::Structure
|
1063
|
+
end
|
1064
|
+
|
1065
|
+
# @note When making an API call, you may pass GetSubscriberRequest
|
1066
|
+
# data as a hash:
|
1067
|
+
#
|
1068
|
+
# {
|
1069
|
+
# id: "String", # required
|
1070
|
+
# }
|
1071
|
+
#
|
1072
|
+
# @!attribute [rw] id
|
1073
|
+
# A value created by Security Lake that uniquely identifies your
|
1074
|
+
# `GetSubscriber` API request.
|
1075
|
+
# @return [String]
|
1076
|
+
#
|
1077
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/GetSubscriberRequest AWS API Documentation
|
1078
|
+
#
|
1079
|
+
class GetSubscriberRequest < Struct.new(
|
1080
|
+
:id)
|
1081
|
+
SENSITIVE = []
|
1082
|
+
include Aws::Structure
|
1083
|
+
end
|
1084
|
+
|
1085
|
+
# @!attribute [rw] subscriber
|
1086
|
+
# Subscription information for the specified subscription ID
|
1087
|
+
# @return [Types::SubscriberResource]
|
1088
|
+
#
|
1089
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/GetSubscriberResponse AWS API Documentation
|
1090
|
+
#
|
1091
|
+
class GetSubscriberResponse < Struct.new(
|
1092
|
+
:subscriber)
|
1093
|
+
SENSITIVE = []
|
1094
|
+
include Aws::Structure
|
1095
|
+
end
|
1096
|
+
|
1097
|
+
# Internal service exceptions are sometimes caused by transient issues.
|
1098
|
+
# Before you start troubleshooting, perform the operation again.
|
1099
|
+
#
|
1100
|
+
# @!attribute [rw] message
|
1101
|
+
# @return [String]
|
1102
|
+
#
|
1103
|
+
# @!attribute [rw] retry_after_seconds
|
1104
|
+
# Retry the request after the specified time.
|
1105
|
+
# @return [Integer]
|
1106
|
+
#
|
1107
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/InternalServerException AWS API Documentation
|
1108
|
+
#
|
1109
|
+
class InternalServerException < Struct.new(
|
1110
|
+
:message,
|
1111
|
+
:retry_after_seconds)
|
1112
|
+
SENSITIVE = []
|
1113
|
+
include Aws::Structure
|
1114
|
+
end
|
1115
|
+
|
1116
|
+
# The request was rejected because an invalid or out-of-range value was
|
1117
|
+
# supplied for an input parameter.
|
1118
|
+
#
|
1119
|
+
# @!attribute [rw] message
|
1120
|
+
# @return [String]
|
1121
|
+
#
|
1122
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/InvalidInputException AWS API Documentation
|
1123
|
+
#
|
1124
|
+
class InvalidInputException < Struct.new(
|
1125
|
+
:message)
|
1126
|
+
SENSITIVE = []
|
1127
|
+
include Aws::Structure
|
1128
|
+
end
|
1129
|
+
|
1130
|
+
# Provides details of lake configuration object in Amazon Security Lake.
|
1131
|
+
#
|
1132
|
+
# @note When making an API call, you may pass LakeConfigurationRequest
|
1133
|
+
# data as a hash:
|
1134
|
+
#
|
1135
|
+
# {
|
1136
|
+
# encryption_key: "String",
|
1137
|
+
# replication_destination_regions: ["us-east-1"], # accepts us-east-1, us-west-2, eu-central-1, us-east-2, eu-west-1, ap-northeast-1, ap-southeast-2
|
1138
|
+
# replication_role_arn: "RoleArn",
|
1139
|
+
# retention_settings: [
|
1140
|
+
# {
|
1141
|
+
# retention_period: 1,
|
1142
|
+
# storage_class: "STANDARD_IA", # accepts STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER_IR, GLACIER, DEEP_ARCHIVE, EXPIRE
|
1143
|
+
# },
|
1144
|
+
# ],
|
1145
|
+
# tags_map: {
|
1146
|
+
# "String" => "String",
|
1147
|
+
# },
|
1148
|
+
# }
|
1149
|
+
#
|
1150
|
+
# @!attribute [rw] encryption_key
|
1151
|
+
# The type of encryption key used by Security Lake to encrypt the lake
|
1152
|
+
# configuration object.
|
1153
|
+
# @return [String]
|
1154
|
+
#
|
1155
|
+
# @!attribute [rw] replication_destination_regions
|
1156
|
+
# Replication enables automatic, asynchronous copying of objects
|
1157
|
+
# across Amazon S3 buckets. Amazon S3 buckets that are configured for
|
1158
|
+
# object replication can be owned by the same Amazon Web Services
|
1159
|
+
# account or by different accounts. You can replicate objects to a
|
1160
|
+
# single destination bucket or to multiple destination buckets. The
|
1161
|
+
# destination buckets can be in different Amazon Web Services Regions
|
1162
|
+
# or within the same Region as the source bucket.
|
1163
|
+
#
|
1164
|
+
# Set up one or more rollup Regions by providing the Region or Regions
|
1165
|
+
# that should contribute to the central rollup Region.
|
1166
|
+
# @return [Array<String>]
|
1167
|
+
#
|
1168
|
+
# @!attribute [rw] replication_role_arn
|
1169
|
+
# Replication settings for the Amazon S3 buckets. This parameter uses
|
1170
|
+
# the IAM role created by you that is managed by Security Lake, to
|
1171
|
+
# ensure the replication setting is correct.
|
1172
|
+
# @return [String]
|
1173
|
+
#
|
1174
|
+
# @!attribute [rw] retention_settings
|
1175
|
+
# Retention settings for the destination Amazon S3 buckets.
|
1176
|
+
# @return [Array<Types::RetentionSetting>]
|
1177
|
+
#
|
1178
|
+
# @!attribute [rw] tags_map
|
1179
|
+
# A tag is a label that you assign to an Amazon Web Services resource.
|
1180
|
+
# Each tag consists of a key and an optional value, both of which you
|
1181
|
+
# define.
|
1182
|
+
# @return [Hash<String,String>]
|
1183
|
+
#
|
1184
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/LakeConfigurationRequest AWS API Documentation
|
1185
|
+
#
|
1186
|
+
class LakeConfigurationRequest < Struct.new(
|
1187
|
+
:encryption_key,
|
1188
|
+
:replication_destination_regions,
|
1189
|
+
:replication_role_arn,
|
1190
|
+
:retention_settings,
|
1191
|
+
:tags_map)
|
1192
|
+
SENSITIVE = []
|
1193
|
+
include Aws::Structure
|
1194
|
+
end
|
1195
|
+
|
1196
|
+
# Provides details of lake configuration object in Amazon Security Lake.
|
1197
|
+
#
|
1198
|
+
# @!attribute [rw] encryption_key
|
1199
|
+
# The type of encryption key used by Security Lake to encrypt the lake
|
1200
|
+
# configuration
|
1201
|
+
# @return [String]
|
1202
|
+
#
|
1203
|
+
# @!attribute [rw] replication_destination_regions
|
1204
|
+
# Replication enables automatic, asynchronous copying of objects
|
1205
|
+
# across Amazon S3 buckets. Amazon S3 buckets that are configured for
|
1206
|
+
# object replication can be owned by the same AWS account or by
|
1207
|
+
# different accounts. You can replicate objects to a single
|
1208
|
+
# destination bucket or to multiple destination buckets. The
|
1209
|
+
# destination buckets can be in different Amazon Web Services Regions
|
1210
|
+
# or within the same Region as the source bucket.
|
1211
|
+
#
|
1212
|
+
# Set up one or more rollup Regions by providing the Region or Regions
|
1213
|
+
# that should contribute to the central rollup Region.
|
1214
|
+
# @return [Array<String>]
|
1215
|
+
#
|
1216
|
+
# @!attribute [rw] replication_role_arn
|
1217
|
+
# Replication settings for the Amazon S3 buckets. This parameter uses
|
1218
|
+
# the IAM role created by you that is managed by Security Lake, to
|
1219
|
+
# ensure the replication setting is correct.
|
1220
|
+
# @return [String]
|
1221
|
+
#
|
1222
|
+
# @!attribute [rw] retention_settings
|
1223
|
+
# Retention settings for the destination Amazon S3 buckets.
|
1224
|
+
# @return [Array<Types::RetentionSetting>]
|
1225
|
+
#
|
1226
|
+
# @!attribute [rw] s3_bucket_arn
|
1227
|
+
# Amazon Resource Names (ARNs) uniquely identify Amazon Web Services
|
1228
|
+
# resources. Security Lake requires an ARN when you need to specify a
|
1229
|
+
# resource unambiguously across all of Amazon Web Services, such as in
|
1230
|
+
# IAM policies, Amazon Relational Database Service (Amazon RDS) tags,
|
1231
|
+
# and API calls.
|
1232
|
+
# @return [String]
|
1233
|
+
#
|
1234
|
+
# @!attribute [rw] status
|
1235
|
+
# Retrieves the status of the configuration operation for an account
|
1236
|
+
# in Amazon Security Lake.
|
1237
|
+
# @return [String]
|
1238
|
+
#
|
1239
|
+
# @!attribute [rw] tags_map
|
1240
|
+
# A tag is a label that you assign to an Amazon Web Services resource.
|
1241
|
+
# Each tag consists of a key and an optional value, both of which you
|
1242
|
+
# define.
|
1243
|
+
# @return [Hash<String,String>]
|
1244
|
+
#
|
1245
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/LakeConfigurationResponse AWS API Documentation
|
1246
|
+
#
|
1247
|
+
class LakeConfigurationResponse < Struct.new(
|
1248
|
+
:encryption_key,
|
1249
|
+
:replication_destination_regions,
|
1250
|
+
:replication_role_arn,
|
1251
|
+
:retention_settings,
|
1252
|
+
:s3_bucket_arn,
|
1253
|
+
:status,
|
1254
|
+
:tags_map)
|
1255
|
+
SENSITIVE = []
|
1256
|
+
include Aws::Structure
|
1257
|
+
end
|
1258
|
+
|
1259
|
+
# @note When making an API call, you may pass ListDatalakeExceptionsRequest
|
1260
|
+
# data as a hash:
|
1261
|
+
#
|
1262
|
+
# {
|
1263
|
+
# max_failures: 1,
|
1264
|
+
# next_token: "SafeString",
|
1265
|
+
# region_set: ["us-east-1"], # accepts us-east-1, us-west-2, eu-central-1, us-east-2, eu-west-1, ap-northeast-1, ap-southeast-2
|
1266
|
+
# }
|
1267
|
+
#
|
1268
|
+
# @!attribute [rw] max_failures
|
1269
|
+
# List the maximum number of failures in Security Lake.
|
1270
|
+
# @return [Integer]
|
1271
|
+
#
|
1272
|
+
# @!attribute [rw] next_token
|
1273
|
+
# List if there are more results available. if nextToken is returned,
|
1274
|
+
# You can make the call again using the returned token to retrieve the
|
1275
|
+
# next page
|
1276
|
+
# @return [String]
|
1277
|
+
#
|
1278
|
+
# @!attribute [rw] region_set
|
1279
|
+
# List the regions from which exceptions are retrieved.
|
1280
|
+
# @return [Array<String>]
|
1281
|
+
#
|
1282
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/ListDatalakeExceptionsRequest AWS API Documentation
|
1283
|
+
#
|
1284
|
+
class ListDatalakeExceptionsRequest < Struct.new(
|
1285
|
+
:max_failures,
|
1286
|
+
:next_token,
|
1287
|
+
:region_set)
|
1288
|
+
SENSITIVE = []
|
1289
|
+
include Aws::Structure
|
1290
|
+
end
|
1291
|
+
|
1292
|
+
# @!attribute [rw] next_token
|
1293
|
+
# List if there are more results available. if nextToken is returned,
|
1294
|
+
# You can make the call again using the returned token to retrieve the
|
1295
|
+
# next page
|
1296
|
+
# @return [String]
|
1297
|
+
#
|
1298
|
+
# @!attribute [rw] non_retryable_failures
|
1299
|
+
# Lists the non-retryable failures in the current region.
|
1300
|
+
# @return [Array<Types::FailuresResponse>]
|
1301
|
+
#
|
1302
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/ListDatalakeExceptionsResponse AWS API Documentation
|
1303
|
+
#
|
1304
|
+
class ListDatalakeExceptionsResponse < Struct.new(
|
1305
|
+
:next_token,
|
1306
|
+
:non_retryable_failures)
|
1307
|
+
SENSITIVE = []
|
1308
|
+
include Aws::Structure
|
1309
|
+
end
|
1310
|
+
|
1311
|
+
# @note When making an API call, you may pass ListLogSourcesRequest
|
1312
|
+
# data as a hash:
|
1313
|
+
#
|
1314
|
+
# {
|
1315
|
+
# input_order: ["REGION"], # accepts REGION, SOURCE_TYPE, MEMBER
|
1316
|
+
# list_all_dimensions: {
|
1317
|
+
# "String" => {
|
1318
|
+
# "String" => ["String"],
|
1319
|
+
# },
|
1320
|
+
# },
|
1321
|
+
# list_single_dimension: ["SafeString"],
|
1322
|
+
# list_two_dimensions: {
|
1323
|
+
# "String" => ["String"],
|
1324
|
+
# },
|
1325
|
+
# max_results: 1,
|
1326
|
+
# next_token: "SafeString",
|
1327
|
+
# }
|
1328
|
+
#
|
1329
|
+
# @!attribute [rw] input_order
|
1330
|
+
# Lists the log sources in input order, namely Region, source type,
|
1331
|
+
# and member account.
|
1332
|
+
# @return [Array<String>]
|
1333
|
+
#
|
1334
|
+
# @!attribute [rw] list_all_dimensions
|
1335
|
+
# List the view of log sources for enabled Security Lake accounts in
|
1336
|
+
# all Regions and source types.
|
1337
|
+
# @return [Hash<String,Hash<String,Array<String>>>]
|
1338
|
+
#
|
1339
|
+
# @!attribute [rw] list_single_dimension
|
1340
|
+
# List the view of log sources for enabled Security Lake accounts for
|
1341
|
+
# the entire region.
|
1342
|
+
# @return [Array<String>]
|
1343
|
+
#
|
1344
|
+
# @!attribute [rw] list_two_dimensions
|
1345
|
+
# Lists the log sources for the specified source types in enabled
|
1346
|
+
# Security Lake accounts for the entire Region, for selected member
|
1347
|
+
# accounts.
|
1348
|
+
# @return [Hash<String,Array<String>>]
|
1349
|
+
#
|
1350
|
+
# @!attribute [rw] max_results
|
1351
|
+
# The maximum number of accounts for which the configuration is
|
1352
|
+
# displayed.
|
1353
|
+
# @return [Integer]
|
1354
|
+
#
|
1355
|
+
# @!attribute [rw] next_token
|
1356
|
+
# If nextToken is returned, there are more results available. You can
|
1357
|
+
# make the call again using the returned token to retrieve the next
|
1358
|
+
# page.
|
1359
|
+
# @return [String]
|
1360
|
+
#
|
1361
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/ListLogSourcesRequest AWS API Documentation
|
1362
|
+
#
|
1363
|
+
class ListLogSourcesRequest < Struct.new(
|
1364
|
+
:input_order,
|
1365
|
+
:list_all_dimensions,
|
1366
|
+
:list_single_dimension,
|
1367
|
+
:list_two_dimensions,
|
1368
|
+
:max_results,
|
1369
|
+
:next_token)
|
1370
|
+
SENSITIVE = []
|
1371
|
+
include Aws::Structure
|
1372
|
+
end
|
1373
|
+
|
1374
|
+
# @!attribute [rw] next_token
|
1375
|
+
# If nextToken is returned, there are more results available. You can
|
1376
|
+
# make the call again using the returned token to retrieve the next
|
1377
|
+
# page.
|
1378
|
+
# @return [String]
|
1379
|
+
#
|
1380
|
+
# @!attribute [rw] region_source_types_accounts_list
|
1381
|
+
# Lists the log sources in the Regions for enabled Security Lake
|
1382
|
+
# accounts.
|
1383
|
+
# @return [Array<Hash<String,Hash<String,Array<String>>>>]
|
1384
|
+
#
|
1385
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/ListLogSourcesResponse AWS API Documentation
|
1386
|
+
#
|
1387
|
+
class ListLogSourcesResponse < Struct.new(
|
1388
|
+
:next_token,
|
1389
|
+
:region_source_types_accounts_list)
|
1390
|
+
SENSITIVE = []
|
1391
|
+
include Aws::Structure
|
1392
|
+
end
|
1393
|
+
|
1394
|
+
# @note When making an API call, you may pass ListSubscribersRequest
|
1395
|
+
# data as a hash:
|
1396
|
+
#
|
1397
|
+
# {
|
1398
|
+
# max_results: 1,
|
1399
|
+
# next_token: "SafeString",
|
1400
|
+
# }
|
1401
|
+
#
|
1402
|
+
# @!attribute [rw] max_results
|
1403
|
+
# The maximum number of accounts for which the configuration is
|
1404
|
+
# displayed.
|
1405
|
+
# @return [Integer]
|
1406
|
+
#
|
1407
|
+
# @!attribute [rw] next_token
|
1408
|
+
# If nextToken is returned, there are more results available. You can
|
1409
|
+
# make the call again using the returned token to retrieve the next
|
1410
|
+
# page.
|
1411
|
+
# @return [String]
|
1412
|
+
#
|
1413
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/ListSubscribersRequest AWS API Documentation
|
1414
|
+
#
|
1415
|
+
class ListSubscribersRequest < Struct.new(
|
1416
|
+
:max_results,
|
1417
|
+
:next_token)
|
1418
|
+
SENSITIVE = []
|
1419
|
+
include Aws::Structure
|
1420
|
+
end
|
1421
|
+
|
1422
|
+
# @!attribute [rw] next_token
|
1423
|
+
# If nextToken is returned, there are more results available. You can
|
1424
|
+
# make the call again using the returned token to retrieve the next
|
1425
|
+
# page.
|
1426
|
+
# @return [String]
|
1427
|
+
#
|
1428
|
+
# @!attribute [rw] subscribers
|
1429
|
+
# The subscribers available in the specified Security Lake account ID.
|
1430
|
+
# @return [Array<Types::SubscriberResource>]
|
1431
|
+
#
|
1432
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/ListSubscribersResponse AWS API Documentation
|
1433
|
+
#
|
1434
|
+
class ListSubscribersResponse < Struct.new(
|
1435
|
+
:next_token,
|
1436
|
+
:subscribers)
|
1437
|
+
SENSITIVE = []
|
1438
|
+
include Aws::Structure
|
1439
|
+
end
|
1440
|
+
|
1441
|
+
# Log status for the Security Lake account.
|
1442
|
+
#
|
1443
|
+
# @!attribute [rw] health_status
|
1444
|
+
# Health status of services including error codes and patterns.
|
1445
|
+
# @return [String]
|
1446
|
+
#
|
1447
|
+
# @!attribute [rw] path_to_logs
|
1448
|
+
# Defines path the stored logs are available which has information on
|
1449
|
+
# your systems, applications, and services.
|
1450
|
+
# @return [String]
|
1451
|
+
#
|
1452
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/LogsStatus AWS API Documentation
|
1453
|
+
#
|
1454
|
+
class LogsStatus < Struct.new(
|
1455
|
+
:health_status,
|
1456
|
+
:path_to_logs)
|
1457
|
+
SENSITIVE = []
|
1458
|
+
include Aws::Structure
|
1459
|
+
end
|
1460
|
+
|
1461
|
+
# Notifications in Security Lake which dictates how notifications are
|
1462
|
+
# posted at the endpoint.
|
1463
|
+
#
|
1464
|
+
# @!attribute [rw] endpoint
|
1465
|
+
# The account which is subscribed to receive exception notifications.
|
1466
|
+
# @return [String]
|
1467
|
+
#
|
1468
|
+
# @!attribute [rw] protocol
|
1469
|
+
# The protocol to which notification messages are posted.
|
1470
|
+
# @return [String]
|
1471
|
+
#
|
1472
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/ProtocolAndNotificationEndpoint AWS API Documentation
|
1473
|
+
#
|
1474
|
+
class ProtocolAndNotificationEndpoint < Struct.new(
|
1475
|
+
:endpoint,
|
1476
|
+
:protocol)
|
1477
|
+
SENSITIVE = []
|
1478
|
+
include Aws::Structure
|
1479
|
+
end
|
1480
|
+
|
1481
|
+
# The resource could not be found.
|
1482
|
+
#
|
1483
|
+
# @!attribute [rw] message
|
1484
|
+
# @return [String]
|
1485
|
+
#
|
1486
|
+
# @!attribute [rw] resource_id
|
1487
|
+
# The ID of the resource for which the type of resource could not be
|
1488
|
+
# found.
|
1489
|
+
# @return [String]
|
1490
|
+
#
|
1491
|
+
# @!attribute [rw] resource_type
|
1492
|
+
# The type of the resource that could not be found.
|
1493
|
+
# @return [String]
|
1494
|
+
#
|
1495
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/ResourceNotFoundException AWS API Documentation
|
1496
|
+
#
|
1497
|
+
class ResourceNotFoundException < Struct.new(
|
1498
|
+
:message,
|
1499
|
+
:resource_id,
|
1500
|
+
:resource_type)
|
1501
|
+
SENSITIVE = []
|
1502
|
+
include Aws::Structure
|
1503
|
+
end
|
1504
|
+
|
1505
|
+
# Retention settings for the destination Amazon S3 buckets in Security
|
1506
|
+
# Lake.
|
1507
|
+
#
|
1508
|
+
# @note When making an API call, you may pass RetentionSetting
|
1509
|
+
# data as a hash:
|
1510
|
+
#
|
1511
|
+
# {
|
1512
|
+
# retention_period: 1,
|
1513
|
+
# storage_class: "STANDARD_IA", # accepts STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER_IR, GLACIER, DEEP_ARCHIVE, EXPIRE
|
1514
|
+
# }
|
1515
|
+
#
|
1516
|
+
# @!attribute [rw] retention_period
|
1517
|
+
# The retention period specifies a fixed period of time during which
|
1518
|
+
# the Security Lake object remains locked. You can specify the
|
1519
|
+
# retention period for one or more source in days.
|
1520
|
+
# @return [Integer]
|
1521
|
+
#
|
1522
|
+
# @!attribute [rw] storage_class
|
1523
|
+
# The range of storage classes that you can choose from based on the
|
1524
|
+
# data access, resiliency, and cost requirements of your workloads.
|
1525
|
+
# @return [String]
|
1526
|
+
#
|
1527
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/RetentionSetting AWS API Documentation
|
1528
|
+
#
|
1529
|
+
class RetentionSetting < Struct.new(
|
1530
|
+
:retention_period,
|
1531
|
+
:storage_class)
|
1532
|
+
SENSITIVE = []
|
1533
|
+
include Aws::Structure
|
1534
|
+
end
|
1535
|
+
|
1536
|
+
# Provides an extension of the AmazonServiceException for errors
|
1537
|
+
# reported by Amazon S3 while processing a request. In particular, this
|
1538
|
+
# class provides access to Amazon S3's extended request ID. This ID is
|
1539
|
+
# required debugging information in the case the user needs to contact
|
1540
|
+
# Amazon about an issue where Amazon S3 is incorrectly handling a
|
1541
|
+
# request.
|
1542
|
+
#
|
1543
|
+
# @!attribute [rw] message
|
1544
|
+
# @return [String]
|
1545
|
+
#
|
1546
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/S3Exception AWS API Documentation
|
1547
|
+
#
|
1548
|
+
class S3Exception < Struct.new(
|
1549
|
+
:message)
|
1550
|
+
SENSITIVE = []
|
1551
|
+
include Aws::Structure
|
1552
|
+
end
|
1553
|
+
|
1554
|
+
# You have exceeded your service quota. To perform the requested action,
|
1555
|
+
# remove some of the relevant resources, or use Service Quotas to
|
1556
|
+
# request a service quota increase.
|
1557
|
+
#
|
1558
|
+
# @!attribute [rw] message
|
1559
|
+
# @return [String]
|
1560
|
+
#
|
1561
|
+
# @!attribute [rw] quota_code
|
1562
|
+
# That the rate of requests to Security Lake is exceeding the request
|
1563
|
+
# quotas for your Amazon Web Services account.
|
1564
|
+
# @return [String]
|
1565
|
+
#
|
1566
|
+
# @!attribute [rw] resource_id
|
1567
|
+
# The ID of the resource that exceeds the service quota.
|
1568
|
+
# @return [String]
|
1569
|
+
#
|
1570
|
+
# @!attribute [rw] resource_type
|
1571
|
+
# The type of the resource that exceeds the service quota.
|
1572
|
+
# @return [String]
|
1573
|
+
#
|
1574
|
+
# @!attribute [rw] service_code
|
1575
|
+
# The code for the service in Service Quotas.
|
1576
|
+
# @return [String]
|
1577
|
+
#
|
1578
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/ServiceQuotaExceededException AWS API Documentation
|
1579
|
+
#
|
1580
|
+
class ServiceQuotaExceededException < Struct.new(
|
1581
|
+
:message,
|
1582
|
+
:quota_code,
|
1583
|
+
:resource_id,
|
1584
|
+
:resource_type,
|
1585
|
+
:service_code)
|
1586
|
+
SENSITIVE = []
|
1587
|
+
include Aws::Structure
|
1588
|
+
end
|
1589
|
+
|
1590
|
+
# The supported source types from which logs and events are collected in
|
1591
|
+
# Amazon Security Lake.
|
1592
|
+
#
|
1593
|
+
# @note SourceType is a union - when making an API calls you must set exactly one of the members.
|
1594
|
+
#
|
1595
|
+
# @note SourceType is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of SourceType corresponding to the set member.
|
1596
|
+
#
|
1597
|
+
# @!attribute [rw] aws_source_type
|
1598
|
+
# Amazon Security Lake supports logs and events collection for
|
1599
|
+
# natively-supported Amazon Web Services services. For more
|
1600
|
+
# information, see the Amazon Security Lake User Guide.
|
1601
|
+
# @return [String]
|
1602
|
+
#
|
1603
|
+
# @!attribute [rw] custom_source_type
|
1604
|
+
# Amazon Security Lake supports custom source types. For the detailed
|
1605
|
+
# list, see the Amazon Security Lake User Guide.
|
1606
|
+
# @return [String]
|
1607
|
+
#
|
1608
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/SourceType AWS API Documentation
|
1609
|
+
#
|
1610
|
+
class SourceType < Struct.new(
|
1611
|
+
:aws_source_type,
|
1612
|
+
:custom_source_type,
|
1613
|
+
:unknown)
|
1614
|
+
SENSITIVE = []
|
1615
|
+
include Aws::Structure
|
1616
|
+
include Aws::Structure::Union
|
1617
|
+
|
1618
|
+
class AwsSourceType < SourceType; end
|
1619
|
+
class CustomSourceType < SourceType; end
|
1620
|
+
class Unknown < SourceType; end
|
1621
|
+
end
|
1622
|
+
|
1623
|
+
# Provides details of the Amazon Security Lake account subscription.
|
1624
|
+
# Subscribers are notified of new objects for a source as the data is
|
1625
|
+
# written to your Amazon Security Lake S3 bucket.
|
1626
|
+
#
|
1627
|
+
# @!attribute [rw] access_types
|
1628
|
+
# You can choose to notify subscribers of new objects with an Amazon
|
1629
|
+
# Simple Queue Service (Amazon SQS) queue or through messaging to an
|
1630
|
+
# HTTPS endpoint provided by the subscriber.
|
1631
|
+
#
|
1632
|
+
# Subscribers can consume data by directly querying Lake Formation
|
1633
|
+
# tables in your S3 bucket via services like Amazon Athena. This
|
1634
|
+
# subscription type is defined as `LAKEFORMATION`.
|
1635
|
+
# @return [Array<String>]
|
1636
|
+
#
|
1637
|
+
# @!attribute [rw] account_id
|
1638
|
+
# The Amazon Web Services account ID of the account that you are using
|
1639
|
+
# to create your Amazon Security Lake account.
|
1640
|
+
# @return [String]
|
1641
|
+
#
|
1642
|
+
# @!attribute [rw] created_at
|
1643
|
+
# The date and time when the subscription was created.
|
1644
|
+
# @return [Time]
|
1645
|
+
#
|
1646
|
+
# @!attribute [rw] external_id
|
1647
|
+
# The external ID of the subscriber. External ID allows the user that
|
1648
|
+
# is assuming the role to assert the circumstances in which they are
|
1649
|
+
# operating. It also provides a way for the account owner to permit
|
1650
|
+
# the role to be assumed only under specific circumstances.
|
1651
|
+
# @return [String]
|
1652
|
+
#
|
1653
|
+
# @!attribute [rw] role_arn
|
1654
|
+
# The Amazon Resource Name (ARN) specifying the role of the
|
1655
|
+
# subscriber.
|
1656
|
+
# @return [String]
|
1657
|
+
#
|
1658
|
+
# @!attribute [rw] s3_bucket_arn
|
1659
|
+
# The Amazon Resource Name (ARN) for the Amazon S3 bucket.
|
1660
|
+
# @return [String]
|
1661
|
+
#
|
1662
|
+
# @!attribute [rw] sns_arn
|
1663
|
+
# The Amazon Resource Name (ARN) for the Amazon Simple Notification
|
1664
|
+
# Service.
|
1665
|
+
# @return [String]
|
1666
|
+
#
|
1667
|
+
# @!attribute [rw] source_types
|
1668
|
+
# Amazon Security Lake supports logs and events collection for the
|
1669
|
+
# natively-supported Amazon Web Services services. For more
|
1670
|
+
# information, see the Amazon Security Lake User Guide.
|
1671
|
+
# @return [Array<Types::SourceType>]
|
1672
|
+
#
|
1673
|
+
# @!attribute [rw] subscriber_description
|
1674
|
+
# The subscriber descriptions for a subscriber account. The
|
1675
|
+
# description for a subscriber includes `subscriberName`, `accountID`,
|
1676
|
+
# `externalID`, and `subscriptionId`.
|
1677
|
+
# @return [String]
|
1678
|
+
#
|
1679
|
+
# @!attribute [rw] subscriber_name
|
1680
|
+
# The name of your Amazon Security Lake subscriber account.
|
1681
|
+
# @return [String]
|
1682
|
+
#
|
1683
|
+
# @!attribute [rw] subscription_endpoint
|
1684
|
+
# The subscription endpoint to which exception messages are posted.
|
1685
|
+
# @return [String]
|
1686
|
+
#
|
1687
|
+
# @!attribute [rw] subscription_id
|
1688
|
+
# The subscription ID of the Amazon Security Lake subscriber account.
|
1689
|
+
# @return [String]
|
1690
|
+
#
|
1691
|
+
# @!attribute [rw] subscription_protocol
|
1692
|
+
# The subscription protocol to which exception messages are posted.
|
1693
|
+
# @return [String]
|
1694
|
+
#
|
1695
|
+
# @!attribute [rw] subscription_status
|
1696
|
+
# Subscription status of the Amazon Security Lake subscriber account.
|
1697
|
+
# @return [String]
|
1698
|
+
#
|
1699
|
+
# @!attribute [rw] updated_at
|
1700
|
+
# The date and time when the subscription was created.
|
1701
|
+
# @return [Time]
|
1702
|
+
#
|
1703
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/SubscriberResource AWS API Documentation
|
1704
|
+
#
|
1705
|
+
class SubscriberResource < Struct.new(
|
1706
|
+
:access_types,
|
1707
|
+
:account_id,
|
1708
|
+
:created_at,
|
1709
|
+
:external_id,
|
1710
|
+
:role_arn,
|
1711
|
+
:s3_bucket_arn,
|
1712
|
+
:sns_arn,
|
1713
|
+
:source_types,
|
1714
|
+
:subscriber_description,
|
1715
|
+
:subscriber_name,
|
1716
|
+
:subscription_endpoint,
|
1717
|
+
:subscription_id,
|
1718
|
+
:subscription_protocol,
|
1719
|
+
:subscription_status,
|
1720
|
+
:updated_at)
|
1721
|
+
SENSITIVE = []
|
1722
|
+
include Aws::Structure
|
1723
|
+
end
|
1724
|
+
|
1725
|
+
# The limit on the number of requests per second was exceeded.
|
1726
|
+
#
|
1727
|
+
# @!attribute [rw] message
|
1728
|
+
# @return [String]
|
1729
|
+
#
|
1730
|
+
# @!attribute [rw] quota_code
|
1731
|
+
# That the rate of requests to Security Lake is exceeding the request
|
1732
|
+
# quotas for your Amazon Web Services account.
|
1733
|
+
# @return [String]
|
1734
|
+
#
|
1735
|
+
# @!attribute [rw] retry_after_seconds
|
1736
|
+
# Retry the request after the specified time.
|
1737
|
+
# @return [Integer]
|
1738
|
+
#
|
1739
|
+
# @!attribute [rw] service_code
|
1740
|
+
# The code for the service in Service Quotas.
|
1741
|
+
# @return [String]
|
1742
|
+
#
|
1743
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/ThrottlingException AWS API Documentation
|
1744
|
+
#
|
1745
|
+
class ThrottlingException < Struct.new(
|
1746
|
+
:message,
|
1747
|
+
:quota_code,
|
1748
|
+
:retry_after_seconds,
|
1749
|
+
:service_code)
|
1750
|
+
SENSITIVE = []
|
1751
|
+
include Aws::Structure
|
1752
|
+
end
|
1753
|
+
|
1754
|
+
# @note When making an API call, you may pass UpdateDatalakeExceptionsExpiryRequest
|
1755
|
+
# data as a hash:
|
1756
|
+
#
|
1757
|
+
# {
|
1758
|
+
# exception_message_expiry: 1, # required
|
1759
|
+
# }
|
1760
|
+
#
|
1761
|
+
# @!attribute [rw] exception_message_expiry
|
1762
|
+
# The time-to-live (TTL) for the exception message to remain.
|
1763
|
+
# @return [Integer]
|
1764
|
+
#
|
1765
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/UpdateDatalakeExceptionsExpiryRequest AWS API Documentation
|
1766
|
+
#
|
1767
|
+
class UpdateDatalakeExceptionsExpiryRequest < Struct.new(
|
1768
|
+
:exception_message_expiry)
|
1769
|
+
SENSITIVE = []
|
1770
|
+
include Aws::Structure
|
1771
|
+
end
|
1772
|
+
|
1773
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/UpdateDatalakeExceptionsExpiryResponse AWS API Documentation
|
1774
|
+
#
|
1775
|
+
class UpdateDatalakeExceptionsExpiryResponse < Aws::EmptyStructure; end
|
1776
|
+
|
1777
|
+
# @note When making an API call, you may pass UpdateDatalakeExceptionsSubscriptionRequest
|
1778
|
+
# data as a hash:
|
1779
|
+
#
|
1780
|
+
# {
|
1781
|
+
# notification_endpoint: "SafeString", # required
|
1782
|
+
# subscription_protocol: "HTTP", # required, accepts HTTP, HTTPS, EMAIL, EMAIL_JSON, SMS, SQS, LAMBDA, APP, FIREHOSE
|
1783
|
+
# }
|
1784
|
+
#
|
1785
|
+
# @!attribute [rw] notification_endpoint
|
1786
|
+
# The account which is subscribed to receive exception notifications.
|
1787
|
+
# @return [String]
|
1788
|
+
#
|
1789
|
+
# @!attribute [rw] subscription_protocol
|
1790
|
+
# The subscription protocol to which exception messages are posted.
|
1791
|
+
# @return [String]
|
1792
|
+
#
|
1793
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/UpdateDatalakeExceptionsSubscriptionRequest AWS API Documentation
|
1794
|
+
#
|
1795
|
+
class UpdateDatalakeExceptionsSubscriptionRequest < Struct.new(
|
1796
|
+
:notification_endpoint,
|
1797
|
+
:subscription_protocol)
|
1798
|
+
SENSITIVE = []
|
1799
|
+
include Aws::Structure
|
1800
|
+
end
|
1801
|
+
|
1802
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/UpdateDatalakeExceptionsSubscriptionResponse AWS API Documentation
|
1803
|
+
#
|
1804
|
+
class UpdateDatalakeExceptionsSubscriptionResponse < Aws::EmptyStructure; end
|
1805
|
+
|
1806
|
+
# @note When making an API call, you may pass UpdateDatalakeRequest
|
1807
|
+
# data as a hash:
|
1808
|
+
#
|
1809
|
+
# {
|
1810
|
+
# configurations: { # required
|
1811
|
+
# "us-east-1" => {
|
1812
|
+
# encryption_key: "String",
|
1813
|
+
# replication_destination_regions: ["us-east-1"], # accepts us-east-1, us-west-2, eu-central-1, us-east-2, eu-west-1, ap-northeast-1, ap-southeast-2
|
1814
|
+
# replication_role_arn: "RoleArn",
|
1815
|
+
# retention_settings: [
|
1816
|
+
# {
|
1817
|
+
# retention_period: 1,
|
1818
|
+
# storage_class: "STANDARD_IA", # accepts STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER_IR, GLACIER, DEEP_ARCHIVE, EXPIRE
|
1819
|
+
# },
|
1820
|
+
# ],
|
1821
|
+
# tags_map: {
|
1822
|
+
# "String" => "String",
|
1823
|
+
# },
|
1824
|
+
# },
|
1825
|
+
# },
|
1826
|
+
# }
|
1827
|
+
#
|
1828
|
+
# @!attribute [rw] configurations
|
1829
|
+
# The configuration object
|
1830
|
+
# @return [Hash<String,Types::LakeConfigurationRequest>]
|
1831
|
+
#
|
1832
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/UpdateDatalakeRequest AWS API Documentation
|
1833
|
+
#
|
1834
|
+
class UpdateDatalakeRequest < Struct.new(
|
1835
|
+
:configurations)
|
1836
|
+
SENSITIVE = []
|
1837
|
+
include Aws::Structure
|
1838
|
+
end
|
1839
|
+
|
1840
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/UpdateDatalakeResponse AWS API Documentation
|
1841
|
+
#
|
1842
|
+
class UpdateDatalakeResponse < Aws::EmptyStructure; end
|
1843
|
+
|
1844
|
+
# @note When making an API call, you may pass UpdateSubscriberRequest
|
1845
|
+
# data as a hash:
|
1846
|
+
#
|
1847
|
+
# {
|
1848
|
+
# external_id: "SafeString",
|
1849
|
+
# id: "String", # required
|
1850
|
+
# source_types: [
|
1851
|
+
# {
|
1852
|
+
# aws_source_type: "ROUTE53", # accepts ROUTE53, VPC_FLOW, CLOUD_TRAIL, SH_FINDINGS
|
1853
|
+
# custom_source_type: "CustomSourceType",
|
1854
|
+
# },
|
1855
|
+
# ],
|
1856
|
+
# subscriber_description: "SafeString",
|
1857
|
+
# subscriber_name: "UpdateSubscriberRequestSubscriberNameString",
|
1858
|
+
# }
|
1859
|
+
#
|
1860
|
+
# @!attribute [rw] external_id
|
1861
|
+
# External ID of the Security Lake account.
|
1862
|
+
# @return [String]
|
1863
|
+
#
|
1864
|
+
# @!attribute [rw] id
|
1865
|
+
# A value created by Security Lake that uniquely identifies your
|
1866
|
+
# `UpdateSubscriber` API request.
|
1867
|
+
# @return [String]
|
1868
|
+
#
|
1869
|
+
# @!attribute [rw] source_types
|
1870
|
+
# The supported Amazon Web Services services from which logs and
|
1871
|
+
# events are collected. Amazon Security Lake supports logs and events
|
1872
|
+
# collection for the following natively-supported Amazon Web Services
|
1873
|
+
# services. For more information, see the Amazon Security Lake User
|
1874
|
+
# Guide.
|
1875
|
+
# @return [Array<Types::SourceType>]
|
1876
|
+
#
|
1877
|
+
# @!attribute [rw] subscriber_description
|
1878
|
+
# Description of the Security Lake account subscriber.
|
1879
|
+
# @return [String]
|
1880
|
+
#
|
1881
|
+
# @!attribute [rw] subscriber_name
|
1882
|
+
# Name of the Security Lake account subscriber.
|
1883
|
+
# @return [String]
|
1884
|
+
#
|
1885
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/UpdateSubscriberRequest AWS API Documentation
|
1886
|
+
#
|
1887
|
+
class UpdateSubscriberRequest < Struct.new(
|
1888
|
+
:external_id,
|
1889
|
+
:id,
|
1890
|
+
:source_types,
|
1891
|
+
:subscriber_description,
|
1892
|
+
:subscriber_name)
|
1893
|
+
SENSITIVE = []
|
1894
|
+
include Aws::Structure
|
1895
|
+
end
|
1896
|
+
|
1897
|
+
# @!attribute [rw] subscriber
|
1898
|
+
# The account subscriber in Amazon Security Lake.
|
1899
|
+
# @return [Types::SubscriberResource]
|
1900
|
+
#
|
1901
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/UpdateSubscriberResponse AWS API Documentation
|
1902
|
+
#
|
1903
|
+
class UpdateSubscriberResponse < Struct.new(
|
1904
|
+
:subscriber)
|
1905
|
+
SENSITIVE = []
|
1906
|
+
include Aws::Structure
|
1907
|
+
end
|
1908
|
+
|
1909
|
+
# @note When making an API call, you may pass UpdateSubscriptionNotificationConfigurationRequest
|
1910
|
+
# data as a hash:
|
1911
|
+
#
|
1912
|
+
# {
|
1913
|
+
# create_sqs: false,
|
1914
|
+
# https_api_key_name: "String",
|
1915
|
+
# https_api_key_value: "String",
|
1916
|
+
# https_method: "POST", # accepts POST, PUT
|
1917
|
+
# role_arn: "RoleArn",
|
1918
|
+
# subscription_endpoint: "UpdateSubscriptionNotificationConfigurationRequestSubscriptionEndpointString",
|
1919
|
+
# subscription_id: "UUID", # required
|
1920
|
+
# }
|
1921
|
+
#
|
1922
|
+
# @!attribute [rw] create_sqs
|
1923
|
+
# Create a new subscription notification for the specified
|
1924
|
+
# subscription ID in Security Lake.
|
1925
|
+
# @return [Boolean]
|
1926
|
+
#
|
1927
|
+
# @!attribute [rw] https_api_key_name
|
1928
|
+
# The key name for the subscription notification.
|
1929
|
+
# @return [String]
|
1930
|
+
#
|
1931
|
+
# @!attribute [rw] https_api_key_value
|
1932
|
+
# The key value for the subscription notification.
|
1933
|
+
# @return [String]
|
1934
|
+
#
|
1935
|
+
# @!attribute [rw] https_method
|
1936
|
+
# The HTTPS method used for the subscription notification.
|
1937
|
+
# @return [String]
|
1938
|
+
#
|
1939
|
+
# @!attribute [rw] role_arn
|
1940
|
+
# The Amazon Resource Name (ARN) specifying the role of the
|
1941
|
+
# subscriber.
|
1942
|
+
# @return [String]
|
1943
|
+
#
|
1944
|
+
# @!attribute [rw] subscription_endpoint
|
1945
|
+
# The subscription endpoint in Security Lake.
|
1946
|
+
# @return [String]
|
1947
|
+
#
|
1948
|
+
# @!attribute [rw] subscription_id
|
1949
|
+
# The subscription ID for which the subscription notification is
|
1950
|
+
# specified.
|
1951
|
+
# @return [String]
|
1952
|
+
#
|
1953
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/UpdateSubscriptionNotificationConfigurationRequest AWS API Documentation
|
1954
|
+
#
|
1955
|
+
class UpdateSubscriptionNotificationConfigurationRequest < Struct.new(
|
1956
|
+
:create_sqs,
|
1957
|
+
:https_api_key_name,
|
1958
|
+
:https_api_key_value,
|
1959
|
+
:https_method,
|
1960
|
+
:role_arn,
|
1961
|
+
:subscription_endpoint,
|
1962
|
+
:subscription_id)
|
1963
|
+
SENSITIVE = []
|
1964
|
+
include Aws::Structure
|
1965
|
+
end
|
1966
|
+
|
1967
|
+
# @!attribute [rw] queue_arn
|
1968
|
+
# Returns the Amazon resource name (ARN) of the queue.
|
1969
|
+
# @return [String]
|
1970
|
+
#
|
1971
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/UpdateSubscriptionNotificationConfigurationResponse AWS API Documentation
|
1972
|
+
#
|
1973
|
+
class UpdateSubscriptionNotificationConfigurationResponse < Struct.new(
|
1974
|
+
:queue_arn)
|
1975
|
+
SENSITIVE = []
|
1976
|
+
include Aws::Structure
|
1977
|
+
end
|
1978
|
+
|
1979
|
+
# Your signing certificate could not be validated.
|
1980
|
+
#
|
1981
|
+
# @!attribute [rw] field_list
|
1982
|
+
# The list of parameters that failed to validate.
|
1983
|
+
# @return [Array<Types::ValidationExceptionField>]
|
1984
|
+
#
|
1985
|
+
# @!attribute [rw] message
|
1986
|
+
# @return [String]
|
1987
|
+
#
|
1988
|
+
# @!attribute [rw] reason
|
1989
|
+
# The reason for the validation exception.
|
1990
|
+
# @return [String]
|
1991
|
+
#
|
1992
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/ValidationException AWS API Documentation
|
1993
|
+
#
|
1994
|
+
class ValidationException < Struct.new(
|
1995
|
+
:field_list,
|
1996
|
+
:message,
|
1997
|
+
:reason)
|
1998
|
+
SENSITIVE = []
|
1999
|
+
include Aws::Structure
|
2000
|
+
end
|
2001
|
+
|
2002
|
+
# The input fails to meet the constraints specified in Amazon Security
|
2003
|
+
# Lake
|
2004
|
+
#
|
2005
|
+
# @!attribute [rw] message
|
2006
|
+
# Describes the error encountered.
|
2007
|
+
# @return [String]
|
2008
|
+
#
|
2009
|
+
# @!attribute [rw] name
|
2010
|
+
# Name of the validation exception.
|
2011
|
+
# @return [String]
|
2012
|
+
#
|
2013
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/ValidationExceptionField AWS API Documentation
|
2014
|
+
#
|
2015
|
+
class ValidationExceptionField < Struct.new(
|
2016
|
+
:message,
|
2017
|
+
:name)
|
2018
|
+
SENSITIVE = []
|
2019
|
+
include Aws::Structure
|
2020
|
+
end
|
2021
|
+
|
2022
|
+
end
|
2023
|
+
end
|