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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists spaces.

This operation returns paginated results.

Synopsis

data ListSpaces = ListSpaces' {
- domainIdEquals :: Maybe Text
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- sortBy :: Maybe SpaceSortKey
- sortOrder :: Maybe SortOrder
- spaceNameContains :: Maybe Text
}
newListSpaces :: ListSpaces
listSpaces_domainIdEquals :: Lens' ListSpaces (Maybe Text)
listSpaces_maxResults :: Lens' ListSpaces (Maybe Natural)
listSpaces_nextToken :: Lens' ListSpaces (Maybe Text)
listSpaces_sortBy :: Lens' ListSpaces (Maybe SpaceSortKey)
listSpaces_sortOrder :: Lens' ListSpaces (Maybe SortOrder)
listSpaces_spaceNameContains :: Lens' ListSpaces (Maybe Text)
data ListSpacesResponse = ListSpacesResponse' {
- nextToken :: Maybe Text
- spaces :: Maybe [SpaceDetails]
- httpStatus :: Int
}
newListSpacesResponse :: Int -> ListSpacesResponse
listSpacesResponse_nextToken :: Lens' ListSpacesResponse (Maybe Text)
listSpacesResponse_spaces :: Lens' ListSpacesResponse (Maybe [SpaceDetails])
listSpacesResponse_httpStatus :: Lens' ListSpacesResponse Int

Creating a Request

data ListSpaces Source #

See: newListSpaces smart constructor.

Constructors

ListSpaces'

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 SpaceSortKey
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.
spaceNameContains :: Maybe Text
A parameter by which to filter the results.

Instances

Instances details

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

newListSpaces :: ListSpaces Source #

Create a value of ListSpaces 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:ListSpaces', listSpaces_domainIdEquals - A parameter to search for the Domain ID.

$sel:maxResults:ListSpaces', listSpaces_maxResults - Returns a list up to a specified limit.

ListSpaces, listSpaces_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:ListSpaces', listSpaces_sortBy - The parameter by which to sort the results. The default is CreationTime.

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

$sel:spaceNameContains:ListSpaces', listSpaces_spaceNameContains - A parameter by which to filter the results.

Request Lenses

listSpaces_domainIdEquals :: Lens' ListSpaces (Maybe Text) Source #

A parameter to search for the Domain ID.

listSpaces_maxResults :: Lens' ListSpaces (Maybe Natural) Source #

Returns a list up to a specified limit.

listSpaces_nextToken :: Lens' ListSpaces (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.

listSpaces_sortBy :: Lens' ListSpaces (Maybe SpaceSortKey) Source #

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

listSpaces_sortOrder :: Lens' ListSpaces (Maybe SortOrder) Source #

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

listSpaces_spaceNameContains :: Lens' ListSpaces (Maybe Text) Source #

A parameter by which to filter the results.

Destructuring the Response

data ListSpacesResponse Source #

See: newListSpacesResponse smart constructor.

Constructors

ListSpacesResponse'
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. spaces :: Maybe [SpaceDetails] The list of spaces. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newListSpacesResponse Source #

Arguments

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

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

ListSpaces, listSpacesResponse_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:spaces:ListSpacesResponse', listSpacesResponse_spaces - The list of spaces.

$sel:httpStatus:ListSpacesResponse', listSpacesResponse_httpStatus - The response's http status code.

Response Lenses

listSpacesResponse_nextToken :: Lens' ListSpacesResponse (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.

listSpacesResponse_spaces :: Lens' ListSpacesResponse (Maybe [SpaceDetails]) Source #

The list of spaces.

listSpacesResponse_httpStatus :: Lens' ListSpacesResponse Int Source #

The response's http status code.