aws-sdk-securitylake 1.0.0 → 1.1.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.
@@ -28,7 +28,7 @@ module Aws::SecurityLake
28
28
  include Aws::Structure
29
29
  end
30
30
 
31
- # Amazon Security Lake can't find an Amazon Web Services account with
31
+ # Amazon Security Lake cannot find an Amazon Web Services account with
32
32
  # the accountID that you specified, or the account whose credentials you
33
33
  # used to make this request isn't a member of an organization.
34
34
  #
@@ -43,12 +43,16 @@ module Aws::SecurityLake
43
43
  include Aws::Structure
44
44
  end
45
45
 
46
- # Security Lake can collect logs and events from supported Amazon Web
47
- # Services services and custom sources.
46
+ # Amazon Security Lake collects logs and events from supported Amazon
47
+ # Web Services and custom sources. For the list of supported Amazon Web
48
+ # Services, see the [Amazon Security Lake User Guide][1].
49
+ #
50
+ #
51
+ #
52
+ # [1]: https://docs.aws.amazon.com/security-lake/latest/userguide/internal-sources.html
48
53
  #
49
54
  # @!attribute [rw] account
50
- # Account ID of the Security Lake account for which logs are
51
- # collected.
55
+ # The ID of the Security Lake account for which logs are collected.
52
56
  # @return [String]
53
57
  #
54
58
  # @!attribute [rw] event_class
@@ -56,14 +60,13 @@ module Aws::SecurityLake
56
60
  # @return [String]
57
61
  #
58
62
  # @!attribute [rw] logs_status
59
- # Log status for the Security Lake account.
63
+ # The log status for the Security Lake account.
60
64
  # @return [Array<Types::LogsStatus>]
61
65
  #
62
66
  # @!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
+ # The supported Amazon Web Services from which logs and events are
68
+ # collected. Amazon Security Lake supports log and event collection
69
+ # for natively supported Amazon Web Services.
67
70
  # @return [String]
68
71
  #
69
72
  # @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/AccountSources AWS API Documentation
@@ -78,23 +81,16 @@ module Aws::SecurityLake
78
81
  end
79
82
 
80
83
  # 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
- # }
84
+ # an Amazon Security Lake administrator account.
90
85
  #
91
86
  # @!attribute [rw] region
92
- # The Regions where Security Lake is auto enabled
87
+ # The Amazon Web Services Regions where Security Lake is automatically
88
+ # enabled.
93
89
  # @return [String]
94
90
  #
95
91
  # @!attribute [rw] sources
96
- # The Amazon Web Services sources which are auto enabled in Security
97
- # Lake.
92
+ # The Amazon Web Services sources that are automatically enabled in
93
+ # Security Lake.
98
94
  # @return [Array<String>]
99
95
  #
100
96
  # @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/AutoEnableNewRegionConfiguration AWS API Documentation
@@ -187,37 +183,24 @@ module Aws::SecurityLake
187
183
  include Aws::Structure
188
184
  end
189
185
 
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
186
  # @!attribute [rw] enable_all_dimensions
207
- # Enables specific sources in all Regions and source types.
187
+ # Enables data collection from specific Amazon Web Services sources in
188
+ # all specific accounts and specific Regions.
208
189
  # @return [Hash<String,Hash<String,Array<String>>>]
209
190
  #
210
191
  # @!attribute [rw] enable_single_dimension
211
- # Enables all sources in specific accounts or Regions.
192
+ # Enables data collection from all Amazon Web Services sources in
193
+ # specific accounts or Regions.
212
194
  # @return [Array<String>]
213
195
  #
214
196
  # @!attribute [rw] enable_two_dimensions
215
- # Enables specific service sources in specific accounts or Regions.
197
+ # Enables data collection from specific Amazon Web Services sources in
198
+ # specific accounts or Regions.
216
199
  # @return [Hash<String,Array<String>>]
217
200
  #
218
201
  # @!attribute [rw] input_order
219
202
  # Specifies the input order to enable dimensions in Security Lake,
220
- # namely region, source type, and member account.
203
+ # namely Region, source type, and member account.
221
204
  # @return [Array<String>]
222
205
  #
223
206
  # @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/CreateAwsLogSourceRequest AWS API Documentation
@@ -232,14 +215,14 @@ module Aws::SecurityLake
232
215
  end
233
216
 
234
217
  # @!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.
218
+ # Lists all accounts in which enabling a natively supported Amazon Web
219
+ # Service as a Security Lake source failed. The failure occurred as
220
+ # these accounts are not part of an organization.
238
221
  # @return [Array<String>]
239
222
  #
240
223
  # @!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.
224
+ # Lists the accounts that are in the process of enabling a natively
225
+ # supported Amazon Web Service as a Security Lake source.
243
226
  # @return [Array<String>]
244
227
  #
245
228
  # @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/CreateAwsLogSourceResponse AWS API Documentation
@@ -251,36 +234,30 @@ module Aws::SecurityLake
251
234
  include Aws::Structure
252
235
  end
253
236
 
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
237
  # @!attribute [rw] custom_source_name
265
- # The custom source name for a third-party custom source.
238
+ # The name for a third-party custom source. This must be a Regionally
239
+ # unique value.
266
240
  # @return [String]
267
241
  #
268
242
  # @!attribute [rw] event_class
269
- # The Open Cybersecurity Schema Framework (OCSF) event class.
243
+ # The Open Cybersecurity Schema Framework (OCSF) event class which
244
+ # describes the type of data that the custom source will send to
245
+ # Security Lake.
270
246
  # @return [String]
271
247
  #
272
248
  # @!attribute [rw] glue_invocation_role_arn
273
- # The IAM Role ARN to be used by the Glue Crawler. The recommended IAM
249
+ # The Amazon Resource Name (ARN) of the Identity and Access Management
250
+ # (IAM) role to be used by the Glue crawler. The recommended IAM
274
251
  # policies are:
275
252
  #
276
253
  # * The managed policy `AWSGlueServiceRole`
277
254
  #
278
- # * A custom policy granting access to your S3 Data Lake
255
+ # * A custom policy granting access to your Amazon S3 Data Lake
279
256
  # @return [String]
280
257
  #
281
258
  # @!attribute [rw] log_provider_account_id
282
- # The Account ID that will assume the above Role to put logs into the
283
- # Data Lake.
259
+ # The Amazon Web Services account ID of the custom source that will
260
+ # write logs and events into the Amazon S3 Data Lake.
284
261
  # @return [String]
285
262
  #
286
263
  # @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/CreateCustomLogSourceRequest AWS API Documentation
@@ -295,7 +272,8 @@ module Aws::SecurityLake
295
272
  end
296
273
 
297
274
  # @!attribute [rw] custom_data_location
298
- # The location of the partition in the Security Lake S3 bucket.
275
+ # The location of the partition in the Amazon S3 bucket for Security
276
+ # Lake.
299
277
  # @return [String]
300
278
  #
301
279
  # @!attribute [rw] glue_crawler_name
@@ -312,12 +290,12 @@ module Aws::SecurityLake
312
290
  # @return [String]
313
291
  #
314
292
  # @!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.
293
+ # The ARN of the IAM role to be used by the entity putting logs into
294
+ # your custom source partition. Security Lake will apply the correct
295
+ # access policies to this role, but you must first manually create the
296
+ # trust policy for this role. The IAM role name must start with the
297
+ # text 'Security Lake'. The IAM role must trust the
298
+ # `logProviderAccountId` to assume the role.
321
299
  # @return [String]
322
300
  #
323
301
  # @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/CreateCustomLogSourceResponse AWS API Documentation
@@ -332,22 +310,10 @@ module Aws::SecurityLake
332
310
  include Aws::Structure
333
311
  end
334
312
 
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
313
  # @!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.
314
+ # Enable Security Lake with the specified configuration settings to
315
+ # begin collecting security data for new accounts in your
316
+ # organization.
351
317
  # @return [Array<Types::AutoEnableNewRegionConfiguration>]
352
318
  #
353
319
  # @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/CreateDatalakeAutoEnableRequest AWS API Documentation
@@ -362,15 +328,9 @@ module Aws::SecurityLake
362
328
  #
363
329
  class CreateDatalakeAutoEnableResponse < Aws::EmptyStructure; end
364
330
 
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
331
  # @!attribute [rw] account
373
- # Account ID of the Security Lake delegated administrator.
332
+ # The Amazon Web Services account ID of the Security Lake delegated
333
+ # administrator.
374
334
  # @return [String]
375
335
  #
376
336
  # @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/CreateDatalakeDelegatedAdminRequest AWS API Documentation
@@ -385,21 +345,14 @@ module Aws::SecurityLake
385
345
  #
386
346
  class CreateDatalakeDelegatedAdminResponse < Aws::EmptyStructure; end
387
347
 
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
348
  # @!attribute [rw] notification_endpoint
397
- # The account in which the exception notifications subscription is
398
- # created.
349
+ # The Amazon Web Services account where you want to receive exception
350
+ # notifications.
399
351
  # @return [String]
400
352
  #
401
353
  # @!attribute [rw] subscription_protocol
402
- # The subscription protocol to which exception messages are posted.
354
+ # The subscription protocol to which exception notifications are
355
+ # posted.
403
356
  # @return [String]
404
357
  #
405
358
  # @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/CreateDatalakeExceptionsSubscriptionRequest AWS API Documentation
@@ -415,57 +368,31 @@ module Aws::SecurityLake
415
368
  #
416
369
  class CreateDatalakeExceptionsSubscriptionResponse < Aws::EmptyStructure; end
417
370
 
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
371
  # @!attribute [rw] configurations
444
- # Enable Security Lake with the specified configurations settings to
445
- # begin ingesting security data.
372
+ # Specify the Region or Regions that will contribute data to the
373
+ # rollup region.
446
374
  # @return [Hash<String,Types::LakeConfigurationRequest>]
447
375
  #
448
376
  # @!attribute [rw] enable_all
449
- # Enable Security Lake in all Regions to begin ingesting security
450
- # data.
377
+ # Enable Security Lake in all Regions.
451
378
  # @return [Boolean]
452
379
  #
453
380
  # @!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.
381
+ # The Amazon Resource Name (ARN) used to create and update the Glue
382
+ # table. This table contains partitions generated by the ingestion and
383
+ # normalization of Amazon Web Services log sources and custom sources.
457
384
  # @return [String]
458
385
  #
459
386
  # @!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.
387
+ # Enable Security Lake in the specified Regions. To enable Security
388
+ # Lake in specific Amazon Web Services Regions, such as us-east-1 or
389
+ # ap-northeast-3, provide the Region codes. For a list of Region
390
+ # codes, see [Amazon Security Lake endpoints][1] in the Amazon Web
391
+ # Services General Reference.
465
392
  #
466
393
  #
467
394
  #
468
- # [1]: https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints
395
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/securitylake.html
469
396
  # @return [Array<String>]
470
397
  #
471
398
  # @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/CreateDatalakeRequest AWS API Documentation
@@ -483,52 +410,33 @@ module Aws::SecurityLake
483
410
  #
484
411
  class CreateDatalakeResponse < Aws::EmptyStructure; end
485
412
 
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
413
  # @!attribute [rw] access_types
504
414
  # The Amazon S3 or Lake Formation access type.
505
415
  # @return [Array<String>]
506
416
  #
507
417
  # @!attribute [rw] account_id
508
- # The third party Amazon Web Services account ID used to access your
509
- # data.
418
+ # The Amazon Web Services account ID used to access your data.
510
419
  # @return [String]
511
420
  #
512
421
  # @!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
422
+ # The external ID of the subscriber. This lets the user that is
423
+ # assuming the role assert the circumstances in which they are
515
424
  # operating. It also provides a way for the account owner to permit
516
425
  # the role to be assumed only under specific circumstances.
517
426
  # @return [String]
518
427
  #
519
428
  # @!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.
429
+ # The supported Amazon Web Services from which logs and events are
430
+ # collected. Security Lake supports log and event collection for
431
+ # natively supported Amazon Web Services.
523
432
  # @return [Array<Types::SourceType>]
524
433
  #
525
434
  # @!attribute [rw] subscriber_description
526
- # The subscriber descriptions for the subscriber account in Amazon
527
- # Security Lake.
435
+ # The description for your subscriber account in Security Lake.
528
436
  # @return [String]
529
437
  #
530
438
  # @!attribute [rw] subscriber_name
531
- # The name of your Amazon Security Lake subscriber account.
439
+ # The name of your Security Lake subscriber account.
532
440
  # @return [String]
533
441
  #
534
442
  # @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/CreateSubscriberRequest AWS API Documentation
@@ -545,23 +453,26 @@ module Aws::SecurityLake
545
453
  end
546
454
 
547
455
  # @!attribute [rw] role_arn
548
- # The Amazon Resource Name (ARN) created by the user to provide to the
456
+ # The Amazon Resource Name (ARN) created by you to provide to the
549
457
  # subscriber. For more information about ARNs and how to use them in
550
- # policies, see IAM identifiers in the IAM User Guide.
458
+ # policies, see [IAM identifiers in the Identity and Access Management
459
+ # (IAM) User Guide][1]. .
460
+ #
461
+ #
462
+ #
463
+ # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html
551
464
  # @return [String]
552
465
  #
553
466
  # @!attribute [rw] s3_bucket_arn
554
- # The Amazon Resource Name (ARN) for the Amazon S3 bucket.
467
+ # The ARN for the Amazon S3 bucket.
555
468
  # @return [String]
556
469
  #
557
470
  # @!attribute [rw] sns_arn
558
- # The Amazon Resource Name (ARN) for the Amazon Simple Notification
559
- # Service.
471
+ # The ARN for the Amazon Simple Notification Service.
560
472
  # @return [String]
561
473
  #
562
474
  # @!attribute [rw] subscription_id
563
- # The `subscriptionId` that was created by the `CreateSubscriber` API
564
- # call.
475
+ # The `subscriptionId` created by the `CreateSubscriber` API call.
565
476
  # @return [String]
566
477
  #
567
478
  # @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/CreateSubscriberResponse AWS API Documentation
@@ -575,48 +486,34 @@ module Aws::SecurityLake
575
486
  include Aws::Structure
576
487
  end
577
488
 
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
489
  # @!attribute [rw] create_sqs
592
- # Create a new subscription notification for the specified
593
- # subscription ID in Security Lake.
490
+ # Create an Amazon Simple Queue Service queue.
594
491
  # @return [Boolean]
595
492
  #
596
493
  # @!attribute [rw] https_api_key_name
597
- # The key name for the subscription notification.
494
+ # The key name for the notification subscription.
598
495
  # @return [String]
599
496
  #
600
497
  # @!attribute [rw] https_api_key_value
601
- # The key value for the subscription notification.
498
+ # The key value for the notification subscription.
602
499
  # @return [String]
603
500
  #
604
501
  # @!attribute [rw] https_method
605
- # The HTTPS method used for the subscription notification.
502
+ # The HTTPS method used for the notification subscription.
606
503
  # @return [String]
607
504
  #
608
505
  # @!attribute [rw] role_arn
609
- # The Amazon Resource Name (ARN) specifying the role of the
610
- # subscriber.
506
+ # The Amazon Resource Name (ARN) of the EventBridge API destinations
507
+ # IAM role that you created.
611
508
  # @return [String]
612
509
  #
613
510
  # @!attribute [rw] subscription_endpoint
614
- # The subscription endpoint in Security Lake.
511
+ # The subscription endpoint in Security Lake. If you prefer
512
+ # notification with an HTTPs endpoint, populate this field.
615
513
  # @return [String]
616
514
  #
617
515
  # @!attribute [rw] subscription_id
618
- # The subscription ID for which the subscription notification is
619
- # specified.
516
+ # The subscription ID for the notification subscription/
620
517
  # @return [String]
621
518
  #
622
519
  # @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/CreateSubscriptionNotificationConfigurationRequest AWS API Documentation
@@ -634,7 +531,7 @@ module Aws::SecurityLake
634
531
  end
635
532
 
636
533
  # @!attribute [rw] queue_arn
637
- # Returns the Amazon resource name (ARN) of the queue.
534
+ # Returns the Amazon Resource Name (ARN) of the queue.
638
535
  # @return [String]
639
536
  #
640
537
  # @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/CreateSubscriptionNotificationConfigurationResponse AWS API Documentation
@@ -645,25 +542,9 @@ module Aws::SecurityLake
645
542
  include Aws::Structure
646
543
  end
647
544
 
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
545
  # @!attribute [rw] disable_all_dimensions
665
- # Removes the specific Amazon Web Services sources from all Regions
666
- # and source types.
546
+ # Removes the specific Amazon Web Services sources from specific
547
+ # accounts and specific Regions.
667
548
  # @return [Hash<String,Hash<String,Array<String>>>]
668
549
  #
669
550
  # @!attribute [rw] disable_single_dimension
@@ -677,8 +558,10 @@ module Aws::SecurityLake
677
558
  # @return [Hash<String,Array<String>>]
678
559
  #
679
560
  # @!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.
561
+ # This is a mandatory input. Specify the input order to disable
562
+ # dimensions in Security Lake, namely Region (Amazon Web Services
563
+ # Region code, source type, and member (account ID of a specific
564
+ # Amazon Web Services account).
682
565
  # @return [Array<String>]
683
566
  #
684
567
  # @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/DeleteAwsLogSourceRequest AWS API Documentation
@@ -698,7 +581,7 @@ module Aws::SecurityLake
698
581
  # @return [Array<String>]
699
582
  #
700
583
  # @!attribute [rw] processing
701
- # Deletion of the Amazon Web Services sources is in-progress.
584
+ # Deletion of the Amazon Web Services sources is in progress.
702
585
  # @return [Array<String>]
703
586
  #
704
587
  # @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/DeleteAwsLogSourceResponse AWS API Documentation
@@ -710,15 +593,8 @@ module Aws::SecurityLake
710
593
  include Aws::Structure
711
594
  end
712
595
 
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
596
  # @!attribute [rw] custom_source_name
721
- # The custom source name for the custome log source.
597
+ # The custom source name for the custom log source.
722
598
  # @return [String]
723
599
  #
724
600
  # @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/DeleteCustomLogSourceRequest AWS API Documentation
@@ -730,7 +606,8 @@ module Aws::SecurityLake
730
606
  end
731
607
 
732
608
  # @!attribute [rw] custom_data_location
733
- # The location of the partition in the Security Lake S3 bucket.
609
+ # The location of the partition in the Amazon S3 bucket for Security
610
+ # Lake.
734
611
  # @return [String]
735
612
  #
736
613
  # @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/DeleteCustomLogSourceResponse AWS API Documentation
@@ -741,20 +618,8 @@ module Aws::SecurityLake
741
618
  include Aws::Structure
742
619
  end
743
620
 
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
621
  # @!attribute [rw] remove_from_configuration_for_new_accounts
757
- # Delete Amazon Security Lake with the specified configurations
622
+ # Delete Amazon Security Lake with the specified configuration
758
623
  # settings to stop ingesting security data for new accounts in
759
624
  # Security Lake.
760
625
  # @return [Array<Types::AutoEnableNewRegionConfiguration>]
@@ -771,15 +636,8 @@ module Aws::SecurityLake
771
636
  #
772
637
  class DeleteDatalakeAutoEnableResponse < Aws::EmptyStructure; end
773
638
 
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
639
  # @!attribute [rw] account
782
- # Account ID the Security Lake delegated administrator.
640
+ # The account ID the Security Lake delegated administrator.
783
641
  # @return [String]
784
642
  #
785
643
  # @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/DeleteDatalakeDelegatedAdminRequest AWS API Documentation
@@ -823,13 +681,6 @@ module Aws::SecurityLake
823
681
  #
824
682
  class DeleteDatalakeResponse < Aws::EmptyStructure; end
825
683
 
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
684
  # @!attribute [rw] id
834
685
  # A value created by Security Lake that uniquely identifies your
835
686
  # `DeleteSubscriber` API request.
@@ -847,15 +698,8 @@ module Aws::SecurityLake
847
698
  #
848
699
  class DeleteSubscriberResponse < Aws::EmptyStructure; end
849
700
 
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
701
  # @!attribute [rw] subscription_id
858
- # The subscription ID of the Amazon Security Lake subscriber account.
702
+ # The ID of the Security Lake subscriber account.
859
703
  # @return [String]
860
704
  #
861
705
  # @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/DeleteSubscriptionNotificationConfigurationRequest AWS API Documentation
@@ -909,7 +753,7 @@ module Aws::SecurityLake
909
753
  include Aws::Structure
910
754
  end
911
755
 
912
- # Response element for actions which make changes namely create, update,
756
+ # Response element for actions that make changes, namely create, update,
913
757
  # or delete actions.
914
758
  #
915
759
  # @!attribute [rw] failures
@@ -917,7 +761,7 @@ module Aws::SecurityLake
917
761
  # @return [Array<Types::Failures>]
918
762
  #
919
763
  # @!attribute [rw] region
920
- # List of Regions where the failure occurred.
764
+ # List of Amazon Web Services Regions where the failure occurred.
921
765
  # @return [String]
922
766
  #
923
767
  # @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/FailuresResponse AWS API Documentation
@@ -1001,33 +845,26 @@ module Aws::SecurityLake
1001
845
  include Aws::Structure
1002
846
  end
1003
847
 
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
848
  # @!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.
849
+ # The Amazon Web Services account ID for which a static snapshot of
850
+ # the current Amazon Web Services Region, including enabled accounts
851
+ # and log sources, is retrieved.
1016
852
  # @return [Array<String>]
1017
853
  #
1018
854
  # @!attribute [rw] max_account_results
1019
855
  # The maximum limit of accounts for which the static snapshot of the
1020
- # current Region including enabled accounts and log sources is
856
+ # current Region, including enabled accounts and log sources, is
1021
857
  # retrieved.
1022
858
  # @return [Integer]
1023
859
  #
1024
860
  # @!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.
861
+ # Lists if there are more results available. The value of nextToken is
862
+ # a unique pagination token for each page. Repeat the call using the
863
+ # returned token to retrieve the next page. Keep all other arguments
864
+ # unchanged.
865
+ #
866
+ # Each pagination token expires after 24 hours. Using an expired
867
+ # pagination token will return an HTTP 400 InvalidToken error.
1031
868
  # @return [String]
1032
869
  #
1033
870
  # @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/GetDatalakeStatusRequest AWS API Documentation
@@ -1045,12 +882,13 @@ module Aws::SecurityLake
1045
882
  # @return [Array<Types::AccountSources>]
1046
883
  #
1047
884
  # @!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.
885
+ # Lists if there are more results available. The value of nextToken is
886
+ # a unique pagination token for each page. Repeat the call using the
887
+ # returned token to retrieve the next page. Keep all other arguments
888
+ # unchanged.
889
+ #
890
+ # Each pagination token expires after 24 hours. Using an expired
891
+ # pagination token will return an HTTP 400 InvalidToken error.
1054
892
  # @return [String]
1055
893
  #
1056
894
  # @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/GetDatalakeStatusResponse AWS API Documentation
@@ -1062,16 +900,9 @@ module Aws::SecurityLake
1062
900
  include Aws::Structure
1063
901
  end
1064
902
 
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
903
  # @!attribute [rw] id
1073
- # A value created by Security Lake that uniquely identifies your
1074
- # `GetSubscriber` API request.
904
+ # A value created by Amazon Security Lake that uniquely identifies
905
+ # your `GetSubscriber` API request.
1075
906
  # @return [String]
1076
907
  #
1077
908
  # @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/GetSubscriberRequest AWS API Documentation
@@ -1083,7 +914,7 @@ module Aws::SecurityLake
1083
914
  end
1084
915
 
1085
916
  # @!attribute [rw] subscriber
1086
- # Subscription information for the specified subscription ID
917
+ # The subscription information for the specified subscription ID.
1087
918
  # @return [Types::SubscriberResource]
1088
919
  #
1089
920
  # @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/GetSubscriberResponse AWS API Documentation
@@ -1113,8 +944,8 @@ module Aws::SecurityLake
1113
944
  include Aws::Structure
1114
945
  end
1115
946
 
1116
- # The request was rejected because an invalid or out-of-range value was
1117
- # supplied for an input parameter.
947
+ # The request was rejected because a value that's not valid or is out
948
+ # of range was supplied for an input parameter.
1118
949
  #
1119
950
  # @!attribute [rw] message
1120
951
  # @return [String]
@@ -1127,29 +958,11 @@ module Aws::SecurityLake
1127
958
  include Aws::Structure
1128
959
  end
1129
960
 
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
- # }
961
+ # Provides details of Amazon Security Lake configuration object.
1149
962
  #
1150
963
  # @!attribute [rw] encryption_key
1151
- # The type of encryption key used by Security Lake to encrypt the lake
1152
- # configuration object.
964
+ # The type of encryption key used by Amazon Security Lake to encrypt
965
+ # the Security Lake configuration object.
1153
966
  # @return [String]
1154
967
  #
1155
968
  # @!attribute [rw] replication_destination_regions
@@ -1167,8 +980,9 @@ module Aws::SecurityLake
1167
980
  #
1168
981
  # @!attribute [rw] replication_role_arn
1169
982
  # 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.
983
+ # the Identity and Access Management (IAM) role you created that is
984
+ # managed by Security Lake, to ensure the replication setting is
985
+ # correct.
1172
986
  # @return [String]
1173
987
  #
1174
988
  # @!attribute [rw] retention_settings
@@ -1193,19 +1007,19 @@ module Aws::SecurityLake
1193
1007
  include Aws::Structure
1194
1008
  end
1195
1009
 
1196
- # Provides details of lake configuration object in Amazon Security Lake.
1010
+ # Provides details of Amazon Security Lake lake configuration object.
1197
1011
  #
1198
1012
  # @!attribute [rw] encryption_key
1199
- # The type of encryption key used by Security Lake to encrypt the lake
1200
- # configuration
1013
+ # The type of encryption key used by secure the Security Lake
1014
+ # configuration object.
1201
1015
  # @return [String]
1202
1016
  #
1203
1017
  # @!attribute [rw] replication_destination_regions
1204
1018
  # Replication enables automatic, asynchronous copying of objects
1205
1019
  # 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
1020
+ # object replication can be owned by the same Amazon Web Services
1021
+ # account or by different accounts. You can replicate objects to a
1022
+ # single destination bucket or to multiple destination buckets. The
1209
1023
  # destination buckets can be in different Amazon Web Services Regions
1210
1024
  # or within the same Region as the source bucket.
1211
1025
  #
@@ -1215,8 +1029,8 @@ module Aws::SecurityLake
1215
1029
  #
1216
1030
  # @!attribute [rw] replication_role_arn
1217
1031
  # 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.
1032
+ # the IAM role you created that is managed by Security Lake, to ensure
1033
+ # the replication setting is correct.
1220
1034
  # @return [String]
1221
1035
  #
1222
1036
  # @!attribute [rw] retention_settings
@@ -1256,27 +1070,23 @@ module Aws::SecurityLake
1256
1070
  include Aws::Structure
1257
1071
  end
1258
1072
 
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
1073
  # @!attribute [rw] max_failures
1269
1074
  # List the maximum number of failures in Security Lake.
1270
1075
  # @return [Integer]
1271
1076
  #
1272
1077
  # @!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
1078
+ # List if there are more results available. The value of nextToken is
1079
+ # a unique pagination token for each page. Repeat the call using the
1080
+ # returned token to retrieve the next page. Keep all other arguments
1081
+ # unchanged.
1082
+ #
1083
+ # Each pagination token expires after 24 hours. Using an expired
1084
+ # pagination token will return an HTTP 400 InvalidToken error.
1276
1085
  # @return [String]
1277
1086
  #
1278
1087
  # @!attribute [rw] region_set
1279
- # List the regions from which exceptions are retrieved.
1088
+ # List the Amazon Web Services Regions from which exceptions are
1089
+ # retrieved.
1280
1090
  # @return [Array<String>]
1281
1091
  #
1282
1092
  # @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/ListDatalakeExceptionsRequest AWS API Documentation
@@ -1290,13 +1100,17 @@ module Aws::SecurityLake
1290
1100
  end
1291
1101
 
1292
1102
  # @!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
1103
+ # List if there are more results available. The value of nextToken is
1104
+ # a unique pagination token for each page. Repeat the call using the
1105
+ # returned token to retrieve the next page. Keep all other arguments
1106
+ # unchanged.
1107
+ #
1108
+ # Each pagination token expires after 24 hours. Using an expired
1109
+ # pagination token will return an HTTP 400 InvalidToken error.
1296
1110
  # @return [String]
1297
1111
  #
1298
1112
  # @!attribute [rw] non_retryable_failures
1299
- # Lists the non-retryable failures in the current region.
1113
+ # Lists the failures that cannot be retried in the current Region.
1300
1114
  # @return [Array<Types::FailuresResponse>]
1301
1115
  #
1302
1116
  # @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/ListDatalakeExceptionsResponse AWS API Documentation
@@ -1308,54 +1122,37 @@ module Aws::SecurityLake
1308
1122
  include Aws::Structure
1309
1123
  end
1310
1124
 
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
1125
  # @!attribute [rw] input_order
1330
1126
  # Lists the log sources in input order, namely Region, source type,
1331
1127
  # and member account.
1332
1128
  # @return [Array<String>]
1333
1129
  #
1334
1130
  # @!attribute [rw] list_all_dimensions
1335
- # List the view of log sources for enabled Security Lake accounts in
1336
- # all Regions and source types.
1131
+ # List the view of log sources for enabled Amazon Security Lake
1132
+ # accounts for specific Amazon Web Services sources from specific
1133
+ # accounts and specific Regions.
1337
1134
  # @return [Hash<String,Hash<String,Array<String>>>]
1338
1135
  #
1339
1136
  # @!attribute [rw] list_single_dimension
1340
1137
  # List the view of log sources for enabled Security Lake accounts for
1341
- # the entire region.
1138
+ # all Amazon Web Services sources from specific accounts or specific
1139
+ # Regions.
1342
1140
  # @return [Array<String>]
1343
1141
  #
1344
1142
  # @!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.
1143
+ # Lists the view of log sources for enabled Security Lake accounts for
1144
+ # specific Amazon Web Services sources from specific accounts or
1145
+ # specific Regions.
1348
1146
  # @return [Hash<String,Array<String>>]
1349
1147
  #
1350
1148
  # @!attribute [rw] max_results
1351
- # The maximum number of accounts for which the configuration is
1149
+ # The maximum number of accounts for which the log sources are
1352
1150
  # displayed.
1353
1151
  # @return [Integer]
1354
1152
  #
1355
1153
  # @!attribute [rw] next_token
1356
1154
  # 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.
1155
+ # repeat the call using the returned token to retrieve the next page.
1359
1156
  # @return [String]
1360
1157
  #
1361
1158
  # @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/ListLogSourcesRequest AWS API Documentation
@@ -1373,13 +1170,11 @@ module Aws::SecurityLake
1373
1170
 
1374
1171
  # @!attribute [rw] next_token
1375
1172
  # 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.
1173
+ # repeat the call using the returned token to retrieve the next page.
1378
1174
  # @return [String]
1379
1175
  #
1380
1176
  # @!attribute [rw] region_source_types_accounts_list
1381
- # Lists the log sources in the Regions for enabled Security Lake
1382
- # accounts.
1177
+ # Lists the log sources by Regions for enabled Security Lake accounts.
1383
1178
  # @return [Array<Hash<String,Hash<String,Array<String>>>>]
1384
1179
  #
1385
1180
  # @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/ListLogSourcesResponse AWS API Documentation
@@ -1391,14 +1186,6 @@ module Aws::SecurityLake
1391
1186
  include Aws::Structure
1392
1187
  end
1393
1188
 
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
1189
  # @!attribute [rw] max_results
1403
1190
  # The maximum number of accounts for which the configuration is
1404
1191
  # displayed.
@@ -1406,8 +1193,7 @@ module Aws::SecurityLake
1406
1193
  #
1407
1194
  # @!attribute [rw] next_token
1408
1195
  # 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.
1196
+ # repeat the call using the returned token to retrieve the next page.
1411
1197
  # @return [String]
1412
1198
  #
1413
1199
  # @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/ListSubscribersRequest AWS API Documentation
@@ -1421,12 +1207,12 @@ module Aws::SecurityLake
1421
1207
 
1422
1208
  # @!attribute [rw] next_token
1423
1209
  # 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.
1210
+ # repeat the call using the returned token to retrieve the next page.
1426
1211
  # @return [String]
1427
1212
  #
1428
1213
  # @!attribute [rw] subscribers
1429
- # The subscribers available in the specified Security Lake account ID.
1214
+ # The subscribers available for the specified Security Lake account
1215
+ # ID.
1430
1216
  # @return [Array<Types::SubscriberResource>]
1431
1217
  #
1432
1218
  # @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/ListSubscribersResponse AWS API Documentation
@@ -1438,10 +1224,10 @@ module Aws::SecurityLake
1438
1224
  include Aws::Structure
1439
1225
  end
1440
1226
 
1441
- # Log status for the Security Lake account.
1227
+ # Retrieves the Logs status for the Amazon Security Lake account.
1442
1228
  #
1443
1229
  # @!attribute [rw] health_status
1444
- # Health status of services including error codes and patterns.
1230
+ # The health status of services, including error codes and patterns.
1445
1231
  # @return [String]
1446
1232
  #
1447
1233
  # @!attribute [rw] path_to_logs
@@ -1458,11 +1244,11 @@ module Aws::SecurityLake
1458
1244
  include Aws::Structure
1459
1245
  end
1460
1246
 
1461
- # Notifications in Security Lake which dictates how notifications are
1462
- # posted at the endpoint.
1247
+ # Protocol used in Amazon Security Lake that dictates how notifications
1248
+ # are posted at the endpoint.
1463
1249
  #
1464
1250
  # @!attribute [rw] endpoint
1465
- # The account which is subscribed to receive exception notifications.
1251
+ # The account that is subscribed to receive exception notifications.
1466
1252
  # @return [String]
1467
1253
  #
1468
1254
  # @!attribute [rw] protocol
@@ -1502,21 +1288,13 @@ module Aws::SecurityLake
1502
1288
  include Aws::Structure
1503
1289
  end
1504
1290
 
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
- # }
1291
+ # Retention settings for the destination Amazon S3 buckets in Amazon
1292
+ # Security Lake.
1515
1293
  #
1516
1294
  # @!attribute [rw] retention_period
1517
1295
  # The retention period specifies a fixed period of time during which
1518
1296
  # the Security Lake object remains locked. You can specify the
1519
- # retention period for one or more source in days.
1297
+ # retention period in days for one or more sources.
1520
1298
  # @return [Integer]
1521
1299
  #
1522
1300
  # @!attribute [rw] storage_class
@@ -1535,10 +1313,9 @@ module Aws::SecurityLake
1535
1313
 
1536
1314
  # Provides an extension of the AmazonServiceException for errors
1537
1315
  # 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.
1316
+ # class provides access to the Amazon S3 extended request ID. If Amazon
1317
+ # S3 is incorrectly handling a request and you need to contact Amazon,
1318
+ # this extended request ID may provide useful debugging information.
1542
1319
  #
1543
1320
  # @!attribute [rw] message
1544
1321
  # @return [String]
@@ -1588,20 +1365,24 @@ module Aws::SecurityLake
1588
1365
  end
1589
1366
 
1590
1367
  # The supported source types from which logs and events are collected in
1591
- # Amazon Security Lake.
1368
+ # Amazon Security Lake. For the list of supported Amazon Web Services,
1369
+ # see the [Amazon Security Lake User Guide][1].
1370
+ #
1371
+ #
1372
+ #
1373
+ # [1]: https://docs.aws.amazon.com/security-lake/latest/userguide/internal-sources.html
1592
1374
  #
1593
1375
  # @note SourceType is a union - when making an API calls you must set exactly one of the members.
1594
1376
  #
1595
1377
  # @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
1378
  #
1597
1379
  # @!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.
1380
+ # Amazon Security Lake supports log and event collection for natively
1381
+ # supported Amazon Web Services.
1601
1382
  # @return [String]
1602
1383
  #
1603
1384
  # @!attribute [rw] custom_source_type
1604
- # Amazon Security Lake supports custom source types. For the detailed
1385
+ # Amazon Security Lake supports custom source types. For a detailed
1605
1386
  # list, see the Amazon Security Lake User Guide.
1606
1387
  # @return [String]
1607
1388
  #
@@ -1620,9 +1401,9 @@ module Aws::SecurityLake
1620
1401
  class Unknown < SourceType; end
1621
1402
  end
1622
1403
 
1623
- # Provides details of the Amazon Security Lake account subscription.
1404
+ # Provides details about the Amazon Security Lake account subscription.
1624
1405
  # Subscribers are notified of new objects for a source as the data is
1625
- # written to your Amazon Security Lake S3 bucket.
1406
+ # written to your Amazon S3 bucket for Security Lake.
1626
1407
  #
1627
1408
  # @!attribute [rw] access_types
1628
1409
  # You can choose to notify subscribers of new objects with an Amazon
@@ -1630,13 +1411,13 @@ module Aws::SecurityLake
1630
1411
  # HTTPS endpoint provided by the subscriber.
1631
1412
  #
1632
1413
  # 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`.
1414
+ # tables in your Amazon S3 bucket through services like Amazon Athena.
1415
+ # This subscription type is defined as `LAKEFORMATION`.
1635
1416
  # @return [Array<String>]
1636
1417
  #
1637
1418
  # @!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.
1419
+ # The Amazon Web Services account ID you are using to create your
1420
+ # Amazon Security Lake account.
1640
1421
  # @return [String]
1641
1422
  #
1642
1423
  # @!attribute [rw] created_at
@@ -1644,8 +1425,8 @@ module Aws::SecurityLake
1644
1425
  # @return [Time]
1645
1426
  #
1646
1427
  # @!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
1428
+ # The external ID of the subscriber. The external ID lets the user
1429
+ # that is assuming the role assert the circumstances in which they are
1649
1430
  # operating. It also provides a way for the account owner to permit
1650
1431
  # the role to be assumed only under specific circumstances.
1651
1432
  # @return [String]
@@ -1656,18 +1437,17 @@ module Aws::SecurityLake
1656
1437
  # @return [String]
1657
1438
  #
1658
1439
  # @!attribute [rw] s3_bucket_arn
1659
- # The Amazon Resource Name (ARN) for the Amazon S3 bucket.
1440
+ # The ARN for the Amazon S3 bucket.
1660
1441
  # @return [String]
1661
1442
  #
1662
1443
  # @!attribute [rw] sns_arn
1663
- # The Amazon Resource Name (ARN) for the Amazon Simple Notification
1664
- # Service.
1444
+ # The ARN for the Amazon Simple Notification Service.
1665
1445
  # @return [String]
1666
1446
  #
1667
1447
  # @!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.
1448
+ # Amazon Security Lake supports log and event collection for natively
1449
+ # supported Amazon Web Services. For more information, see the Amazon
1450
+ # Security Lake User Guide.
1671
1451
  # @return [Array<Types::SourceType>]
1672
1452
  #
1673
1453
  # @!attribute [rw] subscriber_description
@@ -1693,7 +1473,8 @@ module Aws::SecurityLake
1693
1473
  # @return [String]
1694
1474
  #
1695
1475
  # @!attribute [rw] subscription_status
1696
- # Subscription status of the Amazon Security Lake subscriber account.
1476
+ # The subscription status of the Amazon Security Lake subscriber
1477
+ # account.
1697
1478
  # @return [String]
1698
1479
  #
1699
1480
  # @!attribute [rw] updated_at
@@ -1751,13 +1532,6 @@ module Aws::SecurityLake
1751
1532
  include Aws::Structure
1752
1533
  end
1753
1534
 
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
1535
  # @!attribute [rw] exception_message_expiry
1762
1536
  # The time-to-live (TTL) for the exception message to remain.
1763
1537
  # @return [Integer]
@@ -1774,16 +1548,8 @@ module Aws::SecurityLake
1774
1548
  #
1775
1549
  class UpdateDatalakeExceptionsExpiryResponse < Aws::EmptyStructure; end
1776
1550
 
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
1551
  # @!attribute [rw] notification_endpoint
1786
- # The account which is subscribed to receive exception notifications.
1552
+ # The account that is subscribed to receive exception notifications.
1787
1553
  # @return [String]
1788
1554
  #
1789
1555
  # @!attribute [rw] subscription_protocol
@@ -1803,30 +1569,9 @@ module Aws::SecurityLake
1803
1569
  #
1804
1570
  class UpdateDatalakeExceptionsSubscriptionResponse < Aws::EmptyStructure; end
1805
1571
 
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
1572
  # @!attribute [rw] configurations
1829
- # The configuration object
1573
+ # Specify the Region or Regions that will contribute data to the
1574
+ # rollup region.
1830
1575
  # @return [Hash<String,Types::LakeConfigurationRequest>]
1831
1576
  #
1832
1577
  # @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/UpdateDatalakeRequest AWS API Documentation
@@ -1841,45 +1586,31 @@ module Aws::SecurityLake
1841
1586
  #
1842
1587
  class UpdateDatalakeResponse < Aws::EmptyStructure; end
1843
1588
 
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
1589
  # @!attribute [rw] external_id
1861
- # External ID of the Security Lake account.
1590
+ # The external ID of the Security Lake account.
1862
1591
  # @return [String]
1863
1592
  #
1864
1593
  # @!attribute [rw] id
1865
1594
  # A value created by Security Lake that uniquely identifies your
1866
- # `UpdateSubscriber` API request.
1595
+ # subscription.
1867
1596
  # @return [String]
1868
1597
  #
1869
1598
  # @!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.
1599
+ # The supported Amazon Web Services from which logs and events are
1600
+ # collected. For the list of supported Amazon Web Services, see the
1601
+ # [Amazon Security Lake User Guide][1].
1602
+ #
1603
+ #
1604
+ #
1605
+ # [1]: https://docs.aws.amazon.com/security-lake/latest/userguide/internal-sources.html
1875
1606
  # @return [Array<Types::SourceType>]
1876
1607
  #
1877
1608
  # @!attribute [rw] subscriber_description
1878
- # Description of the Security Lake account subscriber.
1609
+ # The description of the Security Lake account subscriber.
1879
1610
  # @return [String]
1880
1611
  #
1881
1612
  # @!attribute [rw] subscriber_name
1882
- # Name of the Security Lake account subscriber.
1613
+ # The name of the Security Lake account subscriber.
1883
1614
  # @return [String]
1884
1615
  #
1885
1616
  # @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/UpdateSubscriberRequest AWS API Documentation
@@ -1895,7 +1626,7 @@ module Aws::SecurityLake
1895
1626
  end
1896
1627
 
1897
1628
  # @!attribute [rw] subscriber
1898
- # The account subscriber in Amazon Security Lake.
1629
+ # The account of the subscriber.
1899
1630
  # @return [Types::SubscriberResource]
1900
1631
  #
1901
1632
  # @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/UpdateSubscriberResponse AWS API Documentation
@@ -1906,22 +1637,9 @@ module Aws::SecurityLake
1906
1637
  include Aws::Structure
1907
1638
  end
1908
1639
 
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
1640
  # @!attribute [rw] create_sqs
1923
1641
  # Create a new subscription notification for the specified
1924
- # subscription ID in Security Lake.
1642
+ # subscription ID in Amazon Security Lake.
1925
1643
  # @return [Boolean]
1926
1644
  #
1927
1645
  # @!attribute [rw] https_api_key_name
@@ -1965,7 +1683,7 @@ module Aws::SecurityLake
1965
1683
  end
1966
1684
 
1967
1685
  # @!attribute [rw] queue_arn
1968
- # Returns the Amazon resource name (ARN) of the queue.
1686
+ # Returns the ARN of the queue.
1969
1687
  # @return [String]
1970
1688
  #
1971
1689
  # @see http://docs.aws.amazon.com/goto/WebAPI/securitylake-2018-05-10/UpdateSubscriptionNotificationConfigurationResponse AWS API Documentation
@@ -2000,7 +1718,7 @@ module Aws::SecurityLake
2000
1718
  end
2001
1719
 
2002
1720
  # The input fails to meet the constraints specified in Amazon Security
2003
- # Lake
1721
+ # Lake.
2004
1722
  #
2005
1723
  # @!attribute [rw] message
2006
1724
  # Describes the error encountered.