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

ListSubscribers

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

Request Syntax


GET /v1/subscribers?maxResults=maxResults&nextToken=nextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

maxResults

The maximum number of accounts for which the configuration is displayed.

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

nextToken

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

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

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "subscribers": [ 
      { 
         "accessTypes": [ "string" ],
         "createdAt": "string",
         "resourceShareArn": "string",
         "resourceShareName": "string",
         "roleArn": "string",
         "s3BucketArn": "string",
         "sources": [ 
            { ... }
         ],
         "subscriberArn": "string",
         "subscriberDescription": "string",
         "subscriberEndpoint": "string",
         "subscriberId": "string",
         "subscriberIdentity": { 
            "externalId": "string",
            "principal": "string"
         },
         "subscriberName": "string",
         "subscriberStatus": "string",
         "updatedAt": "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.

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.

subscribers

The subscribers available for the specified Security Lake account ID.

Type: Array of SubscriberResource 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.

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