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.AutoScaling.DescribeInstanceRefreshes

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets information about the instance refreshes for the specified Auto Scaling group.

This operation is part of the instance refresh feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group after you make configuration changes.

To help you determine the status of an instance refresh, this operation returns information about the instance refreshes you previously initiated, including their status, end time, the percentage of the instance refresh that is complete, and the number of instances remaining to update before the instance refresh is complete.

The following are the possible statuses:

Pending - The request was created, but the operation has not started.
InProgress - The operation is in progress.
Successful - The operation completed successfully.
Failed - The operation failed to complete. You can troubleshoot using the status reason and the scaling activities.
Cancelling - An ongoing operation is being cancelled. Cancellation does not roll back any replacements that have already been completed, but it prevents new replacements from being started.
Cancelled - The operation is cancelled.

Synopsis

Creating a Request

data DescribeInstanceRefreshes Source #

See: newDescribeInstanceRefreshes smart constructor.

Constructors

DescribeInstanceRefreshes'
Fields instanceRefreshIds :: Maybe [Text] One or more instance refresh IDs. maxRecords :: Maybe Int The maximum number of items to return with this call. The default value is `50` and the maximum value is `100`. nextToken :: Maybe Text The token for the next set of items to return. (You received this token from a previous call.) autoScalingGroupName :: Text The name of the Auto Scaling group.

Instances

Instances details

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

newDescribeInstanceRefreshes Source #

Arguments

:: Text	`DescribeInstanceRefreshes`
-> DescribeInstanceRefreshes

Create a value of DescribeInstanceRefreshes 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:instanceRefreshIds:DescribeInstanceRefreshes', describeInstanceRefreshes_instanceRefreshIds - One or more instance refresh IDs.

$sel:maxRecords:DescribeInstanceRefreshes', describeInstanceRefreshes_maxRecords - The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.

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

DescribeInstanceRefreshes, describeInstanceRefreshes_autoScalingGroupName - The name of the Auto Scaling group.

Request Lenses

describeInstanceRefreshes_instanceRefreshIds :: Lens' DescribeInstanceRefreshes (Maybe [Text]) Source #

One or more instance refresh IDs.

describeInstanceRefreshes_maxRecords :: Lens' DescribeInstanceRefreshes (Maybe Int) Source #

The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.

describeInstanceRefreshes_nextToken :: Lens' DescribeInstanceRefreshes (Maybe Text) Source #

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

describeInstanceRefreshes_autoScalingGroupName :: Lens' DescribeInstanceRefreshes Text Source #

The name of the Auto Scaling group.

Destructuring the Response

data DescribeInstanceRefreshesResponse Source #

See: newDescribeInstanceRefreshesResponse smart constructor.

Constructors

DescribeInstanceRefreshesResponse'

Fields

instanceRefreshes :: Maybe [InstanceRefresh]
The instance refreshes for the specified group, sorted by creation timestamp in descending order.
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.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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

newDescribeInstanceRefreshesResponse Source #

Arguments

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

Create a value of DescribeInstanceRefreshesResponse 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:instanceRefreshes:DescribeInstanceRefreshesResponse', describeInstanceRefreshesResponse_instanceRefreshes - The instance refreshes for the specified group, sorted by creation timestamp in descending order.

DescribeInstanceRefreshes, describeInstanceRefreshesResponse_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:httpStatus:DescribeInstanceRefreshesResponse', describeInstanceRefreshesResponse_httpStatus - The response's http status code.

Response Lenses

describeInstanceRefreshesResponse_instanceRefreshes :: Lens' DescribeInstanceRefreshesResponse (Maybe [InstanceRefresh]) Source #

The instance refreshes for the specified group, sorted by creation timestamp in descending order.

describeInstanceRefreshesResponse_nextToken :: Lens' DescribeInstanceRefreshesResponse (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.

describeInstanceRefreshesResponse_httpStatus :: Lens' DescribeInstanceRefreshesResponse Int Source #

The response's http status code.