Copyright | (c) 2013-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
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.
- describeScalingPolicies :: Text -> DescribeScalingPolicies
- data DescribeScalingPolicies
- dNextToken :: Lens' DescribeScalingPolicies (Maybe Text)
- dStatusFilter :: Lens' DescribeScalingPolicies (Maybe ScalingStatusType)
- dLimit :: Lens' DescribeScalingPolicies (Maybe Natural)
- dFleetId :: Lens' DescribeScalingPolicies Text
- describeScalingPoliciesResponse :: Int -> DescribeScalingPoliciesResponse
- data DescribeScalingPoliciesResponse
- dsprsNextToken :: Lens' DescribeScalingPoliciesResponse (Maybe Text)
- dsprsScalingPolicies :: Lens' DescribeScalingPoliciesResponse [ScalingPolicy]
- dsprsResponseStatus :: Lens' DescribeScalingPoliciesResponse Int
Creating a Request
describeScalingPolicies Source #
Creates a value of DescribeScalingPolicies
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data DescribeScalingPolicies Source #
Represents the input for a request action.
See: describeScalingPolicies
smart constructor.
Request Lenses
dNextToken :: Lens' DescribeScalingPolicies (Maybe Text) Source #
Token indicating the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To specify the start of the result set, do not specify a value.
dStatusFilter :: Lens' DescribeScalingPolicies (Maybe ScalingStatusType) Source #
Game session status to filter results on. A scaling policy is only in force when in an Active state.
- 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.
dLimit :: Lens' DescribeScalingPolicies (Maybe Natural) Source #
Maximum number of results to return. You can use this parameter with NextToken to get results as a set of sequential pages.
dFleetId :: Lens' DescribeScalingPolicies Text Source #
Unique identifier for a fleet. Specify the fleet to retrieve scaling policies for.
Destructuring the Response
describeScalingPoliciesResponse Source #
Creates a value of DescribeScalingPoliciesResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data DescribeScalingPoliciesResponse Source #
Represents the returned data in response to a request action.
See: describeScalingPoliciesResponse
smart constructor.
Response Lenses
dsprsNextToken :: Lens' DescribeScalingPoliciesResponse (Maybe Text) Source #
Token indicating where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.
If a request has a limit that exactly matches the number of remaining results, a token is returned even though there are no more results to retrieve.
dsprsScalingPolicies :: Lens' DescribeScalingPoliciesResponse [ScalingPolicy] Source #
Collection of objects containing the scaling policies matching the request.
dsprsResponseStatus :: Lens' DescribeScalingPoliciesResponse Int Source #
The response status code.