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 |
Lists spaces.
This operation returns paginated results.
Synopsis
- data ListSpaces = ListSpaces' {}
- 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.
ListSpaces' | |
|
Instances
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.
ListSpacesResponse' | |
|
Instances
newListSpacesResponse Source #
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.