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.AlexaBusiness.SearchUsers

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Searches users and lists the ones that meet a set of filter and sort criteria.

This operation returns paginated results.

Synopsis

data SearchUsers = SearchUsers' {
- filters :: Maybe [Filter]
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- sortCriteria :: Maybe [Sort]
}
newSearchUsers :: SearchUsers
searchUsers_filters :: Lens' SearchUsers (Maybe [Filter])
searchUsers_maxResults :: Lens' SearchUsers (Maybe Natural)
searchUsers_nextToken :: Lens' SearchUsers (Maybe Text)
searchUsers_sortCriteria :: Lens' SearchUsers (Maybe [Sort])
data SearchUsersResponse = SearchUsersResponse' {
- nextToken :: Maybe Text
- totalCount :: Maybe Int
- users :: Maybe [UserData]
- httpStatus :: Int
}
newSearchUsersResponse :: Int -> SearchUsersResponse
searchUsersResponse_nextToken :: Lens' SearchUsersResponse (Maybe Text)
searchUsersResponse_totalCount :: Lens' SearchUsersResponse (Maybe Int)
searchUsersResponse_users :: Lens' SearchUsersResponse (Maybe [UserData])
searchUsersResponse_httpStatus :: Lens' SearchUsersResponse Int

Creating a Request

data SearchUsers Source #

See: newSearchUsers smart constructor.

Constructors

SearchUsers'

Fields

filters :: Maybe [Filter]
The filters to use for listing a specific set of users. Required. Supported filter keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.
maxResults :: Maybe Natural
The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved. Required.
nextToken :: Maybe Text
An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults. Required.
sortCriteria :: Maybe [Sort]
The sort order to use in listing the filtered set of users. Required. Supported sort keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.

Instances

Instances details

ToJSON SearchUsers Source #
Instance details Defined in Amazonka.AlexaBusiness.SearchUsers Methods toJSON :: SearchUsers -> Value # toEncoding :: SearchUsers -> Encoding # toJSONList :: [SearchUsers] -> Value # toEncodingList :: [SearchUsers] -> Encoding #
ToHeaders SearchUsers Source #
Instance details Defined in Amazonka.AlexaBusiness.SearchUsers Methods toHeaders :: SearchUsers -> [Header] #
ToPath SearchUsers Source #
Instance details Defined in Amazonka.AlexaBusiness.SearchUsers Methods toPath :: SearchUsers -> ByteString #
ToQuery SearchUsers Source #
Instance details Defined in Amazonka.AlexaBusiness.SearchUsers Methods toQuery :: SearchUsers -> QueryString #
AWSPager SearchUsers Source #
Instance details Defined in Amazonka.AlexaBusiness.SearchUsers Methods page :: SearchUsers -> AWSResponse SearchUsers -> Maybe SearchUsers #
AWSRequest SearchUsers Source #
Instance details Defined in Amazonka.AlexaBusiness.SearchUsers Associated Types type AWSResponse SearchUsers # Methods request :: (Service -> Service) -> SearchUsers -> Request SearchUsers # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy SearchUsers -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse SearchUsers))) #
Generic SearchUsers Source #
Instance details Defined in Amazonka.AlexaBusiness.SearchUsers Associated Types type Rep SearchUsers :: Type -> Type # Methods from :: SearchUsers -> Rep SearchUsers x # to :: Rep SearchUsers x -> SearchUsers #
Read SearchUsers Source #
Instance details Defined in Amazonka.AlexaBusiness.SearchUsers Methods readsPrec :: Int -> ReadS SearchUsers # readList :: ReadS [SearchUsers] # readPrec :: ReadPrec SearchUsers # readListPrec :: ReadPrec [SearchUsers] #
Show SearchUsers Source #
Instance details Defined in Amazonka.AlexaBusiness.SearchUsers Methods showsPrec :: Int -> SearchUsers -> ShowS # show :: SearchUsers -> String # showList :: [SearchUsers] -> ShowS #
NFData SearchUsers Source #
Instance details Defined in Amazonka.AlexaBusiness.SearchUsers Methods rnf :: SearchUsers -> () #
Eq SearchUsers Source #
Instance details Defined in Amazonka.AlexaBusiness.SearchUsers Methods (==) :: SearchUsers -> SearchUsers -> Bool # (/=) :: SearchUsers -> SearchUsers -> Bool #
Hashable SearchUsers Source #
Instance details Defined in Amazonka.AlexaBusiness.SearchUsers Methods hashWithSalt :: Int -> SearchUsers -> Int # hash :: SearchUsers -> Int #
type AWSResponse SearchUsers Source #
Instance details Defined in Amazonka.AlexaBusiness.SearchUsers type AWSResponse SearchUsers = SearchUsersResponse
type Rep SearchUsers Source #
Instance details Defined in Amazonka.AlexaBusiness.SearchUsers type Rep SearchUsers = D1 ('MetaData "SearchUsers" "Amazonka.AlexaBusiness.SearchUsers" "amazonka-alexa-business-2.0-BWvKfxFukoyBarGovAkdOS" 'False) (C1 ('MetaCons "SearchUsers'" '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 "sortCriteria") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Sort])))))

newSearchUsers :: SearchUsers Source #

Create a value of SearchUsers 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:SearchUsers', searchUsers_filters - The filters to use for listing a specific set of users. Required. Supported filter keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.

$sel:maxResults:SearchUsers', searchUsers_maxResults - The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved. Required.

SearchUsers, searchUsers_nextToken - An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults. Required.

$sel:sortCriteria:SearchUsers', searchUsers_sortCriteria - The sort order to use in listing the filtered set of users. Required. Supported sort keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.

Request Lenses

searchUsers_filters :: Lens' SearchUsers (Maybe [Filter]) Source #

The filters to use for listing a specific set of users. Required. Supported filter keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.

searchUsers_maxResults :: Lens' SearchUsers (Maybe Natural) Source #

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved. Required.

searchUsers_nextToken :: Lens' SearchUsers (Maybe Text) Source #

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults. Required.

searchUsers_sortCriteria :: Lens' SearchUsers (Maybe [Sort]) Source #

The sort order to use in listing the filtered set of users. Required. Supported sort keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.

Destructuring the Response

data SearchUsersResponse Source #

See: newSearchUsersResponse smart constructor.

Constructors

SearchUsersResponse'
Fields nextToken :: Maybe Text The token returned to indicate that there is more data available. totalCount :: Maybe Int The total number of users returned. users :: Maybe [UserData] The users that meet the specified set of filter criteria, in sort order. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic SearchUsersResponse Source #
Instance details Defined in Amazonka.AlexaBusiness.SearchUsers Associated Types type Rep SearchUsersResponse :: Type -> Type # Methods from :: SearchUsersResponse -> Rep SearchUsersResponse x # to :: Rep SearchUsersResponse x -> SearchUsersResponse #
Read SearchUsersResponse Source #
Instance details Defined in Amazonka.AlexaBusiness.SearchUsers Methods readsPrec :: Int -> ReadS SearchUsersResponse # readList :: ReadS [SearchUsersResponse] # readPrec :: ReadPrec SearchUsersResponse # readListPrec :: ReadPrec [SearchUsersResponse] #
Show SearchUsersResponse Source #
Instance details Defined in Amazonka.AlexaBusiness.SearchUsers Methods showsPrec :: Int -> SearchUsersResponse -> ShowS # show :: SearchUsersResponse -> String # showList :: [SearchUsersResponse] -> ShowS #
NFData SearchUsersResponse Source #
Instance details Defined in Amazonka.AlexaBusiness.SearchUsers Methods rnf :: SearchUsersResponse -> () #
Eq SearchUsersResponse Source #
Instance details Defined in Amazonka.AlexaBusiness.SearchUsers Methods (==) :: SearchUsersResponse -> SearchUsersResponse -> Bool # (/=) :: SearchUsersResponse -> SearchUsersResponse -> Bool #
type Rep SearchUsersResponse Source #
Instance details Defined in Amazonka.AlexaBusiness.SearchUsers type Rep SearchUsersResponse = D1 ('MetaData "SearchUsersResponse" "Amazonka.AlexaBusiness.SearchUsers" "amazonka-alexa-business-2.0-BWvKfxFukoyBarGovAkdOS" 'False) (C1 ('MetaCons "SearchUsersResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "totalCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :: (S1 ('MetaSel ('Just "users") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [UserData])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newSearchUsersResponse Source #

Arguments

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

Create a value of SearchUsersResponse 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:

SearchUsers, searchUsersResponse_nextToken - The token returned to indicate that there is more data available.

$sel:totalCount:SearchUsersResponse', searchUsersResponse_totalCount - The total number of users returned.

$sel:users:SearchUsersResponse', searchUsersResponse_users - The users that meet the specified set of filter criteria, in sort order.

$sel:httpStatus:SearchUsersResponse', searchUsersResponse_httpStatus - The response's http status code.

Response Lenses

searchUsersResponse_nextToken :: Lens' SearchUsersResponse (Maybe Text) Source #

The token returned to indicate that there is more data available.

searchUsersResponse_totalCount :: Lens' SearchUsersResponse (Maybe Int) Source #

The total number of users returned.

searchUsersResponse_users :: Lens' SearchUsersResponse (Maybe [UserData]) Source #

The users that meet the specified set of filter criteria, in sort order.

searchUsersResponse_httpStatus :: Lens' SearchUsersResponse Int Source #

The response's http status code.