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
show all
Defined in:
(unknown)

Overview

Note:

When passing DescribeScalingPoliciesInput as input to an Aws::Client method, you can use a vanilla Hash:

{
  fleet_id: "FleetId", # 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 action.

Instance Attribute Summary collapse

Instance Attribute Details

#fleet_idString

Unique identifier for a fleet to retrieve scaling policies for.

Returns:

  • (String)

    Unique identifier for a fleet to retrieve scaling policies for.

#limitInteger

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

Returns:

  • (Integer)

    Maximum number of results to return.

#next_tokenString

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.

Returns:

  • (String)

    Token that indicates the start of the next sequential page of results.

#status_filterString

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

Returns:

  • (String)

    Scaling policy status to filter results on.