Network.AWS.AutoScaling.ExecutePolicy

Executes the specified policy.

Creating a Request

executePolicy

Arguments

:: Text

epPolicyName

-> ExecutePolicy

Creates a value of ExecutePolicy with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• epHonorCooldown - If this parameter is true, Auto Scaling waits for the cooldown period to complete before executing the policy. Otherwise, Auto Scaling executes the policy without waiting for the cooldown period to complete. This parameter is not supported if the policy type is StepScaling . For more information, see Auto Scaling Cooldowns in the Auto Scaling User Guide .
• epMetricValue - The metric value to compare to BreachThreshold . This enables you to execute a policy of type StepScaling and determine which step adjustment to use. For example, if the breach threshold is 50 and you want to use a step adjustment with a lower bound of 0 and an upper bound of 10, you can set the metric value to 59. If you specify a metric value that doesn't correspond to a step adjustment for the policy, the call returns an error. This parameter is required if the policy type is StepScaling and not supported otherwise.
• epAutoScalingGroupName - The name or Amazon Resource Name (ARN) of the Auto Scaling group.
• epBreachThreshold - The breach threshold for the alarm. This parameter is required if the policy type is StepScaling and not supported otherwise.
• epPolicyName - The name or ARN of the policy.

data ExecutePolicy

Contains the parameters for ExecutePolicy.

See: executePolicy smart constructor.

Instances

Eq ExecutePolicy

Methods

(==) :: ExecutePolicy -> ExecutePolicy -> Bool

(/=) :: ExecutePolicy -> ExecutePolicy -> Bool

Data ExecutePolicy

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ExecutePolicy -> c ExecutePolicy

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ExecutePolicy

toConstr :: ExecutePolicy -> Constr

dataTypeOf :: ExecutePolicy -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ExecutePolicy)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ExecutePolicy)

gmapT :: (forall b. Data b => b -> b) -> ExecutePolicy -> ExecutePolicy

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ExecutePolicy -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ExecutePolicy -> r

gmapQ :: (forall d. Data d => d -> u) -> ExecutePolicy -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ExecutePolicy -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ExecutePolicy -> m ExecutePolicy

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ExecutePolicy -> m ExecutePolicy

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ExecutePolicy -> m ExecutePolicy

Read ExecutePolicy

Methods

readsPrec :: Int -> ReadS ExecutePolicy

readList :: ReadS [ExecutePolicy]

readPrec :: ReadPrec ExecutePolicy

readListPrec :: ReadPrec [ExecutePolicy]

Show ExecutePolicy

Methods

showsPrec :: Int -> ExecutePolicy -> ShowS

show :: ExecutePolicy -> String

showList :: [ExecutePolicy] -> ShowS

Generic ExecutePolicy

Associated Types

type Rep ExecutePolicy :: * -> *

Methods

from :: ExecutePolicy -> Rep ExecutePolicy x

to :: Rep ExecutePolicy x -> ExecutePolicy

Hashable ExecutePolicy

Methods

hashWithSalt :: Int -> ExecutePolicy -> Int

hash :: ExecutePolicy -> Int

NFData ExecutePolicy

Methods

rnf :: ExecutePolicy -> ()

AWSRequest ExecutePolicy

Associated Types

type Rs ExecutePolicy :: *

Methods

request :: ExecutePolicy -> Request ExecutePolicy

response :: MonadResource m => Logger -> Service -> Proxy * ExecutePolicy -> ClientResponse -> m (Response ExecutePolicy)

ToPath ExecutePolicy

Methods

toPath :: ExecutePolicy -> ByteString

ToHeaders ExecutePolicy

Methods

toHeaders :: ExecutePolicy -> [Header]

ToQuery ExecutePolicy

Methods

toQuery :: ExecutePolicy -> QueryString

type Rep ExecutePolicy

type Rep ExecutePolicy = D1 (MetaData "ExecutePolicy" "Network.AWS.AutoScaling.ExecutePolicy" "amazonka-autoscaling-1.4.5-8yDHjz7ddEsEeD2f2YA1qk" False) (C1 (MetaCons "ExecutePolicy'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_epHonorCooldown") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_epMetricValue") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Double)))) ((:*:) (S1 (MetaSel (Just Symbol "_epAutoScalingGroupName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_epBreachThreshold") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Double))) (S1 (MetaSel (Just Symbol "_epPolicyName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))))

type Rs ExecutePolicy

type Rs ExecutePolicy = ExecutePolicyResponse

Request Lenses

epHonorCooldown :: Lens' ExecutePolicy (Maybe Bool)

If this parameter is true, Auto Scaling waits for the cooldown period to complete before executing the policy. Otherwise, Auto Scaling executes the policy without waiting for the cooldown period to complete. This parameter is not supported if the policy type is StepScaling . For more information, see Auto Scaling Cooldowns in the Auto Scaling User Guide .

epMetricValue :: Lens' ExecutePolicy (Maybe Double)

The metric value to compare to BreachThreshold . This enables you to execute a policy of type StepScaling and determine which step adjustment to use. For example, if the breach threshold is 50 and you want to use a step adjustment with a lower bound of 0 and an upper bound of 10, you can set the metric value to 59. If you specify a metric value that doesn't correspond to a step adjustment for the policy, the call returns an error. This parameter is required if the policy type is StepScaling and not supported otherwise.

epAutoScalingGroupName :: Lens' ExecutePolicy (Maybe Text)

The name or Amazon Resource Name (ARN) of the Auto Scaling group.

epBreachThreshold :: Lens' ExecutePolicy (Maybe Double)

The breach threshold for the alarm. This parameter is required if the policy type is StepScaling and not supported otherwise.

epPolicyName :: Lens' ExecutePolicy Text

The name or ARN of the policy.

Destructuring the Response

executePolicyResponse :: ExecutePolicyResponse

Creates a value of ExecutePolicyResponse with the minimum fields required to make a request.

data ExecutePolicyResponse

See: executePolicyResponse smart constructor.

Instances

Eq ExecutePolicyResponse

Methods

(==) :: ExecutePolicyResponse -> ExecutePolicyResponse -> Bool

(/=) :: ExecutePolicyResponse -> ExecutePolicyResponse -> Bool

Data ExecutePolicyResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ExecutePolicyResponse -> c ExecutePolicyResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ExecutePolicyResponse

toConstr :: ExecutePolicyResponse -> Constr

dataTypeOf :: ExecutePolicyResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ExecutePolicyResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ExecutePolicyResponse)

gmapT :: (forall b. Data b => b -> b) -> ExecutePolicyResponse -> ExecutePolicyResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ExecutePolicyResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ExecutePolicyResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> ExecutePolicyResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ExecutePolicyResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ExecutePolicyResponse -> m ExecutePolicyResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ExecutePolicyResponse -> m ExecutePolicyResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ExecutePolicyResponse -> m ExecutePolicyResponse

Read ExecutePolicyResponse

Methods

readsPrec :: Int -> ReadS ExecutePolicyResponse

readList :: ReadS [ExecutePolicyResponse]

readPrec :: ReadPrec ExecutePolicyResponse

readListPrec :: ReadPrec [ExecutePolicyResponse]

Show ExecutePolicyResponse

Methods

showsPrec :: Int -> ExecutePolicyResponse -> ShowS

show :: ExecutePolicyResponse -> String

showList :: [ExecutePolicyResponse] -> ShowS

Generic ExecutePolicyResponse

Associated Types

type Rep ExecutePolicyResponse :: * -> *

Methods

from :: ExecutePolicyResponse -> Rep ExecutePolicyResponse x

to :: Rep ExecutePolicyResponse x -> ExecutePolicyResponse

NFData ExecutePolicyResponse

Methods

rnf :: ExecutePolicyResponse -> ()

type Rep ExecutePolicyResponse

type Rep ExecutePolicyResponse = D1 (MetaData "ExecutePolicyResponse" "Network.AWS.AutoScaling.ExecutePolicy" "amazonka-autoscaling-1.4.5-8yDHjz7ddEsEeD2f2YA1qk" False) (C1 (MetaCons "ExecutePolicyResponse'" PrefixI False) U1)