SageMaker / Client / list_user_profiles

list_user_profiles

SageMaker.Client.list_user_profiles(**kwargs)

Lists user profiles.

See also: AWS API Documentation

Request Syntax

response = client.list_user_profiles(
    NextToken='string',
    MaxResults=123,
    SortOrder='Ascending'|'Descending',
    SortBy='CreationTime'|'LastModifiedTime',
    DomainIdEquals='string',
    UserProfileNameContains='string'
)

Parameters:

• NextToken (string) – 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 (integer) – Returns a list up to a specified limit.

• SortOrder (string) – The sort order for the results. The default is Ascending.

• SortBy (string) – The parameter by which to sort the results. The default is CreationTime.

• DomainIdEquals (string) – A parameter by which to filter the results.

• UserProfileNameContains (string) – A parameter by which to filter the results.

Return type:

dict

Returns:

Response Syntax

{
    'UserProfiles': [
        {
            'DomainId': 'string',
            'UserProfileName': 'string',
            'Status': 'Deleting'|'Failed'|'InService'|'Pending'|'Updating'|'Update_Failed'|'Delete_Failed',
            'CreationTime': datetime(2015, 1, 1),
            'LastModifiedTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • UserProfiles (list) –

    The list of user profiles.

    • (dict) –

      The user profile details.

      • DomainId (string) –

        The domain ID.

      • UserProfileName (string) –

        The user profile name.

      • Status (string) –

        The status.

      • CreationTime (datetime) –

        The creation time.

      • LastModifiedTime (datetime) –

        The last modified time.

  • NextToken (string) –

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