Network.AWS.GameLift.DescribeFleetUtilization

Retrieves utilization statistics for one or more fleets. You can request utilization data for all fleets, or specify a list of one or more fleet IDs. When requesting all fleets, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a FleetUtilization object is returned for each requested fleet ID. When specifying a list of fleet IDs, utilization objects are returned only for fleets that currently exist.

Some API actions may limit the number of fleet IDs allowed in one request. If a request exceeds this limit, the request fails and the error message includes the maximum allowed.

Creating a Request

describeFleetUtilization :: DescribeFleetUtilization

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

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

• dfuNextToken
• dfuLimit
• dfuFleetIds

data DescribeFleetUtilization

Represents the input for a request action.

See: describeFleetUtilization smart constructor.

Instances

Eq DescribeFleetUtilization

Data DescribeFleetUtilization

Read DescribeFleetUtilization

Show DescribeFleetUtilization

Generic DescribeFleetUtilization

ToJSON DescribeFleetUtilization

Hashable DescribeFleetUtilization

AWSRequest DescribeFleetUtilization

ToPath DescribeFleetUtilization

ToHeaders DescribeFleetUtilization

ToQuery DescribeFleetUtilization

type Rep DescribeFleetUtilization

type Rs DescribeFleetUtilization = DescribeFleetUtilizationResponse

Request Lenses

dfuNextToken :: Lens' DescribeFleetUtilization (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. This parameter is ignored when the request specifies one or a list of fleet IDs.

dfuLimit :: Lens' DescribeFleetUtilization (Maybe Natural)

Maximum number of results to return. You can use this parameter with NextToken to get results as a set of sequential pages. This parameter is ignored when the request specifies one or a list of fleet IDs.

dfuFleetIds :: Lens' DescribeFleetUtilization (Maybe (NonEmpty Text))

Unique identifier for the fleet(s) you want to retrieve utilization data for. Leave this parameter empty to retrieve utilization data for all fleets.

Destructuring the Response

describeFleetUtilizationResponse

Arguments

:: Int

dfursResponseStatus

-> DescribeFleetUtilizationResponse

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

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

• dfursNextToken
• dfursFleetUtilization
• dfursResponseStatus

data DescribeFleetUtilizationResponse

Represents the returned data in response to a request action.

See: describeFleetUtilizationResponse smart constructor.

Instances

Eq DescribeFleetUtilizationResponse

Data DescribeFleetUtilizationResponse

Read DescribeFleetUtilizationResponse

Show DescribeFleetUtilizationResponse

Generic DescribeFleetUtilizationResponse

type Rep DescribeFleetUtilizationResponse

Response Lenses

dfursNextToken :: Lens' DescribeFleetUtilizationResponse (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.

dfursFleetUtilization :: Lens' DescribeFleetUtilizationResponse [FleetUtilization]

Collection of objects containing utilization information for each requested fleet ID.

dfursResponseStatus :: Lens' DescribeFleetUtilizationResponse Int

The response status code.