| 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 |
Amazonka.GameLift.DescribeFleetAttributes
Description
Retrieves core fleet-wide properties, including the computing hardware and deployment configuration for all instances in the fleet.
This operation can be used in the following ways:
- To get attributes for one or more specific fleets, provide a list of fleet IDs or fleet ARNs.
- To get attributes for all fleets, do not provide a fleet identifier.
When requesting attributes for multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages.
If successful, a FleetAttributes object is returned for each fleet
requested, unless the fleet identifier is not found.
Some API operations limit the number of fleet IDs that allowed in one request. If a request exceeds this limit, the request fails and the error message contains the maximum allowed number.
Learn more
Related actions
ListFleets | DescribeEC2InstanceLimits | DescribeFleetAttributes | DescribeFleetCapacity | DescribeFleetEvents | DescribeFleetLocationAttributes | DescribeFleetPortSettings | DescribeFleetUtilization | DescribeRuntimeConfiguration | DescribeScalingPolicies | All APIs by task
This operation returns paginated results.
Synopsis
- data DescribeFleetAttributes = DescribeFleetAttributes' {}
- newDescribeFleetAttributes :: DescribeFleetAttributes
- describeFleetAttributes_nextToken :: Lens' DescribeFleetAttributes (Maybe Text)
- describeFleetAttributes_limit :: Lens' DescribeFleetAttributes (Maybe Natural)
- describeFleetAttributes_fleetIds :: Lens' DescribeFleetAttributes (Maybe (NonEmpty Text))
- data DescribeFleetAttributesResponse = DescribeFleetAttributesResponse' {}
- newDescribeFleetAttributesResponse :: Int -> DescribeFleetAttributesResponse
- describeFleetAttributesResponse_nextToken :: Lens' DescribeFleetAttributesResponse (Maybe Text)
- describeFleetAttributesResponse_fleetAttributes :: Lens' DescribeFleetAttributesResponse (Maybe [FleetAttributes])
- describeFleetAttributesResponse_httpStatus :: Lens' DescribeFleetAttributesResponse Int
Creating a Request
data DescribeFleetAttributes Source #
Represents the input for a request operation.
See: newDescribeFleetAttributes smart constructor.
Constructors
| DescribeFleetAttributes' | |
Fields
| |
Instances
newDescribeFleetAttributes :: DescribeFleetAttributes Source #
Create a value of DescribeFleetAttributes 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:DescribeFleetAttributes', describeFleetAttributes_nextToken - A token that indicates the start of the next sequential page of results.
Use the token that is returned with a previous call to this operation.
To start at the beginning of the result set, do not specify a value.
This parameter is ignored when the request specifies one or a list of
fleet IDs.
$sel:limit:DescribeFleetAttributes', describeFleetAttributes_limit - The maximum number of results to return. 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.
$sel:fleetIds:DescribeFleetAttributes', describeFleetAttributes_fleetIds - A list of unique fleet identifiers to retrieve attributes for. You can
use either the fleet ID or ARN value. To retrieve attributes for all
current fleets, do not include this parameter.
Request Lenses
describeFleetAttributes_nextToken :: Lens' DescribeFleetAttributes (Maybe Text) Source #
A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value. This parameter is ignored when the request specifies one or a list of fleet IDs.
describeFleetAttributes_limit :: Lens' DescribeFleetAttributes (Maybe Natural) Source #
The maximum number of results to return. 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.
describeFleetAttributes_fleetIds :: Lens' DescribeFleetAttributes (Maybe (NonEmpty Text)) Source #
A list of unique fleet identifiers to retrieve attributes for. You can use either the fleet ID or ARN value. To retrieve attributes for all current fleets, do not include this parameter.
Destructuring the Response
data DescribeFleetAttributesResponse Source #
Represents the returned data in response to a request operation.
See: newDescribeFleetAttributesResponse smart constructor.
Constructors
| DescribeFleetAttributesResponse' | |
Fields
| |
Instances
newDescribeFleetAttributesResponse Source #
Create a value of DescribeFleetAttributesResponse 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:DescribeFleetAttributes', describeFleetAttributesResponse_nextToken - A token that indicates where to resume retrieving results on the next
call to this operation. If no token is returned, these results represent
the end of the list.
$sel:fleetAttributes:DescribeFleetAttributesResponse', describeFleetAttributesResponse_fleetAttributes - A collection of objects containing attribute metadata for each requested
fleet ID. Attribute objects are returned only for fleets that currently
exist.
$sel:httpStatus:DescribeFleetAttributesResponse', describeFleetAttributesResponse_httpStatus - The response's http status code.
Response Lenses
describeFleetAttributesResponse_nextToken :: Lens' DescribeFleetAttributesResponse (Maybe Text) Source #
A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.
describeFleetAttributesResponse_fleetAttributes :: Lens' DescribeFleetAttributesResponse (Maybe [FleetAttributes]) Source #
A collection of objects containing attribute metadata for each requested fleet ID. Attribute objects are returned only for fleets that currently exist.
describeFleetAttributesResponse_httpStatus :: Lens' DescribeFleetAttributesResponse Int Source #
The response's http status code.