Network.AWS.GameLift.DescribeScalingPolicies

Retrieves all scaling policies applied to a fleet.

To get a fleet's scaling policies, specify the fleet ID. You can filter this request by policy status, such as to retrieve only active scaling policies. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, set of ScalingPolicy objects is returned for the fleet.

A fleet may have all of its scaling policies suspended (StopFleetActions ). This action does not affect the status of the scaling policies, which remains ACTIVE. To see whether a fleet's scaling policies are in force or suspended, call DescribeFleetAttributes and check the stopped actions.

Operations related to fleet capacity scaling include:

• DescribeFleetCapacity
• UpdateFleetCapacity
• DescribeEC2InstanceLimits
• Manage scaling policies:
• PutScalingPolicy (auto-scaling)
• DescribeScalingPolicies (auto-scaling)
• DeleteScalingPolicy (auto-scaling)
• Manage fleet actions:
• StartFleetActions
• StopFleetActions

Creating a Request

describeScalingPolicies

Arguments

:: Text

dFleetId

-> DescribeScalingPolicies

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

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

• dNextToken - 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.
• dStatusFilter - Scaling policy status to filter results on. A scaling policy is only in force when in an ACTIVE status. * ACTIVE -- The scaling policy is currently in force. * UPDATEREQUESTED -- A request to update the scaling policy has been received. * UPDATING -- A change is being made to the scaling policy. * DELETEREQUESTED -- A request to delete the scaling policy has been received. * DELETING -- The scaling policy is being deleted. * DELETED -- The scaling policy has been deleted. * ERROR -- An error occurred in creating the policy. It should be removed and recreated.
• dLimit - Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
• dFleetId - Unique identifier for a fleet to retrieve scaling policies for.

data DescribeScalingPolicies

Represents the input for a request action.

See: describeScalingPolicies smart constructor.

Instances

Eq DescribeScalingPolicies

Defined in Network.AWS.GameLift.DescribeScalingPolicies

Methods

(==) :: DescribeScalingPolicies -> DescribeScalingPolicies -> Bool

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

Data DescribeScalingPolicies

Defined in Network.AWS.GameLift.DescribeScalingPolicies

Methods

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

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

toConstr :: DescribeScalingPolicies -> Constr

dataTypeOf :: DescribeScalingPolicies -> DataType

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

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

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

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

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

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

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

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

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

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

Read DescribeScalingPolicies

Defined in Network.AWS.GameLift.DescribeScalingPolicies

Methods

readsPrec :: Int -> ReadS DescribeScalingPolicies

readList :: ReadS [DescribeScalingPolicies]

readPrec :: ReadPrec DescribeScalingPolicies

readListPrec :: ReadPrec [DescribeScalingPolicies]

Show DescribeScalingPolicies

Defined in Network.AWS.GameLift.DescribeScalingPolicies

Methods

showsPrec :: Int -> DescribeScalingPolicies -> ShowS

show :: DescribeScalingPolicies -> String

showList :: [DescribeScalingPolicies] -> ShowS

Generic DescribeScalingPolicies

Defined in Network.AWS.GameLift.DescribeScalingPolicies

Associated Types

type Rep DescribeScalingPolicies :: Type -> Type

Methods

from :: DescribeScalingPolicies -> Rep DescribeScalingPolicies x

to :: Rep DescribeScalingPolicies x -> DescribeScalingPolicies

Hashable DescribeScalingPolicies

Defined in Network.AWS.GameLift.DescribeScalingPolicies

Methods

hashWithSalt :: Int -> DescribeScalingPolicies -> Int

hash :: DescribeScalingPolicies -> Int

ToJSON DescribeScalingPolicies

Defined in Network.AWS.GameLift.DescribeScalingPolicies

Methods

toJSON :: DescribeScalingPolicies -> Value

toEncoding :: DescribeScalingPolicies -> Encoding

toJSONList :: [DescribeScalingPolicies] -> Value

toEncodingList :: [DescribeScalingPolicies] -> Encoding

AWSRequest DescribeScalingPolicies

Defined in Network.AWS.GameLift.DescribeScalingPolicies

Associated Types

type Rs DescribeScalingPolicies :: Type

Methods

request :: DescribeScalingPolicies -> Request DescribeScalingPolicies

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

ToHeaders DescribeScalingPolicies

Defined in Network.AWS.GameLift.DescribeScalingPolicies

Methods

toHeaders :: DescribeScalingPolicies -> [Header]

ToPath DescribeScalingPolicies

Defined in Network.AWS.GameLift.DescribeScalingPolicies

Methods

toPath :: DescribeScalingPolicies -> ByteString

ToQuery DescribeScalingPolicies

Defined in Network.AWS.GameLift.DescribeScalingPolicies

Methods

toQuery :: DescribeScalingPolicies -> QueryString

NFData DescribeScalingPolicies

Defined in Network.AWS.GameLift.DescribeScalingPolicies

Methods

rnf :: DescribeScalingPolicies -> ()

type Rep DescribeScalingPolicies

Defined in Network.AWS.GameLift.DescribeScalingPolicies

type Rep DescribeScalingPolicies = D1 (MetaData "DescribeScalingPolicies" "Network.AWS.GameLift.DescribeScalingPolicies" "amazonka-gamelift-1.6.1-GajLKSxsevT2faX837q2Xl" False) (C1 (MetaCons "DescribeScalingPolicies'" PrefixI True) ((S1 (MetaSel (Just "_dNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_dStatusFilter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ScalingStatusType))) :*: (S1 (MetaSel (Just "_dLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat)) :*: S1 (MetaSel (Just "_dFleetId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))

type Rs DescribeScalingPolicies

Defined in Network.AWS.GameLift.DescribeScalingPolicies

type Rs DescribeScalingPolicies = DescribeScalingPoliciesResponse

Request Lenses

dNextToken :: Lens' DescribeScalingPolicies (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.

dStatusFilter :: Lens' DescribeScalingPolicies (Maybe ScalingStatusType)

Scaling policy status to filter results on. A scaling policy is only in force when in an ACTIVE status. * ACTIVE -- The scaling policy is currently in force. * UPDATEREQUESTED -- A request to update the scaling policy has been received. * UPDATING -- A change is being made to the scaling policy. * DELETEREQUESTED -- A request to delete the scaling policy has been received. * DELETING -- The scaling policy is being deleted. * DELETED -- The scaling policy has been deleted. * ERROR -- An error occurred in creating the policy. It should be removed and recreated.

dLimit :: Lens' DescribeScalingPolicies (Maybe Natural)

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

dFleetId :: Lens' DescribeScalingPolicies Text

Unique identifier for a fleet to retrieve scaling policies for.

Destructuring the Response

describeScalingPoliciesResponse

Arguments

:: Int

dsprsResponseStatus

-> DescribeScalingPoliciesResponse

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

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

• dsprsNextToken - 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.
• dsprsScalingPolicies - Collection of objects containing the scaling policies matching the request.
• dsprsResponseStatus - -- | The response status code.

data DescribeScalingPoliciesResponse

Represents the returned data in response to a request action.

See: describeScalingPoliciesResponse smart constructor.

Instances

Eq DescribeScalingPoliciesResponse

Defined in Network.AWS.GameLift.DescribeScalingPolicies

Methods

(==) :: DescribeScalingPoliciesResponse -> DescribeScalingPoliciesResponse -> Bool

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

Data DescribeScalingPoliciesResponse

Defined in Network.AWS.GameLift.DescribeScalingPolicies

Methods

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

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

toConstr :: DescribeScalingPoliciesResponse -> Constr

dataTypeOf :: DescribeScalingPoliciesResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read DescribeScalingPoliciesResponse

Defined in Network.AWS.GameLift.DescribeScalingPolicies

Methods

readsPrec :: Int -> ReadS DescribeScalingPoliciesResponse

readList :: ReadS [DescribeScalingPoliciesResponse]

readPrec :: ReadPrec DescribeScalingPoliciesResponse

readListPrec :: ReadPrec [DescribeScalingPoliciesResponse]

Show DescribeScalingPoliciesResponse

Defined in Network.AWS.GameLift.DescribeScalingPolicies

Methods

showsPrec :: Int -> DescribeScalingPoliciesResponse -> ShowS

show :: DescribeScalingPoliciesResponse -> String

showList :: [DescribeScalingPoliciesResponse] -> ShowS

Generic DescribeScalingPoliciesResponse

Defined in Network.AWS.GameLift.DescribeScalingPolicies

Associated Types

type Rep DescribeScalingPoliciesResponse :: Type -> Type

Methods

from :: DescribeScalingPoliciesResponse -> Rep DescribeScalingPoliciesResponse x

to :: Rep DescribeScalingPoliciesResponse x -> DescribeScalingPoliciesResponse

NFData DescribeScalingPoliciesResponse

Defined in Network.AWS.GameLift.DescribeScalingPolicies

Methods

rnf :: DescribeScalingPoliciesResponse -> ()

type Rep DescribeScalingPoliciesResponse

Defined in Network.AWS.GameLift.DescribeScalingPolicies

type Rep DescribeScalingPoliciesResponse = D1 (MetaData "DescribeScalingPoliciesResponse" "Network.AWS.GameLift.DescribeScalingPolicies" "amazonka-gamelift-1.6.1-GajLKSxsevT2faX837q2Xl" False) (C1 (MetaCons "DescribeScalingPoliciesResponse'" PrefixI True) (S1 (MetaSel (Just "_dsprsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_dsprsScalingPolicies") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [ScalingPolicy])) :*: S1 (MetaSel (Just "_dsprsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

dsprsNextToken :: Lens' DescribeScalingPoliciesResponse (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.

dsprsScalingPolicies :: Lens' DescribeScalingPoliciesResponse [ScalingPolicy]

Collection of objects containing the scaling policies matching the request.

dsprsResponseStatus :: Lens' DescribeScalingPoliciesResponse Int

• - | The response status code.