amazonka-application-autoscaling-1.6.0: Amazon Application Auto Scaling SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.ApplicationAutoScaling.DescribeScheduledActions

Contents

Description

Describes the scheduled actions for the specified service namespace.

You can filter the results using the ResourceId , ScalableDimension , and ScheduledActionNames parameters.

To create a scheduled action or update an existing one, see PutScheduledAction . If you are no longer using a scheduled action, you can delete it using DeleteScheduledAction .

Synopsis

Creating a Request

describeScheduledActions Source #

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

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

  • dsasScalableDimension - The scalable dimension. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID. * ecs:service:DesiredCount - The desired task count of an ECS service. * ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot fleet request. * elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group. * appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet. * dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table. * dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table. * dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index. * dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index. * rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition. * sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.
  • dsasResourceId - The identifier of the resource associated with the scheduled action. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID. * ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: servicedefaultsample-webapp . * Spot fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE . * EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroupj-2EEZNYKUA1NTVig-1791Y4E1L8YI0 . * AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet . * DynamoDB table - The resource type is table and the unique identifier is the resource ID. Example: table/my-table . * DynamoDB global secondary index - The resource type is index and the unique identifier is the resource ID. Example: tablemy-tableindex/my-table-index . * Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster . * Amazon SageMaker endpoint variants - The resource type is variant and the unique identifier is the resource ID. Example: endpointmy-end-pointvariant/KMeansClustering .
  • dsasNextToken - The token for the next set of results.
  • dsasScheduledActionNames - The names of the scheduled actions to describe.
  • dsasMaxResults - The maximum number of scheduled action results. This value can be between 1 and 50. The default value is 50. If this parameter is used, the operation returns up to MaxResults results at a time, along with a NextToken value. To get the next set of results, include the NextToken value in a subsequent call. If this parameter is not used, the operation returns up to 50 results and a NextToken value, if applicable.
  • dsasServiceNamespace - The namespace of the AWS service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference .

data DescribeScheduledActions Source #

See: describeScheduledActions smart constructor.

Instances

Eq DescribeScheduledActions Source # 
Data DescribeScheduledActions Source # 

Methods

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

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

toConstr :: DescribeScheduledActions -> Constr #

dataTypeOf :: DescribeScheduledActions -> DataType #

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

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

gmapT :: (forall b. Data b => b -> b) -> DescribeScheduledActions -> DescribeScheduledActions #

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

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

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

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

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

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

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

Read DescribeScheduledActions Source # 
Show DescribeScheduledActions Source # 
Generic DescribeScheduledActions Source # 
Hashable DescribeScheduledActions Source # 
ToJSON DescribeScheduledActions Source # 
NFData DescribeScheduledActions Source # 
AWSRequest DescribeScheduledActions Source # 
ToHeaders DescribeScheduledActions Source # 
ToPath DescribeScheduledActions Source # 
ToQuery DescribeScheduledActions Source # 
type Rep DescribeScheduledActions Source # 
type Rep DescribeScheduledActions = D1 * (MetaData "DescribeScheduledActions" "Network.AWS.ApplicationAutoScaling.DescribeScheduledActions" "amazonka-application-autoscaling-1.6.0-3HluNhWY524EGALWNNupSJ" False) (C1 * (MetaCons "DescribeScheduledActions'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_dsasScalableDimension") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe ScalableDimension))) ((:*:) * (S1 * (MetaSel (Just Symbol "_dsasResourceId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_dsasNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))) ((:*:) * (S1 * (MetaSel (Just Symbol "_dsasScheduledActionNames") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Text]))) ((:*:) * (S1 * (MetaSel (Just Symbol "_dsasMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int))) (S1 * (MetaSel (Just Symbol "_dsasServiceNamespace") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * ServiceNamespace))))))
type Rs DescribeScheduledActions Source # 

Request Lenses

dsasScalableDimension :: Lens' DescribeScheduledActions (Maybe ScalableDimension) Source #

The scalable dimension. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID. * ecs:service:DesiredCount - The desired task count of an ECS service. * ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot fleet request. * elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group. * appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet. * dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table. * dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table. * dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index. * dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index. * rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition. * sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.

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

The identifier of the resource associated with the scheduled action. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID. * ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: servicedefaultsample-webapp . * Spot fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE . * EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroupj-2EEZNYKUA1NTVig-1791Y4E1L8YI0 . * AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet . * DynamoDB table - The resource type is table and the unique identifier is the resource ID. Example: table/my-table . * DynamoDB global secondary index - The resource type is index and the unique identifier is the resource ID. Example: tablemy-tableindex/my-table-index . * Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster . * Amazon SageMaker endpoint variants - The resource type is variant and the unique identifier is the resource ID. Example: endpointmy-end-pointvariant/KMeansClustering .

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

The token for the next set of results.

dsasScheduledActionNames :: Lens' DescribeScheduledActions [Text] Source #

The names of the scheduled actions to describe.

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

The maximum number of scheduled action results. This value can be between 1 and 50. The default value is 50. If this parameter is used, the operation returns up to MaxResults results at a time, along with a NextToken value. To get the next set of results, include the NextToken value in a subsequent call. If this parameter is not used, the operation returns up to 50 results and a NextToken value, if applicable.

dsasServiceNamespace :: Lens' DescribeScheduledActions ServiceNamespace Source #

The namespace of the AWS service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference .

Destructuring the Response

describeScheduledActionsResponse Source #

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

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

data DescribeScheduledActionsResponse Source #

See: describeScheduledActionsResponse smart constructor.

Instances

Eq DescribeScheduledActionsResponse Source # 
Data DescribeScheduledActionsResponse Source # 

Methods

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

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

toConstr :: DescribeScheduledActionsResponse -> Constr #

dataTypeOf :: DescribeScheduledActionsResponse -> DataType #

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

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

gmapT :: (forall b. Data b => b -> b) -> DescribeScheduledActionsResponse -> DescribeScheduledActionsResponse #

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

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

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

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

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

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

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

Read DescribeScheduledActionsResponse Source # 
Show DescribeScheduledActionsResponse Source # 
Generic DescribeScheduledActionsResponse Source # 
NFData DescribeScheduledActionsResponse Source # 
type Rep DescribeScheduledActionsResponse Source # 
type Rep DescribeScheduledActionsResponse = D1 * (MetaData "DescribeScheduledActionsResponse" "Network.AWS.ApplicationAutoScaling.DescribeScheduledActions" "amazonka-application-autoscaling-1.6.0-3HluNhWY524EGALWNNupSJ" False) (C1 * (MetaCons "DescribeScheduledActionsResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_dsarsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_dsarsScheduledActions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [ScheduledAction]))) (S1 * (MetaSel (Just Symbol "_dsarsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

dsarsNextToken :: Lens' DescribeScheduledActionsResponse (Maybe Text) Source #

The token required to get the next set of results. This value is null if there are no more results to return.