applicationautoscaling.d.ts (36744B)
1 import {Request} from '../lib/request'; 2 import {Response} from '../lib/response'; 3 import {AWSError} from '../lib/error'; 4 import {Service} from '../lib/service'; 5 import {ServiceConfigurationOptions} from '../lib/service'; 6 import {ConfigBase as Config} from '../lib/config'; 7 interface Blob {} 8 declare class ApplicationAutoScaling extends Service { 9 /** 10 * Constructs a service object. This object has one method for each API operation. 11 */ 12 constructor(options?: ApplicationAutoScaling.Types.ClientConfiguration) 13 config: Config & ApplicationAutoScaling.Types.ClientConfiguration; 14 /** 15 * Deletes the specified Application Auto Scaling scaling policy. Deleting a policy deletes the underlying alarm action, but does not delete the CloudWatch alarm associated with the scaling policy, even if it no longer has an associated action. To create a scaling policy or update an existing one, see PutScalingPolicy. 16 */ 17 deleteScalingPolicy(params: ApplicationAutoScaling.Types.DeleteScalingPolicyRequest, callback?: (err: AWSError, data: ApplicationAutoScaling.Types.DeleteScalingPolicyResponse) => void): Request<ApplicationAutoScaling.Types.DeleteScalingPolicyResponse, AWSError>; 18 /** 19 * Deletes the specified Application Auto Scaling scaling policy. Deleting a policy deletes the underlying alarm action, but does not delete the CloudWatch alarm associated with the scaling policy, even if it no longer has an associated action. To create a scaling policy or update an existing one, see PutScalingPolicy. 20 */ 21 deleteScalingPolicy(callback?: (err: AWSError, data: ApplicationAutoScaling.Types.DeleteScalingPolicyResponse) => void): Request<ApplicationAutoScaling.Types.DeleteScalingPolicyResponse, AWSError>; 22 /** 23 * Deregisters a scalable target. Deregistering a scalable target deletes the scaling policies that are associated with it. To create a scalable target or update an existing one, see RegisterScalableTarget. 24 */ 25 deregisterScalableTarget(params: ApplicationAutoScaling.Types.DeregisterScalableTargetRequest, callback?: (err: AWSError, data: ApplicationAutoScaling.Types.DeregisterScalableTargetResponse) => void): Request<ApplicationAutoScaling.Types.DeregisterScalableTargetResponse, AWSError>; 26 /** 27 * Deregisters a scalable target. Deregistering a scalable target deletes the scaling policies that are associated with it. To create a scalable target or update an existing one, see RegisterScalableTarget. 28 */ 29 deregisterScalableTarget(callback?: (err: AWSError, data: ApplicationAutoScaling.Types.DeregisterScalableTargetResponse) => void): Request<ApplicationAutoScaling.Types.DeregisterScalableTargetResponse, AWSError>; 30 /** 31 * Provides descriptive information about the scalable targets in the specified namespace. You can filter the results using the ResourceIds and ScalableDimension parameters. To create a scalable target or update an existing one, see RegisterScalableTarget. If you are no longer using a scalable target, you can deregister it using DeregisterScalableTarget. 32 */ 33 describeScalableTargets(params: ApplicationAutoScaling.Types.DescribeScalableTargetsRequest, callback?: (err: AWSError, data: ApplicationAutoScaling.Types.DescribeScalableTargetsResponse) => void): Request<ApplicationAutoScaling.Types.DescribeScalableTargetsResponse, AWSError>; 34 /** 35 * Provides descriptive information about the scalable targets in the specified namespace. You can filter the results using the ResourceIds and ScalableDimension parameters. To create a scalable target or update an existing one, see RegisterScalableTarget. If you are no longer using a scalable target, you can deregister it using DeregisterScalableTarget. 36 */ 37 describeScalableTargets(callback?: (err: AWSError, data: ApplicationAutoScaling.Types.DescribeScalableTargetsResponse) => void): Request<ApplicationAutoScaling.Types.DescribeScalableTargetsResponse, AWSError>; 38 /** 39 * Provides descriptive information about the scaling activities in the specified namespace from the previous six weeks. You can filter the results using the ResourceId and ScalableDimension parameters. Scaling activities are triggered by CloudWatch alarms that are associated with scaling policies. To view the scaling policies for a service namespace, see DescribeScalingPolicies. To create a scaling policy or update an existing one, see PutScalingPolicy. 40 */ 41 describeScalingActivities(params: ApplicationAutoScaling.Types.DescribeScalingActivitiesRequest, callback?: (err: AWSError, data: ApplicationAutoScaling.Types.DescribeScalingActivitiesResponse) => void): Request<ApplicationAutoScaling.Types.DescribeScalingActivitiesResponse, AWSError>; 42 /** 43 * Provides descriptive information about the scaling activities in the specified namespace from the previous six weeks. You can filter the results using the ResourceId and ScalableDimension parameters. Scaling activities are triggered by CloudWatch alarms that are associated with scaling policies. To view the scaling policies for a service namespace, see DescribeScalingPolicies. To create a scaling policy or update an existing one, see PutScalingPolicy. 44 */ 45 describeScalingActivities(callback?: (err: AWSError, data: ApplicationAutoScaling.Types.DescribeScalingActivitiesResponse) => void): Request<ApplicationAutoScaling.Types.DescribeScalingActivitiesResponse, AWSError>; 46 /** 47 * Provides descriptive information about the scaling policies in the specified namespace. You can filter the results using the ResourceId, ScalableDimension, and PolicyNames parameters. To create a scaling policy or update an existing one, see PutScalingPolicy. If you are no longer using a scaling policy, you can delete it using DeleteScalingPolicy. 48 */ 49 describeScalingPolicies(params: ApplicationAutoScaling.Types.DescribeScalingPoliciesRequest, callback?: (err: AWSError, data: ApplicationAutoScaling.Types.DescribeScalingPoliciesResponse) => void): Request<ApplicationAutoScaling.Types.DescribeScalingPoliciesResponse, AWSError>; 50 /** 51 * Provides descriptive information about the scaling policies in the specified namespace. You can filter the results using the ResourceId, ScalableDimension, and PolicyNames parameters. To create a scaling policy or update an existing one, see PutScalingPolicy. If you are no longer using a scaling policy, you can delete it using DeleteScalingPolicy. 52 */ 53 describeScalingPolicies(callback?: (err: AWSError, data: ApplicationAutoScaling.Types.DescribeScalingPoliciesResponse) => void): Request<ApplicationAutoScaling.Types.DescribeScalingPoliciesResponse, AWSError>; 54 /** 55 * Creates or updates a policy for an Application Auto Scaling scalable target. Each scalable target is identified by a service namespace, resource ID, and scalable dimension. A scaling policy applies to the scalable target identified by those three attributes. You cannot create a scaling policy without first registering a scalable target using RegisterScalableTarget. To update a policy, specify its policy name and the parameters that you want to change. Any parameters that you don't specify are not changed by this update request. You can view the scaling policies for a service namespace using DescribeScalingPolicies. If you are no longer using a scaling policy, you can delete it using DeleteScalingPolicy. 56 */ 57 putScalingPolicy(params: ApplicationAutoScaling.Types.PutScalingPolicyRequest, callback?: (err: AWSError, data: ApplicationAutoScaling.Types.PutScalingPolicyResponse) => void): Request<ApplicationAutoScaling.Types.PutScalingPolicyResponse, AWSError>; 58 /** 59 * Creates or updates a policy for an Application Auto Scaling scalable target. Each scalable target is identified by a service namespace, resource ID, and scalable dimension. A scaling policy applies to the scalable target identified by those three attributes. You cannot create a scaling policy without first registering a scalable target using RegisterScalableTarget. To update a policy, specify its policy name and the parameters that you want to change. Any parameters that you don't specify are not changed by this update request. You can view the scaling policies for a service namespace using DescribeScalingPolicies. If you are no longer using a scaling policy, you can delete it using DeleteScalingPolicy. 60 */ 61 putScalingPolicy(callback?: (err: AWSError, data: ApplicationAutoScaling.Types.PutScalingPolicyResponse) => void): Request<ApplicationAutoScaling.Types.PutScalingPolicyResponse, AWSError>; 62 /** 63 * Registers or updates a scalable target. A scalable target is a resource that Application Auto Scaling can scale out or scale in. After you have registered a scalable target, you can use this operation to update the minimum and maximum values for your scalable dimension. After you register a scalable target, you can create and apply scaling policies using PutScalingPolicy. You can view the scaling policies for a service namespace using DescribeScalableTargets. If you are no longer using a scalable target, you can deregister it using DeregisterScalableTarget. 64 */ 65 registerScalableTarget(params: ApplicationAutoScaling.Types.RegisterScalableTargetRequest, callback?: (err: AWSError, data: ApplicationAutoScaling.Types.RegisterScalableTargetResponse) => void): Request<ApplicationAutoScaling.Types.RegisterScalableTargetResponse, AWSError>; 66 /** 67 * Registers or updates a scalable target. A scalable target is a resource that Application Auto Scaling can scale out or scale in. After you have registered a scalable target, you can use this operation to update the minimum and maximum values for your scalable dimension. After you register a scalable target, you can create and apply scaling policies using PutScalingPolicy. You can view the scaling policies for a service namespace using DescribeScalableTargets. If you are no longer using a scalable target, you can deregister it using DeregisterScalableTarget. 68 */ 69 registerScalableTarget(callback?: (err: AWSError, data: ApplicationAutoScaling.Types.RegisterScalableTargetResponse) => void): Request<ApplicationAutoScaling.Types.RegisterScalableTargetResponse, AWSError>; 70 } 71 declare namespace ApplicationAutoScaling.Types { 72 export type AdjustmentType = "ChangeInCapacity"|"PercentChangeInCapacity"|"ExactCapacity"|string; 73 export interface Alarm { 74 /** 75 * The name of the alarm. 76 */ 77 AlarmName: ResourceId; 78 /** 79 * The Amazon Resource Name (ARN) of the alarm. 80 */ 81 AlarmARN: ResourceId; 82 } 83 export type Alarms = Alarm[]; 84 export type Cooldown = number; 85 export interface DeleteScalingPolicyRequest { 86 /** 87 * The name of the scaling policy. 88 */ 89 PolicyName: ResourceIdMaxLen1600; 90 /** 91 * The namespace of the AWS service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference. 92 */ 93 ServiceNamespace: ServiceNamespace; 94 /** 95 * 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 request - The resource type is spot-fleet-request and the unique identifier is the Spot fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0. 96 */ 97 ResourceId: ResourceIdMaxLen1600; 98 /** 99 * 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. ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot fleet request. elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group. 100 */ 101 ScalableDimension: ScalableDimension; 102 } 103 export interface DeleteScalingPolicyResponse { 104 } 105 export interface DeregisterScalableTargetRequest { 106 /** 107 * The namespace of the AWS service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference. 108 */ 109 ServiceNamespace: ServiceNamespace; 110 /** 111 * 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 request - The resource type is spot-fleet-request and the unique identifier is the Spot fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0. 112 */ 113 ResourceId: ResourceIdMaxLen1600; 114 /** 115 * 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. ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot fleet request. elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group. 116 */ 117 ScalableDimension: ScalableDimension; 118 } 119 export interface DeregisterScalableTargetResponse { 120 } 121 export interface DescribeScalableTargetsRequest { 122 /** 123 * The namespace of the AWS service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference. 124 */ 125 ServiceNamespace: ServiceNamespace; 126 /** 127 * The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID. ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp. Spot fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0. 128 */ 129 ResourceIds?: ResourceIdsMaxLen1600; 130 /** 131 * The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID. ecs:service:DesiredCount - The desired task count of an ECS service. ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot fleet request. elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group. 132 */ 133 ScalableDimension?: ScalableDimension; 134 /** 135 * The maximum number of scalable target 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. 136 */ 137 MaxResults?: MaxResults; 138 /** 139 * The token for the next set of results. 140 */ 141 NextToken?: XmlString; 142 } 143 export interface DescribeScalableTargetsResponse { 144 /** 145 * The list of scalable targets that matches the request parameters. 146 */ 147 ScalableTargets?: ScalableTargets; 148 /** 149 * The token required to get the next set of results. This value is null if there are no more results to return. 150 */ 151 NextToken?: XmlString; 152 } 153 export interface DescribeScalingActivitiesRequest { 154 /** 155 * The namespace of the AWS service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference. 156 */ 157 ServiceNamespace: ServiceNamespace; 158 /** 159 * The identifier of the resource associated with the scaling activity. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID. ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp. Spot fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0. 160 */ 161 ResourceId?: ResourceIdMaxLen1600; 162 /** 163 * The scalable dimension. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID. ecs:service:DesiredCount - The desired task count of an ECS service. ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot fleet request. elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group. 164 */ 165 ScalableDimension?: ScalableDimension; 166 /** 167 * The maximum number of scalable target 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. 168 */ 169 MaxResults?: MaxResults; 170 /** 171 * The token for the next set of results. 172 */ 173 NextToken?: XmlString; 174 } 175 export interface DescribeScalingActivitiesResponse { 176 /** 177 * A list of scaling activity objects. 178 */ 179 ScalingActivities?: ScalingActivities; 180 /** 181 * The token required to get the next set of results. This value is null if there are no more results to return. 182 */ 183 NextToken?: XmlString; 184 } 185 export interface DescribeScalingPoliciesRequest { 186 /** 187 * The names of the scaling policies to describe. 188 */ 189 PolicyNames?: ResourceIdsMaxLen1600; 190 /** 191 * The namespace of the AWS service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference. 192 */ 193 ServiceNamespace: ServiceNamespace; 194 /** 195 * The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID. ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp. Spot fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0. 196 */ 197 ResourceId?: ResourceIdMaxLen1600; 198 /** 199 * The scalable dimension. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID. ecs:service:DesiredCount - The desired task count of an ECS service. ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot fleet request. elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group. 200 */ 201 ScalableDimension?: ScalableDimension; 202 /** 203 * The maximum number of scalable target 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. 204 */ 205 MaxResults?: MaxResults; 206 /** 207 * The token for the next set of results. 208 */ 209 NextToken?: XmlString; 210 } 211 export interface DescribeScalingPoliciesResponse { 212 /** 213 * A list of scaling policy objects. 214 */ 215 ScalingPolicies?: ScalingPolicies; 216 /** 217 * The token required to get the next set of results. This value is null if there are no more results to return. 218 */ 219 NextToken?: XmlString; 220 } 221 export type ErrorMessage = string; 222 export type MaxResults = number; 223 export type MetricAggregationType = "Average"|"Minimum"|"Maximum"|string; 224 export type MetricScale = number; 225 export type MinAdjustmentMagnitude = number; 226 export type PolicyName = string; 227 export type PolicyType = "StepScaling"|string; 228 export interface PutScalingPolicyRequest { 229 /** 230 * The name of the scaling policy. 231 */ 232 PolicyName: PolicyName; 233 /** 234 * The namespace of the AWS service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference. 235 */ 236 ServiceNamespace: ServiceNamespace; 237 /** 238 * 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 request - The resource type is spot-fleet-request and the unique identifier is the Spot fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0. 239 */ 240 ResourceId: ResourceIdMaxLen1600; 241 /** 242 * 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. ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot fleet request. elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group. 243 */ 244 ScalableDimension: ScalableDimension; 245 /** 246 * The policy type. If you are creating a new policy, this parameter is required. If you are updating a policy, this parameter is not required. 247 */ 248 PolicyType?: PolicyType; 249 /** 250 * The configuration for the step scaling policy. If you are creating a new policy, this parameter is required. If you are updating a policy, this parameter is not required. For more information, see StepScalingPolicyConfiguration and StepAdjustment. 251 */ 252 StepScalingPolicyConfiguration?: StepScalingPolicyConfiguration; 253 } 254 export interface PutScalingPolicyResponse { 255 /** 256 * The Amazon Resource Name (ARN) of the resulting scaling policy. 257 */ 258 PolicyARN: ResourceIdMaxLen1600; 259 } 260 export interface RegisterScalableTargetRequest { 261 /** 262 * The namespace of the AWS service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference. 263 */ 264 ServiceNamespace: ServiceNamespace; 265 /** 266 * 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 request - The resource type is spot-fleet-request and the unique identifier is the Spot fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0. 267 */ 268 ResourceId: ResourceIdMaxLen1600; 269 /** 270 * 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. ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot fleet request. elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group. 271 */ 272 ScalableDimension: ScalableDimension; 273 /** 274 * The minimum value to scale to in response to a scale in event. This parameter is required if you are registering a scalable target and optional if you are updating one. 275 */ 276 MinCapacity?: ResourceCapacity; 277 /** 278 * The maximum value to scale to in response to a scale out event. This parameter is required if you are registering a scalable target and optional if you are updating one. 279 */ 280 MaxCapacity?: ResourceCapacity; 281 /** 282 * The ARN of an IAM role that allows Application Auto Scaling to modify the scalable target on your behalf. This parameter is required when you register a scalable target and optional when you update one. 283 */ 284 RoleARN?: ResourceIdMaxLen1600; 285 } 286 export interface RegisterScalableTargetResponse { 287 } 288 export type ResourceCapacity = number; 289 export type ResourceId = string; 290 export type ResourceIdMaxLen1600 = string; 291 export type ResourceIdsMaxLen1600 = ResourceIdMaxLen1600[]; 292 export type ScalableDimension = "ecs:service:DesiredCount"|"ec2:spot-fleet-request:TargetCapacity"|"elasticmapreduce:instancegroup:InstanceCount"|string; 293 export interface ScalableTarget { 294 /** 295 * The namespace of the AWS service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference. 296 */ 297 ServiceNamespace: ServiceNamespace; 298 /** 299 * 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 request - The resource type is spot-fleet-request and the unique identifier is the Spot fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0. 300 */ 301 ResourceId: ResourceIdMaxLen1600; 302 /** 303 * 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. ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot fleet request. elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group. 304 */ 305 ScalableDimension: ScalableDimension; 306 /** 307 * The minimum value to scale to in response to a scale in event. 308 */ 309 MinCapacity: ResourceCapacity; 310 /** 311 * The maximum value to scale to in response to a scale out event. 312 */ 313 MaxCapacity: ResourceCapacity; 314 /** 315 * The ARN of an IAM role that allows Application Auto Scaling to modify the scalable target on your behalf. 316 */ 317 RoleARN: ResourceIdMaxLen1600; 318 /** 319 * The Unix timestamp for when the scalable target was created. 320 */ 321 CreationTime: TimestampType; 322 } 323 export type ScalableTargets = ScalableTarget[]; 324 export type ScalingActivities = ScalingActivity[]; 325 export interface ScalingActivity { 326 /** 327 * The unique identifier of the scaling activity. 328 */ 329 ActivityId: ResourceId; 330 /** 331 * The namespace of the AWS service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference. 332 */ 333 ServiceNamespace: ServiceNamespace; 334 /** 335 * 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 request - The resource type is spot-fleet-request and the unique identifier is the Spot fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0. 336 */ 337 ResourceId: ResourceIdMaxLen1600; 338 /** 339 * 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. ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot fleet request. elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group. 340 */ 341 ScalableDimension: ScalableDimension; 342 /** 343 * A simple description of what action the scaling activity intends to accomplish. 344 */ 345 Description: XmlString; 346 /** 347 * A simple description of what caused the scaling activity to happen. 348 */ 349 Cause: XmlString; 350 /** 351 * The Unix timestamp for when the scaling activity began. 352 */ 353 StartTime: TimestampType; 354 /** 355 * The Unix timestamp for when the scaling activity ended. 356 */ 357 EndTime?: TimestampType; 358 /** 359 * Indicates the status of the scaling activity. 360 */ 361 StatusCode: ScalingActivityStatusCode; 362 /** 363 * A simple message about the current status of the scaling activity. 364 */ 365 StatusMessage?: XmlString; 366 /** 367 * The details about the scaling activity. 368 */ 369 Details?: XmlString; 370 } 371 export type ScalingActivityStatusCode = "Pending"|"InProgress"|"Successful"|"Overridden"|"Unfulfilled"|"Failed"|string; 372 export type ScalingAdjustment = number; 373 export type ScalingPolicies = ScalingPolicy[]; 374 export interface ScalingPolicy { 375 /** 376 * The Amazon Resource Name (ARN) of the scaling policy. 377 */ 378 PolicyARN: ResourceIdMaxLen1600; 379 /** 380 * The name of the scaling policy. 381 */ 382 PolicyName: PolicyName; 383 /** 384 * The namespace of the AWS service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference. 385 */ 386 ServiceNamespace: ServiceNamespace; 387 /** 388 * 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 request - The resource type is spot-fleet-request and the unique identifier is the Spot fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0. 389 */ 390 ResourceId: ResourceIdMaxLen1600; 391 /** 392 * 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. ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot fleet request. elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group. 393 */ 394 ScalableDimension: ScalableDimension; 395 /** 396 * The scaling policy type. 397 */ 398 PolicyType: PolicyType; 399 /** 400 * The configuration for the step scaling policy. 401 */ 402 StepScalingPolicyConfiguration?: StepScalingPolicyConfiguration; 403 /** 404 * The CloudWatch alarms associated with the scaling policy. 405 */ 406 Alarms?: Alarms; 407 /** 408 * The Unix timestamp for when the scaling policy was created. 409 */ 410 CreationTime: TimestampType; 411 } 412 export type ServiceNamespace = "ecs"|"elasticmapreduce"|"ec2"|string; 413 export interface StepAdjustment { 414 /** 415 * 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. 416 */ 417 MetricIntervalLowerBound?: MetricScale; 418 /** 419 * 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. 420 */ 421 MetricIntervalUpperBound?: MetricScale; 422 /** 423 * The amount by which to scale, based on the specified adjustment type. A positive value adds to the current scalable dimension while a negative number removes from the current scalable dimension. 424 */ 425 ScalingAdjustment: ScalingAdjustment; 426 } 427 export type StepAdjustments = StepAdjustment[]; 428 export interface StepScalingPolicyConfiguration { 429 /** 430 * The adjustment type, which specifies how the ScalingAdjustment parameter in a StepAdjustment is interpreted. 431 */ 432 AdjustmentType?: AdjustmentType; 433 /** 434 * A set of adjustments that enable you to scale based on the size of the alarm breach. 435 */ 436 StepAdjustments?: StepAdjustments; 437 /** 438 * The minimum number to adjust your scalable dimension as a result of a scaling activity. If the adjustment type is PercentChangeInCapacity, the scaling policy changes the scalable dimension of the scalable target by this amount. 439 */ 440 MinAdjustmentMagnitude?: MinAdjustmentMagnitude; 441 /** 442 * The amount of time, in seconds, after a scaling activity completes where previous trigger-related scaling activities can influence future scaling events. For scale out policies, while Cooldown is in effect, the capacity that has been added by the previous scale out event that initiated the Cooldown is calculated as part of the desired capacity for the next scale out. The intention is to continuously (but not excessively) scale out. For example, an alarm triggers a step scaling policy to scale out an Amazon ECS service by 2 tasks, the scaling activity completes successfully, and a Cooldown period of 5 minutes starts. During the Cooldown period, if the alarm triggers the same policy again but at a more aggressive step adjustment to scale out the service by 3 tasks, the 2 tasks that were added in the previous scale out event are considered part of that capacity and only 1 additional task is added to the desired count. For scale in policies, the Cooldown period is used to block subsequent scale in requests until it has expired. The intention is to scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the Cooldown period after a scale-in, Application Auto Scaling scales out your scalable target immediately. 443 */ 444 Cooldown?: Cooldown; 445 /** 446 * The aggregation type for the CloudWatch metrics. Valid values are Minimum, Maximum, and Average. 447 */ 448 MetricAggregationType?: MetricAggregationType; 449 } 450 export type TimestampType = Date; 451 export type XmlString = string; 452 /** 453 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. 454 */ 455 export type apiVersion = "2016-02-06"|"latest"|string; 456 export interface ClientApiVersions { 457 /** 458 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. 459 */ 460 apiVersion?: apiVersion; 461 } 462 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; 463 } 464 export = ApplicationAutoScaling;