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.SageMaker.ListUserProfiles

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists user profiles.

This operation returns paginated results.

Synopsis

data ListUserProfiles = ListUserProfiles' {
- domainIdEquals :: Maybe Text
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- sortBy :: Maybe UserProfileSortKey
- sortOrder :: Maybe SortOrder
- userProfileNameContains :: Maybe Text
}
newListUserProfiles :: ListUserProfiles
listUserProfiles_domainIdEquals :: Lens' ListUserProfiles (Maybe Text)
listUserProfiles_maxResults :: Lens' ListUserProfiles (Maybe Natural)
listUserProfiles_nextToken :: Lens' ListUserProfiles (Maybe Text)
listUserProfiles_sortBy :: Lens' ListUserProfiles (Maybe UserProfileSortKey)
listUserProfiles_sortOrder :: Lens' ListUserProfiles (Maybe SortOrder)
listUserProfiles_userProfileNameContains :: Lens' ListUserProfiles (Maybe Text)
data ListUserProfilesResponse = ListUserProfilesResponse' {
- nextToken :: Maybe Text
- userProfiles :: Maybe [UserProfileDetails]
- httpStatus :: Int
}
newListUserProfilesResponse :: Int -> ListUserProfilesResponse
listUserProfilesResponse_nextToken :: Lens' ListUserProfilesResponse (Maybe Text)
listUserProfilesResponse_userProfiles :: Lens' ListUserProfilesResponse (Maybe [UserProfileDetails])
listUserProfilesResponse_httpStatus :: Lens' ListUserProfilesResponse Int

Creating a Request

data ListUserProfiles Source #

See: newListUserProfiles smart constructor.

Constructors

ListUserProfiles'

Fields

domainIdEquals :: Maybe Text
A parameter by which to filter the results.
maxResults :: Maybe Natural
Returns a list up to a specified limit.
nextToken :: Maybe Text
If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
sortBy :: Maybe UserProfileSortKey
The parameter by which to sort the results. The default is CreationTime.
sortOrder :: Maybe SortOrder
The sort order for the results. The default is Ascending.
userProfileNameContains :: Maybe Text
A parameter by which to filter the results.

Instances

Instances details

ToJSON ListUserProfiles Source #
Instance details Defined in Amazonka.SageMaker.ListUserProfiles Methods toJSON :: ListUserProfiles -> Value # toEncoding :: ListUserProfiles -> Encoding # toJSONList :: [ListUserProfiles] -> Value # toEncodingList :: [ListUserProfiles] -> Encoding #
ToHeaders ListUserProfiles Source #
Instance details Defined in Amazonka.SageMaker.ListUserProfiles Methods toHeaders :: ListUserProfiles -> [Header] #
ToPath ListUserProfiles Source #
Instance details Defined in Amazonka.SageMaker.ListUserProfiles Methods toPath :: ListUserProfiles -> ByteString #
ToQuery ListUserProfiles Source #
Instance details Defined in Amazonka.SageMaker.ListUserProfiles Methods toQuery :: ListUserProfiles -> QueryString #
AWSPager ListUserProfiles Source #
Instance details Defined in Amazonka.SageMaker.ListUserProfiles Methods page :: ListUserProfiles -> AWSResponse ListUserProfiles -> Maybe ListUserProfiles #
AWSRequest ListUserProfiles Source #
Instance details Defined in Amazonka.SageMaker.ListUserProfiles Associated Types type AWSResponse ListUserProfiles # Methods request :: (Service -> Service) -> ListUserProfiles -> Request ListUserProfiles # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListUserProfiles -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListUserProfiles))) #
Generic ListUserProfiles Source #
Instance details Defined in Amazonka.SageMaker.ListUserProfiles Associated Types type Rep ListUserProfiles :: Type -> Type # Methods from :: ListUserProfiles -> Rep ListUserProfiles x # to :: Rep ListUserProfiles x -> ListUserProfiles #
Read ListUserProfiles Source #
Instance details Defined in Amazonka.SageMaker.ListUserProfiles Methods readsPrec :: Int -> ReadS ListUserProfiles # readList :: ReadS [ListUserProfiles] # readPrec :: ReadPrec ListUserProfiles # readListPrec :: ReadPrec [ListUserProfiles] #
Show ListUserProfiles Source #
Instance details Defined in Amazonka.SageMaker.ListUserProfiles Methods showsPrec :: Int -> ListUserProfiles -> ShowS # show :: ListUserProfiles -> String # showList :: [ListUserProfiles] -> ShowS #
NFData ListUserProfiles Source #
Instance details Defined in Amazonka.SageMaker.ListUserProfiles Methods rnf :: ListUserProfiles -> () #
Eq ListUserProfiles Source #
Instance details Defined in Amazonka.SageMaker.ListUserProfiles Methods (==) :: ListUserProfiles -> ListUserProfiles -> Bool # (/=) :: ListUserProfiles -> ListUserProfiles -> Bool #
Hashable ListUserProfiles Source #
Instance details Defined in Amazonka.SageMaker.ListUserProfiles Methods hashWithSalt :: Int -> ListUserProfiles -> Int # hash :: ListUserProfiles -> Int #
type AWSResponse ListUserProfiles Source #
Instance details Defined in Amazonka.SageMaker.ListUserProfiles type AWSResponse ListUserProfiles = ListUserProfilesResponse
type Rep ListUserProfiles Source #
Instance details Defined in Amazonka.SageMaker.ListUserProfiles type Rep ListUserProfiles = D1 ('MetaData "ListUserProfiles" "Amazonka.SageMaker.ListUserProfiles" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "ListUserProfiles'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "domainIdEquals") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "sortBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UserProfileSortKey)) :: (S1 ('MetaSel ('Just "sortOrder") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SortOrder)) :*: S1 ('MetaSel ('Just "userProfileNameContains") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newListUserProfiles :: ListUserProfiles Source #

Create a value of ListUserProfiles 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:domainIdEquals:ListUserProfiles', listUserProfiles_domainIdEquals - A parameter by which to filter the results.

$sel:maxResults:ListUserProfiles', listUserProfiles_maxResults - Returns a list up to a specified limit.

ListUserProfiles, listUserProfiles_nextToken - If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

$sel:sortBy:ListUserProfiles', listUserProfiles_sortBy - The parameter by which to sort the results. The default is CreationTime.

$sel:sortOrder:ListUserProfiles', listUserProfiles_sortOrder - The sort order for the results. The default is Ascending.

$sel:userProfileNameContains:ListUserProfiles', listUserProfiles_userProfileNameContains - A parameter by which to filter the results.

Request Lenses

listUserProfiles_domainIdEquals :: Lens' ListUserProfiles (Maybe Text) Source #

A parameter by which to filter the results.

listUserProfiles_maxResults :: Lens' ListUserProfiles (Maybe Natural) Source #

Returns a list up to a specified limit.

listUserProfiles_nextToken :: Lens' ListUserProfiles (Maybe Text) Source #

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

listUserProfiles_sortBy :: Lens' ListUserProfiles (Maybe UserProfileSortKey) Source #

The parameter by which to sort the results. The default is CreationTime.

listUserProfiles_sortOrder :: Lens' ListUserProfiles (Maybe SortOrder) Source #

The sort order for the results. The default is Ascending.

listUserProfiles_userProfileNameContains :: Lens' ListUserProfiles (Maybe Text) Source #

A parameter by which to filter the results.

Destructuring the Response

data ListUserProfilesResponse Source #

See: newListUserProfilesResponse smart constructor.

Constructors

ListUserProfilesResponse'
Fields nextToken :: Maybe Text If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results. userProfiles :: Maybe [UserProfileDetails] The list of user profiles. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic ListUserProfilesResponse Source #
Instance details Defined in Amazonka.SageMaker.ListUserProfiles Associated Types type Rep ListUserProfilesResponse :: Type -> Type # Methods from :: ListUserProfilesResponse -> Rep ListUserProfilesResponse x # to :: Rep ListUserProfilesResponse x -> ListUserProfilesResponse #
Read ListUserProfilesResponse Source #
Instance details Defined in Amazonka.SageMaker.ListUserProfiles Methods readsPrec :: Int -> ReadS ListUserProfilesResponse # readList :: ReadS [ListUserProfilesResponse] # readPrec :: ReadPrec ListUserProfilesResponse # readListPrec :: ReadPrec [ListUserProfilesResponse] #
Show ListUserProfilesResponse Source #
Instance details Defined in Amazonka.SageMaker.ListUserProfiles Methods showsPrec :: Int -> ListUserProfilesResponse -> ShowS # show :: ListUserProfilesResponse -> String # showList :: [ListUserProfilesResponse] -> ShowS #
NFData ListUserProfilesResponse Source #
Instance details Defined in Amazonka.SageMaker.ListUserProfiles Methods rnf :: ListUserProfilesResponse -> () #
Eq ListUserProfilesResponse Source #
Instance details Defined in Amazonka.SageMaker.ListUserProfiles Methods (==) :: ListUserProfilesResponse -> ListUserProfilesResponse -> Bool # (/=) :: ListUserProfilesResponse -> ListUserProfilesResponse -> Bool #
type Rep ListUserProfilesResponse Source #
Instance details Defined in Amazonka.SageMaker.ListUserProfiles type Rep ListUserProfilesResponse = D1 ('MetaData "ListUserProfilesResponse" "Amazonka.SageMaker.ListUserProfiles" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "ListUserProfilesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "userProfiles") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [UserProfileDetails])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListUserProfilesResponse Source #

Arguments

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

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

ListUserProfiles, listUserProfilesResponse_nextToken - If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

$sel:userProfiles:ListUserProfilesResponse', listUserProfilesResponse_userProfiles - The list of user profiles.

$sel:httpStatus:ListUserProfilesResponse', listUserProfilesResponse_httpStatus - The response's http status code.

Response Lenses

listUserProfilesResponse_nextToken :: Lens' ListUserProfilesResponse (Maybe Text) Source #

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

listUserProfilesResponse_userProfiles :: Lens' ListUserProfilesResponse (Maybe [UserProfileDetails]) Source #

The list of user profiles.

listUserProfilesResponse_httpStatus :: Lens' ListUserProfilesResponse Int Source #

The response's http status code.