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

GetDataLakeSources

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/sources HTTP/1.1
Content-type: application/json

{
   "accounts": [ "string" ],
   "maxResults": 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.

accounts

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

Length Constraints: Fixed length of 12.

Pattern: ^[0-9]{12}$

Required: No

maxResults

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

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

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

Length Constraints: Minimum length of 0. Maximum length of 2048.

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "dataLakeArn": "string",
   "dataLakeSources": [ 
      { 
         "account": "string",
         "eventClasses": [ "string" ],
         "sourceName": "string",
         "sourceStatuses": [ 
            { 
               "resource": "string",
               "status": "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.

dataLakeArn

The Amazon Resource Name (ARN) created by you to provide to the subscriber. For more information about ARNs and how to use them in policies, see the Amazon Security Lake User Guide.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1011.

Pattern: ^arn:(aws|aws-us-gov|aws-cn):securitylake:[A-za-z0-9_/.\-]{0,63}:[A-za-z0-9_/.\-]{0,63}:[A-Za-z0-9][A-za-z0-9_/.\-]{0,127}$

dataLakeSources

The list of enabled accounts and enabled sources.

Type: Array of DataLakeSource objects

nextToken

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

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

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

BadRequestException

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

HTTP Status Code: 400

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.

HTTP Status Code: 409

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

ThrottlingException

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

HTTP Status Code: 429