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

Contents

Description

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

When scaling events occur, you see a record of the scaling activity in the scaling activities. For more information, see Verifying a scaling activity for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.

If the scaling event succeeds, the value of the StatusCode element in the response is Successful. If an attempt to launch instances failed, the StatusCode value is Failed or Cancelled and the StatusMessage element in the response indicates the cause of the failure. For help interpreting the StatusMessage, see Troubleshooting Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeScalingActivities Source #

See: newDescribeScalingActivities smart constructor.

Constructors

DescribeScalingActivities'

Fields

activityIds :: Maybe [Text]
The activity IDs of the desired scaling activities. If you omit this property, all activities for the past six weeks are described. If unknown activities are requested, they are ignored with no error. If you specify an Auto Scaling group, the results are limited to that group.
Array Members: Maximum number of 50 IDs.
autoScalingGroupName :: Maybe Text
The name of the Auto Scaling group.
includeDeletedGroups :: Maybe Bool
Indicates whether to include scaling activity from deleted Auto Scaling groups.
maxRecords :: Maybe Int
The maximum number of items to return with this call. The default value is 100 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.)

Instances

Instances details

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

newDescribeScalingActivities :: DescribeScalingActivities Source #

Create a value of DescribeScalingActivities 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:activityIds:DescribeScalingActivities', describeScalingActivities_activityIds - The activity IDs of the desired scaling activities. If you omit this property, all activities for the past six weeks are described. If unknown activities are requested, they are ignored with no error. If you specify an Auto Scaling group, the results are limited to that group.

Array Members: Maximum number of 50 IDs.

DescribeScalingActivities, describeScalingActivities_autoScalingGroupName - The name of the Auto Scaling group.

$sel:includeDeletedGroups:DescribeScalingActivities', describeScalingActivities_includeDeletedGroups - Indicates whether to include scaling activity from deleted Auto Scaling groups.

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

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

Request Lenses

describeScalingActivities_activityIds :: Lens' DescribeScalingActivities (Maybe [Text]) Source #

The activity IDs of the desired scaling activities. If you omit this property, all activities for the past six weeks are described. If unknown activities are requested, they are ignored with no error. If you specify an Auto Scaling group, the results are limited to that group.

Array Members: Maximum number of 50 IDs.

describeScalingActivities_autoScalingGroupName :: Lens' DescribeScalingActivities (Maybe Text) Source #

The name of the Auto Scaling group.

describeScalingActivities_includeDeletedGroups :: Lens' DescribeScalingActivities (Maybe Bool) Source #

Indicates whether to include scaling activity from deleted Auto Scaling groups.

describeScalingActivities_maxRecords :: Lens' DescribeScalingActivities (Maybe Int) Source #

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

describeScalingActivities_nextToken :: Lens' DescribeScalingActivities (Maybe Text) Source #

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

Destructuring the Response

data DescribeScalingActivitiesResponse Source #

See: newDescribeScalingActivitiesResponse smart constructor.

Constructors

DescribeScalingActivitiesResponse'

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.
httpStatus :: Int
The response's http status code.
activities :: [Activity]
The scaling activities. Activities are sorted by start time. Activities still in progress are described first.

Instances

Instances details

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

newDescribeScalingActivitiesResponse Source #

Arguments

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

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

DescribeScalingActivities, describeScalingActivitiesResponse_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:DescribeScalingActivitiesResponse', describeScalingActivitiesResponse_httpStatus - The response's http status code.

$sel:activities:DescribeScalingActivitiesResponse', describeScalingActivitiesResponse_activities - The scaling activities. Activities are sorted by start time. Activities still in progress are described first.

Response Lenses

describeScalingActivitiesResponse_nextToken :: Lens' DescribeScalingActivitiesResponse (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.

describeScalingActivitiesResponse_httpStatus :: Lens' DescribeScalingActivitiesResponse Int Source #

The response's http status code.

describeScalingActivitiesResponse_activities :: Lens' DescribeScalingActivitiesResponse [Activity] Source #

The scaling activities. Activities are sorted by start time. Activities still in progress are described first.