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.DescribeWarmPool

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets information about a warm pool and its instances.

For more information, see Warm pools for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

Synopsis

data DescribeWarmPool = DescribeWarmPool' {
- nextToken :: Maybe Text
- maxRecords :: Maybe Int
- autoScalingGroupName :: Text
}
newDescribeWarmPool :: Text -> DescribeWarmPool
describeWarmPool_nextToken :: Lens' DescribeWarmPool (Maybe Text)
describeWarmPool_maxRecords :: Lens' DescribeWarmPool (Maybe Int)
describeWarmPool_autoScalingGroupName :: Lens' DescribeWarmPool Text
data DescribeWarmPoolResponse = DescribeWarmPoolResponse' {
- nextToken :: Maybe Text
- instances :: Maybe [Instance]
- warmPoolConfiguration :: Maybe WarmPoolConfiguration
- httpStatus :: Int
}
newDescribeWarmPoolResponse :: Int -> DescribeWarmPoolResponse
describeWarmPoolResponse_nextToken :: Lens' DescribeWarmPoolResponse (Maybe Text)
describeWarmPoolResponse_instances :: Lens' DescribeWarmPoolResponse (Maybe [Instance])
describeWarmPoolResponse_warmPoolConfiguration :: Lens' DescribeWarmPoolResponse (Maybe WarmPoolConfiguration)
describeWarmPoolResponse_httpStatus :: Lens' DescribeWarmPoolResponse Int

Creating a Request

data DescribeWarmPool Source #

See: newDescribeWarmPool smart constructor.

Constructors

DescribeWarmPool'
Fields nextToken :: Maybe Text The token for the next set of instances to return. (You received this token from a previous call.) maxRecords :: Maybe Int The maximum number of instances to return with this call. The maximum value is `50`. autoScalingGroupName :: Text The name of the Auto Scaling group.

Instances

Instances details

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

newDescribeWarmPool Source #

Arguments

:: Text	`$sel:autoScalingGroupName:DescribeWarmPool'`
-> DescribeWarmPool

Create a value of DescribeWarmPool 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:DescribeWarmPool', describeWarmPool_nextToken - The token for the next set of instances to return. (You received this token from a previous call.)

$sel:maxRecords:DescribeWarmPool', describeWarmPool_maxRecords - The maximum number of instances to return with this call. The maximum value is 50.

$sel:autoScalingGroupName:DescribeWarmPool', describeWarmPool_autoScalingGroupName - The name of the Auto Scaling group.

Request Lenses

describeWarmPool_nextToken :: Lens' DescribeWarmPool (Maybe Text) Source #

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

describeWarmPool_maxRecords :: Lens' DescribeWarmPool (Maybe Int) Source #

The maximum number of instances to return with this call. The maximum value is 50.

describeWarmPool_autoScalingGroupName :: Lens' DescribeWarmPool Text Source #

The name of the Auto Scaling group.

Destructuring the Response

data DescribeWarmPoolResponse Source #

See: newDescribeWarmPoolResponse smart constructor.

Constructors

DescribeWarmPoolResponse'
Fields nextToken :: Maybe Text The token for the next set of items to return. (You received this token from a previous call.) instances :: Maybe [Instance] The instances that are currently in the warm pool. warmPoolConfiguration :: Maybe WarmPoolConfiguration The warm pool configuration details. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newDescribeWarmPoolResponse Source #

Arguments

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

Create a value of DescribeWarmPoolResponse 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:DescribeWarmPool', describeWarmPoolResponse_nextToken - The token for the next set of items to return. (You received this token from a previous call.)

$sel:instances:DescribeWarmPoolResponse', describeWarmPoolResponse_instances - The instances that are currently in the warm pool.

$sel:warmPoolConfiguration:DescribeWarmPoolResponse', describeWarmPoolResponse_warmPoolConfiguration - The warm pool configuration details.

$sel:httpStatus:DescribeWarmPoolResponse', describeWarmPoolResponse_httpStatus - The response's http status code.

Response Lenses

describeWarmPoolResponse_nextToken :: Lens' DescribeWarmPoolResponse (Maybe Text) Source #

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

describeWarmPoolResponse_instances :: Lens' DescribeWarmPoolResponse (Maybe [Instance]) Source #

The instances that are currently in the warm pool.

describeWarmPoolResponse_warmPoolConfiguration :: Lens' DescribeWarmPoolResponse (Maybe WarmPoolConfiguration) Source #

The warm pool configuration details.

describeWarmPoolResponse_httpStatus :: Lens' DescribeWarmPoolResponse Int Source #

The response's http status code.