Network.AWS.GameLift.DescribeFleetAttributes

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.

Fleet-related operations include:

• CreateFleet
• ListFleets
• Describe fleets:
• DescribeFleetAttributes
• DescribeFleetPortSettings
• DescribeFleetUtilization
• DescribeRuntimeConfiguration
• DescribeFleetEvents
• Update fleets:
• UpdateFleetAttributes
• UpdateFleetCapacity
• UpdateFleetPortSettings
• UpdateRuntimeConfiguration
• Manage fleet capacity:
• DescribeFleetCapacity
• UpdateFleetCapacity
• PutScalingPolicy (automatic scaling)
• DescribeScalingPolicies (automatic scaling)
• DeleteScalingPolicy (automatic scaling)
• DescribeEC2InstanceLimits
• DeleteFleet

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 that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. 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.
• 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 identifier for a fleet(s) 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

Methods

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

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

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

Methods

readsPrec :: Int -> ReadS DescribeFleetAttributes

readList :: ReadS [DescribeFleetAttributes]

readPrec :: ReadPrec DescribeFleetAttributes

readListPrec :: ReadPrec [DescribeFleetAttributes]

Show DescribeFleetAttributes

Methods

showsPrec :: Int -> DescribeFleetAttributes -> ShowS

show :: DescribeFleetAttributes -> String

showList :: [DescribeFleetAttributes] -> ShowS

Generic DescribeFleetAttributes

Associated Types

type Rep DescribeFleetAttributes :: * -> *

Methods

from :: DescribeFleetAttributes -> Rep DescribeFleetAttributes x

to :: Rep DescribeFleetAttributes x -> DescribeFleetAttributes

Hashable DescribeFleetAttributes

Methods

hashWithSalt :: Int -> DescribeFleetAttributes -> Int

hash :: DescribeFleetAttributes -> Int

ToJSON DescribeFleetAttributes

Methods

toJSON :: DescribeFleetAttributes -> Value

toEncoding :: DescribeFleetAttributes -> Encoding

toJSONList :: [DescribeFleetAttributes] -> Value

toEncodingList :: [DescribeFleetAttributes] -> Encoding

NFData DescribeFleetAttributes

Methods

rnf :: DescribeFleetAttributes -> ()

AWSRequest DescribeFleetAttributes

Associated Types

type Rs DescribeFleetAttributes :: *

Methods

request :: DescribeFleetAttributes -> Request DescribeFleetAttributes

response :: MonadResource m => Logger -> Service -> Proxy * DescribeFleetAttributes -> ClientResponse -> m (Response DescribeFleetAttributes)

ToQuery DescribeFleetAttributes

Methods

toQuery :: DescribeFleetAttributes -> QueryString

ToPath DescribeFleetAttributes

Methods

toPath :: DescribeFleetAttributes -> ByteString

ToHeaders DescribeFleetAttributes

Methods

toHeaders :: DescribeFleetAttributes -> [Header]

type Rep DescribeFleetAttributes

type Rep DescribeFleetAttributes = D1 (MetaData "DescribeFleetAttributes" "Network.AWS.GameLift.DescribeFleetAttributes" "amazonka-gamelift-1.5.0-LWFsf2alHztGD91U7ab8u0" 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

type Rs DescribeFleetAttributes = DescribeFleetAttributesResponse

Request Lenses

dfaNextToken :: Lens' DescribeFleetAttributes (Maybe Text)

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. 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.

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 identifier for a fleet(s) to retrieve attributes for. To request attributes for all fleets, leave this parameter empty.

Destructuring the Response

describeFleetAttributesResponse

Arguments

:: Int

dfarsResponseStatus

-> 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 that indicates 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

Methods

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

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

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

Methods

readsPrec :: Int -> ReadS DescribeFleetAttributesResponse

readList :: ReadS [DescribeFleetAttributesResponse]

readPrec :: ReadPrec DescribeFleetAttributesResponse

readListPrec :: ReadPrec [DescribeFleetAttributesResponse]

Show DescribeFleetAttributesResponse

Methods

showsPrec :: Int -> DescribeFleetAttributesResponse -> ShowS

show :: DescribeFleetAttributesResponse -> String

showList :: [DescribeFleetAttributesResponse] -> ShowS

Generic DescribeFleetAttributesResponse

Associated Types

type Rep DescribeFleetAttributesResponse :: * -> *

Methods

from :: DescribeFleetAttributesResponse -> Rep DescribeFleetAttributesResponse x

to :: Rep DescribeFleetAttributesResponse x -> DescribeFleetAttributesResponse

NFData DescribeFleetAttributesResponse

Methods

rnf :: DescribeFleetAttributesResponse -> ()

type Rep DescribeFleetAttributesResponse

type Rep DescribeFleetAttributesResponse = D1 (MetaData "DescribeFleetAttributesResponse" "Network.AWS.GameLift.DescribeFleetAttributes" "amazonka-gamelift-1.5.0-LWFsf2alHztGD91U7ab8u0" 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 DecidedStrict) (Rec0 Int)))))

Response Lenses

dfarsNextToken :: Lens' DescribeFleetAttributesResponse (Maybe Text)

Token that indicates 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.

dfarsResponseStatus :: Lens' DescribeFleetAttributesResponse Int

• - | The response status code.