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 |
Synopsis
- deleteScalingPolicy_policyName :: Lens' DeleteScalingPolicy Text
- deleteScalingPolicy_serviceNamespace :: Lens' DeleteScalingPolicy ServiceNamespace
- deleteScalingPolicy_resourceId :: Lens' DeleteScalingPolicy Text
- deleteScalingPolicy_scalableDimension :: Lens' DeleteScalingPolicy ScalableDimension
- deleteScalingPolicyResponse_httpStatus :: Lens' DeleteScalingPolicyResponse Int
- putScalingPolicy_policyType :: Lens' PutScalingPolicy (Maybe PolicyType)
- putScalingPolicy_targetTrackingScalingPolicyConfiguration :: Lens' PutScalingPolicy (Maybe TargetTrackingScalingPolicyConfiguration)
- putScalingPolicy_stepScalingPolicyConfiguration :: Lens' PutScalingPolicy (Maybe StepScalingPolicyConfiguration)
- putScalingPolicy_policyName :: Lens' PutScalingPolicy Text
- putScalingPolicy_serviceNamespace :: Lens' PutScalingPolicy ServiceNamespace
- putScalingPolicy_resourceId :: Lens' PutScalingPolicy Text
- putScalingPolicy_scalableDimension :: Lens' PutScalingPolicy ScalableDimension
- putScalingPolicyResponse_alarms :: Lens' PutScalingPolicyResponse (Maybe [Alarm])
- putScalingPolicyResponse_httpStatus :: Lens' PutScalingPolicyResponse Int
- putScalingPolicyResponse_policyARN :: Lens' PutScalingPolicyResponse Text
- registerScalableTarget_suspendedState :: Lens' RegisterScalableTarget (Maybe SuspendedState)
- registerScalableTarget_maxCapacity :: Lens' RegisterScalableTarget (Maybe Int)
- registerScalableTarget_minCapacity :: Lens' RegisterScalableTarget (Maybe Int)
- registerScalableTarget_roleARN :: Lens' RegisterScalableTarget (Maybe Text)
- registerScalableTarget_serviceNamespace :: Lens' RegisterScalableTarget ServiceNamespace
- registerScalableTarget_resourceId :: Lens' RegisterScalableTarget Text
- registerScalableTarget_scalableDimension :: Lens' RegisterScalableTarget ScalableDimension
- registerScalableTargetResponse_httpStatus :: Lens' RegisterScalableTargetResponse Int
- 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
- describeScalingPoliciesResponse_nextToken :: Lens' DescribeScalingPoliciesResponse (Maybe Text)
- describeScalingPoliciesResponse_scalingPolicies :: Lens' DescribeScalingPoliciesResponse (Maybe [ScalingPolicy])
- describeScalingPoliciesResponse_httpStatus :: Lens' DescribeScalingPoliciesResponse Int
- putScheduledAction_startTime :: Lens' PutScheduledAction (Maybe UTCTime)
- putScheduledAction_schedule :: Lens' PutScheduledAction (Maybe Text)
- putScheduledAction_endTime :: Lens' PutScheduledAction (Maybe UTCTime)
- putScheduledAction_scalableTargetAction :: Lens' PutScheduledAction (Maybe ScalableTargetAction)
- putScheduledAction_timezone :: Lens' PutScheduledAction (Maybe Text)
- putScheduledAction_serviceNamespace :: Lens' PutScheduledAction ServiceNamespace
- putScheduledAction_scheduledActionName :: Lens' PutScheduledAction Text
- putScheduledAction_resourceId :: Lens' PutScheduledAction Text
- putScheduledAction_scalableDimension :: Lens' PutScheduledAction ScalableDimension
- putScheduledActionResponse_httpStatus :: Lens' PutScheduledActionResponse Int
- deleteScheduledAction_serviceNamespace :: Lens' DeleteScheduledAction ServiceNamespace
- deleteScheduledAction_scheduledActionName :: Lens' DeleteScheduledAction Text
- deleteScheduledAction_resourceId :: Lens' DeleteScheduledAction Text
- deleteScheduledAction_scalableDimension :: Lens' DeleteScheduledAction ScalableDimension
- deleteScheduledActionResponse_httpStatus :: Lens' DeleteScheduledActionResponse Int
- describeScheduledActions_scalableDimension :: Lens' DescribeScheduledActions (Maybe ScalableDimension)
- describeScheduledActions_resourceId :: Lens' DescribeScheduledActions (Maybe Text)
- describeScheduledActions_nextToken :: Lens' DescribeScheduledActions (Maybe Text)
- describeScheduledActions_scheduledActionNames :: Lens' DescribeScheduledActions (Maybe [Text])
- describeScheduledActions_maxResults :: Lens' DescribeScheduledActions (Maybe Int)
- describeScheduledActions_serviceNamespace :: Lens' DescribeScheduledActions ServiceNamespace
- describeScheduledActionsResponse_nextToken :: Lens' DescribeScheduledActionsResponse (Maybe Text)
- describeScheduledActionsResponse_scheduledActions :: Lens' DescribeScheduledActionsResponse (Maybe [ScheduledAction])
- describeScheduledActionsResponse_httpStatus :: Lens' DescribeScheduledActionsResponse Int
- describeScalableTargets_resourceIds :: Lens' DescribeScalableTargets (Maybe [Text])
- describeScalableTargets_scalableDimension :: Lens' DescribeScalableTargets (Maybe ScalableDimension)
- describeScalableTargets_nextToken :: Lens' DescribeScalableTargets (Maybe Text)
- describeScalableTargets_maxResults :: Lens' DescribeScalableTargets (Maybe Int)
- describeScalableTargets_serviceNamespace :: Lens' DescribeScalableTargets ServiceNamespace
- describeScalableTargetsResponse_nextToken :: Lens' DescribeScalableTargetsResponse (Maybe Text)
- describeScalableTargetsResponse_scalableTargets :: Lens' DescribeScalableTargetsResponse (Maybe [ScalableTarget])
- describeScalableTargetsResponse_httpStatus :: Lens' DescribeScalableTargetsResponse Int
- describeScalingActivities_scalableDimension :: Lens' DescribeScalingActivities (Maybe ScalableDimension)
- describeScalingActivities_resourceId :: Lens' DescribeScalingActivities (Maybe Text)
- describeScalingActivities_nextToken :: Lens' DescribeScalingActivities (Maybe Text)
- describeScalingActivities_maxResults :: Lens' DescribeScalingActivities (Maybe Int)
- describeScalingActivities_serviceNamespace :: Lens' DescribeScalingActivities ServiceNamespace
- describeScalingActivitiesResponse_scalingActivities :: Lens' DescribeScalingActivitiesResponse (Maybe [ScalingActivity])
- describeScalingActivitiesResponse_nextToken :: Lens' DescribeScalingActivitiesResponse (Maybe Text)
- describeScalingActivitiesResponse_httpStatus :: Lens' DescribeScalingActivitiesResponse Int
- deregisterScalableTarget_serviceNamespace :: Lens' DeregisterScalableTarget ServiceNamespace
- deregisterScalableTarget_resourceId :: Lens' DeregisterScalableTarget Text
- deregisterScalableTarget_scalableDimension :: Lens' DeregisterScalableTarget ScalableDimension
- deregisterScalableTargetResponse_httpStatus :: Lens' DeregisterScalableTargetResponse Int
- alarm_alarmName :: Lens' Alarm Text
- alarm_alarmARN :: Lens' Alarm Text
- customizedMetricSpecification_dimensions :: Lens' CustomizedMetricSpecification (Maybe [MetricDimension])
- customizedMetricSpecification_unit :: Lens' CustomizedMetricSpecification (Maybe Text)
- customizedMetricSpecification_metricName :: Lens' CustomizedMetricSpecification Text
- customizedMetricSpecification_namespace :: Lens' CustomizedMetricSpecification Text
- customizedMetricSpecification_statistic :: Lens' CustomizedMetricSpecification MetricStatistic
- metricDimension_name :: Lens' MetricDimension Text
- metricDimension_value :: Lens' MetricDimension Text
- predefinedMetricSpecification_resourceLabel :: Lens' PredefinedMetricSpecification (Maybe Text)
- predefinedMetricSpecification_predefinedMetricType :: Lens' PredefinedMetricSpecification MetricType
- scalableTarget_suspendedState :: Lens' ScalableTarget (Maybe SuspendedState)
- scalableTarget_serviceNamespace :: Lens' ScalableTarget ServiceNamespace
- scalableTarget_resourceId :: Lens' ScalableTarget Text
- scalableTarget_scalableDimension :: Lens' ScalableTarget ScalableDimension
- scalableTarget_minCapacity :: Lens' ScalableTarget Int
- scalableTarget_maxCapacity :: Lens' ScalableTarget Int
- scalableTarget_roleARN :: Lens' ScalableTarget Text
- scalableTarget_creationTime :: Lens' ScalableTarget UTCTime
- scalableTargetAction_maxCapacity :: Lens' ScalableTargetAction (Maybe Int)
- scalableTargetAction_minCapacity :: Lens' ScalableTargetAction (Maybe Int)
- scalingActivity_statusMessage :: Lens' ScalingActivity (Maybe Text)
- scalingActivity_endTime :: Lens' ScalingActivity (Maybe UTCTime)
- scalingActivity_details :: Lens' ScalingActivity (Maybe Text)
- scalingActivity_activityId :: Lens' ScalingActivity Text
- scalingActivity_serviceNamespace :: Lens' ScalingActivity ServiceNamespace
- scalingActivity_resourceId :: Lens' ScalingActivity Text
- scalingActivity_scalableDimension :: Lens' ScalingActivity ScalableDimension
- scalingActivity_description :: Lens' ScalingActivity Text
- scalingActivity_cause :: Lens' ScalingActivity Text
- scalingActivity_startTime :: Lens' ScalingActivity UTCTime
- scalingActivity_statusCode :: Lens' ScalingActivity ScalingActivityStatusCode
- scalingPolicy_targetTrackingScalingPolicyConfiguration :: Lens' ScalingPolicy (Maybe TargetTrackingScalingPolicyConfiguration)
- scalingPolicy_stepScalingPolicyConfiguration :: Lens' ScalingPolicy (Maybe StepScalingPolicyConfiguration)
- scalingPolicy_alarms :: Lens' ScalingPolicy (Maybe [Alarm])
- scalingPolicy_policyARN :: Lens' ScalingPolicy Text
- scalingPolicy_policyName :: Lens' ScalingPolicy Text
- scalingPolicy_serviceNamespace :: Lens' ScalingPolicy ServiceNamespace
- scalingPolicy_resourceId :: Lens' ScalingPolicy Text
- scalingPolicy_scalableDimension :: Lens' ScalingPolicy ScalableDimension
- scalingPolicy_policyType :: Lens' ScalingPolicy PolicyType
- scalingPolicy_creationTime :: Lens' ScalingPolicy UTCTime
- scheduledAction_scalableDimension :: Lens' ScheduledAction (Maybe ScalableDimension)
- scheduledAction_startTime :: Lens' ScheduledAction (Maybe UTCTime)
- scheduledAction_endTime :: Lens' ScheduledAction (Maybe UTCTime)
- scheduledAction_scalableTargetAction :: Lens' ScheduledAction (Maybe ScalableTargetAction)
- scheduledAction_timezone :: Lens' ScheduledAction (Maybe Text)
- scheduledAction_scheduledActionName :: Lens' ScheduledAction Text
- scheduledAction_scheduledActionARN :: Lens' ScheduledAction Text
- scheduledAction_serviceNamespace :: Lens' ScheduledAction ServiceNamespace
- scheduledAction_schedule :: Lens' ScheduledAction Text
- scheduledAction_resourceId :: Lens' ScheduledAction Text
- scheduledAction_creationTime :: Lens' ScheduledAction UTCTime
- stepAdjustment_metricIntervalLowerBound :: Lens' StepAdjustment (Maybe Double)
- stepAdjustment_metricIntervalUpperBound :: Lens' StepAdjustment (Maybe Double)
- stepAdjustment_scalingAdjustment :: Lens' StepAdjustment Int
- stepScalingPolicyConfiguration_stepAdjustments :: Lens' StepScalingPolicyConfiguration (Maybe [StepAdjustment])
- stepScalingPolicyConfiguration_adjustmentType :: Lens' StepScalingPolicyConfiguration (Maybe AdjustmentType)
- stepScalingPolicyConfiguration_cooldown :: Lens' StepScalingPolicyConfiguration (Maybe Int)
- stepScalingPolicyConfiguration_metricAggregationType :: Lens' StepScalingPolicyConfiguration (Maybe MetricAggregationType)
- stepScalingPolicyConfiguration_minAdjustmentMagnitude :: Lens' StepScalingPolicyConfiguration (Maybe Int)
- suspendedState_dynamicScalingInSuspended :: Lens' SuspendedState (Maybe Bool)
- suspendedState_scheduledScalingSuspended :: Lens' SuspendedState (Maybe Bool)
- suspendedState_dynamicScalingOutSuspended :: Lens' SuspendedState (Maybe Bool)
- targetTrackingScalingPolicyConfiguration_predefinedMetricSpecification :: Lens' TargetTrackingScalingPolicyConfiguration (Maybe PredefinedMetricSpecification)
- targetTrackingScalingPolicyConfiguration_scaleInCooldown :: Lens' TargetTrackingScalingPolicyConfiguration (Maybe Int)
- targetTrackingScalingPolicyConfiguration_customizedMetricSpecification :: Lens' TargetTrackingScalingPolicyConfiguration (Maybe CustomizedMetricSpecification)
- targetTrackingScalingPolicyConfiguration_disableScaleIn :: Lens' TargetTrackingScalingPolicyConfiguration (Maybe Bool)
- targetTrackingScalingPolicyConfiguration_scaleOutCooldown :: Lens' TargetTrackingScalingPolicyConfiguration (Maybe Int)
- targetTrackingScalingPolicyConfiguration_targetValue :: Lens' TargetTrackingScalingPolicyConfiguration Double
Operations
DeleteScalingPolicy
deleteScalingPolicy_policyName :: Lens' DeleteScalingPolicy Text Source #
The name of the scaling policy.
deleteScalingPolicy_serviceNamespace :: Lens' DeleteScalingPolicy 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.
deleteScalingPolicy_resourceId :: Lens' DeleteScalingPolicy Text Source #
The identifier of the resource associated with the scalable target. 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
.
deleteScalingPolicy_scalableDimension :: Lens' DeleteScalingPolicy ScalableDimension Source #
The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
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.
deleteScalingPolicyResponse_httpStatus :: Lens' DeleteScalingPolicyResponse Int Source #
The response's http status code.
PutScalingPolicy
putScalingPolicy_policyType :: Lens' PutScalingPolicy (Maybe PolicyType) Source #
The policy type. This parameter is required if you are creating a scaling policy.
The following policy types are supported:
TargetTrackingScaling
—Not supported for Amazon EMR
StepScaling
—Not supported for DynamoDB, Amazon Comprehend, Lambda,
Amazon Keyspaces, Amazon MSK, Amazon ElastiCache, or Neptune.
For more information, see Target tracking scaling policies and Step scaling policies in the Application Auto Scaling User Guide.
putScalingPolicy_targetTrackingScalingPolicyConfiguration :: Lens' PutScalingPolicy (Maybe TargetTrackingScalingPolicyConfiguration) Source #
A target tracking scaling policy. Includes support for predefined or customized metrics.
This parameter is required if you are creating a policy and the policy
type is TargetTrackingScaling
.
putScalingPolicy_stepScalingPolicyConfiguration :: Lens' PutScalingPolicy (Maybe StepScalingPolicyConfiguration) Source #
A step scaling policy.
This parameter is required if you are creating a policy and the policy
type is StepScaling
.
putScalingPolicy_policyName :: Lens' PutScalingPolicy Text Source #
The name of the scaling policy.
putScalingPolicy_serviceNamespace :: Lens' PutScalingPolicy 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.
putScalingPolicy_resourceId :: Lens' PutScalingPolicy 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
.
putScalingPolicy_scalableDimension :: Lens' PutScalingPolicy ScalableDimension Source #
The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
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.
putScalingPolicyResponse_alarms :: Lens' PutScalingPolicyResponse (Maybe [Alarm]) Source #
The CloudWatch alarms created for the target tracking scaling policy.
putScalingPolicyResponse_httpStatus :: Lens' PutScalingPolicyResponse Int Source #
The response's http status code.
putScalingPolicyResponse_policyARN :: Lens' PutScalingPolicyResponse Text Source #
The Amazon Resource Name (ARN) of the resulting scaling policy.
RegisterScalableTarget
registerScalableTarget_suspendedState :: Lens' RegisterScalableTarget (Maybe SuspendedState) Source #
An embedded object that contains attributes and attribute values that
are used to suspend and resume automatic scaling. Setting the value of
an attribute to true
suspends the specified scaling activities.
Setting it to false
(default) resumes the specified scaling
activities.
Suspension Outcomes
- For
DynamicScalingInSuspended
, while a suspension is in effect, all scale-in activities that are triggered by a scaling policy are suspended. - For
DynamicScalingOutSuspended
, while a suspension is in effect, all scale-out activities that are triggered by a scaling policy are suspended. - For
ScheduledScalingSuspended
, while a suspension is in effect, all scaling activities that involve scheduled actions are suspended.
For more information, see Suspending and resuming scaling in the Application Auto Scaling User Guide.
registerScalableTarget_maxCapacity :: Lens' RegisterScalableTarget (Maybe Int) Source #
The maximum value that you plan to scale out to. When a scaling policy is in effect, Application Auto Scaling can scale out (expand) as needed to the maximum capacity limit in response to changing demand. This property is required when registering a new scalable target.
Although you can specify a large maximum capacity, note that service quotas may impose lower limits. Each service has its own default quotas for the maximum capacity of the resource. If you want to specify a higher limit, you can request an increase. For more information, consult the documentation for that service. For information about the default quotas for each service, see Service Endpoints and Quotas in the Amazon Web Services General Reference.
registerScalableTarget_minCapacity :: Lens' RegisterScalableTarget (Maybe Int) Source #
The minimum value that you plan to scale in to. When a scaling policy is in effect, Application Auto Scaling can scale in (contract) as needed to the minimum capacity limit in response to changing demand. This property is required when registering a new scalable target.
For certain resources, the minimum value allowed is 0. This includes Lambda provisioned concurrency, Spot Fleet, ECS services, Aurora DB clusters, EMR clusters, and custom resources. For all other resources, the minimum value allowed is 1.
registerScalableTarget_roleARN :: Lens' RegisterScalableTarget (Maybe Text) Source #
This parameter is required for services that do not support service-linked roles (such as Amazon EMR), and it must specify the ARN of an IAM role that allows Application Auto Scaling to modify the scalable target on your behalf.
If the service supports service-linked roles, Application Auto Scaling uses a service-linked role, which it creates if it does not yet exist. For more information, see Application Auto Scaling IAM roles.
registerScalableTarget_serviceNamespace :: Lens' RegisterScalableTarget 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.
registerScalableTarget_resourceId :: Lens' RegisterScalableTarget Text Source #
The identifier of the resource that is associated with the scalable target. 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
.
registerScalableTarget_scalableDimension :: Lens' RegisterScalableTarget ScalableDimension Source #
The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.
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.
registerScalableTargetResponse_httpStatus :: Lens' RegisterScalableTargetResponse Int Source #
The response's http status code.
DescribeScalingPolicies
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.
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.
PutScheduledAction
putScheduledAction_startTime :: Lens' PutScheduledAction (Maybe UTCTime) Source #
The date and time for this scheduled action to start, in UTC.
putScheduledAction_schedule :: Lens' PutScheduledAction (Maybe Text) Source #
The schedule for this action. The following formats are supported:
- At expressions - "
at(yyyy-mm-ddThh:mm:ss)
" - Rate expressions - "
rate(value unit)
" - Cron expressions - "
cron(fields)
"
At expressions are useful for one-time schedules. Cron expressions are useful for scheduled actions that run periodically at a specified date and time, and rate expressions are useful for scheduled actions that run at a regular interval.
At and cron expressions use Universal Coordinated Time (UTC) by default.
The cron format consists of six fields separated by white spaces: [Minutes] [Hours] [Day_of_Month] [Month] [Day_of_Week] [Year].
For rate expressions, value is a positive integer and unit is
minute
| minutes
| hour
| hours
| day
| days
.
For more information and examples, see Example scheduled actions for Application Auto Scaling in the Application Auto Scaling User Guide.
putScheduledAction_endTime :: Lens' PutScheduledAction (Maybe UTCTime) Source #
The date and time for the recurring schedule to end, in UTC.
putScheduledAction_scalableTargetAction :: Lens' PutScheduledAction (Maybe ScalableTargetAction) Source #
The new minimum and maximum capacity. You can set both values or just one. At the scheduled time, if the current capacity is below the minimum capacity, Application Auto Scaling scales out to the minimum capacity. If the current capacity is above the maximum capacity, Application Auto Scaling scales in to the maximum capacity.
putScheduledAction_timezone :: Lens' PutScheduledAction (Maybe Text) Source #
Specifies the time zone used when setting a scheduled action by using an at or cron expression. If a time zone is not provided, UTC is used by default.
Valid values are the canonical names of the IANA time zones supported by
Joda-Time (such as Etc/GMT+9
or Pacific/Tahiti
). For more
information, see https://www.joda.org/joda-time/timezones.html.
putScheduledAction_serviceNamespace :: Lens' PutScheduledAction 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.
putScheduledAction_scheduledActionName :: Lens' PutScheduledAction Text Source #
The name of the scheduled action. This name must be unique among all other scheduled actions on the specified scalable target.
putScheduledAction_resourceId :: Lens' PutScheduledAction Text Source #
The identifier of the resource associated with the scheduled action. 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
.
putScheduledAction_scalableDimension :: Lens' PutScheduledAction ScalableDimension Source #
The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
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.
putScheduledActionResponse_httpStatus :: Lens' PutScheduledActionResponse Int Source #
The response's http status code.
DeleteScheduledAction
deleteScheduledAction_serviceNamespace :: Lens' DeleteScheduledAction 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.
deleteScheduledAction_scheduledActionName :: Lens' DeleteScheduledAction Text Source #
The name of the scheduled action.
deleteScheduledAction_resourceId :: Lens' DeleteScheduledAction Text Source #
The identifier of the resource associated with the scheduled action. 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
.
deleteScheduledAction_scalableDimension :: Lens' DeleteScheduledAction ScalableDimension Source #
The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
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.
deleteScheduledActionResponse_httpStatus :: Lens' DeleteScheduledActionResponse Int Source #
The response's http status code.
DescribeScheduledActions
describeScheduledActions_scalableDimension :: 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.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.
describeScheduledActions_resourceId :: 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.
- 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
.
describeScheduledActions_nextToken :: Lens' DescribeScheduledActions (Maybe Text) Source #
The token for the next set of results.
describeScheduledActions_scheduledActionNames :: Lens' DescribeScheduledActions (Maybe [Text]) Source #
The names of the scheduled actions to describe.
describeScheduledActions_maxResults :: 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.
describeScheduledActions_serviceNamespace :: Lens' DescribeScheduledActions 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.
describeScheduledActionsResponse_nextToken :: 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.
describeScheduledActionsResponse_scheduledActions :: Lens' DescribeScheduledActionsResponse (Maybe [ScheduledAction]) Source #
Information about the scheduled actions.
describeScheduledActionsResponse_httpStatus :: Lens' DescribeScheduledActionsResponse Int Source #
The response's http status code.
DescribeScalableTargets
describeScalableTargets_resourceIds :: Lens' DescribeScalableTargets (Maybe [Text]) Source #
The identifier of the resource associated with the scalable target. 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
.
describeScalableTargets_scalableDimension :: Lens' DescribeScalableTargets (Maybe ScalableDimension) Source #
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.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.
describeScalableTargets_nextToken :: Lens' DescribeScalableTargets (Maybe Text) Source #
The token for the next set of results.
describeScalableTargets_maxResults :: Lens' DescribeScalableTargets (Maybe Int) Source #
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.
describeScalableTargets_serviceNamespace :: Lens' DescribeScalableTargets 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.
describeScalableTargetsResponse_nextToken :: Lens' DescribeScalableTargetsResponse (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.
describeScalableTargetsResponse_scalableTargets :: Lens' DescribeScalableTargetsResponse (Maybe [ScalableTarget]) Source #
The scalable targets that match the request parameters.
describeScalableTargetsResponse_httpStatus :: Lens' DescribeScalableTargetsResponse Int Source #
The response's http status code.
DescribeScalingActivities
describeScalingActivities_scalableDimension :: Lens' DescribeScalingActivities (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.
describeScalingActivities_resourceId :: Lens' DescribeScalingActivities (Maybe Text) Source #
The identifier of the resource associated with the scaling activity. 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
.
describeScalingActivities_nextToken :: Lens' DescribeScalingActivities (Maybe Text) Source #
The token for the next set of results.
describeScalingActivities_maxResults :: Lens' DescribeScalingActivities (Maybe Int) Source #
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.
describeScalingActivities_serviceNamespace :: Lens' DescribeScalingActivities 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.
describeScalingActivitiesResponse_scalingActivities :: Lens' DescribeScalingActivitiesResponse (Maybe [ScalingActivity]) Source #
A list of scaling activity objects.
describeScalingActivitiesResponse_nextToken :: Lens' DescribeScalingActivitiesResponse (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.
describeScalingActivitiesResponse_httpStatus :: Lens' DescribeScalingActivitiesResponse Int Source #
The response's http status code.
DeregisterScalableTarget
deregisterScalableTarget_serviceNamespace :: Lens' DeregisterScalableTarget 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.
deregisterScalableTarget_resourceId :: Lens' DeregisterScalableTarget Text Source #
The identifier of the resource associated with the scalable target. 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
.
deregisterScalableTarget_scalableDimension :: Lens' DeregisterScalableTarget ScalableDimension Source #
The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.
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.
deregisterScalableTargetResponse_httpStatus :: Lens' DeregisterScalableTargetResponse Int Source #
The response's http status code.
Types
Alarm
CustomizedMetricSpecification
customizedMetricSpecification_dimensions :: Lens' CustomizedMetricSpecification (Maybe [MetricDimension]) Source #
The dimensions of the metric.
Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.
customizedMetricSpecification_unit :: Lens' CustomizedMetricSpecification (Maybe Text) Source #
The unit of the metric.
customizedMetricSpecification_metricName :: Lens' CustomizedMetricSpecification Text Source #
The name of the metric.
customizedMetricSpecification_namespace :: Lens' CustomizedMetricSpecification Text Source #
The namespace of the metric.
customizedMetricSpecification_statistic :: Lens' CustomizedMetricSpecification MetricStatistic Source #
The statistic of the metric.
MetricDimension
metricDimension_name :: Lens' MetricDimension Text Source #
The name of the dimension.
metricDimension_value :: Lens' MetricDimension Text Source #
The value of the dimension.
PredefinedMetricSpecification
predefinedMetricSpecification_resourceLabel :: Lens' PredefinedMetricSpecification (Maybe Text) Source #
Identifies the resource associated with the metric type. You can't
specify a resource label unless the metric type is
ALBRequestCountPerTarget
and there is a target group attached to the
Spot Fleet request or ECS service.
You create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). The format of the resource label is:
app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff
.
Where:
- app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN
- targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group ARN.
To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.
predefinedMetricSpecification_predefinedMetricType :: Lens' PredefinedMetricSpecification MetricType Source #
The metric type. The ALBRequestCountPerTarget
metric type applies only
to Spot Fleet requests and ECS services.
ScalableTarget
scalableTarget_suspendedState :: Lens' ScalableTarget (Maybe SuspendedState) Source #
Undocumented member.
scalableTarget_serviceNamespace :: Lens' ScalableTarget ServiceNamespace Source #
The namespace of the Amazon Web Services service that provides the
resource, or a custom-resource
.
scalableTarget_resourceId :: Lens' ScalableTarget Text Source #
The identifier of the resource associated with the scalable target. 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
.
scalableTarget_scalableDimension :: Lens' ScalableTarget ScalableDimension Source #
The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.
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.
scalableTarget_minCapacity :: Lens' ScalableTarget Int Source #
The minimum value to scale to in response to a scale-in activity.
scalableTarget_maxCapacity :: Lens' ScalableTarget Int Source #
The maximum value to scale to in response to a scale-out activity.
scalableTarget_roleARN :: Lens' ScalableTarget Text Source #
The ARN of an IAM role that allows Application Auto Scaling to modify the scalable target on your behalf.
scalableTarget_creationTime :: Lens' ScalableTarget UTCTime Source #
The Unix timestamp for when the scalable target was created.
ScalableTargetAction
scalableTargetAction_maxCapacity :: Lens' ScalableTargetAction (Maybe Int) Source #
The maximum capacity.
Although you can specify a large maximum capacity, note that service quotas may impose lower limits. Each service has its own default quotas for the maximum capacity of the resource. If you want to specify a higher limit, you can request an increase. For more information, consult the documentation for that service. For information about the default quotas for each service, see Service Endpoints and Quotas in the Amazon Web Services General Reference.
scalableTargetAction_minCapacity :: Lens' ScalableTargetAction (Maybe Int) Source #
The minimum capacity.
For certain resources, the minimum value allowed is 0. This includes Lambda provisioned concurrency, Spot Fleet, ECS services, Aurora DB clusters, EMR clusters, and custom resources. For all other resources, the minimum value allowed is 1.
ScalingActivity
scalingActivity_statusMessage :: Lens' ScalingActivity (Maybe Text) Source #
A simple message about the current status of the scaling activity.
scalingActivity_endTime :: Lens' ScalingActivity (Maybe UTCTime) Source #
The Unix timestamp for when the scaling activity ended.
scalingActivity_details :: Lens' ScalingActivity (Maybe Text) Source #
The details about the scaling activity.
scalingActivity_activityId :: Lens' ScalingActivity Text Source #
The unique identifier of the scaling activity.
scalingActivity_serviceNamespace :: Lens' ScalingActivity ServiceNamespace Source #
The namespace of the Amazon Web Services service that provides the
resource, or a custom-resource
.
scalingActivity_resourceId :: Lens' ScalingActivity Text Source #
The identifier of the resource associated with the scaling activity. 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
.
scalingActivity_scalableDimension :: Lens' ScalingActivity ScalableDimension Source #
The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
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.
scalingActivity_description :: Lens' ScalingActivity Text Source #
A simple description of what action the scaling activity intends to accomplish.
scalingActivity_cause :: Lens' ScalingActivity Text Source #
A simple description of what caused the scaling activity to happen.
scalingActivity_startTime :: Lens' ScalingActivity UTCTime Source #
The Unix timestamp for when the scaling activity began.
scalingActivity_statusCode :: Lens' ScalingActivity ScalingActivityStatusCode Source #
Indicates the status of the scaling activity.
ScalingPolicy
scalingPolicy_targetTrackingScalingPolicyConfiguration :: Lens' ScalingPolicy (Maybe TargetTrackingScalingPolicyConfiguration) Source #
A target tracking scaling policy.
scalingPolicy_stepScalingPolicyConfiguration :: Lens' ScalingPolicy (Maybe StepScalingPolicyConfiguration) Source #
A step scaling policy.
scalingPolicy_alarms :: Lens' ScalingPolicy (Maybe [Alarm]) Source #
The CloudWatch alarms associated with the scaling policy.
scalingPolicy_policyARN :: Lens' ScalingPolicy Text Source #
The Amazon Resource Name (ARN) of the scaling policy.
scalingPolicy_policyName :: Lens' ScalingPolicy Text Source #
The name of the scaling policy.
scalingPolicy_serviceNamespace :: Lens' ScalingPolicy ServiceNamespace Source #
The namespace of the Amazon Web Services service that provides the
resource, or a custom-resource
.
scalingPolicy_resourceId :: Lens' ScalingPolicy 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
.
scalingPolicy_scalableDimension :: Lens' ScalingPolicy ScalableDimension Source #
The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
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.
scalingPolicy_policyType :: Lens' ScalingPolicy PolicyType Source #
The scaling policy type.
scalingPolicy_creationTime :: Lens' ScalingPolicy UTCTime Source #
The Unix timestamp for when the scaling policy was created.
ScheduledAction
scheduledAction_scalableDimension :: Lens' ScheduledAction (Maybe ScalableDimension) Source #
The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
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.
scheduledAction_startTime :: Lens' ScheduledAction (Maybe UTCTime) Source #
The date and time that the action is scheduled to begin, in UTC.
scheduledAction_endTime :: Lens' ScheduledAction (Maybe UTCTime) Source #
The date and time that the action is scheduled to end, in UTC.
scheduledAction_scalableTargetAction :: Lens' ScheduledAction (Maybe ScalableTargetAction) Source #
The new minimum and maximum capacity. You can set both values or just one. At the scheduled time, if the current capacity is below the minimum capacity, Application Auto Scaling scales out to the minimum capacity. If the current capacity is above the maximum capacity, Application Auto Scaling scales in to the maximum capacity.
scheduledAction_timezone :: Lens' ScheduledAction (Maybe Text) Source #
The time zone used when referring to the date and time of a scheduled action, when the scheduled action uses an at or cron expression.
scheduledAction_scheduledActionName :: Lens' ScheduledAction Text Source #
The name of the scheduled action.
scheduledAction_scheduledActionARN :: Lens' ScheduledAction Text Source #
The Amazon Resource Name (ARN) of the scheduled action.
scheduledAction_serviceNamespace :: Lens' ScheduledAction ServiceNamespace Source #
The namespace of the Amazon Web Services service that provides the
resource, or a custom-resource
.
scheduledAction_schedule :: Lens' ScheduledAction Text Source #
The schedule for this action. The following formats are supported:
- At expressions - "
at(yyyy-mm-ddThh:mm:ss)
" - Rate expressions - "
rate(value unit)
" - Cron expressions - "
cron(fields)
"
At expressions are useful for one-time schedules. Cron expressions are useful for scheduled actions that run periodically at a specified date and time, and rate expressions are useful for scheduled actions that run at a regular interval.
At and cron expressions use Universal Coordinated Time (UTC) by default.
The cron format consists of six fields separated by white spaces: [Minutes] [Hours] [Day_of_Month] [Month] [Day_of_Week] [Year].
For rate expressions, value is a positive integer and unit is
minute
| minutes
| hour
| hours
| day
| days
.
For more information and examples, see Example scheduled actions for Application Auto Scaling in the Application Auto Scaling User Guide.
scheduledAction_resourceId :: Lens' ScheduledAction 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
.
scheduledAction_creationTime :: Lens' ScheduledAction UTCTime Source #
The date and time that the scheduled action was created.
StepAdjustment
stepAdjustment_metricIntervalLowerBound :: Lens' StepAdjustment (Maybe Double) Source #
The lower bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the lower bound is inclusive (the metric must be greater than or equal to the threshold plus the lower bound). Otherwise, it is exclusive (the metric must be greater than the threshold plus the lower bound). A null value indicates negative infinity.
stepAdjustment_metricIntervalUpperBound :: Lens' StepAdjustment (Maybe Double) Source #
The upper bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the upper bound is exclusive (the metric must be less than the threshold plus the upper bound). Otherwise, it is inclusive (the metric must be less than or equal to the threshold plus the upper bound). A null value indicates positive infinity.
The upper bound must be greater than the lower bound.
stepAdjustment_scalingAdjustment :: Lens' StepAdjustment Int Source #
The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity. For exact capacity, you must specify a positive value.
StepScalingPolicyConfiguration
stepScalingPolicyConfiguration_stepAdjustments :: Lens' StepScalingPolicyConfiguration (Maybe [StepAdjustment]) Source #
A set of adjustments that enable you to scale based on the size of the alarm breach.
At least one step adjustment is required if you are adding a new step scaling policy configuration.
stepScalingPolicyConfiguration_adjustmentType :: Lens' StepScalingPolicyConfiguration (Maybe AdjustmentType) Source #
Specifies how the ScalingAdjustment
value in a
StepAdjustment
is interpreted (for example, an absolute number or a percentage). The
valid values are ChangeInCapacity
, ExactCapacity
, and
PercentChangeInCapacity
.
AdjustmentType
is required if you are adding a new step scaling policy
configuration.
stepScalingPolicyConfiguration_cooldown :: Lens' StepScalingPolicyConfiguration (Maybe Int) Source #
The amount of time, in seconds, to wait for a previous scaling activity to take effect.
With scale-out policies, the intention is to continuously (but not excessively) scale out. After Application Auto Scaling successfully scales out using a step scaling policy, it starts to calculate the cooldown time. The scaling policy won't increase the desired capacity again unless either a larger scale out is triggered or the cooldown period ends. While the cooldown period is in effect, capacity added by the initiating scale-out activity is calculated as part of the desired capacity for the next scale-out activity. For example, when an alarm triggers a step scaling policy to increase the capacity by 2, the scaling activity completes successfully, and a cooldown period starts. If the alarm triggers again during the cooldown period but at a more aggressive step adjustment of 3, the previous increase of 2 is considered part of the current capacity. Therefore, only 1 is added to the capacity.
With scale-in policies, the intention is to scale in conservatively to protect your application’s availability, so scale-in activities are blocked until the cooldown period has expired. However, if another alarm triggers a scale-out activity during the cooldown period after a scale-in activity, Application Auto Scaling scales out the target immediately. In this case, the cooldown period for the scale-in activity stops and doesn't complete.
Application Auto Scaling provides a default value of 600 for Amazon ElastiCache replication groups and a default value of 300 for the following scalable targets:
- AppStream 2.0 fleets
- Aurora DB clusters
- ECS services
- EMR clusters
- Neptune clusters
- SageMaker endpoint variants
- Spot Fleets
- Custom resources
For all other scalable targets, the default value is 0:
- Amazon Comprehend document classification and entity recognizer endpoints
- DynamoDB tables and global secondary indexes
- Amazon Keyspaces tables
- Lambda provisioned concurrency
- Amazon MSK broker storage
stepScalingPolicyConfiguration_metricAggregationType :: Lens' StepScalingPolicyConfiguration (Maybe MetricAggregationType) Source #
The aggregation type for the CloudWatch metrics. Valid values are
Minimum
, Maximum
, and Average
. If the aggregation type is null,
the value is treated as Average
.
stepScalingPolicyConfiguration_minAdjustmentMagnitude :: Lens' StepScalingPolicyConfiguration (Maybe Int) Source #
The minimum value to scale by when the adjustment type is
PercentChangeInCapacity
. For example, suppose that you create a step
scaling policy to scale out an Amazon ECS service by 25 percent and you
specify a MinAdjustmentMagnitude
of 2. If the service has 4 tasks and
the scaling policy is performed, 25 percent of 4 is 1. However, because
you specified a MinAdjustmentMagnitude
of 2, Application Auto Scaling
scales out the service by 2 tasks.
SuspendedState
suspendedState_dynamicScalingInSuspended :: Lens' SuspendedState (Maybe Bool) Source #
Whether scale in by a target tracking scaling policy or a step scaling
policy is suspended. Set the value to true
if you don't want
Application Auto Scaling to remove capacity when a scaling policy is
triggered. The default is false
.
suspendedState_scheduledScalingSuspended :: Lens' SuspendedState (Maybe Bool) Source #
Whether scheduled scaling is suspended. Set the value to true
if you
don't want Application Auto Scaling to add or remove capacity by
initiating scheduled actions. The default is false
.
suspendedState_dynamicScalingOutSuspended :: Lens' SuspendedState (Maybe Bool) Source #
Whether scale out by a target tracking scaling policy or a step scaling
policy is suspended. Set the value to true
if you don't want
Application Auto Scaling to add capacity when a scaling policy is
triggered. The default is false
.
TargetTrackingScalingPolicyConfiguration
targetTrackingScalingPolicyConfiguration_predefinedMetricSpecification :: Lens' TargetTrackingScalingPolicyConfiguration (Maybe PredefinedMetricSpecification) Source #
A predefined metric. You can specify either a predefined metric or a customized metric.
targetTrackingScalingPolicyConfiguration_scaleInCooldown :: Lens' TargetTrackingScalingPolicyConfiguration (Maybe Int) Source #
The amount of time, in seconds, after a scale-in activity completes before another scale-in activity can start.
With the scale-in cooldown period, the intention is to scale in conservatively to protect your application’s availability, so scale-in activities are blocked until the cooldown period has expired. However, if another alarm triggers a scale-out activity during the scale-in cooldown period, Application Auto Scaling scales out the target immediately. In this case, the scale-in cooldown period stops and doesn't complete.
Application Auto Scaling provides a default value of 600 for Amazon ElastiCache replication groups and a default value of 300 for the following scalable targets:
- AppStream 2.0 fleets
- Aurora DB clusters
- ECS services
- EMR clusters
- Neptune clusters
- SageMaker endpoint variants
- Spot Fleets
- Custom resources
For all other scalable targets, the default value is 0:
- Amazon Comprehend document classification and entity recognizer endpoints
- DynamoDB tables and global secondary indexes
- Amazon Keyspaces tables
- Lambda provisioned concurrency
- Amazon MSK broker storage
targetTrackingScalingPolicyConfiguration_customizedMetricSpecification :: Lens' TargetTrackingScalingPolicyConfiguration (Maybe CustomizedMetricSpecification) Source #
A customized metric. You can specify either a predefined metric or a customized metric.
targetTrackingScalingPolicyConfiguration_disableScaleIn :: Lens' TargetTrackingScalingPolicyConfiguration (Maybe Bool) Source #
Indicates whether scale in by the target tracking scaling policy is
disabled. If the value is true
, scale in is disabled and the target
tracking scaling policy won't remove capacity from the scalable target.
Otherwise, scale in is enabled and the target tracking scaling policy
can remove capacity from the scalable target. The default value is
false
.
targetTrackingScalingPolicyConfiguration_scaleOutCooldown :: Lens' TargetTrackingScalingPolicyConfiguration (Maybe Int) Source #
The amount of time, in seconds, to wait for a previous scale-out activity to take effect.
With the scale-out cooldown period, the intention is to continuously (but not excessively) scale out. After Application Auto Scaling successfully scales out using a target tracking scaling policy, it starts to calculate the cooldown time. The scaling policy won't increase the desired capacity again unless either a larger scale out is triggered or the cooldown period ends. While the cooldown period is in effect, the capacity added by the initiating scale-out activity is calculated as part of the desired capacity for the next scale-out activity.
Application Auto Scaling provides a default value of 600 for Amazon ElastiCache replication groups and a default value of 300 for the following scalable targets:
- AppStream 2.0 fleets
- Aurora DB clusters
- ECS services
- EMR clusters
- Neptune clusters
- SageMaker endpoint variants
- Spot Fleets
- Custom resources
For all other scalable targets, the default value is 0:
- Amazon Comprehend document classification and entity recognizer endpoints
- DynamoDB tables and global secondary indexes
- Amazon Keyspaces tables
- Lambda provisioned concurrency
- Amazon MSK broker storage
targetTrackingScalingPolicyConfiguration_targetValue :: Lens' TargetTrackingScalingPolicyConfiguration Double Source #
The target value for the metric. Although this property accepts numbers of type Double, it won't accept values that are either too small or too large. Values must be in the range of -2^360 to 2^360. The value must be a valid number based on the choice of metric. For example, if the metric is CPU utilization, then the target value is a percent value that represents how much of the CPU can be used before scaling out.