You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::GameLift::Types::DescribeScalingPoliciesInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb

Overview

Note:

When making an API call, you may pass DescribeScalingPoliciesInput data as a 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)


2251
2252
2253
2254
2255
2256
2257
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 2251

class DescribeScalingPoliciesInput < Struct.new(
  :fleet_id,
  :status_filter,
  :limit,
  :next_token)
  include Aws::Structure
end

#limitInteger

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

Returns:

  • (Integer)


2251
2252
2253
2254
2255
2256
2257
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 2251

class DescribeScalingPoliciesInput < Struct.new(
  :fleet_id,
  :status_filter,
  :limit,
  :next_token)
  include Aws::Structure
end

#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)


2251
2252
2253
2254
2255
2256
2257
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 2251

class DescribeScalingPoliciesInput < Struct.new(
  :fleet_id,
  :status_filter,
  :limit,
  :next_token)
  include Aws::Structure
end

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

Returns:

  • (String)


2251
2252
2253
2254
2255
2256
2257
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 2251

class DescribeScalingPoliciesInput < Struct.new(
  :fleet_id,
  :status_filter,
  :limit,
  :next_token)
  include Aws::Structure
end