AWS SDK for PHP 3.x (original) (raw)
Client: Aws\SecurityLake\SecurityLakeClient
Service ID: securitylake
Version: 2018-05-10
This page describes the parameters and results for the operations of the Amazon Security Lake (2018-05-10), and shows how to use the Aws\SecurityLake\SecurityLakeClientobject to call the described operations. This documentation is specific to the 2018-05-10 API version of the service.
Operation Summary
Each of the following operations can be created from a client using$client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).
CreateAwsLogSource ( array $params = [] )
Adds a natively supported Amazon Web Services service as an Amazon Security Lake source.
CreateCustomLogSource ( array $params = [] )
Adds a third-party custom source in Amazon Security Lake, from the Amazon Web Services Region where you want to create a custom source.
CreateDataLake ( array $params = [] )
Initializes an Amazon Security Lake instance with the provided (or default) configuration.
CreateDataLakeExceptionSubscription ( array $params = [] )
Creates the specified notification subscription in Amazon Security Lake for the organization you specify.
CreateDataLakeOrganizationConfiguration ( array $params = [] )
Automatically enables Amazon Security Lake for new member accounts in your organization.
CreateSubscriber ( array $params = [] )
Creates a subscriber for accounts that are already enabled in Amazon Security Lake.
CreateSubscriberNotification ( array $params = [] )
Notifies the subscriber when new data is written to the data lake for the sources that the subscriber consumes in Security Lake.
DeleteAwsLogSource ( array $params = [] )
Removes a natively supported Amazon Web Services service as an Amazon Security Lake source.
DeleteCustomLogSource ( array $params = [] )
Removes a custom log source from Amazon Security Lake, to stop sending data from the custom source to Security Lake.
DeleteDataLake ( array $params = [] )
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.
DeleteDataLakeExceptionSubscription ( array $params = [] )
Deletes the specified notification subscription in Amazon Security Lake for the organization you specify.
DeleteDataLakeOrganizationConfiguration ( array $params = [] )
Turns off automatic enablement of Amazon Security Lake for member accounts that are added to an organization in Organizations.
DeleteSubscriber ( array $params = [] )
Deletes the subscription permission and all notification settings for accounts that are already enabled in Amazon Security Lake.
DeleteSubscriberNotification ( array $params = [] )
Deletes the specified subscription notification in Amazon Security Lake for the organization you specify.
DeregisterDataLakeDelegatedAdministrator ( array $params = [] )
Deletes the Amazon Security Lake delegated administrator account for the organization.
GetDataLakeExceptionSubscription ( array $params = [] )
Retrieves the protocol and endpoint that were provided when subscribing to Amazon SNS topics for exception notifications.
GetDataLakeOrganizationConfiguration ( array $params = [] )
Retrieves the configuration that will be automatically set up for accounts added to the organization after the organization has onboarded to Amazon Security Lake.
GetDataLakeSources ( array $params = [] )
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 ( array $params = [] )
Retrieves the subscription information for the specified subscription ID.
ListDataLakeExceptions ( array $params = [] )
Lists the Amazon Security Lake exceptions that you can use to find the source of problems and fix them.
ListDataLakes ( array $params = [] )
Retrieves the Amazon Security Lake configuration object for the specified Amazon Web Services Regions.
ListLogSources ( array $params = [] )
Retrieves the log sources.
ListSubscribers ( array $params = [] )
Lists all subscribers for the specific Amazon Security Lake account ID.
ListTagsForResource ( array $params = [] )
Retrieves the tags (keys and values) that are associated with an Amazon Security Lake resource: a subscriber, or the data lake configuration for your Amazon Web Services account in a particular Amazon Web Services Region.
RegisterDataLakeDelegatedAdministrator ( array $params = [] )
Designates the Amazon Security Lake delegated administrator account for the organization.
TagResource ( array $params = [] )
Adds or updates one or more tags that are associated with an Amazon Security Lake resource: a subscriber, or the data lake configuration for your Amazon Web Services account in a particular Amazon Web Services Region.
UntagResource ( array $params = [] )
Removes one or more tags (keys and values) from an Amazon Security Lake resource: a subscriber, or the data lake configuration for your Amazon Web Services account in a particular Amazon Web Services Region.
UpdateDataLake ( array $params = [] )
You can use UpdateDataLake to specify where to store your security data, how it should be encrypted at rest and for how long.
UpdateDataLakeExceptionSubscription ( array $params = [] )
Updates the specified notification subscription in Amazon Security Lake for the organization you specify.
UpdateSubscriber ( array $params = [] )
Updates an existing subscription for the given Amazon Security Lake account ID.
UpdateSubscriberNotification ( array $params = [] )
Updates an existing notification method for the subscription (SQS or HTTPs endpoint) or switches the notification subscription endpoint for a subscriber.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
Operations
CreateAwsLogSource
result=result = result=client->createAwsLogSource([/* ... /]); promise=promise = promise=client->createAwsLogSourceAsync([/ ... */]);
Adds a natively supported Amazon Web Services 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 Services 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 services as a source. Use CreateCustomLogSource to enable data collection from a custom source.
Parameter Syntax
result=result = result=client->createAwsLogSource([ 'sources' => [ // REQUIRED [ 'accounts' => ['', ...], 'regions' => ['', ...], // REQUIRED 'sourceName' => 'ROUTE53|VPC_FLOW|SH_FINDINGS|CLOUD_TRAIL_MGMT|LAMBDA_EXECUTION|S3_DATA|EKS_AUDIT|WAF', // REQUIRED 'sourceVersion' => '', ], // ... ], ]);
Parameter Details
Members
sources
Required: Yes
Type: Array of AwsLogSourceConfiguration structures
Specify the natively-supported Amazon Web Services service to add as a source in Security Lake.
Result Syntax
[ 'failed' => ['', ...], ]
Result Details
Members
failed
Lists all accounts in which enabling a natively supported Amazon Web Services service as a Security Lake source failed. The failure occurred as these accounts are not part of an organization.
Errors
The request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
The resource could not be found.
Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting, perform the operation again.
You do not have sufficient access to perform this action. Access denied errors appear when Amazon Security Lake explicitly or implicitly denies an authorization request. An explicit denial occurs when a policy contains a Deny statement for the specific Amazon Web Services action. An implicit denial occurs when there is no applicable Deny statement and also no applicable Allow statement.
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.
The limit on the number of requests per second was exceeded.
CreateCustomLogSource
result=result = result=client->createCustomLogSource([/* ... /]); promise=promise = promise=client->createCustomLogSourceAsync([/ ... */]);
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.
Parameter Syntax
result=result = result=client->createCustomLogSource([ 'configuration' => [ // REQUIRED 'crawlerConfiguration' => [ // REQUIRED 'roleArn' => '', // REQUIRED ], 'providerIdentity' => [ // REQUIRED 'externalId' => '', // REQUIRED 'principal' => '', // REQUIRED ], ], 'eventClasses' => ['', ...], 'sourceName' => '', // REQUIRED 'sourceVersion' => '', ]);
Parameter Details
Members
configuration
Required: Yes
Type: CustomLogSourceConfiguration structure
The configuration used for the third-party custom source.
eventClasses
The Open Cybersecurity Schema Framework (OCSF) event classes which describes the type of data that the custom source will send to Security Lake. For the list of supported event classes, see the Amazon Security Lake User Guide.
sourceName
Required: Yes
Type: string
Specify the name for a third-party custom source. This must be a Regionally unique value. The sourceName you enter here, is used in the LogProviderRole name which follows the convention AmazonSecurityLake-Provider-{name of the custom source}-{region}. You must use a CustomLogSource name that is shorter than or equal to 20 characters. This ensures that the LogProviderRole name is below the 64 character limit.
sourceVersion
Specify the source version for the third-party custom source, to limit log collection to a specific version of custom data source.
Result Syntax
[ 'source' => [ 'attributes' => [ 'crawlerArn' => '', 'databaseArn' => '', 'tableArn' => '', ], 'provider' => [ 'location' => '', 'roleArn' => '', ], 'sourceName' => '', 'sourceVersion' => '', ], ]
Result Details
Members
source
Type: CustomLogSourceResource structure
The third-party custom source that was created.
Errors
The request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
The resource could not be found.
Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting, perform the operation again.
You do not have sufficient access to perform this action. Access denied errors appear when Amazon Security Lake explicitly or implicitly denies an authorization request. An explicit denial occurs when a policy contains a Deny statement for the specific Amazon Web Services action. An implicit denial occurs when there is no applicable Deny statement and also no applicable Allow statement.
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.
The limit on the number of requests per second was exceeded.
CreateDataLake
result=result = result=client->createDataLake([/* ... /]); promise=promise = promise=client->createDataLakeAsync([/ ... */]);
Initializes an Amazon Security Lake instance with the provided (or default) configuration. You can enable Security Lake in Amazon Web Services Regions with customized settings before enabling log collection in Regions. To specify particular Regions, configure these Regions using the configurations parameter. If you have already enabled Security Lake in a Region when you call this command, the command will update the Region if you provide new configuration parameters. If you have not already enabled Security Lake in the Region when you call this API, it will set up the data lake in the Region with the specified configurations.
When you enable Security Lake, it starts ingesting security data after the CreateAwsLogSource call and after you create subscribers using the CreateSubscriber API. 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.
Parameter Syntax
result=result = result=client->createDataLake([ 'configurations' => [ // REQUIRED [ 'encryptionConfiguration' => [ 'kmsKeyId' => '', ], 'lifecycleConfiguration' => [ 'expiration' => [ 'days' => , ], 'transitions' => [ [ 'days' => , 'storageClass' => '', ], // ... ], ], 'region' => '', // REQUIRED 'replicationConfiguration' => [ 'regions' => ['', ...], 'roleArn' => '', ], ], // ... ], 'metaStoreManagerRoleArn' => '', // REQUIRED 'tags' => [ [ 'key' => '', // REQUIRED 'value' => '', // REQUIRED ], // ... ], ]);
Parameter Details
Members
configurations
Required: Yes
Type: Array of DataLakeConfiguration structures
Specify the Region or Regions that will contribute data to the rollup region.
metaStoreManagerRoleArn
Required: Yes
Type: string
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.
tags
Type: Array of Tag structures
An array of objects, one for each tag to associate with the data lake configuration. For each tag, you must specify both a tag key and a tag value. A tag value cannot be null, but it can be an empty string.
Result Syntax
[ 'dataLakes' => [ [ 'createStatus' => 'INITIALIZED|PENDING|COMPLETED|FAILED', 'dataLakeArn' => '', 'encryptionConfiguration' => [ 'kmsKeyId' => '', ], 'lifecycleConfiguration' => [ 'expiration' => [ 'days' => , ], 'transitions' => [ [ 'days' => , 'storageClass' => '', ], // ... ], ], 'region' => '', 'replicationConfiguration' => [ 'regions' => ['', ...], 'roleArn' => '', ], 's3BucketArn' => '', 'updateStatus' => [ 'exception' => [ 'code' => '', 'reason' => '', ], 'requestId' => '', 'status' => 'INITIALIZED|PENDING|COMPLETED|FAILED', ], ], // ... ], ]
Result Details
Members
dataLakes
Type: Array of DataLakeResource structures
The created Security Lake configuration object.
Errors
The request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
The resource could not be found.
Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting, perform the operation again.
You do not have sufficient access to perform this action. Access denied errors appear when Amazon Security Lake explicitly or implicitly denies an authorization request. An explicit denial occurs when a policy contains a Deny statement for the specific Amazon Web Services action. An implicit denial occurs when there is no applicable Deny statement and also no applicable Allow statement.
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.
The limit on the number of requests per second was exceeded.
CreateDataLakeExceptionSubscription
result=result = result=client->createDataLakeExceptionSubscription([/* ... /]); promise=promise = promise=client->createDataLakeExceptionSubscriptionAsync([/ ... */]);
Creates the specified notification subscription in Amazon Security Lake for the organization you specify. The notification subscription is created for exceptions that cannot be resolved by Security Lake automatically.
Parameter Syntax
result=result = result=client->createDataLakeExceptionSubscription([ 'exceptionTimeToLive' => , 'notificationEndpoint' => '', // REQUIRED 'subscriptionProtocol' => '', // REQUIRED ]);
Parameter Details
Members
exceptionTimeToLive
The expiration period and time-to-live (TTL). It is the duration of time until which the exception message remains.
notificationEndpoint
Required: Yes
Type: string
The Amazon Web Services account where you want to receive exception notifications.
subscriptionProtocol
Required: Yes
Type: string
The subscription protocol to which exception notifications are posted.
Result Syntax
[]
Result Details
The results for this operation are always empty.
Errors
The request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
The resource could not be found.
Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting, perform the operation again.
You do not have sufficient access to perform this action. Access denied errors appear when Amazon Security Lake explicitly or implicitly denies an authorization request. An explicit denial occurs when a policy contains a Deny statement for the specific Amazon Web Services action. An implicit denial occurs when there is no applicable Deny statement and also no applicable Allow statement.
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.
The limit on the number of requests per second was exceeded.
CreateDataLakeOrganizationConfiguration
result=result = result=client->createDataLakeOrganizationConfiguration([/* ... /]); promise=promise = promise=client->createDataLakeOrganizationConfigurationAsync([/ ... */]);
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.
This operation merges the new data lake organization configuration with the existing configuration for Security Lake in your organization. If you want to create a new data lake organization configuration, you must delete the existing one using DeleteDataLakeOrganizationConfiguration.
Parameter Syntax
result=result = result=client->createDataLakeOrganizationConfiguration([ 'autoEnableNewAccount' => [ [ 'region' => '', // REQUIRED 'sources' => [ // REQUIRED [ 'sourceName' => 'ROUTE53|VPC_FLOW|SH_FINDINGS|CLOUD_TRAIL_MGMT|LAMBDA_EXECUTION|S3_DATA|EKS_AUDIT|WAF', 'sourceVersion' => '', ], // ... ], ], // ... ], ]);
Parameter Details
Members
autoEnableNewAccount
Type: Array of DataLakeAutoEnableNewAccountConfiguration structures
Enable Security Lake with the specified configuration settings, to begin collecting security data for new accounts in your organization.
Result Syntax
[]
Result Details
The results for this operation are always empty.
Errors
The request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
The resource could not be found.
Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting, perform the operation again.
You do not have sufficient access to perform this action. Access denied errors appear when Amazon Security Lake explicitly or implicitly denies an authorization request. An explicit denial occurs when a policy contains a Deny statement for the specific Amazon Web Services action. An implicit denial occurs when there is no applicable Deny statement and also no applicable Allow statement.
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.
The limit on the number of requests per second was exceeded.
CreateSubscriber
result=result = result=client->createSubscriber([/* ... /]); promise=promise = promise=client->createSubscriberAsync([/ ... */]);
Creates a subscriber 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.
Parameter Syntax
result=result = result=client->createSubscriber([ 'accessTypes' => ['', ...], 'sources' => [ // REQUIRED [ 'awsLogSource' => [ 'sourceName' => 'ROUTE53|VPC_FLOW|SH_FINDINGS|CLOUD_TRAIL_MGMT|LAMBDA_EXECUTION|S3_DATA|EKS_AUDIT|WAF', 'sourceVersion' => '', ], 'customLogSource' => [ 'attributes' => [ 'crawlerArn' => '', 'databaseArn' => '', 'tableArn' => '', ], 'provider' => [ 'location' => '', 'roleArn' => '', ], 'sourceName' => '', 'sourceVersion' => '', ], ], // ... ], 'subscriberDescription' => '', 'subscriberIdentity' => [ // REQUIRED 'externalId' => '', // REQUIRED 'principal' => '', // REQUIRED ], 'subscriberName' => '', // REQUIRED 'tags' => [ [ 'key' => '', // REQUIRED 'value' => '', // REQUIRED ], // ... ], ]);
Parameter Details
Members
accessTypes
The Amazon S3 or Lake Formation access type.
sources
Required: Yes
Type: Array of LogSourceResource structures
The supported Amazon Web Services services from which logs and events are collected. Security Lake supports log and event collection for natively supported Amazon Web Services services.
subscriberDescription
The description for your subscriber account in Security Lake.
subscriberIdentity
Required: Yes
Type: AwsIdentity structure
The Amazon Web Services identity used to access your data.
subscriberName
Required: Yes
Type: string
The name of your Security Lake subscriber account.
tags
Type: Array of Tag structures
An array of objects, one for each tag to associate with the subscriber. For each tag, you must specify both a tag key and a tag value. A tag value cannot be null, but it can be an empty string.
Result Syntax
[ 'subscriber' => [ 'accessTypes' => ['', ...], 'createdAt' => , 'resourceShareArn' => '', 'resourceShareName' => '', 'roleArn' => '', 's3BucketArn' => '', 'sources' => [ [ 'awsLogSource' => [ 'sourceName' => 'ROUTE53|VPC_FLOW|SH_FINDINGS|CLOUD_TRAIL_MGMT|LAMBDA_EXECUTION|S3_DATA|EKS_AUDIT|WAF', 'sourceVersion' => '', ], 'customLogSource' => [ 'attributes' => [ 'crawlerArn' => '', 'databaseArn' => '', 'tableArn' => '', ], 'provider' => [ 'location' => '', 'roleArn' => '', ], 'sourceName' => '', 'sourceVersion' => '', ], ], // ... ], 'subscriberArn' => '', 'subscriberDescription' => '', 'subscriberEndpoint' => '', 'subscriberId' => '', 'subscriberIdentity' => [ 'externalId' => '', 'principal' => '', ], 'subscriberName' => '', 'subscriberStatus' => 'ACTIVE|DEACTIVATED|PENDING|READY', 'updatedAt' => , ], ]
Result Details
Members
subscriber
Type: SubscriberResource structure
Retrieve information about the subscriber created using the CreateSubscriber API.
Errors
The request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
The resource could not be found.
Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting, perform the operation again.
You do not have sufficient access to perform this action. Access denied errors appear when Amazon Security Lake explicitly or implicitly denies an authorization request. An explicit denial occurs when a policy contains a Deny statement for the specific Amazon Web Services action. An implicit denial occurs when there is no applicable Deny statement and also no applicable Allow statement.
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.
The limit on the number of requests per second was exceeded.
CreateSubscriberNotification
result=result = result=client->createSubscriberNotification([/* ... /]); promise=promise = promise=client->createSubscriberNotificationAsync([/ ... */]);
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.
Parameter Syntax
result=result = result=client->createSubscriberNotification([ 'configuration' => [ // REQUIRED 'httpsNotificationConfiguration' => [ 'authorizationApiKeyName' => '', 'authorizationApiKeyValue' => '', 'endpoint' => '', // REQUIRED 'httpMethod' => 'POST|PUT', 'targetRoleArn' => '', // REQUIRED ], 'sqsNotificationConfiguration' => [ ], ], 'subscriberId' => '', // REQUIRED ]);
Parameter Details
Members
configuration
Required: Yes
Type: NotificationConfiguration structure
Specify the configuration using which you want to create the subscriber notification.
subscriberId
Required: Yes
Type: string
The subscriber ID for the notification subscription.
Result Syntax
[ 'subscriberEndpoint' => '', ]
Result Details
Members
subscriberEndpoint
The subscriber endpoint to which exception messages are posted.
Errors
The request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
The resource could not be found.
Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting, perform the operation again.
You do not have sufficient access to perform this action. Access denied errors appear when Amazon Security Lake explicitly or implicitly denies an authorization request. An explicit denial occurs when a policy contains a Deny statement for the specific Amazon Web Services action. An implicit denial occurs when there is no applicable Deny statement and also no applicable Allow statement.
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.
The limit on the number of requests per second was exceeded.
DeleteAwsLogSource
result=result = result=client->deleteAwsLogSource([/* ... /]); promise=promise = promise=client->deleteAwsLogSourceAsync([/ ... */]);
Removes a natively supported Amazon Web Services 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.
Parameter Syntax
result=result = result=client->deleteAwsLogSource([ 'sources' => [ // REQUIRED [ 'accounts' => ['', ...], 'regions' => ['', ...], // REQUIRED 'sourceName' => 'ROUTE53|VPC_FLOW|SH_FINDINGS|CLOUD_TRAIL_MGMT|LAMBDA_EXECUTION|S3_DATA|EKS_AUDIT|WAF', // REQUIRED 'sourceVersion' => '', ], // ... ], ]);
Parameter Details
Members
sources
Required: Yes
Type: Array of AwsLogSourceConfiguration structures
Specify the natively-supported Amazon Web Services service to remove as a source in Security Lake.
Result Syntax
[ 'failed' => ['', ...], ]
Result Details
Members
failed
Deletion of the Amazon Web Services sources failed as the account is not a part of the organization.
Errors
The request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
The resource could not be found.
Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting, perform the operation again.
You do not have sufficient access to perform this action. Access denied errors appear when Amazon Security Lake explicitly or implicitly denies an authorization request. An explicit denial occurs when a policy contains a Deny statement for the specific Amazon Web Services action. An implicit denial occurs when there is no applicable Deny statement and also no applicable Allow statement.
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.
The limit on the number of requests per second was exceeded.
DeleteCustomLogSource
result=result = result=client->deleteCustomLogSource([/* ... /]); promise=promise = promise=client->deleteCustomLogSourceAsync([/ ... */]);
Removes a custom log source from Amazon Security Lake, to stop sending data from the custom source to Security Lake.
Parameter Syntax
result=result = result=client->deleteCustomLogSource([ 'sourceName' => '', // REQUIRED 'sourceVersion' => '', ]);
Parameter Details
Members
sourceName
Required: Yes
Type: string
The source name of custom log source that you want to delete.
sourceVersion
The source version for the third-party custom source. You can limit the custom source removal to the specified source version.
Result Syntax
[]
Result Details
The results for this operation are always empty.
Errors
The request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
The resource could not be found.
Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting, perform the operation again.
You do not have sufficient access to perform this action. Access denied errors appear when Amazon Security Lake explicitly or implicitly denies an authorization request. An explicit denial occurs when a policy contains a Deny statement for the specific Amazon Web Services action. An implicit denial occurs when there is no applicable Deny statement and also no applicable Allow statement.
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.
The limit on the number of requests per second was exceeded.
DeleteDataLake
result=result = result=client->deleteDataLake([/* ... /]); promise=promise = promise=client->deleteDataLakeAsync([/ ... */]);
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.
Parameter Syntax
result=result = result=client->deleteDataLake([ 'regions' => ['', ...], // REQUIRED ]);
Parameter Details
Members
regions
Required: Yes
Type: Array of strings
The list of Regions where Security Lake is enabled.
Result Syntax
[]
Result Details
The results for this operation are always empty.
Errors
The request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
The resource could not be found.
Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting, perform the operation again.
You do not have sufficient access to perform this action. Access denied errors appear when Amazon Security Lake explicitly or implicitly denies an authorization request. An explicit denial occurs when a policy contains a Deny statement for the specific Amazon Web Services action. An implicit denial occurs when there is no applicable Deny statement and also no applicable Allow statement.
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.
The limit on the number of requests per second was exceeded.
DeleteDataLakeExceptionSubscription
result=result = result=client->deleteDataLakeExceptionSubscription([/* ... /]); promise=promise = promise=client->deleteDataLakeExceptionSubscriptionAsync([/ ... */]);
Deletes the specified notification subscription in Amazon Security Lake for the organization you specify.
Parameter Syntax
result=result = result=client->deleteDataLakeExceptionSubscription([ ]);
Parameter Details
Members
Result Syntax
[]
Result Details
The results for this operation are always empty.
Errors
The request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
The resource could not be found.
Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting, perform the operation again.
You do not have sufficient access to perform this action. Access denied errors appear when Amazon Security Lake explicitly or implicitly denies an authorization request. An explicit denial occurs when a policy contains a Deny statement for the specific Amazon Web Services action. An implicit denial occurs when there is no applicable Deny statement and also no applicable Allow statement.
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.
The limit on the number of requests per second was exceeded.
DeleteDataLakeOrganizationConfiguration
result=result = result=client->deleteDataLakeOrganizationConfiguration([/* ... /]); promise=promise = promise=client->deleteDataLakeOrganizationConfigurationAsync([/ ... */]);
Turns off automatic enablement of Amazon Security Lake for member accounts that are added to an organization in Organizations. Only the delegated Security Lake administrator for an organization can perform this operation. If the delegated Security Lake administrator performs this operation, new member accounts won't automatically contribute data to the data lake.
Parameter Syntax
result=result = result=client->deleteDataLakeOrganizationConfiguration([ 'autoEnableNewAccount' => [ [ 'region' => '', // REQUIRED 'sources' => [ // REQUIRED [ 'sourceName' => 'ROUTE53|VPC_FLOW|SH_FINDINGS|CLOUD_TRAIL_MGMT|LAMBDA_EXECUTION|S3_DATA|EKS_AUDIT|WAF', 'sourceVersion' => '', ], // ... ], ], // ... ], ]);
Parameter Details
Members
autoEnableNewAccount
Type: Array of DataLakeAutoEnableNewAccountConfiguration structures
Turns off automatic enablement of Security Lake for member accounts that are added to an organization.
Result Syntax
[]
Result Details
The results for this operation are always empty.
Errors
The request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
The resource could not be found.
Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting, perform the operation again.
You do not have sufficient access to perform this action. Access denied errors appear when Amazon Security Lake explicitly or implicitly denies an authorization request. An explicit denial occurs when a policy contains a Deny statement for the specific Amazon Web Services action. An implicit denial occurs when there is no applicable Deny statement and also no applicable Allow statement.
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.
The limit on the number of requests per second was exceeded.
DeleteSubscriber
result=result = result=client->deleteSubscriber([/* ... /]); promise=promise = promise=client->deleteSubscriberAsync([/ ... */]);
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.
Parameter Syntax
result=result = result=client->deleteSubscriber([ 'subscriberId' => '', // REQUIRED ]);
Parameter Details
Members
subscriberId
Required: Yes
Type: string
A value created by Security Lake that uniquely identifies your DeleteSubscriber API request.
Result Syntax
[]
Result Details
The results for this operation are always empty.
Errors
The request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
The resource could not be found.
Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting, perform the operation again.
You do not have sufficient access to perform this action. Access denied errors appear when Amazon Security Lake explicitly or implicitly denies an authorization request. An explicit denial occurs when a policy contains a Deny statement for the specific Amazon Web Services action. An implicit denial occurs when there is no applicable Deny statement and also no applicable Allow statement.
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.
The limit on the number of requests per second was exceeded.
DeleteSubscriberNotification
result=result = result=client->deleteSubscriberNotification([/* ... /]); promise=promise = promise=client->deleteSubscriberNotificationAsync([/ ... */]);
Deletes the specified subscription notification in Amazon Security Lake for the organization you specify.
Parameter Syntax
result=result = result=client->deleteSubscriberNotification([ 'subscriberId' => '', // REQUIRED ]);
Parameter Details
Members
subscriberId
Required: Yes
Type: string
The ID of the Security Lake subscriber account.
Result Syntax
[]
Result Details
The results for this operation are always empty.
Errors
The request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
The resource could not be found.
Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting, perform the operation again.
You do not have sufficient access to perform this action. Access denied errors appear when Amazon Security Lake explicitly or implicitly denies an authorization request. An explicit denial occurs when a policy contains a Deny statement for the specific Amazon Web Services action. An implicit denial occurs when there is no applicable Deny statement and also no applicable Allow statement.
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.
The limit on the number of requests per second was exceeded.
DeregisterDataLakeDelegatedAdministrator
result=result = result=client->deregisterDataLakeDelegatedAdministrator([/* ... /]); promise=promise = promise=client->deregisterDataLakeDelegatedAdministratorAsync([/ ... */]);
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.
Parameter Syntax
result=result = result=client->deregisterDataLakeDelegatedAdministrator([ ]);
Parameter Details
Members
Result Syntax
[]
Result Details
The results for this operation are always empty.
Errors
The request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
The resource could not be found.
Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting, perform the operation again.
You do not have sufficient access to perform this action. Access denied errors appear when Amazon Security Lake explicitly or implicitly denies an authorization request. An explicit denial occurs when a policy contains a Deny statement for the specific Amazon Web Services action. An implicit denial occurs when there is no applicable Deny statement and also no applicable Allow statement.
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.
The limit on the number of requests per second was exceeded.
GetDataLakeExceptionSubscription
result=result = result=client->getDataLakeExceptionSubscription([/* ... /]); promise=promise = promise=client->getDataLakeExceptionSubscriptionAsync([/ ... */]);
Retrieves the protocol and endpoint that were provided when subscribing to Amazon SNS topics for exception notifications.
Parameter Syntax
result=result = result=client->getDataLakeExceptionSubscription([ ]);
Parameter Details
Members
Result Syntax
[ 'exceptionTimeToLive' => , 'notificationEndpoint' => '', 'subscriptionProtocol' => '', ]
Result Details
Members
exceptionTimeToLive
The expiration period and time-to-live (TTL). It is the duration of time until which the exception message remains.
notificationEndpoint
The Amazon Web Services account where you receive exception notifications.
subscriptionProtocol
The subscription protocol to which exception notifications are posted.
Errors
The request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
The resource could not be found.
Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting, perform the operation again.
You do not have sufficient access to perform this action. Access denied errors appear when Amazon Security Lake explicitly or implicitly denies an authorization request. An explicit denial occurs when a policy contains a Deny statement for the specific Amazon Web Services action. An implicit denial occurs when there is no applicable Deny statement and also no applicable Allow statement.
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.
The limit on the number of requests per second was exceeded.
GetDataLakeOrganizationConfiguration
result=result = result=client->getDataLakeOrganizationConfiguration([/* ... /]); promise=promise = promise=client->getDataLakeOrganizationConfigurationAsync([/ ... */]);
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.
Parameter Syntax
result=result = result=client->getDataLakeOrganizationConfiguration([ ]);
Parameter Details
Members
Result Syntax
[ 'autoEnableNewAccount' => [ [ 'region' => '', 'sources' => [ [ 'sourceName' => 'ROUTE53|VPC_FLOW|SH_FINDINGS|CLOUD_TRAIL_MGMT|LAMBDA_EXECUTION|S3_DATA|EKS_AUDIT|WAF', 'sourceVersion' => '', ], // ... ], ], // ... ], ]
Result Details
Members
autoEnableNewAccount
Type: Array of DataLakeAutoEnableNewAccountConfiguration structures
The configuration used for new accounts in Security Lake.
Errors
The request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
The resource could not be found.
Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting, perform the operation again.
You do not have sufficient access to perform this action. Access denied errors appear when Amazon Security Lake explicitly or implicitly denies an authorization request. An explicit denial occurs when a policy contains a Deny statement for the specific Amazon Web Services action. An implicit denial occurs when there is no applicable Deny statement and also no applicable Allow statement.
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.
The limit on the number of requests per second was exceeded.
GetDataLakeSources
result=result = result=client->getDataLakeSources([/* ... /]); promise=promise = promise=client->getDataLakeSourcesAsync([/ ... */]);
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.
Parameter Syntax
result=result = result=client->getDataLakeSources([ 'accounts' => ['', ...], 'maxResults' => , 'nextToken' => '', ]);
Parameter Details
Members
accounts
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.
maxResults
The maximum limit of accounts for which the static snapshot of the current Region, including enabled accounts and log sources, is retrieved.
nextToken
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.
Result Syntax
[ 'dataLakeArn' => '', 'dataLakeSources' => [ [ 'account' => '', 'eventClasses' => ['', ...], 'sourceName' => '', 'sourceStatuses' => [ [ 'resource' => '', 'status' => 'COLLECTING|MISCONFIGURED|NOT_COLLECTING', ], // ... ], ], // ... ], 'nextToken' => '', ]
Result Details
Members
dataLakeArn
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
Type: Array of DataLakeSource structures
The list of enabled accounts and enabled sources.
nextToken
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.
Errors
The request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
The resource could not be found.
Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting, perform the operation again.
You do not have sufficient access to perform this action. Access denied errors appear when Amazon Security Lake explicitly or implicitly denies an authorization request. An explicit denial occurs when a policy contains a Deny statement for the specific Amazon Web Services action. An implicit denial occurs when there is no applicable Deny statement and also no applicable Allow statement.
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.
The limit on the number of requests per second was exceeded.
GetSubscriber
result=result = result=client->getSubscriber([/* ... /]); promise=promise = promise=client->getSubscriberAsync([/ ... */]);
Retrieves the subscription information for the specified subscription ID. You can get information about a specific subscriber.
Parameter Syntax
result=result = result=client->getSubscriber([ 'subscriberId' => '', // REQUIRED ]);
Parameter Details
Members
subscriberId
Required: Yes
Type: string
A value created by Amazon Security Lake that uniquely identifies your GetSubscriber API request.
Result Syntax
[ 'subscriber' => [ 'accessTypes' => ['', ...], 'createdAt' => , 'resourceShareArn' => '', 'resourceShareName' => '', 'roleArn' => '', 's3BucketArn' => '', 'sources' => [ [ 'awsLogSource' => [ 'sourceName' => 'ROUTE53|VPC_FLOW|SH_FINDINGS|CLOUD_TRAIL_MGMT|LAMBDA_EXECUTION|S3_DATA|EKS_AUDIT|WAF', 'sourceVersion' => '', ], 'customLogSource' => [ 'attributes' => [ 'crawlerArn' => '', 'databaseArn' => '', 'tableArn' => '', ], 'provider' => [ 'location' => '', 'roleArn' => '', ], 'sourceName' => '', 'sourceVersion' => '', ], ], // ... ], 'subscriberArn' => '', 'subscriberDescription' => '', 'subscriberEndpoint' => '', 'subscriberId' => '', 'subscriberIdentity' => [ 'externalId' => '', 'principal' => '', ], 'subscriberName' => '', 'subscriberStatus' => 'ACTIVE|DEACTIVATED|PENDING|READY', 'updatedAt' => , ], ]
Result Details
Members
subscriber
Type: SubscriberResource structure
The subscriber information for the specified subscriber ID.
Errors
The request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
The resource could not be found.
Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting, perform the operation again.
You do not have sufficient access to perform this action. Access denied errors appear when Amazon Security Lake explicitly or implicitly denies an authorization request. An explicit denial occurs when a policy contains a Deny statement for the specific Amazon Web Services action. An implicit denial occurs when there is no applicable Deny statement and also no applicable Allow statement.
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.
The limit on the number of requests per second was exceeded.
ListDataLakeExceptions
result=result = result=client->listDataLakeExceptions([/* ... /]); promise=promise = promise=client->listDataLakeExceptionsAsync([/ ... */]);
Lists the Amazon Security Lake exceptions that you can use to find the source of problems and fix them.
Parameter Syntax
result=result = result=client->listDataLakeExceptions([ 'maxResults' => , 'nextToken' => '', 'regions' => ['', ...], ]);
Parameter Details
Members
maxResults
Lists the maximum number of failures in Security Lake.
nextToken
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.
regions
The Amazon Web Services Regions from which exceptions are retrieved.
Result Syntax
[ 'exceptions' => [ [ 'exception' => '', 'region' => '', 'remediation' => '', 'timestamp' => , ], // ... ], 'nextToken' => '', ]
Result Details
Members
exceptions
Type: Array of DataLakeException structures
Lists the failures that cannot be retried.
nextToken
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.
Errors
The request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
The resource could not be found.
Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting, perform the operation again.
You do not have sufficient access to perform this action. Access denied errors appear when Amazon Security Lake explicitly or implicitly denies an authorization request. An explicit denial occurs when a policy contains a Deny statement for the specific Amazon Web Services action. An implicit denial occurs when there is no applicable Deny statement and also no applicable Allow statement.
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.
The limit on the number of requests per second was exceeded.
ListDataLakes
result=result = result=client->listDataLakes([/* ... /]); promise=promise = promise=client->listDataLakesAsync([/ ... */]);
Retrieves the Amazon Security Lake configuration object for the specified Amazon Web Services Regions. You can use this operation to determine whether Security Lake is enabled for a Region.
Parameter Syntax
result=result = result=client->listDataLakes([ 'regions' => ['', ...], ]);
Parameter Details
Members
regions
The list of Regions where Security Lake is enabled.
Result Syntax
[ 'dataLakes' => [ [ 'createStatus' => 'INITIALIZED|PENDING|COMPLETED|FAILED', 'dataLakeArn' => '', 'encryptionConfiguration' => [ 'kmsKeyId' => '', ], 'lifecycleConfiguration' => [ 'expiration' => [ 'days' => , ], 'transitions' => [ [ 'days' => , 'storageClass' => '', ], // ... ], ], 'region' => '', 'replicationConfiguration' => [ 'regions' => ['', ...], 'roleArn' => '', ], 's3BucketArn' => '', 'updateStatus' => [ 'exception' => [ 'code' => '', 'reason' => '', ], 'requestId' => '', 'status' => 'INITIALIZED|PENDING|COMPLETED|FAILED', ], ], // ... ], ]
Result Details
Members
dataLakes
Type: Array of DataLakeResource structures
Retrieves the Security Lake configuration object.
Errors
The request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
The resource could not be found.
Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting, perform the operation again.
You do not have sufficient access to perform this action. Access denied errors appear when Amazon Security Lake explicitly or implicitly denies an authorization request. An explicit denial occurs when a policy contains a Deny statement for the specific Amazon Web Services action. An implicit denial occurs when there is no applicable Deny statement and also no applicable Allow statement.
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.
The limit on the number of requests per second was exceeded.
ListLogSources
result=result = result=client->listLogSources([/* ... /]); promise=promise = promise=client->listLogSourcesAsync([/ ... */]);
Retrieves the log sources.
Parameter Syntax
result=result = result=client->listLogSources([ 'accounts' => ['', ...], 'maxResults' => , 'nextToken' => '', 'regions' => ['', ...], 'sources' => [ [ 'awsLogSource' => [ 'sourceName' => 'ROUTE53|VPC_FLOW|SH_FINDINGS|CLOUD_TRAIL_MGMT|LAMBDA_EXECUTION|S3_DATA|EKS_AUDIT|WAF', 'sourceVersion' => '', ], 'customLogSource' => [ 'attributes' => [ 'crawlerArn' => '', 'databaseArn' => '', 'tableArn' => '', ], 'provider' => [ 'location' => '', 'roleArn' => '', ], 'sourceName' => '', 'sourceVersion' => '', ], ], // ... ], ]);
Parameter Details
Members
accounts
The list of Amazon Web Services accounts for which log sources are displayed.
maxResults
The maximum number of accounts for which the log sources are displayed.
nextToken
If nextToken is returned, there are more results available. You can repeat the call using the returned token to retrieve the next page.
regions
The list of Regions for which log sources are displayed.
sources
Type: Array of LogSourceResource structures
The list of sources for which log sources are displayed.
Result Syntax
[ 'nextToken' => '', 'sources' => [ [ 'account' => '', 'region' => '', 'sources' => [ [ 'awsLogSource' => [ 'sourceName' => 'ROUTE53|VPC_FLOW|SH_FINDINGS|CLOUD_TRAIL_MGMT|LAMBDA_EXECUTION|S3_DATA|EKS_AUDIT|WAF', 'sourceVersion' => '', ], 'customLogSource' => [ 'attributes' => [ 'crawlerArn' => '', 'databaseArn' => '', 'tableArn' => '', ], 'provider' => [ 'location' => '', 'roleArn' => '', ], 'sourceName' => '', 'sourceVersion' => '', ], ], // ... ], ], // ... ], ]
Result Details
Members
nextToken
If nextToken is returned, there are more results available. You can repeat the call using the returned token to retrieve the next page.
sources
Type: Array of LogSource structures
The list of log sources in your organization that send data to the data lake.
Errors
The request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
The resource could not be found.
Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting, perform the operation again.
You do not have sufficient access to perform this action. Access denied errors appear when Amazon Security Lake explicitly or implicitly denies an authorization request. An explicit denial occurs when a policy contains a Deny statement for the specific Amazon Web Services action. An implicit denial occurs when there is no applicable Deny statement and also no applicable Allow statement.
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.
The limit on the number of requests per second was exceeded.
ListSubscribers
result=result = result=client->listSubscribers([/* ... /]); promise=promise = promise=client->listSubscribersAsync([/ ... */]);
Lists 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.
Parameter Syntax
result=result = result=client->listSubscribers([ 'maxResults' => , 'nextToken' => '', ]);
Parameter Details
Members
maxResults
The maximum number of accounts for which the configuration is displayed.
nextToken
If nextToken is returned, there are more results available. You can repeat the call using the returned token to retrieve the next page.
Result Syntax
[ 'nextToken' => '', 'subscribers' => [ [ 'accessTypes' => ['', ...], 'createdAt' => , 'resourceShareArn' => '', 'resourceShareName' => '', 'roleArn' => '', 's3BucketArn' => '', 'sources' => [ [ 'awsLogSource' => [ 'sourceName' => 'ROUTE53|VPC_FLOW|SH_FINDINGS|CLOUD_TRAIL_MGMT|LAMBDA_EXECUTION|S3_DATA|EKS_AUDIT|WAF', 'sourceVersion' => '', ], 'customLogSource' => [ 'attributes' => [ 'crawlerArn' => '', 'databaseArn' => '', 'tableArn' => '', ], 'provider' => [ 'location' => '', 'roleArn' => '', ], 'sourceName' => '', 'sourceVersion' => '', ], ], // ... ], 'subscriberArn' => '', 'subscriberDescription' => '', 'subscriberEndpoint' => '', 'subscriberId' => '', 'subscriberIdentity' => [ 'externalId' => '', 'principal' => '', ], 'subscriberName' => '', 'subscriberStatus' => 'ACTIVE|DEACTIVATED|PENDING|READY', 'updatedAt' => , ], // ... ], ]
Result Details
Members
nextToken
If nextToken is returned, there are more results available. You can repeat the call using the returned token to retrieve the next page.
subscribers
Type: Array of SubscriberResource structures
The subscribers available for the specified Security Lake account ID.
Errors
The request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
The resource could not be found.
Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting, perform the operation again.
You do not have sufficient access to perform this action. Access denied errors appear when Amazon Security Lake explicitly or implicitly denies an authorization request. An explicit denial occurs when a policy contains a Deny statement for the specific Amazon Web Services action. An implicit denial occurs when there is no applicable Deny statement and also no applicable Allow statement.
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.
The limit on the number of requests per second was exceeded.
ListTagsForResource
result=result = result=client->listTagsForResource([/* ... /]); promise=promise = promise=client->listTagsForResourceAsync([/ ... */]);
Retrieves the tags (keys and values) that are associated with an Amazon Security Lake resource: a subscriber, or the data lake configuration for your Amazon Web Services account in a particular Amazon Web Services Region.
Parameter Syntax
result=result = result=client->listTagsForResource([ 'resourceArn' => '', // REQUIRED ]);
Parameter Details
Members
resourceArn
Required: Yes
Type: string
The Amazon Resource Name (ARN) of the Amazon Security Lake resource for which you want to retrieve the tags.
Result Syntax
[ 'tags' => [ [ 'key' => '', 'value' => '', ], // ... ], ]
Result Details
Members
tags
Type: Array of Tag structures
An array of objects, one for each tag (key and value) that’s associated with the Amazon Security Lake resource.
Errors
The request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
The resource could not be found.
Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting, perform the operation again.
You do not have sufficient access to perform this action. Access denied errors appear when Amazon Security Lake explicitly or implicitly denies an authorization request. An explicit denial occurs when a policy contains a Deny statement for the specific Amazon Web Services action. An implicit denial occurs when there is no applicable Deny statement and also no applicable Allow statement.
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.
The limit on the number of requests per second was exceeded.
RegisterDataLakeDelegatedAdministrator
result=result = result=client->registerDataLakeDelegatedAdministrator([/* ... /]); promise=promise = promise=client->registerDataLakeDelegatedAdministratorAsync([/ ... */]);
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.
Parameter Syntax
result=result = result=client->registerDataLakeDelegatedAdministrator([ 'accountId' => '', // REQUIRED ]);
Parameter Details
Members
accountId
Required: Yes
Type: string
The Amazon Web Services account ID of the Security Lake delegated administrator.
Result Syntax
[]
Result Details
The results for this operation are always empty.
Errors
The request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
The resource could not be found.
Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting, perform the operation again.
You do not have sufficient access to perform this action. Access denied errors appear when Amazon Security Lake explicitly or implicitly denies an authorization request. An explicit denial occurs when a policy contains a Deny statement for the specific Amazon Web Services action. An implicit denial occurs when there is no applicable Deny statement and also no applicable Allow statement.
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.
The limit on the number of requests per second was exceeded.
TagResource
result=result = result=client->tagResource([/* ... /]); promise=promise = promise=client->tagResourceAsync([/ ... */]);
Adds or updates one or more tags that are associated with an Amazon Security Lake resource: a subscriber, or the data lake configuration for your Amazon Web Services account in a particular Amazon Web Services Region. A tag is a label that you can define and associate with Amazon Web Services resources. Each tag consists of a required tag key and an associated tag value. A tag key is a general label that acts as a category for a more specific tag value. A tag value acts as a descriptor for a tag key. Tags can help you identify, categorize, and manage resources in different ways, such as by owner, environment, or other criteria. For more information, see Tagging Amazon Security Lake resources in the Amazon Security Lake User Guide.
Parameter Syntax
result=result = result=client->tagResource([ 'resourceArn' => '', // REQUIRED 'tags' => [ // REQUIRED [ 'key' => '', // REQUIRED 'value' => '', // REQUIRED ], // ... ], ]);
Parameter Details
Members
resourceArn
Required: Yes
Type: string
The Amazon Resource Name (ARN) of the Amazon Security Lake resource to add or update the tags for.
tags
Required: Yes
Type: Array of Tag structures
An array of objects, one for each tag (key and value) to associate with the Amazon Security Lake resource. For each tag, you must specify both a tag key and a tag value. A tag value cannot be null, but it can be an empty string.
Result Syntax
[]
Result Details
The results for this operation are always empty.
Errors
The request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
The resource could not be found.
Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting, perform the operation again.
You do not have sufficient access to perform this action. Access denied errors appear when Amazon Security Lake explicitly or implicitly denies an authorization request. An explicit denial occurs when a policy contains a Deny statement for the specific Amazon Web Services action. An implicit denial occurs when there is no applicable Deny statement and also no applicable Allow statement.
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.
The limit on the number of requests per second was exceeded.
UntagResource
result=result = result=client->untagResource([/* ... /]); promise=promise = promise=client->untagResourceAsync([/ ... */]);
Removes one or more tags (keys and values) from an Amazon Security Lake resource: a subscriber, or the data lake configuration for your Amazon Web Services account in a particular Amazon Web Services Region.
Parameter Syntax
result=result = result=client->untagResource([ 'resourceArn' => '', // REQUIRED 'tagKeys' => ['', ...], // REQUIRED ]);
Parameter Details
Members
resourceArn
Required: Yes
Type: string
The Amazon Resource Name (ARN) of the Amazon Security Lake resource to remove one or more tags from.
tagKeys
Required: Yes
Type: Array of strings
A list of one or more tag keys. For each value in the list, specify the tag key for a tag to remove from the Amazon Security Lake resource.
Result Syntax
[]
Result Details
The results for this operation are always empty.
Errors
The request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
The resource could not be found.
Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting, perform the operation again.
You do not have sufficient access to perform this action. Access denied errors appear when Amazon Security Lake explicitly or implicitly denies an authorization request. An explicit denial occurs when a policy contains a Deny statement for the specific Amazon Web Services action. An implicit denial occurs when there is no applicable Deny statement and also no applicable Allow statement.
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.
The limit on the number of requests per second was exceeded.
UpdateDataLake
result=result = result=client->updateDataLake([/* ... /]); promise=promise = promise=client->updateDataLakeAsync([/ ... */]);
You can use UpdateDataLake to specify where to store your security data, how it should be encrypted at rest and for how long. You can add a Rollup Region to consolidate data from multiple Amazon Web Services Regions, replace default encryption (SSE-S3) with Customer Manged Key, or specify transition and expiration actions through storage Lifecycle management. The UpdateDataLake API works as an "upsert" operation that performs an insert if the specified item or record does not exist, or an update if it already exists. Security Lake securely stores your data at rest using Amazon Web Services encryption solutions. For more details, see Data protection in Amazon Security Lake.
For example, omitting the key encryptionConfiguration from a Region that is included in an update call that currently uses KMS will leave that Region's KMS key in place, but specifying encryptionConfiguration: {kmsKeyId: 'S3_MANAGED_KEY'} for that same Region will reset the key to S3-managed.
For more details about lifecycle management and how to update retention settings for one or more Regions after enabling Security Lake, see the Amazon Security Lake User Guide.
Parameter Syntax
result=result = result=client->updateDataLake([ 'configurations' => [ // REQUIRED [ 'encryptionConfiguration' => [ 'kmsKeyId' => '', ], 'lifecycleConfiguration' => [ 'expiration' => [ 'days' => , ], 'transitions' => [ [ 'days' => , 'storageClass' => '', ], // ... ], ], 'region' => '', // REQUIRED 'replicationConfiguration' => [ 'regions' => ['', ...], 'roleArn' => '', ], ], // ... ], 'metaStoreManagerRoleArn' => '', ]);
Parameter Details
Members
configurations
Required: Yes
Type: Array of DataLakeConfiguration structures
Specifies the Region or Regions that will contribute data to the rollup region.
metaStoreManagerRoleArn
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.
Result Syntax
[ 'dataLakes' => [ [ 'createStatus' => 'INITIALIZED|PENDING|COMPLETED|FAILED', 'dataLakeArn' => '', 'encryptionConfiguration' => [ 'kmsKeyId' => '', ], 'lifecycleConfiguration' => [ 'expiration' => [ 'days' => , ], 'transitions' => [ [ 'days' => , 'storageClass' => '', ], // ... ], ], 'region' => '', 'replicationConfiguration' => [ 'regions' => ['', ...], 'roleArn' => '', ], 's3BucketArn' => '', 'updateStatus' => [ 'exception' => [ 'code' => '', 'reason' => '', ], 'requestId' => '', 'status' => 'INITIALIZED|PENDING|COMPLETED|FAILED', ], ], // ... ], ]
Result Details
Members
dataLakes
Type: Array of DataLakeResource structures
The created Security Lake configuration object.
Errors
The request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
The resource could not be found.
Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting, perform the operation again.
You do not have sufficient access to perform this action. Access denied errors appear when Amazon Security Lake explicitly or implicitly denies an authorization request. An explicit denial occurs when a policy contains a Deny statement for the specific Amazon Web Services action. An implicit denial occurs when there is no applicable Deny statement and also no applicable Allow statement.
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.
The limit on the number of requests per second was exceeded.
UpdateDataLakeExceptionSubscription
result=result = result=client->updateDataLakeExceptionSubscription([/* ... /]); promise=promise = promise=client->updateDataLakeExceptionSubscriptionAsync([/ ... */]);
Updates the specified notification subscription in Amazon Security Lake for the organization you specify.
Parameter Syntax
result=result = result=client->updateDataLakeExceptionSubscription([ 'exceptionTimeToLive' => , 'notificationEndpoint' => '', // REQUIRED 'subscriptionProtocol' => '', // REQUIRED ]);
Parameter Details
Members
exceptionTimeToLive
The time-to-live (TTL) for the exception message to remain. It is the duration of time until which the exception message remains.
notificationEndpoint
Required: Yes
Type: string
The account that is subscribed to receive exception notifications.
subscriptionProtocol
Required: Yes
Type: string
The subscription protocol to which exception messages are posted.
Result Syntax
[]
Result Details
The results for this operation are always empty.
Errors
The request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
The resource could not be found.
Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting, perform the operation again.
You do not have sufficient access to perform this action. Access denied errors appear when Amazon Security Lake explicitly or implicitly denies an authorization request. An explicit denial occurs when a policy contains a Deny statement for the specific Amazon Web Services action. An implicit denial occurs when there is no applicable Deny statement and also no applicable Allow statement.
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.
The limit on the number of requests per second was exceeded.
UpdateSubscriber
result=result = result=client->updateSubscriber([/* ... /]); promise=promise = promise=client->updateSubscriberAsync([/ ... */]);
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.
Parameter Syntax
result=result = result=client->updateSubscriber([ 'sources' => [ [ 'awsLogSource' => [ 'sourceName' => 'ROUTE53|VPC_FLOW|SH_FINDINGS|CLOUD_TRAIL_MGMT|LAMBDA_EXECUTION|S3_DATA|EKS_AUDIT|WAF', 'sourceVersion' => '', ], 'customLogSource' => [ 'attributes' => [ 'crawlerArn' => '', 'databaseArn' => '', 'tableArn' => '', ], 'provider' => [ 'location' => '', 'roleArn' => '', ], 'sourceName' => '', 'sourceVersion' => '', ], ], // ... ], 'subscriberDescription' => '', 'subscriberId' => '', // REQUIRED 'subscriberIdentity' => [ 'externalId' => '', // REQUIRED 'principal' => '', // REQUIRED ], 'subscriberName' => '', ]);
Parameter Details
Members
sources
Type: Array of LogSourceResource structures
The supported Amazon Web Services services from which logs and events are collected. For the list of supported Amazon Web Services services, see the Amazon Security Lake User Guide.
subscriberDescription
The description of the Security Lake account subscriber.
subscriberId
Required: Yes
Type: string
A value created by Security Lake that uniquely identifies your subscription.
subscriberIdentity
Type: AwsIdentity structure
The Amazon Web Services identity used to access your data.
subscriberName
The name of the Security Lake account subscriber.
Result Syntax
[ 'subscriber' => [ 'accessTypes' => ['', ...], 'createdAt' => , 'resourceShareArn' => '', 'resourceShareName' => '', 'roleArn' => '', 's3BucketArn' => '', 'sources' => [ [ 'awsLogSource' => [ 'sourceName' => 'ROUTE53|VPC_FLOW|SH_FINDINGS|CLOUD_TRAIL_MGMT|LAMBDA_EXECUTION|S3_DATA|EKS_AUDIT|WAF', 'sourceVersion' => '', ], 'customLogSource' => [ 'attributes' => [ 'crawlerArn' => '', 'databaseArn' => '', 'tableArn' => '', ], 'provider' => [ 'location' => '', 'roleArn' => '', ], 'sourceName' => '', 'sourceVersion' => '', ], ], // ... ], 'subscriberArn' => '', 'subscriberDescription' => '', 'subscriberEndpoint' => '', 'subscriberId' => '', 'subscriberIdentity' => [ 'externalId' => '', 'principal' => '', ], 'subscriberName' => '', 'subscriberStatus' => 'ACTIVE|DEACTIVATED|PENDING|READY', 'updatedAt' => , ], ]
Result Details
Members
subscriber
Type: SubscriberResource structure
The updated subscriber information.
Errors
The request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
The resource could not be found.
Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting, perform the operation again.
You do not have sufficient access to perform this action. Access denied errors appear when Amazon Security Lake explicitly or implicitly denies an authorization request. An explicit denial occurs when a policy contains a Deny statement for the specific Amazon Web Services action. An implicit denial occurs when there is no applicable Deny statement and also no applicable Allow statement.
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.
The limit on the number of requests per second was exceeded.
UpdateSubscriberNotification
result=result = result=client->updateSubscriberNotification([/* ... /]); promise=promise = promise=client->updateSubscriberNotificationAsync([/ ... */]);
Updates an existing notification method for the subscription (SQS or HTTPs endpoint) or switches the notification subscription endpoint for a subscriber.
Parameter Syntax
result=result = result=client->updateSubscriberNotification([ 'configuration' => [ // REQUIRED 'httpsNotificationConfiguration' => [ 'authorizationApiKeyName' => '', 'authorizationApiKeyValue' => '', 'endpoint' => '', // REQUIRED 'httpMethod' => 'POST|PUT', 'targetRoleArn' => '', // REQUIRED ], 'sqsNotificationConfiguration' => [ ], ], 'subscriberId' => '', // REQUIRED ]);
Parameter Details
Members
configuration
Required: Yes
Type: NotificationConfiguration structure
The configuration for subscriber notification.
subscriberId
Required: Yes
Type: string
The subscription ID for which the subscription notification is specified.
Result Syntax
[ 'subscriberEndpoint' => '', ]
Result Details
Members
subscriberEndpoint
The subscriber endpoint to which exception messages are posted.
Errors
The request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
The resource could not be found.
Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting, perform the operation again.
You do not have sufficient access to perform this action. Access denied errors appear when Amazon Security Lake explicitly or implicitly denies an authorization request. An explicit denial occurs when a policy contains a Deny statement for the specific Amazon Web Services action. An implicit denial occurs when there is no applicable Deny statement and also no applicable Allow statement.
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.
The limit on the number of requests per second was exceeded.
Shapes
AccessDeniedException
Description
You do not have sufficient access to perform this action. Access denied errors appear when Amazon Security Lake explicitly or implicitly denies an authorization request. An explicit denial occurs when a policy contains a Deny statement for the specific Amazon Web Services action. An implicit denial occurs when there is no applicable Deny statement and also no applicable Allow statement.
Members
errorCode
A coded string to provide more information about the access denied exception. You can use the error code to check the exception type.
message
AwsIdentity
Description
The Amazon Web Services identity.
Members
externalId
Required: Yes
Type: string
The external ID used to establish trust relationship with the Amazon Web Services identity.
principal
Required: Yes
Type: string
The Amazon Web Services identity principal.
AwsLogSourceConfiguration
Description
To add a natively-supported Amazon Web Services service as a log source, use these parameters to specify the configuration settings for the log source.
Members
accounts
Specify the Amazon Web Services account information where you want to enable Security Lake.
regions
Required: Yes
Type: Array of strings
Specify the Regions where you want to enable Security Lake.
sourceName
Required: Yes
Type: string
The name for a Amazon Web Services source.
sourceVersion
The version for a Amazon Web Services source.
AwsLogSourceResource
Description
Amazon Security Lake can collect logs and events from natively-supported Amazon Web Services services.
Members
sourceName
The name for a Amazon Web Services source. This must be a Regionally unique value.
sourceVersion
The version for a Amazon Web Services source. This must be a Regionally unique value.
BadRequestException
Description
The request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
Members
message
ConflictException
Description
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.
Members
message
resourceName
The resource name.
resourceType
The resource type.
CustomLogSourceAttributes
Description
The attributes of a third-party custom source.
Members
crawlerArn
The ARN of the Glue crawler.
databaseArn
The ARN of the Glue database where results are written, such as: arn:aws:daylight:us-east-1::database/sometable/*.
tableArn
The ARN of the Glue table.
CustomLogSourceConfiguration
Description
The configuration used for the third-party custom source.
Members
crawlerConfiguration
Required: Yes
Type: CustomLogSourceCrawlerConfiguration structure
The configuration used for the Glue Crawler for a third-party custom source.
providerIdentity
Required: Yes
Type: AwsIdentity structure
The identity of the log provider for the third-party custom source.
CustomLogSourceCrawlerConfiguration
Description
The configuration used for the Glue Crawler for a third-party custom source.
Members
roleArn
Required: Yes
Type: string
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
CustomLogSourceProvider
Description
The details of the log provider for a third-party custom source.
Members
location
The location of the partition in the Amazon S3 bucket for Security Lake.
roleArn
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.
CustomLogSourceResource
Description
Amazon Security Lake can collect logs and events from third-party custom sources.
Members
attributes
Type: CustomLogSourceAttributes structure
The attributes of a third-party custom source.
provider
Type: CustomLogSourceProvider structure
The details of the log provider for a third-party custom source.
sourceName
The name for a third-party custom source. This must be a Regionally unique value.
sourceVersion
The version for a third-party custom source. This must be a Regionally unique value.
DataLakeAutoEnableNewAccountConfiguration
Description
Automatically enable new organization accounts as member accounts from an Amazon Security Lake administrator account.
Members
region
Required: Yes
Type: string
The Amazon Web Services Regions where Security Lake is automatically enabled.
sources
Required: Yes
Type: Array of AwsLogSourceResource structures
The Amazon Web Services sources that are automatically enabled in Security Lake.
DataLakeConfiguration
Description
Provides details of Amazon Security Lake object.
Members
encryptionConfiguration
Type: DataLakeEncryptionConfiguration structure
Provides encryption details of Amazon Security Lake object.
lifecycleConfiguration
Type: DataLakeLifecycleConfiguration structure
Provides lifecycle details of Amazon Security Lake object.
region
Required: Yes
Type: string
The Amazon Web Services Regions where Security Lake is automatically enabled.
replicationConfiguration
Type: DataLakeReplicationConfiguration structure
Provides replication details of Amazon Security Lake object.
DataLakeEncryptionConfiguration
Description
Provides encryption details of Amazon Security Lake object.
Members
kmsKeyId
The identifier of KMS encryption key used by Amazon Security Lake to encrypt the Security Lake object.
DataLakeException
Description
The details for an Amazon Security Lake exception.
Members
exception
The underlying exception of a Security Lake exception.
region
The Amazon Web Services Regions where the exception occurred.
remediation
List of all remediation steps for a Security Lake exception.
timestamp
Type: timestamp (string|DateTime or anything parsable by strtotime)
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.
DataLakeLifecycleConfiguration
Description
Provides lifecycle details of Amazon Security Lake object.
Members
expiration
Type: DataLakeLifecycleExpiration structure
Provides data expiration details of Amazon Security Lake object.
transitions
Type: Array of DataLakeLifecycleTransition structures
Provides data storage transition details of Amazon Security Lake object.
DataLakeLifecycleExpiration
Description
Provide expiration lifecycle details of Amazon Security Lake object.
Members
days
Number of days before data expires in the Amazon Security Lake object.
DataLakeLifecycleTransition
Description
Provide transition lifecycle details of Amazon Security Lake object.
Members
days
Number of days before data transitions to a different S3 Storage Class in the Amazon Security Lake object.
storageClass
The range of storage classes that you can choose from based on the data access, resiliency, and cost requirements of your workloads.
DataLakeReplicationConfiguration
Description
Provides replication details for objects stored in the Amazon Security Lake data lake.
Members
regions
Specifies one or more centralized rollup Regions. The Amazon Web Services Region specified in the region parameter of the CreateDataLake or UpdateDataLake operations contributes data to the rollup Region or Regions specified in this parameter.
Replication enables automatic, asynchronous copying of objects across Amazon S3 buckets. S3 buckets that are configured for object replication can be owned by the same Amazon Web Services account or by different accounts. You can replicate objects to a single destination bucket or to multiple destination buckets. The destination buckets can be in different Regions or within the same Region as the source bucket.
roleArn
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.
DataLakeResource
Description
Provides details of Amazon Security Lake object.
Members
createStatus
Retrieves the status of the CreateDatalake API call for an account in Amazon Security Lake.
dataLakeArn
Required: Yes
Type: string
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.
encryptionConfiguration
Type: DataLakeEncryptionConfiguration structure
Provides encryption details of Amazon Security Lake object.
lifecycleConfiguration
Type: DataLakeLifecycleConfiguration structure
Provides lifecycle details of Amazon Security Lake object.
region
Required: Yes
Type: string
The Amazon Web Services Regions where Security Lake is enabled.
replicationConfiguration
Type: DataLakeReplicationConfiguration structure
Provides replication details of Amazon Security Lake object.
s3BucketArn
The ARN for the Amazon Security Lake Amazon S3 bucket.
updateStatus
Type: DataLakeUpdateStatus structure
The status of the last UpdateDataLake or DeleteDataLake API request.
DataLakeSource
Description
Amazon Security Lake collects logs and events from supported Amazon Web Services services and custom sources. For the list of supported Amazon Web Services services, see the Amazon Security Lake User Guide.
Members
account
The ID of the Security Lake account for which logs are collected.
eventClasses
The Open Cybersecurity Schema Framework (OCSF) event classes describes the type of data that the custom source will send to Security Lake. For the list of supported event classes, see Supported OCSF Event classes in the Amazon Security Lake User Guide.
sourceName
The supported Amazon Web Services services from which logs and events are collected. Amazon Security Lake supports log and event collection for natively supported Amazon Web Services services.
sourceStatuses
Type: Array of DataLakeSourceStatus structures
The log status for the Security Lake account.
DataLakeSourceStatus
Description
Retrieves the Logs status for the Amazon Security Lake account.
Members
resource
Defines path the stored logs are available which has information on your systems, applications, and services.
status
The health status of services, including error codes and patterns.
DataLakeUpdateException
Description
The details of the last UpdateDataLake or DeleteDataLake API request which failed.
Members
code
The reason code for the exception of the last UpdateDataLake or DeleteDataLake API request.
reason
The reason for the exception of the last UpdateDataLakeor DeleteDataLake API request.
DataLakeUpdateStatus
Description
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.
Members
exception
Type: DataLakeUpdateException structure
The details of the last UpdateDataLakeor DeleteDataLake API request which failed.
requestId
The unique ID for the last UpdateDataLake or DeleteDataLake API request.
status
The status of the last UpdateDataLake or DeleteDataLake API request that was requested.
HttpsNotificationConfiguration
Description
The configurations used for HTTPS subscriber notification.
Members
authorizationApiKeyName
The key name for the notification subscription.
authorizationApiKeyValue
The key value for the notification subscription.
endpoint
Required: Yes
Type: string
The subscription endpoint in Security Lake. If you prefer notification with an HTTPs endpoint, populate this field.
httpMethod
The HTTPS method used for the notification subscription.
targetRoleArn
Required: Yes
Type: string
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.
InternalServerException
Description
Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting, perform the operation again.
Members
message
LogSource
Description
Amazon Security Lake can collect logs and events from natively-supported Amazon Web Services services and custom sources.
Members
account
Specify the account from which you want to collect logs.
region
Specify the Regions from which you want to collect logs.
sources
Type: Array of LogSourceResource structures
Specify the sources from which you want to collect logs.
LogSourceResource
Description
The supported source types from which logs and events are collected in Amazon Security Lake. For a list of supported Amazon Web Services services, see the Amazon Security Lake User Guide.
Members
awsLogSource
Type: AwsLogSourceResource structure
Amazon Security Lake supports log and event collection for natively supported Amazon Web Services services. For more information, see the Amazon Security Lake User Guide.
customLogSource
Type: CustomLogSourceResource structure
NotificationConfiguration
Description
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.
Members
httpsNotificationConfiguration
Type: HttpsNotificationConfiguration structure
The configurations used for HTTPS subscriber notification.
sqsNotificationConfiguration
Type: SqsNotificationConfiguration structure
The configurations for SQS subscriber notification.
ResourceNotFoundException
Description
The resource could not be found.
Members
message
resourceName
The name of the resource that could not be found.
resourceType
The type of the resource that could not be found.
SqsNotificationConfiguration
Description
The configurations used for EventBridge subscriber notification.
Members
SubscriberResource
Description
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.
Members
accessTypes
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.
createdAt
Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time when the subscriber was created.
resourceShareArn
The Amazon Resource Name (ARN) which uniquely defines the Amazon Web Services RAM resource share. Before accepting the RAM resource share invitation, you can view details related to the RAM resource share.
This field is available only for Lake Formation subscribers created after March 8, 2023.
resourceShareName
The name of the resource share.
roleArn
The Amazon Resource Name (ARN) specifying the role of the subscriber.
s3BucketArn
The ARN for the Amazon S3 bucket.
sources
Required: Yes
Type: Array of LogSourceResource structures
Amazon Security Lake supports log and event collection for natively supported Amazon Web Services services. For more information, see the Amazon Security Lake User Guide.
subscriberArn
Required: Yes
Type: string
The subscriber ARN of the Amazon Security Lake subscriber account.
subscriberDescription
The subscriber descriptions for a subscriber account. The description for a subscriber includes subscriberName, accountID, externalID, and subscriberId.
subscriberEndpoint
The subscriber endpoint to which exception messages are posted.
subscriberId
Required: Yes
Type: string
The subscriber ID of the Amazon Security Lake subscriber account.
subscriberIdentity
Required: Yes
Type: AwsIdentity structure
The Amazon Web Services identity used to access your data.
subscriberName
Required: Yes
Type: string
The name of your Amazon Security Lake subscriber account.
subscriberStatus
The subscriber status of the Amazon Security Lake subscriber account.
updatedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time when the subscriber was last updated.
Tag
Description
A tag is a label that you can define and associate with Amazon Web Services resources, including certain types of Amazon Security Lake resources. Tags can help you identify, categorize, and manage resources in different ways, such as by owner, environment, or other criteria. You can associate tags with the following types of Security Lake resources: subscribers, and the data lake configuration for your Amazon Web Services account in individual Amazon Web Services Regions.
A resource can have up to 50 tags. Each tag consists of a required tag key and an associated tag value. A tag key is a general label that acts as a category for a more specific tag value. Each tag key must be unique and it can have only one tag value. A tag value acts as a descriptor for a tag key. Tag keys and values are case sensitive. They can contain letters, numbers, spaces, or the following symbols: _ . : / = + @ -
For more information, see Tagging Amazon Security Lake resources in the Amazon Security Lake User Guide.
Members
key
Required: Yes
Type: string
The name of the tag. This is a general label that acts as a category for a more specific tag value (value).
value
Required: Yes
Type: string
The value that’s associated with the specified tag key (key). This value acts as a descriptor for the tag key. A tag value cannot be null, but it can be an empty string.
ThrottlingException
Description
The limit on the number of requests per second was exceeded.
Members
message
quotaCode
That the rate of requests to Security Lake is exceeding the request quotas for your Amazon Web Services account.
retryAfterSeconds
Retry the request after the specified time.
serviceCode
The code for the service in Service Quotas.