SageMaker / Paginator / ListUserProfiles

ListUserProfiles

class SageMaker.Paginator.ListUserProfiles

paginator = client.get_paginator('list_user_profiles')

paginate(**kwargs)

Creates an iterator that will paginate through responses from SageMaker.Client.list_user_profiles().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    SortOrder='Ascending'|'Descending',
    SortBy='CreationTime'|'LastModifiedTime',
    DomainIdEquals='string',
    UserProfileNameContains='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• 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.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

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)
        },
    ],

}

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.