Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.IdentityStore.ListUsers

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists all users in the identity store. Returns a paginated list of complete User objects. Filtering for a User by the UserName attribute is deprecated. Instead, use the GetUserId API action.

This operation returns paginated results.

Synopsis

data ListUsers = ListUsers' {
- filters :: Maybe [Filter]
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- identityStoreId :: Text
}
newListUsers :: Text -> ListUsers
listUsers_filters :: Lens' ListUsers (Maybe [Filter])
listUsers_maxResults :: Lens' ListUsers (Maybe Natural)
listUsers_nextToken :: Lens' ListUsers (Maybe Text)
listUsers_identityStoreId :: Lens' ListUsers Text
data ListUsersResponse = ListUsersResponse' {
- nextToken :: Maybe Text
- httpStatus :: Int
- users :: [User]
}
newListUsersResponse :: Int -> ListUsersResponse
listUsersResponse_nextToken :: Lens' ListUsersResponse (Maybe Text)
listUsersResponse_httpStatus :: Lens' ListUsersResponse Int
listUsersResponse_users :: Lens' ListUsersResponse [User]

Creating a Request

data ListUsers Source #

See: newListUsers smart constructor.

Constructors

ListUsers'

Fields

filters :: Maybe [Filter]
A list of Filter objects, which is used in the ListUsers and ListGroups requests.
maxResults :: Maybe Natural
The maximum number of results to be returned per request. This parameter is used in the ListUsers and ListGroups requests to specify how many results to return in one page. The length limit is 50 characters.
nextToken :: Maybe Text
The pagination token used for the ListUsers and ListGroups API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.
identityStoreId :: Text
The globally unique identifier for the identity store, such as d-1234567890. In this example, d- is a fixed prefix, and 1234567890 is a randomly generated string that contains numbers and lower case letters. This value is generated at the time that a new identity store is created.

Instances

Instances details

ToJSON ListUsers Source #
Instance details Defined in Amazonka.IdentityStore.ListUsers Methods toJSON :: ListUsers -> Value # toEncoding :: ListUsers -> Encoding # toJSONList :: [ListUsers] -> Value # toEncodingList :: [ListUsers] -> Encoding #
ToHeaders ListUsers Source #
Instance details Defined in Amazonka.IdentityStore.ListUsers Methods toHeaders :: ListUsers -> [Header] #
ToPath ListUsers Source #
Instance details Defined in Amazonka.IdentityStore.ListUsers Methods toPath :: ListUsers -> ByteString #
ToQuery ListUsers Source #
Instance details Defined in Amazonka.IdentityStore.ListUsers Methods toQuery :: ListUsers -> QueryString #
AWSPager ListUsers Source #
Instance details Defined in Amazonka.IdentityStore.ListUsers Methods page :: ListUsers -> AWSResponse ListUsers -> Maybe ListUsers #
AWSRequest ListUsers Source #
Instance details Defined in Amazonka.IdentityStore.ListUsers Associated Types type AWSResponse ListUsers # Methods request :: (Service -> Service) -> ListUsers -> Request ListUsers # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListUsers -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListUsers))) #
Generic ListUsers Source #
Instance details Defined in Amazonka.IdentityStore.ListUsers Associated Types type Rep ListUsers :: Type -> Type # Methods from :: ListUsers -> Rep ListUsers x # to :: Rep ListUsers x -> ListUsers #
Show ListUsers Source #
Instance details Defined in Amazonka.IdentityStore.ListUsers Methods showsPrec :: Int -> ListUsers -> ShowS # show :: ListUsers -> String # showList :: [ListUsers] -> ShowS #
NFData ListUsers Source #
Instance details Defined in Amazonka.IdentityStore.ListUsers Methods rnf :: ListUsers -> () #
Eq ListUsers Source #
Instance details Defined in Amazonka.IdentityStore.ListUsers Methods (==) :: ListUsers -> ListUsers -> Bool # (/=) :: ListUsers -> ListUsers -> Bool #
Hashable ListUsers Source #
Instance details Defined in Amazonka.IdentityStore.ListUsers Methods hashWithSalt :: Int -> ListUsers -> Int # hash :: ListUsers -> Int #
type AWSResponse ListUsers Source #
Instance details Defined in Amazonka.IdentityStore.ListUsers type AWSResponse ListUsers = ListUsersResponse
type Rep ListUsers Source #
Instance details Defined in Amazonka.IdentityStore.ListUsers type Rep ListUsers = D1 ('MetaData "ListUsers" "Amazonka.IdentityStore.ListUsers" "amazonka-identitystore-2.0-FD6RUaLi6gx9YE16ATGTMj" 'False) (C1 ('MetaCons "ListUsers'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter])) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "identityStoreId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListUsers Source #

Arguments

:: Text	`ListUsers`
-> ListUsers

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:filters:ListUsers', listUsers_filters - A list of Filter objects, which is used in the ListUsers and ListGroups requests.

$sel:maxResults:ListUsers', listUsers_maxResults - The maximum number of results to be returned per request. This parameter is used in the ListUsers and ListGroups requests to specify how many results to return in one page. The length limit is 50 characters.

ListUsers, listUsers_nextToken - The pagination token used for the ListUsers and ListGroups API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.

ListUsers, listUsers_identityStoreId - The globally unique identifier for the identity store, such as d-1234567890. In this example, d- is a fixed prefix, and 1234567890 is a randomly generated string that contains numbers and lower case letters. This value is generated at the time that a new identity store is created.

Request Lenses

listUsers_filters :: Lens' ListUsers (Maybe [Filter]) Source #

A list of Filter objects, which is used in the ListUsers and ListGroups requests.

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

The maximum number of results to be returned per request. This parameter is used in the ListUsers and ListGroups requests to specify how many results to return in one page. The length limit is 50 characters.

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

The pagination token used for the ListUsers and ListGroups API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.

listUsers_identityStoreId :: Lens' ListUsers Text Source #

The globally unique identifier for the identity store, such as d-1234567890. In this example, d- is a fixed prefix, and 1234567890 is a randomly generated string that contains numbers and lower case letters. This value is generated at the time that a new identity store is created.

Destructuring the Response

data ListUsersResponse Source #

See: newListUsersResponse smart constructor.

Constructors

ListUsersResponse'

Fields

nextToken :: Maybe Text
The pagination token used for the ListUsers and ListGroups API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.
httpStatus :: Int
The response's http status code.
users :: [User]
A list of User objects in the identity store.

Instances

Instances details

Generic ListUsersResponse Source #
Instance details Defined in Amazonka.IdentityStore.ListUsers Associated Types type Rep ListUsersResponse :: Type -> Type # Methods from :: ListUsersResponse -> Rep ListUsersResponse x # to :: Rep ListUsersResponse x -> ListUsersResponse #
Show ListUsersResponse Source #
Instance details Defined in Amazonka.IdentityStore.ListUsers Methods showsPrec :: Int -> ListUsersResponse -> ShowS # show :: ListUsersResponse -> String # showList :: [ListUsersResponse] -> ShowS #
NFData ListUsersResponse Source #
Instance details Defined in Amazonka.IdentityStore.ListUsers Methods rnf :: ListUsersResponse -> () #
Eq ListUsersResponse Source #
Instance details Defined in Amazonka.IdentityStore.ListUsers Methods (==) :: ListUsersResponse -> ListUsersResponse -> Bool # (/=) :: ListUsersResponse -> ListUsersResponse -> Bool #
type Rep ListUsersResponse Source #
Instance details Defined in Amazonka.IdentityStore.ListUsers type Rep ListUsersResponse = D1 ('MetaData "ListUsersResponse" "Amazonka.IdentityStore.ListUsers" "amazonka-identitystore-2.0-FD6RUaLi6gx9YE16ATGTMj" 'False) (C1 ('MetaCons "ListUsersResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "users") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [User]))))

newListUsersResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListUsersResponse'`
-> ListUsersResponse

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:

ListUsers, listUsersResponse_nextToken - The pagination token used for the ListUsers and ListGroups API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.

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

$sel:users:ListUsersResponse', listUsersResponse_users - A list of User objects in the identity store.

Response Lenses

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

The pagination token used for the ListUsers and ListGroups API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.

listUsersResponse_httpStatus :: Lens' ListUsersResponse Int Source #

The response's http status code.

listUsersResponse_users :: Lens' ListUsersResponse [User] Source #

A list of User objects in the identity store.