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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets information about the scheduled actions that haven't run or that have not reached their end time.

To describe the scaling activities for scheduled actions that have already run, call the DescribeScalingActivities API.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeScheduledActions Source #

See: newDescribeScheduledActions smart constructor.

Constructors

DescribeScheduledActions'

Fields

autoScalingGroupName :: Maybe Text
The name of the Auto Scaling group.
endTime :: Maybe ISO8601
The latest scheduled start time to return. If scheduled action names are provided, this property is ignored.
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.)
scheduledActionNames :: Maybe [Text]
The names of one or more scheduled actions. If you omit this property, all scheduled actions are described. If you specify an unknown scheduled action, it is ignored with no error.
Array Members: Maximum number of 50 actions.
startTime :: Maybe ISO8601
The earliest scheduled start time to return. If scheduled action names are provided, this property is ignored.

Instances

Instances details

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

newDescribeScheduledActions :: DescribeScheduledActions Source #

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

DescribeScheduledActions, describeScheduledActions_autoScalingGroupName - The name of the Auto Scaling group.

DescribeScheduledActions, describeScheduledActions_endTime - The latest scheduled start time to return. If scheduled action names are provided, this property is ignored.

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

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

$sel:scheduledActionNames:DescribeScheduledActions', describeScheduledActions_scheduledActionNames - The names of one or more scheduled actions. If you omit this property, all scheduled actions are described. If you specify an unknown scheduled action, it is ignored with no error.

Array Members: Maximum number of 50 actions.

DescribeScheduledActions, describeScheduledActions_startTime - The earliest scheduled start time to return. If scheduled action names are provided, this property is ignored.

Request Lenses

describeScheduledActions_autoScalingGroupName :: Lens' DescribeScheduledActions (Maybe Text) Source #

The name of the Auto Scaling group.

describeScheduledActions_endTime :: Lens' DescribeScheduledActions (Maybe UTCTime) Source #

The latest scheduled start time to return. If scheduled action names are provided, this property is ignored.

describeScheduledActions_maxRecords :: Lens' DescribeScheduledActions (Maybe Int) Source #

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

describeScheduledActions_nextToken :: Lens' DescribeScheduledActions (Maybe Text) Source #

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

describeScheduledActions_scheduledActionNames :: Lens' DescribeScheduledActions (Maybe [Text]) Source #

The names of one or more scheduled actions. If you omit this property, all scheduled actions are described. If you specify an unknown scheduled action, it is ignored with no error.

Array Members: Maximum number of 50 actions.

describeScheduledActions_startTime :: Lens' DescribeScheduledActions (Maybe UTCTime) Source #

The earliest scheduled start time to return. If scheduled action names are provided, this property is ignored.

Destructuring the Response

data DescribeScheduledActionsResponse Source #

See: newDescribeScheduledActionsResponse smart constructor.

Constructors

DescribeScheduledActionsResponse'

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.
scheduledUpdateGroupActions :: Maybe [ScheduledUpdateGroupAction]
The scheduled actions.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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

newDescribeScheduledActionsResponse Source #

Arguments

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

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

DescribeScheduledActions, describeScheduledActionsResponse_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:scheduledUpdateGroupActions:DescribeScheduledActionsResponse', describeScheduledActionsResponse_scheduledUpdateGroupActions - The scheduled actions.

$sel:httpStatus:DescribeScheduledActionsResponse', describeScheduledActionsResponse_httpStatus - The response's http status code.

Response Lenses

describeScheduledActionsResponse_nextToken :: Lens' DescribeScheduledActionsResponse (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.

describeScheduledActionsResponse_scheduledUpdateGroupActions :: Lens' DescribeScheduledActionsResponse (Maybe [ScheduledUpdateGroupAction]) Source #

The scheduled actions.

describeScheduledActionsResponse_httpStatus :: Lens' DescribeScheduledActionsResponse Int Source #

The response's http status code.