Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
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. This operation does not affect the status of the scaling policies, which remains ACTIVE.
This operation returns paginated results.
Synopsis
- data DescribeScalingPolicies = DescribeScalingPolicies' {}
- newDescribeScalingPolicies :: Text -> DescribeScalingPolicies
- describeScalingPolicies_limit :: Lens' DescribeScalingPolicies (Maybe Natural)
- describeScalingPolicies_location :: Lens' DescribeScalingPolicies (Maybe Text)
- describeScalingPolicies_nextToken :: Lens' DescribeScalingPolicies (Maybe Text)
- describeScalingPolicies_statusFilter :: Lens' DescribeScalingPolicies (Maybe ScalingStatusType)
- describeScalingPolicies_fleetId :: Lens' DescribeScalingPolicies Text
- data DescribeScalingPoliciesResponse = DescribeScalingPoliciesResponse' {
- nextToken :: Maybe Text
- scalingPolicies :: Maybe [ScalingPolicy]
- httpStatus :: Int
- newDescribeScalingPoliciesResponse :: Int -> DescribeScalingPoliciesResponse
- describeScalingPoliciesResponse_nextToken :: Lens' DescribeScalingPoliciesResponse (Maybe Text)
- describeScalingPoliciesResponse_scalingPolicies :: Lens' DescribeScalingPoliciesResponse (Maybe [ScalingPolicy])
- describeScalingPoliciesResponse_httpStatus :: Lens' DescribeScalingPoliciesResponse Int
Creating a Request
data DescribeScalingPolicies Source #
See: newDescribeScalingPolicies
smart constructor.
DescribeScalingPolicies' | |
|
Instances
newDescribeScalingPolicies Source #
Create a value of DescribeScalingPolicies
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:limit:DescribeScalingPolicies'
, describeScalingPolicies_limit
- The maximum number of results to return. Use this parameter with
NextToken
to get results as a set of sequential pages.
DescribeScalingPolicies
, describeScalingPolicies_location
- The fleet location. If you don't specify this value, the response
contains the scaling policies of every location in the fleet.
DescribeScalingPolicies
, describeScalingPolicies_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.
$sel:statusFilter:DescribeScalingPolicies'
, describeScalingPolicies_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.
DescribeScalingPolicies
, describeScalingPolicies_fleetId
- A unique identifier for the fleet for which to retrieve scaling
policies. You can use either the fleet ID or ARN value.
Request Lenses
describeScalingPolicies_limit :: Lens' DescribeScalingPolicies (Maybe Natural) Source #
The maximum number of results to return. Use this parameter with
NextToken
to get results as a set of sequential pages.
describeScalingPolicies_location :: Lens' DescribeScalingPolicies (Maybe Text) Source #
The fleet location. If you don't specify this value, the response contains the scaling policies of every location in the fleet.
describeScalingPolicies_nextToken :: Lens' DescribeScalingPolicies (Maybe Text) Source #
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.
describeScalingPolicies_statusFilter :: 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.
describeScalingPolicies_fleetId :: Lens' DescribeScalingPolicies Text Source #
A unique identifier for the fleet for which to retrieve scaling policies. You can use either the fleet ID or ARN value.
Destructuring the Response
data DescribeScalingPoliciesResponse Source #
See: newDescribeScalingPoliciesResponse
smart constructor.
DescribeScalingPoliciesResponse' | |
|
Instances
newDescribeScalingPoliciesResponse Source #
Create a value of DescribeScalingPoliciesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeScalingPolicies
, describeScalingPoliciesResponse_nextToken
- A token that indicates where to resume retrieving results on the next
call to this operation. If no token is returned, these results represent
the end of the list.
$sel:scalingPolicies:DescribeScalingPoliciesResponse'
, describeScalingPoliciesResponse_scalingPolicies
- A collection of objects containing the scaling policies matching the
request.
$sel:httpStatus:DescribeScalingPoliciesResponse'
, describeScalingPoliciesResponse_httpStatus
- The response's http status code.
Response Lenses
describeScalingPoliciesResponse_nextToken :: Lens' DescribeScalingPoliciesResponse (Maybe Text) Source #
A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.
describeScalingPoliciesResponse_scalingPolicies :: Lens' DescribeScalingPoliciesResponse (Maybe [ScalingPolicy]) Source #
A collection of objects containing the scaling policies matching the request.
describeScalingPoliciesResponse_httpStatus :: Lens' DescribeScalingPoliciesResponse Int Source #
The response's http status code.