![]() |
![]()
| ![]() |
![]()
NAMEPaws::WorkDocs::DescribeUsers - Arguments for method DescribeUsers on Paws::WorkDocs DESCRIPTIONThis 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. SYNOPSISmy $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> ATTRIBUTESAuthenticationToken => StrAmazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API. Fields => StrA comma-separated list of values. Specify "STORAGE_METADATA" to include the user storage quota and utilization information. Include => StrThe state of the users. Specify "ALL" to include inactive users. Valid values are: "ALL", "ACTIVE_PENDING" Limit => IntThe maximum number of items to return. Marker => StrThe marker for the next set of results. (You received this marker from a previous call.) Order => StrThe order for the results. Valid values are: "ASCENDING", "DESCENDING" OrganizationId => StrThe ID of the organization. Query => StrA query to filter users by user name. Sort => StrThe sorting criteria. Valid values are: "USER_NAME", "FULL_NAME", "STORAGE_LIMIT", "USER_STATUS", "STORAGE_USED" UserIds => StrThe IDs of the users. SEE ALSOThis class forms part of Paws, documenting arguments for method DescribeUsers in Paws::WorkDocs BUGS and CONTRIBUTIONSThe source code is located here: <https://github.com/pplu/aws-sdk-perl> Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>
|