Network.AWS.GameLift.UpdateFleetCapacity

Updates capacity settings for a fleet. Use this action to specify the number of EC2 instances (hosts) that you want this fleet to contain. Before calling this action, you may want to call DescribeEC2InstanceLimits to get the maximum capacity based on the fleet's EC2 instance type.

Specify minimum and maximum number of instances. Amazon GameLift will not change fleet capacity to values fall outside of this range. This is particularly important when using auto-scaling (see PutScalingPolicy ) to allow capacity to adjust based on player demand while imposing limits on automatic adjustments.

To update fleet capacity, specify the fleet ID and the number of instances you want the fleet to host. If successful, Amazon GameLift starts or terminates instances so that the fleet's active instance count matches the desired instance count. You can view a fleet's current capacity information by calling DescribeFleetCapacity . If the desired instance count is higher than the instance type's limit, the "Limit Exceeded" exception occurs.

Fleet-related operations include:

• CreateFleet
• ListFleets
• DeleteFleet
• Describe fleets:
• DescribeFleetAttributes
• DescribeFleetCapacity
• DescribeFleetPortSettings
• DescribeFleetUtilization
• DescribeRuntimeConfiguration
• DescribeEC2InstanceLimits
• DescribeFleetEvents
• Update fleets:
• UpdateFleetAttributes
• UpdateFleetCapacity
• UpdateFleetPortSettings
• UpdateRuntimeConfiguration
• Manage fleet actions:
• StartFleetActions
• StopFleetActions

Creating a Request

updateFleetCapacity

Arguments

:: Text

ufcFleetId

-> UpdateFleetCapacity

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

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

• ufcMaxSize - Maximum value allowed for the fleet's instance count. Default if not set is 1.
• ufcMinSize - Minimum value allowed for the fleet's instance count. Default if not set is 0.
• ufcDesiredInstances - Number of EC2 instances you want this fleet to host.
• ufcFleetId - Unique identifier for a fleet to update capacity for.

data UpdateFleetCapacity

Represents the input for a request action.

See: updateFleetCapacity smart constructor.

Instances

Eq UpdateFleetCapacity

Methods

(==) :: UpdateFleetCapacity -> UpdateFleetCapacity -> Bool

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

Data UpdateFleetCapacity

Methods

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

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

toConstr :: UpdateFleetCapacity -> Constr

dataTypeOf :: UpdateFleetCapacity -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> UpdateFleetCapacity -> UpdateFleetCapacity

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

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

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

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

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

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

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

Read UpdateFleetCapacity

Methods

readsPrec :: Int -> ReadS UpdateFleetCapacity

readList :: ReadS [UpdateFleetCapacity]

readPrec :: ReadPrec UpdateFleetCapacity

readListPrec :: ReadPrec [UpdateFleetCapacity]

Show UpdateFleetCapacity

Methods

showsPrec :: Int -> UpdateFleetCapacity -> ShowS

show :: UpdateFleetCapacity -> String

showList :: [UpdateFleetCapacity] -> ShowS

Generic UpdateFleetCapacity

Associated Types

type Rep UpdateFleetCapacity :: * -> *

Methods

from :: UpdateFleetCapacity -> Rep UpdateFleetCapacity x

to :: Rep UpdateFleetCapacity x -> UpdateFleetCapacity

Hashable UpdateFleetCapacity

Methods

hashWithSalt :: Int -> UpdateFleetCapacity -> Int

hash :: UpdateFleetCapacity -> Int

ToJSON UpdateFleetCapacity

Methods

toJSON :: UpdateFleetCapacity -> Value

toEncoding :: UpdateFleetCapacity -> Encoding

toJSONList :: [UpdateFleetCapacity] -> Value

toEncodingList :: [UpdateFleetCapacity] -> Encoding

NFData UpdateFleetCapacity

Methods

rnf :: UpdateFleetCapacity -> ()

AWSRequest UpdateFleetCapacity

Associated Types

type Rs UpdateFleetCapacity :: *

Methods

request :: UpdateFleetCapacity -> Request UpdateFleetCapacity

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * UpdateFleetCapacity -> ClientResponse -> m (Response UpdateFleetCapacity)

ToHeaders UpdateFleetCapacity

Methods

toHeaders :: UpdateFleetCapacity -> [Header]

ToPath UpdateFleetCapacity

Methods

toPath :: UpdateFleetCapacity -> ByteString

ToQuery UpdateFleetCapacity

Methods

toQuery :: UpdateFleetCapacity -> QueryString

type Rep UpdateFleetCapacity

type Rep UpdateFleetCapacity = D1 * (MetaData "UpdateFleetCapacity" "Network.AWS.GameLift.UpdateFleetCapacity" "amazonka-gamelift-1.6.0-DeAosbEJJf8D8cv8ebS5Uv" False) (C1 * (MetaCons "UpdateFleetCapacity'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_ufcMaxSize") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Nat))) (S1 * (MetaSel (Just Symbol "_ufcMinSize") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Nat)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_ufcDesiredInstances") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Nat))) (S1 * (MetaSel (Just Symbol "_ufcFleetId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)))))

type Rs UpdateFleetCapacity

type Rs UpdateFleetCapacity = UpdateFleetCapacityResponse

Request Lenses

ufcMaxSize :: Lens' UpdateFleetCapacity (Maybe Natural)

Maximum value allowed for the fleet's instance count. Default if not set is 1.

ufcMinSize :: Lens' UpdateFleetCapacity (Maybe Natural)

Minimum value allowed for the fleet's instance count. Default if not set is 0.

ufcDesiredInstances :: Lens' UpdateFleetCapacity (Maybe Natural)

Number of EC2 instances you want this fleet to host.

ufcFleetId :: Lens' UpdateFleetCapacity Text

Unique identifier for a fleet to update capacity for.

Destructuring the Response

updateFleetCapacityResponse

Arguments

:: Int

ufcrsResponseStatus

-> UpdateFleetCapacityResponse

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

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

• ufcrsFleetId - Unique identifier for a fleet that was updated.
• ufcrsResponseStatus - -- | The response status code.

data UpdateFleetCapacityResponse

Represents the returned data in response to a request action.

See: updateFleetCapacityResponse smart constructor.

Instances

Eq UpdateFleetCapacityResponse

Methods

(==) :: UpdateFleetCapacityResponse -> UpdateFleetCapacityResponse -> Bool

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

Data UpdateFleetCapacityResponse

Methods

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

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

toConstr :: UpdateFleetCapacityResponse -> Constr

dataTypeOf :: UpdateFleetCapacityResponse -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> UpdateFleetCapacityResponse -> UpdateFleetCapacityResponse

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

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

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

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

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

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

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

Read UpdateFleetCapacityResponse

Methods

readsPrec :: Int -> ReadS UpdateFleetCapacityResponse

readList :: ReadS [UpdateFleetCapacityResponse]

readPrec :: ReadPrec UpdateFleetCapacityResponse

readListPrec :: ReadPrec [UpdateFleetCapacityResponse]

Show UpdateFleetCapacityResponse

Methods

showsPrec :: Int -> UpdateFleetCapacityResponse -> ShowS

show :: UpdateFleetCapacityResponse -> String

showList :: [UpdateFleetCapacityResponse] -> ShowS

Generic UpdateFleetCapacityResponse

Associated Types

type Rep UpdateFleetCapacityResponse :: * -> *

Methods

from :: UpdateFleetCapacityResponse -> Rep UpdateFleetCapacityResponse x

to :: Rep UpdateFleetCapacityResponse x -> UpdateFleetCapacityResponse

NFData UpdateFleetCapacityResponse

Methods

rnf :: UpdateFleetCapacityResponse -> ()

type Rep UpdateFleetCapacityResponse

type Rep UpdateFleetCapacityResponse = D1 * (MetaData "UpdateFleetCapacityResponse" "Network.AWS.GameLift.UpdateFleetCapacity" "amazonka-gamelift-1.6.0-DeAosbEJJf8D8cv8ebS5Uv" False) (C1 * (MetaCons "UpdateFleetCapacityResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_ufcrsFleetId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_ufcrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))

Response Lenses

ufcrsFleetId :: Lens' UpdateFleetCapacityResponse (Maybe Text)

Unique identifier for a fleet that was updated.

ufcrsResponseStatus :: Lens' UpdateFleetCapacityResponse Int

• - | The response status code.