libZSservicesZSamazonka-iamZSamazonka-iam
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.IAM.ListUsers

Description

Lists the IAM users that have the specified path prefix. If no path prefix is specified, the operation returns all users in the Amazon Web Services account. If there are none, the operation returns an empty list.

IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for a user, see GetUser.

You can paginate the results using the MaxItems and Marker parameters.

This operation returns paginated results.

Synopsis

Creating a Request

data ListUsers Source #

See: newListUsers smart constructor.

Constructors

ListUsers' 

Fields

  • pathPrefix :: Maybe Text

    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 :: Maybe Text

    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 :: Maybe Natural

    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.

Instances

Instances details
Eq ListUsers Source # 
Instance details

Defined in Amazonka.IAM.ListUsers

Read ListUsers Source # 
Instance details

Defined in Amazonka.IAM.ListUsers

Show ListUsers Source # 
Instance details

Defined in Amazonka.IAM.ListUsers

Generic ListUsers Source # 
Instance details

Defined in Amazonka.IAM.ListUsers

Associated Types

type Rep ListUsers :: Type -> Type #

NFData ListUsers Source # 
Instance details

Defined in Amazonka.IAM.ListUsers

Methods

rnf :: ListUsers -> () #

Hashable ListUsers Source # 
Instance details

Defined in Amazonka.IAM.ListUsers

AWSPager ListUsers Source # 
Instance details

Defined in Amazonka.IAM.ListUsers

AWSRequest ListUsers Source # 
Instance details

Defined in Amazonka.IAM.ListUsers

Associated Types

type AWSResponse ListUsers #

ToHeaders ListUsers Source # 
Instance details

Defined in Amazonka.IAM.ListUsers

Methods

toHeaders :: ListUsers -> [Header] #

ToPath ListUsers Source # 
Instance details

Defined in Amazonka.IAM.ListUsers

ToQuery ListUsers Source # 
Instance details

Defined in Amazonka.IAM.ListUsers

type Rep ListUsers Source # 
Instance details

Defined in Amazonka.IAM.ListUsers

type Rep ListUsers = D1 ('MetaData "ListUsers" "Amazonka.IAM.ListUsers" "libZSservicesZSamazonka-iamZSamazonka-iam" 'False) (C1 ('MetaCons "ListUsers'" 'PrefixI 'True) (S1 ('MetaSel ('Just "pathPrefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxItems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))))
type AWSResponse ListUsers Source # 
Instance details

Defined in Amazonka.IAM.ListUsers

newListUsers :: ListUsers Source #

Create a value of ListUsers with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:pathPrefix:ListUsers', listUsers_pathPrefix - 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.

$sel:marker:ListUsers', listUsers_marker - 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.

$sel:maxItems:ListUsers', listUsers_maxItems - 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.

Request Lenses

listUsers_pathPrefix :: Lens' ListUsers (Maybe Text) Source #

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.

listUsers_marker :: Lens' ListUsers (Maybe Text) Source #

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.

listUsers_maxItems :: Lens' ListUsers (Maybe Natural) Source #

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.

Destructuring the Response

data ListUsersResponse Source #

Contains the response to a successful ListUsers request.

See: newListUsersResponse smart constructor.

Constructors

ListUsersResponse' 

Fields

  • marker :: Maybe Text

    When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

  • isTruncated :: Maybe Bool

    A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

  • httpStatus :: Int

    The response's http status code.

  • users :: [User]

    A list of users.

Instances

Instances details
Eq ListUsersResponse Source # 
Instance details

Defined in Amazonka.IAM.ListUsers

Read ListUsersResponse Source # 
Instance details

Defined in Amazonka.IAM.ListUsers

Show ListUsersResponse Source # 
Instance details

Defined in Amazonka.IAM.ListUsers

Generic ListUsersResponse Source # 
Instance details

Defined in Amazonka.IAM.ListUsers

Associated Types

type Rep ListUsersResponse :: Type -> Type #

NFData ListUsersResponse Source # 
Instance details

Defined in Amazonka.IAM.ListUsers

Methods

rnf :: ListUsersResponse -> () #

type Rep ListUsersResponse Source # 
Instance details

Defined in Amazonka.IAM.ListUsers

type Rep ListUsersResponse = D1 ('MetaData "ListUsersResponse" "Amazonka.IAM.ListUsers" "libZSservicesZSamazonka-iamZSamazonka-iam" 'False) (C1 ('MetaCons "ListUsersResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "isTruncated") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "users") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [User]))))

newListUsersResponse Source #

Create a value of ListUsersResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:marker:ListUsers', listUsersResponse_marker - When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

$sel:isTruncated:ListUsersResponse', listUsersResponse_isTruncated - A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

$sel:httpStatus:ListUsersResponse', listUsersResponse_httpStatus - The response's http status code.

$sel:users:ListUsersResponse', listUsersResponse_users - A list of users.

Response Lenses

listUsersResponse_marker :: Lens' ListUsersResponse (Maybe Text) Source #

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

listUsersResponse_isTruncated :: Lens' ListUsersResponse (Maybe Bool) Source #

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

listUsersResponse_httpStatus :: Lens' ListUsersResponse Int Source #

The response's http status code.