You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::GameLift::Types::DescribeScalingPoliciesInput
- Inherits:
-
Struct
- Object
- Struct
- Aws::GameLift::Types::DescribeScalingPoliciesInput
- Defined in:
- (unknown)
Overview
When passing DescribeScalingPoliciesInput as input to an Aws::Client method, you can use a vanilla Hash:
{
fleet_id: "FleetIdOrArn", # required
status_filter: "ACTIVE", # accepts ACTIVE, UPDATE_REQUESTED, UPDATING, DELETE_REQUESTED, DELETING, DELETED, ERROR
limit: 1,
next_token: "NonZeroAndMaxString",
}
Represents the input for a request operation.
Instance Attribute Summary collapse
-
#fleet_id ⇒ String
A unique identifier for a fleet to retrieve scaling policies for.
-
#limit ⇒ Integer
The maximum number of results to return.
-
#next_token ⇒ String
Token that indicates the start of the next sequential page of results.
-
#status_filter ⇒ String
Scaling policy status to filter results on.
Instance Attribute Details
#fleet_id ⇒ String
A unique identifier for a fleet to retrieve scaling policies for. You can use either the fleet ID or ARN value.
#limit ⇒ Integer
The maximum number of results to return. Use this parameter with
NextToken
to get results as a set of sequential pages.
#next_token ⇒ String
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.
#status_filter ⇒ String
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.
Possible values:
- ACTIVE
- UPDATE_REQUESTED
- UPDATING
- DELETE_REQUESTED
- DELETING
- DELETED
- ERROR