WorkDocs / Client / describe_users

describe_users#

WorkDocs.Client.describe_users(**kwargs)#

Describes the specified users. You can describe all users or filter the results (for example, by status or organization).

By default, Amazon WorkDocs returns the first 24 active or pending users. If there are more results, the response includes a marker that you can use to request the next set of results.

See also: AWS API Documentation

Request Syntax

response = client.describe_users(
    AuthenticationToken='string',
    OrganizationId='string',
    UserIds='string',
    Query='string',
    Include='ALL'|'ACTIVE_PENDING',
    Order='ASCENDING'|'DESCENDING',
    Sort='USER_NAME'|'FULL_NAME'|'STORAGE_LIMIT'|'USER_STATUS'|'STORAGE_USED',
    Marker='string',
    Limit=123,
    Fields='string'
)
Parameters:

  • AuthenticationToken (string) – Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

  • OrganizationId (string) – The ID of the organization.

  • UserIds (string) – The IDs of the users.

  • Query (string) –

    A query to filter users by user name. Remember the following about the Userids and Query parameters:

    • If you don’t use either parameter, the API returns a paginated list of all users on the site.

    • If you use both parameters, the API ignores the Query parameter.

    • The Userid parameter only returns user names that match a corresponding user ID.

    • The Query parameter runs a “prefix” search for users by the GivenName, SurName, or UserName fields included in a CreateUser API call. For example, querying on Ma returns Márcia Oliveira, María García, and Mateo Jackson. If you use multiple characters, the API only returns data that matches all characters. For example, querying on Ma J only returns Mateo Jackson.

  • Include (string) – The state of the users. Specify “ALL” to include inactive users.

  • Order (string) – The order for the results.

  • Sort (string) – The sorting criteria.

  • Marker (string) – The marker for the next set of results. (You received this marker from a previous call.)

  • Limit (integer) – The maximum number of items to return.

  • Fields (string) – A comma-separated list of values. Specify “STORAGE_METADATA” to include the user storage quota and utilization information.

Return type:

dict

Returns:

Response Syntax

{
    'Users': [
        {
            'Id': 'string',
            'Username': 'string',
            'EmailAddress': 'string',
            'GivenName': 'string',
            'Surname': 'string',
            'OrganizationId': 'string',
            'RootFolderId': 'string',
            'RecycleBinFolderId': 'string',
            'Status': 'ACTIVE'|'INACTIVE'|'PENDING',
            'Type': 'USER'|'ADMIN'|'POWERUSER'|'MINIMALUSER'|'WORKSPACESUSER',
            'CreatedTimestamp': datetime(2015, 1, 1),
            'ModifiedTimestamp': datetime(2015, 1, 1),
            'TimeZoneId': 'string',
            'Locale': 'en'|'fr'|'ko'|'de'|'es'|'ja'|'ru'|'zh_CN'|'zh_TW'|'pt_BR'|'default',
            'Storage': {
                'StorageUtilizedInBytes': 123,
                'StorageRule': {
                    'StorageAllocatedInBytes': 123,
                    'StorageType': 'UNLIMITED'|'QUOTA'
                }
            }
        },
    ],
    'TotalNumberOfUsers': 123,
    'Marker': 'string'
}

Response Structure

  • (dict) –

    • Users (list) –

      The users.

      • (dict) –

        Describes a user.

        • Id (string) –

          The ID of the user.

        • Username (string) –

          The login name of the user.

        • EmailAddress (string) –

          The email address of the user.

        • GivenName (string) –

          The given name of the user.

        • Surname (string) –

          The surname of the user.

        • OrganizationId (string) –

          The ID of the organization.

        • RootFolderId (string) –

          The ID of the root folder.

        • RecycleBinFolderId (string) –

          The ID of the recycle bin folder.

        • Status (string) –

          The status of the user.

        • Type (string) –

          The type of user.

        • CreatedTimestamp (datetime) –

          The time when the user was created.

        • ModifiedTimestamp (datetime) –

          The time when the user was modified.

        • TimeZoneId (string) –

          The time zone ID of the user.

        • Locale (string) –

          The locale of the user.

        • Storage (dict) –

          The storage for the user.

          • StorageUtilizedInBytes (integer) –

            The amount of storage used, in bytes.

          • StorageRule (dict) –

            The storage for a user.

            • StorageAllocatedInBytes (integer) –

              The amount of storage allocated, in bytes.

            • StorageType (string) –

              The type of storage.

    • TotalNumberOfUsers (integer) –

      The total number of users included in the results.

    • Marker (string) –

      The marker to use when requesting the next set of results. If there are no additional results, the string is empty.

Exceptions