wickr/aws.sdk.kotlin.services.wickr/listGuestUsers

listGuestUsers

inline suspend fun WickrClient.listGuestUsers(crossinline block: ListGuestUsersRequest.Builder.() -> Unit): ListGuestUsersResponse

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.

Samples

import aws.sdk.kotlin.services.wickr.model.SortDirection

fun main() { 
   //sampleStart 
   // Get paginated list of guest users
val resp = wickrClient.listGuestUsers {
    networkId = "12345678"
    maxResults = 20
    sortDirection = SortDirection.fromValue("DESC")
    sortFields = "billingPeriod"
} 
   //sampleEnd
}

import aws.sdk.kotlin.services.wickr.model.SortDirection

fun main() { 
   //sampleStart 
   // Filter by billing period
val resp = wickrClient.listGuestUsers {
    networkId = "12345678"
    billingPeriod = "2024-01"
    maxResults = 10
} 
   //sampleEnd
}

import aws.sdk.kotlin.services.wickr.model.SortDirection

fun main() { 
   //sampleStart 
   // Empty guest list
val resp = wickrClient.listGuestUsers {
    networkId = "87654321"
} 
   //sampleEnd
}