DescribeLoadBasedAutoScaling
Describes load-based auto scaling configurations for specified layers.
Note
You must specify at least one of the parameters.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.
Request Syntax
{
"LayerIds": [ "string
" ]
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- LayerIds
-
An array of layer IDs.
Type: Array of strings
Required: Yes
Response Syntax
{
"LoadBasedAutoScalingConfigurations": [
{
"DownScaling": {
"Alarms": [ "string" ],
"CpuThreshold": number,
"IgnoreMetricsTime": number,
"InstanceCount": number,
"LoadThreshold": number,
"MemoryThreshold": number,
"ThresholdsWaitTime": number
},
"Enable": boolean,
"LayerId": "string",
"UpScaling": {
"Alarms": [ "string" ],
"CpuThreshold": number,
"IgnoreMetricsTime": number,
"InstanceCount": number,
"LoadThreshold": number,
"MemoryThreshold": number,
"ThresholdsWaitTime": number
}
}
]
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- LoadBasedAutoScalingConfigurations
-
An array of
LoadBasedAutoScalingConfiguration
objects that describe each layer's configuration.Type: Array of LoadBasedAutoScalingConfiguration objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- ResourceNotFoundException
-
Indicates that a resource was not found.
HTTP Status Code: 400
- ValidationException
-
Indicates that a request was not valid.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: