GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
Paws::WorkDocs::DescribeUsers(3) User Contributed Perl Documentation Paws::WorkDocs::DescribeUsers(3)

Paws::WorkDocs::DescribeUsers - Arguments for method DescribeUsers on Paws::WorkDocs

This class represents the parameters used for calling the method DescribeUsers on the Amazon WorkDocs service. Use the attributes of this class as arguments to method DescribeUsers.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeUsers.

    my $workdocs = Paws->service('WorkDocs');
    my $DescribeUsersResponse = $workdocs->DescribeUsers(
      AuthenticationToken => 'MyAuthenticationHeaderType',    # OPTIONAL
      Fields              => 'MyFieldNamesType',              # OPTIONAL
      Include             => 'ALL',                           # OPTIONAL
      Limit               => 1,                               # OPTIONAL
      Marker              => 'MyPageMarkerType',              # OPTIONAL
      Order               => 'ASCENDING',                     # OPTIONAL
      OrganizationId      => 'MyIdType',                      # OPTIONAL
      Query               => 'MySearchQueryType',             # OPTIONAL
      Sort                => 'USER_NAME',                     # OPTIONAL
      UserIds             => 'MyUserIdsType',                 # OPTIONAL
    );
    # Results:
    my $Marker             = $DescribeUsersResponse->Marker;
    my $TotalNumberOfUsers = $DescribeUsersResponse->TotalNumberOfUsers;
    my $Users              = $DescribeUsersResponse->Users;
    # Returns a L<Paws::WorkDocs::DescribeUsersResponse> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/workdocs/DescribeUsers>

Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

A comma-separated list of values. Specify "STORAGE_METADATA" to include the user storage quota and utilization information.

The state of the users. Specify "ALL" to include inactive users.

Valid values are: "ALL", "ACTIVE_PENDING"

The maximum number of items to return.

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

The order for the results.

Valid values are: "ASCENDING", "DESCENDING"

The ID of the organization.

A query to filter users by user name.

The sorting criteria.

Valid values are: "USER_NAME", "FULL_NAME", "STORAGE_LIMIT", "USER_STATUS", "STORAGE_USED"

The IDs of the users.

This class forms part of Paws, documenting arguments for method DescribeUsers in Paws::WorkDocs

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>

2022-06-01 perl v5.40.2

Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.