securitylake.d.ts 68 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201
  1. import {Request} from '../lib/request';
  2. import {Response} from '../lib/response';
  3. import {AWSError} from '../lib/error';
  4. import {Service} from '../lib/service';
  5. import {ServiceConfigurationOptions} from '../lib/service';
  6. import {ConfigBase as Config} from '../lib/config-base';
  7. interface Blob {}
  8. declare class SecurityLake extends Service {
  9. /**
  10. * Constructs a service object. This object has one method for each API operation.
  11. */
  12. constructor(options?: SecurityLake.Types.ClientConfiguration)
  13. config: Config & SecurityLake.Types.ClientConfiguration;
  14. /**
  15. * Adds a natively supported Amazon Web Service as an Amazon Security Lake source. Enables source types for member accounts in required Amazon Web Services Regions, based on the parameters you specify. You can choose any source type in any Region for either accounts that are part of a trusted organization or standalone accounts. Once you add an Amazon Web Service as a source, Security Lake starts collecting logs and events from it. You can use this API only to enable natively supported Amazon Web Services as a source. Use CreateCustomLogSource to enable data collection from a custom source.
  16. */
  17. createAwsLogSource(params: SecurityLake.Types.CreateAwsLogSourceRequest, callback?: (err: AWSError, data: SecurityLake.Types.CreateAwsLogSourceResponse) => void): Request<SecurityLake.Types.CreateAwsLogSourceResponse, AWSError>;
  18. /**
  19. * Adds a natively supported Amazon Web Service as an Amazon Security Lake source. Enables source types for member accounts in required Amazon Web Services Regions, based on the parameters you specify. You can choose any source type in any Region for either accounts that are part of a trusted organization or standalone accounts. Once you add an Amazon Web Service as a source, Security Lake starts collecting logs and events from it. You can use this API only to enable natively supported Amazon Web Services as a source. Use CreateCustomLogSource to enable data collection from a custom source.
  20. */
  21. createAwsLogSource(callback?: (err: AWSError, data: SecurityLake.Types.CreateAwsLogSourceResponse) => void): Request<SecurityLake.Types.CreateAwsLogSourceResponse, AWSError>;
  22. /**
  23. * Adds a third-party custom source in Amazon Security Lake, from the Amazon Web Services Region where you want to create a custom source. Security Lake can collect logs and events from third-party custom sources. After creating the appropriate IAM role to invoke Glue crawler, use this API to add a custom source name in Security Lake. This operation creates a partition in the Amazon S3 bucket for Security Lake as the target location for log files from the custom source. In addition, this operation also creates an associated Glue table and an Glue crawler.
  24. */
  25. createCustomLogSource(params: SecurityLake.Types.CreateCustomLogSourceRequest, callback?: (err: AWSError, data: SecurityLake.Types.CreateCustomLogSourceResponse) => void): Request<SecurityLake.Types.CreateCustomLogSourceResponse, AWSError>;
  26. /**
  27. * Adds a third-party custom source in Amazon Security Lake, from the Amazon Web Services Region where you want to create a custom source. Security Lake can collect logs and events from third-party custom sources. After creating the appropriate IAM role to invoke Glue crawler, use this API to add a custom source name in Security Lake. This operation creates a partition in the Amazon S3 bucket for Security Lake as the target location for log files from the custom source. In addition, this operation also creates an associated Glue table and an Glue crawler.
  28. */
  29. createCustomLogSource(callback?: (err: AWSError, data: SecurityLake.Types.CreateCustomLogSourceResponse) => void): Request<SecurityLake.Types.CreateCustomLogSourceResponse, AWSError>;
  30. /**
  31. * Initializes an Amazon Security Lake instance with the provided (or default) configuration. You can enable Security Lake in Amazon Web Services Regions with customized settings before enabling log collection in Regions. To specify particular Regions, configure these Regions using the configurations parameter. If you have already enabled Security Lake in a Region when you call this command, the command will update the Region if you provide new configuration parameters. If you have not already enabled Security Lake in the Region when you call this API, it will set up the data lake in the Region with the specified configurations. When you enable Security Lake, it starts ingesting security data after the CreateAwsLogSource call. This includes ingesting security data from sources, storing data, and making data accessible to subscribers. Security Lake also enables all the existing settings and resources that it stores or maintains for your Amazon Web Services account in the current Region, including security log and event data. For more information, see the Amazon Security Lake User Guide.
  32. */
  33. createDataLake(params: SecurityLake.Types.CreateDataLakeRequest, callback?: (err: AWSError, data: SecurityLake.Types.CreateDataLakeResponse) => void): Request<SecurityLake.Types.CreateDataLakeResponse, AWSError>;
  34. /**
  35. * Initializes an Amazon Security Lake instance with the provided (or default) configuration. You can enable Security Lake in Amazon Web Services Regions with customized settings before enabling log collection in Regions. To specify particular Regions, configure these Regions using the configurations parameter. If you have already enabled Security Lake in a Region when you call this command, the command will update the Region if you provide new configuration parameters. If you have not already enabled Security Lake in the Region when you call this API, it will set up the data lake in the Region with the specified configurations. When you enable Security Lake, it starts ingesting security data after the CreateAwsLogSource call. This includes ingesting security data from sources, storing data, and making data accessible to subscribers. Security Lake also enables all the existing settings and resources that it stores or maintains for your Amazon Web Services account in the current Region, including security log and event data. For more information, see the Amazon Security Lake User Guide.
  36. */
  37. createDataLake(callback?: (err: AWSError, data: SecurityLake.Types.CreateDataLakeResponse) => void): Request<SecurityLake.Types.CreateDataLakeResponse, AWSError>;
  38. /**
  39. * Creates the specified notification subscription in Amazon Security Lake for the organization you specify.
  40. */
  41. createDataLakeExceptionSubscription(params: SecurityLake.Types.CreateDataLakeExceptionSubscriptionRequest, callback?: (err: AWSError, data: SecurityLake.Types.CreateDataLakeExceptionSubscriptionResponse) => void): Request<SecurityLake.Types.CreateDataLakeExceptionSubscriptionResponse, AWSError>;
  42. /**
  43. * Creates the specified notification subscription in Amazon Security Lake for the organization you specify.
  44. */
  45. createDataLakeExceptionSubscription(callback?: (err: AWSError, data: SecurityLake.Types.CreateDataLakeExceptionSubscriptionResponse) => void): Request<SecurityLake.Types.CreateDataLakeExceptionSubscriptionResponse, AWSError>;
  46. /**
  47. * Automatically enables Amazon Security Lake for new member accounts in your organization. Security Lake is not automatically enabled for any existing member accounts in your organization.
  48. */
  49. createDataLakeOrganizationConfiguration(params: SecurityLake.Types.CreateDataLakeOrganizationConfigurationRequest, callback?: (err: AWSError, data: SecurityLake.Types.CreateDataLakeOrganizationConfigurationResponse) => void): Request<SecurityLake.Types.CreateDataLakeOrganizationConfigurationResponse, AWSError>;
  50. /**
  51. * Automatically enables Amazon Security Lake for new member accounts in your organization. Security Lake is not automatically enabled for any existing member accounts in your organization.
  52. */
  53. createDataLakeOrganizationConfiguration(callback?: (err: AWSError, data: SecurityLake.Types.CreateDataLakeOrganizationConfigurationResponse) => void): Request<SecurityLake.Types.CreateDataLakeOrganizationConfigurationResponse, AWSError>;
  54. /**
  55. * Creates a subscription permission for accounts that are already enabled in Amazon Security Lake. You can create a subscriber with access to data in the current Amazon Web Services Region.
  56. */
  57. createSubscriber(params: SecurityLake.Types.CreateSubscriberRequest, callback?: (err: AWSError, data: SecurityLake.Types.CreateSubscriberResponse) => void): Request<SecurityLake.Types.CreateSubscriberResponse, AWSError>;
  58. /**
  59. * Creates a subscription permission for accounts that are already enabled in Amazon Security Lake. You can create a subscriber with access to data in the current Amazon Web Services Region.
  60. */
  61. createSubscriber(callback?: (err: AWSError, data: SecurityLake.Types.CreateSubscriberResponse) => void): Request<SecurityLake.Types.CreateSubscriberResponse, AWSError>;
  62. /**
  63. * Notifies the subscriber when new data is written to the data lake for the sources that the subscriber consumes in Security Lake. You can create only one subscriber notification per subscriber.
  64. */
  65. createSubscriberNotification(params: SecurityLake.Types.CreateSubscriberNotificationRequest, callback?: (err: AWSError, data: SecurityLake.Types.CreateSubscriberNotificationResponse) => void): Request<SecurityLake.Types.CreateSubscriberNotificationResponse, AWSError>;
  66. /**
  67. * Notifies the subscriber when new data is written to the data lake for the sources that the subscriber consumes in Security Lake. You can create only one subscriber notification per subscriber.
  68. */
  69. createSubscriberNotification(callback?: (err: AWSError, data: SecurityLake.Types.CreateSubscriberNotificationResponse) => void): Request<SecurityLake.Types.CreateSubscriberNotificationResponse, AWSError>;
  70. /**
  71. * Removes a natively supported Amazon Web Service as an Amazon Security Lake source. You can remove a source for one or more Regions. When you remove the source, Security Lake stops collecting data from that source in the specified Regions and accounts, and subscribers can no longer consume new data from the source. However, subscribers can still consume data that Security Lake collected from the source before removal. You can choose any source type in any Amazon Web Services Region for either accounts that are part of a trusted organization or standalone accounts.
  72. */
  73. deleteAwsLogSource(params: SecurityLake.Types.DeleteAwsLogSourceRequest, callback?: (err: AWSError, data: SecurityLake.Types.DeleteAwsLogSourceResponse) => void): Request<SecurityLake.Types.DeleteAwsLogSourceResponse, AWSError>;
  74. /**
  75. * Removes a natively supported Amazon Web Service as an Amazon Security Lake source. You can remove a source for one or more Regions. When you remove the source, Security Lake stops collecting data from that source in the specified Regions and accounts, and subscribers can no longer consume new data from the source. However, subscribers can still consume data that Security Lake collected from the source before removal. You can choose any source type in any Amazon Web Services Region for either accounts that are part of a trusted organization or standalone accounts.
  76. */
  77. deleteAwsLogSource(callback?: (err: AWSError, data: SecurityLake.Types.DeleteAwsLogSourceResponse) => void): Request<SecurityLake.Types.DeleteAwsLogSourceResponse, AWSError>;
  78. /**
  79. * Removes a custom log source from Amazon Security Lake, to stop sending data from the custom source to Security Lake.
  80. */
  81. deleteCustomLogSource(params: SecurityLake.Types.DeleteCustomLogSourceRequest, callback?: (err: AWSError, data: SecurityLake.Types.DeleteCustomLogSourceResponse) => void): Request<SecurityLake.Types.DeleteCustomLogSourceResponse, AWSError>;
  82. /**
  83. * Removes a custom log source from Amazon Security Lake, to stop sending data from the custom source to Security Lake.
  84. */
  85. deleteCustomLogSource(callback?: (err: AWSError, data: SecurityLake.Types.DeleteCustomLogSourceResponse) => void): Request<SecurityLake.Types.DeleteCustomLogSourceResponse, AWSError>;
  86. /**
  87. * When you disable Amazon Security Lake from your account, Security Lake is disabled in all Amazon Web Services Regions and it stops collecting data from your sources. Also, this API automatically takes steps to remove the account from Security Lake. However, Security Lake retains all of your existing settings and the resources that it created in your Amazon Web Services account in the current Amazon Web Services Region. The DeleteDataLake operation does not delete the data that is stored in your Amazon S3 bucket, which is owned by your Amazon Web Services account. For more information, see the Amazon Security Lake User Guide.
  88. */
  89. deleteDataLake(params: SecurityLake.Types.DeleteDataLakeRequest, callback?: (err: AWSError, data: SecurityLake.Types.DeleteDataLakeResponse) => void): Request<SecurityLake.Types.DeleteDataLakeResponse, AWSError>;
  90. /**
  91. * When you disable Amazon Security Lake from your account, Security Lake is disabled in all Amazon Web Services Regions and it stops collecting data from your sources. Also, this API automatically takes steps to remove the account from Security Lake. However, Security Lake retains all of your existing settings and the resources that it created in your Amazon Web Services account in the current Amazon Web Services Region. The DeleteDataLake operation does not delete the data that is stored in your Amazon S3 bucket, which is owned by your Amazon Web Services account. For more information, see the Amazon Security Lake User Guide.
  92. */
  93. deleteDataLake(callback?: (err: AWSError, data: SecurityLake.Types.DeleteDataLakeResponse) => void): Request<SecurityLake.Types.DeleteDataLakeResponse, AWSError>;
  94. /**
  95. * Deletes the specified notification subscription in Amazon Security Lake for the organization you specify.
  96. */
  97. deleteDataLakeExceptionSubscription(params: SecurityLake.Types.DeleteDataLakeExceptionSubscriptionRequest, callback?: (err: AWSError, data: SecurityLake.Types.DeleteDataLakeExceptionSubscriptionResponse) => void): Request<SecurityLake.Types.DeleteDataLakeExceptionSubscriptionResponse, AWSError>;
  98. /**
  99. * Deletes the specified notification subscription in Amazon Security Lake for the organization you specify.
  100. */
  101. deleteDataLakeExceptionSubscription(callback?: (err: AWSError, data: SecurityLake.Types.DeleteDataLakeExceptionSubscriptionResponse) => void): Request<SecurityLake.Types.DeleteDataLakeExceptionSubscriptionResponse, AWSError>;
  102. /**
  103. * Turns off automatic enablement of Amazon Security Lake for member accounts that are added to an organization in Organizations. Only the delegated Security Lake administrator for an organization can perform this operation. If the delegated Security Lake administrator performs this operation, new member accounts won't automatically contribute data to the data lake.
  104. */
  105. deleteDataLakeOrganizationConfiguration(params: SecurityLake.Types.DeleteDataLakeOrganizationConfigurationRequest, callback?: (err: AWSError, data: SecurityLake.Types.DeleteDataLakeOrganizationConfigurationResponse) => void): Request<SecurityLake.Types.DeleteDataLakeOrganizationConfigurationResponse, AWSError>;
  106. /**
  107. * Turns off automatic enablement of Amazon Security Lake for member accounts that are added to an organization in Organizations. Only the delegated Security Lake administrator for an organization can perform this operation. If the delegated Security Lake administrator performs this operation, new member accounts won't automatically contribute data to the data lake.
  108. */
  109. deleteDataLakeOrganizationConfiguration(callback?: (err: AWSError, data: SecurityLake.Types.DeleteDataLakeOrganizationConfigurationResponse) => void): Request<SecurityLake.Types.DeleteDataLakeOrganizationConfigurationResponse, AWSError>;
  110. /**
  111. * Deletes the subscription permission and all notification settings for accounts that are already enabled in Amazon Security Lake. When you run DeleteSubscriber, the subscriber will no longer consume data from Security Lake and the subscriber is removed. This operation deletes the subscriber and removes access to data in the current Amazon Web Services Region.
  112. */
  113. deleteSubscriber(params: SecurityLake.Types.DeleteSubscriberRequest, callback?: (err: AWSError, data: SecurityLake.Types.DeleteSubscriberResponse) => void): Request<SecurityLake.Types.DeleteSubscriberResponse, AWSError>;
  114. /**
  115. * Deletes the subscription permission and all notification settings for accounts that are already enabled in Amazon Security Lake. When you run DeleteSubscriber, the subscriber will no longer consume data from Security Lake and the subscriber is removed. This operation deletes the subscriber and removes access to data in the current Amazon Web Services Region.
  116. */
  117. deleteSubscriber(callback?: (err: AWSError, data: SecurityLake.Types.DeleteSubscriberResponse) => void): Request<SecurityLake.Types.DeleteSubscriberResponse, AWSError>;
  118. /**
  119. * Deletes the specified notification subscription in Amazon Security Lake for the organization you specify.
  120. */
  121. deleteSubscriberNotification(params: SecurityLake.Types.DeleteSubscriberNotificationRequest, callback?: (err: AWSError, data: SecurityLake.Types.DeleteSubscriberNotificationResponse) => void): Request<SecurityLake.Types.DeleteSubscriberNotificationResponse, AWSError>;
  122. /**
  123. * Deletes the specified notification subscription in Amazon Security Lake for the organization you specify.
  124. */
  125. deleteSubscriberNotification(callback?: (err: AWSError, data: SecurityLake.Types.DeleteSubscriberNotificationResponse) => void): Request<SecurityLake.Types.DeleteSubscriberNotificationResponse, AWSError>;
  126. /**
  127. * Deletes the Amazon Security Lake delegated administrator account for the organization. This API can only be called by the organization management account. The organization management account cannot be the delegated administrator account.
  128. */
  129. deregisterDataLakeDelegatedAdministrator(params: SecurityLake.Types.DeregisterDataLakeDelegatedAdministratorRequest, callback?: (err: AWSError, data: SecurityLake.Types.DeregisterDataLakeDelegatedAdministratorResponse) => void): Request<SecurityLake.Types.DeregisterDataLakeDelegatedAdministratorResponse, AWSError>;
  130. /**
  131. * Deletes the Amazon Security Lake delegated administrator account for the organization. This API can only be called by the organization management account. The organization management account cannot be the delegated administrator account.
  132. */
  133. deregisterDataLakeDelegatedAdministrator(callback?: (err: AWSError, data: SecurityLake.Types.DeregisterDataLakeDelegatedAdministratorResponse) => void): Request<SecurityLake.Types.DeregisterDataLakeDelegatedAdministratorResponse, AWSError>;
  134. /**
  135. * Retrieves the details of exception notifications for the account in Amazon Security Lake.
  136. */
  137. getDataLakeExceptionSubscription(params: SecurityLake.Types.GetDataLakeExceptionSubscriptionRequest, callback?: (err: AWSError, data: SecurityLake.Types.GetDataLakeExceptionSubscriptionResponse) => void): Request<SecurityLake.Types.GetDataLakeExceptionSubscriptionResponse, AWSError>;
  138. /**
  139. * Retrieves the details of exception notifications for the account in Amazon Security Lake.
  140. */
  141. getDataLakeExceptionSubscription(callback?: (err: AWSError, data: SecurityLake.Types.GetDataLakeExceptionSubscriptionResponse) => void): Request<SecurityLake.Types.GetDataLakeExceptionSubscriptionResponse, AWSError>;
  142. /**
  143. * Retrieves the configuration that will be automatically set up for accounts added to the organization after the organization has onboarded to Amazon Security Lake. This API does not take input parameters.
  144. */
  145. getDataLakeOrganizationConfiguration(params: SecurityLake.Types.GetDataLakeOrganizationConfigurationRequest, callback?: (err: AWSError, data: SecurityLake.Types.GetDataLakeOrganizationConfigurationResponse) => void): Request<SecurityLake.Types.GetDataLakeOrganizationConfigurationResponse, AWSError>;
  146. /**
  147. * Retrieves the configuration that will be automatically set up for accounts added to the organization after the organization has onboarded to Amazon Security Lake. This API does not take input parameters.
  148. */
  149. getDataLakeOrganizationConfiguration(callback?: (err: AWSError, data: SecurityLake.Types.GetDataLakeOrganizationConfigurationResponse) => void): Request<SecurityLake.Types.GetDataLakeOrganizationConfigurationResponse, AWSError>;
  150. /**
  151. * Retrieves a snapshot of the current Region, including whether Amazon Security Lake is enabled for those accounts and which sources Security Lake is collecting data from.
  152. */
  153. getDataLakeSources(params: SecurityLake.Types.GetDataLakeSourcesRequest, callback?: (err: AWSError, data: SecurityLake.Types.GetDataLakeSourcesResponse) => void): Request<SecurityLake.Types.GetDataLakeSourcesResponse, AWSError>;
  154. /**
  155. * Retrieves a snapshot of the current Region, including whether Amazon Security Lake is enabled for those accounts and which sources Security Lake is collecting data from.
  156. */
  157. getDataLakeSources(callback?: (err: AWSError, data: SecurityLake.Types.GetDataLakeSourcesResponse) => void): Request<SecurityLake.Types.GetDataLakeSourcesResponse, AWSError>;
  158. /**
  159. * Retrieves the subscription information for the specified subscription ID. You can get information about a specific subscriber.
  160. */
  161. getSubscriber(params: SecurityLake.Types.GetSubscriberRequest, callback?: (err: AWSError, data: SecurityLake.Types.GetSubscriberResponse) => void): Request<SecurityLake.Types.GetSubscriberResponse, AWSError>;
  162. /**
  163. * Retrieves the subscription information for the specified subscription ID. You can get information about a specific subscriber.
  164. */
  165. getSubscriber(callback?: (err: AWSError, data: SecurityLake.Types.GetSubscriberResponse) => void): Request<SecurityLake.Types.GetSubscriberResponse, AWSError>;
  166. /**
  167. * Lists the Amazon Security Lake exceptions that you can use to find the source of problems and fix them.
  168. */
  169. listDataLakeExceptions(params: SecurityLake.Types.ListDataLakeExceptionsRequest, callback?: (err: AWSError, data: SecurityLake.Types.ListDataLakeExceptionsResponse) => void): Request<SecurityLake.Types.ListDataLakeExceptionsResponse, AWSError>;
  170. /**
  171. * Lists the Amazon Security Lake exceptions that you can use to find the source of problems and fix them.
  172. */
  173. listDataLakeExceptions(callback?: (err: AWSError, data: SecurityLake.Types.ListDataLakeExceptionsResponse) => void): Request<SecurityLake.Types.ListDataLakeExceptionsResponse, AWSError>;
  174. /**
  175. * Retrieves the Amazon Security Lake configuration object for the specified Amazon Web Services Regions. You can use this operation to determine whether Security Lake is enabled for a Region.
  176. */
  177. listDataLakes(params: SecurityLake.Types.ListDataLakesRequest, callback?: (err: AWSError, data: SecurityLake.Types.ListDataLakesResponse) => void): Request<SecurityLake.Types.ListDataLakesResponse, AWSError>;
  178. /**
  179. * Retrieves the Amazon Security Lake configuration object for the specified Amazon Web Services Regions. You can use this operation to determine whether Security Lake is enabled for a Region.
  180. */
  181. listDataLakes(callback?: (err: AWSError, data: SecurityLake.Types.ListDataLakesResponse) => void): Request<SecurityLake.Types.ListDataLakesResponse, AWSError>;
  182. /**
  183. * Retrieves the log sources in the current Amazon Web Services Region.
  184. */
  185. listLogSources(params: SecurityLake.Types.ListLogSourcesRequest, callback?: (err: AWSError, data: SecurityLake.Types.ListLogSourcesResponse) => void): Request<SecurityLake.Types.ListLogSourcesResponse, AWSError>;
  186. /**
  187. * Retrieves the log sources in the current Amazon Web Services Region.
  188. */
  189. listLogSources(callback?: (err: AWSError, data: SecurityLake.Types.ListLogSourcesResponse) => void): Request<SecurityLake.Types.ListLogSourcesResponse, AWSError>;
  190. /**
  191. * List all subscribers for the specific Amazon Security Lake account ID. You can retrieve a list of subscriptions associated with a specific organization or Amazon Web Services account.
  192. */
  193. listSubscribers(params: SecurityLake.Types.ListSubscribersRequest, callback?: (err: AWSError, data: SecurityLake.Types.ListSubscribersResponse) => void): Request<SecurityLake.Types.ListSubscribersResponse, AWSError>;
  194. /**
  195. * List all subscribers for the specific Amazon Security Lake account ID. You can retrieve a list of subscriptions associated with a specific organization or Amazon Web Services account.
  196. */
  197. listSubscribers(callback?: (err: AWSError, data: SecurityLake.Types.ListSubscribersResponse) => void): Request<SecurityLake.Types.ListSubscribersResponse, AWSError>;
  198. /**
  199. * Retrieves the tags (keys and values) that are associated with an Amazon Security Lake resource: a subscriber, or the data lake configuration for your Amazon Web Services account in a particular Amazon Web Services Region.
  200. */
  201. listTagsForResource(params: SecurityLake.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: SecurityLake.Types.ListTagsForResourceResponse) => void): Request<SecurityLake.Types.ListTagsForResourceResponse, AWSError>;
  202. /**
  203. * Retrieves the tags (keys and values) that are associated with an Amazon Security Lake resource: a subscriber, or the data lake configuration for your Amazon Web Services account in a particular Amazon Web Services Region.
  204. */
  205. listTagsForResource(callback?: (err: AWSError, data: SecurityLake.Types.ListTagsForResourceResponse) => void): Request<SecurityLake.Types.ListTagsForResourceResponse, AWSError>;
  206. /**
  207. * Designates the Amazon Security Lake delegated administrator account for the organization. This API can only be called by the organization management account. The organization management account cannot be the delegated administrator account.
  208. */
  209. registerDataLakeDelegatedAdministrator(params: SecurityLake.Types.RegisterDataLakeDelegatedAdministratorRequest, callback?: (err: AWSError, data: SecurityLake.Types.RegisterDataLakeDelegatedAdministratorResponse) => void): Request<SecurityLake.Types.RegisterDataLakeDelegatedAdministratorResponse, AWSError>;
  210. /**
  211. * Designates the Amazon Security Lake delegated administrator account for the organization. This API can only be called by the organization management account. The organization management account cannot be the delegated administrator account.
  212. */
  213. registerDataLakeDelegatedAdministrator(callback?: (err: AWSError, data: SecurityLake.Types.RegisterDataLakeDelegatedAdministratorResponse) => void): Request<SecurityLake.Types.RegisterDataLakeDelegatedAdministratorResponse, AWSError>;
  214. /**
  215. * Adds or updates one or more tags that are associated with an Amazon Security Lake resource: a subscriber, or the data lake configuration for your Amazon Web Services account in a particular Amazon Web Services Region. A tag is a label that you can define and associate with Amazon Web Services resources. Each tag consists of a required tag key and an associated tag value. A tag key is a general label that acts as a category for a more specific tag value. A tag value acts as a descriptor for a tag key. Tags can help you identify, categorize, and manage resources in different ways, such as by owner, environment, or other criteria. For more information, see Tagging Amazon Security Lake resources in the Amazon Security Lake User Guide.
  216. */
  217. tagResource(params: SecurityLake.Types.TagResourceRequest, callback?: (err: AWSError, data: SecurityLake.Types.TagResourceResponse) => void): Request<SecurityLake.Types.TagResourceResponse, AWSError>;
  218. /**
  219. * Adds or updates one or more tags that are associated with an Amazon Security Lake resource: a subscriber, or the data lake configuration for your Amazon Web Services account in a particular Amazon Web Services Region. A tag is a label that you can define and associate with Amazon Web Services resources. Each tag consists of a required tag key and an associated tag value. A tag key is a general label that acts as a category for a more specific tag value. A tag value acts as a descriptor for a tag key. Tags can help you identify, categorize, and manage resources in different ways, such as by owner, environment, or other criteria. For more information, see Tagging Amazon Security Lake resources in the Amazon Security Lake User Guide.
  220. */
  221. tagResource(callback?: (err: AWSError, data: SecurityLake.Types.TagResourceResponse) => void): Request<SecurityLake.Types.TagResourceResponse, AWSError>;
  222. /**
  223. * Removes one or more tags (keys and values) from an Amazon Security Lake resource: a subscriber, or the data lake configuration for your Amazon Web Services account in a particular Amazon Web Services Region.
  224. */
  225. untagResource(params: SecurityLake.Types.UntagResourceRequest, callback?: (err: AWSError, data: SecurityLake.Types.UntagResourceResponse) => void): Request<SecurityLake.Types.UntagResourceResponse, AWSError>;
  226. /**
  227. * Removes one or more tags (keys and values) from an Amazon Security Lake resource: a subscriber, or the data lake configuration for your Amazon Web Services account in a particular Amazon Web Services Region.
  228. */
  229. untagResource(callback?: (err: AWSError, data: SecurityLake.Types.UntagResourceResponse) => void): Request<SecurityLake.Types.UntagResourceResponse, AWSError>;
  230. /**
  231. * Specifies where to store your security data and for how long. You can add a rollup Region to consolidate data from multiple Amazon Web Services Regions.
  232. */
  233. updateDataLake(params: SecurityLake.Types.UpdateDataLakeRequest, callback?: (err: AWSError, data: SecurityLake.Types.UpdateDataLakeResponse) => void): Request<SecurityLake.Types.UpdateDataLakeResponse, AWSError>;
  234. /**
  235. * Specifies where to store your security data and for how long. You can add a rollup Region to consolidate data from multiple Amazon Web Services Regions.
  236. */
  237. updateDataLake(callback?: (err: AWSError, data: SecurityLake.Types.UpdateDataLakeResponse) => void): Request<SecurityLake.Types.UpdateDataLakeResponse, AWSError>;
  238. /**
  239. * Updates the specified notification subscription in Amazon Security Lake for the organization you specify.
  240. */
  241. updateDataLakeExceptionSubscription(params: SecurityLake.Types.UpdateDataLakeExceptionSubscriptionRequest, callback?: (err: AWSError, data: SecurityLake.Types.UpdateDataLakeExceptionSubscriptionResponse) => void): Request<SecurityLake.Types.UpdateDataLakeExceptionSubscriptionResponse, AWSError>;
  242. /**
  243. * Updates the specified notification subscription in Amazon Security Lake for the organization you specify.
  244. */
  245. updateDataLakeExceptionSubscription(callback?: (err: AWSError, data: SecurityLake.Types.UpdateDataLakeExceptionSubscriptionResponse) => void): Request<SecurityLake.Types.UpdateDataLakeExceptionSubscriptionResponse, AWSError>;
  246. /**
  247. * Updates an existing subscription for the given Amazon Security Lake account ID. You can update a subscriber by changing the sources that the subscriber consumes data from.
  248. */
  249. updateSubscriber(params: SecurityLake.Types.UpdateSubscriberRequest, callback?: (err: AWSError, data: SecurityLake.Types.UpdateSubscriberResponse) => void): Request<SecurityLake.Types.UpdateSubscriberResponse, AWSError>;
  250. /**
  251. * Updates an existing subscription for the given Amazon Security Lake account ID. You can update a subscriber by changing the sources that the subscriber consumes data from.
  252. */
  253. updateSubscriber(callback?: (err: AWSError, data: SecurityLake.Types.UpdateSubscriberResponse) => void): Request<SecurityLake.Types.UpdateSubscriberResponse, AWSError>;
  254. /**
  255. * Updates an existing notification method for the subscription (SQS or HTTPs endpoint) or switches the notification subscription endpoint for a subscriber.
  256. */
  257. updateSubscriberNotification(params: SecurityLake.Types.UpdateSubscriberNotificationRequest, callback?: (err: AWSError, data: SecurityLake.Types.UpdateSubscriberNotificationResponse) => void): Request<SecurityLake.Types.UpdateSubscriberNotificationResponse, AWSError>;
  258. /**
  259. * Updates an existing notification method for the subscription (SQS or HTTPs endpoint) or switches the notification subscription endpoint for a subscriber.
  260. */
  261. updateSubscriberNotification(callback?: (err: AWSError, data: SecurityLake.Types.UpdateSubscriberNotificationResponse) => void): Request<SecurityLake.Types.UpdateSubscriberNotificationResponse, AWSError>;
  262. }
  263. declare namespace SecurityLake {
  264. export type AccessType = "LAKEFORMATION"|"S3"|string;
  265. export type AccessTypeList = AccessType[];
  266. export type AccountList = AwsAccountId[];
  267. export type AmazonResourceName = string;
  268. export type AwsAccountId = string;
  269. export interface AwsIdentity {
  270. /**
  271. * The external ID used to estalish trust relationship with the AWS identity.
  272. */
  273. externalId: ExternalId;
  274. /**
  275. * The AWS identity principal.
  276. */
  277. principal: AwsPrincipal;
  278. }
  279. export interface AwsLogSourceConfiguration {
  280. /**
  281. * Specify the Amazon Web Services account information where you want to enable Security Lake.
  282. */
  283. accounts?: AccountList;
  284. /**
  285. * Specify the Regions where you want to enable Security Lake.
  286. */
  287. regions: RegionList;
  288. /**
  289. * The name for a Amazon Web Services source. This must be a Regionally unique value.
  290. */
  291. sourceName: AwsLogSourceName;
  292. /**
  293. * The version for a Amazon Web Services source. This must be a Regionally unique value.
  294. */
  295. sourceVersion?: AwsLogSourceVersion;
  296. }
  297. export type AwsLogSourceConfigurationList = AwsLogSourceConfiguration[];
  298. export type AwsLogSourceName = "ROUTE53"|"VPC_FLOW"|"SH_FINDINGS"|"CLOUD_TRAIL_MGMT"|"LAMBDA_EXECUTION"|"S3_DATA"|"EKS_AUDIT"|"WAF"|string;
  299. export interface AwsLogSourceResource {
  300. /**
  301. * The name for a Amazon Web Services source. This must be a Regionally unique value.
  302. */
  303. sourceName?: AwsLogSourceName;
  304. /**
  305. * The version for a Amazon Web Services source. This must be a Regionally unique value.
  306. */
  307. sourceVersion?: AwsLogSourceVersion;
  308. }
  309. export type AwsLogSourceResourceList = AwsLogSourceResource[];
  310. export type AwsLogSourceVersion = string;
  311. export type AwsPrincipal = string;
  312. export interface CreateAwsLogSourceRequest {
  313. /**
  314. * Specify the natively-supported Amazon Web Services service to add as a source in Security Lake.
  315. */
  316. sources: AwsLogSourceConfigurationList;
  317. }
  318. export interface CreateAwsLogSourceResponse {
  319. /**
  320. * Lists all accounts in which enabling a natively supported Amazon Web Service as a Security Lake source failed. The failure occurred as these accounts are not part of an organization.
  321. */
  322. failed?: AccountList;
  323. }
  324. export interface CreateCustomLogSourceRequest {
  325. /**
  326. * The configuration for the third-party custom source.
  327. */
  328. configuration: CustomLogSourceConfiguration;
  329. /**
  330. * The Open Cybersecurity Schema Framework (OCSF) event classes which describes the type of data that the custom source will send to Security Lake. The supported event classes are: 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 CONFIG_STATE INVENTORY_INFO EMAIL_ACTIVITY API_ACTIVITY CLOUD_API
  331. */
  332. eventClasses?: OcsfEventClassList;
  333. /**
  334. * Specify the name for a third-party custom source. This must be a Regionally unique value.
  335. */
  336. sourceName: CustomLogSourceName;
  337. /**
  338. * Specify the source version for the third-party custom source, to limit log collection to a specific version of custom data source.
  339. */
  340. sourceVersion?: CustomLogSourceVersion;
  341. }
  342. export interface CreateCustomLogSourceResponse {
  343. /**
  344. * The created third-party custom source.
  345. */
  346. source?: CustomLogSourceResource;
  347. }
  348. export interface CreateDataLakeExceptionSubscriptionRequest {
  349. /**
  350. * The expiration period and time-to-live (TTL).
  351. */
  352. exceptionTimeToLive?: CreateDataLakeExceptionSubscriptionRequestExceptionTimeToLiveLong;
  353. /**
  354. * The Amazon Web Services account where you want to receive exception notifications.
  355. */
  356. notificationEndpoint: SafeString;
  357. /**
  358. * The subscription protocol to which exception notifications are posted.
  359. */
  360. subscriptionProtocol: SubscriptionProtocol;
  361. }
  362. export type CreateDataLakeExceptionSubscriptionRequestExceptionTimeToLiveLong = number;
  363. export interface CreateDataLakeExceptionSubscriptionResponse {
  364. }
  365. export interface CreateDataLakeOrganizationConfigurationRequest {
  366. /**
  367. * Enable Security Lake with the specified configuration settings, to begin collecting security data for new accounts in your organization.
  368. */
  369. autoEnableNewAccount?: DataLakeAutoEnableNewAccountConfigurationList;
  370. }
  371. export interface CreateDataLakeOrganizationConfigurationResponse {
  372. }
  373. export interface CreateDataLakeRequest {
  374. /**
  375. * Specify the Region or Regions that will contribute data to the rollup region.
  376. */
  377. configurations: DataLakeConfigurationList;
  378. /**
  379. * The Amazon Resource Name (ARN) used to create and update the Glue table. This table contains partitions generated by the ingestion and normalization of Amazon Web Services log sources and custom sources.
  380. */
  381. metaStoreManagerRoleArn: RoleArn;
  382. /**
  383. * An array of objects, one for each tag to associate with the data lake configuration. For each tag, you must specify both a tag key and a tag value. A tag value cannot be null, but it can be an empty string.
  384. */
  385. tags?: TagList;
  386. }
  387. export interface CreateDataLakeResponse {
  388. /**
  389. * The created Security Lake configuration object.
  390. */
  391. dataLakes?: DataLakeResourceList;
  392. }
  393. export interface CreateSubscriberNotificationRequest {
  394. /**
  395. * Specify the configuration using which you want to create the subscriber notification.
  396. */
  397. configuration: NotificationConfiguration;
  398. /**
  399. * The subscriber ID for the notification subscription.
  400. */
  401. subscriberId: UUID;
  402. }
  403. export interface CreateSubscriberNotificationResponse {
  404. /**
  405. * The subscriber endpoint to which exception messages are posted.
  406. */
  407. subscriberEndpoint?: SafeString;
  408. }
  409. export interface CreateSubscriberRequest {
  410. /**
  411. * The Amazon S3 or Lake Formation access type.
  412. */
  413. accessTypes?: AccessTypeList;
  414. /**
  415. * The supported Amazon Web Services from which logs and events are collected. Security Lake supports log and event collection for natively supported Amazon Web Services.
  416. */
  417. sources: LogSourceResourceList;
  418. /**
  419. * The description for your subscriber account in Security Lake.
  420. */
  421. subscriberDescription?: DescriptionString;
  422. /**
  423. * The AWS identity used to access your data.
  424. */
  425. subscriberIdentity: AwsIdentity;
  426. /**
  427. * The name of your Security Lake subscriber account.
  428. */
  429. subscriberName: CreateSubscriberRequestSubscriberNameString;
  430. /**
  431. * An array of objects, one for each tag to associate with the subscriber. For each tag, you must specify both a tag key and a tag value. A tag value cannot be null, but it can be an empty string.
  432. */
  433. tags?: TagList;
  434. }
  435. export type CreateSubscriberRequestSubscriberNameString = string;
  436. export interface CreateSubscriberResponse {
  437. /**
  438. * Retrieve information about the subscriber created using the CreateSubscriber API.
  439. */
  440. subscriber?: SubscriberResource;
  441. }
  442. export interface CustomLogSourceAttributes {
  443. /**
  444. * The ARN of the Glue crawler.
  445. */
  446. crawlerArn?: AmazonResourceName;
  447. /**
  448. * The ARN of the Glue database where results are written, such as: arn:aws:daylight:us-east-1::database/sometable/*.
  449. */
  450. databaseArn?: AmazonResourceName;
  451. /**
  452. * The ARN of the Glue table.
  453. */
  454. tableArn?: AmazonResourceName;
  455. }
  456. export interface CustomLogSourceConfiguration {
  457. /**
  458. * The configuration for the Glue Crawler for the third-party custom source.
  459. */
  460. crawlerConfiguration: CustomLogSourceCrawlerConfiguration;
  461. /**
  462. * The identity of the log provider for the third-party custom source.
  463. */
  464. providerIdentity: AwsIdentity;
  465. }
  466. export interface CustomLogSourceCrawlerConfiguration {
  467. /**
  468. * The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to be used by the Glue crawler. The recommended IAM policies are: The managed policy AWSGlueServiceRole A custom policy granting access to your Amazon S3 Data Lake
  469. */
  470. roleArn: RoleArn;
  471. }
  472. export type CustomLogSourceName = string;
  473. export interface CustomLogSourceProvider {
  474. /**
  475. * The location of the partition in the Amazon S3 bucket for Security Lake.
  476. */
  477. location?: S3URI;
  478. /**
  479. * The ARN of the IAM role to be used by the entity putting logs into your custom source partition. Security Lake will apply the correct access policies to this role, but you must first manually create the trust policy for this role. The IAM role name must start with the text 'Security Lake'. The IAM role must trust the logProviderAccountId to assume the role.
  480. */
  481. roleArn?: RoleArn;
  482. }
  483. export interface CustomLogSourceResource {
  484. /**
  485. * The attributes of a third-party custom source.
  486. */
  487. attributes?: CustomLogSourceAttributes;
  488. /**
  489. * The details of the log provider for a third-party custom source.
  490. */
  491. provider?: CustomLogSourceProvider;
  492. /**
  493. * The name for a third-party custom source. This must be a Regionally unique value.
  494. */
  495. sourceName?: CustomLogSourceName;
  496. /**
  497. * The version for a third-party custom source. This must be a Regionally unique value.
  498. */
  499. sourceVersion?: CustomLogSourceVersion;
  500. }
  501. export type CustomLogSourceVersion = string;
  502. export interface DataLakeAutoEnableNewAccountConfiguration {
  503. /**
  504. * The Amazon Web Services Regions where Security Lake is automatically enabled.
  505. */
  506. region: Region;
  507. /**
  508. * The Amazon Web Services sources that are automatically enabled in Security Lake.
  509. */
  510. sources: AwsLogSourceResourceList;
  511. }
  512. export type DataLakeAutoEnableNewAccountConfigurationList = DataLakeAutoEnableNewAccountConfiguration[];
  513. export interface DataLakeConfiguration {
  514. /**
  515. * Provides encryption details of Amazon Security Lake object.
  516. */
  517. encryptionConfiguration?: DataLakeEncryptionConfiguration;
  518. /**
  519. * Provides lifecycle details of Amazon Security Lake object.
  520. */
  521. lifecycleConfiguration?: DataLakeLifecycleConfiguration;
  522. /**
  523. * The Amazon Web Services Regions where Security Lake is automatically enabled.
  524. */
  525. region: Region;
  526. /**
  527. * Provides replication details of Amazon Security Lake object.
  528. */
  529. replicationConfiguration?: DataLakeReplicationConfiguration;
  530. }
  531. export type DataLakeConfigurationList = DataLakeConfiguration[];
  532. export interface DataLakeEncryptionConfiguration {
  533. /**
  534. * The id of KMS encryption key used by Amazon Security Lake to encrypt the Security Lake object.
  535. */
  536. kmsKeyId?: String;
  537. }
  538. export interface DataLakeException {
  539. /**
  540. * The underlying exception of a Security Lake exception.
  541. */
  542. exception?: SafeString;
  543. /**
  544. * The Amazon Web Services Regions where the exception occurred.
  545. */
  546. region?: Region;
  547. /**
  548. * List of all remediation steps for a Security Lake exception.
  549. */
  550. remediation?: SafeString;
  551. /**
  552. * This error can occur if you configure the wrong timestamp format, or if the subset of entries used for validation had errors or missing values.
  553. */
  554. timestamp?: SyntheticTimestamp_date_time;
  555. }
  556. export type DataLakeExceptionList = DataLakeException[];
  557. export interface DataLakeLifecycleConfiguration {
  558. /**
  559. * Provides data expiration details of Amazon Security Lake object.
  560. */
  561. expiration?: DataLakeLifecycleExpiration;
  562. /**
  563. * Provides data storage transition details of Amazon Security Lake object.
  564. */
  565. transitions?: DataLakeLifecycleTransitionList;
  566. }
  567. export interface DataLakeLifecycleExpiration {
  568. /**
  569. * Number of days before data expires in the Amazon Security Lake object.
  570. */
  571. days?: DataLakeLifecycleExpirationDaysInteger;
  572. }
  573. export type DataLakeLifecycleExpirationDaysInteger = number;
  574. export interface DataLakeLifecycleTransition {
  575. /**
  576. * Number of days before data transitions to a different S3 Storage Class in the Amazon Security Lake object.
  577. */
  578. days?: DataLakeLifecycleTransitionDaysInteger;
  579. /**
  580. * The range of storage classes that you can choose from based on the data access, resiliency, and cost requirements of your workloads.
  581. */
  582. storageClass?: DataLakeStorageClass;
  583. }
  584. export type DataLakeLifecycleTransitionDaysInteger = number;
  585. export type DataLakeLifecycleTransitionList = DataLakeLifecycleTransition[];
  586. export interface DataLakeReplicationConfiguration {
  587. /**
  588. * Specifies one or more centralized rollup Regions. The Amazon Web Services Region specified in the region parameter of the CreateDataLake or UpdateDataLake operations contributes data to the rollup Region or Regions specified in this parameter. Replication enables automatic, asynchronous copying of objects across Amazon S3 buckets. S3 buckets that are configured for object replication can be owned by the same Amazon Web Services account or by different accounts. You can replicate objects to a single destination bucket or to multiple destination buckets. The destination buckets can be in different Regions or within the same Region as the source bucket.
  589. */
  590. regions?: RegionList;
  591. /**
  592. * Replication settings for the Amazon S3 buckets. This parameter uses the Identity and Access Management (IAM) role you created that is managed by Security Lake, to ensure the replication setting is correct.
  593. */
  594. roleArn?: RoleArn;
  595. }
  596. export interface DataLakeResource {
  597. /**
  598. * Retrieves the status of the configuration operation for an account in Amazon Security Lake.
  599. */
  600. createStatus?: DataLakeStatus;
  601. /**
  602. * The Amazon Resource Name (ARN) created by you to provide to the subscriber. For more information about ARNs and how to use them in policies, see the Amazon Security Lake User Guide.
  603. */
  604. dataLakeArn: AmazonResourceName;
  605. /**
  606. * Provides encryption details of Amazon Security Lake object.
  607. */
  608. encryptionConfiguration?: DataLakeEncryptionConfiguration;
  609. /**
  610. * Provides lifecycle details of Amazon Security Lake object.
  611. */
  612. lifecycleConfiguration?: DataLakeLifecycleConfiguration;
  613. /**
  614. * The Amazon Web Services Regions where Security Lake is enabled.
  615. */
  616. region: Region;
  617. /**
  618. * Provides replication details of Amazon Security Lake object.
  619. */
  620. replicationConfiguration?: DataLakeReplicationConfiguration;
  621. /**
  622. * The ARN for the Amazon Security Lake Amazon S3 bucket.
  623. */
  624. s3BucketArn?: S3BucketArn;
  625. /**
  626. * The status of the last UpdateDataLake or DeleteDataLake API request.
  627. */
  628. updateStatus?: DataLakeUpdateStatus;
  629. }
  630. export type DataLakeResourceList = DataLakeResource[];
  631. export interface DataLakeSource {
  632. /**
  633. * The ID of the Security Lake account for which logs are collected.
  634. */
  635. account?: String;
  636. /**
  637. * The Open Cybersecurity Schema Framework (OCSF) event classes which describes the type of data that the custom source will send to Security Lake. The supported event classes are: 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 CONFIG_STATE INVENTORY_INFO EMAIL_ACTIVITY API_ACTIVITY CLOUD_API
  638. */
  639. eventClasses?: OcsfEventClassList;
  640. /**
  641. * The supported Amazon Web Services from which logs and events are collected. Amazon Security Lake supports log and event collection for natively supported Amazon Web Services.
  642. */
  643. sourceName?: String;
  644. /**
  645. * The log status for the Security Lake account.
  646. */
  647. sourceStatuses?: DataLakeSourceStatusList;
  648. }
  649. export type DataLakeSourceList = DataLakeSource[];
  650. export interface DataLakeSourceStatus {
  651. /**
  652. * Defines path the stored logs are available which has information on your systems, applications, and services.
  653. */
  654. resource?: String;
  655. /**
  656. * The health status of services, including error codes and patterns.
  657. */
  658. status?: SourceCollectionStatus;
  659. }
  660. export type DataLakeSourceStatusList = DataLakeSourceStatus[];
  661. export type DataLakeStatus = "INITIALIZED"|"PENDING"|"COMPLETED"|"FAILED"|string;
  662. export type DataLakeStorageClass = string;
  663. export interface DataLakeUpdateException {
  664. /**
  665. * The reason code for the exception of the last UpdateDataLake or DeleteDataLake API request.
  666. */
  667. code?: String;
  668. /**
  669. * The reason for the exception of the last UpdateDataLakeor DeleteDataLake API request.
  670. */
  671. reason?: String;
  672. }
  673. export interface DataLakeUpdateStatus {
  674. /**
  675. * The details of the last UpdateDataLakeor DeleteDataLake API request which failed.
  676. */
  677. exception?: DataLakeUpdateException;
  678. /**
  679. * The unique ID for the last UpdateDataLake or DeleteDataLake API request.
  680. */
  681. requestId?: String;
  682. /**
  683. * The status of the last UpdateDataLake or DeleteDataLake API request that was requested.
  684. */
  685. status?: DataLakeStatus;
  686. }
  687. export interface DeleteAwsLogSourceRequest {
  688. /**
  689. * Specify the natively-supported Amazon Web Services service to remove as a source in Security Lake.
  690. */
  691. sources: AwsLogSourceConfigurationList;
  692. }
  693. export interface DeleteAwsLogSourceResponse {
  694. /**
  695. * Deletion of the Amazon Web Services sources failed as the account is not a part of the organization.
  696. */
  697. failed?: AccountList;
  698. }
  699. export interface DeleteCustomLogSourceRequest {
  700. /**
  701. * The source name of custom log source that you want to delete.
  702. */
  703. sourceName: CustomLogSourceName;
  704. /**
  705. * The source version for the third-party custom source. You can limit the custom source removal to the specified source version.
  706. */
  707. sourceVersion?: CustomLogSourceVersion;
  708. }
  709. export interface DeleteCustomLogSourceResponse {
  710. }
  711. export interface DeleteDataLakeExceptionSubscriptionRequest {
  712. }
  713. export interface DeleteDataLakeExceptionSubscriptionResponse {
  714. }
  715. export interface DeleteDataLakeOrganizationConfigurationRequest {
  716. /**
  717. * Turns off automatic enablement of Security Lake for member accounts that are added to an organization.
  718. */
  719. autoEnableNewAccount?: DataLakeAutoEnableNewAccountConfigurationList;
  720. }
  721. export interface DeleteDataLakeOrganizationConfigurationResponse {
  722. }
  723. export interface DeleteDataLakeRequest {
  724. /**
  725. * The list of Regions where Security Lake is enabled.
  726. */
  727. regions: RegionList;
  728. }
  729. export interface DeleteDataLakeResponse {
  730. }
  731. export interface DeleteSubscriberNotificationRequest {
  732. /**
  733. * The ID of the Security Lake subscriber account.
  734. */
  735. subscriberId: UUID;
  736. }
  737. export interface DeleteSubscriberNotificationResponse {
  738. }
  739. export interface DeleteSubscriberRequest {
  740. /**
  741. * A value created by Security Lake that uniquely identifies your DeleteSubscriber API request.
  742. */
  743. subscriberId: UUID;
  744. }
  745. export interface DeleteSubscriberResponse {
  746. }
  747. export interface DeregisterDataLakeDelegatedAdministratorRequest {
  748. }
  749. export interface DeregisterDataLakeDelegatedAdministratorResponse {
  750. }
  751. export type DescriptionString = string;
  752. export type ExternalId = string;
  753. export interface GetDataLakeExceptionSubscriptionRequest {
  754. }
  755. export interface GetDataLakeExceptionSubscriptionResponse {
  756. /**
  757. * The expiration period and time-to-live (TTL).
  758. */
  759. exceptionTimeToLive?: Long;
  760. /**
  761. * The Amazon Web Services account where you receive exception notifications.
  762. */
  763. notificationEndpoint?: SafeString;
  764. /**
  765. * The subscription protocol to which exception notifications are posted.
  766. */
  767. subscriptionProtocol?: SubscriptionProtocol;
  768. }
  769. export interface GetDataLakeOrganizationConfigurationRequest {
  770. }
  771. export interface GetDataLakeOrganizationConfigurationResponse {
  772. /**
  773. * The configuration for new accounts.
  774. */
  775. autoEnableNewAccount?: DataLakeAutoEnableNewAccountConfigurationList;
  776. }
  777. export interface GetDataLakeSourcesRequest {
  778. /**
  779. * The Amazon Web Services account ID for which a static snapshot of the current Amazon Web Services Region, including enabled accounts and log sources, is retrieved.
  780. */
  781. accounts?: AccountList;
  782. /**
  783. * The maximum limit of accounts for which the static snapshot of the current Region, including enabled accounts and log sources, is retrieved.
  784. */
  785. maxResults?: MaxResults;
  786. /**
  787. * Lists if there are more results available. The value of nextToken is a unique pagination token for each page. Repeat the call using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
  788. */
  789. nextToken?: NextToken;
  790. }
  791. export interface GetDataLakeSourcesResponse {
  792. /**
  793. * The Amazon Resource Name (ARN) created by you to provide to the subscriber. For more information about ARNs and how to use them in policies, see the Amazon Security Lake User Guide.
  794. */
  795. dataLakeArn?: AmazonResourceName;
  796. /**
  797. * The list of enabled accounts and enabled sources.
  798. */
  799. dataLakeSources?: DataLakeSourceList;
  800. /**
  801. * Lists if there are more results available. The value of nextToken is a unique pagination token for each page. Repeat the call using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
  802. */
  803. nextToken?: NextToken;
  804. }
  805. export interface GetSubscriberRequest {
  806. /**
  807. * A value created by Amazon Security Lake that uniquely identifies your GetSubscriber API request.
  808. */
  809. subscriberId: UUID;
  810. }
  811. export interface GetSubscriberResponse {
  812. /**
  813. * The subscriber information for the specified subscriber ID.
  814. */
  815. subscriber?: SubscriberResource;
  816. }
  817. export type HttpMethod = "POST"|"PUT"|string;
  818. export interface HttpsNotificationConfiguration {
  819. /**
  820. * The key name for the notification subscription.
  821. */
  822. authorizationApiKeyName?: String;
  823. /**
  824. * The key value for the notification subscription.
  825. */
  826. authorizationApiKeyValue?: String;
  827. /**
  828. * The subscription endpoint in Security Lake. If you prefer notification with an HTTPs endpoint, populate this field.
  829. */
  830. endpoint: HttpsNotificationConfigurationEndpointString;
  831. /**
  832. * The HTTPS method used for the notification subscription.
  833. */
  834. httpMethod?: HttpMethod;
  835. /**
  836. * The Amazon Resource Name (ARN) of the EventBridge API destinations IAM role that you created. For more information about ARNs and how to use them in policies, see Managing data access and Amazon Web Services Managed Policies in the Amazon Security Lake User Guide.
  837. */
  838. targetRoleArn: RoleArn;
  839. }
  840. export type HttpsNotificationConfigurationEndpointString = string;
  841. export interface ListDataLakeExceptionsRequest {
  842. /**
  843. * List the maximum number of failures in Security Lake.
  844. */
  845. maxResults?: MaxResults;
  846. /**
  847. * List if there are more results available. The value of nextToken is a unique pagination token for each page. Repeat the call using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
  848. */
  849. nextToken?: NextToken;
  850. /**
  851. * The Amazon Web Services Regions from which exceptions are retrieved.
  852. */
  853. regions?: RegionList;
  854. }
  855. export interface ListDataLakeExceptionsResponse {
  856. /**
  857. * Lists the failures that cannot be retried in the current Region.
  858. */
  859. exceptions?: DataLakeExceptionList;
  860. /**
  861. * List if there are more results available. The value of nextToken is a unique pagination token for each page. Repeat the call using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
  862. */
  863. nextToken?: NextToken;
  864. }
  865. export interface ListDataLakesRequest {
  866. /**
  867. * The list of Regions where Security Lake is enabled.
  868. */
  869. regions?: RegionList;
  870. }
  871. export interface ListDataLakesResponse {
  872. /**
  873. * Retrieves the Security Lake configuration object.
  874. */
  875. dataLakes?: DataLakeResourceList;
  876. }
  877. export interface ListLogSourcesRequest {
  878. /**
  879. * The list of Amazon Web Services accounts for which log sources are displayed.
  880. */
  881. accounts?: AccountList;
  882. /**
  883. * The maximum number of accounts for which the log sources are displayed.
  884. */
  885. maxResults?: MaxResults;
  886. /**
  887. * If nextToken is returned, there are more results available. You can repeat the call using the returned token to retrieve the next page.
  888. */
  889. nextToken?: NextToken;
  890. /**
  891. * The list of Regions for which log sources are displayed.
  892. */
  893. regions?: RegionList;
  894. /**
  895. * The list of sources for which log sources are displayed.
  896. */
  897. sources?: LogSourceResourceList;
  898. }
  899. export interface ListLogSourcesResponse {
  900. /**
  901. * If nextToken is returned, there are more results available. You can repeat the call using the returned token to retrieve the next page.
  902. */
  903. nextToken?: NextToken;
  904. /**
  905. * The list of log sources in your organization that send data to the data lake.
  906. */
  907. sources?: LogSourceList;
  908. }
  909. export interface ListSubscribersRequest {
  910. /**
  911. * The maximum number of accounts for which the configuration is displayed.
  912. */
  913. maxResults?: MaxResults;
  914. /**
  915. * If nextToken is returned, there are more results available. You can repeat the call using the returned token to retrieve the next page.
  916. */
  917. nextToken?: NextToken;
  918. }
  919. export interface ListSubscribersResponse {
  920. /**
  921. * If nextToken is returned, there are more results available. You can repeat the call using the returned token to retrieve the next page.
  922. */
  923. nextToken?: NextToken;
  924. /**
  925. * The subscribers available for the specified Security Lake account ID.
  926. */
  927. subscribers?: SubscriberResourceList;
  928. }
  929. export interface ListTagsForResourceRequest {
  930. /**
  931. * The Amazon Resource Name (ARN) of the Amazon Security Lake resource for which you want to retrieve the tags.
  932. */
  933. resourceArn: AmazonResourceName;
  934. }
  935. export interface ListTagsForResourceResponse {
  936. /**
  937. * An array of objects, one for each tag (key and value) that’s associated with the Amazon Security Lake resource.
  938. */
  939. tags?: TagList;
  940. }
  941. export interface LogSource {
  942. /**
  943. * Specify the account from which you want to collect logs.
  944. */
  945. account?: AwsAccountId;
  946. /**
  947. * Specify the Regions from which you want to collect logs.
  948. */
  949. region?: Region;
  950. /**
  951. * Specify the sources from which you want to collect logs.
  952. */
  953. sources?: LogSourceResourceList;
  954. }
  955. export type LogSourceList = LogSource[];
  956. export interface LogSourceResource {
  957. /**
  958. * Amazon Security Lake supports log and event collection for natively supported Amazon Web Services. For more information, see the Amazon Security Lake User Guide.
  959. */
  960. awsLogSource?: AwsLogSourceResource;
  961. /**
  962. * Amazon Security Lake supports custom source types. For more information, see the Amazon Security Lake User Guide.
  963. */
  964. customLogSource?: CustomLogSourceResource;
  965. }
  966. export type LogSourceResourceList = LogSourceResource[];
  967. export type Long = number;
  968. export type MaxResults = number;
  969. export type NextToken = string;
  970. export interface NotificationConfiguration {
  971. /**
  972. * The configurations for HTTPS subscriber notification.
  973. */
  974. httpsNotificationConfiguration?: HttpsNotificationConfiguration;
  975. /**
  976. * The configurations for SQS subscriber notification.
  977. */
  978. sqsNotificationConfiguration?: SqsNotificationConfiguration;
  979. }
  980. export type OcsfEventClass = string;
  981. export type OcsfEventClassList = OcsfEventClass[];
  982. export type Region = string;
  983. export type RegionList = Region[];
  984. export interface RegisterDataLakeDelegatedAdministratorRequest {
  985. /**
  986. * The Amazon Web Services account ID of the Security Lake delegated administrator.
  987. */
  988. accountId: SafeString;
  989. }
  990. export interface RegisterDataLakeDelegatedAdministratorResponse {
  991. }
  992. export type ResourceShareArn = string;
  993. export type ResourceShareName = string;
  994. export type RoleArn = string;
  995. export type S3BucketArn = string;
  996. export type S3URI = string;
  997. export type SafeString = string;
  998. export type SourceCollectionStatus = "COLLECTING"|"MISCONFIGURED"|"NOT_COLLECTING"|string;
  999. export interface SqsNotificationConfiguration {
  1000. }
  1001. export type String = string;
  1002. export interface SubscriberResource {
  1003. /**
  1004. * You can choose to notify subscribers of new objects with an Amazon Simple Queue Service (Amazon SQS) queue or through messaging to an HTTPS endpoint provided by the subscriber. Subscribers can consume data by directly querying Lake Formation tables in your Amazon S3 bucket through services like Amazon Athena. This subscription type is defined as LAKEFORMATION.
  1005. */
  1006. accessTypes?: AccessTypeList;
  1007. /**
  1008. * The date and time when the subscriber was created.
  1009. */
  1010. createdAt?: SyntheticTimestamp_date_time;
  1011. /**
  1012. * The Amazon Resource Name (ARN) which uniquely defines the AWS RAM resource share. Before accepting the RAM resource share invitation, you can view details related to the RAM resource share. This field is available only for Lake Formation subscribers created after March 8, 2023.
  1013. */
  1014. resourceShareArn?: ResourceShareArn;
  1015. /**
  1016. * The name of the resource share.
  1017. */
  1018. resourceShareName?: ResourceShareName;
  1019. /**
  1020. * The Amazon Resource Name (ARN) specifying the role of the subscriber.
  1021. */
  1022. roleArn?: RoleArn;
  1023. /**
  1024. * The ARN for the Amazon S3 bucket.
  1025. */
  1026. s3BucketArn?: S3BucketArn;
  1027. /**
  1028. * Amazon Security Lake supports log and event collection for natively supported Amazon Web Services. For more information, see the Amazon Security Lake User Guide.
  1029. */
  1030. sources: LogSourceResourceList;
  1031. /**
  1032. * The subscriber ARN of the Amazon Security Lake subscriber account.
  1033. */
  1034. subscriberArn: AmazonResourceName;
  1035. /**
  1036. * The subscriber descriptions for a subscriber account. The description for a subscriber includes subscriberName, accountID, externalID, and subscriberId.
  1037. */
  1038. subscriberDescription?: SafeString;
  1039. /**
  1040. * The subscriber endpoint to which exception messages are posted.
  1041. */
  1042. subscriberEndpoint?: SafeString;
  1043. /**
  1044. * The subscriber ID of the Amazon Security Lake subscriber account.
  1045. */
  1046. subscriberId: UUID;
  1047. /**
  1048. * The AWS identity used to access your data.
  1049. */
  1050. subscriberIdentity: AwsIdentity;
  1051. /**
  1052. * The name of your Amazon Security Lake subscriber account.
  1053. */
  1054. subscriberName: SafeString;
  1055. /**
  1056. * The subscriber status of the Amazon Security Lake subscriber account.
  1057. */
  1058. subscriberStatus?: SubscriberStatus;
  1059. /**
  1060. * The date and time when the subscriber was last updated.
  1061. */
  1062. updatedAt?: SyntheticTimestamp_date_time;
  1063. }
  1064. export type SubscriberResourceList = SubscriberResource[];
  1065. export type SubscriberStatus = "ACTIVE"|"DEACTIVATED"|"PENDING"|"READY"|string;
  1066. export type SubscriptionProtocol = string;
  1067. export type SyntheticTimestamp_date_time = Date;
  1068. export interface Tag {
  1069. /**
  1070. * The name of the tag. This is a general label that acts as a category for a more specific tag value (value).
  1071. */
  1072. key: TagKey;
  1073. /**
  1074. * The value that’s associated with the specified tag key (key). This value acts as a descriptor for the tag key. A tag value cannot be null, but it can be an empty string.
  1075. */
  1076. value: TagValue;
  1077. }
  1078. export type TagKey = string;
  1079. export type TagKeyList = TagKey[];
  1080. export type TagList = Tag[];
  1081. export interface TagResourceRequest {
  1082. /**
  1083. * The Amazon Resource Name (ARN) of the Amazon Security Lake resource to add or update the tags for.
  1084. */
  1085. resourceArn: AmazonResourceName;
  1086. /**
  1087. * An array of objects, one for each tag (key and value) to associate with the Amazon Security Lake resource. For each tag, you must specify both a tag key and a tag value. A tag value cannot be null, but it can be an empty string.
  1088. */
  1089. tags: TagList;
  1090. }
  1091. export interface TagResourceResponse {
  1092. }
  1093. export type TagValue = string;
  1094. export type UUID = string;
  1095. export interface UntagResourceRequest {
  1096. /**
  1097. * The Amazon Resource Name (ARN) of the Amazon Security Lake resource to remove one or more tags from.
  1098. */
  1099. resourceArn: AmazonResourceName;
  1100. /**
  1101. * A list of one or more tag keys. For each value in the list, specify the tag key for a tag to remove from the Amazon Security Lake resource.
  1102. */
  1103. tagKeys: TagKeyList;
  1104. }
  1105. export interface UntagResourceResponse {
  1106. }
  1107. export interface UpdateDataLakeExceptionSubscriptionRequest {
  1108. /**
  1109. * The time-to-live (TTL) for the exception message to remain.
  1110. */
  1111. exceptionTimeToLive?: UpdateDataLakeExceptionSubscriptionRequestExceptionTimeToLiveLong;
  1112. /**
  1113. * The account that is subscribed to receive exception notifications.
  1114. */
  1115. notificationEndpoint: SafeString;
  1116. /**
  1117. * The subscription protocol to which exception messages are posted.
  1118. */
  1119. subscriptionProtocol: SubscriptionProtocol;
  1120. }
  1121. export type UpdateDataLakeExceptionSubscriptionRequestExceptionTimeToLiveLong = number;
  1122. export interface UpdateDataLakeExceptionSubscriptionResponse {
  1123. }
  1124. export interface UpdateDataLakeRequest {
  1125. /**
  1126. * Specify the Region or Regions that will contribute data to the rollup region.
  1127. */
  1128. configurations: DataLakeConfigurationList;
  1129. /**
  1130. * The Amazon Resource Name (ARN) used to create and update the Glue table. This table contains partitions generated by the ingestion and normalization of Amazon Web Services log sources and custom sources.
  1131. */
  1132. metaStoreManagerRoleArn?: RoleArn;
  1133. }
  1134. export interface UpdateDataLakeResponse {
  1135. /**
  1136. * The created Security Lake configuration object.
  1137. */
  1138. dataLakes?: DataLakeResourceList;
  1139. }
  1140. export interface UpdateSubscriberNotificationRequest {
  1141. /**
  1142. * The configuration for subscriber notification.
  1143. */
  1144. configuration: NotificationConfiguration;
  1145. /**
  1146. * The subscription ID for which the subscription notification is specified.
  1147. */
  1148. subscriberId: UUID;
  1149. }
  1150. export interface UpdateSubscriberNotificationResponse {
  1151. /**
  1152. * The subscriber endpoint to which exception messages are posted.
  1153. */
  1154. subscriberEndpoint?: SafeString;
  1155. }
  1156. export interface UpdateSubscriberRequest {
  1157. /**
  1158. * The supported Amazon Web Services from which logs and events are collected. For the list of supported Amazon Web Services, see the Amazon Security Lake User Guide.
  1159. */
  1160. sources?: LogSourceResourceList;
  1161. /**
  1162. * The description of the Security Lake account subscriber.
  1163. */
  1164. subscriberDescription?: DescriptionString;
  1165. /**
  1166. * A value created by Security Lake that uniquely identifies your subscription.
  1167. */
  1168. subscriberId: UUID;
  1169. /**
  1170. * The AWS identity used to access your data.
  1171. */
  1172. subscriberIdentity?: AwsIdentity;
  1173. /**
  1174. * The name of the Security Lake account subscriber.
  1175. */
  1176. subscriberName?: UpdateSubscriberRequestSubscriberNameString;
  1177. }
  1178. export type UpdateSubscriberRequestSubscriberNameString = string;
  1179. export interface UpdateSubscriberResponse {
  1180. /**
  1181. * The updated subscriber information.
  1182. */
  1183. subscriber?: SubscriberResource;
  1184. }
  1185. /**
  1186. * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
  1187. */
  1188. export type apiVersion = "2018-05-10"|"latest"|string;
  1189. export interface ClientApiVersions {
  1190. /**
  1191. * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
  1192. */
  1193. apiVersion?: apiVersion;
  1194. }
  1195. export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
  1196. /**
  1197. * Contains interfaces for use with the SecurityLake client.
  1198. */
  1199. export import Types = SecurityLake;
  1200. }
  1201. export = SecurityLake;