list_guest_users ¶

def list_guest_users(
    self,
    network_id: "capo_wickr.types.network_id.NetworkId",
    *,
    config_overrides: Optional[WickrClientConfig] = None,
    max_results: Optional[int] = None,
    sort_direction: Optional[
        "capo_wickr.types.sort_direction.SortDirection"
    ] = None,
    sort_fields: Optional["capo_wickr.types.generic_string.GenericString"] = None,
    username: Optional["capo_wickr.types.generic_string.GenericString"] = None,
    billing_period: Optional[
        "capo_wickr.types.generic_string.GenericString"
    ] = None,
    next_token: Optional["capo_wickr.types.generic_string.GenericString"] = None,
) -> "capo_wickr.types.list_guest_users_response.ListGuestUsersResponse":
    """<p>Retrieves a paginated list of guest users who have communicated with your Wickr network. Guest users are external users from federated networks who can communicate with network members.</p>

    Args:
        network_id: <p>The ID of the Wickr network from which to list guest users.</p>
        max_results: <p>The maximum number of guest users to return in a single page. Valid range is 1-100. Default is 10.</p>
        sort_direction: <p>The direction to sort results. Valid values are 'ASC' (ascending) or 'DESC' (descending). Default is 'DESC'.</p>
        sort_fields: <p>The field to sort guest users by. Accepted values include 'username' and 'billingPeriod'.</p>
        username: <p>Filter results to only include guest users with usernames matching this value.</p>
        billing_period: <p>Filter results to only include guest users from this billing period (e.g., '2024-01').</p>
        next_token: <p>The token for retrieving the next page of results. This is returned from a previous request when there are more results available.</p>

    Raises:
        capo_wickr.errors.bad_request_error.BadRequestError: <p>The request was invalid or malformed. This error occurs when the request parameters do not meet the API requirements, such as invalid field values, missing required parameters, or improperly formatted data.</p>
        capo_wickr.errors.forbidden_error.ForbiddenError: <p>Access to the requested resource is forbidden. This error occurs when the authenticated user does not have the necessary permissions to perform the requested operation, even though they are authenticated.</p>
        capo_wickr.errors.internal_server_error.InternalServerError: <p>An unexpected error occurred on the server while processing the request. This indicates a problem with the Wickr service itself rather than with the request. If this error persists, contact Amazon Web Services Support.</p>
        capo_wickr.errors.rate_limit_error.RateLimitError: <p>The request was throttled because too many requests were sent in a short period of time. Wait a moment and retry the request. Consider implementing exponential backoff in your application.</p>
        capo_wickr.errors.resource_not_found_error.ResourceNotFoundError: <p>The requested resource could not be found. This error occurs when you try to access or modify a network, user, bot, security group, or other resource that doesn't exist or has been deleted.</p>
        capo_wickr.errors.unauthorized_error.UnauthorizedError: <p>The request was not authenticated or the authentication credentials were invalid. This error occurs when the request lacks valid authentication credentials or the credentials have expired.</p>
        capo_wickr.errors.validation_error.ValidationError: <p>One or more fields in the request failed validation. This error provides detailed information about which fields were invalid and why, allowing you to correct the request and retry.</p>
        capo_wickr.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        Get paginated list of guest users

        >>> client.list_guest_users(network_id='12345678', max_results=20, sort_direction='DESC', sort_fields='billingPeriod')
        Filter by billing period

        >>> client.list_guest_users(network_id='12345678', billing_period='2024-01', max_results=10)
        Empty guest list

        >>> client.list_guest_users(network_id='87654321')
    """

    def _handler(
        req: "OperationRequest[capo_wickr.types.list_guest_users_request.ListGuestUsersRequest]",
    ) -> OperationResponse[
        "capo_wickr.types.list_guest_users_response.ListGuestUsersResponse"
    ]:
        import capo_wickr._operations.wickr_admin_api.list_guest_users

        output, http_response = (
            capo_wickr._operations.wickr_admin_api.list_guest_users.list_guest_users(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListGuestUsers")
    )
    input_: capo_wickr.types.list_guest_users_request.ListGuestUsersRequest = {
        "network_id": network_id
    }
    if max_results is not None:
        input_["max_results"] = max_results
    if sort_direction is not None:
        input_["sort_direction"] = sort_direction
    if sort_fields is not None:
        input_["sort_fields"] = sort_fields
    if username is not None:
        input_["username"] = username
    if billing_period is not None:
        input_["billing_period"] = billing_period
    if next_token is not None:
        input_["next_token"] = next_token

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output