Skip to content

Lists user profiles

Description

Lists user profiles.

Usage

sagemaker_list_user_profiles(NextToken, MaxResults, SortOrder, SortBy,
  DomainIdEquals, UserProfileNameContains)

Arguments

  • NextToken

    If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

  • MaxResults

    This parameter defines the maximum number of results that can be return in a single response. The MaxResults parameter is an upper bound, not a target. If there are more results available than the value specified, a NextToken is provided in the response. The NextToken indicates that the user should get the next set of results by providing this token as a part of a subsequent call. The default value for MaxResults is 10.

  • SortOrder

    The sort order for the results. The default is Ascending.

  • SortBy

    The parameter by which to sort the results. The default is CreationTime.

  • DomainIdEquals

    A parameter by which to filter the results.

  • UserProfileNameContains

    A parameter by which to filter the results.

Value

A list with the following syntax:

list(
  UserProfiles = list(
    list(
      DomainId = "string",
      UserProfileName = "string",
      Status = "Deleting"|"Failed"|"InService"|"Pending"|"Updating"|"Update_Failed"|"Delete_Failed",
      CreationTime = as.POSIXct(
        "2015-01-01"
      ),
      LastModifiedTime = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_user_profiles(
  NextToken = "string",
  MaxResults = 123,
  SortOrder = "Ascending"|"Descending",
  SortBy = "CreationTime"|"LastModifiedTime",
  DomainIdEquals = "string",
  UserProfileNameContains = "string"
)