Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetDatalakeStatus

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.

Request Syntax


POST /v1/datalake/status HTTP/1.1
Content-type: application/json

{
   "accountSet": [ "string" ],
   "maxAccountResults": number,
   "nextToken": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

accountSet

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

Type: Array of strings

Pattern: ^[\\\w\-_:/.@=+]*$

Required: No

maxAccountResults

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

Type: Integer

Required: No

nextToken

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

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

Type: String

Pattern: ^[\\\w\-_:/.@=+]*$

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "accountSourcesList": [ 
      { 
         "account": "string",
         "eventClass": "string",
         "logsStatus": [ 
            { 
               "healthStatus": "string",
               "pathToLogs": "string"
            }
         ],
         "sourceType": "string"
      }
   ],
   "nextToken": "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.

accountSourcesList

The list of enabled accounts and enabled sources.

Type: Array of AccountSources objects

nextToken

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

Type: String

Pattern: ^[\\\w\-_:/.@=+]*$

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

ValidationException

Your signing certificate could not be validated.

HTTP Status Code: 400