users#

IAM.ServiceResource.users#

A collection of User resources.A User Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources.

all()#

Creates an iterable of all User resources in the collection.

See also: AWS API Documentation

Request Syntax

user_iterator = iam.users.all()

Return type:: list(iam.User)
Returns:: A list of User resources

filter(**kwargs)#

Creates an iterable of all User resources in the collection filtered by kwargs passed to method. A User collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources.

See also: AWS API Documentation

Request Syntax

user_iterator = iam.users.filter(
    PathPrefix='string',
    Marker='string',
    MaxItems=123
)

Parameters:

PathPrefix (string) –
The path prefix for filtering the results. For example: /division_abc/subdivision_xyz/, which would get all user names whose path starts with /division_abc/subdivision_xyz/.

This parameter is optional. If it is not included, it defaults to a slash (/), listing all user names. This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! ( \u0021) through the DEL character ( \u007F), including most punctuation characters, digits, and upper and lowercased letters.
Marker (string) – Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.
MaxItems (integer) –
Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

Return type:

list(iam.User)

Returns:

A list of User resources

limit(**kwargs)#

Creates an iterable up to a specified amount of User resources in the collection.

See also: AWS API Documentation

Request Syntax

user_iterator = iam.users.limit(
    count=123
)

Parameters:: count (integer) – The limit to the number of resources in the iterable.
Return type:: list(iam.User)
Returns:: A list of User resources

page_size(**kwargs)#

Creates an iterable of all User resources in the collection, but limits the number of items returned by each service call by the specified amount.

See also: AWS API Documentation

Request Syntax

user_iterator = iam.users.page_size(
    count=123
)

Parameters:: count (integer) – The number of items returned by each service call
Return type:: list(iam.User)
Returns:: A list of User resources