Lists all subscribers for the specific Amazon Security Lake account ID. You can retrieve a list of subscriptions associated with a specific organization or Amazon Web Services account.
Parameters:
-
next_token
(Optional[NextToken], default:
None
)
–
If nextToken is returned, there are more results available. You can repeat the call using the returned token to retrieve the next page.
-
max_results
(Optional[MaxResults], default:
None
)
–
The maximum number of accounts for which the configuration is displayed.
Raises:
-
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 Amazon Web Services action. An implicit denial occurs when there is no applicable Deny statement and also no applicable Allow statement.
-
BadRequestException
–
The request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
-
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.
-
InternalServerException
–
Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting, perform the operation again.
-
ResourceNotFoundException
–
The resource could not be found.
-
ThrottlingException
–
The limit on the number of requests per second was exceeded.
-
UnknownServiceError
–
The service returned an error code this client does not model.
Source code in docs_src/capo_securitylake/_services/security_lake.py
| def list_subscribers(
self,
*,
config_overrides: Optional[SecurityLakeClientConfig] = None,
next_token: Optional["capo_securitylake.types.next_token.NextToken"] = None,
max_results: Optional["capo_securitylake.types.max_results.MaxResults"] = None,
) -> "capo_securitylake.types.list_subscribers_response.ListSubscribersResponse":
"""<p>Lists all subscribers for the specific Amazon Security Lake account ID. You can retrieve a list of subscriptions associated with a specific organization or Amazon Web Services account.</p>
Args:
next_token: <p>If nextToken is returned, there are more results available. You can repeat the call using the returned token to retrieve the next page.</p>
max_results: <p>The maximum number of accounts for which the configuration is displayed.</p>
Raises:
capo_securitylake.errors.access_denied_exception.AccessDeniedException: <p>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 Amazon Web Services action. An implicit denial occurs when there is no applicable Deny statement and also no applicable Allow statement.</p>
capo_securitylake.errors.bad_request_exception.BadRequestException: <p>The request is malformed or contains an error such as an invalid parameter value or a missing required parameter.</p>
capo_securitylake.errors.conflict_exception.ConflictException: <p>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.</p>
capo_securitylake.errors.internal_server_exception.InternalServerException: <p>Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting, perform the operation again.</p>
capo_securitylake.errors.resource_not_found_exception.ResourceNotFoundException: <p>The resource could not be found.</p>
capo_securitylake.errors.throttling_exception.ThrottlingException: <p>The limit on the number of requests per second was exceeded.</p>
capo_securitylake.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_securitylake.types.list_subscribers_request.ListSubscribersRequest]",
) -> OperationResponse[
"capo_securitylake.types.list_subscribers_response.ListSubscribersResponse"
]:
import capo_securitylake._operations.security_lake.list_subscribers
output, http_response = (
capo_securitylake._operations.security_lake.list_subscribers.list_subscribers(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListSubscribers")
)
input_: capo_securitylake.types.list_subscribers_request.ListSubscribersRequest = {}
if next_token is not None:
input_["next_token"] = next_token
if max_results is not None:
input_["max_results"] = max_results
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|