Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.IdentityStore.ListUsers

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists the attribute name and value of the user that you specified in the search. We only support UserName as a valid filter attribute path currently, and filter is required. This API returns minimum attributes, including UserId and UserName in the response.

Synopsis

data ListUsers = ListUsers' {
- filters :: Maybe [Filter]
- nextToken :: Maybe Text
- maxResults :: Maybe Natural
- identityStoreId :: Text
}
newListUsers :: Text -> ListUsers
listUsers_filters :: Lens' ListUsers (Maybe [Filter])
listUsers_nextToken :: Lens' ListUsers (Maybe Text)
listUsers_maxResults :: Lens' ListUsers (Maybe Natural)
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 request.
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.
maxResults :: Maybe Natural
The maximum number of results to be returned per request. This parameter is used in the ListUsers and ListGroups request to specify how many results to return in one page. The length limit is 50 characters.
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 number and lower case letters. This value is generated at the time that a new identity store is created.

Instances

Instances details

Eq ListUsers Source #
Instance details Defined in Amazonka.IdentityStore.ListUsers Methods (==) :: ListUsers -> ListUsers -> Bool # (/=) :: ListUsers -> ListUsers -> Bool #
Show ListUsers Source #
Instance details Defined in Amazonka.IdentityStore.ListUsers Methods showsPrec :: Int -> ListUsers -> ShowS # show :: ListUsers -> String # showList :: [ListUsers] -> ShowS #
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 #
NFData ListUsers Source #
Instance details Defined in Amazonka.IdentityStore.ListUsers Methods rnf :: ListUsers -> () #
Hashable ListUsers Source #
Instance details Defined in Amazonka.IdentityStore.ListUsers Methods hashWithSalt :: Int -> ListUsers -> Int # hash :: ListUsers -> Int #
ToJSON ListUsers Source #
Instance details Defined in Amazonka.IdentityStore.ListUsers Methods toJSON :: ListUsers -> Value # toEncoding :: ListUsers -> Encoding # toJSONList :: [ListUsers] -> Value # toEncodingList :: [ListUsers] -> Encoding #
AWSRequest ListUsers Source #
Instance details Defined in Amazonka.IdentityStore.ListUsers Associated Types type AWSResponse ListUsers # Methods request :: ListUsers -> Request ListUsers # response :: MonadResource m => Logger -> Service -> Proxy ListUsers -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListUsers))) #
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 #
type Rep ListUsers Source #
Instance details Defined in Amazonka.IdentityStore.ListUsers type Rep ListUsers = D1 ('MetaData "ListUsers" "Amazonka.IdentityStore.ListUsers" "libZSservicesZSamazonka-identitystoreZSamazonka-identitystore" 'False) (C1 ('MetaCons "ListUsers'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter])) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "identityStoreId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse ListUsers Source #
Instance details Defined in Amazonka.IdentityStore.ListUsers type AWSResponse ListUsers = ListUsersResponse

newListUsers Source #

Arguments

:: Text	`$sel:identityStoreId: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 request.

$sel:nextToken: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.

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

$sel:identityStoreId: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 number 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 request.

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_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 request to specify how many results to return in one page. The length limit is 50 characters.

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 number 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

Eq ListUsersResponse Source #
Instance details Defined in Amazonka.IdentityStore.ListUsers Methods (==) :: ListUsersResponse -> ListUsersResponse -> Bool # (/=) :: ListUsersResponse -> ListUsersResponse -> Bool #
Show ListUsersResponse Source #
Instance details Defined in Amazonka.IdentityStore.ListUsers Methods showsPrec :: Int -> ListUsersResponse -> ShowS # show :: ListUsersResponse -> String # showList :: [ListUsersResponse] -> ShowS #
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 #
NFData ListUsersResponse Source #
Instance details Defined in Amazonka.IdentityStore.ListUsers Methods rnf :: ListUsersResponse -> () #
type Rep ListUsersResponse Source #
Instance details Defined in Amazonka.IdentityStore.ListUsers type Rep ListUsersResponse = D1 ('MetaData "ListUsersResponse" "Amazonka.IdentityStore.ListUsers" "libZSservicesZSamazonka-identitystoreZSamazonka-identitystore" '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:

$sel:nextToken: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.