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.ListApps

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists apps.

This operation returns paginated results.

Synopsis

data ListApps = ListApps' {
- domainIdEquals :: Maybe Text
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- sortBy :: Maybe AppSortKey
- sortOrder :: Maybe SortOrder
- spaceNameEquals :: Maybe Text
- userProfileNameEquals :: Maybe Text
}
newListApps :: ListApps
listApps_domainIdEquals :: Lens' ListApps (Maybe Text)
listApps_maxResults :: Lens' ListApps (Maybe Natural)
listApps_nextToken :: Lens' ListApps (Maybe Text)
listApps_sortBy :: Lens' ListApps (Maybe AppSortKey)
listApps_sortOrder :: Lens' ListApps (Maybe SortOrder)
listApps_spaceNameEquals :: Lens' ListApps (Maybe Text)
listApps_userProfileNameEquals :: Lens' ListApps (Maybe Text)
data ListAppsResponse = ListAppsResponse' {
- apps :: Maybe [AppDetails]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newListAppsResponse :: Int -> ListAppsResponse
listAppsResponse_apps :: Lens' ListAppsResponse (Maybe [AppDetails])
listAppsResponse_nextToken :: Lens' ListAppsResponse (Maybe Text)
listAppsResponse_httpStatus :: Lens' ListAppsResponse Int

Creating a Request

data ListApps Source #

See: newListApps smart constructor.

Constructors

ListApps'

Fields

domainIdEquals :: Maybe Text
A parameter to search for the domain ID.
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 AppSortKey
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.
spaceNameEquals :: Maybe Text
A parameter to search by space name. If UserProfileNameEquals is set, then this value cannot be set.
userProfileNameEquals :: Maybe Text
A parameter to search by user profile name. If SpaceNameEquals is set, then this value cannot be set.

Instances

Instances details

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

newListApps :: ListApps Source #

Create a value of ListApps 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:ListApps', listApps_domainIdEquals - A parameter to search for the domain ID.

$sel:maxResults:ListApps', listApps_maxResults - Returns a list up to a specified limit.

ListApps, listApps_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:ListApps', listApps_sortBy - The parameter by which to sort the results. The default is CreationTime.

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

$sel:spaceNameEquals:ListApps', listApps_spaceNameEquals - A parameter to search by space name. If UserProfileNameEquals is set, then this value cannot be set.

$sel:userProfileNameEquals:ListApps', listApps_userProfileNameEquals - A parameter to search by user profile name. If SpaceNameEquals is set, then this value cannot be set.

Request Lenses

listApps_domainIdEquals :: Lens' ListApps (Maybe Text) Source #

A parameter to search for the domain ID.

listApps_maxResults :: Lens' ListApps (Maybe Natural) Source #

Returns a list up to a specified limit.

listApps_nextToken :: Lens' ListApps (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.

listApps_sortBy :: Lens' ListApps (Maybe AppSortKey) Source #

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

listApps_sortOrder :: Lens' ListApps (Maybe SortOrder) Source #

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

listApps_spaceNameEquals :: Lens' ListApps (Maybe Text) Source #

A parameter to search by space name. If UserProfileNameEquals is set, then this value cannot be set.

listApps_userProfileNameEquals :: Lens' ListApps (Maybe Text) Source #

A parameter to search by user profile name. If SpaceNameEquals is set, then this value cannot be set.

Destructuring the Response

data ListAppsResponse Source #

See: newListAppsResponse smart constructor.

Constructors

ListAppsResponse'
Fields apps :: Maybe [AppDetails] The list of apps. 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. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newListAppsResponse Source #

Arguments

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

Create a value of ListAppsResponse 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:apps:ListAppsResponse', listAppsResponse_apps - The list of apps.

ListApps, listAppsResponse_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:httpStatus:ListAppsResponse', listAppsResponse_httpStatus - The response's http status code.

Response Lenses

listAppsResponse_apps :: Lens' ListAppsResponse (Maybe [AppDetails]) Source #

The list of apps.

listAppsResponse_nextToken :: Lens' ListAppsResponse (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.

listAppsResponse_httpStatus :: Lens' ListAppsResponse Int Source #

The response's http status code.