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

Amazonka.GameLift.DescribeScalingPolicies

Description

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

Related actions

DescribeFleetCapacity | UpdateFleetCapacity | DescribeEC2InstanceLimits | PutScalingPolicy | DescribeScalingPolicies | DeleteScalingPolicy | StopFleetActions | StartFleetActions | All APIs by task

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeScalingPolicies Source #

Represents the input for a request operation.

See: newDescribeScalingPolicies smart constructor.

Constructors

DescribeScalingPolicies' 

Fields

  • location :: Maybe Text

    CONTENT TODO

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

  • statusFilter :: 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.
  • limit :: Maybe Natural

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

  • fleetId :: Text

    A unique identifier for the fleet to retrieve scaling policies for. You can use either the fleet ID or ARN value.

Instances

Instances details
Eq DescribeScalingPolicies Source # 
Instance details

Defined in Amazonka.GameLift.DescribeScalingPolicies

Methods

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

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

Read DescribeScalingPolicies Source # 
Instance details

Defined in Amazonka.GameLift.DescribeScalingPolicies

Methods

readsPrec :: Int -> ReadS DescribeScalingPolicies #

readList :: ReadS [DescribeScalingPolicies] #

readPrec :: ReadPrec DescribeScalingPolicies #

readListPrec :: ReadPrec [DescribeScalingPolicies] #

Show DescribeScalingPolicies Source # 
Instance details

Defined in Amazonka.GameLift.DescribeScalingPolicies

Methods

showsPrec :: Int -> DescribeScalingPolicies -> ShowS #

show :: DescribeScalingPolicies -> String #

showList :: [DescribeScalingPolicies] -> ShowS #

Generic DescribeScalingPolicies Source # 
Instance details

Defined in Amazonka.GameLift.DescribeScalingPolicies

Associated Types

type Rep DescribeScalingPolicies :: Type -> Type #

Methods

from :: DescribeScalingPolicies -> Rep DescribeScalingPolicies x #

to :: Rep DescribeScalingPolicies x -> DescribeScalingPolicies #

NFData DescribeScalingPolicies Source # 
Instance details

Defined in Amazonka.GameLift.DescribeScalingPolicies

Methods

rnf :: DescribeScalingPolicies -> () #

Hashable DescribeScalingPolicies Source # 
Instance details

Defined in Amazonka.GameLift.DescribeScalingPolicies

Methods

hashWithSalt :: Int -> DescribeScalingPolicies -> Int #

hash :: DescribeScalingPolicies -> Int #

ToJSON DescribeScalingPolicies Source # 
Instance details

Defined in Amazonka.GameLift.DescribeScalingPolicies

Methods

toJSON :: DescribeScalingPolicies -> Value #

toEncoding :: DescribeScalingPolicies -> Encoding #

toJSONList :: [DescribeScalingPolicies] -> Value #

toEncodingList :: [DescribeScalingPolicies] -> Encoding #

AWSPager DescribeScalingPolicies Source # 
Instance details

Defined in Amazonka.GameLift.DescribeScalingPolicies

Methods

page :: DescribeScalingPolicies -> AWSResponse DescribeScalingPolicies -> Maybe DescribeScalingPolicies #

AWSRequest DescribeScalingPolicies Source # 
Instance details

Defined in Amazonka.GameLift.DescribeScalingPolicies

Associated Types

type AWSResponse DescribeScalingPolicies #

Methods

request :: DescribeScalingPolicies -> Request DescribeScalingPolicies #

response :: MonadResource m => Logger -> Service -> Proxy DescribeScalingPolicies -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeScalingPolicies))) #

ToHeaders DescribeScalingPolicies Source # 
Instance details

Defined in Amazonka.GameLift.DescribeScalingPolicies

Methods

toHeaders :: DescribeScalingPolicies -> [Header] #

ToPath DescribeScalingPolicies Source # 
Instance details

Defined in Amazonka.GameLift.DescribeScalingPolicies

Methods

toPath :: DescribeScalingPolicies -> ByteString #

ToQuery DescribeScalingPolicies Source # 
Instance details

Defined in Amazonka.GameLift.DescribeScalingPolicies

Methods

toQuery :: DescribeScalingPolicies -> QueryString #

type Rep DescribeScalingPolicies Source # 
Instance details

Defined in Amazonka.GameLift.DescribeScalingPolicies

type Rep DescribeScalingPolicies = D1 ('MetaData "DescribeScalingPolicies" "Amazonka.GameLift.DescribeScalingPolicies" "libZSservicesZSamazonka-gameliftZSamazonka-gamelift" 'False) (C1 ('MetaCons "DescribeScalingPolicies'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "location") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "statusFilter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ScalingStatusType)) :*: (S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "fleetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse DescribeScalingPolicies Source # 
Instance details

Defined in Amazonka.GameLift.DescribeScalingPolicies

type AWSResponse DescribeScalingPolicies = DescribeScalingPoliciesResponse

newDescribeScalingPolicies Source #

Arguments

:: Text

$sel:fleetId:DescribeScalingPolicies'

-> DescribeScalingPolicies 

Create a value of DescribeScalingPolicies 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:location:DescribeScalingPolicies', describeScalingPolicies_location - CONTENT TODO

$sel:nextToken:DescribeScalingPolicies', describeScalingPolicies_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.

$sel:statusFilter:DescribeScalingPolicies', describeScalingPolicies_statusFilter - 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.

$sel:limit:DescribeScalingPolicies', describeScalingPolicies_limit - The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

$sel:fleetId:DescribeScalingPolicies', describeScalingPolicies_fleetId - A unique identifier for the fleet to retrieve scaling policies for. You can use either the fleet ID or ARN value.

Request Lenses

describeScalingPolicies_location :: Lens' DescribeScalingPolicies (Maybe Text) Source #

CONTENT TODO

describeScalingPolicies_nextToken :: Lens' DescribeScalingPolicies (Maybe Text) Source #

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.

describeScalingPolicies_statusFilter :: Lens' DescribeScalingPolicies (Maybe ScalingStatusType) Source #

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.

describeScalingPolicies_limit :: Lens' DescribeScalingPolicies (Maybe Natural) Source #

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

describeScalingPolicies_fleetId :: Lens' DescribeScalingPolicies Text Source #

A unique identifier for the fleet to retrieve scaling policies for. You can use either the fleet ID or ARN value.

Destructuring the Response

data DescribeScalingPoliciesResponse Source #

Represents the returned data in response to a request operation.

See: newDescribeScalingPoliciesResponse smart constructor.

Constructors

DescribeScalingPoliciesResponse' 

Fields

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

  • scalingPolicies :: Maybe [ScalingPolicy]

    A collection of objects containing the scaling policies matching the request.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq DescribeScalingPoliciesResponse Source # 
Instance details

Defined in Amazonka.GameLift.DescribeScalingPolicies

Methods

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

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

Read DescribeScalingPoliciesResponse Source # 
Instance details

Defined in Amazonka.GameLift.DescribeScalingPolicies

Methods

readsPrec :: Int -> ReadS DescribeScalingPoliciesResponse #

readList :: ReadS [DescribeScalingPoliciesResponse] #

readPrec :: ReadPrec DescribeScalingPoliciesResponse #

readListPrec :: ReadPrec [DescribeScalingPoliciesResponse] #

Show DescribeScalingPoliciesResponse Source # 
Instance details

Defined in Amazonka.GameLift.DescribeScalingPolicies

Methods

showsPrec :: Int -> DescribeScalingPoliciesResponse -> ShowS #

show :: DescribeScalingPoliciesResponse -> String #

showList :: [DescribeScalingPoliciesResponse] -> ShowS #

Generic DescribeScalingPoliciesResponse Source # 
Instance details

Defined in Amazonka.GameLift.DescribeScalingPolicies

Associated Types

type Rep DescribeScalingPoliciesResponse :: Type -> Type #

Methods

from :: DescribeScalingPoliciesResponse -> Rep DescribeScalingPoliciesResponse x #

to :: Rep DescribeScalingPoliciesResponse x -> DescribeScalingPoliciesResponse #

NFData DescribeScalingPoliciesResponse Source # 
Instance details

Defined in Amazonka.GameLift.DescribeScalingPolicies

Methods

rnf :: DescribeScalingPoliciesResponse -> () #

type Rep DescribeScalingPoliciesResponse Source # 
Instance details

Defined in Amazonka.GameLift.DescribeScalingPolicies

type Rep DescribeScalingPoliciesResponse = D1 ('MetaData "DescribeScalingPoliciesResponse" "Amazonka.GameLift.DescribeScalingPolicies" "libZSservicesZSamazonka-gameliftZSamazonka-gamelift" 'False) (C1 ('MetaCons "DescribeScalingPoliciesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "scalingPolicies") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ScalingPolicy])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeScalingPoliciesResponse Source #

Arguments

:: Int

$sel:httpStatus:DescribeScalingPoliciesResponse'

-> DescribeScalingPoliciesResponse 

Create a value of DescribeScalingPoliciesResponse 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:nextToken:DescribeScalingPolicies', describeScalingPoliciesResponse_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:scalingPolicies:DescribeScalingPoliciesResponse', describeScalingPoliciesResponse_scalingPolicies - A collection of objects containing the scaling policies matching the request.

$sel:httpStatus:DescribeScalingPoliciesResponse', describeScalingPoliciesResponse_httpStatus - The response's http status code.

Response Lenses

describeScalingPoliciesResponse_nextToken :: Lens' DescribeScalingPoliciesResponse (Maybe Text) Source #

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.

describeScalingPoliciesResponse_scalingPolicies :: Lens' DescribeScalingPoliciesResponse (Maybe [ScalingPolicy]) Source #

A collection of objects containing the scaling policies matching the request.

describeScalingPoliciesResponse_httpStatus :: Lens' DescribeScalingPoliciesResponse Int Source #

The response's http status code.