Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Describes the Application Auto Scaling scaling policies for the specified service namespace.
You can filter the results using ResourceId
, ScalableDimension
, and
PolicyNames
.
For more information, see Target tracking scaling policies and Step scaling policies in the Application Auto Scaling User Guide.
This operation returns paginated results.
Synopsis
- data DescribeScalingPolicies = DescribeScalingPolicies' {}
- newDescribeScalingPolicies :: ServiceNamespace -> DescribeScalingPolicies
- describeScalingPolicies_policyNames :: Lens' DescribeScalingPolicies (Maybe [Text])
- describeScalingPolicies_scalableDimension :: Lens' DescribeScalingPolicies (Maybe ScalableDimension)
- describeScalingPolicies_resourceId :: Lens' DescribeScalingPolicies (Maybe Text)
- describeScalingPolicies_nextToken :: Lens' DescribeScalingPolicies (Maybe Text)
- describeScalingPolicies_maxResults :: Lens' DescribeScalingPolicies (Maybe Int)
- describeScalingPolicies_serviceNamespace :: Lens' DescribeScalingPolicies ServiceNamespace
- data DescribeScalingPoliciesResponse = DescribeScalingPoliciesResponse' {
- nextToken :: Maybe Text
- scalingPolicies :: Maybe [ScalingPolicy]
- httpStatus :: Int
- newDescribeScalingPoliciesResponse :: Int -> DescribeScalingPoliciesResponse
- describeScalingPoliciesResponse_nextToken :: Lens' DescribeScalingPoliciesResponse (Maybe Text)
- describeScalingPoliciesResponse_scalingPolicies :: Lens' DescribeScalingPoliciesResponse (Maybe [ScalingPolicy])
- describeScalingPoliciesResponse_httpStatus :: Lens' DescribeScalingPoliciesResponse Int
Creating a Request
data DescribeScalingPolicies Source #
See: newDescribeScalingPolicies
smart constructor.
DescribeScalingPolicies' | |
|
Instances
newDescribeScalingPolicies Source #
Create a value of DescribeScalingPolicies
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:policyNames:DescribeScalingPolicies'
, describeScalingPolicies_policyNames
- The names of the scaling policies to describe.
$sel:scalableDimension:DescribeScalingPolicies'
, describeScalingPolicies_scalableDimension
- 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.elasticmapreduce:instancegroup:InstanceCount
- The instance count of an EMR Instance Group.ec2:spot-fleet-request:TargetCapacity
- The target capacity of a Spot Fleet.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 and Aurora PostgreSQL-compatible edition.sagemaker:variant:DesiredInstanceCount
- The number of EC2 instances for an SageMaker model endpoint variant.custom-resource:ResourceType:Property
- The scalable dimension for a custom resource provided by your own application or service.comprehend:document-classifier-endpoint:DesiredInferenceUnits
- The number of inference units for an Amazon Comprehend document classification endpoint.comprehend:entity-recognizer-endpoint:DesiredInferenceUnits
- The number of inference units for an Amazon Comprehend entity recognizer endpoint.lambda:function:ProvisionedConcurrency
- The provisioned concurrency for a Lambda function.cassandra:table:ReadCapacityUnits
- The provisioned read capacity for an Amazon Keyspaces table.cassandra:table:WriteCapacityUnits
- The provisioned write capacity for an Amazon Keyspaces table.kafka:broker-storage:VolumeSize
- The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.elasticache:replication-group:NodeGroups
- The number of node groups for an Amazon ElastiCache replication group.elasticache:replication-group:Replicas
- The number of replicas per node group for an Amazon ElastiCache replication group.neptune:cluster:ReadReplicaCount
- The count of read replicas in an Amazon Neptune DB cluster.
$sel:resourceId:DescribeScalingPolicies'
, describeScalingPolicies_resourceId
- The identifier of the resource associated with the scaling policy. This
string consists of the resource type and unique identifier.
- ECS service - The resource type is
service
and the unique identifier is the cluster name and service name. Example:service/default/sample-webapp
. - Spot Fleet - 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:instancegroup/j-2EEZNYKUA1NTV/ig-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 table name. Example:table/my-table
. - DynamoDB global secondary index - The resource type is
index
and the unique identifier is the index name. Example:table/my-table/index/my-table-index
. - Aurora DB cluster - The resource type is
cluster
and the unique identifier is the cluster name. Example:cluster:my-db-cluster
. - SageMaker endpoint variant - The resource type is
variant
and the unique identifier is the resource ID. Example:endpoint/my-end-point/variant/KMeansClustering
. - Custom resources are not supported with a resource type. This
parameter must specify the
OutputValue
from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository. - Amazon Comprehend document classification endpoint - The resource
type and unique identifier are specified using the endpoint ARN.
Example:
arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE
. - Amazon Comprehend entity recognizer endpoint - The resource type and
unique identifier are specified using the endpoint ARN. Example:
arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE
. - Lambda provisioned concurrency - The resource type is
function
and the unique identifier is the function name with a function version or alias name suffix that is not$LATEST
. Example:function:my-function:prod
orfunction:my-function:1
. - Amazon Keyspaces table - The resource type is
table
and the unique identifier is the table name. Example:keyspace/mykeyspace/table/mytable
. - Amazon MSK cluster - The resource type and unique identifier are
specified using the cluster ARN. Example:
arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5
. - Amazon ElastiCache replication group - The resource type is
replication-group
and the unique identifier is the replication group name. Example:replication-group/mycluster
. - Neptune cluster - The resource type is
cluster
and the unique identifier is the cluster name. Example:cluster:mycluster
.
$sel:nextToken:DescribeScalingPolicies'
, describeScalingPolicies_nextToken
- The token for the next set of results.
$sel:maxResults:DescribeScalingPolicies'
, describeScalingPolicies_maxResults
- The maximum number of scalable targets. This value can be between 1 and
10. The default value is 10.
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 10 results and a
NextToken
value, if applicable.
$sel:serviceNamespace:DescribeScalingPolicies'
, describeScalingPolicies_serviceNamespace
- The namespace of the Amazon Web Services service that provides the
resource. For a resource provided by your own application or service,
use custom-resource
instead.
Request Lenses
describeScalingPolicies_policyNames :: Lens' DescribeScalingPolicies (Maybe [Text]) Source #
The names of the scaling policies to describe.
describeScalingPolicies_scalableDimension :: Lens' DescribeScalingPolicies (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.elasticmapreduce:instancegroup:InstanceCount
- The instance count of an EMR Instance Group.ec2:spot-fleet-request:TargetCapacity
- The target capacity of a Spot Fleet.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 and Aurora PostgreSQL-compatible edition.sagemaker:variant:DesiredInstanceCount
- The number of EC2 instances for an SageMaker model endpoint variant.custom-resource:ResourceType:Property
- The scalable dimension for a custom resource provided by your own application or service.comprehend:document-classifier-endpoint:DesiredInferenceUnits
- The number of inference units for an Amazon Comprehend document classification endpoint.comprehend:entity-recognizer-endpoint:DesiredInferenceUnits
- The number of inference units for an Amazon Comprehend entity recognizer endpoint.lambda:function:ProvisionedConcurrency
- The provisioned concurrency for a Lambda function.cassandra:table:ReadCapacityUnits
- The provisioned read capacity for an Amazon Keyspaces table.cassandra:table:WriteCapacityUnits
- The provisioned write capacity for an Amazon Keyspaces table.kafka:broker-storage:VolumeSize
- The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.elasticache:replication-group:NodeGroups
- The number of node groups for an Amazon ElastiCache replication group.elasticache:replication-group:Replicas
- The number of replicas per node group for an Amazon ElastiCache replication group.neptune:cluster:ReadReplicaCount
- The count of read replicas in an Amazon Neptune DB cluster.
describeScalingPolicies_resourceId :: Lens' DescribeScalingPolicies (Maybe Text) Source #
The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.
- ECS service - The resource type is
service
and the unique identifier is the cluster name and service name. Example:service/default/sample-webapp
. - Spot Fleet - 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:instancegroup/j-2EEZNYKUA1NTV/ig-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 table name. Example:table/my-table
. - DynamoDB global secondary index - The resource type is
index
and the unique identifier is the index name. Example:table/my-table/index/my-table-index
. - Aurora DB cluster - The resource type is
cluster
and the unique identifier is the cluster name. Example:cluster:my-db-cluster
. - SageMaker endpoint variant - The resource type is
variant
and the unique identifier is the resource ID. Example:endpoint/my-end-point/variant/KMeansClustering
. - Custom resources are not supported with a resource type. This
parameter must specify the
OutputValue
from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository. - Amazon Comprehend document classification endpoint - The resource
type and unique identifier are specified using the endpoint ARN.
Example:
arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE
. - Amazon Comprehend entity recognizer endpoint - The resource type and
unique identifier are specified using the endpoint ARN. Example:
arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE
. - Lambda provisioned concurrency - The resource type is
function
and the unique identifier is the function name with a function version or alias name suffix that is not$LATEST
. Example:function:my-function:prod
orfunction:my-function:1
. - Amazon Keyspaces table - The resource type is
table
and the unique identifier is the table name. Example:keyspace/mykeyspace/table/mytable
. - Amazon MSK cluster - The resource type and unique identifier are
specified using the cluster ARN. Example:
arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5
. - Amazon ElastiCache replication group - The resource type is
replication-group
and the unique identifier is the replication group name. Example:replication-group/mycluster
. - Neptune cluster - The resource type is
cluster
and the unique identifier is the cluster name. Example:cluster:mycluster
.
describeScalingPolicies_nextToken :: Lens' DescribeScalingPolicies (Maybe Text) Source #
The token for the next set of results.
describeScalingPolicies_maxResults :: Lens' DescribeScalingPolicies (Maybe Int) Source #
The maximum number of scalable targets. This value can be between 1 and 10. The default value is 10.
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 10 results and a
NextToken
value, if applicable.
describeScalingPolicies_serviceNamespace :: Lens' DescribeScalingPolicies ServiceNamespace Source #
The namespace of the Amazon Web Services service that provides the
resource. For a resource provided by your own application or service,
use custom-resource
instead.
Destructuring the Response
data DescribeScalingPoliciesResponse Source #
See: newDescribeScalingPoliciesResponse
smart constructor.
DescribeScalingPoliciesResponse' | |
|
Instances
newDescribeScalingPoliciesResponse Source #
Create a value of DescribeScalingPoliciesResponse
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:nextToken:DescribeScalingPolicies'
, describeScalingPoliciesResponse_nextToken
- The token required to get the next set of results. This value is null
if there are no more results to return.
$sel:scalingPolicies:DescribeScalingPoliciesResponse'
, describeScalingPoliciesResponse_scalingPolicies
- Information about the scaling policies.
$sel:httpStatus:DescribeScalingPoliciesResponse'
, describeScalingPoliciesResponse_httpStatus
- The response's http status code.
Response Lenses
describeScalingPoliciesResponse_nextToken :: Lens' DescribeScalingPoliciesResponse (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.
describeScalingPoliciesResponse_scalingPolicies :: Lens' DescribeScalingPoliciesResponse (Maybe [ScalingPolicy]) Source #
Information about the scaling policies.
describeScalingPoliciesResponse_httpStatus :: Lens' DescribeScalingPoliciesResponse Int Source #
The response's http status code.