ListSubscribers
List 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.
- nextToken
-
If nextToken is returned, there are more results available. You can repeat the call using the returned token to retrieve the next page.
Pattern:
^[\\\w\-_:/.@=+]*$
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" ],
"accountId": "string",
"createdAt": number,
"externalId": "string",
"roleArn": "string",
"s3BucketArn": "string",
"snsArn": "string",
"sourceTypes": [
{
"awsSourceType": "string",
"customSourceType": "string"
}
],
"subscriberDescription": "string",
"subscriberName": "string",
"subscriptionEndpoint": "string",
"subscriptionId": "string",
"subscriptionProtocol": "string",
"subscriptionStatus": "string",
"updatedAt": number
}
]
}
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
Pattern:
^[\\\w\-_:/.@=+]*$
- 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
- 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
- InvalidInputException
-
The request was rejected because a value that's not valid or is out of range was supplied for an input parameter.
HTTP Status Code: 400
- 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: