libZSservicesZSamazonka-gameliftZSamazonka-gamelift
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

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

Setting up GameLift fleets

Related actions

ListFleets | DescribeEC2InstanceLimits | DescribeFleetAttributes | DescribeFleetCapacity | DescribeFleetEvents | DescribeFleetLocationAttributes | DescribeFleetPortSettings | DescribeFleetUtilization | DescribeRuntimeConfiguration | DescribeScalingPolicies | All APIs by task

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeFleetAttributes Source #

Represents the input for a request operation.

See: newDescribeFleetAttributes smart constructor.

Constructors

DescribeFleetAttributes' 

Fields

  • nextToken :: Maybe Text

    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.

  • limit :: Maybe Natural

    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.

  • fleetIds :: Maybe (NonEmpty Text)

    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.

Instances

Instances details
Eq DescribeFleetAttributes Source # 
Instance details

Defined in Amazonka.GameLift.DescribeFleetAttributes

Read DescribeFleetAttributes Source # 
Instance details

Defined in Amazonka.GameLift.DescribeFleetAttributes

Show DescribeFleetAttributes Source # 
Instance details

Defined in Amazonka.GameLift.DescribeFleetAttributes

Generic DescribeFleetAttributes Source # 
Instance details

Defined in Amazonka.GameLift.DescribeFleetAttributes

Associated Types

type Rep DescribeFleetAttributes :: Type -> Type #

NFData DescribeFleetAttributes Source # 
Instance details

Defined in Amazonka.GameLift.DescribeFleetAttributes

Methods

rnf :: DescribeFleetAttributes -> () #

Hashable DescribeFleetAttributes Source # 
Instance details

Defined in Amazonka.GameLift.DescribeFleetAttributes

ToJSON DescribeFleetAttributes Source # 
Instance details

Defined in Amazonka.GameLift.DescribeFleetAttributes

AWSPager DescribeFleetAttributes Source # 
Instance details

Defined in Amazonka.GameLift.DescribeFleetAttributes

AWSRequest DescribeFleetAttributes Source # 
Instance details

Defined in Amazonka.GameLift.DescribeFleetAttributes

ToHeaders DescribeFleetAttributes Source # 
Instance details

Defined in Amazonka.GameLift.DescribeFleetAttributes

ToPath DescribeFleetAttributes Source # 
Instance details

Defined in Amazonka.GameLift.DescribeFleetAttributes

ToQuery DescribeFleetAttributes Source # 
Instance details

Defined in Amazonka.GameLift.DescribeFleetAttributes

type Rep DescribeFleetAttributes Source # 
Instance details

Defined in Amazonka.GameLift.DescribeFleetAttributes

type Rep DescribeFleetAttributes = D1 ('MetaData "DescribeFleetAttributes" "Amazonka.GameLift.DescribeFleetAttributes" "libZSservicesZSamazonka-gameliftZSamazonka-gamelift" 'False) (C1 ('MetaCons "DescribeFleetAttributes'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "fleetIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))))))
type AWSResponse DescribeFleetAttributes Source # 
Instance details

Defined in Amazonka.GameLift.DescribeFleetAttributes

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

  • nextToken :: Maybe Text

    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.

  • fleetAttributes :: Maybe [FleetAttributes]

    A collection of objects containing attribute metadata for each requested fleet ID. Attribute objects are returned only for fleets that currently exist.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq DescribeFleetAttributesResponse Source # 
Instance details

Defined in Amazonka.GameLift.DescribeFleetAttributes

Read DescribeFleetAttributesResponse Source # 
Instance details

Defined in Amazonka.GameLift.DescribeFleetAttributes

Show DescribeFleetAttributesResponse Source # 
Instance details

Defined in Amazonka.GameLift.DescribeFleetAttributes

Generic DescribeFleetAttributesResponse Source # 
Instance details

Defined in Amazonka.GameLift.DescribeFleetAttributes

Associated Types

type Rep DescribeFleetAttributesResponse :: Type -> Type #

NFData DescribeFleetAttributesResponse Source # 
Instance details

Defined in Amazonka.GameLift.DescribeFleetAttributes

type Rep DescribeFleetAttributesResponse Source # 
Instance details

Defined in Amazonka.GameLift.DescribeFleetAttributes

type Rep DescribeFleetAttributesResponse = D1 ('MetaData "DescribeFleetAttributesResponse" "Amazonka.GameLift.DescribeFleetAttributes" "libZSservicesZSamazonka-gameliftZSamazonka-gamelift" 'False) (C1 ('MetaCons "DescribeFleetAttributesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "fleetAttributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [FleetAttributes])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

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.