Network.AWS.IAM.ListUsers

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

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

This operation returns paginated results.

Creating a Request

listUsers :: ListUsers

Creates a value of ListUsers with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• luPathPrefix - The path prefix for filtering the results. For example: division_abcsubdivision_xyz/ , which would get all user names whose path starts with division_abcsubdivision_xyz/ . This parameter is optional. If it is not included, it defaults to a slash (), listing all user names. This parameter allows (per its <http:wikipedia.orgwikiregex 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.
• luMarker - 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.
• luMaxItems - (Optional) 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, it 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.

data ListUsers

See: listUsers smart constructor.

Instances

Eq ListUsers

Defined in Network.AWS.IAM.ListUsers

Methods

(==) :: ListUsers -> ListUsers -> Bool

(/=) :: ListUsers -> ListUsers -> Bool

Data ListUsers

Defined in Network.AWS.IAM.ListUsers

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListUsers -> c ListUsers

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListUsers

toConstr :: ListUsers -> Constr

dataTypeOf :: ListUsers -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ListUsers)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListUsers)

gmapT :: (forall b. Data b => b -> b) -> ListUsers -> ListUsers

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListUsers -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListUsers -> r

gmapQ :: (forall d. Data d => d -> u) -> ListUsers -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ListUsers -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListUsers -> m ListUsers

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListUsers -> m ListUsers

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListUsers -> m ListUsers

Read ListUsers

Defined in Network.AWS.IAM.ListUsers

Methods

readsPrec :: Int -> ReadS ListUsers

readList :: ReadS [ListUsers]

readPrec :: ReadPrec ListUsers

readListPrec :: ReadPrec [ListUsers]

Show ListUsers

Defined in Network.AWS.IAM.ListUsers

Methods

showsPrec :: Int -> ListUsers -> ShowS

show :: ListUsers -> String

showList :: [ListUsers] -> ShowS

Generic ListUsers

Defined in Network.AWS.IAM.ListUsers

Associated Types

type Rep ListUsers :: Type -> Type

Methods

from :: ListUsers -> Rep ListUsers x

to :: Rep ListUsers x -> ListUsers

Hashable ListUsers

Defined in Network.AWS.IAM.ListUsers

Methods

hashWithSalt :: Int -> ListUsers -> Int

hash :: ListUsers -> Int

AWSPager ListUsers

Defined in Network.AWS.IAM.ListUsers

Methods

page :: ListUsers -> Rs ListUsers -> Maybe ListUsers

AWSRequest ListUsers

Defined in Network.AWS.IAM.ListUsers

Associated Types

type Rs ListUsers :: Type

Methods

request :: ListUsers -> Request ListUsers

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy ListUsers -> ClientResponse -> m (Response ListUsers)

ToHeaders ListUsers

Defined in Network.AWS.IAM.ListUsers

Methods

toHeaders :: ListUsers -> [Header]

ToPath ListUsers

Defined in Network.AWS.IAM.ListUsers

Methods

toPath :: ListUsers -> ByteString

ToQuery ListUsers

Defined in Network.AWS.IAM.ListUsers

Methods

toQuery :: ListUsers -> QueryString

NFData ListUsers

Defined in Network.AWS.IAM.ListUsers

Methods

rnf :: ListUsers -> ()

type Rep ListUsers

Defined in Network.AWS.IAM.ListUsers

type Rep ListUsers = D1 (MetaData "ListUsers" "Network.AWS.IAM.ListUsers" "amazonka-iam-1.6.1-BDjAp2BAcQu3GSS4Bsr6zu" False) (C1 (MetaCons "ListUsers'" PrefixI True) (S1 (MetaSel (Just "_luPathPrefix") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_luMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_luMaxItems") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat)))))

type Rs ListUsers

Defined in Network.AWS.IAM.ListUsers

type Rs ListUsers = ListUsersResponse

Request Lenses

luPathPrefix :: Lens' ListUsers (Maybe Text)

The path prefix for filtering the results. For example: division_abcsubdivision_xyz/ , which would get all user names whose path starts with division_abcsubdivision_xyz/ . This parameter is optional. If it is not included, it defaults to a slash (), listing all user names. This parameter allows (per its <http:wikipedia.orgwikiregex 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.

luMarker :: Lens' ListUsers (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.

luMaxItems :: Lens' ListUsers (Maybe Natural)

(Optional) 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, it 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

listUsersResponse

Arguments

:: Int

lursResponseStatus

-> ListUsersResponse

Creates a value of ListUsersResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• lursMarker - When IsTruncated is true , this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
• lursIsTruncated - 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 of your results.
• lursResponseStatus - -- | The response status code.
• lursUsers - A list of users.

data ListUsersResponse

Contains the response to a successful ListUsers request.

See: listUsersResponse smart constructor.

Instances

Eq ListUsersResponse

Defined in Network.AWS.IAM.ListUsers

Methods

(==) :: ListUsersResponse -> ListUsersResponse -> Bool

(/=) :: ListUsersResponse -> ListUsersResponse -> Bool

Data ListUsersResponse

Defined in Network.AWS.IAM.ListUsers

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListUsersResponse -> c ListUsersResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListUsersResponse

toConstr :: ListUsersResponse -> Constr

dataTypeOf :: ListUsersResponse -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ListUsersResponse)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListUsersResponse)

gmapT :: (forall b. Data b => b -> b) -> ListUsersResponse -> ListUsersResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListUsersResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListUsersResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> ListUsersResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ListUsersResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListUsersResponse -> m ListUsersResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListUsersResponse -> m ListUsersResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListUsersResponse -> m ListUsersResponse

Read ListUsersResponse

Defined in Network.AWS.IAM.ListUsers

Methods

readsPrec :: Int -> ReadS ListUsersResponse

readList :: ReadS [ListUsersResponse]

readPrec :: ReadPrec ListUsersResponse

readListPrec :: ReadPrec [ListUsersResponse]

Show ListUsersResponse

Defined in Network.AWS.IAM.ListUsers

Methods

showsPrec :: Int -> ListUsersResponse -> ShowS

show :: ListUsersResponse -> String

showList :: [ListUsersResponse] -> ShowS

Generic ListUsersResponse

Defined in Network.AWS.IAM.ListUsers

Associated Types

type Rep ListUsersResponse :: Type -> Type

Methods

from :: ListUsersResponse -> Rep ListUsersResponse x

to :: Rep ListUsersResponse x -> ListUsersResponse

NFData ListUsersResponse

Defined in Network.AWS.IAM.ListUsers

Methods

rnf :: ListUsersResponse -> ()

type Rep ListUsersResponse

Defined in Network.AWS.IAM.ListUsers

type Rep ListUsersResponse = D1 (MetaData "ListUsersResponse" "Network.AWS.IAM.ListUsers" "amazonka-iam-1.6.1-BDjAp2BAcQu3GSS4Bsr6zu" False) (C1 (MetaCons "ListUsersResponse'" PrefixI True) ((S1 (MetaSel (Just "_lursMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_lursIsTruncated") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 (MetaSel (Just "_lursResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int) :*: S1 (MetaSel (Just "_lursUsers") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [User]))))

Response Lenses

lursMarker :: Lens' ListUsersResponse (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.

lursIsTruncated :: Lens' ListUsersResponse (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 of your results.

lursResponseStatus :: Lens' ListUsersResponse Int

• - | The response status code.

lursUsers :: Lens' ListUsersResponse [User]

A list of users.