list_accounts ¶

def list_accounts(
    self,
    *,
    config_overrides: Optional[ChimeClientConfig] = None,
    name: Optional["capo_chime.types.account_name.AccountName"] = None,
    user_email: Optional["capo_chime.types.email_address.EmailAddress"] = None,
    next_token: Optional["capo_chime.types.string.String"] = None,
    max_results: Optional[
        "capo_chime.types.profile_service_max_results.ProfileServiceMaxResults"
    ] = None,
) -> "capo_chime.types.list_accounts_response.ListAccountsResponse":
    """<p>Lists the Amazon Chime accounts under the administrator's AWS account. You can filter accounts by account name prefix. To find out which Amazon Chime account a user belongs to, you can filter by the user's email address, which returns one account result.</p>

    Args:
        name: <p>Amazon Chime account name prefix with which to filter results.</p>
        user_email: <p>User email address with which to filter results.</p>
        next_token: <p>The token to use to retrieve the next page of results.</p>
        max_results: <p>The maximum number of results to return in a single call. Defaults to 100.</p>

    Raises:
        capo_chime.errors.bad_request_exception.BadRequestException: <p>The input parameters don't match the service's restrictions.</p>
        capo_chime.errors.forbidden_exception.ForbiddenException: <p>The client is permanently forbidden from making the request.</p>
        capo_chime.errors.not_found_exception.NotFoundException: <p>One or more of the resources in the request does not exist in the system.</p>
        capo_chime.errors.service_failure_exception.ServiceFailureException: <p>The service encountered an unexpected error.</p>
        capo_chime.errors.service_unavailable_exception.ServiceUnavailableException: <p>The service is currently unavailable.</p>
        capo_chime.errors.throttled_client_exception.ThrottledClientException: <p>The client exceeded its request rate limit.</p>
        capo_chime.errors.unauthorized_client_exception.UnauthorizedClientException: <p>The client is not currently authorized to make the request.</p>
        capo_chime.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_chime.types.list_accounts_request.ListAccountsRequest]",
    ) -> OperationResponse[
        "capo_chime.types.list_accounts_response.ListAccountsResponse"
    ]:
        import capo_chime._operations.uc_buzz_console_service.list_accounts

        output, http_response = (
            capo_chime._operations.uc_buzz_console_service.list_accounts.list_accounts(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_chime.types.list_accounts_request.ListAccountsRequest",
    ) -> dict[str, Any]:
        import capo_chime.types.list_accounts_request

        return capo_chime.types.list_accounts_request.redact_sensitive(input_)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("ListAccounts", redact_input=_redact_input),
    )
    input_: capo_chime.types.list_accounts_request.ListAccountsRequest = {}
    if name is not None:
        input_["name"] = name
    if user_email is not None:
        input_["user_email"] = user_email
    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