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

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#fleet_idString

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

Returns:

  • (String)


4808
4809
4810
4811
4812
4813
4814
4815
4816
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 4808

class DescribeScalingPoliciesInput < Struct.new(
  :fleet_id,
  :status_filter,
  :limit,
  :next_token,
  :location)
  SENSITIVE = []
  include Aws::Structure
end

#limitInteger

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

Returns:

  • (Integer)


4808
4809
4810
4811
4812
4813
4814
4815
4816
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 4808

class DescribeScalingPoliciesInput < Struct.new(
  :fleet_id,
  :status_filter,
  :limit,
  :next_token,
  :location)
  SENSITIVE = []
  include Aws::Structure
end

#locationString

The fleet location. If you don't specify this value, the response contains the scaling policies of every location in the fleet.

Returns:

  • (String)


4808
4809
4810
4811
4812
4813
4814
4815
4816
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 4808

class DescribeScalingPoliciesInput < Struct.new(
  :fleet_id,
  :status_filter,
  :limit,
  :next_token,
  :location)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

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.

Returns:

  • (String)


4808
4809
4810
4811
4812
4813
4814
4815
4816
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 4808

class DescribeScalingPoliciesInput < Struct.new(
  :fleet_id,
  :status_filter,
  :limit,
  :next_token,
  :location)
  SENSITIVE = []
  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)


4808
4809
4810
4811
4812
4813
4814
4815
4816
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 4808

class DescribeScalingPoliciesInput < Struct.new(
  :fleet_id,
  :status_filter,
  :limit,
  :next_token,
  :location)
  SENSITIVE = []
  include Aws::Structure
end