GetDatalake
Retrieves the Amazon Security Lake configuration object for the specified AWS 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.
Request Syntax
GET /v1/datalake HTTP/1.1
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"configurations": {
"string" : {
"encryptionKey": "string",
"replicationDestinationRegions": [ "string" ],
"replicationRoleArn": "string",
"retentionSettings": [
{
"retentionPeriod": number,
"storageClass": "string"
}
],
"s3BucketArn": "string",
"status": "string",
"tagsMap": {
"string" : "string"
}
}
}
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- configurations
-
Retrieves the Security Lake configuration object.
Type: String to LakeConfigurationResponse object map
Valid Keys:
us-east-1 | us-west-2 | eu-central-1 | us-east-2 | eu-west-1 | ap-northeast-1 | ap-southeast-2
Errors
For information about the errors that are common to all actions, see Common Errors.
- 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 AWS action. An implicit denial occurs when there is no applicable Deny statement and also no applicable Allow statement.
HTTP Status Code: 403
- AccountNotFoundException
-
Amazon Security Lake cannot find an AWS 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.
HTTP Status Code: 403
- InternalServerException
-
Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting, perform the operation again.
HTTP Status Code: 500
- ResourceNotFoundException
-
The resource could not be found.
HTTP Status Code: 404
- ValidationException
-
Your signing certificate could not be validated.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: