Amazonka.GameLift.DescribeFleetAttributes

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

This operation returns paginated results.

Creating a Request

data DescribeFleetAttributes

See: newDescribeFleetAttributes smart constructor.

Constructors

DescribeFleetAttributes'

Fields

• 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.

• 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.

• 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.

Instances

ToJSON DescribeFleetAttributes

Defined in Amazonka.GameLift.DescribeFleetAttributes

Methods

toJSON :: DescribeFleetAttributes -> Value

toEncoding :: DescribeFleetAttributes -> Encoding

toJSONList :: [DescribeFleetAttributes] -> Value

toEncodingList :: [DescribeFleetAttributes] -> Encoding

ToHeaders DescribeFleetAttributes

Defined in Amazonka.GameLift.DescribeFleetAttributes

Methods

toHeaders :: DescribeFleetAttributes -> [Header]

ToPath DescribeFleetAttributes

Defined in Amazonka.GameLift.DescribeFleetAttributes

Methods

toPath :: DescribeFleetAttributes -> ByteString

ToQuery DescribeFleetAttributes

Defined in Amazonka.GameLift.DescribeFleetAttributes

Methods

toQuery :: DescribeFleetAttributes -> QueryString

AWSPager DescribeFleetAttributes

Defined in Amazonka.GameLift.DescribeFleetAttributes

Methods

page :: DescribeFleetAttributes -> AWSResponse DescribeFleetAttributes -> Maybe DescribeFleetAttributes

AWSRequest DescribeFleetAttributes

Defined in Amazonka.GameLift.DescribeFleetAttributes

Associated Types

type AWSResponse DescribeFleetAttributes

Methods

request :: (Service -> Service) -> DescribeFleetAttributes -> Request DescribeFleetAttributes

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeFleetAttributes -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeFleetAttributes)))

Generic DescribeFleetAttributes

Defined in Amazonka.GameLift.DescribeFleetAttributes

Associated Types

type Rep DescribeFleetAttributes :: Type -> Type

Methods

from :: DescribeFleetAttributes -> Rep DescribeFleetAttributes x

to :: Rep DescribeFleetAttributes x -> DescribeFleetAttributes

Read DescribeFleetAttributes

Defined in Amazonka.GameLift.DescribeFleetAttributes

Methods

readsPrec :: Int -> ReadS DescribeFleetAttributes

readList :: ReadS [DescribeFleetAttributes]

readPrec :: ReadPrec DescribeFleetAttributes

readListPrec :: ReadPrec [DescribeFleetAttributes]

Show DescribeFleetAttributes

Defined in Amazonka.GameLift.DescribeFleetAttributes

Methods

showsPrec :: Int -> DescribeFleetAttributes -> ShowS

show :: DescribeFleetAttributes -> String

showList :: [DescribeFleetAttributes] -> ShowS

NFData DescribeFleetAttributes

Defined in Amazonka.GameLift.DescribeFleetAttributes

Methods

rnf :: DescribeFleetAttributes -> ()

Eq DescribeFleetAttributes

Defined in Amazonka.GameLift.DescribeFleetAttributes

Methods

(==) :: DescribeFleetAttributes -> DescribeFleetAttributes -> Bool

(/=) :: DescribeFleetAttributes -> DescribeFleetAttributes -> Bool

Hashable DescribeFleetAttributes

Defined in Amazonka.GameLift.DescribeFleetAttributes

Methods

hashWithSalt :: Int -> DescribeFleetAttributes -> Int

hash :: DescribeFleetAttributes -> Int

type AWSResponse DescribeFleetAttributes

Defined in Amazonka.GameLift.DescribeFleetAttributes

type AWSResponse DescribeFleetAttributes = DescribeFleetAttributesResponse

type Rep DescribeFleetAttributes

Defined in Amazonka.GameLift.DescribeFleetAttributes

type Rep DescribeFleetAttributes = D1 ('MetaData "DescribeFleetAttributes" "Amazonka.GameLift.DescribeFleetAttributes" "amazonka-gamelift-2.0-IjhNQby9jLV6gj30IrgsyK" 'False) (C1 ('MetaCons "DescribeFleetAttributes'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fleetIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :*: (S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newDescribeFleetAttributes :: DescribeFleetAttributes

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: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.

$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.

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.

Request Lenses

describeFleetAttributes_fleetIds :: Lens' DescribeFleetAttributes (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.

describeFleetAttributes_limit :: Lens' DescribeFleetAttributes (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.

describeFleetAttributes_nextToken :: Lens' DescribeFleetAttributes (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.

Destructuring the Response

data DescribeFleetAttributesResponse

See: newDescribeFleetAttributesResponse smart constructor.

Constructors

DescribeFleetAttributesResponse'

Fields

• 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.

• 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.

• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribeFleetAttributesResponse

Defined in Amazonka.GameLift.DescribeFleetAttributes

Associated Types

type Rep DescribeFleetAttributesResponse :: Type -> Type

Methods

from :: DescribeFleetAttributesResponse -> Rep DescribeFleetAttributesResponse x

to :: Rep DescribeFleetAttributesResponse x -> DescribeFleetAttributesResponse

Read DescribeFleetAttributesResponse

Defined in Amazonka.GameLift.DescribeFleetAttributes

Methods

readsPrec :: Int -> ReadS DescribeFleetAttributesResponse

readList :: ReadS [DescribeFleetAttributesResponse]

readPrec :: ReadPrec DescribeFleetAttributesResponse

readListPrec :: ReadPrec [DescribeFleetAttributesResponse]

Show DescribeFleetAttributesResponse

Defined in Amazonka.GameLift.DescribeFleetAttributes

Methods

showsPrec :: Int -> DescribeFleetAttributesResponse -> ShowS

show :: DescribeFleetAttributesResponse -> String

showList :: [DescribeFleetAttributesResponse] -> ShowS

NFData DescribeFleetAttributesResponse

Defined in Amazonka.GameLift.DescribeFleetAttributes

Methods

rnf :: DescribeFleetAttributesResponse -> ()

Eq DescribeFleetAttributesResponse

Defined in Amazonka.GameLift.DescribeFleetAttributes

Methods

(==) :: DescribeFleetAttributesResponse -> DescribeFleetAttributesResponse -> Bool

(/=) :: DescribeFleetAttributesResponse -> DescribeFleetAttributesResponse -> Bool

type Rep DescribeFleetAttributesResponse

Defined in Amazonka.GameLift.DescribeFleetAttributes

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

newDescribeFleetAttributesResponse

Arguments

:: Int

$sel:httpStatus:DescribeFleetAttributesResponse'

-> DescribeFleetAttributesResponse

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: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.

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:httpStatus:DescribeFleetAttributesResponse', describeFleetAttributesResponse_httpStatus - The response's http status code.

Response Lenses

describeFleetAttributesResponse_fleetAttributes :: Lens' DescribeFleetAttributesResponse (Maybe [FleetAttributes])

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

describeFleetAttributesResponse_nextToken :: Lens' DescribeFleetAttributesResponse (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.

describeFleetAttributesResponse_httpStatus :: Lens' DescribeFleetAttributesResponse Int

The response's http status code.