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. At least one of the three dimensions is a mandatory input to this API. However, you can supply any combination of the three dimensions to this API.
By default, a dimension refers to the entire set. When you don't provide a dimension, Security Lake assumes that the missing dimension refers to the entire set. This is overridden when you supply any one of the inputs. For instance, when you do not specify members, the API enables all Security Lake member accounts for all sources. Similarly, when you do not specify Regions, Security Lake is enabled for all the Regions where Security Lake is available as a service.
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.
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.
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 to an associated Glue table and an Glue crawler.
" + "documentation":"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.
", + "idempotent":true }, - "CreateDatalake":{ - "name":"CreateDatalake", + "CreateDataLake":{ + "name":"CreateDataLake", "http":{ "method":"POST", "requestUri":"/v1/datalake", "responseCode":200 }, - "input":{"shape":"CreateDatalakeRequest"}, - "output":{"shape":"CreateDatalakeResponse"}, + "input":{"shape":"CreateDataLakeRequest"}, + "output":{"shape":"CreateDataLakeResponse"}, "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"ConflictException"}, + {"shape":"BadRequestException"}, + {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, - {"shape":"ValidationException"}, - {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"} ], - "documentation":"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. You can either use the enableAll parameter to specify all Regions or specify the Regions where you want to enable Security Lake. To specify particular Regions, use the Regions parameter and then 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.
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. By default, the CreateDataLake Security Lake in all 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.
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.
" - }, - "CreateDatalakeDelegatedAdmin":{ - "name":"CreateDatalakeDelegatedAdmin", - "http":{ - "method":"POST", - "requestUri":"/v1/datalake/delegate", - "responseCode":200 - }, - "input":{"shape":"CreateDatalakeDelegatedAdminRequest"}, - "output":{"shape":"CreateDatalakeDelegatedAdminResponse"}, - "errors":[ - {"shape":"InternalServerException"}, - {"shape":"ValidationException"}, - {"shape":"ThrottlingException"}, - {"shape":"AccessDeniedException"} + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"} ], - "documentation":"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.
" + "documentation":"Creates the specified notification subscription in Amazon Security Lake for the organization you specify.
" }, - "CreateDatalakeExceptionsSubscription":{ - "name":"CreateDatalakeExceptionsSubscription", + "CreateDataLakeOrganizationConfiguration":{ + "name":"CreateDataLakeOrganizationConfiguration", "http":{ "method":"POST", - "requestUri":"/v1/datalake/exceptions/subscription", + "requestUri":"/v1/datalake/organization/configuration", "responseCode":200 }, - "input":{"shape":"CreateDatalakeExceptionsSubscriptionRequest"}, - "output":{"shape":"CreateDatalakeExceptionsSubscriptionResponse"}, + "input":{"shape":"CreateDataLakeOrganizationConfigurationRequest"}, + "output":{"shape":"CreateDataLakeOrganizationConfigurationResponse"}, "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, - {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, - {"shape":"AccountNotFoundException"} + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"} ], - "documentation":"Creates the specified notification subscription in Amazon Security Lake for the organization you specify.
" + "documentation":"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.
" }, "CreateSubscriber":{ "name":"CreateSubscriber", @@ -132,34 +118,31 @@ "input":{"shape":"CreateSubscriberRequest"}, "output":{"shape":"CreateSubscriberResponse"}, "errors":[ - {"shape":"ConflictSubscriptionException"}, + {"shape":"BadRequestException"}, + {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, - {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, - {"shape":"BucketNotFoundException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"AccountNotFoundException"}, - {"shape":"InvalidInputException"} + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"} ], "documentation":"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.
" }, - "CreateSubscriptionNotificationConfiguration":{ - "name":"CreateSubscriptionNotificationConfiguration", + "CreateSubscriberNotification":{ + "name":"CreateSubscriberNotification", "http":{ "method":"POST", - "requestUri":"/subscription-notifications/{subscriptionId}", + "requestUri":"/v1/subscribers/{subscriberId}/notification", "responseCode":200 }, - "input":{"shape":"CreateSubscriptionNotificationConfigurationRequest"}, - "output":{"shape":"CreateSubscriptionNotificationConfigurationResponse"}, + "input":{"shape":"CreateSubscriberNotificationRequest"}, + "output":{"shape":"CreateSubscriberNotificationResponse"}, "errors":[ - {"shape":"ConcurrentModificationException"}, + {"shape":"BadRequestException"}, + {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, - {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"AccountNotFoundException"}, - {"shape":"InvalidInputException"} + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"} ], "documentation":"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.
" }, @@ -167,293 +150,292 @@ "name":"DeleteAwsLogSource", "http":{ "method":"POST", - "requestUri":"/v1/logsources/aws/delete", + "requestUri":"/v1/datalake/logsources/aws/delete", "responseCode":200 }, "input":{"shape":"DeleteAwsLogSourceRequest"}, "output":{"shape":"DeleteAwsLogSourceResponse"}, "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, - {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, - {"shape":"AccountNotFoundException"} + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"} ], - "documentation":"Removes a natively supported Amazon Web Service as an Amazon Security Lake source. When you remove the source, Security Lake stops collecting data from that source, and subscribers can no longer consume new data from the source. Subscribers can still consume data that Security Lake collected from the source before disablement.
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. At least one of the three dimensions is a mandatory input to this API. However, you can supply any combination of the three dimensions to this API.
By default, a dimension refers to the entire set. This is overridden when you supply any one of the inputs. For instance, when you do not specify members, the API disables all Security Lake member accounts for sources. Similarly, when you do not specify Regions, Security Lake is disabled for all the Regions where Security Lake is available as a service.
When you don't provide a dimension, Security Lake assumes that the missing dimension refers to the entire set. For example, if you don't provide specific accounts, the API applies to the entire set of accounts in your organization.
" + "documentation":"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.
" }, "DeleteCustomLogSource":{ "name":"DeleteCustomLogSource", "http":{ "method":"DELETE", - "requestUri":"/v1/logsources/custom", + "requestUri":"/v1/datalake/logsources/custom/{sourceName}", "responseCode":200 }, "input":{"shape":"DeleteCustomLogSourceRequest"}, "output":{"shape":"DeleteCustomLogSourceResponse"}, "errors":[ - {"shape":"InternalServerException"}, - {"shape":"ValidationException"}, - {"shape":"ConflictSourceNamesException"}, - {"shape":"AccessDeniedException"}, - {"shape":"BucketNotFoundException"}, + {"shape":"BadRequestException"}, {"shape":"ResourceNotFoundException"}, - {"shape":"AccountNotFoundException"} - ], - "documentation":"Removes a custom log source from Amazon Security Lake.
", - "idempotent":true - }, - "DeleteDatalake":{ - "name":"DeleteDatalake", - "http":{ - "method":"DELETE", - "requestUri":"/v1/datalake", - "responseCode":200 - }, - "input":{"shape":"DeleteDatalakeRequest"}, - "output":{"shape":"DeleteDatalakeResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"ConflictException"}, {"shape":"InternalServerException"}, - {"shape":"ValidationException"}, - {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"} ], - "documentation":"When you delete Amazon Security Lake from your account, Security Lake is disabled in all Amazon Web Services Regions. Also, this API automatically takes steps to remove the account from Security Lake .
This operation disables security data collection from sources, deletes data stored, and stops making data accessible to subscribers. Security Lake also deletes 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. The DeleteDatalake operation does not delete the Amazon S3 bucket, which is owned by your Amazon Web Services account. For more information, see the Amazon Security Lake User Guide.
Removes a custom log source from Amazon Security Lake, to stop sending data from the custom source to Security Lake.
", "idempotent":true }, - "DeleteDatalakeAutoEnable":{ - "name":"DeleteDatalakeAutoEnable", + "DeleteDataLake":{ + "name":"DeleteDataLake", "http":{ "method":"POST", - "requestUri":"/v1/datalake/autoenable/delete", + "requestUri":"/v1/datalake/delete", "responseCode":200 }, - "input":{"shape":"DeleteDatalakeAutoEnableRequest"}, - "output":{"shape":"DeleteDatalakeAutoEnableResponse"}, + "input":{"shape":"DeleteDataLakeRequest"}, + "output":{"shape":"DeleteDataLakeResponse"}, "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, - {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, - {"shape":"AccountNotFoundException"} + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"} ], - "documentation":" DeleteDatalakeAutoEnable removes automatic enablement of configuration settings for new member accounts (but keeps settings for the delegated administrator) from Amazon Security Lake. You must run this API using credentials of the delegated administrator. When you run this API, new member accounts that are added after the organization enables Security Lake won't contribute to the data lake.
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.
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.
" + "documentation":"Deletes the specified notification subscription in Amazon Security Lake for the organization you specify.
", + "idempotent":true }, - "DeleteDatalakeExceptionsSubscription":{ - "name":"DeleteDatalakeExceptionsSubscription", + "DeleteDataLakeOrganizationConfiguration":{ + "name":"DeleteDataLakeOrganizationConfiguration", "http":{ - "method":"DELETE", - "requestUri":"/v1/datalake/exceptions/subscription", + "method":"POST", + "requestUri":"/v1/datalake/organization/configuration/delete", "responseCode":200 }, - "input":{"shape":"DeleteDatalakeExceptionsSubscriptionRequest"}, - "output":{"shape":"DeleteDatalakeExceptionsSubscriptionResponse"}, + "input":{"shape":"DeleteDataLakeOrganizationConfigurationRequest"}, + "output":{"shape":"DeleteDataLakeOrganizationConfigurationResponse"}, "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, - {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, - {"shape":"AccountNotFoundException"} + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"} ], - "documentation":"Deletes the specified notification subscription in Amazon Security Lake for the organization you specify.
" + "documentation":"Removes automatic the enablement of configuration settings for new member accounts (but retains the settings for the delegated administrator) from Amazon Security Lake. You must run this API using the credentials of the delegated administrator. When you run this API, new member accounts that are added after the organization enables Security Lake won't contribute to the data lake.
" }, "DeleteSubscriber":{ "name":"DeleteSubscriber", "http":{ "method":"DELETE", - "requestUri":"/v1/subscribers", + "requestUri":"/v1/subscribers/{subscriberId}", "responseCode":200 }, "input":{"shape":"DeleteSubscriberRequest"}, "output":{"shape":"DeleteSubscriberResponse"}, "errors":[ - {"shape":"ConcurrentModificationException"}, + {"shape":"BadRequestException"}, + {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, - {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, - {"shape":"BucketNotFoundException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"AccountNotFoundException"}, - {"shape":"InvalidInputException"} + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"} ], - "documentation":"Deletes the subscription permission for accounts that are already enabled in Amazon Security Lake. You can delete a subscriber and remove access to data in the current Amazon Web Services Region.
", + "documentation":"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.
Deletes the specified notification subscription in Amazon Security Lake for the organization you specify.
", "idempotent":true }, - "GetDatalake":{ - "name":"GetDatalake", + "DeregisterDataLakeDelegatedAdministrator":{ + "name":"DeregisterDataLakeDelegatedAdministrator", "http":{ - "method":"GET", - "requestUri":"/v1/datalake", + "method":"DELETE", + "requestUri":"/v1/datalake/delegate", "responseCode":200 }, - "input":{"shape":"GetDatalakeRequest"}, - "output":{"shape":"GetDatalakeResponse"}, + "input":{"shape":"DeregisterDataLakeDelegatedAdministratorRequest"}, + "output":{"shape":"DeregisterDataLakeDelegatedAdministratorResponse"}, "errors":[ - {"shape":"InternalServerException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, + {"shape":"BadRequestException"}, {"shape":"ResourceNotFoundException"}, - {"shape":"AccountNotFoundException"} - ], - "documentation":"Retrieves the Amazon Security Lake configuration object for the specified Amazon Web Services account ID. You can use the GetDatalake API to know whether Security Lake is enabled for the current Region. This API does not take input parameters.
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.
" + "documentation":"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.
", + "idempotent":true }, - "GetDatalakeExceptionsExpiry":{ - "name":"GetDatalakeExceptionsExpiry", + "GetDataLakeExceptionSubscription":{ + "name":"GetDataLakeExceptionSubscription", "http":{ "method":"GET", - "requestUri":"/v1/datalake/exceptions/expiry", + "requestUri":"/v1/datalake/exceptions/subscription", "responseCode":200 }, - "input":{"shape":"GetDatalakeExceptionsExpiryRequest"}, - "output":{"shape":"GetDatalakeExceptionsExpiryResponse"}, + "input":{"shape":"GetDataLakeExceptionSubscriptionRequest"}, + "output":{"shape":"GetDataLakeExceptionSubscriptionResponse"}, "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, - {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, - {"shape":"AccountNotFoundException"} + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"} ], - "documentation":"Retrieves the expiration period and time-to-live (TTL) for which the exception message will remain. Exceptions are stored by default, for 2 weeks from when a record was created in Amazon Security Lake. This API does not take input parameters.
" + "documentation":"Retrieves the details of exception notifications for the account in Amazon Security Lake.
" }, - "GetDatalakeExceptionsSubscription":{ - "name":"GetDatalakeExceptionsSubscription", + "GetDataLakeOrganizationConfiguration":{ + "name":"GetDataLakeOrganizationConfiguration", "http":{ "method":"GET", - "requestUri":"/v1/datalake/exceptions/subscription", + "requestUri":"/v1/datalake/organization/configuration", "responseCode":200 }, - "input":{"shape":"GetDatalakeExceptionsSubscriptionRequest"}, - "output":{"shape":"GetDatalakeExceptionsSubscriptionResponse"}, + "input":{"shape":"GetDataLakeOrganizationConfigurationRequest"}, + "output":{"shape":"GetDataLakeOrganizationConfigurationResponse"}, "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, - {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, - {"shape":"AccountNotFoundException"} + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"} ], - "documentation":"Retrieves the details of exception notifications for the account in Amazon Security Lake.
" + "documentation":"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.
" }, - "GetDatalakeStatus":{ - "name":"GetDatalakeStatus", + "GetDataLakeSources":{ + "name":"GetDataLakeSources", "http":{ "method":"POST", - "requestUri":"/v1/datalake/status", + "requestUri":"/v1/datalake/sources", "responseCode":200 }, - "input":{"shape":"GetDatalakeStatusRequest"}, - "output":{"shape":"GetDatalakeStatusResponse"}, + "input":{"shape":"GetDataLakeSourcesRequest"}, + "output":{"shape":"GetDataLakeSourcesResponse"}, "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, - {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, - {"shape":"AccountNotFoundException"} + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"} ], - "documentation":"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.
" + "documentation":"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.
" }, "GetSubscriber":{ "name":"GetSubscriber", "http":{ "method":"GET", - "requestUri":"/v1/subscribers/{id}", + "requestUri":"/v1/subscribers/{subscriberId}", "responseCode":200 }, "input":{"shape":"GetSubscriberRequest"}, "output":{"shape":"GetSubscriberResponse"}, "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"AccountNotFoundException"}, - {"shape":"InvalidInputException"} + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"} ], "documentation":"Retrieves the subscription information for the specified subscription ID. You can get information about a specific subscriber.
" }, - "ListDatalakeExceptions":{ - "name":"ListDatalakeExceptions", + "ListDataLakeExceptions":{ + "name":"ListDataLakeExceptions", "http":{ "method":"POST", "requestUri":"/v1/datalake/exceptions", "responseCode":200 }, - "input":{"shape":"ListDatalakeExceptionsRequest"}, - "output":{"shape":"ListDatalakeExceptionsResponse"}, + "input":{"shape":"ListDataLakeExceptionsRequest"}, + "output":{"shape":"ListDataLakeExceptionsResponse"}, "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, - {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, - {"shape":"AccountNotFoundException"} + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"} ], "documentation":"Lists the Amazon Security Lake exceptions that you can use to find the source of problems and fix them.
" }, + "ListDataLakes":{ + "name":"ListDataLakes", + "http":{ + "method":"GET", + "requestUri":"/v1/datalakes", + "responseCode":200 + }, + "input":{"shape":"ListDataLakesRequest"}, + "output":{"shape":"ListDataLakesResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Retrieves the Amazon Security Lake configuration object for the specified Amazon Web Services account ID. You can use the ListDataLakes API to know whether Security Lake is enabled for any region.
Retrieves the log sources in the current Amazon Web Services Region.
" + "documentation":"Retrieves the log sources in the current Amazon Web Services Region.
" }, "ListSubscribers":{ "name":"ListSubscribers", @@ -465,114 +447,118 @@ "input":{"shape":"ListSubscribersRequest"}, "output":{"shape":"ListSubscribersResponse"}, "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, - {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"AccountNotFoundException"}, - {"shape":"InvalidInputException"} + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"} ], "documentation":"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.
" }, - "UpdateDatalake":{ - "name":"UpdateDatalake", + "RegisterDataLakeDelegatedAdministrator":{ + "name":"RegisterDataLakeDelegatedAdministrator", "http":{ - "method":"PUT", - "requestUri":"/v1/datalake", + "method":"POST", + "requestUri":"/v1/datalake/delegate", "responseCode":200 }, - "input":{"shape":"UpdateDatalakeRequest"}, - "output":{"shape":"UpdateDatalakeResponse"}, + "input":{"shape":"RegisterDataLakeDelegatedAdministratorRequest"}, + "output":{"shape":"RegisterDataLakeDelegatedAdministratorResponse"}, "errors":[ - {"shape":"EventBridgeException"}, + {"shape":"BadRequestException"}, + {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, - {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"} ], - "documentation":"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.
", - "idempotent":true + "documentation":"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.
" }, - "UpdateDatalakeExceptionsExpiry":{ - "name":"UpdateDatalakeExceptionsExpiry", + "UpdateDataLake":{ + "name":"UpdateDataLake", "http":{ "method":"PUT", - "requestUri":"/v1/datalake/exceptions/expiry", + "requestUri":"/v1/datalake", "responseCode":200 }, - "input":{"shape":"UpdateDatalakeExceptionsExpiryRequest"}, - "output":{"shape":"UpdateDatalakeExceptionsExpiryResponse"}, + "input":{"shape":"UpdateDataLakeRequest"}, + "output":{"shape":"UpdateDataLakeResponse"}, "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, - {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, - {"shape":"AccountNotFoundException"} + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"} ], - "documentation":"Update the expiration period for the exception message to your preferred time, and control the time-to-live (TTL) for the exception message to remain. Exceptions are stored by default for 2 weeks from when a record was created in Amazon Security Lake.
" + "documentation":"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.
", + "idempotent":true }, - "UpdateDatalakeExceptionsSubscription":{ - "name":"UpdateDatalakeExceptionsSubscription", + "UpdateDataLakeExceptionSubscription":{ + "name":"UpdateDataLakeExceptionSubscription", "http":{ "method":"PUT", "requestUri":"/v1/datalake/exceptions/subscription", "responseCode":200 }, - "input":{"shape":"UpdateDatalakeExceptionsSubscriptionRequest"}, - "output":{"shape":"UpdateDatalakeExceptionsSubscriptionResponse"}, + "input":{"shape":"UpdateDataLakeExceptionSubscriptionRequest"}, + "output":{"shape":"UpdateDataLakeExceptionSubscriptionResponse"}, "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, - {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, - {"shape":"AccountNotFoundException"} + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"} ], - "documentation":"Updates the specified notification subscription in Amazon Security Lake for the organization you specify.
" + "documentation":"Updates the specified notification subscription in Amazon Security Lake for the organization you specify.
", + "idempotent":true }, "UpdateSubscriber":{ "name":"UpdateSubscriber", "http":{ "method":"PUT", - "requestUri":"/v1/subscribers/{id}", + "requestUri":"/v1/subscribers/{subscriberId}", "responseCode":200 }, "input":{"shape":"UpdateSubscriberRequest"}, "output":{"shape":"UpdateSubscriberResponse"}, "errors":[ - {"shape":"ConflictSubscriptionException"}, - {"shape":"ConcurrentModificationException"}, + {"shape":"BadRequestException"}, + {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, - {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, - {"shape":"AccountNotFoundException"}, - {"shape":"InvalidInputException"} + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"} ], - "documentation":"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.
", + "documentation":"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.
", "idempotent":true }, - "UpdateSubscriptionNotificationConfiguration":{ - "name":"UpdateSubscriptionNotificationConfiguration", + "UpdateSubscriberNotification":{ + "name":"UpdateSubscriberNotification", "http":{ "method":"PUT", - "requestUri":"/subscription-notifications/{subscriptionId}", + "requestUri":"/v1/subscribers/{subscriberId}/notification", "responseCode":200 }, - "input":{"shape":"UpdateSubscriptionNotificationConfigurationRequest"}, - "output":{"shape":"UpdateSubscriptionNotificationConfigurationResponse"}, + "input":{"shape":"UpdateSubscriberNotificationRequest"}, + "output":{"shape":"UpdateSubscriberNotificationResponse"}, "errors":[ - {"shape":"ConcurrentModificationException"}, + {"shape":"BadRequestException"}, + {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, - {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"AccountNotFoundException"}, - {"shape":"InvalidInputException"} + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"} ], - "documentation":"Updates an existing notification method for the subscription (SQS or HTTPs endpoint) or switches the notification subscription endpoint for a subscriber.
" + "documentation":"Updates an existing notification method for the subscription (SQS or HTTPs endpoint) or switches the notification subscription endpoint for a subscriber.
", + "idempotent":true } }, "shapes":{ "AccessDeniedException":{ "type":"structure", - "required":["message"], "members":{ "errorCode":{ "shape":"String", @@ -600,144 +586,130 @@ }, "AccountList":{ "type":"list", - "member":{"shape":"String"} + "member":{"shape":"AwsAccountId"} + }, + "AmazonResourceName":{ + "type":"string", + "max":1011, + "min":1, + "pattern":"^arn:aws:securitylake:[A-za-z0-9_/.\\-]{0,63}:[A-za-z0-9_/.\\-]{0,63}:[A-Za-z0-9][A-za-z0-9_/.\\-]{0,127}$" }, - "AccountNotFoundException":{ + "AwsAccountId":{ + "type":"string", + "max":12, + "min":12, + "pattern":"^[0-9]{12}$" + }, + "AwsIdentity":{ "type":"structure", - "required":["message"], + "required":[ + "externalId", + "principal" + ], "members":{ - "message":{"shape":"String"} - }, - "documentation":"Amazon Security Lake cannot find an Amazon Web Services account with the accountID that you specified, or the account whose credentials you used to make this request isn't a member of an organization.
", - "error":{ - "httpStatusCode":403, - "senderFault":true + "externalId":{ + "shape":"ExternalId", + "documentation":"The external ID used to estalish trust relationship with the AWS identity.
" + }, + "principal":{ + "shape":"AwsPrincipal", + "documentation":"The AWS identity principal.
" + } }, - "exception":true + "documentation":"The AWS identity.
" }, - "AccountSources":{ + "AwsLogSourceConfiguration":{ "type":"structure", "required":[ - "account", - "sourceType" + "regions", + "sourceName" ], "members":{ - "account":{ - "shape":"String", - "documentation":"The ID of the Security Lake account for which logs are collected.
" + "accounts":{ + "shape":"AccountList", + "documentation":"Specify the Amazon Web Services account information where you want to enable Security Lake.
" }, - "eventClass":{ - "shape":"OcsfEventClass", - "documentation":"Initializes a new instance of the Event class.
" + "regions":{ + "shape":"RegionList", + "documentation":"Specify the Regions where you want to enable Security Lake.
" }, - "logsStatus":{ - "shape":"LogsStatusList", - "documentation":"The log status for the Security Lake account.
" + "sourceName":{ + "shape":"AwsLogSourceName", + "documentation":"The name for a Amazon Web Services source. This must be a Regionally unique value.
" }, - "sourceType":{ - "shape":"String", - "documentation":"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.
" + "sourceVersion":{ + "shape":"AwsLogSourceVersion", + "documentation":"The version for a Amazon Web Services source. This must be a Regionally unique value.
" } }, - "documentation":"Amazon Security Lake collects logs and events from supported Amazon Web Services and custom sources. For the list of supported Amazon Web Services, see the Amazon Security Lake User Guide.
" + "documentation":"The Security Lake logs source configuration file describes the information needed to generate Security Lake logs.
" }, - "AccountSourcesList":{ + "AwsLogSourceConfigurationList":{ "type":"list", - "member":{"shape":"AccountSources"} + "member":{"shape":"AwsLogSourceConfiguration"}, + "max":50, + "min":0 }, - "AllDimensionsMap":{ - "type":"map", - "key":{"shape":"String"}, - "value":{"shape":"TwoDimensionsMap"} + "AwsLogSourceName":{ + "type":"string", + "enum":[ + "ROUTE53", + "VPC_FLOW", + "SH_FINDINGS", + "CLOUD_TRAIL_MGMT", + "LAMBDA_EXECUTION", + "S3_DATA" + ] }, - "AutoEnableNewRegionConfiguration":{ + "AwsLogSourceResource":{ "type":"structure", - "required":[ - "region", - "sources" - ], "members":{ - "region":{ - "shape":"Region", - "documentation":"The Amazon Web Services Regions where Security Lake is automatically enabled.
" + "sourceName":{ + "shape":"AwsLogSourceName", + "documentation":"The name for a Amazon Web Services source. This must be a Regionally unique value.
" }, - "sources":{ - "shape":"AwsSourceTypeList", - "documentation":"The Amazon Web Services sources that are automatically enabled in Security Lake.
" + "sourceVersion":{ + "shape":"AwsLogSourceVersion", + "documentation":"The version for a Amazon Web Services source. This must be a Regionally unique value.
" } }, - "documentation":"Automatically enable new organization accounts as member accounts from an Amazon Security Lake administrator account.
" + "documentation":"Amazon Security Lake can collect logs and events from natively-supported Amazon Web Services services.
" }, - "AutoEnableNewRegionConfigurationList":{ + "AwsLogSourceResourceList":{ "type":"list", - "member":{"shape":"AutoEnableNewRegionConfiguration"} + "member":{"shape":"AwsLogSourceResource"} }, - "AwsAccountId":{ + "AwsLogSourceVersion":{ "type":"string", - "max":12, - "min":12, - "pattern":"^\\d+$" + "pattern":"^(latest|[0-9]\\.[0-9])$" }, - "AwsLogSourceType":{ + "AwsPrincipal":{ "type":"string", - "enum":[ - "ROUTE53", - "VPC_FLOW", - "CLOUD_TRAIL", - "SH_FINDINGS" - ] + "pattern":"^([0-9]{12}|[a-z0-9\\.\\-]*\\.(amazonaws|amazon)\\.com)$" }, - "AwsSourceTypeList":{ - "type":"list", - "member":{"shape":"AwsLogSourceType"} - }, - "Boolean":{ - "type":"boolean", - "box":true - }, - "BucketNotFoundException":{ + "BadRequestException":{ "type":"structure", - "required":["message"], "members":{ "message":{"shape":"String"} }, - "documentation":"Amazon Security Lake generally returns 404 errors if the requested object is missing from the bucket.
", + "documentation":"The request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
", "error":{ - "httpStatusCode":409, + "httpStatusCode":400, "senderFault":true }, "exception":true }, - "ConcurrentModificationException":{ - "type":"structure", - "required":["message"], - "members":{ - "message":{"shape":"String"} - }, - "documentation":"More than one process tried to modify a resource at the same time.
", - "error":{ - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "retryable":{"throttling":false} - }, "ConflictException":{ "type":"structure", - "required":[ - "message", - "resourceId", - "resourceType" - ], "members":{ "message":{"shape":"String"}, - "resourceId":{ + "resourceName":{ "shape":"String", - "documentation":"A conflict occurred when prompting for the Resource ID.
" + "documentation":"The resource name.
" }, "resourceType":{ "shape":"String", - "documentation":"The resource type.
" + "documentation":"The resource type.
" } }, "documentation":"Occurs when a conflict with a previous successful write is detected. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
", @@ -747,51 +719,13 @@ }, "exception":true }, - "ConflictSourceNamesException":{ - "type":"structure", - "required":["message"], - "members":{ - "message":{"shape":"String"} - }, - "documentation":"There was a conflict when you attempted to modify a Security Lake source name.
", - "error":{ - "httpStatusCode":400, - "senderFault":true - }, - "exception":true - }, - "ConflictSubscriptionException":{ - "type":"structure", - "required":["message"], - "members":{ - "message":{"shape":"String"} - }, - "documentation":"A conflicting subscription exception operation is in progress.
", - "error":{ - "httpStatusCode":400, - "senderFault":true - }, - "exception":true - }, "CreateAwsLogSourceRequest":{ "type":"structure", - "required":["inputOrder"], + "required":["sources"], "members":{ - "enableAllDimensions":{ - "shape":"AllDimensionsMap", - "documentation":"Enables data collection from specific Amazon Web Services sources in all specific accounts and specific Regions.
" - }, - "enableSingleDimension":{ - "shape":"InputSet", - "documentation":"Enables data collection from all Amazon Web Services sources in specific accounts or Regions.
" - }, - "enableTwoDimensions":{ - "shape":"TwoDimensionsMap", - "documentation":"Enables data collection from specific Amazon Web Services sources in specific accounts or Regions.
" - }, - "inputOrder":{ - "shape":"DimensionSet", - "documentation":"Specifies the input order to enable dimensions in Security Lake, namely Region, source type, and member account.
" + "sources":{ + "shape":"AwsLogSourceConfigurationList", + "documentation":"Specify the natively-supported Amazon Web Services service to add as a source in Security Lake.
" } } }, @@ -801,156 +735,145 @@ "failed":{ "shape":"AccountList", "documentation":"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.
" - }, - "processing":{ - "shape":"AccountList", - "documentation":"Lists the accounts that are in the process of enabling a natively supported Amazon Web Service as a Security Lake source.
" } } }, "CreateCustomLogSourceRequest":{ "type":"structure", - "required":[ - "customSourceName", - "eventClass", - "glueInvocationRoleArn", - "logProviderAccountId" - ], + "required":["sourceName"], "members":{ - "customSourceName":{ - "shape":"CustomSourceType", - "documentation":"The name for a third-party custom source. This must be a Regionally unique value.
" + "configuration":{ + "shape":"CustomLogSourceConfiguration", + "documentation":"The configuration for the third-party custom source.
" }, - "eventClass":{ - "shape":"OcsfEventClass", - "documentation":"The Open Cybersecurity Schema Framework (OCSF) event class which describes the type of data that the custom source will send to Security Lake.
" + "eventClasses":{ + "shape":"OcsfEventClassList", + "documentation":"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
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
Specify the name for a third-party custom source. This must be a Regionally unique value.
" }, - "logProviderAccountId":{ - "shape":"AwsAccountId", - "documentation":"The Amazon Web Services account ID of the custom source that will write logs and events into the Amazon S3 Data Lake.
" + "sourceVersion":{ + "shape":"CustomLogSourceVersion", + "documentation":"Specify the source version for the third-party custom source, to limit log collection to a specific version of custom data source.
" } } }, "CreateCustomLogSourceResponse":{ "type":"structure", - "required":[ - "customDataLocation", - "glueCrawlerName", - "glueDatabaseName", - "glueTableName", - "logProviderAccessRoleArn" - ], "members":{ - "customDataLocation":{ - "shape":"String", - "documentation":"The location of the partition in the Amazon S3 bucket for Security Lake.
" - }, - "glueCrawlerName":{ - "shape":"String", - "documentation":"The name of the Glue crawler.
" - }, - "glueDatabaseName":{ - "shape":"String", - "documentation":"The Glue database where results are written, such as: arn:aws:daylight:us-east-1::database/sometable/*.
The table name of the Glue crawler.
" - }, - "logProviderAccessRoleArn":{ - "shape":"String", - "documentation":"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.
The created third-party custom source.
" } } }, - "CreateDatalakeAutoEnableRequest":{ + "CreateDataLakeExceptionSubscriptionRequest":{ "type":"structure", - "required":["configurationForNewAccounts"], + "required":[ + "notificationEndpoint", + "subscriptionProtocol" + ], "members":{ - "configurationForNewAccounts":{ - "shape":"AutoEnableNewRegionConfigurationList", - "documentation":"Enable Security Lake with the specified configuration settings to begin collecting security data for new accounts in your organization.
" + "exceptionTimeToLive":{ + "shape":"CreateDataLakeExceptionSubscriptionRequestExceptionTimeToLiveLong", + "documentation":"The expiration period and time-to-live (TTL).
" + }, + "notificationEndpoint":{ + "shape":"SafeString", + "documentation":"The Amazon Web Services account where you want to receive exception notifications.
" + }, + "subscriptionProtocol":{ + "shape":"SubscriptionProtocol", + "documentation":"The subscription protocol to which exception notifications are posted.
" } } }, - "CreateDatalakeAutoEnableResponse":{ + "CreateDataLakeExceptionSubscriptionRequestExceptionTimeToLiveLong":{ + "type":"long", + "box":true, + "min":1 + }, + "CreateDataLakeExceptionSubscriptionResponse":{ "type":"structure", "members":{ } }, - "CreateDatalakeDelegatedAdminRequest":{ + "CreateDataLakeOrganizationConfigurationRequest":{ "type":"structure", - "required":["account"], + "required":["autoEnableNewAccount"], "members":{ - "account":{ - "shape":"SafeString", - "documentation":"The Amazon Web Services account ID of the Security Lake delegated administrator.
" + "autoEnableNewAccount":{ + "shape":"DataLakeAutoEnableNewAccountConfigurationList", + "documentation":"Enable Security Lake with the specified configuration settings, to begin collecting security data for new accounts in your organization.
" } } }, - "CreateDatalakeDelegatedAdminResponse":{ + "CreateDataLakeOrganizationConfigurationResponse":{ "type":"structure", "members":{ } }, - "CreateDatalakeExceptionsSubscriptionRequest":{ + "CreateDataLakeRequest":{ "type":"structure", "required":[ - "notificationEndpoint", - "subscriptionProtocol" + "configurations", + "metaStoreManagerRoleArn" ], "members":{ - "notificationEndpoint":{ - "shape":"SafeString", - "documentation":"The Amazon Web Services account where you want to receive exception notifications.
" + "configurations":{ + "shape":"DataLakeConfigurationList", + "documentation":"Specify the Region or Regions that will contribute data to the rollup region.
" }, - "subscriptionProtocol":{ - "shape":"SubscriptionProtocolType", - "documentation":"The subscription protocol to which exception notifications are posted.
" + "metaStoreManagerRoleArn":{ + "shape":"RoleArn", + "documentation":"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.
" } } }, - "CreateDatalakeExceptionsSubscriptionResponse":{ + "CreateDataLakeResponse":{ "type":"structure", "members":{ + "dataLakes":{ + "shape":"DataLakeResourceList", + "documentation":"The created Security Lake configuration object.
" + } } }, - "CreateDatalakeRequest":{ + "CreateSubscriberNotificationRequest":{ "type":"structure", + "required":[ + "configuration", + "subscriberId" + ], "members":{ - "configurations":{ - "shape":"LakeConfigurationRequestMap", - "documentation":"Specify the Region or Regions that will contribute data to the rollup region.
" - }, - "enableAll":{ - "shape":"Boolean", - "documentation":"Enable Security Lake in all Regions.
" - }, - "metaStoreManagerRoleArn":{ - "shape":"RoleArn", - "documentation":"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.
" + "configuration":{ + "shape":"NotificationConfiguration", + "documentation":"Specify the configuration using which you want to create the subscriber notification.
" }, - "regions":{ - "shape":"RegionSet", - "documentation":"Enable Security Lake in the specified Regions. To enable Security Lake in specific Amazon Web Services Regions, such as us-east-1 or ap-northeast-3, provide the Region codes. For a list of Region codes, see Amazon Security Lake endpoints in the Amazon Web Services General Reference.
" + "subscriberId":{ + "shape":"UUID", + "documentation":"The subscriber ID for the notification subscription.
", + "location":"uri", + "locationName":"subscriberId" } } }, - "CreateDatalakeResponse":{ + "CreateSubscriberNotificationResponse":{ "type":"structure", "members":{ + "subscriberEndpoint":{ + "shape":"SafeString", + "documentation":"The subscriber endpoint to which exception messages are posted.
" + } } }, "CreateSubscriberRequest":{ "type":"structure", "required":[ - "accountId", - "externalId", - "sourceTypes", + "sources", + "subscriberIdentity", "subscriberName" ], "members":{ @@ -958,21 +881,17 @@ "shape":"AccessTypeList", "documentation":"The Amazon S3 or Lake Formation access type.
" }, - "accountId":{ - "shape":"AwsAccountId", - "documentation":"The Amazon Web Services account ID used to access your data.
" - }, - "externalId":{ - "shape":"SafeString", - "documentation":"The external ID of the subscriber. This lets the user that is assuming the role assert the circumstances in which they are operating. It also provides a way for the account owner to permit the role to be assumed only under specific circumstances.
" - }, - "sourceTypes":{ - "shape":"SourceTypeList", + "sources":{ + "shape":"LogSourceResourceList", "documentation":"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.
" }, "subscriberDescription":{ "shape":"DescriptionString", - "documentation":"The description for your subscriber account in Security Lake.
" + "documentation":"The description for your subscriber account in Security Lake.
" + }, + "subscriberIdentity":{ + "shape":"AwsIdentity", + "documentation":"The AWS identity used to access your data.
" }, "subscriberName":{ "shape":"CreateSubscriberRequestSubscriberNameString", @@ -987,416 +906,606 @@ }, "CreateSubscriberResponse":{ "type":"structure", - "required":["subscriptionId"], "members":{ - "resourceShareArn":{ - "shape":"ResourceShareArn", - "documentation":"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.
" + "subscriber":{ + "shape":"SubscriberResource", + "documentation":"Retrieve information about the subscriber created using the CreateSubscriber API.
The ARN of the Glue crawler.
" }, - "resourceShareName":{ - "shape":"ResourceShareName", - "documentation":"The name of the resource share.
" + "databaseArn":{ + "shape":"AmazonResourceName", + "documentation":"The ARN of the Glue database where results are written, such as: arn:aws:daylight:us-east-1::database/sometable/*.
The ARN of the Glue table.
" + } + }, + "documentation":"The attributes of a third-party custom source.
" + }, + "CustomLogSourceConfiguration":{ + "type":"structure", + "required":[ + "crawlerConfiguration", + "providerIdentity" + ], + "members":{ + "crawlerConfiguration":{ + "shape":"CustomLogSourceCrawlerConfiguration", + "documentation":"The configuration for the Glue Crawler for the third-party custom source.
" }, + "providerIdentity":{ + "shape":"AwsIdentity", + "documentation":"The identity of the log provider for the third-party custom source.
" + } + }, + "documentation":"The configuration for the third-party custom source.
" + }, + "CustomLogSourceCrawlerConfiguration":{ + "type":"structure", + "required":["roleArn"], + "members":{ "roleArn":{ "shape":"RoleArn", - "documentation":"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 Amazon Security Lake User Guide.
" + "documentation":"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
The configuration for the Glue Crawler for the third-party custom source.
" + }, + "CustomLogSourceName":{ + "type":"string", + "max":64, + "min":1, + "pattern":"^[\\\\\\w\\-_:/.]*$" + }, + "CustomLogSourceProvider":{ + "type":"structure", + "members":{ + "location":{ + "shape":"S3URI", + "documentation":"The location of the partition in the Amazon S3 bucket for Security Lake.
" }, - "s3BucketArn":{ - "shape":"S3BucketArn", - "documentation":"The ARN for the Amazon S3 bucket.
" + "roleArn":{ + "shape":"RoleArn", + "documentation":"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.
The details of the log provider for a third-party custom source.
" + }, + "CustomLogSourceResource":{ + "type":"structure", + "members":{ + "attributes":{ + "shape":"CustomLogSourceAttributes", + "documentation":"The attributes of a third-party custom source.
" }, - "snsArn":{ - "shape":"SnsTopicArn", - "documentation":"The ARN for the Amazon Simple Notification Service.
" + "provider":{ + "shape":"CustomLogSourceProvider", + "documentation":"The details of the log provider for a third-party custom source.
" }, - "subscriptionId":{ - "shape":"UUID", - "documentation":"The subscriptionId created by the CreateSubscriber API call.
The name for a third-party custom source. This must be a Regionally unique value.
" + }, + "sourceVersion":{ + "shape":"CustomLogSourceVersion", + "documentation":"The version for a third-party custom source. This must be a Regionally unique value.
" } - } + }, + "documentation":"Amazon Security Lake can collect logs and events from third-party custom sources.
" }, - "CreateSubscriptionNotificationConfigurationRequest":{ + "CustomLogSourceVersion":{ + "type":"string", + "max":32, + "min":1, + "pattern":"^[A-Za-z0-9\\-\\.\\_]*$" + }, + "DataLakeAutoEnableNewAccountConfiguration":{ "type":"structure", - "required":["subscriptionId"], + "required":[ + "region", + "sources" + ], "members":{ - "createSqs":{ - "shape":"Boolean", - "documentation":"Create an Amazon Simple Queue Service queue.
" + "region":{ + "shape":"Region", + "documentation":"The Amazon Web Services Regions where Security Lake is automatically enabled.
" }, - "httpsApiKeyName":{ - "shape":"String", - "documentation":"The key name for the notification subscription.
" + "sources":{ + "shape":"AwsLogSourceResourceList", + "documentation":"The Amazon Web Services sources that are automatically enabled in Security Lake.
" + } + }, + "documentation":"Automatically enable new organization accounts as member accounts from an Amazon Security Lake administrator account.
" + }, + "DataLakeAutoEnableNewAccountConfigurationList":{ + "type":"list", + "member":{"shape":"DataLakeAutoEnableNewAccountConfiguration"} + }, + "DataLakeConfiguration":{ + "type":"structure", + "required":["region"], + "members":{ + "encryptionConfiguration":{ + "shape":"DataLakeEncryptionConfiguration", + "documentation":"Provides encryption details of Amazon Security Lake object.
" + }, + "lifecycleConfiguration":{ + "shape":"DataLakeLifecycleConfiguration", + "documentation":"Provides lifecycle details of Amazon Security Lake object.
" + }, + "region":{ + "shape":"Region", + "documentation":"The Amazon Web Services Regions where Security Lake is automatically enabled.
" }, - "httpsApiKeyValue":{ + "replicationConfiguration":{ + "shape":"DataLakeReplicationConfiguration", + "documentation":"Provides replication details of Amazon Security Lake object.
" + } + }, + "documentation":"Provides details of Amazon Security Lake object.
" + }, + "DataLakeConfigurationList":{ + "type":"list", + "member":{"shape":"DataLakeConfiguration"} + }, + "DataLakeEncryptionConfiguration":{ + "type":"structure", + "members":{ + "kmsKeyId":{ "shape":"String", - "documentation":"The key value for the notification subscription.
" + "documentation":"The id of KMS encryption key used by Amazon Security Lake to encrypt the Security Lake object.
" + } + }, + "documentation":"Provides encryption details of Amazon Security Lake object.
" + }, + "DataLakeException":{ + "type":"structure", + "members":{ + "exception":{ + "shape":"SafeString", + "documentation":"The underlying exception of a Security Lake exception.
" }, - "httpsMethod":{ - "shape":"HttpsMethod", - "documentation":"The HTTPS method used for the notification subscription.
" + "region":{ + "shape":"Region", + "documentation":"The Amazon Web Services Regions where the exception occurred.
" }, - "roleArn":{ - "shape":"RoleArn", - "documentation":"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.
" + "remediation":{ + "shape":"SafeString", + "documentation":"List of all remediation steps for a Security Lake exception.
" }, - "subscriptionEndpoint":{ - "shape":"CreateSubscriptionNotificationConfigurationRequestSubscriptionEndpointString", - "documentation":"The subscription endpoint in Security Lake. If you prefer notification with an HTTPs endpoint, populate this field.
" + "timestamp":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"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.
" + } + }, + "documentation":"The details for a Security Lake exception
" + }, + "DataLakeExceptionList":{ + "type":"list", + "member":{"shape":"DataLakeException"} + }, + "DataLakeLifecycleConfiguration":{ + "type":"structure", + "members":{ + "expiration":{ + "shape":"DataLakeLifecycleExpiration", + "documentation":"Provides data expiration details of Amazon Security Lake object.
" }, - "subscriptionId":{ - "shape":"UUID", - "documentation":"The subscription ID for the notification subscription.
", - "location":"uri", - "locationName":"subscriptionId" + "transitions":{ + "shape":"DataLakeLifecycleTransitionList", + "documentation":"Provides data storage transition details of Amazon Security Lake object.
" } - } + }, + "documentation":"Provides lifecycle details of Amazon Security Lake object.
" }, - "CreateSubscriptionNotificationConfigurationRequestSubscriptionEndpointString":{ - "type":"string", - "pattern":"^(arn:aws:.+$|https?://.+$)" + "DataLakeLifecycleExpiration":{ + "type":"structure", + "members":{ + "days":{ + "shape":"DataLakeLifecycleExpirationDaysInteger", + "documentation":"Number of days before data expires in the Amazon Security Lake object.
" + } + }, + "documentation":"Provide expiration lifecycle details of Amazon Security Lake object.
" + }, + "DataLakeLifecycleExpirationDaysInteger":{ + "type":"integer", + "box":true, + "min":1 }, - "CreateSubscriptionNotificationConfigurationResponse":{ + "DataLakeLifecycleTransition":{ "type":"structure", "members":{ - "queueArn":{ - "shape":"SafeString", - "documentation":"Returns the Amazon Resource Name (ARN) of the queue.
" + "days":{ + "shape":"DataLakeLifecycleTransitionDaysInteger", + "documentation":"Number of days before data transitions to a different S3 Storage Class in the Amazon Security Lake object.
" + }, + "storageClass":{ + "shape":"DataLakeStorageClass", + "documentation":"The range of storage classes that you can choose from based on the data access, resiliency, and cost requirements of your workloads.
" } - } + }, + "documentation":"Provide transition lifecycle details of Amazon Security Lake object.
" }, - "CustomSourceType":{ - "type":"string", - "pattern":"^[\\\\\\w\\-_:/.]*$" + "DataLakeLifecycleTransitionDaysInteger":{ + "type":"integer", + "box":true, + "min":1 }, - "DeleteAwsLogSourceRequest":{ + "DataLakeLifecycleTransitionList":{ + "type":"list", + "member":{"shape":"DataLakeLifecycleTransition"} + }, + "DataLakeReplicationConfiguration":{ "type":"structure", - "required":["inputOrder"], "members":{ - "disableAllDimensions":{ - "shape":"AllDimensionsMap", - "documentation":"Removes the specific Amazon Web Services sources from specific accounts and specific Regions.
" + "regions":{ + "shape":"RegionList", + "documentation":"Replication enables automatic, asynchronous copying of objects across Amazon S3 buckets. Amazon 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 Amazon Web Services Regions or within the same Region as the source bucket.
Set up one or more rollup Regions by providing the Region or Regions that should contribute to the central rollup Region.
" }, - "disableSingleDimension":{ - "shape":"InputSet", - "documentation":"Removes all Amazon Web Services sources from specific accounts or Regions.
" + "roleArn":{ + "shape":"RoleArn", + "documentation":"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.
" + } + }, + "documentation":"Provides replication details of Amazon Security Lake object.
" + }, + "DataLakeResource":{ + "type":"structure", + "required":[ + "dataLakeArn", + "region" + ], + "members":{ + "createStatus":{ + "shape":"DataLakeStatus", + "documentation":"Retrieves the status of the configuration operation for an account in Amazon Security Lake.
" }, - "disableTwoDimensions":{ - "shape":"TwoDimensionsMap", - "documentation":"Remove a specific Amazon Web Services source from specific accounts or Regions.
" + "dataLakeArn":{ + "shape":"AmazonResourceName", + "documentation":"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.
" }, - "inputOrder":{ - "shape":"DimensionSet", - "documentation":"This is a mandatory input. Specify the input order to disable dimensions in Security Lake, namely Region (Amazon Web Services Region code, source type, and member (account ID of a specific Amazon Web Services account).
" + "encryptionConfiguration":{ + "shape":"DataLakeEncryptionConfiguration", + "documentation":"Provides encryption details of Amazon Security Lake object.
" + }, + "lifecycleConfiguration":{ + "shape":"DataLakeLifecycleConfiguration", + "documentation":"Provides lifecycle details of Amazon Security Lake object.
" + }, + "region":{ + "shape":"Region", + "documentation":"The Amazon Web Services Regions where Security Lake is enabled.
" + }, + "replicationConfiguration":{ + "shape":"DataLakeReplicationConfiguration", + "documentation":"Provides replication details of Amazon Security Lake object.
" + }, + "s3BucketArn":{ + "shape":"S3BucketArn", + "documentation":"The ARN for the Amazon Security Lake Amazon S3 bucket.
" + }, + "updateStatus":{ + "shape":"DataLakeUpdateStatus", + "documentation":"The status of the last UpdateDataLake or DeleteDataLake API request.
Provides details of Amazon Security Lake object.
" }, - "DeleteAwsLogSourceResponse":{ + "DataLakeResourceList":{ + "type":"list", + "member":{"shape":"DataLakeResource"} + }, + "DataLakeSource":{ "type":"structure", "members":{ - "failed":{ - "shape":"AccountList", - "documentation":"Deletion of the Amazon Web Services sources failed as the account is not a part of the organization.
" + "account":{ + "shape":"String", + "documentation":"The ID of the Security Lake account for which logs are collected.
" }, - "processing":{ - "shape":"AccountList", - "documentation":"Deletion of the Amazon Web Services sources is in progress.
" + "eventClasses":{ + "shape":"OcsfEventClassList", + "documentation":"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
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.
" + }, + "sourceStatuses":{ + "shape":"DataLakeSourceStatusList", + "documentation":"The log status for the Security Lake account.
" } - } + }, + "documentation":"Amazon Security Lake collects logs and events from supported Amazon Web Services and custom sources. For the list of supported Amazon Web Services, see the Amazon Security Lake User Guide.
" }, - "DeleteCustomLogSourceRequest":{ + "DataLakeSourceList":{ + "type":"list", + "member":{"shape":"DataLakeSource"} + }, + "DataLakeSourceStatus":{ "type":"structure", - "required":["customSourceName"], "members":{ - "customSourceName":{ + "resource":{ "shape":"String", - "documentation":"The custom source name for the custom log source.
", - "location":"querystring", - "locationName":"customSourceName" + "documentation":"Defines path the stored logs are available which has information on your systems, applications, and services.
" + }, + "status":{ + "shape":"SourceCollectionStatus", + "documentation":"The health status of services, including error codes and patterns.
" } - } + }, + "documentation":"Retrieves the Logs status for the Amazon Security Lake account.
" }, - "DeleteCustomLogSourceResponse":{ + "DataLakeSourceStatusList":{ + "type":"list", + "member":{"shape":"DataLakeSourceStatus"} + }, + "DataLakeStatus":{ + "type":"string", + "enum":[ + "INITIALIZED", + "PENDING", + "COMPLETED", + "FAILED" + ] + }, + "DataLakeStorageClass":{"type":"string"}, + "DataLakeUpdateException":{ "type":"structure", - "required":["customDataLocation"], "members":{ - "customDataLocation":{ + "code":{ "shape":"String", - "documentation":"The location of the partition in the Amazon S3 bucket for Security Lake.
" + "documentation":"The reason code for the exception of the last UpdateDataLake or DeleteDataLake API request.
The reason for the exception of the last UpdateDataLakeor DeleteDataLake API request.
The details of the last UpdateDataLake or DeleteDataLake API request which failed.
Remove automatic enablement of configuration settings for new member accounts in Security Lake.
" + "exception":{ + "shape":"DataLakeUpdateException", + "documentation":"The details of the last UpdateDataLakeor DeleteDataLake API request which failed.
The unique ID for the last UpdateDataLake or DeleteDataLake API request.
The status of the last UpdateDataLake or DeleteDataLake API request that was requested.
The status of the last UpdateDataLake or DeleteDataLake API request. This is set to Completed after the configuration is updated, or removed if deletion of the data lake is successful.
Specify the natively-supported Amazon Web Services service to remove as a source in Security Lake.
" } } }, - "DeleteDatalakeAutoEnableResponse":{ + "DeleteAwsLogSourceResponse":{ "type":"structure", "members":{ + "failed":{ + "shape":"AccountList", + "documentation":"Deletion of the Amazon Web Services sources failed as the account is not a part of the organization.
" + } } }, - "DeleteDatalakeDelegatedAdminRequest":{ + "DeleteCustomLogSourceRequest":{ "type":"structure", - "required":["account"], + "required":["sourceName"], "members":{ - "account":{ - "shape":"SafeString", - "documentation":"The account ID the Security Lake delegated administrator.
", + "sourceName":{ + "shape":"CustomLogSourceName", + "documentation":"The source name of custom log source that you want to delete.
", "location":"uri", - "locationName":"account" + "locationName":"sourceName" + }, + "sourceVersion":{ + "shape":"CustomLogSourceVersion", + "documentation":"The source version for the third-party custom source. You can limit the custom source removal to the specified source version.
", + "location":"querystring", + "locationName":"sourceVersion" } } }, - "DeleteDatalakeDelegatedAdminResponse":{ + "DeleteCustomLogSourceResponse":{ "type":"structure", "members":{ } }, - "DeleteDatalakeExceptionsSubscriptionRequest":{ + "DeleteDataLakeExceptionSubscriptionRequest":{ "type":"structure", "members":{ } }, - "DeleteDatalakeExceptionsSubscriptionResponse":{ + "DeleteDataLakeExceptionSubscriptionResponse":{ "type":"structure", - "required":["status"], "members":{ - "status":{ - "shape":"SafeString", - "documentation":"Retrieves the status of the delete Security Lake operation for an account.
" - } } }, - "DeleteDatalakeRequest":{ + "DeleteDataLakeOrganizationConfigurationRequest":{ "type":"structure", + "required":["autoEnableNewAccount"], "members":{ + "autoEnableNewAccount":{ + "shape":"DataLakeAutoEnableNewAccountConfigurationList", + "documentation":"Removes the automatic enablement of configuration settings for new member accounts in Security Lake.
" + } } }, - "DeleteDatalakeResponse":{ + "DeleteDataLakeOrganizationConfigurationResponse":{ "type":"structure", "members":{ } }, - "DeleteSubscriberRequest":{ + "DeleteDataLakeRequest":{ "type":"structure", - "required":["id"], + "required":["regions"], "members":{ - "id":{ - "shape":"String", - "documentation":"A value created by Security Lake that uniquely identifies your DeleteSubscriber API request.
The list of Regions where Security Lake is enabled.
" } } }, - "DeleteSubscriberResponse":{ + "DeleteDataLakeResponse":{ "type":"structure", "members":{ } }, - "DeleteSubscriptionNotificationConfigurationRequest":{ + "DeleteSubscriberNotificationRequest":{ "type":"structure", - "required":["subscriptionId"], + "required":["subscriberId"], "members":{ - "subscriptionId":{ + "subscriberId":{ "shape":"UUID", "documentation":"The ID of the Security Lake subscriber account.
", "location":"uri", - "locationName":"subscriptionId" + "locationName":"subscriberId" } } }, - "DeleteSubscriptionNotificationConfigurationResponse":{ + "DeleteSubscriberNotificationResponse":{ "type":"structure", "members":{ } }, - "DescriptionString":{ - "type":"string", - "pattern":"^[\\\\\\w\\s\\-_:/,.@=+]*$" - }, - "Dimension":{ - "type":"string", - "enum":[ - "REGION", - "SOURCE_TYPE", - "MEMBER" - ] - }, - "DimensionSet":{ - "type":"list", - "member":{"shape":"Dimension"} - }, - "EndpointProtocol":{ - "type":"string", - "enum":[ - "HTTPS", - "SQS" - ] - }, - "EventBridgeException":{ - "type":"structure", - "required":["message"], - "members":{ - "message":{"shape":"String"} - }, - "documentation":"Represents an error interacting with the Amazon EventBridge service.
", - "error":{ - "httpStatusCode":400, - "senderFault":true - }, - "exception":true - }, - "Failures":{ - "type":"structure", - "required":[ - "exceptionMessage", - "remediation", - "timestamp" - ], - "members":{ - "exceptionMessage":{ - "shape":"SafeString", - "documentation":"List of all exception messages.
" - }, - "remediation":{ - "shape":"SafeString", - "documentation":"List of all remediation steps for failures.
" - }, - "timestamp":{ - "shape":"SyntheticTimestamp_date_time", - "documentation":"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.
" - } - }, - "documentation":"List of all failures.
" - }, - "FailuresResponse":{ + "DeleteSubscriberRequest":{ "type":"structure", + "required":["subscriberId"], "members":{ - "failures":{ - "shape":"Failureslist", - "documentation":"List of all failures.
" - }, - "region":{ - "shape":"SafeString", - "documentation":"List of Amazon Web Services Regions where the failure occurred.
" + "subscriberId":{ + "shape":"UUID", + "documentation":"A value created by Security Lake that uniquely identifies your DeleteSubscriber API request.
Response element for actions that make changes, namely create, update, or delete actions.
" - }, - "FailuresResponseList":{ - "type":"list", - "member":{"shape":"FailuresResponse"} - }, - "Failureslist":{ - "type":"list", - "member":{"shape":"Failures"} - }, - "GetDatalakeAutoEnableRequest":{ - "type":"structure", - "members":{ } }, - "GetDatalakeAutoEnableResponse":{ + "DeleteSubscriberResponse":{ "type":"structure", - "required":["autoEnableNewAccounts"], "members":{ - "autoEnableNewAccounts":{ - "shape":"AutoEnableNewRegionConfigurationList", - "documentation":"The configuration for new accounts.
" - } } }, - "GetDatalakeExceptionsExpiryRequest":{ + "DeregisterDataLakeDelegatedAdministratorRequest":{ "type":"structure", "members":{ } }, - "GetDatalakeExceptionsExpiryResponse":{ + "DeregisterDataLakeDelegatedAdministratorResponse":{ "type":"structure", - "required":["exceptionMessageExpiry"], "members":{ - "exceptionMessageExpiry":{ - "shape":"Long", - "documentation":"The expiration period and time-to-live (TTL).
" - } } }, - "GetDatalakeExceptionsSubscriptionRequest":{ + "DescriptionString":{ + "type":"string", + "pattern":"^[\\\\\\w\\s\\-_:/,.@=+]*$" + }, + "ExternalId":{ + "type":"string", + "max":1224, + "min":2, + "pattern":"^[\\w+=,.@:\\/-]*$" + }, + "GetDataLakeExceptionSubscriptionRequest":{ "type":"structure", "members":{ } }, - "GetDatalakeExceptionsSubscriptionResponse":{ + "GetDataLakeExceptionSubscriptionResponse":{ "type":"structure", - "required":["protocolAndNotificationEndpoint"], "members":{ - "protocolAndNotificationEndpoint":{ - "shape":"ProtocolAndNotificationEndpoint", - "documentation":"Retrieves the exception notification subscription information.
" + "exceptionTimeToLive":{ + "shape":"Long", + "documentation":"The expiration period and time-to-live (TTL).
" + }, + "notificationEndpoint":{ + "shape":"SafeString", + "documentation":"The Amazon Web Services account where you receive exception notifications.
" + }, + "subscriptionProtocol":{ + "shape":"SubscriptionProtocol", + "documentation":"The subscription protocol to which exception notifications are posted.
" } } }, - "GetDatalakeRequest":{ + "GetDataLakeOrganizationConfigurationRequest":{ "type":"structure", "members":{ } }, - "GetDatalakeResponse":{ + "GetDataLakeOrganizationConfigurationResponse":{ "type":"structure", - "required":["configurations"], "members":{ - "configurations":{ - "shape":"LakeConfigurationResponseMap", - "documentation":"Retrieves the Security Lake configuration object.
" + "autoEnableNewAccount":{ + "shape":"DataLakeAutoEnableNewAccountConfigurationList", + "documentation":"The configuration for new accounts.
" } } }, - "GetDatalakeStatusRequest":{ + "GetDataLakeSourcesRequest":{ "type":"structure", "members":{ - "accountSet":{ - "shape":"InputSet", + "accounts":{ + "shape":"AccountList", "documentation":"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.
" }, - "maxAccountResults":{ - "shape":"Integer", + "maxResults":{ + "shape":"MaxResults", "documentation":"The maximum limit of accounts for which the static snapshot of the current Region, including enabled accounts and log sources, is retrieved.
" }, "nextToken":{ - "shape":"SafeString", - "documentation":"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.
" + "shape":"NextToken", + "documentation":"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.
" } } }, - "GetDatalakeStatusResponse":{ + "GetDataLakeSourcesResponse":{ "type":"structure", - "required":["accountSourcesList"], "members":{ - "accountSourcesList":{ - "shape":"AccountSourcesList", + "dataLakeArn":{ + "shape":"AmazonResourceName", + "documentation":"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.
" + }, + "dataLakeSources":{ + "shape":"DataLakeSourceList", "documentation":"The list of enabled accounts and enabled sources.
" }, "nextToken":{ - "shape":"SafeString", - "documentation":"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.
" + "shape":"NextToken", + "documentation":"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.
" } } }, "GetSubscriberRequest":{ "type":"structure", - "required":["id"], + "required":["subscriberId"], "members":{ - "id":{ - "shape":"String", + "subscriberId":{ + "shape":"UUID", "documentation":"A value created by Amazon Security Lake that uniquely identifies your GetSubscriber API request.
The subscription information for the specified subscription ID.
" + "documentation":"The subscriber information for the specified subscriber ID.
" } } }, - "HttpsMethod":{ + "HttpMethod":{ "type":"string", "enum":[ "POST", "PUT" ] }, - "InputSet":{ - "type":"list", - "member":{"shape":"SafeString"} + "HttpsNotificationConfiguration":{ + "type":"structure", + "required":[ + "endpoint", + "targetRoleArn" + ], + "members":{ + "authorizationApiKeyName":{ + "shape":"String", + "documentation":"The key name for the notification subscription.
" + }, + "authorizationApiKeyValue":{ + "shape":"String", + "documentation":"The key value for the notification subscription.
" + }, + "endpoint":{ + "shape":"HttpsNotificationConfigurationEndpointString", + "documentation":"The subscription endpoint in Security Lake. If you prefer notification with an HTTPs endpoint, populate this field.
" + }, + "httpMethod":{ + "shape":"HttpMethod", + "documentation":"The HTTPS method used for the notification subscription.
" + }, + "targetRoleArn":{ + "shape":"RoleArn", + "documentation":"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.
" + } + }, + "documentation":"The configurations for HTTPS subscriber notification.
" + }, + "HttpsNotificationConfigurationEndpointString":{ + "type":"string", + "pattern":"^https?://.+$" }, "Integer":{ "type":"integer", @@ -1426,194 +1565,100 @@ }, "InternalServerException":{ "type":"structure", - "required":["message"], "members":{ - "message":{"shape":"String"}, - "retryAfterSeconds":{ - "shape":"Integer", - "documentation":"Retry the request after the specified time.
", - "location":"header", - "locationName":"Retry-After" - } + "message":{"shape":"String"} }, - "documentation":"Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting, perform the operation again.
", + "documentation":"Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting, perform the operation again.
", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "retryable":{"throttling":false} }, - "InvalidInputException":{ - "type":"structure", - "required":["message"], - "members":{ - "message":{"shape":"String"} - }, - "documentation":"The request was rejected because a value that's not valid or is out of range was supplied for an input parameter.
", - "error":{ - "httpStatusCode":400, - "senderFault":true - }, - "exception":true - }, - "LakeConfigurationRequest":{ - "type":"structure", - "members":{ - "encryptionKey":{ - "shape":"String", - "documentation":"The type of encryption key used by Amazon Security Lake to encrypt the Security Lake configuration object.
" - }, - "replicationDestinationRegions":{ - "shape":"RegionSet", - "documentation":"Replication enables automatic, asynchronous copying of objects across Amazon S3 buckets. Amazon 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 Amazon Web Services Regions or within the same Region as the source bucket.
Set up one or more rollup Regions by providing the Region or Regions that should contribute to the central rollup Region.
" - }, - "replicationRoleArn":{ - "shape":"RoleArn", - "documentation":"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.
" - }, - "retentionSettings":{ - "shape":"RetentionSettingList", - "documentation":"Retention settings for the destination Amazon S3 buckets.
" - }, - "tagsMap":{ - "shape":"TagsMap", - "documentation":"A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value, both of which you define.
" - } - }, - "documentation":"Provides details of Amazon Security Lake configuration object.
" - }, - "LakeConfigurationRequestMap":{ - "type":"map", - "key":{"shape":"Region"}, - "value":{"shape":"LakeConfigurationRequest"} - }, - "LakeConfigurationResponse":{ + "ListDataLakeExceptionsRequest":{ "type":"structure", "members":{ - "encryptionKey":{ - "shape":"String", - "documentation":"The type of encryption key used by secure the Security Lake configuration object.
" - }, - "replicationDestinationRegions":{ - "shape":"RegionSet", - "documentation":"Replication enables automatic, asynchronous copying of objects across Amazon S3 buckets. Amazon 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 Amazon Web Services Regions or within the same Region as the source bucket.
Set up one or more rollup Regions by providing the Region or Regions that should contribute to the central rollup Region.
" - }, - "replicationRoleArn":{ - "shape":"RoleArn", - "documentation":"Replication settings for the Amazon S3 buckets. This parameter uses the IAM role you created that is managed by Security Lake, to ensure the replication setting is correct.
" - }, - "retentionSettings":{ - "shape":"RetentionSettingList", - "documentation":"Retention settings for the destination Amazon S3 buckets.
" - }, - "s3BucketArn":{ - "shape":"S3BucketArn", - "documentation":"Amazon Resource Names (ARNs) uniquely identify Amazon Web Services resources. Security Lake requires an ARN when you need to specify a resource unambiguously across all of Amazon Web Services, such as in IAM policies, Amazon Relational Database Service (Amazon RDS) tags, and API calls.
" - }, - "status":{ - "shape":"settingsStatus", - "documentation":"Retrieves the status of the configuration operation for an account in Amazon Security Lake.
" + "maxResults":{ + "shape":"MaxResults", + "documentation":"List the maximum number of failures in Security Lake.
" }, - "tagsMap":{ - "shape":"TagsMap", - "documentation":"A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value, both of which you define.
" + "nextToken":{ + "shape":"NextToken", + "documentation":"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.
" }, - "updateStatus":{ - "shape":"UpdateStatus", - "documentation":"The status of the last UpdateDatalake or DeleteDatalake API request.
List the Amazon Web Services Regions from which exceptions are retrieved.
" } - }, - "documentation":"Provides details of Amazon Security Lake lake configuration object.
" - }, - "LakeConfigurationResponseMap":{ - "type":"map", - "key":{"shape":"Region"}, - "value":{"shape":"LakeConfigurationResponse"} + } }, - "LastUpdateFailure":{ + "ListDataLakeExceptionsResponse":{ "type":"structure", "members":{ - "code":{ - "shape":"String", - "documentation":"The reason code for the failure of the last UpdateDatalake or DeleteDatalake API request.
Lists the failures that cannot be retried in the current Region.
" }, - "reason":{ - "shape":"String", - "documentation":"The reason for the failure of the last UpdateDatalakeor DeleteDatalake API request.
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.
" } - }, - "documentation":"The details of the last UpdateDatalake or DeleteDatalake API request which failed.
List the maximum number of failures in Security Lake.
" - }, - "nextToken":{ - "shape":"SafeString", - "documentation":"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.
" - }, - "regionSet":{ - "shape":"RegionSet", - "documentation":"List the Amazon Web Services Regions from which exceptions are retrieved.
" + "regions":{ + "shape":"RegionList", + "documentation":"The list of regions where Security Lake is enabled.
", + "location":"querystring", + "locationName":"regions" } } }, - "ListDatalakeExceptionsResponse":{ + "ListDataLakesResponse":{ "type":"structure", - "required":["nonRetryableFailures"], "members":{ - "nextToken":{ - "shape":"SafeString", - "documentation":"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.
" - }, - "nonRetryableFailures":{ - "shape":"FailuresResponseList", - "documentation":"Lists the failures that cannot be retried in the current Region.
" + "dataLakes":{ + "shape":"DataLakeResourceList", + "documentation":"Retrieves the Security Lake configuration object.
" } } }, "ListLogSourcesRequest":{ "type":"structure", "members":{ - "inputOrder":{ - "shape":"DimensionSet", - "documentation":"Lists the log sources in input order, namely Region, source type, and member account.
" - }, - "listAllDimensions":{ - "shape":"AllDimensionsMap", - "documentation":"List the view of log sources for enabled Amazon Security Lake accounts for specific Amazon Web Services sources from specific accounts and specific Regions.
" - }, - "listSingleDimension":{ - "shape":"InputSet", - "documentation":"List the view of log sources for enabled Security Lake accounts for all Amazon Web Services sources from specific accounts or specific Regions.
" - }, - "listTwoDimensions":{ - "shape":"TwoDimensionsMap", - "documentation":"Lists the view of log sources for enabled Security Lake accounts for specific Amazon Web Services sources from specific accounts or specific Regions.
" + "accounts":{ + "shape":"AccountList", + "documentation":"The list of Amazon Web Services accounts for which log sources are displayed.
" }, "maxResults":{ - "shape":"Integer", + "shape":"MaxResults", "documentation":"The maximum number of accounts for which the log sources are displayed.
" }, "nextToken":{ - "shape":"SafeString", + "shape":"NextToken", "documentation":"If nextToken is returned, there are more results available. You can repeat the call using the returned token to retrieve the next page.
" + }, + "regions":{ + "shape":"RegionList", + "documentation":"The list of regions for which log sources are displayed.
" + }, + "sources":{ + "shape":"LogSourceResourceList", + "documentation":"The list of sources for which log sources are displayed.
" } } }, "ListLogSourcesResponse":{ "type":"structure", - "required":["regionSourceTypesAccountsList"], "members":{ "nextToken":{ - "shape":"String", + "shape":"NextToken", "documentation":"If nextToken is returned, there are more results available. You can repeat the call using the returned token to retrieve the next page.
" }, - "regionSourceTypesAccountsList":{ - "shape":"RegionSourceTypesAccountsList", - "documentation":"Lists the log sources by Regions for enabled Security Lake accounts.
" + "sources":{ + "shape":"LogSourceList", + "documentation":"The list of log sources in your organization that send data to the data lake.
" } } }, @@ -1621,13 +1666,13 @@ "type":"structure", "members":{ "maxResults":{ - "shape":"Integer", + "shape":"MaxResults", "documentation":"The maximum number of accounts for which the configuration is displayed.
", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ - "shape":"String", + "shape":"NextToken", "documentation":"If nextToken is returned, there are more results available. You can repeat the call using the returned token to retrieve the next page.
", "location":"querystring", "locationName":"nextToken" @@ -1636,128 +1681,125 @@ }, "ListSubscribersResponse":{ "type":"structure", - "required":["subscribers"], "members":{ "nextToken":{ - "shape":"String", + "shape":"NextToken", "documentation":"If nextToken is returned, there are more results available. You can repeat the call using the returned token to retrieve the next page.
" }, - "subscribers":{ - "shape":"SubscriberList", - "documentation":"The subscribers available for the specified Security Lake account ID.
" + "subscribers":{ + "shape":"SubscriberResourceList", + "documentation":"The subscribers available for the specified Security Lake account ID.
" + } + } + }, + "LogSource":{ + "type":"structure", + "members":{ + "account":{ + "shape":"AwsAccountId", + "documentation":"Specify the account from which you want to collect logs.
" + }, + "region":{ + "shape":"Region", + "documentation":"Specify the Regions from which you want to collect logs.
" + }, + "sources":{ + "shape":"LogSourceResourceList", + "documentation":"Specify the sources from which you want to collect logs.
" } - } + }, + "documentation":"Amazon Security Lake can collect logs and events from natively-supported Amazon Web Services services and custom sources.
" + }, + "LogSourceList":{ + "type":"list", + "member":{"shape":"LogSource"} }, - "LogsStatus":{ + "LogSourceResource":{ "type":"structure", - "required":[ - "healthStatus", - "pathToLogs" - ], "members":{ - "healthStatus":{ - "shape":"SourceStatus", - "documentation":"The health status of services, including error codes and patterns.
" + "awsLogSource":{ + "shape":"AwsLogSourceResource", + "documentation":"Amazon Security Lake supports log and event collection for natively supported Amazon Web Services.
" }, - "pathToLogs":{ - "shape":"String", - "documentation":"Defines path the stored logs are available which has information on your systems, applications, and services.
" + "customLogSource":{ + "shape":"CustomLogSourceResource", + "documentation":"Amazon Security Lake supports custom source types. For a detailed list, see the Amazon Security Lake User Guide.
" } }, - "documentation":"Retrieves the Logs status for the Amazon Security Lake account.
" + "documentation":"The supported source types from which logs and events are collected in Amazon Security Lake. For the list of supported Amazon Web Services, see the Amazon Security Lake User Guide.
", + "union":true }, - "LogsStatusList":{ + "LogSourceResourceList":{ "type":"list", - "member":{"shape":"LogsStatus"} + "member":{"shape":"LogSourceResource"} }, "Long":{ "type":"long", "box":true }, - "OcsfEventClass":{ + "MaxResults":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "NextToken":{ "type":"string", - "enum":[ - "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" - ] + "pattern":"^[\\\\\\w\\-_:/.@=+]*$" }, - "ProtocolAndNotificationEndpoint":{ + "NotificationConfiguration":{ "type":"structure", "members":{ - "endpoint":{ - "shape":"SafeString", - "documentation":"The account that is subscribed to receive exception notifications.
" + "httpsNotificationConfiguration":{ + "shape":"HttpsNotificationConfiguration", + "documentation":"The configurations for HTTPS subscriber notification.
" }, - "protocol":{ - "shape":"SafeString", - "documentation":"The protocol to which notification messages are posted.
" + "sqsNotificationConfiguration":{ + "shape":"SqsNotificationConfiguration", + "documentation":"The configurations for SQS subscriber notification.
" } }, - "documentation":"Protocol used in Amazon Security Lake that dictates how notifications are posted at the endpoint.
" + "documentation":"Specify the configurations you want to use for subscriber notification to notify the subscriber when new data is written to the data lake for sources that the subscriber consumes in Security Lake.
", + "union":true + }, + "OcsfEventClass":{ + "type":"string", + "pattern":"^[A-Z\\_0-9]*$" + }, + "OcsfEventClassList":{ + "type":"list", + "member":{"shape":"OcsfEventClass"} }, "Region":{ "type":"string", - "enum":[ - "us-east-1", - "us-west-2", - "eu-central-1", - "us-east-2", - "eu-west-1", - "ap-northeast-1", - "ap-southeast-2" - ] + "pattern":"^(af|ap|ca|eu|me|sa|us)-(central|north|(north(?:east|west))|south|south(?:east|west)|east|west)-\\d+$" }, - "RegionSet":{ + "RegionList":{ "type":"list", "member":{"shape":"Region"} }, - "RegionSourceTypesAccountsList":{ - "type":"list", - "member":{"shape":"AllDimensionsMap"} + "RegisterDataLakeDelegatedAdministratorRequest":{ + "type":"structure", + "required":["accountId"], + "members":{ + "accountId":{ + "shape":"SafeString", + "documentation":"The Amazon Web Services account ID of the Security Lake delegated administrator.
" + } + } + }, + "RegisterDataLakeDelegatedAdministratorResponse":{ + "type":"structure", + "members":{ + } }, "ResourceNotFoundException":{ "type":"structure", - "required":[ - "message", - "resourceId", - "resourceType" - ], "members":{ "message":{"shape":"String"}, - "resourceId":{ + "resourceName":{ "shape":"String", - "documentation":"The ID of the resource for which the type of resource could not be found.
" + "documentation":"The name of the resource that could not be found.
" }, "resourceType":{ "shape":"String", @@ -1776,154 +1818,54 @@ "type":"string", "pattern":"^LakeFormation(?:-V[0-9]+)-([a-zA-Z0-9]+)-([\\\\\\w\\-_:/.@=+]*)$" }, - "RetentionSetting":{ - "type":"structure", - "members":{ - "retentionPeriod":{ - "shape":"RetentionSettingRetentionPeriodInteger", - "documentation":"The retention period specifies a fixed period of time during which the Security Lake object remains locked. You can specify the retention period in days for one or more sources.
" - }, - "storageClass":{ - "shape":"StorageClass", - "documentation":"The range of storage classes that you can choose from based on the data access, resiliency, and cost requirements of your workloads.
" - } - }, - "documentation":"Retention settings for the destination Amazon S3 buckets in Amazon Security Lake.
" - }, - "RetentionSettingList":{ - "type":"list", - "member":{"shape":"RetentionSetting"} - }, - "RetentionSettingRetentionPeriodInteger":{ - "type":"integer", - "box":true, - "min":1 - }, "RoleArn":{ "type":"string", - "pattern":"^arn:.*" + "pattern":"^arn:.*$" }, "S3BucketArn":{"type":"string"}, - "S3Exception":{ - "type":"structure", - "required":["message"], - "members":{ - "message":{"shape":"String"} - }, - "documentation":"Provides an extension of the AmazonServiceException for errors reported by Amazon S3 while processing a request. In particular, this class provides access to the Amazon S3 extended request ID. If Amazon S3 is incorrectly handling a request and you need to contact Amazon, this extended request ID may provide useful debugging information.
", - "error":{ - "httpStatusCode":400, - "senderFault":true - }, - "exception":true + "S3URI":{ + "type":"string", + "documentation":"A complete S3 URI pointing to a valid S3 object.
", + "max":1024, + "min":0, + "pattern":"^s3[an]?://[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9](/[^/].*)+$" }, "SafeString":{ "type":"string", "pattern":"^[\\\\\\w\\-_:/.@=+]*$" }, - "ServiceQuotaExceededException":{ - "type":"structure", - "required":[ - "message", - "quotaCode", - "resourceId", - "resourceType", - "serviceCode" - ], - "members":{ - "message":{"shape":"String"}, - "quotaCode":{ - "shape":"String", - "documentation":"That the rate of requests to Security Lake is exceeding the request quotas for your Amazon Web Services account.
" - }, - "resourceId":{ - "shape":"String", - "documentation":"The ID of the resource that exceeds the service quota.
" - }, - "resourceType":{ - "shape":"String", - "documentation":"The type of the resource that exceeds the service quota.
" - }, - "serviceCode":{ - "shape":"String", - "documentation":"The code for the service in Service Quotas.
" - } - }, - "documentation":"You have exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use Service Quotas to request a service quota increase.
", - "error":{ - "httpStatusCode":402, - "senderFault":true - }, - "exception":true - }, - "SnsTopicArn":{"type":"string"}, - "SourceStatus":{ + "SourceCollectionStatus":{ "type":"string", "enum":[ - "ACTIVE", - "DEACTIVATED", - "PENDING" + "COLLECTING", + "MISCONFIGURED", + "NOT_COLLECTING" ] }, - "SourceType":{ + "SqsNotificationConfiguration":{ "type":"structure", "members":{ - "awsSourceType":{ - "shape":"AwsLogSourceType", - "documentation":"Amazon Security Lake supports log and event collection for natively supported Amazon Web Services.
" - }, - "customSourceType":{ - "shape":"CustomSourceType", - "documentation":"Amazon Security Lake supports custom source types. For a detailed list, see the Amazon Security Lake User Guide.
" - } }, - "documentation":"The supported source types from which logs and events are collected in Amazon Security Lake. For the list of supported Amazon Web Services, see the Amazon Security Lake User Guide.
", - "union":true - }, - "SourceTypeList":{ - "type":"list", - "member":{"shape":"SourceType"} - }, - "StorageClass":{ - "type":"string", - "enum":[ - "STANDARD_IA", - "ONEZONE_IA", - "INTELLIGENT_TIERING", - "GLACIER_IR", - "GLACIER", - "DEEP_ARCHIVE", - "EXPIRE" - ] + "documentation":"The configurations for SQS subscriber notification.
" }, "String":{"type":"string"}, - "SubscriberList":{ - "type":"list", - "member":{"shape":"SubscriberResource"} - }, "SubscriberResource":{ "type":"structure", "required":[ - "accountId", - "sourceTypes", - "subscriptionId" + "sources", + "subscriberArn", + "subscriberId", + "subscriberIdentity", + "subscriberName" ], "members":{ "accessTypes":{ "shape":"AccessTypeList", - "documentation":"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.
The Amazon Web Services account ID you are using to create your Amazon Security Lake account.
" + "documentation":"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.
The date and time when the subscription was created.
" - }, - "externalId":{ - "shape":"SafeString", - "documentation":"The external ID of the subscriber. The external ID lets the user that is assuming the role assert the circumstances in which they are operating. It also provides a way for the account owner to permit the role to be assumed only under specific circumstances.
" + "documentation":"The date and time when the subscriber was created.
" }, "resourceShareArn":{ "shape":"ResourceShareArn", @@ -1939,62 +1881,52 @@ }, "s3BucketArn":{ "shape":"S3BucketArn", - "documentation":"The ARN for the Amazon S3 bucket.
" - }, - "snsArn":{ - "shape":"SnsTopicArn", - "documentation":"The ARN for the Amazon Simple Notification Service.
" + "documentation":"The ARN for the Amazon S3 bucket.
" }, - "sourceTypes":{ - "shape":"SourceTypeList", + "sources":{ + "shape":"LogSourceResourceList", "documentation":"Amazon Security Lake supports log and event collection for natively supported Amazon Web Services. For more information, see the Amazon Security Lake User Guide.
" }, + "subscriberArn":{ + "shape":"AmazonResourceName", + "documentation":"The subscriber ARN of the Amazon Security Lake subscriber account.
" + }, "subscriberDescription":{ "shape":"SafeString", - "documentation":"The subscriber descriptions for a subscriber account. The description for a subscriber includes subscriberName, accountID, externalID, and subscriptionId.
The subscriber descriptions for a subscriber account. The description for a subscriber includes subscriberName, accountID, externalID, and subscriberId.
The name of your Amazon Security Lake subscriber account.
" - }, - "subscriptionEndpoint":{ - "shape":"String", - "documentation":"The subscription endpoint to which exception messages are posted.
" + "documentation":"The subscriber endpoint to which exception messages are posted.
" }, - "subscriptionId":{ + "subscriberId":{ "shape":"UUID", - "documentation":"The subscription ID of the Amazon Security Lake subscriber account.
" + "documentation":"The subscriber ID of the Amazon Security Lake subscriber account.
" }, - "subscriptionProtocol":{ - "shape":"EndpointProtocol", - "documentation":"The subscription protocol to which exception messages are posted.
" + "subscriberIdentity":{ + "shape":"AwsIdentity", + "documentation":"The AWS identity used to access your data.
" + }, + "subscriberName":{ + "shape":"SafeString", + "documentation":"The name of your Amazon Security Lake subscriber account.
" }, - "subscriptionStatus":{ - "shape":"SubscriptionStatus", - "documentation":"The subscription status of the Amazon Security Lake subscriber account.
" + "subscriberStatus":{ + "shape":"SubscriberStatus", + "documentation":"The subscriber status of the Amazon Security Lake subscriber account.
" }, "updatedAt":{ "shape":"SyntheticTimestamp_date_time", - "documentation":"The date and time when the subscription was created.
" + "documentation":"The date and time when the subscriber was last updated.
" } }, - "documentation":"Provides details about the Amazon Security Lake account subscription. Subscribers are notified of new objects for a source as the data is written to your Amazon S3 bucket for Security Lake.
" + "documentation":"Provides details about the Amazon Security Lake account subscription. Subscribers are notified of new objects for a source as the data is written to your Amazon S3 bucket for Security Lake.
" }, - "SubscriptionProtocolType":{ - "type":"string", - "enum":[ - "HTTP", - "HTTPS", - "EMAIL", - "EMAIL_JSON", - "SMS", - "SQS", - "LAMBDA", - "APP", - "FIREHOSE" - ] + "SubscriberResourceList":{ + "type":"list", + "member":{"shape":"SubscriberResource"} }, - "SubscriptionStatus":{ + "SubscriberStatus":{ "type":"string", "enum":[ "ACTIVE", @@ -2003,18 +1935,16 @@ "READY" ] }, + "SubscriptionProtocol":{ + "type":"string", + "pattern":"^[a-z\\-]*$" + }, "SyntheticTimestamp_date_time":{ "type":"timestamp", "timestampFormat":"iso8601" }, - "TagsMap":{ - "type":"map", - "key":{"shape":"String"}, - "value":{"shape":"String"} - }, "ThrottlingException":{ "type":"structure", - "required":["message"], "members":{ "message":{"shape":"String"}, "quotaCode":{ @@ -2023,7 +1953,7 @@ }, "retryAfterSeconds":{ "shape":"Integer", - "documentation":"Retry the request after the specified time.
", + "documentation":"Retry the request after the specified time.
", "location":"header", "locationName":"Retry-After" }, @@ -2032,7 +1962,7 @@ "documentation":"The code for the service in Service Quotas.
" } }, - "documentation":"The limit on the number of requests per second was exceeded.
", + "documentation":"The limit on the number of requests per second was exceeded.
", "error":{ "httpStatusCode":429, "senderFault":true @@ -2040,118 +1970,113 @@ "exception":true, "retryable":{"throttling":true} }, - "TwoDimensionsMap":{ - "type":"map", - "key":{"shape":"String"}, - "value":{"shape":"ValueSet"} - }, "UUID":{ "type":"string", - "pattern":"[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}" - }, - "UpdateDatalakeExceptionsExpiryRequest":{ - "type":"structure", - "required":["exceptionMessageExpiry"], - "members":{ - "exceptionMessageExpiry":{ - "shape":"UpdateDatalakeExceptionsExpiryRequestExceptionMessageExpiryLong", - "documentation":"The time-to-live (TTL) for the exception message to remain.
" - } - } - }, - "UpdateDatalakeExceptionsExpiryRequestExceptionMessageExpiryLong":{ - "type":"long", - "box":true, - "min":1 + "pattern":"^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" }, - "UpdateDatalakeExceptionsExpiryResponse":{ - "type":"structure", - "members":{ - } - }, - "UpdateDatalakeExceptionsSubscriptionRequest":{ + "UpdateDataLakeExceptionSubscriptionRequest":{ "type":"structure", "required":[ "notificationEndpoint", "subscriptionProtocol" ], "members":{ + "exceptionTimeToLive":{ + "shape":"UpdateDataLakeExceptionSubscriptionRequestExceptionTimeToLiveLong", + "documentation":"The time-to-live (TTL) for the exception message to remain.
" + }, "notificationEndpoint":{ "shape":"SafeString", "documentation":"The account that is subscribed to receive exception notifications.
" }, "subscriptionProtocol":{ - "shape":"SubscriptionProtocolType", - "documentation":"The subscription protocol to which exception messages are posted.
" + "shape":"SubscriptionProtocol", + "documentation":"The subscription protocol to which exception messages are posted.
" } } }, - "UpdateDatalakeExceptionsSubscriptionResponse":{ + "UpdateDataLakeExceptionSubscriptionRequestExceptionTimeToLiveLong":{ + "type":"long", + "box":true, + "min":1 + }, + "UpdateDataLakeExceptionSubscriptionResponse":{ "type":"structure", "members":{ } }, - "UpdateDatalakeRequest":{ + "UpdateDataLakeRequest":{ "type":"structure", "required":["configurations"], "members":{ "configurations":{ - "shape":"LakeConfigurationRequestMap", + "shape":"DataLakeConfigurationList", "documentation":"Specify the Region or Regions that will contribute data to the rollup region.
" } } }, - "UpdateDatalakeResponse":{ + "UpdateDataLakeResponse":{ "type":"structure", "members":{ + "dataLakes":{ + "shape":"DataLakeResourceList", + "documentation":"The created Security Lake configuration object.
" + } } }, - "UpdateStatus":{ + "UpdateSubscriberNotificationRequest":{ "type":"structure", + "required":[ + "configuration", + "subscriberId" + ], "members":{ - "lastUpdateFailure":{ - "shape":"LastUpdateFailure", - "documentation":"The details of the last UpdateDatalakeor DeleteDatalake API request which failed.
The unique ID for the UpdateDatalake or DeleteDatalake API request.
The configuration for subscriber notification.
" }, - "lastUpdateStatus":{ - "shape":"settingsStatus", - "documentation":"The status of the last UpdateDatalake or DeleteDatalake API request that was requested.
The subscription ID for which the subscription notification is specified.
", + "location":"uri", + "locationName":"subscriberId" } - }, - "documentation":"The status of the last UpdateDatalake or DeleteDatalake API request. This is set to Completed after the configuration is updated, or removed if deletion of the data lake is successful.
The external ID of the Security Lake account.
" - }, - "id":{ - "shape":"String", - "documentation":"A value created by Security Lake that uniquely identifies your subscription.
", - "location":"uri", - "locationName":"id" - }, - "sourceTypes":{ - "shape":"SourceTypeList", + "documentation":"The subscriber endpoint to which exception messages are posted.
" + } + } + }, + "UpdateSubscriberRequest":{ + "type":"structure", + "required":["subscriberId"], + "members":{ + "sources":{ + "shape":"LogSourceResourceList", "documentation":"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.
" }, "subscriberDescription":{ "shape":"DescriptionString", "documentation":"The description of the Security Lake account subscriber.
" }, + "subscriberId":{ + "shape":"UUID", + "documentation":"A value created by Security Lake that uniquely identifies your subscription.
", + "location":"uri", + "locationName":"subscriberId" + }, + "subscriberIdentity":{ + "shape":"AwsIdentity", + "documentation":"The AWS identity used to access your data.
" + }, "subscriberName":{ "shape":"UpdateSubscriberRequestSubscriberNameString", - "documentation":"The name of the Security Lake account subscriber.
" + "documentation":"The name of the Security Lake account subscriber.
" } } }, @@ -2166,127 +2091,10 @@ "members":{ "subscriber":{ "shape":"SubscriberResource", - "documentation":"The account of the subscriber.
" - } - } - }, - "UpdateSubscriptionNotificationConfigurationRequest":{ - "type":"structure", - "required":["subscriptionId"], - "members":{ - "createSqs":{ - "shape":"Boolean", - "documentation":"Create a new subscription notification for the specified subscription ID in Amazon Security Lake.
" - }, - "httpsApiKeyName":{ - "shape":"String", - "documentation":"The key name for the subscription notification.
" - }, - "httpsApiKeyValue":{ - "shape":"String", - "documentation":"The key value for the subscription notification.
" - }, - "httpsMethod":{ - "shape":"HttpsMethod", - "documentation":"The HTTPS method used for the subscription notification.
" - }, - "roleArn":{ - "shape":"RoleArn", - "documentation":"The Amazon Resource Name (ARN) specifying the role of the subscriber. For more information about ARNs and how to use them in policies, see, see the Managing data access and Amazon Web Services Managed Policiesin the Amazon Security Lake User Guide.
" - }, - "subscriptionEndpoint":{ - "shape":"UpdateSubscriptionNotificationConfigurationRequestSubscriptionEndpointString", - "documentation":"The subscription endpoint in Security Lake.
" - }, - "subscriptionId":{ - "shape":"UUID", - "documentation":"The subscription ID for which the subscription notification is specified.
", - "location":"uri", - "locationName":"subscriptionId" - } - } - }, - "UpdateSubscriptionNotificationConfigurationRequestSubscriptionEndpointString":{ - "type":"string", - "pattern":"^(arn:aws:.+$|https?://.+$)" - }, - "UpdateSubscriptionNotificationConfigurationResponse":{ - "type":"structure", - "members":{ - "queueArn":{ - "shape":"SafeString", - "documentation":"Returns the ARN of the queue.
" + "documentation":"The updated subscriber information.
" } } - }, - "ValidationException":{ - "type":"structure", - "required":[ - "message", - "reason" - ], - "members":{ - "fieldList":{ - "shape":"ValidationExceptionFieldList", - "documentation":"The list of parameters that failed to validate.
" - }, - "message":{"shape":"String"}, - "reason":{ - "shape":"ValidationExceptionReason", - "documentation":"The reason for the validation exception.
" - } - }, - "documentation":"Your signing certificate could not be validated.
", - "error":{ - "httpStatusCode":400, - "senderFault":true - }, - "exception":true - }, - "ValidationExceptionField":{ - "type":"structure", - "required":[ - "message", - "name" - ], - "members":{ - "message":{ - "shape":"String", - "documentation":"Describes the error encountered.
" - }, - "name":{ - "shape":"String", - "documentation":"Name of the validation exception.
" - } - }, - "documentation":"The input fails to meet the constraints specified in Amazon Security Lake.
" - }, - "ValidationExceptionFieldList":{ - "type":"list", - "member":{"shape":"ValidationExceptionField"} - }, - "ValidationExceptionReason":{ - "type":"string", - "enum":[ - "unknownOperation", - "cannotParse", - "fieldValidationFailed", - "other" - ] - }, - "ValueSet":{ - "type":"list", - "member":{"shape":"String"} - }, - "settingsStatus":{ - "type":"string", - "enum":[ - "INITIALIZED", - "PENDING", - "COMPLETED", - "FAILED" - ] } }, - "documentation":"Amazon Security Lake is in preview release. Your use of the Security Lake preview is subject to Section 2 of the Amazon Web Services Service Terms(\"Betas and Previews\").
Amazon Security Lake is a fully managed security data lake service. You can use Security Lake to automatically centralize security data from cloud, on-premises, and custom sources into a data lake that's stored in your Amazon Web Servicesaccount. Amazon Web Services Organizations is an account management service that lets you consolidate multiple Amazon Web Services accounts into an organization that you create and centrally manage. With Organizations, you can create member accounts and invite existing accounts to join your organization. Security Lake helps you analyze security data for a more complete understanding of your security posture across the entire organization. It can also help you improve the protection of your workloads, applications, and data.
The data lake is backed by Amazon Simple Storage Service (Amazon S3) buckets, and you retain ownership over your data.
Amazon Security Lake integrates with CloudTrail, a service that provides a record of actions taken by a user, role, or an Amazon Web Services service in Security Lake CloudTrail captures API calls for Security Lake as events. The calls captured include calls from the Security Lake console and code calls to the Security Lake API operations. If you create a trail, you can enable continuous delivery of CloudTrail events to an Amazon S3 bucket, including events for Security Lake. If you don't configure a trail, you can still view the most recent events in the CloudTrail console in Event history. Using the information collected by CloudTrail you can determine the request that was made to Security Lake, the IP address from which the request was made, who made the request, when it was made, and additional details. To learn more about Security Lake information in CloudTrail, see the Amazon Security Lake User Guide.
Security Lake automates the collection of security-related log and event data from integrated Amazon Web Services and third-party services. It also helps you manage the lifecycle of data with customizable retention and replication settings. Security Lake converts ingested data into Apache Parquet format and a standard open-source schema called the Open Cybersecurity Schema Framework (OCSF).
Other Amazon Web Services and third-party services can subscribe to the data that's stored in Security Lake for incident response and security data analytics.
" + "documentation":"Amazon Security Lake is a fully managed security data lake service. You can use Security Lake to automatically centralize security data from cloud, on-premises, and custom sources into a data lake that's stored in your Amazon Web Services account. Amazon Web Services Organizations is an account management service that lets you consolidate multiple Amazon Web Services accounts into an organization that you create and centrally manage. With Organizations, you can create member accounts and invite existing accounts to join your organization. Security Lake helps you analyze security data for a more complete understanding of your security posture across the entire organization. It can also help you improve the protection of your workloads, applications, and data.
The data lake is backed by Amazon Simple Storage Service (Amazon S3) buckets, and you retain ownership over your data.
Amazon Security Lake integrates with CloudTrail, a service that provides a record of actions taken by a user, role, or an Amazon Web Services service. In Security Lake, CloudTrail captures API calls for Security Lake as events. The calls captured include calls from the Security Lake console and code calls to the Security Lake API operations. If you create a trail, you can enable continuous delivery of CloudTrail events to an Amazon S3 bucket, including events for Security Lake. If you don't configure a trail, you can still view the most recent events in the CloudTrail console in Event history. Using the information collected by CloudTrail you can determine the request that was made to Security Lake, the IP address from which the request was made, who made the request, when it was made, and additional details. To learn more about Security Lake information in CloudTrail, see the Amazon Security Lake User Guide.
Security Lake automates the collection of security-related log and event data from integrated Amazon Web Services and third-party services. It also helps you manage the lifecycle of data with customizable retention and replication settings. Security Lake converts ingested data into Apache Parquet format and a standard open-source schema called the Open Cybersecurity Schema Framework (OCSF).
Other Amazon Web Services and third-party services can subscribe to the data that's stored in Security Lake for incident response and security data analytics.
" }