SecurityLake / Client / delete_aws_log_source
delete_aws_log_source#
- SecurityLake.Client.delete_aws_log_source(**kwargs)#
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.
See also: AWS API Documentation
Request Syntax
response = client.delete_aws_log_source( disableAllDimensions={ 'string': { 'string': [ 'string', ] } }, disableSingleDimension=[ 'string', ], disableTwoDimensions={ 'string': [ 'string', ] }, inputOrder=[ 'REGION'|'SOURCE_TYPE'|'MEMBER', ] )
- Parameters:
disableAllDimensions (dict) –
Removes the specific Amazon Web Services sources from specific accounts and specific Regions.
(string) –
(dict) –
(string) –
(list) –
(string) –
disableSingleDimension (list) –
Removes all Amazon Web Services sources from specific accounts or Regions.
(string) –
disableTwoDimensions (dict) –
Remove a specific Amazon Web Services source from specific accounts or Regions.
(string) –
(list) –
(string) –
inputOrder (list) –
[REQUIRED]
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).
(string) –
- Return type:
dict
- Returns:
Response Syntax
{ 'failed': [ 'string', ], 'processing': [ 'string', ] }
Response Structure
(dict) –
failed (list) –
Deletion of the Amazon Web Services sources failed as the account is not a part of the organization.
(string) –
processing (list) –
Deletion of the Amazon Web Services sources is in progress.
(string) –
Exceptions
SecurityLake.Client.exceptions.InternalServerException
SecurityLake.Client.exceptions.ValidationException
SecurityLake.Client.exceptions.AccessDeniedException
SecurityLake.Client.exceptions.AccountNotFoundException