Network.AWS.GameLift.ListBuilds

Retrieves build records for all builds associated with an AWS account. You can filter the result set by build status. Use the pagination parameters to retrieve results in a set of sequential pages.

Build records are not listed in any particular order.

Creating a Request

listBuilds :: ListBuilds

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:

• lbStatus
• lbNextToken
• lbLimit

data ListBuilds

Represents the input for a request action.

See: listBuilds smart constructor.

Instances

Eq ListBuilds

Data ListBuilds

Read ListBuilds

Show ListBuilds

Generic ListBuilds

ToJSON ListBuilds

Hashable ListBuilds

AWSRequest ListBuilds

ToPath ListBuilds

ToHeaders ListBuilds

ToQuery ListBuilds

type Rep ListBuilds

type Rs ListBuilds = ListBuildsResponse

Request Lenses

lbStatus :: Lens' ListBuilds (Maybe BuildStatus)

Build state to filter results on. Use this parameter to retrieve builds in a certain state. To retrieve all builds, leave this parameter empty. Possible build states include:

• INITIALIZED: A new build has been defined, but no files have been uploaded. You cannot create fleets for builds that are in this state. When a build is successfully created, the build state 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)

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)

Maximum number of results to return. You can use this parameter with NextToken to get results as a set of sequential pages.

Destructuring the Response

listBuildsResponse

Arguments

:: Int

lbrsResponseStatus

-> ListBuildsResponse

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:

• lbrsBuilds
• lbrsNextToken
• lbrsResponseStatus

data ListBuildsResponse

Represents the returned data in response to a request action.

See: listBuildsResponse smart constructor.

Instances

Eq ListBuildsResponse

Data ListBuildsResponse

Read ListBuildsResponse

Show ListBuildsResponse

Generic ListBuildsResponse

type Rep ListBuildsResponse

Response Lenses

lbrsBuilds :: Lens' ListBuildsResponse [Build]

Collection of build records that match the request.

lbrsNextToken :: Lens' ListBuildsResponse (Maybe Text)

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

The response status code.