AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the DescribeScalingPolicies operation. Retrieves all scaling policies applied to a fleet.

To get a fleet's scaling policies, specify the fleet ID. You can filter this request by policy status, such as to retrieve only active scaling policies. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, set of ScalingPolicy objects is returned for the fleet.

A fleet may have all of its scaling policies suspended. This operation does not affect the status of the scaling policies, which remains ACTIVE.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.GameLift.AmazonGameLiftRequest
      Amazon.GameLift.Model.DescribeScalingPoliciesRequest

Namespace: Amazon.GameLift.Model
Assembly: AWSSDK.GameLift.dll
Version: 3.x.y.z

Syntax

C# 
public class DescribeScalingPoliciesRequest : AmazonGameLiftRequest
         IAmazonWebServiceRequest

The DescribeScalingPoliciesRequest type exposes the following members

Constructors

NameDescription
Public Method DescribeScalingPoliciesRequest()

Properties

NameTypeDescription
Public Property FleetId System.String

Gets and sets the property FleetId.

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

Public Property Limit System.Int32

Gets and sets the property Limit.

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

Public Property Location System.String

Gets and sets the property Location.

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

Public Property NextToken System.String

Gets and sets the property NextToken.

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.

Public Property StatusFilter Amazon.GameLift.ScalingStatusType

Gets and sets the property StatusFilter.

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.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5