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

Amazonka.AutoScalingPlans.DescribeScalingPlans

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes one or more of your scaling plans.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeScalingPlans Source #

See: newDescribeScalingPlans smart constructor.

Constructors

DescribeScalingPlans'

Fields

applicationSources :: Maybe [ApplicationSource]
The sources for the applications (up to 10). If you specify scaling plan names, you cannot specify application sources.
maxResults :: Maybe Int
The maximum number of scalable resources to return. This value can be between 1 and 50. The default value is 50.
nextToken :: Maybe Text
The token for the next set of results.
scalingPlanNames :: Maybe [Text]
The names of the scaling plans (up to 10). If you specify application sources, you cannot specify scaling plan names.
scalingPlanVersion :: Maybe Integer
The version number of the scaling plan. Currently, the only valid value is 1.
If you specify a scaling plan version, you must also specify a scaling plan name.

Instances

Instances details

ToJSON DescribeScalingPlans Source #
Instance details Defined in Amazonka.AutoScalingPlans.DescribeScalingPlans Methods toJSON :: DescribeScalingPlans -> Value # toEncoding :: DescribeScalingPlans -> Encoding # toJSONList :: [DescribeScalingPlans] -> Value # toEncodingList :: [DescribeScalingPlans] -> Encoding #
ToHeaders DescribeScalingPlans Source #
Instance details Defined in Amazonka.AutoScalingPlans.DescribeScalingPlans Methods toHeaders :: DescribeScalingPlans -> [Header] #
ToPath DescribeScalingPlans Source #
Instance details Defined in Amazonka.AutoScalingPlans.DescribeScalingPlans Methods toPath :: DescribeScalingPlans -> ByteString #
ToQuery DescribeScalingPlans Source #
Instance details Defined in Amazonka.AutoScalingPlans.DescribeScalingPlans Methods toQuery :: DescribeScalingPlans -> QueryString #
AWSPager DescribeScalingPlans Source #
Instance details Defined in Amazonka.AutoScalingPlans.DescribeScalingPlans Methods page :: DescribeScalingPlans -> AWSResponse DescribeScalingPlans -> Maybe DescribeScalingPlans #
AWSRequest DescribeScalingPlans Source #
Instance details Defined in Amazonka.AutoScalingPlans.DescribeScalingPlans Associated Types type AWSResponse DescribeScalingPlans # Methods request :: (Service -> Service) -> DescribeScalingPlans -> Request DescribeScalingPlans # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeScalingPlans -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeScalingPlans))) #
Generic DescribeScalingPlans Source #
Instance details Defined in Amazonka.AutoScalingPlans.DescribeScalingPlans Associated Types type Rep DescribeScalingPlans :: Type -> Type # Methods from :: DescribeScalingPlans -> Rep DescribeScalingPlans x # to :: Rep DescribeScalingPlans x -> DescribeScalingPlans #
Read DescribeScalingPlans Source #
Instance details Defined in Amazonka.AutoScalingPlans.DescribeScalingPlans Methods readsPrec :: Int -> ReadS DescribeScalingPlans # readList :: ReadS [DescribeScalingPlans] # readPrec :: ReadPrec DescribeScalingPlans # readListPrec :: ReadPrec [DescribeScalingPlans] #
Show DescribeScalingPlans Source #
Instance details Defined in Amazonka.AutoScalingPlans.DescribeScalingPlans Methods showsPrec :: Int -> DescribeScalingPlans -> ShowS # show :: DescribeScalingPlans -> String # showList :: [DescribeScalingPlans] -> ShowS #
NFData DescribeScalingPlans Source #
Instance details Defined in Amazonka.AutoScalingPlans.DescribeScalingPlans Methods rnf :: DescribeScalingPlans -> () #
Eq DescribeScalingPlans Source #
Instance details Defined in Amazonka.AutoScalingPlans.DescribeScalingPlans Methods (==) :: DescribeScalingPlans -> DescribeScalingPlans -> Bool # (/=) :: DescribeScalingPlans -> DescribeScalingPlans -> Bool #
Hashable DescribeScalingPlans Source #
Instance details Defined in Amazonka.AutoScalingPlans.DescribeScalingPlans Methods hashWithSalt :: Int -> DescribeScalingPlans -> Int # hash :: DescribeScalingPlans -> Int #
type AWSResponse DescribeScalingPlans Source #
Instance details Defined in Amazonka.AutoScalingPlans.DescribeScalingPlans type AWSResponse DescribeScalingPlans = DescribeScalingPlansResponse
type Rep DescribeScalingPlans Source #
Instance details Defined in Amazonka.AutoScalingPlans.DescribeScalingPlans type Rep DescribeScalingPlans = D1 ('MetaData "DescribeScalingPlans" "Amazonka.AutoScalingPlans.DescribeScalingPlans" "amazonka-autoscaling-plans-2.0-1ffFjJ7hnaH6GMb2VoWJfu" 'False) (C1 ('MetaCons "DescribeScalingPlans'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "applicationSources") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ApplicationSource])) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "scalingPlanNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "scalingPlanVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))))))

newDescribeScalingPlans :: DescribeScalingPlans Source #

Create a value of DescribeScalingPlans 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:applicationSources:DescribeScalingPlans', describeScalingPlans_applicationSources - The sources for the applications (up to 10). If you specify scaling plan names, you cannot specify application sources.

$sel:maxResults:DescribeScalingPlans', describeScalingPlans_maxResults - The maximum number of scalable resources to return. This value can be between 1 and 50. The default value is 50.

DescribeScalingPlans, describeScalingPlans_nextToken - The token for the next set of results.

$sel:scalingPlanNames:DescribeScalingPlans', describeScalingPlans_scalingPlanNames - The names of the scaling plans (up to 10). If you specify application sources, you cannot specify scaling plan names.

DescribeScalingPlans, describeScalingPlans_scalingPlanVersion - The version number of the scaling plan. Currently, the only valid value is 1.

If you specify a scaling plan version, you must also specify a scaling plan name.

Request Lenses

describeScalingPlans_applicationSources :: Lens' DescribeScalingPlans (Maybe [ApplicationSource]) Source #

The sources for the applications (up to 10). If you specify scaling plan names, you cannot specify application sources.

describeScalingPlans_maxResults :: Lens' DescribeScalingPlans (Maybe Int) Source #

The maximum number of scalable resources to return. This value can be between 1 and 50. The default value is 50.

describeScalingPlans_nextToken :: Lens' DescribeScalingPlans (Maybe Text) Source #

The token for the next set of results.

describeScalingPlans_scalingPlanNames :: Lens' DescribeScalingPlans (Maybe [Text]) Source #

The names of the scaling plans (up to 10). If you specify application sources, you cannot specify scaling plan names.

describeScalingPlans_scalingPlanVersion :: Lens' DescribeScalingPlans (Maybe Integer) Source #

The version number of the scaling plan. Currently, the only valid value is 1.

If you specify a scaling plan version, you must also specify a scaling plan name.

Destructuring the Response

data DescribeScalingPlansResponse Source #

See: newDescribeScalingPlansResponse smart constructor.

Constructors

DescribeScalingPlansResponse'
Fields nextToken :: Maybe Text The token required to get the next set of results. This value is `null` if there are no more results to return. scalingPlans :: Maybe [ScalingPlan] Information about the scaling plans. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DescribeScalingPlansResponse Source #
Instance details Defined in Amazonka.AutoScalingPlans.DescribeScalingPlans Associated Types type Rep DescribeScalingPlansResponse :: Type -> Type # Methods from :: DescribeScalingPlansResponse -> Rep DescribeScalingPlansResponse x # to :: Rep DescribeScalingPlansResponse x -> DescribeScalingPlansResponse #
Read DescribeScalingPlansResponse Source #
Instance details Defined in Amazonka.AutoScalingPlans.DescribeScalingPlans Methods readsPrec :: Int -> ReadS DescribeScalingPlansResponse # readList :: ReadS [DescribeScalingPlansResponse] # readPrec :: ReadPrec DescribeScalingPlansResponse # readListPrec :: ReadPrec [DescribeScalingPlansResponse] #
Show DescribeScalingPlansResponse Source #
Instance details Defined in Amazonka.AutoScalingPlans.DescribeScalingPlans Methods showsPrec :: Int -> DescribeScalingPlansResponse -> ShowS # show :: DescribeScalingPlansResponse -> String # showList :: [DescribeScalingPlansResponse] -> ShowS #
NFData DescribeScalingPlansResponse Source #
Instance details Defined in Amazonka.AutoScalingPlans.DescribeScalingPlans Methods rnf :: DescribeScalingPlansResponse -> () #
Eq DescribeScalingPlansResponse Source #
Instance details Defined in Amazonka.AutoScalingPlans.DescribeScalingPlans Methods (==) :: DescribeScalingPlansResponse -> DescribeScalingPlansResponse -> Bool # (/=) :: DescribeScalingPlansResponse -> DescribeScalingPlansResponse -> Bool #
type Rep DescribeScalingPlansResponse Source #
Instance details Defined in Amazonka.AutoScalingPlans.DescribeScalingPlans type Rep DescribeScalingPlansResponse = D1 ('MetaData "DescribeScalingPlansResponse" "Amazonka.AutoScalingPlans.DescribeScalingPlans" "amazonka-autoscaling-plans-2.0-1ffFjJ7hnaH6GMb2VoWJfu" 'False) (C1 ('MetaCons "DescribeScalingPlansResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "scalingPlans") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ScalingPlan])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeScalingPlansResponse Source #

Arguments

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

Create a value of DescribeScalingPlansResponse 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:

DescribeScalingPlans, describeScalingPlansResponse_nextToken - The token required to get the next set of results. This value is null if there are no more results to return.

$sel:scalingPlans:DescribeScalingPlansResponse', describeScalingPlansResponse_scalingPlans - Information about the scaling plans.

$sel:httpStatus:DescribeScalingPlansResponse', describeScalingPlansResponse_httpStatus - The response's http status code.

Response Lenses

describeScalingPlansResponse_nextToken :: Lens' DescribeScalingPlansResponse (Maybe Text) Source #

The token required to get the next set of results. This value is null if there are no more results to return.

describeScalingPlansResponse_scalingPlans :: Lens' DescribeScalingPlansResponse (Maybe [ScalingPlan]) Source #

Information about the scaling plans.

describeScalingPlansResponse_httpStatus :: Lens' DescribeScalingPlansResponse Int Source #

The response's http status code.