CreateAwsLogSource

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

Adds a natively supported Amazon Web Services service as an Amazon Security Lake source. Enables source types for member accounts in required Amazon Web Services Regions, based on the parameters you specify. You can choose any source type in any Region for either accounts that are part of a trusted organization or standalone accounts. Once you add an Amazon Web Services service as a source, Security Lake starts collecting logs and events from it.

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

Parameter Syntax

$result = $client->createAwsLogSource([
    'sources' => [ // REQUIRED
        [
            'accounts' => ['<string>', ...],
            'regions' => ['<string>', ...], // REQUIRED
            'sourceName' => 'ROUTE53|VPC_FLOW|SH_FINDINGS|CLOUD_TRAIL_MGMT|LAMBDA_EXECUTION|S3_DATA|EKS_AUDIT|WAF', // REQUIRED
            'sourceVersion' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

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

Result Details

Errors

BadRequestException:

The request is malformed or contains an error such as an invalid parameter value or a missing required parameter.

ResourceNotFoundException:

The resource could not be found.

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.

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.

ThrottlingException:

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

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, this operation also creates an associated Glue table and an Glue crawler.

Parameter Syntax

$result = $client->createCustomLogSource([
    'configuration' => [ // REQUIRED
        'crawlerConfiguration' => [ // REQUIRED
            'roleArn' => '<string>', // REQUIRED
        ],
        'providerIdentity' => [ // REQUIRED
            'externalId' => '<string>', // REQUIRED
            'principal' => '<string>', // REQUIRED
        ],
    ],
    'eventClasses' => ['<string>', ...],
    'sourceName' => '<string>', // REQUIRED
    'sourceVersion' => '<string>',
]);

Parameter Details

Result Syntax

[
    'source' => [
        'attributes' => [
            'crawlerArn' => '<string>',
            'databaseArn' => '<string>',
            'tableArn' => '<string>',
        ],
        'provider' => [
            'location' => '<string>',
            'roleArn' => '<string>',
        ],
        'sourceName' => '<string>',
        'sourceVersion' => '<string>',
    ],
]

Result Details

Errors

BadRequestException:

The request is malformed or contains an error such as an invalid parameter value or a missing required parameter.

ResourceNotFoundException:

The resource could not be found.

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.

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.

ThrottlingException:

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

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. To specify particular Regions, configure these Regions using the configurations parameter. If you have already enabled Security Lake in a Region when you call this command, the command will update the Region if you provide new configuration parameters. If you have not already enabled Security Lake in the Region when you call this API, it will set up the data lake in the Region with the specified configurations.

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

Parameter Syntax

$result = $client->createDataLake([
    'configurations' => [ // REQUIRED
        [
            'encryptionConfiguration' => [
                'kmsKeyId' => '<string>',
            ],
            'lifecycleConfiguration' => [
                'expiration' => [
                    'days' => <integer>,
                ],
                'transitions' => [
                    [
                        'days' => <integer>,
                        'storageClass' => '<string>',
                    ],
                    // ...
                ],
            ],
            'region' => '<string>', // REQUIRED
            'replicationConfiguration' => [
                'regions' => ['<string>', ...],
                'roleArn' => '<string>',
            ],
        ],
        // ...
    ],
    'metaStoreManagerRoleArn' => '<string>', // REQUIRED
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'dataLakes' => [
        [
            'createStatus' => 'INITIALIZED|PENDING|COMPLETED|FAILED',
            'dataLakeArn' => '<string>',
            'encryptionConfiguration' => [
                'kmsKeyId' => '<string>',
            ],
            'lifecycleConfiguration' => [
                'expiration' => [
                    'days' => <integer>,
                ],
                'transitions' => [
                    [
                        'days' => <integer>,
                        'storageClass' => '<string>',
                    ],
                    // ...
                ],
            ],
            'region' => '<string>',
            'replicationConfiguration' => [
                'regions' => ['<string>', ...],
                'roleArn' => '<string>',
            ],
            's3BucketArn' => '<string>',
            'updateStatus' => [
                'exception' => [
                    'code' => '<string>',
                    'reason' => '<string>',
                ],
                'requestId' => '<string>',
                'status' => 'INITIALIZED|PENDING|COMPLETED|FAILED',
            ],
        ],
        // ...
    ],
]

Result Details

Errors

BadRequestException:

The request is malformed or contains an error such as an invalid parameter value or a missing required parameter.

ResourceNotFoundException:

The resource could not be found.

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.

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.

ThrottlingException:

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

CreateDataLakeExceptionSubscription

$result = $client->createDataLakeExceptionSubscription([/* ... */]);
$promise = $client->createDataLakeExceptionSubscriptionAsync([/* ... */]);

Creates the specified notification subscription in Amazon Security Lake for the organization you specify. The notification subscription is created for exceptions that cannot be resolved by Security Lake automatically.

Parameter Syntax

$result = $client->createDataLakeExceptionSubscription([
    'exceptionTimeToLive' => <integer>,
    'notificationEndpoint' => '<string>', // REQUIRED
    'subscriptionProtocol' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

BadRequestException:

The request is malformed or contains an error such as an invalid parameter value or a missing required parameter.

ResourceNotFoundException:

The resource could not be found.

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.

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.

ThrottlingException:

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

CreateDataLakeOrganizationConfiguration

$result = $client->createDataLakeOrganizationConfiguration([/* ... */]);
$promise = $client->createDataLakeOrganizationConfigurationAsync([/* ... */]);

Automatically enables Amazon Security Lake for new member accounts in your organization. Security Lake is not automatically enabled for any existing member accounts in your organization.

Parameter Syntax

$result = $client->createDataLakeOrganizationConfiguration([
    'autoEnableNewAccount' => [
        [
            'region' => '<string>', // REQUIRED
            'sources' => [ // REQUIRED
                [
                    'sourceName' => 'ROUTE53|VPC_FLOW|SH_FINDINGS|CLOUD_TRAIL_MGMT|LAMBDA_EXECUTION|S3_DATA|EKS_AUDIT|WAF',
                    'sourceVersion' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

BadRequestException:

The request is malformed or contains an error such as an invalid parameter value or a missing required parameter.

ResourceNotFoundException:

The resource could not be found.

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.

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.

ThrottlingException:

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

CreateSubscriber

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

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

Parameter Syntax

$result = $client->createSubscriber([
    'accessTypes' => ['<string>', ...],
    'sources' => [ // REQUIRED
        [
            'awsLogSource' => [
                'sourceName' => 'ROUTE53|VPC_FLOW|SH_FINDINGS|CLOUD_TRAIL_MGMT|LAMBDA_EXECUTION|S3_DATA|EKS_AUDIT|WAF',
                'sourceVersion' => '<string>',
            ],
            'customLogSource' => [
                'attributes' => [
                    'crawlerArn' => '<string>',
                    'databaseArn' => '<string>',
                    'tableArn' => '<string>',
                ],
                'provider' => [
                    'location' => '<string>',
                    'roleArn' => '<string>',
                ],
                'sourceName' => '<string>',
                'sourceVersion' => '<string>',
            ],
        ],
        // ...
    ],
    'subscriberDescription' => '<string>',
    'subscriberIdentity' => [ // REQUIRED
        'externalId' => '<string>', // REQUIRED
        'principal' => '<string>', // REQUIRED
    ],
    'subscriberName' => '<string>', // REQUIRED
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'subscriber' => [
        'accessTypes' => ['<string>', ...],
        'createdAt' => <DateTime>,
        'resourceShareArn' => '<string>',
        'resourceShareName' => '<string>',
        'roleArn' => '<string>',
        's3BucketArn' => '<string>',
        'sources' => [
            [
                'awsLogSource' => [
                    'sourceName' => 'ROUTE53|VPC_FLOW|SH_FINDINGS|CLOUD_TRAIL_MGMT|LAMBDA_EXECUTION|S3_DATA|EKS_AUDIT|WAF',
                    'sourceVersion' => '<string>',
                ],
                'customLogSource' => [
                    'attributes' => [
                        'crawlerArn' => '<string>',
                        'databaseArn' => '<string>',
                        'tableArn' => '<string>',
                    ],
                    'provider' => [
                        'location' => '<string>',
                        'roleArn' => '<string>',
                    ],
                    'sourceName' => '<string>',
                    'sourceVersion' => '<string>',
                ],
            ],
            // ...
        ],
        'subscriberArn' => '<string>',
        'subscriberDescription' => '<string>',
        'subscriberEndpoint' => '<string>',
        'subscriberId' => '<string>',
        'subscriberIdentity' => [
            'externalId' => '<string>',
            'principal' => '<string>',
        ],
        'subscriberName' => '<string>',
        'subscriberStatus' => 'ACTIVE|DEACTIVATED|PENDING|READY',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

BadRequestException:

The request is malformed or contains an error such as an invalid parameter value or a missing required parameter.

ResourceNotFoundException:

The resource could not be found.

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.

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.

ThrottlingException:

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

CreateSubscriberNotification

$result = $client->createSubscriberNotification([/* ... */]);
$promise = $client->createSubscriberNotificationAsync([/* ... */]);

Notifies the subscriber when new data is written to the data lake for the sources that the subscriber consumes in Security Lake. You can create only one subscriber notification per subscriber.

Parameter Syntax

$result = $client->createSubscriberNotification([
    'configuration' => [ // REQUIRED
        'httpsNotificationConfiguration' => [
            'authorizationApiKeyName' => '<string>',
            'authorizationApiKeyValue' => '<string>',
            'endpoint' => '<string>', // REQUIRED
            'httpMethod' => 'POST|PUT',
            'targetRoleArn' => '<string>', // REQUIRED
        ],
        'sqsNotificationConfiguration' => [
        ],
    ],
    'subscriberId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

Errors

BadRequestException:

The request is malformed or contains an error such as an invalid parameter value or a missing required parameter.

ResourceNotFoundException:

The resource could not be found.

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.

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.

ThrottlingException:

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

DeleteAwsLogSource

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

Removes a natively supported Amazon Web Services service as an Amazon Security Lake source. You can remove a source for one or more Regions. When you remove the source, Security Lake stops collecting data from that source in the specified Regions and accounts, and subscribers can no longer consume new data from the source. However, subscribers can still consume data that Security Lake collected from the source before removal.

You can choose any source type in any Amazon Web Services Region for either accounts that are part of a trusted organization or standalone accounts.

Parameter Syntax

$result = $client->deleteAwsLogSource([
    'sources' => [ // REQUIRED
        [
            'accounts' => ['<string>', ...],
            'regions' => ['<string>', ...], // REQUIRED
            'sourceName' => 'ROUTE53|VPC_FLOW|SH_FINDINGS|CLOUD_TRAIL_MGMT|LAMBDA_EXECUTION|S3_DATA|EKS_AUDIT|WAF', // REQUIRED
            'sourceVersion' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

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

Result Details

Errors

BadRequestException:

The request is malformed or contains an error such as an invalid parameter value or a missing required parameter.

ResourceNotFoundException:

The resource could not be found.

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.

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.

ThrottlingException:

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

DeleteCustomLogSource

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

Removes a custom log source from Amazon Security Lake, to stop sending data from the custom source to Security Lake.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

BadRequestException:

The request is malformed or contains an error such as an invalid parameter value or a missing required parameter.

ResourceNotFoundException:

The resource could not be found.

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.

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.

ThrottlingException:

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

DeleteDataLake

$result = $client->deleteDataLake([/* ... */]);
$promise = $client->deleteDataLakeAsync([/* ... */]);

When you disable Amazon Security Lake from your account, Security Lake is disabled in all Amazon Web Services Regions and it stops collecting data from your sources. Also, this API automatically takes steps to remove the account from Security Lake. However, Security Lake retains all of your existing settings and the resources that it created in your Amazon Web Services account in the current Amazon Web Services Region.

The DeleteDataLake operation does not delete the data that is stored in your Amazon S3 bucket, which is owned by your Amazon Web Services account. For more information, see the Amazon Security Lake User Guide.

Parameter Syntax

$result = $client->deleteDataLake([
    'regions' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

BadRequestException:

The request is malformed or contains an error such as an invalid parameter value or a missing required parameter.

ResourceNotFoundException:

The resource could not be found.

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.

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.

ThrottlingException:

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

DeleteDataLakeExceptionSubscription

$result = $client->deleteDataLakeExceptionSubscription([/* ... */]);
$promise = $client->deleteDataLakeExceptionSubscriptionAsync([/* ... */]);

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

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

BadRequestException:

The request is malformed or contains an error such as an invalid parameter value or a missing required parameter.

ResourceNotFoundException:

The resource could not be found.

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.

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.

ThrottlingException:

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

DeleteDataLakeOrganizationConfiguration

$result = $client->deleteDataLakeOrganizationConfiguration([/* ... */]);
$promise = $client->deleteDataLakeOrganizationConfigurationAsync([/* ... */]);

Turns off automatic enablement of Amazon Security Lake for member accounts that are added to an organization in Organizations. Only the delegated Security Lake administrator for an organization can perform this operation. If the delegated Security Lake administrator performs this operation, new member accounts won't automatically contribute data to the data lake.

Parameter Syntax

$result = $client->deleteDataLakeOrganizationConfiguration([
    'autoEnableNewAccount' => [
        [
            'region' => '<string>', // REQUIRED
            'sources' => [ // REQUIRED
                [
                    'sourceName' => 'ROUTE53|VPC_FLOW|SH_FINDINGS|CLOUD_TRAIL_MGMT|LAMBDA_EXECUTION|S3_DATA|EKS_AUDIT|WAF',
                    'sourceVersion' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

BadRequestException:

The request is malformed or contains an error such as an invalid parameter value or a missing required parameter.

ResourceNotFoundException:

The resource could not be found.

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.

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.

ThrottlingException:

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

DeleteSubscriber

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

Deletes the subscription permission and all notification settings for accounts that are already enabled in Amazon Security Lake. When you run DeleteSubscriber, the subscriber will no longer consume data from Security Lake and the subscriber is removed. This operation deletes the subscriber and removes access to data in the current Amazon Web Services Region.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

BadRequestException:

The request is malformed or contains an error such as an invalid parameter value or a missing required parameter.

ResourceNotFoundException:

The resource could not be found.

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.

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.

ThrottlingException:

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

DeleteSubscriberNotification

$result = $client->deleteSubscriberNotification([/* ... */]);
$promise = $client->deleteSubscriberNotificationAsync([/* ... */]);

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

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

BadRequestException:

The request is malformed or contains an error such as an invalid parameter value or a missing required parameter.

ResourceNotFoundException:

The resource could not be found.

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.

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.

ThrottlingException:

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

DeregisterDataLakeDelegatedAdministrator

$result = $client->deregisterDataLakeDelegatedAdministrator([/* ... */]);
$promise = $client->deregisterDataLakeDelegatedAdministratorAsync([/* ... */]);

Deletes the Amazon Security Lake delegated administrator account for the organization. This API can only be called by the organization management account. The organization management account cannot be the delegated administrator account.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

BadRequestException:

The request is malformed or contains an error such as an invalid parameter value or a missing required parameter.

ResourceNotFoundException:

The resource could not be found.

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.

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.

ThrottlingException:

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

GetDataLakeExceptionSubscription

$result = $client->getDataLakeExceptionSubscription([/* ... */]);
$promise = $client->getDataLakeExceptionSubscriptionAsync([/* ... */]);

Retrieves the protocol and endpoint that were provided when subscribing to Amazon SNS topics for exception notifications.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'exceptionTimeToLive' => <integer>,
    'notificationEndpoint' => '<string>',
    'subscriptionProtocol' => '<string>',
]

Result Details

Errors

BadRequestException:

The request is malformed or contains an error such as an invalid parameter value or a missing required parameter.

ResourceNotFoundException:

The resource could not be found.

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.

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.

ThrottlingException:

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

GetDataLakeOrganizationConfiguration

$result = $client->getDataLakeOrganizationConfiguration([/* ... */]);
$promise = $client->getDataLakeOrganizationConfigurationAsync([/* ... */]);

Retrieves the configuration that will be automatically set up for accounts added to the organization after the organization has onboarded to Amazon Security Lake. This API does not take input parameters.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'autoEnableNewAccount' => [
        [
            'region' => '<string>',
            'sources' => [
                [
                    'sourceName' => 'ROUTE53|VPC_FLOW|SH_FINDINGS|CLOUD_TRAIL_MGMT|LAMBDA_EXECUTION|S3_DATA|EKS_AUDIT|WAF',
                    'sourceVersion' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
]

Result Details

Errors

BadRequestException:

The request is malformed or contains an error such as an invalid parameter value or a missing required parameter.

ResourceNotFoundException:

The resource could not be found.

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.

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.

ThrottlingException:

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

GetDataLakeSources

$result = $client->getDataLakeSources([/* ... */]);
$promise = $client->getDataLakeSourcesAsync([/* ... */]);

Retrieves a snapshot of the current Region, including whether Amazon Security Lake is enabled for those accounts and which sources Security Lake is collecting data from.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'dataLakeArn' => '<string>',
    'dataLakeSources' => [
        [
            'account' => '<string>',
            'eventClasses' => ['<string>', ...],
            'sourceName' => '<string>',
            'sourceStatuses' => [
                [
                    'resource' => '<string>',
                    'status' => 'COLLECTING|MISCONFIGURED|NOT_COLLECTING',
                ],
                // ...
            ],
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

BadRequestException:

The request is malformed or contains an error such as an invalid parameter value or a missing required parameter.

ResourceNotFoundException:

The resource could not be found.

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.

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.

ThrottlingException:

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

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([
    'subscriberId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'subscriber' => [
        'accessTypes' => ['<string>', ...],
        'createdAt' => <DateTime>,
        'resourceShareArn' => '<string>',
        'resourceShareName' => '<string>',
        'roleArn' => '<string>',
        's3BucketArn' => '<string>',
        'sources' => [
            [
                'awsLogSource' => [
                    'sourceName' => 'ROUTE53|VPC_FLOW|SH_FINDINGS|CLOUD_TRAIL_MGMT|LAMBDA_EXECUTION|S3_DATA|EKS_AUDIT|WAF',
                    'sourceVersion' => '<string>',
                ],
                'customLogSource' => [
                    'attributes' => [
                        'crawlerArn' => '<string>',
                        'databaseArn' => '<string>',
                        'tableArn' => '<string>',
                    ],
                    'provider' => [
                        'location' => '<string>',
                        'roleArn' => '<string>',
                    ],
                    'sourceName' => '<string>',
                    'sourceVersion' => '<string>',
                ],
            ],
            // ...
        ],
        'subscriberArn' => '<string>',
        'subscriberDescription' => '<string>',
        'subscriberEndpoint' => '<string>',
        'subscriberId' => '<string>',
        'subscriberIdentity' => [
            'externalId' => '<string>',
            'principal' => '<string>',
        ],
        'subscriberName' => '<string>',
        'subscriberStatus' => 'ACTIVE|DEACTIVATED|PENDING|READY',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

BadRequestException:

The request is malformed or contains an error such as an invalid parameter value or a missing required parameter.

ResourceNotFoundException:

The resource could not be found.

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.

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.

ThrottlingException:

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

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([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'regions' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'exceptions' => [
        [
            'exception' => '<string>',
            'region' => '<string>',
            'remediation' => '<string>',
            'timestamp' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

BadRequestException:

The request is malformed or contains an error such as an invalid parameter value or a missing required parameter.

ResourceNotFoundException:

The resource could not be found.

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.

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.

ThrottlingException:

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

ListDataLakes

$result = $client->listDataLakes([/* ... */]);
$promise = $client->listDataLakesAsync([/* ... */]);

Retrieves the Amazon Security Lake configuration object for the specified Amazon Web Services Regions. You can use this operation to determine whether Security Lake is enabled for a Region.

Parameter Syntax

$result = $client->listDataLakes([
    'regions' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'dataLakes' => [
        [
            'createStatus' => 'INITIALIZED|PENDING|COMPLETED|FAILED',
            'dataLakeArn' => '<string>',
            'encryptionConfiguration' => [
                'kmsKeyId' => '<string>',
            ],
            'lifecycleConfiguration' => [
                'expiration' => [
                    'days' => <integer>,
                ],
                'transitions' => [
                    [
                        'days' => <integer>,
                        'storageClass' => '<string>',
                    ],
                    // ...
                ],
            ],
            'region' => '<string>',
            'replicationConfiguration' => [
                'regions' => ['<string>', ...],
                'roleArn' => '<string>',
            ],
            's3BucketArn' => '<string>',
            'updateStatus' => [
                'exception' => [
                    'code' => '<string>',
                    'reason' => '<string>',
                ],
                'requestId' => '<string>',
                'status' => 'INITIALIZED|PENDING|COMPLETED|FAILED',
            ],
        ],
        // ...
    ],
]

Result Details

Errors

BadRequestException:

The request is malformed or contains an error such as an invalid parameter value or a missing required parameter.

ResourceNotFoundException:

The resource could not be found.

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.

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.

ThrottlingException:

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

ListLogSources

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

Retrieves the log sources.

Parameter Syntax

$result = $client->listLogSources([
    'accounts' => ['<string>', ...],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'regions' => ['<string>', ...],
    'sources' => [
        [
            'awsLogSource' => [
                'sourceName' => 'ROUTE53|VPC_FLOW|SH_FINDINGS|CLOUD_TRAIL_MGMT|LAMBDA_EXECUTION|S3_DATA|EKS_AUDIT|WAF',
                'sourceVersion' => '<string>',
            ],
            'customLogSource' => [
                'attributes' => [
                    'crawlerArn' => '<string>',
                    'databaseArn' => '<string>',
                    'tableArn' => '<string>',
                ],
                'provider' => [
                    'location' => '<string>',
                    'roleArn' => '<string>',
                ],
                'sourceName' => '<string>',
                'sourceVersion' => '<string>',
            ],
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'sources' => [
        [
            'account' => '<string>',
            'region' => '<string>',
            'sources' => [
                [
                    'awsLogSource' => [
                        'sourceName' => 'ROUTE53|VPC_FLOW|SH_FINDINGS|CLOUD_TRAIL_MGMT|LAMBDA_EXECUTION|S3_DATA|EKS_AUDIT|WAF',
                        'sourceVersion' => '<string>',
                    ],
                    'customLogSource' => [
                        'attributes' => [
                            'crawlerArn' => '<string>',
                            'databaseArn' => '<string>',
                            'tableArn' => '<string>',
                        ],
                        'provider' => [
                            'location' => '<string>',
                            'roleArn' => '<string>',
                        ],
                        'sourceName' => '<string>',
                        'sourceVersion' => '<string>',
                    ],
                ],
                // ...
            ],
        ],
        // ...
    ],
]

Result Details

Errors

BadRequestException:

The request is malformed or contains an error such as an invalid parameter value or a missing required parameter.

ResourceNotFoundException:

The resource could not be found.

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.

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.

ThrottlingException:

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

ListSubscribers

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'subscribers' => [
        [
            'accessTypes' => ['<string>', ...],
            'createdAt' => <DateTime>,
            'resourceShareArn' => '<string>',
            'resourceShareName' => '<string>',
            'roleArn' => '<string>',
            's3BucketArn' => '<string>',
            'sources' => [
                [
                    'awsLogSource' => [
                        'sourceName' => 'ROUTE53|VPC_FLOW|SH_FINDINGS|CLOUD_TRAIL_MGMT|LAMBDA_EXECUTION|S3_DATA|EKS_AUDIT|WAF',
                        'sourceVersion' => '<string>',
                    ],
                    'customLogSource' => [
                        'attributes' => [
                            'crawlerArn' => '<string>',
                            'databaseArn' => '<string>',
                            'tableArn' => '<string>',
                        ],
                        'provider' => [
                            'location' => '<string>',
                            'roleArn' => '<string>',
                        ],
                        'sourceName' => '<string>',
                        'sourceVersion' => '<string>',
                    ],
                ],
                // ...
            ],
            'subscriberArn' => '<string>',
            'subscriberDescription' => '<string>',
            'subscriberEndpoint' => '<string>',
            'subscriberId' => '<string>',
            'subscriberIdentity' => [
                'externalId' => '<string>',
                'principal' => '<string>',
            ],
            'subscriberName' => '<string>',
            'subscriberStatus' => 'ACTIVE|DEACTIVATED|PENDING|READY',
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

BadRequestException:

The request is malformed or contains an error such as an invalid parameter value or a missing required parameter.

ResourceNotFoundException:

The resource could not be found.

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.

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.

ThrottlingException:

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

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Retrieves the tags (keys and values) that are associated with an Amazon Security Lake resource: a subscriber, or the data lake configuration for your Amazon Web Services account in a particular Amazon Web Services Region.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

BadRequestException:

The request is malformed or contains an error such as an invalid parameter value or a missing required parameter.

ResourceNotFoundException:

The resource could not be found.

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.

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.

ThrottlingException:

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

RegisterDataLakeDelegatedAdministrator

$result = $client->registerDataLakeDelegatedAdministrator([/* ... */]);
$promise = $client->registerDataLakeDelegatedAdministratorAsync([/* ... */]);

Designates the Amazon Security Lake delegated administrator account for the organization. This API can only be called by the organization management account. The organization management account cannot be the delegated administrator account.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

BadRequestException:

The request is malformed or contains an error such as an invalid parameter value or a missing required parameter.

ResourceNotFoundException:

The resource could not be found.

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.

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.

ThrottlingException:

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

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Adds or updates one or more tags that are associated with an Amazon Security Lake resource: a subscriber, or the data lake configuration for your Amazon Web Services account in a particular Amazon Web Services Region. A tag is a label that you can define and associate with Amazon Web Services resources. Each tag consists of a required tag key and an associated tag value. A tag key is a general label that acts as a category for a more specific tag value. A tag value acts as a descriptor for a tag key. Tags can help you identify, categorize, and manage resources in different ways, such as by owner, environment, or other criteria. For more information, see Tagging Amazon Security Lake resources in the Amazon Security Lake User Guide.

Parameter Syntax

$result = $client->tagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tags' => [ // REQUIRED
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

BadRequestException:

The request is malformed or contains an error such as an invalid parameter value or a missing required parameter.

ResourceNotFoundException:

The resource could not be found.

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.

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.

ThrottlingException:

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

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes one or more tags (keys and values) from an Amazon Security Lake resource: a subscriber, or the data lake configuration for your Amazon Web Services account in a particular Amazon Web Services Region.

Parameter Syntax

$result = $client->untagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

BadRequestException:

The request is malformed or contains an error such as an invalid parameter value or a missing required parameter.

ResourceNotFoundException:

The resource could not be found.

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.

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.

ThrottlingException:

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

UpdateDataLake

$result = $client->updateDataLake([/* ... */]);
$promise = $client->updateDataLakeAsync([/* ... */]);

You can use UpdateDataLake to specify where to store your security data, how it should be encrypted at rest and for how long. You can add a Rollup Region to consolidate data from multiple Amazon Web Services Regions, replace default encryption (SSE-S3) with Customer Manged Key, or specify transition and expiration actions through storage Lifecycle management. The UpdateDataLake API works as an "upsert" operation that performs an insert if the specified item or record does not exist, or an update if it already exists. Security Lake securely stores your data at rest using Amazon Web Services encryption solutions. For more details, see Data protection in Amazon Security Lake.

For example, omitting the key encryptionConfiguration from a Region that is included in an update call that currently uses KMS will leave that Region's KMS key in place, but specifying encryptionConfiguration: {kmsKeyId: 'S3_MANAGED_KEY'} for that same Region will reset the key to S3-managed.

For more details about lifecycle management and how to update retention settings for one or more Regions after enabling Security Lake, see the Amazon Security Lake User Guide.

Parameter Syntax

$result = $client->updateDataLake([
    'configurations' => [ // REQUIRED
        [
            'encryptionConfiguration' => [
                'kmsKeyId' => '<string>',
            ],
            'lifecycleConfiguration' => [
                'expiration' => [
                    'days' => <integer>,
                ],
                'transitions' => [
                    [
                        'days' => <integer>,
                        'storageClass' => '<string>',
                    ],
                    // ...
                ],
            ],
            'region' => '<string>', // REQUIRED
            'replicationConfiguration' => [
                'regions' => ['<string>', ...],
                'roleArn' => '<string>',
            ],
        ],
        // ...
    ],
    'metaStoreManagerRoleArn' => '<string>',
]);

Parameter Details

Result Syntax

[
    'dataLakes' => [
        [
            'createStatus' => 'INITIALIZED|PENDING|COMPLETED|FAILED',
            'dataLakeArn' => '<string>',
            'encryptionConfiguration' => [
                'kmsKeyId' => '<string>',
            ],
            'lifecycleConfiguration' => [
                'expiration' => [
                    'days' => <integer>,
                ],
                'transitions' => [
                    [
                        'days' => <integer>,
                        'storageClass' => '<string>',
                    ],
                    // ...
                ],
            ],
            'region' => '<string>',
            'replicationConfiguration' => [
                'regions' => ['<string>', ...],
                'roleArn' => '<string>',
            ],
            's3BucketArn' => '<string>',
            'updateStatus' => [
                'exception' => [
                    'code' => '<string>',
                    'reason' => '<string>',
                ],
                'requestId' => '<string>',
                'status' => 'INITIALIZED|PENDING|COMPLETED|FAILED',
            ],
        ],
        // ...
    ],
]

Result Details

Errors

BadRequestException:

The request is malformed or contains an error such as an invalid parameter value or a missing required parameter.

ResourceNotFoundException:

The resource could not be found.

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.

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.

ThrottlingException:

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

UpdateDataLakeExceptionSubscription

$result = $client->updateDataLakeExceptionSubscription([/* ... */]);
$promise = $client->updateDataLakeExceptionSubscriptionAsync([/* ... */]);

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

Parameter Syntax

$result = $client->updateDataLakeExceptionSubscription([
    'exceptionTimeToLive' => <integer>,
    'notificationEndpoint' => '<string>', // REQUIRED
    'subscriptionProtocol' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

BadRequestException:

The request is malformed or contains an error such as an invalid parameter value or a missing required parameter.

ResourceNotFoundException:

The resource could not be found.

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.

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.

ThrottlingException:

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

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([
    'sources' => [
        [
            'awsLogSource' => [
                'sourceName' => 'ROUTE53|VPC_FLOW|SH_FINDINGS|CLOUD_TRAIL_MGMT|LAMBDA_EXECUTION|S3_DATA|EKS_AUDIT|WAF',
                'sourceVersion' => '<string>',
            ],
            'customLogSource' => [
                'attributes' => [
                    'crawlerArn' => '<string>',
                    'databaseArn' => '<string>',
                    'tableArn' => '<string>',
                ],
                'provider' => [
                    'location' => '<string>',
                    'roleArn' => '<string>',
                ],
                'sourceName' => '<string>',
                'sourceVersion' => '<string>',
            ],
        ],
        // ...
    ],
    'subscriberDescription' => '<string>',
    'subscriberId' => '<string>', // REQUIRED
    'subscriberIdentity' => [
        'externalId' => '<string>', // REQUIRED
        'principal' => '<string>', // REQUIRED
    ],
    'subscriberName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'subscriber' => [
        'accessTypes' => ['<string>', ...],
        'createdAt' => <DateTime>,
        'resourceShareArn' => '<string>',
        'resourceShareName' => '<string>',
        'roleArn' => '<string>',
        's3BucketArn' => '<string>',
        'sources' => [
            [
                'awsLogSource' => [
                    'sourceName' => 'ROUTE53|VPC_FLOW|SH_FINDINGS|CLOUD_TRAIL_MGMT|LAMBDA_EXECUTION|S3_DATA|EKS_AUDIT|WAF',
                    'sourceVersion' => '<string>',
                ],
                'customLogSource' => [
                    'attributes' => [
                        'crawlerArn' => '<string>',
                        'databaseArn' => '<string>',
                        'tableArn' => '<string>',
                    ],
                    'provider' => [
                        'location' => '<string>',
                        'roleArn' => '<string>',
                    ],
                    'sourceName' => '<string>',
                    'sourceVersion' => '<string>',
                ],
            ],
            // ...
        ],
        'subscriberArn' => '<string>',
        'subscriberDescription' => '<string>',
        'subscriberEndpoint' => '<string>',
        'subscriberId' => '<string>',
        'subscriberIdentity' => [
            'externalId' => '<string>',
            'principal' => '<string>',
        ],
        'subscriberName' => '<string>',
        'subscriberStatus' => 'ACTIVE|DEACTIVATED|PENDING|READY',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

BadRequestException:

The request is malformed or contains an error such as an invalid parameter value or a missing required parameter.

ResourceNotFoundException:

The resource could not be found.

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.

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.

ThrottlingException:

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

UpdateSubscriberNotification

$result = $client->updateSubscriberNotification([/* ... */]);
$promise = $client->updateSubscriberNotificationAsync([/* ... */]);

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

Parameter Syntax

$result = $client->updateSubscriberNotification([
    'configuration' => [ // REQUIRED
        'httpsNotificationConfiguration' => [
            'authorizationApiKeyName' => '<string>',
            'authorizationApiKeyValue' => '<string>',
            'endpoint' => '<string>', // REQUIRED
            'httpMethod' => 'POST|PUT',
            'targetRoleArn' => '<string>', // REQUIRED
        ],
        'sqsNotificationConfiguration' => [
        ],
    ],
    'subscriberId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

Errors

BadRequestException:

The request is malformed or contains an error such as an invalid parameter value or a missing required parameter.

ResourceNotFoundException:

The resource could not be found.

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.

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.

ThrottlingException:

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