Network.AWS.GameLift.ListFleets

Retrieves a collection of fleet records for this AWS account. You can filter the result set by build ID. Use the pagination parameters to retrieve results in sequential pages.

Fleet records are not listed in any particular order.

Creating a Request

listFleets :: ListFleets

Creates a value of ListFleets with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• lfBuildId
• lfNextToken
• lfLimit

data ListFleets

Represents the input for a request action.

See: listFleets smart constructor.

Instances

Eq ListFleets

Data ListFleets

Read ListFleets

Show ListFleets

Generic ListFleets

ToJSON ListFleets

Hashable ListFleets

AWSRequest ListFleets

ToPath ListFleets

ToHeaders ListFleets

ToQuery ListFleets

type Rep ListFleets

type Rs ListFleets = ListFleetsResponse

Request Lenses

lfBuildId :: Lens' ListFleets (Maybe Text)

Unique identifier of the build to return fleets for. Use this parameter to return only fleets using the specified build. To retrieve all fleets, leave this parameter empty.

lfNextToken :: Lens' ListFleets (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.

lfLimit :: Lens' ListFleets (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

listFleetsResponse

Arguments

:: Int

lfrsResponseStatus

-> ListFleetsResponse

Creates a value of ListFleetsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• lfrsNextToken
• lfrsFleetIds
• lfrsResponseStatus

data ListFleetsResponse

Represents the returned data in response to a request action.

See: listFleetsResponse smart constructor.

Instances

Eq ListFleetsResponse

Data ListFleetsResponse

Read ListFleetsResponse

Show ListFleetsResponse

Generic ListFleetsResponse

type Rep ListFleetsResponse

Response Lenses

lfrsNextToken :: Lens' ListFleetsResponse (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.

lfrsFleetIds :: Lens' ListFleetsResponse (Maybe (NonEmpty Text))

Set of fleet IDs matching the list request. You can retrieve additional information about all returned fleets by passing this result set to a call to DescribeFleetAttributes, DescribeFleetCapacity, and DescribeFleetUtilization.

lfrsResponseStatus :: Lens' ListFleetsResponse Int

The response status code.