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

ListLogSources

Retrieves the log sources.

Request Syntax


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

{
   "accounts": [ "string" ],
   "maxResults": number,
   "nextToken": "string",
   "regions": [ "string" ],
   "sources": [ 
      { ... }
   ]
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

accounts

The list of AWS accounts for which log sources are displayed.

Type: Array of strings

Length Constraints: Fixed length of 12.

Pattern: [0-9]{12}

Required: No

maxResults

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

Type: Integer

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

Required: No

nextToken

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

Type: String

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

Required: No

regions

The list of Regions for which log sources are displayed.

Type: Array of strings

Required: No

sources

The list of sources for which log sources are displayed.

Type: Array of LogSourceResource objects

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "sources": [ 
      { 
         "account": "string",
         "region": "string",
         "sources": [ 
            { ... }
         ]
      }
   ]
}

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.

nextToken

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

Type: String

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

sources

The list of log sources in your organization that send data to the data lake.

Type: Array of LogSource objects

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.

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

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.

resourceName: The resource name.
resourceType: The resource type.

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.

resourceName: The name of the resource that could not be found.
resourceType: The type of the resource that could not be found.

HTTP Status Code: 404

ThrottlingException

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

quotaCode: That the rate of requests to Security Lake is exceeding the request quotas for your AWS account.
retryAfterSeconds: Retry the request after the specified time.
serviceCode: The code for the service in Service Quotas.

HTTP Status Code: 429