Network.AWS.ApplicationAutoScaling.DescribeScalableTargets

Gets information about the scalable targets in the specified namespace.

You can filter the results using the ResourceIds and ScalableDimension parameters.

To create a scalable target or update an existing one, see RegisterScalableTarget . If you are no longer using a scalable target, you can deregister it using DeregisterScalableTarget .

This operation returns paginated results.

Creating a Request

describeScalableTargets

Arguments

:: ServiceNamespace

dstServiceNamespace

-> DescribeScalableTargets

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

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

• dstResourceIds - The identifier of the resource associated with the scalable target. 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 .
• dstScalableDimension - The scalable dimension associated with the scalable target. 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.
• dstNextToken - The token for the next set of results.
• dstMaxResults - The maximum number of scalable targets. 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.
• dstServiceNamespace - The namespace of the AWS service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference .

data DescribeScalableTargets

See: describeScalableTargets smart constructor.

Instances

Eq DescribeScalableTargets

Methods

(==) :: DescribeScalableTargets -> DescribeScalableTargets -> Bool

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

Data DescribeScalableTargets

Methods

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

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

toConstr :: DescribeScalableTargets -> Constr

dataTypeOf :: DescribeScalableTargets -> DataType

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

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

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

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

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

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

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

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

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

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

Read DescribeScalableTargets

Methods

readsPrec :: Int -> ReadS DescribeScalableTargets

readList :: ReadS [DescribeScalableTargets]

readPrec :: ReadPrec DescribeScalableTargets

readListPrec :: ReadPrec [DescribeScalableTargets]

Show DescribeScalableTargets

Methods

showsPrec :: Int -> DescribeScalableTargets -> ShowS

show :: DescribeScalableTargets -> String

showList :: [DescribeScalableTargets] -> ShowS

Generic DescribeScalableTargets

Associated Types

type Rep DescribeScalableTargets :: * -> *

Methods

from :: DescribeScalableTargets -> Rep DescribeScalableTargets x

to :: Rep DescribeScalableTargets x -> DescribeScalableTargets

Hashable DescribeScalableTargets

Methods

hashWithSalt :: Int -> DescribeScalableTargets -> Int

hash :: DescribeScalableTargets -> Int

ToJSON DescribeScalableTargets

Methods

toJSON :: DescribeScalableTargets -> Value

toEncoding :: DescribeScalableTargets -> Encoding

toJSONList :: [DescribeScalableTargets] -> Value

toEncodingList :: [DescribeScalableTargets] -> Encoding

NFData DescribeScalableTargets

Methods

rnf :: DescribeScalableTargets -> ()

AWSPager DescribeScalableTargets

Methods

page :: DescribeScalableTargets -> Rs DescribeScalableTargets -> Maybe DescribeScalableTargets

AWSRequest DescribeScalableTargets

Associated Types

type Rs DescribeScalableTargets :: *

Methods

request :: DescribeScalableTargets -> Request DescribeScalableTargets

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * DescribeScalableTargets -> ClientResponse -> m (Response DescribeScalableTargets)

ToHeaders DescribeScalableTargets

Methods

toHeaders :: DescribeScalableTargets -> [Header]

ToPath DescribeScalableTargets

Methods

toPath :: DescribeScalableTargets -> ByteString

ToQuery DescribeScalableTargets

Methods

toQuery :: DescribeScalableTargets -> QueryString

type Rep DescribeScalableTargets

type Rep DescribeScalableTargets = D1 * (MetaData "DescribeScalableTargets" "Network.AWS.ApplicationAutoScaling.DescribeScalableTargets" "amazonka-application-autoscaling-1.6.0-3HluNhWY524EGALWNNupSJ" False) (C1 * (MetaCons "DescribeScalableTargets'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_dstResourceIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Text]))) (S1 * (MetaSel (Just Symbol "_dstScalableDimension") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe ScalableDimension)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_dstNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_dstMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int))) (S1 * (MetaSel (Just Symbol "_dstServiceNamespace") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * ServiceNamespace))))))

type Rs DescribeScalableTargets

type Rs DescribeScalableTargets = DescribeScalableTargetsResponse

Request Lenses

dstResourceIds :: Lens' DescribeScalableTargets [Text]

The identifier of the resource associated with the scalable target. 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 .

dstScalableDimension :: Lens' DescribeScalableTargets (Maybe ScalableDimension)

The scalable dimension associated with the scalable target. 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.

dstNextToken :: Lens' DescribeScalableTargets (Maybe Text)

The token for the next set of results.

dstMaxResults :: Lens' DescribeScalableTargets (Maybe Int)

The maximum number of scalable targets. 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.

dstServiceNamespace :: Lens' DescribeScalableTargets ServiceNamespace

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

Destructuring the Response

describeScalableTargetsResponse

Arguments

:: Int

dstsrsResponseStatus

-> DescribeScalableTargetsResponse

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

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

• dstsrsNextToken - The token required to get the next set of results. This value is null if there are no more results to return.
• dstsrsScalableTargets - The scalable targets that match the request parameters.
• dstsrsResponseStatus - -- | The response status code.

data DescribeScalableTargetsResponse

See: describeScalableTargetsResponse smart constructor.

Instances

Eq DescribeScalableTargetsResponse

Methods

(==) :: DescribeScalableTargetsResponse -> DescribeScalableTargetsResponse -> Bool

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

Data DescribeScalableTargetsResponse

Methods

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

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

toConstr :: DescribeScalableTargetsResponse -> Constr

dataTypeOf :: DescribeScalableTargetsResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read DescribeScalableTargetsResponse

Methods

readsPrec :: Int -> ReadS DescribeScalableTargetsResponse

readList :: ReadS [DescribeScalableTargetsResponse]

readPrec :: ReadPrec DescribeScalableTargetsResponse

readListPrec :: ReadPrec [DescribeScalableTargetsResponse]

Show DescribeScalableTargetsResponse

Methods

showsPrec :: Int -> DescribeScalableTargetsResponse -> ShowS

show :: DescribeScalableTargetsResponse -> String

showList :: [DescribeScalableTargetsResponse] -> ShowS

Generic DescribeScalableTargetsResponse

Associated Types

type Rep DescribeScalableTargetsResponse :: * -> *

Methods

from :: DescribeScalableTargetsResponse -> Rep DescribeScalableTargetsResponse x

to :: Rep DescribeScalableTargetsResponse x -> DescribeScalableTargetsResponse

NFData DescribeScalableTargetsResponse

Methods

rnf :: DescribeScalableTargetsResponse -> ()

type Rep DescribeScalableTargetsResponse

type Rep DescribeScalableTargetsResponse = D1 * (MetaData "DescribeScalableTargetsResponse" "Network.AWS.ApplicationAutoScaling.DescribeScalableTargets" "amazonka-application-autoscaling-1.6.0-3HluNhWY524EGALWNNupSJ" False) (C1 * (MetaCons "DescribeScalableTargetsResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_dstsrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_dstsrsScalableTargets") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [ScalableTarget]))) (S1 * (MetaSel (Just Symbol "_dstsrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

dstsrsNextToken :: Lens' DescribeScalableTargetsResponse (Maybe Text)

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

dstsrsScalableTargets :: Lens' DescribeScalableTargetsResponse [ScalableTarget]

The scalable targets that match the request parameters.

dstsrsResponseStatus :: Lens' DescribeScalableTargetsResponse Int

• - | The response status code.