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

Inherits:

Struct

• Object
• Struct
• Aws::GameLift::Types::DescribeScalingPoliciesInput

Includes:

Structure

Defined in:

lib/aws-sdk-gamelift/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #fleet_id ⇒ String

  A unique identifier for the fleet for which to retrieve scaling policies.

• #limit ⇒ Integer

  The maximum number of results to return.

• #location ⇒ String

  The fleet location.

• #next_token ⇒ String

  A 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 the fleet for which to retrieve scaling policies. You can use either the fleet ID or ARN value.

Returns:

• (String)

# File 'lib/aws-sdk-gamelift/types.rb', line 4883

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

#limit ⇒ Integer

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

Returns:

• (Integer)

# File 'lib/aws-sdk-gamelift/types.rb', line 4883

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

#location ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-gamelift/types.rb', line 4883

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

#next_token ⇒ String

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)

# File 'lib/aws-sdk-gamelift/types.rb', line 4883

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

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

Returns:

• (String)

# File 'lib/aws-sdk-gamelift/types.rb', line 4883

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