Copyright	(c) 2013-2021 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

Amazonka.AutoScaling.DescribePolicies

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets information about the scaling policies in the account and Region.

This operation returns paginated results.

Synopsis

data DescribePolicies = DescribePolicies' {
- policyNames :: Maybe [Text]
- nextToken :: Maybe Text
- autoScalingGroupName :: Maybe Text
- maxRecords :: Maybe Int
- policyTypes :: Maybe [Text]
}
newDescribePolicies :: DescribePolicies
describePolicies_policyNames :: Lens' DescribePolicies (Maybe [Text])
describePolicies_nextToken :: Lens' DescribePolicies (Maybe Text)
describePolicies_autoScalingGroupName :: Lens' DescribePolicies (Maybe Text)
describePolicies_maxRecords :: Lens' DescribePolicies (Maybe Int)
describePolicies_policyTypes :: Lens' DescribePolicies (Maybe [Text])
data DescribePoliciesResponse = DescribePoliciesResponse' {
- nextToken :: Maybe Text
- scalingPolicies :: Maybe [ScalingPolicy]
- httpStatus :: Int
}
newDescribePoliciesResponse :: Int -> DescribePoliciesResponse
describePoliciesResponse_nextToken :: Lens' DescribePoliciesResponse (Maybe Text)
describePoliciesResponse_scalingPolicies :: Lens' DescribePoliciesResponse (Maybe [ScalingPolicy])
describePoliciesResponse_httpStatus :: Lens' DescribePoliciesResponse Int

Creating a Request

data DescribePolicies Source #

See: newDescribePolicies smart constructor.

Constructors

DescribePolicies'

Fields

policyNames :: Maybe [Text]
The names of one or more policies. If you omit this parameter, all policies are described. If a group name is provided, the results are limited to that group. If you specify an unknown policy name, it is ignored with no error.
Array Members: Maximum number of 50 items.
nextToken :: Maybe Text
The token for the next set of items to return. (You received this token from a previous call.)
autoScalingGroupName :: Maybe Text
The name of the Auto Scaling group.
maxRecords :: Maybe Int
The maximum number of items to be returned with each call. The default value is 50 and the maximum value is 100.
policyTypes :: Maybe [Text]
One or more policy types. The valid values are SimpleScaling, StepScaling, TargetTrackingScaling, and PredictiveScaling.

Instances

Instances details

Eq DescribePolicies Source #
Instance details Defined in Amazonka.AutoScaling.DescribePolicies Methods (==) :: DescribePolicies -> DescribePolicies -> Bool # (/=) :: DescribePolicies -> DescribePolicies -> Bool #
Read DescribePolicies Source #
Instance details Defined in Amazonka.AutoScaling.DescribePolicies Methods readsPrec :: Int -> ReadS DescribePolicies # readList :: ReadS [DescribePolicies] # readPrec :: ReadPrec DescribePolicies # readListPrec :: ReadPrec [DescribePolicies] #
Show DescribePolicies Source #
Instance details Defined in Amazonka.AutoScaling.DescribePolicies Methods showsPrec :: Int -> DescribePolicies -> ShowS # show :: DescribePolicies -> String # showList :: [DescribePolicies] -> ShowS #
Generic DescribePolicies Source #
Instance details Defined in Amazonka.AutoScaling.DescribePolicies Associated Types type Rep DescribePolicies :: Type -> Type # Methods from :: DescribePolicies -> Rep DescribePolicies x # to :: Rep DescribePolicies x -> DescribePolicies #
NFData DescribePolicies Source #
Instance details Defined in Amazonka.AutoScaling.DescribePolicies Methods rnf :: DescribePolicies -> () #
Hashable DescribePolicies Source #
Instance details Defined in Amazonka.AutoScaling.DescribePolicies Methods hashWithSalt :: Int -> DescribePolicies -> Int # hash :: DescribePolicies -> Int #
AWSPager DescribePolicies Source #
Instance details Defined in Amazonka.AutoScaling.DescribePolicies Methods page :: DescribePolicies -> AWSResponse DescribePolicies -> Maybe DescribePolicies #
AWSRequest DescribePolicies Source #
Instance details Defined in Amazonka.AutoScaling.DescribePolicies Associated Types type AWSResponse DescribePolicies # Methods request :: DescribePolicies -> Request DescribePolicies # response :: MonadResource m => Logger -> Service -> Proxy DescribePolicies -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribePolicies))) #
ToHeaders DescribePolicies Source #
Instance details Defined in Amazonka.AutoScaling.DescribePolicies Methods toHeaders :: DescribePolicies -> [Header] #
ToPath DescribePolicies Source #
Instance details Defined in Amazonka.AutoScaling.DescribePolicies Methods toPath :: DescribePolicies -> ByteString #
ToQuery DescribePolicies Source #
Instance details Defined in Amazonka.AutoScaling.DescribePolicies Methods toQuery :: DescribePolicies -> QueryString #
type Rep DescribePolicies Source #
Instance details Defined in Amazonka.AutoScaling.DescribePolicies type Rep DescribePolicies = D1 ('MetaData "DescribePolicies" "Amazonka.AutoScaling.DescribePolicies" "libZSservicesZSamazonka-autoscalingZSamazonka-autoscaling" 'False) (C1 ('MetaCons "DescribePolicies'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "policyNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "autoScalingGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "maxRecords") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "policyTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))))
type AWSResponse DescribePolicies Source #
Instance details Defined in Amazonka.AutoScaling.DescribePolicies type AWSResponse DescribePolicies = DescribePoliciesResponse

newDescribePolicies :: DescribePolicies Source #

Create a value of DescribePolicies 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:policyNames:DescribePolicies', describePolicies_policyNames - The names of one or more policies. If you omit this parameter, all policies are described. If a group name is provided, the results are limited to that group. If you specify an unknown policy name, it is ignored with no error.

Array Members: Maximum number of 50 items.

$sel:nextToken:DescribePolicies', describePolicies_nextToken - The token for the next set of items to return. (You received this token from a previous call.)

$sel:autoScalingGroupName:DescribePolicies', describePolicies_autoScalingGroupName - The name of the Auto Scaling group.

$sel:maxRecords:DescribePolicies', describePolicies_maxRecords - The maximum number of items to be returned with each call. The default value is 50 and the maximum value is 100.

$sel:policyTypes:DescribePolicies', describePolicies_policyTypes - One or more policy types. The valid values are SimpleScaling, StepScaling, TargetTrackingScaling, and PredictiveScaling.

Request Lenses

describePolicies_policyNames :: Lens' DescribePolicies (Maybe [Text]) Source #

The names of one or more policies. If you omit this parameter, all policies are described. If a group name is provided, the results are limited to that group. If you specify an unknown policy name, it is ignored with no error.

Array Members: Maximum number of 50 items.

describePolicies_nextToken :: Lens' DescribePolicies (Maybe Text) Source #

The token for the next set of items to return. (You received this token from a previous call.)

describePolicies_autoScalingGroupName :: Lens' DescribePolicies (Maybe Text) Source #

The name of the Auto Scaling group.

describePolicies_maxRecords :: Lens' DescribePolicies (Maybe Int) Source #

The maximum number of items to be returned with each call. The default value is 50 and the maximum value is 100.

describePolicies_policyTypes :: Lens' DescribePolicies (Maybe [Text]) Source #

One or more policy types. The valid values are SimpleScaling, StepScaling, TargetTrackingScaling, and PredictiveScaling.

Destructuring the Response

data DescribePoliciesResponse Source #

See: newDescribePoliciesResponse smart constructor.

Constructors

DescribePoliciesResponse'

Fields

nextToken :: Maybe Text
A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.
scalingPolicies :: Maybe [ScalingPolicy]
The scaling policies.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq DescribePoliciesResponse Source #
Instance details Defined in Amazonka.AutoScaling.DescribePolicies Methods (==) :: DescribePoliciesResponse -> DescribePoliciesResponse -> Bool # (/=) :: DescribePoliciesResponse -> DescribePoliciesResponse -> Bool #
Read DescribePoliciesResponse Source #
Instance details Defined in Amazonka.AutoScaling.DescribePolicies Methods readsPrec :: Int -> ReadS DescribePoliciesResponse # readList :: ReadS [DescribePoliciesResponse] # readPrec :: ReadPrec DescribePoliciesResponse # readListPrec :: ReadPrec [DescribePoliciesResponse] #
Show DescribePoliciesResponse Source #
Instance details Defined in Amazonka.AutoScaling.DescribePolicies Methods showsPrec :: Int -> DescribePoliciesResponse -> ShowS # show :: DescribePoliciesResponse -> String # showList :: [DescribePoliciesResponse] -> ShowS #
Generic DescribePoliciesResponse Source #
Instance details Defined in Amazonka.AutoScaling.DescribePolicies Associated Types type Rep DescribePoliciesResponse :: Type -> Type # Methods from :: DescribePoliciesResponse -> Rep DescribePoliciesResponse x # to :: Rep DescribePoliciesResponse x -> DescribePoliciesResponse #
NFData DescribePoliciesResponse Source #
Instance details Defined in Amazonka.AutoScaling.DescribePolicies Methods rnf :: DescribePoliciesResponse -> () #
type Rep DescribePoliciesResponse Source #
Instance details Defined in Amazonka.AutoScaling.DescribePolicies type Rep DescribePoliciesResponse = D1 ('MetaData "DescribePoliciesResponse" "Amazonka.AutoScaling.DescribePolicies" "libZSservicesZSamazonka-autoscalingZSamazonka-autoscaling" 'False) (C1 ('MetaCons "DescribePoliciesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "scalingPolicies") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ScalingPolicy])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribePoliciesResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribePoliciesResponse'`
-> DescribePoliciesResponse

Create a value of DescribePoliciesResponse 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:nextToken:DescribePolicies', describePoliciesResponse_nextToken - A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.

$sel:scalingPolicies:DescribePoliciesResponse', describePoliciesResponse_scalingPolicies - The scaling policies.

$sel:httpStatus:DescribePoliciesResponse', describePoliciesResponse_httpStatus - The response's http status code.

Response Lenses

describePoliciesResponse_nextToken :: Lens' DescribePoliciesResponse (Maybe Text) Source #

A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.

describePoliciesResponse_scalingPolicies :: Lens' DescribePoliciesResponse (Maybe [ScalingPolicy]) Source #

The scaling policies.

describePoliciesResponse_httpStatus :: Lens' DescribePoliciesResponse Int Source #

The response's http status code.