AWS SDK for PHP 3.x

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\SecurityLakeClient object 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 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.
CreateDatalakeAutoEnable ( array $params = [] )
Automatically enables Amazon Security Lake for new member accounts in your organization.
CreateDatalakeDelegatedAdmin ( array $params = [] )
Designates the Amazon Security Lake delegated administrator account for the organization.
CreateDatalakeExceptionsSubscription ( array $params = [] )
Creates the specified notification subscription in Amazon Security Lake for the organization you specify.
CreateSubscriber ( array $params = [] )
Creates a subscription permission for accounts that are already enabled in Amazon Security Lake.
CreateSubscriptionNotificationConfiguration ( 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 Service as an Amazon Security Lake source.
DeleteCustomLogSource ( array $params = [] )
Removes a custom log source from Amazon Security Lake.
DeleteDatalake ( array $params = [] )
When you delete Amazon Security Lake from your account, Security Lake is disabled in all Amazon Web Services Regions.
DeleteDatalakeAutoEnable ( array $params = [] )
DeleteDatalakeAutoEnable removes automatic enablement of configuration settings for new member accounts (but keeps settings for the delegated administrator) from Amazon Security Lake.
DeleteDatalakeDelegatedAdmin ( array $params = [] )
Deletes the Amazon Security Lake delegated administrator account for the organization.
DeleteDatalakeExceptionsSubscription ( array $params = [] )
Deletes the specified notification subscription in Amazon Security Lake for the organization you specify.
DeleteSubscriber ( array $params = [] )
Deletes the subscription permission for accounts that are already enabled in Amazon Security Lake.
DeleteSubscriptionNotificationConfiguration ( array $params = [] )
Deletes the specified notification subscription in Amazon Security Lake for the organization you specify.
GetDatalake ( array $params = [] )
Retrieves the Amazon Security Lake configuration object for the specified Amazon Web Services account ID.
GetDatalakeAutoEnable ( 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.
GetDatalakeExceptionsExpiry ( array $params = [] )
Retrieves the expiration period and time-to-live (TTL) for which the exception message will remain.
GetDatalakeExceptionsSubscription ( array $params = [] )
Retrieves the details of exception notifications for the account in Amazon Security Lake.
GetDatalakeStatus ( 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.
ListLogSources ( array $params = [] )
Retrieves the log sources in the current Amazon Web Services Region.
ListSubscribers ( array $params = [] )
List all subscribers for the specific Amazon Security Lake account ID.
UpdateDatalake ( array $params = [] )
Specifies where to store your security data and for how long.
UpdateDatalakeExceptionsExpiry ( array $params = [] )
Update the expiration period for the exception message to your preferred time, and control the time-to-live (TTL) for the exception message to remain.
UpdateDatalakeExceptionsSubscription ( 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.
UpdateSubscriptionNotificationConfiguration ( 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:

GetDatalakeStatus
ListDatalakeExceptions
ListLogSources
ListSubscribers

Operations

CreateAwsLogSource

$result = $client->createAwsLogSource([/* ... */]);
$promise = $client->createAwsLogSourceAsync([/* ... */]);

Adds a natively supported Amazon Web Service as an Amazon Security Lake source. Enables source types for member accounts in required Amazon Web Services Regions, based on the parameters you specify. You can choose any source type in any Region for either accounts that are part of a trusted organization or standalone accounts. At least one of the three dimensions is a mandatory input to this API. However, you can supply any combination of the three dimensions to this API.

By default, a dimension refers to the entire set. When you don't provide a dimension, Security Lake assumes that the missing dimension refers to the entire set. This is overridden when you supply any one of the inputs. For instance, when you do not specify members, the API enables all Security Lake member accounts for all sources. Similarly, when you do not specify Regions, Security Lake is enabled for all the Regions where Security Lake is available as a service.

You can use this API only to enable natively supported Amazon Web Services as a source. Use CreateCustomLogSource to enable data collection from a custom source.

Parameter Syntax

$result = $client->createAwsLogSource([
    'enableAllDimensions' => [
        '<String>' => [
            '<String>' => ['<string>', ...],
            // ...
        ],
        // ...
    ],
    'enableSingleDimension' => ['<string>', ...],
    'enableTwoDimensions' => [
        '<String>' => ['<string>', ...],
        // ...
    ],
    'inputOrder' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

enableAllDimensions

Type: Associative array of custom strings keys (String) to maps

Enables data collection from specific Amazon Web Services sources in all specific accounts and specific Regions.

enableSingleDimension

Type: Array of strings

Enables data collection from all Amazon Web Services sources in specific accounts or Regions.

enableTwoDimensions

Type: Associative array of custom strings keys (String) to stringss

Enables data collection from specific Amazon Web Services sources in specific accounts or Regions.

inputOrder

Required: Yes
Type: Array of strings

Specifies the input order to enable dimensions in Security Lake, namely Region, source type, and member account.

Result Syntax

[
    'failed' => ['<string>', ...],
    'processing' => ['<string>', ...],
]

Result Details

Members

failed

Type: Array of strings

Lists all accounts in which enabling a natively supported Amazon Web Service as a Security Lake source failed. The failure occurred as these accounts are not part of an organization.

processing

Type: Array of strings

Lists the accounts that are in the process of enabling a natively supported Amazon Web Service as a Security Lake source.

Errors

InternalServerException:
Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting, perform the operation again.
ValidationException:
Your signing certificate could not be validated.
S3Exception:
Provides an extension of the AmazonServiceException for errors reported by Amazon S3 while processing a request. In particular, this class provides access to the Amazon S3 extended request ID. If Amazon S3 is incorrectly handling a request and you need to contact Amazon, this extended request ID may provide useful debugging information.
AccessDeniedException:
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.
ResourceNotFoundException:
The resource could not be found.
AccountNotFoundException:
Amazon Security Lake cannot find an Amazon Web Services account with the accountID that you specified, or the account whose credentials you used to make this request isn't a member of an organization.

CreateCustomLogSource

$result = $client->createCustomLogSource([/* ... */]);
$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 to an associated Glue table and an Glue crawler.

Parameter Syntax

$result = $client->createCustomLogSource([
    'customSourceName' => '<string>', // REQUIRED
    'eventClass' => 'ACCESS_ACTIVITY|FILE_ACTIVITY|KERNEL_ACTIVITY|KERNEL_EXTENSION|MEMORY_ACTIVITY|MODULE_ACTIVITY|PROCESS_ACTIVITY|REGISTRY_KEY_ACTIVITY|REGISTRY_VALUE_ACTIVITY|RESOURCE_ACTIVITY|SCHEDULED_JOB_ACTIVITY|SECURITY_FINDING|ACCOUNT_CHANGE|AUTHENTICATION|AUTHORIZATION|ENTITY_MANAGEMENT_AUDIT|DHCP_ACTIVITY|NETWORK_ACTIVITY|DNS_ACTIVITY|FTP_ACTIVITY|HTTP_ACTIVITY|RDP_ACTIVITY|SMB_ACTIVITY|SSH_ACTIVITY|CLOUD_API|CONTAINER_LIFECYCLE|DATABASE_LIFECYCLE|CONFIG_STATE|CLOUD_STORAGE|INVENTORY_INFO|RFB_ACTIVITY|SMTP_ACTIVITY|VIRTUAL_MACHINE_ACTIVITY', // REQUIRED
    'glueInvocationRoleArn' => '<string>', // REQUIRED
    'logProviderAccountId' => '<string>', // REQUIRED
]);

Parameter Details

Members

customSourceName

Required: Yes
Type: string

The name for a third-party custom source. This must be a Regionally unique value.

eventClass

Required: Yes
Type: string

The Open Cybersecurity Schema Framework (OCSF) event class which describes the type of data that the custom source will send to Security Lake.

glueInvocationRoleArn

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

logProviderAccountId

Required: Yes
Type: string

The Amazon Web Services account ID of the custom source that will write logs and events into the Amazon S3 Data Lake.

Result Syntax

[
    'customDataLocation' => '<string>',
    'glueCrawlerName' => '<string>',
    'glueDatabaseName' => '<string>',
    'glueTableName' => '<string>',
    'logProviderAccessRoleArn' => '<string>',
]

Result Details

Members

customDataLocation

Required: Yes
Type: string

The location of the partition in the Amazon S3 bucket for Security Lake.

glueCrawlerName

Required: Yes
Type: string

The name of the Glue crawler.

glueDatabaseName

Required: Yes
Type: string

The Glue database where results are written, such as: arn:aws:daylight:us-east-1::database/sometable/*.

glueTableName

Required: Yes
Type: string

The table name of the Glue crawler.

logProviderAccessRoleArn

Required: Yes
Type: string

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.

Errors

InternalServerException:
Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting, perform the operation again.
ValidationException:
Your signing certificate could not be validated.
ConflictSourceNamesException:
There was a conflict when you attempted to modify a Security Lake source name.
AccessDeniedException:
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.
BucketNotFoundException:
Amazon Security Lake generally returns 404 errors if the requested object is missing from the bucket.
ResourceNotFoundException:
The resource could not be found.
AccountNotFoundException:
Amazon Security Lake cannot find an Amazon Web Services account with the accountID that you specified, or the account whose credentials you used to make this request isn't a member of an organization.

CreateDatalake

$result = $client->createDatalake([/* ... */]);
$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. You can either use the enableAll parameter to specify all Regions or specify the Regions where you want to enable Security Lake. To specify particular Regions, use the Regions parameter and then configure these Regions using the configurations parameter. If you have already enabled Security Lake in a Region when you call this command, the command will update the Region if you provide new configuration parameters. If you have not already enabled Security Lake in the Region when you call this API, it will set up the data lake in the Region with the specified configurations.

When you enable Security Lake, it starts ingesting security data after the CreateAwsLogSource call. This includes ingesting security data from sources, storing data, and making data accessible to subscribers. Security Lake also enables all the existing settings and resources that it stores or maintains for your Amazon Web Services account in the current Region, including security log and event data. For more information, see the Amazon Security Lake User Guide.

Parameter Syntax

$result = $client->createDatalake([
    'configurations' => [
        '<Region>' => [
            'encryptionKey' => '<string>',
            'replicationDestinationRegions' => ['<string>', ...],
            'replicationRoleArn' => '<string>',
            'retentionSettings' => [
                [
                    'retentionPeriod' => <integer>,
                    'storageClass' => 'STANDARD_IA|ONEZONE_IA|INTELLIGENT_TIERING|GLACIER_IR|GLACIER|DEEP_ARCHIVE|EXPIRE',
                ],
                // ...
            ],
            'tagsMap' => ['<string>', ...],
        ],
        // ...
    ],
    'enableAll' => true || false,
    'metaStoreManagerRoleArn' => '<string>',
    'regions' => ['<string>', ...],
]);

Parameter Details

Members

configurations

Type: Associative array of custom strings keys (Region) to LakeConfigurationRequest structures

Specify the Region or Regions that will contribute data to the rollup region.

enableAll

Type: boolean

Enable Security Lake in all Regions.

metaStoreManagerRoleArn

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.

regions

Type: Array of strings

Enable Security Lake in the specified Regions. To enable Security Lake in specific Amazon Web Services Regions, such as us-east-1 or ap-northeast-3, provide the Region codes. For a list of Region codes, see Amazon Security Lake endpoints in the Amazon Web Services General Reference.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ServiceQuotaExceededException:
You have exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use Service Quotas to request a service quota increase.
ConflictException:
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.
InternalServerException:
Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting, perform the operation again.
ValidationException:
Your signing certificate could not be validated.
ThrottlingException:
The limit on the number of requests per second was exceeded.
AccessDeniedException:
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.
ResourceNotFoundException:
The resource could not be found.

CreateDatalakeAutoEnable

$result = $client->createDatalakeAutoEnable([/* ... */]);
$promise = $client->createDatalakeAutoEnableAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createDatalakeAutoEnable([
    'configurationForNewAccounts' => [ // REQUIRED
        [
            'region' => 'us-east-1|us-west-2|eu-central-1|us-east-2|eu-west-1|ap-northeast-1|ap-southeast-2', // REQUIRED
            'sources' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

configurationForNewAccounts

Required: Yes
Type: Array of AutoEnableNewRegionConfiguration 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

InternalServerException:
Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting, perform the operation again.
ValidationException:
Your signing certificate could not be validated.
AccessDeniedException:
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.
AccountNotFoundException:
Amazon Security Lake cannot find an Amazon Web Services account with the accountID that you specified, or the account whose credentials you used to make this request isn't a member of an organization.

CreateDatalakeDelegatedAdmin

$result = $client->createDatalakeDelegatedAdmin([/* ... */]);
$promise = $client->createDatalakeDelegatedAdminAsync([/* ... */]);

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 = $client->createDatalakeDelegatedAdmin([
    'account' => '<string>', // REQUIRED
]);

Parameter Details

Members

account

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

InternalServerException:
Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting, perform the operation again.
ValidationException:
Your signing certificate could not be validated.
ThrottlingException:
The limit on the number of requests per second was exceeded.
AccessDeniedException:
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.

CreateDatalakeExceptionsSubscription

$result = $client->createDatalakeExceptionsSubscription([/* ... */]);
$promise = $client->createDatalakeExceptionsSubscriptionAsync([/* ... */]);

Creates the specified notification subscription in Amazon Security Lake for the organization you specify.

Parameter Syntax

$result = $client->createDatalakeExceptionsSubscription([
    'notificationEndpoint' => '<string>', // REQUIRED
    'subscriptionProtocol' => 'HTTP|HTTPS|EMAIL|EMAIL_JSON|SMS|SQS|LAMBDA|APP|FIREHOSE', // REQUIRED
]);

Parameter Details

Members

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

InternalServerException:
Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting, perform the operation again.
ValidationException:
Your signing certificate could not be validated.
AccessDeniedException:
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.
AccountNotFoundException:
Amazon Security Lake cannot find an Amazon Web Services account with the accountID that you specified, or the account whose credentials you used to make this request isn't a member of an organization.

CreateSubscriber

$result = $client->createSubscriber([/* ... */]);
$promise = $client->createSubscriberAsync([/* ... */]);

Creates a subscription permission for accounts that are already enabled in Amazon Security Lake. You can create a subscriber with access to data in the current Amazon Web Services Region.

Parameter Syntax

$result = $client->createSubscriber([
    'accessTypes' => ['<string>', ...],
    'accountId' => '<string>', // REQUIRED
    'externalId' => '<string>', // REQUIRED
    'sourceTypes' => [ // REQUIRED
        [
            'awsSourceType' => 'ROUTE53|VPC_FLOW|CLOUD_TRAIL|SH_FINDINGS',
            'customSourceType' => '<string>',
        ],
        // ...
    ],
    'subscriberDescription' => '<string>',
    'subscriberName' => '<string>', // REQUIRED
]);

Parameter Details

Members

accessTypes

Type: Array of strings

The Amazon S3 or Lake Formation access type.

accountId

Required: Yes
Type: string

The Amazon Web Services account ID used to access your data.

externalId

Required: Yes
Type: string

The external ID of the subscriber. This lets the user that is assuming the role assert the circumstances in which they are operating. It also provides a way for the account owner to permit the role to be assumed only under specific circumstances.

sourceTypes

Required: Yes
Type: Array of SourceType structures

The supported Amazon Web Services from which logs and events are collected. Security Lake supports log and event collection for natively supported Amazon Web Services.

subscriberDescription

Type: string

The description for your subscriber account in Security Lake.

subscriberName

Required: Yes
Type: string

The name of your Security Lake subscriber account.

Result Syntax

[
    'resourceShareArn' => '<string>',
    'resourceShareName' => '<string>',
    'roleArn' => '<string>',
    's3BucketArn' => '<string>',
    'snsArn' => '<string>',
    'subscriptionId' => '<string>',
]

Result Details

Members

resourceShareArn

Type: string

The Amazon Resource Name (ARN) which uniquely defines the AWS RAM resource share. Before accepting the RAM resource share invitation, you can view details related to the RAM resource share.

resourceShareName

Type: string

The name of the resource share.

roleArn

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 Amazon Security Lake User Guide.

s3BucketArn

Type: string

The ARN for the Amazon S3 bucket.

snsArn

Type: string

The ARN for the Amazon Simple Notification Service.

subscriptionId

Required: Yes
Type: string

The subscriptionId created by the CreateSubscriber API call.

Errors

ConflictSubscriptionException:
A conflicting subscription exception operation is in progress.
InternalServerException:
Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting, perform the operation again.
ValidationException:
Your signing certificate could not be validated.
AccessDeniedException:
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.
BucketNotFoundException:
Amazon Security Lake generally returns 404 errors if the requested object is missing from the bucket.
ResourceNotFoundException:
The resource could not be found.
AccountNotFoundException:
Amazon Security Lake cannot find an Amazon Web Services account with the accountID that you specified, or the account whose credentials you used to make this request isn't a member of an organization.
InvalidInputException:
The request was rejected because a value that's not valid or is out of range was supplied for an input parameter.

CreateSubscriptionNotificationConfiguration

$result = $client->createSubscriptionNotificationConfiguration([/* ... */]);
$promise = $client->createSubscriptionNotificationConfigurationAsync([/* ... */]);

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 = $client->createSubscriptionNotificationConfiguration([
    'createSqs' => true || false,
    'httpsApiKeyName' => '<string>',
    'httpsApiKeyValue' => '<string>',
    'httpsMethod' => 'POST|PUT',
    'roleArn' => '<string>',
    'subscriptionEndpoint' => '<string>',
    'subscriptionId' => '<string>', // REQUIRED
]);

Parameter Details

Members

createSqs

Type: boolean

Create an Amazon Simple Queue Service queue.

httpsApiKeyName

Type: string

The key name for the notification subscription.

httpsApiKeyValue

Type: string

The key value for the notification subscription.

httpsMethod

Type: string

The HTTPS method used for the notification subscription.

roleArn

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.

subscriptionEndpoint

Type: string

The subscription endpoint in Security Lake. If you prefer notification with an HTTPs endpoint, populate this field.

subscriptionId

Required: Yes
Type: string

The subscription ID for the notification subscription.

Result Syntax

[
    'queueArn' => '<string>',
]

Result Details

Members

queueArn

Type: string

Returns the Amazon Resource Name (ARN) of the queue.

Errors

ConcurrentModificationException:
More than one process tried to modify a resource at the same time.
InternalServerException:
Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting, perform the operation again.
ValidationException:
Your signing certificate could not be validated.
AccessDeniedException:
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.
ResourceNotFoundException:
The resource could not be found.
AccountNotFoundException:
Amazon Security Lake cannot find an Amazon Web Services account with the accountID that you specified, or the account whose credentials you used to make this request isn't a member of an organization.
InvalidInputException:
The request was rejected because a value that's not valid or is out of range was supplied for an input parameter.

DeleteAwsLogSource

$result = $client->deleteAwsLogSource([/* ... */]);
$promise = $client->deleteAwsLogSourceAsync([/* ... */]);

Removes a natively supported Amazon Web Service as an Amazon Security Lake source. When you remove the source, Security Lake stops collecting data from that source, and subscribers can no longer consume new data from the source. Subscribers can still consume data that Security Lake collected from the source before disablement.

You can choose any source type in any Amazon Web Services Region for either accounts that are part of a trusted organization or standalone accounts. At least one of the three dimensions is a mandatory input to this API. However, you can supply any combination of the three dimensions to this API.

By default, a dimension refers to the entire set. This is overridden when you supply any one of the inputs. For instance, when you do not specify members, the API disables all Security Lake member accounts for sources. Similarly, when you do not specify Regions, Security Lake is disabled for all the Regions where Security Lake is available as a service.

When you don't provide a dimension, Security Lake assumes that the missing dimension refers to the entire set. For example, if you don't provide specific accounts, the API applies to the entire set of accounts in your organization.

Parameter Syntax

$result = $client->deleteAwsLogSource([
    'disableAllDimensions' => [
        '<String>' => [
            '<String>' => ['<string>', ...],
            // ...
        ],
        // ...
    ],
    'disableSingleDimension' => ['<string>', ...],
    'disableTwoDimensions' => [
        '<String>' => ['<string>', ...],
        // ...
    ],
    'inputOrder' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

disableAllDimensions

Type: Associative array of custom strings keys (String) to maps

Removes the specific Amazon Web Services sources from specific accounts and specific Regions.

disableSingleDimension

Type: Array of strings

Removes all Amazon Web Services sources from specific accounts or Regions.

disableTwoDimensions

Type: Associative array of custom strings keys (String) to stringss

Remove a specific Amazon Web Services source from specific accounts or Regions.

inputOrder

Required: Yes
Type: Array of strings

This is a mandatory input. Specify the input order to disable dimensions in Security Lake, namely Region (Amazon Web Services Region code, source type, and member (account ID of a specific Amazon Web Services account).

Result Syntax

[
    'failed' => ['<string>', ...],
    'processing' => ['<string>', ...],
]

Result Details

Members

failed

Type: Array of strings

Deletion of the Amazon Web Services sources failed as the account is not a part of the organization.

processing

Type: Array of strings

Deletion of the Amazon Web Services sources is in progress.

Errors

InternalServerException:
Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting, perform the operation again.
ValidationException:
Your signing certificate could not be validated.
AccessDeniedException:
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.
AccountNotFoundException:
Amazon Security Lake cannot find an Amazon Web Services account with the accountID that you specified, or the account whose credentials you used to make this request isn't a member of an organization.

DeleteCustomLogSource

$result = $client->deleteCustomLogSource([/* ... */]);
$promise = $client->deleteCustomLogSourceAsync([/* ... */]);

Removes a custom log source from Amazon Security Lake.

Parameter Syntax

$result = $client->deleteCustomLogSource([
    'customSourceName' => '<string>', // REQUIRED
]);

Parameter Details

Members

customSourceName

Required: Yes
Type: string

The custom source name for the custom log source.

Result Syntax

[
    'customDataLocation' => '<string>',
]

Result Details

Members

customDataLocation

Required: Yes
Type: string

The location of the partition in the Amazon S3 bucket for Security Lake.

Errors

InternalServerException:
Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting, perform the operation again.
ValidationException:
Your signing certificate could not be validated.
ConflictSourceNamesException:
There was a conflict when you attempted to modify a Security Lake source name.
AccessDeniedException:
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.
BucketNotFoundException:
Amazon Security Lake generally returns 404 errors if the requested object is missing from the bucket.
ResourceNotFoundException:
The resource could not be found.
AccountNotFoundException:
Amazon Security Lake cannot find an Amazon Web Services account with the accountID that you specified, or the account whose credentials you used to make this request isn't a member of an organization.

DeleteDatalake

$result = $client->deleteDatalake([/* ... */]);
$promise = $client->deleteDatalakeAsync([/* ... */]);

When you delete Amazon Security Lake from your account, Security Lake is disabled in all Amazon Web Services Regions. Also, this API automatically takes steps to remove the account from Security Lake .

This operation disables security data collection from sources, deletes data stored, and stops making data accessible to subscribers. Security Lake also deletes all the existing settings and resources that it stores or maintains for your Amazon Web Services account in the current Region, including security log and event data. The DeleteDatalake operation does not delete the Amazon S3 bucket, which is owned by your Amazon Web Services account. For more information, see the Amazon Security Lake User Guide.

Parameter Syntax

$result = $client->deleteDatalake([
]);

Parameter Details

Members

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ServiceQuotaExceededException:
You have exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use Service Quotas to request a service quota increase.
ConflictException:
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.
InternalServerException:
Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting, perform the operation again.
ValidationException:
Your signing certificate could not be validated.
ThrottlingException:
The limit on the number of requests per second was exceeded.
AccessDeniedException:
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.
ResourceNotFoundException:
The resource could not be found.

DeleteDatalakeAutoEnable

$result = $client->deleteDatalakeAutoEnable([/* ... */]);
$promise = $client->deleteDatalakeAutoEnableAsync([/* ... */]);

DeleteDatalakeAutoEnable removes automatic enablement of configuration settings for new member accounts (but keeps settings for the delegated administrator) from Amazon Security Lake. You must run this API using credentials of the delegated administrator. When you run this API, new member accounts that are added after the organization enables Security Lake won't contribute to the data lake.

Parameter Syntax

$result = $client->deleteDatalakeAutoEnable([
    'removeFromConfigurationForNewAccounts' => [ // REQUIRED
        [
            'region' => 'us-east-1|us-west-2|eu-central-1|us-east-2|eu-west-1|ap-northeast-1|ap-southeast-2', // REQUIRED
            'sources' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

removeFromConfigurationForNewAccounts

Required: Yes
Type: Array of AutoEnableNewRegionConfiguration structures

Remove automatic enablement of configuration settings for new member accounts in Security Lake.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:
Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting, perform the operation again.
ValidationException:
Your signing certificate could not be validated.
AccessDeniedException:
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.
AccountNotFoundException:
Amazon Security Lake cannot find an Amazon Web Services account with the accountID that you specified, or the account whose credentials you used to make this request isn't a member of an organization.

DeleteDatalakeDelegatedAdmin

$result = $client->deleteDatalakeDelegatedAdmin([/* ... */]);
$promise = $client->deleteDatalakeDelegatedAdminAsync([/* ... */]);

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 = $client->deleteDatalakeDelegatedAdmin([
    'account' => '<string>', // REQUIRED
]);

Parameter Details

Members

account

Required: Yes
Type: string

The account ID the Security Lake delegated administrator.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:
Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting, perform the operation again.
ValidationException:
Your signing certificate could not be validated.
ThrottlingException:
The limit on the number of requests per second was exceeded.
AccessDeniedException:
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.

DeleteDatalakeExceptionsSubscription

$result = $client->deleteDatalakeExceptionsSubscription([/* ... */]);
$promise = $client->deleteDatalakeExceptionsSubscriptionAsync([/* ... */]);

Deletes the specified notification subscription in Amazon Security Lake for the organization you specify.

Parameter Syntax

$result = $client->deleteDatalakeExceptionsSubscription([
]);

Parameter Details

Members

Result Syntax

[
    'status' => '<string>',
]

Result Details

Members

status

Required: Yes
Type: string

Retrieves the status of the delete Security Lake operation for an account.

Errors

InternalServerException:
Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting, perform the operation again.
ValidationException:
Your signing certificate could not be validated.
AccessDeniedException:
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.
AccountNotFoundException:
Amazon Security Lake cannot find an Amazon Web Services account with the accountID that you specified, or the account whose credentials you used to make this request isn't a member of an organization.

DeleteSubscriber

$result = $client->deleteSubscriber([/* ... */]);
$promise = $client->deleteSubscriberAsync([/* ... */]);

Deletes the subscription permission for accounts that are already enabled in Amazon Security Lake. You can delete a subscriber and remove access to data in the current Amazon Web Services Region.

Parameter Syntax

$result = $client->deleteSubscriber([
    'id' => '<string>', // REQUIRED
]);

Parameter Details

Members

id

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

ConcurrentModificationException:
More than one process tried to modify a resource at the same time.
InternalServerException:
Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting, perform the operation again.
ValidationException:
Your signing certificate could not be validated.
AccessDeniedException:
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.
BucketNotFoundException:
Amazon Security Lake generally returns 404 errors if the requested object is missing from the bucket.
ResourceNotFoundException:
The resource could not be found.
AccountNotFoundException:
Amazon Security Lake cannot find an Amazon Web Services account with the accountID that you specified, or the account whose credentials you used to make this request isn't a member of an organization.
InvalidInputException:
The request was rejected because a value that's not valid or is out of range was supplied for an input parameter.

DeleteSubscriptionNotificationConfiguration

$result = $client->deleteSubscriptionNotificationConfiguration([/* ... */]);
$promise = $client->deleteSubscriptionNotificationConfigurationAsync([/* ... */]);

Deletes the specified notification subscription in Amazon Security Lake for the organization you specify.

Parameter Syntax

$result = $client->deleteSubscriptionNotificationConfiguration([
    'subscriptionId' => '<string>', // REQUIRED
]);

Parameter Details

Members

subscriptionId

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

ConcurrentModificationException:
More than one process tried to modify a resource at the same time.
InternalServerException:
Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting, perform the operation again.
ValidationException:
Your signing certificate could not be validated.
AccessDeniedException:
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.
ResourceNotFoundException:
The resource could not be found.
AccountNotFoundException:
Amazon Security Lake cannot find an Amazon Web Services account with the accountID that you specified, or the account whose credentials you used to make this request isn't a member of an organization.
InvalidInputException:
The request was rejected because a value that's not valid or is out of range was supplied for an input parameter.

GetDatalake

$result = $client->getDatalake([/* ... */]);
$promise = $client->getDatalakeAsync([/* ... */]);

Retrieves the Amazon Security Lake configuration object for the specified Amazon Web Services account ID. You can use the GetDatalake API to know whether Security Lake is enabled for the current Region. This API does not take input parameters.

Parameter Syntax

$result = $client->getDatalake([
]);

Parameter Details

Members

Result Syntax

[
    'configurations' => [
        '<Region>' => [
            'encryptionKey' => '<string>',
            'replicationDestinationRegions' => ['<string>', ...],
            'replicationRoleArn' => '<string>',
            'retentionSettings' => [
                [
                    'retentionPeriod' => <integer>,
                    'storageClass' => 'STANDARD_IA|ONEZONE_IA|INTELLIGENT_TIERING|GLACIER_IR|GLACIER|DEEP_ARCHIVE|EXPIRE',
                ],
                // ...
            ],
            's3BucketArn' => '<string>',
            'status' => 'INITIALIZED|PENDING|COMPLETED|FAILED',
            'tagsMap' => ['<string>', ...],
            'updateStatus' => [
                'lastUpdateFailure' => [
                    'code' => '<string>',
                    'reason' => '<string>',
                ],
                'lastUpdateRequestId' => '<string>',
                'lastUpdateStatus' => 'INITIALIZED|PENDING|COMPLETED|FAILED',
            ],
        ],
        // ...
    ],
]

Result Details

Members

configurations

Required: Yes
Type: Associative array of custom strings keys (Region) to LakeConfigurationResponse structures

Retrieves the Security Lake configuration object.

Errors

InternalServerException:
Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting, perform the operation again.
ValidationException:
Your signing certificate could not be validated.
AccessDeniedException:
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.
ResourceNotFoundException:
The resource could not be found.
AccountNotFoundException:
Amazon Security Lake cannot find an Amazon Web Services account with the accountID that you specified, or the account whose credentials you used to make this request isn't a member of an organization.

GetDatalakeAutoEnable

$result = $client->getDatalakeAutoEnable([/* ... */]);
$promise = $client->getDatalakeAutoEnableAsync([/* ... */]);

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 = $client->getDatalakeAutoEnable([
]);

Parameter Details

Members

Result Syntax

[
    'autoEnableNewAccounts' => [
        [
            'region' => 'us-east-1|us-west-2|eu-central-1|us-east-2|eu-west-1|ap-northeast-1|ap-southeast-2',
            'sources' => ['<string>', ...],
        ],
        // ...
    ],
]

Result Details

Members

autoEnableNewAccounts

Required: Yes
Type: Array of AutoEnableNewRegionConfiguration structures

The configuration for new accounts.

Errors

InternalServerException:
Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting, perform the operation again.
ValidationException:
Your signing certificate could not be validated.
AccessDeniedException:
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.
AccountNotFoundException:
Amazon Security Lake cannot find an Amazon Web Services account with the accountID that you specified, or the account whose credentials you used to make this request isn't a member of an organization.

GetDatalakeExceptionsExpiry

$result = $client->getDatalakeExceptionsExpiry([/* ... */]);
$promise = $client->getDatalakeExceptionsExpiryAsync([/* ... */]);

Retrieves the expiration period and time-to-live (TTL) for which the exception message will remain. Exceptions are stored by default, for 2 weeks from when a record was created in Amazon Security Lake. This API does not take input parameters.

Parameter Syntax

$result = $client->getDatalakeExceptionsExpiry([
]);

Parameter Details

Members

Result Syntax

[
    'exceptionMessageExpiry' => <integer>,
]

Result Details

Members

exceptionMessageExpiry

Required: Yes
Type: long (int|float)

The expiration period and time-to-live (TTL).

Errors

InternalServerException:
Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting, perform the operation again.
ValidationException:
Your signing certificate could not be validated.
AccessDeniedException:
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.
AccountNotFoundException:
Amazon Security Lake cannot find an Amazon Web Services account with the accountID that you specified, or the account whose credentials you used to make this request isn't a member of an organization.

GetDatalakeExceptionsSubscription

$result = $client->getDatalakeExceptionsSubscription([/* ... */]);
$promise = $client->getDatalakeExceptionsSubscriptionAsync([/* ... */]);

Retrieves the details of exception notifications for the account in Amazon Security Lake.

Parameter Syntax

$result = $client->getDatalakeExceptionsSubscription([
]);

Parameter Details

Members

Result Syntax

[
    'protocolAndNotificationEndpoint' => [
        'endpoint' => '<string>',
        'protocol' => '<string>',
    ],
]

Result Details

Members

protocolAndNotificationEndpoint

Required: Yes
Type: ProtocolAndNotificationEndpoint structure

Retrieves the exception notification subscription information.

Errors

InternalServerException:
Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting, perform the operation again.
ValidationException:
Your signing certificate could not be validated.
AccessDeniedException:
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.
AccountNotFoundException:
Amazon Security Lake cannot find an Amazon Web Services account with the accountID that you specified, or the account whose credentials you used to make this request isn't a member of an organization.

GetDatalakeStatus

$result = $client->getDatalakeStatus([/* ... */]);
$promise = $client->getDatalakeStatusAsync([/* ... */]);

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 = $client->getDatalakeStatus([
    'accountSet' => ['<string>', ...],
    'maxAccountResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members

accountSet

Type: Array of strings

The Amazon Web Services account ID for which a static snapshot of the current Amazon Web Services Region, including enabled accounts and log sources, is retrieved.

maxAccountResults

Type: int

The maximum limit of accounts for which the static snapshot of the current Region, including enabled accounts and log sources, is retrieved.

nextToken

Type: string

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

[
    'accountSourcesList' => [
        [
            'account' => '<string>',
            'eventClass' => 'ACCESS_ACTIVITY|FILE_ACTIVITY|KERNEL_ACTIVITY|KERNEL_EXTENSION|MEMORY_ACTIVITY|MODULE_ACTIVITY|PROCESS_ACTIVITY|REGISTRY_KEY_ACTIVITY|REGISTRY_VALUE_ACTIVITY|RESOURCE_ACTIVITY|SCHEDULED_JOB_ACTIVITY|SECURITY_FINDING|ACCOUNT_CHANGE|AUTHENTICATION|AUTHORIZATION|ENTITY_MANAGEMENT_AUDIT|DHCP_ACTIVITY|NETWORK_ACTIVITY|DNS_ACTIVITY|FTP_ACTIVITY|HTTP_ACTIVITY|RDP_ACTIVITY|SMB_ACTIVITY|SSH_ACTIVITY|CLOUD_API|CONTAINER_LIFECYCLE|DATABASE_LIFECYCLE|CONFIG_STATE|CLOUD_STORAGE|INVENTORY_INFO|RFB_ACTIVITY|SMTP_ACTIVITY|VIRTUAL_MACHINE_ACTIVITY',
            'logsStatus' => [
                [
                    'healthStatus' => 'ACTIVE|DEACTIVATED|PENDING',
                    'pathToLogs' => '<string>',
                ],
                // ...
            ],
            'sourceType' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members

accountSourcesList

Required: Yes
Type: Array of AccountSources structures

The list of enabled accounts and enabled sources.

nextToken

Type: string

Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

Errors

InternalServerException:
Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting, perform the operation again.
ValidationException:
Your signing certificate could not be validated.
AccessDeniedException:
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.
AccountNotFoundException:
Amazon Security Lake cannot find an Amazon Web Services account with the accountID that you specified, or the account whose credentials you used to make this request isn't a member of an organization.

GetSubscriber

$result = $client->getSubscriber([/* ... */]);
$promise = $client->getSubscriberAsync([/* ... */]);

Retrieves the subscription information for the specified subscription ID. You can get information about a specific subscriber.

Parameter Syntax

$result = $client->getSubscriber([
    'id' => '<string>', // REQUIRED
]);

Parameter Details

Members

id

Required: Yes
Type: string

A value created by Amazon Security Lake that uniquely identifies your GetSubscriber API request.

Result Syntax

[
    'subscriber' => [
        'accessTypes' => ['<string>', ...],
        'accountId' => '<string>',
        'createdAt' => <DateTime>,
        'externalId' => '<string>',
        'resourceShareArn' => '<string>',
        'resourceShareName' => '<string>',
        'roleArn' => '<string>',
        's3BucketArn' => '<string>',
        'snsArn' => '<string>',
        'sourceTypes' => [
            [
                'awsSourceType' => 'ROUTE53|VPC_FLOW|CLOUD_TRAIL|SH_FINDINGS',
                'customSourceType' => '<string>',
            ],
            // ...
        ],
        'subscriberDescription' => '<string>',
        'subscriberName' => '<string>',
        'subscriptionEndpoint' => '<string>',
        'subscriptionId' => '<string>',
        'subscriptionProtocol' => 'HTTPS|SQS',
        'subscriptionStatus' => 'ACTIVE|DEACTIVATED|PENDING|READY',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Members

subscriber

Type: SubscriberResource structure

The subscription information for the specified subscription ID.

Errors

InternalServerException:
Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting, perform the operation again.
AccessDeniedException:
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.
ResourceNotFoundException:
The resource could not be found.
AccountNotFoundException:
Amazon Security Lake cannot find an Amazon Web Services account with the accountID that you specified, or the account whose credentials you used to make this request isn't a member of an organization.
InvalidInputException:
The request was rejected because a value that's not valid or is out of range was supplied for an input parameter.

ListDatalakeExceptions

$result = $client->listDatalakeExceptions([/* ... */]);
$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 = $client->listDatalakeExceptions([
    'maxFailures' => <integer>,
    'nextToken' => '<string>',
    'regionSet' => ['<string>', ...],
]);

Parameter Details

Members

maxFailures

Type: int

List the maximum number of failures in Security Lake.

nextToken

Type: string

List if there are more results available. The value of nextToken is a unique pagination token for each page. Repeat the call using the returned token to retrieve the next page. Keep all other arguments unchanged.

Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

regionSet

Type: Array of strings

List the Amazon Web Services Regions from which exceptions are retrieved.

Result Syntax

[
    'nextToken' => '<string>',
    'nonRetryableFailures' => [
        [
            'failures' => [
                [
                    'exceptionMessage' => '<string>',
                    'remediation' => '<string>',
                    'timestamp' => <DateTime>,
                ],
                // ...
            ],
            'region' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

nextToken

Type: string

Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

nonRetryableFailures

Required: Yes
Type: Array of FailuresResponse structures

Lists the failures that cannot be retried in the current Region.

Errors

InternalServerException:
Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting, perform the operation again.
ValidationException:
Your signing certificate could not be validated.
AccessDeniedException:
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.
AccountNotFoundException:
Amazon Security Lake cannot find an Amazon Web Services account with the accountID that you specified, or the account whose credentials you used to make this request isn't a member of an organization.

ListLogSources

$result = $client->listLogSources([/* ... */]);
$promise = $client->listLogSourcesAsync([/* ... */]);

Retrieves the log sources in the current Amazon Web Services Region.

Parameter Syntax

$result = $client->listLogSources([
    'inputOrder' => ['<string>', ...],
    'listAllDimensions' => [
        '<String>' => [
            '<String>' => ['<string>', ...],
            // ...
        ],
        // ...
    ],
    'listSingleDimension' => ['<string>', ...],
    'listTwoDimensions' => [
        '<String>' => ['<string>', ...],
        // ...
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members

inputOrder

Type: Array of strings

Lists the log sources in input order, namely Region, source type, and member account.

listAllDimensions

Type: Associative array of custom strings keys (String) to maps

List the view of log sources for enabled Amazon Security Lake accounts for specific Amazon Web Services sources from specific accounts and specific Regions.

listSingleDimension

Type: Array of strings

List the view of log sources for enabled Security Lake accounts for all Amazon Web Services sources from specific accounts or specific Regions.

listTwoDimensions

Type: Associative array of custom strings keys (String) to stringss

Lists the view of log sources for enabled Security Lake accounts for specific Amazon Web Services sources from specific accounts or specific Regions.

maxResults

Type: int

The maximum number of accounts for which the log sources are displayed.

nextToken

Type: string

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' => '<string>',
    'regionSourceTypesAccountsList' => [
        [
            '<String>' => [
                '<String>' => ['<string>', ...],
                // ...
            ],
            // ...
        ],
        // ...
    ],
]

Result Details

Members

nextToken

Type: string

If nextToken is returned, there are more results available. You can repeat the call using the returned token to retrieve the next page.

regionSourceTypesAccountsList

Required: Yes
Type: Array of maps

Lists the log sources by Regions for enabled Security Lake accounts.

Errors

InternalServerException:
Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting, perform the operation again.
ValidationException:
Your signing certificate could not be validated.
AccessDeniedException:
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.
ResourceNotFoundException:
The resource could not be found.
AccountNotFoundException:
Amazon Security Lake cannot find an Amazon Web Services account with the accountID that you specified, or the account whose credentials you used to make this request isn't a member of an organization.

ListSubscribers

$result = $client->listSubscribers([/* ... */]);
$promise = $client->listSubscribersAsync([/* ... */]);

List all subscribers for the specific Amazon Security Lake account ID. You can retrieve a list of subscriptions associated with a specific organization or Amazon Web Services account.

Parameter Syntax

$result = $client->listSubscribers([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members

maxResults

Type: int

The maximum number of accounts for which the configuration is displayed.

nextToken

Type: string

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' => '<string>',
    'subscribers' => [
        [
            'accessTypes' => ['<string>', ...],
            'accountId' => '<string>',
            'createdAt' => <DateTime>,
            'externalId' => '<string>',
            'resourceShareArn' => '<string>',
            'resourceShareName' => '<string>',
            'roleArn' => '<string>',
            's3BucketArn' => '<string>',
            'snsArn' => '<string>',
            'sourceTypes' => [
                [
                    'awsSourceType' => 'ROUTE53|VPC_FLOW|CLOUD_TRAIL|SH_FINDINGS',
                    'customSourceType' => '<string>',
                ],
                // ...
            ],
            'subscriberDescription' => '<string>',
            'subscriberName' => '<string>',
            'subscriptionEndpoint' => '<string>',
            'subscriptionId' => '<string>',
            'subscriptionProtocol' => 'HTTPS|SQS',
            'subscriptionStatus' => 'ACTIVE|DEACTIVATED|PENDING|READY',
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Members

nextToken

Type: string

If nextToken is returned, there are more results available. You can repeat the call using the returned token to retrieve the next page.

subscribers

Required: Yes
Type: Array of SubscriberResource structures

The subscribers available for the specified Security Lake account ID.

Errors

InternalServerException:
Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting, perform the operation again.
ValidationException:
Your signing certificate could not be validated.
AccessDeniedException:
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.
ResourceNotFoundException:
The resource could not be found.
AccountNotFoundException:
Amazon Security Lake cannot find an Amazon Web Services account with the accountID that you specified, or the account whose credentials you used to make this request isn't a member of an organization.
InvalidInputException:
The request was rejected because a value that's not valid or is out of range was supplied for an input parameter.

UpdateDatalake

$result = $client->updateDatalake([/* ... */]);
$promise = $client->updateDatalakeAsync([/* ... */]);

Specifies where to store your security data and for how long. You can add a rollup Region to consolidate data from multiple Amazon Web Services Regions.

Parameter Syntax

$result = $client->updateDatalake([
    'configurations' => [ // REQUIRED
        '<Region>' => [
            'encryptionKey' => '<string>',
            'replicationDestinationRegions' => ['<string>', ...],
            'replicationRoleArn' => '<string>',
            'retentionSettings' => [
                [
                    'retentionPeriod' => <integer>,
                    'storageClass' => 'STANDARD_IA|ONEZONE_IA|INTELLIGENT_TIERING|GLACIER_IR|GLACIER|DEEP_ARCHIVE|EXPIRE',
                ],
                // ...
            ],
            'tagsMap' => ['<string>', ...],
        ],
        // ...
    ],
]);

Parameter Details

Members

configurations

Required: Yes
Type: Associative array of custom strings keys (Region) to LakeConfigurationRequest structures

Specify the Region or Regions that will contribute data to the rollup region.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

EventBridgeException:
Represents an error interacting with the Amazon EventBridge service.
InternalServerException:
Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting, perform the operation again.
ValidationException:
Your signing certificate could not be validated.
AccessDeniedException:
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.
ResourceNotFoundException:
The resource could not be found.

UpdateDatalakeExceptionsExpiry

$result = $client->updateDatalakeExceptionsExpiry([/* ... */]);
$promise = $client->updateDatalakeExceptionsExpiryAsync([/* ... */]);

Update the expiration period for the exception message to your preferred time, and control the time-to-live (TTL) for the exception message to remain. Exceptions are stored by default for 2 weeks from when a record was created in Amazon Security Lake.

Parameter Syntax

$result = $client->updateDatalakeExceptionsExpiry([
    'exceptionMessageExpiry' => <integer>, // REQUIRED
]);

Parameter Details

Members

exceptionMessageExpiry

Required: Yes
Type: long (int|float)

The time-to-live (TTL) for the exception message to remain.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:
Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting, perform the operation again.
ValidationException:
Your signing certificate could not be validated.
AccessDeniedException:
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.
AccountNotFoundException:
Amazon Security Lake cannot find an Amazon Web Services account with the accountID that you specified, or the account whose credentials you used to make this request isn't a member of an organization.

UpdateDatalakeExceptionsSubscription

$result = $client->updateDatalakeExceptionsSubscription([/* ... */]);
$promise = $client->updateDatalakeExceptionsSubscriptionAsync([/* ... */]);

Updates the specified notification subscription in Amazon Security Lake for the organization you specify.

Parameter Syntax

$result = $client->updateDatalakeExceptionsSubscription([
    'notificationEndpoint' => '<string>', // REQUIRED
    'subscriptionProtocol' => 'HTTP|HTTPS|EMAIL|EMAIL_JSON|SMS|SQS|LAMBDA|APP|FIREHOSE', // REQUIRED
]);

Parameter Details

Members

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

InternalServerException:
Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting, perform the operation again.
ValidationException:
Your signing certificate could not be validated.
AccessDeniedException:
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.
AccountNotFoundException:
Amazon Security Lake cannot find an Amazon Web Services account with the accountID that you specified, or the account whose credentials you used to make this request isn't a member of an organization.

UpdateSubscriber

$result = $client->updateSubscriber([/* ... */]);
$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 = $client->updateSubscriber([
    'externalId' => '<string>',
    'id' => '<string>', // REQUIRED
    'sourceTypes' => [ // REQUIRED
        [
            'awsSourceType' => 'ROUTE53|VPC_FLOW|CLOUD_TRAIL|SH_FINDINGS',
            'customSourceType' => '<string>',
        ],
        // ...
    ],
    'subscriberDescription' => '<string>',
    'subscriberName' => '<string>',
]);

Parameter Details

Members

externalId

Type: string

The external ID of the Security Lake account.

id

Required: Yes
Type: string

A value created by Security Lake that uniquely identifies your subscription.

sourceTypes

Required: Yes
Type: Array of SourceType structures

The supported Amazon Web Services from which logs and events are collected. For the list of supported Amazon Web Services, see the Amazon Security Lake User Guide.

subscriberDescription

Type: string

The description of the Security Lake account subscriber.

subscriberName

Type: string

The name of the Security Lake account subscriber.

Result Syntax

[
    'subscriber' => [
        'accessTypes' => ['<string>', ...],
        'accountId' => '<string>',
        'createdAt' => <DateTime>,
        'externalId' => '<string>',
        'resourceShareArn' => '<string>',
        'resourceShareName' => '<string>',
        'roleArn' => '<string>',
        's3BucketArn' => '<string>',
        'snsArn' => '<string>',
        'sourceTypes' => [
            [
                'awsSourceType' => 'ROUTE53|VPC_FLOW|CLOUD_TRAIL|SH_FINDINGS',
                'customSourceType' => '<string>',
            ],
            // ...
        ],
        'subscriberDescription' => '<string>',
        'subscriberName' => '<string>',
        'subscriptionEndpoint' => '<string>',
        'subscriptionId' => '<string>',
        'subscriptionProtocol' => 'HTTPS|SQS',
        'subscriptionStatus' => 'ACTIVE|DEACTIVATED|PENDING|READY',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Members

subscriber

Type: SubscriberResource structure

The account of the subscriber.

Errors

ConflictSubscriptionException:
A conflicting subscription exception operation is in progress.
ConcurrentModificationException:
More than one process tried to modify a resource at the same time.
InternalServerException:
Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting, perform the operation again.
ValidationException:
Your signing certificate could not be validated.
AccessDeniedException:
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.
AccountNotFoundException:
Amazon Security Lake cannot find an Amazon Web Services account with the accountID that you specified, or the account whose credentials you used to make this request isn't a member of an organization.
InvalidInputException:
The request was rejected because a value that's not valid or is out of range was supplied for an input parameter.

UpdateSubscriptionNotificationConfiguration

$result = $client->updateSubscriptionNotificationConfiguration([/* ... */]);
$promise = $client->updateSubscriptionNotificationConfigurationAsync([/* ... */]);

Updates an existing notification method for the subscription (SQS or HTTPs endpoint) or switches the notification subscription endpoint for a subscriber.

Parameter Syntax

$result = $client->updateSubscriptionNotificationConfiguration([
    'createSqs' => true || false,
    'httpsApiKeyName' => '<string>',
    'httpsApiKeyValue' => '<string>',
    'httpsMethod' => 'POST|PUT',
    'roleArn' => '<string>',
    'subscriptionEndpoint' => '<string>',
    'subscriptionId' => '<string>', // REQUIRED
]);

Parameter Details

Members

createSqs

Type: boolean

Create a new subscription notification for the specified subscription ID in Amazon Security Lake.

httpsApiKeyName

Type: string

The key name for the subscription notification.

httpsApiKeyValue

Type: string

The key value for the subscription notification.

httpsMethod

Type: string

The HTTPS method used for the subscription notification.

roleArn

Type: string

The Amazon Resource Name (ARN) specifying the role of the subscriber. For more information about ARNs and how to use them in policies, see, see the Managing data access and Amazon Web Services Managed Policiesin the Amazon Security Lake User Guide.

subscriptionEndpoint

Type: string

The subscription endpoint in Security Lake.

subscriptionId

Required: Yes
Type: string

The subscription ID for which the subscription notification is specified.

Result Syntax

[
    'queueArn' => '<string>',
]

Result Details

Members

queueArn

Type: string

Returns the ARN of the queue.

Errors

ConcurrentModificationException:
More than one process tried to modify a resource at the same time.
InternalServerException:
Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting, perform the operation again.
ValidationException:
Your signing certificate could not be validated.
AccessDeniedException:
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.
ResourceNotFoundException:
The resource could not be found.
AccountNotFoundException:
Amazon Security Lake cannot find an Amazon Web Services account with the accountID that you specified, or the account whose credentials you used to make this request isn't a member of an organization.
InvalidInputException:
The request was rejected because a value that's not valid or is out of range was supplied for an input parameter.

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

Type: string

A coded string to provide more information about the access denied exception. You can use the error code to check the exception type.

message

Required: Yes
Type: string

AccountNotFoundException

Description

Amazon Security Lake cannot find an Amazon Web Services account with the accountID that you specified, or the account whose credentials you used to make this request isn't a member of an organization.

Members

message

Required: Yes
Type: string

AccountSources

Description

Amazon Security Lake collects logs and events from supported Amazon Web Services and custom sources. For the list of supported Amazon Web Services, see the Amazon Security Lake User Guide.

Members

account

Required: Yes
Type: string

The ID of the Security Lake account for which logs are collected.

eventClass

Type: string

Initializes a new instance of the Event class.

logsStatus

Type: Array of LogsStatus structures

The log status for the Security Lake account.

sourceType

Required: Yes
Type: string

The supported Amazon Web Services from which logs and events are collected. Amazon Security Lake supports log and event collection for natively supported Amazon Web Services.

AutoEnableNewRegionConfiguration

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 strings

The Amazon Web Services sources that are automatically enabled in Security Lake.

BucketNotFoundException

Description

Amazon Security Lake generally returns 404 errors if the requested object is missing from the bucket.

Members

message

Required: Yes
Type: string

ConcurrentModificationException

Description

More than one process tried to modify a resource at the same time.

Members

message

Required: Yes
Type: string

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

Required: Yes
Type: string

resourceId

Required: Yes
Type: string

A conflict occurred when prompting for the Resource ID.

resourceType

Required: Yes
Type: string

The resource type.

ConflictSourceNamesException

Description

There was a conflict when you attempted to modify a Security Lake source name.

Members

message

Required: Yes
Type: string

ConflictSubscriptionException

Description

A conflicting subscription exception operation is in progress.

Members

message

Required: Yes
Type: string

EventBridgeException

Description

Represents an error interacting with the Amazon EventBridge service.

Members

message

Required: Yes
Type: string

Failures

Description

List of all failures.

Members

exceptionMessage

Required: Yes
Type: string

List of all exception messages.

remediation

Required: Yes
Type: string

List of all remediation steps for failures.

timestamp

Required: Yes
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.

FailuresResponse

Description

Response element for actions that make changes, namely create, update, or delete actions.

Members

failures

Type: Array of Failures structures

List of all failures.

region

Type: string

List of Amazon Web Services Regions where the failure occurred.

InternalServerException

Description

Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting, perform the operation again.

Members

message

Required: Yes
Type: string

retryAfterSeconds

Type: int

Retry the request after the specified time.

InvalidInputException

Description

The request was rejected because a value that's not valid or is out of range was supplied for an input parameter.

Members

message

Required: Yes
Type: string

LakeConfigurationRequest

Description

Provides details of Amazon Security Lake configuration object.

Members

encryptionKey

Type: string

The type of encryption key used by Amazon Security Lake to encrypt the Security Lake configuration object.

replicationDestinationRegions

Type: Array of strings

Replication enables automatic, asynchronous copying of objects across Amazon S3 buckets. Amazon S3 buckets that are configured for object replication can be owned by the same Amazon Web Services account or by different accounts. You can replicate objects to a single destination bucket or to multiple destination buckets. The destination buckets can be in different Amazon Web Services Regions or within the same Region as the source bucket.

Set up one or more rollup Regions by providing the Region or Regions that should contribute to the central rollup Region.

replicationRoleArn

Type: string

Replication settings for the Amazon S3 buckets. This parameter uses the Identity and Access Management (IAM) role you created that is managed by Security Lake, to ensure the replication setting is correct.

retentionSettings

Type: Array of RetentionSetting structures

Retention settings for the destination Amazon S3 buckets.

tagsMap

Type: Associative array of custom strings keys (String) to strings

A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value, both of which you define.

LakeConfigurationResponse

Description

Provides details of Amazon Security Lake lake configuration object.

Members

encryptionKey

Type: string

The type of encryption key used by secure the Security Lake configuration object.

replicationDestinationRegions

Type: Array of strings

Set up one or more rollup Regions by providing the Region or Regions that should contribute to the central rollup Region.

replicationRoleArn

Type: string

Replication settings for the Amazon S3 buckets. This parameter uses the IAM role you created that is managed by Security Lake, to ensure the replication setting is correct.

retentionSettings

Type: Array of RetentionSetting structures

Retention settings for the destination Amazon S3 buckets.

s3BucketArn

Type: string

Amazon Resource Names (ARNs) uniquely identify Amazon Web Services resources. Security Lake requires an ARN when you need to specify a resource unambiguously across all of Amazon Web Services, such as in IAM policies, Amazon Relational Database Service (Amazon RDS) tags, and API calls.

status

Type: string

Retrieves the status of the configuration operation for an account in Amazon Security Lake.

tagsMap

Type: Associative array of custom strings keys (String) to strings

A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value, both of which you define.

updateStatus

Type: UpdateStatus structure

The status of the last UpdateDatalake or DeleteDatalake API request.

LastUpdateFailure

Description

The details of the last UpdateDatalake or DeleteDatalake API request which failed.

Members

code

Type: string

The reason code for the failure of the last UpdateDatalake or DeleteDatalake API request.

reason

Type: string

The reason for the failure of the last UpdateDatalakeor DeleteDatalake API request.

LogsStatus

Description

Retrieves the Logs status for the Amazon Security Lake account.

Members

healthStatus

Required: Yes
Type: string

The health status of services, including error codes and patterns.

pathToLogs

Required: Yes
Type: string

Defines path the stored logs are available which has information on your systems, applications, and services.

ProtocolAndNotificationEndpoint

Description

Protocol used in Amazon Security Lake that dictates how notifications are posted at the endpoint.

Members

endpoint

Type: string

The account that is subscribed to receive exception notifications.

protocol

Type: string

The protocol to which notification messages are posted.

ResourceNotFoundException

Description

The resource could not be found.

Members

message

Required: Yes
Type: string

resourceId

Required: Yes
Type: string

The ID of the resource for which the type of resource could not be found.

resourceType

Required: Yes
Type: string

The type of the resource that could not be found.

RetentionSetting

Description

Retention settings for the destination Amazon S3 buckets in Amazon Security Lake.

Members

retentionPeriod

Type: int

The retention period specifies a fixed period of time during which the Security Lake object remains locked. You can specify the retention period in days for one or more sources.

storageClass

Type: string

The range of storage classes that you can choose from based on the data access, resiliency, and cost requirements of your workloads.

S3Exception

Description

Provides an extension of the AmazonServiceException for errors reported by Amazon S3 while processing a request. In particular, this class provides access to the Amazon S3 extended request ID. If Amazon S3 is incorrectly handling a request and you need to contact Amazon, this extended request ID may provide useful debugging information.

Members

message

Required: Yes
Type: string

ServiceQuotaExceededException

Description

You have exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use Service Quotas to request a service quota increase.

Members

message

Required: Yes
Type: string

quotaCode

Required: Yes
Type: string

That the rate of requests to Security Lake is exceeding the request quotas for your Amazon Web Services account.

resourceId

Required: Yes
Type: string

The ID of the resource that exceeds the service quota.

resourceType

Required: Yes
Type: string

The type of the resource that exceeds the service quota.

serviceCode

Required: Yes
Type: string

The code for the service in Service Quotas.

SourceType

Description

The supported source types from which logs and events are collected in Amazon Security Lake. For the list of supported Amazon Web Services, see the Amazon Security Lake User Guide.

Members

awsSourceType

Type: string

Amazon Security Lake supports log and event collection for natively supported Amazon Web Services.

customSourceType

Type: string

Amazon Security Lake supports custom source types. For a detailed list, see the Amazon Security Lake User Guide.

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

Type: Array of strings

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.

accountId

Required: Yes
Type: string

The Amazon Web Services account ID you are using to create your Amazon Security Lake account.

createdAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time when the subscription was created.

externalId

Type: string

The external ID of the subscriber. The external ID lets the user that is assuming the role assert the circumstances in which they are operating. It also provides a way for the account owner to permit the role to be assumed only under specific circumstances.

resourceShareArn

Type: string

The Amazon Resource Name (ARN) which uniquely defines the AWS RAM resource share. Before accepting the RAM resource share invitation, you can view details related to the RAM resource share.

This field is available only for Lake Formation subscribers created after March 8, 2023.

resourceShareName

Type: string

The name of the resource share.

roleArn

Type: string

The Amazon Resource Name (ARN) specifying the role of the subscriber.

s3BucketArn

Type: string

The ARN for the Amazon S3 bucket.

snsArn

Type: string

The ARN for the Amazon Simple Notification Service.

sourceTypes

Required: Yes
Type: Array of SourceType structures

Amazon Security Lake supports log and event collection for natively supported Amazon Web Services. For more information, see the Amazon Security Lake User Guide.

subscriberDescription

Type: string

The subscriber descriptions for a subscriber account. The description for a subscriber includes subscriberName, accountID, externalID, and subscriptionId.

subscriberName

Type: string

The name of your Amazon Security Lake subscriber account.

subscriptionEndpoint

Type: string

The subscription endpoint to which exception messages are posted.

subscriptionId

Required: Yes
Type: string

The subscription ID of the Amazon Security Lake subscriber account.

subscriptionProtocol

Type: string

The subscription protocol to which exception messages are posted.

subscriptionStatus

Type: string

The subscription status of the Amazon Security Lake subscriber account.

updatedAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time when the subscription was created.

ThrottlingException

Description

The limit on the number of requests per second was exceeded.

Members

message

Required: Yes
Type: string

quotaCode

Type: string

That the rate of requests to Security Lake is exceeding the request quotas for your Amazon Web Services account.

retryAfterSeconds

Type: int

Retry the request after the specified time.

serviceCode

Type: string

The code for the service in Service Quotas.

UpdateStatus

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

lastUpdateFailure

Type: LastUpdateFailure structure

The details of the last UpdateDatalakeor DeleteDatalake API request which failed.

lastUpdateRequestId

Type: string

The unique ID for the UpdateDatalake or DeleteDatalake API request.

lastUpdateStatus

Type: string

The status of the last UpdateDatalake or DeleteDatalake API request that was requested.

ValidationException

Description

Your signing certificate could not be validated.

Members

fieldList

Type: Array of ValidationExceptionField structures

The list of parameters that failed to validate.

message

Required: Yes
Type: string

reason

Required: Yes
Type: string

The reason for the validation exception.

ValidationExceptionField

Description

The input fails to meet the constraints specified in Amazon Security Lake.

Members

message

Required: Yes
Type: string

Describes the error encountered.

name

Required: Yes
Type: string

Name of the validation exception.

Namespaces

Classes

Interfaces

Traits

Exceptions

Functions

Amazon Security Lake 2018-05-10

Operation Summary

Paginators

Operations

CreateAwsLogSource

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateCustomLogSource

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateDatalake

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

CreateDatalakeAutoEnable

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

CreateDatalakeDelegatedAdmin

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

CreateDatalakeExceptionsSubscription

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

CreateSubscriber

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateSubscriptionNotificationConfiguration

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeleteAwsLogSource

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeleteCustomLogSource

Parameter Syntax