Copyright | (c) 2013-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Retrieves build records for all builds associated with the AWS account in use. You can limit results to builds that are in a specific status by using the Status
parameter. Use the pagination parameters to retrieve results in a set of sequential pages.
Build records are not listed in any particular order.
- listBuilds :: ListBuilds
- data ListBuilds
- lbStatus :: Lens' ListBuilds (Maybe BuildStatus)
- lbNextToken :: Lens' ListBuilds (Maybe Text)
- lbLimit :: Lens' ListBuilds (Maybe Natural)
- listBuildsResponse :: Int -> ListBuildsResponse
- data ListBuildsResponse
- lbrsBuilds :: Lens' ListBuildsResponse [Build]
- lbrsNextToken :: Lens' ListBuildsResponse (Maybe Text)
- lbrsResponseStatus :: Lens' ListBuildsResponse Int
Creating a Request
listBuilds :: ListBuilds Source #
Creates a value of ListBuilds
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data ListBuilds Source #
Represents the input for a request action.
See: listBuilds
smart constructor.
Request Lenses
lbStatus :: Lens' ListBuilds (Maybe BuildStatus) Source #
Build status to filter results by. To retrieve all builds, leave this parameter empty.
Possible build statuses include the following:
- INITIALIZED – A new build has been defined, but no files have been uploaded. You cannot create fleets for builds that are in this status. When a build is successfully created, the build status is set to this value.
- READY – The game build has been successfully uploaded. You can now create new fleets for this build.
- FAILED – The game build upload failed. You cannot create new fleets for this build.
lbNextToken :: Lens' ListBuilds (Maybe Text) Source #
Token indicating the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To specify the start of the result set, do not specify a value.
lbLimit :: Lens' ListBuilds (Maybe Natural) Source #
Maximum number of results to return. Use this parameter with NextToken
to get results as a set of sequential pages.
Destructuring the Response
Creates a value of ListBuildsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data ListBuildsResponse Source #
Represents the returned data in response to a request action.
See: listBuildsResponse
smart constructor.
Response Lenses
lbrsBuilds :: Lens' ListBuildsResponse [Build] Source #
Collection of build records that match the request.
lbrsNextToken :: Lens' ListBuildsResponse (Maybe Text) Source #
Token indicating where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.
If a request has a limit that exactly matches the number of remaining results, a token is returned even though there are no more results to retrieve.
lbrsResponseStatus :: Lens' ListBuildsResponse Int Source #
The response status code.