Skip to content

Retrieves a list that describes one or more specified users in the user pool

Description

Retrieves a list that describes one or more specified users in the user pool.

Usage

appstream_describe_users(AuthenticationType, MaxResults, NextToken)

Arguments

  • AuthenticationType

    [required] The authentication type for the users in the user pool to describe. You must specify USERPOOL.

  • MaxResults

    The maximum size of each page of results.

  • NextToken

    The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

Value

A list with the following syntax:

list(
  Users = list(
    list(
      Arn = "string",
      UserName = "string",
      Enabled = TRUE|FALSE,
      Status = "string",
      FirstName = "string",
      LastName = "string",
      CreatedTime = as.POSIXct(
        "2015-01-01"
      ),
      AuthenticationType = "API"|"SAML"|"USERPOOL"|"AWS_AD"
    )
  ),
  NextToken = "string"
)

Request syntax

svc$describe_users(
  AuthenticationType = "API"|"SAML"|"USERPOOL"|"AWS_AD",
  MaxResults = 123,
  NextToken = "string"
)