Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Gets a list of build project names, with each build project name representing a single build project.
This operation returns paginated results.
Synopsis
- data ListProjects = ListProjects' {}
- newListProjects :: ListProjects
- listProjects_sortOrder :: Lens' ListProjects (Maybe SortOrderType)
- listProjects_nextToken :: Lens' ListProjects (Maybe Text)
- listProjects_sortBy :: Lens' ListProjects (Maybe ProjectSortByType)
- data ListProjectsResponse = ListProjectsResponse' {}
- newListProjectsResponse :: Int -> ListProjectsResponse
- listProjectsResponse_nextToken :: Lens' ListProjectsResponse (Maybe Text)
- listProjectsResponse_projects :: Lens' ListProjectsResponse (Maybe (NonEmpty Text))
- listProjectsResponse_httpStatus :: Lens' ListProjectsResponse Int
Creating a Request
data ListProjects Source #
See: newListProjects
smart constructor.
ListProjects' | |
|
Instances
newListProjects :: ListProjects Source #
Create a value of ListProjects
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:sortOrder:ListProjects'
, listProjects_sortOrder
- The order in which to list build projects. Valid values include:
ASCENDING
: List in ascending order.DESCENDING
: List in descending order.
Use sortBy
to specify the criterion to be used to list build project
names.
$sel:nextToken:ListProjects'
, listProjects_nextToken
- During a previous call, if there are more than 100 items in the list,
only the first 100 items are returned, along with a unique string called
a nextToken. To get the next batch of items in the list, call this
operation again, adding the next token to the call. To get all of the
items in the list, keep calling this operation with each subsequent next
token that is returned, until no more next tokens are returned.
$sel:sortBy:ListProjects'
, listProjects_sortBy
- The criterion to be used to list build project names. Valid values
include:
CREATED_TIME
: List based on when each build project was created.LAST_MODIFIED_TIME
: List based on when information about each build project was last changed.NAME
: List based on each build project's name.
Use sortOrder
to specify in what order to list the build project names
based on the preceding criteria.
Request Lenses
listProjects_sortOrder :: Lens' ListProjects (Maybe SortOrderType) Source #
The order in which to list build projects. Valid values include:
ASCENDING
: List in ascending order.DESCENDING
: List in descending order.
Use sortBy
to specify the criterion to be used to list build project
names.
listProjects_nextToken :: Lens' ListProjects (Maybe Text) Source #
During a previous call, if there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a nextToken. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.
listProjects_sortBy :: Lens' ListProjects (Maybe ProjectSortByType) Source #
The criterion to be used to list build project names. Valid values include:
CREATED_TIME
: List based on when each build project was created.LAST_MODIFIED_TIME
: List based on when information about each build project was last changed.NAME
: List based on each build project's name.
Use sortOrder
to specify in what order to list the build project names
based on the preceding criteria.
Destructuring the Response
data ListProjectsResponse Source #
See: newListProjectsResponse
smart constructor.
ListProjectsResponse' | |
|
Instances
newListProjectsResponse Source #
Create a value of ListProjectsResponse
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:nextToken:ListProjects'
, listProjectsResponse_nextToken
- If there are more than 100 items in the list, only the first 100 items
are returned, along with a unique string called a nextToken. To get
the next batch of items in the list, call this operation again, adding
the next token to the call.
$sel:projects:ListProjectsResponse'
, listProjectsResponse_projects
- The list of build project names, with each build project name
representing a single build project.
$sel:httpStatus:ListProjectsResponse'
, listProjectsResponse_httpStatus
- The response's http status code.
Response Lenses
listProjectsResponse_nextToken :: Lens' ListProjectsResponse (Maybe Text) Source #
If there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a nextToken. To get the next batch of items in the list, call this operation again, adding the next token to the call.
listProjectsResponse_projects :: Lens' ListProjectsResponse (Maybe (NonEmpty Text)) Source #
The list of build project names, with each build project name representing a single build project.
listProjectsResponse_httpStatus :: Lens' ListProjectsResponse Int Source #
The response's http status code.