amazonka-gamelift-1.4.5: Amazon GameLift SDK.

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

Network.AWS.GameLift.DescribeFleetAttributes

Contents

Description

Retrieves fleet properties, including metadata, status, and configuration, for one or more fleets. You can request attributes for all fleets, or specify a list of one or more fleet IDs. When requesting multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a FleetAttributes object is returned for each requested fleet ID. When specifying a list of fleet IDs, attribute objects are returned only for fleets that currently exist.

Synopsis

Creating a Request

describeFleetAttributes :: DescribeFleetAttributes #

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

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

  • dfaNextToken - 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.
  • dfaLimit - 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.
  • dfaFleetIds - Unique identifiers for the fleet(s) that you want to retrieve attributes for. To request attributes for all fleets, leave this parameter empty.

data DescribeFleetAttributes #

Represents the input for a request action.

See: describeFleetAttributes smart constructor.

Instances

Eq DescribeFleetAttributes # 
Data DescribeFleetAttributes # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeFleetAttributes -> c DescribeFleetAttributes #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeFleetAttributes #

toConstr :: DescribeFleetAttributes -> Constr #

dataTypeOf :: DescribeFleetAttributes -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeFleetAttributes) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeFleetAttributes) #

gmapT :: (forall b. Data b => b -> b) -> DescribeFleetAttributes -> DescribeFleetAttributes #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeFleetAttributes -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeFleetAttributes -> r #

gmapQ :: (forall d. Data d => d -> u) -> DescribeFleetAttributes -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeFleetAttributes -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeFleetAttributes -> m DescribeFleetAttributes #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeFleetAttributes -> m DescribeFleetAttributes #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeFleetAttributes -> m DescribeFleetAttributes #

Read DescribeFleetAttributes # 
Show DescribeFleetAttributes # 
Generic DescribeFleetAttributes # 
Hashable DescribeFleetAttributes # 
ToJSON DescribeFleetAttributes # 
NFData DescribeFleetAttributes # 

Methods

rnf :: DescribeFleetAttributes -> () #

AWSRequest DescribeFleetAttributes # 
ToQuery DescribeFleetAttributes # 
ToPath DescribeFleetAttributes # 
ToHeaders DescribeFleetAttributes # 
type Rep DescribeFleetAttributes # 
type Rep DescribeFleetAttributes = D1 (MetaData "DescribeFleetAttributes" "Network.AWS.GameLift.DescribeFleetAttributes" "amazonka-gamelift-1.4.5-90oxfPbG0dmH3SoKqzJqw8" False) (C1 (MetaCons "DescribeFleetAttributes'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_dfaNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_dfaLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))) (S1 (MetaSel (Just Symbol "_dfaFleetIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (List1 Text)))))))
type Rs DescribeFleetAttributes # 

Request Lenses

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

dfaLimit :: Lens' DescribeFleetAttributes (Maybe Natural) #

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.

dfaFleetIds :: Lens' DescribeFleetAttributes (Maybe (NonEmpty Text)) #

Unique identifiers for the fleet(s) that you want to retrieve attributes for. To request attributes for all fleets, leave this parameter empty.

Destructuring the Response

describeFleetAttributesResponse #

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

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

  • dfarsNextToken - 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.
  • dfarsFleetAttributes - Collection of objects containing attribute metadata for each requested fleet ID.
  • dfarsResponseStatus - -- | The response status code.

data DescribeFleetAttributesResponse #

Represents the returned data in response to a request action.

See: describeFleetAttributesResponse smart constructor.

Instances

Eq DescribeFleetAttributesResponse # 
Data DescribeFleetAttributesResponse # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeFleetAttributesResponse -> c DescribeFleetAttributesResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeFleetAttributesResponse #

toConstr :: DescribeFleetAttributesResponse -> Constr #

dataTypeOf :: DescribeFleetAttributesResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeFleetAttributesResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeFleetAttributesResponse) #

gmapT :: (forall b. Data b => b -> b) -> DescribeFleetAttributesResponse -> DescribeFleetAttributesResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeFleetAttributesResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeFleetAttributesResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> DescribeFleetAttributesResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeFleetAttributesResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeFleetAttributesResponse -> m DescribeFleetAttributesResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeFleetAttributesResponse -> m DescribeFleetAttributesResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeFleetAttributesResponse -> m DescribeFleetAttributesResponse #

Read DescribeFleetAttributesResponse # 
Show DescribeFleetAttributesResponse # 
Generic DescribeFleetAttributesResponse # 
NFData DescribeFleetAttributesResponse # 
type Rep DescribeFleetAttributesResponse # 
type Rep DescribeFleetAttributesResponse = D1 (MetaData "DescribeFleetAttributesResponse" "Network.AWS.GameLift.DescribeFleetAttributes" "amazonka-gamelift-1.4.5-90oxfPbG0dmH3SoKqzJqw8" False) (C1 (MetaCons "DescribeFleetAttributesResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_dfarsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_dfarsFleetAttributes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [FleetAttributes]))) (S1 (MetaSel (Just Symbol "_dfarsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)))))

Response Lenses

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

dfarsFleetAttributes :: Lens' DescribeFleetAttributesResponse [FleetAttributes] #

Collection of objects containing attribute metadata for each requested fleet ID.