Copyright | (c) 2013-2018 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@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.
A fleet may have all of its scaling policies suspended (StopFleetActions
). This action does not affect the status of the scaling policies, which remains ACTIVE. To see whether a fleet's scaling policies are in force or suspended, call DescribeFleetAttributes
and check the stopped actions.
Operations related to fleet capacity scaling include:
DescribeFleetCapacity
UpdateFleetCapacity
DescribeEC2InstanceLimits
- Manage scaling policies:
PutScalingPolicy
(auto-scaling)DescribeScalingPolicies
(auto-scaling)DeleteScalingPolicy
(auto-scaling)- Manage fleet actions:
StartFleetActions
StopFleetActions
- 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:
dNextToken
- 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.dStatusFilter
- Scaling policy status to filter results on. A scaling policy is only in force when in anACTIVE
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.dLimit
- Maximum number of results to return. Use this parameter withNextToken
to get results as a set of sequential pages.dFleetId
- Unique identifier for a fleet to retrieve scaling policies for.
data DescribeScalingPolicies Source #
Represents the input for a request action.
See: describeScalingPolicies
smart constructor.
Request Lenses
dNextToken :: Lens' DescribeScalingPolicies (Maybe Text) Source #
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.
dStatusFilter :: Lens' DescribeScalingPolicies (Maybe ScalingStatusType) Source #
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.
dLimit :: Lens' DescribeScalingPolicies (Maybe Natural) Source #
Maximum number of results to return. Use this parameter with NextToken
to get results as a set of sequential pages.
dFleetId :: Lens' DescribeScalingPolicies Text Source #
Unique identifier for a 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:
dsprsNextToken
- Token that indicates 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.dsprsScalingPolicies
- Collection of objects containing the scaling policies matching the request.dsprsResponseStatus
- -- | The response status code.
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 that indicates 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.
dsprsScalingPolicies :: Lens' DescribeScalingPoliciesResponse [ScalingPolicy] Source #
Collection of objects containing the scaling policies matching the request.
dsprsResponseStatus :: Lens' DescribeScalingPoliciesResponse Int Source #
- - | The response status code.